.. _bridge_vlan_module:


bridge_vlan -- Attach VLAN ids to virtual network interfaces.
=============================================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

This module adds VLAN ids to all virtual network interfaces attached
to the specified virtual network. The virtual network has a physical
network interface that is configured as a VLAN trunk port.
The module sets the tasks return elements like changed and success
to true when
\- Physical interface is configured for trunk VLAN
\- There are TAPs attached to the virtual network
\- All identified VLAN ids were applied to all identified interfaces
The module sets the tasks to failed when
\- Physical interface is configured to forward multiple VLAN ids
\- There are TAPs attached to the virtual network
\- There was a failure allowing VLAN ids for one or more TAPs
For any other conditions, the changed is marked as false and success is
marked as true.



Requirements
------------
The below requirements are needed on the host that executes this module.

- nmcli
- bridge
- ip



Parameters
----------

  networks (True, list, None)
    The name of the virtual networks.









Examples
--------

.. code-block:: yaml+jinja

    
    - name: Attach all configured VLANs to the interfaces of osp_trunk
      become: true
      cifmw.general.bridge_vlan:
        networks:
          - osp_trunk



Return Values
-------------

success (always, bool, True)
  Status of the execution





Status
------





Authors
~~~~~~~

- Pragadeeswaran (@psathyan)