ansible / ansible.builtin / v2.9.27 / module / virt Manages virtual machines supported by libvirt | "added in version" 0.2 of ansible.builtin" Authors: Ansible Core Team, Michael DeHaan, Seth Vidal (@skvidal) preview | supported by communityansible.builtin.virt (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
Manages virtual machines supported by I(libvirt).
# 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
uri: default: qemu:///system description: - libvirt connection uri. xml: description: - XML document used with the define command. - Must be raw XML content using C(lookup). XML cannot be reference to a file. name: description: - name of the guest VM being managed. Note that VM must be previously defined with xml. - This option is required unless I(command) is C(list_vms). state: choices: - destroyed - paused - running - shutdown description: - Note that there may be some lag for state requests like C(shutdown) since these refer only to VM states. After starting a guest, it may not be immediately accessible. state and command are mutually exclusive except when command=list_vms. In this case all VMs in specified state will be listed. command: choices: - create - define - destroy - freemem - get_xml - info - list_vms - nodeinfo - pause - shutdown - start - status - stop - undefine - unpause - virttype description: - In addition to state management, various non-idempotent commands are available. autostart: description: - start VM at host startup. type: bool version_added: '2.3' version_added_collection: ansible.builtin
list_vms: description: The list of vms defined on the remote system returned: success sample: - build.example.org - dev.example.org type: list status: description: The status of the VM, among running, crashed, paused and shutdown returned: success sample: success type: str