community.general.virtualbox inventory – virtualbox 清单源

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.general。

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

概要

  • 从本地 virtualbox 安装获取清单主机。

  • 使用以 virtualbox.(yml|yaml) 或 vbox.(yml|yaml) 结尾的 YAML 配置文件。

  • inventory_hostname 始终是 virtualbox 实例的“Name”。

  • 可以使用 VBoxManage 将组分配给虚拟机。可以通过使用 / 作为分隔符来分配多个组。

  • 公开了一个单独的参数 enable_advanced_group_parsing 以更改分组行为。有关详细信息，请参阅参数文档。

参数

参数

注释

cache

boolean

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

选项

  • false ← (默认)

  • true

配置

cache_connection

string

缓存连接数据或路径，请阅读缓存插件文档以了解具体信息。

配置

cache_plugin

string

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

默认： "memory"

配置

cache_prefix

string

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

默认： "ansible_inventory_"

配置

cache_timeout

integer

缓存持续时间（以秒为单位）。

默认： 3600

配置

compose

dictionary

从 jinja2 表达式创建变量。

默认： {}

enable_advanced_group_parsing

boolean

在 community.general 9.2.0 中添加

默认组解析规则（当此设置设置为 false 时）是根据 / 字符拆分 VirtualBox VM 的组，并将生成的列表元素分配为 Ansible 组。

设置 enable_advanced_group_parsing=true 会将此行为更改为与 VirtualBox 根据 https://www.virtualbox.org/manual/UserManual.html#gui-vmgroups 对组的解释相匹配。现在使用 , 字符拆分组，并且 / 字符表示嵌套组。

启用后，使用 VBoxManage modifyvm "vm01" --groups "/TestGroup/TestGroup2,/TestGroup3" 配置的 VM 将导致组 TestGroup2 成为 TestGroup 的子组；并且 VM 是 TestGroup2 和 TestGroup3 的一部分。

选项

  • false ← (默认)

  • true

groups

dictionary

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

默认： {}

keyed_groups

列表 / 元素=字典

根据变量的值将主机添加到组。

默认值： []

default_value

string

在 ansible-core 2.12 中添加。

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

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

key

string

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

parent_group

string

键控组的父组。

prefix

string

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

默认值： ""

separator

string

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

默认值： "_"

trailing_separator

boolean

在 ansible-core 2.12 中添加。

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

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

选项

  • false

  • true ← (默认)

leading_separator

boolean

在 ansible-core 2.11 中添加。

与 keyed_groups 结合使用。

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

这是因为默认前缀是 ""，默认分隔符是 "_"。

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

如果组名称是从映射派生的，则仍然使用分隔符连接项。

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

选项

  • false

  • true ← (默认)

network_info_path

string

用于查询网络信息 (ansible_host) 的属性路径

默认值： "/VirtualBox/GuestInfo/Net/0/V4/IP"

plugin

字符串 / 必需

确保这是 'virtualbox' 插件的源文件的令牌

选项

  • "virtualbox"

  • "community.general.virtualbox"

query

dictionary

从 virtualbox 属性创建变量

默认： {}

running_only

boolean

切换显示所有虚拟机与仅显示当前正在运行的虚拟机

选项

  • false ← (默认)

  • true

settings_password_file

string

提供一个包含设置密码的文件（等效于 –settingspwfile）

strict

boolean

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

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

选项

  • false ← (默认)

  • true

use_extra_vars

boolean

在 ansible-core 2.11 中添加。

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

选项

  • false ← (默认)

  • true

配置

示例

# file must be named vbox.yaml or vbox.yml
simple_config_file:
    plugin: community.general.virtualbox
    settings_password_file: /etc/virtulbox/secrets
    query:
      logged_in_users: /VirtualBox/GuestInfo/OS/LoggedInUsersList
    compose:
      ansible_connection: ('indows' in vbox_Guest_OS)|ternary('winrm', 'ssh')

# add hosts (all match with minishift vm) to the group container if any of the vms are in ansible_inventory'
plugin: community.general.virtualbox
groups:
  container: "'minis' in (inventory_hostname)"

作者

  • 未知

提示

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