community.general.manageiq_alert_profiles module – Configuration of alert profiles for ManageIQ
Note
This module is part of the community.general collection (version 8.6.4).
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.
manageiq-client https://github.com/ManageIQ/manageiq-api-client-python/
Parameters
Parameter |
Comments |
---|---|
List of alert descriptions to assign to this profile. Required if state is “present” |
|
ManageIQ connection configuration information. |
|
The path to a CA bundle file or directory with certificates. |
|
ManageIQ password. |
|
ManageIQ token. |
|
ManageIQ environment URL. |
|
ManageIQ username. |
|
Whether SSL certificates should be verified for HTTPS requests. Choices:
|
|
The unique alert profile name in ManageIQ. Required when state is “absent” or “present”. |
|
Optional notes for this profile |
|
The resource type for the alert profile in ManageIQ. Required when state is “present”. Choices:
|
|
absent - alert profile should not exist, present - alert profile should exist, Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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!