Using the Workbench to define a SNMP device

The Workbench provides the view into a node's installation, configuration and resource definition. The Workbench also provides access and control over those resources.

A device is a resource that can represent a physical device such as a SNMP enabled device, also known as a SNMP agent. An example of a device could be a printer, a router, or a server, that is accessible to the deviceWISE node via a UDP port. A device can also be defined in one node to represent a device that is defined and supported in another node. This allows your application solution to have access to devices and their data independent of their location or connectivity details.

Defining a SNMP Client Device

To define a device that represents a SNMP enabled device, follow these steps:

1. From the Workbench left pane, expand the node where you want to define the device.
2. Select the Devices icon. The Devices window appears as the right pane. The Devices window provides a table format that lists the previously defined devices.
   
   
3. To define a new device, select New at the bottom of the pane.
   The Device window appears.The available device types are determined by the device support that is installed in this node. The SNMP driver consists of two selections, the SNMP Client and the SNMP Trap Receiver.
   
4. Select the SNMP Client option to create a device that will be able to read and write to MIB objects defined on a SNMP node.
   
   
5. The Device window changes to accommodate the selected device type.
   
   

6. The SNMP Client provides a few fields that allow the user to define the type of SNMP agent the deviceWISE will be connected to.
   To define a device that represents a SNMP client, set the new device's parameters as follows:

   Field	Description
   Name	Enter a name that will identify the SNMP device.
   IP Address	Enter the IP Address of the SNMP device.
   SNMP Version	Enter the SNMP version that the device is using. Either 1 or 2c.
   Community	Enter the name of the community to which this SNMP device belongs.

   You can also specify advanced settings for the SNMP Client device. Select the Advanced Properties checkbox.

   Parameter	Description
   Per Variable Security	Select False to disable the allocation of additional memory to track User to Variable access for all Variables in this Device. Select True to enable this feature if required. For more information, see Setting up Read Write per device variable.

7. Select Validate to have the parameters validated and to connect to the SNMP client. If there is a problem connecting to the SNMP client, an error code will be displayed.
   
8. Select Save to save the device definition. The device will appear in the Devices window list of devices.
   
9. You can now control the device (Start, Stop), access the device's MIB variables by using the Variables window, and build solutions that use the device's resources.

Defining a deviceWISE Trap Receiver Device

There is a second type of deviceWISE device that interacts with SNMP devices: the SNMP Trap Receiver. Unlike the SNMP Client, which sets up a connection directly with a single SNMP Device, the SNMP Trap Receiver opens a port on the deviceWISE node and listens for SNMP Trap messages that can be sent from any SNMP device across the network.

Two steps are required to receive and process SNMP Trap, the definition of a SNMP Trap Receiver and the creation of a trigger that will process the Trap that was received. The steps to define a SNMP Trap Receiver device are shown below.

1. From the Workbench left pane, expand the node where you want to define the device.
   
2. Select the Devices icon. The Devices window appears as the right pane.
   The Devices window provides a table format that lists the previously defined devices.
   
   
3. To define a new device, select New at the bottom of the pane.
   The Device window appears. The available device types are determined by the device support that is installed in this node.
   
4. Select the SNMP Trap Receiver option to create a deviceWISE device that will receive Trap messages generated by SNMP nodes.
   
   
5. The Device window changes to accommodate the selected device type.
   
   
6. The SNMP Trap Receiver has one field that can be modified to customize this deviceWISE device, the Port field. To define a device that represents a SNMP Trap Receiver, set this new device's parameters as follows:

   Field	Description
   Name	Enter a name that will identify this deviceWISE SNMP device.
   Port	Enter the UDP Port that deviceWISE will create to listen for SNMP Trap messages. The default value of 162 should be used. This is the default port number that is defined in the SNMP specification that SNMP Traps are routed.

   You can also specify advanced settings for the SNMP Trap Receiver device. Select the Advanced Properties checkbox.

   Parameter	Description
   Per Variable Security	Select False to disable the allocation of additional memory to track User to Variable access for all Variables in this Device. Select True to enable this feature if required. For more information, see Setting up Read Write per device variable.

7. Select Validate to have the parameters validated. The Validate function will then attempt to create a UDP port on the deviceWISE node.
   
8. Select Save to save the device definition. The device will appear in the Devices window list of devices.
   
9. You can now control the device (Start, Stop) which will enable the deviceWISE node to accept Trap messages from SNMP devices. The receipt of a Trap message can then be used as an event that will cause a deviceWISE trigger to execute.