community.libvirt.libvirt 库存 – Libvirt 库存源

注意

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

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

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

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

community.libvirt 2.10.0 中的新增功能

概要

  • 获取库存源中的 libvirt 虚拟机。

要求

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

  • python >= 2.6

  • libvirt python 绑定

参数

参数

注释

compose

字典

从 jinja2 表达式创建变量。

默认值： {}

groups

字典

根据 Jinja2 条件将主机添加到组。

默认值： {}

inventory_hostname

字符串

注册为库存主机名。如果设置为“uuid”，将使用服务器的 uuid，并为服务器名称创建一个组。如果设置为“name”，将使用服务器的名称，除非有多个服务器具有相同的名称，在这种情况下将使用“uuid”逻辑。默认是执行“name”。

选项

  • "name" ← (默认)

  • "uuid"

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 ← (默认)

plugin

字符串 / 必需

确保这是“libvirt”插件的源文件的标记。

选项

  • "libvirt"

  • "community.libvirt.libvirt"

strict

布尔值

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

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

选项

  • false ← (默认)

  • true

uri

字符串 / 必需

Libvirt 连接 URI

use_extra_vars

布尔值

在 ansible-core 2.11 中添加

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

选项

  • false ← (默认)

  • true

配置

示例

# Connect to lxc host
plugin: community.libvirt.libvirt
uri: 'lxc:///'

# Connect to qemu
plugin: community.libvirt.libvirt
uri: 'qemu:///system'

作者

  • Dave Olsthoorn (@daveol)

提示

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