community.general.opennebula inventory – OpenNebula inventory source
Note
This inventory plugin is part of the community.general collection (version 9.5.0).
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 community.general
.
To use it in a playbook, specify: community.general.opennebula
.
New in community.general 3.8.0
Synopsis
Get inventory hosts from OpenNebula cloud.
Uses an YAML configuration file ending with either
opennebula.yml
oropennebula.yaml
to set parameter values.Uses
api_authfile
,~/.one/one_auth
, orONE_AUTH
pointing to a OpenNebula credentials file.
Parameters
Parameter |
Comments |
---|---|
If both Set environment variable Configuration:
|
|
Password or a token of the user to login into OpenNebula RPC server. If not set, the value of the Configuration:
|
|
Name of the user to login into the OpenNebula RPC server. If not set then the value of the Configuration:
|
|
Create vars from jinja2 expressions. Default: |
|
Only return servers filtered by this label. |
|
Create host groups by vm labels Choices:
|
|
Add hosts to group based on Jinja2 conditionals. Default: |
|
Field to match the hostname. Note Choices:
|
|
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 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:
|
|
Token that ensures this is a source file for the ‘opennebula’ plugin. 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
# inventory_opennebula.yml file in YAML format
# Example command line: ansible-inventory --list -i inventory_opennebula.yml
# Pass a label filter to the API
plugin: community.general.opennebula
api_url: https://opennebula:2633/RPC2
filter_by_label: Cache