api_host

string

API host to XOA API.

If the value is not specified in the inventory configuration, the value of environment variable ANSIBLE_XO_HOST will be used instead.

Configuration:

• Environment variable: ANSIBLE_XO_HOST

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: {}

groups

dictionary

Add hosts to group based on Jinja2 conditionals.

Default: {}

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)

password

string / required

Xen Orchestra password.

If the value is not specified in the inventory configuration, the value of environment variable ANSIBLE_XO_PASSWORD will be used instead.

Configuration:

• Environment variable: ANSIBLE_XO_PASSWORD

plugin

string / required

The name of this plugin, it should always be set to community.general.xen_orchestra for this plugin to recognize it as its own.

Choices:

• "community.general.xen_orchestra"

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

use_host_uuid

boolean

added in community.general 10.4.0

Import Xen Hosts to inventory using their UUID as the Host entry name.

If set to false use Host name labels instead of UUIDs.

Choices:

• false
• true ← (default)

use_ssl

boolean

Use wss when connecting to the Xen Orchestra API.

Choices:

• false
• true ← (default)

use_vm_uuid

boolean

added in community.general 10.4.0

Import Xen VMs to inventory using their UUID as the VM entry name.

If set to false use VM name labels instead of UUIDs.

Choices:

• false
• true ← (default)

user

string / required

Xen Orchestra user.

If the value is not specified in the inventory configuration, the value of environment variable ANSIBLE_XO_USER will be used instead.

Configuration:

• Environment variable: ANSIBLE_XO_USER

validate_certs

boolean

Verify TLS certificate if using HTTPS.

Choices:

• false
• true ← (default)