summaryrefslogtreecommitdiff
path: root/cloudinit/sources/helpers/vmware/imc/config_nic.py
blob: d79e69366c4fa9272f5af07f071eecd7dcf2308c (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
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
# vi: ts=4 expandtab
#
#    Copyright (C) 2015 Canonical Ltd.
#    Copyright (C) 2016 VMware INC.
#
#    Author: Sankar Tanguturi <stanguturi@vmware.com>
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License version 3, 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 logging
import os
import subprocess
import re

logger = logging.getLogger(__name__)


class NicConfigurator:
    def __init__(self, nics):
        """
        Initialize the Nic Configurator
        @param nics (list) an array of nics to configure
        """
        self.nics = nics
        self.mac2Name = {}
        self.ipv4PrimaryGateway = None
        self.ipv6PrimaryGateway = None
        self.find_devices()
        self._primaryNic = self.get_primary_nic()

    def get_primary_nic(self):
        """
        Retrieve the primary nic if it exists
        @return (NicBase): the primary nic if exists, None otherwise
        """
        primaryNic = None

        for nic in self.nics:
            if nic.primary:
                if primaryNic:
                    raise Exception('There can only be one primary nic',
                                    primaryNic.mac, nic.mac)
            primaryNic = nic

        return primaryNic

    def find_devices(self):
        """
        Create the mac2Name dictionary
        The mac address(es) are in the lower case
        """
        cmd = 'ip addr show'
        outText = subprocess.check_output(cmd, shell=True).decode()
        sections = re.split(r'\n\d+: ', '\n' + outText)[1:]

        macPat = r'link/ether (([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2}))'
        for section in sections:
            matcher = re.search(macPat, section)
            if not matcher:  # Only keep info about nics
                continue
            mac = matcher.group(1).lower()
            name = section.split(':', 1)[0]
            self.mac2Name[mac] = name

    def gen_one_nic(self, nic):
        """
        Return the lines needed to configure a nic
        @return (str list): the string list to configure the nic
        @param nic (NicBase): the nic to configure
        """
        lines = []
        name = self.mac2Name.get(nic.mac.lower())
        if not name:
            raise ValueError('No known device has MACADDR: %s' % nic.mac)

        if nic.onboot:
            lines.append('auto %s' % name)

        # Customize IPv4
        lines.extend(self.gen_ipv4(name, nic))

        # Customize IPv6
        lines.extend(self.gen_ipv6(name, nic))

        lines.append('')

        return lines

    def gen_ipv4(self, name, nic):
        """
        Return the lines needed to configure the IPv4 setting of a nic
        @return (str list): the string list to configure the gateways
        @param name (str): name of the nic
        @param nic (NicBase): the nic to configure
        """
        lines = []

        bootproto = nic.bootProto.lower()
        if nic.ipv4_mode.lower() == 'disabled':
            bootproto = 'manual'
        lines.append('iface %s inet %s' % (name, bootproto))

        if bootproto != 'static':
            return lines

        # Static Ipv4
        v4 = nic.staticIpv4
        if v4.ip:
            lines.append('    address %s' % v4.ip)
        if v4.netmask:
            lines.append('    netmask %s' % v4.netmask)

        # Add the primary gateway
        if nic.primary and v4.gateways:
            self.ipv4PrimaryGateway = v4.gateways[0]
            lines.append('    gateway %s metric 0' % self.ipv4PrimaryGateway)
            return lines

        # Add routes if there is no primary nic
        if not self._primaryNic:
            lines.extend(self.gen_ipv4_route(nic, v4.gateways))

        return lines

    def gen_ipv4_route(self, nic, gateways):
        """
        Return the lines needed to configure additional Ipv4 route
        @return (str list): the string list to configure the gateways
        @param nic (NicBase): the nic to configure
        @param gateways (str list): the list of gateways
        """
        lines = []

        for gateway in gateways:
            lines.append('    up route add default gw %s metric 10000' %
                         gateway)

        return lines

    def gen_ipv6(self, name, nic):
        """
        Return the lines needed to configure the gateways for a nic
        @return (str list): the string list to configure the gateways
        @param name (str): name of the nic
        @param nic (NicBase): the nic to configure
        """
        lines = []

        if not nic.staticIpv6:
            return lines

        # Static Ipv6
        addrs = nic.staticIpv6
        lines.append('iface %s inet6 static' % name)
        lines.append('    address %s' % addrs[0].ip)
        lines.append('    netmask %s' % addrs[0].netmask)

        for addr in addrs[1:]:
            lines.append('    up ifconfig %s inet6 add %s/%s' % (name, addr.ip,
                                                                 addr.netmask))
        # Add the primary gateway
        if nic.primary:
            for addr in addrs:
                if addr.gateway:
                    self.ipv6PrimaryGateway = addr.gateway
                    lines.append('    gateway %s' % self.ipv6PrimaryGateway)
                    return lines

        # Add routes if there is no primary nic
        if not self._primaryNic:
            lines.extend(self._genIpv6Route(name, nic, addrs))

        return lines

    def _genIpv6Route(self, name, nic, addrs):
        lines = []

        for addr in addrs:
            lines.append('    up route -A inet6 add default gw %s metric 10000' %
                         addr.gateway)

        return lines

    def generate(self):
        """Return the lines that is needed to configure the nics"""
        lines = []
        lines.append('iface lo inet loopback')
        lines.append('auto lo')
        lines.append('')

        for nic in self.nics:
            lines.extend(self.gen_one_nic(nic))

        return lines

    def clear_dhcp(self):
        logger.info('Clearing DHCP leases')

        subprocess.call('pkill dhclient', shell=True)
        subprocess.check_call('rm -f /var/lib/dhcp/*', shell=True)

    def if_down_up(self):
        names = []
        for nic in self.nics:
            name = self.mac2Name.get(nic.mac.lower())
            names.append(name)

        for name in names:
            logger.info('Bring down interface %s' % name)
            subprocess.check_call('ifdown %s' % name, shell=True)

        self.clear_dhcp()

        for name in names:
            logger.info('Bring up interface %s' % name)
            subprocess.check_call('ifup %s' % name, shell=True)

    def configure(self):
        """
        Configure the /etc/network/intefaces
        Make a back up of the original
        """
        containingDir = '/etc/network'

        interfaceFile = os.path.join(containingDir, 'interfaces')
        originalFile = os.path.join(containingDir,
                                    'interfaces.before_vmware_customization')

        if not os.path.exists(originalFile) and os.path.exists(interfaceFile):
            os.rename(interfaceFile, originalFile)

        lines = self.generate()
        with open(interfaceFile, 'w') as fp:
            for line in lines:
                fp.write('%s\n' % line)

        self.if_down_up()