- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# openstack – OpenStack inventory source

- Synopsis

- Requirements

- Parameters

- Examples

- Status

## 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 master node that executes this inventory.

- openstacksdk

## Parameters

Parameter | Choices/Defaults | Configuration | Comments
--- | --- | --- | ---
cache boolean | Choices: no ← yes | ini entries: [inventory] cache = no env:ANSIBLE_INVENTORY_CACHE | Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work.
cache_connection string |  | ini entries: [defaults] fact_caching_connection = VALUE [inventory] cache_connection = VALUE env:ANSIBLE_CACHE_PLUGIN_CONNECTION env:ANSIBLE_INVENTORY_CACHE_CONNECTION | Cache connection data or path, read cache plugin documentation for specifics.
cache_plugin string | Default: "memory" | ini entries: [defaults] fact_caching = memory [inventory] cache_plugin = memory env:ANSIBLE_CACHE_PLUGIN env:ANSIBLE_INVENTORY_CACHE_PLUGIN | Cache plugin to use for the inventory's source data.
cache_prefix - | Default: "ansible_inventory_" | ini entries: [default] fact_caching_prefix = ansible_inventory_ [inventory] cache_prefix = ansible_inventory_ env:ANSIBLE_CACHE_PLUGIN_PREFIX env:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX | Prefix to use for cache plugin files/tables
cache_timeout integer | Default: 3600 | ini entries: [defaults] fact_caching_timeout = 3600 [inventory] cache_timeout = 3600 env:ANSIBLE_CACHE_PLUGIN_TIMEOUT env:ANSIBLE_INVENTORY_CACHE_TIMEOUT | Cache duration in seconds
clouds_yaml_path list |  | env:OS_CLIENT_CONFIG_FILE | 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
compose dictionary | Default: {} |  | Create vars from jinja2 expressions.
expand_hostvars boolean | Choices: no ← yes |  | 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)
fail_on_errors boolean | Choices: no ← yes |  | 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)
groups dictionary | Default: {} |  | Add hosts to group based on Jinja2 conditionals.
inventory_hostname string | Choices: name ← uuid |  | 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)
keyed_groups list | Default: [] |  | Add hosts to group based on the values of a variable.
only_clouds list | Default: [] |  | List of clouds from clouds.yaml to use, instead of using the whole list.
plugin - / required | Choices: openstack |  | token that ensures this is a source file for the 'openstack' plugin.
private boolean | Choices: no ← yes |  | 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.
show_all boolean | Choices: no ← yes |  | toggles showing all vms vs only those with a working IP
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.

## Examples

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

## Status

- This inventory is not guaranteed to have a backwards compatible interface. [preview]

- This inventory is maintained by the Ansible Community. [community]

### Authors

- Marco Vito Moscaritolo <marco@agavee.com>

- Jesse Keating <jesse.keating@rackspace.com>

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

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.