Forge Home


Puppet module to install libvirt and create virtual domain configuration


110 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 5.0.4 (latest)
  • 5.0.3
  • 5.0.2
  • 5.0.1
  • 5.0.0
  • 4.5.0
  • 4.4.0
  • 4.3.4
  • 4.3.3
  • 4.3.2
  • 4.3.1
  • 4.3.0
  • 4.2.3
  • 4.2.2
  • 4.2.1
  • 4.2.0
  • 4.1.2
  • 4.1.1
  • 4.1.0
  • 4.0.0
  • 3.1.0
  • 3.0.0
  • 2.2.2
  • 2.2.1
  • 2.2.0
  • 2.1.5
  • 2.1.4
  • 2.1.3
  • 2.1.1
  • 2.1.0
  • 2.0.4
  • 2.0.2
  • 2.0.1
  • 2.0.0
released Mar 15th 2024
This version is compatible with:
  • Puppet Enterprise 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
  • Puppet >=5.0.0 < 9.0.0
  • , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'cirrax-libvirt', '5.0.4'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add cirrax-libvirt
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install cirrax-libvirt --version 5.0.4

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



cirrax/libvirt — version 5.0.4 Mar 15th 2024

libvirt puppet module

PDK Puppet Forge Puppet Forge Puppet Forge Puppet Forge

Table of Contents

  1. Overview
  2. Description
  3. Usage
  4. Reference
  5. Profiles
  6. Limitations
  7. Contributing

Upgrade warnings:

Upgrading to puppet 8 comes with Ruby 3, which doesn't have the rexml gem bundled. It should be installed on the puppetserver.

sudo puppetserver gem install rexml

Upgrade to version 5.x.x introduced types/providers for network, nwfilter and domains replacing the execs used before version 5.0.0. To compare the XML's generated with puppet and the actual running XML's generated with virsh they are sorted which leads to display lots of changes if you use the diff_dir functionality.

Version 5.0.0 also introduce a generic template for network and nwfilter which should be more flexible to define the configurations needed (the 'old' templates are still default).

Upgrade to version 4.x.x will probably break any existing setup (puppet run fails), since several parameters of libvirt::domain are now deprecated in favor of using profiles. To make upgrade easier (and see what happens), upgrade to version 3.1.x and set libvirt::diff_dir. Like this you can see the changes to be applied after the upgrade.


Puppet module to install libvirt and create virtual domain configuration. This module has very minimal external dependencies and tries to not make any assumptions about how you want to setup your virtual machines. Certain profiles can be defined and used for a set of VM's

The module contains helper scripts to manage VMs on a 2 node cluster with disk replication over DRBD. But this is completely optional.

Remark: Debian >= 12 (bullseye) and Ubuntu >= 21.10 uses architecture specific packages. Currently amd64 is configured. Merge requests for other architectures are welcome!


This module tries to adhere to the Unix philosophy of doing one thing but doing it right. It installs and configures libvirt and virtual domains, but does not do the basic setup of your networking bridge or configure the disks used by the virtual domains. This is left to other puppet modules.

For a basic setup you have to include the libvirt class, define a libvirt::network and a libvirt::domain.

As an optional add-on this module contains a libvirt hook and a Python management script to create a 2 node cluster with disks replicated over DRBD. This setup allows live migration of VMs from one node to the other.

A complete working solution can be achived by integrating the following modules in addition to this module:


Install libvirt:

class {'libvirt': }

Install including the DRBD hook:

class {'libvirt':
  qemu_hook => 'drbd',

If you want to see the diffs of the xml file generated, set libvirt::diff_dir to a directory. As a result all generated XML files are stored there, and diffs are visible.

Define a network (basic linux bridge example):

libvirt::network { 'net-simple':
    forward_mode   => 'bridge',
    bridge         => 'br-simple',

Define a network (advanced openvswitch example):

libvirt::network { 'net-ovs':
  forward_mode     => 'bridge',
  bridge           => 'br-ovs',
  virtualport_type => 'openvswitch',
  autostart        => true,
  portgroups       => [
                       {'name'     => 'intern',
                        'trunk'    => false,
                        'vlan_tag' => '2',
                       {'name'     => 'trunk',
                        'trunk'    => true,
                        'vlan_tag' => ['100', '101', '102', ],

Define a domain (VM):

libvirt::domain { 'my-domain':
  devices_profile => 'default',
  dom_profile     => 'default',
  boot            => 'hd',
  domconf         => { memory: { values => '2048', attrs => { unit => 'MiB' }}},
  disks           => [{'type' => 'block',
                       'device' => 'disk',
                       'source' => {'dev' => '/dev/vm-pool/my-domain.img'},
                      {'type'   => 'file',
                       'device' => 'disk',
                       'source' => {'dev' => '/var/lib/libvirt/images/my-disk.qcow2'},
                       'bus'    => 'virtio',
                       'driver' => {'name'  => 'qemu',
                                    'type'  => 'qcow2',
                                    'cache' => 'none',
  interfaces      => [{'network' => 'net-simple'},],
  autostart       => true,

Define a storage pool:

libvirt_pool { 'default' :
    ensure     => present,
    type       => 'logical',
    autostart  => true,
    sourcedev  => '/dev/sda5',
    sourcename => 'vm',
    target     => '/dev/vm',

Complete documentation is included in puppet doc format in the manifest files or in the file.


The detailed configuration of all parameters is found in the file generated from the strings in the manifests.


Profiles are a set of values to add to the configuration, eg. some devices you like to add to all VM's (keyboard etc.)

The default profile used is defined in hiera in the data/profiles directory. The profiles in hiera are hash merged, so you can define you're own profiles easily. Here is an example:

        mode: 'capabilities'
        type: 'misc'
           values: '/dev/input/event3'

will result in a device (without the default devices...):


To not repeat all profile values you can 'inherit' a profile, meaning you set a base profile with wich the profile will be merged. Let's take enlarge our profile:

      base: 'default'
      merge: 'merge'

which results in the hostdev been added to the default profile. Merge parameter in profileconfig defines how to merge, valid values are merge (default) or deep for a deep merge.

Hint: To better see what is changing you can set libvirt::diff_dir to a directory.


Things currently not supported:

  • Operating Systems other than Debian, Ubuntu or RedHat. Adding support for other systems is a matter of defining the relevant parameters in hiera.
  • Documentation always needs some love ;) I would especially appreciate some examples of profiles you are using.

Patches to support any of these (or other) missing features are welcome.


Please report bugs and feature request using GitHub issue tracker.

For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint and the available spec tests in order to follow the recommended Puppet style guidelines from the Puppet Labs style guide.


This module is mainly written by Cirrax GmbH.

See the list of contributors for a list of all contributors.