-
Notifications
You must be signed in to change notification settings - Fork 124
/
Copy pathDOCS-SUBMGT3-MIB-V1SMI.my
1394 lines (1303 loc) · 52 KB
/
DOCS-SUBMGT3-MIB-V1SMI.my
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
-- MIB file created 04-Nov-2009 23:28:01, by
-- SMICng version 2.2.11-beta(PRO)(Solaris), January 20, 2001. Enterprise key cisco.com
DOCS-SUBMGT3-MIB DEFINITIONS ::= BEGIN
-- From file: "DOCS-SUBMGT3-MIB.my"
-- Compile options "4 7 F H N O W 03 06 0B 0G 0N 0T"
IMPORTS
RowStatus, TruthValue, TimeStamp, MacAddress
FROM SNMPv2-TC-v1
InetAddressType, InetAddress, InetAddressPrefixLength,
InetPortNumber
FROM INET-ADDRESS-MIB
docsIf3CmtsCmRegStatusId
FROM DOCS-IF3-MIB
SnmpTagList
FROM SNMP-TARGET-MIB
DocsL2vpnIfList
FROM DOCS-L2VPN-MIB
clabProjDocsis
FROM CLAB-DEF-MIB
Counter, Gauge
FROM RFC1155-SMI
OBJECT-TYPE
FROM RFC-1212;
docsSubmgt3Mib OBJECT IDENTIFIER ::= { clabProjDocsis 10 }
-- MODULE-IDENTITY
-- LastUpdated
-- 200705180000Z
-- OrgName
-- Cable Television Laboratories, Inc.
-- ContactInfo
--
-- Postal: Cable Television Laboratories, Inc.
-- 858 Coal Creek Circle
-- Louisville, Colorado 80027-9750
-- U.S.A.
-- Phone: +1 303-661-9100
-- Fax: +1 303-661-9199
-- E-mail: [email protected]
-- Descr
-- This MIB module contains the management objects for the
-- CMTS control of the IP4 and IPv6 traffic with origin and
-- destination to CMs and/or CPEs behind the CM.
-- RevDate
-- 200705180000Z
-- RevDescr
-- Revised Version includes ECNs
-- OSSIv3.0-N-07.0445-3
-- OSSIv3.0-N-07.0444-3
-- OSSIv3.0-N-07.0441-4
-- and published as I03
-- RevDate
-- 200612071700Z
-- RevDescr
-- Initial version, published as part of the CableLabs
-- OSSIv3.0 specification CM-SP-OSSIv3.0-I01-061207
-- Copyright 1999-2006 Cable Television Laboratories, Inc.
-- All rights reserved.
docsSubmgt3MibObjects OBJECT IDENTIFIER ::= { docsSubmgt3Mib 1 }
docsSubmgt3Base OBJECT IDENTIFIER ::= { docsSubmgt3MibObjects 1 }
docsSubmgt3MibConformance OBJECT IDENTIFIER ::= { docsSubmgt3Mib 2 }
docsSubmgt3MibCompliances OBJECT IDENTIFIER ::= { docsSubmgt3MibConformance 1 }
docsSubmgt3MibGroups OBJECT IDENTIFIER ::= { docsSubmgt3MibConformance 2 }
docsSubmgt3BaseCpeMaxIpv4Def OBJECT-TYPE
SYNTAX Gauge(0..1023)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the maximum number of IPv4
Addresses allowed for the CM's CPEs if not signaled in the
registration process."
DEFVAL { 16 }
::= { docsSubmgt3Base 1 }
docsSubmgt3BaseCpeMaxIpv6PrefixDef OBJECT-TYPE
SYNTAX Gauge(0..1023)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the maximum number of IPv6
prefixes allowed for the CM's CPEs if not signaled in
the registration process."
DEFVAL { 16 }
::= { docsSubmgt3Base 2 }
docsSubmgt3BaseCpeActiveDef OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for enabling
Subscriber Management filters and controls
in the CM if the parameter is not signaled in the DOCSIS
Registration process."
DEFVAL { false }
::= { docsSubmgt3Base 3 }
docsSubmgt3BaseCpeLearnableDef OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for enabling
the CPE learning process for the CM if the parameter
is not signaled in the DOCSIS Registration process."
DEFVAL { true }
::= { docsSubmgt3Base 4 }
docsSubmgt3BaseSubFilterDownDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
subscriber (CPE) downstream filter group for the
CM if the parameter is not signaled in the DOCSIS Registration
process."
DEFVAL { 0 }
::= { docsSubmgt3Base 5 }
docsSubmgt3BaseSubFilterUpDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
subscriber (CPE) upstream filter group for the CM
if the parameter is not signaled in the DOCSIS Registration
process."
DEFVAL { 0 }
::= { docsSubmgt3Base 6 }
docsSubmgt3BaseCmFilterDownDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
CM stack downstream filter group applying to the CM
if the parameter is not signaled in the DOCSIS Registration
process."
DEFVAL { 0 }
::= { docsSubmgt3Base 7 }
docsSubmgt3BaseCmFilterUpDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
CM stack upstream filter group applying to the CM if
the parameter is not signaled in the DOCSIS Registration
process."
DEFVAL { 0 }
::= { docsSubmgt3Base 8 }
docsSubmgt3BasePsFilterDownDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
PS or eRouter downstream filter group for the CM if
the parameter is not signaled in the DOCSIS Registration
process."
DEFVAL { 0 }
::= { docsSubmgt3Base 9 }
docsSubmgt3BasePsFilterUpDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
PS or eRouter upstream filter group for the CM if the
parameter is not signaled in the DOCSIS Registration
process."
DEFVAL { 0 }
::= { docsSubmgt3Base 10 }
docsSubmgt3BaseMtaFilterDownDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
MTA downstream filter group for the CM if the parameter
is not signaled in the DOCSIS Registration process."
DEFVAL { 0 }
::= { docsSubmgt3Base 11 }
docsSubmgt3BaseMtaFilterUpDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
MTA upstream filter group for the CM if the parameter
is not signaled in the DOCSIS Registration process."
DEFVAL { 0 }
::= { docsSubmgt3Base 12 }
docsSubmgt3BaseStbFilterDownDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
STB downstream filter group for the CM if the parameter
is not signaled in the DOCSIS Registration process."
DEFVAL { 0 }
::= { docsSubmgt3Base 13 }
docsSubmgt3BaseStbFilterUpDef OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the default value for the
STB upstream filter group for the CM if the parameter
is not signaled in the DOCSIS Registration process."
DEFVAL { 0 }
::= { docsSubmgt3Base 14 }
docsSubmgt3CpeCtrlTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsSubmgt3CpeCtrlEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This object maintains per-CM traffic policies enforced
by the CMTS. The CMTS acquires the CM traffic policies
through the CM registration process, or in the
absence of some or all of those parameters, from the
Base object. The CM information and controls are meaningful
and used by the CMTS, but only after the CM is
operational."
::= { docsSubmgt3MibObjects 2 }
docsSubmgt3CpeCtrlEntry OBJECT-TYPE
SYNTAX DocsSubmgt3CpeCtrlEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The conceptual row of docsSubmgt3CpeCtrlTable.
The CMTS does not persist the instances of the CpeCtrl
object across reinitializations."
INDEX { docsIf3CmtsCmRegStatusId }
-- Augments docsIf3CmtsCmRegStatusEntry FROM DOCS-IF3-MIB
::= { docsSubmgt3CpeCtrlTable 1 }
DocsSubmgt3CpeCtrlEntry ::= SEQUENCE {
docsSubmgt3CpeCtrlMaxCpeIpv4 Gauge,
docsSubmgt3CpeCtrlMaxCpeIpv6Prefix Gauge,
docsSubmgt3CpeCtrlActive TruthValue,
docsSubmgt3CpeCtrlLearnable TruthValue,
docsSubmgt3CpeCtrlReset TruthValue,
docsSubmgt3CpeCtrlLastReset TimeStamp
}
docsSubmgt3CpeCtrlMaxCpeIpv4 OBJECT-TYPE
SYNTAX Gauge(0..1023)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the number of simultaneous
IP v4 addresses permitted for CPE connected to the CM.
When the MaxCpeIpv4 attribute is set to zero (0), all Ipv4 CPE
traffic from the CM is dropped. The CMTS configures this
attribute with whichever of the 'Subscriber Management CPE IPv4
List' or 'Subscriber Management Control-Max_CpeIPv4' signaled
encodings is greater, or in the absence of all of those
provisioning parameters, with the CpeMaxIp v4Def
from the Base object. This limit applies to learned
and DOCSIS-provisioned entries but not to entries added
through some administrative process at the CMTS.
Note that this attribute is only meaningful when the
Active attribute of the CM is set to 'true'."
REFERENCE
"DOCSIS 3.0 MAC and Upper Layer Protocols Interface
Specification CM-SP-MULPIv3.0-I04-070518, Subscriber Management
TLVs section in the Common Radio Frequency Interface Encodings
Annex."
::= { docsSubmgt3CpeCtrlEntry 1 }
docsSubmgt3CpeCtrlMaxCpeIpv6Prefix OBJECT-TYPE
SYNTAX Gauge(0..1023)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the number of simultaneous
IPv6 prefixes permitted for CPE connected to the
CM.
When the MaxCpeIpv6Prefix is set to zero (0), all IPv6 CPE
traffic from the CM is dropped. The CMTS configures this
attribute with whichever of the 'Subscriber Management CPE IPv6 List'
or'Subscriber Management Control Max Cpe IPv6 Prefix'
signaled encodings is greater, or in the absence of all of those
provisioning parameters, with the CpeMaxIpv6PrefixDef
from the Base object. This limit applies to learned
and DOCSIS-provisioned entries but not to entries added
through some administrative process at the CMTS.
Note that this attribute is only meaningful when the
Active attribute of the CM is set to 'true'."
REFERENCE
"DOCSIS 3.0 MAC and Upper Layer Protocols Interface
Specification CM-SP-MULPIv3.0-I04-070518, Subscriber Management
TLVs section in the Common Radio Frequency Interface Encodings
Annex."
::= { docsSubmgt3CpeCtrlEntry 2 }
docsSubmgt3CpeCtrlActive OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute controls the application of subscriber
management to this CM. If this is set to 'true',
CMTS-based CPE control is active, and all the actions
required by the various filter policies and controls
apply at the CMTS. If this is set to false, no subscriber
management filtering is done at the CMTS (but other
filters may apply). If not set through DOCSIS provisioning,
this object defaults to the value of the Active
attribute of the Base object."
REFERENCE
"DOCSIS 3.0 MAC and Upper Layer Protocols Interface
Specification CM-SP-MULPIv3.0-I04-070518, Subscriber Management
Control section in the Common Radio Frequency Interface
Encodings Annex."
::= { docsSubmgt3CpeCtrlEntry 3 }
docsSubmgt3CpeCtrlLearnable OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute controls whether the CMTS may learn
(and pass traffic for) CPE IP addresses associated
with a CM. If this is set to 'true', the CMTS may learn up
to the CM MaxCpeIp value less any DOCSIS-provisioned
entries related to this CM. The nature of the learning
mechanism is not specified here. If not set through
DOCSIS provisioning, this object defaults to the
value of the CpeLearnableDef attribute from the Base
object. Note that this attribute is only meaningful
if docsSubMgtCpeControlActive is 'true' to enforce
a limit in the number of CPEs learned. CPE learning
is always performed for the CMTS for security reasons."
REFERENCE
"DOCSIS 3.0 MAC and Upper Layer Protocols Interface
Specification CM-SP-MULPIv3.0-I04-070518, Subscriber Management
Control section in the Common Radio Frequency Interface
Encodings Annex."
::= { docsSubmgt3CpeCtrlEntry 4 }
docsSubmgt3CpeCtrlReset OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"If set to 'true', this attribute commands the CMTS
to delete the instances denoted as 'learned' addresses
in the CpeIp object. This attribute always returns
false on read."
::= { docsSubmgt3CpeCtrlEntry 5 }
docsSubmgt3CpeCtrlLastReset OBJECT-TYPE
SYNTAX TimeStamp
-- Rsyntax TimeTicks
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the system Up Time of the
last set to 'true' of the Reset attribute of this instance.
Zero if never reset."
::= { docsSubmgt3CpeCtrlEntry 6 }
docsSubmgt3CpeIpTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsSubmgt3CpeIpEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This object defines the list of IP Addresses behind
the CM known by the CMTS.
If the Active attribute of the CpeCtrl object associated
with a CM is set to 'true' and the CMTS receives an
IP packet from a CM that contains a source IP address that
does not match one of the CPE IP addresses associated
with this CM, one of two things occurs. If the number
of CPE IPs is less than the MaxCpeIp of the CpeCtrl object
for that CM, the source IP address is added to this
object and the packet is forwarded; otherwise, the
packet is dropped."
::= { docsSubmgt3MibObjects 3 }
docsSubmgt3CpeIpEntry OBJECT-TYPE
SYNTAX DocsSubmgt3CpeIpEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The conceptual row of docsSubmgt3CpeIpTable."
INDEX { docsIf3CmtsCmRegStatusId, docsSubmgt3CpeIpId }
::= { docsSubmgt3CpeIpTable 1 }
DocsSubmgt3CpeIpEntry ::= SEQUENCE {
docsSubmgt3CpeIpId Gauge,
docsSubmgt3CpeIpAddrType InetAddressType,
docsSubmgt3CpeIpAddr InetAddress,
docsSubmgt3CpeIpAddrPrefixLen InetAddressPrefixLength,
docsSubmgt3CpeIpLearned TruthValue,
docsSubmgt3CpeIpType INTEGER
}
docsSubmgt3CpeIpId OBJECT-TYPE
SYNTAX Gauge(1..1023)
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This attribute represents a unique identifier for
a CPE IP of the CM. An instance of this attribute exists
for each CPE provisioned in the 'Subscriber Management
CPE IPv4 Table' or 'Subscriber Management CPE
IPv6 Table' encodings. An entry is created either through
the included CPE IP addresses in the provisioning
object, or CPEs learned from traffic sourced from the
CM."
::= { docsSubmgt3CpeIpEntry 1 }
docsSubmgt3CpeIpAddrType OBJECT-TYPE
SYNTAX InetAddressType
-- Rsyntax INTEGER {
-- ?? enum value of zero may cause problems
-- unknown(0),
-- ipv4(1),
-- ipv6(2),
-- ipv4z(3),
-- ipv6z(4),
-- dns(16)
-- }
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The type of Internet address of the Addr attribute."
::= { docsSubmgt3CpeIpEntry 2 }
docsSubmgt3CpeIpAddr OBJECT-TYPE
SYNTAX InetAddress
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This attribute represents the IP address either set
from provisioning or learned via address gleaning
or other forwarding means."
::= { docsSubmgt3CpeIpEntry 3 }
docsSubmgt3CpeIpAddrPrefixLen OBJECT-TYPE
SYNTAX InetAddressPrefixLength
-- Rsyntax Gauge(0..2040)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This attribute represents the prefix length associated with
the IP subnet prefix either set from provisioning or learned
via address gleaning or other forwarding means. For IPv4 CPE
addresses this attribute generally reports the value 32
(32 bits) to indicate a unicast IPv4 address. For IPv6, this
attribute represents either an IPv6 unicast address
(128 bits, equal to /128 prefix length) or a subnet prefix
length (for example 56 bits, equal to /56 prefix length)."
::= { docsSubmgt3CpeIpEntry 4 }
docsSubmgt3CpeIpLearned OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This attribute is set to 'true' when the IP address
was learned from IP packets sent upstream rather than
via the CM provisioning process."
::= { docsSubmgt3CpeIpEntry 5 }
docsSubmgt3CpeIpType OBJECT-TYPE
SYNTAX INTEGER {
cpe(1),
ps(2),
mta(3),
stb(4),
tea(5),
erouter(6)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This attribute represents the type of CPE based on
the following classification below:
'cpe' Regular CPE clients.
'ps' CableHome Portal Server (PS)
'mta' PacketCable Multimedia Terminal Adapter (MTA)
'stb' Digital Set-top Box (STB).
'tea' T1 Emulation adapter (TEA)
'erouter' Embedded Router (eRouter)"
::= { docsSubmgt3CpeIpEntry 6 }
docsSubmgt3GrpTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsSubmgt3GrpEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This object defines the set of downstream and upstream
filter groups that the CMTS applies to traffic associated
with that CM."
REFERENCE
"DOCSIS 3.0 MAC and Upper Layer Protocols Interface
Specification CM-SP-MULPIv3.0-I01-060804, Subscriber
Management TLVs section in the Common Radio Frequency
Interface Encodings Annex."
::= { docsSubmgt3MibObjects 4 }
docsSubmgt3GrpEntry OBJECT-TYPE
SYNTAX DocsSubmgt3GrpEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The conceptual row of docsSubmgt3GrpTable.
The CMTS does not persist the instances of the Grp
object across reinitializations."
INDEX { docsIf3CmtsCmRegStatusId }
-- Augments docsIf3CmtsCmRegStatusEntry FROM DOCS-IF3-MIB
::= { docsSubmgt3GrpTable 1 }
DocsSubmgt3GrpEntry ::= SEQUENCE {
docsSubMgt3GrpUdcGroupIds SnmpTagList,
docsSubMgt3GrpUdcSentInRegRsp TruthValue,
docsSubmgt3GrpSubFilterDs Gauge,
docsSubmgt3GrpSubFilterUs Gauge,
docsSubmgt3GrpCmFilterDs Gauge,
docsSubmgt3GrpCmFilterUs Gauge,
docsSubmgt3GrpPsFilterDs Gauge,
docsSubmgt3GrpPsFilterUs Gauge,
docsSubmgt3GrpMtaFilterDs Gauge,
docsSubmgt3GrpMtaFilterUs Gauge,
docsSubmgt3GrpStbFilterDs Gauge,
docsSubmgt3GrpStbFilterUs Gauge
}
docsSubMgt3GrpUdcGroupIds OBJECT-TYPE
SYNTAX SnmpTagList
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group(s) associated
with the CM signaled 'Upstream Drop Classifier Group ID'
encodings during the registration process. UDC Group IDs are
integer values and this attribute reports them as decimal
numbers that are space-separated. The zero-length string indicates
that the CM didn't signal UDC Group IDs.
This attribute provides two functions:
- Communicate the CM the configured UDC Group ID(s), irrespective
of the CM being provisioned to filter upstream traffic based
on IP Filters or UDCs.
- Optionally, and with regards to the CMTS, if the value of the
attribute UdcSentInReqRsp is 'true', indicates that the filtering
rules associated with the Subscriber Management Group ID(s) will
be sent during registration to the CM. It is vendor specific
whether the CMTS updates individual CM UDCs after registration
when rules are changed in the Grp object."
DEFVAL { ''H }
::= { docsSubmgt3GrpEntry 1 }
docsSubMgt3GrpUdcSentInRegRsp OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the CMTS upstream filtering
status for this CM. The value 'true' indicates that the
CMTS has sent UDCs to the CM during registration process.
In order for a CMTS to send UDCs to a CM, the CMTS MAC Domain
needed to be enabled via the MAC Domain attribute
SendUdcRulesEnabled and the CM had indicated the UDC capability
support during the registration process. The value 'false'
indicates that the CMTS was not enabled to sent UDCs to the
CMs in the MAC Domain, or the CM does not advertised UDC
support in its capabilities encodings, or both. Since the
CMTS capability to sent UDCs to CMs during the registration
process is optional, the CMTS is not required to implement
the value 'true'."
DEFVAL { false }
::= { docsSubmgt3GrpEntry 2 }
docsSubmgt3GrpSubFilterDs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic destined for subscriber's CPE attached to the
referenced CM (attached to CM CPE interfaces). This
value corresponds to the 'Subscriber Downstream
Group' value of the 'Subscriber Management Filter Groups'
encoding signaled during the CM registration
or in its absence, to the SubFilterDownDef attribute
of the Base object. The value zero or a filter group
ID not configured in the CMTS means no filtering is applied
to traffic destined to hosts attached to this CM."
::= { docsSubmgt3GrpEntry 3 }
docsSubmgt3GrpSubFilterUs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic originating from subscriber's CPE attached
to the referenced CM (attached to CM CPE interfaces).
This value corresponds to the 'Subscriber Upstream
Group' value of the 'Subscriber Management Filter
Groups' encoding signaled during the CM registration
or in its absence, to the SubFilterUpDef attribute
of the Base object. The value zero or a filter group
ID not configured in the CMTS means no filtering
is applied to traffic originating from hosts attached
to this CM."
::= { docsSubmgt3GrpEntry 4 }
docsSubmgt3GrpCmFilterDs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic destined for the CM itself. This value corresponds
to the 'CM Downstream Group' value of the
'Subscriber Management Filter Groups' encoding signaled
during the CM registration or in its absence,
to the CmFilterDownDef attribute of the Base object.
The value zero or a filter group ID not configured in
the CMTS means no filtering is applied to traffic destined
to the CM."
::= { docsSubmgt3GrpEntry 5 }
docsSubmgt3GrpCmFilterUs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic originating from the CM itself. This value
corresponds to the 'Subscriber Upstream Group'
value of the 'Subscriber Management Filter Groups'
encoding signaled during the CM registration or in its
absence, to the SubFilterUpDef attribute of the Base
object. The value zero or a filter group ID not configured
in the CMTS means no filtering is applied to traffic
originating from this CM."
::= { docsSubmgt3GrpEntry 6 }
docsSubmgt3GrpPsFilterDs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic destined to the Embedded CableHome Portal
Services Element or the Embedded Router on the referenced
CM. This value corresponds to the 'PS Downstream
Group' value of the 'Subscriber Management Filter
Groups' encoding signaled during the CM registration
or in its absence, to the SubFilterDownDef attribute
of the Base object. The value zero or a filter
group ID not configured in the CMTS means no filtering
is applied to traffic destined to the Embedded CableHome
Portal Services Element or Embedded Router on
this CM."
::= { docsSubmgt3GrpEntry 7 }
docsSubmgt3GrpPsFilterUs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic originating from the Embedded CableHome
Portal Services Element or Embedded Router on the
referenced CM. This value corresponds to the 'PS Upstream
Group' value of the 'Subscriber Management Filter
Groups' encoding signaled during the CM registration
or in its absence, to the SubFilterUpDef attribute
of the Base object. The value zero or a filter group
ID not configured in the CMTS means no filtering is
applied to traffic originating from the Embedded CableHome
Portal Services Element or Embedded Router
on this CM."
::= { docsSubmgt3GrpEntry 8 }
docsSubmgt3GrpMtaFilterDs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic destined to the Embedded Multimedia Terminal
Adapter on the referenced CM. This value corresponds
to the 'MTA Downstream Group' value of the 'Subscriber
Management Filter Groups' encoding signaled
during the CM registration or in its absence, to
the SubFilterDownDef attribute of the Base object.
The value zero or a filter group ID not configured in the
CMTS means no filtering is applied to traffic destined
to the Embedded Multimedia Terminal Adapter on
this CM."
::= { docsSubmgt3GrpEntry 9 }
docsSubmgt3GrpMtaFilterUs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic originating from the Embedded Multimedia
Terminal Adapter on the referenced CM. This value
corresponds to the 'MTA Upstream Group' value of the
'Subscriber Management Filter Groups' encoding signaled
during the CM registration or in its absence,
to the SubFilterUpDef attribute of the Base object.
The value zero or a filter group ID not configured in
the CMTS means no filtering is applied to traffic originating
from the Embedded Multimedia Terminal Adapter
on this CM."
::= { docsSubmgt3GrpEntry 10 }
docsSubmgt3GrpStbFilterDs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic destined for the Embedded Set-Top Box on
the referenced CM. This value corresponds to the 'STB
Downstream Group' value of the 'Subscriber Management
Filter Groups' encoding signaled during the CM
registration or in its absence, to the SubFilterDownDef
attribute of the Base object. The value zero or
a filter group ID not configured in the CMTS means no filtering
is applied to traffic destined to the Embedded
Set-Top Box on this CM."
::= { docsSubmgt3GrpEntry 11 }
docsSubmgt3GrpStbFilterUs OBJECT-TYPE
SYNTAX Gauge(0..1024)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the filter group applied
to traffic originating from the Embedded Set-Top
Box on the referenced CM. This value corresponds to the
'STB Upstream Group' value of the 'Subscriber Management
Filter Groups' encoding signaled during the
CM registration or in its absence, to the SubFilterUpDef
attribute of the Base object. The value zero or
a filter group ID not configured in the CMTS means no filtering
is applied to traffic originating from the
Embedded Set-Top Box on this CM."
::= { docsSubmgt3GrpEntry 12 }
docsSubmgt3FilterGrpTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsSubmgt3FilterGrpEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This object describes a set of filter or classifier
criteria. Classifiers are assigned by group to the
individual CMs. That assignment is made via the 'Subscriber
Management TLVs' encodings sent upstream from
the CM to the CMTS during registration or in their
absence, default values configured in the CMTS.
A Filter Group ID (GrpId) is a set of rules that correspond
to the expansion of a UDC Group ID into UDC individual
classification rules. The Filter Group Ids are generated
whenever the CMTS is configured to send UDCs during the CM
registration process. Implementation of L2 classification
criteria is optional for the CMTS; LLC/MAC upstream and
downstream filter criteria can be ignored during the packet
matching process."
::= { docsSubmgt3MibObjects 5 }
docsSubmgt3FilterGrpEntry OBJECT-TYPE
SYNTAX DocsSubmgt3FilterGrpEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"The conceptual row of docsSubmgt3FilterGrpTable.
The CMTS persists all instances of the FilterGrp object
across reinitializations."
INDEX { docsSubmgt3FilterGrpGrpId, docsSubmgt3FilterGrpRuleId }
::= { docsSubmgt3FilterGrpTable 1 }
DocsSubmgt3FilterGrpEntry ::= SEQUENCE {
docsSubmgt3FilterGrpGrpId Gauge,
docsSubmgt3FilterGrpRuleId Gauge,
docsSubmgt3FilterGrpAction INTEGER,
docsSubmgt3FilterGrpPriority Gauge,
docsSubmgt3FilterGrpIpTosLow OCTET STRING,
docsSubmgt3FilterGrpIpTosHigh OCTET STRING,
docsSubmgt3FilterGrpIpTosMask OCTET STRING,
docsSubmgt3FilterGrpIpProtocol Gauge,
docsSubmgt3FilterGrpInetAddrType InetAddressType,
docsSubmgt3FilterGrpInetSrcAddr InetAddress,
docsSubmgt3FilterGrpInetSrcMask InetAddress,
docsSubmgt3FilterGrpInetDestAddr InetAddress,
docsSubmgt3FilterGrpInetDestMask InetAddress,
docsSubmgt3FilterGrpSrcPortStart InetPortNumber,
docsSubmgt3FilterGrpSrcPortEnd InetPortNumber,
docsSubmgt3FilterGrpDestPortStart InetPortNumber,
docsSubmgt3FilterGrpDestPortEnd InetPortNumber,
docsSubmgt3FilterGrpDestMacAddr MacAddress,
docsSubmgt3FilterGrpDestMacMask MacAddress,
docsSubmgt3FilterGrpSrcMacAddr MacAddress,
docsSubmgt3FilterGrpEnetProtocolType INTEGER,
docsSubmgt3FilterGrpEnetProtocol Gauge,
docsSubmgt3FilterGrpUserPriLow Gauge,
docsSubmgt3FilterGrpUserPriHigh Gauge,
docsSubmgt3FilterGrpVlanId Gauge,
docsSubmgt3FilterGrpClassPkts Counter,
docsSubmgt3FilterGrpFlowLabel Gauge,
docsSubmgt3FilterGrpCmInterfaceMask DocsL2vpnIfList,
docsSubmgt3FilterGrpRowStatus RowStatus
}
docsSubmgt3FilterGrpGrpId OBJECT-TYPE
SYNTAX Gauge(1..65535)
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This key is an identifier for a set of classifiers known
as a filter group. Each CM may be associated with
several filter groups for its upstream and downstream
traffic, one group per target end point on the CM as
defined in the Grp object. Typically, many CMs share
a common set of filter groups."
::= { docsSubmgt3FilterGrpEntry 1 }
docsSubmgt3FilterGrpRuleId OBJECT-TYPE
SYNTAX Gauge(1..65535)
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This key represents an ordered classifier identifier
within the group. Filters are applied in order if
the Priority attribute is not supported."
::= { docsSubmgt3FilterGrpEntry 2 }
docsSubmgt3FilterGrpAction OBJECT-TYPE
SYNTAX INTEGER {
permit(1),
deny(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the action to take upon
this filter matching. 'permit' means to stop the classification
matching and accept the packet for further
processing. 'deny' means to drop the packet."
DEFVAL { permit }
::= { docsSubmgt3FilterGrpEntry 3 }
docsSubmgt3FilterGrpPriority OBJECT-TYPE
SYNTAX Gauge(0..65535)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute defines the order in which classifiers
are compared against packets. The higher the value,
the higher the priority."
DEFVAL { 0 }
::= { docsSubmgt3FilterGrpEntry 4 }
docsSubmgt3FilterGrpIpTosLow OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(1))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the low value of a range
of ToS (Type of Service) octet values. This object is
defined as an 8-bit octet as per the DOCSIS Specification
for packet classification.
The IP ToS octet, as originally defined in RFC 791, has
been superseded by the 6-bit Differentiated Services
Field (DSField, RFC 3260) and the 2-bit Explicit
Congestion Notification Field (ECN field, RFC 3168)."
REFERENCE
"DOCSIS 3.0 MAC and Upper Layer Protocols Interface
Specification CM-SP-MULPIv3.0-I01-060804.
RFC 791.
RFC 3260.
RFC 3168."
DEFVAL { '00'H }
::= { docsSubmgt3FilterGrpEntry 5 }
docsSubmgt3FilterGrpIpTosHigh OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(1))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the high value of a range
of ToS octet values. This object is defined as an 8-bit
octet as per the DOCSIS Specification for packet classification.
The IP ToS octet, as originally defined in RFC 791, has
been superseded by the 6-bit Differentiated Services
Field (DSField, RFC 3260) and the 2-bit Explicit
Congestion Notification Field (ECN field, RFC 3168)."
REFERENCE
"DOCSIS 3.0 MAC and Upper Layer Protocols Interface
Specification CM-SP-MULPIv3.0-I01-060804.
RFC 791.
RFC 3260.
RFC 3168."
DEFVAL { '00'H }
::= { docsSubmgt3FilterGrpEntry 6 }
docsSubmgt3FilterGrpIpTosMask OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(1))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the mask value that is bitwise
ANDed with ToS octet in an IP packet, and the resulting value
is used for range checking of IpTosLow and IpTosHigh."
DEFVAL { '00'H }
::= { docsSubmgt3FilterGrpEntry 7 }
docsSubmgt3FilterGrpIpProtocol OBJECT-TYPE
SYNTAX Gauge(0..257)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This attribute represents the value of the IP Protocol
field required for IP packets to match this rule.
The value 256 matches traffic with any IP Protocol value.
The value 257 by convention matches both TCP and
UDP."
DEFVAL { 256 }
::= { docsSubmgt3FilterGrpEntry 8 }
docsSubmgt3FilterGrpInetAddrType OBJECT-TYPE
SYNTAX InetAddressType
-- Rsyntax INTEGER {
-- ?? enum value of zero may cause problems
-- unknown(0),
-- ipv4(1),
-- ipv6(2),
-- ipv4z(3),
-- ipv6z(4),
-- dns(16)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The type of the Internet address for InetSrcAddr,
InetSrcMask, InetDestAddr, and InetDestMask."
-- DEFVAL { unknown }
::= { docsSubmgt3FilterGrpEntry 9 }