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.Putty.
Summary
Settings for Plink build.
- Assembly
- Cake
.Putty .dll - Namespace
- Cake
.Putty - Base Types
-
- ToolSettings
- AutoToolSettings
graph BT
Type-->Base0["AutoToolSettings"]
click Base0 "/api/Cake.Putty/AutoToolSettings"
Base0-->Base1["ToolSettings"]
Type["PlinkSettings"]
class Type type-node
Syntax
public sealed class PlinkSettings : AutoToolSettingsConstructors
| Name | Summary |
|---|---|
| PlinkSettings |
Properties
| Name | Value | Summary |
|---|---|---|
| AgentForwarding | Nullable |
Enable / disable agent forwarding.
|
| Batch | bool |
Disable all interactive prompts.
|
| Compression | bool |
Enable compression.
|
| ConfigurationString | string |
configuration-string (e.g. 19200,8,n,1,X)
|
| Dont |
bool |
Don't start a shell/command (SSH-2 only).
|
| Dynamic |
string |
[listen-IP:]listen-port
Dynamic SOCKS-based port forwarding.
|
| EnablePageant | Nullable |
Enables or disabled use of Pageant.
|
| Hostkey | string |
Manually specify a host key (may be repeated).
|
| IpVersion | Nullable |
Force use of IPv4 or IPv6.
|
| Key |
FilePath |
Private key file for user authentication.
|
| Load |
string |
Load settings from saved session.
|
| LocalPortForwarding | string |
[listen-IP:]listen-port:host:port
Forward local port to remote address.
|
| Password | string |
Login with specified password.
|
| Port | int |
Connect to specified port.
|
| Protocol | Nullable |
Force use of a particular protocol.
|
| PtyAllocation | Nullable |
Enable / disable pty allocation.
|
| RemoteCommandsFile | string |
Remote command is an SSH subsystem (SSH-2 only).
|
| RemotePortForwarding | string |
[listen-IP:]listen-port:host:port
Forward remote port to local address.
|
| SshVersion | Nullable |
Force use of particular SSH protocol version.
|
| Tunnel | string |
host:port
Open tunnel in place of session(SSH-2 only).
|
| User | string |
Connect with specified username.
|
| X11Forwarding | Nullable |
Enable / disable X11 forwarding.
|
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
|