virt – Manages virtual machines supported by libvirt
virt – Manages virtual machines supported by libvirt
Synopsis
- 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
Parameter | Choices/Defaults | Comments |
---|---|---|
autostart boolean added in 2.3 |
|
start VM at host startup. |
command - |
|
In addition to state management, various non-idempotent commands are available. |
name - |
name of the guest VM being managed. Note that VM must be previously defined with xml. This option is required unless command is | |
state - |
|
Note that there may be some lag for state requests like |
uri - |
Default: "qemu:///system" |
libvirt connection uri. |
xml - |
XML document used with the define command. Must be raw XML content using |
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:///"
---
# a playbook example of defining and launching an LXC guest
tasks:
- name: define vm
virt:
name: foo
command: define
xml: "{{ lookup('template', 'container-template.xml.j2') }}"
uri: 'lxc:///'
- name: start vm
virt:
name: foo
state: running
uri: 'lxc:///'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
list_vms dictionary |
success |
The list of vms defined on the remote system
Sample: ['build.example.org', 'dev.example.org'] |
status string |
success |
The status of the VM, among running, crashed, paused and shutdown
Sample: success |
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
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/virt_module.html