tasks/ext/SshTask.php
Classes
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
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
trueDetails- Type
- boolean
$host= '""'
Default value
""Details- Type
- n/a
$password= '""'
Default value
""Details- Type
- n/a
$port= '22'
Default value
22Details- 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(
)
:
voidgetDescription(
)
:
voidgetHost(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetPassword(
)
:
voidgetPort(
)
:
voidgetPrivkeyfile(
)
:
voidReturns the private keyfile
getPrivkeyfilepassphrase(
$privkeyfilepassphrase
)
:
voidReturns the private keyfile passphrase
Parameters
| Name | Type | Description |
|---|---|---|
| $privkeyfilepassphrase |
getProject(
)
:
voidgetPubkeyfile(
)
:
voidReturns the pubkeyfile
getRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidgetUsername(
)
:
voidinit(
)
:
voidlog(
)
:
voidmain(
)
:
voidmaybeConfigure(
)
:
voidperform(
)
:
voidsetCommand(
$command
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $command |
setDescription(
)
:
voidsetDisplay(
boolean $display
)
:
voidSets whether to display the output of the command
Parameters
| Name | Type | Description |
|---|---|---|
| $display | boolean |
setHost(
$host
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $host |
setLocation(
)
:
voidsetOwningTarget(
)
:
voidsetPassword(
$password
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $password |
setPort(
$port
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $port |
setPrivkeyfile(
$privkeyfile
)
:
voidSets the private key file of the user to scp
Parameters
| Name | Type | Description |
|---|---|---|
| $privkeyfile |
setPrivkeyfilepassphrase(
$privkeyfilepassphrase
)
:
voidSets the private key file passphrase of the user to scp
Parameters
| Name | Type | Description |
|---|---|---|
| $privkeyfilepassphrase |
setProject(
)
:
voidsetProperty(
string $property
)
:
voidSets the name of the property to capture (any) output of the command
Parameters
| Name | Type | Description |
|---|---|---|
| $property | string |
setPubkeyfile(
$pubkeyfile
)
:
voidSets the public key file of the user to scp
Parameters
| Name | Type | Description |
|---|---|---|
| $pubkeyfile |
setRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetUsername(
$username
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $username |