cloudscale_ch.cloud.inventory – cloudscale.ch inventory source

cloudscale_ch.cloud.inventory – cloudscale.ch inventory source

Note

This plugin is part of the cloudscale_ch.cloud collection (version 1.3.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
• Notes
• 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_timeout integer	Default: 30		Timeout in seconds for calls to the cloudscale.ch API.
api_token string / required			cloudscale.ch API token. This can also be passed in the CLOUDSCALE_API_TOKEN environment variable.
api_url string added in 1.3.0 of cloudscale_ch.cloud	Default: "https://api.cloudscale.ch/v1%22		cloudscale.ch API URL. This can also be passed in the CLOUDSCALE_API_URL 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.
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.

Notes

Note

• All operations are performed using the cloudscale.ch public API v1.
• For details consult the full API documentation: https://www.cloudscale.ch/en/api/v1.
• A valid API token is required for all operations. You can create as many tokens as you like using the cloudscale.ch control panel at https://control.cloudscale.ch.

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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cloudscale_ch/cloud/inventory_inventory.html