> ## Documentation Index
> Fetch the complete documentation index at: https://doc.qbilon.io/llms.txt
> Use this file to discover all available pages before exploring further.

# PRTG

> Configure the PRTG connector and the data imported from PRTG.

[https://www.youtube.com/watch?v=KhAgw--KsSE](https://www.youtube.com/watch?v=KhAgw--KsSE)

## Configuration

Importing data from PRTG requires the following information:

| **Name** | **Explanation** |
| - | - |
| Host | URL of the PRTG server without a trailing "/", e.g., `https://prtg.mycompany.com` |
| API Token | "API Key" that was created in the PRTG configuration Retrievable via "Setup" in your PRTG instance:  not be accessible afterwards  |
| Load Sensors as assets | load all device sensors as assets (may result in a larger diagram) |
| Allow insecure connections | SSL connections are accepted without any certificate validation. This can be used to allow a connection to a host with self-signed or misconfigured certificates. This can also be useful when the certificate authority of your SSL certificate is not in the default trust stores of Java. **Warning:** Make sure that you can trust this insecure connection. |
| Execution Settings | The import execution pattern can be set to "Onetime", "Scheduled" (recurring according to certain time interval) or "Dependency" (each time after a specific other data source is executed). |

**Table**: PRTG Connector Settings

After the automation task has been added and executed, you can click on the task tile to see its details on the right panel. Here, Qbilon shows the three tabs "Data Source Details", "Warning & Errors" (cf. [Warnings and Errors](https://doc.qbilon.io/06-data-sources/warnings-errors.md) chapter) and "Execution Details".

## Collected Data

### Structure

The PRTG connector task fetches basic information from PRTG. The structure of this information looks like this:

![PRTG: Structure](https://mintcdn.com/qbilon-docs/Jmla3tEw4FRYjkNT/.gitbook/assets/9c323380-d3bc-48f6-90d3-3b930f0efa38-screenshot-2026-09-22-143122.png?fit=max\&auto=format\&n=Jmla3tEw4FRYjkNT\&q=85\&s=19d452e5d24c3d43873bf07d23b678ae)

"PRTG Sensor Instances" are only retrieved if the flag "Load Sensors as Assets" has been set during configuration. Qbilon collects different basic information for each instance of the asset types PRTG Group, Device and PRTG Sensor Instance as well as for the relations between them.

### Data – PRTG Group

| **Property** | **Explanation** | **Example** | **Possible Values** |
| - | - | - | - |
| Group Type | The type of this group, e.g., a Group or a Probe | `"Probe"` | "Group" or "Probe" |
| Number Sensors | The total amount of sensors that belong directly or transitively to this group | `120` | positive numbers including 0 |
| Number Sensors Down | The total amount of sensors that belong directly or transitively to this group and have the status "Down" | `3` | positive numbers including 0 |
| Number Sensors Down Acknowledged | The total amount of sensors that belong directly or transitively to this group and have the status "Down Acknowledged" | `4` | positive numbers including 0 |
| Number Sensors Up | The total amount of sensors that belong directly or transitively to this group and have the status "Up" | `1000` | positive numbers including 0 |
| Number Sensors Warning | The total amount of sensors that belong directly or transitively to this group and have the status "Warning" | `12` | positive numbers including 0 |
| Priority | The priority given to this group by the user (for details see [PRTG documentation](https://www.paessler.com/manuals/prtg/priority_and_favorites)) | `3` | integers from 1-5, default is 3 |
| PRTG Name | The name of the group as shown in PRTG (for details see [PRTG documentation](https://www.paessler.com/manuals/prtg/group_settings#basic)) | `"Cloud Services"` | any text value (forbidden chars: `<` and `>`) |
| PRTG Object Id | ID, e.g. of a group, device or sensor, which uniquely identifies an object within one core server | `1001` | positive numbers including 0 |
| PRTG Url | URL of this group within PRTG | `https://prtg.mycomp.com/group.htm?id=4018` | valid URLs |
| Status | The status of the group as shown in PRTG | `Up` | `Down`, `Down (Partial)`, `Down (Acknowledged)`, `Warning`, `Up`, `Paused`, `Unusual`, `Unknown` |
| Tags | The tags of the group as shown in PRTG | `Some Tag` | arbitrary tags |

### Data – Device

| **Property** | **Explanation** | **Example** | **Possible Values** |
| - | - | - | - |
| Hostname | Hostname that was extracted from either the PRTG Name or the PRTG Host. Empty if nothing was detected | `my.device.com` | Empty OR a valid host name |
| IP Address | IP address that was extracted from either the PRTG Name or the PRTG Host. Empty if nothing was detected | `127.0.0.1` | Empty OR a valid IPv4/IPv6 IP address |
| Number Sensors | The total amount of sensors that belong directly or transitively to this device | `123` | positive numbers including 0 |
| Number Sensors Down | The total amount of sensors that belong directly or transitively to this device and have the status "Down" | `3` | positive numbers including 0 |
| Number Sensors Down Acknowledged | The total amount of sensors that belong directly or transitively to this device and have the status "Down Acknowledged" | `12` | positive numbers including 0 |
| Number Sensors Up | The total amount of sensors that belong directly or transitively to this device and have the status "Up" | `145` | positive numbers including 0 |
| Number Sensors Warning | The total amount of sensors that belong directly or transitively to this device and have the status "Warning" | `2` | positive numbers including 0 |
| Priority | The priority given to this group by the user (for details see [PRTG documentation](https://www.paessler.com/manuals/prtg/priority_and_favorites)) | `3` | Integers from 1-5, default is 3 |
| PRTG Host | The host name or IP address as given in the basic device settings (for details see [PRTG documentation](https://www.paessler.com/manuals/prtg/device_settings#basic)) | `my.device.com` | Empty OR a valid IPv4/IPv6 IP address OR a valid host name |
| PRTG Name | The name of the group as shown in PRTG (for details see [PRTG documentation](https://www.paessler.com/manuals/prtg/group_settings#basic)) | `"Disk Free"` | Any text value. Forbidden characters are "\<" and ">" |
| PRTG Object Id | ID, e.g. of a group, device or sensor, which uniquely identifies an object within one core server | `1002` | positive Numbers including 0 |
| PRTG Url | URL of this device within PRTG | `https://prtg.mycomp.com/device.htm?id=1092` | Valid URLs |
| Status | The status of the device as shown in PRTG. | `Up` | `Down`, `Down (Partial)`, `Down (Acknowledged)`, `Warning`, `Up`, `Paused`, `Unusual`, `Unknown` |
| Tags | The tags of the device as shown in PRTG | `Some Text` | arbitrary Tags |

### Data – PRTG Sensor Instance

| **Property** | **Explanation** | **Example** | **Possible Values** |
| - | - | - | - |
| Date Last Down (UTC) | Date in UTC when this sensor was last reported to be "down" | `15/09/2024, 02:00:00` | a valid date OR empty |
| Date Last Error (UTC) | Date in UTC when this sensor was last reported to be in "error state" | `15/09/2024, 02:00:00` | a valid date OR empty |
| Date Last Ok (UTC) | Date in UTC when this sensor was last reported to be in "ok status" | `15/09/2024, 02:00:00` | a valid date OR empty |
| Date Last Up (UTC) | Date in UTC when this sensor was last reported to be in "up state" | `15/09/2024, 02:00:00` | a valid date OR empty |
| Date Last Value (UTC) | Date in UTC when this sensor reported its last value | `15/09/2024, 02:00:00` | a valid date OR empty |
| Downtime (%) | Downtime in percent | `23.54` | a floating point number between 0 and 100, both included |
| Last Message | The last plain text message received by this sensor | `Could not find an interpreter for 'python' on the probe system.` | arbitrary text |
| Last Value | The last plain text value received by this sensor | `744 Watts` | arbitrary text |
| Last Value (Numeric) | The last value received by this sensor as number | `744` | arbitrary floating point number |
| Loading Interval (Seconds) | Scanning interval in seconds, that was set for this sensor (see [PRTG documentation](https://www.paessler.com/support/how-to/scanning-intervals#:~:text=Pre%2Ddefined%20scanning%20intervals%20in,related%20to%20the%20scanning%20interval.) for details) | `30` | 10, 30, 60, 300, 600, 900, 1800, 3600, ... |
| Sensor Type | The kind of sensor (see [PRTG documentation](https://www.paessler.com/manuals/prtg/list_of_available_sensor_types) for details) | `Ping` | Ping, SSL Certificate, HTTP, ... |
| Priority | The priority given to this group by the user (as explained in the [PRTG documentation](https://www.paessler.com/manuals/prtg/priority_and_favorites)) | `3` | integers from 1-5 (default is 3) |
| PRTG Object Id | ID, e.g. of a group, device or sensor, which uniquely identifies an object within one core server | `1002` | positive numbers including 0 |
| PRTG Url | URL of this sensor within PRTG | `https://prtg.mycomp.com/sensor.htm/id=5138` | valid URLs |
| Status | The status of the sensor as shown in PRTG. | `Up` | `Down`, `Down (Partial)`, `Down (Acknowledged)`, `Warning`, `Up`, `Paused`, `Unusual`, `Unknown` |
| Tags | The tags of the device as shown in PRTG | `Some Tag` | arbitrary Tags |
| Uptime (%) | Uptime in percent | `23.54` | a floating point number between 0 and 100, both included |

### "Contains" Relations

The collected "contains" relations reflect the structure of how the retrieved entities are structured within PRTG, e.g. a Group can contain another Group or Devices, while Sensors are contained within Devices.
No additional information is collected on these "contains" relations as they only reflect the internal structure of PRTG and do not provide any additional information.

### PRTG Flow

The "PRTG Flow" connections are only available when there is one or more of the following sensors in use in your PRTG installation:

* [IPFIX](https://www.paessler.com/manuals/prtg/ipfix_sensor)
* [Packet Sniffer](https://www.paessler.com/manuals/prtg/packet_sniffer_header_sensor)
* [jFlow v5](https://www.paessler.com/manuals/prtg/jflow_v5_sensor)
* [NetFlow v5](https://www.paessler.com/manuals/prtg/netflow_v5_sensor)
* [NetFlow v9](https://www.paessler.com/manuals/prtg/netflow_v9_sensor)
* [sFlow](https://www.paessler.com/manuals/prtg/sflow_sensor)

If one or more of those is available, then your PRTG collects data about "Top Talkers", "Top Connections", etc. This information is used by Qbilon to reconstruct the communication connections between the devices you are monitoring with your PRTG.

For every connection that starts from a device known to your PRTG installation and ends at a device known to your PRTG installation, Qbilon creates a relation between the two. Each of those connections provides the following, additional information:

| **Property** | **Explanation** | **Example** | **Possible Values** |
| - | - | - | - |
| Source Host | the host name of the source of the PRTG Flow connection | `forti-fw-200.mycompany.lan` | valid host names |
| Source IP | the IP address of the source of the PRTG Flow connection | `10.49.236.61` | valid IP addresses |
| Source Port List | a list of the 30 most recently detected used source ports of this PRTG Flow connection | `0,443` | positive integers between 0 and 65535, both included |
| Target Host | the host name of the target of the PRTG Flow connection | `forti-fw-200.mycompany.lan` | valid host names |
| Target IP | the IP address of the source of the PRTG Flow connection | `10.49.236.61` | valid IP addresses |
| Target Port List | a list of the 30 most recently detected used target ports of this PRTG Flow connection | `0,54754,55331,55778` | positive integers between 0 and 65535, both included |

**Enhance Connection Detection**
By default PRTG has a list of 100 "Top X". This limits the number of PRTG Flow connections that can be retrieved by Qbilon, because –depending on your monitored IT– most of the "Top Talkers" in a system never change, e.g. only the "bottom" 20-30 of them vary constantly and can thus be detected as new PRTG Flow relations by Qbilon.
In order to be able to detect more PRTG Flow connections you can change the maximum number of "Top X" in PRTG. Please refer to the [PRTG documentation](https://www.paessler.com/manuals/prtg/toplists) on how to do this.

## Additional Information

Please note the following information on access and rights management:

* PRTG has to be reachable from the machine that runs Qbilon.
* There are no additional user accounts needed. If the corresponding credentials work within third-party tools, they will work in Qbilon too.
* If you want to create a separate PRTG user for Qbilon, then you can follow these steps:
  * `System Administration` ➝ `User Accounts` ➝ `Create User` (preferably with read-only access)
  * `Group Membership` → `Mandatory User Group Assignment` (recommended: no administrative rights)
  * `Devices` ➝ `Main Group` ➝ (Right-click) `Edit Access Rights` ➝ Reset read access for new user group as well as access rights of subordinate objects to "Assumed"


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.