You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

sshexec.html 4.9 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Language" content="en-us">
  4. <title>SSHEXEC Task</title>
  5. </head>
  6. <body>
  7. <h2><a name="sshexec">SSHEXEC</a></h2>
  8. <h3>Description</h3>
  9. <p><em>since Ant 1.6</em></p>
  10. <p>Runs a command on a remote machine running SSH daemon.
  11. </p>
  12. <p><b>Note:</b> This task depends on external libraries not included
  13. in the Ant distribution. See <a
  14. href="../install.html#librarydependencies">Library Dependencies</a>
  15. for more information. This task has been tested with jsch-0.1.7 and
  16. won't work with earlier versions of jsch..</p>
  17. <h3>Parameters</h3>
  18. <table border="1" cellpadding="2" cellspacing="0">
  19. <tr>
  20. <td valign="top"><b>Attribute</b></td>
  21. <td valign="top"><b>Description</b></td>
  22. <td align="center" valign="top"><b>Required</b></td>
  23. </tr>
  24. <tr>
  25. <td valign="top">username</td>
  26. <td valign="top">The username on the remote host to which you are connecting.</td>
  27. <td valign="top" align="center">Yes</td>
  28. </tr>
  29. <tr>
  30. <td valign="top">command</td>
  31. <td valign="top">The command to run on the remote host.</td>
  32. <td valian="top" align="center">Yes</td>
  33. </tr>
  34. <tr>
  35. <td valign="top">port</td>
  36. <td valign="top">The port to connect to on the remote host.</td>
  37. <td valian="top" align="center">No, defaults to 22.</td>
  38. </tr>
  39. <tr>
  40. <td valign="top">trust</td>
  41. <td valign="top">This trusts all unknown hosts if set to yes/true.</td>
  42. <td valian="top" align="center">No, defaults to No.</td>
  43. </tr>
  44. <tr>
  45. <td valign="top">knownhosts</td>
  46. <td valign="top">This sets the known hosts file to use to validate
  47. the identity of the remote host. This must be a SSH2 format file.
  48. SSH1 format is not supported.</td>
  49. <td valian="top" align="center">No, defaults to
  50. ${user.home}/.ssh/known_hosts.</td>
  51. </tr>
  52. <tr>
  53. <td valign="top">failonerror</td>
  54. <td valign="top">Log a warning message, but do not stop the build,
  55. when the transfer does not work.
  56. </td>
  57. <td valign="top" align="center">No; defaults to true.</td>
  58. </tr>
  59. <tr>
  60. <td valign="top">password</td>
  61. <td valign="top">The password.</td>
  62. <td valign="top" align="center">Not if you are using key based
  63. authentication or the password has been given in the file or
  64. todir attribute.</td>
  65. </tr>
  66. <tr>
  67. <td valign="top">keyfile</td>
  68. <td valign="top">Location of the file holding the private key.</td>
  69. <td valign="top" align="center">Yes, if you are using key based
  70. authentication.</td>
  71. </tr>
  72. <tr>
  73. <td valign="top">passphrase</td>
  74. <td valign="top">Passphrase for your private key.</td>
  75. <td valign="top" align="center">No, defaults to an empty string.</td>
  76. </tr>
  77. <tr>
  78. <td valign="top">output</td>
  79. <td valign="top">Name of a file to which to write the output.</td>
  80. <td align="center" valign="top">No</td>
  81. </tr>
  82. <tr>
  83. <td valign="top">append</td>
  84. <td valign="top">Whether output file should be appended to or overwritten. Defaults to false, meaning overwrite any existing file.</td>
  85. <td align="center" valign="top">No</td>
  86. </tr>
  87. <tr>
  88. <td valign="top">outputproperty</td>
  89. <td valign="top">The name of a property in which the output of the
  90. command should be stored.</td>
  91. <td align="center" valign="top">No</td>
  92. </tr>
  93. <tr>
  94. <td valign="top">timeout</td>
  95. <td valign="top">Stop the command if it doesn't finish within the
  96. specified time (given in milliseconds). Defaults to 0 which means &quot;wait forever&quot;.</td>
  97. <td align="center" valign="top">No</td>
  98. </tr>
  99. </table>
  100. <h3>Examples</h3>
  101. <p><b>Run a command on a remote machine using password authentication</b></p>
  102. <pre>
  103. &lt;sshexec host=&quot;somehost&quot;
  104. username=&quot;dude&quot;
  105. password=&quot;yo&quot;
  106. command=&quot;touch somefile&quot;/&gt;
  107. </pre>
  108. <p><b>Run a command on a remote machine using key authentication</b></p>
  109. <pre>
  110. &lt;sshexec host=&quot;somehost&quot;
  111. username=&quot;dude&quot;
  112. keyfile=&quot;${user.home}/.ssh/id_dsa&quot;
  113. passphrase=&quot;yo its a secret&quot;
  114. command=&quot;touch somefile&quot;/&gt;
  115. </pre>
  116. <p><b>Run a command on a remote machine using key authentication with no passphrase</b></p>
  117. <pre>
  118. &lt;sshexec host=&quot;somehost&quot;
  119. username=&quot;dude&quot;
  120. keyfile=&quot;${user.home}/.ssh/id_dsa&quot;
  121. command=&quot;touch somefile&quot;/&gt;
  122. </pre>
  123. <p><strong>Security Note:</strong> Hard coding passwords and/or usernames
  124. in sshexec task can be a serious security hole. Consider using variable
  125. substituion and include the password on the command line. For example:<br>
  126. <pre>
  127. &lt;sshexec host=&quot;somehost&quot;
  128. username=&quot;${username}&quot;
  129. password=&quot;${password}&quot;
  130. command=&quot;touch somefile&quot;/&gt;
  131. </pre>
  132. Invoke ant with the following command line:
  133. <pre>
  134. ant -Dusername=me -Dpassword=mypassword target1 target2
  135. </pre>
  136. </p>
  137. <hr><p align="center">Copyright &copy; 2003 Apache Software Foundation.
  138. All rights Reserved.</p>
  139. </body>
  140. </html>