1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH VIRTNBDRESTORE "1" "January 2026" "virtnbdrestore 2.44" "User Commands"
.SH NAME
virtnbdrestore \- restore utility for libvirt
.SH DESCRIPTION
usage: virtnbdrestore [\-h] [\-a {dump,restore,verify}] \fB\-i\fR INPUT \fB\-o\fR OUTPUT
.TP
[\-u UNTIL] [\-s SEQUENCE] [\-d DISK] [\-n] [\-f SOCKETFILE]
[\-r] [\-c] [\-D] [\-C CONFIG_FILE] [\-N NAME] [\-B BUFFSIZE]
[\-A] [\-\-compress] [\-U URI] [\-\-user USER]
[\-\-ssh\-user SSH_USER] [\-\-ssh\-port SSH_PORT]
[\-\-password PASSWORD] [\-P NBD_PORT] [\-I NBD_IP] [\-\-tls]
[\-\-tls\-cert TLS_CERT] [\-L LOGFILE] [\-\-nocolor] [\-v] [\-V]
.PP
Restore virtual machine disks
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.SS "General options:"
.TP
\fB\-a\fR, \fB\-\-action\fR {dump,restore,verify}
Action to perform: (default: restore)
.TP
\fB\-i\fR, \fB\-\-input\fR INPUT
Directory including a backup set
.TP
\fB\-o\fR, \fB\-\-output\fR OUTPUT
Restore target directory
.TP
\fB\-u\fR, \fB\-\-until\fR UNTIL
Restore only until checkpoint, point in time restore.
.TP
\fB\-s\fR, \fB\-\-sequence\fR SEQUENCE
Restore image based on specified backup files.
.TP
\fB\-d\fR, \fB\-\-disk\fR DISK
Process only disk matching target dev name. (default: None)
.TP
\fB\-n\fR, \fB\-\-noprogress\fR
Disable progress bar
.TP
\fB\-f\fR, \fB\-\-socketfile\fR SOCKETFILE
Use specified file for NBD Server socket (default: \fI\,/var/tmp/virtnbdbackup.19055\/\fP)
.TP
\fB\-r\fR, \fB\-\-raw\fR
Copy raw images as is during restore. (default: False)
.TP
\fB\-c\fR, \fB\-\-adjust\-config\fR
Adjust vm configuration during restore. (default: False)
.TP
\fB\-D\fR, \fB\-\-define\fR
Register/define VM after restore. (default: False)
.TP
\fB\-C\fR, \fB\-\-config\-file\fR CONFIG_FILE
Name of the vm config file used for restore. (default: vmconfig.xml)
.TP
\fB\-N\fR, \fB\-\-name\fR NAME
Define restored domain with specified name
.TP
\fB\-B\fR, \fB\-\-buffsize\fR BUFFSIZE
Buffer size to use during verify (default: 8192)
.TP
\fB\-A\fR, \fB\-\-preallocate\fR
Preallocate restored qcow images. (default: False)
.TP
\fB\-\-compress\fR
Use compression driver during restore. (default: False)
.SS "Remote Restore options:"
.TP
\fB\-U\fR, \fB\-\-uri\fR URI
Libvirt connection URI. (default: qemu:///session)
.TP
\fB\-\-user\fR USER
User to authenticate against libvirtd. (default: None)
.TP
\fB\-\-ssh\-user\fR SSH_USER
User to authenticate against remote sshd: used for remote copy of files. (default: abi)
.TP
\fB\-\-ssh\-port\fR SSH_PORT
Port to connect to remote sshd: used for remote copy of files. (default: 22)
.TP
\fB\-\-password\fR PASSWORD
Password to authenticate against libvirtd. (default: None)
.TP
\fB\-P\fR, \fB\-\-nbd\-port\fR NBD_PORT
Port used by remote NBD Service, should be unique for each started backup. (default: 10809)
.TP
\fB\-I\fR, \fB\-\-nbd\-ip\fR NBD_IP
IP used to bind remote NBD service on (default: hostname returned by libvirtd)
.TP
\fB\-\-tls\fR
Enable and use TLS for NBD connection. (default: False)
.TP
\fB\-\-tls\-cert\fR TLS_CERT
Path to TLS certificates used during offline backup and restore. (default: /etc/pki/qemu/)
.SS "Logging options:"
.TP
\fB\-L\fR, \fB\-\-logfile\fR LOGFILE
Path to Logfile (default: \fI\,/home/abi/virtnbdrestore.log\/\fP)
.TP
\fB\-\-nocolor\fR
Disable colored output (default: False)
.SS "Debug options:"
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Enable debug output
.TP
\fB\-V\fR, \fB\-\-version\fR
Show version and exit
.SH EXAMPLES
.IP
# Dump backup metadata:
.IP
virtnbdrestore \-i /backup/ \-o dump
.IP
# Verify checksums for existing data files in backup:
.IP
virtnbdrestore \-i /backup/ \-o verify
.IP
# Complete restore with all disks:
.IP
virtnbdrestore \-i /backup/ \-o /target
.IP
# Complete restore, adjust config and redefine vm after restore:
.IP
virtnbdrestore \-cD \-i /backup/ \-o /target
.IP
# Complete restore, adjust config and redefine vm with name 'foo':
.IP
virtnbdrestore \-cD \-\-name foo \-i /backup/ \-o /target
.IP
# Restore only disk 'vda':
.IP
virtnbdrestore \-i /backup/ \-o /target \-d vda
.IP
# Point in time restore:
.IP
virtnbdrestore \-i /backup/ \-o /target \-\-until virtnbdbackup.2
.IP
# Restore and process specific file sequence:
.IP
virtnbdrestore \-i /backup/ \-o /target \-\-sequence vdb.full.data,vdb.inc.virtnbdbackup.1.data
.IP
# Restore to remote system:
.IP
virtnbdrestore \-U qemu+ssh://root@remotehost/system \-\-ssh\-user root \-i /backup/ \-o /remote_target
|
