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的值。

配置

缓存

布尔值

切换以启用/禁用清单源数据的缓存，需要设置缓存插件才能正常工作。

选项

  • false ← (默认)

  • true

配置

cache_connection

字符串

缓存连接数据或路径，请参阅缓存插件文档了解详细信息。

配置

cache_plugin

字符串

用于清单源数据的缓存插件。

默认值： "memory"

配置

cache_prefix

字符串

用于缓存插件文件/表的前缀

默认值： "ansible_inventory_"

配置

cache_timeout

整数

缓存持续时间（秒）

默认值： 3600

配置

compose

字典

从Jinja2表达式创建变量。

默认值： {}

groups

字典

基于Jinja2条件将主机添加到组。

默认值： {}

keyed_groups

列表 / 元素=字典

基于变量的值将主机添加到组。

默认值： []

default_value

字符串

在ansible-core 2.12中添加

当主机变量的值为空字符串时的默认值。

此选项与keyed_groups[].trailing_separator互斥。

键

字符串

用于生成组的输入字典中的键

父组

字符串

键控组的父组

前缀

字符串

键控组名称将以此前缀开头

默认值： ""

分隔符

字符串

用于构建键控组名称的分隔符

默认值： "_"

尾随分隔符

布尔值

在ansible-core 2.12中添加

将此选项设置为False 以省略主机变量值为空字符串时的keyed_groups[].separator。

此选项与keyed_groups[].default_value互斥。

选项

  • false

  • true ← (默认)

前导分隔符

布尔值

在 ansible-core 2.11 中添加

与 keyed_groups 结合使用。

默认情况下，未提供前缀或分隔符的键控组的名称将以下划线开头。

这是因为默认前缀为“”而默认分隔符为“_”。

如果未给出前缀，请将此选项设置为 False 以省略前导下划线（或其他分隔符）。

如果组名称是从映射中导出的，则仍使用分隔符来连接项目。

要完全不使用组名称中的分隔符，请将键控组的分隔符设置为空字符串。

选项

  • false

  • true ← (默认)

密码

字符串 / 必需

Xen Orchestra 密码。

如果在清单配置中未指定该值，则将改用环境变量ANSIBLE_XO_PASSWORD的值。

配置

插件

字符串 / 必需

此插件的名称，应始终设置为community.general.xen_orchestra，以便此插件将其识别为自身。

选项

  • "community.general.xen_orchestra"

严格模式

布尔值

如果为yes，则将无效条目设为致命错误，否则跳过并继续。

由于可以在表达式中使用事实，因此它们可能并不总是可用，我们默认忽略这些错误。

选项

  • false ← (默认)

  • true

使用额外变量

布尔值

在 ansible-core 2.11 中添加

将额外变量合并到可用于组合的变量中（最高优先级）。

选项

  • false ← (默认)

  • true

配置

使用SSL

布尔值

连接到 Xen Orchestra API 时使用 wss

选项

  • false

  • true ← (默认)

用户

字符串 / 必需

Xen Orchestra 用户。

如果在清单配置中未指定该值，则将改用环境变量ANSIBLE_XO_USER的值。

配置

验证证书

布尔值

如果使用 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)

提示

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