ansible.builtin.hcloud (v2.9.27) — inventory

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Reads inventories from the Hetzner Cloud API.

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

Requirements

• python >= 2.7
• hcloud-python >= 1.0.0

Inputs

    
token:
    description: The Hetzner Cloud API Token.
    env:
    - name: HCLOUD_TOKEN
    required: true

types:
    default: []
    description: Populate inventory with instances with this type.
    required: false
    type: list

groups:
    default: {}
    description: Add hosts to group based on Jinja2 conditionals.
    type: dict

images:
    default: []
    description: Populate inventory with instances with this image name, only available
      for system images.
    required: false
    type: list

plugin:
    choices:
    - hcloud
    description: marks this as an instance of the "hcloud" plugin
    required: true

strict:
    default: false
    description:
    - If V(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.
    type: bool

compose:
    default: {}
    description: Create vars from jinja2 expressions.
    type: dict

locations:
    default: []
    description: Populate inventory with instances in this location.
    required: false
    type: list

connect_with:
    choices:
    - public_ipv4
    - hostname
    - ipv4_dns_ptr
    default: public_ipv4
    description: Connect to the server using the value from this field.
    type: str

keyed_groups:
    default: []
    description: Add hosts to group based on the values of a variable.
    elements: dict
    suboptions:
      default_value:
        description:
        - The default value when the host variable's value is an empty string.
        - This option is mutually exclusive with O(keyed_groups[].trailing_separator).
        type: str
        version_added: '2.12'
        version_added_collection: ansible.builtin
      key:
        description:
        - The key from input dictionary used to generate groups
        type: str
      parent_group:
        description: parent group for keyed group
        type: str
      prefix:
        default: ''
        description: A keyed group name will start with this prefix
        type: str
      separator:
        default: _
        description: separator used to build the keyed group name
        type: str
      trailing_separator:
        default: true
        description:
        - Set this option to V(False) to omit the O(keyed_groups[].separator) after the
          host variable when the value is an empty string.
        - This option is mutually exclusive with O(keyed_groups[].default_value).
        type: bool
        version_added: '2.12'
        version_added_collection: ansible.builtin
    type: list

label_selector:
    default: ''
    description: Populate inventory with instances with this label.
    required: false
    type: str

use_extra_vars:
    default: false
    description: Merge extra vars into the available variables for composition (highest
      precedence).
    env:
    - name: ANSIBLE_INVENTORY_USE_EXTRA_VARS
    ini:
    - key: use_extra_vars
      section: inventory_plugins
    type: bool
    version_added: '2.11'
    version_added_collection: ansible.builtin

leading_separator:
    default: true
    description:
    - 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.
    type: boolean
    version_added: '2.11'
    version_added_collection: ansible.builtin