Differences
This shows you the differences between the selected revisions of the page.
| 2011-12-09 | 2011-12-09 | ||
| no summary (203.190.151.114) (hidden) | Restored revision 1322165954. Undoing revisions 1323437056, 1323437094, 1323437135, 1323437155. (martin) (hidden) | ||
| Line 21: | Line 21: | ||
| ~~AD~~ | ~~AD~~ | ||
| + | ===== Checking Results ===== | ||
| + | WinSCP returns 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.((When checking WinSCP exit code from batch file, make sure you are using [[executables|winscp.com]].)) | ||
| + | To further analyze results of scripted operations, you will find [[logging_xml|XML logging]] useful. | ||
| ===== [[syntax]] Commands Syntax ===== | ===== [[syntax]] Commands Syntax ===== | ||
| Line 46: | Line 49: | ||
| 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.)). | 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.)). | ||
| + | ===== 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_chmod|chmod]] | Changes permissions of remote file | | ||
| + | | [[scriptcommand_close|close]] | Closes session | | ||
| + | | [[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_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 ===== | ===== [[hostkey]] Verifying the Host Key or Certificate in Script ===== | ||
| Line 64: | Line 97: | ||
| Note that the configuration also includes [[scripting#hostkey|verified SSH host keys]]. | Note that the configuration also includes [[scripting#hostkey|verified SSH host keys]]. | ||
| + | ===== Example ===== | ||
| + | The example below 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> | ||
| + | # Automatically abort script on errors | ||
| + | option batch abort | ||
| + | # Disable overwrite confirmations that conflict with the previous | ||
| + | option confirm off | ||
| + | # Connect using a password | ||
| + | # open sftp://user:password@example.com -hostkey="ssh-rsa 1024 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx" | ||
| + | # Connect | ||
| + | open sftp://user@example.com -hostkey="ssh-rsa 1024 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx" | ||
| + | # Change remote directory | ||
| + | cd /home/user | ||
| + | # Force binary mode transfer | ||
| + | option transfer binary | ||
| + | # Download file to the local directory d:\ | ||
| + | get examplefile.txt d:\ | ||
| + | # Disconnect | ||
| + | close | ||
| + | # Connect as a different user | ||
| + | open user2@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. As the script connects the session itself, using the command ''open'', omit the ''session'' command-line parameter. | ||
| + | <code> | ||
| + | winscp.exe /console /script=example.txt | ||
| + | </code> | ||
| + | |||
| + | For simple scripts you can specify all the commands on [[commandline|command-line]] using ''/command'' switch: | ||
| + | <code> | ||
| + | winscp.exe /console /command "option batch abort" "open user@example.com" "get examplefile.txt d:\" "exit" | ||
| + | </code> | ||
| + | |||
| + | Instead of using ''open'' command you can also open a session using a [[commandline|command-line parameter]]. Note that in that case session is opened yet before script starts. Particularly ''option'' commands do not apply yet. Generally you should avoid using this method. | ||
| + | <code> | ||
| + | winscp.exe /console /script=example.txt user@example.com | ||
| + | </code> | ||
| + | |||
| + | ===== Further Reading ===== | ||
| + | * [[guide_automation|Guide to scripting]]; | ||
| + | * [[faq#scripting_automation|FAQs about scripting]]; | ||
| + | * [[scripts|Useful example scripts]]. | ||