5.16. SSH
5.16.1. camel-ssh-kafka-connector シンク設定 リンクのコピーリンクがクリップボードにコピーされました!
コネクターの説明: SSH を使用してリモートホストでコマンドを実行します。
camel-ssh-kafka-connector をシンクとして使用する場合、以下の Maven 依存関係を使用してコネクターをサポートするようにしてください。
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-ssh-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
Kafka コネクションでこのシンクコネクターを使用するには、以下の connector.class を設定する必要があります。
connector.class=org.apache.camel.kafkaconnector.ssh.CamelSshSinkConnector
camel-ssh シンクコネクターは、以下に示す 30 のオプションをサポートします。
| 名前 | 説明 | デフォルト | 必要性 | 優先順位 |
|---|---|---|---|---|
| camel.sink.path.host | リモート SSH サーバーのホスト名を設定します。 | null | true | HIGH |
| camel.sink.path.port | リモート SSH サーバーのポート番号を設定します。 | 22 | false | MEDIUM |
| camel.sink.endpoint.failOnUnknownHost | 不明なホストへの接続が失敗するかどうかを指定します。この値は、プロパティー knownHosts が設定されている場合にのみチェックされます。 | false | false | MEDIUM |
| camel.sink.endpoint.knownHostsResource | known_hosts ファイルのリソースパスを設定します | null | false | MEDIUM |
| camel.sink.endpoint.timeout | リモート SSH サーバー接続を確立する際に待機するタイムアウトをミリ秒単位で設定します。デフォルトは 30000 ミリ秒 (ms) です。 | 30000L | false | MEDIUM |
| camel.sink.endpoint.lazyStartProducer | 最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時にプロデューサーが失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、プロデューサーの作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。 | false | false | MEDIUM |
| camel.sink.endpoint.channelType | コマンド実行の一部として Channel に渡すチャネルタイプを設定します。デフォルトは exec です。 | exec | false | MEDIUM |
| camel.sink.endpoint.shellPrompt | コマンド実行後にレスポンスが読み取られたときに shellPrompt がドロップされるように設定します | null | false | MEDIUM |
| camel.sink.endpoint.sleepForShellPrompt | シェルプロンプトからのレスポンスの読み取りを待機するスリープ期間をミリ秒単位で設定します。デフォルトは 100 ミリ秒 (ms) です。 | 100L | false | MEDIUM |
| camel.sink.endpoint.certResource | 認証に使用する証明書のリソースパスを設定します。ResourceHelperKeyPairProvider を使用してファイルベースの証明書を解決し、keyType 設定に依存します。 | null | false | MEDIUM |
| camel.sink.endpoint.certResourcePassword | certResource が暗号化されたキーである場合、certResource の読み込みに使用するパスワードを設定します。 | null | false | MEDIUM |
| camel.sink.endpoint.keyPairProvider | 証明書を使用してリモート SSH サーバーに接続するときに使用する KeyPairProvider 参照を設定します。 | null | false | MEDIUM |
| camel.sink.endpoint.keyType | 認証の一部として KeyPairProvider に渡すキータイプを設定します。KeyPairProvider.loadKey(…) にこの値が渡されます。Camel 3.0.0/2.25.0 から、デフォルトで、Camel はロードされた最初の利用可能なキーペアを選択します。これより前は、ssh-rsa の KeyType がデフォルトで適用されていました。 | null | false | MEDIUM |
| camel.sink.endpoint.password | リモート SSH サーバーへの接続に使用するパスワードを設定します。keyPairProvider を null に設定する必要があります。 | null | false | MEDIUM |
| camel.sink.endpoint.username | リモート SSH サーバーへのログインに使用するユーザー名を設定します。 | null | false | MEDIUM |
| camel.component.ssh.failOnUnknownHost | 不明なホストへの接続が失敗するかどうかを指定します。この値は、プロパティー knownHosts が設定されている場合にのみチェックされます。 | false | false | MEDIUM |
| camel.component.ssh.knownHostsResource | known_hosts ファイルのリソースパスを設定します | null | false | MEDIUM |
| camel.component.ssh.timeout | リモート SSH サーバー接続を確立する際に待機するタイムアウトをミリ秒単位で設定します。デフォルトは 30000 ミリ秒 (ms) です。 | 30000L | false | MEDIUM |
| camel.component.ssh.lazyStartProducer | 最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時にプロデューサーが失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、プロデューサーの作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。 | false | false | MEDIUM |
| camel.component.ssh.autowiredEnabled | 自動ワイヤリングが有効になっているかどうか。これは、コンポーネントで設定される一致するタイプのインスタンスが 1 つあるかどうかを検出するためにレジストリーを検索することで、自動ワイアリングオプションに使用されます (オプションは自動ワイアとマーク付けされる必要があります)。これは、JDBC データソース、JMS 接続ファクトリー、AWS クライアントなどの自動設定に使用できます。 | true | false | MEDIUM |
| camel.component.ssh.channelType | コマンド実行の一部として Channel に渡すチャネルタイプを設定します。デフォルトは exec です。 | exec | false | MEDIUM |
| camel.component.ssh.configuration | コンポーネントの設定 | null | false | MEDIUM |
| camel.component.ssh.shellPrompt | コマンド実行後にレスポンスが読み取られたときに shellPrompt がドロップされるように設定します | null | false | MEDIUM |
| camel.component.ssh.sleepForShellPrompt | シェルプロンプトからのレスポンスの読み取りを待機するスリープ期間をミリ秒単位で設定します。デフォルトは 100 ミリ秒 (ms) です。 | 100L | false | MEDIUM |
| camel.component.ssh.certResource | 認証に使用する証明書のリソースパスを設定します。ResourceHelperKeyPairProvider を使用してファイルベースの証明書を解決し、keyType 設定に依存します。 | null | false | MEDIUM |
| camel.component.ssh.certResourcePassword | certResource が暗号化されたキーである場合、certResource の読み込みに使用するパスワードを設定します。 | null | false | MEDIUM |
| camel.component.ssh.keyPairProvider | 証明書を使用してリモート SSH サーバーに接続するときに使用する KeyPairProvider 参照を設定します。 | null | false | MEDIUM |
| camel.component.ssh.keyType | 認証の一部として KeyPairProvider に渡すキータイプを設定します。KeyPairProvider.loadKey(…) にこの値が渡されます。Camel 3.0.0/2.25.0 から、デフォルトで、Camel はロードされた最初の利用可能なキーペアを選択します。これより前は、ssh-rsa の KeyType がデフォルトで適用されていました。 | null | false | MEDIUM |
| camel.component.ssh.password | リモート SSH サーバーへの接続に使用するパスワードを設定します。keyPairProvider を null に設定する必要があります。 | null | false | MEDIUM |
| camel.component.ssh.username | リモート SSH サーバーへのログインに使用するユーザー名を設定します。 | null | false | MEDIUM |
camel-ssh シンクコネクターには、すぐに使用できるコンバータはありません。
camel-ssh シンクコネクターは、以下に示すそのまま使える transforms を 0 個サポートします。
org.apache.camel.kafkaconnector.ssh.transformers.SshTransforms
camel-ssh シンクコネクターには、すぐに使用できる集約ストラテジーはありません。