-
Notifications
You must be signed in to change notification settings - Fork 21
/
tr-098-1-2-0-full.xml
18609 lines (17135 loc) · 718 KB
/
tr-098-1-2-0-full.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<!--
TR-069 InternetGatewayDevice:1.4 Root Object definition
Copyright (c) 2009-2017, Broadband Forum
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only.
Please reference the Forum IPR Policy for patent licensing terms
<https://www.broadband-forum.org/ipr-policy>.
Any moral rights which are necessary to exercise under the above
license grant are also deemed granted under this license.
Summary:
TR-069 InternetGatewayDevice:1.4 Root Object Definition. Contains definition of
InternetGatewayDevice:1.4 Root Object.
Version History:
March 2009: tr-098-1-2-0.xml, corresponds to TR-098 Amendment 1 sections 2.4 (Data
Model), 2.4.1 (Inform and Notification Requirements) and 3 (Profile
Definitions).
September 2009: tr-098-1-2-0.xml (name unchanged)
- fixed header information (had been cut-and-pasted from elsewhere)
- changed WLANConfigurationNumberOfEntries to (wrong but consistent)
LANWLANConfigurationNumberOfEntries
- fixed 802.1Q-2004 reference to 802.1Q-2005
- fixed cwmp-datamodel.xsd to be cwmp-datamodel-1-0.xsd
-->
<dm:document
xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-14"
xmlns:dmr="urn:broadband-forum-org:cwmp:datamodel-report-0-1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="
urn:broadband-forum-org:cwmp:datamodel-1-14
http://www.broadband-forum.org/cwmp/cwmp-datamodel-1-14.xsd
urn:broadband-forum-org:cwmp:datamodel-report-0-1
cwmp-datamodel-report.xsd"
spec="urn:broadband-forum-org:tr-098-1-2-0">
<dataType name="IPAddress">
<description>
IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.
All IPv4 addresses and subnet masks MUST be represented as strings in
IPv4 dotted-decimal notation. Here are some examples of valid IPv4
address textual representations:
* 216.52.29.100
* 192.168.1.254
All IPv6 addresses MUST be represented using any of the 3 standard
textual representations defined in {{bibref|RFC4291}} Sections 2.2.1,
2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but
use of lower-case letters is RECOMMENDED. Here are some examples of valid
IPv6 address textual representations:
* 1080:0:0:800:ba98:3210:11aa:12dd
* 1080::800:ba98:3210:11aa:12dd
* 0:0:0:0:0:0:13.1.68.3
IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are
discussed in {{bibref|RFC4007|Section 6}}.
Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be
represented as empty strings unless otherwise specified by the parameter
definition.
</description>
<string>
<size maxLength="45"/>
</string>
</dataType>
<dataType name="MACAddress">
<description>
All MAC addresses are represented as strings of 12 hexadecimal digits
(digits 0-9, letters A-F or a-f) displayed as six pairs of digits
separated by colons. Unspecified or inapplicable MAC addresses MUST be
represented as empty strings unless otherwise specified by the parameter
definition.
</description>
<string>
<size maxLength="17"/>
<pattern value=""/>
<pattern value="([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])"/>
</string>
</dataType>
<bibliography>
<reference id="OUI">
<name>Organizationally Unique Identifiers (OUIs)</name>
<hyperlink>https://standards.ieee.org/faqs/regauth</hyperlink>
</reference>
<reference id="IEEE_EUI64">
<name>
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority
</name>
<title>
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority
</title>
<organization>IEEE</organization>
<date>March 1997</date>
<hyperlink>
https://standards.ieee.org/regauth/oui/tutorials/EUI64.html
</hyperlink>
</reference>
<reference id="802.1D-2004">
<name>IEEE Std 802.1D-2004</name>
<title>Media Access Control (MAC) Bridges</title>
<organization>IEEE</organization>
<date>2004</date>
<hyperlink>
https://standards.ieee.org/getieee802/download/802.1D-2004.pdf
</hyperlink>
</reference>
<reference id="802.1Q-2005">
<name>IEEE Std 802.1Q-2005</name>
<title>Virtual Bridged Local Area Networks</title>
<organization>IEEE</organization>
<date>2006</date>
<hyperlink>
https://standards.ieee.org/getieee802/download/802.1Q-2005.pdf
</hyperlink>
</reference>
<reference id="IANA-uri-schemes">
<name>IANA Uniform Resource Identifier (URI) Schemes Registry</name>
<title>Uniform Resource Identifier (URI) Schemes</title>
<organization>IANA</organization>
<hyperlink>https://www.iana.org/assignments/uri-schemes</hyperlink>
</reference>
<reference id="RFC862">
<name>RFC 862</name>
<title>Echo Protocol</title>
<organization>IETF</organization>
<category>RFC</category>
<date>1983</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc862</hyperlink>
</reference>
<reference id="RFC2131">
<name>RFC 2131</name>
<title>Dynamic Host Configuration Protocol</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2131</hyperlink>
</reference>
<reference id="RFC2132">
<name>RFC 2132</name>
<title>DHCP Options and BOOTP Vendor Extensions</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2132</hyperlink>
</reference>
<reference id="RFC2225">
<name>RFC 2225</name>
<title>Classical IP and ARP over ATM</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2225</hyperlink>
</reference>
<reference id="RFC2474">
<name>RFC 2474</name>
<title>
Definition of the Differentiated Services Field (DS Field) in the IPv4
and IPv6 Headers
</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2474</hyperlink>
</reference>
<reference id="RFC2516">
<name>RFC 2516</name>
<title>A Method for Transmitting PPP Over Ethernet (PPPoE)</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2516</hyperlink>
</reference>
<reference id="RFC2616">
<name>RFC 2616</name>
<title>Hypertext Transfer Protocol - HTTP/1.1</title>
<organization>IETF</organization>
<category>RFC</category>
<date>1999</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2616</hyperlink>
</reference>
<reference id="RFC2634">
<name>RFC 2634</name>
<title>Enhanced Security Services for S/MIME</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2634</hyperlink>
</reference>
<reference id="RFC2662">
<name>RFC 2662</name>
<title>Definitions of Managed Objects for the ADSL Lines</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2662</hyperlink>
</reference>
<reference id="RFC2684">
<name>RFC 2684</name>
<title>Multiprotocol Encapsulation over ATM Adaptation Layer 5</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2684</hyperlink>
</reference>
<reference id="RFC2697">
<name>RFC 2697</name>
<title>A Single Rate Three Color Marker</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2697</hyperlink>
</reference>
<reference id="RFC2698">
<name>RFC 2698</name>
<title>A Two Rate Three Color Marker</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2698</hyperlink>
</reference>
<reference id="RFC2898">
<name>RFC 2898</name>
<title>
PKCS #5: Password-Based Cryptography Specification Version 2.0
</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc2898</hyperlink>
</reference>
<reference id="RFC3004">
<name>RFC 3004</name>
<title>The User Class Option for DHCP</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc3004</hyperlink>
</reference>
<reference id="RFC3066">
<name>RFC 3066</name>
<title>Tags for the Identification of Languages</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc3066</hyperlink>
</reference>
<reference id="RFC3489">
<name>RFC 3489</name>
<title>
STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network
Address Translators (NATs)
</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc3489</hyperlink>
</reference>
<reference id="RFC3925">
<name>RFC 3925</name>
<title>
Vendor-Identifying Vendor Options for Dynamic Host Configuration
Protocol version 4 (DHCPv4)
</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc3925</hyperlink>
</reference>
<reference id="RFC3986">
<name>RFC 3986</name>
<title>Uniform Resource Identifier (URI): Generic Syntax</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc3986</hyperlink>
</reference>
<reference id="RFC4007">
<name>RFC 4007</name>
<title>IPv6 Scoped Address Architecture</title>
<organization>IETF</organization>
<category>RFC</category>
<hyperlink>https://www.rfc-editor.org/rfc/rfc4007</hyperlink>
</reference>
<reference id="RFC4122">
<name>RFC 4122</name>
<title>A Universally Unique IDentifier (UUID) URN Namespace</title>
<organization>IETF</organization>
<category>RFC</category>
<date>2005</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc4122</hyperlink>
</reference>
<reference id="RFC4291">
<name>RFC 4291</name>
<title>IP Version 6 Addressing Architecture</title>
<organization>IETF</organization>
<category>RFC</category>
<date>2006</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc4291</hyperlink>
</reference>
<reference id="RFC4632">
<name>RFC 4632</name>
<title>
Classless Inter-domain Routing (CIDR): The Internet Address Assignment
and Aggregation Plan
</title>
<organization>IETF</organization>
<date>2006</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc4632</hyperlink>
</reference>
<reference id="RFC7159">
<name>RFC7159</name>
<title>
The JavaScript Object Notation (JSON) Data Interchange Format
</title>
<organization>IETF</organization>
<category>RFC</category>
<date>March 2014</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc7159</hyperlink>
</reference>
<reference id="RFC7230">
<name>RFC 7230</name>
<title>
Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing
</title>
<organization>IETF</organization>
<category>RFC</category>
<date>June 2014</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc7230</hyperlink>
</reference>
<reference id="RFC7252">
<name>RFC 7252</name>
<title>The Constrained Application Protocol (CoAP)</title>
<organization>IETF</organization>
<category>RFC</category>
<date>June 2014</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc7252</hyperlink>
</reference>
<reference id="RFC8141">
<name>RFC 8141</name>
<title>Uniform Resource Names (URNs)</title>
<organization>IETF</organization>
<category>RFC</category>
<date>April 2017</date>
<hyperlink>https://www.rfc-editor.org/rfc/rfc8141</hyperlink>
</reference>
<reference id="TR-069a2">
<name>TR-069 Amendment 2</name>
<title>CPE WAN Management Protocol</title>
<organization>Broadband Forum</organization>
<category>TR</category>
<date>December 2007</date>
</reference>
<reference id="TR-069">
<name>TR-069 Amendment 6</name>
<title>CPE WAN Management Protocol</title>
<organization>Broadband Forum</organization>
<category>TR</category>
<date>April 2018</date>
</reference>
<reference id="TR-098a1">
<name>TR-098 Amendment 1</name>
<title>Internet Gateway Device Data Model for TR-069</title>
<organization>Broadband Forum</organization>
<category>TR</category>
<date>December 2006</date>
</reference>
<reference id="TR-098a2">
<name>TR-098 Amendment 2</name>
<title>Internet Gateway Device Data Model for TR-069</title>
<organization>Broadband Forum</organization>
<category>TR</category>
<date>September 2008</date>
</reference>
<reference id="TR-106a1">
<name>TR-106 Amendment 1</name>
<title>Data Model Template for TR-069-Enabled Devices</title>
<organization>Broadband Forum</organization>
<category>TR</category>
<date>November 2006</date>
</reference>
<reference id="TR-143">
<name>TR-143 Amendment 1 Corrigendum 1</name>
<title>
Enabling Network Throughput Performance Tests and Statistical
Monitoring
</title>
<organization>Broadband Forum</organization>
<category>TR</category>
<date>August 2015</date>
</reference>
<reference id="WPSv1.0">
<name>Wi-Fi Protected Setup Specification Version 1.0h</name>
<title>Wi-Fi Alliance</title>
<date>2006</date>
<hyperlink>
https://www.wi-fi.org/discover-wi-fi/specifications
</hyperlink>
</reference>
<reference id="BLUE">
<name>Blue</name>
<title>A New Class of Active Queue Management Algorithms</title>
<hyperlink>
https://en.wikipedia.org/wiki/Blue_(queue_management_algorithm)
</hyperlink>
</reference>
<reference id="HTML4.01">
<name>HTML 4.01 Specification</name>
<organization>W3C</organization>
<hyperlink>https://www.w3.org/TR/html4</hyperlink>
</reference>
<reference id="RED">
<name>References on RED (Random Early Detection) Queue Management</name>
<hyperlink>http://www.icir.org/floyd/red.html</hyperlink>
</reference>
<reference id="SOAP1.1">
<name>Simple Object Access Protocol (SOAP) 1.1</name>
<organization>W3C</organization>
<hyperlink>https://www.w3.org/TR/2000/NOTE-SOAP-20000508</hyperlink>
</reference>
<reference id="ZigBee2007">
<name>ZigBee 2007 Specification</name>
<title>ZigBee 2007 Specification</title>
<organization>ZigBee Alliance</organization>
<date>October 2007</date>
<hyperlink>https://csa-iot.org/all-solutions/zigbee</hyperlink>
</reference>
</bibliography>
<model name="InternetGatewayDevice:1.4">
<object name="InternetGatewayDevice." access="readOnly" minEntries="1"
maxEntries="1">
<description>
The top-level object for an Internet Gateway Device.
</description>
<parameter name="DeviceSummary" access="readOnly" forcedInform="true"
dmr:previousParameter="">
<description>
As defined in {{bibref|TR-106a1}}.
</description>
<syntax>
<string>
<size maxLength="1024"/>
</string>
</syntax>
</parameter>
<parameter name="LANDeviceNumberOfEntries" access="readOnly">
<description>
Number of instances of {{object|LANDevice}}.
</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="WANDeviceNumberOfEntries" access="readOnly">
<description>
Number of instances of {{object|WANDevice}}.
</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Services." access="readOnly"
minEntries="1" maxEntries="1" dmr:previousObject="">
<description>
This object contains general services information.
</description>
</object>
<object name="InternetGatewayDevice.DeviceInfo." access="readOnly"
minEntries="1" maxEntries="1">
<description>
This object contains general device information.
</description>
<parameter name="Manufacturer" access="readOnly">
<description>
The manufacturer of the CPE (human readable string).
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="ManufacturerOUI" access="readOnly">
<description>
Organizationally unique identifier of the device manufacturer.
Represented as a six hexadecimal-digit value using all upper-case
letters and including any leading zeros. The value MUST be a valid
OUI as defined in {{bibref|OUI}}.
This value MUST remain fixed over the lifetime of the device,
including across firmware updates.
</description>
<syntax>
<string>
<size maxLength="6"/>
</string>
</syntax>
</parameter>
<parameter name="ModelName" access="readOnly">
<description>
Model name of the CPE (human readable string).
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="Description" access="readOnly">
<description>
A full description of the CPE device (human readable string).
</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ProductClass" access="readOnly">
<description>
Identifier of the class of product for which the serial number
applies. That is, for a given manufacturer, this parameter is used to
identify the product or class of product over which the
{{param|SerialNumber}} parameter is unique.
This value MUST remain fixed over the lifetime of the device,
including across firmware updates.
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="SerialNumber" access="readOnly">
<description>
Serial number of the CPE.
This value MUST remain fixed over the lifetime of the device,
including across firmware updates.
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="HardwareVersion" access="readOnly" forcedInform="true">
<description>
A string identifying the particular CPE model and version.
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="SoftwareVersion" access="readOnly"
activeNotify="forceEnabled" forcedInform="true">
<description>
A string identifying the software version currently installed in the
CPE. To allow version comparisons, this element SHOULD be in the form
of dot-delimited integers, where each successive integer represents a
more minor category of variation. For example, ''3.0.21'' where the
components mean: ''Major.Minor.Build''.
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="ModemFirmwareVersion" access="readOnly">
<description>
A string identifying the version of the modem firmware currently
installed in the CPE. This is applicable only when the modem firmware
is separable from the overall CPE software.
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="EnabledOptions" access="readOnly">
<description>
The OptionName of each Option that is currently enabled in the CPE.
The OptionName of each is identical to the OptionName element of the
OptionStruct described in {{bibref|TR-069a2}}. Only those options are
listed whose State indicates the option is enabled.
</description>
<syntax>
<list>
<size maxLength="1024"/>
</list>
<string/>
</syntax>
</parameter>
<parameter name="AdditionalHardwareVersion" access="readOnly">
<description>
Any additional hardware version information the vendor might wish to
supply.
</description>
<syntax>
<list>
<size maxLength="64"/>
</list>
<string/>
</syntax>
</parameter>
<parameter name="AdditionalSoftwareVersion" access="readOnly">
<description>
Any additional software version information the vendor might wish to
supply.
</description>
<syntax>
<list>
<size maxLength="64"/>
</list>
<string/>
</syntax>
</parameter>
<parameter name="SpecVersion" access="readOnly" status="deprecated"
forcedInform="true">
<description>
Represents the version of the specification implemented by the
device. Currently 1.0 is the only available version. The value of
this parameter MUST equal "1.0". This parameter is DEPRECATED because
its value is fixed and it therefore serves no purpose. However, it is
a Forced Inform parameter and therefore cannot be OBSOLETED.
</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
<default type="object" value="1.0" status="deleted"/>
</syntax>
</parameter>
<parameter name="ProvisioningCode" access="readWrite"
activeNotify="forceEnabled" forcedInform="true">
<description>
Identifier of the primary service provider and other provisioning
information, which MAY be used by the ACS to determine service
provider-specific customization and provisioning parameters. If not
{{empty}}, this argument SHOULD be in the form of a hierarchical
descriptor with one or more nodes specified. Each node in the
hierarchy is represented as a 4-character sub-string, containing only
numerals or upper-case letters. If there is more than one node
indicated, each node is separated by a "." (dot). Examples: "TLCO" or
"TLCO.GRP2".
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="UpTime" access="readOnly" activeNotify="canDeny">
<description>
Time in seconds since the CPE was last restarted.
</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="FirstUseDate" access="readOnly">
<description>
Date and time in UTC that the CPE first both successfully established
an IP-layer network connection and acquired an absolute time
reference using NTP or equivalent over that network connection. The
CPE MAY reset this date after a factory reset.
If NTP or equivalent is not available, this parameter, if present,
SHOULD be set to the Unknown Time value.
</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="DeviceLog" access="readOnly" activeNotify="canDeny">
<description>
Vendor-specific log(s).
</description>
<syntax>
<string>
<size maxLength="32768"/>
</string>
</syntax>
</parameter>
<parameter name="VendorConfigFileNumberOfEntries" access="readOnly">
<description>
Number of instances of {{object|VendorConfigFile}}.
</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.DeviceInfo.VendorConfigFile.{i}."
access="readOnly" minEntries="0" maxEntries="unbounded"
numEntriesParameter="VendorConfigFileNumberOfEntries">
<description>
Every instance of this object is a Vendor Configuration File, and
contains parameters associated with the Vendor Configuration File.
This table of Vendor Configuration Files is for information only and
does not allow the ACS to operate on these files in any way. Whenever
the CPE successfully downloads a configuration file as a result of the
Download RPC with the FileType argument of ''3 Vendor Configuration
File'', the CPE MUST update this table. If the name of the file
(determined as described in the definition of the {{param|Name}}
parameter) differs from that of any existing instance, then the CPE
MUST create a new instance to represent this file. If instead, the name
of the file is identical to that of an existing instance, then the CPE
MUST update the content of the existing instance with the new version,
date, and (optionally) description of the file.{{nokeys}}
</description>
<uniqueKey>
<parameter ref="Name"/>
</uniqueKey>
<parameter name="Name" access="readOnly">
<description>
Name of the vendor configuration file.
If the CPE is able to obtain the name of the configuration file from
the file itself, then the value of this parameter MUST be set to that
name. Otherwise, if the CPE can extract the file name from the URL
used to download the configuration file, then the value of this
parameter MUST be set to that name. Otherwise, the value of this
parameter MUST be set to the value of the TargetFileName argument of
the Download RPC used to download this configuration file.
</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="Version" access="readOnly">
<description>
A string identifying the configuration file version currently used in
the CPE.
If the CPE is able to obtain the version of the configuration file
from the file itself, then the value of this parameter MUST be set to
the obtained value. Otherwise, the value of this parameter MUST be
{{empty}}.
</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
</syntax>
</parameter>
<parameter name="Date" access="readOnly">
<description>
Date and time when the content of the current version of this vendor
configuration file was first applied by the CPE.
</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="Description" access="readOnly">
<description>
A description of the vendor configuration file (human-readable
string).
</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.DeviceConfig." access="readOnly"
minEntries="1" maxEntries="1">
<description>
This object contains general configuration parameters.
</description>
<parameter name="PersistentData" access="readWrite">
<description>
Arbitrary user data that MUST persist across CPE reboots.
</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ConfigFile" access="readWrite">
<description>
A dump of the currently running configuration on the CPE. This
parameter enables the ability to backup and restore the last known
good state of the CPE. It returns a vendor-specific document that
defines the state of the CPE. The document MUST be capable of
restoring the CPE's state when written back to the CPE using
SetParameterValues.
An alternative to this parameter, e.g. when the configuration file is
larger than the parameter size limit, is to use the Upload and
Download RPCs with a FileType of ''1 Vendor Configuration File''.
</description>
<syntax>
<string>
<size maxLength="32768"/>
</string>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.ManagementServer." access="readOnly"
minEntries="1" maxEntries="1">
<description>
This object contains parameters relating to the CPE's association with
an ACS.
</description>
<parameter name="EnableCWMP" access="readWrite" dmr:previousParameter="">
<description>
Enables and disables the CPE's support for CWMP. {{false}} means that
CWMP support in the CPE is disabled, in which case the device MUST
NOT send any Inform messages to the ACS or accept any Connection
Request notifications from the ACS. {{true}} means that CWMP support
on the CPE is enabled. The factory default value MUST be {{true}}.
The subscriber can re-enable the CPE's CWMP support either by
performing a factory reset or by using a LAN-side protocol to change
the value of this parameter back to {{true}}.
</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="URL" access="readWrite">
<description>
URL, as defined in {{bibref|RFC3986}}, for the CPE to connect to the
ACS using the CPE WAN Management Protocol. This parameter MUST be in
the form of a valid HTTP or HTTPS URL {{bibref|RFC2616}}. The
''host'' portion of this URL is used by the CPE for validating the
ACS certificate when using SSL or TLS. Note that on a factory reset
of the CPE, the value of this parameter might be reset to its factory
value. If an ACS modifies the value of this parameter, it SHOULD be
prepared to accommodate the situation that the original value is
restored as the result of a factory reset.
</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="Username" access="readWrite">
<description>
Username used to authenticate the CPE when making a connection to the
ACS using the CPE WAN Management Protocol. This username is used only
for HTTP-based authentication of the CPE.
Note that on a factory reset of the CPE, the value of this parameter
might be reset to its factory value. If an ACS modifies the value of
this parameter, it SHOULD be prepared to accommodate the situation
that the original value is restored as the result of a factory reset.
</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="Password" access="readWrite">
<description>
Password used to authenticate the CPE when making a connection to the
ACS using the CPE WAN Management Protocol. This password is used only
for HTTP-based authentication of the CPE.
Note that on a factory reset of the CPE, the value of this parameter
might be reset to its factory value. If an ACS modifies the value of
this parameter, it SHOULD be prepared to accommodate the situation
that the original value is restored as the result of a factory reset.
</description>
<syntax hidden="true">
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="PeriodicInformEnable" access="readWrite">
<description>
Whether or not the CPE MUST periodically send CPE information to the
ACS using the Inform method call.
</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="PeriodicInformInterval" access="readWrite">
<description>
The duration in seconds of the interval for which the CPE MUST
attempt to connect with the ACS and call the Inform method if
{{param|PeriodicInformEnable}} is {{true}}.
</description>
<syntax>
<unsignedInt>
<range minInclusive="1"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="PeriodicInformTime" access="readWrite">
<description>
An absolute time reference in UTC to determine when the CPE will
initiate the periodic Inform method calls. Each Inform call MUST
occur at this reference time plus or minus an integer multiple of the
{{param|PeriodicInformInterval}}. {{param}} is used only to set the
"phase" of the periodic Informs. The actual value of {{param}} can be
arbitrarily far into the past or future. For example, if
{{param|PeriodicInformInterval}} is 86400 (a day) and if {{param}} is
set to UTC midnight on some day (in the past, present, or future)
then periodic Informs will occur every day at UTC midnight. These
MUST begin on the very next midnight, even if {{param}} refers to a
day in the future. The Unknown Time value defined in
{{bibref|TR-098a2|section 2.2}} indicates that no particular time
reference is specified. That is, the CPE MAY locally choose the time
reference, and needs only to adhere to the specified
{{param|PeriodicInformInterval}}. If absolute time is not available
to the CPE, its periodic Inform behavior MUST be the same as if the
{{param}} parameter was set to the Unknown Time value.
</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="ParameterKey" access="readOnly" activeNotify="canDeny"
forcedInform="true">
<description>
{{param}} provides the ACS a reliable and extensible means to track