community.general.manageiq_alerts 模块 – ManageIQ 中的告警配置

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.general。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:community.general.manageiq_alerts

概要

  • manageiq_alerts 模块支持在 ManageIQ 中添加、更新和删除告警。

要求

在执行此模块的主机上需要以下要求。

参数

参数

注释

description

字符串

ManageIQ 中唯一的告警描述。

当 state 为“absent”或“present”时,这是必需的。

enabled

布尔值

启用或禁用告警。如果 state 为“present”,则这是必需的。

选项

  • false

  • true

expression

字典

ManageIQ 的告警表达式。

可以是“Miq 表达式”格式或“哈希表达式”格式。

如果 state 为“present”,则这是必需的。

expression_type

字符串

表达式类型。

选项

  • "hash" ← (默认)

  • "miq"

manageiq_connection

字典

ManageIQ 连接配置信息。

ca_cert

别名:ca_bundle_path

字符串

CA 证书包文件或目录的路径。

password

字符串

ManageIQ 密码。MIQ_PASSWORD 环境变量(如果已设置)。否则,如果没有传递令牌,则需要此参数。

token

字符串

ManageIQ 令牌。MIQ_TOKEN 环境变量(如果已设置)。否则,如果没有传递用户名或密码,则需要此参数。

url

字符串

ManageIQ 环境 URL。MIQ_URL 环境变量(如果已设置)。否则,需要传递此参数。

username

字符串

ManageIQ 用户名。MIQ_USERNAME 环境变量(如果已设置)。否则,如果没有传递令牌,则需要此参数。

validate_certs

别名:verify_ssl

布尔值

是否应为 HTTPS 请求验证 SSL 证书。

选项

  • false

  • true ← (默认)

options

字典

其他告警选项,例如通知类型和频率

resource_type

字符串

ManageIQ 中告警的实体类型。当 state 为“present”时,这是必需的。

选项

  • "Vm"

  • "ContainerNode"

  • "MiqServer"

  • "Host"

  • "Storage"

  • "EmsCluster"

  • "ExtManagementSystem"

  • "MiddlewareServer"

state

字符串

absent - 告警不应该存在,

present - 告警应该存在,

选项

  • "absent"

  • "present" ← (默认)

属性

属性

支持

描述

check_mode

支持:不支持

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

diff_mode

支持:不支持

在 diff 模式下,将返回有关已更改内容(或可能需要在 check_mode 下更改的内容)的详细信息。

示例

- name: Add an alert with a "hash expression" to ManageIQ
  community.general.manageiq_alerts:
    state: present
    description: Test Alert 01
    options:
      notifications:
        email:
          to: ["[email protected]"]
          from: "[email protected]"
    resource_type: ContainerNode
    expression:
        eval_method: hostd_log_threshold
        mode: internal
        options: {}
    enabled: true
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: false  # only do this when you trust the network!

- name: Add an alert with a "miq expression" to ManageIQ
  community.general.manageiq_alerts:
    state: present
    description: Test Alert 02
    options:
      notifications:
        email:
          to: ["[email protected]"]
          from: "[email protected]"
    resource_type: Vm
    expression_type: miq
    expression:
        and:
          - CONTAINS:
              tag: Vm.managed-environment
              value: prod
          - not:
            CONTAINS:
              tag: Vm.host.managed-environment
              value: prod
    enabled: true
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: false  # only do this when you trust the network!

- name: Delete an alert from ManageIQ
  community.general.manageiq_alerts:
    state: absent
    description: Test Alert 01
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: false  # only do this when you trust the network!

作者

  • Elad Alfassa (@elad661)