Differences
This shows you the differences between the selected revisions of the page.
| 2016-02-04 | 2016-07-29 | ||
| hashtable style sessionoptions initilization (martin) | 5.9 stable released (martin) | ||
| Line 11: | Line 11: | ||
| Establishes connection to given host. Use [[session_url|session URL]] or name of the [[session_configuration#site|site]]. To open site, stored in folder, use path syntax “folder/site”. Using session URL is preferred as it makes your script [[scripting#configuration|independent on the persisted configuration]]. With session %%URL%%, you typically specify a protocol, host name, username and password, optionally also a port number and SSH host key fingerprint. | Establishes connection to given host. Use [[session_url|session URL]] or name of the [[session_configuration#site|site]]. To open site, stored in folder, use path syntax “folder/site”. Using session URL is preferred as it makes your script [[scripting#configuration|independent on the persisted configuration]]. With session %%URL%%, you typically specify a protocol, host name, username and password, optionally also a port number and SSH host key fingerprint. | ||
| - | You can use //[[ui_generateurl|Generate Session URL/Code]]// command to generate the ''open'' command for a given stored site. &beta_feature | + | You can use //[[ui_generateurl|Generate Session URL/Code]]// command to generate the ''open'' command for a given stored site. |
| Note that to allow the session be opened automatically without interaction, you need to make sure you provide all details, including all credentials. Generally, you need to provide a password in your [[session_url|session URL]] or [[session_configuration#site|site]]. With [[ssh|SSH]] you may alternatively use private key. With SSH, [[ftps|FTPS]] or WebDAVS you need to [[scripting#hostkey|verify the host or certificate]]. | Note that to allow the session be opened automatically without interaction, you need to make sure you provide all details, including all credentials. Generally, you need to provide a password in your [[session_url|session URL]] or [[session_configuration#site|site]]. With [[ssh|SSH]] you may alternatively use private key. With SSH, [[ftps|FTPS]] or WebDAVS you need to [[scripting#hostkey|verify the host or certificate]]. | ||
| Line 19: | Line 19: | ||
| | ''-==privatekey===%%<file>%%'' | [[public_key#private|SSH private key]] path. \\ [[SFTP]] and [[SCP]] protocols only. | | | ''-==privatekey===%%<file>%%'' | [[public_key#private|SSH private key]] path. \\ [[SFTP]] and [[SCP]] protocols only. | | ||
| | ''-==hostkey===%%"<fingerprint>"%%'' | Specifies fingerprint of expected [[ssh_verifying_the_host_key|SSH host key]] (or several alternative fingerprints separated by semicolon). It makes WinSCP automatically [[scripting#hostkey|accept host key]] with the fingerprint. As the host key fingerprint contains spaces you need to surround it by quotes. //Learn how to [[faq_hostkey|obtain host key fingerprint]]//. \\ In exceptional situations, when security is not required, you can use value ''*'' to accept any host key. In this case, script output and log file will include warning about insecure connection. \\ [[SFTP]] and [[SCP]] protocols only. | | | ''-==hostkey===%%"<fingerprint>"%%'' | Specifies fingerprint of expected [[ssh_verifying_the_host_key|SSH host key]] (or several alternative fingerprints separated by semicolon). It makes WinSCP automatically [[scripting#hostkey|accept host key]] with the fingerprint. As the host key fingerprint contains spaces you need to surround it by quotes. //Learn how to [[faq_hostkey|obtain host key fingerprint]]//. \\ In exceptional situations, when security is not required, you can use value ''*'' to accept any host key. In this case, script output and log file will include warning about insecure connection. \\ [[SFTP]] and [[SCP]] protocols only. | | ||
| - | | ''-==clientcert===%%<file>%%'' | [[tls#client_certificate|TLS/SSL client certificate]] path. &beta_feature \\ [[ftps|FTPS]] and [[webdav|WebDAVS]] protocols only. | | + | | ''-==clientcert===%%<file>%%'' | [[tls#client_certificate|TLS/SSL client certificate]] path. \\ [[ftps|FTPS]] and [[webdav|WebDAVS]] protocols only. | |
| | ''-==certificate===%%"<fingerprint>"%%'' | Specifies fingerprint of expected [[tls#certificate|TLS/SSL certificate]] (or several fingerprints separated by semicolon). It makes WinSCP automatically [[scripting#hostkey|accept certificate]] with the fingerprint. \\ In exceptional situations, when security is not required, you can use value ''*'' to accept any certificate. In this case, script output and log file will include warning about insecure connection. \\ [[ftps|FTPS]] and [[webdav|WebDAVS]] protocols only. | | | ''-==certificate===%%"<fingerprint>"%%'' | Specifies fingerprint of expected [[tls#certificate|TLS/SSL certificate]] (or several fingerprints separated by semicolon). It makes WinSCP automatically [[scripting#hostkey|accept certificate]] with the fingerprint. \\ In exceptional situations, when security is not required, you can use value ''*'' to accept any certificate. In this case, script output and log file will include warning about insecure connection. \\ [[ftps|FTPS]] and [[webdav|WebDAVS]] protocols only. | | ||
| | ''-==passphrase===<phrase>'' | Passphrase for encrypted private keys and client certificates. \\ SFTP, SCP, FTPS and WebDAVS protocols only. | | | ''-==passphrase===<phrase>'' | Passphrase for encrypted private keys and client certificates. \\ SFTP, SCP, FTPS and WebDAVS protocols only. | | ||
| Line 27: | Line 27: | ||
| | ''-==timeout===<sec>'' | Server response timeout | | | ''-==timeout===<sec>'' | Server response timeout | | ||
| | ''-==rawsettings== setting1=value1 setting2=value2 ...'' | Allows configuring any site settings using [[rawsettings|raw format]] as in an INI file. E.g. to enable SSH compression and agent forwarding use ''-rawsettings Compression=1 AgentFwd=1''. The switch must come after session URL. | | | ''-==rawsettings== setting1=value1 setting2=value2 ...'' | Allows configuring any site settings using [[rawsettings|raw format]] as in an INI file. E.g. to enable SSH compression and agent forwarding use ''-rawsettings Compression=1 AgentFwd=1''. The switch must come after session URL. | | ||
| - | | ''-==filezilla=='' | Load ''site'' from FileZilla site manager.((WinSCP looks for sites in ''C:\Users\username\AppData\Roaming\FileZilla\sitemanager.xml''. &winpath)) \\ Additionally it prints a full syntax to use to open an identical session without relying on an external FileZilla configuration. &beta_feature | | + | | ''-==filezilla=='' | Load ''site'' from FileZilla site manager.((WinSCP looks for sites in ''C:\Users\username\AppData\Roaming\FileZilla\sitemanager.xml''. &winpath)) \\ Additionally it prints a full syntax to use to open an identical session without relying on an external FileZilla configuration. | |
| XML log element: ''[[logging_xml|session]]'' | XML log element: ''[[logging_xml|session]]'' | ||