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
|
# Copyright 2023-2024 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library. If not, see <http://www.gnu.org/licenses/>.
# syslog: migrate deprecated CLI options
# - protocols -> local7
# - security -> auth
from vyos.configtree import ConfigTree
base = ['system', 'syslog']
def rename_facilities(config, base_tree, facility, facility_new) -> None:
if config.exists(base + [base_tree, 'facility', facility]):
# do not overwrite already existing replacement facility
if not config.exists(base + [base_tree, 'facility', facility_new]):
config.rename(base + [base_tree, 'facility', facility], facility_new)
else:
# delete old duplicate facility config
config.delete(base + [base_tree, 'facility', facility])
def migrate(config: ConfigTree) -> None:
if not config.exists(base):
return
#
# Rename protocols and securityy facility to common ones
#
replace = {
'protocols' : 'local7',
'security' : 'auth'
}
for facility, facility_new in replace.items():
rename_facilities(config, 'console', facility, facility_new)
rename_facilities(config, 'global', facility, facility_new)
if config.exists(base + ['host']):
for host in config.list_nodes(base + ['host']):
rename_facilities(config, f'host {host}', facility, facility_new)
#
# It makes no sense to configure udp/tcp transport per individual facility
#
if config.exists(base + ['host']):
for host in config.list_nodes(base + ['host']):
protocol = None
for facility in config.list_nodes(base + ['host', host, 'facility']):
tmp_path = base + ['host', host, 'facility', facility, 'protocol']
if config.exists(tmp_path):
# We can only change the first one
if protocol == None:
protocol = config.return_value(tmp_path)
config.set(base + ['host', host, 'protocol'], value=protocol)
config.delete(tmp_path)
|