summaryrefslogtreecommitdiff
path: root/src/conf_mode/interface-dummy.py
blob: d8a36a5b2ac9ff3e6b5ae256dbbeb918ca485879 (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
#!/usr/bin/env python3
#
# Copyright (C) 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/>.
#
#

from os import environ
from copy import deepcopy
from sys import exit
from pyroute2 import IPDB
from vyos.config import Config
from vyos import ConfigError

default_config_data = {
    'address': [],
    'address_remove': [],
    'deleted': False,
    'description': '',
    'disable': False,
    'intf': ''
}

def diff(first, second):
    second = set(second)
    return [item for item in first if item not in second]

def get_config():
    dummy = deepcopy(default_config_data)
    conf = Config()

    # determine tagNode instance
    try:
        dummy['intf'] = environ['VYOS_TAGNODE_VALUE']
    except KeyError as E:
        print("Interface not specified")

    # Check if interface has been removed
    if not conf.exists('interfaces dummy ' + dummy['intf']):
        dummy['deleted'] = True
        return dummy

    # set new configuration level
    conf.set_level('interfaces dummy ' + dummy['intf'])

    # retrieve configured interface addresses
    if conf.exists('address'):
        dummy['address'] = conf.return_values('address')

    # retrieve interface description
    if conf.exists('description'):
        dummy['description'] = conf.return_value('description')
    else:
        dummy['description'] = dummy['intf']

    # Disable this interface
    if conf.exists('disable'):
        dummy['disable'] = True

    # Determine interface addresses (currently effective) - to determine which
    # address is no longer valid and needs to be removed from the interface
    eff_addr = conf.return_effective_values('address')
    act_addr = conf.return_values('address')
    dummy['address_remove'] = diff(eff_addr, act_addr)

    return dummy

def verify(dummy):
    return None

def generate(dummy):
    return None

def apply(dummy):
    ipdb = IPDB(mode='explicit')
    dummyif = dummy['intf']

    # Remove dummy interface
    if dummy['deleted']:
        try:
            # delete dummy interface
            with ipdb.interface[ dummyif ] as du:
                du.remove()
        except:
            pass
    else:
        try:
            # create dummy interface if it's non existing
            ipdb.create(kind='dummy', ifname=dummyif).commit()
        except:
            pass

        # retrieve handle to dummy interface
        du = ipdb.interfaces[dummyif]
        # begin a transaction prior to make any change
        du.begin()
        # enable interface
        du.up()
        # update interface description used e.g. within SNMP
        du.ifalias = dummy['description']

        # Configure interface address(es)
        for addr in dummy['address_remove']:
            du.del_ip(addr)
        for addr in dummy['address']:
            du.add_ip(addr)

        # disable interface on demand
        if dummy['disable']:
            du.down()

        # commit changes on bridge interface
        du.commit()

    return None

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