summaryrefslogtreecommitdiff
path: root/interface-definitions/flow-accounting-conf.xml.in
blob: 6d11c565d00bf512ce9bcced5217d0fc6e859b8c (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
<?xml version="1.0" encoding="UTF-8"?>
<!-- flow-accounting configuration -->
<interfaceDefinition>
  <node name="system">
    <children>
      <node name="flow-accounting" owner="${vyos_conf_scripts_dir}/flow_accounting_conf.py">
        <properties>
          <help>Flow accounting settings</help>
          <priority>990</priority>
        </properties>
        <children>
          <leafNode name="buffer-size">
            <properties>
              <help>Buffer size</help>
              <valueHelp>
                <format>0-4294967295</format>
                <description>Buffer size in MiB</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 0-4294967295" />
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="disable-imt">
            <properties>
              <help>Disable in memory table plugin</help>
              <valueless />
            </properties>
          </leafNode>
          <leafNode name="syslog-facility">
            <properties>
              <help>Syslog facility for flow-accounting</help>
              <completionHelp>
                <list>auth authpriv cron daemon kern lpr mail mark news protocols security syslog user uucp local0 local1 local2 local3 local4 local5 local6 local7 all</list>
              </completionHelp>
              <valueHelp>
                <format>auth</format>
                <description>Authentication and authorization</description>
              </valueHelp>
              <valueHelp>
                <format>authpriv</format>
                <description>Non-system authorization</description>
              </valueHelp>
              <valueHelp>
                <format>cron</format>
                <description>Cron daemon</description>
              </valueHelp>
              <valueHelp>
                <format>daemon</format>
                <description>System daemons</description>
              </valueHelp>
              <valueHelp>
                <format>kern</format>
                <description>Kernel</description>
              </valueHelp>
              <valueHelp>
                <format>lpr</format>
                <description>Line printer spooler</description>
              </valueHelp>
              <valueHelp>
                <format>mail</format>
                <description>Mail subsystem</description>
              </valueHelp>
              <valueHelp>
                <format>mark</format>
                <description>Timestamp</description>
              </valueHelp>
              <valueHelp>
                <format>news</format>
                <description>USENET subsystem</description>
              </valueHelp>
              <valueHelp>
                <format>protocols</format>
                <description>Routing protocols (local7)</description>
              </valueHelp>
              <valueHelp>
                <format>security</format>
                <description>Authentication and authorization</description>
              </valueHelp>
              <valueHelp>
                <format>syslog</format>
                <description>Authentication and authorization</description>
              </valueHelp>
              <valueHelp>
                <format>user</format>
                <description>Application processes</description>
              </valueHelp>
              <valueHelp>
                <format>uucp</format>
                <description>UUCP subsystem</description>
              </valueHelp>
              <valueHelp>
                <format>local0</format>
                <description>Local facility 0</description>
              </valueHelp>
              <valueHelp>
                <format>local1</format>
                <description>Local facility 1</description>
              </valueHelp>
              <valueHelp>
                <format>local2</format>
                <description>Local facility 2</description>
              </valueHelp>
              <valueHelp>
                <format>local3</format>
                <description>Local facility 3</description>
              </valueHelp>
              <valueHelp>
                <format>local4</format>
                <description>Local facility 4</description>
              </valueHelp>
              <valueHelp>
                <format>local5</format>
                <description>Local facility 5</description>
              </valueHelp>
              <valueHelp>
                <format>local6</format>
                <description>Local facility 6</description>
              </valueHelp>
              <valueHelp>
                <format>local7</format>
                <description>Local facility 7</description>
              </valueHelp>
              <valueHelp>
                <format>all</format>
                <description>Authentication and authorization</description>
              </valueHelp>
            </properties>
          </leafNode>
          <leafNode name="interface">
            <properties>
              <help>Interface for flow-accounting [REQUIRED]</help>
                <completionHelp>
                  <script>${vyos_completion_dir}/list_interfaces.py</script>
              </completionHelp>
              <multi/>
            </properties>
          </leafNode>
          <node name="netflow">
            <properties>
              <help>NetFlow settings</help>
            </properties>
            <children>
              <leafNode name="engine-id">
                <properties>
                  <help>NetFlow engine-id</help>
                  <valueHelp>
                    <format>0-255 or 0-255:0-255</format>
                    <description>NetFlow engine-id for v5</description>
                  </valueHelp>
                  <valueHelp>
                    <format>0-4294967295</format>
                    <description>NetFlow engine-id for v9 / IPFIX</description>
                  </valueHelp>
                  <constraint>
                   <regex>^(\d|[1-9]\d{1,8}|[1-3]\d{9}|4[01]\d{8}|42[0-8]\d{7}|429[0-3]\d{6}|4294[0-8]\d{5}|42949[0-5]\d{4}|429496[0-6]\d{3}|4294967[01]\d{2}|42949672[0-8]\d|429496729[0-5])$|^(\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5]):(\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])$</regex>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="max-flows">
                <properties>
                  <help>NetFlow maximum flows</help>
                  <valueHelp>
                    <format>0-4294967295</format>
                    <description>NetFlow maximum flows</description>
                  </valueHelp>
                  <constraint>
                   <validator name="numeric" argument="--range 0-4294967295" />
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="sampling-rate">
                <properties>
                  <help>NetFlow sampling-rate</help>
                  <valueHelp>
                    <format>0-4294967295</format>
                    <description>Sampling rate (1 in N packets)</description>
                  </valueHelp>
                  <constraint>
                   <validator name="numeric" argument="--range 0-4294967295" />
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="source-ip">
                <properties>
                  <help>IPv4 or IPv6 source address of NetFlow packets</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>IPv4 source address of NetFlow packets</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>IPv6 source address of NetFlow packets</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                    <validator name="ipv6-address"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="version">
                <properties>
                  <help>NetFlow version to export</help>
                  <completionHelp>
                    <list>5 9 10</list>
                  </completionHelp>
                  <valueHelp>
                    <format>5</format>
                    <description>NetFlow version 5</description>
                  </valueHelp>
                  <valueHelp>
                    <format>9</format>
                    <description>NetFlow version 9 (default)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>10</format>
                    <description>IPFIX</description>
                  </valueHelp>
                </properties>
              </leafNode>
              <tagNode name="server">
                <properties>
                  <help>Server to export NetFlow [REQUIRED]</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>IPv4 server to export NetFlow</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>IPv6 server to export NetFlow</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                    <validator name="ipv6-address"/>
                  </constraint>
                </properties>
                <children>
                  <leafNode name="port">
                    <properties>
                      <help>NetFlow port number</help>
                      <valueHelp>
                        <format>1025-65535</format>
                        <description>NetFlow port number (default 2055)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 1025-65535" />
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
              <node name="timeout">
                <properties>
                  <help>NetFlow timeout values</help>
                </properties>
                <children>
                  <leafNode name="expiry-interval">
                    <properties>
                      <help>Expiry scan interval</help>
                      <valueHelp>
                        <format>0-2147483647</format>
                        <description>Expiry scan interval (default 60)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 0-2147483647" />
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="flow-generic">
                    <properties>
                      <help>Generic flow timeout value</help>
                      <valueHelp>
                        <format>0-2147483647</format>
                        <description>Generic flow timeout in seconds (default 3600)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 0-2147483647" />
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="icmp">
                    <properties>
                      <help>ICMP timeout value</help>
                      <valueHelp>
                        <format>0-2147483647</format>
                        <description>ICMP timeout in seconds (default 300)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 0-2147483647" />
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="max-active-life">
                    <properties>
                      <help>Max active timeout value</help>
                      <valueHelp>
                        <format>0-2147483647</format>
                        <description>Max active timeout in seconds (default 604800)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 0-2147483647" />
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="tcp-fin">
                    <properties>
                      <help>TCP finish timeout value</help>
                      <valueHelp>
                        <format>0-2147483647</format>
                        <description>TCP FIN timeout in seconds (default 300)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 0-2147483647" />
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="tcp-generic">
                    <properties>
                      <help>TCP generic timeout value</help>
                      <valueHelp>
                        <format>0-2147483647</format>
                        <description>TCP generic timeout in seconds (default 3600)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 0-2147483647" />
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="tcp-rst">
                    <properties>
                      <help>TCP reset timeout value</help>
                      <valueHelp>
                        <format>0-2147483647</format>
                        <description>TCP RST timeout in seconds (default 120)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 0-2147483647" />
                      </constraint>
                    </properties>
                  </leafNode>
                  <leafNode name="udp">
                    <properties>
                      <help>UDP timeout value</help>
                      <valueHelp>
                        <format>0-2147483647</format>
                        <description>UDP timeout in seconds (default 300)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 0-2147483647" />
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </node>
          <node name="sflow">
            <properties>
              <help>sFlow settings</help>
            </properties>
            <children>
              <leafNode name="agent-address">
                <properties>
                  <help>sFlow agent IPv4 address</help>
                  <valueHelp>
                    <format>auto</format>
                    <description>auto select sFlow agent-address (default)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>sFlow IPv4 agent address</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                    <regex>^auto$</regex>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="sampling-rate">
                <properties>
                  <help>sFlow sampling-rate</help>
                  <valueHelp>
                    <format>0-4294967295</format>
                    <description>Sampling rate (1 in N packets)</description>
                  </valueHelp>
                  <constraint>
                   <validator name="numeric" argument="--range 0-4294967295" />
                  </constraint>
                </properties>
              </leafNode>
              <tagNode name="server">
                <properties>
                  <help>Server to export sFlow [REQUIRED]</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>IPv4 server to export sFlow</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>IPv6 server to export sFlow</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                    <validator name="ipv6-address"/>
                  </constraint>
                </properties>
                <children>
                  <leafNode name="port">
                    <properties>
                      <help>sFlow port number</help>
                      <valueHelp>
                        <format>1025-65535</format>
                        <description>sFlow port number (default 6343)</description>
                      </valueHelp>
                      <constraint>
                       <validator name="numeric" argument="--range 1025-65535" />
                      </constraint>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>