Come join our live training webinar every other Wednesday at 11am PST and hear LogicMonitor experts explain best practices and answer common questions. We understand these are uncertain times, and we are here to help!
Note that LogicMonitor does have an available REST API equivalent for this API call.
Collectors are used to gather data from your hosts and send it to LogicMonitor. They are installed and run on a host within your infrastructure. The LogicMonitor API allows you to manage collectors programmatically. With the addAgent RPC API call you can add and install a collector.
Note: As with all of our API calls, authentication is required.
New collectors can be added with three steps:
Note: Once a collector record is created, the corresponding installer is only valid for two hours.
https://accountName.logicmonitor.com/santaba/rpc/addAgent?c=accountName&u=user&p=password&autogen=trueOrFalse&credential=collectorCredential&description=collectorDescription&backupAgentId=backupCollectorId
Request Parameters: You can include the following as query parameters in an addAgent RPC call:
Note: The -v flag for curl makes the output more verbose and descriptive. This may be necessary for things like finding the collector id as well as the collector credentials: curl -v “https://accountName.logicmonitor.com/santaba/rpc/addAgent?c=accountName&u=user&p=password&autogen=true”
All outputs will be in the format: { [status], [data], [errmsg] }, where status is the status of the response, errmsg is the error message associated with the response, and the data object includes the following:
0 : Unregistered collector 1 : Registered collector 2 : Stopped collector 3 : Suspended collector
After the collector is created and registered in your LogicMonitor account an install file must be downloaded and executed.
1. For a Windows server:
https://accountName.logicmonitor.com/santaba/do/LogicMonitorSetup.exe?id=123& c=accountName&u=user&p=password&arch=machineArchitecture
2. For a Linux server:
https://accountName.logicmonitor.com/santaba/do/logicmonitorsetup?id=123&c=accountName&u=user&p=password&arch=machineArchitecture
or:
curl -o outputFileName.bin "https://accountName.logicmonitor.com/santaba/do/logicmonitorsetup?id=123&c=accountName&u=user&p=password&arch=machineArchitecture
Note: The binary will be hardcoded with the identifier of the collector created in step 1 – each collector installation requires a separate download.
The last step in adding a collector is running the install file on the selected server. The device where the collector resides will need to be a Windows or Linux (physical or virtual) server with an outgoing SSL connection over port 443 to the LogicMonitor servers.
For Windows: Run:
LogicMonitorSetup123.exe /q /d:"" /a: /p:
/d:(Optional) This is the path to install the collector into. It defaults to /Program Files/LogicMonitor/Collector / /a:(Optional) This is the account the windows service will run as. Defaults to LocalSystem. /p: (Required if /a is given) This is the password to use that corresponds to the user account specified. Note:If you do not specify the collector to run as a privileged user it will install and run as local system. Local system may not have sufficient permissions to monitor other windows hosts remotely.
For Linux: Run:
chmod +x logicmonitorsetup123.bin
and then:
./logicmonitorsetup123.bin [-h] [-y] [-p proxyHost:port] [-U proxyUser] [-P proxyPass]
-h : (optional) show usage
-y : (optional) install silently (don’t ask questions). Defaults to false
-p proxyAddr:port : (optional) proxy server in form of address:port (e.g. 10.0.0.1:8080)
-U proxyUser : (optional) username to authenticate to proxy server if any
-P proxyPass : (optional) password to authenticate to proxy server if required
Request:
curl "https://apiAccount.logicmonitor.com/santaba/rpc/addAgent?c=apiAccount&u=apiUser&p=example&autogen=true"
Response:
{ "status": 200, "data": { "nextRecipient": 0, "clearSent": true, "lastSentNotificationOn": 0, "netscanVersion": "0", "suppressAlertClear": "false", "build": "0", "lastSentNotificationOnLocal": "", "id": 132, "resendIval": 15, "watchdogUpdatedOn": "2015-11-17 14:35:39 PST", "escalatingChainId": 0, "description": "", "ackComment": "", "credential2": "", "updatedOn": 1447799739, "updatedOnLocal": "2015-11-17 14:35:39 PST", "agentConf": "", "platform": "n/a", "ackedBy": "", "isDown": false, "status": 0, "ackedOn": "", "confVersion": "0", "uptime": 0, "createdOnLocal": "2015-11-17 14:35:39 PST", "credential": "gi{ppwC8", "createdOn": 1447799739, "numberOfHosts": 0, "backupAgentId": 0, "company": "sarah", "server": "sarah.logicmonitor.com", "acked": false }, "errmsg": "OK" }
curl -o lmSetup.bin "https://sarah.logicmonitor.com/santaba/do/logicmonitorsetup?c=sarah&u=sarah&p=example&id=132&arch=64"
% Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 101M 100 101M 0 0 717k 0 0:02:24 0:02:24 --:--:-- 589k
[[email protected] sterry]# chmod +x lmSetup.bin [[email protected] sterry]# ./lmSetup.bin Enter the installation parent directory [/usr/local/logicmonitor]: Extracting installer files ... Extracting bundled JRE files ... Detecting proxy, please wait ... Registering collector, please wait ... Starting LogicMonitor Watchdog ... Congratulations! LogicMonitor Collector has been installed successfully!
In This Article