ssh_download
DestructiveIdempotent
Copy a file or directory from a remote server to your local machine, using sha256 checks to ensure data integrity, including root-owned files via temporary staging.
Instructions
Copies a file or directory from a server to this machine. Data lands under a temporary name and takes its place in one rename, and every file is checked by sha256 on both sides; a machine without sha256 answers 'unavailable', which means delivered, not broken. A root-owned copy stages in /tmp on the server, so it needs room there. To read a text file rather than keep it, ssh_file_read skips the disk.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sudo | No | For /root and the like. A root copy stages in /tmp, is fetched and removed — the machine needs room. Default: false | |
| verify | No | sha256 on both sides, per file. "unavailable" = no sha256 on the machine = delivered, not broken. Default: true | |
| profile | Yes | Machine name. | |
| timeout | No | Milliseconds. No ceiling by default — a transfer runs as long as it takes. | |
| recursive | No | Only to force it — a directory is recognised on its own. | |
| local_path | Yes | Where it lands on this machine. | |
| remote_path | Yes | What to fetch from the server. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| files | No | ||
| legend | No | What the words in this answer mean. A key names the field before the value — "state=limited", "jobs[].state=lost" — and only the values this answer actually used are listed. |