]>
Commit | Line | Data |
---|---|---|
271fe394 DM |
1 | package PVE::Storage::PBSPlugin; |
2 | ||
3 | # Plugin to access Proxmox Backup Server | |
4 | ||
5 | use strict; | |
6 | use warnings; | |
4133e6e2 | 7 | |
76bb5feb | 8 | use Fcntl qw(F_GETFD F_SETFD FD_CLOEXEC); |
271fe394 | 9 | use HTTP::Request; |
76bb5feb | 10 | use IO::File; |
271fe394 | 11 | use JSON; |
76bb5feb WB |
12 | use LWP::UserAgent; |
13 | use POSIX qw(strftime ENOENT); | |
271fe394 | 14 | |
271fe394 | 15 | use PVE::JSONSchema qw(get_standard_option); |
4133e6e2 TL |
16 | use PVE::Network; |
17 | use PVE::Storage::Plugin; | |
18 | use PVE::Tools qw(run_command file_read_firstline trim dir_glob_regex dir_glob_foreach $IPV6RE); | |
271fe394 DM |
19 | |
20 | use base qw(PVE::Storage::Plugin); | |
21 | ||
22 | # Configuration | |
23 | ||
24 | sub type { | |
25 | return 'pbs'; | |
26 | } | |
27 | ||
28 | sub plugindata { | |
29 | return { | |
30 | content => [ {backup => 1, none => 1}, { backup => 1 }], | |
31 | }; | |
32 | } | |
33 | ||
34 | sub properties { | |
35 | return { | |
36 | datastore => { | |
4133e6e2 | 37 | description => "Proxmox Backup Server datastore name.", |
271fe394 DM |
38 | type => 'string', |
39 | }, | |
40 | # openssl s_client -connect <host>:8007 2>&1 |openssl x509 -fingerprint -sha256 | |
41 | fingerprint => get_standard_option('fingerprint-sha256'), | |
ce2e2733 | 42 | 'encryption-key' => { |
1aeb322b | 43 | description => "Encryption key. Use 'autogen' to generate one automatically without passphrase.", |
76bb5feb WB |
44 | type => 'string', |
45 | }, | |
4133e6e2 TL |
46 | port => { |
47 | description => "For non default port.", | |
48 | type => 'integer', | |
49 | minimum => 1, | |
50 | maximum => 65535, | |
51 | default => 8007, | |
52 | } | |
271fe394 DM |
53 | }; |
54 | } | |
55 | ||
56 | sub options { | |
57 | return { | |
58 | server => { fixed => 1 }, | |
59 | datastore => { fixed => 1 }, | |
4133e6e2 | 60 | port => { optional => 1 }, |
271fe394 DM |
61 | nodes => { optional => 1}, |
62 | disable => { optional => 1}, | |
63 | content => { optional => 1}, | |
64 | username => { optional => 1 }, | |
ce2e2733 TL |
65 | password => { optional => 1 }, |
66 | 'encryption-key' => { optional => 1 }, | |
271fe394 | 67 | maxfiles => { optional => 1 }, |
3353698f | 68 | 'prune-backups' => { optional => 1 }, |
271fe394 DM |
69 | fingerprint => { optional => 1 }, |
70 | }; | |
71 | } | |
72 | ||
73 | # Helpers | |
74 | ||
75 | sub pbs_password_file_name { | |
76 | my ($scfg, $storeid) = @_; | |
77 | ||
462537a2 | 78 | return "/etc/pve/priv/storage/${storeid}.pw"; |
271fe394 DM |
79 | } |
80 | ||
81 | sub pbs_set_password { | |
82 | my ($scfg, $storeid, $password) = @_; | |
83 | ||
84 | my $pwfile = pbs_password_file_name($scfg, $storeid); | |
9e34813f | 85 | mkdir "/etc/pve/priv/storage"; |
271fe394 DM |
86 | |
87 | PVE::Tools::file_set_contents($pwfile, "$password\n"); | |
88 | } | |
89 | ||
90 | sub pbs_delete_password { | |
91 | my ($scfg, $storeid) = @_; | |
92 | ||
93 | my $pwfile = pbs_password_file_name($scfg, $storeid); | |
94 | ||
95 | unlink $pwfile; | |
96 | } | |
97 | ||
98 | sub pbs_get_password { | |
99 | my ($scfg, $storeid) = @_; | |
100 | ||
101 | my $pwfile = pbs_password_file_name($scfg, $storeid); | |
102 | ||
103 | return PVE::Tools::file_read_firstline($pwfile); | |
104 | } | |
105 | ||
76bb5feb WB |
106 | sub pbs_encryption_key_file_name { |
107 | my ($scfg, $storeid) = @_; | |
108 | ||
109 | return "/etc/pve/priv/storage/${storeid}.enc"; | |
110 | } | |
111 | ||
112 | sub pbs_set_encryption_key { | |
113 | my ($scfg, $storeid, $key) = @_; | |
114 | ||
115 | my $pwfile = pbs_encryption_key_file_name($scfg, $storeid); | |
116 | mkdir "/etc/pve/priv/storage"; | |
117 | ||
118 | PVE::Tools::file_set_contents($pwfile, "$key\n"); | |
119 | } | |
120 | ||
121 | sub pbs_delete_encryption_key { | |
122 | my ($scfg, $storeid) = @_; | |
123 | ||
124 | my $pwfile = pbs_encryption_key_file_name($scfg, $storeid); | |
125 | ||
4ef17e1f TL |
126 | if (!unlink $pwfile) { |
127 | return if $! == ENOENT; | |
128 | die "failed to delete encryption key! $!\n"; | |
129 | } | |
18cf6c9f | 130 | delete $scfg->{'encryption-key'}; |
76bb5feb WB |
131 | } |
132 | ||
133 | sub pbs_get_encryption_key { | |
134 | my ($scfg, $storeid) = @_; | |
135 | ||
136 | my $pwfile = pbs_encryption_key_file_name($scfg, $storeid); | |
137 | ||
138 | return PVE::Tools::file_get_contents($pwfile); | |
139 | } | |
140 | ||
141 | # Returns a file handle if there is an encryption key, or `undef` if there is not. Dies on error. | |
142 | sub pbs_open_encryption_key { | |
143 | my ($scfg, $storeid) = @_; | |
144 | ||
145 | my $encryption_key_file = pbs_encryption_key_file_name($scfg, $storeid); | |
146 | ||
147 | my $keyfd; | |
148 | if (!open($keyfd, '<', $encryption_key_file)) { | |
149 | return undef if $! == ENOENT; | |
150 | die "failed to open encryption key: $encryption_key_file: $!\n"; | |
151 | } | |
152 | ||
153 | return $keyfd; | |
154 | } | |
155 | ||
8602fd56 FE |
156 | sub print_volid { |
157 | my ($storeid, $btype, $bid, $btime) = @_; | |
158 | ||
159 | my $time_str = strftime("%FT%TZ", gmtime($btime)); | |
160 | my $volname = "backup/${btype}/${bid}/${time_str}"; | |
161 | ||
162 | return "${storeid}:${volname}"; | |
163 | } | |
271fe394 | 164 | |
4133e6e2 TL |
165 | my sub get_server_with_port { |
166 | my ($scfg) = @_; | |
167 | ||
168 | my $server = $scfg->{server}; | |
169 | $server = "[$server]" if $server =~ /^$IPV6RE$/; | |
170 | ||
171 | if (my $port = $scfg->{port}) { | |
172 | $server .= ":$port" if $port != 8007; | |
173 | } | |
174 | return $server; | |
175 | } | |
176 | ||
02cc5e10 WB |
177 | my $USE_CRYPT_PARAMS = { |
178 | backup => 1, | |
179 | restore => 1, | |
180 | 'upload-log' => 1, | |
181 | }; | |
182 | ||
76bb5feb | 183 | my sub do_raw_client_cmd { |
02cc5e10 WB |
184 | my ($scfg, $storeid, $client_cmd, $param, %opts) = @_; |
185 | ||
186 | my $use_crypto = $USE_CRYPT_PARAMS->{$client_cmd}; | |
271fe394 | 187 | |
1574a590 TL |
188 | my $client_exe = '/usr/bin/proxmox-backup-client'; |
189 | die "executable not found '$client_exe'! Proxmox backup client not installed?\n" | |
190 | if ! -x $client_exe; | |
191 | ||
4133e6e2 | 192 | my $server = get_server_with_port($scfg); |
271fe394 DM |
193 | my $datastore = $scfg->{datastore}; |
194 | my $username = $scfg->{username} // 'root@pam'; | |
195 | ||
196 | my $userns_cmd = delete $opts{userns_cmd}; | |
197 | ||
198 | my $cmd = []; | |
199 | ||
200 | push @$cmd, @$userns_cmd if defined($userns_cmd); | |
201 | ||
1574a590 | 202 | push @$cmd, $client_exe, $client_cmd; |
271fe394 | 203 | |
76bb5feb WB |
204 | # This must live in the top scope to not get closed before the `run_command` |
205 | my $keyfd; | |
02cc5e10 | 206 | if ($use_crypto) { |
76bb5feb WB |
207 | if (defined($keyfd = pbs_open_encryption_key($scfg, $storeid))) { |
208 | my $flags = fcntl($keyfd, F_GETFD, 0) | |
209 | // die "failed to get file descriptor flags: $!\n"; | |
210 | fcntl($keyfd, F_SETFD, $flags & ~FD_CLOEXEC) | |
211 | or die "failed to remove FD_CLOEXEC from encryption key file descriptor\n"; | |
212 | push @$cmd, '--crypt-mode=encrypt', '--keyfd='.fileno($keyfd); | |
213 | } else { | |
214 | push @$cmd, '--crypt-mode=none'; | |
215 | } | |
216 | } | |
217 | ||
271fe394 DM |
218 | push @$cmd, @$param if defined($param); |
219 | ||
220 | push @$cmd, "--repository", "$username\@$server:$datastore"; | |
221 | ||
222 | local $ENV{PBS_PASSWORD} = pbs_get_password($scfg, $storeid); | |
223 | ||
224 | local $ENV{PBS_FINGERPRINT} = $scfg->{fingerprint}; | |
225 | ||
8b4c2a7e DM |
226 | # no ascii-art on task logs |
227 | local $ENV{PROXMOX_OUTPUT_NO_BORDER} = 1; | |
228 | local $ENV{PROXMOX_OUTPUT_NO_HEADER} = 1; | |
229 | ||
271fe394 | 230 | if (my $logfunc = $opts{logfunc}) { |
e6d1edcb | 231 | $logfunc->("run: " . join(' ', @$cmd)); |
271fe394 DM |
232 | } |
233 | ||
234 | run_command($cmd, %opts); | |
235 | } | |
236 | ||
76bb5feb WB |
237 | # FIXME: External perl code should NOT have access to this. |
238 | # | |
239 | # There should be separate functions to | |
240 | # - make backups | |
241 | # - restore backups | |
242 | # - restore files | |
243 | # with a sane API | |
02cc5e10 | 244 | sub run_raw_client_cmd { |
76bb5feb | 245 | my ($scfg, $storeid, $client_cmd, $param, %opts) = @_; |
02cc5e10 | 246 | return do_raw_client_cmd($scfg, $storeid, $client_cmd, $param, %opts); |
76bb5feb WB |
247 | } |
248 | ||
271fe394 DM |
249 | sub run_client_cmd { |
250 | my ($scfg, $storeid, $client_cmd, $param, $no_output) = @_; | |
251 | ||
252 | my $json_str = ''; | |
fee2ece3 | 253 | my $outfunc = sub { $json_str .= "$_[0]\n" }; |
271fe394 DM |
254 | |
255 | $param = [] if !defined($param); | |
256 | $param = [ $param ] if !ref($param); | |
257 | ||
258 | $param = [@$param, '--output-format=json'] if !$no_output; | |
259 | ||
02cc5e10 | 260 | do_raw_client_cmd($scfg, $storeid, $client_cmd, $param, |
76bb5feb | 261 | outfunc => $outfunc, errmsg => 'proxmox-backup-client failed'); |
271fe394 DM |
262 | |
263 | return undef if $no_output; | |
264 | ||
265 | my $res = decode_json($json_str); | |
266 | ||
267 | return $res; | |
268 | } | |
269 | ||
270 | # Storage implementation | |
271 | ||
c855ac15 DM |
272 | sub extract_vzdump_config { |
273 | my ($class, $scfg, $volname, $storeid) = @_; | |
274 | ||
275 | my ($vtype, $name, $vmid, undef, undef, undef, $format) = $class->parse_volname($volname); | |
276 | ||
277 | my $config = ''; | |
fee2ece3 | 278 | my $outfunc = sub { $config .= "$_[0]\n" }; |
c855ac15 DM |
279 | |
280 | my $config_name; | |
281 | if ($format eq 'pbs-vm') { | |
282 | $config_name = 'qemu-server.conf'; | |
283 | } elsif ($format eq 'pbs-ct') { | |
284 | $config_name = 'pct.conf'; | |
285 | } else { | |
286 | die "unable to extract configuration for backup format '$format'\n"; | |
287 | } | |
288 | ||
02cc5e10 | 289 | do_raw_client_cmd($scfg, $storeid, 'restore', [ $name, $config_name, '-' ], |
76bb5feb | 290 | outfunc => $outfunc, errmsg => 'proxmox-backup-client failed'); |
c855ac15 DM |
291 | |
292 | return $config; | |
293 | } | |
294 | ||
8f26b391 FE |
295 | sub prune_backups { |
296 | my ($class, $scfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc) = @_; | |
297 | ||
298 | $logfunc //= sub { print "$_[1]\n" }; | |
299 | ||
300 | my $backups = $class->list_volumes($storeid, $scfg, $vmid, ['backup']); | |
301 | ||
302 | $type = 'vm' if defined($type) && $type eq 'qemu'; | |
303 | $type = 'ct' if defined($type) && $type eq 'lxc'; | |
304 | ||
305 | my $backup_groups = {}; | |
306 | foreach my $backup (@{$backups}) { | |
307 | (my $backup_type = $backup->{format}) =~ s/^pbs-//; | |
308 | ||
309 | next if defined($type) && $backup_type ne $type; | |
310 | ||
311 | my $backup_group = "$backup_type/$backup->{vmid}"; | |
312 | $backup_groups->{$backup_group} = 1; | |
313 | } | |
314 | ||
315 | my @param; | |
1b87f013 FE |
316 | |
317 | my $keep_all = delete $keep->{'keep-all'}; | |
318 | ||
319 | if (!$keep_all) { | |
320 | foreach my $opt (keys %{$keep}) { | |
321 | next if $keep->{$opt} == 0; | |
322 | push @param, "--$opt"; | |
323 | push @param, "$keep->{$opt}"; | |
324 | } | |
325 | } else { # no need to pass anything to PBS | |
326 | $keep = { 'keep-all' => 1 }; | |
8f26b391 FE |
327 | } |
328 | ||
329 | push @param, '--dry-run' if $dryrun; | |
330 | ||
331 | my $prune_list = []; | |
332 | my $failed; | |
333 | ||
334 | foreach my $backup_group (keys %{$backup_groups}) { | |
335 | $logfunc->('info', "running 'proxmox-backup-client prune' for '$backup_group'") | |
336 | if !$dryrun; | |
337 | eval { | |
338 | my $res = run_client_cmd($scfg, $storeid, 'prune', [ $backup_group, @param ]); | |
339 | ||
340 | foreach my $backup (@{$res}) { | |
341 | die "result from proxmox-backup-client is not as expected\n" | |
342 | if !defined($backup->{'backup-time'}) | |
343 | || !defined($backup->{'backup-type'}) | |
344 | || !defined($backup->{'backup-id'}) | |
345 | || !defined($backup->{'keep'}); | |
346 | ||
347 | my $ctime = $backup->{'backup-time'}; | |
348 | my $type = $backup->{'backup-type'}; | |
349 | my $vmid = $backup->{'backup-id'}; | |
350 | my $volid = print_volid($storeid, $type, $vmid, $ctime); | |
351 | ||
352 | push @{$prune_list}, { | |
353 | ctime => $ctime, | |
354 | mark => $backup->{keep} ? 'keep' : 'remove', | |
355 | type => $type eq 'vm' ? 'qemu' : 'lxc', | |
356 | vmid => $vmid, | |
357 | volid => $volid, | |
358 | }; | |
359 | } | |
360 | }; | |
361 | if (my $err = $@) { | |
362 | $logfunc->('err', "prune '$backup_group': $err\n"); | |
363 | $failed = 1; | |
364 | } | |
365 | } | |
366 | die "error pruning backups - check log\n" if $failed; | |
367 | ||
368 | return $prune_list; | |
369 | } | |
370 | ||
1aeb322b TL |
371 | my $autogen_encryption_key = sub { |
372 | my ($scfg, $storeid) = @_; | |
373 | my $encfile = pbs_encryption_key_file_name($scfg, $storeid); | |
478609d3 TL |
374 | if (-f $encfile) { |
375 | rename $encfile, "$encfile.old"; | |
376 | } | |
4558cb6e TL |
377 | my $cmd = ['proxmox-backup-client', 'key', 'create', '--kdf', 'none', $encfile]; |
378 | run_command($cmd, errmsg => 'failed to create encryption key'); | |
379 | return PVE::Tools::file_get_contents($encfile); | |
1aeb322b TL |
380 | }; |
381 | ||
271fe394 DM |
382 | sub on_add_hook { |
383 | my ($class, $storeid, $scfg, %param) = @_; | |
384 | ||
0b6b98d1 TL |
385 | my $res = {}; |
386 | ||
76bb5feb WB |
387 | if (defined(my $password = $param{password})) { |
388 | pbs_set_password($scfg, $storeid, $password); | |
b494636a DM |
389 | } else { |
390 | pbs_delete_password($scfg, $storeid); | |
391 | } | |
76bb5feb | 392 | |
ce2e2733 | 393 | if (defined(my $encryption_key = $param{'encryption-key'})) { |
d2c47b38 | 394 | my $decoded_key; |
1aeb322b | 395 | if ($encryption_key eq 'autogen') { |
0b6b98d1 | 396 | $res->{'encryption-key'} = $autogen_encryption_key->($scfg, $storeid); |
3cc2eb73 | 397 | $decoded_key = decode_json($res->{'encryption-key'}); |
1aeb322b | 398 | } else { |
d2c47b38 TL |
399 | $decoded_key = eval { decode_json($encryption_key) }; |
400 | if ($@ || !exists($decoded_key->{data})) { | |
401 | die "Value does not seems like a valid, JSON formatted encryption key!\n"; | |
402 | } | |
1aeb322b | 403 | pbs_set_encryption_key($scfg, $storeid, $encryption_key); |
0b6b98d1 | 404 | $res->{'encryption-key'} = $encryption_key; |
1aeb322b | 405 | } |
3cc2eb73 | 406 | $scfg->{'encryption-key'} = $decoded_key->{fingerprint} || 1; |
76bb5feb WB |
407 | } else { |
408 | pbs_delete_encryption_key($scfg, $storeid); | |
409 | } | |
0b6b98d1 TL |
410 | |
411 | return $res; | |
b494636a DM |
412 | } |
413 | ||
414 | sub on_update_hook { | |
415 | my ($class, $storeid, $scfg, %param) = @_; | |
416 | ||
0b6b98d1 TL |
417 | my $res = {}; |
418 | ||
76bb5feb WB |
419 | if (exists($param{password})) { |
420 | if (defined($param{password})) { | |
421 | pbs_set_password($scfg, $storeid, $param{password}); | |
422 | } else { | |
423 | pbs_delete_password($scfg, $storeid); | |
424 | } | |
425 | } | |
b494636a | 426 | |
ce2e2733 TL |
427 | if (exists($param{'encryption-key'})) { |
428 | if (defined(my $encryption_key = delete($param{'encryption-key'}))) { | |
d2c47b38 | 429 | my $decoded_key; |
1aeb322b | 430 | if ($encryption_key eq 'autogen') { |
0b6b98d1 | 431 | $res->{'encryption-key'} = $autogen_encryption_key->($scfg, $storeid); |
3cc2eb73 | 432 | $decoded_key = decode_json($res->{'encryption-key'}); |
1aeb322b | 433 | } else { |
d2c47b38 TL |
434 | $decoded_key = eval { decode_json($encryption_key) }; |
435 | if ($@ || !exists($decoded_key->{data})) { | |
436 | die "Value does not seems like a valid, JSON formatted encryption key!\n"; | |
437 | } | |
1aeb322b | 438 | pbs_set_encryption_key($scfg, $storeid, $encryption_key); |
0b6b98d1 | 439 | $res->{'encryption-key'} = $encryption_key; |
1aeb322b | 440 | } |
3cc2eb73 | 441 | $scfg->{'encryption-key'} = $decoded_key->{fingerprint} || 1; |
76bb5feb WB |
442 | } else { |
443 | pbs_delete_encryption_key($scfg, $storeid); | |
444 | } | |
271fe394 | 445 | } |
0b6b98d1 TL |
446 | |
447 | return $res; | |
271fe394 DM |
448 | } |
449 | ||
450 | sub on_delete_hook { | |
451 | my ($class, $storeid, $scfg) = @_; | |
452 | ||
453 | pbs_delete_password($scfg, $storeid); | |
76bb5feb | 454 | pbs_delete_encryption_key($scfg, $storeid); |
f3ccd0ef FE |
455 | |
456 | return; | |
271fe394 DM |
457 | } |
458 | ||
459 | sub parse_volname { | |
460 | my ($class, $volname) = @_; | |
461 | ||
462 | if ($volname =~ m!^backup/([^\s_]+)/([^\s_]+)/([0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)$!) { | |
463 | my $btype = $1; | |
464 | my $bid = $2; | |
465 | my $btime = $3; | |
466 | my $format = "pbs-$btype"; | |
467 | ||
468 | my $name = "$btype/$bid/$btime"; | |
469 | ||
470 | if ($bid =~ m/^\d+$/) { | |
471 | return ('backup', $name, $bid, undef, undef, undef, $format); | |
472 | } else { | |
473 | return ('backup', $name, undef, undef, undef, undef, $format); | |
474 | } | |
475 | } | |
476 | ||
477 | die "unable to parse PBS volume name '$volname'\n"; | |
478 | } | |
479 | ||
480 | sub path { | |
481 | my ($class, $scfg, $volname, $storeid, $snapname) = @_; | |
482 | ||
483 | die "volume snapshot is not possible on pbs storage" | |
484 | if defined($snapname); | |
485 | ||
486 | my ($vtype, $name, $vmid) = $class->parse_volname($volname); | |
487 | ||
4133e6e2 | 488 | my $server = get_server_with_port($scfg); |
271fe394 DM |
489 | my $datastore = $scfg->{datastore}; |
490 | my $username = $scfg->{username} // 'root@pam'; | |
491 | ||
492 | # artifical url - we currently do not use that anywhere | |
493 | my $path = "pbs://$username\@$server:$datastore/$name"; | |
494 | ||
495 | return ($path, $vmid, $vtype); | |
496 | } | |
497 | ||
498 | sub create_base { | |
499 | my ($class, $storeid, $scfg, $volname) = @_; | |
500 | ||
501 | die "can't create base images in pbs storage\n"; | |
502 | } | |
503 | ||
504 | sub clone_image { | |
505 | my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_; | |
506 | ||
507 | die "can't clone images in pbs storage\n"; | |
508 | } | |
509 | ||
510 | sub alloc_image { | |
511 | my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_; | |
512 | ||
513 | die "can't allocate space in pbs storage\n"; | |
514 | } | |
515 | ||
516 | sub free_image { | |
517 | my ($class, $storeid, $scfg, $volname, $isBase) = @_; | |
518 | ||
519 | my ($vtype, $name, $vmid) = $class->parse_volname($volname); | |
520 | ||
521 | run_client_cmd($scfg, $storeid, "forget", [ $name ], 1); | |
522 | } | |
523 | ||
524 | ||
525 | sub list_images { | |
526 | my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_; | |
527 | ||
528 | my $res = []; | |
529 | ||
530 | return $res; | |
531 | } | |
532 | ||
878fe017 TL |
533 | my sub snapshot_files_encrypted { |
534 | my ($files) = @_; | |
535 | return 0 if !$files; | |
536 | ||
537 | my $any; | |
538 | my $all = 1; | |
539 | for my $file (@$files) { | |
540 | my $fn = $file->{filename}; | |
541 | next if $fn eq 'client.log.blob' || $fn eq 'index.json.blob'; | |
542 | ||
543 | my $crypt = $file->{'crypt-mode'}; | |
544 | ||
545 | $all = 0 if !$crypt || $crypt ne 'encrypt'; | |
546 | $any ||= $crypt eq 'encrypt'; | |
547 | } | |
548 | return $any && $all; | |
549 | } | |
550 | ||
271fe394 DM |
551 | sub list_volumes { |
552 | my ($class, $storeid, $scfg, $vmid, $content_types) = @_; | |
553 | ||
554 | my $res = []; | |
555 | ||
556 | return $res if !grep { $_ eq 'backup' } @$content_types; | |
557 | ||
558 | my $data = run_client_cmd($scfg, $storeid, "snapshots"); | |
559 | ||
560 | foreach my $item (@$data) { | |
561 | my $btype = $item->{"backup-type"}; | |
562 | my $bid = $item->{"backup-id"}; | |
545e127e | 563 | my $epoch = $item->{"backup-time"}; |
271fe394 DM |
564 | my $size = $item->{size} // 1; |
565 | ||
566 | next if !($btype eq 'vm' || $btype eq 'ct'); | |
567 | next if $bid !~ m/^\d+$/; | |
ddf7fdaa | 568 | next if defined($vmid) && $bid ne $vmid; |
271fe394 | 569 | |
8602fd56 | 570 | my $volid = print_volid($storeid, $btype, $bid, $epoch); |
271fe394 | 571 | |
545e127e | 572 | my $info = { |
c05b1a8c TL |
573 | volid => $volid, |
574 | format => "pbs-$btype", | |
575 | size => $size, | |
576 | content => 'backup', | |
577 | vmid => int($bid), | |
578 | ctime => $epoch, | |
545e127e | 579 | }; |
271fe394 | 580 | |
9778e5c2 | 581 | $info->{verification} = $item->{verification} if defined($item->{verification}); |
6fef456c | 582 | $info->{notes} = $item->{comment} if defined($item->{comment}); |
878fe017 TL |
583 | if (defined($item->{fingerprint})) { |
584 | $info->{encrypted} = $item->{fingerprint}; | |
585 | } elsif (snapshot_files_encrypted($item->{files})) { | |
586 | $info->{encrypted} = '1'; | |
587 | } | |
9778e5c2 | 588 | |
271fe394 DM |
589 | push @$res, $info; |
590 | } | |
591 | ||
592 | return $res; | |
593 | } | |
594 | ||
595 | sub status { | |
596 | my ($class, $storeid, $scfg, $cache) = @_; | |
597 | ||
598 | my $total = 0; | |
599 | my $free = 0; | |
600 | my $used = 0; | |
601 | my $active = 0; | |
602 | ||
603 | eval { | |
604 | my $res = run_client_cmd($scfg, $storeid, "status"); | |
605 | ||
606 | $active = 1; | |
607 | $total = $res->{total}; | |
608 | $used = $res->{used}; | |
f155c912 TL |
609 | $free = $res->{avail}; |
610 | }; | |
271fe394 DM |
611 | if (my $err = $@) { |
612 | warn $err; | |
613 | } | |
614 | ||
615 | return ($total, $free, $used, $active); | |
616 | } | |
617 | ||
618 | sub activate_storage { | |
619 | my ($class, $storeid, $scfg, $cache) = @_; | |
bb0a0f96 | 620 | |
3de42368 TL |
621 | # a 'status' client command is to expensive here |
622 | # TODO: use a dummy ping API call to ensure the PBS API daemon is available for real | |
623 | my $server = $scfg->{server}; | |
624 | my $port = $scfg->{port} // 8007; | |
625 | PVE::Network::tcp_ping($server, $port, 2); | |
bb0a0f96 | 626 | |
271fe394 DM |
627 | return 1; |
628 | } | |
629 | ||
630 | sub deactivate_storage { | |
631 | my ($class, $storeid, $scfg, $cache) = @_; | |
632 | return 1; | |
633 | } | |
634 | ||
635 | sub activate_volume { | |
636 | my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_; | |
637 | ||
638 | die "volume snapshot is not possible on pbs device" if $snapname; | |
639 | ||
640 | return 1; | |
641 | } | |
642 | ||
643 | sub deactivate_volume { | |
644 | my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_; | |
645 | ||
646 | die "volume snapshot is not possible on pbs device" if $snapname; | |
647 | ||
648 | return 1; | |
649 | } | |
650 | ||
45e93e6d DC |
651 | sub get_volume_notes { |
652 | my ($class, $scfg, $storeid, $volname, $timeout) = @_; | |
653 | ||
654 | my (undef, $name, undef, undef, undef, undef, $format) = $class->parse_volname($volname); | |
655 | ||
656 | my $data = run_client_cmd($scfg, $storeid, "snapshot", [ "notes", "show", $name ]); | |
657 | ||
658 | return $data->{notes}; | |
659 | } | |
660 | ||
661 | sub update_volume_notes { | |
662 | my ($class, $scfg, $storeid, $volname, $notes, $timeout) = @_; | |
663 | ||
664 | my (undef, $name, undef, undef, undef, undef, $format) = $class->parse_volname($volname); | |
665 | ||
666 | run_client_cmd($scfg, $storeid, "snapshot", [ "notes", "update", $name, $notes ], 1); | |
667 | ||
668 | return undef; | |
669 | } | |
670 | ||
271fe394 DM |
671 | sub volume_size_info { |
672 | my ($class, $scfg, $storeid, $volname, $timeout) = @_; | |
673 | ||
674 | my ($vtype, $name, undef, undef, undef, undef, $format) = $class->parse_volname($volname); | |
675 | ||
676 | my $data = run_client_cmd($scfg, $storeid, "files", [ $name ]); | |
677 | ||
678 | my $size = 0; | |
679 | foreach my $info (@$data) { | |
680 | $size += $info->{size} if $info->{size}; | |
681 | } | |
682 | ||
683 | my $used = $size; | |
684 | ||
685 | return wantarray ? ($size, $format, $used, undef) : $size; | |
686 | } | |
687 | ||
688 | sub volume_resize { | |
689 | my ($class, $scfg, $storeid, $volname, $size, $running) = @_; | |
690 | die "volume resize is not possible on pbs device"; | |
691 | } | |
692 | ||
693 | sub volume_snapshot { | |
694 | my ($class, $scfg, $storeid, $volname, $snap) = @_; | |
695 | die "volume snapshot is not possible on pbs device"; | |
696 | } | |
697 | ||
698 | sub volume_snapshot_rollback { | |
699 | my ($class, $scfg, $storeid, $volname, $snap) = @_; | |
700 | die "volume snapshot rollback is not possible on pbs device"; | |
701 | } | |
702 | ||
703 | sub volume_snapshot_delete { | |
704 | my ($class, $scfg, $storeid, $volname, $snap) = @_; | |
705 | die "volume snapshot delete is not possible on pbs device"; | |
706 | } | |
707 | ||
708 | sub volume_has_feature { | |
709 | my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_; | |
710 | ||
711 | return undef; | |
712 | } | |
713 | ||
714 | 1; |