theforeman.foreman.foreman inventory – Foreman清单源

注意

此清单插件是 theforeman.foreman 集合 (版本 4.2.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此清单插件，请参阅 要求 获取详细信息。

要在playbook中使用它，请指定： theforeman.foreman.foreman。

概要

  • 从Foreman获取清单主机。

  • 可以使用报表API（默认）或主机API来获取有关主机的信息。

  • 对于许多主机，报表API更快。

  • 报表API需要在Foreman服务器上安装 foreman_ansible 插件。

  • 某些选项仅在使用报表API时才有效。

  • 使用以``foreman.(yml|yaml)``结尾的YAML配置文件。

要求

以下要求是在执行此清单的本地控制器节点上需要的。

  • requests >= 1.1

参数

参数

注释

batch_size

整数

每次单个调用从Foreman API检索的主机数

默认值： 250

cache

布尔值

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

选项

  • false ← (默认)

  • true

配置

cache_connection

字符串

缓存连接数据或路径，请阅读缓存插件文档以了解详情。

配置

cache_plugin

字符串

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

默认值： "memory"

配置

cache_prefix

字符串

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

默认值： "ansible_inventory_"

配置

cache_timeout

整数

缓存持续时间（秒）。

默认值： 3600

配置

compose

字典

从jinja2表达式创建变量。

默认值： {}

foreman

字符串

与Foreman服务器相关的配置，已弃用。

您可以在此字典中传递use_reports_api以启用报表API。

仅用于向后兼容。

group_prefix

字符串

应用于Foreman组的前缀

默认值： "foreman_"

groups

字典

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

默认值： {}

host_filters

字符串

这可以用来限制返回的主机列表

hostnames

列表 / 元素=字符串

按优先级顺序排列的模板列表，用于组合inventory_hostname。

如果模板结果为空字符串或None值，则将其忽略。

默认值： ["name"]

keyed_groups

列表 / 元素=字典

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

默认值： []

默认值

字符串

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

legacy_hostvars

布尔值

切换，如果为真，插件将构建Foreman脚本中存在的旧版hostvars

将hostvars放在键为`foreman`、`foreman_facts`和`foreman_params`的字典中

选项

  • false ← (默认)

  • true

max_timeout

整数

轮询时使用report_data端点时，在回退到旧主机API之前的超时时间。

默认值： 600

密码

字符串 / 必需

访问Foreman服务器的用户的密码。

配置

插件

字符串 / 必需

确保这是foreman插件的源文件的令牌。

选项

  • "theforeman.foreman.foreman"

轮询间隔

整数

轮询时两次调用report_data端点之间的轮询间隔。

默认值： 10

报告

字典

报告API特定配置，已弃用。

您可以将Report API特定的参数作为此dict的一部分传递，而不是主配置。

仅用于向后兼容。

严格模式

布尔值

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

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

选项

  • false ← (默认)

  • true

URL

字符串 / 必需

Foreman服务器的URL。

配置

use_extra_vars

布尔值

在 ansible-core 2.11 中添加

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

选项

  • false ← (默认)

  • true

配置

use_reports_api

布尔值

使用报表API。

选项

  • false

  • true ← (默认)

用户

字符串 / 必需

访问Foreman服务器的用户名。

配置

validate_certs

布尔值

是否验证Foreman服务器的TLS证书。

选项

  • false

  • true ← (默认)

配置

vars_prefix

字符串

应用于主机变量的前缀，不包括facts或params

默认值： "foreman_"

want_content_facet_attributes

布尔值

切换，如果为真，清单将获取主机关联的ContentView详细信息。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

want_facts

布尔值

切换，如果为True，插件将从服务器检索主机facts

选项

  • false ← (默认)

  • true

want_host_group

布尔值

切换，如果为真，清单将获取host_groups并为其创建分组。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

want_hostcollections

布尔值

切换，如果为真，插件将为主机集合创建Ansible组

选项

  • false ← (默认)

  • true

want_ipv4

布尔值

切换，如果为真，清单将获取主机的ipv4地址。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

want_ipv6

布尔值

切换，如果为真，清单将获取主机的ipv6地址。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

want_location

布尔值

切换，如果为真，清单将获取主机所属的位置并为其创建分组。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

want_organization

布尔值

切换，如果为真，清单将获取主机所属的组织并为其创建分组。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

want_params

布尔值

切换，如果为真，清单将检索“all_parameters”信息作为主机变量

选项

  • false ← (默认)

  • true

want_smart_proxies

布尔值

切换，如果为真，清单将获取主机注册到的智能代理。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

want_subnet

布尔值

切换，如果为真，清单将获取子网。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

want_subnet_v6

布尔值

切换，如果为真，清单将获取ipv6子网。

仅适用于使用报表API的清单 - 否则忽略属性。

选项

  • false

  • true ← (默认)

示例

# my.foreman.yml
plugin: theforeman.foreman.foreman
url: https://foreman.example.com
user: ansibleinventory
password: changeme
host_filters: 'organization="Web Engineering"'

# shortname.foreman.yml
plugin: theforeman.foreman.foreman
url: https://foreman.example.com
user: ansibleinventory
password: changeme
hostnames:
  - name.split('.')[0]

提示

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