community.general.xen_orchestra inventory – Xen Orchestra inventory source
Note
This inventory plugin is part of the community.general collection (version 9.4.0).
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 community.general
.
You need further requirements to be able to use this inventory plugin,
see Requirements for details.
To use it in a playbook, specify: community.general.xen_orchestra
.
New in community.general 4.1.0
Synopsis
Get inventory hosts from a Xen Orchestra deployment.
Uses a configuration file as an inventory source, it must end in
.xen_orchestra.yml
or.xen_orchestra.yaml
.
Requirements
The below requirements are needed on the local controller node that executes this inventory.
websocket-client >= 1.0.0
Parameters
Parameter |
Comments |
---|---|
API host to XOA API. If the value is not specified in the inventory configuration, the value of environment variable Configuration:
|
|
Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work. Choices:
Configuration:
|
|
Cache connection data or path, read cache plugin documentation for specifics. Configuration:
|
|
Cache plugin to use for the inventory’s source data. Default: Configuration:
|
|
Prefix to use for cache plugin files/tables. Default: Configuration:
|
|
Cache duration in seconds. Default: Configuration:
|
|
Create vars from jinja2 expressions. Default: |
|
Add hosts to group based on Jinja2 conditionals. Default: |
|
Add hosts to group based on the values of a variable. Default: |
|
The default value when the host variable’s value is an empty string. This option is mutually exclusive with |
|
The key from input dictionary used to generate groups. |
|
parent group for keyed group. |
|
A keyed group name will start with this prefix. Default: |
|
separator used to build the keyed group name. Default: |
|
Set this option to This option is mutually exclusive with Choices:
|
|
Use in conjunction with 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 Set this option to 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:
|
|
Xen Orchestra password. If the value is not specified in the inventory configuration, the value of environment variable Configuration:
|
|
The name of this plugin, it should always be set to Choices:
|
|
If Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. Choices:
|
|
Merge extra vars into the available variables for composition (highest precedence). Choices:
Configuration:
|
|
Use wss when connecting to the Xen Orchestra API Choices:
|
|
Xen Orchestra user. If the value is not specified in the inventory configuration, the value of environment variable Configuration:
|
|
Verify TLS certificate if using HTTPS. Choices:
|
Examples
# file must be named xen_orchestra.yaml or xen_orchestra.yml
plugin: community.general.xen_orchestra
api_host: 192.168.1.255
user: xo
password: xo_pwd
validate_certs: true
use_ssl: true
groups:
kube_nodes: "'kube_node' in tags"
compose:
ansible_port: 2222