SshTask

The SshTask executes commands on a remote host using ssh. This task requires the PHP SSH2 extension to function.

Table 145. Attributes

Name Type Description Default Required
host String Remote host none Yes
port Integer Remote port 22 No
username String Username to use for the connection none Yes
password String Password to use for the connection none No
pubkeyfile String Public key file (OpenSSH format) to use for the connection none No
privkeyfile String Private key file (OpenSSH format) to use for the connection none No
privkeyfilepassphrase String Private key file passphrase to use for the connection none No
command String Command to execute on the remote server none Yes
property String The name of the property to capture (any) output of the command none No
display Boolean Whether to display the output of the command true No
pty String The terminal type to open none No
failonerror Boolean Decides if a command chain will fail if one of the executed commands failed. Added for backward compatibility. Set to true if you execute more than one command and want the task to fail on any error. False No