-
Notifications
You must be signed in to change notification settings - Fork 124
/
Copy pathDOCS-CABLE-DEVICE-MIB-V1SMI.my
2872 lines (2615 loc) · 97.7 KB
/
DOCS-CABLE-DEVICE-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 28-Oct-2009 16:20:41, by
-- SMICng version 2.2.11-beta(PRO)(Solaris), January 20, 2001. Enterprise key cisco.com
DOCS-CABLE-DEVICE-MIB DEFINITIONS ::= BEGIN
-- From file: "DOCS-CABLE-DEVICE-MIB.my"
-- Compile options "4 7 F H N O W 03 06 0B 0G 0N 0T"
IMPORTS
mib-2
FROM SNMPv2-SMI-v1
RowStatus, RowPointer, DateAndTime, TruthValue, StorageType
FROM SNMPv2-TC-v1
InetAddressType, InetAddress
FROM INET-ADDRESS-MIB
SnmpAdminString
FROM SNMP-FRAMEWORK-MIB
InterfaceIndexOrZero
FROM IF-MIB
ZeroBasedCounter32
FROM RMON2-MIB
Counter, Gauge, IpAddress
FROM RFC1155-SMI
OBJECT-TYPE
FROM RFC-1212;
docsDev OBJECT IDENTIFIER ::= { mib-2 69 }
-- MODULE-IDENTITY
-- LastUpdated
-- 200612200000Z
-- OrgName
-- IETF IP over Cable Data Network
-- Working Group
-- ContactInfo
-- Rich Woundy
-- Postal: Comcast Cable
-- 27 Industrial Avenue
-- Chelmsford, MA 01824 U.S.A.
-- Phone: +1 978 244 4010
-- E-mail: [email protected]
--
-- Kevin Marez
-- Postal: Motorola Corporation
-- 6450 Sequence Drive
-- San Diego, CA 92121 U.S.A.
-- Phone: +1 858 404 3785
-- E-mail: [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,
-- Jean-Francois Mule,
-- Descr
-- This is the MIB Module for DOCSIS-compliant cable modems
-- and cable-modem termination systems.
--
-- Copyright (C) The IETF Trust (2006). This version
-- of this MIB module was published in RFC 4639; for full
-- legal notices see the RFC itself.
-- RevDate
-- 200612200000Z
-- RevDescr
-- Second version, published as RFC 4639.
--
-- Modifications to this MIB module since RFC 2669 include:
-- - Deprecation of the docsDevFilter group in favor of the
-- DiffServ MIB groups, to enable support for IPv6
-- filtering and DiffServ Code Point (DSCP) marking.
-- - Deprecation of the docsDevCpeGroup in favor of the
-- docsDevCpeInetGroup, to enable support of IPv6.
-- - Addition of various InetAddress objects to enable
-- support of IPv6.
-- - Deprecation of docsDevNmAccessTable in favor of SNMP
-- Coexistence and SNMPv3 == yet adding
-- docsDevNmAccessTrapVersion and clarifying
-- docsDevNmAccessIp for current use of this table,
-- - Addition of docsDevIgmpModeControl for management and
-- control of the IGMP mode of operation,
-- - Addition of docsDevMaxCpe for management of the
-- maxmium number of CPEs permitted access through a
-- cable modem,
-- - Addition of docsDevSwServerTransportProtocol, and
-- modifications to docsDevSoftware object DESCRIPTIONS,
-- to enable software downloads via either TFTP or HTTP,
-- - Replacement of docsDevEvThrottleInhibited with
-- docsDevEvThrottleThresholdExceeded to simplify
-- event threshold management,
-- - Modification of docsDevEvReporting to enable local
-- logging to the internal volatile log, and not to the
-- internal non-volatile log,
-- - Modification of the compliance statement to make the
-- docsDevCpe objects optional
-- - Created placeholders for two OIDs in the
-- docsDevFilterPolicyTable that were never used
-- - Modified the DESCRIPTION of
-- docsDevSwServerTransportProtocol and
-- docsDevSwServerAddressType to address the
-- dependence between each object
-- - Added a reference to docsDevServerConfigTftpAddress
-- - Clarified the scope of notifications that are covered
-- by docsDevEvThrottleThreshold
-- - Clarified an error condition that could occur when
-- doing a SET to docsDevEvReporting
-- - Defined each of the enumerated types for both
-- docsDevEvLevel and docsDevEvPriority
-- - Added UNITS clause to docsDevFilterLLCMatches,
-- docsDevFilterIpMatches, docsDevMaxCpe,
-- docsDevEvThrottleThreshold and docsDevEvCounts.
-- - Added REFERENCE clause to docsDevFilterIpProtocol
-- - Modified DESCRIPTION of docsDevCpeInetAddr to be
-- more protocol-neutral
-- - Removed the enumerated value (1) from both
-- docsDevCpeInetSource and docsDevCpeSource
-- - Covered additional read-write and read-create objects
-- in the Security Considerations section
-- - Modified the default value of docsDevNmAccessIpMask
-- to be consistent with OSSI specification
-- - Modified the SYNTAX of docsDevNmAccessCommunity and
-- docsDevNmAccessInterfaces in the Conformance
-- Statement section
-- - Added SYNTAX clause to docsDevEvReporting in the
-- Conformance Statement section
-- - Modified SYNTAX clause of docsDevEvReporting to
-- move new enumerated type to byte boundary
-- - Added references to DOCSIS 2.0 specifications to
-- multiple objects
-- - Clarified non-persistency across reboots for
-- all tables
-- - Clarified functionality of docsDevSw objects as
-- they relate to docsDevSwOperStatus
-- - Clarified enumerated types (9) and (10) for
-- docsDevServerBootState
-- - Defined the state of unknown(0) for the following
-- objects: docsDevServerDhcpAddressType,
-- docsDevServerTimeAddressType,
-- docsDevServerConfigTftpAddressType and
-- docsDevServerConfigTftpAddressType
-- - Modified the value in docsDevFilterIpDaddr to be
-- consistent with the SYNTAX
-- - Specified which rows could be modified in an
-- active row for docsDevFilterPolicyStatus
-- - Defined the term 'manually' in docsDevCpeEnroll
-- - Clarified the description for
-- docsDevFilterTosOrMask
-- - Covered the case of a non-existent row for
-- docsDevFilterPolicyPtr
-- - Added DEFVAL clauses for multiple objects
-- - Replaced docsDevNotification OBJECT IDENTIFIER
-- with docsDevNotifications to address possible
-- compatibility issues
-- - Added support for the usage of RFC 3413 and RFC 3014
-- as event notification mechanisms
-- - Removed docsDevFilterPolicyObsoleteGroup
-- - Added stdInterface(9) type to docsDevEvReporting to
-- support the usage of RFC3413 and RFC3014
-- - Modified DESCRIPTION for docsDevMaxCpe
-- RevDate
-- 199908190000Z
-- RevDescr
-- Initial version, published as RFC 2669.
docsDevMIBObjects OBJECT IDENTIFIER ::= { docsDev 1 }
docsDevBase OBJECT IDENTIFIER ::= { docsDevMIBObjects 1 }
docsDevSoftware OBJECT IDENTIFIER ::= { docsDevMIBObjects 3 }
docsDevServer OBJECT IDENTIFIER ::= { docsDevMIBObjects 4 }
docsDevEvent OBJECT IDENTIFIER ::= { docsDevMIBObjects 5 }
docsDevFilter OBJECT IDENTIFIER ::= { docsDevMIBObjects 6 }
docsDevCpe OBJECT IDENTIFIER ::= { docsDevMIBObjects 7 }
docsDevNotification OBJECT IDENTIFIER ::= { docsDev 2 }
docsDevNotifications OBJECT IDENTIFIER ::= { docsDev 0 }
docsDevConformance OBJECT IDENTIFIER ::= { docsDev 3 }
docsDevGroups OBJECT IDENTIFIER ::= { docsDevConformance 1 }
docsDevCompliances OBJECT IDENTIFIER ::= { docsDevConformance 2 }
docsDevGroupsV2 OBJECT IDENTIFIER ::= { docsDevConformance 3 }
docsDevCompliancesV2 OBJECT IDENTIFIER ::= { docsDevConformance 4 }
docsDevRole OBJECT-TYPE
SYNTAX INTEGER {
cm(1),
cmtsActive(2),
cmtsBackup(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"Defines the current role of this device. cm(1) is a
Cable Modem, cmtsActive(2) is a Cable Modem Termination
System that is controlling the system of cable modems,
and cmtsBackup(3) is a CMTS that is currently connected
but is not controlling the system (not currently used).
In general, if this device is a 'cm', its role will not
change during operation or between reboots. If the
device is a 'cmts' it may change between cmtsActive and
cmtsBackup and back again during normal operation. NB:
At this time, the DOCSIS standards do not support the
concept of a backup CMTS, but cmtsBackup is included for
completeness."
::= { docsDevBase 1 }
docsDevDateTime OBJECT-TYPE
SYNTAX DateAndTime
-- Rsyntax OCTET STRING(SIZE(8|11))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The current date and time, with time zone information
(if known).
If the real data and time cannot be determined, this
shall represent elapsed time from boot relative to
the standard epoch '1970-1-1,0:0:0.0'. In other
words, if this agent has been up for 3 minutes and
not been able to determine what the actual date and
time are, this object will return the value
'1970-1-1,0:03:0.0'."
::= { docsDevBase 2 }
docsDevResetNow OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Setting this object to true(1) causes the device to
reset. Reading this object always returns false(2)."
::= { docsDevBase 3 }
docsDevSerialNumber OBJECT-TYPE
SYNTAX SnmpAdminString
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The manufacturer's serial number for this device."
::= { docsDevBase 4 }
docsDevSTPControl OBJECT-TYPE
SYNTAX INTEGER {
stEnabled(1),
noStFilterBpdu(2),
noStPassBpdu(3)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This object controls operation of the spanning tree
protocol (as distinguished from transparent bridging).
If set to stEnabled(1), then the spanning tree protocol
is enabled, subject to bridging constraints.
If noStFilterBpdu(2), then spanning tree is not active,
and Bridge PDUs received are discarded.
If noStPassBpdu(3), then spanning tree is not active,
and Bridge PDUs are transparently forwarded.
Note that a device need not implement all of these
options, but that noStFilterBpdu(2) is required."
DEFVAL { noStFilterBpdu }
::= { docsDevBase 5 }
docsDevIgmpModeControl OBJECT-TYPE
SYNTAX INTEGER {
passive(1),
active(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This object controls the IGMP mode of operation for
the CM or CMTS. In passive mode, the device forwards
IGMP between interfaces as based on knowledge of
Multicast Session activity on the subscriber side
interface and the rules defined in the DOCSIS RFI
specification. In active mode, the device terminates
at and initiates IGMP through its interfaces as based
on the knowledge of Multicast Session activity on the
subscriber side interface."
REFERENCE
"DOCSIS RFI 1.1 Specification, Section 3.3.1. and
DOCSIS RFI 2.0 Specification, Section 5.3.1."
DEFVAL { passive }
::= { docsDevBase 6 }
docsDevMaxCpe OBJECT-TYPE
SYNTAX Gauge(0..255)
-- Units
-- CPEs
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The maximum number of CPEs that can be granted access
through a CM during a CM epoch. This value can be
obtained from the CM configuration file; however,
it may be adjusted by the CM according to hardware or
software limitations that have been imposed on the
implementation."
REFERENCE
"DOCSIS RFI 1.0 Specification, Appendix C.7.20., and
DOCSIS RFI 1.1 Specification, Appendix C.1.1.7. and
DOCSIS RFI 2.0 Specification, Appendix C.1.1.7."
::= { docsDevBase 7 }
docsDevNmAccessTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsDevNmAccessEntry
ACCESS not-accessible
STATUS deprecated
DESCRIPTION
"This table controls access to SNMP objects by network
management stations. If the table is empty, access to
SNMP objects is unrestricted. The objects in this table
MUST NOT persist across reboots. The objects in this
table are only accessible from cable devices that are
not capable of operating in SNMP Coexistence mode
(RFC 3584) or in SNMPv3 mode (RFC 3410).
See the conformance section for
details. Note that some devices are required by other
specifications (e.g., the DOCSIS OSSIv1.1 specification)
to support the legacy SNMPv1/v2c docsDevNmAccess mode
for backward compatibility.
This table is deprecated. Instead, use the SNMP
coexistence MIBs from RFC 3584, the TARGET and
NOTIFICATION MIBs from RFC 3413, and
the View-Based Access Control Model (VACM) MIBs for
all SNMP protocol versions from RFC 3415."
::= { docsDevMIBObjects 2 }
docsDevNmAccessEntry OBJECT-TYPE
SYNTAX DocsDevNmAccessEntry
ACCESS not-accessible
STATUS deprecated
DESCRIPTION
"An entry describing access to SNMP objects by a
particular network management station. An entry in
this table is not readable unless the management station
has read-write permission (either implicit if the table
is empty, or explicit through an entry in this table).
Entries are ordered by docsDevNmAccessIndex. The first
matching entry (e.g., matching IP address and community
string) is used to derive access."
INDEX { docsDevNmAccessIndex }
::= { docsDevNmAccessTable 1 }
DocsDevNmAccessEntry ::= SEQUENCE {
docsDevNmAccessIndex INTEGER,
docsDevNmAccessIp IpAddress,
docsDevNmAccessIpMask IpAddress,
docsDevNmAccessCommunity OCTET STRING,
docsDevNmAccessControl INTEGER,
docsDevNmAccessInterfaces OCTET STRING,
docsDevNmAccessStatus RowStatus,
docsDevNmAccessTrapVersion INTEGER
}
docsDevNmAccessIndex OBJECT-TYPE
SYNTAX INTEGER(1..2147483647)
ACCESS not-accessible
STATUS deprecated
DESCRIPTION
"Index used to order the application of access
entries."
::= { docsDevNmAccessEntry 1 }
docsDevNmAccessIp OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-write
STATUS deprecated
DESCRIPTION
"The IP address (or subnet) of the network management
station. The address 0.0.0.0 is defined to mean
any Network Management Station (NMS). If traps are
enabled for this entry, then the value must be the
address of a specific device. Implementations MAY
recognize 255.255.255.255 as equivalent to 0.0.0.0."
DEFVAL { '00000000'H }
::= { docsDevNmAccessEntry 2 }
docsDevNmAccessIpMask OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-write
STATUS deprecated
DESCRIPTION
"The IP subnet mask of the network management stations.
If traps are enabled for this entry, then the value must
be 0.0.0.0. Implementations MAY recognize
255.255.255.255 as equivalent to 0.0.0.0."
DEFVAL { '00000000'H }
::= { docsDevNmAccessEntry 3 }
docsDevNmAccessCommunity OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(0..32))
ACCESS read-write
STATUS deprecated
DESCRIPTION
"The community string to be matched for access by this
entry. If set to a zero-length string, then any
community string will match. When read, this object
SHOULD return a zero-length string."
DEFVAL { "public" }
::= { docsDevNmAccessEntry 4 }
docsDevNmAccessControl OBJECT-TYPE
SYNTAX INTEGER {
none(1),
read(2),
readWrite(3),
roWithTraps(4),
rwWithTraps(5),
trapsOnly(6)
}
ACCESS read-write
STATUS deprecated
DESCRIPTION
"Specifies the type of access allowed to this NMS.
Setting this object to none(1) causes the table entry
to be destroyed. Read(2) allows access by 'get' and
'get-next' PDUs. ReadWrite(3) allows access by 'set' as
well. RoWithtraps(4), rwWithTraps(5), and trapsOnly(6)
control distribution of Trap PDUs transmitted by this
device."
DEFVAL { read }
::= { docsDevNmAccessEntry 5 }
docsDevNmAccessInterfaces OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(1..32))
ACCESS read-write
STATUS deprecated
DESCRIPTION
"Specifies the set of interfaces from which requests from
this NMS will be accepted. Each octet within
the value of this object specifies a set of eight
interfaces, the first octet specifying ports 1
through 8, the second octet specifying interfaces 9
through 16, etc. Within each octet, the most
significant bit represents the lowest numbered
interface, and the least significant bit represents the
highest numbered interface. Thus, each interface is
represented by a single bit within the value of this
object. If that bit has a value of '1' then that
interface is included in the set.
Note that entries in this table apply only to link-layer
interfaces (e.g., Ethernet and CATV MAC). Bits
representing upstream and downstream channel interfaces
MUST NOT be set to '1'.
Note that if bits corresponding to non-existing
interfaces are set, the result is implementation
specific.
Note that according to the DOCSIS OSSIv1.1
specification, when ifIndex '1' is included in the
set, then this row applies to all CPE
(customer-facing) interfaces.
The size of this object is the minimum required to
represent all configured interfaces for this device."
::= { docsDevNmAccessEntry 6 }
docsDevNmAccessStatus OBJECT-TYPE
SYNTAX RowStatus
-- Rsyntax INTEGER {
-- active(1),
-- notInService(2),
-- notReady(3),
-- createAndGo(4),
-- createAndWait(5),
-- destroy(6)
-- }
ACCESS read-write
STATUS deprecated
DESCRIPTION
"Controls and reflects the status of rows in this
table. Rows in this table may be created by either the
create-and-go or create-and-wait paradigm. There is no
restriction on changing values in a row of this table
while the row is active.
The following objects MUST have valid values before this
object can be set to active: docsDevNmAccessIp,
docsDevNmAccessStatus, docsDevNmAccessIpMask,
docsDevNmAccessCommunity, docsDevNmAccessControl, and
docsDevNmAccessInterfaces."
::= { docsDevNmAccessEntry 7 }
docsDevNmAccessTrapVersion OBJECT-TYPE
SYNTAX INTEGER {
disableSNMPv2trap(1),
enableSNMPv2trap(2)
}
ACCESS read-write
STATUS deprecated
DESCRIPTION
"Specifies the TRAP version that is sent to this NMS.
Setting this object to disableSNMPv2trap (1) causes the
trap in SNMPv1 format to be sent to a particular NMS.
Setting this object to enableSNMPv2trap (2) causes the
trap in SNMPv2 format be sent to a particular NMS."
DEFVAL { disableSNMPv2trap }
::= { docsDevNmAccessEntry 8 }
docsDevSwServer OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-write
STATUS deprecated
DESCRIPTION
"The address of the TFTP server used for software
upgrades. If the TFTP server is unknown or is a
non-IPv4 address, return 0.0.0.0.
This object is deprecated. See docsDevSwServerAddress
for its replacement. This object will have its value
modified, given a valid SET to docsDevSwServerAddress."
::= { docsDevSoftware 1 }
docsDevSwFilename OBJECT-TYPE
SYNTAX SnmpAdminString(SIZE(0..64))
-- Rsyntax OCTET STRING(SIZE(0..64))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The filename of the software image to be downloaded via
TFTP, or the abs_path (as defined in RFC 2616) of the
software image to be downloaded via HTTP.
Unless set via SNMP, this is the filename or abs_path
specified by the provisioning server during the boot
process that corresponds to the software version that
is desired for this device.
If unknown, the value of this object is the zero-length
string."
::= { docsDevSoftware 2 }
docsDevSwAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
upgradeFromMgt(1),
allowProvisioningUpgrade(2),
ignoreProvisioningUpgrade(3)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"If set to upgradeFromMgt(1), the device will initiate a
TFTP or HTTP software image download. After
successfully receiving an image, the device will set
its state to ignoreProvisioningUpgrade(3) and reboot.
If the download process is interrupted (e.g., by a reset
or power failure), the device will load the previous
image and, after re-initialization, continue to attempt
loading the image specified in docsDevSwFilename.
If set to allowProvisioningUpgrade(2), the device will
use the software version information supplied by the
provisioning server when next rebooting (this does not
cause a reboot).
When set to ignoreProvisioningUpgrade(3), the device
will disregard software image upgrade information
from the provisioning server.
Note that reading this object can return
upgradeFromMgt(1). This indicates that a software
download is currently in progress, and that the device
will reboot after successfully receiving an image."
DEFVAL { allowProvisioningUpgrade }
::= { docsDevSoftware 3 }
docsDevSwOperStatus OBJECT-TYPE
SYNTAX INTEGER {
inProgress(1),
completeFromProvisioning(2),
completeFromMgt(3),
failed(4),
other(5)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"InProgress(1) indicates that a TFTP or HTTP download is
underway, either as a result of a version mismatch at
provisioning or as a result of a upgradeFromMgt request.
No other docsDevSw* objects can be modified in
this state.
CompleteFromProvisioning(2) indicates that the last
software upgrade was a result of version mismatch at
provisioning.
CompleteFromMgt(3) indicates that the last software
upgrade was a result of setting docsDevSwAdminStatus to
upgradeFromMgt.
Failed(4) indicates that the last attempted download
failed, ordinarily due to TFTP or HTTP timeout."
REFERENCE
"DOCSIS RFI 1.0 Specification, Section 8.2., and
DOCSIS RFI 1.1 Specification, Section 10.1. and
DOCSIS RFI 2.0 Specification, Section 12.1."
::= { docsDevSoftware 4 }
docsDevSwCurrentVers OBJECT-TYPE
SYNTAX SnmpAdminString
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The software version currently operating in this device.
This string's syntax is that used by the
individual vendor to identify software versions.
For a CM, this string will describe the current
software load. For a CMTS, this object SHOULD contain
a human-readable representation either of the vendor
specific designation of the software for the chassis,
or of the software for the control processor. If
neither of these is applicable, the value MUST be a
zero-length string."
::= { docsDevSoftware 5 }
docsDevSwServerAddressType 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 address of the TFTP or HTTP server used for
software upgrades.
If docsDevSwServerTransportProtocol is currently set to
tftp(1), attempting to set this object to dns(16) MUST
result in an error."
::= { docsDevSoftware 6 }
docsDevSwServerAddress OBJECT-TYPE
SYNTAX InetAddress
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The address of the TFTP or HTTP server used for software
upgrades.
If the TFTP/HTTP server is unknown, return the zero-
length address string (see the TextualConvention).
If docsDevSwServer is also implemented in this agent,
this object is tied to it. A set of this object to an
IPv4 address will result in also setting the value of
docsDevSwServer to that address. If this object is set
to an IPv6 address, docsDevSwServer is set to 0.0.0.0.
If docsDevSwServer is set, this object is also set to
that value. Note that if both are set in the same
action, the order of which one sets the other is
undefined."
::= { docsDevSoftware 7 }
docsDevSwServerTransportProtocol OBJECT-TYPE
SYNTAX INTEGER {
tftp(1),
http(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This object specifies the transport protocol (TFTP or
HTTP) to be used for software upgrades.
If the value of this object is tftp(1), then the cable
device uses TFTP (RFC 1350) read request packets to
download the docsDevSwFilename from the
docsDevSwServerAddress in octet mode.
If the value of this object is http(2), then the cable
device uses HTTP 1.0 (RFC 1945) or HTTP 1.1 (RFC 2616)
GET requests sent to host docsDevSwServerAddress to
download the software image from path docsDevSwFilename.
If docsDevSwServerAddressType is currently set to
dns(16), attempting to set this object to tftp(1) MUST
result in an error."
DEFVAL { tftp }
::= { docsDevSoftware 8 }
docsDevServerBootState OBJECT-TYPE
SYNTAX INTEGER {
operational(1),
disabled(2),
waitingForDhcpOffer(3),
waitingForDhcpResponse(4),
waitingForTimeServer(5),
waitingForTftp(6),
refusedByCmts(7),
forwardingDenied(8),
other(9)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"If operational(1), the device has completed loading and
processing of configuration parameters, and the CMTS has
completed the Registration exchange.
If disabled(2), then the device was administratively
disabled, possibly by being refused network access in
the configuration file.
If waitingForDhcpOffer(3), then a Dynamic Host
Configuration Protocol (DHCP) Discover has been
transmitted, and no offer has yet been received.
If waitingForDhcpResponse(4), then a DHCP Request has
been transmitted, and no response has yet been received.
If waitingForTimeServer(5), then a Time Request has been
transmitted, and no response has yet been received.
If waitingForTftp(6), then a request to the TFTP
parameter server has been made, and no response
received.
If refusedByCmts(7), then the Registration
Request/Response exchange with the CMTS failed.
If forwardingDenied(8), then the registration process
was completed, but the network access option in the
received configuration file prohibits forwarding.
If other(9), then the registration process reached a
point that does not fall into one of the above
categories.
If unknown(10), then the device has not yet begun the
registration process or is in some other indeterminate
state."
REFERENCE
"DOCSIS RFI 1.0 Specification, Figure 7-1, and
DOCSIS RFI 1.1 Specification, Figure 9-1 and
DOCSIS RFI 2.0 Specification, Figure 11-1."
::= { docsDevServer 1 }
docsDevServerDhcp OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-only
STATUS deprecated
DESCRIPTION
"The IP address of the DHCP server that assigned an IP
address to this device. Returns 0.0.0.0 if DHCP is not
used for IP address assignment, or if this agent is
not assigned an IPv4 address.
This object is deprecated and is replaced by
docsDevServerDhcpAddress."
::= { docsDevServer 2 }
docsDevServerTime OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-only
STATUS deprecated
DESCRIPTION
"The IP address of the Time server (RFC 0868). Returns
0.0.0.0 if the time server IP address is unknown, or if
the time server is not an IPv4 server.
This object is deprecated and is replaced by
docsDevServerTimeAddress."
::= { docsDevServer 3 }
docsDevServerTftp OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-only
STATUS deprecated
DESCRIPTION
"The IP address of the TFTP server responsible for
downloading provisioning and configuration parameters
to this device. Returns 0.0.0.0 if the TFTP server
address is unknown or is not an IPv4 address.
This object is deprecated and is replaced by
docsDevServerConfigTftpAddress."
::= { docsDevServer 4 }
docsDevServerConfigFile OBJECT-TYPE
SYNTAX SnmpAdminString
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The name of the device configuration file read from
the TFTP server. Returns a zero-length string if
the configuration file name is unknown."
::= { docsDevServer 5 }
docsDevServerDhcpAddressType 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 address of docsDevServerDhcpAddress. If
DHCP was not used, this value should return
unknown(0)."
::= { docsDevServer 6 }
docsDevServerDhcpAddress OBJECT-TYPE
SYNTAX InetAddress
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The internet address of the DHCP server that assigned
an IP address to this device. Returns the zero length
octet string if DHCP was not used for IP address
assignment."
::= { docsDevServer 7 }
docsDevServerTimeAddressType 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 address of docsDevServerTimeAddress. If
no time server exists, this value should return
unknown(0)."
::= { docsDevServer 8 }
docsDevServerTimeAddress OBJECT-TYPE
SYNTAX InetAddress
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The Internet address of the RFC 868 Time server,
as provided by DHCP option 4.
Note that if multiple values are provided to the
CM in DHCP option 4, the value of this MIB object
MUST be the Time server address from which the Time
of Day reference was acquired as based on the DOCSIS
RFI specification. During the period of time where
the Time of Day have not been acquired, the Time
server address reported by the CM may report the
first address value in the DHCP option value or the
last server address the CM attempted to get the Time
of day value.
Returns the zero-length octet string if the time server
IP address is not provisioned."
REFERENCE
"DOCSIS RFI 1.1 Specification, Section 9.2.7. and
DOCSIS RFI 2.0 Specification, Section 11.2.7."
::= { docsDevServer 9 }
docsDevServerConfigTftpAddressType 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 address of docsDevServerConfigTftpAddress.
If no TFTP server exists, this value should return
unknown(0)."
::= { docsDevServer 10 }
docsDevServerConfigTftpAddress OBJECT-TYPE
SYNTAX InetAddress
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The internet address of the TFTP server responsible for
downloading provisioning and configuration parameters
to this device. Returns the zero-length octet string if
the config server address is unknown. There are certain
security risks that are involved with using TFTP."
REFERENCE
"RFC 3617, Section 5"
::= { docsDevServer 11 }
docsDevEvControl OBJECT-TYPE
SYNTAX INTEGER {
resetLog(1),
useDefaultReporting(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Setting this object to resetLog(1) empties the event
log. All data is deleted. Setting it to
useDefaultReporting(2) returns all event priorities to
their factory-default reporting. Reading this object
always returns useDefaultReporting(2)."
::= { docsDevEvent 1 }
docsDevEvSyslog OBJECT-TYPE
SYNTAX IpAddress
ACCESS read-write
STATUS deprecated
DESCRIPTION
"The IP address of the Syslog server. If 0.0.0.0, either
syslog transmission is inhibited, or the Syslog server
address is not an IPv4 address.
This object is deprecated and is replaced by
docsDevEvSyslogAddress."
::= { docsDevEvent 2 }
docsDevEvThrottleAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
unconstrained(1),
maintainBelowThreshold(2),
stopAtThreshold(3),
inhibited(4)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Controls the transmission of traps and syslog messages
with respect to the trap pacing threshold.
unconstrained(1) causes traps and syslog messages to be
transmitted without regard to the threshold settings.
maintainBelowThreshold(2) causes trap transmission and
syslog messages to be suppressed if the number of traps
would otherwise exceed the threshold.
stopAtThreshold(3) causes trap transmission to cease at
the threshold and not to resume until directed to do so.
inhibited(4) causes all trap transmission and syslog
messages to be suppressed.
A single event is always treated as a single event for
threshold counting. That is, an event causing both a
trap and a syslog message is still treated as a single
event.
Writing to this object resets the thresholding state."
DEFVAL { unconstrained }
::= { docsDevEvent 3 }
docsDevEvThrottleInhibited OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-only
STATUS deprecated
DESCRIPTION
"If true(1), trap and syslog transmission is currently
inhibited due to thresholds and/or the current setting
of docsDevEvThrottleAdminStatus. In addition, this is
true(1) when transmission is inhibited because no
syslog (docsDevEvSyslog) or trap (docsDevNmAccessEntry)
destinations have been set.