community.general.xen_orchestra 库存 – Xen Orchestra 库存源

注意

此库存插件是 community.general 集合（版本 10.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要进一步的要求才能使用此库存插件，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：community.general.xen_orchestra。

community.general 4.1.0 中的新增功能

概要 

从 Xen Orchestra 部署获取库存主机。
使用配置文件作为库存源，它必须以 .xen_orchestra.yml 或 .xen_orchestra.yaml 结尾。

要求 

在执行此库存的本地控制器节点上需要以下要求。

websocket-client >= 1.0.0

参数 

参数	注释
api_host 字符串	XOA API 的 API 主机。如果在库存配置中未指定该值，则将使用环境变量 `ANSIBLE_XO_HOST` 的值。配置环境变量：`ANSIBLE_XO_HOST`
cache 布尔值	切换以启用/禁用库存源数据的缓存，需要设置缓存插件才能工作。选项 `false` ← (默认) `true` 配置 INI 条目 [inventory] cache = false 环境变量：`ANSIBLE_INVENTORY_CACHE`
cache_connection 字符串	缓存连接数据或路径，请阅读缓存插件文档以获取详细信息。配置 INI 条目 [defaults] fact_caching_connection = VALUE [inventory] cache_connection = VALUE 环境变量：`ANSIBLE_CACHE_PLUGIN_CONNECTION` 环境变量：`ANSIBLE_INVENTORY_CACHE_CONNECTION`
cache_plugin 字符串	用于库存源数据的缓存插件。默认： `"memory"` 配置 INI 条目 [defaults] fact_caching = memory [inventory] cache_plugin = memory 环境变量：`ANSIBLE_CACHE_PLUGIN` 环境变量：`ANSIBLE_INVENTORY_CACHE_PLUGIN`
cache_prefix 字符串	用于缓存插件文件/表的前缀。默认： `"ansible_inventory_"` 配置 INI 条目 [defaults] fact_caching_prefix = ansible_inventory_ [inventory] cache_prefix = ansible_inventory_ 环境变量：`ANSIBLE_CACHE_PLUGIN_PREFIX` 环境变量：`ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX`
cache_timeout 整数	缓存持续时间（秒）。默认： `3600` 配置 INI 条目 [defaults] fact_caching_timeout = 3600 [inventory] cache_timeout = 3600 环境变量：`ANSIBLE_CACHE_PLUGIN_TIMEOUT` 环境变量：`ANSIBLE_INVENTORY_CACHE_TIMEOUT`
compose 字典	从 jinja2 表达式创建变量。默认： `{}`
groups 字典	根据 Jinja2 条件将主机添加到组。默认： `{}`
keyed_groups 列表 / 元素=字典	根据变量的值将主机添加到组。默认： `[]`
default_value 字符串在 ansible-core 2.12 中添加。	当主机变量的值为空字符串时的默认值。此选项与 `keyed_groups[].trailing_separator` 互斥。
key 字符串	用于生成组的输入字典中的键。
parent_group 字符串	键控组的父组。
prefix 字符串	键控组的名称将以此前缀开头。默认值: `""`
separator 字符串	用于构建键控组名称的分隔符。默认值: `"_"`
trailing_separator 布尔值在 ansible-core 2.12 中添加。	将此选项设置为 `false` 以省略当值为空字符串时主机变量之后的 `keyed_groups[].separator`。此选项与 `keyed_groups[].default_value` 互斥。选项 `false` `true` ← (默认)
leading_separator 布尔值在 ansible-core 2.11 中添加。	与 `keyed_groups` 结合使用。默认情况下，没有提供前缀或分隔符的键控组的名称将以下划线开头。这是因为默认前缀是 `""`，默认分隔符是 `"_"`。如果未提供前缀，则将此选项设置为 `false` 以省略前导下划线（或其他分隔符）。如果组名称派生自映射，则仍使用分隔符连接各个项。要在组名称中完全不使用分隔符，请将键控组的分隔符设置为空字符串。选项 `false` `true` ← (默认)
password string / 必填	Xen Orchestra 密码。如果 inventory 配置中未指定该值，则将使用环境变量 `ANSIBLE_XO_PASSWORD` 的值。配置环境变量：`ANSIBLE_XO_PASSWORD`
plugin string / 必填	此插件的名称，应始终设置为 `community.general.xen_orchestra`，以便此插件将其识别为自身。选项 `"community.general.xen_orchestra"`
strict 布尔值	如果为 `yes`，则将无效条目视为致命错误，否则跳过并继续。由于可以在表达式中使用 facts，它们可能并非始终可用，因此默认情况下我们会忽略这些错误。选项 `false` ← (默认) `true`
use_extra_vars 布尔值在 ansible-core 2.11 中添加。	将 extra vars 合并到可用于组合的变量中（优先级最高）。选项 `false` ← (默认) `true` 配置 INI 条目 [inventory_plugins] use_extra_vars = false 环境变量：`ANSIBLE_INVENTORY_USE_EXTRA_VARS`
use_ssl 布尔值	连接到 Xen Orchestra API 时使用 wss。选项 `false` `true` ← (默认)
user string / 必填	Xen Orchestra 用户。如果 inventory 配置中未指定该值，则将使用环境变量 `ANSIBLE_XO_USER` 的值。配置环境变量：`ANSIBLE_XO_USER`
validate_certs 布尔值	如果使用 HTTPS，则验证 TLS 证书。选项 `false` `true` ← (默认)

示例 

# 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

作者

Dom Del Nano (@ddelnano)
Samori Gorse (@shinuza)

提示

每个条目类型的配置条目都具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。