community.libvirt.virt – Manages virtual machines supported by libvirt¶
Note
This plugin is part of the community.libvirt collection (version 1.0.1).
To install it use: ansible-galaxy collection install community.libvirt
.
To use it in a playbook, specify: community.libvirt.virt
.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.6
libvirt-python
Parameters¶
Examples¶
# a playbook task line:
- community.libvirt.virt:
name: alpha
state: running
# /usr/bin/ansible invocations
# ansible host -m virt -a "name=alpha command=status"
# ansible host -m virt -a "name=alpha command=get_xml"
# ansible host -m virt -a "name=alpha command=create uri=lxc:///"
# defining and launching an LXC guest
- name: define vm
community.libvirt.virt:
command: define
xml: "{{ lookup('template', 'container-template.xml.j2') }}"
uri: 'lxc:///'
- name: start vm
community.libvirt.virt:
name: foo
state: running
uri: 'lxc:///'
# setting autostart on a qemu VM (default uri)
- name: set autostart for a VM
community.libvirt.virt:
name: foo
autostart: yes
# Defining a VM and making is autostart with host. VM will be off after this task
- name: define vm from xml and set autostart
community.libvirt.virt:
command: define
xml: "{{ lookup('template', 'vm_template.xml.j2') }}"
autostart: yes
# Listing VMs
- name: list all VMs
community.libvirt.virt:
command: list_vms
register: all_vms
- name: list only running VMs
community.libvirt.virt:
command: list_vms
state: running
register: running_vms
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Ansible Core Team
Michael DeHaan
Seth Vidal (@skvidal)