-
Notifications
You must be signed in to change notification settings - Fork 21
/
tr-098-1-2-1.xml
5277 lines (5262 loc) · 346 KB
/
tr-098-1-2-1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
TR-069 InternetGatewayDevice:1.4 Root Object definition (Corrigendum 1)
Copyright (c) 2009-2017, Broadband Forum
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only.
Please reference the Forum IPR Policy for patent licensing terms
<https://www.broadband-forum.org/ipr-policy>.
Any moral rights which are necessary to exercise under the above
license grant are also deemed granted under this license.
Summary:
TR-069 InternetGatewayDevice:1.4 Root Object Definition (Corrigendum 1).
Contains definition of InternetGatewayDevice:1.4 Root Object.
Version History:
March 2009: tr-098-1-2-0.xml, corresponds to TR-098 Amendment 1 sections 2.4 (Data
Model), 2.4.1 (Inform and Notification Requirements) and 3 (Profile
Definitions).
September 2009: tr-098-1-2-0.xml (name unchanged)
- fixed header information (had been cut-and-pasted from elsewhere)
- changed WLANConfigurationNumberOfEntries to (wrong but consistent)
LANWLANConfigurationNumberOfEntries
- fixed 802.1Q-2004 reference to 802.1Q-2005
- fixed cwmp-datamodel.xsd to be cwmp-datamodel-1-0.xsd
December 2011: tr-098-1-2-1.xml
- changed Bridging AvailIf InterfaceRef to be strong
- marked Policer DSCP descriptions as replaced
- fixed data type for QoS QueueStats Interface (string)
- marked WANEthIfConfig.MaxBitRate "Auto" as deleted
- marked VCSearchList description as replaced
-->
<dm:document xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-0"
xmlns:dmr="urn:broadband-forum-org:cwmp:datamodel-report-0-1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:broadband-forum-org:cwmp:datamodel-1-0 http://www.broadband-forum.org/cwmp/cwmp-datamodel-1-0.xsd
urn:broadband-forum-org:cwmp:datamodel-report-0-1 http://www.broadband-forum.org/cwmp/cwmp-datamodel-report.xsd"
spec="urn:broadband-forum-org:tr-098-1-2-1">
<import file="tr-069-biblio.xml" spec="urn:broadband-forum-org:tr-069-biblio"/>
<import file="tr-106-1-0-types.xml" spec="urn:broadband-forum-org:tr-106-1-0">
<dataType name="IPAddress"/>
<dataType name="MACAddress"/>
</import>
<import file="tr-143-1-0.xml" spec="urn:broadband-forum-org:tr-143-1-0">
<model name="InternetGatewayDevice:1.3"/>
</import>
<model name="InternetGatewayDevice:1.4" base="InternetGatewayDevice:1.3">
<object base="InternetGatewayDevice." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="DeviceSummary" access="readOnly" forcedInform="true">
<description action="replace">As defined in {{bibref|TR-106a1}}.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.DeviceInfo." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="ManufacturerOUI" access="readOnly">
<description action="append">This value MUST remain fixed over the lifetime of the device, including across firmware updates.</description>
</parameter>
<parameter base="ProductClass" access="readOnly">
<description action="append">This value MUST remain fixed over the lifetime of the device, including across firmware updates.</description>
</parameter>
<parameter base="SerialNumber" access="readOnly">
<description action="append">This value MUST remain fixed over the lifetime of the device, including across firmware updates.</description>
</parameter>
<parameter base="SoftwareVersion" access="readOnly" activeNotify="forceEnabled" forcedInform="true">
<description action="replace">A string identifying the software version currently installed in the CPE.
To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, ''3.0.21'' where the components mean: ''Major.Minor.Build''.</description>
</parameter>
<parameter base="EnabledOptions" access="readOnly">
<description action="replace">The OptionName of each Option that is currently enabled in the CPE. The OptionName of each is identical to the OptionName element of the OptionStruct described in {{bibref|TR-069a2}}. Only those options are listed whose State indicates the option is enabled.</description>
</parameter>
<parameter base="SpecVersion" access="readOnly" status="deprecated" forcedInform="true">
<syntax>
<string/>
<default type="object" value="1.0" status="deleted"/>
</syntax>
</parameter>
<parameter base="UpTime" access="readOnly" activeNotify="canDeny">
</parameter>
<parameter base="DeviceLog" access="readOnly" activeNotify="canDeny">
</parameter>
</object>
<object base="InternetGatewayDevice.DeviceConfig." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="ConfigFile" access="readWrite">
<description action="append">An alternative to this parameter, e.g. when the configuration file is larger than the parameter size limit, is to use the Upload and Download RPCs with a FileType of ''1 Vendor Configuration File''.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.ManagementServer." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="EnableCWMP" access="readWrite" dmr:previousParameter="">
<description>Enables and disables the CPE's support for CWMP.
{{false}} means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS.
{{true}} means that CWMP support on the CPE is enabled.
The factory default value MUST be {{true}}.
The subscriber can re-enable the CPE's CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to {{true}}.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter base="PeriodicInformTime" access="readWrite">
<description action="replace">An absolute time reference in UTC to determine when the CPE will initiate the periodic Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the {{param|PeriodicInformInterval}}.
{{param}} is used only to set the "phase" of the periodic Informs. The actual value of {{param}} can be arbitrarily far into the past or future.
For example, if {{param|PeriodicInformInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then periodic Informs will occur every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future.
The Unknown Time value defined in {{bibref|TR-098a2|section 2.2}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified {{param|PeriodicInformInterval}}.
If absolute time is not available to the CPE, its periodic Inform behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value.</description>
</parameter>
<parameter base="ConnectionRequestURL" access="readOnly" activeNotify="forceDefaultEnabled" forcedInform="true">
</parameter>
<parameter base="UpgradesManaged" access="readWrite">
<description action="replace">Indicates whether or not the ACS will manage upgrades for the CPE. If {{true}}, the CPE SHOULD NOT use other means other than the ACS to seek out available upgrades. If {{false}}, the CPE MAY use other means for this purpose.
Note that an autonomous upgrade (reported via an ''10 AUTONOMOUS TRANSFER COMPLETE'' Inform Event code) SHOULD be regarded as a managed upgade if it is performed according to ACS-specified policy.</description>
</parameter>
<parameter name="DefaultActiveNotificationThrottle" access="readWrite" dmr:previousParameter="DownloadProgressURL">
<description>This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of seconds that the CPE MUST wait since the end of the last session with the ACS before establishing a new session for the purpose of delivering an active notification.
In other words, if CPE needs to establish a new session with the ACS for the sole purpose of delivering an active notification, it MUST delay establishing such a session as needed to ensure that the minimum time since the last session completion has been met.
The time is counted since the last successfully completed session, regardless of whether or not it was used for active notifications or other purposes. However, if connection to the ACS is established for purposes other than just delivering active notifications, including for the purpose of retrying a failed session, such connection MUST NOT be delayed based on this parameter value, and the pending active notifications MUST be communicated during that connection.
The time of the last session completion does not need to be tracked across reboots.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter base="UDPConnectionRequestAddress" access="readOnly">
<description action="replace">Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see {{bibref|TR-069a2|Annex G}}).
This parameter is represented in the form of an Authority element as defined in {{bibref|RFC3986}}. The value MUST be in one of the following two forms:
: host:port
: host
When {{param|STUNEnable}} is {{true}}, the ''host'' and ''port'' portions of this parameter MUST represent the public address and port corresponding to the NAT binding through which the ACS can send UDP Connection Request messages (once this information is learned by the CPE through the use of STUN).
When {{param|STUNEnable}} is {{false}}, the ''host'' and ''port'' portions of the URL MUST represent the local IP address and port on which the CPE is listening for UDP Connection Request messages.
The second form of this parameter MAY be used only if the port value is equal to "80".</description>
</parameter>
</object>
<object base="InternetGatewayDevice.ManagementServer.ManageableDevice.{i}." access="readOnly" minEntries="0" maxEntries="unbounded" numEntriesParameter="ManageableDeviceNumberOfEntries">
<description action="replace">Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to {{bibref|TR-069a2|Annex F}} as indicated by the presence of the DHCP option specified in that Annex.</description>
<parameter name="Host" access="readOnly">
<description>{{reference|a ''Host'' table row}} This list MUST include an item for each ''Host'' table entry, whether active or inactive, that corresponds to this physical LAN Device.
As such entries are added to or removed from the ''Host'' tables, the value of this parameter MUST be updated accordingly.
For example: ''InternetGatewayDevice.LANDevice.1.Hosts.Host.1,InternetGatewayDevice.LANDevice.1.Hosts.Host.5''</description>
<syntax>
<list>
<size maxLength="1024"/>
</list>
<string>
<pathRef refType="strong" targetType="row" targetParent="InternetGatewayDevice.LANDevice.{i}.Hosts.Host."/>
</string>
</syntax>
</parameter>
</object>
<object base="InternetGatewayDevice.Time." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="Enable" access="readWrite" dmr:previousParameter="">
<description>Enables or disables the NTP or SNTP time client.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="Status" access="readOnly">
<description>Status of Time support on the CPE. {{enum}}
The {{enum|Unsynchronized}} value indicates that the CPE's absolute time has not yet been set.
The {{enum|Synchronized}} value indicates that the CPE has acquired accurate absolute time; its current time is accurate.
The {{enum|Error_FailedToSynchronize}} value indicates that the CPE failed to acquire accurate absolute time; its current time is not accurate.
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Unsynchronized"/>
<enumeration value="Synchronized"/>
<enumeration value="Error_FailedToSynchronize"/>
<enumeration value="Error" optional="true"/>
</string>
</syntax>
</parameter>
<parameter base="LocalTimeZone" access="readWrite" status="obsoleted">
<description action="replace">The local time zone offset from UTC, ignoring daylight savings time adjustments, in the form:
: +hh:mm
: -hh:mm
For example, this will always be "-08:00" for California, "+00:00" or "-00:00" for the United Kingdom, and "+01:00" for France.
This parameter is OBSOLETED because the information that it represents is fully covered by {{param|LocalTimeZoneName}}.</description>
</parameter>
<parameter base="LocalTimeZoneName" access="readWrite">
<description action="append">The name SHOULD be encoded according to IEEE 1003.1 (POSIX). The following is an example value: ''EST+5EDT,M4.1.0/2,M10.5.0/2''</description>
</parameter>
<parameter base="DaylightSavingsUsed" access="readWrite" status="obsoleted">
<description action="append">This parameter is OBSOLETED because the information that it represents is fully covered by {{param|LocalTimeZoneName}}.</description>
</parameter>
<parameter base="DaylightSavingsStart" access="readWrite" status="obsoleted">
<description action="replace">Current local date and time at which the switch to daylight savings time occurs. If daylight savings time is not used, this value is ignored.
This parameter is OBSOLETED because the information that it represents is fully covered by {{param|LocalTimeZoneName}}.</description>
</parameter>
<parameter base="DaylightSavingsEnd" access="readWrite" status="obsoleted">
<description action="replace">Current local date and time at which the switch from daylight savings time will occur. If daylight savings time is not used, this value is ignored.
This parameter is OBSOLETED because the information that it represents is fully covered by {{param|LocalTimeZoneName}}.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.UserInterface." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="UserDatabaseSupported" access="readOnly" dmr:previousParameter="">
<description>Present only if the CPE provides a password-protected LAN-side user interface.
Indicates whether or not the CPE supports a user database that provides per-user passwords that can be used for accessing the local user interface.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="SharedPassword" access="readWrite">
<description>Present only if the CPE provides a password-protected LAN-side user interface.
Indicates whether or not a single shared password MUST protect the local user interface, or whether per-user passwords can be used.
If either UserDatabaseSupported or PasswordUserSelectable is {{false}}, the CPE MUST ignore the value of this parameter.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="AvailableLanguages" access="readOnly" dmr:previousParameter="ExamplePassword">
<description>Available user-interface languages, where each language is specified according to RFC 3066 {{bibref|RFC3066}}.</description>
<syntax>
<list>
<size maxLength="256"/>
</list>
<string/>
</syntax>
</parameter>
<parameter name="CurrentLanguage" access="readWrite">
<description>Current user-interface language, specified according to RFC 3066 {{bibref|RFC3066}}.</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.CaptivePortal." access="readOnly" minEntries="1" maxEntries="1">
<description>This object contains parameters relating to the captive portal configuration on the CPE.
The captive portal configuration defines the CPE's WAN-destined HTTP (port 80) traffic redirect behavior.
When the captive portal is disabled, WAN-destined HTTP (port 80) traffic MUST be permitted to all destinations.
When the captive portal is enabled, WAN-destined HTTP (port 80) traffic MUST be permitted only to destinations listed in the {{param|AllowedList}}; traffic to all other destinations MUST be redirected to the {{param|CaptivePortalURL}}.</description>
<parameter name="Enable" access="readWrite">
<description>Enables or disables the captive portal.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="Status" access="readOnly">
<description>Indicates the status of the captive portal. {{enum}}
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Enabled"/>
<enumeration value="Error_URLEmpty">
<description>{{param|CaptivePortalURL}} is {{empty}}</description>
</enumeration>
<enumeration value="Error" optional="true"/>
</string>
</syntax>
</parameter>
<parameter name="AllowedList" access="readWrite">
<description>IP addresses to which HTTP (port 80) traffic MUST always be permitted, regardless of whether the captive portal is enabled.
Each entry in the list MUST be either an IP address or an IP subnet specified using variable length subnet mask (VLSM) syntax.
An IP subnet is specified as an IP address followed (with no intervening white space) by "/n", where n is an integer in the range 0-32; this is equivalent to a subnet mask consisting of n 1s followed by 32 minus n 0s.
For example, 1.2.3.4 specifies a single IP address, and 1.2.3.4/24 specifies a class C subnet with subnet mask 255.255.255.0.
The maximum length of a single entry (plus comma) is 19 characters so 10000 bytes is sufficient for more than 500 IP addresses and/or IP subnets.</description>
<syntax>
<list>
<size maxLength="10000"/>
</list>
<string/>
</syntax>
</parameter>
<parameter name="CaptivePortalURL" access="readWrite">
<description>Captive portal URL to which WAN-destined HTTP (port 80) traffic to destinations not listed in the {{param|AllowedList}} will be redirected.
The captive portal URL MUST be an HTTP (not HTTPS) URL.
The CPE MUST permit the captive portal URL to be set to {{empty}}, which has the effect of disabling the captive portal (if {{param|Enable}} is {{true}} and the captive portal URL is {{empty}}, {{param|Status}} MUST be {{enum|Error_URLEmpty|Status}}).</description>
<syntax>
<string>
<size maxLength="2000"/>
</string>
</syntax>
</parameter>
</object>
<object base="InternetGatewayDevice.Layer3Forwarding." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="DefaultConnectionService" access="readWrite">
<description action="replace">Specifies the default WAN interface. The content is the full hierarchical parameter name of the default layer 3 connection object. Example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="ForwardNumberOfEntries">
<description action="replace">Layer 3 forwarding table.
In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP, OSPF, DHCP, and IPCP. The CPE MAY reject attempts to delete or modify a dynamic route entry.
For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:
* Only table entries with a matching {{param|ForwardingPolicy}} are considered, i.e. those that either do not specify a {{param|ForwardingPolicy}}, or else specify a {{param|ForwardingPolicy}} that matches that of the incoming packet.
* For the remaining table entries, those for which the source address/mask matches are sorted by longest prefix, i.e. with the most specific networks first (an unspecified source address is a wild-card and always matches, with a prefix length of zero).
* For the remaining table entries, those for which the destination address/mask matches are sorted by longest prefix, i.e. with the most specific networks first (an unspecified destination address is a wild-card and always matches, with a prefix length of zero).
* The first of the remaining table entries is applied to the packet.</description>
<parameter name="StaticRoute" access="readOnly" dmr:previousParameter="Status">
<description>If {{true}}, this route is a Static route.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter base="GatewayIPAddress" access="readWrite">
<description action="replace">IP address of the gateway.
Only one of GatewayIPAddress and Interface SHOULD be configured for a route.
If both are configured, {{param}} and {{param|Interface}} MUST be consistent with each other.</description>
</parameter>
<parameter base="Interface" access="readWrite">
<description action="replace">Specifies the egress interface associated with this entry. {{reference|the layer 3 connection object}} Example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.
Only one of {{param|GatewayIPAddress}} and {{param}} SHOULD be configured for a route.
If both are configured, {{param|GatewayIPAddress}} and {{param}} MUST be consistent with each other.
For a route that was configured by setting {{param|GatewayIPAddress}} but not {{param}}, read access to {{param}} MUST return the full hierarchical parameter name for the route's egress interface.</description>
<syntax>
<string>
<pathRef refType="weak" targetType="row"/>
</string>
</syntax>
</parameter>
</object>
<object base="InternetGatewayDevice.Layer2Bridging." access="readOnly" minEntries="1" maxEntries="1">
<description action="replace">Layer 2 bridging configuration. Specifies bridges between layer 2 LAN and/or WAN interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces.
This object can be used to configure both 802.1D {{bibref|802.1D-2004}} and 802.1Q {{bibref|802.1Q-2005}} bridges. Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled.
If the Layer2Bridging object is implemented, the view that it provides of the CPE's underlying bridging configuration MUST be consistent with the view provided by any LANDevice and WAN**Connection objects. The implications of this are explained in Annex A.6.</description>
<parameter name="MaxDBridgeEntries" access="readOnly" dmr:previousParameter="MaxBridgeEntries">
<description>The maximum number of 802.1D {{bibref|802.1D-2004}} entries available in the {{object|Bridge}} table. A positive value for this parameter implies support for 802.1D.
There is no guarantee that this many 802.1D Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxQBridgeEntries" access="readOnly">
<description>The maximum number of 802.1Q {{bibref|802.1Q-2005}} entries available in the {{object|Bridge}} table. A positive value for this parameter implies support for 802.1Q.
There is no guarantee that this many 802.1Q Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxVLANEntries" access="readOnly">
<description>The maximum number of 802.1Q {{bibref|802.1Q-2005}} VLANs supported per {{object|Bridge}} table entry.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object base="InternetGatewayDevice.Layer2Bridging.Bridge.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="BridgeNumberOfEntries">
<description action="replace">Bridge table. Each entry in this table represents a single physical 802.1D {{bibref|802.1D-2004}} or 802.1Q {{bibref|802.1Q-2005}} bridge.
If the Bridge Port table is supported, it explicitly defines the Bridge's interfaces. Otherwise, they are implicitly defined via the union of the FilterInterface / MarkingInterface parameters for all the Filter and Marking table entries that are associated with the Bridge.</description>
<parameter name="BridgeStandard" access="readWrite" dmr:previousParameter="BridgeKey">
<description>Selects the standard supported by this Bridge table entry.</description>
<syntax>
<string>
<enumeration value="802.1D">
<description>{{bibref|802.1D-2004}}</description>
</enumeration>
<enumeration value="802.1Q">
<description>{{bibref|802.1Q-2005}}</description>
</enumeration>
</string>
<default type="object" value="802.1D"/>
</syntax>
</parameter>
<parameter base="VLANID" access="readWrite">
<description action="replace">For an 802.1D {{bibref|802.1D-2004}} Bridge, which has no concept of VLANs, the value of this parameter MUST be 0.
For an 802.1Q {{bibref|802.1Q-2005}} Bridge, this is the Bridge's default VLAN ID, i.e. the VLAN ID that applies to Filter table entries with ''VLANIDFilter''=-1. For an 802.1Q Bridge, the value of this parameter MUST NOT be 0.</description>
<syntax>
<unsignedInt/>
<default type="object" value="0" status="deleted"/>
</syntax>
</parameter>
<parameter name="PortNumberOfEntries" access="readOnly">
<description>Number of entries in the Bridge {{object|Port}} table.</description>
<syntax>
<unsignedInt/>
<default type="object" value="0"/>
</syntax>
</parameter>
<parameter name="VLANNumberOfEntries" access="readOnly">
<description>Number of entries in the Bridge {{object|VLAN}} table.</description>
<syntax>
<unsignedInt/>
<default type="object" value="0"/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer2Bridging.Bridge.{i}.Port.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="PortNumberOfEntries" enableParameter="PortEnable">
<description>Bridge Port table. If this table is supported, it MUST contain an entry for each Bridge Port.</description>
<uniqueKey>
<parameter ref="PortInterface"/>
</uniqueKey>
<parameter name="PortEnable" access="readWrite">
<description>Enables or disables this Bridge Port table entry.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="PortInterface" access="readWrite">
<description>The interface associated with this Bridge Port table entry. Represents a bridge port as defined in 802.1D {{bibref|802.1D-2004}} and 802.1Q {{bibref|802.1Q-2005}}.
To associate this Bridge Port with an interface listed in the ''AvailableInterface'' table, the {{param}} value is set to the value of the corresponding ''AvailableInterfaceKey''.</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="PortState" access="readOnly">
<description>Bridge Port state as defined in 802.1D {{bibref|802.1D-2004}} and 802.1Q {{bibref|802.1Q-2005}}.</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Blocking"/>
<enumeration value="Listening"/>
<enumeration value="Learning"/>
<enumeration value="Forwarding"/>
<enumeration value="Broken"/>
</string>
<default type="object" value="Disabled"/>
</syntax>
</parameter>
<parameter name="PVID" access="readWrite">
<description>Default Port VLAN ID as defined in 802.1Q {{bibref|802.1Q-2005}}.
For an 802.1D {{bibref|802.1D-2004}} Bridge, this parameter MUST be ignored.</description>
<syntax>
<int>
<range minInclusive="1" maxInclusive="4094"/>
</int>
<default type="object" value="1"/>
</syntax>
</parameter>
<parameter name="AcceptableFrameTypes" access="readWrite">
<description>Bridge Port acceptable frame types as defined in 802.1Q {{bibref|802.1Q-2005}}. {{enum}}
For an 802.1D {{bibref|802.1D-2004}} Bridge, the value of this parameter MUST be {{enum|AdmitAll}}.</description>
<syntax>
<string>
<enumeration value="AdmitAll"/>
<enumeration value="AdmitOnlyVLANTagged" optional="true"/>
<enumeration value="AdmitOnlyPrioUntagged" optional="true"/>
</string>
<default type="object" value="AdmitAll"/>
</syntax>
</parameter>
<parameter name="IngressFiltering" access="readWrite">
<description>Enables or disables Ingress Filtering as defined in 802.1Q {{bibref|802.1Q-2005}}.
For an 802.1D {{bibref|802.1D-2004}} Bridge, the value of this parameter MUST be {{false}}.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLAN.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="VLANNumberOfEntries" enableParameter="VLANEnable">
<description>Bridge VLAN table. If this table is supported, if MUST contain an entry for each VLAN known to the Bridge.
This table only applies to an 802.1Q {{bibref|802.1Q-2005}} Bridge.</description>
<uniqueKey>
<parameter ref="VLANID"/>
</uniqueKey>
<parameter name="VLANEnable" access="readWrite">
<description>Enables or disables this VLAN table entry.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="VLANName" access="readWrite">
<description>Human-readable name for this VLAN table entry.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="VLANID" access="readWrite">
<description>VLAN ID of the entry,</description>
<syntax>
<int>
<range minInclusive="1" maxInclusive="4094"/>
</int>
</syntax>
</parameter>
</object>
<object base="InternetGatewayDevice.Layer2Bridging.Filter.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="FilterNumberOfEntries">
<description action="append">For both 802.1D {{bibref|802.1D-2004}} and 802.1Q {{bibref|802.1Q-2005}} Bridges, this table is used for the following:
# If the Bridge Port table is not supported, it implicitly specifies the Bridge interfaces (in collaboration with the Marking table).
# It specifies destination MAC address classification rules.
For an 802.1Q Bridge, this table is also used for the following:
# For each VLAN ID, it specifies the interfaces that are in the VLAN's Member Set.
# If the Bridge Port table is not supported, it specifies the Port VLAN ID (PVID) for each interface.
This table also supports several concepts that are not covered by either 802.1D or 802.1Q:
# It allows a given packet to be admitted to multiple Bridges.
# It supports Ethertype and source MAC address classification rules.</description>
<parameter base="FilterStatus" access="readOnly">
<description action="append">If the Bridge Port table is supported, but none of its entries correspond to {{param|FilterInterface}}, or if such an entry exists but is disabled, {{param}} MUST NOT indicate {{enum|Enabled}}.
If the Bridge VLAN table is supported, but none of its entries correspond to {{param|VLANIDFilter}}, or if such an entry exists but is disabled, {{param}} MUST NOT indicate {{enum|Enabled}}.</description>
</parameter>
<parameter base="ExclusivityOrder" access="readWrite">
<description action="replace">Whether or not the Filter definition is exclusive of all others. And if the entry is exclusive, order of precedence.
A value of 1 or greater indicates an Exclusive Filter, where the value 1 indicates the first entry to be considered (highest precedence).
A value of 0 indicates a Non-Exclusive Filter (OPTIONAL).
For each packet, if the packet matches any Exclusive Filters, the packet is assigned to the Bridge associated with the highest precedence Exclusive Filter to which it matches (lowest {{param}} value).
If and only if the packet does not match any Exclusive Filters, the packet is assigned to all Bridges associated with each Non-Exclusive Filter for which it matches the defining criteria.
If a packet matches no Filter, it is discarded.
When the {{param}} is set to match that of an existing Exclusive Filter (1 or greater), the value for the existing entry and all higher numbered entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion or change in {{param}} of an Exclusive Filter causes {{param}} values of other Exclusive Filters (values 1 or greater) to be compacted.
Note that the use of Exclusive Filters to associate a layer 3 router interface with LAN and/or WAN interfaces via a Bridge entry overrides and updates the association between layer 3 and layer 2 objects implied by the ''InternetGatewayDevice'' object hierarchy.
Support for Non-Exclusive Filter entries, i.e. entries with an {{param}} value of 0, is OPTIONAL because 802.1D {{bibref|802.1D-2004}} and 802.1Q {{bibref|802.1Q-2005}} do not consider the case of a packet potentially being admitted to more than one bridge.</description>
<syntax>
<unsignedInt/>
<default type="object" value="0" status="deleted"/>
</syntax>
</parameter>
<parameter base="FilterInterface" access="readWrite">
<description action="replace">The interface or interfaces associated with this Filter table entry. The bridge corresponding to this Filter table entry is defined to admit packets on ingress to the bridge from the specified interfaces that meet all of the criteria specified in the Filter table entry. The following values are defined.
* To associate this Filter with a single interface listed in the ''AvailableInterface'' table, the {{param}} value is set to the value of the corresponding ''AvailableInterfaceKey''.
* ''AllInterfaces'' indicates that this Filter is associated with all LAN and WAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''LANInterface'' or ''WANInterface''). This value is DEPRECATED because of the configuration complexity it requires.
* ''LANInterfaces'' indicates that this Filter is associated with all LAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''LANInterface''). This value is DEPRECATED because of the configuration complexity it requires.
* ''WANInterfaces'' indicates that this Filter is associated with all WAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''WANInterface''). This value is DEPRECATED because of the configuration complexity it requires.
{{empty}} indicates the Filter table entry is not associated with any interface (and has no effect)</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
</syntax>
</parameter>
<parameter base="VLANIDFilter" access="readWrite">
<description action="replace">The 802.1Q {{bibref|802.1Q-2005}} VLAN ID associated with this Filter table entry.
A value of -1 indicates that the default VLAN ID for the Bridge MUST be used instead (as specified by {{param|InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID}} for the Bridge table entry associated with this Filter table entry).
For an 802.1Q bridge, the value of this parameter MUST NOT be 0, and it is interpreted as follows (more than one condition can apply, e.g. a single Filter table entry might both add an interface to a VLAN's Member Set, and define a classification rule).
# If the Bridge Port table is not supported, it is a candidate to be the 802.1Q Port VLAN ID (PVID) for the interface associated with this Filter. Where there is more than one such candidate for a given interface, the PVID MUST be selected according to the {{param|ExclusivityOrder}} precedence rules.
# The interface associated with this Filter is added to the VLAN's 802.1Q Member Set.
# If a classification parameter, e.g. {{param|DestMACAddressFilterList}}, is specified, a classification rule for this VLAN ID is added.
For an 802.1D {{bibref|802.1D-2004}} Bridge, which has no concept of VLANs, the VLAN ID MUST be 0. This is most easily achieved by allowing this parameter to retain its default value of -1 and relying on the fact that the default VLAN ID for an 802.1D bridge will always be 0.</description>
<syntax>
<int>
<range minInclusive="-1" maxInclusive="4094"/>
</int>
</syntax>
</parameter>
<parameter base="AdmitOnlyVLANTagged" access="readWrite" status="deprecated">
<description action="replace">802.1Q {{bibref|802.1Q-2005}} Acceptable Frame Types criterion.
This parameter is DEPRECATED, because it only partly models 802.1Q Acceptable Frame Types (and Ingress Filtering). The Bridge Port table SHOULD be used instead and, if supported, MUST take precedence over this parameter.
If {{true}}, the Bridge admits only packets tagged with VLAN IDs that include the ingress interface in their 802.1Q Member Sets.
If {{false}}, the Bridge admits both packets tagged with VLAN IDs that include the ingress interface in their 802.1Q Member Sets, and any Untagged or PriorityOnly packets. All Untagged or PriorityOnly packets are associated on ingress with the interface's Port VLAN ID (PVID).
See the description of {{param|VLANIDFilter}} for an explanation of how the Member Set and PVID are determined.
If more than one Filter table entry is associated with a given interface, the value of {{param}} MUST be the same for all such entries.
For an 802.1D {{bibref|802.1D-2004}} Bridge, which has no concept of VLANs, the value of this parameter MUST be {{false}}.</description>
</parameter>
<parameter base="EthertypeFilterList" access="readWrite">
<description action="replace">Classification criterion.
{{list|each representing an Ethertype value}}
Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on Ethertype.</description>
</parameter>
<parameter base="EthertypeFilterExclude" access="readWrite">
<description action="append">Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on Ethertype.</description>
</parameter>
<parameter base="SourceMACAddressFilterList" access="readWrite">
<description action="replace">Classification criterion.
{{list|each representing a MAC Address}}
Each list entry MAY optionally specify a bit-mask, where matching of a packet's MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching.
For example, the list might be: ''01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33''
Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
</parameter>
<parameter base="SourceMACAddressFilterExclude" access="readWrite">
<description action="append">Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
</parameter>
<parameter base="DestMACAddressFilterList" access="readWrite">
<description action="replace">Classification criterion.
{{list|each representing a MAC Address}}
Each list entry MAY optionally specify a bit-mask, where matching of a packet's MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching.
For example, the list might be: ''01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33''</description>
</parameter>
<parameter base="SourceMACFromVendorClassIDFilter" access="readWrite">
<description action="replace">Classification criterion.
A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132 {{bibref|RFC2132}}) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in SourceMACFromVendorClassIDMode. Case sensitive.
Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
</parameter>
<parameter base="SourceMACFromVendorClassIDFilterExclude" access="readWrite">
<description action="append">Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
</parameter>
<parameter name="SourceMACFromVendorClassIDMode" access="readWrite">
<description>{{param|SourceMACFromVendorClassIDFilter}} pattern match criterion. {{enum}}
For example, if {{param|SourceMACFromVendorClassIDFilter}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.
Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
<syntax>
<string>
<enumeration value="Exact"/>
<enumeration value="Prefix"/>
<enumeration value="Suffix"/>
<enumeration value="Substring"/>
</string>
<default type="object" value="Exact"/>
</syntax>
</parameter>
<parameter base="DestMACFromVendorClassIDFilter" access="readWrite">
<description action="replace">Classification criterion.
A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132 {{bibref|RFC2132}}) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in {{param|DestMACFromVendorClassIDMode}}. Case sensitive.</description>
</parameter>
<parameter name="DestMACFromVendorClassIDMode" access="readWrite" dmr:previousParameter="DestMACFromVendorClassIDFilterExclude">
<description>{{param|DestMACFromVendorClassIDFilter}} pattern match criterion. {{enum}}
For example, if {{param|DestMACFromVendorClassIDFilter}} is ''Example'' then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.</description>
<syntax>
<string>
<enumeration value="Exact"/>
<enumeration value="Prefix"/>
<enumeration value="Suffix"/>
<enumeration value="Substring"/>
</string>
<default type="object" value="Exact"/>
</syntax>
</parameter>
<parameter base="SourceMACFromClientIDFilter" access="readWrite">
<description action="replace">Classification criterion.
A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP Client Identifier (Option 61 as defined in RFC 2132 {{bibref|RFC2132}}) in the most recent DHCP lease acquisition or renewal was equal to the specified value. The option value is binary, so an exact match is REQUIRED.
Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
</parameter>
<parameter base="SourceMACFromClientIDFilterExclude" access="readWrite">
<description action="append">Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
</parameter>
<parameter base="DestMACFromClientIDFilter" access="readWrite">
<description action="replace">Classification criterion.
A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP Client Identifier (Option 61 as defined in RFC 2132 {{bibref|RFC2132}}) in the most recent DHCP lease acquisition or renewal was equal to the specified value. The option value is binary, so an exact match is REQUIRED.</description>
</parameter>
<parameter base="SourceMACFromUserClassIDFilter" access="readWrite">
<description action="replace">Classification criterion.
A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP User Class Identifier (Option 77 as defined in RFC 3004 {{bibref|RFC3004}}) in the most recent DHCP lease acquisition or renewal was equal to the specified value.
Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
</parameter>
<parameter base="SourceMACFromUserClassIDFilterExclude" access="readWrite">
<description action="append">Note that neither 802.1D {{bibref|802.1D-2004}} nor 802.1Q {{bibref|802.1Q-2005}} support classification based on source MAC address.</description>
</parameter>
<parameter base="DestMACFromUserClassIDFilter" access="readWrite">
<description action="replace">Classification criterion.
A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP User Class Identifier (Option 77 as defined in RFC 3004 {{bibref|RFC3004}}) in the most recent DHCP lease acquisition or renewal was equal to the specified value.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.Layer2Bridging.Marking.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="MarkingNumberOfEntries">
<description action="replace">Marking table identifying non-default layer 2 marking behavior for packets on egress from the specified interfaces.
This table is not relevant to 802.1D {{bibref|802.1D-2004}} Bridges, which are not VLAN-aware.
For 802.1Q {{bibref|802.1Q-2005}} Bridges, this table is used for the following:
# It specifies whether VLAN tags are to be removed on egress.
This table also supports several concepts that are not covered by 802.1Q:
# It allows the VLAN ID to be changed on egress.
# It allows the Ethernet Priority to be changed on egress.</description>
<parameter base="MarkingStatus" access="readOnly">
<description action="append">If the Bridge Port table is supported, but none of its entries correspond to {{param|MarkingInterface}}, or if such an entry exists but is disabled, {{param}} MUST NOT indicate {{enum|Enabled}}.</description>
</parameter>
<parameter base="MarkingInterface" access="readWrite">
<description action="replace">The interface or interfaces associated with this Marking table entry for which the specified marking behavior is to apply on egress from the associated bridge. The following values are defined.
* To associate this Marking table entry with a single interface listed in the ''AvailableInterface'' table, the {{param}} value is set to the value of the corresponding ''AvailableInterfaceKey''.
* ''AllInterfaces'' indicates that this Marking table entry is associated with all LAN and WAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''LANInterface'' or ''WANInterface''). This value is DEPRECATED because of the configuration complexity it requires.
* ''LANInterfaces'' indicates that this Marking table entry is associated with all LAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''LANInterface''). This value is DEPRECATED because of the configuration complexity it requires.
* ''WANInterfaces'' indicates that this Marking table entry is associated with all WAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''WANInterface''). This value is DEPRECATED because of the configuration complexity it requires.
* {{empty}} indicates the Marking table entry table entry is not associated with any interface (and has no effect)
If there is more than one enabled Marking table entry that specifies one or more of the same interfaces for the same bridge (identical values of {{param|MarkingBridgeReference}}), then for packets on egress from the specified bridge to those interfaces, the applied marking MUST be that specified in the Marking table entry among those in conflict with the lowest {{param|MarkingKey}} value.
If an interface in a given bridge does not have a corresponding Marking table entry, the marking is left unchanged on egress.</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
</syntax>
</parameter>
<parameter base="VLANIDUntag" access="readWrite">
<description action="replace">If {{true}}, on egress to the interfaces associated with this Marking table entry, all packets are sent Untagged.
If {{false}}, on egress to the interfaces associated with this Marking table entry, all packets are sent Tagged with the VLAN ID of the VLAN in which the packet is being bridged.</description>
</parameter>
<parameter base="VLANIDMark" access="readWrite">
<description action="replace">The 802.1Q {{bibref|802.1Q-2005}} VLAN ID to be used on egress to the interfaces associated with this Marking table entry.
A value of -1 indicates that the VLAN ID of the VLAN in which the packet is being bridged is to be used, i.e. no change.
The value of this parameter MUST NOT be 0.
If {{param|VLANIDUntag}} is {{true}}, then no VLAN marking is done since the tag containing the VLAN ID is removed.
Note that 802.1Q does not support re-marking on egress.</description>
<syntax>
<int>
<range minInclusive="-1" maxInclusive="4094"/>
</int>
</syntax>
</parameter>
<parameter name="VLANIDMarkOverride" access="readWrite">
<description>If {{false}}, on egress to the interfaces associated with this Marking table entry, the {{param|VLANIDMark}}, if specified, is applied only to PriorityOnly packets.
If {{true}}, on egress to the interfaces associated with this Marking table entry, the {{param|VLANIDMark}}, if specified, is to be applied to all packets on this Bridge.
If {{param|VLANIDUntag}} is {{true}}, then no VLAN marking is done since the tag containing the VLAN ID is removed.
Note that 802.1Q {{bibref|802.1Q-2005}} does not support re-marking on egress.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter base="EthernetPriorityMark" access="readWrite">
<description action="replace">Ethernet priority code (as defined in 802.1D {{bibref|802.1D-2004}}) to mark traffic with that falls into this Bridge on egress to the interfaces associated with this Marking table entry. A value of -1 indicates no change from the incoming packet or the mark assigned by the classifier.
Note that 802.1Q {{bibref|802.1Q-2005}} does not support re-marking on egress.</description>
</parameter>
<parameter base="EthernetPriorityOverride" access="readWrite">
<description action="replace">If {{false}}, on egress to the interfaces associated with this Marking table entry, the {{param|EthernetPriorityMark}}, if specified, is applied only to packets of priority 0.
If {{true}}, on egress to the interfaces associated with this Marking table entry, the {{param|EthernetPriorityMark}}, if specified, is to be applied to all packets on this Bridge.
Note that 802.1Q {{bibref|802.1Q-2005}} does not support re-marking on egress.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.Layer2Bridging.AvailableInterface.{i}." access="readOnly" minEntries="0" maxEntries="unbounded" numEntriesParameter="AvailableInterfaceNumberOfEntries">
<description action="replace">Table containing all LAN and WAN interfaces that are available to be referenced by the Bridge table. Only interfaces that can carry layer 2 bridged traffic are included.</description>
<parameter base="InterfaceReference" access="readOnly" activeNotify="canDeny">
<description action="replace">{{reference|an available LAN or WAN interface}} This table SHOULD contain a single entry for each available LAN and WAN interface.
When such an interface is modeled in more than one place within the data model, the value of this parameter MUST include the full hierarchical parameter names of all of the corresponding objects. For example, if a given Ethernet interface is present within two ''LANDevice'' instances, the value of this parameter might be: ''InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.1, InternetGatewayDevice.LANDevice.2.LANEthernetInterfaceConfig.1''
Note that the remainder of the parameter description does not refer to the possibility that the parameter value is a comma-separated list. Nevertheless, the above requirement does apply.
* For a WAN interface, this parameter is the full hierarchical parameter name of a particular ''WANConnectionDevice''. A ''WANConnectionDevice'' is considered available (included in this table) only if it supports layer 2 bridged traffic. That is, this table MUST include only ''WANConnectionDevice''s that contain either a ''WANEthernetLinkConfig'' object, or that contain a ''WANDSLLinkConfig'' object for which the ''LinkType'' is ''EoA''. For example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2''
* For a LAN interface, this parameter is the full hierarchical parameter name of a particular ''LAN**InterfaceConfig'' object, or a ''WLANConfiguration'' object. This table SHOULD include one entry for each such object. For example: ''InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2''
* For a WAN-side connection to the Gateway's IP router, this parameter is the full hierarchical parameter name of a particular ''WAN**Connection'' service. This table SHOULD include an entry for each layer 3 WAN connection. For example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''
* For a LAN-side connection to the Gateway's IP router, this parameter is the full hierarchical parameter name of a particular ''LANDevice''. This table SHOULD include an entry for each ''LANDevice'', each of which is associated with a LAN-side layer 3 connection to the Gateway's IP router. For example: ''InternetGatewayDevice.LANDevice.2''</description>
<syntax>
<list>
<size maxLength="256"/>
</list>
<string>
<size maxLength="256" status="deleted"/>
<pathRef refType="strong" targetType="row"/>
</string>
</syntax>
</parameter>
</object>
<object base="InternetGatewayDevice.QueueManagement." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="QueueStatsNumberOfEntries" access="readOnly" dmr:previousParameter="QueueNumberOfEntries">
<description>The number of entries in the {{object|QueueStats}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="DefaultTrafficClass" access="readWrite" dmr:previousParameter="DefaultForwardingPolicy">
<description>Identifier of the traffic class associated with traffic not associated with any specified classifier.
A value of -1 indicates a null traffic class.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
</syntax>
</parameter>
<parameter base="DefaultQueue" access="readWrite">
<description action="append">A value of 0xffffffff (-1) indicates a null queue (permitted in data model versions 1.4 and later).</description>
</parameter>
</object>
<object base="InternetGatewayDevice.QueueManagement.Classification.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="ClassificationNumberOfEntries">
<parameter base="ClassificationOrder" access="readWrite">
<description action="append">The value on creation of a Classification table entry MUST be one greater than the largest current value.</description>
</parameter>
<parameter base="SourceVendorClassID" access="readWrite">
<description action="replace">Classification criterion.
Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132 {{bibref|RFC2132}}, matched according to the criterion in {{param|SourceVendorClassIDMode}}. Case sensitive.
{{empty}} indicates this criterion is not used for classification.</description>
</parameter>
<parameter name="SourceVendorClassIDMode" access="readWrite" dmr:previousParameter="SourceVendorClassIDExclude">
<description>SourceVendorClassID pattern match criterion. {{enum}}
For example, if {{param|SourceVendorClassID}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.</description>
<syntax>
<string>
<enumeration value="Exact"/>
<enumeration value="Prefix"/>
<enumeration value="Suffix"/>
<enumeration value="Substring"/>
</string>
<default type="object" value="Exact"/>
</syntax>
</parameter>
<parameter base="DestVendorClassID" access="readWrite">
<description action="replace">Classification criterion.
Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132 {{bibref|RFC2132}}, matched according to the criterion in {{param|DestVendorClassIDMode}}. Case sensitive.
{{empty}} indicates this criterion is not used for classification.</description>
</parameter>
<parameter name="DestVendorClassIDMode" access="readWrite" dmr:previousParameter="DestVendorClassIDExclude">
<description>DestVendorClassID pattern match criterion. {{enum}}
For example, if {{param|DestVendorClassID}} is "Example" then an Option 60 value of "Example device" will match with {{param}} values of {{enum|Prefix}} or {{enum|Substring}}, but not with {{enum|Exact}} or {{enum|Suffix}}.</description>
<syntax>
<string>
<enumeration value="Exact"/>
<enumeration value="Prefix"/>
<enumeration value="Suffix"/>
<enumeration value="Substring"/>
</string>
<default type="object" value="Exact"/>
</syntax>
</parameter>
<parameter base="SourceClientID" access="readWrite">
<description action="replace">Classification criterion.
Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132 {{bibref|RFC2132}}. The option value is binary, so an exact match is REQUIRED.
{{empty}} indicates this criterion is not used for classification.</description>
</parameter>
<parameter base="DestClientID" access="readWrite">
<description action="replace">Classification criterion.
Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132 {{bibref|RFC2132}}. The option value is binary, so an exact match is REQUIRED.
{{empty}} indicates this criterion is not used for classification.</description>
</parameter>
<parameter base="SourceUserClassID" access="readWrite">
<description action="replace">Classification criterion.
Used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in RFC 3004 {{bibref|RFC3004}}.
{{empty}} indicates this criterion is not used for classification.</description>
</parameter>
<parameter base="DestUserClassID" access="readWrite">
<description action="replace">Classification criterion.
Used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in RFC 3004 {{bibref|RFC3004}}.
{{empty}} indicates this criterion is not used for classification.</description>
</parameter>
<parameter name="SourceVendorSpecificInfo" access="readWrite" dmr:previousParameter="DestUserClassIDExclude">
<description>Classification criterion.
Used to identify one or more LAN devices, value of the DHCP Vendor-specific Information (Option 125) as defined in RFC 3925 {{bibref|RFC3925}}, matched according to the criteria in {{param|SourceVendorSpecificInfoEnterprise}}, {{param|SourceVendorSpecificInfoSubOption}} and {{param|SourceVendorSpecificInfoMode}}. Case sensitive.
{{empty}} indicates this criterion is not used for classification.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceVendorSpecificInfoExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets sourced from LAN devices that match the {{param|SourceVendorSpecificInfo}} entry, if specified.
If {{true}}, the class includes all packets except those sourced from LAN devices that match the {{param|SourceVendorSpecificInfo}} entry, if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="SourceVendorSpecificInfoEnterprise" access="readWrite">
<description>{{param|SourceVendorSpecificInfo}} Enterprise Number as defined in RFC 3925 {{bibref|RFC3925}}.
The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number.</description>
<syntax>
<unsignedInt/>
<default type="object" value="0"/>
</syntax>
</parameter>
<parameter name="SourceVendorSpecificInfoSubOption" access="readWrite">
<description>{{param|SourceVendorSpecificInfo}} Sub Option Code as defined in RFC 3925 {{bibref|RFC3925}}.</description>
<syntax>
<int>
<range minInclusive="0" maxInclusive="255"/>
</int>
<default type="object" value="0"/>
</syntax>
</parameter>
<parameter name="SourceVendorSpecificInfoMode" access="readWrite">
<description>{{param|SourceVendorSpecificInfo}} pattern match criterion.</description>
<syntax>
<string>
<enumeration value="Exact"/>
<enumeration value="Prefix"/>
<enumeration value="Suffix"/>
<enumeration value="Substring"/>
</string>
<default type="object" value="Exact"/>
</syntax>
</parameter>
<parameter name="DestVendorSpecificInfo" access="readWrite">
<description>Classification criterion.
Used to identify one or more LAN devices, value of the DHCP Vendor-specific Information (Option 125) as defined in RFC 3925 {{bibref|RFC3925}}, matched according to the criteria in {{param|DestVendorSpecificInfoEnterprise}}, {{param|DestVendorSpecificInfoSubOption}} and {{param|DestVendorSpecificInfoMode}}.
{{empty}} indicates this criterion is not used for classification.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestVendorSpecificInfoExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets destined for LAN devices that match the {{param|DestVendorSpecificInfo}} entry, if specified.
If {{true}}, the class includes all packets except those destined for LAN devices that match the {{param|DestVendorSpecificInfo}} entry, if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="DestVendorSpecificInfoEnterprise" access="readWrite">
<description>{{param|DestVendorSpecificInfo}} Enterprise Number as defined in RFC 3925 {{bibref|RFC3925}}.
The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number.</description>
<syntax>
<unsignedInt/>
<default type="object" value="0"/>
</syntax>
</parameter>
<parameter name="DestVendorSpecificInfoSubOption" access="readWrite">
<description>{{param|DestVendorSpecificInfo}} Sub Option Code as defined in RFC 3925 {{bibref|RFC3925}}.</description>
<syntax>
<int>
<range minInclusive="0" maxInclusive="255"/>
</int>
<default type="object" value="0"/>
</syntax>
</parameter>
<parameter name="DestVendorSpecificInfoMode" access="readWrite">
<description>{{param|DestVendorSpecificInfo}} pattern match criterion.</description>
<syntax>
<string>
<enumeration value="Exact"/>
<enumeration value="Prefix"/>
<enumeration value="Suffix"/>
<enumeration value="Substring"/>
</string>
<default type="object" value="Exact"/>
</syntax>
</parameter>
<parameter base="DSCPCheck" access="readWrite">
<description action="replace">Classification criterion.
DiffServ codepoint (defined in RFC 2474 {{bibref|RFC2474}}).
If set to a Class Selector Codepoint (defined in RFC 2474), all DSCP values that match the first 3 bits will be considered a valid match.
A value of -1 indicates this criterion is not used for classification.</description>
</parameter>
<parameter name="OutOfBandInfo" access="readWrite" dmr:previousParameter="VLANIDExclude">
<description>Classification criterion.
Allows traffic to be distinguished based on out-of-band information such as physical port or application ID. Primarily intended for, but not restricted to, locally sourced traffic.
If specified, this entry applies to traffic with matching out-of-band information. A value of -1 indicates this criterion is not used for classification.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter name="TrafficClass" access="readWrite" dmr:previousParameter="ForwardingPolicy">
<description>Classification result.
Identifier of the traffic class associated with traffic that falls in this classification. If specified, at least one Queue table entry MUST include this traffic class in its ''TrafficClass'' parameter (which is a comma-separated list).
A value of -1 indicates a null traffic class.
{{param}}, {{param|ClassQueue}} and {{param|ClassApp}} are mutually exclusive and one of the three MUST be specified. If {{param}} and {{param|ClassQueue}} are null, {{param|ClassApp}} MUST be specified, and vice versa.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter base="ClassQueue" access="readWrite">
<description action="replace">Classification result.
Instance number of the Queue table entry for traffic that falls in this classification.
A value of -1 indicates a null queue.
{{param|TrafficClass}}, {{param}} and {{param|ClassApp}} are mutually exclusive and one of the three MUST be specified. If {{param|TrafficClass}} and {{param}} are null, {{param|ClassApp}} MUST be specified, and vice versa.</description>
</parameter>
<parameter base="ClassApp" access="readWrite">
<description action="replace">Classification result.
Instance number of the App table entry for traffic that falls in this classification.
A value of -1 indicates a null App table entry.
{{param|TrafficClass}}, {{param|ClassQueue}} and {{param}} are mutually exclusive and one of the three MUST be specified. If {{param|TrafficClass}} and {{param|ClassQueue}} are null, {{param}} MUST be specified, and vice versa.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.QueueManagement.App.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="AppNumberOfEntries">
<parameter name="AppDefaultTrafficClass" access="readWrite" dmr:previousParameter="AppDefaultForwardingPolicy">
<description>Identifier of the traffic class associated with traffic associated with this App table entry, but not associated with any specified flow.
A value of -1 indicates a null traffic class.
{{param}} and {{param|AppDefaultQueue}} MUST NOT both be specified.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter base="AppDefaultQueue" access="readWrite">
<description action="append">{{param|AppDefaultTrafficClass}} and {{param}} MUST NOT both be specified.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.QueueManagement.Flow.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="FlowNumberOfEntries">
<parameter name="FlowTrafficClass" access="readWrite" dmr:previousParameter="FlowForwardingPolicy">
<description>Identifier of the traffic class associated with this flow.
A value of -1 indicates a null traffic class.
{{param}} and {{param|FlowQueue}} MUST NOT both be specified.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter base="FlowQueue" access="readWrite">
<description action="append">{{param|FlowTrafficClass}} and {{param}} MUST NOT both be specified.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.QueueManagement.Policer.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="PolicerNumberOfEntries">
<parameter base="MeterType" access="readWrite">
<description action="replace">Identifies the method of traffic measurement to be used for this policer. {{enum}}
{{enum|SimpleTokenBucket}} makes use of {{param|CommittedRate}} and {{param|CommittedBurstSize}}.
{{enum|SingleRateThreeColor}} makes use of {{param|CommittedRate}}, {{param|CommittedBurstSize}}, and {{param|ExcessBurstSize}} as defined in RFC 2697 {{bibref|RFC2697}}.