About the connector
PRTG is a powerful monitoring solution that analyzes your entire IT infrastructure, monitors your network, performance, hardware, cloud, databases, applications, etc.
This document provides information about the PRTG connector, which facilitates automated interactions, with a PRTG server using FortiSOAR™ playbooks. Add the PRTG connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving details for a specific object type such as device or sensor, or scanning a sensor based on the sensor ID you have specified.
Version information
Connector Version: 1.1.0
FortiSOAR™ Version Tested on: 4.12.1-253
Authored By: Fortinet
Certified: Yes
Release Notes for version 1.1.0
Following enhancements have been made to the BMC Remedyforce connector in version 1.1.0:
- Added a new operation and playbook: Delete Object.
- Added an optional input parameter Duration to the Acknowledge Alarm operation.
- Added an option to Run Auto Discovery with Template in the Run Auto Discovery operation.
Installing the connector
All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:
yum install cyops-connector-prtg
For the detailed procedure to install a connector, click here
Prerequisites to configuring the connector
- You must have the URL of the PRTG server to which you will connect and perform automated operations and credentials (username-password/passhash) to access that server.
- To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.
Configuring the connector
For the procedure to configure a connector, click here
Configuration parameters
In FortiSOAR™, on the connectors page, select the PRTG connector and click Configure to configure the following parameters:
| Parameter |
Description |
| Server URL |
URL of the PRTG server to which you will connect and perform the automated operations. |
| Username |
Username to access the PRTG server to which you will connect and perform the automated operations. |
| Authentication Type |
Select the authentication type that you want to use to access the PRTG server to which you will connect and perform the automated operations. You can choose between Password or Passhash. |
| Value |
Value of the Password or Passhash, depending on the Authentication Type that you have selected, that is used to access the PRTG server to which you will connect and perform the automated operations. |
| Verify SSL |
Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True. |
Actions supported by the connector
The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:
| Function |
Description |
Annotation and Category |
| List Object Details |
Retrieves detailed information for a selected content type such as device or sensor from PRTG, based on the input parameters you have specified. |
list_object_details
Investigation |
| Get Sensor Status |
Retrieves the status of a sensor from PRTG, based on the sensor ID you have specified. |
get_sensors_status
Investigation |
| Pause Sensor |
Pauses a sensor on PRTG based on the sensor ID and other input parameters you have specified. |
pause_sensor
Investigation |
| Resume Sensor |
Resumes a sensor on PRTG based on the sensor ID you have specified. |
resume_sensor
Investigation |
| Acknowledge Alarm |
Marks a sensor as acknowledged on PRTG for the duration (optionally) you have specified based on the sensor ID you have specified. |
acknowledge_alarm
Investigation |
| Scan Sensor |
Scans a sensor on PRTG based on the sensor ID you have specified. |
scan_sensor
Investigation |
| Run Auto Discovery |
Runs auto discovery on an existing object in PRTG based on the Device ID or Group ID you have specified. or Runs auto discovery with template on an existing object in PRTG based on the device template(s) and Device ID or Group ID you have specified. |
run_auto_discovery
Investigation |
| Delete Object |
Deletes an object from PRTG based on the object ID and type you have specified. |
delete_object
Investigation |
operation: List Object Details
Input parameters
| Parameter |
Description |
| Content Type |
Choose the content type from one of the following: Channels, Devices, Messages, Reports, Sensors, Sys Info, Stored Reports, Tickets, or Top Lists. |
| Filter Status |
(Optional) Filters out sensors based on the sensor status you have selected. For example, if you select Up, then information for only those sensors whose status is up will be retrieved from PRTG.
Note: This field is visible only when you have selected the Content Type as Sensor. |
| Filter Tags |
(Optional) Filters out sensors based on the sensor tags you have listed. You can provide a csv list of tags based on which sensor will be filtered out while retrieving information from PRTG.
Note: This field is visible only when you have selected the Content Type as Sensor. |
| Last Seen |
(Optional) Filters out messages or tickets based on the time frame you have selected. For example, if you select Yesterday, then information for only those messages or tickets that were last seen yesterday will be retrieved from PRTG.
Note: This field is visible only when you have selected the Content Type as Messages or Tickets. |
| Response Fields |
(Optional) Fields (can select multiple fields) that you want to include in the response of this operation. |
| Open Filter |
(Optional) Open query to filter out data that you want to retrieve from PRTG. |
| Start Index |
(Optional) Start Index from where you want to retrieve results from PRTG. You can use this parameter with the Count parameter to request the data page by page. |
| Count |
(Optional) Maximum number of results that this operation should return.
By default it is set at 500. |
| Sort By |
(Optional) Sort the results retrieved from PRTG server based on the specified column name. For example, name, lastvalue, uptime, priority, etc. |
Output
The output contains a non-dictionary value.
operation: Get Sensor Status
Input parameters
| Parameter |
Description |
| Sensor ID |
ID of the sensor whose status you want to retrieve from PRTG. |
Output
The output contains the following populated JSON schema:
{
"status": "",
"result": {
"prtgversion": "",
"sensordata": {
"statusid": "",
"parentdeviceid": "",
"downtimetime": "",
"statustext": "",
"name": "",
"parentdevicename": "",
"updowntotal": "",
"lastdown": "",
"uptime": "",
"probename": "",
"favorite": "",
"lastcheck": "",
"lastvalue": "-",
"uptimetime": "",
"parentgroupname": "",
"lastmessage": "",
"lastup": "",
"info": "",
"interval": "",
"sensortype": "",
"downtime": "",
"updownsince": ""
}
}
}
operation: Pause Sensor
Input parameters
| Parameter |
Description |
| Sensor ID |
ID of the sensor that you want to pause on PRTG. |
| Duration |
(Optional) Duration in minutes, for which you want to pause a sensor on PRTG.
By default, this is set to "Indefinite". |
| Message |
(Optional) Message that you want to display when the user wants to pause the sensor. |
Output
The output contains the following populated JSON schema:
{
"status": "",
"message": ""
}
operation: Resume Sensor
Input parameters
| Parameter |
Description |
| Sensor ID |
ID of the sensor that you want to resume on PRTG. |
Output
The output contains the following populated JSON schema:
{
"status": "",
"message": ""
}
operation: Acknowledge Alarm
Input parameters
| Parameter |
Description |
| Sensor ID |
ID of the sensor that you want to mark as acknowledged on PRTG. |
| Message |
(Optional) Message that you want to display when the user wants to mark the sensor as acknowledged. |
| Duration |
(Optional) Datetime till when the acknowledge status will be retained, i.e., the datetime till when the sensor will be marked as acknowledged. The datetime you select must be in the future.
You can choose one of the following options: Indefinitely, For 5 Minutes, For 15 Minutes, For 1 Hour, For 3 Hours, For 1 Day,or Until. If you choose Until, then you require to specify the datetime until when the acknowledge status will be retained. By default, it is set a Indefinitely. |
Output
The output contains the following populated JSON schema:
{
"status": "",
"message": ""
}
operation: Scan Sensor
Input parameters
| Parameter |
Description |
| Sensor ID |
ID of the sensor that you want to scan on PRTG. |
Output
The output contains the following populated JSON schema:
{
"status": "",
"message": ""
}
operation: Run Auto Discovery
Input parameters
| Parameter |
Description |
| Auto Discovery |
Type of auto discovery type that you want to run on PRTG. You can choose from Run Auto-Discovery or Run Auto-Discovery with Template.
- If you choose Run Auto-Discovery, then you must specify the following parameters:
- Object ID: ID of an existing object (device or group) based on which you want to run auto-discovery on PRTG.
You can use the List Object Detail operation to get the Object ID.
- If you choose Run Auto-Discovery with Template, then you must specify the following parameters:
- Device Template(s): CSV list of device templates that will be used for auto-discovery on PRTG.
- Object ID: ID of an existing object (device or group) based on which you want to run auto-discovery on PRTG.
You can use the List Object Detail operation to get the Object ID.
|
Output
The output contains the following populated JSON schema:
{
"status": "",
"message": ""
}
operation: Delete Object
Input parameters
| Parameter |
Description |
| Object Type |
Type of object that you want to delete from PRTG. You can choose from the following options: Device, Group, Probe or Sensor. |
| Object ID |
ID of the object (based on the object type you have selected) that you want to delete from PRTG. |
Output
The output contains the following populated JSON schema:
{
"status": "",
"message": ""
}
Included playbooks
The Sample - PRTG - 1.1.0 playbook collection comes bundled with the PRTG connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the PRTG connector.
- Acknowledge Alarm
- Delete Object
- Get Sensors Status
- List Object Details
- Pause Sensor
- Resume Sensor
- Run Auto Discovery
- Scan Sensor
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.
