openstack.cloud.openstack inventory – OpenStack inventory source

Note

This inventory plugin is part of the openstack.cloud collection (version 1.8.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 openstack.cloud.

To use it in a playbook, specify: openstack.cloud.openstack.

Synopsis

  • Get inventory hosts from OpenStack clouds

  • Uses openstack.(yml|yaml) YAML configuration file to configure the inventory plugin

  • Uses standard clouds.yaml YAML configuration file to configure cloud credentials

Requirements

The below requirements are needed on the local controller node that executes this inventory.

  • openstacksdk >= 0.28

Parameters

Parameter

Comments

all_projects

boolean

Lists servers from all projects

Choices:

  • no ← (default)

  • yes

cache

boolean

Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work.

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [inventory]
cache = no

  • Environment variable: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Cache connection data or path, read cache plugin documentation for specifics.

Configuration:

  • INI entries:

    [defaults]
fact_caching_connection = None

    [inventory]
cache_connection = None

  • Environment variable: ANSIBLE_CACHE_PLUGIN_CONNECTION

  • Environment variable: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Cache plugin to use for the inventory’s source data.

Default: “memory”

Configuration:

  • INI entries:

    [defaults]
fact_caching = memory

    [inventory]
cache_plugin = memory

  • Environment variable: ANSIBLE_CACHE_PLUGIN

  • Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Prefix to use for cache plugin files/tables

Default: “ansible_inventory_”

Configuration:

  • INI entries:

    [default]
fact_caching_prefix = ansible_inventory_

    Removed in: version 2.16 of ansible.builtin

    Why: Fixes typing error in INI section name

    Alternative: Use the ‘defaults’ section instead

    [defaults]
fact_caching_prefix = ansible_inventory_

    [inventory]
cache_prefix = ansible_inventory_

  • Environment variable: ANSIBLE_CACHE_PLUGIN_PREFIX

  • Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Cache duration in seconds

Default: 3600

Configuration:

  • INI entries:

    [defaults]
fact_caching_timeout = 3600

    [inventory]
cache_timeout = 3600

  • Environment variable: ANSIBLE_CACHE_PLUGIN_TIMEOUT

  • Environment variable: ANSIBLE_INVENTORY_CACHE_TIMEOUT

clouds_yaml_path

list / elements=string
Override path to clouds.yaml file. If this value is given it

will be searched first. The default path for the ansible inventory adds /etc/ansible/openstack.yaml and /etc/ansible/openstack.yml to the regular locations documented at https://docs.openstack.org/os-client-config/latest/user/configuration.html#config-files

Configuration:

  • Environment variable: OS_CLIENT_CONFIG_FILE

compose

dictionary

Create vars from jinja2 expressions.

Default: {}

expand_hostvars

boolean
Run extra commands on each host to fill in additional

information about the host. May interrogate cinder and neutron and can be expensive for people with many hosts. (Note, the default value of this is opposite from the default old openstack.py inventory script’s option expand_hostvars)

Choices:

  • no ← (default)

  • yes

fail_on_errors

boolean
Causes the inventory to fail and return no hosts if one cloud

has failed (for example, bad credentials or being offline). When set to False, the inventory will return as many hosts as it can from as many clouds as it can contact. (Note, the default value of this is opposite from the old openstack.py inventory script’s option fail_on_errors)

Choices:

  • no ← (default)

  • yes

groups

dictionary

Add hosts to group based on Jinja2 conditionals.

Default: {}

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’, which is the opposite of the old openstack.py inventory script’s option use_hostnames)

Choices:

  • name ← (default)

  • uuid

keyed_groups

list / elements=dictionary

Add hosts to group based on the values of a variable.

Default: []

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

A keyed group name will start with this prefix

Default: “”

separator

string

separator used to build the keyed group name

Default: “_”

trailing_separator

boolean

added in 2.12 of ansible.builtin

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.

Choices:

  • no

  • yes ← (default)

leading_separator

boolean

added in 2.11 of ansible.builtin

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:

  • no

  • yes ← (default)

legacy_groups

boolean

Automatically create groups from host variables.

Choices:

  • no

  • yes ← (default)

only_clouds

list / elements=string
List of clouds from clouds.yaml to use, instead of using

the whole list.

Default: []

plugin

string / required

token that ensures this is a source file for the ‘openstack’ plugin.

Choices:

  • openstack

  • openstack.cloud.openstack

private

boolean
Use the private interface of each server, if it has one, as

the host’s IP in the inventory. This can be useful if you are running ansible inside a server in the cloud and would rather communicate to your servers over the private network.

Choices:

  • no ← (default)

  • yes

show_all

boolean

toggles showing all vms vs only those with a working IP

Choices:

  • no ← (default)

  • yes

strict

boolean

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.

Choices:

  • no ← (default)

  • yes

use_extra_vars

boolean

added in 2.11 of ansible.builtin

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

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [inventory_plugins]
use_extra_vars = no

  • Environment variable: ANSIBLE_INVENTORY_USE_EXTRA_VARS

use_names

boolean
Use the host’s ‘name’ instead of ‘interface_ip’ for the ‘ansible_host’ and

‘ansible_ssh_host’ facts. This might be desired when using jump or bastion hosts and the name is the FQDN of the host.

Choices:

  • no ← (default)

  • yes

Examples

# file must be named openstack.yaml or openstack.yml
# Make the plugin behave like the default behavior of the old script
plugin: openstack.cloud.openstack
expand_hostvars: yes
fail_on_errors: yes
all_projects: yes

Authors

  • OpenStack Ansible SIG

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.