summaryrefslogtreecommitdiff
path: root/src/conf_mode/vpp_sflow.py
blob: de592f514d539109b855d1c2206961cdda9f256c (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
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
#!/usr/bin/env python3
#
# Copyright VyOS maintainers and contributors <maintainers@vyos.io>
#
# 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 vyos import ConfigError
from vyos.config import Config
from vyos.vpp.utils import cli_ifaces_list
from vyos.vpp.sflow import SFlow
from vyos.vpp.config_verify import verify_vpp_interface_not_a_member


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

    base = ['vpp', 'sflow']

    # Get config_dict with default values
    config = conf.get_config_dict(
        base,
        key_mangling=('-', '_'),
        get_first_key=True,
        no_tag_node_value_mangle=True,
        with_defaults=True,
        with_recursive_defaults=True,
    )

    # Get effective config as we need full dictionary for deletion
    effective_config = conf.get_config_dict(
        base,
        key_mangling=('-', '_'),
        effective=True,
        get_first_key=True,
        no_tag_node_value_mangle=True,
    )

    # Get system sflow configuration to check for server
    system_sflow = conf.get_config_dict(
        ['system', 'sflow'],
        key_mangling=('-', '_'),
        get_first_key=True,
        no_tag_node_value_mangle=True,
        with_recursive_defaults=True,
    )

    if system_sflow:
        config['system_sflow'] = system_sflow

    if effective_config:
        config.update({'effective': effective_config})

    if not conf.exists(base):
        config['remove'] = True
        return config

    # Add list of VPP interfaces to the config
    config.update({'vpp_ifaces': cli_ifaces_list(conf)})

    # VPP interface membership data for member-conflict checks
    config['interfaces_vpp'] = conf.get_config_dict(
        ['interfaces', 'vpp'],
        key_mangling=('-', '_'),
        get_first_key=True,
        no_tag_node_value_mangle=True,
    )

    return config


def verify(config):
    if 'remove' in config:
        return None

    # Check if interface section exists
    if 'interface' not in config:
        raise ConfigError('Interfaces must be configured for sFlow')

    # Verify that all interfaces specified exist in VPP
    for interface in config['interface']:
        if interface not in config['vpp_ifaces']:
            raise ConfigError(
                f'{interface} must be a VPP interface for sFlow monitoring'
            )
        verify_vpp_interface_not_a_member(interface, config)

    # Verify that system sflow has enable-vpp defined
    if 'system_sflow' not in config or 'vpp' not in config.get('system_sflow', {}):
        raise ConfigError(
            '"sflow vpp" must be defined under system sflow configuration'
        )


def generate(config):
    # No templates to render for sFlow
    pass


def apply(config):
    s = SFlow()

    # Disable sFlow on deleted interface
    for interface in config.get('effective', {}).get('interface', []):
        if interface not in config.get('interface', []):
            s.disable_sflow(interface)

    if 'remove' in config:
        return None

    # Configure sample rate
    if 'sampling_rate' in config.get('system_sflow', {}):
        s.set_sampling_rate(int(config['system_sflow']['sampling_rate']))

    # Configure polling interval
    if 'polling' in config.get('system_sflow', {}):
        s.set_polling_interval(int(config['system_sflow']['polling']))

    # Configure header bytes
    if 'header_bytes' in config:
        s.set_header_bytes(int(config['header_bytes']))

    # Configure interfaces
    for interface in config.get('interface', []):
        s.enable_sflow(interface)


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