virt – Manages virtual machines supported by libvirt¶
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- libvirt-python
Parameters¶
Examples¶
# a playbook task line:
- 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
  virt:
    command: define
    xml: "{{ lookup('template', 'container-template.xml.j2') }}"
    uri: 'lxc:///'
- name: start vm
  virt:
    name: foo
    state: running
    uri: 'lxc:///'
# setting autostart on a qemu VM (default uri)
- name: set autostart for a VM
  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
  virt:
    command: define
    xml: "{{ lookup('template', 'vm_template.xml.j2') }}"
    autostart: yes
# Listing VMs
- name: list all VMs
  virt:
    command: list_vms
  register: all_vms
- name: list only running VMs
  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:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Ansible Core Team
- Michael DeHaan
- Seth Vidal (@skvidal)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
