ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject cvs commit: ant/docs/manual/OptionalTasks sshexec.html
Date Thu, 13 Mar 2003 09:01:54 GMT
bodewig     2003/03/13 01:01:54

  Modified:    .        WHATSNEW
               docs/manual install.html optionaltasklist.html
  Added:       docs/manual/OptionalTasks sshexec.html
  Log:
  Documentation for <sshexec>.
  
  Submitted by:	Rob Anderson <Anderson dot Rob at vectorscm dot com>
  
  Revision  Changes    Path
  1.363     +3 -3      ant/WHATSNEW
  
  Index: WHATSNEW
  ===================================================================
  RCS file: /home/cvs/ant/WHATSNEW,v
  retrieving revision 1.362
  retrieving revision 1.363
  diff -u -r1.362 -r1.363
  --- WHATSNEW	12 Mar 2003 11:41:36 -0000	1.362
  +++ WHATSNEW	13 Mar 2003 09:01:53 -0000	1.363
  @@ -157,9 +157,9 @@
   * The <javadoc> task <tag> subelement has been enhanced to allow files
     with tag mappings to be used.
   
  -* New task <scp> that supports file transfers over SSH.  Requires
  -  jsch, a BSD licensed SSH library that can be found at 
  -  http://www.jcraft.com/jsch/index.html
  +* New tasks: <scp> supports file transfers, <sshexec> executes a
  +  command over SSH.  They require jsch, a BSD licensed SSH library that
  +  can be found at http://www.jcraft.com/jsch/index.html
   
   Changes from Ant 1.5.2 to Ant 1.5.3
   ===================================
  
  
  
  1.48      +1 -1      ant/docs/manual/install.html
  
  Index: install.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/install.html,v
  retrieving revision 1.47
  retrieving revision 1.48
  diff -u -r1.47 -r1.48
  --- install.html	6 Mar 2003 12:42:43 -0000	1.47
  +++ install.html	13 Mar 2003 09:01:53 -0000	1.48
  @@ -420,7 +420,7 @@
     </tr>
     <tr>
       <td>jsch.jar</td>
  -    <td>scp task</td>
  +    <td>sshexec and scp tasks</td>
       <td><a href="http://www.jcraft.com/jsch/index.html"
           target="_top">http://www.jcraft.com/jsch/index.html</a></td>
     </tr>
  
  
  
  1.36      +1 -0      ant/docs/manual/optionaltasklist.html
  
  Index: optionaltasklist.html
  ===================================================================
  RCS file: /home/cvs/ant/docs/manual/optionaltasklist.html,v
  retrieving revision 1.35
  retrieving revision 1.36
  diff -u -r1.35 -r1.36
  --- optionaltasklist.html	6 Mar 2003 12:42:43 -0000	1.35
  +++ optionaltasklist.html	13 Mar 2003 09:01:54 -0000	1.36
  @@ -60,6 +60,7 @@
   <a href="OptionalTasks/sound.html">Sound</a><br>
   <a href="OptionalTasks/sos.html">SourceOffSite</a><br>
   <a href="OptionalTasks/splash.html">Splash</a><br>
  +<a href="OptionalTasks/sshexec.html">Sshexec</a><br>
   <a href="OptionalTasks/starteam.html">Starteam Tasks</a><br>
   <a href="OptionalTasks/stylebook.html">Stylebook</a><br>
   <a href="OptionalTasks/symlink.html">Symlink</a><br>
  
  
  
  1.1                  ant/docs/manual/OptionalTasks/sshexec.html
  
  Index: sshexec.html
  ===================================================================
  <html>
  
  <head>
  <meta http-equiv="Content-Language" content="en-us">
  <title>SSHEXEC Task</title>
  </head>
  
  <body>
  
  <h2><a name="sshexec">SSHEXEC</a></h2>
  <h3>Description</h3>
  <p>Runs a command on a remote machine running SSH daemon.
  </p>
  
  <p><b>Note:</b> This task depends on external libraries not included
  in the Ant distribution.  See <a
  href="../install.html#librarydependencies">Library Dependencies</a>
  for more information.  This task has been tested with jsch-0.1.2.</p>
  
  <h3>Parameters</h3>
  <table border="1" cellpadding="2" cellspacing="0">
    <tr>
      <td valign="top"><b>Attribute</b></td>
      <td valign="top"><b>Description</b></td>
      <td align="center" valign="top"><b>Required</b></td>
    </tr>
    <tr>
      <td valign="top">username</td>
      <td valign="top">The username on the remote host to which you are connecting.</td>
      <td valign="top" align="center">Yes</td>
    </tr>
    <tr>
      <td valign="top">command</td>
      <td valign="top">The command to run on the remote host.</td>
      <td valian="top" align="center">Yes</td>
    </tr>
    <tr>
      <td valign="top">port</td>
      <td valign="top">The port to connect to on the remote host.</td>
      <td valian="top" align="center">No, defaults to 22.</td>
    </tr>
    <tr>
      <td valign="top">trust</td>
      <td valign="top">This trusts all unknown hosts if set to yes/true.</td>
      <td valian="top" align="center">No, defaults to No.</td>
    </tr>
    <tr>
      <td valign="top">knownhosts</td>
      <td valign="top">This sets the known hosts file to use to validate
      the identity of the remote host.  This must be a SSH2 format file.
      SSH1 format is not supported.</td>
      <td valian="top" align="center">No, defaults to
      ${user.home}/.ssh/known_hosts.</td>
    </tr>
    <tr>
      <td valign="top">failonerror</td>
       <td valign="top">Log a warning message, but do not stop the build,
         when the transfer does not work.
       </td>
       <td valign="top" align="center">No; defaults to true.</td>
    </tr>
    <tr>
      <td valign="top">password</td>
       <td valign="top">The password.</td>
       <td valign="top" align="center">Not if you are using key based
       authentication or the password has been given in the file or
       todir attribute.</td>
    </tr>
    <tr>
      <td valign="top">keyfile</td>
       <td valign="top">Location of the file holding the private key.</td>
       <td valign="top" align="center">Yes, if you are using key based
       authentication.</td>
    </tr>
    <tr>
      <td valign="top">passphrase</td>
       <td valign="top">Passphrase for your private key.</td>
       <td valign="top" align="center">No, defaults to an empty string.</td>
    </tr>
  </table>
  
  <h3>Examples</h3>
  <p><b>Run a command on a remote machine using password authentication</b></p>
  <pre>
    &lt;sshexec host=&quot;somehost&quot;
  	username=&quot;dude&quot;
  	password=&quot;yo&quot;
  	command=&quot;touch somefile&quot;/&gt;
  </pre>
  
  <p><b>Run a command on a remote machine using key authentication</b></p>
  <pre>
    &lt;sshexec host=&quot;somehost&quot;
  	username=&quot;dude&quot;
  	keyfile=&quot;${user.home}/.ssh/id_dsa&quot;
  	passphrase=&quot;yo its a secret&quot;
  	command=&quot;touch somefile&quot;/&gt;
  </pre>
  
  <p><b>Run a command on a remote machine using key authentication with no passphrase</b></p>
  <pre>
    &lt;sshexec host=&quot;somehost&quot;
  	username=&quot;dude&quot;
  	keyfile=&quot;${user.home}/.ssh/id_dsa&quot;
  	command=&quot;touch somefile&quot;/&gt;
  </pre>
  
  <p><strong>Security Note:</strong>  Hard coding passwords and/or usernames
  in sshexec task can be a serious security hole.  Consider using variable
  substituion and include the password on the command line.  For example:<br>
  <pre>
    &lt;sshexec host=&quot;somehost&quot;
  	username=&quot;${username}&quot;
  	password=&quot;${password}&quot;
  	command=&quot;touch somefile&quot;/&gt;
  </pre>
  Invoke ant with the following command line:
  <pre>
      ant -Dusername=me -Dpassword=mypassword target1 target2
  </pre>
  </p>
  
  <hr><p align="center">Copyright &copy; 2003 Apache Software Foundation.
  All rights Reserved.</p>
  
  </body>
  </html>
  
  
  
  

Mime
View raw message