W3cubDocs

/Ansible

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

Note

This plugin is part of the community.general collection (version 3.8.1).

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_alert_profiles.

Synopsis

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

Requirements

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

Parameters

Parameter Choices/Defaults 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
string
The path to a CA bundle file or directory with certificates. defaults to None.

aliases: ca_bundle_path
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
boolean
    Choices:
  • no
  • yes
Whether SSL certificates should be verified for HTTPS requests. defaults to True.

aliases: verify_ssl
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
    Choices:
  • Vm
  • ContainerNode
  • MiqServer
  • Host
  • Storage
  • EmsCluster
  • ExtManagementSystem
  • MiddlewareServer
The resource type for the alert profile in ManageIQ. Required when state is "present".
state
string
    Choices:
  • absent
  • present
absent - alert profile should not exist,
present - alert profile should exist,

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

- 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

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/manageiq_alert_profiles_module.html