PRTG Manual: SNMP Custom v2 Sensor

The SNMP Custom v2 sensor monitors a single parameter that is returned by a specific object identifier (OID) or Abstract Syntax Notation One (ASN.1) Management Information Base (MIB) via the Simple Network Management Protocol (SNMP).

i_betaThis sensor is in beta status. The operating methods and the available settings are still subject to change. Do not expect that all functions work properly, or that this sensor works as expected at all.

SNMP Custom v2 Sensor

SNMP Custom v2 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: SNMP Aangepast v2
  • French: SNMP personnalisé v2
  • German: SNMP (Benutzerdef.) v2
  • Japanese: SNMP カスタム v2
  • Portuguese: SNMP (customizado) v2
  • Russian: SNMP Custom v2
  • Simplified Chinese: SNMP 自定义 v2
  • Spanish: SNMP (personalizado) v2

Remarks

  • This sensor supports IPv6.
  • This sensor has a very low performance impact.
  • It might not work to query data from a probe device via SNMP (querying localhost, 127.0.0.1, or ::1). Add this device with the IP address that it has in your network and create the sensor on this device instead.

Basic Sensor Settings

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a 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.

i_round_blueIf 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?

Parent Tags

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

  • snmp
  • snmpcustomsensor

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

SNMP Custom Specific

SNMP Custom Specific

SNMP Custom Specific

Setting

Description

OID or ASN.1 MIB Name

Enter the OID or ASN.1 MIB name of the SNMP object that you want to receive numeric data from.

i_round_blueMost OIDs begin with 1.3.6.1. However, OIDs that start with 1.0, or 1.1, or 1.2 are also allowed. If you want to entirely disable the validation of your entry, add the string norfccheck: to the beginning of the OID, for example, norfccheck:2.0.0.0.1.

Value Type

Select the expected numeric type of the result:

  • Absolute (unsigned integer) (default): Integers without an operational sign, such as 10 or 120.
  • Absolute (signed integer): Integers with an operational sign, such as -12 or 120.
  • Absolute (floating point): Float values, such as -5.80 or 8.23.
  • Delta (unsigned integer): Integers without an operational sign, such as 10 or 120. The sensor calculates the difference between the last value and the current value.
  • Time (unsigned integer): Integers without an operational sign, such as 10 or 120. The sensor measures the response time.

i_round_blueYou cannot change this value after sensor creation.

Channel Unit

Define the unit of the numeric data that this sensor receives. The following options are only visible if you select Absolute (unsigned integer), Absolute (signed integer), Absolute (floating point), or Delta (unsigned integer) as Value Type:

  • Custom
  • Count (default)
  • Percent (CPU)
  • Temperature (°C)
  • Bytes (memory)
  • Bytes (disk)
  • Bytes (bandwidth)
  • Bytes per second (disk)
  • Bytes per second (network)

The following options are only visible if you select Time (unsigned integer) as Value Type:

  • Time (milliseconds)
  • Time (seconds, default)
  • Time (hours)

i_square_cyanFor more information about the available units, see section Custom Sensors.

i_round_blueYou cannot change this value after sensor creation.

Multiplication

If you want to multiply the received data with a certain value, enter the multiplier. Use the default value 1 to not change the received value. Enter an integer.

Division

If you want to divide the received data by a certain value, enter the divisor. Use the default value 1 to not change the received value. Enter an integer.

Sensor Display

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.

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

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

Do not store the sensor 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 and Result of Sensor [ID].Data.txt. This setting is for debugging purposes. PRTG overwrites these files with each scanning interval.

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 1 minute.

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 (default).

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 state

Result

The single numeric value for a specified OID

i_round_blueThis channel is the primary channel by default.

More

i_square_blueKNOWLEDGE BASE

How do I find out which OID I need for an SNMP Custom sensor?

What security features does PRTG include?

My SNMP sensors don’t work. What can I do?

How do I use Management Information Base (MIB) folders with the SNMP Custom v2 sensor?

 

i_playVIDEO TUTORIAL

SNMP Custom sensor and SNMP Custom Library sensor