IPFusion SNMP

The IPFusion SNMP integrated system provides the ability to connect and monitor devices that support SNMP communication to PrismUI.

Definitions

SNMP — Simple Network Management Protocol. A standard protocol for managing devices on IP networks. Hardware monitoring can include basic SNMP devices.

OID — Object Identifier. A standardized identifier mechanism used to identify devices and their statuses.

Setup

See the Data Servers page for information on configuring driver communication.

Compatibility

The IPFusion SNMP integrated system is compatible with SNMP version 2.

Prerequisites

Software Minimum Version
IPFusion — SNMP 1.9
.NET Framework 4.7.2

Ports

These ports must be open in your network firewall for the integration to work.

Purpose Default Value Configurable
Device Asset 161 Yes
Dataserver 9451 Yes
Debug Tools 9461 No

Assets

Object

This asset represents a managed object.

Required Property Grid Fields

Device Selection The associated Device asset. Device selections appear in the format: Caption:AssetID.
OID The Object Identifier.
Enterprise OID The OID for the traps this asset should receive. If this asset should receive traps no matter their OID, leave this blank. If a trap has an OID matching any enterprise OID for an asset, only assets with that enterprise OID will receive it.
Trap Status Duration The amount of time in seconds where this Object will remain in the Trap status after receiving a trap event. After that time has passed, it will return back to its previous status.

View all properties

Supported States

Normal The asset is online and in its default state.
Fault An issue has been detected in a connected asset.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Integer An Integer value is being reported.
Integer Range An integer value being reported is within a specified range.
String A string value is being reported.
Float A floating point value is being reported.
Float Range A floating point value within a specified range is being reported.
Trap A trap event has been received matching this assets OID.
Note: If the value provided by the system does not match a status in the Status Table, asset will go into fault state.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Trap

This asset represents a managed object reporting traps.

Required Property Grid Fields

Device Selection The associated Device asset. Device selections appear in the format: Caption:AssetID.
Enterprise OID The OID for the traps this asset should receive. If this asset should receive traps no matter their OID, leave this blank. If a trap has an OID matching any enterprise OID for an asset, only assets with that enterprise OID will receive it.
OID The Object Identifier.
Trap Status Duration The amount of time in seconds where this asset will remain in the Trap status after receiving a trap event. After that time has passed, it will return back to its previous status.

View all properties

Supported States

Normal The asset is online and in its default state.
Fault An issue has been detected in a connected asset.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Trap A trap event has been received matching this assets OID.
Note: If the value provided by the system does not match a status in the Status Table, asset will go into fault state.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Device

This asset represents a managed device.

Required Property Grid Fields

Authentication Password The password used to authenticate with the device.
Authentication Protocol The type of authentication used on this device.
Community String This string is sent along with SNMP requests to a device and is used similarly to a user ID or password. Is used to access device information.
IP Address IP Address or host name for the device.
Polling Rate How frequently to Poll the device.
Port The Port number for the device connection. Typically this is 161 or 162.
Privacy Password Password used when connecting to a device with a private connection.
Privacy Protocol The protocol in use to encrypt the connection.
SNMP Version Version of the SNMP protocol the device uses. Versions one to three are supported.
Timeout Amount of time to wait before timing out the connection to the device.
User The User name used to authenticate with the device.

View all properties

Supported States

Normal The asset is online and in its default state.
Fault An issue has been detected in a connected asset.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Workflow Integration

System Events

System Events are used to trigger Workflows. The triggering item can provide additional information about the event.

Trap Received

A trap message has been received from a device asset.

Table 1. Triggering Item Properties
Address The address of the sender for the trap.
Port The port number the trap was sent from.
OID The object identifier for the object the trap originated from.
Data The trap message.

Value Changed

The value for an object asset has changed. This does not require a status change in order to fire, only the underlying value.

Note: This trigger fires when getting the initial value for an OID during Runtime startup and any subsequent value changes.
Table 2. Trigger Item Properties
Object Identifier The identifier for the object this event originated from.
Current Status Value The current value for the object at the time this trigger fired.
Last Status Value The previous value of the object prior to this trigger firing.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.