telekom_mms.icinga_director.icinga_command_template 模块 – 在 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_command_template。

telekom_mms.icinga_director 1.1.0 中的新增功能

概要 

通过 director API 添加或删除 Icinga2 的命令模板。

参数 

参数	注释
append 布尔值在 telekom_mms.icinga_director 1.25.0 中添加	不要覆盖整个对象，而是追加定义的属性。注意 - 不可能追加到现有的变量、导入或任何其他列表/字典。您必须覆盖完整的列表/字典。注意 - 默认设置的变量也将应用，即使未设置也是如此。选项 `false` `true`
arguments 字典	命令模板的参数。每个参数都可以采用字符串、json 或字典当使用字典作为参数值时，支持以下属性：`skip_key`，`repeat_key`，`required`，`order`，`description`），`set_if`，`value`。 `value` 属性可以是字符串、json 或字典。当用作字典时，您可以将其 `type` 定义为 `Function` 并将其 `body` 属性设置为 Icinga DSL 配置片段。
client_cert 路径	用于 SSL 客户端身份验证的 PEM 格式证书链文件。此文件也可以包含密钥，如果包含密钥，则不需要 `client_key`。
client_key 路径	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果 `client_cert` 包含证书和密钥，则不需要此选项。
command 字符串	Icinga 应该运行的命令。接受提供的绝对路径，相对路径以“PluginDir + ”为前缀，允许类似的常量前缀。空格将导致命令路径和独立参数的分隔。请注意，这意味着我们目前不支持插件名称和路径中的空格。
disabled 布尔值	禁用的对象将不会部署。选项 `false` ← (默认) `true`
force 布尔值	如果 `yes`，则不会获取缓存副本。选项 `false` ← (默认) `true`
force_basic_auth 布尔值	使用 `url_username` 和 `url_password` 指定的凭据应通过 HTTP 标头传递。选项 `false` ← (默认) `true`
http_agent 字符串	用于识别的标头，通常出现在 Web 服务器日志中。默认值： `"ansible-httpget"`
imports 列表 / 元素=字符串	可导入的模板，您可以添加任意多个。请注意，从多个模板导入属性时，顺序很重要 - 最后一个优先。默认值： `[]`
methods_execute 别名：command_type 字符串	当对您的基础设施运行检查时，您需要插件检查命令。通知命令将在通知用户时使用。事件命令允许您在出现问题时触发特定操作。有些人将它们用于自动修复机制，例如在特定阈值时重启服务或重新启动系统。选项 `"PluginCheck"` ← (默认) `"PluginNotification"` `"PluginEvent"`
object_name 别名：name 字符串 / 必需	命令模板的名称。
state 字符串	应用功能状态。选项 `"present"` ← (默认) `"absent"`
timeout 字符串	可选命令超时。允许的值是秒或后缀为特定单位的持续时间（例如 1m 或 3m 30s）。
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或通过Negotiate身份验证的Kerberos。需要安装Python库gssapi。 GSSAPI的凭据可以通过`url_username`/`url_password`或通过指定自定义Kerberos凭据缓存的GSSAPI环境变量`KRB5CCNAME`来指定。即使已安装用于NTLM的GSSAPI机制，也不支持NTLM身份验证。选项 `false` ← (默认) `true`
use_proxy 布尔值	如果为`no`，即使目标主机上的环境变量中定义了代理，也不会使用代理。选项 `false` `true` ← (默认)
validate_certs 布尔值	如果为`no`，则不会验证SSL证书。这仅应在使用自签名证书的个人控制站点上使用。选项 `false` `true` ← (默认)
vars 字典	命令模板的自定义属性。默认值： `{}`
zone 字符串	Icinga集群区域。允许手动覆盖Director关于将配置部署到何处的决策。除非您深入了解Icinga集群堆栈的工作原理，否则应考虑不要这样做。

备注 

注意

此模块支持检查模式。

示例 

- name: Create command template
  telekom_mms.icinga_director.icinga_command_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    arguments:
      '--authpassphrase':
        value: $snmpv3_priv_key$
      '--authprotocol':
        value: $snmpv3_auth_protocol$
      '--critical':
        value: $centreon_critical$
      '--filter':
        value: $centreon_filter$
      '--hostname':
        value: $snmp_address$
      '--maxrepetitions':
        value: $centreon_maxrepetitions$
      '--mode':
        value: $centreon_mode$
      '--plugin':
        value: $centreon_plugin$
      '--privpassphrase':
        value: $snmpv3_auth_key$
      '--privprotocol':
        value: $snmpv3_priv_protocol$
      '--snmp-community':
        value: $snmp_community$
      '--snmp-timeout':
        value: $snmp_timeout$
      '--snmp-username':
        value: $snmpv3_user$
      '--snmp-version':
        value: $snmp_version$
      '--subsetleef':
        value: $centreon_subsetleef$
      '--verbose':
        set_if: $centreon_verbose$
      '--warning':
        value: $centreon_warning$
      '--dummy-arg':
        description: "dummy arg using Icinga DSL code"
        value:
          type: "Function"
          body: 'return macro("$dummy_var$")'
    command: "/opt/centreon-plugins/centreon_plugins.pl"
    command_type: "PluginCheck"
    object_name: centreon-plugins-template
    disabled: false
    vars:
      centreon_maxrepetitions: 20
      centreon_subsetleef: 20
      centreon_verbose: false
      snmp_address: $address$
      snmp_timeout: 60
      snmp_version: '2'
      snmpv3_auth_key: authkey
      snmpv3_priv_key: privkey
      snmpv3_user: user

- name: Update command template
  telekom_mms.icinga_director.icinga_command_template:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: centreon-plugins-template
    timeout: "2m"
    append: true

作者

Lars Krahl (@mmslkr)