New-PveNodesQemuAgent
Execute QEMU Guest Agent commands.
API: POST /nodes/{node}/qemu/{vmid}/agent, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveNodesQemuAgent [-PveTicket <PveTicket>] -Command <string> -Node <string> -Vmid <int> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Command |
string |
Yes | The QGA command. Values: fsfreeze-freeze, fsfreeze-status, fsfreeze-thaw, fstrim, get-fsinfo, get-host-name, get-memory-block-info, get-memory-blocks, get-osinfo, get-time, get-timezone, get-users, get-vcpus, info, network-get-interfaces, ping, shutdown, suspend-disk, suspend-hybrid, suspend-ram. |
-Node |
string |
Yes | The cluster node name. |
-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.
