PscpSettings Class


Settings for Pscp build.
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Putty/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["PscpSettings"] class Type type-node


public sealed class PscpSettings : AutoToolSettings


Name Summary


Name Value Summary
Batch bool
Disable all interactive prompts.
Compression bool
Enable compression.
CopyDirectoriesRecursively bool
Copy directories recursively.
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.
Password string
Login with specified password.
Port int
Connect to specified port.
PreserveFiltAttributes bool
Preserve file attributes.
Protocol Nullable<Protocol>
Force use of SFTP or SCP protocol.
SshVersion Nullable<SshVersion>
Force use of particular SSH protocol version.
Unsafe bool
Allow server-side wildcards (DANGEROUS).
User string
Connect with specified username.

Extension Methods

Name Value Summary
Dump<PscpSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<PscpSettings>(PscpSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PscpSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<PscpSettings>(string) void
Requires the Cake.Issues addin
ThrowIfNull<PscpSettings>(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
ThrowIfNull<PscpSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin