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 22 Port of the SSH Server
username   Username used for authenticating with SSH Server.
password   Password used for authenticating with SSH Server. Used if keyPairProvider is null.
keyPairProvider   Refers to a org.apache.sshd.common.KeyPairProvider to use for loading keys for authentication. If this option is used, then password is not used.
keyType ssh-rsa Refers to a key type to load from keyPairProvider. The key types can for example be "ssh-rsa" or "ssh-dss".
certFilename   Refers to a file name to use as file based keyPairProvider.
timeout 30000 Milliseconds to wait beforing timing out connection to SSH Server.
initialDelay 1000 Consumer only: Milliseconds before polling the SSH server starts.
delay 500 Consumer only: Milliseconds before the next poll of the SSH Server.
useFixedDelay true 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.

See Also

© 2004-2011 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram