summaryrefslogtreecommitdiff
path: root/src/conf_mode/system_frr.py
blob: d8224b3c36166623ee9734561b91838b3be3a6bb (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
#!/usr/bin/env python3
#
# Copyright (C) 2021-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/>.

from pathlib import Path
from sys import exit

from vyos import ConfigError
from vyos import airbag
from vyos.config import Config
from vyos.logger import syslog
from vyos.template import render_to_string
from vyos.utils.boot import boot_configuration_complete
from vyos.utils.file import read_file
from vyos.utils.file import write_file
from vyos.utils.process import call
airbag.enable()

# path to daemons config and config status files
config_file = '/etc/frr/daemons'

def get_config(config=None):
    if config:
        conf = config
    else:
        conf = Config()

    base = ['system', 'frr']
    frr_config = conf.get_config_dict(base, get_first_key=True)

    return frr_config

def verify(frr_config):
    # Nothing to verify here
    pass

def generate(frr_config):
    # read daemons config file
    daemons_config_current = read_file(config_file)
    # generate new config file
    daemons_config_new = render_to_string('frr/daemons.frr.tmpl', frr_config)
    # update configuration file if this is necessary
    if daemons_config_new != daemons_config_current:
        syslog.warning('FRR daemons configuration file need to be changed')
        write_file(config_file, daemons_config_new)
        frr_config['config_file_changed'] = True

def apply(frr_config):
    # display warning to user
    if boot_configuration_complete() and frr_config.get('config_file_changed'):
        # Since FRR restart is not safe thing, better to give
        # control over this to users
        print('''
        You need to reboot a router (preferred) or restart FRR
        to apply changes in modules settings
        ''')

    # restart FRR automatically
    # During initial boot this should be safe in most cases
    if not boot_configuration_complete() and frr_config.get('config_file_changed'):
        syslog.warning('Restarting FRR to apply changes in modules')
        call(f'systemctl restart frr.service')

if __name__ == '__main__':
    try:
        c = get_config()
        verify(c)
        generate(c)
        apply(c)
    except ConfigError as e:
        print(e)
        exit(1)