Open vSwitch Collection

⚠️ The openvswitch.openvswitch collection has been deprecated and will reach it's end-of-life on December, 2025. We are no longer accepting new pull requests, except for ones that fix critical bugs or security vulnerabilities. This collection is not supported with ansible-core>2.17.

The Open vSwitch collection includes a variety of Ansible content to help automate the management of Open vSwitch.

Ansible version compatibility

This collection has been tested against following Ansible versions: <2.18.0,>=2.15.0.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Supported connections

The Open vSwitch collection supports local connections only.

Included content

Click the Content button to see the list of content included in this collection.

Modules

Name	Description
openvswitch.openvswitch.openvswitch_bond	Manage Open vSwitch bonds
openvswitch.openvswitch.openvswitch_bridge	Manage Open vSwitch bridges
openvswitch.openvswitch.openvswitch_db	Configure open vswitch database.
openvswitch.openvswitch.openvswitch_port	Manage Open vSwitch ports

Installing this collection

You can install the Open vSwitch collection with the Ansible Galaxy CLI:

ansible-galaxy collection install openvswitch.openvswitch

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: openvswitch.openvswitch

Using this collection

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as openvswitch.openvswitch.openvswitch_port. The following example task replaces configuration changes in the existing configuration on a Open vSwitch network device, using the FQCN:

---
  - name: Creates port eth2 on bridge br-ex
    openvswitch.openvswitch.openvswitch_port:
      bridge: br-ex
      port: eth2
    state: present

NOTE: For Ansible 2.9, you may not see deprecation warnings when you run your playbooks with this collection. Use this documentation to track when a module is deprecated.

See Also:

• Ansible Using collections for more details.

Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Open vSwitch collection repository. See Contributing to Ansible-maintained collections for complete details.

You can also join us on:

• IRC - the #ansible-network irc.libera.chat channel
• Slack - https://ansiblenetwork.slack.com

See the Ansible Community Guide for details on contributing to Ansible.

Code of Conduct

This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

Changelogs

Release notes are available here.

Roadmap

More information

• Ansible network resources
• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.