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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
#!/usr/bin/env python3
#
# Copyright (C) 2017-2019 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 re
import sys
import os
import jinja2
from copy import deepcopy
from vyos.config import Config
from vyos import ConfigError
# Please be careful if you edit the template.
config_file = "/etc/default/lldpd"
lldp_tmpl = """
### Autogenerated by lldp.py ###
DAEMON_ARGS="{% if snmp %}-x {% endif %}{% if addr %}-m {{ addr }} {% endif %}{% if cdp %}-c {% endif %}{% if edp %}-e {% endif %}{% if fdp %}-f {% endif %}{% if sonmp %}-s{% endif %}"
"""
default_config_data = {
"options": '',
"interface_list": '',
"location": ''
}
def get_options(config):
options = {}
config.set_level('service lldp')
options['listen_vlan'] = config.exists('listen-vlan')
options['addr'] = config.return_value('management-address')
snmp = config.exists('snmp enable')
options["snmp"] = snmp
if snmp:
config.set_level('')
options["sys_snmp"] = config.exists('service snmp')
config.set_level('service lldp')
config.set_level('service lldp legacy-protocols')
options['cdp'] = config.exists('cdp')
options['edp'] = config.exists('edp')
options['fdp'] = config.exists('fdp')
options['sonmp'] = config.exists('sonmp')
return options
def get_interface_list(config):
config.set_level('service lldp')
intfs_names = config.list_nodes('interface')
if len(intfs_names) < 0:
return 0
interface_list = []
for name in intfs_names:
config.set_level('service lldp interface {0}'.format(name))
disable = config.exists('disable')
intf = {
'name': name,
'disable': disable
}
interface_list.append(intf)
return interface_list
def get_location_intf(config, name):
path = 'service lldp interface {0}'.format(name)
config.set_level(path)
if config.exists('location'):
return 0
config.set_level('{} location'.format(path))
civic_based = {}
elin = None
coordinate_based = {}
if config.exists('civic-based'):
config.set_level('{} location civic-based'.format(path))
cc = config.return_value('country-code')
civic_based['country_code'] = cc
civic_based['ca_type'] = []
ca_types_names = config.list_nodes('ca-type')
if ca_types_names:
for ca_types_name in ca_types_names:
config.set_level('{0} location civic-based ca-type {1}'.format(path, ca_types_name))
ca_val = config.return_value('ca-value')
ca_type = {
'name': ca_types_name,
'ca_val': ca_val
}
civic_based['ca_type'].append(ca_type)
elif config.exists('elin'):
elin = config.return_value('elin')
elif config.exists('coordinate-based'):
config.set_level('{} location coordinate-based'.format(path))
coordinate_based['altitude'] = config.return_value('altitude')
coordinate_based['latitude'] = config.return_value('latitude')
coordinate_based['longitude'] = config.return_value('longitude')
coordinate_based['datum'] = config.return_value('datum')
intf = {
'name': name,
'civic_based': civic_based,
'elin': elin,
'coordinate_based': coordinate_based
}
return intf
def get_location(config):
config.set_level('service lldp')
intfs_names = config.list_nodes('interface')
if len(intfs_names) < 0:
return 0
if config.exists('disable'):
return 0
intfs_location = []
for name in intfs_names:
intf = get_location_intf(config, name)
intfs_location.append(intf)
return intfs_location
def get_config():
lldp = deepcopy(default_config_data)
conf = Config()
if not conf.exists('service lldp'):
return None
else:
lldp['options'] = get_options(conf)
lldp['interface_list'] = get_interface_list(conf)
lldp['location'] = get_location(conf)
return lldp
def verify(lldp):
# bail out early - looks like removal from running config
if lldp is None:
return
# check location
for location in lldp['location']:
# check civic-based
if len(location['civic_based']) > 0:
if len(location['coordinate_based']) > 0 or location['elin']:
raise ConfigError('Can only configure 1 location type for interface {0}'.format(location['name']))
# check country-code
if not location['civic_based']['country_code']:
raise ConfigError('Invalid location for interface {0}:\n' \
'must configure the country code'.format(location['name']))
if not re.match(r'^[a-zA-Z]{2}$', location['civic_based']['country_code']):
raise ConfigError('Invalid location for interface {0}:\n' \
'country-code must be 2 characters'.format(location['name']))
# check ca-type
if len(location['civic_based']['ca_type']) < 0:
raise ConfigError('Invalid location for interface {0}:\n' \
'must define at least 1 ca-type'.format(location['name']))
for ca_type in location['civic_based']['ca_type']:
if not int(ca_type['name']) in range(0, 129):
raise ConfigError('Invalid location for interface {0}:\n' \
'ca-type must between 0-128'.format(location['name']))
if not ca_type['ca_val']:
raise ConfigError('Invalid location for interface {0}:\n' \
'must configure the ca-value for ca-type {1}'.format(location["name"],ca_type['name']))
# check coordinate-based
elif len(location['coordinate_based']) > 0:
# check longitude and latitude
if not location['coordinate_based']['longitude']:
raise ConfigError('Must define longitude for interface {0}'.format(location['name']))
if not location['coordinate_based']['latitude']:
raise ConfigError('Must define latitude for interface {0}'.format(location['name']))
if not re.match(r'^(\d+)(\.\d+)?[nNsS]$', location['coordinate_based']['latitude']):
raise ConfigError('Invalid location for interface {0}:\n' \
'latitude should be a number followed by S or N'.format(location['name']))
if not re.match(r'^(\d+)(\.\d+)?[eEwW]$', location['coordinate_based']['longitude']):
raise ConfigError('Invalid location for interface {0}:\n' \
'longitude should be a number followed by E or W'.format(location['name']))
# check altitude and datum if exist
if location['coordinate_based']['altitude']:
if not re.match(r'^[-+0-9\.]+$', location['coordinate_based']['altitude']):
raise ConfigError('Invalid location for interface {0}:\n' \
'altitude should be a positive or negative number'.format(location['name']))
if location['coordinate_based']['datum']:
if not re.match(r'^(WGS84|NAD83|MLLW)$', location['coordinate_based']['datum']):
raise ConfigError("Invalid location for interface {0}:\n' \
'datum should be WGS84, NAD83, or MLLW".format(location['name']))
# check elin
elif location['elin']:
if not re.match(r'^[0-9]{10,25}$', location['elin']):
raise ConfigError('Invalid location for interface {0}:\n' \
'ELIN number must be between 10-25 numbers'.format(location['name']))
# check options
if lldp['options']['snmp']:
if not lldp['options']['sys_snmp']:
raise ConfigError('SNMP must be configured to enable LLDP SNMP')
def generate(lldp):
# bail out early - looks like removal from running config
if lldp is None:
return
tmpl = jinja2.Template(lldp_tmpl)
config_text = tmpl.render(lldp['options'])
with open(config_file, 'w') as f:
f.write(config_text)
def apply(lldp):
if lldp:
# start/restart lldp service
os.system('sudo systemctl restart lldpd.service')
else:
# LLDP service has been terminated
os.system('sudo systemctl stop lldpd.service')
os.unlink(config_file)
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
sys.exit(1)
|
