Import disk from file using API

A

anzure

New Member
Jul 26, 2021
4
0
1
27
I know that you can import disk from file to VM using CLI:
qm importdisk 9000 bionic-server-cloudimg-amd64.img local-lvm

However I want to do this using the API, but there is no endpoint for that.
I have attempted to change the configuration and move the disk..

VM config is set to:
POST /api2/json/nodes/pve/qemu/9000/config
Code: 
vmid=        9000
name=        ubuntu-tmp
net0=        virtio,bridge=vmbr0
memory=        2048
scsihw=        virtio-scsi-pci
scsi0=        local:iso/bionic-server-cloudimg-amd64.img
ide2=        local-lvm:cloudinit
bootdisk=    scsi0
boot=        c

Moving the disk:
POST /api2/json/nodes/pve/qemu/9000/move_disk
Code: 
disk=        scsi0
storage=    local-lvm

Every attempt has just resulted in "no bootable devices found" (bios error).
And it works perfectly fine when using the CLI importdisk command.

Any suggestions for a workaround?
 
Hi,
we are working on adding such an API endpoint. Could you try placing the image as images/9000/bionic-server-cloudimg-amd64.qcow2 rather than as an ISO image? Use qemu-img info bionic-server-cloudimg-amd64.img to make sure the format is actually qcow2 first. (It was for the image I found online.)
 
  • Like
Reactions: supermario87
A bit of necroposting confirming that taking the image file from storage:iso/image does not work with the API endpoint move_disk

It only works with qm importdisk cli utility(in fact, importdisk can take the image from any path)

Any updates on the importdisk functionality in the API endpoint @Fabian_E ??
 
supermario87 said:
Any updates on the importdisk functionality in the API endpoint @Fabian_E ??
Click to expand...
Sadly, I cannot give any time estimate when the feature will be available. I'm afraid it might still take a while.
 
The feature is available with qemu-server >= 7.1-5. Rather than it's own API endpoint, there is an import-from property that can be used when setting the VM drive. For example
Code: 
pvesh set /nodes/pve701/qemu/105/config --scsi1 local:0,discard=on,import-from=myzpool:vm-123-disk-0
...
create full clone of drive scsi0 (myzpool:vm-123-disk-0)
...
scsi1: successfully created disk 'local:105/vm-105-disk-1.raw,discard=on,size=103M'
with <target storage>:0 being required syntax. This can also be used upon VM creation.

EDIT: For completeness, I should mention that you can also specify an absolute path as an import source.
 
Last edited:
Fabian_E said:
with <target storage>:0 being required syntax. This can also be used upon VM creation.

EDIT: For completeness, I should mention that you can also specify an absolute path as an import source.
Click to expand...

I cannot confirm that:
Bash: 
curl -XPOST --silent -v --insecure -H "Authorization: PVEAPIToken=$(cat ./proxmox-api-token.txt)" -H "Content-Type: application/json" \                                                              
--data '{"vmid": 102, "scsihw": "virtio-scsi-pci", "virtio0": "local:0,import-from=/var/lib/vz/template/iso/ubuntu-server-cloudimg-amd64.img", "agent": 1, "serial0": "socket"}' \
https://192.168.121.209:8006/api2/json/nodes/bullseye/qemu
HTTP/1.1 500 Only root can pass arbitrary filesystem paths. at /usr/share/perl5/PVE/Storage.pm line 539.
 
dermorz said:
I cannot confirm that:
Bash: 
curl -XPOST --silent -v --insecure -H "Authorization: PVEAPIToken=$(cat ./proxmox-api-token.txt)" -H "Content-Type: application/json" \                                                             
--data '{"vmid": 102, "scsihw": "virtio-scsi-pci", "virtio0": "local:0,import-from=/var/lib/vz/template/iso/ubuntu-server-cloudimg-amd64.img", "agent": 1, "serial0": "socket"}' \
https://192.168.121.209:8006/api2/json/nodes/bullseye/qemu
HTTP/1.1 500 Only root can pass arbitrary filesystem paths. at /usr/share/perl5/PVE/Storage.pm line 539.
Click to expand...
The error message tells you exactly what the problem is. Being able to pass arbitrary paths is a security risk, so it needs to be limited.
 
I don't disagree on that. I was just confused that it didn't match with what you said earlier in this thread. I was btw authenticated with root@pam with an unrestricted API Token, so the error message was also a bit misleading.
 
You just need the proper permissions to do it. Being authenticated with an API token for root@pam is not the same as being authenticated as root@pam. Otherwise, tokens for root@pam would be a security risk too.
 
It should work. IIRC, the content type check shouldn't be done when using absolute paths.
 
Interesting. Maybe this is worth exploring then. But on the other hand, I am not sure if it's a good idea to require the user of an integration to have full permissions, if that integration's purpose is just to spin up VMs.

But just for completeness sake: Would the absolute path always be /var/lib/vz/template/iso/<filename> or does it depend on the storage attached and used, right? Would there be a deterministic way to get the absolute path via API?
 
dermorz said:
Interesting. Maybe this is worth exploring then. But on the other hand, I am not sure if it's a good idea to require the user of an integration to have full permissions, if that integration's purpose is just to spin up VMs.
Click to expand...
Yes, of course. I agree that there is no good workflow for this at the moment. I just created the relevant enhancement request.
dermorz said:
But just for completeness sake: Would the absolute path always be /var/lib/vz/template/iso/<filename> or does it depend on the storage attached and used, right? Would there be a deterministic way to get the absolute path via API?
Click to expand...
It does depend on the storage. You can GET /storage/<storage ID> whose result includes the base path of the storage. The rest of the path is template/iso/<name of image>
 
  • Like
Reactions: dermorz
I know this is a rather old thread and I have seen that the enhancement request has been implemented for API-Token for root@pam. Is there any news/progress on letting users authenticated with non root@pam API-Tokens import vendor prepared cloud images with the import-from parameter?
 
ridingroedeer said:
I know this is a rather old thread and I have seen that the enhancement request has been implemented for API-Token for root@pam. Is there any news/progress on letting users authenticated with non root@pam API-Tokens import vendor prepared cloud images with the import-from parameter?
Click to expand...
There is a series to allow import from OVA/OVF being worked on by @dcsapak : https://lists.proxmox.com/pipermail/pve-devel/2024-May/063974.html
This might get extended for "normal" images as well in the future.
 
fiona said:
Yes, of course. I agree that there is no good workflow for this at the moment. I just created the relevant enhancement request.

It does depend on the storage. You can GET /storage/<storage ID> whose result includes the base path of the storage. The rest of the path is template/iso/<name of image>
Click to expand...
Know this is an old thread but this response confused me. what i end up doing is:

Code: 
pvesm list local

or replace local with whatever storage your running and it gives you a value back what proxmox understands:


Code: 
pvesm list local
Volid                                          Format  Type             Size VMID
local:103/vm-103-disk-0.raw                    raw     images    21474836480 103
local:iso/noble-server-cloudimg-amd64.img      iso     iso         625462272
 
Hi @bjorns ,
the question was about getting the absolute path via the API, which can be done with the HTTP GET request.
Your command gives volume IDs that Proxmox VE handles.

Note that nowadays it is possible to upload images for import in the UI and via API. It's necessary to enable the import content type in the storage configuration then.
 
fiona said:
Hi @bjorns ,
the question was about getting the absolute path via the API, which can be done with the HTTP GET request.
Your command gives volume IDs that Proxmox VE handles.

Note that nowadays it is possible to upload images for import in the UI and via API. It's necessary to enable the import content type in the storage configuration then.
Click to expand...
Ow that sounds interesting how do you do that, do you have link to documentation : "It's necessary to enable the import content type in the storage configuration then." ?
 
Datacenter > Storage > [file-based storage] > Edit > Content.
After that you can select the storage in the side bar and then Import.
 
  • Like
Reactions: bjorns
You must log in or register to reply here.
Top Bottom