Class: Ansible::Ruby::Modules::Rax_mon_entity

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

Overview

Create or delete a Rackspace Cloud Monitoring entity, which represents a device to monitor. Entities associate checks and alarms with a target system and provide a convenient, centralized place to store IP addresses. 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

#agent_id ⇒ Object?

Returns Rackspace monitoring agent on the target device to which this entity is bound. Necessary to collect C(agent.) rax_mon_checks against this entity.

Returns:

  • (Object, nil) —

    Rackspace monitoring agent on the target device to which this entity is bound. Necessary to collect C(agent.) rax_mon_checks against this entity.



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

attribute :agent_id

#label ⇒ Object

Returns Defines a name for this entity. Must be a non-empty string between 1 and 255 characters long.

Returns:

  • (Object) —

    Defines a name for this entity. Must be a non-empty string between 1 and 255 characters long.



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

attribute :label

#metadata ⇒ Object?

Returns Hash of arbitrary C(name), C(value) pairs that are passed to associated rax_mon_alarms. Names and values must all be between 1 and 255 characters long.

Returns:

  • (Object, nil) —

    Hash of arbitrary C(name), C(value) pairs that are passed to associated rax_mon_alarms. Names and values must all be between 1 and 255 characters long.



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

attribute :metadata

#named_ip_addresses ⇒ Object?

Returns Hash of IP addresses that may be referenced by name by rax_mon_checks added to this entity. Must be a dictionary of with keys that are names between 1 and 64 characters long, and values that are valid IPv4 or IPv6 addresses.

Returns:

  • (Object, nil) —

    Hash of IP addresses that may be referenced by name by rax_mon_checks added to this entity. Must be a dictionary of with keys that are names between 1 and 64 characters long, and values that are valid IPv4 or IPv6 addresses.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_mon_entity.rb', line 23

attribute :named_ip_addresses

#state ⇒ :present, ...

Returns Ensure that an entity with this C(name) exists or does not exist.

Returns:

  • (:present, :absent, nil) —

    Ensure that an entity with this C(name) exists or does not exist.



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

attribute :state