community.libvirt.libvirt – Libvirt inventory source
community.libvirt.libvirt – Libvirt inventory source
Note
This plugin is part of the community.libvirt collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.libvirt
.
To use it in a playbook, specify: community.libvirt.libvirt
.
New in version 2.10: of community.libvirt
Synopsis
- Get libvirt guests in an inventory source
Requirements
The below requirements are needed on the local controller node that executes this inventory.
- libvirt-python
Parameters
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
compose dictionary |
Default: {} |
Create vars from jinja2 expressions. | |
groups dictionary |
Default: {} |
Add hosts to group based on Jinja2 conditionals. | |
inventory_hostname string |
|
What to register as the inventory hostname. If set to 'uuid' the uuid of the server will be used and a group will be created for the server name. If set to 'name' the name of the server will be used unless there are more than one server with the same name in which case the 'uuid' logic will be used. Default is to do 'name' | |
keyed_groups list / elements=string |
Default: [] |
Add hosts to group based on the values of a variable. | |
plugin string / required |
|
Token that ensures this is a source file for the 'libvirt' plugin. | |
strict boolean |
|
If Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. | |
uri string / required |
Libvirt Connection URI |
Examples
# Connect to lxc host
plugin: community.libvirt.libvirt
uri: 'lxc:///'
# Connect to qemu
plugin: community.libvirt.libvirt
uri: 'qemu:///system'
Authors
- Dave Olsthoorn <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/libvirt/libvirt_inventory.html