Class: Ansible::Ruby::Modules::Rax_mon_check

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

Overview

Create or delete a Rackspace Cloud Monitoring check associated with an existing rax_mon_entity. A check is a specific test or measurement that is performed, possibly from different monitoring zones, on the systems you monitor. 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_type ⇒ :"remote.dns", ...

Returns The type of check to create. C(remote.) checks may be created on any rax_mon_entity. C(agent.) checks may only be created on rax_mon_entities that have a non-null C(agent_id).

Returns:

  • (:"remote.dns", :"remote.ftp-banner", :"remote.http", :"remote.imap-banner", :"remote.mssql-banner", :"remote.mysql-banner", :"remote.ping", :"remote.pop3-banner", :"remote.postgresql-banner", :"remote.smtp-banner", :"remote.smtp", :"remote.ssh", :"remote.tcp", :"remote.telnet-banner", :"agent.filesystem", :"agent.memory", :"agent.load_average", :"agent.cpu", :"agent.disk", :"agent.network", :"agent.plugin") —

    The type of check to create. C(remote.) checks may be created on any rax_mon_entity. C(agent.) checks may only be created on rax_mon_entities that have a non-null C(agent_id).



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

attribute :check_type

#details ⇒ Object?

Returns Additional details specific to the check type. Must be a hash of strings between 1 and 255 characters long, or an array or object containing 0 to 256 items.

Returns:

  • (Object, nil) —

    Additional details specific to the check type. Must be a hash of strings between 1 and 255 characters long, or an array or object containing 0 to 256 items.



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

attribute :details

#disabled ⇒ Symbol?

Returns If “yes”, ensure the check is created, but don’t actually use it yet.

Returns:

  • (Symbol, nil) —

    If “yes”, ensure the check is created, but don’t actually use it yet.



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_check.rb', line 40

attribute :disabled

#entity_id ⇒ Object

Returns ID of the rax_mon_entity to target with this check.

Returns:

  • (Object) —

    ID of the rax_mon_entity to target with this check.



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

attribute :entity_id

#label ⇒ Object

Returns Defines a label for this check, between 1 and 64 characters long.

Returns:

  • (Object) —

    Defines a label for this check, between 1 and 64 characters long.



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

attribute :label

#metadata ⇒ Object?

Returns Hash of arbitrary key-value pairs to accompany this check if it fires. Keys and values must be strings between 1 and 255 characters long.

Returns:

  • (Object, nil) —

    Hash of arbitrary key-value pairs to accompany this check if it fires. Keys and values must be strings between 1 and 255 characters long.



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_check.rb', line 44

attribute :metadata

#monitoring_zones_poll ⇒ Object?

Returns Comma-separated list of the names of the monitoring zones the check should run from. Available monitoring zones include mzdfw, mzhkg, mziad, mzlon, mzord and mzsyd. Required for remote.* checks; prohibited for agent.* checks.

Returns:

  • (Object, nil) —

    Comma-separated list of the names of the monitoring zones the check should run from. Available monitoring zones include mzdfw, mzhkg, mziad, mzlon, mzord and mzsyd. Required for remote.* checks; prohibited for agent.* checks.



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

attribute :monitoring_zones_poll

#period ⇒ Object?

Returns The number of seconds between each time the check is performed. Must be greater than the minimum period set on your account.

Returns:

  • (Object, nil) —

    The number of seconds between each time the check is performed. Must be greater than the minimum period set on your account.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_check.rb', line 47

attribute :period

#state ⇒ :present, ...

Returns Ensure that a check with this C(label) exists or does not exist.

Returns:

  • (:present, :absent, nil) —

    Ensure that a check with this C(label) exists or does not exist.



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

attribute :state

#target_alias ⇒ Object?

Returns One of ‘target_alias` and `target_hostname` is required for remote.* checks, but prohibited for agent.* checks. Use the corresponding key in the entity’s ‘ip_addresses` hash to resolve an IP address to target.

Returns:

  • (Object, nil) —

    One of ‘target_alias` and `target_hostname` is required for remote.* checks, but prohibited for agent.* checks. Use the corresponding key in the entity’s ‘ip_addresses` hash to resolve an IP address to target.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_check.rb', line 34

attribute :target_alias

#target_hostname ⇒ Object?

Returns One of ‘target_hostname` and `target_alias` is required for remote.* checks, but prohibited for agent.* checks. The hostname this check should target. Must be a valid IPv4, IPv6, or FQDN.

Returns:

  • (Object, nil) —

    One of ‘target_hostname` and `target_alias` is required for remote.* checks, but prohibited for agent.* checks. The hostname this check should target. Must be a valid IPv4, IPv6, or FQDN.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_check.rb', line 31

attribute :target_hostname

#timeout ⇒ Object?

Returns The number of seconds this check will wait when attempting to collect results. Must be less than the period.

Returns:

  • (Object, nil) —

    The number of seconds this check will wait when attempting to collect results. Must be less than the period.



50
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_check.rb', line 50

attribute :timeout