SNMP

Receive traps and poll SNMP (Simple Network Management Protocol) capable devices.

Metadata

Property	Value
Scheme	`snmp`
Support Level	Stable
Labels	monitoring
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-snmp</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`host`	string	✓		Hostname of the SNMP enabled device
`port`	integer	✓		Port number of the SNMP enabled device
`oids`	object			Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: 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
`protocol`	string		`udp`	Here you can select which protocol to use. You can use either udp or tcp.
`retries`	integer		`2`	Defines how often a retry is made before canceling the request.
`snmpCommunity`	string		`public`	Sets the community octet string for the snmp request.
`snmpContextEngineId`	string			Sets the context engine ID field of the scoped PDU.
`snmpContextName`	string			Sets the context name field of this scoped PDU.
`snmpVersion`	integer		`0`	Sets the snmp version for the request. The value 0 means SNMPv1, 1 means SNMPv2c, and the value 3 means SNMPv3
`timeout`	integer		`1500`	Sets the timeout value for the request in millis.
`type`	object			Which operation to perform such as poll, trap, etc.
`delay`	duration		`60000`	Milliseconds before the next poll.
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`treeList`	boolean		`false`	Sets the flag whether the scoped PDU will be displayed as the list if it has child elements in its tree
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`pollStrategy`	object			A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
`runLoggingLevel`	object		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	object		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
`authenticationPassphrase`	string			The authentication passphrase. If not null, authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown.
`authenticationProtocol`	string			Authentication protocol to use if security level is set to enable authentication The possible values are: MD5, SHA1
`privacyPassphrase`	string			The privacy passphrase. If not null, privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown.
`privacyProtocol`	string			The privacy protocol ID to be associated with this user. If set to null, this user only supports unencrypted messages.
`securityLevel`	integer		`3`	Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level, but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level, and only the one with the right encryption/decryption key can read the contents of the message.
`securityName`	string			Sets the security name to be used with this target.