Element Summary

ElementDescriptionClass
componentSNMP Componentorg.apache.servicemix.snmp.SnmpComponent
pollerThis is the polling endpoint for the snmp component.org.apache.servicemix.snmp.SnmpPollingEndpoint
trap-consumerThis is the trap endpoint for the snmp component. This endpoint receives and process trap PDUs from a device. Then it sends an exchange to the target service containing the processed content.org.apache.servicemix.snmp.SnmpTrapConsumerEndpoint

Element Detail

Element: component

ElementTypeDescription
endpoints(poller | trap-consumer)*
executorFactory<spring:bean/>

Element: poller

AttributeTypeDescription
addressxs:string

Specifies the connection URI used to connect to a snmp capable device.

Template:
   <protocol>:<host>/<port>

Details:

Name Description
protocol the protocol to use (udp or tcp)
host the name or ip address of the snmp capable device
port the port number to use

Example:
   udp:192.168.2.122/161

   The default value is null

concurrentPollingxs:boolean
delayxs:long
endpointxs:string
firstTimexs:date
interfaceNamexs:QName
periodxs:long
retriesxs:integer

Specifies the connection retries.

   The default value is 2

servicexs:QName
snmpCommunityxs:string

Specifies the snmp community to use.

   The default value is "public"

snmpVersionxs:integer

Specifies the snmp protocol version to use.

   The default value is 0 (version 1)

targetEndpointxs:string
targetInterfacexs:QName
targetOperationxs:QName
targetServicexs:QName
targetUrixs:string
timeoutxs:integer

Specifies the connection time out in milliseconds.

   The default value is 1500

ElementTypeDescription
definition<spring:bean/>
description<spring:bean/>
marshaler<spring:bean/>

Specifies a marshaler class which provides the logic for converting a snmp response into a normalized message. This class has to implement the SnmpMarshalerSupport interface. If you don't specify a marshaler, the DefaultSnmpMarshaler will be used.

oids(<spring:bean/>)*

Specifies a reference to a list of OID values which will be used for the snmp request. You have two possibilities how to specify the value:

 a) referencing to a file containing a list of OID values separated by a line feed
    or
 b) defining a coma (,) separated list of OID values

Examples:
   a) oids="classpath:myOids.txt"
       oids="file:/home/lhein/snmp/device_a/oids.txt"

   b) oids="1.3.6.1.2.1.1.3.0 , 1.3.6.1.2.1.25.3.2.1.5.1 , 1.3.6.1.2.1.25.3.5.1.1.1 , 1.3.6.1.2.1.43.5.1.1.11.1"

   The default value is null

scheduler<spring:bean/>
serviceUnit<spring:bean/>

Element: trap-consumer

AttributeTypeDescription
addressxs:string

Specifies the connection URI used to connect to a snmp capable device.

Template:
   <protocol>:<host>/<port>

Details:

Name Description
protocol the protocol to use (udp or tcp)
host the name or ip address of the snmp capable device
port the port number to use

Example:
   udp:192.168.2.122/162

   The default value is null

enabledxs:boolean

Specifies wether the endpoint is enabled or not. If its value is set to true, the connection data will be setted and trap PDUs will be processed. Otherwise, the endpoint won't do anything.

endpointxs:string
interfaceNamexs:QName
servicexs:QName
targetEndpointxs:string
targetInterfacexs:QName
targetOperationxs:QName
targetServicexs:QName
targetUrixs:string
ElementTypeDescription
definition<spring:bean/>
description<spring:bean/>
marshaler<spring:bean/>

Specifies a marshaler class which provides the logic for converting a snmp trap into a normalized message. This class has to implement the SnmpMarshalerSupport interface. If you don't specify a marshaler, the DefaultSnmpMarshaler will be used.

serviceUnit<spring:bean/>