org.apache.tools.ant.taskdefs.optional.ssh
Class SSHExec
- LogListener
Executes a command on a remote machine via ssh.
Version:
- Ant 1.6
SSHExec() - Constructor for SSHExecTask.
|
void | execute() - Execute the command on the remote host.
|
void | setAppend(boolean append) - Determines if the output is appended to the file given in
setOutput .
|
void | setCommand(String command) - Sets the command to execute on the remote host.
|
void | setOutput(File output) - If used, stores the output of the command to the given file.
|
void | setOutputproperty(String property) - If set, the output of the command will be stored in the given property.
|
void | setTimeout(long timeout) - The connection can be dropped after a specified number of
milliseconds.
|
getFailonerror , getHost , getPort , getUserInfo , getVerbose , init , openSession , setFailonerror , setHost , setKeyfile , setKnownhosts , setPassphrase , setPassword , setPort , setTrust , setUsername , setVerbose |
execute , getDescription , getLocation , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , maybeConfigure , perform , reconfigure , setDescription , setLocation , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
SSHExec
public SSHExec()
Constructor for SSHExecTask.
execute
public void execute()
throws BuildException
Execute the command on the remote host.
- execute in interface Task
BuildException
- Most likely a network error or bad parameter.
setAppend
public void setAppend(boolean append)
Determines if the output is appended to the file given in
setOutput
. Default is false, that is, overwrite
the file.
append
- True to append to an existing file, false to overwrite.
setCommand
public void setCommand(String command)
Sets the command to execute on the remote host.
command
- The new command value
setOutput
public void setOutput(File output)
If used, stores the output of the command to the given file.
output
- The file to write to.
setOutputproperty
public void setOutputproperty(String property)
If set, the output of the command will be stored in the given property.
property
- The name of the property in which the command output
will be stored.
setTimeout
public void setTimeout(long timeout)
The connection can be dropped after a specified number of
milliseconds. This is sometimes useful when a connection may be
flaky. Default is 0, which means "wait forever".
timeout
- The new timeout value in seconds
Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.