Copy Built-ins¶
Copy Built-ins copy files to a remote host using SSH.
For Windows users, local files using an absolute path must be specified with the local: prefix. Otherwise the command will interpret a drive letter as a hostname and produce an error message such as No ssh host configured with name: C.
Syntax
1 | copy(<source String>, <destination String>) |
Parameters
-
source - The source file's location, including its extension
-
destination - The path the source file will be copied to
Example
1 | copy("local:Myfile.txt", "myRemoteHost:/home/User/You") |
Additionally, a timeout parameter can be included.
Syntax
1 | copy(<source String>, <destination String>, <timeoutInMilliSeconds Number>) |
Parameter
- timeoutInMilliseconds - The timeout value in milliseconds
- Default value for a timeout is set to
300seconds (300,000 milliseconds)
- Default value for a timeout is set to
Example
1 | copy("Myfile.txt", "/home/User/You", 5000) |