Documentation

rax_mon_notification_plan - Create or delete a Rackspace Cloud Monitoring notification plan.

New in version 2.0.

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

Options

parameter required default choices comments
api_key
no
Rackspace API key, overrides credentials.

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

aliases: creds_file
critical_state
no
Notification list to use when the alarm state is CRITICAL. Must be an array of valid rax_mon_notification ids.
env
(added in 1.5)
no
identity_type
(added in 1.5)
no rackspace
Authentication mechanism to use, such as rackspace or keystone.
label
yes
Defines a friendly name for this notification plan. String between 1 and 255 characters long.
ok_state
no
Notification list to use when the alarm state is OK. Must be an array of valid rax_mon_notification ids.
region
no DFW
Region to create an instance in.
state
no
  • present
  • absent
Ensure that the notification plan with this label exists or does not exist.
tenant_id
(added in 1.5)
no
The tenant ID used for authentication.
tenant_name
(added in 1.5)
no
The tenant name used for authentication.
username
no
Rackspace username, overrides credentials.
verify_ssl
(added in 1.5)
no
Whether or not to require SSL validation of API endpoints.
warning_state
no
Notification list to use when the alarm state is WARNING. Must be an array of valid rax_mon_notification ids.

Examples

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

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, ...)

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.