<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: SSH Script Sensor
The SSH Script sensor connects to a Linux/Unix system via Secure Shell (SSH) and executes a script file that is located on the target system. This option is available as part of the PRTG API.
SSH Script Sensor
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
Sensor in Other Languages
- Dutch: SSH Script
- French: Script (SSH)
- German: SSH-Skript
- Japanese: SSH スクリプト
- Portuguese: Script (SSH)
- Russian: Скрипт SSH
- Simplified Chinese: SSH 脚本
- Spanish: Script (SSH)
Remarks
Add Sensor
The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.
Sensor Settings
|
|
Script
|
Select a script file from the dropdown list. It shows all script files that are available in the /var/prtg/scripts directory on the target Linux/Unix system. For a script file to appear in this list, store the target file in this directory.
Make sure that the script has executable rights.
To show the expected sensor value and status, your file must use the correct format for the returned values. In this case, it is exitcode:value:message to standard output stdout. The exit code determines the sensor status.
For detailed information on how to create custom sensors and for the return format, see section Custom Sensors.
For an example script, see the Knowledge Base: Is there a shell script example for the SSH Script sensor?
|
Value Type
|
Define the type of the values that your executable or script file returns:
- Integer: An integer is expected as return value. If the script returns a float, PRTG displays the value 0.
- Float: A float is expected as return value, with a dot (.) between the predecimal position and the decimal places.
The sensor also displays integers unless they produce a buffer overflow.
- Counter: Your script returns an integer that increases. PRTG shows the difference between the values of two sensor scans.
A counter must return an integer. It does not support float values.
The sensor does not support string values.
|
Channel Name
|
Enter a name for the channel. Enter a string. This is for display purposes only.
You can change this value later in the channel settings of this sensor.
|
Basic Sensor Settings
Click the Settings tab of a sensor to change its settings.
Basic Sensor Settings
|
|
Sensor Name
|
Enter a name to identify the sensor.
|
Parent Tags
|
Shows tags that the sensor inherits from its parent device, parent group, and parent probe.
This setting is for your information only. You cannot change it.
|
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.
It is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).
For performance reasons, it can take some minutes until you can filter for new tags that you added.
The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:
|
Priority
|
Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority () to the highest priority ().
|
Sensor Settings
Sensor Settings
|
|
Script
|
Shows the name of the script that the sensor executes with each scanning interval.
PRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.
|
Character Encoding
|
Define the character encoding that you use in your script to correctly display the sensor message:
|
Parameters
|
If your script file catches command-line parameters, define them here. You can also use placeholders. Enter a string or leave the field empty.
For a full list of all placeholders, see section Custom Sensors.
You must escape special characters and whitespaces in your parameters and surround them with double quotes. See section Escape Special Characters and Whitespaces in Parameters for details.
In SSH scripts, you can use alphanumeric characters and the special characters ".", "_", "-", "=", and "/" outside of quoted strings.
|
Mutex Name
|
Define a mutual exclusion (mutex) name for the process. Enter a string or leave the field empty.
PRTG runs all custom script sensors that have the same mutex name serially (not simultaneously). This is useful if you use a lot of sensors and want to avoid high resource usage caused by processes that run running at the same time.
See the Knowledge Base: What is the Mutex Name in the EXE/Script sensor settings?
|
Unit String
|
Define a unit for the channel value. Enter a string. This is for display purposes only and is the default unit for a new channel. You can change the unit after sensor creation in the sensor's channel settings.
|
Value Type
|
Shows the expected type of the returned value.
PRTG shows this value for reference purposes only. If you need to change this value, add the sensor anew.
|
If Value Changes
|
Define what the sensor does when the sensor value changes:
- Ignore changes (default): Take no action on change.
- Trigger 'change' notification: Send an internal message indicating that the sensor value has changed. In combination with a change trigger, you can use this mechanism to trigger a notification whenever the sensor value changes.
|
SSH Specific
SSH Specific
|
|
Connection Timeout (Sec.)
|
Define a timeout in seconds for the connection. This is the time that the sensor waits to establish a connection to the host. Keep this value as low as possible. Enter an integer.
Ensure that the connection timeout is a value that is higher than the shell timeout to avoid potential errors.
|
Shell Timeout (Sec.)
|
Define a timeout in seconds for the shell response. This is the time in seconds the sensor waits for the shell to return a response after it has sent its specific command (for example, cat /proc/loadavg). The maximum value is 300 seconds (5 minutes). Enter an integer.
Ensure that the shell timeout is a value that is lower than the connection timeout to avoid potential errors.
|
SSH Port
|
Define which port this sensor uses for the SSH connection:
- Inherit port number from parent device (default): Use the port number as defined in the Credentials for Linux/Solaris/macOS (SSH/WBEM) Systems section of the parent device settings.
- Enter custom port number: Define a custom port number below and do not use the port number from the parent device settings.
|
Use Port Number
|
This setting is only visible if you select Enter custom port number above. Enter the port number (between 1 and 65535) that this sensor uses for the SSH connection. Enter an integer.
|
SSH Engine
|
Select the method that you want to use to access data with this SSH sensor. We strongly recommend that you use the default engine. You can still use the legacy mode for some time to ensure compatibility with your target systems. Choose between:
- Inherit from parent device (default): Use the SSH engine that you defined in the parent device settings or higher up in the object hierarchy. If you have not changed the SSH engine, this is the recommended default engine.
- Default: This is the default monitoring method for SSH sensors. It provides the best performance and security. It is set by default in objects that are higher up in the hierarchy, so usually you can keep the Inherit from parent device (default) option.
- Compatibility mode (deprecated): Try this legacy method only if the default mode does not work on a target device. The compatibility mode is the SSH engine that PRTG used in previous versions. It is deprecated. We will remove this legacy mode soon, so try to get your SSH sensors running with the default SSH engine.
The option you select here overrides the selection of the SSH engine in a higher object: a parent device, group, probe, or root.
|
Result Handling
|
Define what PRTG does with the sensor result:
- Discard result: Do not store the sensor result.
- Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file names are Result of Sensor [ID].txt, Result of Sensor [ID].Data.txt, and Result of Sensor [ID] (SSHv2).txt. This setting is for debugging purposes. PRTG overwrites these files with each scanning interval.
- Store result in case of error: Store the last sensor result only if the sensor shows the Down status.
This option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.
In a cluster, PRTG stores the result in the PRTG data directory of the master node.
|
Sensor Display
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 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 below a channel gauge 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.
You cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).
|
Stack Unit
|
This setting 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.
|
Inherited Settings
By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click under the corresponding setting name to disable the inheritance and to display its options.
For more information, see section Inheritance of Settings.
Scanning Interval
Scanning Interval
For more information, see section Root Group Settings, section Scanning Interval.
Schedules, Dependencies, and Maintenance Window
You cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.
Schedules, Dependencies, and Maintenance Window
For more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.
Access Rights
Access Rights
For more information, see section Root Group Settings, section Access Rights.
Channel Unit Configuration
Which channel units are available depends on the sensor type and the available parameters. If no configurable channels are available, this field shows No configurable channels.
Channel Unit Configuration
For more information, see section Root Group Settings, section Channel Unit Configuration.
Escape Special Characters and Whitespaces in Parameters
You need to escape special characters in parameters that you pass to an executable or script and surround them with quotation marks to make sure that the characters are correctly interpreted. PowerShell scripts in particular require adequate escaping so that the parameters are passed in a valid PowerShell syntax. PRTG automatically does most of the escaping for you.
Follow these rules to escape special characters and whitespaces in the parameters fields:
- Use quotes for parameters that contain whitespaces.
-name "Mr John Q Public"
-name 'Mr John Q Public'
- Use double quotes for parameters that contain single quotes.
-name "Mr 'John Q' Public"
- Use single quotes for parameters that contain double quotes.
-name 'Mr "John Q" Public'
- Use a backslash (\) to escape and pass a literal double quote.
-name pub\"lic
- Use double quotes for parameters that contain double and single quotes and escape double quotes.
-name "pu'b\"lic"
In SSH scripts, you can use alphanumeric characters and the special characters ".", "_", "-", "=", and "/" outside of quoted strings.
We recommend that you do not pass passwords in parameters. Use placeholders instead. See section Custom Sensors for details.
Channel List
Which channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.
|
|
Downtime
|
In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent.
|
Execution Time
|
The execution time in milliseconds (msec)
This channel is the primary channel by default.
|
[Value]
|
The value that the script file returns in one channel
For details about the return value format, see section Custom Sensors.
|
More
Knowledge Base
SSH and SFTP sensors in Unknown status
Is there a shell script example for the SSH Script sensor?
What security features does PRTG include?
What is the Mutex Name in the EXE/Script sensor settings?
How can I test if parameters are correctly transmitted to my script when using an EXE/Script sensor?
How can I show special characters with EXE/Script sensors?
Why do I have to store SQL sensor queries and custom scripts in files on the probe computer?
For which sensor types do you recommend Windows Server 2012 R2 or later and why?