Executing commands in virtual machines

The guest-agent API allows executing commands and transferring files inside a virtual machine guest operating system.

The command object is available only for approximately 5–10 minutes after execution and is automatically deleted afterwards.

Only users with the guest_exec role can perform these operations.

To use this API, supported guest tools (vz-tools or standard QEMU guest agent tools) must be installed and running inside the guest operating system. If guest tools are not available or the corresponding commands are disabled in the guest, the operation fails.