file.send
Queues a server-to-client file transfer.
Allowed Sources
Lanview ConsoleLocal Server ConsoleBatchDescription
Queues a server-to-client file transfer. Creates a tracked file transfer and durable server transfer state under Server\\Transfers. If /cache is used, Server sends the existing cached payload without Studio re-uploading it. Duplicate cached file names are refused as ambiguous; use PayloadId in that case. If no destination is supplied, the Client uses its service temp location, which may resolve to C:\\WINDOWS\\SystemTemp when running as SYSTEM. If the destination exists and /overwrite is omitted, the Client refuses the transfer. Server upload cache is where Studio uploads files to the Server; file.send destination is where the target Client writes the file. R5 supports resume after server restart when source metadata, server durable state, client sidecar state, and the partial file all validate.
Syntax
file.send "<server file path>" to <deviceId|machineName> ["<destination path>"] [/overwrite] OR file.send /cache <PayloadId|FileName> to <deviceId|machineName> ["<destination path>"] [/overwrite]Parameters
| Parameter | Use | Description |
|---|---|---|
<server file path> | Required | Existing server-side file. /cache <PayloadId|FileName> Reuse a completed Server cache payload from file.cache.list by PayloadId, unique short PayloadId, or exact original file name. |
<deviceId|machineName> | Required | Approved connected target. |
<destination path> | Required | Optional client destination path. /overwrite Allows replacing an existing destination file. /delayms Development/test delay between chunks, 0-10000 ms. /stopafterbytes Development/test stop after a positive byte count. |
<PayloadId|FileName> | Required | Reuse a completed Server cache payload from file.cache.list by PayloadId, unique short PayloadId, or exact original file name. <deviceId|machineName> Approved connected target. <destination path> Optional client destination path. |
/overwrite | Optional | Allows replacing an existing destination file. /delayms Development/test delay between chunks, 0-10000 ms. /stopafterbytes Development/test stop after a positive byte count. |
/cache | Required for one syntax form | <PayloadId|FileName> Reuse a completed Server cache payload from file.cache.list by PayloadId, unique short PayloadId, or exact original file name. <deviceId|machineName> Approved connected target. <destination path> Optional client destination path. /overwrite Allows replacing an existing destination file. /delayms Development/test delay between chunks, 0-10000 ms. /stopafterbytes Development/test stop after a positive byte count. |
Permissions
packages.publishAudit Events
CommandCommandResultReceivedCommandResultReceivedServer, Client and Studio Involvement
Needs review
Common Issues
- The command may require an authenticated server console or named-pipe admin console session.
- Targeted commands may fail if a device is offline, unapproved or not eligible.
Troubleshooting Notes
Needs review.