Proxmox 8 API agent/exec changes

[BelCloud]

Hello

I have noticed that in Proxmox 8, the <command> parameter for the API call POST /api2/json/nodes/{node}/qemu/{vmid}/agent/exec has been changed from <string> to <array> in the format: [string, ...]

Does anyone have a working example with the new format?

I have tried to send it as array, but the format doesn't seem to be recognized by the API:

array(2) {
  ["data"]=>
  NULL
  ["errors"]=>
  array(3) {
    ["command[0]"]=>
    string(85) "property is not defined in schema and the schema does not allow additional properties"
    ["command[1]"]=>
    string(85) "property is not defined in schema and the schema does not allow additional properties"
    ["command"]=>
    string(42) "property is missing and it is not optional"
  }
}

On the old format "command arg1 arg2", I'm just receiving null.

Thank you

 

[mira]

Can you provide an actual example of your usage of the API?

Based on the API Viewer [0] it should just be a list containing the command, followed by the arguments: ['cmd', 'arg1', 'arg2', ...]
I've used `pvesh` to test it, but passing `--comand` with an array argument worked.


[0] https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/agent/exec

 

[mira]

Do you have the actual call somewhere available in JSON format?
That could help narrow down where the issue lies. Sadly I don't have experience with PHP.

 

[BelCloud]

Thank you for the reply!

With curl, it should be something like this:

curl -sSk -H 'Authorization: PVEAPIToken=TOKEN' -X POST --data command[]="/bin/bash"  --data command[]="/tmp/myscript" https://HOST:8006/api2/json/nodes/NODE/qemu/100/agent/exec

But it returns the same error as with my php library.
I assume that the command needs to be in another format. Does it work only as json?

 

[mira]

If I understand that correctly, you're sending multiple arrays.
But the command should be a single array containing multiple strings: ['cmd', 'arg1', 'arg2']
In JSON this would be something like "command": ["cmd", "arg1", "arg2"]

 

[BelCloud]

In theory, it's a single array called command, that's how it's normally done when sending a POST with urlencode data.
The exact JSON counterpart of the above request is {"command":["\/bin\/bash","\/tmp\/myscript"]} , but sending it as JSON will require modifying all existing Proxmox libraries from urlencode to json.

 

[mira]

It looks like -d 'command=/bin/bash&command=/tmp/myscript' would work, and -d 'command=/bin/bash' -d 'command=/tmp/myscript'

 

[BelCloud]

Thank you very much!

Do you know if there are any other planned changes to this function, as parameters? As it's a breaking change from 7 to 8 and the new implementation will create a lot of issues in existing libraries.


It might be better to deprecate the command parameter and create a new one with the array.

 

[fiona]

Related entry on the bugzilla: https://bugzilla.proxmox.com/show_bug.cgi?id=4871