openvswitch_port – Manage Open vSwitch ports — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# openvswitch_port – Manage Open vSwitch ports

- Synopsis
- Requirements
- Parameters
- Examples
- Status

## Synopsis

- Manage Open vSwitch ports

## 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 to manage
external_ids - added in 2.0 | Default: {} | Dictionary of external_ids applied to a port.
port - / required |  | Name of port to manage on the bridge
set - added in 2.0 |  | Set a single property on a port.
state - | Choices: present ← absent | Whether the port should exist
tag - added in 2.2 |  | VLAN tag for this port. Must be a value between 0 and 4095.
timeout - | Default: 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 not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- David Stygstra (@stygstra)

Hint

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