Get-PveNodesQemuAgentFileRead
Reads the given file via guest agent. Is limited to 16777216 bytes.
API: GET /nodes/{node}/qemu/{vmid}/agent/file-read, Proxmox VE API viewer
Syntax
Section titled “Syntax”Get-PveNodesQemuAgentFileRead [-PveTicket <PveTicket>] [-Count <int>] [-Decode <bool>] -File <string> -Node <string> [-Offset <int>] -Vmid <int> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Count |
int |
No | Number of bytes to read. |
-Decode |
bool |
No | Data received from the QEMU Guest-Agent is base64 encoded. If this is set to true, the data is decoded. Otherwise the content is forwarded with base64 encoding. Defaults to true. |
-File |
string |
Yes | The path to the file. |
-Node |
string |
Yes | The cluster node name. |
-Offset |
int |
No | Offset to start reading at. |
-Vmid |
int |
Yes | The (unique) ID of the VM. |
Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.
Output
Section titled “Output”A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.
