api.vm.qga

/vm/(hostname_or_uuid)/qga/(command)

api.vm.qga.views.vm_qga(*args, **kwargs)

Run (PUT) a command via Qemu Guest Agent.

PUT /vm/(hostname_or_uuid)/qga/(command)

DC-bound?:

• ✓

Permissions:

• VmOwner

Asynchronous?:

• ✓

Parameters:

• hostname_or_uuid (string) – required - Server hostname or uuid
• command (string) –

  required - QGA command. Available commands are:

  • fsfreeze <status|freeze|thaw>
  • info
  • ping
  • sync
  • reboot
  • poweroff
  • get-time
  • set-time [epoch time in nanoseconds]
• data.params (array) – List of command parameters

Status Codes:

• 200 OK – SUCCESS
• 201 Created – PENDING
• 400 Bad Request – FAILURE
• 403 Forbidden – Forbidden
• 404 Not Found – VM not found
• 412 Precondition Failed – Invalid command
• 423 Locked – Node is not operational / VM is not operational
• 501 Not Implemented – Operation not supported

es example:

es set /vm/example.cust.erigones.com/qga/get-time

{
    "url": "https://my.erigones.com/api/vm/example.cust.erigones.com/qga/get-time",
    "status": 200,
    "method": "PUT",
    "text": {
        "status": "SUCCESS",
        "result": {
            "message": "1470161967939841000",
            "returncode": 0
        },
        "task_id": "0-a2327793-2600-423d-8f07"
    }
}