community.general.rax_mon_notification_plan – Create or delete a Rackspace Cloud Monitoring notification plan.

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

Synopsis

Create or delete a Rackspace Cloud Monitoring notification plan by associating existing rax_mon_notifications with severity levels. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Requirements

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

python >= 2.6
pyrax

Parameters

Parameter	Choices/Defaults	Comments
api_key string		Rackspace API key, overrides credentials. aliases: password
auth_endpoint string		The URI of the authentication service. If not specified will be set to https://identity.api.rackspacecloud.com/v2.0/
credentials path		File to find the Rackspace credentials in. Ignored if api_key and username are provided. aliases: creds_file
critical_state list / elements=string		Notification list to use when the alarm state is CRITICAL. Must be an array of valid rax_mon_notification ids.
env string		Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
identity_type string	Default: "rackspace"	Authentication mechanism to use, such as rackspace or keystone.
label string / required		Defines a friendly name for this notification plan. String between 1 and 255 characters long.
ok_state list / elements=string		Notification list to use when the alarm state is OK. Must be an array of valid rax_mon_notification ids.
region string		Region to create an instance in.
state string	Choices: present ← absent	Ensure that the notification plan with this `label` exists or does not exist.
tenant_id string		The tenant ID used for authentication.
tenant_name string		The tenant name used for authentication.
username string		Rackspace username, overrides credentials.
validate_certs boolean	Choices: no yes	Whether or not to require SSL validation of API endpoints. aliases: verify_ssl
warning_state list / elements=string		Notification list to use when the alarm state is WARNING. Must be an array of valid rax_mon_notification ids.

Notes

Note

The following environment variables can be used, RAX_USERNAME, RAX_API_KEY, RAX_CREDS_FILE, RAX_CREDENTIALS, RAX_REGION.
RAX_CREDENTIALS and RAX_CREDS_FILE points to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
RAX_USERNAME and RAX_API_KEY obviate the use of a credentials file
RAX_REGION defines a Rackspace Public Cloud region (DFW, ORD, LON, …)

Examples

- name: Example notification plan
  gather_facts: False
  hosts: local
  connection: local
  tasks:
  - name: Establish who gets called when.
    community.general.rax_mon_notification_plan:
      credentials: ~/.rax_pub
      state: present
      label: defcon1
      critical_state:
      - "{{ everyone['notification']['id'] }}"
      warning_state:
      - "{{ opsfloor['notification']['id'] }}"
    register: defcon1

Authors

Ash Wilson (@smashwilson)

© 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/rax_mon_notification_plan_module.html

Docs

Docs4dev

Title here