community.general.icinga2 清单 – Icinga2 清单源
注意
此清单插件是 community.general 集合(版本 10.1.0)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.general
。
要在剧本中使用它,请指定:community.general.icinga2
。
community.general 3.7.0 中的新增功能
概要
从 Icinga2 API 获取清单主机。
使用配置文件作为清单源,它必须以
.icinga2.yml
或.icinga2.yaml
结尾。
参数
参数 |
注释 |
---|---|
从 jinja2 表达式创建变量。 默认值: |
|
使用 Icinga2 主机组作为组。 选择
|
|
根据 Jinja2 条件将主机添加到组。 默认值: |
|
一个有效的 Icinga2 API 主机过滤器。留空表示不进行过滤 |
|
允许基于不同的属性覆盖清单名称。 这允许更改限制的使用方式。 当前的默认值 选择
|
|
根据变量的值将主机添加到组。 默认值: |
|
当主机变量的值为空字符串时的默认值。 此选项与 |
|
用于生成组的输入字典中的键 |
|
键控组的父组 |
|
键控组名称将以此前缀开头 默认值: |
|
用于构建键控组名称的分隔符 默认值: |
|
将此选项设置为 此选项与 选择
|
|
与 keyed_groups 结合使用。 默认情况下,不提供前缀或分隔符的键控组的名称将以下划线开头。 这是因为默认前缀为 "",默认分隔符为 "_"。 如果未提供前缀,请将此选项设置为 False 以省略前导下划线(或其他分隔符)。 如果组名来源于映射,分隔符仍然用于连接各项。 如果完全不想在组名中使用分隔符,请将键控组的分隔符设置为空字符串。 选择
|
|
用于查询 API 的密码。 |
|
插件名称。 选择
|
|
如果设置为 由于可以在表达式中使用事实,它们可能并非始终可用,默认情况下我们会忽略这些错误。 选择
|
|
Icinga2 API 的根 URL。 |
|
将额外变量合并到可用于组合的变量中(优先级最高)。 选择
配置
|
|
用于查询 API 的用户名。 |
|
启用或禁用 SSL 证书验证。 选择
|
示例
# my.icinga2.yml
plugin: community.general.icinga2
url: https://127.0.0.1:5665
user: ansible
password: secure
host_filter: \"linux-servers\" in host.groups
validate_certs: false # only do this when connecting to localhost!
inventory_attr: name
groups:
# simple name matching
webservers: inventory_hostname.startswith('web')
# using icinga2 template
databaseservers: "'db-template' in (icinga2_attributes.templates|list)"
compose:
# set all icinga2 attributes to a host variable 'icinga2_attrs'
icinga2_attrs: icinga2_attributes
# set 'ansible_user' and 'ansible_port' from icinga2 host vars
ansible_user: icinga2_attributes.vars.ansible_user
ansible_port: icinga2_attributes.vars.ansible_port | default(22)