community.general.manageiq_alert_profiles module – Configuration of alert profiles for ManageIQ

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • The manageiq_alert_profiles module supports adding, updating and deleting alert profiles in ManageIQ.

Aliases: remote_management.manageiq.manageiq_alert_profiles

Requirements

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

Parameters

Parameter

Comments

alerts

list / elements=string

List of alert descriptions to assign to this profile.

Required if state is “present”

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.

password

string

ManageIQ password. MIQ_PASSWORD environment variable if set. Otherwise, required if no token is passed in.

token

string

ManageIQ token. MIQ_TOKEN environment variable if set. Otherwise, required if no username or password is passed in.

url

string

ManageIQ environment URL. MIQ_URL environment variable if set. Otherwise, it is required to pass it.

username

string

ManageIQ username. MIQ_USERNAME environment variable 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.

Choices:

  • false

  • true ← (default)

name

string

The unique alert profile name in ManageIQ.

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

notes

string

Optional notes for this profile

resource_type

string

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

Choices:

  • "Vm"

  • "ContainerNode"

  • "MiqServer"

  • "Host"

  • "Storage"

  • "EmsCluster"

  • "ExtManagementSystem"

  • "MiddlewareServer"

state

string

absent - alert profile should not exist,

present - alert profile should exist,

Choices:

  • "absent"

  • "present" ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Add an alert profile to ManageIQ
  community.general.manageiq_alert_profiles:
    state: present
    name: Test profile
    resource_type: ContainerNode
    alerts:
      - Test Alert 01
      - Test Alert 02
    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 profile from ManageIQ
  community.general.manageiq_alert_profiles:
    state: absent
    name: Test profile
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: false  # only do this when you trust the network!

Authors

  • Elad Alfassa (@elad661)