Class: Ansible::Ruby::Modules::Logicmonitor

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb

Overview

LogicMonitor is a hosted, full-stack, infrastructure monitoring platform. This module manages hosts, host groups, and collectors within your LogicMonitor account.

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

#action ⇒ :add, ...

Returns The action you wish to perform on target.,Add: Add an object to your LogicMonitor account.,Remove: Remove an object from your LogicMonitor account.,Update: Update properties, description, or groups (target=host) for an object in your LogicMonitor account.,SDT: Schedule downtime for an object in your LogicMonitor account.

Returns:

  • (:add, :remove, :update, :sdt) —

    The action you wish to perform on target.,Add: Add an object to your LogicMonitor account.,Remove: Remove an object from your LogicMonitor account.,Update: Update properties, description, or groups (target=host) for an object in your LogicMonitor account.,SDT: Schedule downtime for an object in your LogicMonitor account.



17
 
# File 'lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb', line 17

attribute :action

#alertenable ⇒ :yes, ...

Returns A boolean flag to turn alerting on or off for an object.,Optional for managing all hosts (action=add or action=update).

Returns:

  • (:yes, :no, nil) —

    A boolean flag to turn alerting on or off for an object.,Optional for managing all hosts (action=add or action=update).



60
 
# File 'lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb', line 60

attribute :alertenable

#collector ⇒ Object?

Returns The fully qualified domain name of a collector in your LogicMonitor account.,This is required for the creation of a LogicMonitor host (target=host action=add).,This is required for updating, removing or scheduling downtime for hosts if ‘displayname’ isn’t specified (target=host action=update action=remove action=sdt).

Returns:

  • (Object, nil) —

    The fully qualified domain name of a collector in your LogicMonitor account.,This is required for the creation of a LogicMonitor host (target=host action=add).,This is required for updating, removing or scheduling downtime for hosts if ‘displayname’ isn’t specified (target=host action=update action=remove action=sdt).



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

attribute :collector

#company ⇒ String

Returns The LogicMonitor account company name. If you would log in to your account at “superheroes.logicmonitor.com” you would use “superheroes.”.

Returns:

  • (String) —

    The LogicMonitor account company name. If you would log in to your account at “superheroes.logicmonitor.com” you would use “superheroes.”



21
 
# File 'lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb', line 21

attribute :company

#description ⇒ String?

Returns The long text description of the object in your LogicMonitor account.,Optional for managing hosts and host groups (target=host or target=hostgroup; action=add or action=update).

Returns:

  • (String, nil) —

    The long text description of the object in your LogicMonitor account.,Optional for managing hosts and host groups (target=host or target=hostgroup; action=add or action=update).



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

attribute :description

#displayname ⇒ String?

Returns The display name of a host in your LogicMonitor account or the desired display name of a device to manage.,Optional for managing hosts (target=host).

Returns:

  • (String, nil) —

    The display name of a host in your LogicMonitor account or the desired display name of a device to manage.,Optional for managing hosts (target=host).



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

attribute :displayname

#duration ⇒ Integer?

Returns The duration (minutes) of the Scheduled Down Time (SDT).,Optional for putting an object into SDT (action=sdt).

Returns:

  • (Integer, nil) —

    The duration (minutes) of the Scheduled Down Time (SDT).,Optional for putting an object into SDT (action=sdt).



68
 
# File 'lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb', line 68

attribute :duration

#fullpath ⇒ Object?

Returns The fullpath of the host group object you would like to manage.,Recommend running on a single Ansible host.,Required for management of LogicMonitor host groups (target=hostgroup).

Returns:

  • (Object, nil) —

    The fullpath of the host group object you would like to manage.,Recommend running on a single Ansible host.,Required for management of LogicMonitor host groups (target=hostgroup).



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

attribute :fullpath

#groups ⇒ Object?

Returns A list of groups that the host should be a member of.,Optional for managing hosts (target=host; action=add or action=update).

Returns:

  • (Object, nil) —

    A list of groups that the host should be a member of.,Optional for managing hosts (target=host; action=add or action=update).



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

attribute :groups

#hostname ⇒ String?

Returns The hostname of a host in your LogicMonitor account, or the desired hostname of a device to manage.,Optional for managing hosts (target=host).

Returns:

  • (String, nil) —

    The hostname of a host in your LogicMonitor account, or the desired hostname of a device to manage.,Optional for managing hosts (target=host).



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

attribute :hostname

#id ⇒ Object?

Returns ID of the datasource to target.,Required for management of LogicMonitor datasources (target=datasource).

Returns:

  • (Object, nil) —

    ID of the datasource to target.,Required for management of LogicMonitor datasources (target=datasource).



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

attribute :id

#password ⇒ String

Returns The password of the specified LogicMonitor user.

Returns:

  • (String) —

    The password of the specified LogicMonitor user



29
 
# File 'lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb', line 29

attribute :password

#properties ⇒ Object?

Returns A dictionary of properties to set on the LogicMonitor host or host group.,Optional for managing hosts and host groups (target=host or target=hostgroup; action=add or action=update).,This parameter will add or update existing properties in your LogicMonitor account.

Returns:

  • (Object, nil) —

    A dictionary of properties to set on the LogicMonitor host or host group.,Optional for managing hosts and host groups (target=host or target=hostgroup; action=add or action=update).,This parameter will add or update existing properties in your LogicMonitor account.



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

attribute :properties

#starttime ⇒ String?

Returns The time that the Scheduled Down Time (SDT) should begin.,Optional for managing SDT (action=sdt).,Y-m-d H:M.

Returns:

  • (String, nil) —

    The time that the Scheduled Down Time (SDT) should begin.,Optional for managing SDT (action=sdt).,Y-m-d H:M



64
 
# File 'lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb', line 64

attribute :starttime

#target ⇒ :collector, ...

Returns The type of LogicMonitor object you wish to manage.,Collector: Perform actions on a LogicMonitor collector.,NOTE You should use Ansible service modules such as M(service) or M(supervisorctl) for managing the Collector ‘logicmonitor-agent’ and ‘logicmonitor-watchdog’ services. Specifically, you’ll probably want to start these services after a Collector add and stop these services before a Collector remove.,Host: Perform actions on a host device.,Hostgroup: Perform actions on a LogicMonitor host group.,NOTE Host and Hostgroup tasks should always be performed via delegate_to: localhost. There are no benefits to running these tasks on the remote host and doing so will typically cause problems.rn.

Returns:

  • (:collector, :host, :datsource, :hostgroup) —

    The type of LogicMonitor object you wish to manage.,Collector: Perform actions on a LogicMonitor collector.,NOTE You should use Ansible service modules such as M(service) or M(supervisorctl) for managing the Collector ‘logicmonitor-agent’ and ‘logicmonitor-watchdog’ services. Specifically, you’ll probably want to start these services after a Collector add and stop these services before a Collector remove.,Host: Perform actions on a host device.,Hostgroup: Perform actions on a LogicMonitor host group.,NOTE Host and Hostgroup tasks should always be performed via delegate_to: localhost. There are no benefits to running these tasks on the remote host and doing so will typically cause problems.rn



13
 
# File 'lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb', line 13

attribute :target

#user ⇒ String

Returns A LogicMonitor user name. The module will authenticate and perform actions on behalf of this user.

Returns:

  • (String) —

    A LogicMonitor user name. The module will authenticate and perform actions on behalf of this user.



25
 
# File 'lib/ansible/ruby/modules/generated/monitoring/logicmonitor.rb', line 25

attribute :user