1-- *****************************************************************
2-- DOCS-DSG-IF-MIB.my:
3--
4-- Mar 2005 Jun Yan
5--
6-- Initial Version:
7-- Mar 2005: DSG-InterfaceSpecification-CM-SP-DSG-I03-041124.pdf
8--
9-- Copyright (c) 2005-2006, 2008-2009 by cisco Systems Inc.
10-- All rights reserved.
11-- *****************************************************************
12
13DSG-IF-MIB DEFINITIONS ::= BEGIN
14
15IMPORTS
16    MODULE-IDENTITY,
17    OBJECT-TYPE,
18    Unsigned32,
19    Integer32
20        FROM SNMPv2-SMI
21    OBJECT-GROUP,
22    MODULE-COMPLIANCE
23        FROM SNMPv2-CONF
24    TruthValue,
25    MacAddress,
26    RowStatus
27        FROM SNMPv2-TC
28    InetAddressType,
29    InetAddress,
30    InetAddressPrefixLength,
31    InetPortNumber
32        FROM INET-ADDRESS-MIB
33    SnmpAdminString
34        FROM SNMP-FRAMEWORK-MIB
35    InterfaceIndex,
36    ifIndex
37        FROM IF-MIB
38    clabProjDocsis
39        FROM CLAB-DEF-MIB;
40
41
42dsgIfMIB MODULE-IDENTITY
43    LAST-UPDATED    "200903230000Z"
44    ORGANIZATION    "Cable Television Laboratories, Inc"
45    CONTACT-INFO
46            "Postal: Cable Television Laboratories, Inc.
47            858 Coal Creek Circle
48            Louisville, Colorado 80027
49            U.S.A.
50            Phone : +1 303-661-9100
51            Fax : +1 303-661-9199
52            E-mail:"
53    DESCRIPTION
54        "This is the MIB Module for the DOCSIS Set-top Gateway
55        (DSG). The DSG provides a one-way IP datagram transport
56        for Out-Of-Band (OOB) messaging to cable set-top clients.
57        The one-way IP datagram transport is called a DSG Tunnel.
58        A DSG Tunnel carrying either a broadcast, unicast or
59        multicast IP datagram stream originating at the DOCSIS
60        Set-top Gateway and carrying Out-Of-Band messages intended
61        for set-top clients. It is carried over one or more
62        downstream DOCSIS channels.
63        Multiple DSG tunnels may exist on a single downstream
64        DOCSIS channel."
65    REVISION        "200903230000Z"
66    DESCRIPTION
67        "Initial revision, published as part of DOCSIS Set-top
68        Gateway Specification."
69    ::= { clabProjDocsis 3 }
70
71
72dsgIfMIBNotifications  OBJECT IDENTIFIER
73    ::= { dsgIfMIB 0 }
74
75dsgIfMIBObjects  OBJECT IDENTIFIER
76    ::= { dsgIfMIB 1 }
77
78dsgIfMIBConformance  OBJECT IDENTIFIER
79    ::= { dsgIfMIB 2 }
80
81dsgIfClassifier  OBJECT IDENTIFIER
82    ::= { dsgIfMIBObjects 1 }
83
84dsgIfTunnel  OBJECT IDENTIFIER
85    ::= { dsgIfMIBObjects 2 }
86
87dsgIfTunnelGrpToChannel  OBJECT IDENTIFIER
88    ::= { dsgIfMIBObjects 3 }
89
90dsgIfDownstreamChannel  OBJECT IDENTIFIER
91    ::= { dsgIfMIBObjects 4 }
92
93dsgIfDCD  OBJECT IDENTIFIER
94    ::= { dsgIfMIBObjects 5 }
95
96-- --------------------------------------------------------------------
97-- The Classifier Table contains objects for classifying packets.
98-- The DSG Agent applies the DSG classifier parameters to the inbound
99-- packets from the DSG server in order to assign the packet to the
100-- appropriate DSG tunnel. The DSG Agent must classify incoming
101-- packets based upon the objects in this table with the exception of
102-- the dsgIfClassDestPortStart and dsgIfClassDestPortEnd objects.
103--
104-- The DSG Agent must also include these encoding in the DCD messages on
105-- the downstream channels to which the classifiers apply.
106--
107-- The DSG classifier is unique per DSG Agent.
108-- ----------------------------------------------------------------------
109
110dsgIfClassifierTable OBJECT-TYPE
111    SYNTAX          SEQUENCE OF DsgIfClassifierEntry
112    MAX-ACCESS      not-accessible
113    STATUS          current
114    DESCRIPTION
115        "The Classifier Table contains attributes use to classify
116        inbound packets into the tunnel and classifiers for the DSG
117        clients, encoding in the DCD messages on the downstream
118        channels to which the classifiers apply."
119    ::= { dsgIfClassifier 1 }
120
121dsgIfClassifierEntry OBJECT-TYPE
122    SYNTAX          DsgIfClassifierEntry
123    MAX-ACCESS      not-accessible
124    STATUS          current
125    DESCRIPTION
126        "An entry in the Classifier Table. Rows are created
127        by an SNMP SET request setting the value of
128        dsgIfClassRowStatus to 'createAndGo'. Each entry is created
129        for a tunnel, index by dsgTunnelIndex.
130        Rows are deleted by an SNMP SET request setting the value
131        of dsgIfClassRowStatus to 'destroy'."
132    INDEX           {
133                        dsgIfTunnelIndex,
134                        dsgIfClassId
135                    }
136    ::= { dsgIfClassifierTable 1 }
137
138DsgIfClassifierEntry ::= SEQUENCE {
139        dsgIfClassId                Unsigned32,
140        dsgIfClassPriority          Unsigned32,
141        dsgIfClassSrcIpAddrType     InetAddressType,
142        dsgIfClassSrcIpAddr         InetAddress,
143        dsgIfClassSrcIpPrefixLength InetAddressPrefixLength,
144        dsgIfClassDestIpAddressType InetAddressType,
145        dsgIfClassDestIpAddress     InetAddress,
146        dsgIfClassDestPortStart     InetPortNumber,
147        dsgIfClassDestPortEnd       InetPortNumber,
148        dsgIfClassRowStatus         RowStatus,
149        dsgIfClassIncludeInDCD      TruthValue
150}
151
152dsgIfClassId OBJECT-TYPE
153    SYNTAX          Unsigned32 (1..65535)
154    MAX-ACCESS      not-accessible
155    STATUS          current
156    DESCRIPTION
157        "The index that provides a unique classifier (in a DSG
158        Agent). This value corresponds to the Classifier ID TLV
159        in the DCD message."
160    ::= { dsgIfClassifierEntry 1 }
161
162dsgIfClassPriority OBJECT-TYPE
163    SYNTAX          Unsigned32 (0..255)
164    MAX-ACCESS      read-create
165    STATUS          current
166    DESCRIPTION
167        "The priority of this classifier.
168        Default value 0 indicates lowest priority."
169    DEFVAL          { 0 }
170    ::= { dsgIfClassifierEntry 2 }
171
172dsgIfClassSrcIpAddrType OBJECT-TYPE
173    SYNTAX          InetAddressType
174    MAX-ACCESS      read-create
175    STATUS          current
176    DESCRIPTION
177        "The type of internet address of dsgIfClassSrcIpAddress."
178    DEFVAL          { ipv4 }
179    ::= { dsgIfClassifierEntry 3 }
180
181dsgIfClassSrcIpAddr OBJECT-TYPE
182    SYNTAX          InetAddress
183    MAX-ACCESS      read-create
184    STATUS          current
185    DESCRIPTION
186        "The source IP address to be matched for this classifier.
187        A value 0 for this object indicates a match of any IP
188        address. A value that contains non-zero bits
189        outside the range indicated by dsgIfClassSrcIpPrefixLength
190        is invalid and should be rejected."
191    DEFVAL          { ''H }
192    ::= { dsgIfClassifierEntry 4 }
193
194dsgIfClassSrcIpPrefixLength OBJECT-TYPE
195    SYNTAX          InetAddressPrefixLength
196    MAX-ACCESS      read-create
197    STATUS          current
198    DESCRIPTION
199        "The length of the CIDR Prefix carried in
200        dsgIfClassSrcIpAddr. In IPv4 addresses, a length of 32 indicates
201        a match of a single host address, and a length between
202        0 and 32 indicates the use of a CIDR Prefix. A length of
203        0 is not allowed. This object is irrelevant and not used
204        when dsgIfClassSrcIpAddr value is 0."
205    DEFVAL          { 32 }
206    ::= { dsgIfClassifierEntry 5 }
207
208dsgIfClassDestIpAddressType OBJECT-TYPE
209    SYNTAX          InetAddressType
210    MAX-ACCESS      read-create
211    STATUS          current
212    DESCRIPTION
213        "The type of internet address of dsgIfClassDestIpAddress."
214    DEFVAL          { ipv4 }
215    ::= { dsgIfClassifierEntry 6 }
216
217dsgIfClassDestIpAddress OBJECT-TYPE
218    SYNTAX          InetAddress
219    MAX-ACCESS      read-create
220    STATUS          current
221    DESCRIPTION
222        "The destination IP address to be matched for this
223        classifier."
224    DEFVAL          { ''H }
225    ::= { dsgIfClassifierEntry 7 }
226
227dsgIfClassDestPortStart OBJECT-TYPE
228    SYNTAX          InetPortNumber
229    MAX-ACCESS      read-create
230    STATUS          current
231    DESCRIPTION
232        "This is the inclusive lower bound of the transport-layer
233        source port range that is to be matched."
234    DEFVAL          { 0 }
235    ::= { dsgIfClassifierEntry 8 }
236
237dsgIfClassDestPortEnd OBJECT-TYPE
238    SYNTAX          InetPortNumber
239    MAX-ACCESS      read-create
240    STATUS          current
241    DESCRIPTION
242        "This is the inclusive higher bound of the transport-layer
243        source port range that is to be matched."
244    DEFVAL          { 65535 }
245    ::= { dsgIfClassifierEntry 9 }
246
247dsgIfClassRowStatus OBJECT-TYPE
248    SYNTAX          RowStatus
249    MAX-ACCESS      read-create
250    STATUS          current
251    DESCRIPTION
252        "The status of the row. A value of active(1) indicates
253        that this classifier is applied to this tunnel.
254        A value of notInService(2) indicates that matching of
255        the packets are ignored and this classifier parameters
256        will not be included in the DCD message."
257    ::= { dsgIfClassifierEntry 10 }
258
259dsgIfClassIncludeInDCD OBJECT-TYPE
260    SYNTAX          TruthValue
261    MAX-ACCESS      read-create
262    STATUS          current
263    DESCRIPTION
264        "Indicates whether or not this DSG Classifier will
265        be sent in DCD messages for use as a Layer-3 and
266        Layer-4 packet filter by the DSG eCM."
267    DEFVAL          { false }
268    ::= { dsgIfClassifierEntry 11 }
269
270
271-- ----------------------------------------------------------------------
272-- The DSG Tunnel Table contains group(s) of DSG Tunnel Indexes.
273-- Tunnel Entry is mapped to the destination MAC address and each
274-- tunnel is associated to the Qos Service Class Name.
275-- ----------------------------------------------------------------------
276
277dsgIfTunnelTable OBJECT-TYPE
278    SYNTAX          SEQUENCE OF DsgIfTunnelEntry
279    MAX-ACCESS      not-accessible
280    STATUS          current
281    DESCRIPTION
282        "The DSG Tunnel Table contains group(s) of tunnel(s).
283        Each tunnel is associated to the destination MAC address."
284    ::= { dsgIfTunnel 1 }
285
286dsgIfTunnelEntry OBJECT-TYPE
287    SYNTAX          DsgIfTunnelEntry
288    MAX-ACCESS      not-accessible
289    STATUS          current
290    DESCRIPTION
291        "An entry in the DSG Tunnel Table. Rows are created by
292        an SNMP SET request setting the value of
293        dsgIfTunnelRowStatus to 'createAndGo'.
294        Each entry associated to a tunnel. A dsgIfTunnelGroupIndex
295        represents a group of tunnels that could be associated to
296        one or more downstream. Each dsgIfTunnelIndex represents
297        a tunnel.
298        Rows are deleted by an SNMP SET request setting the
299        value of dsgIfTunnelRowStatus to 'destroy'."
300    INDEX           { dsgIfTunnelIndex }
301    ::= { dsgIfTunnelTable 1 }
302
303DsgIfTunnelEntry ::= SEQUENCE {
304        dsgIfTunnelIndex             Unsigned32,
305        dsgIfTunnelGroupIndex        Unsigned32,
306        dsgIfTunnelClientIdListIndex Unsigned32,
307        dsgIfTunnelMacAddress        MacAddress,
308        dsgIfTunnelServiceClassName  SnmpAdminString,
309        dsgIfTunnelRowStatus         RowStatus
310}
311
312dsgIfTunnelIndex OBJECT-TYPE
313    SYNTAX          Unsigned32
314    MAX-ACCESS      not-accessible
315    STATUS          current
316    DESCRIPTION
317        "The index into the DSG Tunnel table that represent
318        a tunnel."
319    ::= { dsgIfTunnelEntry 1 }
320
321dsgIfTunnelGroupIndex OBJECT-TYPE
322    SYNTAX          Unsigned32
323    MAX-ACCESS      read-create
324    STATUS          current
325    DESCRIPTION
326        "This index represents a group of tunnels that could be
327        associated to one or more downstream which mapped
328        to dsgIfTunnelGrpIndex."
329    ::= { dsgIfTunnelEntry 2 }
330
331dsgIfTunnelClientIdListIndex OBJECT-TYPE
332    SYNTAX          Unsigned32
333    MAX-ACCESS      read-create
334    STATUS          current
335    DESCRIPTION
336        "This index represents a group of client id(s)
337        which mapped to dsgIfClientIdListIndex."
338    ::= { dsgIfTunnelEntry 3 }
339
340dsgIfTunnelMacAddress OBJECT-TYPE
341    SYNTAX          MacAddress
342    MAX-ACCESS      read-create
343    STATUS          current
344    DESCRIPTION
345        "The DSG tunnel destination MAC address."
346    DEFVAL          { '000000000000'H }
347    ::= { dsgIfTunnelEntry 4 }
348
349dsgIfTunnelServiceClassName OBJECT-TYPE
350    SYNTAX          SnmpAdminString
351    MAX-ACCESS      read-create
352    STATUS          current
353    DESCRIPTION
354        "The Service Class Name that associated to the
355        docsQosServiceClassName(in DOCS-QOS-MIB). Creation of a
356        Service Class MUST be configured through the
357        docsQosServiceClassTable. Only partial of the
358        docsQosServiceClassTable objects are applicable to the
359        DSG service class thus some are ignored.
360        If the referenced parameter is not present in the
361        corresponding DOCSIS QOS Parameter Set, the default
362        value of this object is a zero length string."
363    REFERENCE       "SP-RFIv1.1-I10-030730, Appendix C.2.2.3.4"
364    ::= { dsgIfTunnelEntry 5 }
365
366dsgIfTunnelRowStatus OBJECT-TYPE
367    SYNTAX          RowStatus
368    MAX-ACCESS      read-create
369    STATUS          current
370    DESCRIPTION
371        "The status of the row. A value of notInService(2)
372        indicates that this tunnel is disabled and no OOB traffic
373        will be forwarded to DSG clients and this tunnel parameters
374        will not be included in the DCD message."
375    ::= { dsgIfTunnelEntry 6 }
376
377
378-- ---------------------------------------------------------------------
379-- The DSG Tunnel Group to Channel Table contains the association of
380-- groups of tunnels to one or more downstream channels. This table
381-- contains the downstream ifIndex, rule priority, ucid range and vendor
382-- parameter identification(2).
383-- ---------------------------------------------------------------------
384
385dsgIfTunnelGrpToChannelTable OBJECT-TYPE
386    SYNTAX          SEQUENCE OF DsgIfTunnelGrpToChannelEntry
387    MAX-ACCESS      not-accessible
388    STATUS          current
389    DESCRIPTION
390        "The DSG Tunnel Group to Channel Table associates a group
391        of tunnels to one or more downstream channel."
392    ::= { dsgIfTunnelGrpToChannel 1 }
393
394dsgIfTunnelGrpToChannelEntry OBJECT-TYPE
395    SYNTAX          DsgIfTunnelGrpToChannelEntry
396    MAX-ACCESS      not-accessible
397    STATUS          current
398    DESCRIPTION
399        "An entry in the DSG Tunnel Table. Rows are created by
400        an SNMP SET request setting the value of
401        dsgIfTunnelGrpRowStatus to 'createAndGo'.
402        Rows are deleted by an SNMP SET request setting the
403        value of dsgIfTunnelRowStatus to 'destroy'."
404    INDEX           {
405                        dsgIfTunnelGrpIndex,
406                        dsgIfTunnelGrpChannelIndex
407                    }
408    ::= { dsgIfTunnelGrpToChannelTable 1 }
409
410DsgIfTunnelGrpToChannelEntry ::= SEQUENCE {
411        dsgIfTunnelGrpIndex         Unsigned32,
412        dsgIfTunnelGrpChannelIndex  Unsigned32,
413        dsgIfTunnelGrpDsIfIndex     InterfaceIndex,
414        dsgIfTunnelGrpRulePriority  Unsigned32,
415        dsgIfTunnelGrpUcidList      OCTET STRING,
416        dsgIfTunnelGrpVendorParamId Unsigned32,
417        dsgIfTunnelGrpRowStatus     RowStatus
418}
419
420dsgIfTunnelGrpIndex OBJECT-TYPE
421    SYNTAX          Unsigned32
422    MAX-ACCESS      not-accessible
423    STATUS          current
424    DESCRIPTION
425        "The index into this table."
426    ::= { dsgIfTunnelGrpToChannelEntry 1 }
427
428dsgIfTunnelGrpChannelIndex OBJECT-TYPE
429    SYNTAX          Unsigned32
430    MAX-ACCESS      not-accessible
431    STATUS          current
432    DESCRIPTION
433        "The index into this table."
434    ::= { dsgIfTunnelGrpToChannelEntry 2 }
435
436dsgIfTunnelGrpDsIfIndex OBJECT-TYPE
437    SYNTAX          InterfaceIndex
438    MAX-ACCESS      read-create
439    STATUS          current
440    DESCRIPTION
441        "The downstream ifIndex that will be associated to
442        this group of tunnel(s)."
443    ::= { dsgIfTunnelGrpToChannelEntry 3 }
444
445dsgIfTunnelGrpRulePriority OBJECT-TYPE
446    SYNTAX          Unsigned32 (0..255)
447    MAX-ACCESS      read-create
448    STATUS          current
449    DESCRIPTION
450        "The DSG rule priority determines the order of which
451        channel and its associated UCIDs should be applied by
452        the DSG client. The default value is 0, which is the lowest
453        priority."
454    DEFVAL          { 0 }
455    ::= { dsgIfTunnelGrpToChannelEntry 4 }
456
457dsgIfTunnelGrpUcidList OBJECT-TYPE
458    SYNTAX          OCTET STRING (SIZE  (0..255))
459    MAX-ACCESS      read-create
460    STATUS          current
461    DESCRIPTION
462        "The list of Upstream Channel ID (UCID) values (octets)
463        for which the DSG rule applies. A DSG client matches this
464        parameter if its UCID value is included in the list. The
465        default value of zero length string indicates that this
466        DSG Rule applies to all DSG clients."
467    DEFVAL          { "" }
468    ::= { dsgIfTunnelGrpToChannelEntry 5 }
469
470dsgIfTunnelGrpVendorParamId OBJECT-TYPE
471    SYNTAX          Unsigned32
472    MAX-ACCESS      read-create
473    STATUS          current
474    DESCRIPTION
475        "The index of vendor parameter, dsgIfVendorParamId in the
476        dsgIfVendorParamTable describing the vendor specific DSG
477        parameters. If no associated entry in dsgIfVendorParamTable
478        exists, this value is 0."
479    DEFVAL          { 0 }
480    ::= { dsgIfTunnelGrpToChannelEntry 6 }
481
482dsgIfTunnelGrpRowStatus OBJECT-TYPE
483    SYNTAX          RowStatus
484    MAX-ACCESS      read-create
485    STATUS          current
486    DESCRIPTION
487        "The status of this row. The value of notInService(2)
488        indicates that this tunnel group is disabled and no OOB
489        traffic on all the associated tunnel(s) will be forwarded
490        to DSG clients and all parameters will not be included in
491        the DCD message."
492    ::= { dsgIfTunnelGrpToChannelEntry 7 }
493
494
495-- ---------------------------------------------------------------------
496-- The Downstream Table contains the DSG Tunnel Index, the timer
497-- index, specific vendor parameter identification(3) and the
498-- index to the downstream channel list.
499-- ---------------------------------------------------------------------
500
501dsgIfDownstreamTable OBJECT-TYPE
502    SYNTAX          SEQUENCE OF DsgIfDownstreamEntry
503    MAX-ACCESS      not-accessible
504    STATUS          current
505    DESCRIPTION
506        "The DSG Downstream Table contains the associated timers,
507        vendor specific parameters index and the channel list
508        index to a specific downstream."
509    ::= { dsgIfDownstreamChannel 1 }
510
511dsgIfDownstreamEntry OBJECT-TYPE
512    SYNTAX          DsgIfDownstreamEntry
513    MAX-ACCESS      not-accessible
514    STATUS          current
515    DESCRIPTION
516        "An entry in the DSG Downstream Table.
517        An entry in this table exists for each ifEntry with
518        an ifType of docsCableDownstream(128)."
519    INDEX           { ifIndex }
520    ::= { dsgIfDownstreamTable 1 }
521
522DsgIfDownstreamEntry ::= SEQUENCE {
523        dsgIfDownTimerIndex       Unsigned32,
524        dsgIfDownVendorParamId    Unsigned32,
525        dsgIfDownChannelListIndex Unsigned32,
526        dsgIfDownEnableDCD        TruthValue
527}
528
529dsgIfDownTimerIndex OBJECT-TYPE
530    SYNTAX          Unsigned32
531    MAX-ACCESS      read-write
532    STATUS          current
533    DESCRIPTION
534        "The index into the timer table, dsgIfTimerTable providing
535        the timers used by the DSG client(s).
536        The default value 0 indicates there is no associated
537        timers that need to be sent in the DCD message."
538    DEFVAL          { 0 }
539    ::= { dsgIfDownstreamEntry 1 }
540
541dsgIfDownVendorParamId OBJECT-TYPE
542    SYNTAX          Unsigned32
543    MAX-ACCESS      read-write
544    STATUS          current
545    DESCRIPTION
546        "The index of vendor parameter, dsgIfVendorParamId in the
547        dsgIfVendorParamTable describing the vendor specific DSG
548        parameters. If no associated entry in dsgIfVendorParamTable
549        exists, this value is 0."
550    DEFVAL          { 0 }
551    ::= { dsgIfDownstreamEntry 2 }
552
553dsgIfDownChannelListIndex OBJECT-TYPE
554    SYNTAX          Unsigned32
555    MAX-ACCESS      read-write
556    STATUS          current
557    DESCRIPTION
558        "The index of a the downstream frequency channel lists,
559        dsgIfChannelListIndex in the dsgIfChannelListTable
560        providing the list of downstream frequencies that
561        contain DSG tunnels."
562    DEFVAL          { 0 }
563    ::= { dsgIfDownstreamEntry 3 }
564
565dsgIfDownEnableDCD OBJECT-TYPE
566    SYNTAX          TruthValue
567    MAX-ACCESS      read-write
568    STATUS          current
569    DESCRIPTION
570        "Used to enable or disable DCD messages to be sent on this
571        downstream channel. The value is always true(1) for those
572        downstreams that contains one or many DSG Tunnels."
573    ::= { dsgIfDownstreamEntry 4 }
574
575
576-- ---------------------------------------------------------------------
577-- The Client Table contains the objects specifies the matching
578-- parameters for the DSG clients for which the DSG rules applies.
579-- The DSG clients recognized that ids may be originated from different
580-- address space. The same DSG client id may be used by multiple rules.
581-- ---------------------------------------------------------------------
582
583dsgIfClientIdTable OBJECT-TYPE
584    SYNTAX          SEQUENCE OF DsgIfClientIdEntry
585    MAX-ACCESS      not-accessible
586    STATUS          current
587    DESCRIPTION
588        "The Client Identification Table contains the client
589        identification type and value. It also contains the
590        vendor specific parameter identification. There could
591        be multiple client ids associated to a tunnel, grouped
592        by the dsgIfClientIdListIndex."
593    ::= { dsgIfDCD 1 }
594
595dsgIfClientIdEntry OBJECT-TYPE
596    SYNTAX          DsgIfClientIdEntry
597    MAX-ACCESS      not-accessible
598    STATUS          current
599    DESCRIPTION
600        "An entry in the Client Id Table. Rows are created
601        by an SNMP SET request setting the value of
602        dsgIfClientRowStatus to 'createAndGo'.
603        Rows are deleted by an SNMP SET request setting the
604        value of dsgIfClientIdRowStatus to 'destroy'."
605    INDEX           {
606                        dsgIfClientIdListIndex,
607                        dsgIfClientIdIndex
608                    }
609    ::= { dsgIfClientIdTable 1 }
610
611DsgIfClientIdEntry ::= SEQUENCE {
612        dsgIfClientIdListIndex   Unsigned32,
613        dsgIfClientIdIndex       Unsigned32,
614        dsgIfClientIdType        INTEGER,
615        dsgIfClientIdValue       OCTET STRING,
616        dsgIfClientVendorParamId Unsigned32,
617        dsgIfClientRowStatus     RowStatus
618}
619
620dsgIfClientIdListIndex OBJECT-TYPE
621    SYNTAX          Unsigned32
622    MAX-ACCESS      not-accessible
623    STATUS          current
624    DESCRIPTION
625        "The index to this table."
626    ::= { dsgIfClientIdEntry 1 }
627
628dsgIfClientIdIndex OBJECT-TYPE
629    SYNTAX          Unsigned32
630    MAX-ACCESS      not-accessible
631    STATUS          current
632    DESCRIPTION
633        "The index to each entry of the Client Id."
634    ::= { dsgIfClientIdEntry 2 }
635
636dsgIfClientIdType OBJECT-TYPE
637    SYNTAX          INTEGER  {
638                        broadcast(1),
639                        macAddress(2),
640                        caSystemId(3),
641                        applicationId(4)
642                    }
643    MAX-ACCESS      read-create
644    STATUS          current
645    DESCRIPTION
646        "The Client Identification type. A DSG client id of type
647        broadcast(1) received by all DSG client(s). A DSG client
648        id of type macAddress(2) is received by the DSG client that
649        has been assigned with this MAC address where the first 3
650        bytes is the Organization Unique Identifier (OUI). A DSG
651        client id of type caSystemId(3) is received by the DSG
652        client that has been assigned a CA_system_ID. A DSG client
653        id of type applicationId(4) is received by the DSG client
654        that has been assigned an application ID."
655    DEFVAL          { broadcast }
656    ::= { dsgIfClientIdEntry 3 }
657
658dsgIfClientIdValue OBJECT-TYPE
659    SYNTAX          OCTET STRING (SIZE  (6))
660    MAX-ACCESS      read-create
661    STATUS          current
662    DESCRIPTION
663        "The Client Identification Value. The content depends on
664        the value of the dsgIfClientIdType. The dsgIfClientIdType
665        of a type broadcast(1), the value is empty string. The type
666        of macAddress(2), the value represents the well known MAC
667        address. The type of caSystemId(3) the value represents the
668        CA System Id. The type of applicationId(4) the value
669        represents the application Id."
670    DEFVAL          { '000000000000'H }
671    ::= { dsgIfClientIdEntry 4 }
672
673dsgIfClientVendorParamId OBJECT-TYPE
674    SYNTAX          Unsigned32
675    MAX-ACCESS      read-create
676    STATUS          current
677    DESCRIPTION
678        "The index of the vendor parameter id, dsgIfVendorParamId
679        in the dsgIfVendorParamTable describing the vendor specific
680        DSG parameters. If no associated entry in
681        dsgIfVendorParamTable exists, this value is 0."
682    DEFVAL          { 0 }
683    ::= { dsgIfClientIdEntry 5 }
684
685dsgIfClientRowStatus OBJECT-TYPE
686    SYNTAX          RowStatus
687    MAX-ACCESS      read-create
688    STATUS          current
689    DESCRIPTION
690        "The status of the row."
691    ::= { dsgIfClientIdEntry 6 }
692
693
694-- ---------------------------------------------------------------------
695-- The Vendor Parameter Table contains vendor specific parameters
696-- which allows vendors to send the specific parameters within a
697-- DSG rule or within the DSG Configuration block in a DCD message.
698-- ---------------------------------------------------------------------
699
700dsgIfVendorParamTable OBJECT-TYPE
701    SYNTAX          SEQUENCE OF DsgIfVendorParamEntry
702    MAX-ACCESS      not-accessible
703    STATUS          current
704    DESCRIPTION
705        "The DSG Vendor Parameter Table allows vendors to send
706        specific parameters to the DSG clients within a DSG
707        rule or within the DSG Configuration block in a
708        DCD message."
709    ::= { dsgIfDCD 2 }
710
711dsgIfVendorParamEntry OBJECT-TYPE
712    SYNTAX          DsgIfVendorParamEntry
713    MAX-ACCESS      not-accessible
714    STATUS          current
715    DESCRIPTION
716        "An entry in the DSG Vendor Parameter Table. Rows are
717        created by an SNMP SET request setting the value of
718        dsgIfVendorRowStatus to 'createAndGo'. Each entry
719        represents one or more vendor??s specific parameters.
720        Rows are deleted by an SNMP SET request setting the
721        value of dsgIfVendorRowStatus to 'destroy'.
722        There are limits to the amount of vendor specific
723        information that can be carried in a DSG Rule or
724        DSG Configuration block. An SNMP SET request which
725        would result in these limits being exceeded should be
726        rejected."
727    INDEX           {
728                        dsgIfVendorParamId,
729                        dsgIfVendorIndex
730                    }
731    ::= { dsgIfVendorParamTable 1 }
732
733DsgIfVendorParamEntry ::= SEQUENCE {
734        dsgIfVendorParamId   Unsigned32,
735        dsgIfVendorIndex     Unsigned32,
736        dsgIfVendorOUI       OCTET STRING,
737        dsgIfVendorValue     OCTET STRING,
738        dsgIfVendorRowStatus RowStatus
739}
740
741dsgIfVendorParamId OBJECT-TYPE
742    SYNTAX          Unsigned32
743    MAX-ACCESS      not-accessible
744    STATUS          current
745    DESCRIPTION
746        "The index of the table."
747    ::= { dsgIfVendorParamEntry 1 }
748
749dsgIfVendorIndex OBJECT-TYPE
750    SYNTAX          Unsigned32
751    MAX-ACCESS      not-accessible
752    STATUS          current
753    DESCRIPTION
754        "The Vendor Specific Index."
755    ::= { dsgIfVendorParamEntry 2 }
756
757dsgIfVendorOUI OBJECT-TYPE
758    SYNTAX          OCTET STRING (SIZE  (3))
759    MAX-ACCESS      read-create
760    STATUS          current
761    DESCRIPTION
762        "The Vendor assigned Organization Unique Id (OUI)."
763    DEFVAL          { '000000'H }
764    ::= { dsgIfVendorParamEntry 3 }
765
766dsgIfVendorValue OBJECT-TYPE
767    SYNTAX          OCTET STRING (SIZE  (0..50))
768    MAX-ACCESS      read-create
769    STATUS          current
770    DESCRIPTION
771        "The Vendor Specific Parameter Value."
772    DEFVAL          { "" }
773    ::= { dsgIfVendorParamEntry 4 }
774
775dsgIfVendorRowStatus OBJECT-TYPE
776    SYNTAX          RowStatus
777    MAX-ACCESS      read-create
778    STATUS          current
779    DESCRIPTION
780        "The status of the row."
781    ::= { dsgIfVendorParamEntry 5 }
782
783
784-- ---------------------------------------------------------------------
785-- The Channel List Table contains lists of one or multiple
786-- downstream frequencies that are carrying DSG tunnels. The
787-- appropriate DSG Channel List will be included in the DCD
788-- message on the associated downstream channel from the
789-- dsgIfDownstreamTable.
790-- The DSG Client uses this list to determine which downstream
791-- frequencies have DSG Tunnels present.
792-- ---------------------------------------------------------------------
793
794dsgIfChannelListTable OBJECT-TYPE
795    SYNTAX          SEQUENCE OF DsgIfChannelListEntry
796    MAX-ACCESS      not-accessible
797    STATUS          current
798    DESCRIPTION
799        "The DSG Channel List Table contains list of one or
800        multiple downstream frequencies that are carrying DSG
801        tunnel(s)."
802    ::= { dsgIfDCD 3 }
803
804dsgIfChannelListEntry OBJECT-TYPE
805    SYNTAX          DsgIfChannelListEntry
806    MAX-ACCESS      not-accessible
807    STATUS          current
808    DESCRIPTION
809        "An entry in the DSG Channel List Table. Rows are
810        created by an SNMP SET request setting the value of
811        dsgIfChannelRowStatus to 'createAndGo'.
812        Rows are deleted by an SNMP SET request setting the value
813        of dsgIfChannelRowStatus to 'destroy'."
814    INDEX           {
815                        dsgIfChannelListIndex,
816                        dsgIfChannelIndex
817                    }
818    ::= { dsgIfChannelListTable 1 }
819
820DsgIfChannelListEntry ::= SEQUENCE {
821        dsgIfChannelListIndex Unsigned32,
822        dsgIfChannelIndex     Unsigned32,
823        dsgIfChannelDsFreq    Integer32,
824        dsgIfChannelRowStatus RowStatus
825}
826
827dsgIfChannelListIndex OBJECT-TYPE
828    SYNTAX          Unsigned32
829    MAX-ACCESS      not-accessible
830    STATUS          current
831    DESCRIPTION
832        "The index to this table."
833    ::= { dsgIfChannelListEntry 1 }
834
835dsgIfChannelIndex OBJECT-TYPE
836    SYNTAX          Unsigned32
837    MAX-ACCESS      not-accessible
838    STATUS          current
839    DESCRIPTION
840        "The index for each downstream frequency that
841        contains the DSG tunnel(s)."
842    ::= { dsgIfChannelListEntry 2 }
843
844dsgIfChannelDsFreq OBJECT-TYPE
845    SYNTAX          Integer32 (0..1000000000)
846    UNITS           "hertz"
847    MAX-ACCESS      read-create
848    STATUS          current
849    DESCRIPTION
850        "The DOCSIS downstream center frequency. The receive
851        frequency MUST be a multiple of 62500Hz."
852    DEFVAL          { 0 }
853    ::= { dsgIfChannelListEntry 3 }
854
855dsgIfChannelRowStatus OBJECT-TYPE
856    SYNTAX          RowStatus
857    MAX-ACCESS      read-create
858    STATUS          current
859    DESCRIPTION
860        "The status of the row."
861    ::= { dsgIfChannelListEntry 4 }
862
863
864-- ---------------------------------------------------------------------
865-- The Timer Table contains 4 timeout timers that are sent to the DSG
866-- clients via the DCD message. These timers are sent to the DSG clients
867-- via the DCD message.
868-- Each downstream mapped to only one set of timers.
869-- ---------------------------------------------------------------------
870
871dsgIfTimerTable OBJECT-TYPE
872    SYNTAX          SEQUENCE OF DsgIfTimerEntry
873    MAX-ACCESS      not-accessible
874    STATUS          current
875    DESCRIPTION
876        "The DSG Timer Table contains timers that are sent to
877        the DSG client(s) via the DCD message."
878    ::= { dsgIfDCD 4 }
879
880dsgIfTimerEntry OBJECT-TYPE
881    SYNTAX          DsgIfTimerEntry
882    MAX-ACCESS      not-accessible
883    STATUS          current
884    DESCRIPTION
885        "An entry in the DSG Timer Table. Rows are created
886        by an SNMP SET request setting the value of
887        dsgIfTimerRowStatus to 'createAndGo'.
888        Rows are deleted by an SNMP SET request setting the value
889        of dsgIfTimerRowStatus to 'destroy'."
890    INDEX           { dsgIfTimerIndex }
891    ::= { dsgIfTimerTable 1 }
892
893DsgIfTimerEntry ::= SEQUENCE {
894        dsgIfTimerIndex     Unsigned32,
895        dsgIfTimerTdsg1     Unsigned32,
896        dsgIfTimerTdsg2     Unsigned32,
897        dsgIfTimerTdsg3     Unsigned32,
898        dsgIfTimerTdsg4     Unsigned32,
899        dsgIfTimerRowStatus RowStatus
900}
901
902dsgIfTimerIndex OBJECT-TYPE
903    SYNTAX          Unsigned32
904    MAX-ACCESS      not-accessible
905    STATUS          current
906    DESCRIPTION
907        "The index to this table."
908    ::= { dsgIfTimerEntry 1 }
909
910dsgIfTimerTdsg1 OBJECT-TYPE
911    SYNTAX          Unsigned32 (1..65535)
912    UNITS           "second"
913    MAX-ACCESS      read-create
914    STATUS          current
915    DESCRIPTION
916        "Initialization Timeout. This is the timeout period
917        for the DSG packets during initialization of the DSG
918        client. The default value is 2 seconds."
919    DEFVAL          { 2 }
920    ::= { dsgIfTimerEntry 2 }
921
922dsgIfTimerTdsg2 OBJECT-TYPE
923    SYNTAX          Unsigned32 (1..65535)
924    UNITS           "second"
925    MAX-ACCESS      read-create
926    STATUS          current
927    DESCRIPTION
928        "Operational Timeout. This is the timeout period for
929        the DSG packets during normal operation of the DSG client.
930        Default value is 10 minutes."
931    DEFVAL          { 600 }
932    ::= { dsgIfTimerEntry 3 }
933
934dsgIfTimerTdsg3 OBJECT-TYPE
935    SYNTAX          Unsigned32 (0..65535)
936    UNITS           "second"
937    MAX-ACCESS      read-create
938    STATUS          current
939    DESCRIPTION
940        "Two-way retry timer. This is the retry timer that
941        determines when the DSG client attempts to reconnect
942        with the DSG Agent and established two-way connectivity.
943        Default value is 5 minutes. The value 0 indicates that
944        the client will continuously retry two-way operation."
945    DEFVAL          { 300 }
946    ::= { dsgIfTimerEntry 4 }
947
948dsgIfTimerTdsg4 OBJECT-TYPE
949    SYNTAX          Unsigned32 (0..65535)
950    UNITS           "second"
951    MAX-ACCESS      read-create
952    STATUS          current
953    DESCRIPTION
954        "One-way retry timer. The retry timer that determines
955        when the client attempts to rescan for a DOCSIS
956        downstream channel that contains DSG packets after a
957        dsgIfTimerTdsg1 or dsgIfTimerTdsg2 timeout.
958        Default value is 30 minutes. The value 0 indicates that
959        the client will immediately begin scanning upon
960        dsgIfTimerTdsg1 or dsgIfTimerTdsg2 timeout."
961    DEFVAL          { 1800 }
962    ::= { dsgIfTimerEntry 5 }
963
964dsgIfTimerRowStatus OBJECT-TYPE
965    SYNTAX          RowStatus
966    MAX-ACCESS      read-create
967    STATUS          current
968    DESCRIPTION
969        "The status of the row."
970    ::= { dsgIfTimerEntry 6 }
971
972
973-- Conformance definitions
974
975dsgIfConformance  OBJECT IDENTIFIER
976    ::= { dsgIfMIB 4 }
977
978dsgIfGroups  OBJECT IDENTIFIER
979    ::= { dsgIfConformance 1 }
980
981dsgIfCompliances  OBJECT IDENTIFIER
982    ::= { dsgIfConformance 2 }
983
984
985dsgIfBasicCompliance MODULE-COMPLIANCE
986    STATUS          current
987    DESCRIPTION
988        "The compliance statement for DOCSIS Set-top Gateway
989        systems."
990    MODULE          -- this module
991    GROUP           dsgIfClassifierGroup
992    DESCRIPTION
993        "Mandatory in DOCSIS Set-top Gateway systems."
994
995    GROUP           dsgIfBaseGroup
996    DESCRIPTION
997        "Mandatory in DOCSIS Set-top Gateway systems."
998
999    GROUP           dsgIfDCDGroup
1000    DESCRIPTION
1001        "Mandatory in DOCSIS Set-top Gateway systems."
1002    ::= { dsgIfCompliances 1 }
1003
1004dsgIfClassifierGroup OBJECT-GROUP
1005    OBJECTS         {
1006                        dsgIfClassPriority,
1007                        dsgIfClassSrcIpAddrType,
1008                        dsgIfClassSrcIpAddr,
1009                        dsgIfClassSrcIpPrefixLength,
1010                        dsgIfClassDestIpAddressType,
1011                        dsgIfClassDestIpAddress,
1012                        dsgIfClassDestPortStart,
1013                        dsgIfClassDestPortEnd,
1014                        dsgIfClassRowStatus,
1015                        dsgIfClassIncludeInDCD
1016                    }
1017    STATUS          current
1018    DESCRIPTION
1019        "A collection of objects providing the classifier
1020        configuration."
1021    ::= { dsgIfGroups 1 }
1022
1023dsgIfBaseGroup OBJECT-GROUP
1024    OBJECTS         {
1025                        dsgIfTunnelGroupIndex,
1026                        dsgIfTunnelClientIdListIndex,
1027                        dsgIfTunnelMacAddress,
1028                        dsgIfTunnelServiceClassName,
1029                        dsgIfTunnelRowStatus,
1030                        dsgIfTunnelGrpDsIfIndex,
1031                        dsgIfTunnelGrpRulePriority,
1032                        dsgIfTunnelGrpUcidList,
1033                        dsgIfTunnelGrpVendorParamId,
1034                        dsgIfTunnelGrpRowStatus,
1035                        dsgIfDownTimerIndex,
1036                        dsgIfDownVendorParamId,
1037                        dsgIfDownChannelListIndex,
1038                        dsgIfDownEnableDCD
1039                    }
1040    STATUS          current
1041    DESCRIPTION
1042        "A collection of objects providing DSG Tunnel and Channel
1043        configuration."
1044    ::= { dsgIfGroups 2 }
1045
1046dsgIfDCDGroup OBJECT-GROUP
1047    OBJECTS         {
1048                        dsgIfClientIdType,
1049                        dsgIfClientIdValue,
1050                        dsgIfClientVendorParamId,
1051                        dsgIfClientRowStatus,
1052                        dsgIfVendorOUI,
1053                        dsgIfVendorValue,
1054                        dsgIfVendorRowStatus,
1055                        dsgIfChannelDsFreq,
1056                        dsgIfChannelRowStatus,
1057                        dsgIfTimerTdsg1,
1058                        dsgIfTimerTdsg2,
1059                        dsgIfTimerTdsg3,
1060                        dsgIfTimerTdsg4,
1061                        dsgIfTimerRowStatus
1062                    }
1063    STATUS          current
1064    DESCRIPTION
1065        "A collection of objects providing Timers configuration."
1066    ::= { dsgIfGroups 3 }
1067
1068END
1069