Raw Site Settings

You can use raw site settings to setup advanced site settings.

In scripting, use -rawsettings switch of scripting command open (when the settings cannot be configured using session URL nor using any dedicated switch of the command).

In .NET assembly, use SessionOptions.AddRawSettings method (when the settings cannot be configured using any dedicated property of SessionOptions class).

For both cases, you can just configure the advanced settings on Advanced Site Settings dialog and have WinSCP generate the code for you.

You will also use raw site settings syntax to mass-modify stored sites using /batchsettings command-line parameter.

Common Advanced Settings

Name Description Values
PingType Keepalives1) 0 = Off, 1 = Sending of null SSH packets, 2 = Executing dummy protocol commands
PingIntervalSecs Seconds between keepalives
ProxyMethod Proxy type 0 = None, 1 = SOCKS4, 2 = SOCKS5, 3 = HTTP, 4 = Telnet (SFTP/SCP protocols only), 5 = Local (SFTP/SCP), For additional options with FTP protocol, see FtpProxyLogonType
ProxyHost Proxy host name
ProxyPort Proxy port number
ProxyUsername Proxy username
ProxyPassword Proxy password
FtpProxyLogonType FTP proxy types 1 = SITE %host, 2 = USER %proxyuser, USER %user@%host, 3 = OPEN %host, 4 = USER %proxyuser, USER %user, 5 = USER %user@%host, 6 = USER %proxyuser@%host, 7 = USER %user@%host %proxyuser, 8 = USER %user@%proxyuser@%host
ProxyDNS Do DNS name lookup at proxy end 0 = Off, 1 = On, 3 = Auto
ProxyLocalhost Consider proxying local host connections 0 = Off, 1 = On
ProxyTelnetCommand Telnet proxy command
ProxyLocalCommand Local proxy command
Compression SSH session compression 0 = Disabled, 1 = Enabled
SshProt SSH protocol version 0 = SSH-1, 3 = SSH-2
SshNoUserAuth Bypass authentication entirely 0 = Disabled, 1 = Enabled
Cipher SSH encryption cipher selection policy Comma-separated list of cipher preference order, where names of ciphers are aes, blowfish, 3des, arcfour and des. Token WARN is used to delimit substandard ciphers. Example: blowfish,aes,3des,WARN,arcfour,des
KEX Key exchange algorithm selection policy Comma-separated list of KEX preference order, where names of KEXes are ecdh, dh-gex-sha1, dh-group14-sha1, rsa, and dh-group1-sha1. Token WARN is used to delimit substandard KEXes. Example: ecdh,dh-gex-sha1,dh-group14-sha1,rsa,WARN,dh-group1-sha1
AuthKI Attempt keyboard-interactive authentication 0 = Disabled, 1 = Enabled
AuthGSSAPI Attempt GSSAPI authentication 0 = Disabled, 1 = Enabled
TryAgent Attempt Authentication Using Pageant 0 = Disabled, 1 = Enabled
FtpAccount FTP account
FtpForcePasvIp2 Force IP address for passive mode connections 0 = On, 1 = Off, 2 = Auto
FtpUseMlsd Use MLSD command for directory listing 0 = On, 1 = Off, 2 = Auto
Tunnel Connection tunneling 0 = Disabled, 1 = Enabled
TunnelHostName Tunnel host name
TunnelPortNumber Tunnel port number
TunnelUserName Tunnel user name
TunnelPasswordPlain Tunnel password
TunnelHostKey Fingerprint of expected SSH tunnel host key
TunnelPublicKeyFile Path to tunnel private key file
Utf UTF-8 Encoding for Filenames 0 = Off, 1 = On, 2 = Auto
Shell Shell (SCP protocol)
LookupUserGroups2 Lookup user groups 0 = On, 1 = Off, 2 = Auto
LocalDirectory Local Directory2)
TimeDifference Time zone offset Hexadecimal representation of 64-bit IEEE 754 floating point number (double), representing the offset in days.
Example: 555555555555A5BF = -1 hour3)
ConsiderDST Daylight Saving Time 0 = Adjust remote timestamp with DST, 1 = Adjust remote timestamp to local conventions, 2 = Preserve remote timestamp
ResolveSymlinks Resolve symbolic links 0 = Disabled, 1 = Enabled
FollowDirectorySymlinks Follow symbolic links to directories 0 = Disabled, 1 = Enabled
SftpServer Path to SFTP server binary For example sudo su -c /bin/sftp-server
SFTPMaxVersion Preferred SFTP protocol version 0-5 = SFTP version number
MinTlsVersion Minimum TLS/SSL version 3 = SSL 3.0, 10 = TLS 1.0, 11 = TLS 1.1, 12 = TLS 1.2
MaxTlsVersion Maximum TLS/SSL version See MinTlsVersion
SendBuf Optimize connection buffer size 0 = Off, Any positive value = On, value indicates size of the buffer, with recommended value of 262144
The SshSimple may need to be set to 1 to disable some of the optimizations, that unchecking the GUI option disables.
EOLType End-of-line characters 0 = LF, 1 = CRLF
PostLoginCommands FTP Post login commands If you need to execute multiple commands, separate them by new-line (line-feed, hexadecimal UTF-8 code 0A). I.e. in scripting use %0A (-rawsettings PostLoginCommands=CMD1%0ACMD2), in C# use \n, in PowerShell use `n

Other Settings

To find correct syntax for settings not listed above, configure the setting in the GUI, store it into a site, save configuration to an INI file and use the same syntax as you find an INI file.

Advertisements:

Example

For example to enable HTTP proxy, in scripting:

open <session_url> -rawsettings ProxyMethod=3 ProxyHost=proxy

or in .NET assembly (using PowerShell):

$sessionOptions.AddRawSettings("ProxyMethod", "3")
$sessionOptions.AddRawSettings("ProxyHost", "proxy")
1) Enabling keepalives has very limited effect in scripting (except for keepuptodate command) and almost no effect in .NET assembly.
2) Note that Remote Directory can be set using session URL, you do not need to use raw site settings for it.
3) In C# you can calculate -1 hour offset using: string.Join("", BitConverter.GetBytes(TimeSpan.FromHours(-1).TotalDays).Select(b => b.ToString("X2"))).
 
  rawsettings.txt · Last modified: by martin
 

Search Documentation

This page

Donate

About donations

$9   $19   $49   $99

About donations

Recommend

Associations

Site design by Black Gate