summaryrefslogtreecommitdiff
path: root/interface-definitions/service_webproxy.xml.in
blob: 03f504ac74f23044e26a21490839a584d86e0ff0 (plain)
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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="webproxy" owner="${vyos_conf_scripts_dir}/service_webproxy.py">
        <properties>
          <help>Webproxy service settings</help>
          <priority>500</priority>
        </properties>
        <children>
          <leafNode name="append-domain">
            <properties>
              <help>Default domain name</help>
              <valueHelp>
                <format>domain</format>
                <description>Domain to use for urls that do not contain a '.'</description>
              </valueHelp>
              <constraint>
                <regex>[.][A-Za-z0-9][-.A-Za-z0-9]*</regex>
              </constraint>
              <constraintErrorMessage>Must start append-domain with a '.'</constraintErrorMessage>
            </properties>
          </leafNode>
          <node name="authentication">
            <properties>
              <help>Proxy Authentication Settings</help>
            </properties>
            <children>
              <leafNode name="children">
                <properties>
                  <help>Number of authentication helper processes (default: 5)</help>
                  <valueHelp>
                    <format>n</format>
                    <description>Number of authentication helper processes</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-500"/>
                  </constraint>
                </properties>
                <defaultValue>5</defaultValue>
              </leafNode>
              <leafNode name="credentials-ttl">
                <properties>
                  <help>Authenticated session time to live in minutes (default: 60)</help>
                  <valueHelp>
                    <format>n</format>
                    <description>Authenticated session timeout</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-600"/>
                  </constraint>
                </properties>
                <defaultValue>60</defaultValue>
              </leafNode>
              <node name="ldap">
                <properties>
                  <help>LDAP authentication settings</help>
                </properties>
                <children>
                  <leafNode name="base-dn">
                    <properties>
                      <help>LDAP Base DN to search</help>
                    </properties>
                  </leafNode>
                  <leafNode name="bind-dn">
                    <properties>
                      <help>LDAP DN used to bind to server</help>
                    </properties>
                  </leafNode>
                  <leafNode name="filter-expression">
                    <properties>
                      <help>Filter expression to perform LDAP search with</help>
                    </properties>
                  </leafNode>
                  <leafNode name="password">
                    <properties>
                      <help>LDAP password to bind with</help>
                    </properties>
                  </leafNode>
                  <leafNode name="persistent-connection">
                    <properties>
                      <help>Use persistent LDAP connection</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  #include <include/port-number.xml.i>
                  <leafNode name="port">
                    <defaultValue>389</defaultValue>
                  </leafNode>
                  <leafNode name="server">
                    <properties>
                      <help>LDAP server to use</help>
                    </properties>
                  </leafNode>
                  <leafNode name="use-ssl">
                    <properties>
                      <help>Use SSL/TLS for LDAP connection</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="username-attribute">
                    <properties>
                      <help>LDAP username attribute</help>
                    </properties>
                  </leafNode>
                  <leafNode name="version">
                    <properties>
                      <help>LDAP protocol version (default: 3)</help>
                      <completionHelp>
                          <list>2 3</list>
                      </completionHelp>
                      <valueHelp>
                        <format>2</format>
                        <description>LDAP protocol version 2</description>
                      </valueHelp>
                      <valueHelp>
                        <format>3</format>
                        <description>LDAP protocol version 2</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 2-3"/>
                      </constraint>
                    </properties>
                    <defaultValue>3</defaultValue>
                  </leafNode>
                </children>
              </node>
              <leafNode name="method">
                <properties>
                  <help>Authentication Method</help>
                  <completionHelp>
                    <list>ldap</list>
                  </completionHelp>
                  <valueHelp>
                    <format>ldap</format>
                    <description>Lightweight Directory Access Protocol</description>
                  </valueHelp>
                  <constraint>
                    <regex>^(ldap)$</regex>
                  </constraint>
                  <constraintErrorMessage>The only supported method currently is LDAP</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="realm">
                <properties>
                  <help>Name of authentication realm (e.g. "My Company proxy server")</help>
                </properties>
              </leafNode>
            </children>
          </node>
          <tagNode name="cache-peer">
            <properties>
              <help>Specify other caches in a hierarchy</help>
              <valueHelp>
                <format>hostname</format>
                <description>Cache peers FQDN</description>
              </valueHelp>
            </properties>
            <children>
              <leafNode name="address">
                <properties>
                  <help>Hostname or IP address of peer</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>Squid cache-peer IPv4 address</description>
                  </valueHelp>
                  <valueHelp>
                    <format>hostname</format>
                    <description>Squid cache-peer hostname</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ip-address"/>
                    <validator name="fqdn"/>
                  </constraint>
                  <constraintErrorMessage>Invalid FQDN or IP address</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="http-port">
                <properties>
                  <help>Default Proxy Port (default: 3128)</help>
                  <valueHelp>
                    <format>u32:1025-65535</format>
                    <description>Default port number</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1025-65535"/>
                  </constraint>
                </properties>
                <defaultValue>3128</defaultValue>
              </leafNode>
               <leafNode name="icp-port">
                <properties>
                  <help>Cache peer ICP port (default: disabled)</help>
                  <valueHelp>
                    <format>u32:1-65535</format>
                    <description>Cache peer ICP port</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-65535"/>
                  </constraint>
                </properties>
                <defaultValue>0</defaultValue>
              </leafNode>
              <leafNode name="options">
                <properties>
                  <help>Cache peer options (default: "no-query default")</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Cache peer options</description>
                  </valueHelp>
                </properties>
                <defaultValue>no-query default</defaultValue>
              </leafNode>
              <leafNode name="type">
                <properties>
                  <help>Squid peer type (default parent)</help>
                  <completionHelp>
                    <list>parent sibling multicast</list>
                  </completionHelp>
                  <valueHelp>
                    <format>parent</format>
                    <description>Peer is a parent</description>
                  </valueHelp>
                  <valueHelp>
                    <format>sibling</format>
                    <description>Peer is a sibling</description>
                  </valueHelp>
                  <valueHelp>
                    <format>multicast</format>
                    <description>Peer is a member of a multicast group</description>
                  </valueHelp>
                  <constraint>
                    <regex>^(parent|sibling|multicast)$</regex>
                  </constraint>
                </properties>
                <defaultValue>parent</defaultValue>
              </leafNode>
            </children>
          </tagNode>
          <leafNode name="cache-size">
            <properties>
              <help>Disk cache size in MB (default: 100)</help>
               <valueHelp>
                <format>u32</format>
                <description>Disk cache size in MB</description>
              </valueHelp>
               <valueHelp>
                <format>0</format>
                <description>Disable disk caching</description>
              </valueHelp>
            </properties>
            <defaultValue>100</defaultValue>
          </leafNode>
          <leafNode name="default-port">
            <properties>
              <help>Default Proxy Port (default: 3128)</help>
              <valueHelp>
                <format>u32:1025-65535</format>
                <description>Default port number</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1025-65535"/>
              </constraint>
            </properties>
            <defaultValue>3128</defaultValue>
          </leafNode>
          <leafNode name="disable-access-log">
            <properties>
              <help>Disable logging of HTTP accesses</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="domain-block">
            <properties>
              <help>Domain name to block</help>
              <multi/>
            </properties>
          </leafNode>
          <leafNode name="domain-noncache">
            <properties>
              <help>Domain name to access without caching</help>
              <multi/>
            </properties>
          </leafNode>
          <tagNode name="listen-address">
            <properties>
              <help>IPv4 listen-address for WebProxy [REQUIRED]</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_local_ips.sh --ipv4</script>
              </completionHelp>
              <valueHelp>
                <format>ipv4</format>
                <description>IPv4 address listen on</description>
              </valueHelp>
            </properties>
            <children>
              <leafNode name="port">
                <properties>
                  <help>Default Proxy Port (default: 3128)</help>
                  <valueHelp>
                    <format>u32:1025-65535</format>
                    <description>Default port number</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1025-65535"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="disable-transparent">
                <properties>
                  <help>Disable transparent mode</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
          <leafNode name="maximum-object-size">
            <properties>
              <help>Maximum size of object to be stored in cache in kilobytes</help>
              <valueHelp>
                <format>u32</format>
                <description>Object size in KB</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-100000"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="mem-cache-size">
            <properties>
              <help>Memory cache size in MB</help>
              <valueHelp>
                <format>u32</format>
                <description>Memory cache size in MB </description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-100000"/>
              </constraint>
            </properties>
            <defaultValue>20</defaultValue>
          </leafNode>
          <leafNode name="minimum-object-size">
            <properties>
              <help>Maximum size of object to be stored in cache in kilobytes</help>
              <valueHelp>
                <format>u32</format>
                <description>Object size in KB</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-100000"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="outgoing-address">
            <properties>
              <help>Outgoing IP address for webproxy</help>
            </properties>
          </leafNode>
          <leafNode name="reply-block-mime">
            <properties>
              <help>MIME type to block</help>
              <completionHelp>
                <list>image/gif www/mime application/macbinary application/oda application/octet-stream application/pdf application/postscript application/postscript application/postscript text/rtf application/octet-stream application/octet-stream application/x-tar application/x-csh application/x-dvi application/x-hdf application/x-latex text/plain application/x-netcdf application/x-netcdf application/x-sh application/x-tcl application/x-tex application/x-texinfo application/x-texinfo application/x-troff application/x-troff application/x-troff application/x-troff-man application/x-troff-me application/x-troff-ms application/x-wais-source application/zip application/x-bcpio application/x-cpio application/x-gtar application/x-rpm application/x-shar application/x-sv4cpio application/x-sv4crc application/x-tar application/x-ustar audio/basic audio/basic audio/mpeg audio/mpeg audio/mpeg audio/x-aiff audio/x-aiff audio/x-aiff audio/x-wav image/bmp image/ief image/jpeg image/jpeg image/jpeg image/tiff image/tiff image/x-cmu-raster image/x-portable-anymap image/x-portable-bitmap image/x-portable-graymap image/x-portable-pixmap image/x-rgb image/x-xbitmap image/x-xpixmap image/x-xwindowdump text/html text/html text/css application/x-javascript text/plain text/plain text/plain text/plain text/plain text/plain text/plain text/plain text/plain text/richtext text/tab-separated-values text/x-setext video/mpeg video/mpeg video/mpeg video/quicktime video/quicktime video/x-msvideo video/x-sgi-movie application/mac-compactpro application/mac-binhex40 application/macwriteii application/msword application/msword application/vnd.ms-excel application/vnd.ms-powerpoint application/vnd.lotus-1-2-3 application/vnd.mif application/x-stuffit application/pict application/pict application/x-arj-compressed application/x-lha-compressed application/x-lha-compressed application/x-deflate text/plain application/octet-stream application/octet-stream image/png application/octet-stream application/x-xpinstall application/octet-stream text/plain application/x-director application/x-director application/x-director image/vnd.djvu image/vnd.djvu application/octet-stream application/octet-stream application/andrew-inset x-conference/x-cooltalk model/iges model/iges audio/midi audio/midi audio/midi model/mesh model/mesh video/vnd.mpegurl chemical/x-pdb application/x-chess-pgn audio/x-realaudio audio/x-pn-realaudio audio/x-pn-realaudio text/sgml text/sgml application/x-koan application/x-koan application/x-koan application/x-koan application/smil application/smil application/octet-stream application/x-futuresplash application/x-shockwave-flash application/x-cdlink model/vrml image/vnd.wap.wbmp application/vnd.wap.wbxml application/vnd.wap.wmlc application/vnd.wap.wmlscriptc application/vnd.wap.wmlscript application/xhtml application/xhtml text/xml text/xml chemical/x-xyz text/plain</list>
              </completionHelp>
              <constraint>
                <regex>^(image/gif|www/mime|application/macbinary|application/oda|application/octet-stream|application/pdf|application/postscript|application/postscript|application/postscript|text/rtf|application/octet-stream|application/octet-stream|application/x-tar|application/x-csh|application/x-dvi|application/x-hdf|application/x-latex|text/plain|application/x-netcdf|application/x-netcdf|application/x-sh|application/x-tcl|application/x-tex|application/x-texinfo|application/x-texinfo|application/x-troff|application/x-troff|application/x-troff|application/x-troff-man|application/x-troff-me|application/x-troff-ms|application/x-wais-source|application/zip|application/x-bcpio|application/x-cpio|application/x-gtar|application/x-rpm|application/x-shar|application/x-sv4cpio|application/x-sv4crc|application/x-tar|application/x-ustar|audio/basic|audio/basic|audio/mpeg|audio/mpeg|audio/mpeg|audio/x-aiff|audio/x-aiff|audio/x-aiff|audio/x-wav|image/bmp|image/ief|image/jpeg|image/jpeg|image/jpeg|image/tiff|image/tiff|image/x-cmu-raster|image/x-portable-anymap|image/x-portable-bitmap|image/x-portable-graymap|image/x-portable-pixmap|image/x-rgb|image/x-xbitmap|image/x-xpixmap|image/x-xwindowdump|text/html|text/html|text/css|application/x-javascript|text/plain|text/plain|text/plain|text/plain|text/plain|text/plain|text/plain|text/plain|text/plain|text/richtext|text/tab-separated-values|text/x-setext|video/mpeg|video/mpeg|video/mpeg|video/quicktime|video/quicktime|video/x-msvideo|video/x-sgi-movie|application/mac-compactpro|application/mac-binhex40|application/macwriteii|application/msword|application/msword|application/vnd.ms-excel|application/vnd.ms-powerpoint|application/vnd.lotus-1-2-3|application/vnd.mif|application/x-stuffit|application/pict|application/pict|application/x-arj-compressed|application/x-lha-compressed|application/x-lha-compressed|application/x-deflate|text/plain|application/octet-stream|application/octet-stream|image/png|application/octet-stream|application/x-xpinstall|application/octet-stream|text/plain|application/x-director|application/x-director|application/x-director|image/vnd.djvu|image/vnd.djvu|application/octet-stream|application/octet-stream|application/andrew-inset|x-conference/x-cooltalk|model/iges|model/iges|audio/midi|audio/midi|audio/midi|model/mesh|model/mesh|video/vnd.mpegurl|chemical/x-pdb|application/x-chess-pgn|audio/x-realaudio|audio/x-pn-realaudio|audio/x-pn-realaudio|text/sgml|text/sgml|application/x-koan|application/x-koan|application/x-koan|application/x-koan|application/smil|application/smil|application/octet-stream|application/x-futuresplash|application/x-shockwave-flash|application/x-cdlink|model/vrml|image/vnd.wap.wbmp|application/vnd.wap.wbxml|application/vnd.wap.wmlc|application/vnd.wap.wmlscriptc|application/vnd.wap.wmlscript|application/xhtml|application/xhtml|text/xml|text/xml|chemical/x-xyz|text/plain)$</regex>
              </constraint>
              <multi/>
            </properties>
          </leafNode>
          <leafNode name="reply-body-max-size">
            <properties>
              <help>Maximum reply body size in KB</help>
              <valueHelp>
                <format>u32</format>
                <description>Reply size in KB</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-100000"/>
              </constraint>
            </properties>
          </leafNode>
          <node name="url-filtering">
            <properties>
              <help>URL filtering settings</help>
            </properties>
            <children>
              #include <include/generic-disable-node.xml.i>
              <node name="squidguard">
                <properties>
                  <help>URL filtering via squidGuard redirector</help>
                </properties>
                <children>
                  #include <include/webproxy-url-filtering.xml.i>
                  <node name="auto-update">
                    <properties>
                      <help>Auto update settings</help>
                    </properties>
                    <children>
                      <leafNode name="update-hour">
                        <properties>
                          <help>Hour of day for database update [REQUIRED]</help>
                          <valueHelp>
                            <format>u32:0-23</format>
                            <description>Hour for database update</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 0-23"/>
                          </constraint>
                        </properties>
                        <defaultValue>0</defaultValue>
                      </leafNode>
                    </children>
                  </node>
                  <leafNode name="redirect-url">
                    <properties>
                      <help>Redirect URL for filtered websites (default: block.vyos.net)</help>
                      <valueHelp>
                        <format>url</format>
                        <description>URL for redirect</description>
                      </valueHelp>
                    </properties>
                    <defaultValue>block.vyos.net</defaultValue>
                  </leafNode>
                  <tagNode name="rule">
                    <properties>
                      <help>URL filter rule for a source-group</help>
                      <valueHelp>
                        <format>u32:1-1024</format>
                        <description>Rule Number</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-1024"/>
                      </constraint>
                      <constraintErrorMessage>SquidGuard rule must between 1-1024</constraintErrorMessage>
                    </properties>
                    <children>
                      #include <include/webproxy-url-filtering.xml.i>
                      <leafNode name="redirect-url">
                        <properties>
                          <help>Redirect URL for filtered websites</help>
                          <valueHelp>
                            <format>url</format>
                            <description>URL for redirect</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                      <leafNode name="source-group">
                        <properties>
                          <help>Source-group for this rule [REQUIRED]</help>
                          <valueHelp>
                            <format>group</format>
                            <description>Source group identifier for this rule</description>
                          </valueHelp>
                          <completionHelp>
                            <path>service webproxy url-filtering squidguard source-group</path>
                          </completionHelp>
                        </properties>
                      </leafNode>
                      <leafNode name="time-period">
                        <properties>
                          <help>Time-period for this rule</help>
                          <valueHelp>
                            <format>period</format>
                            <description>Time period for this rule</description>
                          </valueHelp>
                          <completionHelp>
                            <path>service webproxy url-filtering squidguard time-period</path>
                          </completionHelp>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <tagNode name="source-group">
                    <properties>
                      <help>Source group name</help>
                      <valueHelp>
                        <format>name</format>
                        <description>Name of source group</description>
                      </valueHelp>
                      <constraint>
                        <regex>^[^0-9]</regex>
                      </constraint>
                      <constraintErrorMessage>URL-filter source-group cannot start with a number!</constraintErrorMessage>
                    </properties>
                    <children>
                      <leafNode name="address">
                        <properties>
                          <help>Address for source-group</help>
                          <valueHelp>
                            <format>ipv4</format>
                            <description>IPv4 address to match</description>
                          </valueHelp>
                          <valueHelp>
                            <format>ipv4net</format>
                            <description>IPv4 prefix to match</description>
                          </valueHelp>
                          <valueHelp>
                            <format>ipv4range</format>
                            <description>IPv4 address range to match</description>
                          </valueHelp>
                          <constraint>
                            <validator name="ipv4-address"/>
                            <validator name="ipv4-prefix"/>
                            <validator name="ipv4-range"/>
                          </constraint>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="description">
                        <properties>
                          <help>Description for source-group</help>
                        </properties>
                      </leafNode>
                      <leafNode name="domain">
                        <properties>
                          <help>Domain for source-group</help>
                          <valueHelp>
                            <format>domain</format>
                            <description>Domain name for the source-group</description>
                          </valueHelp>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="ldap-ip-search">
                        <properties>
                          <help>LDAP search expression for an IP address list</help>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="ldap-user-search">
                        <properties>
                          <help>LDAP search expression for a user group</help>
                          <multi/>
                        </properties>
                      </leafNode>
                      <leafNode name="user">
                        <properties>
                          <help>List of user names</help>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <tagNode name="time-period">
                    <properties>
                      <help>Time period name</help>
                    </properties>
                    <children>
                      <tagNode name="days">
                        <properties>
                          <help>Time-period days</help>
                          <completionHelp>
                            <list>Sun Mon Tue Wed Thu Fri Sat weekdays weekend all</list>
                          </completionHelp>
                          <valueHelp>
                            <format>Sun</format>
                            <description>Sunday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>Mon</format>
                            <description>Monday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>Tue</format>
                            <description>Tuesday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>Wed</format>
                            <description>Wednesday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>Thu</format>
                            <description>Thursday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>Fri</format>
                            <description>Friday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>Sat</format>
                            <description>Saturday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>weekdays</format>
                            <description>Monday through Friday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>weekend</format>
                            <description>Saturday and Sunday</description>
                          </valueHelp>
                          <valueHelp>
                            <format>all</format>
                            <description>All days of the week</description>
                          </valueHelp>
                          <constraint>
                            <regex>^(Sun|Mon|Tue|Wed|Thu|Fri|Sat|weekdays|weekend|all)$</regex>
                          </constraint>
                        </properties>
                        <children>
                          <leafNode name="time">
                            <properties>
                              <help>Time for time-period</help>
                              <valueHelp>
                                <format>&lt;hh:mm - hh:mm&gt;</format>
                                <description>Time range in 24hr time</description>
                              </valueHelp>
                              <constraint>
                                <!-- time range example: 12:00-13:00 -->
                                <regex>^(\d\d:\d\d)-(\d\d:\d\d)$</regex>
                              </constraint>
                              <constraintErrorMessage>Expected time format hh:mm - hh:mm in 24hr time</constraintErrorMessage>
                            </properties>
                          </leafNode>
                        </children>
                      </tagNode>
                      <leafNode name="description">
                        <properties>
                          <help>Time-period description</help>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                </children>
              </node>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>