cache

boolean

Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work.

Choices:

• false ← (default)
• true

Configuration:

• INI entry:

  [inventory]
  cache = false
  

• Environment variable: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Cache connection data or path, read cache plugin documentation for specifics.

Configuration:

• INI entries:

  [defaults]
  fact_caching_connection = VALUE
  

  [inventory]
  cache_connection = VALUE
  

• Environment variable: ANSIBLE_CACHE_PLUGIN_CONNECTION
• Environment variable: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Cache plugin to use for the inventory’s source data.

Default: "memory"

Configuration:

• INI entries:

  [defaults]
  fact_caching = memory
  

  [inventory]
  cache_plugin = memory
  

• Environment variable: ANSIBLE_CACHE_PLUGIN
• Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Prefix to use for cache plugin files/tables.

Default: "ansible_inventory_"

Configuration:

• INI entries:

  [defaults]
  fact_caching_prefix = ansible_inventory_
  

  [inventory]
  cache_prefix = ansible_inventory_
  

• Environment variable: ANSIBLE_CACHE_PLUGIN_PREFIX
• Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Cache duration in seconds.

Default: 3600

Configuration:

• INI entries:

  [defaults]
  fact_caching_timeout = 3600
  

  [inventory]
  cache_timeout = 3600
  

• Environment variable: ANSIBLE_CACHE_PLUGIN_TIMEOUT
• Environment variable: ANSIBLE_INVENTORY_CACHE_TIMEOUT

compose

dictionary

Create vars from jinja2 expressions.

Default: {}

filters

list / elements=dictionary

added in community.hrobot 2.0.0

A list of include/exclude filters that allows to select/deselect hosts for this inventory.

Filters are processed sequentially until the first filter where filters[].exclude or filters[].include matches is found. In case filters[].exclude matches, the host is excluded, and in case filters[].include matches, the host is included. In case no filter matches, the host is included.

exclude

string

A Jinja2 condition. If it matches for a host, that host is excluded.

Exactly one of filters[].exclude and filters[].include can be specified.

include

string

A Jinja2 condition. If it matches for a host, that host is included.

Exactly one of filters[].exclude and filters[].include can be specified.

groups

dictionary

Add hosts to group based on Jinja2 conditionals.

Default: {}

hetzner_password

string / required

The password for the Robot web-service user.

Configuration:

• Environment variable: HROBOT_API_PASSWORD

hetzner_user

string / required

The username for the Robot web-service user.

Configuration:

• Environment variable: HROBOT_API_USER

keyed_groups

list / elements=dictionary

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

Default: []

default_value

string

added in ansible-core 2.12

The default value when the host variable’s value is an empty string.

This option is mutually exclusive with keyed_groups[].trailing_separator.

key

string

The key from input dictionary used to generate groups.

parent_group

string

parent group for keyed group.

prefix

string

A keyed group name will start with this prefix.

Default: ""

separator

string

separator used to build the keyed group name.

Default: "_"

trailing_separator

boolean

added in ansible-core 2.12

Set this option to false to omit the keyed_groups[].separator after the host variable when the value is an empty string.

This option is mutually exclusive with keyed_groups[].default_value.

Choices:

• false
• true ← (default)

leading_separator

boolean

added in ansible-core 2.11

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:

• false
• true ← (default)

plugin

string / required

Token that ensures this is a source file for the plugin.

Choices:

• "community.hrobot.robot"

rate_limit_retry_timeout

integer

added in community.hrobot 2.1.0

Timeout (in seconds) for waiting when rate limit exceeded errors are returned.

Set to 0 to not retry.

Set to a negative value like -1 to retry forever.

Default: -1

simple_filters

dictionary

A dictionary of filter value pairs.

Available filters are listed here are keys of server like status or server_ip.

See https://robot.your-server.de/doc/webservice/en.html#get-server for all values that can be used.

This option used to be called filters before community.hrobot 2.0.0. It has been renamed from filters to simple_filters in community.hrobotdns 1.9.0, and the old name was still available as an alias until community.hrobot 2.0.0. filters is now used for something else.

Default: {}

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:

• false ← (default)
• true

use_extra_vars

boolean

added in ansible-core 2.11

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

Choices:

• false ← (default)
• true

Configuration:

• INI entry:

  [inventory_plugins]
  use_extra_vars = false
  

• Environment variable: ANSIBLE_INVENTORY_USE_EXTRA_VARS