// kafka-connector options: START
[[camel-ssh-kafka-connector-sink]]
= camel-ssh-kafka-connector sink configuration

When using camel-ssh-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

[source,xml]
----
<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>
----

To use this Sink connector in Kafka connect you'll need to set the following connector.class

[source,java]
----
connector.class=org.apache.camel.kafkaconnector.ssh.CamelSshSinkConnector
----


The camel-ssh sink connector supports 32 options, which are listed below.



[width="100%",cols="2,5,^1,1,1",options="header"]
|===
| Name | Description | Default | Required | Priority
| *camel.sink.path.host* | Sets the hostname of the remote SSH server. | null | true | HIGH
| *camel.sink.path.port* | Sets the port number for the remote SSH server. | 22 | false | MEDIUM
| *camel.sink.endpoint.failOnUnknownHost* | Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set. | false | false | MEDIUM
| *camel.sink.endpoint.knownHostsResource* | Sets the resource path for a known_hosts file | null | false | MEDIUM
| *camel.sink.endpoint.timeout* | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. | 30000L | false | MEDIUM
| *camel.sink.endpoint.lazyStartProducer* | 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. | false | false | MEDIUM
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | false | MEDIUM
| *camel.sink.endpoint.channelType* | Sets the channel type to pass to the Channel as part of command execution. Defaults to exec. | "exec" | false | MEDIUM
| *camel.sink.endpoint.shellPrompt* | Sets the shellPrompt to be dropped when response is read after command execution | null | false | MEDIUM
| *camel.sink.endpoint.sleepForShellPrompt* | Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds. | 100L | false | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | false | MEDIUM
| *camel.sink.endpoint.certResource* | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting. | null | false | MEDIUM
| *camel.sink.endpoint.certResourcePassword* | Sets the password to use in loading certResource, if certResource is an encrypted key. | null | false | MEDIUM
| *camel.sink.endpoint.keyPairProvider* | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. | null | false | MEDIUM
| *camel.sink.endpoint.keyType* | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa' was enforced by default. | null | false | MEDIUM
| *camel.sink.endpoint.password* | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. | null | false | MEDIUM
| *camel.sink.endpoint.username* | Sets the username to use in logging into the remote SSH server. | null | false | MEDIUM
| *camel.component.ssh.failOnUnknownHost* | Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set. | false | false | MEDIUM
| *camel.component.ssh.knownHostsResource* | Sets the resource path for a known_hosts file | null | false | MEDIUM
| *camel.component.ssh.timeout* | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. | 30000L | false | MEDIUM
| *camel.component.ssh.lazyStartProducer* | 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. | false | false | MEDIUM
| *camel.component.ssh.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | false | LOW
| *camel.component.ssh.channelType* | Sets the channel type to pass to the Channel as part of command execution. Defaults to exec. | "exec" | false | MEDIUM
| *camel.component.ssh.configuration* | Component configuration | null | false | MEDIUM
| *camel.component.ssh.shellPrompt* | Sets the shellPrompt to be dropped when response is read after command execution | null | false | MEDIUM
| *camel.component.ssh.sleepForShellPrompt* | Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds. | 100L | false | MEDIUM
| *camel.component.ssh.certResource* | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting. | null | false | MEDIUM
| *camel.component.ssh.certResourcePassword* | Sets the password to use in loading certResource, if certResource is an encrypted key. | null | false | MEDIUM
| *camel.component.ssh.keyPairProvider* | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. | null | false | MEDIUM
| *camel.component.ssh.keyType* | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa' was enforced by default. | null | false | MEDIUM
| *camel.component.ssh.password* | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. | null | false | MEDIUM
| *camel.component.ssh.username* | Sets the username to use in logging into the remote SSH server. | null | false | MEDIUM
|===



The camel-ssh sink connector has no converters out of the box.





The camel-ssh sink connector has no transforms out of the box.





The camel-ssh sink connector has no aggregation strategies out of the box.
// kafka-connector options: END
