-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathindex.html
More file actions
3542 lines (3525 loc) · 136 KB
/
index.html
File metadata and controls
3542 lines (3525 loc) · 136 KB
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
<!DOCTYPE html>
<!-- BBF GitHub Pages pandoc template; modified from default.html template -->
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8"/>
<meta name="generator" content="pandoc"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"/>
<meta name="author" content=""/>
<meta name="description" content="Broadband Forum CPE WAN Management
Protocol (CWMP) Data Models: Device Data Model Files and
Documentation"/>
<meta name="theme-color" content="#157878"/>
<title>BBF – Broadband Forum CPE WAN Management Protocol (CWMP) Data Models</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
/* The extra [class] is a hack that increases specificity enough to
override a similar rule in reveal.js */
ul.task-list[class]{list-style: none;}
ul.task-list li input[type="checkbox"] {
font-size: inherit;
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
<link rel="stylesheet" href="github.css"/>
<link rel="stylesheet" href="extra.css"/>
<link rel="stylesheet" href="local.css"/>
<link rel="stylesheet" href="toc.css"/>
<!-- Automatic hover links scripts -->
<script>
window.addEventListener('DOMContentLoaded', function() {
var hoverlink = null;
var elems = document.querySelectorAll('.auto-hoverlink:not(section)');
for (var i = 0; i < elems.length; i++) {
var elem = elems[i];
elem.addEventListener('mouseenter', event => {
var target = event.target;
var info_attr = target.attributes.getNamedItem('data-info');
var anchor_attr = target.attributes.getNamedItem('data-anchor');
var thing = info_attr ? info_attr.value : target.localName
/* we check the parent to cover the case where pandoc has moved the
id from a header to its parent section */
var anchor = target.id || target.parentElement.id ||
(anchor_attr ? anchor_attr.value : null);
if (hoverlink) {
hoverlink.remove();
hoverlink = null;
}
if (!anchor) {
console.warn('%s %s has no id or data-anchor',
thing, target.textContent);
} else {
hoverlink = document.createElement('a');
hoverlink.href = '#' + anchor;
hoverlink.className = 'hoverlink';
hoverlink.title = 'Permalink to this ' + thing;
target.appendChild(hoverlink);
}
});
elem.addEventListener('mouseleave', () => {
if (hoverlink) {
setTimeout(function(href) {
if (hoverlink && hoverlink.href == href) {
hoverlink.remove();
hoverlink = null;
}
}, 1000, hoverlink.href);
}
});
}
});
</script>
<!-- Automatic hover links styles -->
<style>
:root {
--hoverlink-gap: 0.2em;
--hoverlink-size: 0.9em;
}
.hoverlink {
text-decoration: none;
}
.hoverlink::after {
position: absolute;
display: inline-block;
content: "";
margin-left: var(--hoverlink-gap);
width: var(--hoverlink-size);
height: var(--hoverlink-size);
background-size: var(--hoverlink-size) var(--hoverlink-size);
/* https://icon-library.com/images/permalink-icon/permalink-icon-17.jpg
(resized from 512x512 to 64x64) */
background-image: url(permalink.png);
}
</style>
<!-- Automatic sections scripts -->
<script>
/* 1. Find all sections, i.e., elements with class "new-section"
2. If a section has no id (shouldn't happen), auto-assign one
3. For each element with an id, set "data-section" to its section id
4. For each internal link, similarly set "data-section" to its section id
*/
window.addEventListener('DOMContentLoaded', () => {
var target_sections = new Map();
var sections = document.getElementsByClassName('new-section');
for (var i = 0; i < sections.length; i++) {
var section = sections[i];
if (!section.id) {
section.id = 'section-' + i;
}
target_sections.set(section.id, section.id);
section.setAttribute('data-section', section.id)
var targets = section.querySelectorAll('[id]');
for (var j = 0; j < targets.length; j++) {
var target = targets[j];
target_sections.set(target.id, section.id);
target.setAttribute('data-section', section.id)
}
}
var doc_url = new URL(document.URL);
var links = document.querySelectorAll('a[href]');
var warned = new Map()
for (var i = 0; i < links.length; i++) {
var link = links[i];
var url = new URL(link.href, document.URL);
if (url.hostname == doc_url.hostname &&
url.pathname == doc_url.pathname && url.hash) {
var href = url.hash.substring(1);
var section_id = target_sections.get(href)
if (!section_id) {
if (!warned.get(href)) {
console.warn("href %s undefined or not within a section",
href);
warned.set(href, true);
}
} else {
link.setAttribute('data-section', section_id);
}
}
}
});
/* Create a new scope to avoid using a global variable */
(function() {
/* Show the section with the given id, which is assumed to be valid */
function show_section(section_id) {
var section = document.getElementById(section_id);
/* The "cover-only" class indicates elements that should only be
shown when the cover page section is shown */
var cover_onlys = document.getElementsByClassName('cover-only');
if (section) {
for (var i = 0; i < cover_onlys.length; i++) {
var cover_only = cover_onlys[i];
if (section_id != 'sec:cover-page') {
cover_only.classList.add('hidden')
} else {
cover_only.classList.remove('hidden')
}
}
}
/* Hide all sections, then un-hide this one */
var sections = document.getElementsByClassName('new-section');
for (var i = 0; i < sections.length; i++) {
sections[i].classList.add('hidden');
}
section.classList.remove('hidden')
}
/* Add click events to all links, using the "data-section" attribute
(set earlier) to show the associated section */
window.addEventListener('DOMContentLoaded', () => {
var links = document.querySelectorAll('a[data-section]');
for (var i = 0; i < links.length; i++) {
links[i].addEventListener('click', event => {
var link = event.currentTarget;
var section_id = link.attributes['data-section'].value;
show_section(section_id);
});
}
});
/* Ensure that loading the page with a URL fragment (hash) will show the
associated section */
window.addEventListener('DOMContentLoaded', () => {
var url = new URL(document.URL);
if (url.hash.length > 1) {
var href = url.hash.substring(1);
var target = document.getElementById(href);
if (!target) {
var fallback = 'sec:executive-summary';
console.warn("target %s undefined; falling back on %s",
href, fallback);
href = fallback;
target = document.getElementById(href);
if (!target) {
var fallback = 'sec:cover-page';
console.warn("target %s undefined; falling back on %s",
href, fallback);
href = fallback;
target = document.getElementById(href);
}
}
if (!target) {
console.warn("target %s undefined", href);
} else {
var section_id = target.attributes['data-section'].value;
if (!section_id) {
console.warn("target %s not within a section", href);
} else {
show_section(section_id);
}
}
}
});
/* End of new scope */
})();
</script>
<!-- Automatic sections styles -->
<style>
h1.cover-page, .hidden, aside.footnotes-end-of-document {
display: none;
}
</style>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<section class="page-header">
<h1 class="project-name">
<a href="index.html" style="text-decoration: none; color: white;">
<img src="bbflogo-reverse-dark.png"/><br>
CPE WAN Management Protocol
</a>
</h1>
<h2 class="project-tagline">Device Data Model Files and
Documentation</h2>
<p></p>
<p></p>
<div class="project-buttons">
<a class="btn" href="#sec:current-data-models">Current Data
Models</a>
<a class="btn" href="https://device-data-model.broadband-forum.org" title="TR-181">Device
Data Model</a>
<a class="btn" href="https://data-model-template.broadband-forum.org" title="TR-106">Data
Model Template</a>
<a class="btn" href="https://pypi.org/project/bbfreport" title="bbfreport">Report
Tool</a>
<a class="btn" href="https://www.broadband-forum.org/download/TR-069.pdf" title="CWMP
Specification">Specification</a>
<a class="btn" href="https://usp.technology" title="usp.technology">Discover
USP</a>
</div>
</section>
<section class="main-content">
<header id="title-block-header" class="cover-only">
<h1 class="title auto-hoverlink" id="title">Broadband Forum CPE
WAN Management Protocol (CWMP) Data Models</h1>
<p class="subtitle">2025-12-01: TR-106 Amendment 16 Corrigendum 1
and <a
href="https://www.broadband-forum.org/download/TR-181_Issue-2_Amendment-20_Corrigendum-1.pdf">TR-181
Issue 2 Amendment 20 Corrigendum 1</a></p>
<p class="author"></p>
</header>
<nav id="SIDEBAR" role="doc-toc">
<ul>
<li><a href="#sec:cover-page">Introduction</a></li>
<li><a href="#sec:current-data-models">Current Data Models</a>
<ul>
<li><a href="#sec:current-device2"><span
class="heading">Device:2</span></a></li>
<li><a href="#sec:current-fapservice2"><span
class="heading">FAPService:2</span></a></li>
<li><a href="#sec:current-fapservice1"><span
class="heading">FAPService:1</span></a></li>
<li><a href="#sec:current-storageservice1"><span
class="heading">StorageService:1</span></a></li>
<li><a href="#sec:current-stbservice1"><span
class="heading">STBService:1</span></a></li>
<li><a href="#sec:current-voiceservice2"><span
class="heading">VoiceService:2</span></a></li>
<li><a href="#sec:current-voiceservice1"><span
class="heading">VoiceService:1</span></a></li>
</ul></li>
<li><a href="#sec:root-data-models">Root Data Models</a>
<ul>
<li><a href="#sec:device2">Device:2</a></li>
<li><a href="#sec:device1-deprecated">Device:1
<strong>[DEPRECATED]</strong></a></li>
<li><a
href="#sec:internetgatewaydevice1-deprecated">InternetGatewayDevice:1
<strong>[DEPRECATED]</strong></a></li>
</ul></li>
<li><a href="#sec:service-data-models">Service Data Models</a>
<ul>
<li><a href="#sec:fapservice2">FAPService:2</a></li>
<li><a href="#sec:fapservice1">FAPService:1</a></li>
<li><a href="#sec:storageservice1">StorageService:1</a></li>
<li><a href="#sec:stbservice1">STBService:1</a></li>
<li><a href="#sec:voiceservice2">VoiceService:2</a></li>
<li><a href="#sec:voiceservice1">VoiceService:1</a></li>
</ul></li>
<li><a href="#sec:component-definitions">Component Definitions</a>
<ul>
<li><a href="#sec:femto-components">Femto Components</a></li>
<li><a href="#sec:component-objects-for-cwmp-deprecated">Component
Objects for CWMP <strong>[DEPRECATED]</strong></a></li>
<li><a href="#sec:network-performance-tests">Network Performance
Tests</a></li>
</ul></li>
<li><a href="#sec:schema-files">Schema Files</a>
<ul>
<li><a href="#sec:xmpp-connection-request-schema">XMPP Connection
Request Schema</a></li>
<li><a href="#sec:udp-lightweight-notification-schema">UDP Lightweight
Notification Schema</a></li>
<li><a
href="#sec:ipdr-service-specification-for-bulk-data-collection">IPDR
Service Specification for Bulk Data Collection</a></li>
<li><a href="#sec:device-type-schema-dt-schema">Device Type Schema (DT
Schema)</a></li>
<li><a href="#sec:data-model-report-schema-dmr-schema">Data Model Report
Schema (DMR Schema)</a></li>
<li><a href="#sec:dt-device-type-features-schema-dtf-schema">DT (Device
Type) Features Schema (DTF Schema)</a></li>
<li><a href="#sec:dm-data-model-definition-schema-dm-schema">DM Data
Model Definition Schema (DM Schema)</a></li>
<li><a href="#sec:cwmp-rpc-schema">CWMP RPC Schema</a></li>
<li><a href="#sec:xml-catalog"><span>XML Catalog</span></a></li>
</ul></li>
<li><a href="#sec:support-files">Support Files</a>
<ul>
<li><a href="#sec:data-model-data-types">Data Model Data Types</a></li>
<li><a href="#sec:data-model-bibliographic-references">Data Model
Bibliographic References</a></li>
</ul></li>
<li><a href="#sec:outdated-corrigenda">Outdated Corrigenda</a></li>
</ul>
</nav>
<section id="sec:cover-page" class="cover-page unnumbered new-section">
<h1 class="cover-page unnumbered">Introduction</h1>
<ul class="task-list">
</ul>
<p>The Broadband Forum defines several data models for use with the CPE
WAN Management Protocol (<a
href="https://www.broadband-forum.org/download/TR-069.pdf">TR-069
Amendment 6</a>). These data models contain objects and parameters that
describe the many different functions and capabilities available to
devices and services that are manageable via CWMP.</p>
<p>CWMP data models are divided into two types: <em>Root</em> and
<em>Service</em>. The root data model, <em>Device</em><a
href="#fn1"><span id="fnref1"><sup>1</sup></span></a>, is used to
describe the major functions of a network aware device, including
interfaces, software/firmware, diagnostics, components common to CWMP
and other services, and the basic device information necessary to
CWMP.</p>
<p>Service data models describe modular functionality that allow the
extension of the root data model on a device (under
<em>Device.Services.</em>) to provide particular services, such as a
voice service, set top box service, network attached storage, etc.</p>
<p>Each data model is defined by a <em>Name:Version</em> syntax. A
device defines its data model by defining a <em>device type</em>, an XML
document that maps to (imports) BBF official data model objects and/or
vendor specific objects. A full explanation of how to develop compliant
CWMP data models can be found in <a
href="https://www.broadband-forum.org/download/TR-154.pdf">TR-154</a>.</p>
<p>Note: All the files below are directly reachable via: <a
href="https://www.broadband-forum.org/cwmp/%3Cfilename"
class="uri">https://www.broadband-forum.org/cwmp/<filename</a>>.</p>
<h2 class="unlisted auto-hoverlink" data-info="header"
id="sec:how-do-i-use-these">How do I use these?</h2>
<p>Use the CWMP data model files to define and implement what exists in
your solution’s <em>Supported Data Model</em>. This will help the ACS to
learn what your CPE is capable of. The data models will also describe
how your CPE’s <em>Instantiated Data Model</em> will behave during
operation.</p>
<ul>
<li>View the HTML files on this page for a human-readable look at the
data model documentation.</li>
<li>Use the XML files in this repository when generating code and
performing data validation.</li>
</ul>
<p>These data models are the basis for the Broadband Forum’s <a
href="https://usp-data-models.broadband-forum.org">data models for the
User Services Platform (USP)</a>.</p>
<p>The source files used to build the complete CWMP data model can be
found on <a
href="https://github.com/BroadbandForum/cwmp-data-models">GitHub</a>.</p>
<p>A ZIP file containing all the latest data models can be downloaded
from <a
href="https://github.com/BroadbandForum/cwmp-data-models/archive/master.zip">here</a>.</p>
<hr />
<ol>
<li><div id="fn1">
<p>Early versions of the CWMP data model defined two root data models,
<em>InternetGatewayDevice</em> and <em>Device</em>. Version 2 of the
<em>Device</em> root data model (<em>Device:2</em>) deprecates
<em>InternetGatewayDevice</em> and <em>Device:1</em> in favor of a
single root data model.<a href="#fnref1">↩</a></p>
</div></li>
</ol>
</section>
<section id="sec:current-data-models"
class="auto-hoverlink new-section hidden" data-info="header">
<h1 class="auto-hoverlink" data-info="header">Current Data Models</h1>
<table class="data-models">
<colgroup>
<col style="width: 8%" />
<col style="width: 6%" />
<col style="width: 8%" />
<col style="width: 3%" />
<col style="width: 50%" />
<col style="width: 8%" />
<col style="width: 12%" />
</colgroup>
<thead>
<tr>
<th style="text-align: left;">Data Model</th>
<th style="text-align: left;">Version</th>
<th style="text-align: left;">XML</th>
<th style="text-align: left;">HTML</th>
<th style="text-align: left;">Description</th>
<th style="text-align: left;">Date</th>
<th style="text-align: left;">Specification</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="4" style="text-align: left;"><h2 id="sec:current-device2"
class="auto-hoverlink" data-info="header"><a href="#sec:device2"
class="heading">Device:2</a></h2></td>
<td rowspan="4" style="text-align: left;"><p> 2.20</p></td>
<td rowspan="2" style="text-align: left;"><p> <span
id="tr-181-2-20-1-cwmp.xml" class="auto-hoverlink"><a
href="tr-181-2-20-1-cwmp-full.xml">tr-181-2-20-1-cwmp-full.xml</a></span></p></td>
<td style="text-align: left;"><p><a
href="tr-181-2-20-1-cwmp.html"><strong>Full</strong></a></p></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Fixed Cellular APN type to be compatible with the 5G Data Network
Name</li>
<li>Changed Cellular SIM Location parameter to be read-only</li>
<li>Added additional bibrefs to PON power safe parameter</li>
<li>Changed TrustedElement PIN from being a string with maximum size 4
to be a digit-only string with a size between 4 to 8</li>
<li>Changed TrustedElement Status parameter to be read-only</li>
</ul></td>
<td rowspan="2" style="text-align: left;"><p> December 2025</p></td>
<td rowspan="2" style="text-align: left;"><p> <a
href="https://device-data-model.broadband-forum.org">Device Data
Model</a></p>
<p><a
href="https://www.broadband-forum.org/download/TR-181_Issue-2_Amendment-20_Corrigendum-1.pdf">TR-181
Issue 2 Amendment 20 Corrigendum 1</a></p></td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-181-2-20-1-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td rowspan="2" style="text-align: left;"><p> <span
id="tr-181-2-20-0-cwmp.xml" class="auto-hoverlink"><a
href="tr-181-2-20-0-cwmp-full.xml">tr-181-2-20-0-cwmp-full.xml</a></span></p></td>
<td style="text-align: left;"><p><a
href="tr-181-2-20-0-cwmp.html"><strong>Full</strong></a></p></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Added support for periodic file uploads via
Device.PeriodicFileTransfer.</li>
<li>Added support for hardware specific information under
Device.Hardware.</li>
<li>Added support for configuring device internal connection monitoring
mechanisms and automatic remedies under
Device.ConnectionMonitoring.</li>
<li>Various features allow to specify a Certificate and a CABundle for
mutual TLS authentication</li>
<li>Added support for low and high temperature events in
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}.</li>
<li>Added support for the Wi-Fi Data Elements feature “Wi-Fi
Configuration Templates” under Device.WiFi.Templates.</li>
<li>Added Device.DeviceInfo.Reboots.CurrentBootCycle</li>
<li>Added peripheral power management for
<ul>
<li>Ethernet to Device.Ethernet.Interface.{i}.</li>
<li>USB to Device.USB.Port.{i}.</li>
<li>Wi-Fi to Device.WiFi.Radio.{i}.</li>
<li>Thread to Device.Thread.Radio.{i}.</li>
<li>XPON to Device.XPON.ONU.{i}.PowerManagement.</li>
</ul></li>
<li>Added USB device state reporting and the ability to configure which
USB devices are allowed to connect via the
Device.USB.USBHosts.AllowedDevice.{i}. table</li>
<li>Added Type and Interface parameters to
Device.HomePlug.Interface.{i}.</li>
<li>Marked Wi-Fi commands FullScan(), ChannelScan(), Disassociate(), and
BTMRequest() obsoleted</li>
<li>Added antenna configuration to Device.WiFi.Radio.{i}.</li>
<li>Added a full WireGuard VPN datamodel under Device.WireGuard.</li>
<li>Added Device.WiFi.Radio.{i}.Capabilities. tree</li>
<li>Added MTU parameter to Device.WiFi.SSID.{i}.</li>
<li>Added IPLayerCapacityIncrementalResult! event to
Device.IP.Diagnostics.</li>
<li>Improved Device.Routing.Router.{i}. support and added
Device.Routing.Policy.{i}.</li>
<li>Added host table cleanup support to Device.Hosts.</li>
<li>Added Device.DNS.RebindProtection.</li>
<li>Added Release() command to Device.DHCPv4.Client.{i}. and
Device.DHCPv6.Client.{i}.</li>
<li>Added the configuration of the UPnP IGD service via
Device.UPnP.Device.IGD.</li>
<li>Added FloodLimit and BurstLimit parameters to
Device.Firewall.Chain.{i}.Rule.{i}.</li>
<li>Added support for GetCertificateURI() under
Device.Security.Certificate.{i}.</li>
<li>Added Role configuration to
Device.SoftwareModules.ExecutionUnit.{i}.</li>
<li>Added authentication to UDS MTP via
Device.UnixDomainSockets.Authentication.{i}.</li>
<li>Added interface stack and IP address support to
Device.SessionManagement.Session.{i}.</li>
<li>Added support for Device.IoTCapability.{i}.PulseControl. and
Device.IoTCapability.{i}.Binding.{i}.</li>
<li>Improved descriptions of some parameters with ranged types</li>
<li>Added support for setting the transport mode in the MQTT Broker
configuration</li>
<li>Miscellaneous spelling corrections and markup improvements</li>
</ul></td>
<td rowspan="2" style="text-align: left;"><p> November 2025</p></td>
<td rowspan="2" style="text-align: left;"><p> <a
href="https://device-data-model.broadband-forum.org">Device Data
Model</a></p>
<p><a
href="https://www.broadband-forum.org/download/TR-181_Issue-2_Amendment-20.pdf">TR-181
Issue 2 Amendment 20</a></p></td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-181-2-20-0-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td colspan="7" style="text-align: left;"></td>
</tr>
<tr>
<td rowspan="5" style="text-align: left;"><h2
id="sec:current-fapservice2" class="auto-hoverlink"
data-info="header"><a href="#sec:fapservice2"
class="heading">FAPService:2</a></h2></td>
<td rowspan="5" style="text-align: left;"><p> 2.1</p></td>
<td rowspan="2" style="text-align: left;"><p> <span
id="tr-196-2-1-2-cwmp.xml" class="auto-hoverlink"><a
href="tr-196-2-1-2-cwmp-full.xml">tr-196-2-1-2-cwmp-full.xml</a></span></p></td>
<td style="text-align: left;"><p><a
href="tr-196-2-1-2-cwmp.html"><strong>Full</strong></a></p></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Deprecated Blacklisted parameters and replaced with Blocklisted
parameters</li>
</ul></td>
<td rowspan="2" style="text-align: left;"><p> July 2022</p></td>
<td rowspan="5" style="text-align: left;"><p> <a
href="https://www.broadband-forum.org/download/TR-196_Issue-2.pdf">TR-196
Issue 2</a></p></td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-196-2-1-2-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td rowspan="2" style="text-align: left;"> <span
id="tr-196-2-1-1-cwmp.xml" class="auto-hoverlink"><a
href="tr-196-2-1-1-cwmp-full.xml">tr-196-2-1-1-cwmp-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-196-2-1-1-cwmp.html"><strong>Full</strong></a></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Added USP support (split XML into common, CWMP and USP files)</li>
</ul></td>
<td rowspan="2" style="text-align: left;"> September 2019</td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-196-2-1-1-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td style="text-align: left;"><span id="tr-196-2-1-0.xml"
class="auto-hoverlink"><a
href="tr-196-2-1-0-full.xml">tr-196-2-1-0-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-196-2-1-0.html"><strong>Full</strong></a></td>
<td style="text-align: left;"><ul>
<li>Added parameters for 3GPP SA5 Rel 11 and 12 (TS 32.452, TS
32.453)</li>
<li>Added parameters for 3GPP SA5 Rel 13 (CR S5-145293)</li>
<li>Added parameters for 3GPP SA5 Rel 13 (CR S5-146268)</li>
</ul></td>
<td style="text-align: left;">August 2015</td>
</tr>
<tr>
<td colspan="7" style="text-align: left;"></td>
</tr>
<tr>
<td rowspan="2" style="text-align: left;"><h2
id="sec:current-fapservice1" class="auto-hoverlink"
data-info="header"><a href="#sec:fapservice1"
class="heading">FAPService:1</a></h2></td>
<td rowspan="2" style="text-align: left;"><p> 1.1</p></td>
<td style="text-align: left;"><p><span id="tr-196-1-1-1.xml"
class="auto-hoverlink"><a
href="tr-196-1-1-1-full.xml">tr-196-1-1-1-full.xml</a></span></p></td>
<td style="text-align: left;"><p><a
href="tr-196-1-1-1.html"><strong>Full</strong></a></p></td>
<td style="text-align: left;"><ul>
<li>Added Alias parameters</li>
</ul></td>
<td style="text-align: left;"><p>November 2012</p></td>
<td style="text-align: left;"><p><a
href="https://www.broadband-forum.org/download/TR-196_Amendment-1_Corrigendum-1.pdf">TR-196
Amendment 1 Corrigendum 1</a></p></td>
</tr>
<tr>
<td style="text-align: left;"><span id="tr-196-1-1-0.xml"
class="auto-hoverlink"><a
href="tr-196-1-1-0-full.xml">tr-196-1-1-0-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-196-1-1-0.html"><strong>Full</strong></a></td>
<td style="text-align: left;"><ul>
<li>Supported 3GPP releases 9 and 10</li>
</ul></td>
<td style="text-align: left;">May 2011</td>
<td style="text-align: left;"><a
href="https://www.broadband-forum.org/download/TR-196_Amendment-1.pdf">TR-196
Amendment 1</a></td>
</tr>
<tr>
<td colspan="7" style="text-align: left;"></td>
</tr>
<tr>
<td rowspan="3" style="text-align: left;"><h2
id="sec:current-storageservice1" class="auto-hoverlink"
data-info="header"><a href="#sec:storageservice1"
class="heading">StorageService:1</a></h2></td>
<td rowspan="3" style="text-align: left;"><p> 1.3</p></td>
<td rowspan="2" style="text-align: left;"><p> <span
id="tr-140-1-3-1-cwmp.xml" class="auto-hoverlink"><a
href="tr-140-1-3-1-cwmp-full.xml">tr-140-1-3-1-cwmp-full.xml</a></span></p></td>
<td style="text-align: left;"><p><a
href="tr-140-1-3-1-cwmp.html"><strong>Full</strong></a></p></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Added USP support (split XML into common, CWMP and USP files)</li>
</ul></td>
<td rowspan="2" style="text-align: left;"><p> September 2019</p></td>
<td rowspan="3" style="text-align: left;"><p> <a
href="https://www.broadband-forum.org/download/TR-140_Amendment-3.pdf">TR-140
Amendment 3</a></p></td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-140-1-3-1-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td style="text-align: left;"><span id="tr-140-1-3-0.xml"
class="auto-hoverlink"><a
href="tr-140-1-3-0-full.xml">tr-140-1-3-0-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-140-1-3-0.html"><strong>Full</strong></a></td>
<td style="text-align: left;"><ul>
<li>Update file system and connection enumerations</li>
<li>Added SMART data model</li>
</ul></td>
<td style="text-align: left;">May 2017</td>
</tr>
<tr>
<td colspan="7" style="text-align: left;"></td>
</tr>
<tr>
<td rowspan="3" style="text-align: left;"><h2
id="sec:current-stbservice1" class="auto-hoverlink"
data-info="header"><a href="#sec:stbservice1"
class="heading">STBService:1</a></h2></td>
<td rowspan="3" style="text-align: left;"><p> 1.4</p></td>
<td rowspan="2" style="text-align: left;"><p> <span
id="tr-135-1-4-1-cwmp.xml" class="auto-hoverlink"><a
href="tr-135-1-4-1-cwmp-full.xml">tr-135-1-4-1-cwmp-full.xml</a></span></p></td>
<td style="text-align: left;"><p><a
href="tr-135-1-4-1-cwmp.html"><strong>Full</strong></a></p></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Added USP support (split XML into common, CWMP and USP files)</li>
</ul></td>
<td rowspan="2" style="text-align: left;"><p> September 2019</p></td>
<td rowspan="3" style="text-align: left;"><p> <a
href="https://www.broadband-forum.org/download/TR-135_Amendment-3.pdf">TR-135
Amendment 3</a></p></td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-135-1-4-1-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td style="text-align: left;"><span id="tr-135-1-4-0.xml"
class="auto-hoverlink"><a
href="tr-135-1-4-0-full.xml">tr-135-1-4-0-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-135-1-4-0.html"><strong>Full</strong></a></td>
<td style="text-align: left;"><ul>
<li>Added objects for Service Monitoring of Events</li>
</ul></td>
<td style="text-align: left;">August 2015</td>
</tr>
<tr>
<td colspan="7" style="text-align: left;"></td>
</tr>
<tr>
<td rowspan="3" style="text-align: left;"><h2
id="sec:current-voiceservice2" class="auto-hoverlink"
data-info="header"><a href="#sec:voiceservice2"
class="heading">VoiceService:2</a></h2></td>
<td rowspan="3" style="text-align: left;"><p> 2.0</p></td>
<td style="text-align: left;"><p><span id="tr-104-2-0-2-cwmp.xml"
class="auto-hoverlink"><a
href="tr-104-2-0-2-cwmp-full.xml">tr-104-2-0-2-cwmp-full.xml</a></span></p></td>
<td style="text-align: left;"><p><a
href="tr-104-2-0-2-cwmp.html"><strong>Full</strong></a></p></td>
<td style="text-align: left;"><ul>
<li>Clarified meaning of SessionID and added new SIPSessionID</li>
</ul></td>
<td style="text-align: left;"><p>January 2020</p></td>
<td rowspan="3" style="text-align: left;"><p> <a
href="https://www.broadband-forum.org/download/TR-104_Issue-2.pdf">TR-104
Issue 2</a></p></td>
</tr>
<tr>
<td style="text-align: left;"><span id="tr-104-2-0-1-cwmp.xml"
class="auto-hoverlink"><a
href="tr-104-2-0-1-cwmp-full.xml">tr-104-2-0-1-cwmp-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-104-2-0-1-cwmp.html"><strong>Full</strong></a></td>
<td style="text-align: left;"><ul>
<li>Added USP support (split XML into common, CWMP and USP files)</li>
</ul></td>
<td style="text-align: left;">September 2019</td>
</tr>
<tr>
<td style="text-align: left;"><span id="tr-104-2-0-0.xml"
class="auto-hoverlink"><a
href="tr-104-2-0-0-full.xml">tr-104-2-0-0-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-104-2-0-0.html"><strong>Full</strong></a></td>
<td style="text-align: left;"><ul>
<li>Original</li>
</ul></td>
<td style="text-align: left;">March 2014</td>
</tr>
<tr>
<td colspan="7" style="text-align: left;"></td>
</tr>
<tr>
<td style="text-align: left;"><h2 id="sec:current-voiceservice1"
class="auto-hoverlink" data-info="header"><a href="#sec:voiceservice1"
class="heading">VoiceService:1</a></h2></td>
<td style="text-align: left;">1.1</td>
<td style="text-align: left;"><span id="tr-104-1-1-0.xml"
class="auto-hoverlink"><a
href="tr-104-1-1-0-full.xml">tr-104-1-1-0-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-104-1-1-0.html"><strong>Full</strong></a></td>
<td style="text-align: left;"><ul>
<li>Added <em>Alias</em> parameters</li>
</ul></td>
<td style="text-align: left;">July 2011</td>
<td style="text-align: left;"><a
href="https://www.broadband-forum.org/download/TR-104_Issue-1.pdf">TR-104
Issue 1</a></td>
</tr>
</tbody>
</table>
</section>
<section id="sec:root-data-models"
class="auto-hoverlink new-section hidden" data-info="header">
<h1 class="auto-hoverlink" data-info="header">Root Data Models</h1>
<table class="data-models">
<colgroup>
<col style="width: 8%" />
<col style="width: 6%" />
<col style="width: 8%" />
<col style="width: 3%" />
<col style="width: 50%" />
<col style="width: 8%" />
<col style="width: 12%" />
</colgroup>
<thead>
<tr>
<th style="text-align: left;">Data Model</th>
<th style="text-align: left;">Version</th>
<th style="text-align: left;">XML</th>
<th style="text-align: left;">HTML</th>
<th style="text-align: left;">Description</th>
<th style="text-align: left;">Date</th>
<th style="text-align: left;">Specification</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="41" style="text-align: left;"><h2 id="sec:device2"
class="auto-hoverlink" data-info="header">Device:2</h2></td>
<td rowspan="4" style="text-align: left;"><p> 2.20</p></td>
<td rowspan="2" style="text-align: left;"><p> <a
href="tr-181-2-20-1-cwmp-full.xml">tr-181-2-20-1-cwmp-full.xml</a></p></td>
<td style="text-align: left;"><p><a
href="tr-181-2-20-1-cwmp.html"><strong>Full</strong></a></p></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Fixed Cellular APN type to be compatible with the 5G Data Network
Name</li>
<li>Changed Cellular SIM Location parameter to be read-only</li>
<li>Added additional bibrefs to PON power safe parameter</li>
<li>Changed TrustedElement PIN from being a string with maximum size 4
to be a digit-only string with a size between 4 to 8</li>
<li>Changed TrustedElement Status parameter to be read-only</li>
</ul></td>
<td rowspan="2" style="text-align: left;"><p> December 2025</p></td>
<td rowspan="2" style="text-align: left;"><p> <a
href="https://device-data-model.broadband-forum.org">Device Data
Model</a></p>
<p><a
href="https://www.broadband-forum.org/download/TR-181_Issue-2_Amendment-20_Corrigendum-1.pdf">TR-181
Issue 2 Amendment 20 Corrigendum 1</a></p></td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-181-2-20-1-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td rowspan="2" style="text-align: left;"> <a
href="tr-181-2-20-0-cwmp-full.xml">tr-181-2-20-0-cwmp-full.xml</a></td>
<td style="text-align: left;"><a
href="tr-181-2-20-0-cwmp.html"><strong>Full</strong></a></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Added support for periodic file uploads via
Device.PeriodicFileTransfer.</li>
<li>Added support for hardware specific information under
Device.Hardware.</li>
<li>Added support for configuring device internal connection monitoring
mechanisms and automatic remedies under
Device.ConnectionMonitoring.</li>
<li>Various features allow to specify a Certificate and a CABundle for
mutual TLS authentication</li>
<li>Added support for low and high temperature events in
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}.</li>
<li>Added support for the Wi-Fi Data Elements feature “Wi-Fi
Configuration Templates” under Device.WiFi.Templates.</li>
<li>Added Device.DeviceInfo.Reboots.CurrentBootCycle</li>
<li>Added peripheral power management for
<ul>
<li>Ethernet to Device.Ethernet.Interface.{i}.</li>
<li>USB to Device.USB.Port.{i}.</li>
<li>Wi-Fi to Device.WiFi.Radio.{i}.</li>
<li>Thread to Device.Thread.Radio.{i}.</li>
<li>XPON to Device.XPON.ONU.{i}.PowerManagement.</li>
</ul></li>
<li>Added USB device state reporting and the ability to configure which
USB devices are allowed to connect via the
Device.USB.USBHosts.AllowedDevice.{i}. table</li>
<li>Added Type and Interface parameters to
Device.HomePlug.Interface.{i}.</li>
<li>Marked Wi-Fi commands FullScan(), ChannelScan(), Disassociate(), and
BTMRequest() obsoleted</li>
<li>Added antenna configuration to Device.WiFi.Radio.{i}.</li>
<li>Added a full WireGuard VPN datamodel under Device.WireGuard.</li>
<li>Added Device.WiFi.Radio.{i}.Capabilities. tree</li>
<li>Added MTU parameter to Device.WiFi.SSID.{i}.</li>
<li>Added IPLayerCapacityIncrementalResult! event to
Device.IP.Diagnostics.</li>
<li>Improved Device.Routing.Router.{i}. support and added
Device.Routing.Policy.{i}.</li>
<li>Added host table cleanup support to Device.Hosts.</li>
<li>Added Device.DNS.RebindProtection.</li>
<li>Added Release() command to Device.DHCPv4.Client.{i}. and
Device.DHCPv6.Client.{i}.</li>
<li>Added the configuration of the UPnP IGD service via
Device.UPnP.Device.IGD.</li>
<li>Added FloodLimit and BurstLimit parameters to
Device.Firewall.Chain.{i}.Rule.{i}.</li>
<li>Added support for GetCertificateURI() under
Device.Security.Certificate.{i}.</li>
<li>Added Role configuration to
Device.SoftwareModules.ExecutionUnit.{i}.</li>
<li>Added authentication to UDS MTP via
Device.UnixDomainSockets.Authentication.{i}.</li>
<li>Added interface stack and IP address support to
Device.SessionManagement.Session.{i}.</li>
<li>Added support for Device.IoTCapability.{i}.PulseControl. and
Device.IoTCapability.{i}.Binding.{i}.</li>
<li>Improved descriptions of some parameters with ranged types</li>
<li>Added support for setting the transport mode in the MQTT Broker
configuration</li>
<li>Miscellaneous spelling corrections and markup improvements</li>
</ul></td>
<td rowspan="2" style="text-align: left;"> November 2025</td>
<td rowspan="2" style="text-align: left;"> <a
href="https://www.broadband-forum.org/download/TR-181_Issue-2_Amendment-20.pdf">TR-181
Issue 2 Amendment 20</a></td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-181-2-20-0-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td rowspan="4" style="text-align: left;"> 2.19</td>
<td rowspan="2" style="text-align: left;"> <span
id="tr-181-2-19-1-cwmp.xml" class="auto-hoverlink"><a
href="tr-181-2-19-1-cwmp-full.xml">tr-181-2-19-1-cwmp-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-181-2-19-1-cwmp.html"><strong>Full</strong></a></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Fix the order of some datamodel objects in the rendered HTML</li>
<li>Explain permissions behaviour for Get messages</li>
<li>Add missing spec attributes, messing up the diffs from future
versions</li>
</ul></td>
<td rowspan="4" style="text-align: left;"> April 2025</td>
<td rowspan="2" style="text-align: left;"> <a
href="https://www.broadband-forum.org/download/TR-181_Issue-2_Amendment-19_Corrigendum-1.pdf">TR-181
Issue 2 Amendment 19 Corrigendum 1</a></td>
</tr>
<tr>
<td style="text-align: left;"><a
href="tr-181-2-19-1-cwmp-diffs.html">Diff</a></td>
</tr>
<tr>
<td rowspan="2" style="text-align: left;"> <span
id="tr-181-2-19-0-cwmp.xml" class="auto-hoverlink"><a
href="tr-181-2-19-0-cwmp-full.xml">tr-181-2-19-0-cwmp-full.xml</a></span></td>
<td style="text-align: left;"><a
href="tr-181-2-19-0-cwmp.html"><strong>Full</strong></a></td>
<td rowspan="2" style="text-align: left;"><ul>
<li>Included LinkReadWrite component instead of Link component on all
networking interfaces and automatically create most of the
Parameters</li>
<li>Added support for Cellular short message service</li>
<li>Revamped Device.Cellular.Interface.</li>
<li>Made previously USP-only Device.CollectionDevice. available to
CWMP</li>
<li>Added note about limited abilities of Device.SoftwareModules. in
CWMP</li>
<li>Addressed some versioning issues in the CWMP specific datamodel</li>
<li>Added ability to rotate KernelFault and ProcessFault entries</li>
<li>Added more features to DHCP configuration and Stats for DHCP
use</li>
<li>Added logging support for Firewall in Device.Firewall.Log.{i}.</li>
<li>Added BlobSensor to IoT</li>
<li>Added the latest IPLayerCapacity diagnostics features, including
authentication, better status and results</li>
<li>Added more LED control parameters</li>
<li>Added ALPN support to MQTT</li>
<li>Added SFP support via Device.SFPs.</li>
<li>Added SFP support to Device.Optical.Interface.{i}.</li>
<li>Deprecated Device.PDU.</li>
<li>Added new 3GPP mobile network session management support via
Device.SessionManagement.</li>
<li>Added Radius security via Device.RadSecProxy.</li>
<li>Added TLS support to SysLog</li>
<li>Added support for the Thread protocol via Device.Thread.</li>
<li>Added support for trusted elements (e.g. mobile SIM) via
Device.TrustedElements.</li>
<li>Added support for Wi-Fi DataElements r4</li>
<li>Added support for Ethernet advertised link modes</li>
<li>Changed writeOnceReadOnly Parameters to readOnly in CWMP</li>
<li>Added support for power monitoring via
Device.DeviceInfo.PowerStatus.</li>
<li>Added selection of IPv4/IPv6 mode to NTP client</li>
<li>Added new permission system for USP services</li>
<li>Revamped Bitrate parameters into a component</li>
<li>Revamped IPVersion parameters into a component</li>
<li>Revamped DHCP client configuration into components</li>
<li>Added some missing units to IoT</li>
<li>Revamped client certificates into a component</li>
<li>Added support for CA bundles in Device.Security.CABundle.{i}.</li>
<li>Refactored Device.SoftwareModules. into its own file</li>
<li>Added Privileged parameter to
Device.SoftwareModules.ExecutionUnit.{i}.</li>
<li>Added Device.Thread.MLE.{i}.AssociatedNode.{i}.Neighbor.{i}.</li>
<li>Added RegisterTrustPaths parameter in InstallDU() and Update()
commands and Device.USPServices.Trust.{i}.</li>
</ul></td>
<td rowspan="2" style="text-align: left;"> <a
href="https://www.broadband-forum.org/download/TR-181_Issue-2_Amendment-19.pdf">TR-181