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.
|
check_id
required |
|
ID of the check that should be alerted on. May be acquired by registering the value of a rax_mon_check task.
|
credentials
|
|
File to find the Rackspace credentials in. Ignored if api_key and username are provided.
aliases: creds_file
|
criteria
|
|
Alarm DSL that describes alerting conditions and their output states. Must be between 1 and 16384 characters long. See http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/alerts-language.html for a reference on the alerting language.
|
disabled
bool |
|
If yes, create this alarm, but leave it in an inactive state. Defaults to no.
|
entity_id
required |
|
ID of the entity this alarm is attached to. May be acquired by registering the value of a rax_mon_entity task.
|
env
(added in 1.5) |
|
|
identity_type
(added in 1.5) |
Default:
rackspace
|
Authentication mechanism to use, such as rackspace or keystone.
|
label
required |
|
Friendly name for this alarm, used to achieve idempotence. Must be a String between 1 and 255 characters long.
|
metadata
|
|
Arbitrary key/value pairs to accompany the alarm. Must be a hash of String keys and values between 1 and 255 characters long.
|
notification_plan_id
required |
|
ID of the notification plan to trigger if this alarm fires. May be acquired by registering the value of a rax_mon_notification_plan task.
|
region
|
Default:
DFW
|
Region to create an instance in.
|
state
|
Choices:
present ←
- absent
|
Ensure that the alarm 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.
|