community.general.opennebula – OpenNebula inventory source

Note

This plugin is part of the community.general collection (version 4.2.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 version 3.8.0: of community.general

Synopsis

  • Get inventory hosts from OpenNebula cloud.

  • Uses an YAML configuration file ending with either opennebula.yml or opennebula.yaml to set parameter values.

  • Uses api_authfile, ~/.one/one_auth, or ONE_AUTH pointing to a OpenNebula credentials file.

Parameters

Parameter Choices/Defaults Configuration Comments
api_authfile
string
env:ONE_AUTH
If both api_username or api_password are not set, then it will try authenticate with ONE auth file. Default path is ~/.one/one_auth.
Set environment variable ONE_AUTH to override this path.
api_password
string
env:ONE_PASSWORD
Password or a token of the user to login into OpenNebula RPC server.
If not set, the value of the ONE_PASSWORD environment variable is used.
api_url
string / required
env:ONE_URL
URL of the OpenNebula RPC server.
It is recommended to use HTTPS so that the username/password are not transferred over the network unencrypted.
If not set then the value of the ONE_URL environment variable is used.
api_username
string
env:ONE_USERNAME
Name of the user to login into the OpenNebula RPC server. If not set then the value of the ONE_USERNAME environment variable is used.
compose
dictionary
Default:
{}
Create vars from jinja2 expressions.
filter_by_label
string
Only return servers filtered by this label.
group_by_labels
boolean
    Choices:
  • no
  • yes ←
Create host groups by vm labels
groups
dictionary
Default:
{}
Add hosts to group based on Jinja2 conditionals.
hostname
string
    Choices:
  • v4_first_ip ←
  • v6_first_ip
  • name
Field to match the hostname. Note v4_first_ip corresponds to the first IPv4 found on VM.
keyed_groups
list / elements=dictionary
Default:
[]
Add hosts to group based on the values of a variable.
default_value
string
added in 2.12 of ansible.builtin
The default value when the host variable's value is an empty string.
This option is mutually exclusive with trailing_separator.
key
string
The key from input dictionary used to generate groups
parent_group
string
parent group for keyed group
prefix
string
Default:
""
A keyed group name will start with this prefix
separator
string
Default:
"_"
separator used to build the keyed group name
trailing_separator
boolean
added in 2.12 of ansible.builtin
    Choices:
  • no
  • yes ←
Set this option to False to omit the separator after the host variable when the value is an empty string.
This option is mutually exclusive with default_value.
leading_separator
boolean
added in 2.11 of ansible.builtin
    Choices:
  • no
  • yes ←
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.
plugin
string / required
    Choices:
  • community.general.opennebula
Token that ensures this is a source file for the 'opennebula' plugin.
strict
boolean
    Choices:
  • no ←
  • yes
If yes make invalid entries a fatal error, otherwise skip and continue.
Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.
use_extra_vars
boolean
added in 2.11 of ansible.builtin
    Choices:
  • no ←
  • yes
ini entries:

[inventory_plugins]
use_extra_vars = no

env:ANSIBLE_INVENTORY_USE_EXTRA_VARS
Merge extra vars into the available variables for composition (highest precedence).

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

Authors

  • Kristian Feldsam (@feldsam)