summaryrefslogtreecommitdiff
path: root/interface-definitions/system-sflow.xml.in
blob: 335181fe1b5d5e059ccf415e6937fafb7e9d4263 (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
<?xml version="1.0" encoding="UTF-8"?>
<!-- sflow configuration -->
<interfaceDefinition>
  <node name="system">
    <children>
      <node name="sflow" owner="${vyos_conf_scripts_dir}/system_sflow.py">
        <properties>
          <help>sFlow settings</help>
          <priority>990</priority>
        </properties>
        <children>
          <leafNode name="agent-address">
            <properties>
              <help>sFlow agent IPv4 or IPv6 address</help>
              <completionHelp>
                <list>auto</list>
                <script>${vyos_completion_dir}/list_local_ips.sh --both</script>
              </completionHelp>
              <valueHelp>
                <format>ipv4</format>
                <description>sFlow IPv4 agent address</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6</format>
                <description>sFlow IPv6 agent address</description>
              </valueHelp>
              <constraint>
                <validator name="ipv4-address"/>
                <validator name="ipv6-address"/>
                <validator name="ipv6-link-local"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="agent-interface">
            <properties>
              <help>IP address associated with this interface</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces</script>
              </completionHelp>
              <valueHelp>
                <format>txt</format>
                <description>Interface name</description>
              </valueHelp>
              <constraint>
                #include <include/constraint/interface-name.xml.in>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="drop-monitor-limit">
            <properties>
              <help>Export headers of dropped by kernel packets</help>
              <valueHelp>
                <format>u32:1-65535</format>
                <description>Maximum rate limit of N drops per second send out in the sFlow datagrams</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
          </leafNode>
          #include <include/generic-interface-multi.xml.i>
          <leafNode name="polling">
            <properties>
              <help>Schedule counter-polling in seconds</help>
              <valueHelp>
                <format>u32:1-600</format>
                <description>Polling rate in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-600"/>
              </constraint>
            </properties>
            <defaultValue>30</defaultValue>
          </leafNode>
          <leafNode name="sampling-rate">
            <properties>
              <help>sFlow sampling-rate</help>
              <valueHelp>
                <format>u32:1-65535</format>
                <description>Sampling rate (1 in N packets)</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
            <defaultValue>1000</defaultValue>
          </leafNode>
          <tagNode name="server">
            <properties>
              <help>sFlow destination server</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>
              #include <include/port-number.xml.i>
              <leafNode name="port">
                <defaultValue>6343</defaultValue>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>