telekom_mms.icinga_director.icinga_host 模块 – 在 Icinga2 中管理主机

注意

此模块是 telekom_mms.icinga_director 集合 (版本 2.2.1) 的一部分。

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

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

要在 playbook 中使用它，请指定：telekom_mms.icinga_director.icinga_host。

telekom_mms.icinga_director 1.0.0 中的新增功能

概要

• 通过 director API 添加或删除 Icinga2 主机。

参数

参数	注释
accept_config 布尔值 telekom_mms.icinga_director 1.9.0 中新增	代理是否配置为接受配置。 选项 false true
address 字符串	主机地址。通常是 IPv4 地址，但可能是检查插件能够处理的任何类型的地址。
address6 字符串 telekom_mms.icinga_director 1.4.0 中新增	主机 IPv6 地址。通常是 IPv6 地址，但可能是检查插件能够处理的任何类型的地址。
append 布尔值 telekom_mms.icinga_director 1.25.0 中新增	不要覆盖整个对象，而是附加定义的属性。 注意 - 无法追加到现有的变量、导入或任何其他列表/字典。您必须覆盖整个列表/字典。 注意 - 即使未设置，默认设置的变量也将应用。 选项 false true
check_command 字符串	检查命令的名称。 虽然这不需要在 director 中定义，但您仍然必须在主机或主机模板中提供 check_command。
check_interval 字符串	您的常规检查间隔。
check_period 字符串	确定应何时监控此对象的时间段的名称。默认情况下不限。
check_timeout 字符串	检查命令超时时间（秒）。覆盖 CheckCommand 的超时属性
client_cert 路径	用于 SSL 客户端身份验证的 PEM 格式证书链文件。 此文件也可以包含密钥，如果包含密钥，则不需要 client_key。
client_key 路径	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。 如果 client_cert 包含证书和密钥，则不需要此选项。
command_endpoint 字符串	执行命令的端点。
disabled 布尔值	禁用的对象将不会部署。 选项 false ← (默认) true
display_name 字符串	此主机的替代名称。可能是主机别名或帮助用户识别此主机的某种字符串。
enable_active_checks 布尔值	是否主动检查此对象。 选项 false true
enable_event_handler 布尔值	是否为此对象启用事件处理程序。 选项 false true
enable_flapping 布尔值	是否为此对象启用抖动检测。 选项 false true
enable_notifications 布尔值	是否为此对象发送通知。 选项 false true
enable_passive_checks 布尔值	是否接受此对象的被动检查结果。 选项 false true
enable_perfdata 布尔值	是否处理此对象提供的性能数据。 选项 false true
event_command 字符串	主机事件命令，如果满足以下条件之一，则在每次检查执行时调用： 主机处于软状态 主机状态更改为硬状态 主机状态从软状态或硬状态恢复到 OK/Up
flapping_threshold_high 字符串	服务被认为处于抖动状态的百分比上限
flapping_threshold_low 字符串	服务不被认为处于抖动状态的百分比下限
force 布尔值	如果为 yes，则不获取缓存副本。 选项 false ← (默认) true
force_basic_auth 布尔值	使用 url_username 和 url_password 指定的凭据应通过 HTTP 标头传递。 选项 false ← (默认) true
groups 列表 / 元素=字符串	应直接分配给此节点的主机组。主机组可能出于各种原因有用。 您可以根据分配的主机组分配服务检查。它们也经常用作在 Icinga Web 2 中强制执行受限视图的工具。 主机组可以直接分配给单个主机或主机模板。 您可能还想考虑使用应用规则分配主机组。 默认值： []
has_agent 布尔值 telekom_mms.icinga_director 1.9.0 中新增	此主机是否安装了 Icinga 2 代理。 选项 false true
http_agent 字符串	用于标识的标头，通常出现在 Web 服务器日志中。 默认值： "ansible-httpget"
icon_image 字符串	指向此对象图标的 URL。 尝试使用“tux.png”表示相对于 public/img/icons 的图标，或使用“cloud”（无扩展名）表示来自 Icinga 图标字体的项目
icon_image_alt 字符串	如果缺少上述图标，则显示的替代文本
imports 列表 / 元素=字符串	选择主机模板。如果 state 为 present，则需要。 如果 *state* 为 present，则需要。
master_should_connect 布尔值 telekom_mms.icinga_director 1.9.0 中新增	父（主）节点是否应主动尝试连接到此代理。 选项 false true
max_check_attempts 字符串	定义在多少次检查尝试后达到新的硬状态。
notes 字符串 telekom_mms.icinga_director 1.8.0 中新增	此对象的附加注释。
notes_url 字符串 telekom_mms.icinga_director 1.8.0 中新增	指向此对象的附加注释的 URL。 多个 URL 请按以下格式分隔：“‘http://url1’ ‘http://url2’”。 最大长度为 255 个字符。
object_name 别名：name 字符串 / 必填	此主机的 Icinga 对象名称。 这通常是完全限定的主机名，但基本上可以是任何类型的字符串。 为了方便用户使用，我们强烈建议为模板使用有意义的名称。 例如，“generic-host” 不美观，“Standard Linux Server” 更易于理解。
retry_interval 字符串	重试间隔，在状态更改后应用，除非达到下一个硬状态。
state 字符串	应用特性状态。 选项 "present" ← (默认) "absent"
url 字符串 / 必填	HTTP、HTTPS 或 FTP URL，格式为 (http|https|ftp)://[user[:pass]]@host.domain[:port]/path
url_password 字符串	用于 HTTP 基本身份验证的密码。 如果未指定 url_username 参数，则不会使用 url_password 参数。
url_username 字符串	用于 HTTP 基本身份验证的用户名。 对于允许空密码的站点，此参数可以不与 url_password 配合使用。
use_gssapi 布尔值 ansible-core 2.11 版本中新增	使用 GSSAPI 执行身份验证，通常用于 Kerberos 或通过 Negotiate 身份验证的 Kerberos。 需要安装 Python 库 gssapi。 GSSAPI 的凭据可以使用 url_username/url_password 指定，也可以使用 GSSAPI 环境变量 KRB5CCNAME 指定自定义 Kerberos 凭据缓存。 即使安装了 NTLM 的 GSSAPI 机制，也不支持 NTLM 身份验证。 选项 false ← (默认) true
use_proxy 布尔值	如果为 no，则即使目标主机上的环境变量中定义了代理，也不会使用代理。 选项 false true ← (默认)
validate_certs 布尔值	如果为 no，则不会验证 SSL 证书。 这仅应在使用自签名证书的个人控制站点上使用。 选项 false true ← (默认)
vars 字典	主机的自定义属性。
volatile 布尔值	此检查是否易失。 选项 false true
zone 字符串	设置区域。

备注

注意

• 此模块支持检查模式。

示例

- name: Create a host in icinga
  telekom_mms.icinga_director.icinga_host:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    accept_config: true
    address: "127.0.0.1"
    address6: "::1"
    check_command: hostalive
    check_interval: 90s
    check_timeout: 60
    command_endpoint: fooendpoint
    disabled: false
    display_name: "foohost"
    enable_active_checks: true
    enable_event_handler: false
    enable_flapping: false
    enable_notifications: true
    enable_passive_checks: false
    enable_perfdata: false
    flapping_threshold_high: "30.0"
    flapping_threshold_low: "25.0"
    has_agent: true
    icon_image_alt: "alt text"
    icon_image: "http://url1"
    master_should_connect: true
    max_check_attempts: 3
    object_name: "foohost"
    retry_interval: "1m"
    volatile: false
    groups:
      - "foohostgroup"
    imports:
      - "foohosttemplate"
    vars:
      dnscheck: "no"

- name: update a host in icinga
  telekom_mms.icinga_director.icinga_host:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "foohost"
    notes: "example note"
    notes_url: "'http://url1' 'http://url2'"
    append: true

作者

• Sebastian Gumprich (@rndmh3ro)

资源链接

• 问题跟踪器
• 代码库 (源代码)