PRTG Manual: EXE/Script Advanced Sensor

The EXE/Script Advanced sensor runs an executable file (EXE, DLL) or a script (batch file, VBScript, Powershell) on the computer running the local or remote probe. This option is provided as part of PRTG's Application Programming Interface (API). The sensor can show values returned by the executable file or script in multiple channels. The return value of this sensor must be valid XML. For details about the return value format please see the Application Programming Interface (API) Definition.

Note: The executable or script file must be stored on the system of the probe the sensor is created on: If used on a remote probe, the file must be stored on the system running the remote probe. In a cluster setup, please copy the file to every cluster node.

Note: If you want to execute a custom Windows Management Instrumentation Query Language (WQL) script, please use the WMI Custom Sensor.

Limited to 50 Sensor Channels

PRTG does not support more than 50 sensor channels officially. Depending on the data used with this sensor type, you might exceed the maximum number of supported sensor channels. In this case, PRTG will try to display all sensor channels. However, please be aware that you will experience limited usability and performance.

Add Sensor

The Add Sensor dialog appears when adding a new sensor on a device manually. It only shows the setting fields that are imperative for creating the sensor. Therefore, you will not see all setting fields in this dialog. You can change all settings in the sensor's Settings tab later.

The following settings for this sensor differ in the 'Add Sensor' dialog in comparison to the sensor's settings page:

Sensor Settings


Select an executable file from the list. It will be executed with every scanning interval. In this list, files in the corresponding /Custom Sensors/EXEXML sub-directory of the probe system's PRTG program directory are shown (see Data Storage). In order for the files to appear in this list, please store them into this folder. Store files ending in BAT, CMD, DLL, EXE, PS1, and VBS. In order for the sensor to show the expected values and sensor status, your files must return the expected XML format to standard output. Values and message must be embedded in the XML. For detailed information on how to build custom sensors and for the expected return format, please see the API documentation (Application Programming Interface (API) Definition). There, find detailed information the the "Custom Sensors" tab.

Note: Please do not use the folder \Custom Sensors\Powershell Scripts to store your files. This remnant from previous software versions is not used any more and may usually be deleted.

Note: When using custom sensors on the Cluster Probe, please copy your files to every cluster node installation.

Sensor Settings

On the sensor's details page, click on the Settings tab to change settings.

Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name defined in the settings of the parent device the sensor is created on.

Basic Sensor Settings

Sensor Name

Enter a meaningful name to identify the sensor. The name will be shown by default in the device tree and in all alarms.


Enter one or more tags, separated by space or comma. You can use tags to group sensors and use tag-filtered views later on. Tags are not case sensitive. We recommend using the default value. You can add additional tags to it, if you like. Other tags are automatically inherited from objects further up in the device tree. Those are not visible here.


Select a priority for the sensor. This setting determines where the sensor will be placed in sensor lists. Top priority will be at the top of a list. You can choose from one star (low priority) to five stars (top priority).

Sensor Settings


Shows the executable or script file that is executed with each sensor scan, as defined on sensor creation. Once a sensor is created this value cannot be changed. It is shown for reference purposes only. If you need to change this, please add the sensor anew.


If your executable or script file catches command line parameters, you can define them here. Placeholders can be used as well. For a full list of all placeholders please see the API documentation (Application Programming Interface (API) Definition). Note: Please make sure you write the placeholders in quotes to ensure that they are working properly if their values contain blanks. Use single quotation marks ' ' with PowerShell scripts, and double quotes " " with all others. Please enter a string or leave the field empty.


Choose if PRTG's command line parameters will also be available as environment parameters.

  • Default Environment: Do not provide PRTG placeholders' values in the environment. Choose this secure option if you're not sure.
  • Set placeholders as environment values: From within your executable or script, the values of PRTG's command line parameters will be available via environment variables. For example, you can then read and use the current host value of the PRTG device this EXE/script sensor is created on from within your script. This option can mean a security risk, because also credentials are provided in several variables. For a full list of all available variables please see the API documentation (Application Programming Interface (API) Definition).

Security Context

Define the Windows user account that will be used to run the executable or script file. Choose between:

  • Use security context of probe service: Run the selected file under the same Windows user account the probe is running on. By default, this is the Windows system user account (if not manually changed).
  • Use Windows credentials of parent device: Use the Windows user account defined in the settings of the parent device this sensor is created on. Please go to sensor's parent device's settings to change these Windows credentials.

Mutex Name

Define any desired mutex name for the process. All EXE/Script sensors having the same mutex name will be executed serially (not simultaneously). This is useful if you use a lot of sensors and want to avoid high resource usage caused by processes running simultaneously. For links to more information, please see the More section below. Please enter a string or leave the field empty.

Timeout (sec.)

Enter a timeout in seconds for the request. If the reply takes longer than this value the external process is killed and an error message is triggered.

EXE Result

Define what will be done with the results the executable file gives back. Choose between:

  • Discard EXE result: Do not store the requested web page.
  • Write EXE result to disk: Store the last result received from the script with the file name "Result of Sensor [ID].txt" to the "Logs (Sensors)" directory (on the Master node, if in a cluster). This is for debugging purposes. The file will be overridden with each scanning interval. For information on how to find the folder used for storage, please see Data Storage section.
  • Write EXE result to disk in case of error: Store the last result received from the script only if the sensor is in a down status. The file name is "Result of Sensor [ID].txt" in the "Logs (Sensors)" directory. Enable this option if you do not want failures to be overwritten by a following success of the script.

Sensor Display

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 will always be displayed underneath the sensor's name. The available options depend on what channels are available for this sensor. Note: You can set another primary channel later by clicking on the pin symbol of a channel in the sensor's overview tab.

Chart Type

Define how different channels will be shown for this sensor.

  • Show channels independently (default): Show an own 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 will generate an easy-to-read graph which visualizes the different components of your total traffic. Note: This option cannot be used in combination with manual Vertical Axis Scaling (available in the Sensor Channels Settings settings).

Stack Unit

This setting is only available if stacked graphs are selected above. Choose a unit from the list. All channels with this unit will be 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.

Note: The Stack Unit option for stacking graphs will only work if you explicitly define the same <unit> for at least two channels. For detailed information about sensor settings please see the API documentation (Application Programming Interface (API) Definition).

Inherited Settings

By default, all following settings are inherited from objects higher in the hierarchy and should be changed there, if necessary. Often, best practice is to change them centrally in the Root group's settings. To change a setting for this object, disable inheritance by clicking on the check mark symbol in front of the respective setting name. You will then see the options described below.

Scanning Interval

Scanning Interval

The scanning interval determines the time the sensor waits between two scans. Select a scanning interval (seconds, minutes, or hours) from the list. You can change the available intervals in the system administration.

Schedules, Dependencies, and Maintenance Window

Note: Inheritance for schedules, dependencies, and maintenance windows cannot be interrupted; the according settings from the parent objects will always be active. However, you can define additional settings here. They will be active in parallel to the parent objects' settings.


Select a schedule from the list. Schedules can be used to monitor for a certain time span (days, hours) throughout the week. With the period list option it is also possible to pause monitoring for a specific time span. You can create new schedules and edit existing ones in the account settings. Note: Schedules are generally inherited. New schedules will be added to existing ones, so all schedules are active.

Maintenance Window

Specify if you want to set-up a one-time maintenance window. During a maintenance window this object and all child objects will not be monitored. They will enter a paused state then. Choose between:

  • Not set (monitor continuously): No maintenance window will be set.
  • Set up a one-time maintenance window: Pause monitoring within a maintenance window.

Maintenance Begins At

This field is only visible if maintenance window is enabled above. Use the date time picker to enter the start date and time of the maintenance window.

Maintenance End At

This field is only visible if maintenance window is enabled above. Use the date time picker to enter the end date and time of the maintenance window.

Dependency Type

Define a dependency type. Dependencies can be used to pause monitoring for an object depending on the status of another. You can choose between:

  • Use parent: Pause the current sensor if the device it is created on is in a Down status, or if it is paused by another dependency.
  • Select object: Pause the current sensor if the device it is created on is in an Down status, or if it is paused by another dependency. Additionally, pause the current sensor if a specific other object in the device tree is in a Down status, or if it is paused by another dependency. Select below.
  • Master object for parent: Make this sensor the master object for its parent device. The sensor will influence the behavior of the device it is created on: If the sensor is in a Down status, the device will be 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 will be paused if the parent group of its parent device is in a Down status, or if it is paused by another dependency.

Note: Testing your dependencies is easy! Simply choose Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later all dependent objects should be paused.


This field is only visible if the select object option is enabled above. Click on the reading-glass symbol and use the object selector to choose an object on which the current sensor will be dependent on.

Delay (Seconds)

Define a time span. After the master object for this dependency comes back to an Up status, monitoring of the depending objects will be additionally delayed by the defined time span. This can help avoid false alarms, for example, after a server restart, by giving systems more time for all services to start up. Please enter an integer value in seconds. Note: This setting is not available if you choose this sensor to be the Master object for parent. In this case, please define delays in the parent Device Settings or the superior Group Settings.

Access Rights

User Group Access

Define which user group(s) will have access to the object you're editing. A table with user groups and right is shown; it contains all user groups from your setup. For each user group you can choose from the following access rights:

  • Inherited: Use the settings of the parent object.
  • None: Users in this group cannot see or edit the object. The object does not show up in lists and in the device tree. Exception: If a child object is visible to the user, the object is visible in the device tree, though not accessible.
  • Read: Users in this group can see the object and review its monitoring results.
  • Write: Users in this group can see the object, review its monitoring results, and edit the object's settings. They cannot edit access rights settings.
  • Full: Users in this group can see the object, review its monitoring results, edit the object's settings, and edit access rights settings.

You can create new user groups in the System Administration—User Groups settings. To automatically set all objects further down in the hierarchy to inherit this object's access rights, set a check mark for the Revert children's access rights to inherited option.

For more details about access rights, please see section User Access Rights.

Channel Unit Configuration

Channel Unit Types

For each type of sensor channel, define the unit in which data is displayed. If defined on probe, group, or device level, these settings can be inherited to all sensors underneath. You can set units for the following channel types (if available):

  • Bandwidth
  • Memory
  • Disk
  • File
  • Custom

Note: Custom channel types can be set on sensor level only.


Information about custom scripts and executables

Knowledge Base: What is the Mutex Name in PRTG's EXE/Script Sensor's settings?

Knowledge Base: How and Where Does PRTG Store its Data?

Knowledge Base: How can I test if parameters are correctly transmitted to my script when using an EXE/Script sensor?

Edit Sensor Channels

In order to change display settings, spike filter, and limits, please switch to the sensor's Overview tab and click on the gear icon of a specific channel. For detailed information, please see Sensor Channels Settings section.


Click on the Notifications tab to change notification triggers. For detailed information, please see Sensor Notifications Settings section.


For more general information about settings, please see Object Settings section.

Sensor Settings Overview

For information about sensor settings, please see the following sections: