Documentation

openstack - OpenStack inventory source

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

Options

parameter
required
default
choices
configuration
comments
fail_on_errors
no
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)
inventory_hostname
no
name
  • 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)
compose
no
Create vars from jinja2 expressions.
clouds_yaml_path
no
None
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
expand_hostvars
no
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)
show_all
no
toggles showing all vms vs only those with a working IP
only_clouds
no
List of clouds from clouds.yaml to use, instead of using the whole list.
private
no
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.
groups
no
Add hosts to group based on Jinja2 conditionals.

Examples

# file must be named openstack.yaml or openstack.yml
# Make the plugin behave like the default behavior of the old script
simple_config_file:
    plugin: openstack
    inventory_hostname: 'name'
    expand_hostvars: true
    fail_on_errors: true

Author

  • UNKNOWN

If you want to help with development, please read Community Information & Contributing, Testing Ansible and Developing Plugins.