PRTG Manual: Configuration

Setting

Description

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.

Use NATS Connection Security (TLS)?

Select if the multi-platform probe uses Transport Layer Security (TLS):

▪Yes: The multi-platform probe uses TLS. This option requires that you have a certificate authority (CA) certificate available for authentication.

▪No: The multi-platform probe uses NATS encryption via the nats:// protocol.

Use the system CA certificates?

Select if the multi-platform probe authenticates from a CA certificate that is present in the system trust store:

▪Yes: Use a certificate in the system trust store.

▪No: Do not use the system trust store. Use a custom path to a CA certificate.

This setting must match the NATS server Certificate Authority Handling setting in the PRTG web interface if you use a remote NATS server.

Path to the server CA PEM certificate

This setting is only visible if you select not to use system CA certificates above.

Enter the path of the CA certificate that the multi-platform probe uses for authentication. The default path is /etc/paessler/mpprobe/certs/ca.pem.

All multi-platform probe components require certificates and keys in the PEM format. Common file extensions include .pem, .crt, .cer, and .key.

If you get a WARN message that states The provided Server CA PEM path does not point to a file, the configuration wizard did not find a valid CA certificate at the path that you entered. To resolve this issue, move the desired CA certificate to the path you entered after you finish the configuration wizard. Alternatively, run the configuration wizard again and provide a different path.

FQDN of the NATS server system

Enter the hostname as a fully qualified domain address name (FQDN) of the system where the NATS server is installed. If you use the integrated NATS server, the FQDN that you enter must match the FQDN that you entered in the PRTG Administration Tool.

TLS connections require a FQDN because the hostname must match one of the subject alternative names on the TLS server certificate.

Do not use an IP address.

Example: host.example.com

NATS Server Port

Enter the port that the multi-platform probe uses to connect to the NATS server. The default port is 23563.

NATS authentication scheme

Use the arrow keys to select how the multi-platform authenticates with the NATS server:

▪NKey (integrated NATS server): The configuration wizard generates an NKey pair that the multi-platform probe uses to authenticate with the NATS server. This option is required if you want to use the integrated NATS server.

▪Username/Password: The multi-platform probe authenticates with a username and password. This is the default option.
This option is not supported in PRTG Hosted Monitor for new connections. Use NKeys for authentication instead.

Regenerate the NKey authentication?

This setting is only visible when you rerun the configuration wizard and select NKey (integrated NATS server) above.

Select if this multi-platform probe needs a new NKey:

▪Yes: Generate a new NKey.
You must also update the NATS server access identifier in PRTG for PRTG to recognize the multi-platform probe.

▪No: Do not change the NKey from the previous configuration.

NATS tenant name

This setting is only visible if you select NKey (integrated NATS server) above.

Enter a tenant name to identify the multi-platform probe. We recommend that you use a unique tenant name for each multi-platform probe or network section.

NATS username

This setting is only visible if you select Username/Password above.

Enter the username to use with the NATS server.

NATS password

This setting is only visible if you select Username/Password above.

Enter the password associated with the username for the NATS server.

Parameters

Description

url

Enter the URL of the NATS server. The URL follows the format tls://host name:port if you used the Transport Layer Security (TLS) schema.

Replace tls:// with nats:// if you used the unsecured NATS schema.

user

Enter the NATS user name.

password

Enter the NATS password.

Example: Create a multi-platform probe Docker image configuration file

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.
The editor nano works for both Debian and Ubuntu.

1.Enter the necessary values for the parameters:

[nats]
url = "tls://localhost:23563"
[nats.authentication]
user = "johnqpublic"
password = "password"

2.Name the file config.toml and save the file.