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 (on host that executes module)
- python >= 2.6
- pyrax
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
|
||
| details |
yes |
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)
|
no |
Environment as configured in
~/.pyrax.cfg, see
https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration.
|
||
| 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. String between 1 and 255 characters long.
|
||
| notification_type |
yes |
|
A supported notification type.
|
|
| region |
no | DFW |
Region to create an instance in.
|
|
| state |
no |
|
Ensure that the notification 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.
|
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
Notes
Note
- The following environment variables can be used,
RAX_USERNAME,RAX_API_KEY,RAX_CREDS_FILE,RAX_CREDENTIALS,RAX_REGION. -
RAX_CREDENTIALSandRAX_CREDS_FILEpoints to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating -
RAX_USERNAMEandRAX_API_KEYobviate the use of a credentials file -
RAX_REGIONdefines 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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/rax_mon_notification_module.html
