C.65 SshTask
Prev | Appendix C. Optional tasks | Next

## C.65 SshTask

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

Table C.92: 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

### C.65.1 Example

    <ssh username="john" password="smith"
    host="webserver" command="ls" />

Executes a single command on the remote server.

### C.65.2 Supported Nested Tags

- `sshconfig`

  Sometimes it is necessary to set specific configuration parameters on the ssh connection when connecting to a remote server. You can set them with the sshconfig nested tag. Set the parameters to specify connection and encryption options. These are the parameters as specified by the $methods parameter of the ssh2_connect function. See ssh2_connect for more information

  sshconfig can also be used as project level parameter with a refid so the same parameters can be re-used across a project easily.

  Table C.93: Attributes

  Name | Type | Description | Default | Required
  --- | --- | --- | --- | ---
  `kex` | `String` | List of key exchange methods to advertise, comma separated in order of preference. | n/a | No
  `hostkey` | `String` | List of hostkey methods to advertise, come separated in order of preference. | n/a | No
  `client` | `Nested Tag` | Element containing attributes crypt, comp, and mac method preferences for messages sent from client to server. All attributes are optional. | n/a | No
  `server` | `Nested Tag` | Element containing attributes crypt, comp, and mac method preferences for messages sent from server to client. All attributes are optional. | n/a | No

Prev | Up | Next
C.64 ScpTask | Home | C.66 SimpleTestTask