| Parameter |
Choices/Defaults |
Configuration |
Comments |
|
all_projects
boolean
|
|
|
Lists servers from all projects
|
|
cache
boolean
|
|
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 = None
[inventory]
cache_connection = None
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
string
|
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
/ elements=string
|
|
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
|
|
|
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
|
|
|
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
|
|
|
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
/ elements=string
|
Default:
[]
|
|
Add hosts to group based on the values of a variable.
|
|
legacy_groups
boolean
|
|
|
Automatically create groups from host variables.
|
|
only_clouds
list
/ elements=string
|
Default:
[]
|
|
List of clouds from clouds.yaml to use, instead of using
the whole list.
|
|
plugin
string
/ required
|
|
|
token that ensures this is a source file for the 'openstack' plugin.
|
|
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.
|
|
show_all
boolean
|
|
|
toggles showing all vms vs only those with a working IP
|
|
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.
|
