Receive File
tm_inventory_receive_fileReceive a file from remote hosts in a YAML inventory group to a local path, enabling bulk retrieval of files across one host or the whole group.
Instructions
Receive file (tm_inventory). Bulk inventory operations against YAML host groups.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cfg | No | Local SSH config path (copy_ssh_config). | |
| cmd | No | Shell command (run_command). | |
| key | No | Shared key path (configure_key_auth). | /app/.ssh/id_ed25519 |
| host | No | run_command only. Optional single-host alias to target instead of the whole 'group' fan-out — the safe way to reach ONE inventory host (e.g. 'gb10') without running against 'homelab'. Resolved and authorized through the same alias store tm_remote/tm_hosts use, so the two are one source of truth: an unknown or unauthorized alias is rejected outright, never silently skipped. Takes precedence over 'group' when set. | |
| group | No | Target group. | all |
| lpath | No | Local file path (send_file). | |
| rpath | No | Remote file path (send_file/receive_file). | |
| key_pfx | No | Prefix for new keys (rotate_key). | /root/.ssh/id_ |
| preview | No | run_command only. If true, resolve the exact target host(s) for 'host'/'group' and return them in 'resolved_hosts' WITHOUT running 'cmd' — lets a caller verify scope before executing for real (no surprise fan-out). The real (non-preview) response also always includes 'resolved_hosts' for the same reason. | |
| rmt_cfg | No | Remote config path (copy_ssh_config). | /root/.ssh/config |
| timeout | No | Command timeout in seconds. | |
| key_type | No | Key type: rsa or ed25519. | ed25519 |
| parallel | No | Run parallel. | |
| inventory | No | YAML inventory path (default: $XDG_CONFIG_HOME/agent-connectors/inventory.yaml). | /root/.config/agent-connectors/inventory.yml |
| max_threads | No | Max threads. | |
| lpath_prefix | No | Local dir prefix (receive_file). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||