summaryrefslogtreecommitdiff
path: root/src/op_mode/vrf.py
blob: a9a416761cba9a520dfb0034cee68ca934f79894 (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
85
86
87
88
89
90
91
92
93
94
95
#!/usr/bin/env python3
#
# Copyright (C) 2022 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 json
import jmespath
import sys
import typing

from tabulate import tabulate
from vyos.util import cmd

import vyos.opmode


def _get_raw_data(name=None):
    """
    If vrf name is not set - get all VRFs
    If vrf name is set - get only this name data
    If vrf name set and not found - return []
    """
    output = cmd('ip --json --brief link show type vrf')
    data = json.loads(output)
    if not data:
        return []
    if name:
        is_vrf_exists = True if [vrf for vrf in data if vrf.get('ifname') == name] else False
        if is_vrf_exists:
            output = cmd(f'ip --json --brief link show dev {name}')
            data = json.loads(output)
            return data
        return []
    return data


def _get_vrf_members(vrf: str) -> list:
    """
    Get list of interface VRF members
    :param vrf: str
    :return: list
    """
    output = cmd(f'ip --json --brief link show master {vrf}')
    answer = json.loads(output)
    interfaces = []
    for data in answer:
        if 'ifname' in data:
            interfaces.append(data.get('ifname'))
    return interfaces if len(interfaces) > 0 else ['n/a']


def _get_formatted_output(raw_data):
    data_entries = []
    for vrf in raw_data:
        name = vrf.get('ifname')
        state = vrf.get('operstate').lower()
        hw_address = vrf.get('address')
        flags = ','.join(vrf.get('flags')).lower()
        members = ','.join(_get_vrf_members(name))
        data_entries.append([name, state, hw_address, flags, members])

    headers = ["Name", "State", "MAC address", "Flags", "Interfaces"]
    output = tabulate(data_entries, headers, numalign="left")
    return output


def show(raw: bool, name: typing.Optional[str]):
    vrf_data = _get_raw_data(name=name)
    if not jmespath.search('[*].ifname', vrf_data):
        return "VRF is not configured"
    if raw:
        return vrf_data
    else:
        return _get_formatted_output(vrf_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)