SNMP

SNMP

Description: Represents the component that manages SnmpEndpoint. It holds the list of named direct endpoints.
Scheme: snmp
Syntax: snmp:host:port
Maven: org.apache.camel/camel-snmp/2.16.1
Name Kind Group Required Default Type Enum Description
host path consumer true java.lang.String Hostname of the SNMP enabled device
port path consumer true java.lang.Integer Port number of the SNMP enabled device
authenticationPassphrase parameter consumer java.lang.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 parameter consumer java.lang.String MD5
SHA1
Authentication protocol to use if security level is set to enable authentication The possible values are: MD5, SHA1
delay parameter consumer 60000 long Sets update rate in seconds @param updateEvery the update rate in seconds
privacyPassphrase parameter consumer java.lang.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 parameter consumer java.lang.String The privacy protocol ID to be associated with this user. If set to null, this user only supports unencrypted messages.
protocol parameter consumer udp java.lang.String tcp
udp
Here you can select which protocol to use. You can use either udp or tcp.
retries parameter consumer 2 int Defines how often a retry is made before canceling the request.
securityLevel parameter consumer 3 int 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 consumer java.lang.String Sets the security name to be used with this target.
sendEmptyMessageWhenIdle parameter consumer boolean If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
snmpCommunity parameter consumer public java.lang.String Sets the community octet string for the snmp request.
snmpContextEngineId parameter consumer java.lang.String Sets the context engine ID field of the scoped PDU.
snmpContextName parameter consumer java.lang.String Sets the context name field of this scoped PDU.
snmpVersion parameter consumer 0 int 0
1
3
Sets the snmp version for the request.

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

timeout parameter consumer 1500 int Sets the timeout value for the request in millis.
type parameter consumer org.apache.camel.component.snmp.SnmpActionType TRAP
POLL
GET_NEXT
Which operation to perform such as poll, trap, etc.
pollStrategy parameter consumer (advanced) org.apache.camel.spi.PollingConsumerPollStrategy 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.
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
backoffErrorThreshold parameter scheduler int The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
backoffIdleThreshold parameter scheduler int The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
backoffMultiplier parameter scheduler int 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 parameter scheduler boolean If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
initialDelay parameter scheduler 1000 long Milliseconds before the first poll starts.
runLoggingLevel parameter scheduler TRACE org.apache.camel.LoggingLevel 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.
scheduledExecutorService parameter scheduler java.util.concurrent.ScheduledExecutorService 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 parameter scheduler org.apache.camel.spi.ScheduledPollConsumerScheduler spring
quartz2
To use a cron scheduler from either camel-spring or camel-quartz2 component
schedulerProperties parameter scheduler java.util.Map To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler.
startScheduler parameter scheduler true boolean Whether the scheduler should be auto started.
timeUnit parameter scheduler MILLISECONDS java.util.concurrent.TimeUnit NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
Time unit for initialDelay and delay options.
useFixedDelay parameter scheduler true boolean Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.