community.libvirt Collection

This repo hosts the community.libvirt Ansible Collection.

The collection includes the libvirt modules and plugins supported by Ansible libvirt community to help the management of virtual machines and/or containers via the libvirt API.

This collection is shipped with the ansible package.

Community standards

This project follows:

• The Ansible Code of Conduct in all interactions within this project. If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.
• The Ansible Community Policy for AI-Assisted Contributions.

Communication

• Join the Ansible forum:
• Get Help: get help or help others. Please add appropriate tags if you start new discussions, for example the libvirt tag.
• Posts tagged with 'libvirt': subscribe to participate in related conversations.
• Social Spaces: gather and interact with fellow enthusiasts.

• News & Announcements: track project-wide announcements including social events.

• The Ansible Bullhorn newsletter: used to announce releases and important changes.

For more information about communication, see the Ansible communication guide.

Tested with Ansible

• 2.17
• 2.18
• 2.19
• 2.20
• devel

External requirements

• python >= 2.6
• libvirt python bindings
• lxml

Some modules require additional system tools: - virt-install: required by the virt_install and virt_cloud_instance modules. - qemu-img: required by the virt_cloud_instance module.

Included content

Modules:

• virt
• virt_net
• virt_pool
• virt_volume
• virt_install
• virt_cloud_instance

Inventory:

• libvirt

Connection:

• libvirt_lxc
• libvirt_qemu

Using this collection

Before using the libvirt collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install community.libvirt

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

---
collections:
  - name: community.libvirt

You can also download the tarball from Ansible Galaxy and install the collection manually wherever you need.

Note that if you install the collection from Ansible Galaxy with the command-line tool or tarball, it will not be upgraded automatically when you upgrade the Ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install community.libvirt --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax:

ansible-galaxy collection install community.libvirt:==X.Y.Z

See Ansible Using collections for more details.

Contributing to this collection

The content of this collection is made by people just like you, a community of individuals collaborating on making the world better through developing automation software.

We are actively accepting new contributors.

All types of contributions are very welcome.

You don't know how to start? Refer to our contribution guide!

The aspiration is to follow the following general guidelines:

• Changes should include tests and documentation where appropriate.
• Changes will be lint tested using standard python lint tests.
• No changes which do not pass CI testing will be approved/merged.
• The collection plugins must provide the same coverage of python support as the versions of Ansible supported.
• The versions of Ansible supported by the collection must be the same as those in developed, or those maintained, as shown in the Ansible Release and Maintenance documentation.

We use the following guidelines:

• CONTRIBUTING.md
• REVIEW_CHECKLIST.md
• Ansible Community Guide
• Ansible Development Guide
• Ansible Collection Development Guide

Local Testing

To learn how to test your pull request locally, refer to the Quick-start guide.

To learn how to test a pull request made by another person in your local environment, refer to the Test PR locally guide.

Collection maintenance

The current maintainers (contributors with write or higher access) are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain / become a maintainer of this collection, refer to the Maintainer guidelines.

It is necessary for maintainers of this collection to be subscribed to:

• The collection itself (the Watch button -> All Activity in the upper right corner of the repository's homepage).
• The "Changes Impacting Collection Contributors and Maintainers" issue.

They also should be subscribed to Ansible's The Bullhorn newsletter.

Releases Support Timeline

We maintain each major release version (1.x.y, 2.x.y, ...) for one year after the next major version is released.

Here is the table for the support timeline: - 1.x.y: released 2020-08-18, maintained until 2026-07-21 (bugfixes only) - 2.x.y: released 2025-07-21, current

Publishing New Version

See the Releasing guidelines to learn more.

Reference

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

License

GNU General Public License v3.0 or later.

See LICENCE to see the full text.