PRTG Manual: Port Sensor

Sensor Name

Enter a meaningful name to identify the sensor. By default, PRTG shows this name in the device tree, as well as in alarms, logs, notifications, reports, maps, libraries, and tickets.

Parent Tags

Shows tags that this sensor inherits from its parent device, group, and probe. This setting is shown for your information only and cannot be changed here.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited. You can add additional tags to the sensor.

It is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

There are default tags that are automatically predefined in a sensor's settings when you add a sensor. See section Default Tags below.

Priority

Select a priority for the sensor. This setting determines where the sensor is placed in sensor lists. A sensor with a top priority is at the top of a list. Choose from one star (low priority) to five stars (top priority).

Timeout (Sec.)

Enter a timeout in seconds for the request. If the reply takes longer than this value, the sensor cancels the request and shows a corresponding error message. Enter an integer value. The maximum value is 900 seconds (15 minutes).

Port

Enter the number of the port to which this sensor connects. Enter an integer value.

Security

Define the security level for the sensor connection:

• Use Transport-Level Security (default): Establish the connection with the strongest Transport Layer Security (TLS) method that the target device provides.
• Do not use Transport-Level Security: Establish the connection without encryption.

Goal

Define how the sensor reports on the port:

• Open: Show an Up status if the port is open, and a Down status if the port is closed.
• Closed: Show an Up status if the port is closed, and a Down status if the port is open.

Command

Define whether the sensor sends a command after opening the port:

• Don't send command: Only check if a connection to the port is possible.
• Send command: Open a Telnet session to the respective port and send the command.
  You cannot use this option if the target machine is a web server.

Command

This field is only visible if you enable Send command above. Enter a command that the sensor sends to the respective port in a Telnet session. You cannot use line breaks, only a simple Telnet command in a single line. Enter a string.

Response

Define if the sensor further processes the received response:

• Ignore response: Do not check the response.
• Check response code (integer): Check if the response matches a defined response code. Define the response code below.
• Check response text: Check if the response matches a defined response text. Define the response text below.

Allowed Code

This field is only visible if you enable Check response code (integer) above. Enter a code that the target device must return. If it does not match, the sensor shows a Down status. Enter an integer value.

Check for Keywords (positive)

This setting is only visible if you enable Check response text above. Check if a certain keyword is part of the received value. If there is no match, the sensor shows a Down status.

• Disable: Do not check for positive keywords.
• Enable keyword check (positive): Check if a certain keyword exists in the received value. Define the keyword below.

Response Must Include

This setting is only visible if you Enable keyword check (positive) above. Define the search string that the returned value must contain. You can enter a simple string in plain text or a regular expression.

The search string must be case sensitive.

Search Method

Define the method with which you want to provide the search string:

• Simple string search: Search for a simple string in plain text.

The characters * and ? work as placeholders. * stands for no number or any number of characters and ? stands for exactly one character (as known from the Windows search). You cannot change this behavior. The literal search for these characters is only possible with a regular expression.

• Regular expression: Search with a regular expression (regex).

PRTG supports Perl Compatible Regular Expression (PCRE) regex. For more details, see section Regular Expressions.

Check for Keywords (negative)

This setting is only visible if you enable Plain Text above. Check if a certain keyword is not part of the received value. If there is a match, the sensor shows a Down status.

• Disable: Do not check for negative keywords.
• Enable keyword check (negative): Check if a certain keyword does not exist in the received value. Define the keyword below.

Response Must Not Include

This setting is only visible if you Enable keyword check (negative) above. Define the search string that the returned value must not contain. You can enter a simple string in plain text or a regular expression.

The search string must be case sensitive.

Search Method

Define the method with which you want to provide the search string:

• Simple string search: Search for a simple string in plain text.

The characters * and ? work as placeholders. * stands for no number or any number of characters and ? stands for exactly one character (as known from the Windows search). You cannot change this behavior. The literal search for these characters is only possible with a regular expression.

• Regular expression: Search with a regex.

PRTG supports Perl Compatible Regular Expression (PCRE) regex. For more details, see section Regular Expressions.

Sensor Result

Define what PRTG does with the sensor results:

• Discard sensor result: Do not store the sensor result.
• Write sensor result to disk (file name: Result of Sensor [ID].txt): Store the last result received from the sensor to the \Logs\sensors subfolder of the PRTG data directory on the probe system (master node, if in a cluster). File names: Result of Sensor [ID].txt and Result of Sensor [ID].Data.txt. This is for debugging purposes. PRTG overwrites these files with each scanning interval.

This option is not available when the sensor runs on the hosted probe of a PRTG hosted by Paessler instance.

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

You can set a different primary channel later by clicking the pin symbol of a channel on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

• Show channels independently (default): Show a graph for each channel.
• Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
  This option cannot be used in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This field is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Scanning Interval

Select a scanning interval (seconds, minutes, or hours). The scanning interval determines the amount of time that the sensor waits between two scans. You can change the available intervals in the system administration on PRTG on premises installations.

If a Sensor Query Fails

Define the number of scanning intervals that the sensor has time to reach and check a device again in case a sensor query fails. Depending on the option that you select, the sensor can try to reach and check a device again several times before the sensor shows a Down status. This can avoid false alarms if the monitored device only has temporary issues. For previous scanning intervals with failed requests, the sensor shows a Warning status. Choose from:

• Set sensor to down immediately: Set the sensor to a Down status immediately after the first failed request.
• Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to a Warning status after the first failed request. If the following request also fails, the sensor shows an error.
• Set sensor to warning for 2 intervals, then set to down: Set the sensor to a Down status only after three consecutively failed requests.
• Set sensor to warning for 3 intervals, then set to down: Set the sensor to a Down status only after four consecutively failed requests.
• Set sensor to warning for 4 intervals, then set to down: Set the sensor to a Down status only after five consecutively failed requests.
• Set sensor to warning for 5 intervals, then set to down: Set the sensor to a Down status only after six consecutively failed requests.

Sensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval before they show a Down status. It is not possible to immediately set a WMI sensor to a Down status, so the first option does not apply to these sensors. All other options can apply.

If you define error limits for a sensor's channels, the sensor immediately shows a Down status. No "wait" option applies.

If a channel uses lookup values, the sensor immediately shows a Down status. No "wait" options apply.

Schedule

Select a schedule from the list. Schedules can be used to monitor for a certain time span (days or hours) every week.

You can create schedules, edit schedules, or pause monitoring for a specific time span. For more information, see section Account Settings—Schedules.

Schedules are generally inherited. New schedules are added to schedules that you already set up, so all schedules are active at the same time.

Maintenance Window

Specify if you want to set up a one-time maintenance window. During a maintenance window, the selected object and all child objects are not monitored. They are in a Paused status instead. Choose between:

• Not set (monitor continuously): No maintenance window is set and monitoring is always active.
• Set up a one-time maintenance window: Pause monitoring within a maintenance window. You can define a time span for a monitoring pause below and change it even for an active maintenance window.

To terminate an active maintenance window before the defined end date, change the time entry in Maintenance Ends to a date in the past.

Maintenance Begins

This field is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the start date and time of the maintenance window.

Maintenance Ends

This field is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the end date and time of the maintenance window.

Dependency Type

Define a dependency type. You can use dependencies to pause monitoring for an object depending on the status of a different object. You can choose from:

• Use parent: Use the dependency type of the parent object.
• Select a sensor: Use the dependency type of the parent object. Additionally, pause the current object if a specific sensor is in a Down status or in a Paused status caused by another dependency.

• Master sensor for parent: Make this sensor the master object for its parent device. The sensor influences the behavior of its parent device: If the sensor is in a Down status, the device is paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor is paused if the parent group is paused by another dependency.

To test your dependencies, select Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later, all dependent objects are paused. You can check all dependencies under Devices | Dependencies in the main menu bar.

Dependency

This field is only visible if you enable Select a sensor above. Click the Search button and use the object selector to select a sensor on which the current object will depend.

Dependency Delay (Sec.)

This field is only visible if you enable Select a sensor above. Define a time span in seconds for dependency delay.

After the master sensor for this dependency comes back to an Up status, monitoring of the dependent objects is additionally delayed by the defined time span. This can prevent false alarms, for example, after a server restart, by giving systems more time for all services to start up. Enter an integer value.

This setting is not available if you set this sensor to Use parent or to be the Master sensor for parent. In this case, define delays in the parent device settings or in its parent group settings.

User Group Access

Define the user groups that have access to the sensor. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:

• Inherited: Inherit the access rights settings of the parent object.
• No access: Users in this user group cannot see or edit the sensor. The sensor neither shows up in lists nor in the device tree.
• Read access: Users in this group can see the sensor and view its monitoring results. They cannot edit any settings.
• Write access: Users in this group can see the sensor, view its monitoring results, and edit its settings. They cannot edit its access rights settings.
• Full access: Users in this group can see the sensor, view its monitoring results, edit its settings, and edit its access rights settings.

For more details on access rights, see section Access Rights Management.