Documentation

openvswitch_port - Manage Open vSwitch ports

New in version 1.4.

Synopsis

  • Manage Open vSwitch ports

Options

parameter required default choices comments
bridge
yes
Name of bridge to manage
external_ids
(added in 2.0)
no
Dictionary of external_ids applied to a port.
port
yes
Name of port to manage on the bridge
set
(added in 2.0)
no None
Set a single property on a port.
state
no present
  • present
  • absent
Whether the port should exist
tag
(added in 2.2)
no
VLAN tag for this port. Must be a value between 0 and 4095.
timeout
no 5
How long to wait for ovs-vswitchd to respond

Examples

# Creates port eth2 on bridge br-ex
- openvswitch_port:
    bridge: br-ex
    port: eth2
    state: present

# Creates port eth6
- openvswitch_port:
    bridge: bridge-loop
    port: eth6
    state: present
    set: Interface eth6

# Creates port vlan10 with tag 10 on bridge br-ex
- openvswitch_port:
    bridge: br-ex
    port: vlan10
    tag: 10
    state: present
    set: Interface vlan10

# Assign interface id server1-vifeth6 and mac address 00:00:5E:00:53:23
# to port vifeth6 and setup port to be managed by a controller.
- openvswitch_port:
    bridge: br-int
    port: vifeth6
    state: present
  args:
    external_ids:
      iface-id: '{{ inventory_hostname }}-vifeth6'
      attached-mac: '00:00:5E:00:53:23'
      vm-id: '{{ inventory_hostname }}'
      iface-status: active

Status

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

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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