forked from BroadbandForum/cwmp-data-models
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tr-098-1-0-0.xml
2772 lines (2758 loc) · 161 KB
/
tr-098-1-0-0.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
TR-069 InternetGatewayDevice:1.1 Root Object definition
Copyright (c) 2009-2017, Broadband Forum
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products
derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only.
Please reference the Forum IPR Policy for patent licensing terms
<https://www.broadband-forum.org/ipr-policy>.
Any moral rights which are necessary to exercise under the above
license grant are also deemed granted under this license.
Summary:
TR-069 InternetGatewayDevice:1.1 Root Object Definition. Contains definition of
InternetGatewayDevice:1.1 Root Object.
Version History:
March 2009: tr-098-1-0-0.xml, corresponds to TR-098 sections 2.4 (Data Model), 2.4.1
(Inform and Notification Requirements) and 3 (Profile Definitions).
September 2009: tr-098-1-0-0.xml (name unchanged)
- changed WLANConfigurationNumberOfEntries to (wrong but consistent)
LANWLANConfigurationNumberOfEntries
- fixed cwmp-datamodel.xsd to be cwmp-datamodel-1-0.xsd
-->
<dm:document xmlns:dm="urn:broadband-forum-org:cwmp:datamodel-1-0"
xmlns:dmr="urn:broadband-forum-org:cwmp:datamodel-report-0-1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:broadband-forum-org:cwmp:datamodel-1-0 cwmp-datamodel-1-0.xsd
urn:broadband-forum-org:cwmp:datamodel-report-0-1 cwmp-datamodel-report.xsd"
spec="urn:broadband-forum-org:tr-098-1-0-0">
<import file="tr-069-biblio.xml" spec="urn:broadband-forum-org:tr-069-biblio"/>
<import file="tr-106-1-0-types.xml" spec="urn:broadband-forum-org:tr-106-1-0">
<dataType name="IPAddress"/>
<dataType name="MACAddress"/>
</import>
<import file="tr-069-1-0.xml" spec="urn:broadband-forum-org:tr-069-1-0">
<model name="InternetGatewayDevice:1.0"/>
</import>
<model name="InternetGatewayDevice:1.1" base="InternetGatewayDevice:1.0">
<object base="InternetGatewayDevice." access="readOnly" minEntries="1" maxEntries="1">
<parameter name="DeviceSummary" access="readOnly" forcedInform="true" dmr:previousParameter="">
<description>As defined in {{bibref|TR-106}}.</description>
<syntax>
<string>
<size maxLength="1024"/>
</string>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Services." access="readOnly" minEntries="1" maxEntries="1" dmr:previousObject="">
<description>This object contains general services information.</description>
</object>
<object base="InternetGatewayDevice.DeviceInfo." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="HardwareVersion" access="readOnly" forcedInform="true"/>
<parameter base="SoftwareVersion" access="readOnly" activeNotify="forceEnabled" forcedInform="true"/>
<parameter base="EnabledOptions" access="readOnly">
<description action="replace">Comma-separated list of the OptionName of each Option that is currently enabled in the CPE. The OptionName of each is identical to the OptionName element of the OptionStruct described in {{bibref|TR-069}}. Only those options are listed whose State indicates the option is enabled.</description>
</parameter>
<parameter base="SpecVersion" access="readOnly" status="deprecated" forcedInform="true">
<description action="replace">This parameter is deprecated
Represents the version of the specification implemented by the device. Currently 1.0 is the only available version.</description>
<syntax>
<string>
<size maxLength="16"/>
</string>
<default type="object" value="1.0"/>
</syntax>
</parameter>
<parameter base="ProvisioningCode" access="readWrite" activeNotify="forceEnabled" forcedInform="true"/>
<parameter base="FirstUseDate" access="readOnly">
<description action="replace">Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset.</description>
</parameter>
</object>
<object base="InternetGatewayDevice.ManagementServer." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="URL" access="readWrite">
<description action="replace">URL for the CPE to connect to the ACS using the CPE WAN Management Protocol.
This parameter MUST be in the form of a valid HTTP or HTTPS URL {{bibref|RFC2616}}.
The ''host'' portion of this URL is used by the CPE for server-side certificate authentication when using SSL or TLS.</description>
</parameter>
<parameter base="ParameterKey" access="readOnly" activeNotify="canDeny" forcedInform="true">
<description action="replace">{{param}} provides the ACS a reliable and extensible means to track changes made by the ACS. The value of {{param}} MUST be equal to the value of the ParameterKey argument from the most recent successful SetParameterValues, AddObject, or DeleteObject method call from the ACS.
The CPE MUST set {{param}} to the value specified in the corresponding method arguments if and only if the method completes successfully and no fault response is generated. If a method call does not complete successfully (implying that the changes requested in the method did not take effect), the value of {{param}} MUST NOT be modified.
The CPE MUST only modify the value of {{param}} as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of {{param}} MUST be set to {{empty}}.</description>
</parameter>
<parameter base="ConnectionRequestURL" access="readOnly" activeNotify="forceEnabled" forcedInform="true"/>
</object>
<object base="InternetGatewayDevice.Time." access="readOnly" minEntries="1" maxEntries="1">
<parameter base="CurrentLocalTime" access="readOnly" activeNotify="canDeny"/>
</object>
<object base="InternetGatewayDevice.Layer3Forwarding." access="readOnly" minEntries="1" maxEntries="1">
</object>
<object base="InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="ForwardNumberOfEntries">
<description action="append">This table MUST NOT include routes learned through dynamic layer-3 routing protocols, such as RIP or OSPF.</description>
<parameter base="Enable" access="readWrite">
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter base="DestIPAddress" access="readWrite">
<description action="replace">Destination address. {{empty}} or a value of "0.0.0.0" indicates no destination address is specified.</description>
</parameter>
<parameter base="DestSubnetMask" access="readWrite">
<description action="replace">Destination subnet mask. {{empty}} or a value of "0.0.0.0" indicates no destination subnet mask is specified.</description>
</parameter>
<parameter base="SourceIPAddress" access="readWrite">
<description action="replace">Source address. {{empty}} or a value of "0.0.0.0" indicates no source address is specified.</description>
</parameter>
<parameter base="SourceSubnetMask" access="readWrite">
<description action="replace">Source subnet mask. {{empty}} or a value of "0.0.0.0" indicates no source subnet mask is specified.</description>
</parameter>
<parameter name="ForwardingPolicy" access="readWrite">
<description>Identifier of a set of classes or flows that have the corresponding {{param}} value as defined in the ''QueueManagement'' object.
A value of -1 indicates no {{param}} is specified.
If specified, this forwarding entry is to apply only to traffic associated with the specified classes and flows.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter base="Interface" access="readWrite">
<description action="replace">Specifies the egress interface associated with this entry. The content is the full hierarchical parameter name of the layer-3 connection object. Example: ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''.</description>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer2Bridging." access="readOnly" minEntries="1" maxEntries="1">
<description>Layer-2 bridging table. 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.</description>
<parameter name="MaxBridgeEntries" access="readOnly" activeNotify="canDeny">
<description>The maximum number of entries available in the {{object|Bridge}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxFilterEntries" access="readOnly" activeNotify="canDeny">
<description>The maximum number of entries available in the {{object|Filter}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxMarkingEntries" access="readOnly" activeNotify="canDeny">
<description>The maximum number of entries available in the {{object|Marking}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="BridgeNumberOfEntries" access="readOnly">
<description>Number of entries in the {{object|Bridge}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="FilterNumberOfEntries" access="readOnly">
<description>Number of entries in the {{object|Filter}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MarkingNumberOfEntries" access="readOnly">
<description>Number of entries in the {{object|Marking}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="AvailableInterfaceNumberOfEntries" access="readOnly">
<description>Number of entries in the {{object|AvailableInterfaces}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer2Bridging.Bridge.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="BridgeNumberOfEntries" enableParameter="BridgeEnable">
<description>Bridge table.</description>
<uniqueKey>
<parameter ref="BridgeKey"/>
</uniqueKey>
<parameter name="BridgeKey" access="readOnly">
<description>Unique key for each Bridge table entry.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="BridgeEnable" access="readWrite">
<description>Enables or disables this Bridge table entry.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="BridgeStatus" access="readOnly">
<description>The status of this Bridge table entry.</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Enabled"/>
<enumeration value="Error"/>
</string>
<default type="object" value="Disabled"/>
</syntax>
</parameter>
<parameter name="BridgeName" access="readWrite">
<description>Human-readable name for this Bridge table entry.</description>
<syntax>
<string>
<size maxLength="64"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="VLANID" access="readWrite">
<description>The 802.1Q VLAN ID associated with this Bridge.
A value of 0 indicates either Untagged or PriorityOnly tagging, which are treated identically.</description>
<syntax>
<unsignedInt>
<range minInclusive="0" maxInclusive="4094"/>
</unsignedInt>
<default type="object" value="0"/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer2Bridging.Filter.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="FilterNumberOfEntries" enableParameter="FilterEnable">
<description>Filter table containing filter entries each of which is associated with one Bridge as specified by a ''Bridge'' table entry.</description>
<uniqueKey>
<parameter ref="FilterKey"/>
</uniqueKey>
<parameter name="FilterKey" access="readOnly">
<description>Unique key for each Filter table entry.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="FilterEnable" access="readWrite">
<description>Enables or disables this Filter table entry.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="FilterStatus" access="readOnly">
<description>The status of this Filter table entry.</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Enabled"/>
<enumeration value="Error"/>
</string>
<default type="object" value="Disabled"/>
</syntax>
</parameter>
<parameter name="FilterBridgeReference" access="readWrite">
<description>The ''BridgeKey'' value of the ''Bridge'' table entry associated with this Filter. A value of -1 indicates the Filter table entry is not associated with a Bridge (and has no effect).</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter name="ExclusivityOrder" access="readWrite">
<description>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.
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 the default association between layer-3 and layer-2 objects implied by the ''InternetGatewayDevice'' object hierarchy.</description>
<syntax>
<unsignedInt/>
<default type="object" value="0"/>
</syntax>
</parameter>
<parameter name="FilterInterface" access="readWrite">
<description>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 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'').
* ''LANInterfaces'' indicates that this Filter is associated with all LAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''LANInterface'').
* ''WANInterfaces'' indicates that this Filter is associated with all WAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''WANInterface'').
* {{empty}} indicates the Filter table entry is not associated with any interface (and has no effect)</description>
<syntax>
<string/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="VLANIDFilter" access="readWrite">
<description>The 802.1Q VLAN ID of packets to admit to the specified Bridge through the interfaces specified for this Filter.
A value of -1 indicates that the default VLAN ID for the Bridge should be used instead (as specified by {{param|InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID}} for the ''Bridge'' table entry associated with this Filter table entry). On creation of a Filter entry, the default value for this parameter should be -1.</description>
<syntax>
<int>
<range minInclusive="-1" maxInclusive="4095"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter name="AdmitOnlyVLANTagged" access="readWrite">
<description>If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits only packets tagged with a VLAN ID that matches the {{param|VLANIDFilter}} parameter (or instead, the VLAN ID for the Bridge if {{param|VLANIDFilter}} is unspecified).
If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits both packets tagged with a VLAN ID that matches the {{param|VLANIDFilter}} parameter (or instead, the VLAN ID for the Bridge if {{param|VLANIDFilter}} is unspecified), and any Untagged or PriorityOnly packets. All Untagged or PriorityOnly packets are tagged on ingress with the value of the {{param|VLANID}} parameter.
If the {{param|VLANIDFilter}} parameter (or instead, the VLAN ID for the Bridge if {{param|VLANIDFilter}} is unspecified) is equal to 0, then this parameter is ignored, and only packets that are Untagged or PriorityOnly packets are admitted.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="EthertypeFilterList" access="readWrite">
<description>Comma-separated list of unsigned integers, each representing an Ethertype value.</description>
<syntax>
<list>
<size maxLength="256"/>
</list>
<unsignedInt/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="EthertypeFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit only those packets that match one of the {{param|EthertypeFilterList}} entries (in either the Ethernet or SNAP Type header). If the {{param|EthertypeFilterList}} is empty, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit all packets except those packets that match one of the {{param|EthertypeFilterList}} entries (in either the Ethernet or SNAP Type header). If the {{param|EthertypeFilterList}} is empty, packets are admitted regardless of Ethertype.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter name="SourceMACAddressFilterList" access="readWrite">
<description>Comma-separated list of MAC Addresses.
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 may 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>
<syntax>
<list>
<size maxLength="512"/>
</list>
<string/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceMACAddressFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches one of the {{param|SourceMACAddressFilterList}} entries. If the {{param|SourceMACAddressFilterList}} is empty, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches one of the {{param|SourceMACAddressFilterList}} entries. If the {{param|SourceMACAddressFilterList}} is empty, packets are admitted regardless of MAC address.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter name="DestMACAddressFilterList" access="readWrite">
<description>Comma-separated list of MAC Addresses.
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 may 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>
<syntax>
<list>
<size maxLength="512"/>
</list>
<string/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestMACAddressFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches one of the {{param|DestMACAddressFilterList}} entries. If the {{param|DestMACAddressFilterList}} is empty, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches one of the {{param|DestMACAddressFilterList}} entries. If the {{param|DestMACAddressFilterList}} is empty, packets are admitted regardless of MAC address.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter name="SourceMACFromVendorClassIDFilter" access="readWrite">
<description>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 it its DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132) in the most recent DHCP lease acquisition or renewal was equal to the specified value.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceMACFromVendorClassIDFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in {{param|SourceMACFromVendorClassIDFilter}}. If {{param|SourceMACFromVendorClassIDFilter}} is {{empty}}, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in {{param|SourceMACFromVendorClassIDFilter}}. If the {{param|SourceMACFromVendorClassIDFilter}} is {{empty}}, packets are admitted regardless of MAC address.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter name="DestMACFromVendorClassIDFilter" access="readWrite">
<description>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 it its DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132) in the most recent DHCP lease acquisition or renewal was equal to the specified value.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestMACFromVendorClassIDFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromVendorClassIDFilter}}. If {{param|DestMACFromVendorClassIDFilter}} is {{empty}}, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromVendorClassIDFilter}}. If the {{param|DestMACFromVendorClassIDFilter}} is {{empty}}, packets are admitted regardless of MAC address.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter name="SourceMACFromClientIDFilter" access="readWrite">
<description>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 it its DHCP Client Identifier (Option 61 as defined in RFC 2132) in the most recent DHCP lease acquisition or renewal was equal to the specified value.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceMACFromClientIDFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in {{param|SourceMACFromClientIDFilter}}. If {{param|SourceMACFromClientIDFilter}} is {{empty}}, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in {{param|SourceMACFromClientIDFilter}}. If the {{param|SourceMACFromClientIDFilter}} is {{empty}}, packets are admitted regardless of MAC address.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter name="DestMACFromClientIDFilter" access="readWrite">
<description>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 it its DHCP Client Identifier (Option 61 as defined in RFC 2132) in the most recent DHCP lease acquisition or renewal was equal to the specified value.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestMACFromClientIDFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromClientIDFilter}}. If {{param|DestMACFromClientIDFilter}} is {{empty}}, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromClientIDFilter}}. If the {{param|DestMACFromClientIDFilter}} is {{empty}}, packets are admitted regardless of MAC address.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter name="SourceMACFromUserClassIDFilter" access="readWrite">
<description>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 it its DHCP User Class Identifier (Option 77 as defined in RFC 3004) in the most recent DHCP lease acquisition or renewal was equal to the specified value.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceMACFromUserClassIDFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in {{param|SourceMACFromUserClassIDFilter}}. If {{param|SourceMACFromUserClassIDFilter}} is {{empty}}, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in {{param|SourceMACFromUserClassIDFilter}}. If the {{param|SourceMACFromUserClassIDFilter}} is {{empty}}, packets are admitted regardless of MAC address.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
<parameter name="DestMACFromUserClassIDFilter" access="readWrite">
<description>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 it its DHCP User Class Identifier (Option 77 as defined in RFC 3004) in the most recent DHCP lease acquisition or renewal was equal to the specified value.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestMACFromUserClassIDFilterExclude" access="readWrite">
<description>If {{false}}, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromUserClassIDFilter}}. If {{param|DestMACFromUserClassIDFilter}} is {{empty}}, no packets are admitted.
If {{true}}, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in {{param|DestMACFromUserClassIDFilter}}. If the {{param|DestMACFromUserClassIDFilter}} is {{empty}}, packets are admitted regardless of MAC address.</description>
<syntax>
<boolean/>
<default type="object" value="true"/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer2Bridging.Marking.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="MarkingNumberOfEntries" enableParameter="MarkingEnable">
<description>Marking table identifying non-default layer-2 marking behavior for packets on egress from the specified interfaces.</description>
<uniqueKey>
<parameter ref="MarkingKey"/>
</uniqueKey>
<parameter name="MarkingKey" access="readOnly">
<description>Unique key for each Marking table entry.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MarkingEnable" access="readWrite">
<description>Enables or disables this Marking table entry.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="MarkingStatus" access="readOnly">
<description>The status of this Marking table entry.</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Enabled"/>
<enumeration value="Error"/>
</string>
<default type="object" value="Disabled"/>
</syntax>
</parameter>
<parameter name="MarkingBridgeReference" access="readWrite">
<description>The ''BridgeKey'' value of the Bridge table entry associated with this Marking table entry. A value of -1 indicates the Marking table entry is not associated with a Bridge (and has no effect).
The effect of a Marking table entry applies only to packets that have been admitted to the specified bridge (regardless of the ingress interface).</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter name="MarkingInterface" access="readWrite">
<description>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 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'').
* ''LANInterfaces'' indicates that this Marking table entry is associated with all LAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''LANInterface'').
* ''WANInterfaces'' indicates that this Marking table entry is associated with all WAN interfaces listed in the ''AvailableInterface'' table (all entries of ''InterfaceType'' ''WANInterface'').
* {{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/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="VLANIDUntag" access="readWrite">
<description>If {{true}}, on egress to the interfaces associated with this Marking table entry, all packets are Untagged. That is, the VLAN tag is stripped from the packet.
If {{false}}, on egress to the interfaces associated with this Marking table entry, all VLAN tags are left intact (including those added on ingress).</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="VLANIDMark" access="readWrite">
<description>The 802.1Q VLAN ID to be used on egress to the interfaces associated with this Marking table entry (if VLANIDUntag is {{false}}).
A value of -1 indicates that the default VLAN ID for the Bridge should be used instead (as specified by {{param|InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID}} for the ''Bridge'' table entry associated with this Marking table entry).</description>
<syntax>
<int>
<range minInclusive="-1" maxInclusive="4095"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter name="EthernetPriorityMark" access="readWrite">
<description>Ethernet priority code (as defined in 802.1D) 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.</description>
<syntax>
<int>
<range minInclusive="-1" maxInclusive="7"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter name="EthernetPriorityOverride" access="readWrite">
<description>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.
If {{param|VLANIDUntag}} is {{true}}, then no priority marking is done since the tag containing the Ethernet priority is removed.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.Layer2Bridging.AvailableInterface.{i}." access="readOnly" minEntries="0" maxEntries="unbounded" numEntriesParameter="AvailableInterfaceNumberOfEntries">
<description>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>
<uniqueKey>
<parameter ref="AvailableInterfaceKey"/>
</uniqueKey>
<parameter name="AvailableInterfaceKey" access="readOnly" activeNotify="canDeny">
<description>Unique key for each Interface entry.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="InterfaceType" access="readOnly" activeNotify="canDeny">
<description>Whether the interface is a LAN-side or WAN-side interface, or a LAN-side or WAN-side connection to the Gateway's IP router.</description>
<syntax>
<string>
<enumeration value="LANInterface"/>
<enumeration value="WANInterface"/>
<enumeration value="LANRouterConnection"/>
<enumeration value="WANRouterConnection"/>
</string>
</syntax>
</parameter>
<parameter name="InterfaceReference" access="readOnly" activeNotify="canDeny">
<description>This table should contain a single entry for each available LAN and WAN interface.
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.LANLANEthernetInterfaceConfig.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>
<string>
<size maxLength="256"/>
</string>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.QueueManagement." access="readOnly" minEntries="1" maxEntries="1">
<description>Queue management configuration object.</description>
<parameter name="Enable" access="readWrite">
<description>Enables or disables all queuing operation.</description>
<syntax>
<boolean/>
</syntax>
</parameter>
<parameter name="MaxQueues" access="readOnly" activeNotify="canDeny">
<description>The maximum number of queues supported by the CPE. Calculated as the sum of the number of different queues pointed to by Classification table. For each entry in the Classification table, the count includes a queue for each egress interface to which the corresponding classified traffic could reach.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxClassificationEntries" access="readOnly" activeNotify="canDeny">
<description>The maximum number of entries available in the Classification table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ClassificationNumberOfEntries" access="readOnly">
<description>The number of entries in the {{object|Classification}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxAppEntries" access="readOnly" activeNotify="canDeny">
<description>The maximum number of entries available in the {{object|App}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="AppNumberOfEntries" access="readOnly">
<description>The number of entries in the {{object|App}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxFlowEntries" access="readOnly" activeNotify="canDeny">
<description>The maximum number of entries available in the {{object|Flow}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="FlowNumberOfEntries" access="readOnly">
<description>The number of entries in the {{object|Flow}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxPolicerEntries" access="readOnly" activeNotify="canDeny">
<description>The maximum number of entries available in the {{object|Policer}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="PolicerNumberOfEntries" access="readOnly">
<description>The number of entries in the {{object|Policer}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="MaxQueueEntries" access="readOnly" activeNotify="canDeny">
<description>The maximum number of entries available in the {{object|Queue}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="QueueNumberOfEntries" access="readOnly">
<description>The number of entries in the {{object|Queue}} table.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="DefaultForwardingPolicy" access="readWrite">
<description>Identifier of the forwarding policy associated with traffic not associated with any specified classifier.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="DefaultPolicer" access="readWrite">
<description>Instance number of the Policer table entry for traffic not associated with any specified classifier.
A value of -1 indicates a null policer.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
</syntax>
</parameter>
<parameter name="DefaultQueue" access="readWrite">
<description>Instance number of the {{object|Queue}} table entry for traffic not associated with any specified classifier.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="DefaultDSCPMark" access="readWrite">
<description>DSCP to mark traffic not associated with any specified classifier.
A value of -1 indicates no change from the incoming packet.
A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value as defined in {{bibref|TR-098|Appendix A}}.</description>
<syntax>
<int>
<range minInclusive="-2"/>
</int>
</syntax>
</parameter>
<parameter name="DefaultEthernetPriorityMark" access="readWrite">
<description>Ethernet priority code (as defined in 802.1D) to mark traffic not associated with any specified classifier.
A value of -1 indicates no change from the incoming packet.
A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value as defined in {{bibref|TR-098|Appendix A}}.</description>
<syntax>
<int>
<range minInclusive="-2"/>
</int>
</syntax>
</parameter>
<parameter name="AvailableAppList" access="readOnly">
<description>Comma-separated list of URNs, each indicating a protocol supported for use as a ProtocolIdentifier in the App table. This list may include any of the URNs defined in {{bibref|TR-098|Appendix A}} as well as other URNs defined elsewhere.</description>
<syntax>
<list>
<size maxLength="1024"/>
</list>
<string/>
</syntax>
</parameter>
</object>
<object name="InternetGatewayDevice.QueueManagement.Classification.{i}." access="readWrite" minEntries="0" maxEntries="unbounded" numEntriesParameter="ClassificationNumberOfEntries">
<description>Classification table.</description>
<parameter name="ClassificationKey" access="readOnly">
<description>Unique key for each classification entry.</description>
<syntax>
<unsignedInt/>
</syntax>
</parameter>
<parameter name="ClassificationEnable" access="readWrite">
<description>Enables or disables this classifier.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="ClassificationStatus" access="readOnly">
<description>The status of this classifier.</description>
<syntax>
<string>
<enumeration value="Disabled"/>
<enumeration value="Enabled"/>
<enumeration value="Error"/>
</string>
<default type="object" value="Disabled"/>
</syntax>
</parameter>
<parameter name="ClassificationOrder" access="readWrite">
<description>Position of the classification entry in the order of precedence. A value of 1 indicates the first entry considered. For each packet, the highest ordered entry that matches the classification criteria is applied. All lower order entries are ignored.
When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.</description>
<syntax>
<unsignedInt>
<range minInclusive="1"/>
</unsignedInt>
</syntax>
</parameter>
<parameter name="ClassInterface" access="readWrite">
<description>Classification criterion.
Specifies the LAN or WAN ingress interface associated with this entry. The content is the full hierarchical parameter name of the particular ''WANDevice'', ''WANConnectionDevice'', ''WAN**Connection'', ''LANDevice'', or ''LAN**InterfaceConfig'' object.
The following are WAN interface examples:
* ''InternetGatewayDevice.WANDevice.2''
* ''InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1''
The following are LAN interface examples:
* ''InternetGatewayDevice.LANDevice.3''
* ''InternetGatewayDevice.LANDevice.1.LANLANEthernetInterfaceConfig.2''
The string ''WAN'' indicates this entry is to apply to traffic entering from any WAN interface.
The string ''LAN'' indicates this entry is to apply to traffic entering from any LAN interface.
The string ''Local'' indicates this entry is to apply to IP-layer traffic entering from a local source within the Internet Gateway Device.
{{empty}} indicates this classification entry is to apply to all sources.</description>
<syntax>
<string>
<size maxLength="256"/>
</string>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestIP" access="readWrite">
<description>Classification criterion.
Destination IP address. {{empty}} indicates this criterion is not used for classification.</description>
<syntax>
<dataType ref="IPAddress"/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestMask" access="readWrite">
<description>Destination IP address mask. If not {{empty}}, only the indicated network portion of the DestIP address is to be used for classification. {{empty}} indicates that the full DestIP address is to be used for classification.</description>
<syntax>
<dataType ref="IPAddress"/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestIPExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets that match the (masked) DestIP entry, if specified.
If {{true}}, the class includes all packets except those that match the (masked) DestIP entry, if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="SourceIP" access="readWrite">
<description>Classification criterion.
Source IP address. {{empty}} indicates this criterion is not used for classification.</description>
<syntax>
<dataType ref="IPAddress"/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceMask" access="readWrite">
<description>Source IP address mask. If not {{empty}}, only the indicated network portion of the SourceIP address is to be used for classification. {{empty}} indicates that the full SourceIP address is to be used for classification.</description>
<syntax>
<dataType ref="IPAddress"/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceIPExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets that match the (masked) SourceIP entry, if specified.
If {{true}}, the class includes all packets except those that match the (masked) SourceIP entry, if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="Protocol" access="readWrite">
<description>Classification criterion.
Protocol number. 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="ProtocolExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets that match the Protocol entry, if specified.
If {{true}}, the class includes all packets except those that match the Protocol entry, if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="DestPort" access="readWrite">
<description>Classification criterion.
Destination port number. 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="DestPortRangeMax" access="readWrite">
<description>Classification criterion.
If specified, indicates the classification criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort.
A value of -1 indicates that no port range is specified.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter name="DestPortExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets that match the DestPort entry (or port range), if specified.
If {{true}}, the class includes all packets except those that match the DestPort entry (or port range), if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="SourcePort" access="readWrite">
<description>Classification criterion.
Source port number. 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="SourcePortRangeMax" access="readWrite">
<description>Classification criterion.
If specified, indicates the classification criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort.
A value of -1 indicates that no port range is specified.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>
</syntax>
</parameter>
<parameter name="SourcePortExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets that match the SourcePort entry (or port range), if specified.
If {{true}}, the class includes all packets except those that match the SourcePort entry (or port range), if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="SourceMACAddress" access="readWrite">
<description>Classification criterion.
Source MAC Address. {{empty}} indicates this criterion is not used for classification.</description>
<syntax>
<dataType ref="MACAddress"/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceMACMask" access="readWrite">
<description>Bit-mask for the MAC address, where matching of a packet's MAC address with the SourceMACAddress is only to be done for bit positions set to one in the mask. A mask of ''FF:FF:FF:FF:FF:FF'' or {{empty}} indicates all bits of the SourceMACAdress are to be used for classification.</description>
<syntax>
<dataType ref="IPAddress"/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="SourceMACExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets that match the (masked) SourceMACAddress entry, if specified.
If {{true}}, the class includes all packets except those that match the (masked) SourceMACAddress entry, if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="DestMACAddress" access="readWrite">
<description>Classification criterion.
Destination MAC Address. {{empty}} indicates this criterion is not used for classification.
The use of destination MAC address as a classification criterion is primarily useful only for bridged traffic.</description>
<syntax>
<dataType ref="MACAddress"/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestMACMask" access="readWrite">
<description>Bit-mask for the MAC address, where matching of a packet's MAC address with the DestMACAddress is only to be done for bit positions set to one in the mask. A mask of ''FF:FF:FF:FF:FF:FF'' or {{empty}} indicates all bits of the DestMACAdress are to be used for classification.</description>
<syntax>
<dataType ref="IPAddress"/>
<default type="object" value=""/>
</syntax>
</parameter>
<parameter name="DestMACExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets that match the (masked) DestMACAddress entry, if specified.
If {{true}}, the class includes all packets except those that match the (masked) DestMACAddress entry, if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="Ethertype" access="readWrite">
<description>Classification criterion.
Ethertype as indicated in either the Ethernet or SNAP Type header. 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="EthertypeExclude" access="readWrite">
<description>If {{false}}, the class includes only those packets that match the Ethertype entry, if specified.
If {{true}}, the class includes all packets except those that match the Ethertype entry, if specified.</description>
<syntax>
<boolean/>
<default type="object" value="false"/>
</syntax>
</parameter>
<parameter name="SSAP" access="readWrite">
<description>Classification criterion.
SSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification.</description>
<syntax>
<int>
<range minInclusive="-1"/>
</int>
<default type="object" value="-1"/>