diff --git a/interface-definitions/service-monitoring-zabbix-agent.xml.in b/interface-definitions/service-monitoring-zabbix-agent.xml.in
new file mode 100644
index 000000000..cfeb02ce0
--- /dev/null
+++ b/interface-definitions/service-monitoring-zabbix-agent.xml.in
@@ -0,0 +1,184 @@
+<?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>
+ <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>
diff --git a/interface-definitions/service-zabbix-agent.xml.in b/interface-definitions/service-zabbix-agent.xml.in
deleted file mode 100644
index 1f93790f5..000000000
--- a/interface-definitions/service-zabbix-agent.xml.in
+++ /dev/null
@@ -1,181 +0,0 @@
-<?xml version="1.0"?>
-<interfaceDefinition>
- <node name="service">
- <children>
- <node name="zabbix-agent" owner="${vyos_conf_scripts_dir}/service_zabbix_agent.py">
- <properties>
- <help>Zabbix-agent settings</help>
- <priority>380</priority>
- </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>
- <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>
-</interfaceDefinition>
diff --git a/smoketest/scripts/cli/test_service_zabbix-agent.py b/smoketest/scripts/cli/test_service_monitoring_zabbix-agent.py
similarity index 98%
rename from smoketest/scripts/cli/test_service_zabbix-agent.py
rename to smoketest/scripts/cli/test_service_monitoring_zabbix-agent.py
index 2a125bec6..7cc661688 100755
--- a/smoketest/scripts/cli/test_service_zabbix-agent.py
+++ b/smoketest/scripts/cli/test_service_monitoring_zabbix-agent.py
@@ -1,86 +1,86 @@
#!/usr/bin/env python3
#
# Copyright (C) 2023 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import unittest
from base_vyostest_shim import VyOSUnitTestSHIM
from vyos.configsession import ConfigSessionError
from vyos.utils.process import process_named_running
from vyos.utils.file import read_file
PROCESS_NAME = 'zabbix_agent2'
ZABBIX_AGENT_CONF = '/run/zabbix/zabbix-agent2.conf'
-base_path = ['service', 'zabbix-agent']
+base_path = ['service', 'monitoring', 'zabbix-agent']
class TestZabbixAgent(VyOSUnitTestSHIM.TestCase):
def tearDown(self):
# Check for running process
self.assertTrue(process_named_running(PROCESS_NAME))
self.cli_delete(base_path)
self.cli_commit()
# Process must be terminated after deleting the config
self.assertFalse(process_named_running(PROCESS_NAME))
def test_01_zabbix_agent(self):
directory = '/tmp'
buffer_send = '8'
buffer_size = '120'
log_level = {'warning': '3'}
log_size = '1'
servers = ['192.0.2.1', '2001:db8::1']
servers_active = {'192.0.2.5': {'port': '10051'}, '2001:db8::123': {'port': '10052'}}
port = '10050'
timeout = '5'
listen_ip = '0.0.0.0'
self.cli_set(base_path + ['directory', directory])
self.cli_set(base_path + ['limits', 'buffer-flush-interval', buffer_send])
self.cli_set(base_path + ['limits', 'buffer-size', buffer_size])
self.cli_set(base_path + ['log', 'debug-level', next(iter(log_level))])
self.cli_set(base_path + ['log', 'size', log_size])
for server in servers:
self.cli_set(base_path + ['server', server])
for server_active, server_config in servers_active.items():
self.cli_set(base_path + ['server-active', server_active, 'port', server_config['port']])
self.cli_set(base_path + ['timeout', timeout])
# commit changes
self.cli_commit()
config = read_file(ZABBIX_AGENT_CONF)
self.assertIn(f'LogFileSize={log_size}', config)
self.assertIn(f'DebugLevel={log_level.get("warning")}', config)
self.assertIn(f'Server={",".join(sorted(servers))}', config)
tmp = 'ServerActive=192.0.2.5:10051,[2001:db8::123]:10052'
self.assertIn(tmp, config)
self.assertIn(f'ListenPort={port}', config)
self.assertIn(f'ListenIP={listen_ip}', config)
self.assertIn(f'BufferSend={buffer_send}', config)
self.assertIn(f'BufferSize={buffer_size}', config)
self.assertIn(f'Include={directory}/*.conf', config)
self.assertIn(f'Timeout={timeout}', config)
if __name__ == '__main__':
unittest.main(verbosity=2)
diff --git a/src/conf_mode/service_zabbix_agent.py b/src/conf_mode/service_monitoring_zabbix-agent.py
similarity index 98%
rename from src/conf_mode/service_zabbix_agent.py
rename to src/conf_mode/service_monitoring_zabbix-agent.py
index 47de8f2ec..98d8a32ca 100755
--- a/src/conf_mode/service_zabbix_agent.py
+++ b/src/conf_mode/service_monitoring_zabbix-agent.py
@@ -1,98 +1,98 @@
#!/usr/bin/env python3
#
# Copyright (C) 2023 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
from vyos.config import Config
from vyos.template import render
from vyos.utils.process import call
from vyos import ConfigError
from vyos import airbag
airbag.enable()
service_name = 'zabbix-agent2'
service_conf = f'/run/zabbix/{service_name}.conf'
systemd_override = r'/run/systemd/system/zabbix-agent2.service.d/10-override.conf'
def get_config(config=None):
if config:
conf = config
else:
conf = Config()
- base = ['service', 'zabbix-agent']
+ base = ['service', 'monitoring', 'zabbix-agent']
if not conf.exists(base):
return None
config = conf.get_config_dict(base, key_mangling=('-', '_'),
get_first_key=True,
no_tag_node_value_mangle=True,
with_recursive_defaults=True)
# Cut the / from the end, /tmp/ => /tmp
if 'directory' in config and config['directory'].endswith('/'):
config['directory'] = config['directory'][:-1]
return config
def verify(config):
# bail out early - looks like removal from running config
if config is None:
return
if 'server' not in config:
raise ConfigError('Server is required!')
def generate(config):
# bail out early - looks like removal from running config
if config is None:
# Remove old config and return
config_files = [service_conf, systemd_override]
for file in config_files:
if os.path.isfile(file):
os.unlink(file)
return None
# Write configuration file
render(service_conf, 'zabbix-agent/zabbix-agent.conf.j2', config)
render(systemd_override, 'zabbix-agent/10-override.conf.j2', config)
return None
def apply(config):
call('systemctl daemon-reload')
if config:
call(f'systemctl restart {service_name}.service')
else:
call(f'systemctl stop {service_name}.service')
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
exit(1)