# tasks/ext/SshTask.php

Execute commands on a remote host using ssh.

Author
  Johan Van den Brande
Package
  phing.tasks.ext
Version
  $Id: SshTask.php 1205 2011-07-02 10:34:13Z mrook $

## \SshTask
jump to top

Package: phing\tasks\ext

Execute commands on a remote host using ssh.

Parent(s)
  \Task < \ProjectComponent
Author
  Johan Van den Brande
Version
  $Id: SshTask.php 1205 2011-07-02 10:34:13Z mrook $

### Properties

`$command= '""'`
Default value`""`Details

Type
  n/a

`boolean $display= 'true'`

Whether to display the output of the command

Default value `true` Details

Type
  boolean

`$host= '""'`
Default value`""`Details

Type
  n/a

`$password= '""'`
Default value`""`Details

Type
  n/a

`$port= '22'`
Default value `22` Details

Type
  n/a

`$privkeyfile= ''''`
Default value`''`Details

Type
  n/a

`$privkeyfilepassphrase= ''''`
Default value`''`Details

Type
  n/a

`string $property= '""'`

The name of the property to capture (any) output of the command

Default value`""`Details

Type
  string

`$pubkeyfile= ''''`
Default value`''`Details

Type
  n/a

`$username= '""'`
Default value`""`Details

Type
  n/a

### Methods

`getCommand( ) : void`

`getDescription( ) : void`

`getHost( ) : void`

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getPassword( ) : void`

`getPort( ) : void`

`getPrivkeyfile( ) : void`

Returns the private keyfile

`getPrivkeyfilepassphrase( $privkeyfilepassphrase ) : void`

Returns the private keyfile passphrase

Parameters

Name | Type | Description
--- | --- | ---
$privkeyfilepassphrase |  |

`getProject( ) : void`

`getPubkeyfile( ) : void`

Returns the pubkeyfile

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`getUsername( ) : void`

`init( ) : void`

`log( ) : void`

`main( ) : void`

`maybeConfigure( ) : void`

`perform( ) : void`

`setCommand( $command ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$command |  |

`setDescription( ) : void`

`setDisplay( boolean $display ) : void`

Sets whether to display the output of the command

Parameters

Name | Type | Description
--- | --- | ---
$display | boolean |

`setHost( $host ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$host |  |

`setLocation( ) : void`

`setOwningTarget( ) : void`

`setPassword( $password ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$password |  |

`setPort( $port ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$port |  |

`setPrivkeyfile( $privkeyfile ) : void`

Sets the private key file of the user to scp

Parameters

Name | Type | Description
--- | --- | ---
$privkeyfile |  |

`setPrivkeyfilepassphrase( $privkeyfilepassphrase ) : void`

Sets the private key file passphrase of the user to scp

Parameters

Name | Type | Description
--- | --- | ---
$privkeyfilepassphrase |  |

`setProject( ) : void`

`setProperty( string $property ) : void`

Sets the name of the property to capture (any) output of the command

Parameters

Name | Type | Description
--- | --- | ---
$property | string |

`setPubkeyfile( $pubkeyfile ) : void`

Sets the public key file of the user to scp

Parameters

Name | Type | Description
--- | --- | ---
$pubkeyfile |  |

`setRuntimeConfigurableWrapper( ) : void`

`setTaskName( ) : void`

`setTaskType( ) : void`

`setUsername( $username ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$username |  |

Documentation was generated by DocBlox 0.17.1.