Class: Ansible::Ruby::Modules::Sensu_check

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Sensu_check

Defined in:

lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb

Instance Method Summary

• #aggregate ⇒ Boolean^?

  Classifies the check as an aggregate check,,making it available via the aggregate API.

• #backup ⇒ Boolean^?

  Create a backup file (if yes), including the timestamp information so,you can get the original file back if you somehow clobbered it incorrectly.

• #command ⇒ String

  Path to the sensu check to run (not required when I(state=absent)).

• #custom ⇒ Object^?

  A hash/dictionary of custom parameters for mixing to the configuration.,You can’t rewrite others module parameters using this.

• #dependencies ⇒ Object^?

  Other checks this check depends on, if dependencies fail,,handling of this check will be disabled.

• #handle ⇒ Boolean^?

  Whether the check should be handled or not.

• #handlers ⇒ Object^?

  List of handlers to notify when the check fails.

• #high_flap_threshold ⇒ Object^?

  The low threshhold for flap detection.

• #interval ⇒ String^?

  Check interval in seconds.

• #low_flap_threshold ⇒ Object^?

  The low threshhold for flap detection.

• #metric ⇒ Boolean^?

  Whether the check is a metric.

• #name ⇒ String

  The name of the check,This is the key that is used to determine whether a check exists.

• #occurrences ⇒ Integer^?

  Number of event occurrences before the handler should take action.

• #path ⇒ String^?

  Path to the json file of the check to be added/removed.,Will be created if it does not exist (unless I(state=absent)).,The parent folders need to exist when I(state=present), otherwise an error will be thrown.

• #publish ⇒ Boolean^?

  Whether the check should be scheduled at all.,You can still issue it via the sensu api.

• #refresh ⇒ Object^?

  Number of seconds handlers should wait before taking second action.

• #source ⇒ Object^?

  The check source, used to create a JIT Sensu client for an external resource (e.g. a network switch).

• #standalone ⇒ Boolean^?

  Whether the check should be scheduled by the sensu client or server,This option obviates the need for specifying the I(subscribers) option.

• #state ⇒ :present, ...

  Whether the check should be present or not.

• #subdue_begin ⇒ Object^?

  When to disable handling of check failures.

• #subdue_end ⇒ Object^?

  When to enable handling of check failures.

• #subscribers ⇒ Object^?

  List of subscribers/channels this check should run for,See sensu_subscribers to subscribe a machine to a channel.

• #timeout ⇒ Integer^?

  Timeout for the check.

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

#aggregate ⇒ Boolean^?

Returns Classifies the check as an aggregate check,,making it available via the aggregate API.

Returns:

• (Boolean, nil) —

  Classifies the check as an aggregate check,,making it available via the aggregate API

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 76

attribute :aggregate

#backup ⇒ Boolean^?

Returns Create a backup file (if yes), including the timestamp information so,you can get the original file back if you somehow clobbered it incorrectly.

Returns:

• (Boolean, nil) —

  Create a backup file (if yes), including the timestamp information so,you can get the original file back if you somehow clobbered it incorrectly.

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 22

attribute :backup

#command ⇒ String

Returns Path to the sensu check to run (not required when I(state=absent)).

Returns:

• (String) —

  Path to the sensu check to run (not required when I(state=absent))

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 26

attribute :command

#custom ⇒ Object^?

Returns A hash/dictionary of custom parameters for mixing to the configuration.,You can’t rewrite others module parameters using this.

Returns:

• (Object, nil) —

  A hash/dictionary of custom parameters for mixing to the configuration.,You can’t rewrite others module parameters using this

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 86

attribute :custom

#dependencies ⇒ Object^?

Returns Other checks this check depends on, if dependencies fail,,handling of this check will be disabled.

Returns:

• (Object, nil) —

  Other checks this check depends on, if dependencies fail,,handling of this check will be disabled

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 54

attribute :dependencies

#handle ⇒ Boolean^?

Returns Whether the check should be handled or not.

Returns:

• (Boolean, nil) —

  Whether the check should be handled or not

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 44

attribute :handle

#handlers ⇒ Object^?

Returns List of handlers to notify when the check fails.

Returns:

• (Object, nil) —

  List of handlers to notify when the check fails

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 30

attribute :handlers

#high_flap_threshold ⇒ Object^?

Returns The low threshhold for flap detection.

Returns:

• (Object, nil) —

  The low threshhold for flap detection

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 83

attribute :high_flap_threshold

#interval ⇒ String^?

Returns Check interval in seconds.

Returns:

• (String, nil) —

  Check interval in seconds

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 36

attribute :interval

#low_flap_threshold ⇒ Object^?

Returns The low threshhold for flap detection.

Returns:

• (Object, nil) —

  The low threshhold for flap detection

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 80

attribute :low_flap_threshold

#metric ⇒ Boolean^?

Returns Whether the check is a metric.

Returns:

• (Boolean, nil) —

  Whether the check is a metric

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 57

attribute :metric

#name ⇒ String

Returns The name of the check,This is the key that is used to determine whether a check exists.

Returns:

• (String) —

  The name of the check,This is the key that is used to determine whether a check exists

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 10

attribute :name

#occurrences ⇒ Integer^?

Returns Number of event occurrences before the handler should take action.

Returns:

• (Integer, nil) —

  Number of event occurrences before the handler should take action

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 69

attribute :occurrences

#path ⇒ String^?

Returns Path to the json file of the check to be added/removed.,Will be created if it does not exist (unless I(state=absent)).,The parent folders need to exist when I(state=present), otherwise an error will be thrown.

Returns:

• (String, nil) —

  Path to the json file of the check to be added/removed.,Will be created if it does not exist (unless I(state=absent)).,The parent folders need to exist when I(state=present), otherwise an error will be thrown

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 18

attribute :path

#publish ⇒ Boolean^?

Returns Whether the check should be scheduled at all.,You can still issue it via the sensu api.

Returns:

• (Boolean, nil) —

  Whether the check should be scheduled at all.,You can still issue it via the sensu api

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 65

attribute :publish

#refresh ⇒ Object^?

Returns Number of seconds handlers should wait before taking second action.

Returns:

• (Object, nil) —

  Number of seconds handlers should wait before taking second action

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 73

attribute :refresh

#source ⇒ Object^?

Returns The check source, used to create a JIT Sensu client for an external resource (e.g. a network switch).

Returns:

• (Object, nil) —

  The check source, used to create a JIT Sensu client for an external resource (e.g. a network switch).

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 89

attribute :source

#standalone ⇒ Boolean^?

Returns Whether the check should be scheduled by the sensu client or server,This option obviates the need for specifying the I(subscribers) option.

Returns:

• (Boolean, nil) —

  Whether the check should be scheduled by the sensu client or server,This option obviates the need for specifying the I(subscribers) option

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 61

attribute :standalone

#state ⇒ :present, ...

Returns Whether the check should be present or not.

Returns:

• (:present, :absent, nil) —

  Whether the check should be present or not

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 14

attribute :state

#subdue_begin ⇒ Object^?

Returns When to disable handling of check failures.

Returns:

• (Object, nil) —

  When to disable handling of check failures

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 48

attribute :subdue_begin

#subdue_end ⇒ Object^?

Returns When to enable handling of check failures.

Returns:

• (Object, nil) —

  When to enable handling of check failures

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 51

attribute :subdue_end

#subscribers ⇒ Object^?

Returns List of subscribers/channels this check should run for,See sensu_subscribers to subscribe a machine to a channel.

Returns:

• (Object, nil) —

  List of subscribers/channels this check should run for,See sensu_subscribers to subscribe a machine to a channel

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 33

attribute :subscribers

#timeout ⇒ Integer^?

Returns Timeout for the check.

Returns:

• (Integer, nil) —

  Timeout for the check

# File 'lib/ansible/ruby/modules/generated/extras/monitoring/sensu_check.rb', line 40

attribute :timeout