-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathtr-181-2-13-0-usp.xml
6054 lines (6019 loc) · 304 KB
/
tr-181-2-13-0-usp.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"?>
<!--
USP Device:2.13 Root Object definition
Copyright (c) 2010-2019, Broadband Forum
The undersigned members have elected to grant the copyright to
their contributed material used in this software:
Copyright (c) 2017-2019 ARRIS Enterprises, LLC.
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:
USP Device:2.13 Root Object definition.
Editors:
* John Blackford, CommScope
* Tim Carey, Nokia
* Tim Spets, Greenwave System
* Klaus Wich, Huawei
Broadband User Service Work Area Directors:
* Jason Walls, QA Cafe
* John Blackford, CommScope
Issue History (Filename: Approval Date: Publication Date: Changes):
* tr-181-2-0-0.xml: May 2010:
- Corresponds to TR-181 Issue 2.
* tr-181-2-1-0.xml: November 2010:
- Corresponds to TR-181 Issue 2 Amendment 1.
* tr-181-2-2-0.xml: March 2011:
- Corresponds to TR-181 Issue 2 Amendment 2.
* tr-181-2-3-0.xml: September 2011:
- Corresponds to TR-181 Issue 2 Amendment 3.
* tr-181-2-4-0.xml: November 2011:
- Corresponds to TR-181 Issue 2 Amendment 4.
* tr-181-2-5-0.xml: May 2012:
- Corresponds to TR-181 Issue 2 Amendment 5.
* tr-181-2-6-0.xml: November 2012:
- Corresponds to TR-181 Issue 2 Amendment 6.
* tr-181-2-7-0.xml: November 2013: January 17, 2014
- Corresponds to TR-181 Issue 2 Amendment 7.
* tr-181-2-8-0.xml: 8 September 2014: 17 September 2014:
- Corresponds to TR-181 Issue 2 Amendment 8.
* tr-181-2-9-0.xml: 1 December 2014: 4 February 2015:
- Added WiFi MAC Address Filtering
- Added Traceroute fixes
- Added IEEE 1905 data model
- Incorporated TR-143a1
* tr-181-2-10-0.xml: 9 November 2015: 13 November 2015:
- Corresponds to TR-181 Issue 2 Amendment 10.
* tr-181-2-11-0.xml: 18 July 2016: 12 August 2016
- Corresponds to TR-181 Issue 2 Amendment 11.
* tr-181-2-12-0-usp.xml: 26 March 2018: 26 March 2018
- Corresponds to TR-181 Issue 2 Amendment 12.
- Added USP Local agent support (TR-369)
- Added Firmware Image support
- Added Ethernet Link Aggregation Group
- Added additional Wi-Fi and WAN statistics
- Added support for Two-Way Active Measurement Protocol (TWAMP) reflector
- Added support for Layer Two Tunneling Protocol version 3 (L2TPv3)
- Added support for Virtual eXtensible Local Area Network (VXLAN) tunnels
- Added support for Broadband Access Service Attributes and Performance Metrics measurement test framework (BASAPM)
- Added support for Large-Scale Measurement of Broadband Performance (LMAP)
* tr-181-2-13-0-common.xml: 13 September 2019: 13 September 2019:
- Corresponds to TR-181 Issue 2 Amendment 13.
- Added support for WFA Data Elements
- Added support for Multi AP
- Added support for WPA3 and 802.11ax
- Added support for MQTT 5.0
- Added support for Package capture diagnostics
- Updates for TR-369 MQTT support
- Added support for IoT Data model
-->
<dm:document xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-7"
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-7
https://www.broadband-forum.org/cwmp/cwmp-datamodel-1-7.xsd
urn:broadband-forum-org:cwmp:datamodel-report-0-1
https://www.broadband-forum.org/cwmp/cwmp-datamodel-report.xsd"
spec="urn:broadband-forum-org:tr-181-2-13-0-usp"
file="tr-181-2-13-0-usp.xml">
<description>
{{docname|Device:2 Root Data Model for USP (TR-369)}}
{{appdate|September 2019}}
{{trname|TR-181i2a13}}
* Added support for WFA Data Elements
* Added support for Multi AP
* Added support for WPA3 and 802.11ax
* Added support for MQTT 5.0
* Added support for Package capture diagnostics
* Updates for TR-369 MQTT support
* Added support for IoT Data model
</description>
<import file="tr-069-biblio.xml" spec="urn:broadband-forum-org:tr-069"/>
<import file="tr-106-types.xml" spec="urn:broadband-forum-org:tr-106">
<dataType name="Alias" ref="_AliasUSP"/>
<dataType name="IPAddress"/>
<dataType name="StatsCounter32"/>
<dataType name="StatsCounter64"/>
<dataType name="UUID"/>
<dataType name="JSONObject"/>
</import>
<import file="tr-181-2-iot.xml" spec="urn:broadband-forum-org:tr-181-2-13-iot">
<component name="IoT_NodeComponent"/>
<component name="IoT_ProxiedDeviceExtensionComponent"/>
<component name="IoT_ObjectComponent"/>
</import>
<import file="tr-181-2-common.xml" spec="urn:broadband-forum-org:tr-181-2-13">
<component name="ADSLLineDiagnosticsInput"/>
<component name="ADSLLineDiagnosticsOutput"/>
<component name="SELTUERDiagnosticsInput"/>
<component name="SELTUERDiagnosticsOutput"/>
<component name="SELTQLNDiagnosticsInput"/>
<component name="SELTQLNDiagnosticsOutput"/>
<component name="SELTPDiagnosticsInput"/>
<component name="SELTPDiagnosticsOutput"/>
<component name="ATMF5LoopbackDiagnosticsInput"/>
<component name="ATMF5LoopbackDiagnosticsOutput"/>
<component name="HPNAPHYThroughputDiagnosticsInput"/>
<component name="HPNAPHYThroughputDiagnosticsOutput"/>
<component name="HPNAPerformanceMonitoringDiagnosticsInput"/>
<component name="HPNAPerformanceMonitoringDiagnosticsOutput"/>
<component name="GhnPHYThroughputDiagnosticsInput"/>
<component name="GhnPHYThroughputDiagnosticsOutput"/>
<component name="GhnPerformanceMonitoringDiagnosticsInput"/>
<component name="GhnPerformanceMonitoringDiagnosticsOutput"/>
<component name="UPAInterfaceMeasurementDiagnosticsInput"/>
<component name="UPAInterfaceMeasurementDiagnosticsOutput"/>
<component name="WiFiNeighboringWiFiDiagnosticsOutput"/>
<component name="IPPingDiagnosticsInput"/>
<component name="IPPingDiagnosticsOutput"/>
<component name="IPTraceRouteDiagnosticsInput"/>
<component name="IPTraceRouteDiagnosticsOutput"/>
<component name="IPDownloadDiagnosticsCapabilities"/>
<component name="IPDownloadDiagnosticsInput"/>
<component name="IPDownloadDiagnosticsInput2"/>
<component name="IPDownloadDiagnosticsOutput"/>
<component name="IPUploadDiagnosticsCapabilities"/>
<component name="IPUploadDiagnosticsInput"/>
<component name="IPUploadDiagnosticsInput2"/>
<component name="IPUploadDiagnosticsOutput"/>
<component name="IPUDPEchoDiagnosticsInput"/>
<component name="IPUDPEchoDiagnosticsCapabilities"/>
<component name="IPUDPEchoDiagnosticsInput2"/>
<component name="IPUDPEchoDiagnosticsOutput"/>
<component name="IPServerSelectionDiagnosticsInput"/>
<component name="IPServerSelectionDiagnosticsOutput"/>
<component name="DNSLookupDiagnosticsInput"/>
<component name="DNSLookupDiagnosticsOutput"/>
<component name="SelfTestDiagnosticsOutput"/>
<component name="SendMagicPacketInput"/>
<component name="PacketCaptureDiagnosticsInput"/>
<component name="PacketCaptureDiagnosticsOutput"/>
<model name="_Device:2.13" ref="Device:2.13"/>
</import>
<!-- Templates used in object and/or parameter descriptions -->
<template id="MQTTReconnect">
{{templ|MQTTChange}} If the change needs to be applied immediately, the command {{param|ForceReconnect}} has to be executed.
</template>
<template id="MQTTWillChange">
{{templ|MQTTChange}}
If will handling is enabled (Parameter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the command {{param|ForceReconnect}} has to be executed.
</template>
<template id="BULK-DATA-HTTP-REF">
{{bibref|TR-369|Annex A}}
</template>
<template id="BULK-DATA-CSV-ENC">
{{bibref|TR-369|Annex A.2.1}}
</template>
<template id="BULK-DATA-TIMESTAMP">
.
</template>
<template id="XMPP-REF">
.
</template>
<template id="XMPP-REF-APP">
.
</template>
<model name="Device:2.13" base="_Device:2.13">
<object base="Device." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="ProxiedDeviceNumberOfEntries" access="readOnly" dmr:version="2.12">
<description>{{numentries}}</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<command name="Reboot()" dmr:version="2.12">
<description>
Reboot the entity associated with the containing {{object}}.
</description>
</command>
<event name="Boot!" dmr:version="2.12">
<description>
Boot event indicating that the {{object}} was rebooted.
</description>
<parameter name="CommandKey" dmr:version="2.12">
<description>
The ''command_key'' supplied when requesting the boot, or {{empty}} if the boot was not requested via a USP operation.
</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="Cause" dmr:version="2.12">
<description>
The cause of the boot.
</description>
<syntax>
<string>
<enumeration value="LocalReboot">
<description>
A {{object}} Event that was the result of a reboot triggered locally on the Device (NOT as a result of a {{command|#.Reboot()}} Command)
</description>
</enumeration>
<enumeration value="RemoteReboot">
<description>
A {{object}} Event that was the result of a reboot triggered via the {{command|#.Reboot()}} Command
</description>
</enumeration>
<enumeration value="LocalFactoryReset">
<description>
A {{object}} Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a {{command|#.FactoryReset()}} Command)
</description>
</enumeration>
<enumeration value="RemoteFactoryReset">
<description>
A {{object}} Event that was the result of a factory reset triggered via the {{command|#.FactoryReset()}} Command
</description>
</enumeration>
</string>
</syntax>
</parameter>
<parameter name="FirmwareUpdated" dmr:version="2.12">
<description>
{{true}} if the firmware was updated as a result of the boot that caused this Event Notification; otherwise {{false}}.
</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="ParameterMap" dmr:version="2.12">
<description>
Boot parameters configured via the recipient Controller's {{object|.LocalAgent.Controller.{i}.BootParameter}} table.
Formatted as a {{datatype|expand}}
</description>
<syntax>
<dataType ref="JSONObject"/>
</syntax>
</parameter>
</event>
<command name="FactoryReset()">
<description>
Factory reset the entity associated with the containing {{object}}.
</description>
</command>
<command name="SelfTestDiagnostics()" async="true" dmr:version="2.12">
<description>
This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware.
</description>
<output>
<parameter name="Status" dmr:version="2.13">
<description>
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.
</description>
<syntax>
<string>
<enumeration value="Complete"/>
<enumeration value="Error_Internal"/>
<enumeration value="Error_Other"/>
</string>
</syntax>
</parameter>
<component ref="SelfTestDiagnosticsOutput"/>
</output>
</command>
<command name="PacketCaptureDiagnostics()" async="true" dmr:version="2.13">
<description>
This diagnostic command is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format.
</description>
<input>
<component ref="PacketCaptureDiagnosticsInput"/>
</input>
<output>
<parameter name="Status" dmr:version="2.13">
<description>
Indicates the availability of diagnostics data. {{enum}}
If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate.
</description>
<syntax>
<string>
<enumeration value="Canceled" optional="true"/>
<enumeration value="Complete"/>
<enumeration value="Error" optional="true"/>
<enumeration value="Error_Internal"/>
<enumeration value="Error_Other"/>
</string>
</syntax>
</parameter>
<component ref="PacketCaptureDiagnosticsOutput"/>
</output>
</command>
</object>
<object base="Device.DeviceInfo." access="readOnly" minEntries="1" maxEntries="1" dmr:version="2.12">
<parameter base="ManufacturerOUI" access="readOnly">
<description action="append">
Any change would indicate that it's a new Agent and would therefore require a {{event|#.Boot!}} Event with a {{enum|LocalFactoryReset|#.Boot!.Cause}} enumerated value in the {{param|#.Boot!.Cause}} argument.
</description>
</parameter>
<parameter name="FriendlyName" access="readWrite" dmr:version="2.12">
<description>
The friendly name of the device.
In {{bibref|TR-369}} the friendly name is used during the advertisement of an endpoint - see section IANA-Registered USP Service Names of {{bibref|TR-369}}.
</description>
<syntax>
<string>
<size maxLength="32"/>
</string>
</syntax>
</parameter>
<parameter name="CID" access="readOnly" dmr:previousParameter="ManufacturerOUI" dmr:version="2.12">
<description>
Company identifier assigned and registered by the IEEE Registration Authority to the entity responsible for this Agent. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. {{pattern}}
This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it's a new Agent and would therefore require a {{event|#.Boot!}} Event with a {{enum|LocalFactoryReset|#.Boot!.Cause}} enumerated value in the {{param|#.Boot!.Cause}} argument.
</description>
<syntax>
<string>
<size minLength="6" maxLength="6"/>
<pattern value="[0-9A-F]{6}"/>
</string>
</syntax>
</parameter>
<parameter name="PEN" access="readOnly" dmr:version="2.12">
<description>
Private Enterprise Number assigned and registered by IANA to the entity responsible for this Agent. Represented as a decimal encoding of the IANA-assinged number.
This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it's a new Agent and would therefore require a {{event|#.Boot!}} Event with a {{enum|LocalFactoryReset|#.Boot!.Cause}} enumerated value in the {{param|#.Boot!.Cause}} argument.
</description>
<syntax>
<string>
<size maxLength="10"/>
</string>
</syntax>
</parameter>
</object>
<object base="Device.BulkData." access="readOnly" minEntries="1" maxEntries="1">
<description action="replace">
This object provides bulk data collection capabilities and global collection settings that affect the entire device.
Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server.
The IPDR solution is based on a service specification described in {{bibref|TR-232}}.
The HTTP solution is based on transfer mechanisms described in {{bibref|TR-369|Annex A}}.
The USPEventNotif solution is based on sending a Device.BulkData.Profile.{i}.Push! Event Notification via USP {{bibref|TR-369}}.
The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server.
</description>
<parameter base="Protocols" access="readOnly" dmr:version="2.5">
<syntax>
<list/>
<string>
<enumeration value="Streaming"/>
<enumeration value="File"/>
<enumeration value="HTTP"/>
<enumeration value="USPEventNotif">
<description>
User Services Platform (USP - {{bibref|TR-369|Annex A}}) Event Notiification
</description>
</enumeration>
</string>
</syntax>
</parameter>
<parameter base="EncodingTypes" access="readOnly" dmr:version="2.5">
<syntax>
<list/>
<string>
<enumeration value="XML"/>
<enumeration value="XDR"/>
<enumeration value="CSV">
<description action="replace">
Comma Separated Values. Used with the HTTP and USPEventNotif Protocols. {{bibref|RFC4180}}
</description>
</enumeration>
<enumeration value="JSON">
<description action="replace">
JavaScript Object Notation. Used with the HTTP and USPEventNotif Protocols. {{bibref|RFC7159}}
</description>
</enumeration>
</string>
</syntax>
</parameter>
</object>
<object base="Device.BulkData.Profile.{i}." access="readWrite" numEntriesParameter="ProfileNumberOfEntries" enableParameter="Enable" minEntries="0" maxEntries="unbounded">
<parameter name="Controller" access="readOnly" dmr:previousParameter="Name" dmr:version="2.12">
<description>
{{reference|the {{object|Device.LocalAgent.Controller.}} instance that created or last updated this {{object}}}}
The value of this parameter is automatically populated by the USP Agent upon {{object}} creation using the reference to the USP Controller that created the instance.
The value of this parameter is automatically updated by the USP Agent upon {{object}} alteration using the reference to the USP Controller that changed the instance.
</description>
<syntax>
<string>
<pathRef refType="strong" targetParent="Device.LocalAgent.Controller." targetType="row"/>
</string>
</syntax>
</parameter>
<event name="Push!" dmr:version="2.13">
<description>
Bulk Data Push event for delivering a bulk data report within a USP Notification message.
</description>
<parameter name="Data" dmr:version="2.13">
<description>
The contents of the bulk data report in the configured CSV or JSON Encoding Type.
</description>
<syntax>
<string/>
</syntax>
</parameter>
</event>
</object>
<object base="Device.BulkData.Profile.{i}.Parameter.{i}." access="readWrite" minEntries="0" maxEntries="unbounded">
<parameter base="Name" access="readWrite">
<description action="replace">
Name of the parameter in the report body.
If the value of this parameter is {{empty}}, then the value of the {{param|Reference}} parameter is used as the name.
When the value {{param|Reference}} parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in {{bibref|TR-369|Annex A.2.3}}.
</description>
</parameter>
</object>
<object base="Device.BulkData.Profile.{i}.CSVEncoding." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="ReportFormat" access="readWrite">
<description action="replace">
This parameter describes the formatting used for reports defined by this profile as described in {{bibref|TR-369|Annex A.2.5}}.
Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in {{bibref|RFC2616}}.
</description>
</parameter>
</object>
<object base="Device.BulkData.Profile.{i}.JSONEncoding." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="ReportFormat" access="readWrite">
<description action="replace">
This parameter describes the formatting used for the report as described in {{bibref|TR-369|Annex A.2.6}}.
Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in {{bibref|RFC2616}}.
</description>
</parameter>
<parameter base="ReportTimestamp" access="readWrite">
<description action="replace">
The format of timestamp to use for the JSON Object named "CollectionTime" as described in {{bibref|TR-369|Annex A.2.6.1}}.
</description>
</parameter>
</object>
<object base="Device.BulkData.Profile.{i}.HTTP." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="RetryMinimumWaitInterval" access="readWrite">
<description action="replace">
Configures the data transfer retry wait interval, in seconds, as specified in {{bibref|TR-369|Annex A.1.2.1}}.
The device MUST use a random value between {{param}} and ({{param}} * {{param|RetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
</description>
</parameter>
<parameter base="RetryIntervalMultiplier" access="readWrite">
<description action="replace">
Configures the retry interval multiplier as specified in {{bibref|TR-369|Annex A.1.2.1}}.
This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.
The device MUST use a random value between {{param|RetryMinimumWaitInterval}} and ({{param|RetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
</description>
</parameter>
</object>
<object base="Device.BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}." access="readWrite" minEntries="0" maxEntries="unbounded">
<description action="replace">
This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by {{bibref|TR-369|Annex A.1.1}}.
</description>
</object>
<object name="Device.LocalAgent." access="readOnly" minEntries="1" maxEntries="1" dmr:version="2.12">
<description>
This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the {{object|.DeviceInfo}} object.
NOTE: The Vendor Log File table ({{object|.DeviceInfo.VendorLogFile}}) details are located on the {{object|.DeviceInfo}} object.
</description>
<parameter name="EndpointID" access="readOnly" dmr:version="2.12">
<description>
The unique USP identifier for this USP Agent.
</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="SoftwareVersion" access="readOnly" dmr:version="2.12">
<description>
The current USP Agent software version; not the version of the overall device firmware, which is located in {{param|.DeviceInfo.SoftwareVersion}}.
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="UpTime" access="readOnly" activeNotify="canDeny" dmr:version="2.12">
<description>
Time in {{units}} since the USP Agent was last restarted (either via a reset of the software or reboot of the underlying device).
</description>
<syntax>
<unsignedInt>
<units value="seconds"/>
</unsignedInt>
</syntax>
</parameter>
<event name="Periodic!" dmr:version="2.12">
<description>
Periodic event configured via the recipient Controller's {{param|Controller.{i}.PeriodicNotifInterval}} and {{param|Controller.{i}.PeriodicNotifTime}} parameters.
</description>
</event>
<event name="WakeUp!" dmr:version="2.12">
<description>
Wake-up event.
</description>
</event>
<event name="TransferComplete!" dmr:version="2.12">
<description>
Indicates that a file has been transferred to or from the Device. The event is sent when the transfer has either completed successfully (in which case {{param|FaultCode}} will be zero), or else has failed (in which case {{param|FaultCode}} will be non-zero and {{param|FaultString}} will give further details).
The file transfer can be requested via a USP operation or via some other mechanism. If it's requested via a USP operation {{param|Command}}, {{param|CommandKey}} and {{param|Requestor}} give further details.
</description>
<parameter name="Command" dmr:version="2.12">
<description>
The Path Name of the command that requested the transfer, or {{empty}} if the transfer was not requested via a USP operation.
</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="CommandKey" dmr:version="2.12">
<description>
The ''command_key'' supplied when requesting the transfer, or {{empty}} if the transfer was not requested via a USP operation.
</description>
<syntax>
<string/>
<default type="parameter" value=""/>
</syntax>
</parameter>
<parameter name="Requestor" dmr:version="2.12">
<description>
The Endpoint ID of the Controller that requested the transfer, or {{empty}} if no Controller requested it.
</description>
<syntax>
<string/>
<default type="parameter" value=""/>
</syntax>
</parameter>
<parameter name="TransferType" dmr:version="2.12">
<description>
The type (direction) of the transfer.
</description>
<syntax>
<string>
<enumeration value="Download">
<description>
Downstream transfer; to the Agent.
</description>
</enumeration>
<enumeration value="Upload">
<description>
Upstream transfer; from the Agent.
</description>
</enumeration>
</string>
<default type="parameter" value="Download"/>
</syntax>
</parameter>
<parameter name="Affected" dmr:version="2.12">
<description>
The Path Name of the Object or Object Instance that was affected by the transfer, or {{empty}} if no data model object was affected by the transfer.
</description>
<syntax>
<string/>
<default type="parameter" value=""/>
</syntax>
</parameter>
<parameter name="TransferURL" dmr:version="2.12">
<description>
The URL from or to which this transfer was performed, or {{empty}} if no such URL is available.
</description>
<syntax>
<string>
<size maxLength="1024"/>
</string>
<default type="parameter" value=""/>
</syntax>
</parameter>
<parameter name="StartTime" dmr:version="2.12">
<description>
The date and time in UTC at which the transfer was started. The Device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the ''Unknown Time'' value.
</description>
<syntax>
<dateTime/>
<default type="parameter" value="0001-01-01T00:00:00Z"/>
</syntax>
</parameter>
<parameter name="CompleteTime" dmr:version="2.12">
<description>
The date and time in UTC at which the transfer was fully completed. This need only be filled in if the transfer has been fully completed. The Device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the ''Unknown Time'' value.
</description>
<syntax>
<dateTime/>
<default type="parameter" value="0001-01-01T00:00:00Z"/>
</syntax>
</parameter>
<parameter name="FaultCode" dmr:version="2.12">
<description>
The numerical fault code as defined in {{bibref|TR-369}}. A value of 0 (zero) indicates no fault.
</description>
<syntax>
<unsignedInt/>
<default type="parameter" value="0"/>
</syntax>
</parameter>
<parameter name="FaultString" dmr:version="2.12">
<description>
A human-readable text description of the fault. This field SHOULD be {{empty}} if the {{param|FaultCode}} equals 0 (zero).
</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="parameter" value=""/>
</syntax>
</parameter>
</event>
<command name="AddCertificate()" dmr:version="2.12">
<description>
This command is issued to allow a Controller (with the proper permissions) to add a new certificate to {{object|#.Certificate.{i}}}. This does not automatically produce a trust relationship with the host identified by the Certificate. To produce a trust relationship, an entry is required to exist in {{param|#.Controller.{i}.Credential}} or {{param|#.ControllerTrust.Credential.{i}.Credential}} that references the new {{object|#.Certificate.{i}}} entry. The Agent will use the Serial Number and Issuer fields from the input {{param|Certificate}} to populate the {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters. If {{object|#.Certificate}} already has an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters, this command will fail. To replace an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}}, the existing instance must first be deleted.
</description>
<input>
<parameter name="Alias" dmr:version="2.12">
<description>
An optional input the Controller can use to specify the {{param|##.Certificate.{i}.Alias}} value for the added entry. If provided as an input and the value already exists in {{object|##.Certificate.{i}}}, this commmand will fail.
</description>
<syntax>
<dataType ref="Alias"/>
</syntax>
</parameter>
<parameter name="Certificate" mandatory="true" dmr:version="2.12">
<description>
The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) {{bibref|RFC7468}} format.
</description>
<syntax>
<string>
<size maxLength="65535"/>
</string>
</syntax>
</parameter>
</input>
</command>
<parameter name="SupportedProtocols" access="readOnly" dmr:version="2.12">
<description>
USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol.
</description>
<syntax>
<list minItems="1"/>
<string>
<enumeration value="CoAP">
<description>
See {{bibref|RFC7252}}
</description>
</enumeration>
<enumeration value="WebSocket">
<description>
See {{bibref|RFC6455}}
</description>
</enumeration>
<enumeration value="STOMP">
<description>
See {{bibref|STOMP1.2}}
</description>
</enumeration>
<enumeration value="MQTT">
<description>
See {{bibref|MQTT311}} and {{bibref|MQTT50}}
</description>
</enumeration>
</string>
</syntax>
</parameter>
<parameter name="SupportedFingerprintAlgorithms" access="readOnly" dmr:version="2.12">
<description>
{{list|each entry is an algorithm for calculating firgerprints that is supported by the Agent}}
</description>
<syntax>
<list/>
<string>
<enumeration value="SHA-1">
<description>
As specified in {{bibref|RFC3174}}.
</description>
</enumeration>
<enumeration value="SHA-224">
<description>
As specified in {{bibref|RFC6234}}.
</description>
</enumeration>
<enumeration value="SHA-256">
<description>
As specified in {{bibref|RFC6234}}.
</description>
</enumeration>
<enumeration value="SHA-384">
<description>
As specified in {{bibref|RFC6234}}.
</description>
</enumeration>
<enumeration value="SHA-512">
<description>
As specified in {{bibref|RFC6234}}.
</description>
</enumeration>
</string>
</syntax>
</parameter>
<parameter name="SupportedThresholdOperator" access="readOnly" dmr:version="2.13">
<description>
{{list|each entry is a threshold operation for {{param|Threshold.{i}.ThresholdOperator}} supported by the Agent}}
</description>
<syntax>
<list/>
<string>
<enumeration value="Rise">
<description>
Parameter value changes from below the {{param|Threshold.{i}.ThresholdValue}} to a value above
</description>
</enumeration>
<enumeration value="Fall">
<description>
Parameter value changes from above the {{param|Threshold.{i}.ThresholdValue}} to a value below
</description>
</enumeration>
<enumeration value="Cross">
<description>
Parameter value either changes from above the {{param|Threshold.{i}.ThresholdValue}} to a value below or vice versa
</description>
</enumeration>
<enumeration value="Eq">
<description>
Parameter value changes from any value to the {{param|Threshold.{i}.ThresholdValue}}
</description>
</enumeration>
<enumeration value="NotEq">
<description>
Parameter value changes from the {{param|Threshold.{i}.ThresholdValue}} to any other value
</description>
</enumeration>
</string>
</syntax>
</parameter>
<parameter name="AdvertisedDeviceSubtypes" access="readWrite" dmr:version="2.12">
<description>{{list|each entry is a subtype component of the service type that is advertised for the device using mDNS as defined in {{bibref|RFC6762}}}}
</description>
<syntax>
<list/>
<string/>
</syntax>
</parameter>
<parameter name="MaxSubscriptionChangeAdoptionTime" access="readWrite" dmr:version="2.12">
<description>
The acceptable amount of time in {{units}} between the alteration of the Agent's Subscriptions (e.g. updated subscription, new subscription, removed subscription, etc.) and the notifications related to those subscriptions being delivered.
For example, if this parameter is set to 30 {{units}}, then once a Subscription has been updated, the Agent has 30 {{units}} before it needs to start delivering notifications based on the updated version of the Subscription (instead of the old version of the Subscription).
</description>
<syntax>
<unsignedInt>
<range minInclusive="5"/>
<units value="seconds"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="MTPNumberOfEntries" access="readOnly" dmr:version="2.12">
<description>{{numentries}}</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ThresholdNumberOfEntries" access="readOnly" dmr:version="2.13">
<description>{{numentries}}</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ControllerNumberOfEntries" access="readOnly" dmr:version="2.12">
<description>{{numentries}}</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="SubscriptionNumberOfEntries" access="readOnly" dmr:version="2.12">
<description>{{numentries}}</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="RequestNumberOfEntries" access="readOnly" dmr:version="2.12">
<description>{{numentries}}</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="CertificateNumberOfEntries" access="readOnly" dmr:version="2.12">
<description>{{numentries}}</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="Device.LocalAgent.MTP.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="MTPNumberOfEntries" enableParameter="Enable" dmr:version="2.12">
<description>
Each instance of this table represents a MTP used by the local Agent.
</description>
<uniqueKey functional="false">
<parameter ref="Alias"/>
</uniqueKey>
<parameter name="Alias" access="readWrite" dmr:version="2.12">
<description>
{{datatype|expand}}
</description>
<syntax>
<dataType ref="Alias"/>
</syntax>
</parameter>
<parameter name="Enable" access="readWrite" dmr:version="2.12">
<description>
Enable/Disable this {{object}} instance.
If this {{object}} instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it.
</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="Status" access="readOnly" dmr:version="2.12">
<description>
The current operational state of the {{object}} instance.
</description>
<syntax>
<string>
<enumeration value="Up"/>
<enumeration value="Down">
<description>Value when this {{object}} instance cannot establish communication.</description>
</enumeration>
<enumeration value="Error" optional="true">
<description>Value when this {{object}} instance is misconfigured.</description>
</enumeration>
</string>
</syntax>
</parameter>
<parameter name="Protocol" access="readWrite" dmr:version="2.12">
<description>
The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint.
</description>
<syntax>
<string>
<enumerationRef targetParam="Device.LocalAgent.SupportedProtocols"/>
</string>
<default type="object" value="CoAP"/>
</syntax>
</parameter>
<parameter name="EnableMDNS" access="readWrite" dmr:version="2.12">
<description>
This parameter, when {{true}}, enables the advertisement of DNS-SD services defined for this {{object}} instance using mDNS as defined in {{bibref|RFC6762}}.
This parameter cannot be set to {{true}} if there are multiple {{object}} instances with the same value of the {{param|Protocol}} parameter.
When {{true}}, the hostname advertised in the SRV record MUST be a Fully Qualified Domain Name (FQDN).
The interfaces that advertise these DNS-SD services are restriced to the set of interfaces associated with this {{object}} instance and the interfaces defined by the {{param|##.DNS.SD.AdvertisedInterfaces}} parameter.
</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
</object>
<object name="Device.LocalAgent.Threshold.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="ThresholdNumberOfEntries" enableParameter="Enable" dmr:version="2.13">
<description>
Each instance of this table represents a Threshold Event that is triggered by a threshold test.
For example:
ReferencePath: Device.Ethernet.[Enable==1].Stats.
ThresholdParam: BytesSent
ThresholdOperator: Rise
ThresholdValue: 100000
Would trigger a {{event|Triggered!}} Event whenever a value of a parameter matching Device.Ethernet.[Enable==1].Stats.BytesSent rises from below to above 100000.
</description>
<uniqueKey functional="false">
<parameter ref="Alias"/>
</uniqueKey>
<parameter name="Alias" access="readWrite" dmr:version="2.13">
<description>
{{datatype|expand}}
</description>
<syntax>
<dataType ref="Alias"/>
</syntax>
</parameter>
<parameter name="Enable" access="readWrite" dmr:version="2.13">
<description>
Enable/Disable this {{object}} instance.
If the {{object}} instance is disabled, the {{event|Triggered!}} Event will not be invoked, even if there is a {{object|.LocalAgent.Subscription.{i}.}} instance that references it
</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="OperatingMode" access="readWrite" dmr:version="2.13">
<description>
Determines whether to disable this {{object}} instance after the {{event|Triggered!}} Event has been invoked.
</description>
<syntax>
<string>
<enumeration value="Normal">
<description>
The {{object}} will generate events as long as the {{param|Enable}} is {{true}}
</description>
</enumeration>
<enumeration value="Single">
<description>
After invoking the {{event|Triggered!}} Event, the {{param|Enable}} parameter will be automatically set to {{false}}
</description>
</enumeration>
</string>
<default type="object" value="Normal"/>
</syntax>
</parameter>
<parameter name="ReferencePath" access="readWrite" dmr:version="2.13">
<description>
The combination of {{param}} and {{param|ThresholdParam}} create the reference to the parameter being checked for the threshold test.
{{param}} can be either an Object Path or a Search Path.
</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="ThresholdParam" access="readWrite" dmr:version="2.13">
<description>
The combination of {{param|ReferencePath}} and {{param}} create the reference to the parameter being checked for the threshold test.
{{param}} is the name of the Parameter in the context of {{param|ReferencePath}}.
</description>
<syntax>
<string/>
</syntax>
</parameter>
<parameter name="ThresholdOperator" access="readWrite" dmr:version="2.13">
<description>
The operator used for the threshold test.
</description>
<syntax>
<string>
<enumerationRef targetParam="Device.LocalAgent.SupportedThresholdOperator"/>
</string>
<default type="object" value="Rise"/>
</syntax>
</parameter>
<parameter name="ThresholdValue" access="readWrite" dmr:version="2.13">
<description>
The Value used for the threshold test.