-
Notifications
You must be signed in to change notification settings - Fork 21
/
Copy pathtr-069-1-0-0.xml
3837 lines (3824 loc) · 180 KB
/
tr-069-1-0-0.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.0 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.0 Root Object Definition. Contains definition of
InternetGatewayDevice:1.0 Root Object.
Version History:
March 2009: tr-069-1-0-0.xml, corresponds to TR-069 appendix B (CPE Parameters).
September 2009: tr-069-1-0-0.xml (name unchanged)
- changed WLANConfigurationNumberOfEntries to (wrong but consistent)
LANWLANConfigurationNumberOfEntries
- fixed cwmp-datamodel.xsd to be cwmp-datamodel-1-0.xsd
-->
<dm:document xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-0"
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-0 cwmp-datamodel-1-0.xsd
urn:broadband-forum-org:cwmp:datamodel-report-0-1 cwmp-datamodel-report.xsd"
spec="urn:broadband-forum-org:tr-069-1-0-0">
<import file="tr-069-biblio.xml" spec="urn:broadband-forum-org:tr-069-biblio"/>
<import file="tr-106-1-0-types.xml" spec="urn:broadband-forum-org:tr-106-1-0">
<dataType name="IPAddress"/>
<dataType name="MACAddress"/>
</import>
<model name="InternetGatewayDevice:1.0">
<object name="InternetGatewayDevice." access="readOnly" minEntries="1" maxEntries="1">
<description>The top-level object for an Internet Gateway Device.</description>
<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.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}}.</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.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="SerialNumber" access="readOnly">
<description>Serial number of the CPE.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="HardwareVersion" access="readOnly">
<description>A string identifying the particular CPE model and version.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="SoftwareVersion" access="readOnly">
<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-069|Table 48}}. 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>Represents any additional hardware version information the vendor may wish to supply.</description>
<syntax>
<list>
<size maxLength="64"/>
</list>
<string/>
</syntax>
</parameter>
<parameter name="AdditionalSoftwareVersion" access="readOnly">
<description>Represents any additional software version information the vendor may wish to supply.</description>
<syntax>
<list>
<size maxLength="64"/>
</list>
<string/>
</syntax>
</parameter>
<parameter name="SpecVersion" access="readOnly">
<description>Represents the version of the specification implemented by the device. Currently 1.0 is the only available version.</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
</syntax>
</parameter>
<parameter name="ProvisioningCode" access="readWrite">
<description>Identifier of the primary service provider and other provisioning information, which MAY be used by the Server 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">
<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 successfully established a network connection.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="DeviceLog" access="readOnly">
<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.</description>
<uniqueKey>
<parameter ref="Name"/>
</uniqueKey>
<parameter name="Name" access="readOnly">
<description>Name of the vendor 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.</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.</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="URL" access="readWrite">
<description>URL 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}}. An HTTPS URL indicates that the ACS supports SSL.
The ''host'' portion of this URL is used by the CPE for validating the certificate from the ACS when using certificate-based authentication.</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.</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.</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 Server 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 should initiate the Inform method calls. Each Inform call must occur at this reference time plus or minus an integer multiple of the {{param|PeriodicInformInterval}}.
A zero dateTime value (0000-00-00T00:00:00) indicates that no particular time reference is specified. That is, the CPE may locally choose the time reference, required only to adhere to the specified {{param|PeriodicInformInterval}}.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="ParameterKey" access="readOnly">
<description>The value of the ParameterKey argument from the most recent SetParameterValues, AddObject, or DeleteObject method call from the Server. If there have been no such calls, this value is empty.</description>
<syntax>
<string>
<size maxLength="32"/>
</string>
</syntax>
</parameter>
<parameter name="ConnectionRequestURL" access="readOnly">
<description>HTTP URL for an ACS to make a Connection Request notification to the CPE.
In the form:
: http://host:port/path
The ''host'' portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ConnectionRequestUsername" access="readWrite">
<description>Username used to authenticate an ACS making a Connection Request to the CPE.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ConnectionRequestPassword" access="readWrite">
<description>Password used to authenticate an ACS making a Connection Request to the CPE.</description>
<syntax hidden="true">
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="UpgradesManaged" access="readWrite">
<description>Indicates whether or not the ACS will manage upgrades for the CPE. If {{true}}, the CPE SHOULD not use other means other than the ACS to seek out available upgrades. If {{false}}, the CPE MAY use other means for this purpose.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="KickURL" access="readOnly">
<description>Present only for a CPE that supports the Kicked RPC method.
LAN-accessible URL from which the CPE can be "kicked" to initiate the Kicked RPC method call. MUST be an absolute URL including a host name or IP address as would be used on the LAN side of the CPE.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="DownloadProgressURL" access="readOnly">
<description>Present only for a CPE that provides a LAN-side web page to show progress during a file download.
LAN-accessible URL to which a web-server associated with the ACS may redirect a user's browser on initiation of a file download to observer the status of the download.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Time." access="readOnly" minEntries="1" maxEntries="1">
<description>This object contains parameters relating an NTP or SNTP time client in the CPE. Support for this object is Optional.</description>
<parameter name="NTPServer1" access="readWrite">
<description>First NTP timeserver. Either a host name or IP address.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="NTPServer2" access="readWrite">
<description>Second NTP timeserver. Either a host name or IP address.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="NTPServer3" access="readWrite">
<description>Third NTP timeserver. Either a host name or IP address.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="NTPServer4" access="readWrite">
<description>Fourth NTP timeserver. Either a host name or IP address.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="NTPServer5" access="readWrite">
<description>Fifth NTP timeserver. Either a host name or IP address.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="CurrentLocalTime" access="readOnly">
<description>The current date and time in the CPE's local time zone.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="LocalTimeZone" access="readWrite">
<description>The local time offset from UTC in the form:
: +hh:mm
: -hh:mm</description>
<syntax>
<string>
<size maxLength="6"/>
</string>
</syntax>
</parameter>
<parameter name="LocalTimeZoneName" access="readWrite">
<description>Name of the local time zone (human readable string).</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="DaylightSavingsUsed" access="readWrite">
<description>Whether or not daylight savings time is in use in the CPE's local time zone.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="DaylightSavingsStart" access="readWrite">
<description>Date and time daylight savings time begins if used in local standard time. If daylight savings time is not used, this value is ignored.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="DaylightSavingsEnd" access="readWrite">
<description>Date and time daylight savings time ends if used in local daylight time. If daylight savings time is not used, this value is ignored.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.UserInterface." access="readOnly" minEntries="1" maxEntries="1">
<description>This object contains parameters relating to the user interface of the CPE. Support for this object is Optional.</description>
<parameter name="PasswordRequired" access="readWrite">
<description>Present only if the CPE provides a password-protected LAN-side user interface.
Indicates whether or not the local user interface must require a password to be chosen by the user. If {{false}}, the choice of whether or not a password is used is left to the user.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="PasswordUserSelectable" access="readWrite">
<description>Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.
Indicates whether or not a password to protect the local user interface of the CPE may be selected by the user directly, or must be equal to the password used by the LAN-side Auto-Configuration protocol.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="UpgradeAvailable" access="readWrite">
<description>Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="WarrantyDate" access="readWrite">
<description>Indicates the date and time in UTC that the warranty associated with the CPE is to expire.</description>
<syntax>
<dateTime/>
</syntax>
</parameter>
<parameter name="ISPName" access="readWrite">
<description>The name of the customer's ISP.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="ISPHelpDesk" access="readWrite">
<description>The help desk phone number of the ISP.</description>
<syntax>
<string>
<size maxLength="32"/>
</string>
</syntax>
</parameter>
<parameter name="ISPHomePage" access="readWrite">
<description>The URL of the ISP's home page.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ISPHelpPage" access="readWrite">
<description>The URL of the ISP's on-line support page.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ISPLogo" access="readWrite">
<description>Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less.</description>
<syntax>
<base64>
<size minLength="0" maxLength="4095"/>
</base64>
</syntax>
</parameter>
<parameter name="ISPLogoSize" access="readWrite">
<description>Un-encoded binary image size in bytes.
If ISPLogoSize input value is 0 then the ISPLogo is cleared.
ISPLogoSize can also be used as a check to verify correct transfer and conversion of Base64 string to image size.</description>
<syntax>
<unsignedInt>
<range minInclusive="0" maxInclusive="4095"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="ISPMailServer" access="readWrite">
<description>The URL of the ISP's mail server.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ISPNewsServer" access="readWrite">
<description>The URL of the ISP's news server.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="TextColor" access="readWrite">
<description>The color of text on the GUI screens in RGB hexidecimal notation (e.g., FF0088).</description>
<syntax>
<string>
<size maxLength="6"/>
</string>
</syntax>
</parameter>
<parameter name="BackgroundColor" access="readWrite">
<description>The color of the GUI screen backgrounds in RGB hexidecimal notation (e.g., FF0088).</description>
<syntax>
<string>
<size maxLength="6"/>
</string>
</syntax>
</parameter>
<parameter name="ButtonColor" access="readWrite">
<description>The color of buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088).</description>
<syntax>
<string>
<size maxLength="6"/>
</string>
</syntax>
</parameter>
<parameter name="ButtonTextColor" access="readWrite">
<description>The color of text on buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088).</description>
<syntax>
<string>
<size maxLength="6"/>
</string>
</syntax>
</parameter>
<parameter name="AutoUpdateServer" access="readWrite">
<description>The server the CPE can check to see if an update is available for direct download to it. This MUST NOT be used by the CPE if the {{param|InternetGatewayDevice.ManagementServer.UpgradesManaged}} parameter is {{true}}.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="UserUpdateServer" access="readWrite">
<description>The server where a user can check via a web browser if an update is available for download to a PC. This MUST NOT be used by the CPE if the {{param|InternetGatewayDevice.ManagementServer.UpgradesManaged}} parameter is {{true}}.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ExampleLogin" access="readWrite">
<description>An example of a correct login, according to ISP-specific rules.</description>
<syntax>
<string>
<size maxLength="40"/>
</string>
</syntax>
</parameter>
<parameter name="ExamplePassword" access="readWrite">
<description>An example of a correct password, according to ISP-specific rules.</description>
<syntax>
<string>
<size maxLength="30"/>
</string>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer3Forwarding." access="readOnly" minEntries="1" maxEntries="1">
<description>This object allows the handling of the routing and forwarding configuration of the device.</description>
<parameter name="DefaultConnectionService" access="readWrite">
<description>Specifies the default WAN interface. The content is the full hierarchical parameter name of the default layer-3 connection object. Example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="ForwardNumberOfEntries" access="readOnly">
<description>Number of forwarding instances.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="ForwardNumberOfEntries" enableParameter="Enable">
<description>Layer-3 forwarding table.</description>
<uniqueKey>
<parameter ref="DestIPAddress"/>
<parameter ref="DestSubnetMask"/>
<parameter ref="SourceIPAddress"/>
<parameter ref="SourceSubnetMask"/>
</uniqueKey>
<parameter name="Enable" access="readWrite">
<description>Enables or disables the forwarding entry. On creation, an entry is disabled by default.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="Status" access="readOnly">
<description>Indicates the status of the forwarding entry.</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Enabled"/>
<enumeration value="Error"/>
</string>
</syntax>
</parameter>
<parameter name="Type" access="readWrite">
<description>Indicates the type of route.</description>
<syntax>
<string>
<enumeration value="Default"/>
<enumeration value="Network"/>
<enumeration value="Host"/>
</string>
</syntax>
</parameter>
<parameter name="DestIPAddress" access="readWrite">
<description>Destination address.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="DestSubnetMask" access="readWrite">
<description>Destination subnet mask.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="SourceIPAddress" access="readWrite">
<description>Source address.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="SourceSubnetMask" access="readWrite">
<description>Source subnet mask.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="GatewayIPAddress" access="readWrite">
<description>IP address of the gateway.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="Interface" access="readWrite">
<description>Specifies the WAN interface associated with this entry. The content is the full hierarchical parameter name of the layer-3 connection object. Example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="ForwardingMetric" access="readWrite">
<description>Forwarding metric. A value of -1 indicates this metric is not used.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
</syntax>
</parameter>
<parameter name="MTU" access="readWrite">
<description>The maximum allowed size of an Ethernet frame for this route.</description>
<syntax>
<unsignedInt>
<range minInclusive="1" maxInclusive="1540"/>
</unsignedInt>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.LANConfigSecurity." access="readOnly" minEntries="1" maxEntries="1">
<description>This object contains generic device configuration information.</description>
<parameter name="ConfigPassword" access="readWrite">
<description>A password to allow LAN access to protected auto-configuration services.</description>
<syntax hidden="true">
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.IPPingDiagnostics." access="readOnly" minEntries="1" maxEntries="1">
<description>This object is provides access to an IP-layer ping test.</description>
<parameter name="DiagnosticsState" access="readWrite">
<description>Indicates availability of diagnostic data. {{enum}}
Value may be set to {{enum|Requested}} to initiate the diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}.
When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.
When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message.</description>
<syntax>
<string>
<enumeration value="None" access="readOnly"/>
<enumeration value="Requested"/>
<enumeration value="Complete" access="readOnly"/>
<enumeration value="Error_CannotResolveHostName" access="readOnly"/>
</string>
</syntax>
</parameter>
<parameter name="Interface" access="readWrite">
<description>Specifies the WAN or LAN IP-layer interface over which the test is to be performed. The content is the full hierarchical parameter name of the interface.
The following is a WAN interface example:
: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''
The following is a LAN interface example:
: ''InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1''</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="Host" access="readWrite">
<description>Host name or address of the host to ping.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="NumberOfRepetitions" access="readWrite">
<description>Number of repetitions of the ping test to perform before reporting the results.</description>
<syntax>
<unsignedInt>
<range minInclusive="1"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="Timeout" access="readWrite">
<description>Timeout in milliseconds for the ping test.</description>
<syntax>
<unsignedInt>
<range minInclusive="1"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="DataBlockSize" access="readWrite">
<description>Size of the data block in bytes to be sent for each ping.</description>
<syntax>
<unsignedInt>
<range minInclusive="1" maxInclusive="65535"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="DSCP" access="readWrite">
<description>DiffServ codepoint to be used for the test packets. By default the CPE should set this value to zero.</description>
<syntax>
<unsignedInt>
<range minInclusive="0" maxInclusive="64"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="SuccessCount" access="readOnly">
<description>Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="FailureCount" access="readOnly">
<description>Result parameter indicating the number of failed pings in the most recent ping test.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="AverageResponseTime" access="readOnly">
<description>Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MinimumResponseTmie" access="readOnly">
<description>Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaximumResponseTime" access="readOnly">
<description>Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.LANDevice.{i}." access="readOnly" minEntries="0" maxEntries="unbounded" numEntriesParameter="LANDeviceNumberOfEntries">
<description>Each instance contains all LAN-related objects for a given bridged subnet.</description>
<parameter name="LANEthernetInterfaceNumberOfEntries" access="readOnly">
<description>Number of instances of {{object|LANEthernetInterfaceConfig}} in this ''LANDevice''.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="LANUSBInterfaceNumberOfEntries" access="readOnly">
<description>Number of instances of {{object|LANUSBInterfaceConfig}} in this ''LANDevice''.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="LANWLANConfigurationNumberOfEntries" access="readOnly">
<description>Number of instances of {{object|WLANConfiguration}} in this ''LANDevice''.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement." access="readOnly" minEntries="1" maxEntries="1">
<description>This object enables reporting of LAN-related device information and setting and configuring LAN IP addressing.</description>
<parameter name="DHCPServerConfigurable" access="readWrite">
<description>Enables the configuration of the DHCP server on the LAN interface. If this variable is set to {{false}}, the CPE should restore its default DHCP server settings.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="DHCPServerEnable" access="readWrite">
<description>Enables or disables the DHCP server on the LAN interface.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="DHCPRelay" access="readOnly">
<description>Indicates if the DHCP server performs the role of a server (0) or a relay (1) on the LAN interface.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="MinAddress" access="readWrite">
<description>Specifies first address in the pool to be assigned by the DHCP server on the LAN interface.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="MaxAddress" access="readWrite">
<description>Specifies last address in the pool to be assigned by the DHCP server on the LAN interface.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="ReservedAddresses" access="readWrite">
<description>Comma separated list of addresses marked reserved from the address allocation pool.</description>
<syntax>
<list/>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="SubnetMask" access="readWrite">
<description>Specifies the client's network subnet mask.</description>
<syntax>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="DNSServers" access="readWrite">
<description>Comma separated list of DNS servers offered to DHCP clients. Support for more than three DNS Servers is Optional.</description>
<syntax>
<list/>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="DomainName" access="readWrite">
<description>Sets the domain name to provide to clients on the LAN interface.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
</syntax>
</parameter>
<parameter name="IPRouters" access="readWrite">
<description>Comma separated list of IP addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is Optional.</description>
<syntax>
<list/>
<dataType ref="IPAddress"/>
</syntax>
</parameter>
<parameter name="DHCPLeaseTime" access="readWrite">
<description>Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
</syntax>
</parameter>
<parameter name="UseAllocatedWAN" access="readWrite">
<description>{{enum}}
If {{enum|Normal}}, then DHCP addresses are to be allocated out of a private address pool.
If {{enum|UseAllocatedSubnet}}, instructs the CPE to allocate DHCP addresses from the WAN subnet block for the WAN connection identified in {{param|AssociatedConnection}}.
If {{enum|Passthrough}}, then the specified LAN Host identified by the Passthrough MAC address is given the WAN IP address.</description>
<syntax>
<string>
<enumeration value="Normal"/>
<enumeration value="UseAllocatedSubnet"/>
<enumeration value="Passthrough"/>
</string>
</syntax>
</parameter>
<parameter name="AssociatedConnection" access="readWrite">
<description>Specifies the connection instance for the connection to be used for address allocation if {{param|UseAllocatedWAN}} is set to {{enum|UseAllocatedSubnet|UseAllocatedWAN}} or {{enum|Passthrough|UseAllocatedWAN}}. The content is the full hierarchical parameter name of the default layer-3 connection object. Example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
<parameter name="PassthroughLease" access="readWrite">
<description>DHCP lease time in seconds given to the specified LAN Host when the WAN IP address is passed-through.
Note: A temporary private IP address with short lease (for example, 1 min) may be given to the passthrough LAN Host before the WAN IP address is acquired.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="PassthroughMACAddress" access="readWrite">
<description>Hardware address of the LAN Host that is used to passthrough the WAN IP address if {{param|UseAllocatedWAN}} is {{enum|Passthrough|UseAllocatedWAN}}.</description>
<syntax>
<dataType ref="MACAddress"/>
</syntax>
</parameter>
<parameter name="AllowedMACAddresses" access="readWrite">
<description>Hardware addresses that are allowed to connect to this connection if ''MACAddressControlEnabled'' is 1 for a given interface.</description>
<syntax>
<list/>
<dataType ref="MACAddress"/>
</syntax>
</parameter>
<parameter name="IPInterfaceNumberOfEntries" access="readOnly">
<description>Number of IP interface at LAN side of the CPE. 1 is a typical value for CPE not supporting Multihomed interfaces. Support for more than one interface instance is Optional.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.IPInterface.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="IPInterfaceNumberOfEntries" enableParameter="Enable">