ovirt.ovirt.ovirt inventory – oVirt inventory source
Note
This inventory plugin is part of the ovirt.ovirt collection (version 1.6.6).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ovirt.ovirt
.
To use it in a playbook, specify: ovirt.ovirt.ovirt
.
New in version 1.0.0: of ovirt.ovirt
Synopsis
Get inventory hosts from the ovirt service.
Requires a YAML file ending in ‘ovirt.yml’, ‘ovirt4.yml’, ‘ovirt.yaml’, ‘ovirt4.yaml’.
Requirements
The below requirements are needed on the local controller node that executes this inventory.
ovirt-engine-sdk-python >= 4.2.4
Parameters
Parameter |
Comments |
---|---|
Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work. Choices:
Configuration:
|
|
Cache connection data or path, read cache plugin documentation for specifics. Configuration:
|
|
Cache plugin to use for the inventory’s source data. Default: “memory” Configuration:
|
|
Prefix to use for cache plugin files/tables Default: “ansible_inventory_” Configuration:
|
|
Cache duration in seconds Default: 3600 Configuration:
|
|
Create vars from jinja2 expressions. Default: {} |
|
Add hosts to group based on Jinja2 conditionals. Default: {} |
|
Add hosts to group based on the values of a variable. Default: [] |
|
The default value when the host variable’s value is an empty string. This option is mutually exclusive with |
|
The key from input dictionary used to generate groups |
|
parent group for keyed group |
|
A keyed group name will start with this prefix Default: “” |
|
separator used to build the keyed group name Default: “_” |
|
Set this option to False to omit the This option is mutually exclusive with Choices:
|
|
Use in conjunction with keyed_groups. By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. This is because the default prefix is “” and the default separator is “_”. Set this option to False to omit the leading underscore (or other separator) if no prefix is given. If the group name is derived from a mapping the separator is still used to concatenate the items. To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. Choices:
|
|
path to ovirt-engine CA file. If |
|
list of options that describe the ordering for which hostnames should be assigned. See https://ovirt.github.io/ovirt-engine-api-model/master/#types/vm for available attributes. Default: [“fqdn”, “name”] |
|
A boolean flag that indicates if the server TLS certificate and host name should be checked. |
|
ovirt authentication password. Configuration:
|
|
dictionary of filter key-values to query VM’s. See https://ovirt.github.io/ovirt-engine-sdk/master/services.m.html#ovirtsdk4.services.VmsService.list for filter parameters. |
|
URL to ovirt-engine API. Configuration:
|
|
ovirt authentication user. Configuration:
|
|
the name of this plugin, it should always be set to ‘ovirt’ for this plugin to recognise it as it’s own. Choices:
|
|
If Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. Choices:
|
|
Merge extra vars into the available variables for composition (highest precedence). Choices:
Configuration:
|
Examples
# Ensure the CA is available:
# $ wget "https://engine/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA" -O /path/to/ca.pem
# Sample content of ovirt.yml:
plugin: ovirt.ovirt.ovirt
ovirt_url: https://engine/ovirt-engine/api
ovirt_cafile: /path/to/ca.pem
ovirt_username: ansible-tester
ovirt_password: secure
ovirt_query_filter:
search: 'name=myvm AND cluster=mycluster'
case_sensitive: no
max: 15
keyed_groups:
- key: cluster
prefix: 'cluster'
groups:
dev: "'dev' in tags"
compose:
ansible_host: devices["eth0"][0]
Authors
Bram Verschueren (@bverschueren)
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.