]> git.proxmox.com Git - qemu-server.git/blob - qmrestore
better documentation
[qemu-server.git] / qmrestore
1 #!/usr/bin/perl -w
2
3 use strict;
4 use PVE::SafeSyslog;
5 use PVE::Tools qw(extract_param);
6 use PVE::INotify;
7 use PVE::RPCEnvironment;
8 use PVE::CLIHandler;
9 use PVE::JSONSchema qw(get_standard_option);
10 use PVE::API2::Qemu;
11
12 use Data::Dumper; # fixme: remove
13
14 use base qw(PVE::CLIHandler);
15
16 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
17
18 initlog('qmrestore');
19
20 die "please run as root\n" if $> != 0;
21
22 PVE::INotify::inotify_init();
23
24 my $rpcenv = PVE::RPCEnvironment->init('cli');
25
26 $rpcenv->init_request();
27 $rpcenv->set_language($ENV{LANG});
28 $rpcenv->set_user('root@pam');
29
30 __PACKAGE__->register_method({
31 name => 'qmrestore',
32 path => 'qmrestore',
33 method => 'POST',
34 description => "Restore QemuServer vzdump backups.",
35 parameters => {
36 additionalProperties => 0,
37 properties => {
38 vmid => get_standard_option('pve-vmid'),
39 archive => {
40 description => "The backup file. You can pass '-' to read from standard input.",
41 type => 'string',
42 maxLength => 255,
43 },
44 storage => get_standard_option('pve-storage-id', {
45 description => "Default storage.",
46 optional => 1,
47 }),
48 force => {
49 optional => 1,
50 type => 'boolean',
51 description => "Allow to overwrite existing VM.",
52 },
53 unique => {
54 optional => 1,
55 type => 'boolean',
56 description => "Assign a unique random ethernet address.",
57 },
58 },
59 },
60 returns => {
61 type => 'string',
62 },
63 code => sub {
64 my ($param) = @_;
65
66 $param->{node} = PVE::INotify::nodename();
67
68 return PVE::API2::Qemu->create_vm($param);
69 }});
70
71 my $cmddef = [ __PACKAGE__, 'qmrestore', ['archive', 'vmid'], undef,
72 sub {
73 my $upid = shift;
74 my $status = PVE::Tools::upid_read_status($upid);
75 exit($status eq 'OK' ? 0 : -1);
76 }];
77
78 push @ARGV, 'help' if !scalar(@ARGV);
79
80 PVE::CLIHandler::handle_simple_cmd($cmddef, \@ARGV, undef, $0);
81
82 exit 0;
83
84 __END__
85
86 =head1 NAME
87
88 qmrestore - restore QemuServer vzdump backups
89
90 =head1 SYNOPSIS
91
92 =include synopsis
93
94 =head1 DESCRIPTION
95
96 Restore the QemuServer vzdump backup C<archive> to virtual machine
97 C<vmid>. Volumes are allocated on the original storage if there is no
98 C<storage> specified.
99
100 =head1 SEE ALSO
101
102 vzdump(1) vzrestore(1)
103
104 =include pve_copyright