Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

SSHHelper

Conatins a task which allows to perform SSH operations

Nested types and modules

TypeDescription
SSHParams
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

The SSH parameter type.

Functions and values

Function or valueDescription
SSH setParams command
Signature: setParams:(SSHParams -> SSHParams) -> command:string -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Performs a command via SSH.

Parameters

  • setParams - Function used to manipulate the default SSHParams value.
  • command - The target path. Can be something like user@host:directory/TargetFile or a local path.

Sample

1: 

SSH (fun p -> { p with ToolPath = "tools/ssh.exe" }) command
SSHDefaults
Signature: SSHParams
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

The SSH default parameters