PRTG Manual: SFTP Secure File Transfer Protocol Sensor
<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: SFTP Secure File Transfer Protocol Sensor
The SFTP Secure File Transfer Protocol sensor monitors File Transfer Protocol (FTP) servers of a Linux/Unix system via the Secure Shell (SSH) File Transfer Protocol (FTP over SSH).
SFTP Secure File Transfer Protocol Sensor
For a detailed list and descriptions of the channels that this sensor can show, see section Channel List.
Sensor in Other Languages
Dutch: SFTP Secure File Transfer Protocol
French: Protocole sécurisé de transfert de fichiers (SFTP)
German: SFTP Secure File Transfer Protocol
Japanese: SFTP(Secure File Transfer Protocol)
Portuguese: SFTP Secure File Transfer Protocol
Russian: Защищенный протокол передачи файлов SFTP
Simplified Chinese: SFTP 安全文件传输协议
Spanish: SFTP Secure File Transfer Protocol
Remarks
This sensor requires credentials for Linux/Solaris/macOS (SSH/WBEM) systems in the settings of the parent device.
This sensor does not support all Linux/Unix and macOS distributions.
If the name contains angle brackets (<>), PRTG replaces them with braces ({}) for security reasons. For more information, see the Knowledge Base: What security features does PRTG include?
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:
sftpsensor
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 ().
SSH Specific
SSH Specific
Setting
Description
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. The maximum timeout value is 900 seconds (15 minutes).
Make sure 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.
Make sure 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 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 option.
Default: This is the default SSH engine. 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): Use this only if the default SSH engine 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 to run with the default SSH engine.
We strongly recommend that you use 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 (default): 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 name is Result of Sensor [ID].Data.txt. This setting is for debugging purposes. PRTG overwrites this file 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
Setting
Description
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 select Stack channels on top of each other above.
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 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 (default).
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.
Channel List
Which channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.
Channel
Description
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
Response Time
The response time
This channel is the primary channel by default.
More
KNOWLEDGE BASE
Which encryption algorithms do PRTG SSH sensors support?