328.2. 选项


SSH 组件支持 15 个选项,如下所列。

Name描述默认值类型

配置 (高级)

使用共享的 SSH 配置

 

SshConfiguration

host (common)

设置远程 SSH 服务器的主机名。

 

字符串

port (common)

设置远程 SSH 服务器的端口号。

 

int

用户名 (security)

设置登录远程 SSH 服务器的用户名。

 

字符串

密码 (security)

设置用于连接远程 SSH 服务器的密码。需要 keyPairProvider 设置为 null。

 

字符串

pollCommand (common)

设置在每次轮询循环期间要发送到远程 SSH 服务器的命令字符串。只适用于用作消费者的 camel-ssh 组件,即 from (ssh://…​)。您可能需要使用换行符来结束您的命令,并且必须采用 URL 编码 %0A

 

字符串

keyPairProvider (security)

设置在使用证书连接到远程 SSH 服务器时使用的 KeyPairProvider 引用。

 

KeyPairProvider

keyType (security)

设置要传递给 KeyPairProvider 的密钥类型,作为身份验证的一部分。KeyPairProvider.loadKey (…​)将传递这个值。默认为 ssh-rsa。

 

字符串

timeout (common)

设置在建立远程 SSH 服务器连接时等待的超时时间(毫秒)。默认值为 30000 毫秒。

 

long

certFilename (security)

弃用 设置用于身份验证的证书的资源路径。

 

字符串

certResource (security)

设置用于身份验证的证书的资源路径。将使用 ResourceHelperKeyPairProvider 解析基于文件的证书,并依赖于 keyType 设置。

 

字符串

channelType (advanced)

将频道类型设置为在命令执行过程中传递给频道。默认为 exec。

 

字符串

shellPrompt (advanced)

在命令执行后读取响应时,将 shell 提示符设置为丢弃

 

字符串

sleepForShellPrompt (advanced)

设置睡眠周期(以毫秒为单位),以等待从 shell 提示符读取响应。默认值为 100 毫秒。

 

long

resolveProperty Placeholders (advanced)

组件是否应在启动时解析属性占位符。只有 String 类型的属性可以使用属性占位符。

true

布尔值

SSH 端点使用 URI 语法进行配置:

ssh:host:port

使用以下路径和查询参数:

328.2.1. 路径参数(2 参数):

Name描述默认值类型

主机

必需 设置远程 SSH 服务器的主机名。

 

字符串

port

设置远程 SSH 服务器的端口号。

22

int

328.2.2. 查询参数(31 参数):

Name描述默认值类型

failOnUnknownHost (common)

指定到未知主机的连接是否应该失败。只有在设置了属性 knownHosts 时,才会检查这个值。

false

布尔值

knownHostsResource (common)

设置 known_hosts 文件的资源路径

 

字符串

timeout (common)

设置在建立远程 SSH 服务器连接时等待的超时时间(毫秒)。默认值为 30000 毫秒。

30000

long

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。

false

布尔值

pollCommand (consumer)

设置在每次轮询循环期间要发送到远程 SSH 服务器的命令字符串。只适用于用作消费者的 camel-ssh 组件,例如 from.e. from (ssh://…​),您可能需要使用换行符结束您的命令,且必须采用 URL 编码的 %0A

 

字符串

sendEmptyMessageWhenIdle (consumer)

如果轮询使用者没有轮询任何文件,您可以启用此选项来发送空消息(无正文)。

false

布尔值

ExceptionHandler ( consumer)

要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。

 

ExceptionHandler

exchangePattern (consumer)

在消费者创建交换时设置交换模式。

 

ExchangePattern

pollStrategy (consumer)

可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作期间通常会发生错误处理,然后再创建交换并在 Camel 中路由。

 

PollingConsumerPoll Strategy

channelType (advanced)

将频道类型设置为在命令执行过程中传递给频道。默认为 exec。

exec

字符串

shellPrompt (advanced)

在命令执行后读取响应时,将 shell 提示符设置为丢弃

 

字符串

sleepForShellPrompt (advanced)

设置睡眠周期(以毫秒为单位),以等待从 shell 提示符读取响应。默认值为 100 毫秒。

100

long

同步 (高级)

设置是否应严格使用同步处理,还是允许 Camel 使用异步处理(如果支持)。

false

布尔值

backoffErrorThreshold (scheduler)

在 backoffMultipler 应该 kick-in 之前发生的后续错误轮询(因为某些错误)的数量。

 

int

backoffIdleThreshold (scheduler)

在 backoffMultipler 应该 kick-in 之前应该发生的后续空闲轮询数量。

 

int

backoffMultiplier (scheduler)

如果一行中有很多后续空闲/errors,则让调度的轮询消费者避退。然后,倍数是在下一次实际尝试再次发生前跳过的轮询数量。当使用这个选项时,还必须配置 backoffIdleThreshold 和/或 backoffErrorThreshold。

 

int

delay (scheduler)

下一次轮询前的时间(毫秒)。您还可以使用单位来指定时间值,如 60s (60 秒)、5m30s (5 分钟和 30 秒),以及 1h (1 小时)。

500

long

greedy (scheduler)

如果启用了 greedy,如果上一个运行轮询 1 或更多消息,则 ScheduledPollConsumer 将立即运行。

false

布尔值

initialDelay (scheduler)

第一次轮询开始前的毫秒。您还可以使用单位来指定时间值,如 60s (60 秒)、5m30s (5 分钟和 30 秒),以及 1h (1 小时)。

1000

long

runLoggingLevel (scheduler)

消费者在轮询时记录 start/complete log 行。这个选项允许您为其配置日志级别。

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

允许配置用于消费者的自定义/共享线程池。默认情况下,每个使用者都有自己的单线程线程池。

 

ScheduledExecutor Service

scheduler (scheduler)

使用 camel-spring 或 camel-quartz2 组件的 cron 调度程序

none

ScheduledPollConsumer Scheduler

schedulerProperties (scheduler)

在使用自定义调度程序或任何基于 Spring 的调度程序时配置附加属性。

 

Map

startScheduler (scheduler)

调度程序是否应自动启动。

true

布尔值

timeUnit (scheduler)

initialDelay 和 delay 选项的时间单位。

MILLISECONDS

TimeUnit

useFixedDelay (scheduler)

控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。

true

布尔值

certResource (security)

设置用于身份验证的证书的资源路径。将使用 ResourceHelperKeyPairProvider 解析基于文件的证书,并依赖于 keyType 设置。

 

字符串

keyPairProvider (security)

设置在使用证书连接到远程 SSH 服务器时使用的 KeyPairProvider 引用。

 

KeyPairProvider

keyType (security)

设置要传递给 KeyPairProvider 的密钥类型,作为身份验证的一部分。KeyPairProvider.loadKey (…​)将传递这个值。默认为 ssh-rsa。

ssh-rsa

字符串

密码 (security)

设置用于连接远程 SSH 服务器的密码。需要 keyPairProvider 设置为 null。

 

字符串

用户名 (security)

设置登录远程 SSH 服务器的用户名。

 

字符串

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.