openvswitch.openvswitch.openvswitch_bridge – Manage Open vSwitch bridges

Note

This plugin is part of the openvswitch.openvswitch collection (version 2.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install openvswitch.openvswitch.

To use it in a playbook, specify: openvswitch.openvswitch.openvswitch_bridge.

New in version 1.0.0: of openvswitch.openvswitch

Synopsis

  • Manage Open vSwitch bridges

Requirements

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

  • ovs-vsctl

Parameters

Parameter Choices/Defaults Comments
bridge
string / required
Name of bridge or fake bridge to manage
database_socket
string
Path/ip to datbase socket to use
Default path is used if not specified
Path should start with 'unix:' prefix
external_ids
dictionary
A dictionary of external-ids. Omitting this parameter is a No-op. To clear all external-ids pass an empty value.
fail_mode
string
Set bridge fail-mode. The default value (None) is a No-op.
parent
string
Bridge parent of the fake bridge to manage
set
string
Run set command after bridge configuration. This parameter is non-idempotent, play will always return changed state if present
state
string
    Choices:
  • present ←
  • absent
Whether the bridge should exist
timeout
integer
Default:
5
How long to wait for ovs-vswitchd to respond
vlan
integer
The VLAN id of the fake bridge to manage (must be between 0 and 4095). This parameter is required if parent parameter is set.

Examples

# Create a bridge named br-int
- openvswitch.openvswitch.openvswitch_bridge:
    bridge: br-int
    state: present

# Create a fake bridge named br-int within br-parent on the VLAN 405
- openvswitch.openvswitch.openvswitch_bridge:
    bridge: br-int
    parent: br-parent
    vlan: 405
    state: present

# Create an integration bridge
- openvswitch.openvswitch.openvswitch_bridge:
    bridge: br-int
    state: present
    fail_mode: secure
  args:
    external_ids:
      bridge-id: br-int
# Create a bridge named br0 in database with socket at /opt/second.sock
- openvswitch.openvswitch.openvswitch_bridge:
    bridge: br0
    state: present
    database_socket: unix:/opt/second.sock

Authors

  • David Stygstra (@stygstra)