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

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #initialize, #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.



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

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:



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

attribute :criteria

#disabled ⇒ :yes, ...

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

Returns:

  • (:yes, :no, nil) —

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



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

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.



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

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.



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

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.



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

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.



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

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.



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

attribute :state