libvirt puppet module

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.

Overview

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!

Description

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:

• puppetlabs-lvm
• puppet-drbd (only for DRBD setups)
• puppet-vswitch (only when using OpenvSwitch)

Usage

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 REFERENCE.md file.

Reference

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

Profiles

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:

libvirt::profiles::devices:
  myprofile:
    hostdev:
      attrs:
        mode: 'capabilities'
        type: 'misc'
      values:
        source:
           values: '/dev/input/event3'

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

  <source>
    <char>/dev/input/event3</char>
  </source>
</hostdev>

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:

libvirt::profiles::devices:
  myprofile:
    profileconfig:
      base: 'default'
      merge: 'merge'
    hostdev:
      ...

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.

Limitations

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.

Contributing

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.

Authors

This module is mainly written by Cirrax GmbH.

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

Reference

Table of Contents

Classes

• libvirt: this is the main class, used configure libvirt.
• libvirt::config: Installs configuration files
• libvirt::install: Installs the required packages and files
• libvirt::manage_domains_config: Installs configuration files for manage-domains script
• libvirt::profiles: this class loads all the available profiles for usage in domain.pp
• libvirt::service: Installs services

Defined types

• libvirt::domain: Define a new libvirt domain. The name of the domain is the resource name. The domain_title attribute allows to to set a free text title.
• libvirt::network: Define a new libvirt network. The name of the network is the resource name.
• libvirt::nwfilter: libvirt::nwfilter Define a new libvirt nwfilter. The name of the nwfilter is the resource name. It expects an ip address and will set up fir

Resource types

• libvirt_domain: ensures a persistent domain (vm) (transient domains are ignored)
• libvirt_network: ensures a persistent network (transient networks are ignored)
• libvirt_nwfilter: ensures a nwfilter
• libvirt_pool: Manages libvirt pools
• libvirtd_conf: setting name to manage value in libvirtd.conf
• libvirtd_default: setting name to manage default for libvirtd

Functions

• libvirt::get_merged_profile: merges profiles
• libvirt::normalxml: normalize a xml string
• libvirt_generate_mac: Returns a MAC address in the QEMU/KVM MAC OID (52:54:00:...). It computes a sha1 hash of all keys concatenated, the first 6 hex digits will
• libvirt_generate_mac_addresses: Generates MAC addresses for all interfaces in the array which do not yet have an address specified. The MAC addresses are based on the domain
• libvirt_generate_uuid: compute sha1 hash of all keys concatenated

Data types

• Libvirt::Domain::Device: A device of a Domain
• Libvirt::Domain::Disk: A disk of a Domain
• Libvirt::Domain::Interface: A interface of a Domain
• Libvirt::Filterref: an array for nwfilter references
• Libvirt::Net::Bandwith: network metadata
• Libvirt::Net::Bridge: network bridge
• Libvirt::Net::Dns: network dns
• Libvirt::Net::Dnsmasq_options: network dnsmasq_options
• Libvirt::Net::Domain: network domain
• Libvirt::Net::Forward: network forward
• Libvirt::Net::IP: network ip: The IP element sets up NAT'ing and an optional DHCP server local to the host.
• Libvirt::Net::Metadata: network metadata
• Libvirt::Net::Port: network port
• Libvirt::Net::Portgroup: network portgroup
• Libvirt::Net::Route: network route: static routes
• Libvirt::Net::Virtualport: network virtualport
• Libvirt::Net::Vlan: network vlan
• Libvirt::Nwfilter::Chain: a nwfilter chain
• Libvirt::Nwfilter::Param: a parameter for a nwfilter
• Libvirt::Nwfilter::Priority: a nwfilter priority
• Libvirt::Nwfilter::Protocol::Arp_rarp: nwfilter rule protocol of ARP/RARP
• Libvirt::Nwfilter::Protocol::Espipv6_ahipv6_udpliteipv6_allipv6: nwfilter rule protocol of ESP, AH, UDPLITE, ALL over IPv6
• Libvirt::Nwfilter::Protocol::Icmp: nwfilter rule protocol of icmp
• Libvirt::Nwfilter::Protocol::Icmpv6: nwfilter rule protocol of icmpv6
• Libvirt::Nwfilter::Protocol::Igmp_esp_ah_udplite_all: nwfilter rule protocol of IGMP, ESP, AH, UDPLITE, ALL
• Libvirt::Nwfilter::Protocol::Ipv4: nwfilter rule protocol of ipv4
• Libvirt::Nwfilter::Protocol::Ipv6: nwfilter rule protocol of ipv6
• Libvirt::Nwfilter::Protocol::Mac: nwfilter rule protocol of mac
• Libvirt::Nwfilter::Protocol::Stp: nwfilter rule protocol of stp
• Libvirt::Nwfilter::Protocol::Tcp_udp_sctp: nwfilter rule protocol of TCP/UDP/SCTP
• Libvirt::Nwfilter::Protocol::Tcpipv6_udpipv6_sctpipv6: nwfilter rule protocol of TCP/UDP/SCTP over IPV6
• Libvirt::Nwfilter::Protocol::Vlan: nwfilter rule protocol of VLAN
• Libvirt::Nwfilter::Rule: a single nwfilter rule
• Libvirt::Nwrules: An array of Nwfilter rules
• Libvirt::Profiles::Devices: A device of a Domain

Classes

libvirt

Libvirt (http://libvirt.org/) Puppet module

Examples

using a drbd hook

class { 'libvirt':
  qemu_hook => 'drbd',
  qemu_conf => {
    'vnc_listen' => '0.0.0.0'
  }
}

Parameters

The following parameters are available in the libvirt class:

• service_name
• service_ensure
• service_enable
• manage_service
• libvirt_package_names
• qemu_conf
• qemu_hook
• qemu_hook_packages
• create_networks
• create_domains
• create_nwfilters
• create_pools
• evacuation
• max_job_time
• suspend_multiplier
• migration_url_format
• uri_aliases
• uri_default
• default_conf
• libvirtd_conf
• config_dir
• manage_domains_config
• drop_default_net
• diff_dir
• filter_default_prio
• default_nwfilters
• load_nwfilter_set
• purge_nwfilter
• purge_network
• purge_domain
• tree_network

service_name

Data type: String

Service name for libvirt. The default value is Distribution specific. Only set this if your setup differs from the packages provided by your distribution.

Default value: 'libvirtd'

service_ensure

Data type: String

Whether the service should be running. Defaults to 'running'

Default value: 'running'

service_enable

Data type: Boolean

Whether the service should be enabled. Defaults to true

Default value: true

manage_service

Data type: Boolean

Whether the service should be managed by this module. Defaults to true

Default value: true

libvirt_package_names

Data type: Array

Array of the libvirt packages to install. Required, see hiera data directory for defaults

Default value: []

qemu_conf

Data type: Hash

Hash of key/value pairs you want to put in qemu.conf file.

Default value: {}

qemu_hook

Data type: Optional[String]

QEMU hook to install. The only currently available hook is a script to setup DRBD resources. Valid values are 'drbd' or undef (=no hook). Defaults to undef.

Default value: undef

qemu_hook_packages

Data type: Hash

Hash of Arrays of hook specific packages to install see hiera data directory for defaults

Default value: {}

create_networks

Data type: Hash

Hash of networks to create with libvirt::network Defaults to {}

Default value: {}

create_domains

Data type: Hash

Hash of domains to create with libvirt::domain Defaults to {}

Default value: {}

create_nwfilters

Data type: Hash

Hash of nwfilters to create with libvirt::nwfilter Defaults to {}

Default value: {}

create_pools

Data type: Hash

Hash of pools to create with libvirt_pool Defaults to {}

Default value: {}

evacuation

Data type: String

Default evacuation policy to shutdown or migrate all domains on a host. Valid values are 'migrate', 'save' and 'shutdown'. This can be overriden on a per domain basis. The default value is 'migrate'.

Default value: 'migrate'

max_job_time

Data type: String

Default maximum job time in seconds when migrating, saving or shuting down domains with the manage-domains script. This can be overriden on a per domain basis. The default is 120.

Default value: '120'

suspend_multiplier

Data type: String

Default suspend_multiplier for migrating domains with the manage-domains script. This can be overriden on a per domain basis. The default is 5.

Default value: '5'

migration_url_format

Data type: String

url format for to use for migration. default is ssh possible values: ssh: gives an url: 'qemu+ssh://%s/system' tls: gives an url: 'qemu+tls://%s/system' alias: sepcify the url as an alias in /etc/libvirt.conf

Default value: 'ssh'

uri_aliases

Data type: Array

define aliases for a client to connect defaults to []

Default value: []

uri_default

Data type: Optional[String]

the default url to use. defaults to undef (which means the system default is used)

Default value: undef

default_conf

Data type: Hash

Hash to add config to /etc/default/libvirtd (Debian) or /etc/sysconfig/libvirtd (RedHat) Defaults to {}

Default value: {}

libvirtd_conf

Data type: Hash[Optional[String],Variant[String,Integer,Array]]

Hash to add config to /etc/libvirt/libvirtd.conf Defaults to {}

Default value: {}

config_dir

Data type: String

the directory for configurations. Defaults to '/etc/libvirt'

Default value: '/etc/libvirt'

manage_domains_config

Data type: String

configuration file for managing domains. Defaults to '/etc/manage-domains.ini'

Default value: '/etc/manage-domains.ini'

drop_default_net

Data type: Boolean

Boolean, if true, purges the default network Deprecated, use $purge_network if you like to drop networks not managed with puppet.

Default value: false

diff_dir

Data type: Optional[String]

if this is set to a path, the directory is created and the xmls generated for the domains are kept and diffs are shown on changes by puppet. usefull for development (or on upgrade) defaults to undef (== disabled)

Default value: undef

filter_default_prio

Data type: Hash

default filter priorities per filter chain. defaults are taken from hiera.

Default value: {}

default_nwfilters

Data type: Hash[String[1], Hash]

hash of default filters to load this parameter is hash merged.

Default value: {}

load_nwfilter_set

Data type: Array[String[1]]

set of nwfilters to load this loads (createresources) of all filters defined in $load_nwfilter_set.each |$i| {$default_nwfilters[$i]} see data/profiles/nwfilter* for supported sets of filter will set the default template to 'generic'

Default value: []

purge_nwfilter

Data type: Enum['none','purge','noop']

what to do with nwfilters not managed with puppet: none: we do not care purge: remove the filters noop: warn (do a purge with noop parameter)

Default value: 'none'

purge_network

Data type: Enum['none','purge','noop']

what to do with persistent networks not managed with puppet: none: we do not care purge: remove the network noop: warn (do a purge with noop parameter) Remark: non persistent networks are not affected. only persisten network are handled within this module.

Default value: 'none'

purge_domain

Data type: Enum['none','purge','noop']

what to do with persistent domains not managed with puppet: none: we do not care purge: remove the domain noop: warn (do a purge with noop parameter) Remark: non persistent domains are not affected. only persisten domains are handled within this module.

Default value: 'none'

tree_network

Data type: Hash

this is the tree of all elements available for network xml definition, which stears the xml generation everything not defined as element is treated as attribute. There is no need to change this !! Better file a bug !

Default value: {}

libvirt::config

libvirt::config

• Note parameter are inherited from ::libvirt and documented there.

Parameters

The following parameters are available in the libvirt::config class:

• qemu_hook
• qemu_conf
• uri_aliases
• uri_default
• default_conf
• libvirtd_conf
• config_dir

qemu_hook

Data type: Optional[String]

source name for qemu hook

Default value: $libvirt::qemu_hook

qemu_conf

Data type: Hash

configuration that goes into qemu.conf

Default value: $libvirt::qemu_conf

uri_aliases

Data type: Array

uri alias from libvirt.conf

Default value: $libvirt::uri_aliases

uri_default

Data type: Optional[String]

uri default from libvirt.conf

Default value: $libvirt::uri_default

default_conf

Data type: Hash

defaults for libvirtd.conf

Default value: $libvirt::default_conf

libvirtd_conf

Data type: Hash[Optional[String],Variant[String,Integer,Array]]

libvirtd.conf configs

Default value: $libvirt::libvirtd_conf

config_dir

Data type: String

directory for configs

Default value: $libvirt::config_dir

libvirt::install

libvirt::install

Parameters

The following parameters are available in the libvirt::install class:

• qemu_hook
• packages
• qemu_hook_packages
• package_ensure
• manage_domain_file

qemu_hook

Data type: Optional[String]

QEMU hook to install. The only currently available hook is a script to setup DRBD resources. Valid values are 'drbd' or '' (=no hook). Default inherited from ::libvirt class

Default value: $libvirt::qemu_hook

packages

Data type: Array

Array of the libvirt package names to install. Default inherited from ::libvirt class

Default value: $libvirt::libvirt_package_names

qemu_hook_packages

Data type: Hash

Hash of Arrays of hook specific packages to install Default inherited from ::libvirt class

Default value: $libvirt::qemu_hook_packages

package_ensure

Data type: String

What state the packages should be in. Defaults to 'installed'

Default value: 'installed'

manage_domain_file

Data type: String[1]

script to use for manage-domains

Default value: 'puppet:///modules/libvirt/scripts/manage-domains'

libvirt::manage_domains_config

libvirt::manage_domains_config

Parameters

The following parameters are available in the libvirt::manage_domains_config class:

• manage_domains_config

manage_domains_config

Data type: String[1]

file where the manage_domains configuration is. Defaults to $libvirt::manage_domains_config Remark: if you change this, you also have to change in libvirt::domain define

Default value: $libvirt::manage_domains_config

libvirt::profiles

libvirt::profiles

find some default profiles in the data/profiles directory

Parameters

The following parameters are available in the libvirt::profiles class:

• devices
• domconf
• ignore

devices

Data type: Libvirt::Profiles::Devices

devices profiles to load remark: parameter is hiera hash merged

domconf

Data type: Hash

domconf profiles to load remark: parameter is hiera hash merged

ignore

Data type: Hash[String[1], Array[String[1]]]

an Array per profile of Xpath definitions to ignore when comparing the configured with the persistent/running configuration of a domain. Libvirt add some default configurations which should not be included in the XML we compare. remark: parameter is hiera hash merged

Default value: {}

libvirt::service

libvirt::service

Parameters

The following parameters are available in the libvirt::service class:

• service_name
• service_ensure
• service_enable
• manage_service
• modular_services

service_name

Data type: String

Service name for libvirt. The default value is Distribution specific and inherited from ::libvirt class.

Default value: $libvirt::service_name

service_ensure

Data type: String

Whether the service should be running. Defaults to 'running'

Default value: $libvirt::service_ensure

service_enable

Data type: Boolean

Whether the service should be enabled. Defaults to true

Default value: $libvirt::service_enable

manage_service

Data type: Boolean

Whether the service should be managed at all. Defaults to true

Default value: $libvirt::manage_service

modular_services

Data type: Optional[Hash[String[1], Hash]]

Hash of service resources for modular drivers and sockets. When this is set, service_name, service_ensure, and service_enable are ignored. Services tagged with libvirt-libvirtd-conf are notified from changes in Libvirtd_conf.

Example usage: Use the following snippet, if your libvirtd>5.6.0 and you like TLS socket usage (former --listen and TLS option): libvirt::service::modular_services: libvirtd.service: enable: false tag: 'libvirt-libvirtd-conf' libvirtd-tls.socket: ensure: 'running' enable: true

Default value: undef

Defined types

libvirt::domain

libvirt::domain

• Note Most parameters are modeled after their equivalents in the libvirt domain XML definition. See http://libvirt.org/formatdomain.html for more information.

Parameters

The following parameters are available in the libvirt::domain defined type:

• ensure
• type
• domain_title
• description
• uuid
• boot
• disks
• interfaces
• autostart
• active
• dom_profile
• domconf
• devices_profile
• devices
• additionaldevices
• replace
• ignore_profile
• ignore
• default_host
• evacuation
• max_job_time
• suspend_multiplier
• show_diff

ensure

Data type: Enum['present','absent']

if we ensure the VM present or absent.

Default value: 'present'

type

Data type: String[1]

Specify the hypervisor used for running the domain. The allowed values are driver specific, but include "xen", "kvm", "qemu" and "lxc" Defaults to 'kvm'

Default value: 'kvm'

domain_title

Data type: Optional[String]

Free text title of the domain. Defaults to undef.

Default value: undef

description

Data type: Optional[String]

Free text description of the domain. Defaults to undef.

Default value: undef

uuid

Data type: String[1]

UUID for the domain. The default is the uuid, generated with puppet.

Default value: libvirt_generate_uuid($name)

boot

Data type: String[1]

Default boot device. Valid values are any accepted by libvirt or the string 'per-device' to set individual boot orders on disks or interfaces. Defaults to 'hd'.

Default value: 'hd'

disks

Data type: Array[Libvirt::Domain::Disk]

Array of hashes defining the disks of this domain. Defaults to no disks at all. The hashes support the following keys:

• type: Disk type, supported types are 'file', 'block', 'network' and 'volume'.
• device: Disk device type exposed to the guest. Supported values are 'floppy', 'disk', 'cdrom' and 'lun'.
• bus: Target bus, defaults to 'virtio'.
• source: Hash of source parameters. The supported hash keys vary by the type of disk: file: 'file' key to specify the pathname of the source file backing this disk. block: 'dev' key to specify the pathname to the block device backing this disk. network: 'protocol' and 'name' volume: 'pool' and 'volume'
• driver: Hash of driver parameters. Defaults to raw disks images, no caching and native io. Use {'name' => 'qemu', 'type' => 'qcow2'} for QCOW2 images. See the libvirt domain XML documentation for all possible values.
• boot_order: Integer starting at 1 for the highest priority (shared with interfaces).

Default value: []

interfaces

Data type: Array[Libvirt::Domain::Interface]

Array of hashes defining the network interfaces of this domain. Defaults to no network interfaces. The hashes support the following keys:

• mac: MAC address of the interface. Without a mac key, a random address will be assigned by libvirt. The MAC address should start with 52:54:00.
• network: libvirt network to attach to (mandatory).
• portgroup: portgroup to attach to (optional).
• type: Type of network card. Defaults to 'virtio'.
• boot_order: Integer starting at 1 for the highest priority (shared with disks).

Default value: []

autostart

Data type: Boolean

Wheter the libvirt autostart flag should be set. Defaults to true. Autostart domains are started if the host is booted.

Default value: true

active

Data type: Optional[Boolean]

If true, this ensures the VM is running, if false ensures the machine is not running. Default: undef

Default value: undef

dom_profile

Data type: String[1]

profile to use for $domconf. Defaults to 'default' which is defined in data/profiles/xxx.yaml A profile is a predefined set of parameters for a vm. see class libvirt::profiles for additional information.

Default value: 'default'

domconf

Data type: Hash

the generic domain configuration to activate for vm. this parameter is merged with the choosen profile, ($libvirt::profiles::domconf) to generate the final configuration. Defaults to {} which does not change the profile. see also libvirt::profiles for how to use profiles

Default value: {}

devices_profile

Data type: String[1]

profile to use for $devices. Defaults to 'default' which is defined in data/profiles/xxx.yaml A profile is a predefined set of parameters for a vm. see class libvirt::profiles for additional information.

Default value: 'default'

devices

Data type: Hash[String[1],Libvirt::Domain::Device]

devices to attach to the vm this parameter is merged with the choosen profile, ($libvirt::profiles::devices) to generate the final configuration. Defaults to {} which does not change the profile. see also libvirt::profiles for how to use profiles

Default value: {}

additionaldevices

Data type: Hash[String[1],Libvirt::Domain::Device]

additional devices to attach to the vm Same format as $devices, but without merging. Defaults to {}

Default value: {}

replace

Data type: Boolean

set this to true if you like to replace existing VM configurations with puppet definitions (or if you change the config in puppet) To avoid replacement in each puppet run, this needs to set the libvirt::domain::ignore parameter according the VM definition to filter the XML generated by virsh (virsh adds some state and automatic dependency information to the dumped XML). Since libvirt does not only add state information to result of the dumpxml command (which can be handled with the $ignore parameter) but does also not display certain elements used to generate a domain this functionality is not yet very usefull.

Default value: false

ignore_profile

Data type: String[1]

the profile to take for the ignore parameters

Default value: 'default'

ignore

Data type: Array[String[1]]

Array Xpath definitions to ignore when comparing the configured with the persistent/running configuration of a domain. Libvirt add some default configurations which should not be included in the XML we compare. This is merged with the configured profile (value of $ignore_profile).

Default value: []

default_host

Data type: Optional[String[1]]

FQDN for the default host of this domain. The manage-domains script uses this value to move a domain to it's default host if it's running elsewhere.

Default value: undef

evacuation

Data type: Optional[String[1]]

Evacuation policy for this domain. Valid values are 'migrate', 'save' and 'shutdown'. The default is to not set a value and to use the global default.

Default value: undef

max_job_time

Data type: Optional[String[1]]

Maximum job time in seconds when migrating, saving or shuting down this domain with the manage-domains script. The default is to not set a value and to use the global default.

Default value: undef

suspend_multiplier

Data type: Optional[String[1]]

suspend_multiplier for migrating domains with the manage-domains script. The default is to not set a value and to use the global default.

Default value: undef

show_diff

Data type: Boolean

set to false, if you do not want to see the changes

Default value: true

libvirt::network

libvirt::network

• Note Most parameters are modeled after their equivalents in the libvirt network XML definition. See http://libvirt.org/formatnetwork.html for more information.

Parameters

The following parameters are available in the libvirt::network defined type:

• ensure
• metadata
• bridge
• domain
• forward
• bandwith
• vlan
• port
• ips
• routes
• dns
• dnsmasq_options
• virtualport
• forward_mode
• virtualport_type
• portgroups
• autostart
• forward_dev
• forward_interfaces
• ip_address
• ip_netmask
• dhcp_start
• dhcp_end
• dns_enable
• mtu
• template
• show_diff

ensure

Data type: Enum['present','absent']

if we ensure the network present or absent.

Default value: 'present'

metadata

Data type: Optional[Libvirt::Net::Metadata]

Network metadata only used for the 'generic' template

Default value: undef

bridge

Data type: Optional[Libvirt::Net::Bridge]

Name of the bridge device to use for this network as String or a Hash of attributes for the 'bridge' with 'name' attribute beeing mandatory. The default simple template only supports string.

Default value: undef

domain

Data type: Optional[Libvirt::Net::Domain]

DNS domain of the DHCP server only used for the 'generic' template

Default value: undef

forward

Data type: Optional[Libvirt::Net::Forward]

Determines the method of forwarding only used for the 'generic' template

Default value: undef

bandwith

Data type: Optional[Libvirt::Net::Bandwith]

setting quality of service for a particular network only used for the 'generic' template

Default value: undef

vlan

Data type: Optional[Libvirt::Net::Vlan]

vlan tags only used for the 'generic' template

Default value: undef

port

Data type: Optional[Libvirt::Net::Port]

for port isolation only used for the 'generic' template

Default value: undef

ips

Data type: Array[Optional[Libvirt::Net::Ip]]

ip adresses only used for the 'generic' template

Default value: []

routes

Data type: Array[Optional[Libvirt::Net::Route]]

routes only used for the 'generic' template

Default value: []

dns

Data type: Optional[Libvirt::Net::Dns]

dns only used for the 'generic' template

Default value: undef

dnsmasq_options

Data type: Optional[Libvirt::Net::Dnsmasq_options]

options for dnsmasq only used for the 'generic' template

Default value: undef

virtualport

Data type: Optional[Libvirt::Net::Virtualport]

virtual port only used for the 'generic' template

Default value: undef

forward_mode

Data type: String

Network forward mode. Valid modes are 'nat', 'route', 'bridge', 'private', 'vepa', 'passthrough' and 'hostdev'. The default is 'bridge'. only used for the 'simple' template

Default value: 'bridge'

virtualport_type

Data type: Optional[String]

Set this to 'openvswitch' for an Open vSwitch bridge. Leave undefined otherwise. only used for the 'simple' template

Default value: undef

portgroups

Data type: Array[Optional[Libvirt::Net::Portgroup]]

Array of hashes defining portgroups. This only works for Open vSwitch networks. The hash supports the following keys (for the simple template):

• name: Name of the portgroup.
• trunk: Set to true if this is a trunk port. In this case, the vlan_tag element must contain an array of allowed VLAN tags.
• vlan_tag: VLAN tag for this portgroup. to use all possible portgroup values you need to use the generic template.

Default value: []

autostart

Data type: Boolean

Wheter to start this network on boot or not. Defaults to true.

Default value: true

forward_dev

Data type: Optional[String]

The interface to forward, useful in bridge and route mode only used for the 'simple' template

Default value: undef

forward_interfaces

Data type: Array

An array of interfaces to forwad only used for the 'simple' template

Default value: []

ip_address

Data type: Optional[String]

The ip address for the device only used for the 'simple' template

Default value: undef

ip_netmask

Data type: Optional[String]

The netmask for the ip address only used for the 'simple' template

Default value: undef

dhcp_start

Data type: Optional[String]

Optional dhcp range start only used for the 'simple' template

Default value: undef

dhcp_end

Data type: Optional[String]

Optional dhcp range end only used for the 'simple' template

Default value: undef

dns_enable

Data type: Optional[String]

Set this to 'no' to disable the DNS service. Leave undefined otherwise. only used for the 'simple' template

Default value: undef

mtu

Data type: Optional[Integer]

Set a custom mtu value. Default depending on the setting of the type of device being used, usually 1500.

Default value: undef

template

Data type: Enum['simple','generic']

template to use to create the network xml

Default value: 'simple'

show_diff

Data type: Boolean

set to false, if you do not want to see the changes

Default value: true

libvirt::nwfilter

libvirt::nwfilter

Define a new libvirt nwfilter. The name of the nwfilter is the resource name. It expects an ip address and will set up firewalling that restricts inbound traffic to the given port numbers.

Parameters

The following parameters are available in the libvirt::nwfilter defined type:

• ensure
• uuid
• chain
• priority
• rules
• filterref
• ip
• publictcpservices
• publicudpservices
• customtcprules
• customudprules
• template
• show_diff

ensure

Data type: Enum['present', 'absent']

if the resource should be present or absent.

Default value: 'present'

uuid

Data type: Optional[String]

The libvirt UUID, optional.

Default value: undef

chain

Data type: Libvirt::Nwfilter::Chain

filter chain to use

Default value: 'root'

priority

Data type: Optional[Libvirt::Nwfilter::Priority]

filter priority only used if template is set to generic

Default value: undef

rules

Data type: Libvirt::Nwrules

the filter rules to apply only used if template is set to generic

Default value: []

filterref

Data type: Libvirt::Filterref

references to other filters to include only used if template is set to generic Example (yaml): filterref:

• filter: 'other filter'
• filter: 'filter with parameter' parameters:
  • IP: '127.0.0.1',
  • PORT: '22',
  • PORT: '80',

Default value: []

ip

Data type: Optional[String]

The VM's IP address, mandatory. only used if template is set to simple

Default value: undef

publictcpservices

Data type: Array

An array with portnumbers that should be accessible over TCP from anywhere only used if template is set to simple

Default value: []

publicudpservices

Data type: Array

An array with portnumbers that should be accessible over UDP from anywhere only used if template is set to simple

Default value: []

customtcprules

Data type: Array

An array with rules that allow traffic to a specific TCP port from a specific address. Syntax: [{remote_ip => port}, ... ] only used if template is set to simple

Default value: []

customudprules

Data type: Array

An array with rules that allow traffic to a specific UDP port from a specific address. Syntax: [{remote_ip => port}, ... ] only used if template is set to simple

Default value: []

template

Data type: Enum['simple','generic']

template to use. default to the 'old' simple template. for new implementations you shoud use generic which is much more powerfull and should support all possible libvirt configurations.

Default value: 'simple'

show_diff

Data type: Boolean

set to false, if you do not want to see the changes

Default value: true

Resource types

libvirt_domain

ensures a persistent domain (vm) (transient domains are ignored)

Properties

The following properties are available in the libvirt_domain type.

active

Valid values: true, false

Whether the domain should be started (active=true), or shutdown (active=false)

autostart

Valid values: true, false

Whether the domain should be autostarted.

Default value: false

content

content of the domain formated as XML

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the libvirt_domain type.

• ignore
• name
• provider
• replace
• show_diff
• uuid

ignore

Array of Xpath definitions to ignore. Libvirt generates some configurations automatic wich are shown in the xml output. This array defines Xpath queries of such configurations

Default value: []

name

namevar

name of the domain, name as namevar

provider

The specific backend to use for this libvirt_domain resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

replace

Valid values: true, false, yes, no

Set this to true to replace a already existing VM. To avoid change the VM pn every puppet run, you need to set the ignore parameter according your VM definition.

Default value: false

show_diff

Valid values: true, false, yes, no

Whether to display whole change when the xml changes, defaulting to false, since we do not want to fill up logs !

Default value: false

uuid

uuid to use for creation of a new domain, if undef (default) automatic creation

libvirt_network

ensures a persistent network (transient networks are ignored)

Properties

The following properties are available in the libvirt_network type.

active

Valid values: true, false

Whether the network should be started. (active)

Default value: true

autostart

Valid values: true, false

Whether the network should be autostarted.

Default value: true

content

content of the network formated as XML

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the libvirt_network type.

• name
• provider
• show_diff
• uuid

name

namevar

name of the network, name as namevar

provider

The specific backend to use for this libvirt_network resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

show_diff

Valid values: true, false, yes, no

Whether to display whole change when the xml changes, defaulting to false, since we do not want to fill up logs !

Default value: false

uuid

uuid to use for creation of a new network, if undef (default) automatic creation

libvirt_nwfilter

ensures a nwfilter

Properties

The following properties are available in the libvirt_nwfilter type.

content

content of the nwfilter formated as XML

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

Parameters

The following parameters are available in the libvirt_nwfilter type.

• name
• provider
• show_diff
• uuid

name

namevar

name of the filter, name as namevar

provider

The specific backend to use for this libvirt_nwfilter resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

show_diff

Valid values: true, false, yes, no

Whether to display whole change when the xml changes, defaulting to false, since we do not want to fill up logs !

Default value: false

uuid

uuid to use for creation of a new nwfilter, if undef (default) automatic creation

libvirt_pool

Manages libvirt pools

Examples

libvirt_pool { 'default' :
  ensure => absent
}

libvirt_pool { 'mydirpool' :
  ensure    => present,
  active    => true,
  autostart => true,
  type      => 'dir',
  target    => '/tmp/mypool',
}

libvirt_pool { 'mydirpool2' :
  ensure       => present,
  active       => true,
  autostart    => true,
  type         => 'dir',
  target       => '/tmp/mypool2',
  target_owner => 107,
  target_group => 107,
  target_mode  => '0755',
}

libvirt_pool { 'vm_storage':
  ensure    => 'present',
  active    => 'true',
  type      => 'logical',
  sourcedev => ['/dev/sdb', '/dev/sdc'],
  target    => '/dev/vg0'
}

Properties

The following properties are available in the libvirt_pool type.

active

Valid values: true, false

Whether the pool should be started.

Default value: true

autostart

Valid values: true, false

Whether the pool should be autostarted.

Default value: false

ensure

Valid values: present, absent

Manages the creation or the removal of a pool present means that the pool will be defined and created absent means that the pool will be purged from the system

Default value: present

Parameters

The following parameters are available in the libvirt_pool type.

• name
• provider
• sourcedev
• sourceformat
• sourcehost
• sourcename
• sourcepath
• target
• target_group
• target_mode
• target_owner
• type

name

Valid values: %r{^\S+$}

namevar

The pool name.

provider

The specific backend to use for this libvirt_pool resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

sourcedev

Valid values: %r{(\/)?(\w)}

The source device.

sourceformat

Valid values: auto, nfs, glusterfs, cifs

The source format.

sourcehost

Valid values: %r{^\S+$}

The source host.

sourcename

Valid values: %r{^\S+$}

The source name.

sourcepath

Valid values: %r{(\/)?(\w)}

The source path.

target

Valid values: %r{(\/)?(\w)}

The target.

target_group

Valid values: %r{^\S+$}

The group of the target dir or filesystem

target_mode

Valid values: %r{^[0-7]{4}$}

The mode of the target dir or filesystem

target_owner

Valid values: %r{^\S+$}

The owner of the target dir or filesystem

type

Valid values: dir, netfs, fs, logical, disk, iscsi, mpath, rbd, sheepdog

The pool type.

libvirtd_conf

setting name to manage value in libvirtd.conf

Properties

The following properties are available in the libvirtd_conf type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

value

The value of the setting to be defined.

Parameters

The following parameters are available in the libvirtd_conf type.

• name
• provider
• secret

name

Valid values: %r{\S+}

namevar

setting name to manage value in libvirtd.conf

provider

The specific backend to use for this libvirtd_conf resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

secret

Valid values: true, false

Whether to hide the value from Puppet logs. Defaults to false.

Default value: false

libvirtd_default

setting name to manage default for libvirtd

Properties

The following properties are available in the libvirtd_default type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

value

The value of the setting to be defined.

Parameters

The following parameters are available in the libvirtd_default type.

• name
• provider
• secret

name

Valid values: %r{\S+}

namevar

setting name to manage default for libvirtd

provider

The specific backend to use for this libvirtd_default resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

secret

Valid values: true, false

Whether to hide the value from Puppet logs. Defaults to false.

Default value: false

Functions

libvirt::get_merged_profile

Type: Puppet Language

function to merge profiles.

A profile is a hash of values. A profile can depend on another profile. The base for a profile can be configured in the profiles data: $data['profileconfig']['base'], which should reference another profile. Merging is per default done using a hash merge. Alternativ deep_merge can configured for a profile by setting $data['profileconfig']['merge'] to 'deep'. (remark: this is NOT the deep_merge of hiera, but of puppetlab-stdlib, see https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/REFERENCE.md#deep_merge)

• Note The profiles are computed using recursion. $data['profileconfig'] is removed from the resulting hash.

libvirt::get_merged_profile(Hash $profile_hash, String $profile)

function to merge profiles.

A profile is a hash of values. A profile can depend on another profile. The base for a profile can be configured in the profiles data: $data['profileconfig']['base'], which should reference another profile. Merging is per default done using a hash merge. Alternativ deep_merge can configured for a profile by setting $data['profileconfig']['merge'] to 'deep'. (remark: this is NOT the deep_merge of hiera, but of puppetlab-stdlib, see https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/REFERENCE.md#deep_merge)

Returns: Any the computed profile

profile_hash

Data type: Hash

all the profiles

profile

Data type: String

Name of the computed profile to return

libvirt::normalxml

Type: Ruby 4.x API

For the providers to compare the xml string it needs exact matching. this function does the same for the input as it is done with the output of the dumpxml in the provider. (see resource libvirt_nwfilter)

libvirt::normalxml(String $value)

For the providers to compare the xml string it needs exact matching. this function does the same for the input as it is done with the output of the dumpxml in the provider. (see resource libvirt_nwfilter)

Returns: String the normalized xml string.

value

Data type: String

the xml string

libvirt_generate_mac

Type: Ruby 3.x API

Returns a MAC address in the QEMU/KVM MAC OID (52:54:00:...).

It computes a sha1 hash of all keys concatenated, the first 6 hex digits will be used as mac address.

libvirt_generate_mac()

Returns a MAC address in the QEMU/KVM MAC OID (52:54:00:...).

It computes a sha1 hash of all keys concatenated, the first 6 hex digits will be used as mac address.

Returns: Any a mac address in the QEMU/KVM MAC OID (52:54:00:...)

libvirt_generate_mac_addresses

Type: Ruby 3.x API

Generates MAC addresses for all interfaces in the array which do not yet have an address specified. The MAC addresses are based on the domain name, network and portgroup. The function libvirt_generate_mac is used to generate a single mac address.

libvirt_generate_mac_addresses(Any $hash)

Generates MAC addresses for all interfaces in the array which do not yet have an address specified. The MAC addresses are based on the domain name, network and portgroup. The function libvirt_generate_mac is used to generate a single mac address.

Returns: Any the interfacess with mac address

hash

Data type: Any

of interfaces

libvirt_generate_uuid

Type: Ruby 3.x API

Return a uuid generated from an sha1 hash of all keys concatenated

libvirt_generate_uuid()

Return a uuid generated from an sha1 hash of all keys concatenated

Returns: String the computed uuid

Data types

Libvirt::Domain::Device

A device of a Domain

Alias of

Variant[Array[Libvirt::Domain::Device], String[1], Integer, Struct[{
      values => Optional[Variant[Hash, String[1],Integer, Libvirt::Domain::Device]],
      attrs  => Optional[Variant[String[1], Integer, Hash]],
  }], Hash[String[1], Libvirt::Domain::Device]]

Libvirt::Domain::Disk

A disk of a Domain

Alias of

Struct[{
    type       => Enum['file', 'block', 'network', 'volume'],
    device     => Enum['floppy', 'disk', 'cdrom', 'lun'],
    bus        => String[1],
    driver     => Optional[Hash[String[1],String[1]]],
    boot_order => Optional[Integer],
    source     => Optional[Hash[String[1], String[1]]],
}]

Libvirt::Domain::Interface

A interface of a Domain

Alias of

Struct[{
    type      => Optional[String[1]],
    network   => String[1],
    portgroup => Optional[String[1]],
    mac       => Optional[String[1]],
    filter    => Optional[Variant[
        String[1],
        Struct[{
            filterref  => String[1],
            parameters => Optional[Hash[
                String[1],
                Variant[String[1],Array[String[1]]]
            ]],
        }],
    ]],
    boot_order => Optional[Integer],
}]

Libvirt::Filterref

an array for nwfilter references

Alias of

Array[Optional[
    Struct[{
        filter     => String[1],
        parameters => Optional[
          Array[
            Hash[
              Pattern[/\A[A-Z]/],
              Variant[String[1],Integer],
            ]
          ]
        ]
    }]
]]

Libvirt::Net::Bandwith

network metadata

Alias of

Struct[{
    inbound  => Optional[Struct[{
          average => Optional[Integer],
          peak    => Optional[Integer],
          burst   => Optional[Integer],
          floot   => Optional[Integer],
    }]],
    outbound => Optional[Struct[{
          average => Optional[Integer],
          peak    => Optional[Integer],
          burst   => Optional[Integer],
    }]],
}]

Libvirt::Net::Bridge

network bridge

Alias of

Variant[String[1], Struct[{
      name            => String[1],
      stp             => Optional[Enum['on','off']],
      delay           => Optional[Integer],
      macTableManager => Optional[Enum['kernel','libvirt']],
      zone            => Optional[String[1]],
  }]]

Libvirt::Net::Dns

network dns

Alias of

Struct[{
    enable => Optional[Enum['yes','no']],
    forwardPlainNames => Optional[Enum['yes','no']],
    forwarder => Optional[Array[Struct[{
            addr => Optional[String[1]],
            domain => Optional[String[1]],
    }]]],
    txt => Optional[Array[Struct[{
            name => Optional[String[1]],
            value => Optional[String[1]],
    }]]],
    srv => Optional[Array[Struct[{
            service => String[1],
            protocol => String[1],
            domain => Optional[String[1]],
            target => Optional[String[1]],
            port => Optional[Integer],
            priority => Optional[Integer],
            weight => Optional[Integer],
    }]]],
    host => Optional[Array[Struct[{
            ip => String[1],
            hostname => Array[String[1]],
    }]]],
}]

Libvirt::Net::Dnsmasq_options

network dnsmasq_options

Alias of

Array[Struct[{
      'dnsmasq:option' => Struct[{
          value => String[1],
      }],
}]]

Libvirt::Net::Domain

network domain

Alias of

Struct[{
    name                => String[1],
    localOnly           => Optional[Enum['yes','no']],
}]

Libvirt::Net::Forward

network forward

Alias of

Struct[{
    mode => Enum['nat','route','open','bridge','private','vepa','passthrough','hostdev'],
    managed => Optional[Enum['yes','no']],
    dev  => Optional[String[1]],
    nat  => Optional[Struct[{
          addresses => Optional[Array[Struct[{
                  start => String[1],
                  end   => String[1],
          }]]],
          port => Optional[Struct[{
                start => Integer,
                end   => Integer,
          }]],
          ipv6 => Optional[Enum['yes']],
    }]],
    interface => Optional[Array[Struct[{
            dev => String[1],
    }]]],
    pf => Optional[Struct[{
          dev => String[1],
    }]],
    driver    => Optional[Struct[{
          name => Enum['vfio','kvm'],
    }]],
    address => Optional[Array[Struct[{
            type     => Optional[String[1]],
            domain   => Optional[String[1]],
            bus      => Optional[String[1]],
            slot     => Optional[String[1]],
            function => Optional[String[1]],
    }]]],
}]

Libvirt::Net::IP

network ip: The IP element sets up NAT'ing and an optional DHCP server local to the host.

Alias of

Struct[{
    address => Optional[String[1]],
    netmask => Optional[String[1]],
    prefix => Optional[String[1]],
    family => Optional[String[1]],
    localPtr => Optional[String[1]],
    tftp    => Optional[Array[Struct[{
            root => String[1],
    }]]],
    dhcp => Optional[Struct[{
          range => Optional[Array[Struct[{
                  start => String[1],
                  end   => String[1],
                  lease => Optional[Array[Struct[{
                          expiry => Integer,
                          unit   => Optional[Enum['seconds', 'minutes', 'hours']],
                  }]]],
                  unit   => Optional[String[1]],
          }]]],
          host => Optional[Array[Struct[{
                  mac => Optional[String[1]],
                  id => Optional[String[1]],
                  name => Optional[String[1]],
                  ip => String[1],
                  lease => Optional[Array[Struct[{
                          expiry => Integer,
                          unit   => Optional[Enum['seconds', 'minutes', 'hours']],
                  }]]],
          }]]],
          bootp => Optional[Struct[{
                file => Optional[String[1]],
                server => Optional[String[1]],
          }]],
    }]],
}]

Libvirt::Net::Metadata

network metadata

Alias of

Struct[{
    ipv6                => Optional[Enum['yes','no']],
    trustGuestRxFilters => Optional[Enum['yes','no']],
}]

Libvirt::Net::Port

network port

Alias of

Struct[{
    isolated => Optional[Enum['yes', 'no']],
}]

Libvirt::Net::Portgroup

network portgroup

Alias of

Struct[{
    name                => String[1],
    trunk               => Optional[Boolean],                             # for simple template only
    vlan_tag            => Optional[Variant[String[1],Array[String[1]]]], # for simple template only
    vlan                => Optional[Libvirt::Net::Vlan],
    bandwith            => Optional[Libvirt::Net::Bandwith],
    virtualport         => Optional[Libvirt::Net::Virtualport],
    'default'           => Optional[Enum['yes']],
    trustGuestRxFilters => Optional[Enum['yes', 'no']],
}]

Libvirt::Net::Route

network route: static routes

Alias of

Struct[{
    family => Optional[Enum['ipv6']],
    address => String[1],
    gateway => String[1],
    netmask => Optional[String[1]],
    prefix => Optional[String[1]],
    metric => Optional[Integer],
}]

Libvirt::Net::Virtualport

network virtualport

Alias of

Struct[{
    type => Optional[Enum['802.1Qbg', 'openvswitch']],
    parameters => Optional[Array[Struct[{
            interfaceid => Optional[String[1]],
            managerid => Optional[Integer],
            typeid    => Optional[Integer],
            typeidversion => Optional[Integer],
            instanceid => Optional[String[1]],
            profileid => Optional[String[1]],
    }]]],
}]

Libvirt::Net::Vlan

network vlan

Alias of

Struct[{
    trunk => Optional[Enum['yes']],
    tag => Array[Struct[{
          id         => Integer,
          nativeMode => Optional[Enum['untagged', 'tagged']],
    }]],
}]

Libvirt::Nwfilter::Chain

a nwfilter chain

Alias of Variant[Enum['root','mac','stp','vlan','arp','rarp','ipv4','ipv6'], Pattern[/\Amac-.+\Z/,/\Astp-.+\Z/,/\Avlan-.+\Z/,/\Ar*arp-.+\Z/,/\Aipv[46]-.+\Z/]]

Libvirt::Nwfilter::Param

a parameter for a nwfilter

Alias of Pattern[/\$[A-Z]+/]

Libvirt::Nwfilter::Priority

a nwfilter priority

Alias of Integer[-1000, 1000]

Libvirt::Nwfilter::Protocol::Arp_rarp

nwfilter rule protocol of ARP/RARP

Alias of

Struct[{
    id            => Enum['arp', 'rarp'],
    match         => Optional[Enum['no','yes']],
    srcmacaddr    => Optional[String[1]],
    srcmacmask    => Optional[String[1]],
    dstmacaddr    => Optional[String[1]],
    dstmacmask    => Optional[String[1]],
    hwtype        => Optional[Integer[0,256]],
    protocoltype  => Optional[Integer[0,256]],
    opcode        => Optional[Variant[
        Integer[0,256],
        Enum['Request',
          'Reply',
          'Request_Reverse',
          'Reply_Reverse',
          'DRARP_Request',
          'DRARP_Reply',
          'DRARP_Error',
          'InARP_Request',
        'ARP_NAK'],
    ]],
    arpsrcmacaddr => Optional[String[1]],
    arpdstmacaddr => Optional[String[1]],
    arpsrcipaddr  => Optional[String[1]],
    arpsrcipmask  => Optional[String[1]],
    arpdstipaddr  => Optional[String[1]],
    arpdstipmask  => Optional[String[1]],
    gratuitous    => Optional[Boolean],
    comment       => Optional[String[1,256]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Espipv6_ahipv6_udpliteipv6_allipv6

nwfilter rule protocol of ESP, AH, UDPLITE, ALL over IPv6

Alias of

Struct[{
    id         => Enum['esp-ipv6', 'ah-ipv6', 'udplite-ipv6', 'all-ipv6'],
    match      => Optional[Enum['no','yes']],
    srcmacaddr => Optional[String[1]],
    srcipaddr  => Optional[String[1]],
    srcipmask  => Optional[String[1]],
    dstipaddr  => Optional[String[1]],
    dstipmask  => Optional[String[1]],
    srcipfrom  => Optional[String[1]],
    srcipto    => Optional[String[1]],
    dstipfrom  => Optional[String[1]],
    dstipto    => Optional[String[1]],
    dscp       => Optional[Integer[0,256]],
    comment    => Optional[String[1,256]],
    state      => Optional[String[1]],
    ipset      => Optional[String[1]],
    ipsetflags => Optional[String[1]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Icmp

nwfilter rule protocol of icmp

Alias of

Struct[{
    id         => Enum['icmp'],
    match      => Optional[Enum['no','yes']],
    srcmacaddr => Optional[String[1]],
    srcmacmask => Optional[Stdlib::MAC],
    dstmacaddr => Optional[String[1]],
    dstmacmask => Optional[Stdlib::MAC],
    srcipaddr  => Optional[String[1]],
    srcipmask  => Optional[String[1]],
    dstipaddr  => Optional[String[1]],
    dstipmask  => Optional[String[1]],
    srcipfrom  => Optional[String[1]],
    srcipto    => Optional[String[1]],
    dstipfrom  => Optional[String[1]],
    dstipto    => Optional[String[1]],
    type       => Optional[Integer[0,65535]],
    code       => Optional[Integer[0,65535]],
    dscp       => Optional[Integer[0,256]],
    comment    => Optional[String[1,256]],
    state      => Optional[String[1]],
    ipset      => Optional[String[1]],
    ipsetflags => Optional[String[1]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Icmpv6

nwfilter rule protocol of icmpv6

Alias of

Struct[{
    id         => Enum['icmpv6'],
    match      => Optional[Enum['no','yes']],
    srcmacaddr => Optional[String[1]],
    srcipaddr  => Optional[String[1]],
    srcipmask  => Optional[String[1]],
    dstipaddr  => Optional[String[1]],
    dstipmask  => Optional[String[1]],
    srcipfrom  => Optional[String[1]],
    srcipto    => Optional[String[1]],
    dstipfrom  => Optional[String[1]],
    dstipto    => Optional[String[1]],
    type       => Optional[Integer[0,65535]],
    code       => Optional[Integer[0,65535]],
    dscp       => Optional[Integer[0,256]],
    comment    => Optional[String[1,256]],
    state      => Optional[String[1]],
    ipset      => Optional[String[1]],
    ipsetflags => Optional[String[1]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Igmp_esp_ah_udplite_all

nwfilter rule protocol of IGMP, ESP, AH, UDPLITE, ALL

Alias of

Struct[{
    id         => Enum['igmp', 'esp', 'ah', 'udplite', 'all'],
    match      => Optional[Enum['no','yes']],
    srcmacaddr => Optional[String[1]],
    srcmacmask => Optional[String[1]],
    dstmacaddr => Optional[String[1]],
    dstmacmask => Optional[String[1]],
    srcipaddr  => Optional[String[1]],
    srcipmask  => Optional[String[1]],
    dstipaddr  => Optional[String[1]],
    dstipmask  => Optional[String[1]],
    srcipfrom  => Optional[String[1]],
    srcipto    => Optional[String[1]],
    dstipfrom  => Optional[String[1]],
    dstipto    => Optional[String[1]],
    dscp       => Optional[Integer[0,256]],
    comment    => Optional[String[1,256]],
    state      => Optional[String[1]],
    ipset      => Optional[String[1]],
    ipsetflags => Optional[String[1]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Ipv4

nwfilter rule protocol of ipv4

Alias of

Struct[{
    id           => Enum['ip'],
    match        => Optional[Enum['no','yes']],
    srcmacaddr   => Optional[String[1]],
    srcmacmask   => Optional[String[1]],
    dstmacaddr   => Optional[String[1]],
    dstmacmask   => Optional[String[1]],
    srcipaddr    => Optional[String[1]],
    srcipmask    => Optional[String[1]],
    dstipaddr    => Optional[String[1]],
    dstipmask    => Optional[String[1]],
    protocol     => Optional[Variant[
        Integer[0,256],
        Enum['tcp', 'udp', 'udplite', 'esp', 'ah', 'icmp', 'igmp', 'sctp'],
    ]],
    srcportstart    => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    srcportend      => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    dstportstart    => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    dstportend      => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    dscp            => Variant[Integer[0,256],Libvirt::Nwfilter::Param, Undef],
    protocolid      => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    comment         => Optional[String[1,256]],
    connlimit-above => Variant[Integer,Libvirt::Nwfilter::Param, Undef],
}]

Libvirt::Nwfilter::Protocol::Ipv6

nwfilter rule protocol of ipv6

Alias of

Struct[{
    id              => Enum['ipv6'],
    match           => Optional[Enum['no','yes']],
    srcmacaddr      => Optional[String[1]],
    srcmacmask      => Optional[String[1]],
    dstmacaddr      => Optional[String[1]],
    dstmacmask      => Optional[String[1]],
    srcipaddr       => Optional[String[1]],
    srcipmask       => Optional[String[1]],
    dstipaddr       => Optional[String[1]],
    dstipmask       => Optional[String[1]],
    protocol        => Optional[Variant[
        Integer[0,256],
        Enum['tcp', 'udp', 'udplite', 'esp', 'ah', 'icmpv6', 'sctp'],
    ]],
    srcportstart    => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    srcportend      => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    dstportstart    => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    dstportend      => Variant[Integer[0,65535],Libvirt::Nwfilter::Param, Undef],
    type            => Variant[Integer[0,246],Libvirt::Nwfilter::Param, Undef],
    typeend         => Variant[Integer[0,246],Libvirt::Nwfilter::Param, Undef],
    code            => Variant[Integer[0,246],Libvirt::Nwfilter::Param, Undef],
    comment         => Optional[String[1,256]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Mac

nwfilter rule protocol of mac

Alias of

Struct[{
    id         => Enum['mac'],
    match      => Optional[Enum['no','yes']],
    srcmacaddr => Optional[String[1]],
    srcmacmask => Optional[String[1]],
    dstmacaddr => Optional[String[1]],
    dstmacmask => Optional[String[1]],
    protocolid => Optional[Variant[
        Enum['arp', 'rarp', 'ipv4', 'ipv6'],
        Pattern[/\A0x[0-9]{1,4}\Z/],
    ]],
    comment    => Optional[String[1,256]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Stp

nwfilter rule protocol of stp

Alias of

Struct[{
    id                  => Enum['stp'],
    match               => Optional[Enum['no','yes']],
    srcmacaddr          => Optional[String[1]],
    srcmacmask          => Optional[String[1]],
    type                => Optional[Integer[0,256]],
    flags               => Optional[Integer[0,256]],
    root-priority       => Optional[Integer[0,65535]],
    root-priority-hi    => Optional[Integer[0,65535]],
    root-address        => Optional[String[1]],
    root-address-mask   => Optional[String[1]],
    root-cost           => Optional[Integer[0,2147483647]],
    root-cost-hi        => Optional[Integer[0,2147483647]],
    sender-priority     => Optional[Integer[0,65535]],
    sender-priority-hi  => Optional[Integer[0,65535]],
    sender-address      => Optional[String[1]],
    sender-address-mask => Optional[String[1]],
    port                => Optional[Integer[0,65535]],
    port-hi             => Optional[Integer[0,65535]],
    msg-age             => Optional[Integer[0,65535]],
    msg-age-hi          => Optional[Integer[0,65535]],
    max-age             => Optional[Integer[0,65535]],
    max-age-hi          => Optional[Integer[0,65535]],
    hello-time          => Optional[Integer[0,65535]],
    hello-time-hi       => Optional[Integer[0,65535]],
    forward-delay       => Optional[Integer[0,65535]],
    forward-delay-hi    => Optional[Integer[0,65535]],
    comment             => Optional[String[1,256]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Tcp_udp_sctp

nwfilter rule protocol of TCP/UDP/SCTP

Alias of

Struct[{
    id           => Enum['tcp', 'udp', 'sctp'],
    match        => Optional[Enum['no','yes']],
    srcmacaddr   => Optional[String[1]],
    srcipaddr    => Optional[String[1]],
    srcipmask    => Optional[String[1]],
    dstipaddr    => Optional[String[1]],
    dstipmask    => Optional[String[1]],
    srcipfrom    => Optional[String[1]],
    srcipto      => Optional[String[1]],
    srcportstart => Optional[Integer[0,65535]],
    srcportend   => Optional[Integer[0,65535]],
    dstportstart => Optional[Integer[0,65535]],
    dstportend   => Optional[Integer[0,65535]],
    dscp         => Optional[Integer[0,256]],
    comment      => Optional[String[1,256]],
    state        => Optional[String[1]],
    flags        => Optional[String[1]],
    ipset        => Optional[String[1]],
    ipsetflags   => Optional[String[1]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Tcpipv6_udpipv6_sctpipv6

nwfilter rule protocol of TCP/UDP/SCTP over IPV6

Alias of

Struct[{
    id           => Enum['tcp-ipv6', 'udp-ipv6', 'sctp-ipv6'],
    match        => Optional[Enum['no','yes']],
    srcmacaddr   => Optional[String[1]],
    srcipaddr    => Optional[String[1]],
    srcipmask    => Optional[String[1]],
    dstipaddr    => Optional[String[1]],
    dstipmask    => Optional[String[1]],
    srcipfrom    => Optional[String[1]],
    srcipto      => Optional[String[1]],
    dstipfrom    => Optional[String[1]],
    dstipto      => Optional[String[1]],
    srcportstart => Optional[Integer[0,65535]],
    srcportend   => Optional[Integer[0,65535]],
    dstportstart => Optional[Integer[0,65535]],
    dstportend   => Optional[Integer[0,65535]],
    dscp         => Optional[Integer[0,256]],
    comment      => Optional[String[1,256]],
    state        => Optional[String[1]],
    flags        => Optional[String[1]],
    ipset        => Optional[String[1]],
    ipsetflags   => Optional[String[1]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Protocol::Vlan

nwfilter rule protocol of VLAN

Alias of

Struct[{
    id             => Enum['vlan'],
    match          => Optional[Enum['no','yes']],
    srcmacaddr     => Optional[String[1]],
    srcmacmask     => Optional[String[1]],
    dstmacaddr     => Optional[String[1]],
    dstmacmask     => Optional[String[1]],
    vlanid         => Optional[Integer[0,4095]],
    encap_protocol => Optional[Variant[
        Enum['arp','ipv4','ipv6'],
        Integer[0,65535]
    ]],
    comment        => Optional[String[1,256]],
    connlimit-above => Optional[Integer],
}]

Libvirt::Nwfilter::Rule

a single nwfilter rule

Alias of

Struct[{
    action     => Enum['drop','reject','accept','return','continue'],
    direction  => Enum['in','out','inout'],
    priority   => Optional[Libvirt::Nwfilter::Priority],
    statematch => Optional[Enum['0','false','1','true']],
    protocols  => Optional[Array[Optional[Variant[
            Libvirt::Nwfilter::Protocol::Mac,
            Libvirt::Nwfilter::Protocol::Vlan,
            Libvirt::Nwfilter::Protocol::Stp,
            Libvirt::Nwfilter::Protocol::Arp_rarp,
            Libvirt::Nwfilter::Protocol::Ipv4,
            Libvirt::Nwfilter::Protocol::Ipv6,
            Libvirt::Nwfilter::Protocol::Tcp_udp_sctp,
            Libvirt::Nwfilter::Protocol::Icmp,
            Libvirt::Nwfilter::Protocol::Igmp_esp_ah_udplite_all,
            Libvirt::Nwfilter::Protocol::Tcpipv6_udpipv6_sctpipv6,
            Libvirt::Nwfilter::Protocol::Icmpv6,
            Libvirt::Nwfilter::Protocol::Espipv6_ahipv6_udpliteipv6_allipv6,
    ]]]]
}]

Libvirt::Nwrules

An array of Nwfilter rules

Alias of Array[Optional[Libvirt::Nwfilter::Rule]]

Libvirt::Profiles::Devices

A device of a Domain

Alias of

Hash[String[1], Variant[
    Struct[{
        'profileconfig' => Optional[Struct[{ 'base' => Optional[String[1]] }]],
    }],
    Libvirt::Domain::Device,
  ]]