SNMP Input Adapter

< Previous		Next >

Introduction

The Spotfire Streaming SNMP Input Adapter allows a StreamBase application to act as an SNMP manager for receiving SNMP v1 and v2c traps.

The adapter has the following capabilities:

Listens for trap notifications sent to the given port number.
When such a trap is received, outputs a tuple describing the values contained in the trap.
Optionally receives commands from the StreamBase application to connect (start listening) and disconnect (stop listening).
Optionally issues status tuples on a dedicated to inform the application of interesting events such as connection and disconnection.

The adapter exposes a set of input and output ports, the fields for which are defined later in this document. In addition, the adapter exposes a set of adapter properties as described in Adapter Properties.

Adapter Properties

Settings are used to control most of the behavior of the adapter. The settings are grouped under several tabs in the Properties view in StreamBase Studio.

In the table in this section, the Property column shows each property name as found in the one or more adapter properties tabs of the Properties view for this adapter.

Input Adapter Properties

General Tab

Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. The first character must be alphabetic or an underscore.

Adapter: A read-only field that shows the formal name of the adapter.

Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this adapter starts.

Enable Error Output Port: Select this checkbox to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally, enter text to briefly describe the purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Adapter Properties Tab

Property	Data Type	Default	Description
UDP port	int	162	The port number to use, on which the adapter will listen for incoming traps from SNMP agents. Note This setting is required.
Connect On Startup	boolean (check box)	true (selected)	When selected, the adapter attempts to open the specified UDP port and start listening for incoming traps immediately after starting. If cleared, the adapter remains idle after starting and waits for a Connect command as described in Command Input Port.
Add Command Input Port	boolean (check box)	false (cleared)	When selected, the adapter adds an input port for the app to issue commands to the adapter, for example to make it start or stop listening for incoming traps. The schema for this port is described in Command Input Port.
Add Status Output Port	boolean (check box)	false (cleared)	When selected, the adapter adds an output port to issue events that may be of interest to the application, for example to inform the app that the adapter has started or stopped listening for incoming traps. The schema for this port is described in Status Output Port Schema.
Log Level	drop-down list	INFO	Controls the level of verbosity the adapter uses to issue informational traces to the console. This setting is independent of the containing application's overall log level. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE.

Cluster Aware Tab

Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.

Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.

Concurrency Tab

Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.

Caution

Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.

Adapter Ports And Schemas

Input Port Overview

The adapter has at most one input port, depending on its configuration (see Add Command Input Port in Adapter Properties Tab).

Command Input Port

The (optional) Command input port is used to instruct the adapter to perform certain actions, such as connect or disconnect from the UDP port on which it listens for traps.

The schema for the Command Input port is expected to contain the following fields:

Field Name	Field Type	Field Description
`command`	string	Contains the name of the command to execute. This field is required to be non-null for all supported commands. See below for a list of the available commands.
`params`	list(string)	All-purpose list of string parameters that may be of use to specify additional information to apply the command. Currently, this field is not used by any of the supported commands and is only here to allow for future expansion. This field may be left null or empty if no parameters are required or needed.

Available commands include:

Connect: Start listening for SNMP traps on the configured UDP port. Required fields:
- command: Should contain the value Connect. Case is unimportant.
Disconnect: Stop listening for SNMP traps. Required fields:
- command: Should contain the value Disconnect. Case is unimportant.

Output Port Overview

The adapter has at least one output port, and optionally a second one:

The first port issues a tuple for each SNMP trap received, and describes its content.
The second (optional) port routes status messages, such as connection and disconnection events.

The schema for each output port is described in the following sections:

Traps Output Port Schema

The first output port routes incoming SNMP traps to the StreamBase application.

The schema for this port is pre-set by the adapter, and is described in the following table:

Field Name		Field Type	Description
requestID		int	The value of the incoming trap's PDU's request ID field.
type		string	The type of the incoming trap's PDU: `V1TRAP` for SNMP v1 traps `TRAP` for SNMP v2c traps
address		string	The IP address of the trap's originator. Will only be non-null for SNMP v1 traps.
enterpriseOID		string	The enterprise OID. Will only be non-null for SNMP v1 traps.
genericTrap		int	The generic number of this trap. Will only be non-null for SNMP v1 traps.
specificTrap		int	The specific number of this trap. Will only be non-null for SNMP v1 traps.
uptime		timestamp	An INTERVAL timestamp representing the trap sender's system uptime. Will only be non-null for SNMP v1 traps.
errorIndex		int	The error index, if any.
errorStatus		string	The error status, if any.
variableBindings		list(tuple)	Contains the list of variable bindings for the trap. Each tuple describes one binding and has the following fields:
^	oid	string	The binding's OID value.
	type	string	The binding's value's data type.
	value	string	The binding's value.

Status Output Port Schema

The second output port routes Status messages to the StreamBase application, provided the adapter has been configured to expose this optional port (see Add Status Output Port in Adapter Properties Tab).