]>
git.proxmox.com Git - pve-storage.git/blob - PVE/Storage/PBSPlugin.pm
707337dff75eb65e4da6135648d963941b8d1f31
1 package PVE
::Storage
::PBSPlugin
;
3 # Plugin to access Proxmox Backup Server
7 use POSIX
qw(strftime);
12 use Data
::Dumper
; # fixme: remove
14 use PVE
::Tools
qw(run_command file_read_firstline trim dir_glob_regex dir_glob_foreach);
15 use PVE
::Storage
::Plugin
;
16 use PVE
::JSONSchema
qw(get_standard_option);
18 use base
qw(PVE::Storage::Plugin);
28 content
=> [ {backup
=> 1, none
=> 1}, { backup
=> 1 }],
35 description
=> "Proxmox backup server datastore name.",
38 # openssl s_client -connect <host>:8007 2>&1 |openssl x509 -fingerprint -sha256
39 fingerprint
=> get_standard_option
('fingerprint-sha256'),
45 server
=> { fixed
=> 1 },
46 datastore
=> { fixed
=> 1 },
47 nodes
=> { optional
=> 1},
48 disable
=> { optional
=> 1},
49 content
=> { optional
=> 1},
50 username
=> { optional
=> 1 },
51 password
=> { optional
=> 1},
52 maxfiles
=> { optional
=> 1 },
53 fingerprint
=> { optional
=> 1 },
59 sub pbs_password_file_name
{
60 my ($scfg, $storeid) = @_;
62 return "/etc/pve/priv/storage/${storeid}.pw";
65 sub pbs_set_password
{
66 my ($scfg, $storeid, $password) = @_;
68 my $pwfile = pbs_password_file_name
($scfg, $storeid);
70 PVE
::Tools
::file_set_contents
($pwfile, "$password\n");
73 sub pbs_delete_password
{
74 my ($scfg, $storeid) = @_;
76 my $pwfile = pbs_password_file_name
($scfg, $storeid);
81 sub pbs_get_password
{
82 my ($scfg, $storeid) = @_;
84 my $pwfile = pbs_password_file_name
($scfg, $storeid);
86 return PVE
::Tools
::file_read_firstline
($pwfile);
90 sub run_raw_client_cmd
{
91 my ($scfg, $storeid, $client_cmd, $param, %opts) = @_;
93 my $client_exe = '/usr/bin/proxmox-backup-client';
94 die "executable not found '$client_exe'! Proxmox backup client not installed?\n"
97 my $server = $scfg->{server
};
98 my $datastore = $scfg->{datastore
};
99 my $username = $scfg->{username
} // 'root@pam';
101 my $userns_cmd = delete $opts{userns_cmd
};
105 push @$cmd, @$userns_cmd if defined($userns_cmd);
107 push @$cmd, $client_exe, $client_cmd;
109 push @$cmd, @$param if defined($param);
111 push @$cmd, "--repository", "$username\@$server:$datastore";
113 local $ENV{PBS_PASSWORD
} = pbs_get_password
($scfg, $storeid);
115 local $ENV{PBS_FINGERPRINT
} = $scfg->{fingerprint
};
117 if (my $logfunc = $opts{logfunc
}) {
118 $logfunc->("run bps command: " . join(' ', @$cmd));
121 run_command
($cmd, %opts);
125 my ($scfg, $storeid, $client_cmd, $param, $no_output) = @_;
128 my $outfunc = sub { $json_str .= "$_[0]\n" };
130 $param = [] if !defined($param);
131 $param = [ $param ] if !ref($param);
133 $param = [@$param, '--output-format=json'] if !$no_output;
135 run_raw_client_cmd
($scfg, $storeid, $client_cmd, $param,
136 outfunc
=> $outfunc, errmsg
=> 'proxmox-backup-client failed');
138 return undef if $no_output;
140 my $res = decode_json
($json_str);
145 # Storage implementation
147 sub extract_vzdump_config
{
148 my ($class, $scfg, $volname, $storeid) = @_;
150 my ($vtype, $name, $vmid, undef, undef, undef, $format) = $class->parse_volname($volname);
153 my $outfunc = sub { $config .= "$_[0]\n" };
156 if ($format eq 'pbs-vm') {
157 $config_name = 'qemu-server.conf';
158 } elsif ($format eq 'pbs-ct') {
159 $config_name = 'pct.conf';
161 die "unable to extract configuration for backup format '$format'\n";
164 run_raw_client_cmd
($scfg, $storeid, 'restore', [ $name, $config_name, '-' ],
165 outfunc
=> $outfunc, errmsg
=> 'proxmox-backup-client failed');
171 my ($class, $storeid, $scfg, %param) = @_;
173 if (my $password = $param{password
}) {
174 pbs_set_password
($scfg, $storeid, $password);
179 my ($class, $storeid, $scfg) = @_;
181 pbs_delete_password
($scfg, $storeid);
185 my ($class, $volname) = @_;
187 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)$!) {
191 my $format = "pbs-$btype";
193 my $name = "$btype/$bid/$btime";
195 if ($bid =~ m/^\d+$/) {
196 return ('backup', $name, $bid, undef, undef, undef, $format);
198 return ('backup', $name, undef, undef, undef, undef, $format);
202 die "unable to parse PBS volume name '$volname'\n";
206 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
208 die "volume snapshot is not possible on pbs storage"
209 if defined($snapname);
211 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
213 my $server = $scfg->{server
};
214 my $datastore = $scfg->{datastore
};
215 my $username = $scfg->{username
} // 'root@pam';
217 # artifical url - we currently do not use that anywhere
218 my $path = "pbs://$username\@$server:$datastore/$name";
220 return ($path, $vmid, $vtype);
224 my ($class, $storeid, $scfg, $volname) = @_;
226 die "can't create base images in pbs storage\n";
230 my ($class, $scfg, $storeid, $volname, $vmid, $snap) = @_;
232 die "can't clone images in pbs storage\n";
236 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
238 die "can't allocate space in pbs storage\n";
242 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
244 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
246 run_client_cmd
($scfg, $storeid, "forget", [ $name ], 1);
251 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
259 my ($class, $storeid, $scfg, $vmid, $content_types) = @_;
263 return $res if !grep { $_ eq 'backup' } @$content_types;
265 my $data = run_client_cmd
($scfg, $storeid, "snapshots");
267 foreach my $item (@$data) {
268 my $btype = $item->{"backup-type"};
269 my $bid = $item->{"backup-id"};
270 my $btime = $item->{"backup-time"};
271 my $size = $item->{size
} // 1;
273 next if !($btype eq 'vm' || $btype eq 'ct');
274 next if $bid !~ m/^\d+$/;
276 $btime = strftime
("%FT%TZ", gmtime($btime));
277 my $volname = "backup/${btype}/${bid}/${btime}";
279 my $volid = "$storeid:$volname";
281 my $info = { volid
=> $volid , format
=> "pbs-$btype", size
=> $size, content
=> 'backup', vmid
=> int($bid) };
290 my ($class, $storeid, $scfg, $cache) = @_;
298 my $res = run_client_cmd
($scfg, $storeid, "status");
301 $total = $res->{total
};
302 $used = $res->{used
};
303 $free = $res->{avail
};
309 return ($total, $free, $used, $active);
312 sub activate_storage
{
313 my ($class, $storeid, $scfg, $cache) = @_;
317 sub deactivate_storage
{
318 my ($class, $storeid, $scfg, $cache) = @_;
322 sub activate_volume
{
323 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
325 die "volume snapshot is not possible on pbs device" if $snapname;
330 sub deactivate_volume
{
331 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
333 die "volume snapshot is not possible on pbs device" if $snapname;
338 sub volume_size_info
{
339 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
341 my ($vtype, $name, undef, undef, undef, undef, $format) = $class->parse_volname($volname);
343 my $data = run_client_cmd
($scfg, $storeid, "files", [ $name ]);
346 foreach my $info (@$data) {
347 $size += $info->{size
} if $info->{size
};
352 return wantarray ?
($size, $format, $used, undef) : $size;
356 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
357 die "volume resize is not possible on pbs device";
360 sub volume_snapshot
{
361 my ($class, $scfg, $storeid, $volname, $snap) = @_;
362 die "volume snapshot is not possible on pbs device";
365 sub volume_snapshot_rollback
{
366 my ($class, $scfg, $storeid, $volname, $snap) = @_;
367 die "volume snapshot rollback is not possible on pbs device";
370 sub volume_snapshot_delete
{
371 my ($class, $scfg, $storeid, $volname, $snap) = @_;
372 die "volume snapshot delete is not possible on pbs device";
375 sub volume_has_feature
{
376 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;