Parameter |
Choices/Defaults |
Comments |
action
required |
Choices:
- 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.
|
alertenable
bool |
|
A boolean flag to turn alerting on or off for an object.
Optional for managing all hosts (action=add or action=update).
|
collector
|
|
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).
|
company
required |
|
The LogicMonitor account company name. If you would log in to your account at "superheroes.logicmonitor.com" you would use "superheroes."
|
description
|
Default:
|
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).
|
displayname
|
Default:
hostname -f
|
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).
|
duration
|
Default:
30
|
The duration (minutes) of the Scheduled Down Time (SDT).
Optional for putting an object into SDT (action=sdt).
|
fullpath
|
|
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).
|
groups
|
Default:
[]
|
A list of groups that the host should be a member of.
Optional for managing hosts (target=host; action=add or action=update).
|
hostname
|
Default:
hostname -f
|
The hostname of a host in your LogicMonitor account, or the desired hostname of a device to manage.
Optional for managing hosts (target=host).
|
id
|
|
ID of the datasource to target.
Required for management of LogicMonitor datasources (target=datasource).
|
password
required |
|
The password of the specified LogicMonitor user
|
properties
|
Default:
{}
|
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.
|
starttime
|
Default:
Now
|
The time that the Scheduled Down Time (SDT) should begin.
Optional for managing SDT (action=sdt).
Y-m-d H:M
|
target
required |
Choices:
- 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 service or 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.
|
user
required |
|
A LogicMonitor user name. The module will authenticate and perform actions on behalf of this user.
|