PRTG Manual: Network Share Sensor

The Network Share sensor monitors a Server Message Block (SMB) or Common Internet File System (CIFS) network share.

i_betaThis sensor is in beta status. The operating methods and the available settings can change at any time. Do not expect that all functions work properly, or that this sensor works as expected at all. Be aware that this sensor can be removed from PRTG at any time.

Network Share Sensor

Network Share Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • Dutch: Network Share
  • French: Network Share
  • German: Network Share
  • Japanese: Network Share
  • Portuguese: Network Share
  • Russian: Network Share
  • Simplified Chinese: Network Share
  • Spanish: Network Share

Remarks

  • This sensor supports the IPv6 protocol.
  • This sensor has a low performance impact.

Detailed Requirements

Requirement

Description

Enabled Beta Sensors experimental feature

This sensor requires that the Beta Sensors experimental feature of PRTG is enabled.

i_square_cyanFor more information, see the Knowledge Base: What are beta sensors and how can I use them?

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.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

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.

i_round_blueThis 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.

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

i_round_blueFor 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:

  • networkshare
  • smb
  • cifs
  • folder

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 (i_priority_1) to the highest priority (i_priority_5).

Network Share Specific

Network Share Specific

Network Share Specific

Setting

Setting

Path

Enter the path of the network share that you want to monitor. For example, folder\subfolder.

Timeout (Sec.)

Enter a timeout in seconds. If the scan of the folder takes longer, the sensor cancels the request and shows an error message. If two consecutive scans fail, the sensor shows the Down status. The default value is 300 seconds (5 minutes).

Recurse Subfolders

Specify if the sensor includes subfolders in the folder monitoring. Choose between:

  • Do not recurse subfolders: Only monitor the folder. Do not monitor its subfolders.
  • Monitor the folder and its subfolders (recursive): Monitor the folder and all of its subfolders.
    i_round_redIf you recurse subfolders in large directories that have a high number of branches, this may cause timeout errors or performance issues.

Filter by File Name

Select if you want to filter by file name. Choose between:

  • Disable (default): Do not filter by file name.
  • Include filter: The sensor counts files that match the File Filter.
  • Exclude filter: The sensor counts files that do not match the File Filter.

File Filter

This field is only visible if you select Include filter or Exclude filter above. Enter a comma-separated list of file names, file formats, or patterns you want to filter for. For example, '*.pdf,*.docx' includes or excludes files with the file formats .pdf or .docx.

i_round_blueThe file filter is not case sensitive and supports wildcards (*).

File Age Filter

Select if you want to filter by file age. Choose between:

  • Disable (default): Do not filter by file age.
  • Enable: Filter by file age.

Newer Than

This field is only visible if you select Enable above. Enter a file age. The sensor only counts files that are younger than this age.

i_round_blueLeave this field empty if you only want to filter for files with the Older Than setting.

Older Than

This field is only visible if you select Enable above Enter a file age. The sensor only counts files that are older than this age.

i_round_blueLeave this field empty if you only want to filter for files with the Newer Than setting.

File Age Filter Unit

This field is only visible if you select Enable above. Select the time unit that you want to use for the File Age Filter. Choose between:

  • Days (default)
  • Hours
  • Minutes

Sensor Display

Sensor Display

Sensor Display

Setting

Setting

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.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary 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.
    i_round_redYou 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.

Debug Options

Debug Options

Debug Options

Setting

Description

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 name is Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites this file with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

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 b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

i_round_blueThe minimum scanning interval of this sensor is 1 minute.

i_round_blueThe recommended scanning interval of this sensor is 5 minutes.

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou 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

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel Unit Configuration

i_round_blueWhich 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

Channel Unit Configuration

i_square_cyanFor more information, see section Root Group Settings, section Channel Unit Configuration.

Channel List

i_round_blueWhich 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 in percent.

File Count

The number of files in the folder

i_round_redThe sensor counts all files in a folder, including hidden files.

i_round_blueThis channel is the primary channel by default.

Folder Count

The number of folders

Folder Size

The folder size in bytes

Newest File

The time since the newest modification of a file in the folder (newest file)

i_round_blueThe sensor shows a negative value if the date of a modified file is in the future.

Oldest File

The time since the oldest modification of a file in the folder (oldest file)

More

i_square_blueKnowledge Base

What are beta sensors and how can I use them?

What security features does PRTG include?