Generate session URL/code dialog is used to generate a session URL, a file URL or a code template.
To open the dialog to generate the session URL or code, use:
To open the dialog to generate a file transfer code:
To open the dialog to generate the file URL, use:
The dialog has three tabs. Each is described individually.
Use the URL tab to generate a session URL or a file URL. The tab is not available when generating a file transfer code.
The generated URL always includes a protocol and a host name portions. Other parts can be included optionally.
Check the User name to include username into the URL. The option is not available when the dialog is opened from the Login dialog and the user name was not specified; or (rarely) when the current session did not require the user name.
Check the Password to include password into the URL. Make sure you protect an URL that includes the password appropriately. The option is not available when the dialog is opened from the Login dialog and the password was not specified; or when the current session does not use a password authentication; or when the password was not stored nor remembered.
Check the SSH host key to include an SSH host key fingerprint into the URL. The option is available for an SFTP and an SCP (SSH-based) sessions only. The option is not available, if no session was opened to the host as the host key is not known yet. Note that some (most) SSH clients need not understand a session URL that includes the host key fingerprint.
Check the Initial directory to include an initial remote directory into the URL. When the dialog is opened from the Login dialog, Remote directory as specified on the Advanced site settings dialog is used. When opened from the main window, the current working remote directory is used. The option is not available when generating an URL for selected file(s) as a path to the file(s) is used instead.
Check the WinSCP-specific to generate an WinSCP-specific URL. Note that you need to enable the option with the WebDAV protocol, if you want WinSCP to handle the URL, as WinSCP never registers for the
Check the Save extension to include a save extension into the URL. As the extension is WinSCP-specific, the option WinSCP-specific should be selected along.
The generated URL(s) is shown in the bottom box. When generating an URL for a site, only one URL is displayed. When generating an URL for a selected file(s), one URL per a file is displayed.
Use the Script tab to generate a WinSCP script template for the session or the file transfer.
The script will include:
opencommand with the session URL and all other switches needed to configure the session.
lcdcommands to navigate to the source and destination folders of the transfer and the
getcommands to actually transfer the files (with all needed switches to setup any non-default transfer settings).
exitcommand to end the script.
Use the Format to select a format of the script to generate:
.bat) template that executes the
winscp.comwith the above commands, specified using the
/commandcommand-line switch. Additionally the batch file enables session logging using the
/logswitch and isolates the script run from a GUI configuration using the
/ini=nulswitch. At the end, the batch file checks WinSCP exit code to choose further actions to take; and propagates the WinSCP exit code to a batch file exit code using the
winscp.exe(but usable for
winscp.comtoo) with the above commands, session logging and configuration isolation (see the previous point). The command-line is suitable for task managers of all kinds, like Windows Scheduler or SSIS. Depending on your requirements, you may want prepend the
/consoleswitch to make the script console visible, while the script is running.
The script will not include options to verify the host key or certificate, if the session was not opened before yet. Open the session at least once, before generating the script.
You can click on script commands and switches and command-line switches to open their respective help pages.
Use the .NET assembly tab to generate a code template using WinSCP .NET assembly for the session or the file transfer.
The code will:
SessionOptionswith all properties needed to configure the session.
TransferOptionsclass instance will be constructed and set up, if any non-default transfer settings are used. The
OperationResultBase.Checkmethod will be called on results of the methods to throw an exception on any error.
Session.EscapeFileMaskmethod will be called to escape them.
Use the Language to select a language to generate the template for. Available languages are C#, VB.NET and PowerShell.
The code will not set properties to verify a host key (
SessionOptions.SshHostKeyFingerprint) or a certificate (
SessionOptions.TlsHostCertificateFingerprint), if the session was not opened before yet. Open the session at least once, before generating the code.
You can click on classes, methods and properties to open their respective help pages.
Use Copy to Clipboard to copy generated URL(s) or code to a clipboard.
Site design by Black Gate