PlinkSettings Class

Summary

Settings for Plink build.
Assembly
Cake.Putty.dll
Namespace
Cake.Putty
Base Types
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 : AutoToolSettings

Constructors

Name Summary
PlinkSettings()

Properties

Name Value Summary
AgentForwarding Nullable<bool>
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)
DontStartShellCommand bool
Don't start a shell/command (SSH-2 only).
DynamicPortForwarding string
[listen-IP:]listen-port Dynamic SOCKS-based port forwarding.
EnablePageant Nullable<bool>
Enables or disabled use of Pageant.
Hostkey string
Manually specify a host key (may be repeated).
IpVersion Nullable<IpVersion>
Force use of IPv4 or IPv6.
KeyFileForUserAuthentication FilePath
Private key file for user authentication.
LoadSettingsFromSavedSession 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<PlinkProtocol>
Force use of a particular protocol.
PtyAllocation Nullable<bool>
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<SshVersion>
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<bool>
Enable / disable X11 forwarding.

Extension Methods

Name Value Summary
Dump<PlinkSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<PlinkSettings>(PlinkSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PlinkSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<PlinkSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<PlinkSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<PlinkSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin