openstack.cloud.openstack inventory – OpenStack inventory source
Note
This inventory plugin is part of the openstack.cloud collection (version 1.10.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
.
You need further requirements to be able to use this inventory plugin,
see Requirements for details.
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.
python >= 3.6
openstacksdk >= 0.28, < 0.99.0
Parameters
Parameter |
Comments |
---|---|
Lists servers from all projects Choices:
|
|
Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work. Choices:
Configuration:
|
|
Cache connection data or path, read cache plugin documentation for specifics. Configuration:
|
|
Cache plugin to use for the inventory’s source data. Default: Configuration:
|
|
Prefix to use for cache plugin files/tables Default: Configuration:
|
|
Cache duration in seconds Default: Configuration:
|
|
Configuration:
|
|
Create vars from jinja2 expressions. Default: |
|
Choices:
|
|
Choices:
|
|
Add hosts to group based on Jinja2 conditionals. Default: |
|
Choices:
|
|
Add hosts to group based on the values of a variable. Default: |
|
The default value when the host variable’s value is an empty string. This option is mutually exclusive with |
|
The key from input dictionary used to generate groups |
|
parent group for keyed group |
|
A keyed group name will start with this prefix Default: |
|
separator used to build the keyed group name Default: |
|
Set this option to False to omit the This option is mutually exclusive with Choices:
|
|
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:
|
|
Automatically create groups from host variables. Choices:
|
|
Default: |
|
token that ensures this is a source file for the ‘openstack’ plugin. Choices:
|
|
Choices:
|
|
toggles showing all vms vs only those with a working IP Choices:
|
|
If Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. Choices:
|
|
Merge extra vars into the available variables for composition (highest precedence). Choices:
Configuration:
|
|
Choices:
|
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