Documentation

libvirt

Manage Libvirt virtual machines (domains).

Attributes

check_mode:
  support: full

Parameters

Parameter	Required	Type	Values	Description
name	true	string		Name of the domain/VM.
state		string	running stopped paused undefined present destroyed restarted	State of the domain.
uri		string		Libvirt connection URI.
xml		string		Domain XML definition (overrides other resource parameters).
memory		integer		Memory allocation in MiB.
vcpu		integer		Number of virtual CPUs.
disk		object		Disk configuration.
network		object		Network interface configuration.
autostart		boolean		Set autostart flag on the domain.
remove_storage		boolean		Remove associated storage when undefining.
force		boolean		Force stop (destroy) instead of graceful shutdown.

Example

- name: Define and start a VM
  libvirt:
    name: webserver
    state: running
    memory: 2048
    vcpu: 2
    disk:
      path: /var/lib/libvirt/images/webserver.qcow2
      size: 20G
      format: qcow2
    network:
      network_type: bridge
      source: virbr0

- name: Define VM with custom XML
  libvirt:
    name: myvm
    state: present
    xml: |
      <domain type='kvm'>
        <name>myvm</name>
        <memory unit='MiB'>4096</memory>
        <vcpu>4</vcpu>
        ...
      </domain>

- name: Start a VM
  libvirt:
    name: webserver
    state: running

- name: Stop a VM
  libvirt:
    name: webserver
    state: stopped

- name: Pause a VM
  libvirt:
    name: webserver
    state: paused

- name: Restart a VM
  libvirt:
    name: webserver
    state: restarted

- name: Set VM autostart
  libvirt:
    name: webserver
    autostart: true

- name: Undefine a VM
  libvirt:
    name: webserver
    state: undefined

- name: Undefine a VM with storage
  libvirt:
    name: webserver
    state: undefined
    remove_storage: true

- name: Connect to remote libvirt
  libvirt:
    name: webserver
    state: running
    uri: qemu+ssh://root@192.168.1.10/system