summaryrefslogtreecommitdiff
path: root/interface-definitions/service-monitoring-zabbix-agent.xml.in
blob: 40f2df642c4c9b0f623613a86330df414d81b7dd (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="monitoring">
        <children>
          <node name="zabbix-agent" owner="${vyos_conf_scripts_dir}/service_monitoring_zabbix-agent.py">
            <properties>
              <help>Zabbix-agent settings</help>
            </properties>
            <children>
              <leafNode name="directory">
                <properties>
                  <help>Folder containing individual Zabbix-agent configuration files</help>
                  <constraint>
                    <validator name="file-path" argument="--directory"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="host-name">
                <properties>
                  <help>Zabbix agent hostname</help>
                  <constraint>
                    #include <include/constraint/host-name.xml.i>
                  </constraint>
                  <constraintErrorMessage>Host-name must be alphanumeric and can contain hyphens</constraintErrorMessage>
                </properties>
              </leafNode>
              <node name="limits">
                <properties>
                  <help>Limit settings</help>
                </properties>
                <children>
                  <leafNode name="buffer-flush-interval">
                    <properties>
                      <help>Do not keep data longer than N seconds in buffer</help>
                      <valueHelp>
                        <format>u32:1-3600</format>
                        <description>Seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-3600"/>
                      </constraint>
                      <constraintErrorMessage>buffer-flush-interval must be between 1 and 3600 seconds</constraintErrorMessage>
                    </properties>
                    <defaultValue>5</defaultValue>
                  </leafNode>
                  <leafNode name="buffer-size">
                    <properties>
                      <help>Maximum number of values in a memory buffer</help>
                      <valueHelp>
                        <format>u32:2-65535</format>
                        <description>Maximum number of values in a memory buffer</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 2-65535"/>
                      </constraint>
                      <constraintErrorMessage>Buffer-size must be between 2 and 65535</constraintErrorMessage>
                    </properties>
                    <defaultValue>100</defaultValue>
                  </leafNode>
                </children>
              </node>
              <node name="log">
                <properties>
                  <help>Log settings</help>
                </properties>
                <children>
                  <leafNode name="debug-level">
                    <properties>
                      <help>Debug level</help>
                      <completionHelp>
                        <list>basic critical error warning debug extended-debug</list>
                      </completionHelp>
                      <valueHelp>
                        <format>basic</format>
                        <description>Basic information</description>
                      </valueHelp>
                      <valueHelp>
                        <format>critical</format>
                        <description>Critical information</description>
                      </valueHelp>
                      <valueHelp>
                        <format>error</format>
                        <description>Error information</description>
                      </valueHelp>
                      <valueHelp>
                        <format>warning</format>
                        <description>Warnings</description>
                      </valueHelp>
                      <valueHelp>
                        <format>debug</format>
                        <description>Debug information</description>
                      </valueHelp>
                      <valueHelp>
                        <format>extended-debug</format>
                        <description>Extended debug information</description>
                      </valueHelp>
                      <constraint>
                        <regex>(basic|critical|error|warning|debug|extended-debug)</regex>
                      </constraint>
                    </properties>
                    <defaultValue>warning</defaultValue>
                  </leafNode>
                  <leafNode name="remote-commands">
                    <properties>
                      <help>Enable logging of executed shell commands as warnings</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="size">
                    <properties>
                      <help>Log file size in megabytes</help>
                      <valueHelp>
                        <format>u32:0-1024</format>
                        <description>Megabytes</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-1024"/>
                      </constraint>
                      <constraintErrorMessage>Size must be between 0 and 1024 Megabytes</constraintErrorMessage>
                    </properties>
                    <defaultValue>0</defaultValue>
                  </leafNode>
                </children>
              </node>
              #include <include/listen-address.xml.i>
              <leafNode name="listen-address">
                <defaultValue>0.0.0.0</defaultValue>
              </leafNode>
              #include <include/port-number.xml.i>
              <leafNode name="port">
                <defaultValue>10050</defaultValue>
              </leafNode>
              <leafNode name="server">
                <properties>
                  <help>Remote server to connect to</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>Server IPv4 address</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>Server IPv6 address</description>
                  </valueHelp>
                  <valueHelp>
                    <format>hostname</format>
                    <description>Server hostname/FQDN</description>
                  </valueHelp>
                  <multi/>
                </properties>
              </leafNode>
              <tagNode name="server-active">
                <properties>
                  <help>Remote server address to get active checks from</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>Server IPv4 address</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>Server IPv6 address</description>
                  </valueHelp>
                  <valueHelp>
                    <format>hostname</format>
                    <description>Server hostname/FQDN</description>
                  </valueHelp>
                </properties>
                <children>
                  #include <include/port-number.xml.i>
                </children>
              </tagNode>
              <leafNode name="timeout">
                <properties>
                  <help>Item processing timeout in seconds</help>
                  <valueHelp>
                    <format>u32:1-30</format>
                    <description>Item processing timeout</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-30"/>
                  </constraint>
                  <constraintErrorMessage>Timeout must be between 1 and 30 seconds</constraintErrorMessage>
                </properties>
                <defaultValue>3</defaultValue>
              </leafNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>