Creating snippets using PVE API

May 7, 2019
2
0
1
Hello,

Thank you for Proxmox! I'm running 5.4-3 in a test lab right now.

I am trying to use the `customci` configuration parameter for VM's, so I can provide arbitrary `user-data` in the cloud-init configuration. For that, I see that the new snippet feature is the way to go if I understood correctly.

However, I noticed that it's not possible to create snippets using the PVE API (at least through the /api2/json/nodes/{node}/storage/{storage}/upload endpoint). The error I'm currently getting is:

400 Parameter verification failed.
content: upload content type 'snippets' not allowed


I've checked the source code and I see that only the `iso` and `vztmpl` content types are considered for this endpoint: https://git.proxmox.com/?p=pve-stor...9e6fe495501eaed874eee94367d49cb3;hb=HEAD#l410

I think it would make sense to allow snippet managing using the PVE API, is this possible in some way I missed? If it's not, is this planned for the near future? Would it be a desired feature that could be contributed?


Thank you!
 
May 7, 2019
2
0
1
As a first approach I wrote a patch that allows the snippet creation on this very endpoint:

Code:
diff --git a/PVE/API2/Storage/Status.pm b/PVE/API2/Storage/Status.pm
index 9a5a952..fd7ac5f 100644
--- a/PVE/API2/Storage/Status.pm
+++ b/PVE/API2/Storage/Status.pm
@@ -417,8 +417,10 @@ __PACKAGE__->register_method ({
                raise_param_exc({ filename => "missing '.tar.gz' or '.tar.xz' extension" });
            }
            $path = PVE::Storage::get_vztmpl_dir($cfg, $param->{storage});
-       } else {
-           raise_param_exc({ content => "upload content type '$content' not allowed" });
+       } elsif ($content eq 'snippets') {
+           $path = PVE::Storage::get_snippet_dir($cfg, $param->{storage});
+  } else {
+      raise_param_exc({ content => "upload content type '$content' not allowed" });
        }
 
        die "storage '$param->{storage}' does not support '$content' content\n"
diff --git a/PVE/Storage.pm b/PVE/Storage.pm
index eb5e86f..bc0981b 100755
--- a/PVE/Storage.pm
+++ b/PVE/Storage.pm
@@ -340,6 +340,15 @@ sub get_iso_dir {
     return $plugin->get_subdir($scfg, 'iso');
 }
 
+sub get_snippet_dir {
+    my ($cfg, $storeid) = @_;
+
+    my $scfg = storage_config($cfg, $storeid);
+    my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
+
+    return $plugin->get_subdir($scfg, 'snippets');
+}
+
 sub get_vztmpl_dir {
     my ($cfg, $storeid) = @_;

However this endpoint does not seem the right place for handling snippets (at least creation and deletion), since in REST terms the deletion of the snippet would look awkward? In any case, I'll wait for your feedback :)
 

dcsapak

Proxmox Staff Member
Staff member
Feb 1, 2016
7,874
952
163
33
Vienna
thats right, currently you cannot create/delete snippets via the api, you have to create them on the target storage (e.g. via a commandline tool, file explorer, etc.)

edit:
if you want to be able to upload some, please open an enhancement request here:

https://bugzilla.proxmox.com
 

About

The Proxmox community has been around for many years and offers help and support for Proxmox VE, Proxmox Backup Server, and Proxmox Mail Gateway.
We think our community is one of the best thanks to people like you!

Get your subscription!

The Proxmox team works very hard to make sure you are running the best software and getting stable updates and security enhancements, as well as quick enterprise support. Tens of thousands of happy customers have a Proxmox subscription. Get your own in 60 seconds.

Buy now!