telekom_mms.icinga_director.ansible_icinga 角色 – 使用 Icinga Director 配置 Icinga 实例
注意
此角色是 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.ansible_icinga
。
入口点 icinga_service_apply
– 使用 Icinga Director 配置 Icinga 实例
概要
主入口点包括可以使用该角色创建的所有对象的任务。
参数
参数 |
注释 |
---|---|
用于 SSL 客户端身份验证的 PEM 格式的证书链文件。此文件也可以包含密钥,如果包含密钥,则不需要“client_key”。 |
|
包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果 `client_cert` 同时包含证书和密钥,则不需要此选项。 |
|
格式为 (http|https|ftp)://[user[:pass]]@host.domain[:port]/path 的 HTTP、HTTPS 或 FTP URL |
|
用于 HTTP 基本身份验证的密码。如果未指定 `url_username` 参数,则不会使用 `url_password` 参数。 |
|
用于 HTTP 基本身份验证的用户名。此参数可以在允许空密码的站点上使用,而无需 `url_password` |
|
使用 GSSAPI 执行身份验证,通常用于 Kerberos 或通过 Negotiate 身份验证的 Kerberos。需要安装 Python 库 gssapi <https://github.com/pythongssapi/python-gssapi>。GSSAPI 的凭据可以使用 `url_username`/`url_password` 或使用指定自定义 Kerberos 凭据缓存的 GSSAPI 环境变量 `KRB5CCNAME` 来指定。即使安装了 NTLM 的 GSSAPI mech,也`不`支持 NTLM 身份验证。 选项
|
|
如果为 `no`,则即使在目标主机上的环境变量中定义了代理,也不会使用代理。 选项
|
|
如果为“no”,则不会验证 SSL 证书。icinga_这仅应在个人控制的站点上使用自签名证书。 选项
|
入口点 main
– 使用 Icinga Director 配置 Icinga 实例
概要
主入口点包括可以使用该角色创建的所有对象的任务。
参数
参数 |
注释 |
---|---|
要配置的 Icinga command_templates 列表 |
|
命令模板的参数。 |
|
Icinga 应该运行的命令。 绝对路径按原样接受,相对路径以“PluginDir + ”为前缀,类似常量前缀也允许。 空格将导致命令路径和独立参数的分隔。 请注意,这意味着我们目前不支持插件名称和路径中的空格。 |
|
当针对您的基础设施运行检查时,您需要插件检查命令。 当需要通知您的用户时,将使用通知命令。 事件命令允许您在发生问题时触发特定操作。 有些人将它们用于自动修复机制,例如在特定阈值重启服务或重启系统。 选项
|
|
已禁用对象将不会被部署。 选项
|
|
可导入模板,根据需要添加多个。请注意,从多个模板导入属性时,顺序很重要 - 最后一个获胜。 |
|
命令模板的名称。 |
|
应用功能状态。 选项
|
|
可选的命令超时时间。允许的值为秒或带有特定单位的持续时间(例如 1m 或 3m 30s)。 |
|
命令模板的自定义属性。 |
|
Icinga 集群区域。允许手动覆盖 Director 关于将配置部署到何处的决定。 除非您对 Icinga 集群堆栈的工作方式有深入了解,否则您应该考虑不要这样做。 |
|
要配置的 Icinga 命令列表 |
|
命令的参数。 |
|
Icinga 应运行的命令。当状态为 绝对路径按原样接受,相对路径以“PluginDir + ”为前缀,类似常量前缀也允许。 空格将导致命令路径和独立参数的分隔。 请注意,这意味着我们目前不支持插件名称和路径中的空格。 |
|
当针对您的基础设施运行检查时,您需要插件检查命令。 当需要通知您的用户时,将使用通知命令。 事件命令允许您在发生问题时触发特定操作。 有些人将它们用于自动修复机制,例如在特定阈值重启服务或重启系统。 选项
|
|
已禁用对象将不会被部署。 选项
|
|
可导入模板,根据需要添加多个。请注意,从多个模板导入属性时,顺序很重要 - 最后一个获胜。 |
|
命令的名称。 |
|
应用功能状态。 选项
|
|
可选的命令超时时间。允许的值为秒或带有特定单位的持续时间(例如 1m 或 3m 30s)。 |
|
命令的自定义属性。 |
|
Icinga 集群区域。允许手动覆盖 Director 关于将配置部署到何处的决定。 除非您对 Icinga 集群堆栈的工作方式有深入了解,否则您应该考虑不要这样做。 |
|
要配置的 Icinga 端点列表 |
|
远程 Icinga 2 实例的主机名/IP 地址。 |
|
在连接丢失时保留重放日志的持续时间。默认为 1d(86400 秒)。属性以秒为单位指定。如果 log_duration 设置为 0,则禁用重放日志。您也可以以人类可读的格式指定该值,例如 10m 表示 10 分钟,或 1h 表示 1 小时。 |
|
此端点的 Icinga 对象名称。 这通常是完全限定的主机名,但基本上可以是任何类型的字符串。 为了方便您的用户,我们强烈建议您为模板使用有意义的名称。 例如,“generic-endpoint”很丑陋,“标准 Linux 服务器”更容易理解。 |
|
远程 Icinga 2 实例的服务名称/端口。默认为 5665。 |
|
应用功能状态。 选项
|
|
此端点所属的区域的名称。 |
|
要配置的 Icinga host_templates 列表 |
|
是否配置代理以接受配置。 选项
|
|
主机地址。通常是 IPv4 地址,但可以是您的检查插件能够处理的任何类型的地址。 |
|
主机 IPv6 地址。通常是 IPv6 地址,但可以是您的检查插件能够处理的任何类型的地址。 |
|
检查命令的名称。 尽管这不是必须在 Director 中定义的,但您仍然必须在主机或主机模板中提供 check_command。 |
|
您的常规检查间隔。 |
|
已禁用对象将不会被部署。 选项
|
|
此主机的替代名称。 可能是主机别名或任何类型的字符串,可帮助您的用户识别此主机。 |
|
主机的事件命令,如果满足以下条件之一,则在每次检查执行时调用 主机处于软状态 主机状态更改为硬状态 主机状态从软状态或硬状态恢复为 OK/Up |
|
应直接分配给此节点的主机组。主机组在各种情况下都很有用。 您可以根据分配的主机组分配服务检查。它们通常也用作在 Icinga Web 2 中强制执行受限视图的工具。 主机组可以直接分配给单个主机或主机模板。 您可能还需要考虑使用应用规则分配主机组。 默认值: |
|
此主机是否已安装 Icinga 2 代理。 选项
|
|
选择一个主机模板。 |
|
父(主)节点是否应主动尝试连接到此代理。 选项
|
|
此主机模板的 Icinga 对象名称。 这通常是完全限定的主机名,但基本上可以是任何类型的字符串。 为了方便您的用户,我们强烈建议您为模板使用有意义的名称。 例如,“generic-host”很丑陋,“标准 Linux 服务器”更容易理解。 |
|
此对象的其他备注。 |
|
应用功能状态。 选项
|
|
主机的自定义属性。 |
|
设置区域。 |
|
要配置的 Icinga 主机组列表 |
|
这允许您配置分配过滤器。 请随意组合任意数量的嵌套运算符。 |
|
此组的替代显示名称。 如果您想知道这有什么帮助,请将其留空。 |
|
此主机组的 Icinga 对象名称。 |
|
应用功能状态。 选项
|
|
要配置的 Icinga 主机列表 |
|
是否配置代理以接受配置。 选项
|
|
主机地址。通常是 IPv4 地址,但可以是您的检查插件能够处理的任何类型的地址。 |
|
主机 IPv6 地址。通常是 IPv6 地址,但可以是您的检查插件能够处理的任何类型的地址。 |
|
检查命令的名称。 尽管这不是必须在 Director 中定义的,但您仍然必须在主机或主机模板中提供 check_command。 |
|
已禁用对象将不会被部署。 选项
|
|
此主机的替代名称。可能是主机别名或任何类型的字符串,可帮助您的用户识别此主机。 |
|
应直接分配给此节点的主机组。主机组在各种情况下都很有用。 您可以根据分配的主机组分配服务检查。它们通常也用作在 Icinga Web 2 中强制执行受限视图的工具。 主机组可以直接分配给单个主机或主机模板。 您可能还需要考虑使用应用规则分配主机组。 默认值: |
|
此主机是否已安装 Icinga 2 代理。 选项
|
|
选择一个主机模板。当状态为 |
|
父(主)节点是否应主动尝试连接到此代理。 选项
|
|
此主机的 Icinga 对象名称。 这通常是完全限定的主机名,但基本上可以是任何类型的字符串。 为了方便您的用户,我们强烈建议您为模板使用有意义的名称。 例如,“generic-host”很丑陋,“标准 Linux 服务器”更容易理解。 |
|
此对象的其他备注。 |
|
应用功能状态。 选项
|
|
主机的自定义属性。 |
|
设置区域。 |
|
要配置的 Icinga 通知列表 |
|
此通知应影响主机还是服务。 选项
|
|
通知生效的过滤器。 |
|
已禁用对象将不会被部署。 选项
|
|
可导入的模板,添加任意多个。当状态为 请注意,从多个模板导入属性时,顺序很重要 - 最后一个胜出。 |
|
通知的名称。 |
|
通知间隔(以秒为单位)。此间隔用于活动通知。 默认为 30 分钟。如果设置为 0,则禁用重新通知。 |
|
应用功能状态。 选项
|
|
您要接收通知的主机或服务状态。 |
|
时间段的名称,该时间段确定何时应触发此通知。 |
|
首次通知延迟。 延迟,除非应发送首次通知。 |
|
上次通知。 何时应发送上次通知。 |
|
您要接收通知的状态转换类型。 |
|
应通过此通知通知的用户组。 |
|
应通过此通知通知的用户。 |
|
通知的自定义属性。 |
|
要配置的 Icinga service_applies 列表 |
|
为所有具有指定自定义属性的对象评估应用规则。 例如,选择“host.vars.custom_attr”将生成“for (config in host.vars.array_var)”,其中可以通过“$config$”访问“config”。 注意 - 只有类型为“Array”的自定义变量才符合条件。 |
|
服务应用规则生效的过滤器。 |
|
检查命令定义。 |
|
您的常规检查间隔。 |
|
时间段的名称,该时间段确定何时应监视此对象。默认情况下不受限制。 |
|
检查命令超时时间(以秒为单位)。覆盖 CheckCommand 的 timeout 属性。 |
|
应该在其上执行服务的主机。 |
|
服务应用规则的替代显示名称。 |
|
是否主动检查此对象。 选项
|
|
是否启用此对象的事件处理程序。 选项
|
|
是否为此对象发送通知。 选项
|
|
是否接受此对象的被动检查结果。 选项
|
|
是否处理此对象提供的性能数据。 选项
|
|
应直接分配给此服务的服务组。 服务组在各种情况下都很有用。 它们有助于在 Icinga Web 2 中提供特定于服务类型的视图,无论是用于自定义仪表板还是作为强制执行限制的工具。 服务组可以直接分配给单个服务或服务模板。 |
|
可导入的模板,添加任意多个。 请注意,从多个模板导入属性时,顺序很重要 - 最后一个胜出。 |
|
定义在多少次检查尝试后达到新的硬状态。 |
|
Icinga 服务应用规则的名称。 |
|
此对象的其他备注。 |
|
重试间隔,除非达到下一个硬状态,否则将在状态更改后应用。 |
|
应用功能状态。 选项
|
|
服务应用规则的自定义属性。 |
|
要配置的 Icinga service_templates 列表 |
|
检查命令定义。 |
|
您的常规检查间隔。 |
|
时间段的名称,该时间段确定何时应监视此对象。默认情况下不受限制。 |
|
检查命令超时时间(以秒为单位)。覆盖 CheckCommand 的 timeout 属性。 |
|
已禁用对象将不会被部署。 选项
|
|
是否主动检查此对象。 选项
|
|
是否启用此对象的事件处理程序。 选项
|
|
是否为此对象发送通知。 选项
|
|
是否接受此对象的被动检查结果。 选项
|
|
是否处理此对象提供的性能数据。 选项
|
|
服务的事件命令,如果满足以下条件之一,则在每次检查执行时调用 服务处于软状态 服务状态更改为硬状态 服务状态从软状态或硬状态恢复为 OK/Up |
|
应直接分配给此服务的服务组。 服务组在各种情况下都很有用。 它们有助于在 Icinga Web 2 中提供特定于服务类型的视图,无论是用于自定义仪表板还是作为强制执行限制的工具。 服务组可以直接分配给单个服务或服务模板。 默认值: |
|
可导入的模板,添加任意多个。 请注意,从多个模板导入属性时,顺序很重要 - 最后一个胜出。 默认值: |
|
定义在多少次检查尝试后达到新的硬状态。 |
|
服务模板的名称。 |
|
此对象的其他备注。 |
|
重试间隔,除非达到下一个硬状态,否则将在状态更改后应用。 |
|
应用功能状态。 选项
|
|
是否应在 Icinga 代理上执行此服务的检查命令。 选项
|
|
服务模板的自定义属性。 默认值: |
|
此检查是否为易变的。 选项
|
|
要配置的 Icinga sservicegroups 列表 |
|
这允许您配置分配过滤器。 请随意组合任意数量的嵌套运算符。 |
|
此组的替代显示名称。 如果您想知道这有什么帮助,请将其留空。 |
|
Icinga 服务组的名称。 |
|
应用功能状态。 选项
|
|
要配置的 Icinga 服务列表 |
|
检查命令定义。 |
|
您的常规检查间隔。 |
|
时间段的名称,该时间段确定何时应监视此对象。默认情况下不受限制。 |
|
检查命令超时时间(以秒为单位)。覆盖 CheckCommand 的 timeout 属性。 |
|
已禁用对象将不会被部署。 选项
|
|
是否主动检查此对象。 选项
|
|
是否启用此对象的事件处理程序。 选项
|
|
是否为此对象发送通知。 选项
|
|
是否接受此对象的被动检查结果。 选项
|
|
是否处理此对象提供的性能数据。 选项
|
|
应直接分配给此服务的服务组。 服务组在各种情况下都很有用。 它们有助于在 Icinga Web 2 中提供特定于服务类型的视图,无论是用于自定义仪表板还是作为强制执行限制的工具。 服务组可以直接分配给单个服务或服务模板。 默认值: |
|
选择应将此单个服务分配到的主机。 |
|
可导入的模板,添加任意多个。 请注意,从多个模板导入属性时,顺序很重要 - 最后一个胜出。 默认值: |
|
定义在多少次检查尝试后达到新的硬状态。 |
|
服务的名称。 |
|
此对象的其他备注。 |
|
重试间隔,除非达到下一个硬状态,否则将在状态更改后应用。 |
|
应用功能状态。 选项
|
|
是否应在 Icinga 代理上执行此服务的检查命令。 选项
|
|
服务的自定义属性。 默认值: |
|
此检查是否为易变的。 选项
|
|
要配置的 Icinga timeperiods 列表 |
|
此时间段的替代名称。 |
|
可导入的模板,添加任意多个。 请注意,从多个模板导入属性时,顺序很重要 - 最后一个胜出。 |
|
时间段的名称。 |
|
日期和时间段的字典。 |
|
应用功能状态。 选项
|
|
要配置的 Icinga user_templates 列表 |
|
是否为此用户发送通知。 选项
|
|
可导入的模板,添加任意多个。 请注意,从多个模板导入属性时,顺序很重要 - 最后一个胜出。 |
|
用户模板的名称。 |
|
时间段的名称,该时间段确定何时应触发对该用户的通知。默认情况下未设置。 |
|
应用功能状态。 选项
|
|
用户的自定义属性。 默认值: |
|
要配置的 Icinga 用户列表 |
|
已禁用对象将不会被部署。 选项
|
|
此用户的替代名称。 如果您的对象名称是用户名,这可能是对应人员的完整姓名。 |
|
用户的电子邮件地址。 |
|
应直接分配给此用户的用户组。 分组在多种情况下都很有用。 您可能更喜欢向组而不是单个用户发送通知。 |
|
可导入的模板,添加任意多个。 请注意,从多个模板导入属性时,顺序很重要 - 最后一个胜出。 |
|
用户的姓名。 |
|
用户的寻呼机地址。 |
|
时间段的名称,该时间段确定何时应触发对该用户的通知。默认情况下未设置。 |
|
应用功能状态。 选项
|
|
用户的自定义属性。 默认值: |
|
要配置的 Icinga 区域列表 |
|
是否应将此区域的配置文件同步到所有端点。 选项
|
|
此区域的 Icinga 对象名称。 这通常是完全限定的主机名,但基本上可以是任何类型的字符串。 为了方便您的用户,我们强烈建议您为模板使用有意义的名称。 例如,“generic-zone”很难看懂,“Standard Linux Server”更容易理解。 |
|
父区域的名称。 |
|
应用功能状态。 选项
|