cloudscale_ch.cloud.inventory – cloudscale.ch inventory source

Note

This plugin is part of the cloudscale_ch.cloud collection (version 2.0.0).

To install it use: ansible-galaxy collection install cloudscale_ch.cloud.

To use it in a playbook, specify: cloudscale_ch.cloud.inventory.

Synopsis
Parameters
Examples

Synopsis

Get inventory hosts from cloudscale.ch API
Uses an YAML configuration file ending with either cloudscale.yml or cloudscale.yaml to set parameter values (also see examples).

Parameters

Parameter	Choices/Defaults	Configuration	Comments
ansible_host string	public_v4 ← public_v6 private none		Which IP address to register as the ansible_host. If the requested value does not exist or this is set to 'none', no ansible_host will be set.
api_token string			cloudscale.ch API token. This can also be passed in the `CLOUDSCALE_API_TOKEN` environment variable.
compose dictionary	Default: {}		Create vars from jinja2 expressions.
groups dictionary	Default: {}		Add hosts to group based on Jinja2 conditionals.
inventory_hostname string	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.
keyed_groups list / elements=string	Default: []		Add hosts to group based on the values of a variable.
leading_separator boolean added in 2.11 of ansible.builtin	no yes ←		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.
plugin string / required	cloudscale		Token that ensures this is a source file for the 'cloudscale' plugin.
strict boolean	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.
use_extra_vars boolean added in 2.11 of ansible.builtin	no ← yes	ini entries: [inventory_plugins]use_extra_vars = no env:ANSIBLE_INVENTORY_USE_EXTRA_VARS	Merge extra vars into the available variables for composition (highest precedence).

Examples

# cloudscale.yml name ending file in YAML format
# Example command line: ansible-inventory --list -i inventory_cloudscale.yml

plugin: cloudscale_ch.cloud.inventory

# Example grouping by tag key "project"
plugin: cloudscale_ch.cloud.inventory
keyed_groups:
  - prefix: project
    key: cloudscale.tags.project

# Example grouping by key "operating_system" lowercased and prefixed with "os"
plugin: cloudscale_ch.cloud.inventory
keyed_groups:
  - prefix: os
    key: cloudscale.image.operating_system | lower

Authors

Gaudenz Steinlin (@gaudenz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cloudscale_ch/cloud/inventory_inventory.html