Documentation

openvswitch_bridge - Manage Open vSwitch bridges

New in version 1.4.

Synopsis

Manage Open vSwitch bridges

Requirements (on host that executes module)

  • ovs-vsctl

Options

parameter required default choices comments
bridge
yes
    Name of bridge to manage
    external_ids
    (added in 2.0)
    no 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)
      no None
      • secure
      • standalone
      Set bridge fail-mode. The default value (None) is a No-op.
      state
      no present
      • present
      • absent
      Whether the bridge should exist
      timeout
      no 5
        How long to wait for ovs-vswitchd to respond

        Examples

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

        This is an Extras Module

        For more information on what this means please read Extras Modules

        For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.