This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.SFTP.
Summary
All needed settings to connect to the SFTP Server
It is important to either use the KeyFile or the Key property, not both. Leave the unused property empty.
If you only want to use a username/password combo leave both KeyFile and Key properties empty.
- Assembly
- Cake
.SFTP .dll - Namespace
- Cake
.SFTP - Base Types
-
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
Type["SFTPSettings"]
class Type type-node
Syntax
public class SFTPSettings : ToolSettingsAttributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute |
Constructors
| Name | Summary |
|---|---|
| SFTPSettings |
The constructor |
| SFTPSettings |
The constructor |
| SFTPSettings |
The constructor |
| SFTPSettings |
The constructor |
Properties
| Name | Value | Summary |
|---|---|---|
| Host | string |
The SFTP Server URL
|
| Key | string |
This is the string containing the private key
|
| KeyFile | string |
This is the path to the private key file on you local computer
|
| Password | string |
The Password on the server
|
| Port | int |
The port of the SFTP Server, is 22 by default
|
| UserName | string |
The User Name on the server
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|