community.general.icinga2_host 模块 – 在 Icinga2 中管理主机

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

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

要在剧本中使用它，请指定： community.general.icinga2_host。

概要

参数

参数

注释

check_command

字符串

用于检查主机是否在线的命令。

默认值： "hostalive"

client_cert

路径

用于 SSL 客户端身份验证的 PEM 格式证书链文件。此文件也可以包含密钥，如果包含密钥，则不需要 client_key。

client_key

路径

包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果 client_cert 包含证书和密钥，则不需要此选项。

display_name

字符串

用于显示主机的名称。

如果未指定，则默认为 name 参数的值。

force

布尔值

如果为 yes，则不获取缓存副本。

选项

  • false ← (默认)

  • true

force_basic_auth

布尔值

httplib2（uri 模块使用的库）仅在 Web 服务响应初始请求并返回 401 状态时才发送身份验证信息。由于某些基本身份验证服务无法正确发送 401，因此登录将失败。此选项强制在初始请求时发送基本身份验证标头。

选项

  • false ← (默认)

  • true

http_agent

字符串

用于识别的标头，通常显示在 Web 服务器日志中。

默认值： "ansible-httpget"

ip

字符串

主机的 IP 地址。

从 community.general 8.0.0 开始，此参数不再需要。

name

别名：host

字符串 / 必需

用于创建/删除主机的名称。此名称不必是 FQDN，但必须唯一。

state

字符串

应用功能状态。

选项

  • "present" ← (默认)

  • "absent"

template

字符串

用于定义主机的模板。

对象创建后无法修改模板。

url

字符串

形式为 (http|https|ftp)://[user[:pass]]@host.domain[:port]/path 的 HTTP、HTTPS 或 FTP URL

url_password

字符串

用于 HTTP 基本身份验证的密码。

如果未指定 url_username 参数，则不会使用 url_password 参数。

url_username

字符串

用于 HTTP 基本身份验证的用户名。

此参数可与 url_password 一起使用，也可用于允许空密码的站点。

use_gssapi

布尔值

在 ansible-core 2.11 中添加

使用 GSSAPI 执行身份验证，通常用于 Kerberos 或通过协商身份验证的 Kerberos。

需要安装 Python 库 gssapi。

GSSAPI 凭据可以通过 url_username/url_password 指定，也可以通过指定自定义 Kerberos 凭据缓存的 GSSAPI 环境变量 KRB5CCNAME 指定。

即使已安装用于 NTLM 的 GSSAPI 机制，也不支持 NTLM 身份验证。

选项

  • false ← (默认)

  • true

use_proxy

布尔值

如果为 false，则即使目标主机上的环境变量中定义了代理，也不会使用代理。

选项

  • false

  • true ← (默认)

validate_certs

布尔值

如果为 false，则不会验证 SSL 证书。这仅应在使用自签名证书的个人控制站点上使用。

选项

  • false

  • true ← (默认)

variables

字典

变量字典。

zone

字符串

应从此区域轮询此主机。

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- name: Add host to icinga
  community.general.icinga2_host:
    url: "https://icinga2.example.com"
    url_username: "ansible"
    url_password: "a_secret"
    state: present
    name: "{{ ansible_fqdn }}"
    ip: "{{ ansible_default_ipv4.address }}"
    variables:
      foo: "bar"
  delegate_to: 127.0.0.1

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

data

字典

用于创建、修改或删除主机的数 据结构

返回值：始终返回

name

字符串

用于创建、修改或删除主机的名称

返回值：始终返回

作者

  • Jurgen Brand (@t794104)