SSH
Available as of Camel 2.10
The SSH component enables access to SSH servers such that you can send an SSH command, and process the response.
Maven users will need to add the following dependency to their pom.xml
for this component:
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-ssh</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency>
URI format
ssh:[username[:password]@]host[:port][?options]
Options
Name |
Default Value |
Description |
---|---|---|
host |
|
Hostname of SSH Server |
port |
|
Port of the SSH Server |
username |
|
Username used for authenticating with SSH Server. |
password |
|
Password used for authenticating with SSH Server. Used if |
keyPairProvider |
|
Refers to a |
keyType |
|
Refers to a key type to load from |
timeout |
|
Milliseconds to wait beforing timing out connection to SSH Server. |
initialDelay |
|
Consumer only: Milliseconds before polling the SSH server starts. |
delay |
|
Consumer only: Milliseconds before the next poll of the SSH Server. |
useFixedDelay |
|
Consumer only: Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
pollCommand |
|
Consumer only: Command to send to SSH Server during each poll cycle. Used only when acting as Consumer |
Example
See the examples/camel-example-ssh
in the Camel distribution.