SNMP

SNMP

Scheme: snmp
Name Kind Type Required Deprecated Default Value Enum Values Description
host path java.lang.String true false Hostname of the SNMP enabled device
port path java.lang.Integer true false Port number of the SNMP enabled device
protocol parameter java.lang.String false udp tcp
udp
Here you can select which protocol to use. You can use either udp or tcp.
retries parameter int false 2 Defines how often a retry is made before canceling the request.
timeout parameter int false 1500 Sets the timeout value for the request in millis.
snmpVersion parameter int false 0 0
1
3
Sets the snmp version for the request.

The value 0 means SNMPv1, 1 means SNMPv2c, and the value 3 means SNMPv3

snmpCommunity parameter java.lang.String false public Sets the community octet string for the snmp request.
type parameter org.apache.camel.component.snmp.SnmpActionType false TRAP
POLL
GET_NEXT
Which operation to perform such as poll, trap, etc.
delay parameter long false 60000 Sets update rate in seconds @param updateEvery the update rate in seconds
securityLevel parameter int false 3 1
2
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 parameter java.lang.String false Sets the security name to be used with this target.
authenticationProtocol parameter java.lang.String false MD5
SHA1
Authentication protocol to use if security level is set to enable authentication The possible values are: MD5, SHA1
authenticationPassphrase parameter java.lang.String false 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.
privacyProtocol parameter java.lang.String false The privacy protocol ID to be associated with this user. If set to null, this user only supports unencrypted messages.
privacyPassphrase parameter java.lang.String false 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.
snmpContextName parameter java.lang.String false Sets the context name field of this scoped PDU.
snmpContextEngineId parameter java.lang.String false Sets the context engine ID field of the scoped PDU.
startScheduler parameter boolean false true Whether the scheduler should be auto started.
initialDelay parameter long false 1000 Milliseconds before the first poll starts.
timeUnit parameter java.util.concurrent.TimeUnit false MILLISECONDS NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
Time unit for initialDelay and delay options.
useFixedDelay parameter boolean false true Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
pollStrategy parameter org.apache.camel.spi.PollingConsumerPollStrategy false 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.
runLoggingLevel parameter org.apache.camel.LoggingLevel false TRACE TRACE
DEBUG
INFO
WARN
ERROR
OFF
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
sendEmptyMessageWhenIdle parameter boolean false If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
greedy parameter boolean false If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
scheduler parameter org.apache.camel.spi.ScheduledPollConsumerScheduler false spring
quartz2
To use a cron scheduler from either camel-spring or camel-quartz2 component
schedulerProperties parameter java.util.Map false To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler.
scheduledExecutorService parameter java.util.concurrent.ScheduledExecutorService false Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
backoffMultiplier parameter int false 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.
backoffIdleThreshold parameter int false The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
backoffErrorThreshold parameter int false The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).