cloudscale_ch.cloud.inventory – cloudscale.ch inventory source

Note

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

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

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

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
    Choices:
  • 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
    Choices:
  • 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.
plugin
string / required
    Choices:
  • cloudscale
Token that ensures this is a source file for the 'cloudscale' plugin.
strict
boolean
    Choices:
  • 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.

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)