Class: Ansible::Ruby::Modules::Rax_mon_alarm

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb

Overview

Create or delete a Rackspace Cloud Monitoring alarm that associates an existing rax_mon_entity, rax_mon_check, and rax_mon_notification_plan with criteria that specify what conditions will trigger which levels of notifications. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#check_id ⇒ Object

Returns ID of the check that should be alerted on. May be acquired by registering the value of a rax_mon_check task.

Returns:

  • (Object) —

    ID of the check that should be alerted on. May be acquired by registering the value of a rax_mon_check task.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb', line 24

attribute :check_id

#criteria ⇒ Object?

Returns Alarm DSL that describes alerting conditions and their output states. Must be between 1 and 16384 characters long. See docs.rackspace.com/cm/api/v1.0/cm-devguide/content/alerts-language.html for a reference on the alerting language.

Returns:



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb', line 32

attribute :criteria

#disabled ⇒ Symbol?

Returns If yes, create this alarm, but leave it in an inactive state. Defaults to no.

Returns:

  • (Symbol, nil) —

    If yes, create this alarm, but leave it in an inactive state. Defaults to no.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb', line 35

attribute :disabled

#entity_id ⇒ Object

Returns ID of the entity this alarm is attached to. May be acquired by registering the value of a rax_mon_entity task.

Returns:

  • (Object) —

    ID of the entity this alarm is attached to. May be acquired by registering the value of a rax_mon_entity task.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb', line 20

attribute :entity_id

#label ⇒ Object

Returns Friendly name for this alarm, used to achieve idempotence. Must be a String between 1 and 255 characters long.

Returns:

  • (Object) —

    Friendly name for this alarm, used to achieve idempotence. Must be a String between 1 and 255 characters long.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb', line 16

attribute :label

#metadata ⇒ Object?

Returns Arbitrary key/value pairs to accompany the alarm. Must be a hash of String keys and values between 1 and 255 characters long.

Returns:

  • (Object, nil) —

    Arbitrary key/value pairs to accompany the alarm. Must be a hash of String keys and values between 1 and 255 characters long.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb', line 39

attribute :metadata

#notification_plan_id ⇒ Object

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

Returns:

  • (Object) —

    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.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb', line 28

attribute :notification_plan_id

#state ⇒ :present, ...

Returns Ensure that the alarm with this C(label) exists or does not exist.

Returns:

  • (:present, :absent, nil) —

    Ensure that the alarm with this C(label) exists or does not exist.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_alarm.rb', line 12

attribute :state