-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathDOCS-IF-MIB
5255 lines (4861 loc) · 218 KB
/
DOCS-IF-MIB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
DOCS-IF-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
Unsigned32,
Integer32,
Counter32,
Counter64,
TimeTicks,
IpAddress,
transmission
FROM SNMPv2-SMI -- [RFC2578]
TEXTUAL-CONVENTION,
MacAddress,
RowStatus,
TruthValue,
TimeInterval,
TimeStamp,
StorageType
FROM SNMPv2-TC -- [RFC2579]
OBJECT-GROUP,
MODULE-COMPLIANCE
FROM SNMPv2-CONF -- [RFC2580]
ifIndex, InterfaceIndexOrZero
FROM IF-MIB -- [RFC2863]
InetAddressType,
InetAddress
FROM INET-ADDRESS-MIB -- [RFC4001]
IANAifType
FROM IANAifType-MIB; -- [IANA]
docsIfMib MODULE-IDENTITY
LAST-UPDATED "200605240000Z" -- May 24, 2006
ORGANIZATION "IETF IPCDN Working Group"
CONTACT-INFO
" David Raftus
Postal: ATI Technologies Inc.
340 Terry Fox Drive, Suite 202
Ottawa Ontario
Canada
Phone: +1 613 592 1052 ext.222
E-mail: [email protected]
Eduardo Cardona
Postal: Cable Television Laboratories, Inc.
858 Coal Creek Circle
Louisville, CO 80027-9750
U.S.A.
Phone: Tel: +1 303 661 9100
Fax: +1 303 661 9199
E-mail: [email protected];[email protected]
IETF IPCDN Working Group
General Discussion: [email protected]
Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn
Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn
Co-chairs: Richard Woundy, [email protected]
Jean-Francois Mule, [email protected]"
DESCRIPTION
"This is the MIB Module for DOCSIS 2.0-compliant Radio
Frequency (RF) interfaces in Cable Modems and
Cable Modem Termination Systems.
Copyright (C) The Internet Society (2006). This
version of this MIB module is part of RFC 4546; see
the RFC itself for full legal notices."
REVISION "200605240000Z"
DESCRIPTION
"Revision of the IETF RF MIB module for DOCSIS 2.0.
This version published as RFC 4546.
This MIB module revision includes the following
among others:
Usage of ifType (205) for upstream logical channels.
Addition of downstream and upstream utilization
counters.
Additional statistics per upstream interface.
Upstream channel offline configuration mechanism.
Added MIB support for new DOCSIS 2.0 modulation
attributes.
Euro-DOCSIS downstream interleave values.
Adjustments to RFC 2670 definitions based on
the MIB review guidelines from the IETF
Operations and Management Area (OPS)."
REVISION "199908190000Z"
DESCRIPTION
"Initial version, published as RFC 2670.
Modified by Mike St. Johns to fix problems identified by
the first pass of the MIB doctor. Of special note,
docsIfRangingResp and docsIfCmtsInsertionInterval were
obsoleted and replaced by other objects with the same
functionality, but with more appropriate syntax."
::= { transmission 127 }
-- Textual Conventions
TenthdBmV ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d-1"
STATUS current
DESCRIPTION
"This data type represents power levels that are normally
expressed in dBmV. Units are in tenths of a dBmV;
for example, 5.1 dBmV will be represented as 51."
SYNTAX Integer32
TenthdB ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d-1"
STATUS current
DESCRIPTION
"This data type represents power levels that are normally
expressed in dB. Units are in tenths of a dB;
for example, 5.1 dB will be represented as 51."
SYNTAX Integer32
DocsisVersion ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Indicates the DOCSIS Radio Frequency specification being
referenced.
'docsis10' indicates DOCSIS 1.0.
'docsis11' indicates DOCSIS 1.1.
'docsis20' indicates DOCSIS 2.0."
SYNTAX INTEGER {
docsis10 (1),
docsis11 (2),
docsis20 (3)
}
DocsisQosVersion ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Indicates the referenced quality-of-service
level.
'docsis10 refers to DOCSIS 1.0 Class of
Service queuing services, and 'docsis11' refers
to DOCSIS 1.1 Quality of Service."
SYNTAX INTEGER {
docsis10 (1),
docsis11 (2)
}
DocsisUpstreamType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Indicates the DOCSIS Upstream Channel Type.
'unknown' means information not available.
'tdma' is related to TDMA, Time Division
Multiple Access; 'atdma' is related to A-TDMA,
Advanced Time Division Multiple Access,
'scdma' is related to S-CDMA, Synchronous
Code Division Multiple Access.
'tdmaAndAtdma is related to simultaneous support of
TDMA and A-TDMA modes."
SYNTAX INTEGER {
unknown(0),
tdma(1),
atdma(2),
scdma(3),
tdmaAndAtdma(4)
}
DocsEqualizerData ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This data type represents the equalizer data
as measured at the receiver interface.
The format of the equalizer follows the structure of the
Transmit Equalization Adjust RNG-RSP TLV of DOCSIS RFI
v2.0 :
1 byte Main tap location 1..(n + m)
1 byte Number of forward taps per symbol
1 byte Number of forward taps: n
1 byte Number of reverse taps: m
Following are the equalizer coefficients:
First, forward taps coefficients:
2 bytes F1 (real), 2 bytes F1 (imag)
...
2 bytes Fn (real), 2 bytes Fn (imag)
Then, reverse taps coefficients:
2 bytes D1 (real), 2 bytes D1 (imag)
...
2 bytes Dm (real), 2 bytes Dm (imag)
The equalizer coefficients are considered signed 16-bit
integers in the range from -32768 (0x8000) to 32767
(0x7FFF).
DOCSIS specifications require up to a maximum of
64 equalizer taps (n + m); therefore, this object size
can get up 260 bytes (4 + 4x64).
The minimum object size (other than zero) for a t-spaced
tap with a minimum of 8 symbols will be 36 (4 + 4x8)."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Figure 8-23."
SYNTAX OCTET STRING(SIZE (0 | 36..260))
docsIfMibObjects OBJECT IDENTIFIER ::= { docsIfMib 1 }
docsIfBaseObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 1 }
docsIfCmObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 2 }
docsIfCmtsObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 3 }
--
-- BASE GROUP
--
--
-- The following table is implemented on both the Cable Modem
-- and the Cable Modem Termination System. This table is
-- read only for the CM.
--
docsIfDownstreamChannelTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIfDownstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table describes the attributes of downstream
channels (frequency bands)."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Tables 6-16, and 6-17."
::= { docsIfBaseObjects 1 }
docsIfDownstreamChannelEntry OBJECT-TYPE
SYNTAX DocsIfDownstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry provides a list of attributes for a single
downstream channel.
An entry in this table exists for each ifEntry with an
ifType of docsCableDownstream(128)."
INDEX { ifIndex }
::= { docsIfDownstreamChannelTable 1 }
DocsIfDownstreamChannelEntry ::= SEQUENCE {
docsIfDownChannelId Integer32,
docsIfDownChannelFrequency Integer32,
docsIfDownChannelWidth Integer32,
docsIfDownChannelModulation INTEGER,
docsIfDownChannelInterleave INTEGER,
docsIfDownChannelPower TenthdBmV,
docsIfDownChannelAnnex INTEGER,
docsIfDownChannelStorageType StorageType
}
docsIfDownChannelId OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Cable Modem Termination System identification of the
downstream channel within this particular MAC interface.
if the interface is down, the object returns the most
current value. If the downstream channel ID is unknown,
this object returns a value of 0."
::= { docsIfDownstreamChannelEntry 1 }
docsIfDownChannelFrequency OBJECT-TYPE
SYNTAX Integer32 (0..1000000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The center of the downstream frequency associated with
this channel. This object will return the current tuner
frequency. If a CMTS provides IF output, this object
will return 0, unless this CMTS is in control of the
final downstream frequency. See the associated
compliance object for a description of valid frequencies
that may be written to this object."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 6.3.3."
::= { docsIfDownstreamChannelEntry 2 }
docsIfDownChannelWidth OBJECT-TYPE
SYNTAX Integer32 (0..16000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The bandwidth of this downstream channel. Most
implementations are expected to support a channel width
of 6 MHz (North America) and/or 8 MHz (Europe). See the
associated compliance object for a description of the
valid channel widths for this object."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Table 6-17."
::= { docsIfDownstreamChannelEntry 3 }
docsIfDownChannelModulation OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
other(2),
qam64(3),
qam256(4)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The modulation type associated with this downstream
channel. If the interface is down, this object either
returns the configured value (CMTS), the most current
value (CM), or the value of unknown(1). See the
associated conformance object for write conditions and
limitations. See the reference for specifics on the
modulation profiles implied by qam64 and qam256."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Table 6-17."
::= { docsIfDownstreamChannelEntry 4 }
docsIfDownChannelInterleave OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
other(2),
taps8Increment16(3),
taps16Increment8(4),
taps32Increment4(5),
taps64Increment2(6),
taps128Increment1(7),
taps12increment17(8)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The Forward Error Correction (FEC) interleaving used
for this downstream channel.
Values are defined as follows:
taps8Increment16(3): protection 5.9/4.1 usec,
latency .22/.15 msec
taps16Increment8(4): protection 12/8.2 usec,
latency .48/.33 msec
taps32Increment4(5): protection 24/16 usec,
latency .98/.68 msec
taps64Increment2(6): protection 47/33 usec,
latency 2/1.4 msec
taps128Increment1(7): protection 95/66 usec,
latency 4/2.8 msec
taps12increment17(8): protection 18/14 usec,
latency 0.43/0.32 msec
The value 'taps12increment17' is supported by EuroDOCSIS
cable systems only, and the others by DOCSIS cable systems.
If the interface is down, this object either returns
the configured value (CMTS), the most current value (CM),
or the value of unknown(1).
The value of other(2) is returned if the interleave
is known but not defined in the above list.
See the associated conformance object for write
conditions and limitations. See the reference for the FEC
configuration described by the setting of this object."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Table 6-15."
::= { docsIfDownstreamChannelEntry 5 }
docsIfDownChannelPower OBJECT-TYPE
SYNTAX TenthdBmV
UNITS "dBmV"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"At the CMTS, the operational transmit power. At the CM,
the received power level.
If the interface is down, this object either returns
the configured value (CMTS), the most current value (CM)
or the value of 0. See the associated conformance object
for write conditions and limitations. See the reference
for recommended and required power levels."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Tables 6-16, 6-17."
::= { docsIfDownstreamChannelEntry 6 }
docsIfDownChannelAnnex OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
other(2),
annexA(3),
annexB(4),
annexC(5)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of this object indicates the conformance of
the implementation to important regional cable standards.
annexA : Annex A from ITU-T J.83 is used.
(equivalent to EN 300 429)
annexB : Annex B from ITU-T J.83 is used.
annexC : Annex C from ITU-T J.83 is used."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Sections 6.3.1, and H.3.1."
::= { docsIfDownstreamChannelEntry 7 }
docsIfDownChannelStorageType OBJECT-TYPE
SYNTAX StorageType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The storage type for this conceptual row.
Entries with this object set to permanent(4)
do not require write operations for read-write
objects."
::= { docsIfDownstreamChannelEntry 8 }
--
-- The following table is implemented on both the CM and the CMTS.
-- For the CM, only attached channels appear in the table. For the
-- CM, this table is read-only as well.
--
docsIfUpstreamChannelTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIfUpstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table describes the attributes of attached upstream
channels."
::= { docsIfBaseObjects 2 }
docsIfUpstreamChannelEntry OBJECT-TYPE
SYNTAX DocsIfUpstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"List of attributes for a single upstream channel. For
DOCSIS 2.0 CMTSs, an entry in this table exists for
each ifEntry with an ifType of docsCableUpstreamChannel
(205).
For DOCSIS 1.x CM/CMTSs and DOCSIS 2.0 CMs, an entry in
this table exists for each ifEntry with an ifType of
docsCableUpstream (129).
For DOCSIS 2.0 CMTSs, two classes of interfaces can be
defined for this table:
o Upstream Physical Interfaces: The traditional DOCSIS
1.x CMTS upstream interface ifType 129 and the DOCSIS
2.0 ifType 205 that are functional. In other words,
interfaces that represent upstream receivers within
an RF MAC interface.
Entries of physical interfaces are exposed to the
management interface with their corresponding
ifStack hierarchy and are not administratively
created by this table.
o Upstream Temporary Interfaces: A fictitious
interface created for the purpose of manipulating
physical interface parameters offline, then
validating prior to updating the target physical
interface.
In case of a reinitialization of the managed system,
physical interfaces values persist while the temporary
interfaces are not recreated.
This mechanism helps to minimize service disruptions
originating in situations where a group of interface
parameter values need to be consistent with each other
in SET operations. A temporary buffer
(temporary interface) is provided to allow the CMTS
to validate the parameters offline."
INDEX { ifIndex }
::= { docsIfUpstreamChannelTable 1 }
DocsIfUpstreamChannelEntry ::= SEQUENCE {
docsIfUpChannelId Integer32,
docsIfUpChannelFrequency Integer32,
docsIfUpChannelWidth Integer32,
docsIfUpChannelModulationProfile Unsigned32,
docsIfUpChannelSlotSize Unsigned32,
docsIfUpChannelTxTimingOffset Unsigned32,
docsIfUpChannelRangingBackoffStart Integer32,
docsIfUpChannelRangingBackoffEnd Integer32,
docsIfUpChannelTxBackoffStart Integer32,
docsIfUpChannelTxBackoffEnd Integer32,
docsIfUpChannelScdmaActiveCodes Unsigned32,
docsIfUpChannelScdmaCodesPerSlot Integer32,
docsIfUpChannelScdmaFrameSize Unsigned32,
docsIfUpChannelScdmaHoppingSeed Unsigned32,
docsIfUpChannelType DocsisUpstreamType,
docsIfUpChannelCloneFrom InterfaceIndexOrZero,
docsIfUpChannelUpdate TruthValue,
docsIfUpChannelStatus RowStatus,
docsIfUpChannelPreEqEnable TruthValue
}
docsIfUpChannelId OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The CMTS identification of the upstream channel."
::= { docsIfUpstreamChannelEntry 1 }
docsIfUpChannelFrequency OBJECT-TYPE
SYNTAX Integer32 (0..1000000000)
UNITS "hertz"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The center of the frequency band associated with this
upstream interface. This object returns 0 if the frequency
is undefined or unknown. Minimum permitted upstream
frequency is 5,000,000 Hz for current technology. See
the associated conformance object for write conditions
and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Table 4-2."
::= { docsIfUpstreamChannelEntry 2 }
docsIfUpChannelWidth OBJECT-TYPE
SYNTAX Integer32 (0..64000000)
UNITS "hertz"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The bandwidth of this upstream interface. This object
returns 0 if the interface width is undefined or unknown.
Minimum permitted interface width is currently 200,000 Hz.
See the associated conformance object for write conditions
and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Table 6-5."
::= { docsIfUpstreamChannelEntry 3 }
docsIfUpChannelModulationProfile OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"An entry identical to the docsIfModIndex in the
docsIfCmtsModulationTable that describes this channel.
This channel is further instantiated there by a grouping
of interval usage codes (IUCs) that, together, fully
describe the channel modulation. This object returns 0 if
the docsIfCmtsModulationTable entry does not exist or is
empty. See the associated conformance object for write
conditions and limitations.
Setting this object returns an 'inconsistentValue'
error if the following conditions are not satisfied:
1. All the IUC entries in the selected modulation profile
MUST have the same value of docsIfCmtsModChannelType.
2. All of the Modulation parameters in the selected
modulation profile MUST be consistent with the other
parameters in this docsIfUpstreamChannelEntry."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Table 8-19."
::= { docsIfUpstreamChannelEntry 4 }
docsIfUpChannelSlotSize OBJECT-TYPE
SYNTAX Unsigned32
UNITS "ticks"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable to TDMA and ATDMA channel types only.
The number of 6.25 microsecond ticks in each upstream
mini-slot. Returns zero if the value is undefined or
unknown or in case of an SCDMA channel.
See the associated conformance object for write
conditions and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 8.1.2.4."
::= { docsIfUpstreamChannelEntry 5 }
docsIfUpChannelTxTimingOffset OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"At the CM, a measure of the current round trip time
obtained from the ranging offset (initial ranging offset +
ranging offset adjustments).
At the CMTS, the maximum of timing offset, among all the
CMs that are/were present on the channel, taking into
account all ( initial + periodic ) timing offset
corrections that were sent for each of the CMs. Generally,
these measurements are positive, but if the measurements
are negative, the value of this object is zero. Used for
timing of CM upstream transmissions to ensure synchronized
arrivals at the CMTS.
Units are one 64th fraction of 6.25 microseconds."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 6.2.19."
::= { docsIfUpstreamChannelEntry 6 }
docsIfUpChannelRangingBackoffStart OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The initial random backoff window to use when retrying
Ranging Requests. Expressed as a power of 2. A value of
16 at the CMTS indicates that a proprietary adaptive retry
mechanism is to be used. See the associated conformance
object for write conditions and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Sections 8.3.4, and 9.4."
::= { docsIfUpstreamChannelEntry 7 }
docsIfUpChannelRangingBackoffEnd OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The final random backoff window to use when retrying
Ranging Requests. Expressed as a power of 2. A value of
16 at the CMTS indicates that a proprietary adaptive retry
mechanism is to be used. See the associated conformance
object for write conditions and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 8.3.4, and 9.4."
::= { docsIfUpstreamChannelEntry 8 }
docsIfUpChannelTxBackoffStart OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The initial random backoff window to use when retrying
transmissions. Expressed as a power of 2. A value of 16
at the CMTS indicates that a proprietary adaptive retry
mechanism is to be used. See the associated conformance
object for write conditions and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 8.3.4, and 9.4."
::= { docsIfUpstreamChannelEntry 9 }
docsIfUpChannelTxBackoffEnd OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The final random backoff window to use when retrying
transmissions. Expressed as a power of 2. A value of 16
at the CMTS indicates that a proprietary adaptive retry
mechanism is to be used. See the associated conformance
object for write conditions and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 8.3.4, and 9.4."
::= { docsIfUpstreamChannelEntry 10 }
docsIfUpChannelScdmaActiveCodes OBJECT-TYPE
SYNTAX Unsigned32 (0|64..66|68..70|72|74..78|80..82|84..88
|90..96|98..100|102|104..106|108
|110..112|114..126|128)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable for SCDMA channel types only.
Number of active codes. Returns zero for
Non-SCDMA channel types. Note that legal
values from 64..128 MUST be non-prime."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 6.2.11.2.1."
::= { docsIfUpstreamChannelEntry 11 }
docsIfUpChannelScdmaCodesPerSlot OBJECT-TYPE
SYNTAX Integer32(0 | 2..32)
UNITS "codesperMinislots"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable for SCDMA channel types only.
The number of SCDMA codes per mini-slot.
Returns zero if the value is undefined or unknown or in
case of a TDMA or ATDMA channel."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 6.2.11.2.1."
::= { docsIfUpstreamChannelEntry 12 }
docsIfUpChannelScdmaFrameSize OBJECT-TYPE
SYNTAX Unsigned32 (0..32)
UNITS "spreadIntervals"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable for SCDMA channel types only.
SCDMA Frame size in units of spreading intervals.
This value returns zero for non-SCDMA Profiles."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 6.2.12."
::= { docsIfUpstreamChannelEntry 13 }
docsIfUpChannelScdmaHoppingSeed OBJECT-TYPE
SYNTAX Unsigned32 (0..32767)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable for SCDMA channel types only.
15-bit seed used for code hopping sequence initialization.
Returns zero for non-SCDMA channel types.
Setting this value to a value different than zero for
non-SCDMA channel types returns the error 'wrongValue'."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 6.2.14.1."
::= { docsIfUpstreamChannelEntry 14 }
docsIfUpChannelType OBJECT-TYPE
SYNTAX DocsisUpstreamType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Reflects the Upstream channel type.
This object returns the value of docsIfCmtsModChannelType
for the modulation profile selected in
docsIfUpChannelModulationProfile for this row."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Section 6.2.1."
::= { docsIfUpstreamChannelEntry 15 }
docsIfUpChannelCloneFrom OBJECT-TYPE
SYNTAX InterfaceIndexOrZero
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object contains the ifIndex value of the physical
interface row entry whose parameters are to be adjusted.
Upon setting this object to the ifIndex value of a
physical interface, the following interface objects values
are copied to this entry:
docsIfUpChannelFrequency,
docsIfUpChannelWidth,
docsIfUpChannelModulationProfile,
docsIfUpChannelSlotSize,
docsIfUpChannelRangingBackoffStart,
docsIfUpChannelRangingBackoffEnd,
docsIfUpChannelTxBackoffStart,
docsIfUpChannelTxBackoffEnd,
docsIfUpChannelScdmaActiveCodes,
docsIfUpChannelScdmaCodesPerSlot,
docsIfUpChannelScdmaFrameSize,
docsIfUpChannelScdmaHoppingSeed,
docsIfUpChannelType, and
docsIfUpChannelPreEqEnable
Setting this object to the value of a non-existent or
a temporary upstream interface returns the error
'wrongValue'.
This object MUST contain a value of zero for physical
interfaces entries.
Setting this object in row entries that correspond to
physical interfaces returns the error 'wrongValue'."
::= { docsIfUpstreamChannelEntry 16 }
docsIfUpChannelUpdate OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Used to perform the copy of adjusted parameters from the
temporary interface entry to the physical interface
indicated by the docsIfUpChannelCloneFrom object. The
transfer is initiated through an SNMP SET to 'true' of
this object.
A SET to 'true' fails and returns error 'commitFailed'
if docsIfUpChannelStatus value is 'notInService', which
means that the interface parameters values are not
compatible with each other or have not been validated yet.
Reading this object always returns 'false'."
::= { docsIfUpstreamChannelEntry 17 }
docsIfUpChannelStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object is only used for the creation of a temporary
upstream row with the purpose of updating the parameters
of a physical upstream channel entry.
The following restrictions apply to this object:
1. This object is not writable for physical interfaces.
2. Temporary interface entries are only created by a SET
of this object to createandWait(5).
3. ifAdminStatus from the Interface MIB RFC 2863 is used
to take a physical upstream channel offline, to be
consistent with DOCSIS 1.x operation, as indicated in
RFC 2670.
In addition,
o ifAdminStatus 'down' is reflected in this object
as 'notInService'.
o ifOperStatus 'down' while ifAdminStatus 'up' is
reflected in this object as 'notInservice'.
4. Temporary created rows MUST be set to 'active' with
the purpose of validating upstream parameter
consistency prior to transferring the parameters to the
physical interface.
Below is a mandatory procedure for adjusting the values
of a physical interface:
1. Create a temporary interface entry through an SNMP SET
using 'createAndWait'. At this point, the RowStatus
reports 'notReady'.
The Manager entity uses an ifIndex value outside the
operational range of the physical interfaces for the
creation of a temporary interface.
2. Set the docsIfUpChannelCloneFrom object to the ifIndex
value of the physical row to update. Now
docsIfUpChannelStatus reports 'notInService'.
3. Change the upstream parameters to the desired values
in the temporary row.
4. Validate that all parameters are consistent by setting
docsIfUpChannelStatus to 'active'. A failure to set the
RowStatus to 'active' returns the error 'commitFailed',
which means the parameters are not compatible with the
target physical interface.
5. With docsIfUpChannelStatus 'active', transfer the
parameters to the target physical interface by setting
the object docsIfUpChannelUpdate to 'true'.
6. Delete the temporary row by setting
docsIfUpChannelStatus to 'destroy'."
::= { docsIfUpstreamChannelEntry 18 }
docsIfUpChannelPreEqEnable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"At the CMTS, this object is used to enable or disable
pre-equalization on the upstream channel represented by
this table instance. At the CM, this object is read-only
and reflects the status of pre-equalization as represented
in the RNG-RSP. Pre-equalization is considered enabled at
the CM if a RNG-RSP with pre-equalization data has been
received at least once since the last mac
reinitialization."
DEFVAL {false}
::= { docsIfUpstreamChannelEntry 19 }
-- The following table describes the attributes of each class of
-- service. The entries in this table are referenced from the
-- docsIfServiceEntries. They exist as a separate table in order to
-- reduce redundant information in docsIfServiceTable.
--
-- This table is implemented at both the CM and the CMTS.
-- The CM need only maintain entries for the classes of service
-- referenced by its docsIfCmServiceTable.
--
docsIfQosProfileTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIfQosProfileEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Describes the attributes for each class of service."
::= { docsIfBaseObjects 3 }
docsIfQosProfileEntry OBJECT-TYPE
SYNTAX DocsIfQosProfileEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Describes the attributes for a single class of service.
If implemented as read-create in the Cable Modem
Termination System, creation of entries in this table is
controlled by the value of
docsIfCmtsQosProfilePermissions.
If implemented as read-only, entries are created based
on information in REG-REQ MAC messages received from
cable modems (for Cable Modem Termination System), or
based on information extracted from the TFTP option file
(for Cable Modem).
In the Cable Modem Termination System, read-only entries
are removed if no longer referenced by
docsIfCmtsServiceTable.
An entry in this table MUST not be removed while it is
referenced by an entry in docsIfCmServiceTable (Cable
Modem) or docsIfCmtsServiceTable (Cable Modem Termination
System).
An entry in this table SHOULD NOT be changeable while
it is referenced by an entry in docsIfCmtsServiceTable.
If this table is created automatically, there SHOULD only
be a single entry for each Class of Service. Multiple
entries with the same Class of Service parameters are NOT
RECOMMENDED."
INDEX { docsIfQosProfIndex }
::= { docsIfQosProfileTable 1 }
DocsIfQosProfileEntry ::= SEQUENCE {
docsIfQosProfIndex Integer32,
docsIfQosProfPriority Integer32,
docsIfQosProfMaxUpBandwidth Integer32,
docsIfQosProfGuarUpBandwidth Integer32,
docsIfQosProfMaxDownBandwidth Integer32,
docsIfQosProfMaxTxBurst Integer32, -- deprecated
docsIfQosProfBaselinePrivacy TruthValue,
docsIfQosProfStatus RowStatus,
docsIfQosProfMaxTransmitBurst Integer32,
docsIfQosProfStorageType StorageType
}
docsIfQosProfIndex OBJECT-TYPE
SYNTAX Integer32 (1..16383)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The index value that uniquely identifies an entry
in the docsIfQosProfileTable."
::= { docsIfQosProfileEntry 1 }
docsIfQosProfPriority OBJECT-TYPE
SYNTAX Integer32 (0..7)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"A relative priority assigned to this service when
allocating bandwidth. Zero indicates lowest priority
and seven indicates highest priority.
Interpretation of priority is device-specific.
MUST NOT be changed while this row is active."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Annex C.1.1.4."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 2 }
docsIfQosProfMaxUpBandwidth OBJECT-TYPE
SYNTAX Integer32 (0..100000000)
UNITS "bits per second"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The maximum upstream bandwidth, in bits per second,
allowed for a service with this service class.
Zero if there is no restriction of upstream bandwidth.
MUST NOT be changed while this row is active."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I10-051209,
Annex C.1.1.4."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 3 }
docsIfQosProfGuarUpBandwidth OBJECT-TYPE
SYNTAX Integer32 (0..100000000)
UNITS "bits per second"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Minimum guaranteed upstream bandwidth, in bits per second,
allowed for a service with this service class.
MUST NOT be changed while this row is active."
REFERENCE