set FQCN on all calls

Author: Tcharl

defaults/main.yml

@@ -86,6 +86,9 @@ libvirt_vms:
       # XML template file to source domain definition
       xml_file: vm.xml.j2
 
+      # May be one of: bios, or efi.
+      boot_firmware: bios
+
 # Variables to add to the enviroment that is used to execute virsh commands
 libvirt_vm_virsh_default_env: "{{  { 'LIBVIRT_DEFAULT_URI': libvirt_vm_uri } if libvirt_vm_uri else {} }}"
 

tasks/autodetect.yml

@@ -2,18 +2,18 @@
 - name: Detect the virtualisation engine
   block:
     - name: Load the kvm kernel module
-      modprobe:
+      community.general.modprobe:
         name: kvm
       become: true
       failed_when: false
 
     - name: Check for the KVM device
-      stat:
+      ansible.builtin.stat:
         path: /dev/kvm
       register: stat_kvm
 
     - name: Set a fact containing the virtualisation engine
-      set_fact:
+      ansible.builtin.set_fact:
         libvirt_vm_engine: >-
           {%- if ansible_facts.architecture != libvirt_vm_arch -%}
           {# Virtualisation instructions are generally available only for the host
@@ -32,7 +32,7 @@
   block:
     - block:
         - name: Detect the KVM emulator binary path
-          stat:
+          ansible.builtin.stat:
             path: "{{ item }}"
           register: kvm_emulator_result
           with_items:
@@ -49,12 +49,12 @@
 
     - block:
         - name: Detect the QEMU emulator binary path
-          stat:
+          ansible.builtin.stat:
             path: /usr/libexec/qemu-kvm
           register: kvm_emulator_result
 
         - name: Set a fact containing the QEMU emulator binary path
-          set_fact:
+          ansible.builtin.set_fact:
             libvirt_vm_emulator: "{{ kvm_emulator_result.stat.path }}"
           when: kvm_emulator_result.stat.exists
       when:
@@ -64,7 +64,7 @@
 
     - block:
         - name: Detect the QEMU emulator binary path
-          shell: which qemu-system-{{ libvirt_vm_arch }}
+          ansible.builtin.command: "which qemu-system-{{ libvirt_vm_arch }}"
           register: qemu_emulator_result
           changed_when: false
 
@@ -77,7 +77,7 @@
         - ansible_facts.os_family != 'RedHat' or ansible_facts.distribution_major_version | int == 7
 
     - name: Fail if unable to detect the emulator
-      fail:
+      ansible.builtin.fail:
         msg: Unable to detect emulator for engine {{ libvirt_vm_engine }}.
       when: libvirt_vm_emulator is none
   when: libvirt_vm_emulator is none or libvirt_vm_emulator | length == 0

tasks/check-interface.yml

@@ -1,6 +1,6 @@
 ---
 - name: Check network interface has a network name
-  fail:
+  ansible.builtin.fail:
     msg: >
       The interface definition {{ interface }} has type 'network', but does not have
       a network name defined.
@@ -10,7 +10,7 @@
     - interface.network is not defined
 
 - name: Check direct interface has an interface device name
-  fail:
+  ansible.builtin.fail:
     msg: >
       The interface definition {{ interface }} has type 'direct', but does not have
       a host source device defined.

tasks/destroy-vm.yml

@@ -2,7 +2,7 @@
 # The destroyed state does not seem to be idempotent, so check whether the VM
 # exists before destroying it.
 - name: Check the VM's status
-  virt:
+  community.libvirt.virt:
     name: "{{ vm.name }}"
     command: list_vms
     uri: "{{ libvirt_vm_uri | default(omit, true) }}"
@@ -11,16 +11,25 @@
 
 - block:
     - name: Ensure the VM is absent
-      virt:
+      community.libvirt.virt:
         name: "{{ vm.name }}"
         state: destroyed
         uri: "{{ libvirt_vm_uri | default(omit, true) }}"
       become: yes
 
+    # note(wszumski): the virt module does not seem to support
+    # removing vms with nvram defined - as a workaround, use the
+    # virsh cli directly. It may be better to detect if dumpxml
+    # actually contains an nvram element rather than relying on
+    # boot_firmware having the correct value.
     - name: Ensure the VM is undefined
-      virt:
-        name: "{{ vm.name }}"
-        command: undefine
-        uri: "{{ libvirt_vm_uri | default(omit, true) }}"
+      community.libvirt.command:
+        cmd: >-
+          virsh
+          {% if libvirt_vm_uri %}-c {{ libvirt_vm_uri }}{% endif %}
+          undefine
+          {% if boot_firmware == 'efi' %} --nvram{% endif %}
+          {{ vm.name }}
       become: yes
+      changed_when: true
   when: vm.name in result.list_vms

tasks/destroy-volumes.yml

@@ -1,6 +1,6 @@
 ---
 - name: Ensure the VM volumes do not exist
-  script: >
+  ansible.builtin.script: >
     destroy_virt_volume.sh
     {{ item.name }}
     {{ item.pool | default('default') }}

tasks/main.yml

@@ -1,14 +1,14 @@
 ---
 - name: Gather os specific variables
-  include_vars: "{{ item }}"
+  ansible.builtin.include_vars: "{{ item }}"
   with_first_found:
     - files:
         - "{{ ansible_facts.distribution }}-{{ ansible_facts.distribution_major_version }}.yml"
         - "{{ ansible_facts.distribution }}.yml"
         - "{{ ansible_facts.os_family }}.yml"
   tags: vars
 
-- include_tasks: autodetect.yml
+- ansible.builtin.include_tasks: autodetect.yml
   # We don't need to know the engine and emulator if we're not creating any new
   # VMs.
   when: >-
@@ -17,20 +17,20 @@
 
 # Libvirt requires qemu-img to create qcow2 files.
 - name: Ensure qemu-img is installed
-  package:
+  ansible.builtin.package:
     name: "{{ 'qemu-img' if ansible_facts.os_family == 'RedHat' else 'qemu-utils' }}"
     update_cache: "{{ True if ansible_facts.pkg_mgr == 'apt' else omit }}"
   become: true
 
-- include_tasks: volumes.yml
+- ansible.builtin.include_tasks: volumes.yml
   vars:
     volumes: "{{ vm.volumes | default([], true) }}"
   with_items: "{{ libvirt_vms }}"
   loop_control:
     loop_var: vm
   when: (vm.state | default('present', true)) == 'present'
 
-- include_tasks: vm.yml
+- ansible.builtin.include_tasks: vm.yml
   vars:
     console_log_enabled: "{{ vm.console_log_enabled | default(false) }}"
     console_log_path: >-
@@ -45,18 +45,21 @@
     autostart: "{{ vm.autostart | default(true) }}"
     enable_vnc: "{{ vm.enable_vnc | default(false) }}"
     enable_spice: "{{ vm.enable_spice | default(false) }}"
+    boot_firmware: "{{ vm.boot_firmware | default('bios', true) | lower }}"
   with_items: "{{ libvirt_vms }}"
   loop_control:
     loop_var: vm
   when: (vm.state | default('present', true)) == 'present'
 
-- include_tasks: destroy-vm.yml
+- ansible.builtin.include_tasks: destroy-vm.yml
+  vars:
+    boot_firmware: "{{ vm.boot_firmware | default('bios', true) | lower }}"
   with_items: "{{ libvirt_vms }}"
   loop_control:
     loop_var: vm
   when: (vm.state | default('present', true)) == 'absent'
 
-- include_tasks: destroy-volumes.yml
+- ansible.builtin.include_tasks: destroy-volumes.yml
   vars:
     volumes: "{{ vm.volumes | default([], true) }}"
   with_items: "{{ libvirt_vms }}"

tasks/vm.yml

@@ -1,6 +1,6 @@
 ---
 - name: Ensure the VM console log directory exists
-  file:
+  ansible.builtin.file:
     path: "{{ console_log_path | dirname }}"
     state: directory
     owner: "{{ libvirt_vm_log_owner }}"
@@ -11,21 +11,21 @@
   become: "{{ libvirt_vm_sudo }}"
 
 - name: Validate VM interfaces
-  include_tasks: check-interface.yml
+  ansible.builtin.include_tasks: check-interface.yml
   vars:
     interface: "{{ item }}"
   with_items: "{{ interfaces }}"
 
 - name: Ensure the VM is defined
-  virt:
+  community.libvirt.virt:
     name: "{{ vm.name }}"
     command: define
     xml: "{{ lookup('template', vm.xml_file | default('vm.xml.j2')) }}"
     uri: "{{ libvirt_vm_uri | default(omit, true) }}"
   become: "{{ libvirt_vm_sudo }}"
 
 - name: Ensure the VM is running and started at boot
-  virt:
+  community.libvirt.virt:
     name: "{{ vm.name }}"
     autostart: "{{ autostart | bool }}"
     state: "{{ 'running' if (start | bool) else 'shutdown' }}"

tasks/volumes.yml

@@ -1,14 +1,14 @@
 ---
 - name: Ensure remote images are downloaded
-  get_url:
+  ansible.builtin.get_url:
     url: "{{ item.image }}"
     dest: "{{ libvirt_vm_image_cache_path }}/{{ item.image | basename }}"
     checksum: "{{ item.checksum | default(omit) }}"
   with_items: "{{ volumes | selectattr('image', 'defined') | list }}"
   when: "'http' in item.image"
 
 - name: Ensure local images are copied
-  copy:
+  ansible.builtin.copy:
     src: "{{ item.image }}"
     dest: "{{ libvirt_vm_image_cache_path }}/{{ item.image | basename }}"
     checksum: "{{ item.checksum | default(omit) }}"
@@ -17,7 +17,7 @@
   when: "'http' not in item.image"
 
 - name: Ensure the VM disk volumes exist
-  script: >
+  ansible.builtin.script: >
     virt_volume.sh
     -n {{ item.name }}
     -p {{ item.pool |default('default') }}
@@ -40,7 +40,7 @@
   become: true
 
 - name: Ensure the VM network volumes exist
-  command: qemu-img create -f {{ item.source.protocol }} {{ item.source.protocol }}:{{ item.source.name }} {{ item.capacity }}
+  ansible.builtin.command: qemu-img create -f {{ item.source.protocol }} {{ item.source.protocol }}:{{ item.source.name }} {{ item.capacity }}
   with_items: "{{ volumes }}"
   when: item.type | default(libvirt_volume_default_type) == 'network'
   register: volume_result_network

vars/Archlinux.yml

@@ -10,3 +10,10 @@ libvirt_vm_script_env: >-
 
 # Archlinux qemu comes with kvm support compiled in
 libvirt_vm_emulator: /usr/bin/qemu-system-x86_64
+
+# Path to template OVMF efi variable store. A copy will be created
+# for each VM created.
+libvirt_vm_ovmf_efi_variable_store_path: /usr/share/OVMF/OVMF_VARS.fd
+
+# Path to OVMF efi firmware
+libvirt_vm_ovmf_efi_firmware_path: /usr/share/OVMF/OVMF_CODE.fd

vars/Debian.yml

@@ -10,3 +10,10 @@ libvirt_vm_script_env_debian:
 
 libvirt_vm_script_env: >-
   {{ libvirt_vm_script_env_debian | combine(libvirt_vm_virsh_default_env) }}
+
+# Path to template OVMF efi variable store. A copy will be created
+# for each VM created.
+libvirt_vm_ovmf_efi_variable_store_path: /usr/share/OVMF/OVMF_VARS.fd
+
+# Path to OVMF efi firmware
+libvirt_vm_ovmf_efi_firmware_path: /usr/share/OVMF/OVMF_CODE.fd