Multi-Platform Probe for PRTG
Configuration
Configure the multi-platform probe.
▪For Debian, Ubuntu, and RHEL systems: Use the configuration wizard to set up your multi-platform probe, or configure it unattended.
▪For Docker: Create a configuration file.
Configuration wizard output
The configuration wizard writes two files that the multi-platform probe uses for authentication.
File |
Description |
Configuration file |
/etc/paessler/mpprobe/prtg-probe.toml Holds the probe ID, the connection settings, and, if available, the certificate authority (CA) certificate. If a setting is not explicitly defined, it uses the default setting. |
Identity key |
/var/lib/paessler/mpprobe/probe-identity.key A private key that the multi-platform probe uses to prove its identity to PRTG. The key never leaves the remote probe system.
|
1.Run the configuration wizard:
sudo probe-admin-tool wizard
2.Enter the settings according to your desired configuration:
Setting |
Description |
Probe ID |
Shows the universally unique identifier (UUID) that PRTG uses to identify the multi-platform probe. The wizard suggests a new UUID.
|
Probe Name |
Shows the name that PRTG displays on the device tree in the PRTG web interface. The default probe name is multi-platform-probe@hostname where the hostname is the name of your server. |
QUIC or TCP connection |
Select how the multi-platform probe connects to the PRTG core server: ▪QUIC: The multi-platform probe connects over UDP. This is the default setting. ▪TCP: The multi-platform probe connects over TCP with Transport Layer Security (TLS). Select this option on networks that block UDP.
|
Address of the PRTG core server |
Enter the address of the PRTG core server system as a Domain Name System (DNS) name, an IPv4 address, or an IPv6 address in brackets. Examples: prtg.example.com, 192.0.2.0, [2001:db8::1]
|
Port of the PRTG probe adapter |
Enter the port that the multi-platform probe uses to connect to the PRTG core server. The default port is 23563. |
Server CA certificate |
Select how the multi-platform probe establishes trust in the certificate of the PRTG core server: ▪Fetch it from the PRTG server and verify the thumbprint: The configuration wizard connects to the PRTG core server, shows the SHA-256 thumbprint of the certificate that answered, and asks you to paste the thumbprint that PRTG shows. The configuration wizard only trusts the certificate if both thumbprints match. ▪Use a CA certificate file (PEM): Enter the path of a CA certificate file on the remote probe system. The configuration wizard copies the certificate into the configuration file, so you can delete the file afterward. ▪Use the system CA certificates: The multi-platform probe trusts every CA certificate in the system trust store. We recommend that you only use this option if you manage the system trust store centrally. ▪Keep the current CA certificate: This option is only visible if you already defined a CA certificate. The multi-platform probe keeps the certificate from the previous configuration.
|
TLS server name on the adapter certificate |
This setting is only visible if the certificate of the PRTG core server does not list the address that you entered above. Enter a DNS name that the certificate lists as a subject alternative name (SAN). The multi-platform probe sends this name in the TLS handshake and verifies the certificate against it. This applies, for example, if the multi-platform probe reaches the PRTG core server by IP address, by a short name, or through a CNAME record, a network address translation (NAT) address, or a load balancer address. |
Regenerate the secret key |
This setting is only visible if the remote probe system already has an identity key. Select if this multi-platform probe needs a new identity key: ▪Yes: Generate a new identity key. ▪No: Keep the identity key from the previous configuration. If the remote probe system has no identity key, the configuration wizard creates one without asking. |
The configuration wizard shows where it wrote the configuration file, followed by the access token that is unique for your multi-platform probe.
If you lose the access token, you can print it again at any time with the command sudo probe-admin-tool identity show. The multi-platform probe also logs the access token every time it starts.
3.Validate the configuration before you start the multi-platform probe:
sudo probe-admin-tool check
This command validates the configuration file and the identity key without a network connection. It lists every problem at once and exits with a non-zero exit code if there is any.
Start the multi-platform probe
1.On the remote probe system, start the multi-platform probe:
sudo systemctl start prtg.mpprobe.service
If the multi-platform probe is already running, restart it instead with sudo systemctl restart prtg.mpprobe.service.
2.Confirm that the multi-platform probe runs on your system:
systemctl status prtg.mpprobe.service
The status should show active (running). If this is not the status, use journalctl to learn more:
journalctl -u prtg.mpprobe.service
If you roll out multi-platform probes with configuration management, use the provision command instead of the configuration wizard:
sudo probe-admin-tool provision --address prtg.example.com \
--ca-thumbprint <SHA-256 thumbprint> --verify-connection
Parameter |
Description |
--address |
Define the address of the PRTG core server system. This parameter is required if the remote probe system has no configuration yet. |
--protocol --port |
Define the connection type (quic or tcp) and the port of the PRTG core server. The defaults are quic and 23563. |
--ca-thumbprint --ca-pem-path --ca-pem --system-ca |
Define how the multi-platform probe establishes trust in the certificate of the PRTG core server. Use only one of these parameters at a time. |
--server-name |
Define a DNS name that the server certificate lists, if it does not list the address. |
--id --name |
Define the probe ID and the probe name. The default name is multi-platform-probe@hostname. |
--verify-connection |
Test the connection to the PRTG core server. The command fails if the PRTG core server does not answer or if the certificate fails verification. |
--force |
Write over a configuration file that the configuration wizard cannot read, and replace the identity key.
|
--remove-name --remove-server-name |
Overwrite an existing setting with its default value. |
The command prints the access token with the information where to enter it in PRTG. If you redirect the output or pipe it into another command, the command prints only the access token, so that your automation can collect it.
For a full list of parameters, run probe-admin-tool provision --help.
More commands
Command |
Description |
probe-admin-tool check |
Validates the configuration file and the identity key with the rules that the multi-platform probe applies at start, without a network connection. Lists every problem at once. |
probe-admin-tool config-template |
Prints a documented template of every configuration setting with its default. |
probe-admin-tool identity show |
Prints the access token of the multi-platform probe. |
probe-admin-tool identity rotate-key |
Replaces the identity key, keeps the probe ID, and prints the new access token.
|
Multi-platform probes require credentials that match the NATS server to communicate and transmit data. To use the multi-platform probe as a Docker image, you must create a configuration file that contains the appropriate credentials.
The Docker image does not yet support QUIC or TCP connections. If you use the multi-platform probe as a Docker image, it still requires a NATS server for communication.
You can reuse this configuration file with multiple multi-platform probes. All multi-platform probes with this configuration file use the same NATS URL and NATS credentials.
1.Create a configuration file that follows TOML formatting:
YAML formatting is still supported.
[nats]
url = ""
[nats.authentication]
user = ""
password = ""
2.Enter information for the following parameters:
Parameters |
Description |
url |
Enter the URL of the NATS server. The URL follows the format tls://hostname:port if you used the Transport Layer Security (TLS) schema.
|
user |
Enter the NATS username. |
password |
Enter the NATS password. |
3.Save the configuration file as config.toml.
For all examples, the default path on the host machine is /opt/docker. 1.Create a new directory in /opt/docker called /config. 2.Create a new file in the /config directory. 1.Enter the necessary values for the parameters: [nats] 2.Name the file config.toml and save the file. |
Go to section Docker container.