Page MenuHomeVyOS Platform
Files F118309838

load-balancing_wan.py
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

load-balancing_wan.py
View Options

#!/usr/bin/env python3
#
# Copyright (C) 2023-2025 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/>.
from sys import exit
from vyos.config import Config
from vyos.configdep import set_dependents, call_dependents
from vyos.utils.process import cmd
from vyos import ConfigError
from vyos import airbag
airbag.enable()
service = 'vyos-wan-load-balance.service'
def get_config(config=None):
if config:
conf = config
else:
conf = Config()
base = ['load-balancing', 'wan']
lb = conf.get_config_dict(base, key_mangling=('-', '_'),
no_tag_node_value_mangle=True,
get_first_key=True,
with_recursive_defaults=True)
# prune limit key if not set by user
for rule in lb.get('rule', []):
if lb.from_defaults(['rule', rule, 'limit']):
del lb['rule'][rule]['limit']
set_dependents('conntrack', conf)
return lb
def verify(lb):
if not lb:
return None
if 'interface_health' in lb:
for ifname, health_conf in lb['interface_health'].items():
if 'nexthop' not in health_conf:
raise ConfigError(f'Nexthop must be configured for interface {ifname}')
if 'test' not in health_conf:
continue
for test_id, test_conf in health_conf['test'].items():
if 'type' not in test_conf:
raise ConfigError(f'No type configured for health test on interface {ifname}')
if test_conf['type'] == 'user-defined' and 'test_script' not in test_conf:
raise ConfigError(f'Missing user-defined script for health test on interface {ifname}')
else:
raise ConfigError('Interface health tests must be configured')
if 'rule' in lb:
for rule_id, rule_conf in lb['rule'].items():
if 'interface' not in rule_conf and 'exclude' not in rule_conf:
raise ConfigError(f'Interface or exclude not specified on load-balancing wan rule {rule_id}')
if 'failover' in rule_conf and 'exclude' in rule_conf:
raise ConfigError(f'Failover cannot be configured with exclude on load-balancing wan rule {rule_id}')
if 'limit' in rule_conf:
if 'exclude' in rule_conf:
raise ConfigError(f'Limit cannot be configured with exclude on load-balancing wan rule {rule_id}')
if 'rate' in rule_conf['limit'] and 'period' not in rule_conf['limit']:
raise ConfigError(f'Missing "limit period" on load-balancing wan rule {rule_id}')
if 'period' in rule_conf['limit'] and 'rate' not in rule_conf['limit']:
raise ConfigError(f'Missing "limit rate" on load-balancing wan rule {rule_id}')
for direction in ['source', 'destination']:
if direction in rule_conf:
if 'port' in rule_conf[direction]:
if 'protocol' not in rule_conf:
raise ConfigError(f'Protocol required to specify port on load-balancing wan rule {rule_id}')
if rule_conf['protocol'] not in ['tcp', 'udp', 'tcp_udp']:
raise ConfigError(f'Protocol must be tcp, udp or tcp_udp to specify port on load-balancing wan rule {rule_id}')
def generate(lb):
return None
def apply(lb):
if not lb:
cmd(f'sudo systemctl stop {service}')
else:
cmd(f'sudo systemctl restart {service}')
call_dependents()
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
exit(1)

File Metadata

Mime Type
text/x-script.python
Expires
Sat, Oct 17, 12:52 AM (1 d, 19 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
4377827
Default Alt Text
load-balancing_wan.py (4 KB)

Event Timeline