Differences
This shows you the differences between the selected revisions of the page.
| 2023-05-23 | 2023-05-23 (current) | ||
| old revision restored (5.181.158.236) (hidden) (untrusted) | Restored revision 1655392419. Undoing revision 1684871517. (martin) (hidden) | ||
| Line 1: | Line 1: | ||
| - | 317 | + | ====== Scripting and Task Automation ====== |
| + | //This article contains detailed description of scripting/automation functionality. You may want to see [[guide_automation|simplified guide]] to the functionality instead.// | ||
| + | In addition to [[interfaces|graphical interface]], WinSCP offers scripting/console interface with many [[#commands|commands]]. The commands can be typed in interactively, or read from script file or another source. | ||
| + | Using scripting interface directly is recommended for simple tasks not requiring any control structures. For complex tasks, using [[library|WinSCP .NET assembly]] is preferred. | ||
| + | |||
| + | ~~AD~~ | ||
| + | |||
| + | &screenshotpict(scripting) | ||
| + | |||
| + | ===== [[using_scripting]] Using Scripting ===== | ||
| + | Enter the console/scripting mode by using ''[[executables|winscp.com]]''; or ''/console'' command-line parameter with ''[[executables|winscp.exe]]''. For details see [[commandline#scripting|console/scripting command-line parameters]]. | ||
| + | |||
| + | For automation, commands can be read from a script file specified by ''/script'' switch, passed from the command-line using the ''/command'' switch, or read from standard input of ''winscp.com''. | ||
| + | |||
| + | The script file must use UTF-8 or UTF-16 (with BOM) encoding. | ||
| + | |||
| + | When running commands specified using ''/script'' or ''/command'', batch mode is used implicitly and overwrite confirmations are turned off. In an interactive scripting mode, the user is prompted in the same way as in GUI mode. To force batch mode (all prompts are automatically answered negatively) use the command ''[[scriptcommand_option#batch|option batch abort]]''. For batch mode it is recommended to turn off confirmations using ''[[scriptcommand_option#confirm|option confirm off]]'' to allow overwrites (otherwise the [[ui_overwrite|overwrite confirmation prompt]] would be answered negatively, making overwrites impossible). | ||
| + | |||
| + | Multiple sessions can be opened simultaneously. Use the ''[[scriptcommand_session|session]]'' command to switch between them. | ||
| + | |||
| + | Note that the first connection to an SSH server requires [[#hostkey|verification of the host key]]. | ||
| + | Also the first connection to FTPS or WebDAVS host with [[tls#certificate|certificate]] signed by untrusted authority requires verification of the certificate. | ||
| + | |||
| + | ~~AD~~ | ||
| + | |||
| + | ===== [[result]] Checking Results ===== | ||
| + | WinSCP [[executables]] return exit code 1 when any command is interrupted due to an error or any prompt is answered //Abort// (even automatically in batch mode). Otherwise it returns the exit code 0. | ||
| + | |||
| + | To further analyze results of scripted operations, you will find [[logging_xml|XML logging]] useful. | ||
| + | |||
| + | //For more details, refer to [[faq_script_result|*]]// | ||
| + | |||
| + | |||
| + | ===== [[syntax]] Commands Syntax ===== | ||
| + | All WinSCP commands have syntax: | ||
| + | <code> | ||
| + | command -switch -switch2 parameter1 parameter2 ... parametern | ||
| + | </code> | ||
| + | |||
| + | ==== [[quotes]] Command Parameters with Spaces ==== | ||
| + | |||
| + | Command parameters that include space(s) have to be surrounded by double-quotes. To use double-quote literally, double it: | ||
| + | <code winscp> | ||
| + | put "file with spaces and ""quotes"".html" | ||
| + | </code> | ||
| + | |||
| + | Note that when you are specifying commands on [[commandline#scripting|command-line]] using ''/command'', you need to surround each command by double-quote and [[commandline#syntax|escape the in-command double-quotes by doubling them]]. | ||
| + | |||
| + | To debug the quoting, enable session logging on level //Debug 1// (''[[commandline#logging|/loglevel=1]]''). The log will show how WinSCP understands both your command-line and individual scripting commands. | ||
| + | |||
| + | |||
| + | ==== [[variables]] Environment Variables ==== | ||
| + | |||
| + | You can use environment variables in the commands, with syntax ''%NAME%'':((Generally do surround reference by double-quotes to cope properly with spaces in its value.)) | ||
| + | <code winscp> | ||
| + | put "%FILE_TO_UPLOAD%" | ||
| + | </code> | ||
| + | |||
| + | Note that variable expansion is different than in Windows batch files: | ||
| + | |||
| + | * You cannot use any [[https://en.wikibooks.org/wiki/Windows_Batch_Scripting#String_processing|string processing syntax]]. | ||
| + | * You cannot use [[wp>Environment_variable#Windows_2|dynamic/pseudo environment variables]], such as ''%DATE%'' or ''%RANDOM%''. | ||
| + | * References to undefined variables are kept intact (not removed). | ||
| + | * You can use ''%WINSCP_PATH%'' to refer to WinSCP [[executable]] path. | ||
| + | |||
| + | ==== [[timestamp]] Timestamp ==== | ||
| + | |||
| + | WinSCP automatically resolves ''%TIMESTAMP[rel]#format%'' to a real time (optionally to a past or future time) with the given format. The ''format'' may include ''yyyy'' for year, ''mm'' for month, ''dd'' for day, ''hh'' for hour, ''nn'' for minute and ''ss'' for second. For example, the ''%TIMESTAMP#yyyy-mm-dd%'' resolves to ''2016-06-22'' on 22 June 2016. See [[https://docwiki.embarcadero.com/Libraries/en/System.SysUtils.FormatDateTime|other formats you can use]]. | ||
| + | |||
| + | The optional ''rel'' part, with syntax ''[-+]time[YDHNS]'', produces past (''-'') or future (''+'') timestamps. One of the following units must be used: ''Y'' (years), ''D'' (days), ''H'' (hours), ''N'' (minutes) or ''S'' (seconds). For example, the ''%TIMESTAMP-1D#yyyy-mm-dd%'' (the ''-1D'' meaning one day in the past) resolves to ''2016-06-21'' on 22 June 2016. | ||
| + | |||
| + | To use ''<nowiki>%TIMESTAMP...%</nowiki>'' on a command-line in a batch file, you need to escape the ''%'' by doubling it to ''<nowiki>%%TIMESTAMP...%%</nowiki>'', to avoid a batch file interpreter trying to resolve the variable. | ||
| + | |||
| + | ==== [[arguments]] Script Arguments ==== | ||
| + | |||
| + | You can reference script arguments (passed on command-line using parameter ''[[commandline#scripting|/parameter]]'') using syntax ''%N%'', where ''N'' is ordinal number of argument:((Generally do surround reference by double-quotes to cope properly with spaces in its value.)) | ||
| + | <code winscp> | ||
| + | put "%1%" | ||
| + | </code> | ||
| + | |||
| + | ==== Case Sensitivity of File Names ==== | ||
| + | |||
| + | Note that WinSCP treats filenames in case sensitive manner. So even if your server treats filenames in case insensitive manner, make sure you specify case properly.((This is important particularly for FTP sessions.)) | ||
| + | |||
| + | ==== [[comments]] Comments ==== | ||
| + | |||
| + | To insert comments into the script file, start the line with ''#'' (hash): | ||
| + | <code winscp> | ||
| + | # Connect to the server | ||
| + | open mysession | ||
| + | </code> | ||
| + | |||
| + | ===== [[commands]] Commands ===== | ||
| + | The following commands are implemented. | ||
| + | |||
| + | To see help for the command, read respective documentation article below or type command ''[[scriptcommand_help|help <command>]]'' directly in console. | ||
| + | |||
| + | ^ Command ^ Description ^ | ||
| + | | [[scriptcommand_call|call]] | Executes arbitrary remote shell command | | ||
| + | | [[scriptcommand_cd|cd]] | Changes remote working directory | | ||
| + | | [[scriptcommand_checksum|checksum]] | Calculates checksum of remote file | | ||
| + | | [[scriptcommand_chmod|chmod]] | Changes permissions of remote file | | ||
| + | | [[scriptcommand_close|close]] | Closes session | | ||
| + | | [[scriptcommand_cp|cp]] | Duplicates remote file | | ||
| + | | [[scriptcommand_echo|echo]] | Prints message onto script output | | ||
| + | | [[scriptcommand_exit|exit]] | Closes all sessions and terminates the program | | ||
| + | | [[scriptcommand_get|get]] | Downloads file from remote directory to local directory | | ||
| + | | [[scriptcommand_help|help]] | Displays help | | ||
| + | | [[scriptcommand_keepuptodate|keepuptodate]] | Continuously reflects changes in local directory on remote one | | ||
| + | | [[scriptcommand_lcd|lcd]] | Changes local working directory | | ||
| + | | [[scriptcommand_lls|lls]] | Lists the contents of local directory | | ||
| + | | [[scriptcommand_ln|ln]] | Creates remote symbolic link | | ||
| + | | [[scriptcommand_lpwd|lpwd]] | Prints local working directory | | ||
| + | | [[scriptcommand_ls|ls]] | Lists the contents of remote directory | | ||
| + | | [[scriptcommand_mkdir|mkdir]] | Creates remote directory | | ||
| + | | [[scriptcommand_mv|mv]] | Moves or renames remote file | | ||
| + | | [[scriptcommand_open|open]] | Connects to server | | ||
| + | | [[scriptcommand_option|option]] | Sets or shows value of script options | | ||
| + | | [[scriptcommand_put|put]] | Uploads file from local directory to remote directory | | ||
| + | | [[scriptcommand_pwd|pwd]] | Prints remote working directory | | ||
| + | | [[scriptcommand_rm|rm]] | Removes remote file | | ||
| + | | [[scriptcommand_rmdir|rmdir]] | Removes remote directory | | ||
| + | | [[scriptcommand_session|session]] | Lists connected sessions or selects active session | | ||
| + | | [[scriptcommand_stat|stat]] | Retrieves attributes of remote file | | ||
| + | | [[scriptcommand_synchronize|synchronize]] | Synchronizes remote directory with local one | | ||
| + | |||
| + | ===== [[console]] The Console Interface Tool ===== | ||
| + | Learn about ''[[executables|winscp.com]]'', the console interface tool. | ||
| + | |||
| + | ===== [[hostkey]] Verifying the Host Key or Certificate in Script ===== | ||
| + | The first connection to an SSH server requires [[ssh_verifying_the_host_key|verification of the host key]]. To automate the verification in script, use ''[[scriptcommand_open#hostkey|-hostkey]]'' switch of ''[[scriptcommand_open|open]]'' command to accept the expected host key automatically. | ||
| + | |||
| + | You can find the key fingerprint on [[ui_fsinfo|Server and Protocol Information Dialog]]. You can also copy the key fingerprint to clipboard from the [[ssh_verifying_the_host_key|confirmation prompt]] on the first (interactive) connection using //Copy key fingerprints to clipboard// command (in the script, use SHA-256 fingerprint of the host key only). //Learn more about [[faq_hostkey|obtaining host key fingerprint]]//. | ||
| + | |||
| + | FTPS/WebDAVS [[tls#certificate|TLS/SSL certificate]] signed by untrusted authority may also need to be verified. To automate the verification in script, use ''[[scriptcommand_open#certificate|-certificate]]'' switch of ''[[scriptcommand_open|open]]'' command to accept the expected certificate automatically. | ||
| + | |||
| + | |||
| + | |||
| + | ===== [[different_account]] Running a Script under a Different Account (e.g., Using a Scheduler) ===== | ||
| + | If you are going to run the script under a different account (for example [[guide_schedule|using the Windows Task Scheduler]]), make sure the script does not rely on a configuration settings that might differ on the other account. When using registry as [[config|configuration storage]], the settings are accessible only for your Windows account. Ideally, make sure the script does not rely on any external configuration, to make it completely portable. Note that the configuration also includes [[#hostkey|verified SSH host keys]] and FTPS/WebDAVS [[tls#certificate|TLS/SSL certificates]]. | ||
| + | |||
| + | //For details, see the [[#configuration|next section]] and [[faq_environment|*]]// | ||
| + | |||
| + | ===== [[configuration]] Sharing Configuration with Graphical Mode ===== | ||
| + | In scripting/console mode, WinSCP shares [[config|configuration]] with [[interfaces|graphical mode]] by default. While this can be useful in some cases, it can also be a disadvantage. | ||
| + | |||
| + | The disadvantage is that change to configuration in graphical mode may break your script (common example is enabling //[[ui_synchronize|Existing files only]]// option for [[task_synchronize_full|synchronization]]). Also the script is not portable to other machines, when it relies on an external configuration. | ||
| + | |||
| + | If you want to protect your script from such inadvertent change or if you want to make the script portable, you should isolate its configuration from graphical mode explicitly. | ||
| + | |||
| + | The best way to do that is to configure all the options you need using script commands only (''[[scriptcommand_option|option]]'' command, switches of other commands, [[session_url|session URL]]), or if no such command is available, using [[rawsettings|raw site settings]] and [[rawconfig|raw configuration]]. Finally force scripting mode to [[config#no|start with the default configuration]] using ''[[commandline#configuration|/ini=nul]]'' command-line parameter. | ||
| + | |||
| + | Alternatively [[config#export|export your configuration]] to a separate INI file and reference it using ''[[commandline#configuration|/ini=]]'' command-line parameter. Also consider setting the INI file read-only, to prevent WinSCP writing to it, when exiting. Particularly, if you are running multiple scripts in parallel, to prevent different instances of WinSCP trying to write it at the same time. | ||
| + | |||
| + | ===== Generating Script ===== | ||
| + | |||
| + | You can have WinSCP [[ui_generateurl|generate a script template for you]]. | ||
| + | |||
| + | ===== [[example]] Example ===== | ||
| + | In the example below, WinSCP connects to ''example.com'' server with account ''user'', downloads file and closes the session. Then it connects to the same server with the account ''user2'' and uploads the file back. | ||
| + | <code winscp> | ||
| + | # Connect | ||
| + | open sftp://user:password@example.com/ -hostkey="ssh-rsa 2048 xxxxxxxxxxx..." | ||
| + | # Change remote directory | ||
| + | cd /home/user | ||
| + | # Download file to the local directory d:\ | ||
| + | get examplefile.txt d:\ | ||
| + | # Disconnect | ||
| + | close | ||
| + | # Connect as a different user | ||
| + | open sftp://user2:password@example.com/ | ||
| + | # Change the remote directory | ||
| + | cd /home/user2 | ||
| + | # Upload the file to current working directory | ||
| + | put d:\examplefile.txt | ||
| + | # Disconnect | ||
| + | close | ||
| + | # Exit WinSCP | ||
| + | exit | ||
| + | </code> | ||
| + | Save the script to the file ''example.txt''. To execute the script file use the following command. | ||
| + | <code batch> | ||
| + | winscp.com /ini=nul /script=example.txt | ||
| + | </code> | ||
| + | |||
| + | For simple scripts you can specify all the commands on [[commandline|command-line]] using ''/command'' switch: | ||
| + | <code batch> | ||
| + | winscp.com /ini=nul /command "open sftp://user:password@example.com/ -hostkey=""ssh-rsa 2048 xxxxxxxxxxx...""" "get examplefile.txt d:\" "exit" | ||
| + | </code> | ||
| + | |||
| + | In Windows batch file, you can use ''^'' to split too long command-line to separate lines by [[wp>Batch_file#Escaped_characters_in_strings|escaping]] following new-line character: | ||
| + | |||
| + | <code batch> | ||
| + | winscp.com /ini=nul /command ^ | ||
| + | "open sftp://user:password@example.com/ -hostkey=""ssh-rsa 2048 xxxxxxxxxxx...""" ^ | ||
| + | "get examplefile.txt d:\" ^ | ||
| + | "exit" | ||
| + | </code> | ||
| + | |||
| + | //See other [[scripts|useful example scripts]]//. | ||
| + | |||
| + | ===== Converting Script to Code Based on .NET Assembly ===== | ||
| + | When you find yourself limited by scripting capabilities, you may consider [[library_from_script|converting your script to code that uses WinSCP .NET assembly]]. | ||
| + | |||
| + | ===== Further Reading ===== | ||
| + | * [[guide_automation|Guide to scripting]]; | ||
| + | * [[faq#scripting|FAQs about scripting]]; | ||
| + | * [[scripts|Useful example scripts]]; | ||
| + | * [[library|WinSCP .NET assembly]]. | ||
| - | 1 | ||