summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorStefan Bodewig <bodewig@apache.org>2021-03-07 10:43:26 +0100
committerStefan Bodewig <bodewig@apache.org>2021-03-07 10:43:26 +0100
commitb01e7008bacb6efbd0d33eb8d27c9343db3def19 (patch)
treeb6b54466208c45da37c8b89cd6b600a41eb6fa02 /manual
parent9cf0e53fb36c352bd4a6767eea062c7bc3358f81 (diff)
downloadant-b01e7008bacb6efbd0d33eb8d27c9343db3def19.tar.gz
BZ-65089 support setting arbitrary configs for JSch Session
Diffstat (limited to 'manual')
-rw-r--r--manual/Tasks/scp.html25
-rw-r--r--manual/Tasks/sshexec.html27
-rw-r--r--manual/Tasks/sshsession.html25
3 files changed, 77 insertions, 0 deletions
diff --git a/manual/Tasks/scp.html b/manual/Tasks/scp.html
index a9a95a12d..e9e4a33eb 100644
--- a/manual/Tasks/scp.html
+++ b/manual/Tasks/scp.html
@@ -217,6 +217,31 @@ set.</p>
<p>Prior to Ant 1.9.7 only <code>&lt;fileset&gt;</code> has been supported as a nested element.</p>
+<h4 id="additionalConfig">additionalConfig</h4>
+
+<p><em>since Ant 1.10.10</em></p>
+
+<p>Adds configuration settings for the JSch Session created that are
+ not directly supported by specific Ant attributes.</p>
+
+<table class="attr">
+ <tr>
+ <th scope="col">Attribute</th>
+ <th scope="col">Description</th>
+ <th scope="col">Required</th>
+ </tr>
+ <tr>
+ <td>key</td>
+ <td>The key of the configuration setting.</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>value</td>
+ <td>The value of the configuration setting.</td>
+ <td>Yes</td>
+ </tr>
+</table>
+
<h3>Examples</h3>
<p>Copy a single local file to a remote machine:</p>
<pre>&lt;scp file=&quot;myfile.txt&quot; todir=&quot;user:password@somehost:/home/chuck&quot;/&gt;</pre>
diff --git a/manual/Tasks/sshexec.html b/manual/Tasks/sshexec.html
index 6437b4608..f0a0e9c40 100644
--- a/manual/Tasks/sshexec.html
+++ b/manual/Tasks/sshexec.html
@@ -230,6 +230,33 @@ JSCh earlier than 0.1.28.</p>
</tr>
</table>
+<h3>Parameters specified as nested elements</h3>
+
+<h4 id="additionalConfig">additionalConfig</h4>
+
+<p><em>since Ant 1.10.10</em></p>
+
+<p>Adds configuration settings for the JSch Session created that are
+ not directly supported by specific Ant attributes.</p>
+
+<table class="attr">
+ <tr>
+ <th scope="col">Attribute</th>
+ <th scope="col">Description</th>
+ <th scope="col">Required</th>
+ </tr>
+ <tr>
+ <td>key</td>
+ <td>The key of the configuration setting.</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>value</td>
+ <td>The value of the configuration setting.</td>
+ <td>Yes</td>
+ </tr>
+</table>
+
<h3>Examples</h3>
<p>Run a command on a remote machine using password authentication</p>
diff --git a/manual/Tasks/sshsession.html b/manual/Tasks/sshsession.html
index 6f557bb72..c8cf29118 100644
--- a/manual/Tasks/sshsession.html
+++ b/manual/Tasks/sshsession.html
@@ -186,6 +186,31 @@ both sets of tunnels will be established.</p>
</tr>
</table>
+<h4 id="additionalConfig">additionalConfig</h4>
+
+<p><em>since Ant 1.10.10</em></p>
+
+<p>Adds configuration settings for the JSch Session created that are
+ not directly supported by specific Ant attributes.</p>
+
+<table class="attr">
+ <tr>
+ <th scope="col">Attribute</th>
+ <th scope="col">Description</th>
+ <th scope="col">Required</th>
+ </tr>
+ <tr>
+ <td>key</td>
+ <td>The key of the configuration setting.</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>value</td>
+ <td>The value of the configuration setting.</td>
+ <td>Yes</td>
+ </tr>
+</table>
+
<h4 id="Sequential">sequential</h4>
<p>The <code>sequential</code> element is a required parameter. It is a container for nested Tasks
which are to be executed once the SSH connection is established and all local and/or remote tunnels