hetzner.hcloud.hcloud – Ansible dynamic inventory plugin for the Hetzner Cloud.

Note

This plugin is part of the hetzner.hcloud collection (version 1.6.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 hetzner.hcloud.

To use it in a playbook, specify: hetzner.hcloud.hcloud.

Synopsis

  • Reads inventories from the Hetzner Cloud API.

  • Uses a YAML configuration file that ends with hcloud.(yml|yaml).

Requirements

The below requirements are needed on the local controller node that executes this inventory.

  • python >= 2.7

  • hcloud-python >= 1.0.0

Parameters

Parameter

Comments

compose

dictionary

Create vars from jinja2 expressions.

Default: {}

connect_with

string

Connect to the server using the value from this field.

Choices:

  • public_ipv4 ← (default)

  • hostname

  • ipv4_dns_ptr

  • private_ipv4

groups

dictionary

Add hosts to group based on Jinja2 conditionals.

Default: {}

images

list / elements=string

Populate inventory with instances with this image name, only available for system images.

Default: []

keyed_groups

list / elements=string

Add hosts to group based on the values of a variable.

Default: []

label_selector

string

Populate inventory with instances with this label.

Default: “”

leading_separator

boolean

added in 2.11 of ansible.builtin

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:

  • no

  • yes ← (default)

locations

list / elements=string

Populate inventory with instances in this location.

Default: []

network

string

Populate inventory with instances which are attached to this network name or ID.

Default: “”

plugin

string / required

marks this as an instance of the “hcloud” plugin

Choices:

  • hcloud

  • hetzner.hcloud.hcloud

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.

Choices:

  • no ← (default)

  • yes

token

string

The Hetzner Cloud API Token.

token_env

string

Environment variable to load the Hetzner Cloud API Token from.

Default: “HCLOUD_TOKEN”

types

list / elements=string

Populate inventory with instances with this type.

Default: []

use_extra_vars

boolean

added in 2.11 of ansible.builtin

Merge extra vars into the available variables for composition (highest precedence).

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [inventory_plugins]
    use_extra_vars = no
    
  • Environment variable: ANSIBLE_INVENTORY_USE_EXTRA_VARS

Examples

# Minimal example. `HCLOUD_TOKEN` is exposed in environment.
plugin: hcloud

# Example with locations, types, groups and token
plugin: hcloud
token: foobar
locations:
  - nbg1
types:
  - cx11

# Group by a location with prefix e.g. "hcloud_location_nbg1"
# and image_os_flavor without prefix and separator e.g. "ubuntu"
# and status with prefix e.g. "server_status_running"
plugin: hcloud
keyed_groups:
  - key: location
    prefix: hcloud_location
  - key: image_os_flavor
    separator: ""
  - key: status
    prefix: server_status

Authors

  • Lukas Kaemmerling (@lkaemmerling)