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

Consider the following remarks and requirements for this sensor:

Remark

Description

Enabled Beta Sensors experimental feature

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

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

IPv6

This sensor supports IPv6.

Performance impact

This sensor has a very low performance impact.

Lookups

This sensor can use lookups. Select Lookup as Channel #x Unit and define the lookup file in Channel #x Lookup.

Localhost

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.

Scanning interval

  • The minimum scanning interval of this sensor is 1 minute.
  • The recommended scanning interval of this sensor is 1 minute.

Multi-platform probe

You can add this sensor to a multi-platform probe.

Knowledge Base

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

Basic Sensor Settings

Basic Sensor Settings

Basic Sensor Settings

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • snmp
  • snmpcustomsensor

i_square_cyanFor more information about basic sensor settings, see section Sensor Settings.

SNMP Custom Specific

SNMP Custom Specific

SNMP Custom Specific

Setting

Description

Channel #x Name

Enter a name for the channel in which the sensor shows the results at the OID. Enter a string.

Channel #x 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.

Channel #x 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 #x Unit

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

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

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.

Channel #x Custom Unit

This setting is only visible if you select Custom above.

Define a unit for the channel value. Enter a string.

Channel #x Lookup

This setting is only visible if you select Lookup above.

Select a lookup file that you want to use with this channel.

Channel #x Scale Factor

This setting is only visible if you select Custom above.

If you want to scale the received data, enter an integer or a floating-point number. If you want to scale up, enter a value over one. If you want to scale down, enter a value below one. Use the default scale factor, 1, to not change the data.

Channel #x If Value Changes

Define what the sensor does when its value changes:

  • Ignore (default): Do nothing.
  • Trigger 'change' notification: Send an internal message that indicates a change.
    i_round_blueIn combination with a change trigger, you can use this to trigger a notification if a change occurs.

Channel #2 - #10

You can define up to 10 channels. You must define at least one channel, so you see all available settings for Channel #1. Specify how to handle all other possible channels:

  • Disable (default): Do not create this channel.
  • Enable: Create this channel.

i_round_blueIt is not possible to enable or disable channels after sensor creation.

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, PRTG displays the last value of the primary channel 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 this sensor shows different channels:

  • 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. PRTG stacks all channels with this unit 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 (default): Do not store the sensor result.
  • Store result: Store the sensor result and the last response 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.

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.

Result

The single numeric value for a specified OID

i_round_blueThis channel is the primary channel by default.

More

i_square_blueKNOWLEDGE BASE

What are beta sensors and how can I use them?

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