This is an old revision of the document!
Raw Site Settings
You can use raw site settings to setup advanced site settings,
- in scripting, using
-rawsettingsswitch of scripting commandopen(when the settings that cannot be configured using session URL nor using any dedicated switch of the command); - in .NET assembly, using
SessionOptions.AddRawSettingsmethod (when the settings cannot be configured using any dedicated property ofSessionOptionsclass).
Advertisement
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 |
Preferred SSH protocol version | 0 = SSH-1 only, 1 = SSH-1 preferred, 2 = SSH-2 preferred, 3 = SSH-2 only |
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 |
AuthKI |
Attempt keyboard-interactive authentication | 0 = Disabled, 1 = Enabled |
AuthGSSAPI |
Attempt GSSAPI authentication | 0 = Disabled, 1 = Enabled |
FtpAccount |
FTP account | |
FtpForcePasvIp |
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 | |
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, 3 = Auto |
Shell |
Shell (SCP protocol) | |
LocalDirectory |
Local Directory2 | |
ConsiderDST |
Daylight Saving Time | 0 = Adjust remote timestamp with DST, 1 = Adjust remote timestamp to local conventions, 2 = Preserve remote timestamp |
SFTPMaxVersion |
Preferred SFTP protocol version | 0-5 = SFTP version number |
SendBuf |
Optimize connection buffer size | 0 = Off, Any positive value = On, value indicates size of the buffer, with recommended value of 262144 |
EOLType |
End-of-line characters | 0 = LF, 1 = CRLF |
Advertisement
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.
Example
For example to enable HTTP proxy, in scripting:
open <session_url> -rawsettings ProxyMethod=3 ProxyHost=proxy
or in .NET assembly (using PowerShell):
$session.AddRawSettings("ProxyMethod", "3") $session.AddRawSettings("ProxyHost", "proxy")
- Enabling keepalives has very limited effect in scripting (except for
keepuptodatecommand) and almost no effect in .NET assembly.Back - Note that Remote Directory can be set using session URL, you do not need to use raw site settings for it.Back