rax_mon_notification – Create or delete a Rackspace Cloud Monitoring notification.

New in version 2.0.

Synopsis

  • Create or delete a Rackspace Cloud Monitoring notification that specifies a channel that can be used to communicate alarms, such as email, webhooks, or PagerDuty. 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
-
Rackspace API key, overrides credentials.

aliases: password
auth_endpoint
-
added in 1.5
 Default:
"https://identity.api.rackspacecloud.com/v2.0/"
The URI of the authentication service.
credentials
-
File to find the Rackspace credentials in. Ignored if api_key and username are provided.

aliases: creds_file
details
- / required
Dictionary of key-value pairs used to initialize the notification. Required keys and meanings vary with notification type. See http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/ service-notification-types-crud.html for details.
env
-
added in 1.5
identity_type
-
added in 1.5
 Default:
"rackspace"
Authentication mechanism to use, such as rackspace or keystone.
label
- / required
Defines a friendly name for this notification. String between 1 and 255 characters long.
notification_type
- / required
    Choices:
  • webhook
  • email
  • pagerduty
A supported notification type.
region
-
Default:
"DFW"
Region to create an instance in.
state
-
    Choices:
  • present
  • absent
Ensure that the notification with this label exists or does not exist.
tenant_id
-
added in 1.5
The tenant ID used for authentication.
tenant_name
-
added in 1.5
The tenant name used for authentication.
username
-
Rackspace username, overrides credentials.
verify_ssl
-
added in 1.5
Whether or not to require SSL validation of API endpoints.

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: Monitoring notification example
  gather_facts: False
  hosts: local
  connection: local
  tasks:
  - name: Email me when something goes wrong.
    rax_mon_entity:
      credentials: ~/.rax_pub
      label: omg
      type: email
      details:
        address: [email protected]
    register: the_notification

Status

Authors

  • Ash Wilson (@smashwilson)

Hint

If you notice any issues in this documentation you can edit this document to improve it.