summaryrefslogtreecommitdiff
path: root/python/vyos/ifconfig/wireless.py
blob: faa47358d4ca6a0f5385589eaf4a1cc2fdfe1792 (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
# Copyright 2020 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library.  If not, see <http://www.gnu.org/licenses/>.

import os

from vyos.ifconfig.vlan import VLANIf

class WiFiIf(VLANIf):
    """
    Handle WIFI/WLAN interfaces.
    """

    options = ['phy', 'op_mode']

    default = {
        'type': 'wifi',
        'phy': 'phy0',
        'op_mode': 'monitor'
    }

    def _create(self):
        cmd = 'iw phy {phy} interface add {ifname} type {op_mode}' \
            .format(**self.config)
        self._cmd(cmd)

        # place interface in administrative down state
        # this should be improved in the long run to reduce the amount of
        # interface flaps
        self.set_state('down')

    def _delete(self):
        cmd = 'iw dev {ifname} del' \
            .format(**self.config)
        self._cmd(cmd)

    @staticmethod
    def get_config():
        """
        WiFi interfaces require a configuration when they are added using
        iw (type/phy). This static method will provide the configuration
        ictionary used by this class.

        Example:
        >> conf = WiFiIf().get_config()
        """
        config = {
            'phy': 'phy0',
            'op_mode': 'monitor' # required for proper interface deletion, as
                                 # _update() is called prior to remove()
        }
        return config