Documentation

openvswitch_bridge - Manage Open vSwitch bridges

New in version 1.4.

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
required
Name of bridge or fake bridge to manage
external_ids
(added in 2.0)
Default:
None
A dictionary of external-ids. Omitting this parameter is a No-op. To clear all external-ids pass an empty value.
fail_mode
(added in 2.0)
    Choices:
  • secure
  • standalone
Default:
None
Set bridge fail-mode. The default value (None) is a No-op.
parent
(added in 2.3)
Default:
None
Bridge parent of the fake bridge to manage
set
(added in 2.3)
Default:
None
Run set command after bridge configuration. This parameter is non-idempotent, play will always return changed state if present
state
    Choices:
  • present ←
  • absent
Whether the bridge should exist
timeout Default:
5
How long to wait for ovs-vswitchd to respond
vlan
(added in 2.3)
Default:
None
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_bridge:
    bridge: br-int
    state: present

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

# Create an integration bridge
- openvswitch_bridge:
    bridge: br-int
    state: present
    fail_mode: secure
  args:
    external_ids:
      bridge-id: br-int

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • David Stygstra (@stygstra)

Hint

If you notice any issues in this documentation you can edit this document to improve it.