Ansible Module for Linux Bridge and VLAN

LICENSE

MIT License

Copyright (c) 2021 Ryo Nakamura

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

linux_bridge.py

#!/usr/bin/env python
#-*- coding: utf-8 -*-

DOCUMENTATION = '''
---
module: linux_bridge
short_description: Manage Linux bridges
requirements: [ brctl ]
description:
    - Manage Linux bridges
options:
    bridge:
        required: true
        description:
            - Name of bridge to manage
    state:
        required: false
        default: "present"
        choices: [ present, absent ]
        description:
            - Whether the bridge should exist
'''

EXAMPLES = '''
# Create bridge a named br-int
- linux_bridge: bridge=br-int state=present
'''

class LinuxBridge (object) :

    def __init__ (self, module) :
        self.module = module
        self.bridge = module.params['bridge']
        self.state = module.params['state']

        return

    def brctl (self, cmd) :

        return self.module.run_command (['brctl'] + cmd)


    def ifconfig (self, cmd) :

        return self.module.run_command (['ifconfig'] + cmd)


    def br_exists (self) :
        
        syspath = "/sys/class/net/" + self.bridge
        if os.path.exists (syspath) :
            return True
        else :
            return False

        return 


    def addbr (self) :
        
        (rc, out, err) = self.brctl (['addbr', self.bridge])

        if rc != 0 :
            raise Exception (err)

        self.ifconfig ([self.bridge, 'up'])

        return


    def delbr (self) :
        
        self.ifconfig ([self.bridge, 'down'])

        (rc, out, err) = self.brctl (['delbr', self.bridge])

        if rc != 0 :
            raise Exception (err)
    
        return


    def check (self) :

        try :
            if self.state == 'absent' and self.br_exists () :
                changed = True
            elif self.state == 'present' and not self.br_exists () :
                changed = True
            else :
                changed = False

        except Exception, e :
            self.module.fail_json (msg = str (e))

        self.module.exit_json (changed = changed)

        return
        

    def run (self) :

        changed = False

        try :
            if self.state == 'absent' and self.br_exists () :
                self.delbr ()
                changed = True

            elif self.state == 'present' and not self.br_exists () :
                self.addbr ()
                changed = True

        except Exception, e :
            self.module.fail_json (msg = str (e))


        self.module.exit_json (changed = changed)

        return
            

def main () :

    module = AnsibleModule (
        argument_spec = {
            'bridge' : { 'required' : True },
            'state' : {'default' : 'present', 
                       'choices' : ['present', 'absent']
                       }
            },
        supports_check_mode = True,
        )

    br = LinuxBridge (module)

    if module.check_mode :
        br.check ()
    else :
        br.run ()

    return

from ansible.module_utils.basic import *
main ()

linux_bridge_port.py

#!/usr/bin/python
#-*- coding: utf-8 -*-

DOCUMENTATION = '''
module: linux_bridge_port
short_description: Manage Linux bridge ports
requirements: [ brctl ]
descroption:
    - Manage Linux bridge ports
options:
    bridge:
        required: true
        description:
            - Name of bridge to manage
    port:
        requirement: true
        description:
            - Name of port to manage on the bridge
    state:
        required: false
        default: "present"
        choices: [ present, absent ]
        description:
            - Whether the port should exist
'''

EXAMPLES = '''
# create port eth0 on bridge br-int
- linux_bridge_port: bridge=br-int port=eth0 state=present
'''

class LinuxPort (object) :
    def __init__ (self, module) :
        self.module = module
        self.bridge = module.params['bridge']
        self.port = module.params['port']
        self.state = module.params['state']

        return


    def brctl (self, cmd) :
        
        return self.module.run_command (['brctl'] + cmd)


    def port_exists (self) :

        syspath = "/sys/class/net/%s/brif/%s" % (self.bridge, self.port)

        if os.path.exists (syspath) :
            return True
        else :
            return False

        return

    def addif (self) :

        (rc, out, err) = self.brctl (['addif', self.bridge, self.port])
        
        if rc != 0 :
            raise Exception (err)

        return


    def delif (self) :

        (rc, out, err) = self.brctl (['delif', self.bridge, self.port])
        
        if rc != 0 :
            raise Exception (err)

        return


    def check (self) :

        try :
            if self.state == 'absent' and self.port_exists () :
                changed = True
            elif self.state == 'present' and not self.port_exists () :
                changed = True
            else :
                changed = False
        except Exception, e :
            self.module.fail_json (msg = str (e))

        self.module.exit_json (changed = changed)

        return

    
    def run (self) :

        changed = False

        try :
            if self.state == 'absent' :
                if self.port_exists () :
                    self.delif ()
                    changed = True

            elif self.state == 'present' :
                if not self.port_exists () :
                    self.addif ()
                    changed = True

        except Exception, e :
            self.module.fail_json (msg = str (e))

        self.module.exit_json (changed = changed)

        return

def main () :

    module = AnsibleModule (
        argument_spec = {
            'bridge' : { 'required': True},
            'port' : {'required' : True},
            'state' : {'default' : 'present', 
                       'choices' : ['present', 'absent']}
            },
        supports_check_mode = True,
        )

    port = LinuxPort (module)

    if module.check_mode :
        port.check ()
    else :
        port.run ()

    return


from ansible.module_utils.basic import *
main ()

vlan.py

#!/usr/bin/env python
#-*- coding: utf-8 -*-

DOCUMENTATION = '''
module: vlan
short_description: Manage vlan
requirements: [ ip ]
description:
    - Manage VLAN. vlan interface name is DEV.ID
options:
    vlan:
        required: true
        description:
            - vlan id 
    port:
        required: true
        description:
            - interface for tagged vlan
    state:
        required: false
        default: "present"
        choices: [ present, absent ]
        description:
            - Whether the vlan should exist
'''

EXAMPLES = '''
# Create vlan id 3000 interface on interface eth0
- vlan: vlan=3000 port=eth0
'''

class Vlan (object) :

    def __init__ (self, module) :
        self.module = module
        self.vlan = module.params['vlan']
        self.port = module.params['port']
        self.state = module.params['state']
        self.vif = "%s.%s" % (self.port, self.vlan)

        return

    def ip (self, cmd) :
        
        return self.module.run_command (['ip'] + cmd)

    def ifconfig (self, cmd) :

        return self.module.run_command (['ifconfig'] + cmd)

    def vlan_exists (self) :
        
        syspath = "/sys/class/net/" + self.vif

        return os.path.exists (syspath)

    def addvlan (self) :

        cmd = ['link', 'add', 'link', self.port, 'name', self.vif,
               'type', 'vlan', 'id', self.vlan ]

        (rc, out, err) = self.ip (cmd)

        if rc != 0 :
            raise Exception (err)

        self.ifconfig ([self.vif, 'up'])

        return

    def delvlan (self) :

        self.ifconfig ([self.vif, 'down'])

        cmd = ['link', 'del', 'dev', self.vif]

        (rc, out, err) = self.ip (cmd)

        if rc != 0 :
            raise Exception (err)

        return

    def check (self) :

        try :
            if self.state == 'absent' and self.vlan_exists () :
                changed = True
            elif self.state == 'present' and not self.vlan_exists () :
                changed = True
            else :
                changed = False

        except :
            self.module.fail_json (msg = str (e))

        self.module.exit_json (changed = changed)

        return


    def run (self) :

        changed = False

        try :
            if self.state == 'absent' and self.vlan_exists () :
                self.delvlan ()
                changed = True

            elif self.state == 'present' and not self.vlan_exists () :
                self.addvlan ()
                changed = True

        except Exception, e :
            self.module.fail_json (msg = str (e))

        self.module.exit_json (changed = changed)

        return

def main () :

    module = AnsibleModule (
        argument_spec = {
            'vlan' : { 'required' : True },
            'port' : { 'required' : True },
            'state' : {'default' : 'present',
                       'choices' : ['present', 'absent']
                       }
            },
        supports_check_mode = True,
        )

    vlan = Vlan (module)

    if module.check_mode :
        vlan.check ()
    else :
        vlan.run ()

    return

from ansible.module_utils.basic import *
main ()

Hi, is this code under an open source license?

Hey do you want to open a PR agains https://github.com/ansible/ansible ? this sounds like a good addition

Thanks for this, was really useful. Agree that it would be a good addition.

Getting this working on python 3 was a breeze (it 2to3-ed no problem):

pelson@~/dev/misc/hosts-config/modules> 2to3-3.5 linux_bridge.py -w
RefactoringTool: Skipping optional fixer: buffer
RefactoringTool: Skipping optional fixer: idioms
RefactoringTool: Skipping optional fixer: set_literal
RefactoringTool: Skipping optional fixer: ws_comma
RefactoringTool: Refactored linux_bridge.py
--- linux_bridge.py	(original)
+++ linux_bridge.py	(refactored)
@@ -90,7 +90,7 @@
             else :
                 changed = False
 
-        except Exception, e :
+        except Exception as e :
             self.module.fail_json (msg = str (e))
 
         self.module.exit_json (changed = changed)
@@ -111,7 +111,7 @@
                 self.addbr ()
                 changed = True
 
-        except Exception, e :
+        except Exception as e :
             self.module.fail_json (msg = str (e))
 
 
RefactoringTool: Files that were modified:
RefactoringTool: linux_bridge.py

Good job! Have to replace "ifconfig" with "ip" in vlan.py because in ubuntu 18.04 there is no ifconfig by default.