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

Unknown macro: {div}

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		Refers to a key type to load from `keyPairProvider`. The key types can for example be "ssh-rsa" or "ssh-dss".
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.

Child pages

SSH

URI format

Options

Example

See Also