community.general.manageiq_alerts module – Configuration of alerts in ManageIQ

Note

This module is part of the community.general collection (version 4.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.manageiq_alerts.

Synopsis

  • The manageiq_alerts module supports adding, updating and deleting alerts in ManageIQ.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

description

string

The unique alert description in ManageIQ.

Required when state is “absent” or “present”.

enabled

boolean

Enable or disable the alert. Required if state is “present”.

Choices:

  • no

  • yes

expression

dictionary

The alert expression for ManageIQ.

Can either be in the “Miq Expression” format or the “Hash Expression format”.

Required if state is “present”.

expression_type

string

Expression type.

Choices:

  • hash ← (default)

  • miq

manageiq_connection

dictionary

ManageIQ connection configuration information.

ca_cert

aliases: ca_bundle_path

string

The path to a CA bundle file or directory with certificates. defaults to None.

password

string

ManageIQ password. MIQ_PASSWORD env var if set. otherwise, required if no token is passed in.

token

string

ManageIQ token. MIQ_TOKEN env var if set. otherwise, required if no username or password is passed in.

url

string

ManageIQ environment url. MIQ_URL env var if set. otherwise, it is required to pass it.

username

string

ManageIQ username. MIQ_USERNAME env var if set. otherwise, required if no token is passed in.

validate_certs

aliases: verify_ssl

boolean

Whether SSL certificates should be verified for HTTPS requests. defaults to True.

Choices:

  • no

  • yes ← (default)

options

dictionary

Additional alert options, such as notification type and frequency

resource_type

string

The entity type for the alert in ManageIQ. Required when state is “present”.

Choices:

  • Vm

  • ContainerNode

  • MiqServer

  • Host

  • Storage

  • EmsCluster

  • ExtManagementSystem

  • MiddlewareServer

state

string

absent - alert should not exist,

present - alert should exist,

Choices:

  • absent

  • present ← (default)

Examples

- 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

- 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

- 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

Authors

  • Elad Alfassa (@elad661)