-
Notifications
You must be signed in to change notification settings - Fork 21
/
cwmp-datamodel-1-7.xsd
1936 lines (1921 loc) · 87.7 KB
/
cwmp-datamodel-1-7.xsd
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"?>
<!--
Data Model Definition Schema (DM Schema) v1.7
Copyright (c) 2008-2019, 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:
CWMP and USP Data Model Definition Schema (DM Schema). DM Instances define CWMP
or USP data models. Within the schema, elements are grouped by category (simple
types, complex types etc), and are in alphabetical order within each category.
Issue History (Filename: Approval Date: Publication Date: Changes):
* cwmp-datamodel-1-0.xsd: November 2008: corresponds to TR-106 Amendment 2
* cwmp-datamodel-1-1.xsd: September 2009: corresponds to TR-106 Amendment 3
- made import/@file a URI and optional (in line with DT Schema)
- added RangeFacet step attribute
* cwmp-datamodel-1-2.xsd: March 2010: corresponds to TR-106 Amendment 4
- added uniqueKey/@functional attribute
- supported #.A relative path syntax (parent)
* cwmp-datamodel-1-3.xsd: November 2010: corresponds to TR-106 Amendment 5
- removed the referential check done on object/@enableParameter
- removed the referential check done on object/uniqueKey/parameter/@ref
- updated all of the unique parameter-name constraints so that the
parameter/@base attribute is also considered.
- updated all of the unique object-name constraints so that the
object/@base attribute is also considered.
- added "prefix" option to the description/@action attribute
- made import/@file attribute required for import element
- removed size facet's default maxLength on string/base64/hexBinary
parameters
- added syntax/@command attribute to the syntax element
* cwmp-datamodel-1-4.xsd: July 2011: corresponds to TR-106 Amendment 6
- added top-level @file attribute
* cwmp-datamodel-1-5.xsd: September 2013: October 7 2013: corresponds to TR-106 Amendment 7
- added profile/@minVersion attribute
- allowed uniqueKey parameters to be in sub-objects
- defined BibliographyReference type (previously anonymous)
- clarified encoding and character set requirements
- clarified that unique key parameters can't be lists
- added UUID data type
- added ListNesting data type, nestedBrackets attribute, and allowed
use of the list facet in named data type definitions
* cwmp-datamodel-1-6.xsd: March 2018: March 26 2018: corresponds to TR-106 Amendment 8
- supported USP commands, events and mount points
* cwmp-datamodel-1-7.xsd: September 13 2019: September 13 2019:
- supported implementation defaults, version attribute, description templates,
writeOnceReadOnly access type and the decimal datatype
-->
<!DOCTYPE cwmp-datamodel [
<!ENTITY colon ":">
<!ENTITY hash "#">
<!ENTITY dot "\.">
<!ENTITY inst "(\{i\})">
<!ENTITY name "([\i-[:]][\c-[:\.]]*)">
<!ENTITY Name "([\i-[a-z:]][\c-[:\.]]*)">
<!ENTITY num "(\d+)">
<!ENTITY exclam "!">
<!ENTITY parens "\(\)">
]>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:tns="urn:broadband-forum-org:cwmp:datamodel-1-7"
targetNamespace="urn:broadband-forum-org:cwmp:datamodel-1-7" elementFormDefault="unqualified"
attributeFormDefault="unqualified">
<!-- Simple types -->
<xs:simpleType name="AbbrefId">
<xs:annotation>
<xs:documentation>Abbreviation item ID; SHOULD uniquely identify this item across all instance documents.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token"/>
</xs:simpleType>
<xs:simpleType name="ActiveNotify">
<xs:annotation>
<xs:documentation>Parameter active notify support.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="normal"/>
<xs:enumeration value="forceEnabled"/>
<xs:enumeration value="forceDefaultEnabled"/>
<xs:enumeration value="canDeny"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="AnyTypeName">
<xs:annotation>
<xs:documentation>Built-in or derived type name.</xs:documentation>
</xs:annotation>
<xs:union memberTypes="tns:BuiltinTypeName tns:DataTypeName"/>
</xs:simpleType>
<xs:simpleType name="ArgumentDefaultType">
<xs:annotation>
<xs:documentation>Type of argument parameter default.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="parameter">
<xs:annotation>
<xs:documentation>Default if argument parameter isn't supported.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="BibrefId">
<xs:annotation>
<xs:documentation>Bibliographic reference ID; SHOULD uniquely identify this reference across all instance documents.
For BBF DM Instances, the bibliographic reference ID rules specified in A.2.4 MUST be used. For example, to reference TR-106 Issue 1 Amendment 2, the value of this attribute would be TR-106a2.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token"/>
</xs:simpleType>
<xs:simpleType name="BuiltinTypeName">
<xs:annotation>
<xs:documentation>Built-in type name.
The type hierarchy is as for XML Schema, with "any" and "base64" mapping to the "anySimpleType" and "base64Binary" XML Schema types respectively.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="any"/>
<xs:enumeration value="base64"/>
<xs:enumeration value="boolean"/>
<xs:enumeration value="dateTime"/>
<xs:enumeration value="decimal"/>
<xs:enumeration value="hexBinary"/>
<xs:enumeration value="integer"/>
<xs:enumeration value="int"/>
<xs:enumeration value="long"/>
<xs:enumeration value="string"/>
<xs:enumeration value="unsignedInt"/>
<xs:enumeration value="unsignedLong"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="CommandName">
<xs:annotation>
<xs:documentation>Command name (maximum length 256); the same as xs:NCName except that dots are not permitted and it's terminated with a "()". This name MUST in addition follow the vendor-specific parameter name requirements of section 3.3.
A command name SHOULD NOT start with an underscore or include any hyphens.
In BBF standards, a command name MUST NOT start with an underscore or include any hyphens.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:maxLength value="256"/>
<xs:pattern value="&name;&parens;"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ComponentName">
<xs:annotation>
<xs:documentation>Component name; the same as xs:NCName except that dots are not permitted.
A component which has a name beginning with an underscore is internal and cannot be imported by another DM Instance.
In BBF standards, a component name MUST NOT include any hyphens.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="&name;"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="DataTypeName">
<xs:annotation>
<xs:documentation>Data type name; the same as xs:NCName except that cannot start with lower-case letter (to avoid conflict with built-in data type names) and dots are not permitted.
A data type which has a name beginning with an underscore is internal and cannot be imported by another DM Instance.
In BBF standards, a data type name MUST NOT include any hyphens.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="&Name;"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="DescriptionAction">
<xs:annotation>
<xs:documentation>Description action.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="create"/>
<xs:enumeration value="prefix"/>
<xs:enumeration value="append"/>
<xs:enumeration value="replace"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="EventName">
<xs:annotation>
<xs:documentation>Event name (maximum length 256); the same as xs:NCName except that dots are not permitted and it's terminated with a "!". This name MUST in addition follow the vendor-specific parameter name requirements of section 3.3.
An event name SHOULD NOT start with an underscore or include any hyphens.
In BBF standards, an event name MUST NOT start with an underscore or include any hyphens.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:maxLength value="256"/>
<xs:pattern value="&name;&exclam;"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="GlorefId">
<xs:annotation>
<xs:documentation>Glossary item ID; SHOULD uniquely identify this item across all instance documents.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token"/>
</xs:simpleType>
<xs:simpleType name="ListNesting">
<xs:annotation>
<xs:documentation>Nested list escaping requirements. See section 3.2.3.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="legacy">
<xs:annotation>
<xs:documentation>MUST escape inner comma separators.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="permitted">
<xs:annotation>
<xs:documentation>MAY escape inner comma separators; MAY use bracketed nested list syntax.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="required">
<xs:annotation>
<xs:documentation>MUST use bracketed nested list syntax.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="MaxEntries">
<xs:annotation>
<xs:documentation>Positive integer or "unbounded".</xs:documentation>
</xs:annotation>
<xs:union memberTypes="xs:positiveInteger">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="unbounded"/>
</xs:restriction>
</xs:simpleType>
</xs:union>
</xs:simpleType>
<xs:simpleType name="ModelName">
<xs:annotation>
<xs:documentation>Model name, including major and minor versions. The name part is the same as xs:NCName except that dots are not permitted.
A model which has a name beginning with an underscore is internal and cannot be imported by another DM Instance.
In BBF standards, a model name MUST NOT include any hyphens.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="&name;:#˙#"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ModelNames">
<xs:annotation>
<xs:documentation>List of model names.</xs:documentation>
</xs:annotation>
<xs:list itemType="tns:ModelName"/>
</xs:simpleType>
<xs:simpleType name="MountType">
<xs:annotation>
<xs:documentation>Indicates whether an object is mountable or a mount point. Mountable objects MUST be top-level children of the Root Object (other objects are not permitted to be mounted).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="none"/>
<xs:enumeration value="mountable"/>
<xs:enumeration value="mountPoint"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ObjectName">
<xs:annotation>
<xs:documentation>Object name (maximum length 256). Each component is the same as xs:NCName except that dots are not permitted. This name MUST in addition follow the vendor-specific object name requirements of section 3.3.
An object name component SHOULD NOT start with an underscore or include any hyphens.
In BBF standards, an object name component MUST NOT start with an underscore or include any hyphens.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:maxLength value="256"/>
<xs:pattern value="(&name;˙(&inst;˙)?)+"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ObjectReference">
<xs:annotation>
<xs:documentation>Object path that cannot contain "{i}" placeholders and that therefore references a single object. The path MUST follow the requirements of A.2.3.4 (its scope will typically be specified via an attribute of type PathScope).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="&hash;*˙?(&name;˙)*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ObjectReferencePattern">
<xs:annotation>
<xs:documentation>Object path that can contain "{i}" placeholders and that can therefore references multiple objects. The path MUST follow the requirements of A.2.3.4 (its scope will typically be specified via an attribute of type PathScope).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="&hash;*˙?(&name;˙(&inst;˙)?)*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ObjectReferencePatterns">
<xs:annotation>
<xs:documentation>List of object paths, each of which can contain "{i}" placeholders.</xs:documentation>
</xs:annotation>
<xs:list itemType="tns:ObjectReferencePattern"/>
</xs:simpleType>
<xs:simpleType name="OpaqueID">
<xs:annotation>
<xs:documentation>Opaque ID.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ModelDefaultType">
<xs:annotation>
<xs:documentation>Type of model parameter default.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="factory">
<xs:annotation>
<xs:documentation>Default from standard, e.g. RFC. Also applies on object creation.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="object">
<xs:annotation>
<xs:documentation>Default on object creation.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="implementation">
<xs:annotation>
<xs:documentation>Informational default that is likely after a reset or if no other value is available.</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ParameterName">
<xs:annotation>
<xs:documentation>Parameter name (maximum length 256); the same as xs:NCName except that dots are not permitted. This name MUST in addition follow the vendor-specific parameter name requirements of section 3.3.
A parameter name SHOULD NOT start with an underscore or include any hyphens.
In BBF standards, a parameter name MUST NOT start with an underscore or include any hyphens.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:maxLength value="256"/>
<xs:pattern value="&name;"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ParameterReference">
<xs:annotation>
<xs:documentation>Parameter path that cannot contain "{i}" placeholders and that therefore references a single parameter. The path MUST follow the requirements of A.2.3.4 (its scope will typically be specified via an attribute of type PathScope).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="&hash;*˙?(&name;˙)*&name;"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="PathScope">
<xs:annotation>
<xs:documentation>Object / parameter path name scope (A.2.3.4).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="normal"/>
<xs:enumeration value="model"/>
<xs:enumeration value="object"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ProfileName">
<xs:annotation>
<xs:documentation>Profile name, including version. The name part is the same as xs:NCName except that dots are not permitted.
A profile name SHOULD NOT start with an underscore or include any hyphens.
In BBF standards, a profile name MUST NOT start with an underscore or include any hyphens.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="&name;:#"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ProfileNames">
<xs:annotation>
<xs:documentation>List of profile names.</xs:documentation>
</xs:annotation>
<xs:list itemType="tns:ProfileName"/>
</xs:simpleType>
<xs:simpleType name="ProfileObjectAccess">
<xs:annotation>
<xs:documentation>Object access (within profile).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="notSpecified"/>
<xs:enumeration value="present"/>
<xs:enumeration value="create"/>
<xs:enumeration value="delete"/>
<xs:enumeration value="createDelete"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReadWriteAccess">
<xs:annotation>
<xs:documentation>Read-write access.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="readOnly"/>
<xs:enumeration value="readWrite"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ParameterAccess">
<xs:annotation>
<xs:documentation>Parameter access options.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="readOnly"/>
<xs:enumeration value="readWrite"/>
<xs:enumeration value="writeOnceReadOnly"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReferenceType">
<xs:annotation>
<xs:documentation>Reference type (A.2.3.6).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="weak"/>
<xs:enumeration value="strong"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="Status">
<xs:annotation>
<xs:documentation>Item status (applies to most types of item).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="current"/>
<xs:enumeration value="deprecated"/>
<xs:enumeration value="obsoleted"/>
<xs:enumeration value="deleted"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="TargetType">
<xs:annotation>
<xs:documentation>(Reference) target type (used in path references).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:enumeration value="any"/>
<xs:enumeration value="parameter"/>
<xs:enumeration value="object"/>
<xs:enumeration value="single"/>
<xs:enumeration value="table"/>
<xs:enumeration value="row"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UniqueKeyReference">
<xs:annotation>
<xs:documentation>Relative parameter path name that cannot contain "{i}" placeholders and that therefore represents a valid uniqueKey parameter name.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="(&name;˙)*&name;"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UnitsString">
<xs:annotation>
<xs:documentation>Units string.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:maxLength value="32"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UUID">
<xs:annotation>
<xs:documentation>Universally Unique IDentifier (see RFC 4122).</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern
value="[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="Version">
<xs:annotation>
<xs:documentation>Version (major.minor) in which this item was first defined.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="#˙#"/>
</xs:restriction>
</xs:simpleType>
<!-- Model groups -->
<xs:group name="AllBuiltinDataTypes">
<xs:annotation>
<xs:documentation>All built-in data types.</xs:documentation>
</xs:annotation>
<xs:choice>
<xs:element name="base64">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="size" type="tns:SizeFacet">
<xs:annotation>
<xs:documentation>Length is that of the actual string, not the base64-encoded string. See A.2.3.3.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
<xs:element name="boolean">
<xs:complexType>
<xs:sequence>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
<xs:element name="dateTime">
<xs:complexType>
<xs:sequence>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
<xs:element name="hexBinary">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="size" type="tns:SizeFacet">
<xs:annotation>
<xs:documentation>Length is that of the actual string, not the hexBinary-encoded string. See A.2.3.3.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
<xs:element name="decimal">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="range" type="tns:DecimalRangeFacet"/>
<xs:element name="units" type="tns:UnitsFacet"/>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
<xs:element name="int">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="instanceRef" type="tns:InstanceRefFacet"/>
<xs:element name="range" type="tns:RangeFacet"/>
<xs:element name="units" type="tns:UnitsFacet"/>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
<xs:element name="long">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="range" type="tns:RangeFacet"/>
<xs:element name="units" type="tns:UnitsFacet"/>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
<xs:element name="string">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="size" type="tns:SizeFacet"/>
<xs:element name="pathRef" type="tns:PathRefFacet"/>
<xs:element name="enumeration" type="tns:EnumerationFacet"/>
<xs:element name="enumerationRef" type="tns:EnumerationRefFacet"/>
<xs:element name="pattern" type="tns:PatternFacet"/>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
<xs:unique name="stringEnumerationValue">
<xs:selector xpath="enumeration"/>
<xs:field xpath="@value"/>
</xs:unique>
<xs:unique name="stringPatternValue">
<xs:selector xpath="pattern"/>
<xs:field xpath="@value"/>
</xs:unique>
</xs:element>
<xs:element name="unsignedInt">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="instanceRef" type="tns:InstanceRefFacet"/>
<xs:element name="range" type="tns:RangeFacet"/>
<xs:element name="units" type="tns:UnitsFacet"/>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
<xs:element name="unsignedLong">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="range" type="tns:RangeFacet"/>
<xs:element name="units" type="tns:UnitsFacet"/>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:group>
<xs:group name="AllFacets">
<xs:annotation>
<xs:documentation>All facets.</xs:documentation>
</xs:annotation>
<xs:choice>
<xs:element name="size" type="tns:SizeFacet">
<xs:annotation>
<xs:documentation>Size facets, taken together, define the valid size ranges, e.g. (0:0) and (6:6) mean that the size has to be 0 or 6.
The size facet MUST NOT be specified for non-string data types, i.e. data types that are not derived from base64, hexBinary or string.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="instanceRef" type="tns:InstanceRefFacet">
<xs:annotation>
<xs:documentation>InstanceRef facets specify how a parameter can reference an object instance (table row) via its instance number.
The instanceRef facet MUST NOT be specified for data types that are not derived from int or unsignedInt.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="pathRef" type="tns:PathRefFacet">
<xs:annotation>
<xs:documentation>PathRef facets specify how a parameter can reference a parameter or object via its path name.
The pathRef facet MUST NOT be specified for data types that are not derived from string.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="decimalRange" type="tns:DecimalRangeFacet">
<xs:annotation>
<xs:documentation>Decimal range facets, taken together, define the valid value ranges, e.g. [-1:-1] and [2.6:63.7] mean that the value has to be -1 or between 2.6:63.7 inclusive (it cannot be 0).
The decimal range facet MUST NOT be specified for non-decimal data types, i.e. data types that are not derived from decimal types.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="range" type="tns:RangeFacet">
<xs:annotation>
<xs:documentation>Range facets taken together, define the valid value ranges with an optional step value, e.g. [-1:-1] and [1:4094] mean that the value has to be -1 or 1:4094 (it cannot be 0), [2:1024 step 2] mean all even values between 2 and 1024 inclusive.
The range facet MUST NOT be specified for non-numeric data types, i.e. data types that are not derived from one of the integer types.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="enumeration" type="tns:EnumerationFacet">
<xs:annotation>
<xs:documentation>Enumeration facets, taken together, define the valid values, e.g. "a" and "b" mean that the value has to be a or b.
The enumeration facet MUST NOT be specified for data types that are not derived from string.
Derived types MAY add additional enumeration values. See A.2.5.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="enumerationRef" type="tns:EnumerationRefFacet">
<xs:annotation>
<xs:documentation>EnumerationRef facets allow a parameter's valid values to be obtained from another parameter.
The enumerationRef facet MUST NOT be specified for data types that are not derived from string.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="pattern" type="tns:PatternFacet">
<xs:annotation>
<xs:documentation>Pattern attributes, taken together, define valid patterns, e.g. "" and "[0-9A-Fa-f]{6}" means that the value has to be empty or a 6 digit hex string.
The pattern facet MUST NOT be specified for data types that are not derived from string.
Pattern syntax is the same as for XML Schema regular expressions. See https://www.w3.org/TR/xmlschema-2/#regexs.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="units" type="tns:UnitsFacet">
<xs:annotation>
<xs:documentation>Multiple units facets MUST NOT be specified.
The units facet MUST NOT be specified for data types that are not numeric, i.e. data types that are not derived from one of the integer types.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:group>
<!-- Complex types -->
<xs:complexType name="Abbreviations">
<xs:annotation>
<xs:documentation>Abbreviations definition.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="description" type="tns:Description" minOccurs="0"/>
<xs:element name="item" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="description" type="tns:Description">
<xs:annotation>
<xs:documentation>The description of the item.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="id" type="tns:AbbrefId" use="required">
<xs:annotation>
<xs:documentation>Uniquely identifies the item (this is checked by schema validation). Can be referenced from descriptions by using the {{abbref}} template. See A.2.2.4.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ArgumentDefaultFacet">
<xs:annotation>
<xs:documentation>Argument parameter default facet.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="tns:BaseStatusFacet">
<xs:attribute name="type" type="tns:ArgumentDefaultType" use="required"/>
<xs:attribute name="value" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Value MUST be valid for the data type.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ArgumentSyntax">
<xs:annotation>
<xs:documentation>Argument parameter syntax specification.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="tns:BaseSyntax">
<xs:sequence>
<xs:element name="default" type="tns:ArgumentDefaultFacet" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="BaseAccessFacet" abstract="true">
<xs:annotation>
<xs:documentation>Base facet (access, status and optional attributes).</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="tns:BaseStatusFacet">
<xs:attribute name="access" type="tns:ReadWriteAccess" default="readWrite"/>
<xs:attribute name="optional" type="xs:boolean" default="false"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="BaseParameter">
<xs:annotation>
<xs:documentation>Base Parameter definition and reference.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="description" type="tns:Description" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="name" type="tns:ParameterName">
<xs:annotation>
<xs:documentation>MUST be unique within the parent object (this is checked by schema validation).
MUST be present if and only if defining a new parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="base" type="tns:ParameterName">
<xs:annotation>
<xs:documentation>MUST be present if and only if modifying an existing parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="status" type="tns:Status" default="current"/>
<xs:attribute name="version" type="tns:Version"/>
<xs:attribute name="id" type="tns:OpaqueID"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
<xs:complexType name="BaseObject">
<xs:annotation>
<xs:documentation>Base Object definition and reference.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="description" type="tns:Description" minOccurs="0"/>
<xs:element name="uniqueKey" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>MUST NOT be present if the object is not a table (see maxEntries).
The parameters referenced by each unique key element MUST constitute a unique key.
All of the referenced parameters MUST be single-valued (i.e. not list-valued).
For a non-functional key, or if the table has no enableParameter, the uniqueness requirement always applies.
For a functional key, and if the table has an enableParameter, the uniqueness requirement applies only to enabled table entries.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="parameter" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="ref" type="tns:UniqueKeyReference" use="required"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="functional" type="xs:boolean" default="true">
<xs:annotation>
<xs:documentation>Indicates whether this is a functional (true) or non-functional (false) key.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:unique name="uniqueKeyParameterRef">
<xs:selector xpath="parameter"/>
<xs:field xpath="@ref"/>
</xs:unique>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="tns:ObjectName">
<xs:annotation>
<xs:documentation>MUST be unique within the component or model (this is checked by schema validation).
MUST be present if and only if defining a new object.
If the object is a table (see maxEntries), the final part of the name MUST be "{i}.".</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="base" type="tns:ObjectName">
<xs:annotation>
<xs:documentation>MUST be present if and only if modifying an existing object.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="minEntries" type="xs:nonNegativeInteger" use="required">
<xs:annotation>
<xs:documentation>minEntries MUST be less than or equal to maxEntries (all values are regarded as being less than "unbounded").</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxEntries" type="tns:MaxEntries" use="required">
<xs:annotation>
<xs:documentation>minEntries and maxEntries indicate whether the object is a table:
* minEntries=0, maxEntries=1 : single-instance object which might not be allowed to exist, e.g. because only one of it and another object can exist at the same time
* minEntries=1, maxEntries=1 : single-instance object that is always allowed to exist
* all other cases : object is a table</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="status" type="tns:Status" default="current"/>
<xs:attribute name="version" type="tns:Version"/>
<xs:attribute name="id" type="tns:OpaqueID"/>
<xs:attribute name="discriminatorParameter" type="tns:ParameterName">
<xs:annotation>
<xs:documentation>MUST be present and specified for all single-instance objects which are part of a union and point to the same parameter specifying the name of the object which is currently in use, i.e. only one object which is part of a union can exist at the same time.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
<xs:complexType name="BaseStatusFacet" abstract="true">
<xs:annotation>
<xs:documentation>Base facet (status attribute).</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="description" type="tns:Description" minOccurs="0"/>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="status" type="tns:Status" default="current"/>
<xs:attribute name="version" type="tns:Version"/>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
<xs:complexType name="BaseSyntax">
<xs:annotation>
<xs:documentation>Base parameter syntax specification (omits defaults).</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice>
<xs:element name="list" type="tns:ListFacet" minOccurs="0">
<xs:annotation>
<xs:documentation>For lists, the TR-069 parameter is always a string and the data type specification applies to individual list items, not to the parameter value.
See section 3.2 for comma-separated list formatting rules.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice>
<xs:group ref="tns:AllBuiltinDataTypes">
<xs:annotation>
<xs:documentation>Direct use of built-in data type, possibly modified via use of facets.</xs:documentation>
</xs:annotation>
</xs:group>
<xs:element name="dataType" type="tns:DataTypeReference">
<xs:annotation>
<xs:documentation>Use of named data type, possibly modified via use of facets.</xs:documentation>
</xs:annotation>
<xs:unique name="dtRefEnumerationValue">
<xs:selector xpath="enumeration"/>
<xs:field xpath="@value"/>
</xs:unique>
<xs:unique name="dtRefPatternValue">
<xs:selector xpath="pattern"/>
<xs:field xpath="@value"/>
</xs:unique>
</xs:element>
</xs:choice>
</xs:sequence>
<xs:attribute name="hidden" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>If true, MUST always read back as the null value for the parameter's base data type (A.2.3.5).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="command" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>If true, setting this parameter triggers an Agent action. Such a parameter is not part of the device configuration and MUST always read back as the null value for the parameter's base data type (A.2.3.5).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
<xs:complexType name="Bibliography">
<xs:annotation>
<xs:documentation>Bibliography definition.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="description" type="tns:Description" minOccurs="0"/>
<xs:element name="reference" type="tns:BibliographyReference" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="BibliographyReference">
<xs:annotation>
<xs:documentation>Bibliography reference definition.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="name" type="xs:token">
<xs:annotation>
<xs:documentation>Name by which the referenced document is usually known, e.g. TR-069, RFC 2863.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="xs:token" minOccurs="0"/>
<xs:element name="organization" type="xs:token" minOccurs="0">
<xs:annotation>
<xs:documentation>Organization that published the referenced document, e.g. BBF, IEEE, IETF.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="category" type="xs:token" minOccurs="0">
<xs:annotation>
<xs:documentation>Document category, e.g. TR (BBF), RFC (IETF).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="date" type="xs:token" minOccurs="0">
<xs:annotation>
<xs:documentation>Publication date.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="hyperlink" type="xs:anyURI"/>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="id" type="tns:BibrefId" use="required">
<xs:annotation>
<xs:documentation>Uniquely identifies the reference (this is checked by schema validation). Can be referenced from descriptions by using the {{bibref}} template. See A.2.2.4.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
<xs:complexType name="CommandArguments">
<xs:annotation>
<xs:documentation>Command Arguments (input or output) definition and reference.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="description" type="tns:Description" minOccurs="0"/>
<xs:choice maxOccurs="unbounded">
<xs:element name="component" type="tns:ComponentReference"/>
<xs:element name="parameter" type="tns:CommandParameter"/>
<xs:element name="object" type="tns:CommandObject"/>
</xs:choice>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"/>
</xs:complexType>
<xs:complexType name="CommandObject">
<xs:annotation>
<xs:documentation>Command Object definition and reference.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="tns:BaseObject">
<xs:sequence>
<xs:element name="parameter" type="tns:CommandParameter" maxOccurs="unbounded"
minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="CommandParameter">
<xs:annotation>
<xs:documentation>Command Parameter definition and reference.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="tns:BaseParameter">
<xs:sequence>
<xs:element name="syntax" type="tns:ArgumentSyntax" minOccurs="0"/>
<xs:any namespace="##other" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute default="false" name="mandatory" type="xs:boolean">
<xs:annotation>
<xs:documentation>If true, the parameter MUST be present in the command.</xs:documentation>
</xs:annotation>