camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Camel > SSH
Date Mon, 06 Feb 2012 06:52:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/1/_/styles/combined.css?spaceKey=CAMEL&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/CAMEL/SSH">SSH</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~davsclaus">Claus
Ibsen</a>
    </h4>
        <br/>
                         <h4>Changes (2)</h4>
                                 
    
<div id="page-diffs">
                    <table class="diff" cellpadding="0" cellspacing="0">
    
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" >| username | | Username used for authenticating
with SSH Server. | <br>| password | | Password used for authenticating with SSH Server.
Used if {{keyPairProvider}} is null. | <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">|
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. | <br>|
keyType | | Refers to a key type to load from {{keyPairProvider}}. The key types can for example
be &quot;ssh-rsa&quot; or &quot;ssh-dss&quot;. | <br></td></tr>
            <tr><td class="diff-unchanged" >| timeout | {{30000}} | Milliseconds
to wait beforing timing out connection to SSH Server. | <br>| initialDelay | {{1000}}
| *Consumer only:* Milliseconds before polling the SSH server starts. | <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" >{div} <br> <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">h3.
Example <br>See the {{examples/camel-example-ssh}} in the Camel distribution. <br></td></tr>
            <tr><td class="diff-unchanged" > <br>{include:Endpoint See Also}
<br></td></tr>
    
            </table>
    </div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <h2><a name="SSH-SSH"></a>SSH</h2>
<p><b>Available as of Camel 2.10</b></p>

<p>The SSH component enables access to SSH servers such that you can send an SSH command,
and process the response.</p>

<p>Maven users will need to add the following dependency to their <tt>pom.xml</tt>
for this component:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml">
<span class="code-tag">&lt;dependency&gt;</span>
    <span class="code-tag">&lt;groupId&gt;</span>org.apache.camel<span
class="code-tag">&lt;/groupId&gt;</span>
    <span class="code-tag">&lt;artifactId&gt;</span>camel-ssh<span
class="code-tag">&lt;/artifactId&gt;</span>
    <span class="code-tag">&lt;version&gt;</span>x.x.x<span class="code-tag">&lt;/version&gt;</span>
    <span class="code-tag"><span class="code-comment">&lt;!-- use the same
version as your Camel core version --&gt;</span></span>
<span class="code-tag">&lt;/dependency&gt;</span>
</pre>
</div></div>

<h3><a name="SSH-URIformat"></a>URI format</h3>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
ssh:[username[:password]@]host[:port][?options]
</pre>
</div></div>

<h3><a name="SSH-Options"></a>Options</h3>
<div class="confluenceTableSmall"><div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Name </th>
<th class='confluenceTh'> Default Value </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'> host </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Hostname of SSH Server </td>
</tr>
<tr>
<td class='confluenceTd'> port </td>
<td class='confluenceTd'> <tt>22</tt> </td>
<td class='confluenceTd'> Port of the SSH Server </td>
</tr>
<tr>
<td class='confluenceTd'> username </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Username used for authenticating with SSH Server. </td>
</tr>
<tr>
<td class='confluenceTd'> password </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Password used for authenticating with SSH Server. Used if
<tt>keyPairProvider</tt> is null. </td>
</tr>
<tr>
<td class='confluenceTd'> keyPairProvider </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Refers to a <tt>org.apache.sshd.common.KeyPairProvider</tt>
to use for loading keys for authentication. If this option is used, then <tt>password</tt>
is not used. </td>
</tr>
<tr>
<td class='confluenceTd'> keyType </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> Refers to a key type to load from <tt>keyPairProvider</tt>.
The key types can for example be "ssh-rsa" or "ssh-dss". </td>
</tr>
<tr>
<td class='confluenceTd'> timeout </td>
<td class='confluenceTd'> <tt>30000</tt> </td>
<td class='confluenceTd'> Milliseconds to wait beforing timing out connection to SSH
Server. </td>
</tr>
<tr>
<td class='confluenceTd'> initialDelay </td>
<td class='confluenceTd'> <tt>1000</tt> </td>
<td class='confluenceTd'> <b>Consumer only:</b> Milliseconds before polling
the SSH server starts. </td>
</tr>
<tr>
<td class='confluenceTd'> delay </td>
<td class='confluenceTd'> <tt>500</tt> </td>
<td class='confluenceTd'> <b>Consumer only:</b> Milliseconds before the
next poll of the SSH Server. </td>
</tr>
<tr>
<td class='confluenceTd'> useFixedDelay </td>
<td class='confluenceTd'> <tt>true</tt> </td>
<td class='confluenceTd'> <b>Consumer only:</b> Controls if fixed delay
or fixed rate is used. See ScheduledExecutorService in JDK for details. </td>
</tr>
<tr>
<td class='confluenceTd'> pollCommand </td>
<td class='confluenceTd'>&nbsp;</td>
<td class='confluenceTd'> <b>Consumer only:</b> Command to send to SSH Server
during each poll cycle. Used only when acting as Consumer </td>
</tr>
</tbody></table>
</div>
</div>

<h3><a name="SSH-Example"></a>Example</h3>
<p>See the <tt>examples/camel-example-ssh</tt> in the Camel distribution.</p>

<h3><a name="SSH-SeeAlso"></a>See Also</h3>
<ul>
	<li><a href="/confluence/display/CAMEL/Configuring+Camel" title="Configuring Camel">Configuring
Camel</a></li>
	<li><a href="/confluence/display/CAMEL/Component" title="Component">Component</a></li>
	<li><a href="/confluence/display/CAMEL/Endpoint" title="Endpoint">Endpoint</a></li>
	<li><a href="/confluence/display/CAMEL/Getting+Started" title="Getting Started">Getting
Started</a></li>
</ul>

    </div>
        <div id="commentsSection" class="wiki-content pageSection">
        <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
        </div>
        <a href="https://cwiki.apache.org/confluence/display/CAMEL/SSH">View Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=27836863&revisedVersion=2&originalVersion=1">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/CAMEL/SSH?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message