ssh_sync
Sync files or directories between a local machine and a remote host using rsync over SSH. Choose upload or download direction, preview changes with dry-run, and exclude or delete files as needed.
Instructions
Incrementally sync files or directories between the local machine and one remote target via local rsync over SSH.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | ||
| delete | No | Delete files in the destination that are not in the source. | |
| source | Yes | For upload: local path. For download: remote path (without host prefix). | |
| target | Yes | OpenSSH target (host alias or user@host). Specifies the remote host — do not include the host in source or destination. | |
| dry_run | No | Show what would be transferred without actually doing it. | |
| exclude | No | Glob patterns to exclude from the sync. | |
| timeout | No | Local timeout in seconds. | |
| compress | No | Compress data during transfer. Default: true. | |
| direction | Yes | ||
| destination | Yes | For upload: remote path. For download: local path. | |
| identity_file | No | ||
| extra_ssh_args | No | Additional ssh(1) flags passed verbatim, e.g. ["-J", "jumphost"]. Prefer the dedicated port, identity_file, and strict_host_key_checking parameters. | |
| extra_rsync_args | No | Additional rsync flags passed verbatim. | |
| known_hosts_file | No | ||
| strict_host_key_checking | No | Boolean or one of yes, no, ask, accept-new, off. |