Add support for setting the libvirt connection URI (#16)

Add support for setting the libvirt connection URI. This allows you to use connection URIs that differ from the default of: `qemu:///system'.

Author: jovial

README.md

@@ -27,6 +27,12 @@ Role Variables
 
 - `libvirt_vm_arch`: CPU architecture, default is `x86_64`.
 
+- `libvirt_vm_uri`: Override the libvirt connection URI. See the 
+  [libvirt docs](https://libvirt.org/remote.html) docs for more details.
+
+- `libvirt_vm_virsh_default_env`: Variables contained within this dictionary are
+  added to the environment used when executing virsh commands.
+
 - `libvirt_vms`: list of VMs to be created/destroyed. Each one may have the
   following attributes:
 

defaults/main.yml

@@ -61,6 +61,11 @@ libvirt_vms:
       # Path to console log file.
       console_log_path: "{{ libvirt_vm_console_log_path }}"
 
+# 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 {} }}"
+
+# Override for the libvirt connection uri. Leave unset to use the default. 
+libvirt_vm_uri: ""
 
 ### DEPRECATED ###
 # Use the above settings for each item within `libvirt_vms`, instead of the

tasks/destroy-vm.yml

@@ -5,6 +5,7 @@
   virt:
     name: "{{ vm.name }}"
     command: list_vms
+    uri: "{{ libvirt_vm_uri | default(omit, true) }}"
   register: result
   become: yes
 
@@ -13,11 +14,13 @@
       virt:
         name: "{{ vm.name }}"
         state: destroyed
+        uri: "{{ libvirt_vm_uri | default(omit, true) }}"
       become: yes
 
     - name: Ensure the VM is undefined
       virt:
         name: "{{ vm.name }}"
         command: undefine
+        uri: "{{ libvirt_vm_uri | default(omit, true) }}"
       become: yes
   when: vm.name in result.list_vms

tasks/destroy-volumes.yml

@@ -6,6 +6,7 @@
     {{ item.pool }}
   with_items: "{{ volumes }}"
   register: volume_result
+  environment: "{{ libvirt_vm_script_env }}"
   changed_when:
     - volume_result is success
     - (volume_result.stdout | from_json).changed | default(True)

tasks/main.yml

@@ -1,4 +1,13 @@
 ---
+- name: Gather os specific variables
+  include_vars: "{{ item }}"
+  with_first_found:
+    - files:
+        - "{{ ansible_distribution }}-{{ ansible_distribution_major_version}}.yml"
+        - "{{ ansible_distribution }}.yml"
+        - "{{ ansible_os_family }}.yml"
+  tags: vars
+
 - include_tasks: autodetect.yml
   # We don't need to know the engine and emulator if we're not creating any new
   # VMs.

tasks/vm.yml

@@ -1,14 +1,4 @@
 ---
-- name: Gather os specific variables
-  include_vars: "{{ item }}"
-  with_first_found:
-    - files:
-        - "{{ ansible_distribution }}-{{ ansible_distribution_major_version}}.yml"
-        - "{{ ansible_distribution }}.yml"
-        - "{{ ansible_os_family }}.yml"
-      skip: true
-  tags: vars
-
 - name: Ensure the VM console log directory exists
   file:
     path: "{{ console_log_path | dirname }}"
@@ -31,11 +21,13 @@
     name: "{{ vm.name }}"
     command: define
     xml: "{{ lookup('template', 'vm.xml.j2') }}"
+    uri: "{{ libvirt_vm_uri | default(omit, true) }}"
   become: true
 
 - name: Ensure the VM is running and started at boot
   virt:
     name: "{{ vm.name }}"
     autostart: "{{ autostart | bool }}"
     state: "{{ 'running' if (start | bool) else 'shutdown' }}"
+    uri: "{{ libvirt_vm_uri | default(omit, true) }}"
   become: true

tasks/volumes.yml

@@ -1,13 +1,4 @@
 ---
-- name: Gather os specific variables
-  include_vars: "{{ item }}"
-  with_first_found:
-    - files:
-        - "{{ ansible_distribution }}-{{ ansible_distribution_major_version}}.yml"
-        - "{{ ansible_distribution }}.yml"
-        - "{{ ansible_os_family }}.yml"
-  tags: vars
-
 - name: Ensure remote images are downloaded
   get_url:
     url: "{{ item }}"
@@ -33,7 +24,7 @@
     {{ libvirt_vm_image_cache_path }}/{{ item.image | basename }}
     {% endif %}
   with_items: "{{ volumes }}"
-  environment: "{{ libvirt_vm_volume_creation_env }}"
+  environment: "{{ libvirt_vm_script_env }}"
   register: volume_result
   changed_when:
     - volume_result is success

vars/Debian.yml

@@ -4,4 +4,4 @@
 libvirt_vm_log_owner: libvirt-qemu
 
 # The environment passed to virt_volume.sh
-libvirt_vm_volume_creation_env: {}
+libvirt_vm_script_env: "{{ libvirt_vm_virsh_default_env }}"

vars/RedHat.yml

@@ -4,6 +4,9 @@
 libvirt_vm_log_owner: qemu
 
 # The environment passed to virt_volume.sh
-libvirt_vm_volume_creation_env:
+libvirt_vm_script_env_redhat:
   VOLUME_GROUP: qemu
   VOLUME_OWNER: qemu
+
+libvirt_vm_script_env: >-
+  {{ libvirt_vm_script_env_redhat | combine(libvirt_vm_virsh_default_env) }}