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
|
#!/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 jmespath
import json
import sys
import typing
from tabulate import tabulate
from vyos.configquery import ConfigTreeQuery
from vyos.util import cmd
from vyos.util import dict_search
import vyos.opmode
unconf_message = 'LLDP is not configured'
capability_codes = """Capability Codes: R - Router, B - Bridge, W - Wlan r - Repeater, S - Station
D - Docsis, T - Telephone, O - Other
"""
def _verify(func):
"""Decorator checks if LLDP config exists"""
from functools import wraps
@wraps(func)
def _wrapper(*args, **kwargs):
config = ConfigTreeQuery()
if not config.exists(['service', 'lldp']):
raise vyos.opmode.UnconfiguredSubsystem(unconf_message)
return func(*args, **kwargs)
return _wrapper
def _get_raw_data(interface=None, detail=False):
"""
If interface name is not set - get all interfaces
"""
tmp = 'lldpcli -f json show neighbors'
if detail:
tmp += f' details'
if interface:
tmp += f' ports {interface}'
output = cmd(tmp)
data = json.loads(output)
if not data:
return []
return data
def _get_formatted_output(raw_data):
data_entries = []
tmp = dict_search('lldp.interface', raw_data)
if not tmp:
return None
for neighbor in dict_search('lldp.interface', raw_data):
for local_if, values in neighbor.items():
tmp = []
# Device field
if 'chassis' in values:
tmp.append(next(iter(values['chassis'])))
else:
tmp.append('')
# Local Port field
tmp.append(local_if)
# Protocol field
tmp.append(values['via'])
# Capabilities
cap = ''
capabilities = jmespath.search('chassis.[*][0][0].capability', values)
# One can not always ensure that "capability" is of type list, add
# safeguard. E.G. Unify US-24-250W only has a dict, not a list of dicts
if isinstance(capabilities, dict):
capabilities = [capabilities]
if capabilities:
for capability in capabilities:
if capability['enabled']:
if capability['type'] == 'Router':
cap += 'R'
if capability['type'] == 'Bridge':
cap += 'B'
if capability['type'] == 'Wlan':
cap += 'W'
if capability['type'] == 'Station':
cap += 'S'
if capability['type'] == 'Repeater':
cap += 'r'
if capability['type'] == 'Telephone':
cap += 'T'
if capability['type'] == 'Docsis':
cap += 'D'
if capability['type'] == 'Other':
cap += 'O'
tmp.append(cap)
# Remote software platform
platform = jmespath.search('chassis.[*][0][0].descr', values)
tmp.append(platform[:37])
# Remote interface
interface = jmespath.search('port.descr', values)
if not interface:
interface = jmespath.search('port.id.value', values)
if not interface:
interface = 'Unknown'
tmp.append(interface)
# Add individual neighbor to output list
data_entries.append(tmp)
headers = ["Device", "Local Port", "Protocol", "Capability", "Platform", "Remote Port"]
output = tabulate(data_entries, headers, numalign="left")
return capability_codes + output
@_verify
def show_neighbors(raw: bool, interface: typing.Optional[str], detail: typing.Optional[bool]):
lldp_data = _get_raw_data(interface=interface, detail=detail)
if raw:
return lldp_data
else:
return _get_formatted_output(lldp_data)
if __name__ == "__main__":
try:
res = vyos.opmode.run(sys.modules[__name__])
if res:
print(res)
except (ValueError, vyos.opmode.Error) as e:
print(e)
sys.exit(1)
|
