summaryrefslogtreecommitdiff
path: root/interface-definitions/protocols-isis.xml.in
blob: 9882311083826a76a9b8fa55975a2fe7bcec7fec (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
<?xml version="1.0"?>
<!-- Protocol IS-IS configuration -->
<interfaceDefinition>
  <node name="protocols">
    <children>
      <tagNode name="isis" owner="${vyos_conf_scripts_dir}/protocols_isis.py">
        <properties>
          <help>Intermediate System to Intermediate System (ISIS)</help>
          <valueHelp>
            <format>text(TAG)</format>
            <description>ISO Routing area tag</description>
          </valueHelp>
        </properties>
        <children>
          <node name="area-password">
            <properties>
              <help>Configure the authentication password for an area</help>
            </properties>
            <children>
              <leafNode name="plaintext-password">
                <properties>
                  <help>Plain-text authentication type</help>
                  <valueHelp>
                    <format>&lt;text&gt;</format>
                    <description>Level-wide password</description>
                  </valueHelp>
                </properties>
              </leafNode>
              <leafNode name="md5">
                <properties>
                  <help>MD5 authentication type</help>
                  <valueHelp>
                    <format>&lt;md5&gt;</format>
                    <description>Level-wide password</description>
                  </valueHelp>
                </properties>
              </leafNode>
            </children>
          </node>
          <node name="default-information">
            <properties>
              <help>Control distribution of default information</help>
            </properties>
            <children>
              <node name="originate">
                <properties>
                  <help>Distribute a default route</help>
                </properties>
                <children>
                  <node name="ipv4">
                    <properties>
                      <help>Distribute default route for IPv4</help>
                    </properties>
                    <children>
                      <leafNode name="level-1">
                        <properties>
                          <help>Distribute default route into level-1</help>
                          <valueless/>
                        </properties>
                      </leafNode>
                      <leafNode name="level-2">
                        <properties>
                          <help>Distribute default route into level-2</help>
                          <valueless/>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                  <node name="ipv6">
                    <properties>
                      <help>Distribute default route for IPv6</help>
                    </properties>
                    <children>
                      <leafNode name="level-1">
                        <properties>
                          <help>Distribute default route into level-1</help>
                          <completionHelp>
                            <list>always</list>
                          </completionHelp>
                          <valueHelp>
                            <format>always</format>
                            <description>Always advertise default route</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                      <leafNode name="level-2">
                        <properties>
                          <help>Distribute default route into level-2</help>
                          <completionHelp>
                            <list>always</list>
                          </completionHelp>
                          <valueHelp>
                            <format>always</format>
                            <description>Always advertise default route</description>
                          </valueHelp>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                </children>
              </node>
            </children>
          </node>
          <node name="domain-password">
            <properties>
              <help>Set the authentication password for a routing domain</help>
            </properties>
            <children>
              <leafNode name="plaintext-password">
                <properties>
                  <help>Plain-text authentication type</help>
                  <valueHelp>
                    <format>&lt;text&gt;</format>
                    <description>Level-wide password</description>
                  </valueHelp>
                </properties>
              </leafNode>
   <!--           <leafNode name="md5">
                <properties>
                  <help>MD5 authentication type</help>
                  <valueHelp>
                    <format>&lt;md5&gt;</format>
                    <description>Level-wide password</description>
                  </valueHelp>
                </properties>
              </leafNode>  -->
            </children>
          </node>
          <leafNode name="dynamic-hostname">
            <properties>
              <help>Dynamic hostname for IS-IS</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="level">
            <properties>
              <help>IS-IS level number</help>
              <completionHelp>
                <list>level-1 level-1-2 level-2</list>
              </completionHelp>
              <valueHelp>
                <format>level-1</format>
                <description>Act as a station router</description>
              </valueHelp>
              <valueHelp>
                <format>level-1-2</format>
                <description>Act as both a station and an area router</description>
              </valueHelp>
              <valueHelp>
                <format>level-2</format>
                <description>Act as an area router</description>
              </valueHelp>
              <constraint>
                <regex>(level-1|level-1-2|level-2)</regex>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="lsp-gen-interval">
            <properties>
              <help>Minimum interval between regenerating same LSP</help>
              <valueHelp>
                <format>&lt;1-120&gt;</format>
                <description>Minimum interval in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-120"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="lsp-mtu">
            <properties>
              <help>Configure the maximum size of generated LSPs</help>
              <valueHelp>
                <format>&lt;128-4352&gt;</format>
                <description>Maximum size of generated LSPs</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 128-4352"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="lsp-refresh-interval">
            <properties>
              <help>LSP refresh interval</help>
              <valueHelp>
                <format>&lt;1-65235&gt;</format>
                <description>LSP refresh interval in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65235"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="max-lsp-lifetime">
            <properties>
              <help>Maximum LSP lifetime</help>
              <valueHelp>
                <format>&lt;350-65535&gt;</format>
                <description>LSP lifetime in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="metric-style">
            <properties>
              <help>Use old-style (ISO 10589) or new-style packet formats</help>
              <completionHelp>
                <list>narrow transition wide</list>
              </completionHelp>
              <valueHelp>
                <format>narrow</format>
                <description>Use old style of TLVs with narrow metric</description>
              </valueHelp>
              <valueHelp>
                <format>transition</format>
                <description>Send and accept both styles of TLVs during transition</description>
              </valueHelp>
              <valueHelp>
                <format>wide</format>
                <description>Use new style of TLVs to carry wider metric</description>
              </valueHelp>
              <constraint>
                <regex>(narrow|transition|wide)</regex>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="net">
            <properties>
              <help>A Network Entity Title for this process (ISO only)</help>
              <valueHelp>
                <format>XX.XXXX. ... .XXX.XX</format>
                <description>Network entity title (NET)</description>
              </valueHelp>
              <constraint>
                <regex>[a-fA-F0-9]{2}(\.[a-fA-F0-9]{4}){3,9}\.[a-fA-F0-9]{2}</regex>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="purge-originator">
            <properties>
              <help>Use the RFC 6232 purge-originator</help>
              <valueless/>
            </properties>
          </leafNode>
          <node name="redistribute">
            <properties>
              <help>Redistribute information from another routing protocol</help>
            </properties>
            <children>
              <node name="ipv4">
                <properties>
                  <help>Redistribute IPv4 routes</help>
                </properties>
                <children>
                  <node name="bgp">
                    <properties>
                      <help>Border Gateway Protocol (BGP)</help>
                    </properties>
                    <children>
                      #include <include/isis-redistribute-ipv4.xml.i>
                    </children>
                  </node>
                  <node name="connected">
                    <properties>
                      <help>Redistribute connected routes into ISIS</help>
                    </properties>
                    <children>
                      #include <include/isis-redistribute-ipv4.xml.i>
                    </children>
                  </node>
                  <node name="kernel">
                    <properties>
                      <help>Redistribute kernel routes into ISIS</help>
                    </properties>
                    <children>
                      #include <include/isis-redistribute-ipv4.xml.i>
                    </children>
                  </node>
                  <node name="ospf">
                    <properties>
                      <help>Redistribute OSPF routes into ISIS</help>
                    </properties>
                    <children>
                      #include <include/isis-redistribute-ipv4.xml.i>
                    </children>
                  </node>
                  <node name="rip">
                    <properties>
                      <help>Redistribute RIP routes into ISIS</help>
                    </properties>
                    <children>
                      #include <include/isis-redistribute-ipv4.xml.i>
                    </children>
                  </node>
                  <node name="static">
                    <properties>
                      <help>Redistribute static routes into ISIS</help>
                    </properties>
                    <children>
                      #include <include/isis-redistribute-ipv4.xml.i>
                    </children>
                  </node>
                </children>
              </node>
            </children>
          </node>
          <leafNode name="set-attached-bit">
            <properties>
              <help>Set attached bit to identify as L1/L2 router for inter-area traffic</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="set-overload-bit">
            <properties>
              <help>Set overload bit to avoid any transit traffic</help>
              <valueless/>
            </properties>
          </leafNode>
          <node name="spf-delay-ietf">
            <properties>
              <help>IETF SPF delay algorithm</help>
            </properties>
            <children>
              <leafNode name="init-delay">
                <properties>
                  <help>Delay used while in QUIET state</help>
                  <valueHelp>
                    <format>&lt;0-60000&gt;</format>
                    <description>Delay used while in QUIET state (in ms)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-60000"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="short-delay">
                <properties>
                  <help>Delay used while in SHORT_WAIT state</help>
                  <valueHelp>
                    <format>&lt;0-60000&gt;</format>
                    <description>Delay used while in SHORT_WAIT state (in ms)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-60000"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="long-delay">
                <properties>
                  <help>Delay used while in LONG_WAIT</help>
                  <valueHelp>
                    <format>&lt;0-60000&gt;</format>
                    <description>Delay used while in LONG_WAIT state (in ms)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-60000"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="holddown">
                <properties>
                  <help>Time with no received IGP events before considering IGP stable</help>
                  <valueHelp>
                    <format>&lt;0-60000&gt;</format>
                    <description>Time with no received IGP events before considering IGP stable (in ms)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-60000"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="time-to-learn">
                <properties>
                  <help>Maximum duration needed to learn all the events related to a single failure</help>
                  <valueHelp>
                    <format>&lt;0-60000&gt;</format>
                    <description>Maximum duration needed to learn all the events related to a single failure (in ms)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-60000"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="spf-interval">
            <properties>
              <help>Minimum interval between SPF calculations</help>
              <valueHelp>
                <format>&lt;1-120&gt;</format>
                <description>Minimum interval between consecutive SPFs in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-120"/>
              </constraint>
            </properties>
          </leafNode>
          <tagNode name="interface">
            <!-- (config-if)# ip router isis WORD (same as name of IS-IS process)
                  if any section of "interface" pesent  -->
            <properties>
              <help>Interface params</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces.py</script>
              </completionHelp>
            </properties>
            <children>
              <leafNode name="bfd">
                <properties>
                  <help>Enable BFD support</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="circuit-type">
                <properties>
                  <help>Configure circuit type for interface</help>
                  <completionHelp>
                    <list>level-1 level-1-2 level-2-only</list>
                  </completionHelp>
                  <valueHelp>
                    <format>level-1</format>
                    <description>Level-1 only adjacencies are formed</description>
                  </valueHelp>
                  <valueHelp>
                    <format>level-1-2</format>
                    <description>Level-1-2 adjacencies are formed</description>
                  </valueHelp>
                  <valueHelp>
                    <format>level-2-only</format>
                    <description>Level-2 only adjacencies are formed</description>
                  </valueHelp>
                  <constraint>
                    <regex>(level-1|level-1-2|level-2-only)</regex>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="hello-padding">
                <properties>
                  <help>Add padding to IS-IS hello packets</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="hello-interval">
                <properties>
                  <help>Set Hello interval</help>
                  <valueHelp>
                    <format>&lt;1-600&gt;</format>
                    <description>Set Hello interval</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-600"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="hello-multiplier">
                <properties>
                  <help>Set Hello interval</help>
                  <valueHelp>
                    <format>&lt;2-100&gt;</format>
                    <description>Set multiplier for Hello holding time</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 2-100"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="metric">
                <properties>
                  <help>Set default metric for circuit</help>
                  <valueHelp>
                    <format>&lt;0-16777215&gt;</format>
                    <description>Default metric value</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-16777215"/>
                  </constraint>
                </properties>
              </leafNode>
              <node name="network">
                <properties>
                  <help>Set network type</help>
                </properties>
                <children>
                  <leafNode name="point-to-point">
                    <properties>
                      <help>point-to-point network type</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="passive">
                <properties>
                  <help>Configure the passive mode for interface</help>
                  <valueless/>
                </properties>
              </leafNode>
              <node name="password">
                <properties>
                  <help>Configure the authentication password for a circuit</help>
                </properties>
                <children>
                  <leafNode name="plaintext-password">
                    <properties>
                      <help>Plain-text authentication type</help>
                      <valueHelp>
                        <format>&lt;text&gt;</format>
                        <description>Circuit password</description>
                      </valueHelp>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="priority">
                <properties>
                  <help>Set priority for Designated Router election</help>
                  <valueHelp>
                    <format>&lt;0-127&gt;</format>
                    <description>Priority value</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-127"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="psnp-interval">
                <properties>
                  <help>Set PSNP interval in seconds</help>
                  <valueHelp>
                    <format>&lt;0-127&gt;</format>
                    <description>Priority value</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-127"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="three-way-handshake">
                <properties>
                  <help>Enable/Disable three-way handshake</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>