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/monitoring/sensu_check.rb
Overview
Manage the checks that should be run on a machine by I(Sensu). Most options do not have a default and will not be added to the check definition unless specified. All defaults except I(path), I(state), I(backup) and I(metric) are not managed by this module, they are simply specified for your convenience.
Instance Method Summary collapse
-
#aggregate ⇒ :yes, ...
Classifies the check as an aggregate check,,making it available via the aggregate API.
-
#backup ⇒ :yes, ...
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 ⇒ :yes, ...
Whether the check should be handled or not.
-
#handlers ⇒ Object?
List of handlers to notify when the check fails.
-
#high_flap_threshold ⇒ Object?
The high threshold for flap detection.
-
#interval ⇒ Integer?
Check interval in seconds.
-
#low_flap_threshold ⇒ Object?
The low threshold for flap detection.
-
#metric ⇒ :yes, ...
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 ⇒ :yes, ...
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 ⇒ :yes, ...
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.
-
#ttl ⇒ Object?
Time to live in seconds until the check is considered stale.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#aggregate ⇒ :yes, ...
Returns Classifies the check as an aggregate check,,making it available via the aggregate API.
84 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 84 attribute :aggregate |
#backup ⇒ :yes, ...
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.
27 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 27 attribute :backup |
#command ⇒ String
Returns Path to the sensu check to run (not required when I(state=absent)).
31 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 31 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.
94 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 94 attribute :custom |
#dependencies ⇒ Object?
Returns Other checks this check depends on, if dependencies fail,,handling of this check will be disabled.
62 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 62 attribute :dependencies |
#handle ⇒ :yes, ...
Returns Whether the check should be handled or not.
52 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 52 attribute :handle |
#handlers ⇒ Object?
Returns List of handlers to notify when the check fails.
35 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 35 attribute :handlers |
#high_flap_threshold ⇒ Object?
Returns The high threshold for flap detection.
91 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 91 attribute :high_flap_threshold |
#interval ⇒ Integer?
Returns Check interval in seconds.
41 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 41 attribute :interval |
#low_flap_threshold ⇒ Object?
Returns The low threshold for flap detection.
88 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 88 attribute :low_flap_threshold |
#metric ⇒ :yes, ...
Returns Whether the check is a metric.
65 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 65 attribute :metric |
#name ⇒ String
Returns The name of the check,This is the key that is used to determine whether a check exists.
15 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 15 attribute :name |
#occurrences ⇒ Integer?
Returns Number of event occurrences before the handler should take action.
77 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 77 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.
23 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 23 attribute :path |
#publish ⇒ :yes, ...
Returns Whether the check should be scheduled at all.,You can still issue it via the sensu api.
73 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 73 attribute :publish |
#refresh ⇒ Object?
Returns Number of seconds handlers should wait before taking second action.
81 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 81 attribute :refresh |
#source ⇒ Object?
Returns The check source, used to create a JIT Sensu client for an external resource (e.g. a network switch).
97 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 97 attribute :source |
#standalone ⇒ :yes, ...
Returns Whether the check should be scheduled by the sensu client or server,This option obviates the need for specifying the I(subscribers) option.
69 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 69 attribute :standalone |
#state ⇒ :present, ...
Returns Whether the check should be present or not.
19 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 19 attribute :state |
#subdue_begin ⇒ Object?
Returns When to disable handling of check failures.
56 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 56 attribute :subdue_begin |
#subdue_end ⇒ Object?
Returns When to enable handling of check failures.
59 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 59 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.
38 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 38 attribute :subscribers |
#timeout ⇒ Integer?
Returns Timeout for the check.
45 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 45 attribute :timeout |
#ttl ⇒ Object?
Returns Time to live in seconds until the check is considered stale.
49 |
# File 'lib/ansible/ruby/modules/generated/monitoring/sensu_check.rb', line 49 attribute :ttl |