openstack - OpenStack inventory source


  • 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


Parameter Choices/Defaults Configuration Comments
clouds_yaml_path Default:
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
compose Default:
Create vars from jinja2 expressions.
expand_hostvars Default:
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 inventory script's option expand_hostvars)
fail_on_errors Default:
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 inventory script's option fail_on_errors)
groups Default:
Add hosts to group based on Jinja2 conditionals.
  • 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 inventory script's option use_hostnames)
only_clouds Default:
List of clouds from clouds.yaml to use, instead of using the whole list.
private Default:
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 Default:
toggles showing all vms vs only those with a working IP


# 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





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