blob: fdcf120f360247afb6ed9699ec9feffb9e4ab40a [file] [log] [blame]
bellardacd935e2004-11-15 22:57:26 +00001@example
2@c man begin SYNOPSIS
Denis V. Lunev10985132016-06-17 17:44:13 +03003@command{qemu-img} [@var{standard} @var{options}] @var{command} [@var{command} @var{options}]
bellardacd935e2004-11-15 22:57:26 +00004@c man end
5@end example
6
Kevin Wolf48467322012-08-16 10:56:35 +02007@c man begin DESCRIPTION
8qemu-img allows you to create, convert and modify images offline. It can handle
9all image formats supported by QEMU.
10
11@b{Warning:} Never use qemu-img to modify images in use by a running virtual
12machine or any other process; this may destroy the image. Also, be aware that
13querying an image that is being modified by another process may encounter
14inconsistent state.
15@c man end
16
bellardacd935e2004-11-15 22:57:26 +000017@c man begin OPTIONS
18
Denis V. Lunev10985132016-06-17 17:44:13 +030019Standard options:
20@table @option
21@item -h, --help
22Display this help and exit
23@item -V, --version
24Display version information and exit
Denis V. Lunev06a1e0c2016-06-17 17:44:14 +030025@item -T, --trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}]
26@findex --trace
27@include qemu-option-trace.texi
Denis V. Lunev10985132016-06-17 17:44:13 +030028@end table
29
bellardacd935e2004-11-15 22:57:26 +000030The following commands are supported:
Stuart Brady153859b2009-06-07 00:42:17 +010031
32@include qemu-img-cmds.texi
bellardacd935e2004-11-15 22:57:26 +000033
34Command parameters:
35@table @var
36@item filename
37 is a disk image filename
Daniel P. Berrange3babeb12016-02-17 10:10:17 +000038
39@item --object @var{objectdef}
40
41is a QEMU user creatable object definition. See the @code{qemu(1)} manual
42page for a description of the object properties. The most common object
43type is a @code{secret}, which is used to supply passwords and/or encryption
44keys.
45
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000046@item --image-opts
47
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010048Indicates that the source @var{filename} parameter is to be interpreted as a
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000049full option string, not a plain filename. This parameter is mutually
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010050exclusive with the @var{-f} parameter.
51
52@item --target-image-opts
53
54Indicates that the @var{output_filename} parameter(s) are to be interpreted as
55a full option string, not a plain filename. This parameter is mutually
56exclusive with the @var{-O} parameters. It is currently required to also use
57the @var{-n} parameter to skip image creation. This restriction may be relaxed
58in a future release.
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000059
ths5fafdf22007-09-16 21:08:06 +000060@item fmt
Kevin Wolff932c042009-10-28 12:49:15 +010061is the disk image format. It is guessed automatically in most cases. See below
62for a description of the supported disk formats.
bellardacd935e2004-11-15 22:57:26 +000063
Kashyap Chamarthye5357562012-10-18 11:25:34 +053064@item --backing-chain
65will enumerate information about backing files in a disk image chain. Refer
66below for further description.
67
ths5fafdf22007-09-16 21:08:06 +000068@item size
Kevin Wolfeff44262009-06-04 15:39:39 +020069is the disk image size in bytes. Optional suffixes @code{k} or @code{K}
70(kilobyte, 1024) @code{M} (megabyte, 1024k) and @code{G} (gigabyte, 1024M)
71and T (terabyte, 1024G) are supported. @code{b} is ignored.
bellardacd935e2004-11-15 22:57:26 +000072
73@item output_filename
ths5fafdf22007-09-16 21:08:06 +000074is the destination disk image filename
bellardacd935e2004-11-15 22:57:26 +000075
76@item output_fmt
77 is the destination format
Kevin Wolfeff44262009-06-04 15:39:39 +020078@item options
79is a comma separated list of format specific options in a
80name=value format. Use @code{-o ?} for an overview of the options supported
Kevin Wolf3e032362009-10-28 12:49:17 +010081by the used format or see the format descriptions below for details.
Wenchao Xiaef806542013-12-04 17:10:57 +080082@item snapshot_param
83is param used for internal snapshot, format is
84'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]'
85@item snapshot_id_or_name
86is deprecated, use snapshot_param instead
bellardacd935e2004-11-15 22:57:26 +000087
88@item -c
89indicates that target image must be compressed (qcow format only)
blueswir1d2c639d2009-01-24 18:19:25 +000090@item -h
91with or without a command shows help and lists the supported formats
Jes Sorensenaaf55b42011-07-19 15:01:34 +020092@item -p
Kevin Wolf0e3bd992014-01-20 15:12:16 +010093display progress bar (compare, convert and rebase commands only).
94If the @var{-p} option is not used for a command that supports it, the
Max Reitz262fbae2017-02-08 00:57:57 +010095progress is reported when the process receives a @code{SIGUSR1} or
96@code{SIGINFO} signal.
Miroslav Rezaninaf382d432013-02-13 09:09:40 +010097@item -q
98Quiet mode - do not print any output (except errors). There's no progress bar
99in case both @var{-q} and @var{-p} options are used.
Kevin Wolfa22f1232011-08-26 15:27:13 +0200100@item -S @var{size}
101indicates the consecutive number of bytes that must contain only zeros
102for qemu-img to create a sparse image during conversion. This value is rounded
103down to the nearest 512 bytes. You may use the common size suffixes like
104@code{k} for kilobytes.
Kevin Wolf3763f262011-12-07 13:57:13 +0100105@item -t @var{cache}
106specifies the cache mode that should be used with the (destination) file. See
107the documentation of the emulator's @code{-drive cache=...} option for allowed
108values.
Max Reitz40055952014-07-22 22:58:42 +0200109@item -T @var{src_cache}
Stefan Hajnoczibb87fdf2014-09-02 11:01:02 +0100110specifies the cache mode that should be used with the source file(s). See
111the documentation of the emulator's @code{-drive cache=...} option for allowed
112values.
blueswir1d2c639d2009-01-24 18:19:25 +0000113@end table
114
115Parameters to snapshot subcommand:
116
117@table @option
118
119@item snapshot
120is the name of the snapshot to create, apply or delete
121@item -a
122applies a snapshot (revert disk to saved state)
123@item -c
124creates a snapshot
125@item -d
126deletes a snapshot
127@item -l
128lists all snapshots in the given image
bellardacd935e2004-11-15 22:57:26 +0000129@end table
130
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100131Parameters to compare subcommand:
132
133@table @option
134
135@item -f
136First image format
137@item -F
138Second image format
139@item -s
Daniel P. Berrangeb6af0972015-08-26 12:17:13 +0100140Strict mode - fail on different image size or sector allocation
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100141@end table
142
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100143Parameters to convert subcommand:
144
145@table @option
146
147@item -n
148Skip the creation of the target volume
Peter Lieven2d9187b2017-02-28 13:40:07 +0100149@item -m
150Number of parallel coroutines for the convert process
151@item -W
152Allow out-of-order writes to the destination. This option improves performance,
153but is only recommended for preallocated devices like host devices or other
154raw block devices.
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100155@end table
156
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200157Parameters to dd subcommand:
158
159@table @option
160
161@item bs=@var{block_size}
162defines the block size
163@item count=@var{blocks}
164sets the number of input blocks to copy
165@item if=@var{input}
166sets the input file
167@item of=@var{output}
168sets the output file
Reda Sallahif7c15532016-08-10 16:16:09 +0200169@item skip=@var{blocks}
170sets the number of input blocks to skip
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200171@end table
172
bellardacd935e2004-11-15 22:57:26 +0000173Command description:
174
175@table @option
Kevin Wolf55d539c2016-06-03 13:59:41 +0200176@item bench [-c @var{count}] [-d @var{depth}] [-f @var{fmt}] [--flush-interval=@var{flush_interval}] [-n] [--no-drain] [-o @var{offset}] [--pattern=@var{pattern}] [-q] [-s @var{buffer_size}] [-S @var{step_size}] [-t @var{cache}] [-w] @var{filename}
Kevin Wolfb6133b82014-08-05 14:17:13 +0200177
Kevin Wolfb6495fa2015-07-10 18:09:18 +0200178Run a simple sequential I/O benchmark on the specified image. If @code{-w} is
179specified, a write test is performed, otherwise a read test is performed.
180
181A total number of @var{count} I/O requests is performed, each @var{buffer_size}
Kevin Wolfd3199a32015-07-10 18:09:18 +0200182bytes in size, and with @var{depth} requests in parallel. The first request
Kevin Wolf83de9be2015-07-13 13:13:17 +0200183starts at the position given by @var{offset}, each following request increases
184the current position by @var{step_size}. If @var{step_size} is not given,
185@var{buffer_size} is used for its value.
Kevin Wolfb6133b82014-08-05 14:17:13 +0200186
Kevin Wolf55d539c2016-06-03 13:59:41 +0200187If @var{flush_interval} is specified for a write test, the request queue is
188drained and a flush is issued before new writes are made whenever the number of
189remaining requests is a multiple of @var{flush_interval}. If additionally
190@code{--no-drain} is specified, a flush is issued without draining the request
191queue first.
192
Kevin Wolfb6133b82014-08-05 14:17:13 +0200193If @code{-n} is specified, the native AIO backend is used if possible. On
194Linux, this option only works if @code{-t none} or @code{-t directsync} is
195specified as well.
196
Kevin Wolfb6495fa2015-07-10 18:09:18 +0200197For write tests, by default a buffer filled with zeros is written. This can be
198overridden with a pattern byte specified by @var{pattern}.
199
Max Reitz40055952014-07-22 22:58:42 +0200200@item check [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
Kevin Wolfe6184692011-01-17 15:35:28 +0100201
Federico Simoncelli8599ea42013-01-28 06:59:47 -0500202Perform a consistency check on the disk image @var{filename}. The command can
203output in the format @var{ofmt} which is either @code{human} or @code{json}.
Kevin Wolfe6184692011-01-17 15:35:28 +0100204
Kevin Wolf4534ff52012-05-11 16:07:02 +0200205If @code{-r} is specified, qemu-img tries to repair any inconsistencies found
206during the check. @code{-r leaks} repairs only cluster leaks, whereas
207@code{-r all} fixes all kinds of errors, with a higher risk of choosing the
Stefan Weil0546b8c2012-08-10 22:03:25 +0200208wrong fix or hiding corruption that has already occurred.
Kevin Wolf4534ff52012-05-11 16:07:02 +0200209
Kevin Wolfe6184692011-01-17 15:35:28 +0100210Only the formats @code{qcow2}, @code{qed} and @code{vdi} support
211consistency checks.
212
Max Reitzd6635c42014-06-02 22:15:21 +0200213In case the image does not have any inconsistencies, check exits with @code{0}.
214Other exit codes indicate the kind of inconsistency found or if another error
215occurred. The following table summarizes all exit codes of the check subcommand:
216
217@table @option
218
219@item 0
220Check completed, the image is (now) consistent
221@item 1
222Check not completed because of internal errors
223@item 2
224Check completed, image is corrupted
225@item 3
226Check completed, image has leaked clusters, but is not corrupted
227@item 63
228Checks are not supported by the image format
229
230@end table
231
232If @code{-r} is specified, exit codes representing the image state refer to the
233state after (the attempt at) repairing it. That is, a successful @code{-r all}
234will yield the exit code 0, independently of the image state before.
235
John Snow6e6e55f2017-07-17 20:34:22 -0400236@item create [-f @var{fmt}] [-b @var{backing_file}] [-F @var{backing_fmt}] [-u] [-o @var{options}] @var{filename} [@var{size}]
bellardacd935e2004-11-15 22:57:26 +0000237
238Create the new disk image @var{filename} of size @var{size} and format
Kevin Wolf8063d0f2009-10-28 12:49:16 +0100239@var{fmt}. Depending on the file format, you can add one or more @var{options}
240that enable additional features of this format.
bellardacd935e2004-11-15 22:57:26 +0000241
Kevin Wolf8063d0f2009-10-28 12:49:16 +0100242If the option @var{backing_file} is specified, then the image will record
243only the differences from @var{backing_file}. No size needs to be specified in
244this case. @var{backing_file} will never be modified unless you use the
245@code{commit} monitor command (or qemu-img commit).
bellardacd935e2004-11-15 22:57:26 +0000246
Fam Zhenga16efd52017-08-04 22:36:58 +0800247If a relative path name is given, the backing file is looked up relative to
248the directory containing @var{filename}.
249
John Snow6e6e55f2017-07-17 20:34:22 -0400250Note that a given backing file will be opened to check that it is valid. Use
251the @code{-u} option to enable unsafe backing file mode, which means that the
252image will be created even if the associated backing file cannot be opened. A
253matching backing file must be created or additional options be used to make the
254backing file specification valid when you want to use an image created this
255way.
256
Kevin Wolfeff44262009-06-04 15:39:39 +0200257The size can also be specified using the @var{size} option with @code{-o},
258it doesn't need to be specified separately in this case.
259
Max Reitz1b22bff2014-10-24 15:57:40 +0200260@item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
bellardacd935e2004-11-15 22:57:26 +0000261
Jeff Cody37222902014-01-24 09:02:37 -0500262Commit the changes recorded in @var{filename} in its base image or backing file.
263If the backing file is smaller than the snapshot, then the backing file will be
264resized to be the same size as the snapshot. If the snapshot is smaller than
265the backing file, the backing file will not be truncated. If you want the
266backing file to match the size of the smaller snapshot, you can safely truncate
267it yourself once the commit operation successfully completes.
bellardacd935e2004-11-15 22:57:26 +0000268
Max Reitz9a86fe42014-10-24 15:57:38 +0200269The image @var{filename} is emptied after the operation has succeeded. If you do
270not need @var{filename} afterwards and intend to drop it, you may skip emptying
271@var{filename} by specifying the @code{-d} flag.
272
Max Reitz1b22bff2014-10-24 15:57:40 +0200273If the backing chain of the given image file @var{filename} has more than one
274layer, the backing file into which the changes will be committed may be
275specified as @var{base} (which has to be part of @var{filename}'s backing
276chain). If @var{base} is not specified, the immediate backing file of the top
Max Reitz67e56472017-10-26 09:59:47 +0200277image (which is @var{filename}) will be used. Note that after a commit operation
278all images between @var{base} and the top image will be invalid and may return
279garbage data when read. For this reason, @code{-b} implies @code{-d} (so that
280the top image stays valid).
Max Reitz1b22bff2014-10-24 15:57:40 +0200281
Max Reitz40055952014-07-22 22:58:42 +0200282@item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-s] [-q] @var{filename1} @var{filename2}
Miroslav Rezaninad14ed182013-02-13 09:09:41 +0100283
284Check if two images have the same content. You can compare images with
285different format or settings.
286
287The format is probed unless you specify it by @var{-f} (used for
288@var{filename1}) and/or @var{-F} (used for @var{filename2}) option.
289
290By default, images with different size are considered identical if the larger
291image contains only unallocated and/or zeroed sectors in the area after the end
292of the other image. In addition, if any sector is not allocated in one image
293and contains only zero bytes in the second one, it is evaluated as equal. You
294can use Strict mode by specifying the @var{-s} option. When compare runs in
295Strict mode, it fails in case image size differs or a sector is allocated in
296one image and is not allocated in the second one.
297
298By default, compare prints out a result message. This message displays
299information that both images are same or the position of the first different
300byte. In addition, result message can report different image size in case
301Strict mode is used.
302
303Compare exits with @code{0} in case the images are equal and with @code{1}
304in case the images differ. Other exit codes mean an error occurred during
305execution and standard error output should contain an error message.
306The following table sumarizes all exit codes of the compare subcommand:
307
308@table @option
309
310@item 0
311Images are identical
312@item 1
313Images differ
314@item 2
315Error on opening an image
316@item 3
317Error on checking a sector allocation
318@item 4
319Error on reading data
320
321@end table
322
Max Reitz2b4c0a22017-04-26 15:46:49 +0200323@item convert [-c] [-p] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-m @var{num_coroutines}] [-W] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
bellardacd935e2004-11-15 22:57:26 +0000324
Wenchao Xiaef806542013-12-04 17:10:57 +0800325Convert the disk image @var{filename} or a snapshot @var{snapshot_param}(@var{snapshot_id_or_name} is deprecated)
326to disk image @var{output_filename} using format @var{output_fmt}. It can be optionally compressed (@code{-c}
Kevin Wolfeff44262009-06-04 15:39:39 +0200327option) or use any format specific options like encryption (@code{-o} option).
bellardacd935e2004-11-15 22:57:26 +0000328
Kevin Wolf8063d0f2009-10-28 12:49:16 +0100329Only the formats @code{qcow} and @code{qcow2} support compression. The
bellardacd935e2004-11-15 22:57:26 +0000330compression is read-only. It means that if a compressed sector is
331rewritten, then it is rewritten as uncompressed data.
332
bellardacd935e2004-11-15 22:57:26 +0000333Image conversion is also useful to get smaller image when using a
Stefan Hajnoczi550830f2014-09-16 15:24:24 +0100334growable format such as @code{qcow}: the empty sectors are detected and
335suppressed from the destination image.
bellardacd935e2004-11-15 22:57:26 +0000336
Peter Lieven11b66992013-10-24 12:07:05 +0200337@var{sparse_size} indicates the consecutive number of bytes (defaults to 4k)
338that must contain only zeros for qemu-img to create a sparse image during
339conversion. If @var{sparse_size} is 0, the source will not be scanned for
340unallocated or zero sectors, and the destination image will always be
341fully allocated.
342
Kevin Wolf8063d0f2009-10-28 12:49:16 +0100343You can use the @var{backing_file} option to force the output image to be
344created as a copy on write image of the specified base image; the
345@var{backing_file} should have the same content as the input's base image,
346however the path, image format, etc may differ.
347
Fam Zhenga16efd52017-08-04 22:36:58 +0800348If a relative path name is given, the backing file is looked up relative to
349the directory containing @var{output_filename}.
350
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100351If the @code{-n} option is specified, the target volume creation will be
352skipped. This is useful for formats such as @code{rbd} if the target
353volume has already been created with site specific options that cannot
354be supplied through qemu-img.
355
Peter Lieven2d9187b2017-02-28 13:40:07 +0100356Out of order writes can be enabled with @code{-W} to improve performance.
357This is only recommended for preallocated devices like host devices or other
358raw block devices. Out of order write does not work in combination with
359creating compressed images.
360
361@var{num_coroutines} specifies how many coroutines work in parallel during
362the convert process (defaults to 8).
363
Reda Sallahif7c15532016-08-10 16:16:09 +0200364@item dd [-f @var{fmt}] [-O @var{output_fmt}] [bs=@var{block_size}] [count=@var{blocks}] [skip=@var{blocks}] if=@var{input} of=@var{output}
Reda Sallahi86ce1f62016-08-10 04:43:12 +0200365
366Dd copies from @var{input} file to @var{output} file converting it from
367@var{fmt} format to @var{output_fmt} format.
368
369The data is by default read and written using blocks of 512 bytes but can be
370modified by specifying @var{block_size}. If count=@var{blocks} is specified
371dd will stop reading input after reading @var{blocks} input blocks.
372
373The size syntax is similar to dd(1)'s size syntax.
374
Kashyap Chamarthye5357562012-10-18 11:25:34 +0530375@item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
bellardacd935e2004-11-15 22:57:26 +0000376
377Give information about the disk image @var{filename}. Use it in
378particular to know the size reserved on disk which can be different
bellard19d36792006-08-07 21:34:34 +0000379from the displayed size. If VM snapshots are stored in the disk image,
Benoît Canetc054b3f2012-09-05 13:09:02 +0200380they are displayed too. The command can output in the format @var{ofmt}
381which is either @code{human} or @code{json}.
blueswir1d2c639d2009-01-24 18:19:25 +0000382
Kashyap Chamarthye5357562012-10-18 11:25:34 +0530383If a disk image has a backing file chain, information about each disk image in
384the chain can be recursively enumerated by using the option @code{--backing-chain}.
385
386For instance, if you have an image chain like:
387
388@example
389base.qcow2 <- snap1.qcow2 <- snap2.qcow2
390@end example
391
392To enumerate information about each disk image in the above chain, starting from top to base, do:
393
394@example
395qemu-img info --backing-chain snap2.qcow2
396@end example
397
Paolo Bonzinifacd6e22013-09-04 19:00:34 +0200398@item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
399
400Dump the metadata of image @var{filename} and its backing file chain.
401In particular, this commands dumps the allocation state of every sector
402of @var{filename}, together with the topmost file that allocates it in
403the backing file chain.
404
405Two option formats are possible. The default format (@code{human})
406only dumps known-nonzero areas of the file. Known-zero parts of the
407file are omitted altogether, and likewise for parts that are not allocated
408throughout the chain. @command{qemu-img} output will identify a file
409from where the data can be read, and the offset in the file. Each line
410will include four fields, the first three of which are hexadecimal
411numbers. For example the first line of:
412@example
413Offset Length Mapped to File
4140 0x20000 0x50000 /tmp/overlay.qcow2
4150x100000 0x10000 0x95380000 /tmp/backing.qcow2
416@end example
417@noindent
418means that 0x20000 (131072) bytes starting at offset 0 in the image are
419available in /tmp/overlay.qcow2 (opened in @code{raw} format) starting
420at offset 0x50000 (327680). Data that is compressed, encrypted, or
421otherwise not available in raw format will cause an error if @code{human}
422format is in use. Note that file names can include newlines, thus it is
423not safe to parse this output format in scripts.
424
425The alternative format @code{json} will return an array of dictionaries
426in JSON format. It will include similar information in
427the @code{start}, @code{length}, @code{offset} fields;
428it will also include other more specific information:
429@itemize @minus
430@item
431whether the sectors contain actual data or not (boolean field @code{data};
432if false, the sectors are either unallocated or stored as optimized
433all-zero clusters);
434
435@item
436whether the data is known to read as zero (boolean field @code{zero});
437
438@item
439in order to make the output shorter, the target file is expressed as
440a @code{depth}; for example, a depth of 2 refers to the backing file
441of the backing file of @var{filename}.
442@end itemize
443
444In JSON format, the @code{offset} field is optional; it is absent in
445cases where @code{human} format would omit the entry or exit with an error.
446If @code{data} is false and the @code{offset} field is present, the
447corresponding sectors in the file are not yet in use, but they are
448preallocated.
449
450For more information, consult @file{include/block/block.h} in QEMU's
451source code.
452
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +0100453@item measure [--output=@var{ofmt}] [-O @var{output_fmt}] [-o @var{options}] [--size @var{N} | [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-l @var{snapshot_param}] @var{filename}]
454
455Calculate the file size required for a new image. This information can be used
456to size logical volumes or SAN LUNs appropriately for the image that will be
457placed in them. The values reported are guaranteed to be large enough to fit
458the image. The command can output in the format @var{ofmt} which is either
459@code{human} or @code{json}.
460
461If the size @var{N} is given then act as if creating a new empty image file
462using @command{qemu-img create}. If @var{filename} is given then act as if
463converting an existing image file using @command{qemu-img convert}. The format
464of the new file is given by @var{output_fmt} while the format of an existing
465file is given by @var{fmt}.
466
467A snapshot in an existing image can be specified using @var{snapshot_param}.
468
469The following fields are reported:
470@example
471required size: 524288
472fully allocated size: 1074069504
473@end example
474
475The @code{required size} is the file size of the new image. It may be smaller
476than the virtual disk size if the image format supports compact representation.
477
478The @code{fully allocated size} is the file size of the new image once data has
479been written to all sectors. This is the maximum size that the image file can
480occupy with the exception of internal snapshots, dirty bitmaps, vmstate data,
481and other advanced image format features.
482
blueswir1d2c639d2009-01-24 18:19:25 +0000483@item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot} ] @var{filename}
484
485List, apply, create or delete snapshots in image @var{filename}.
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +0100486
Max Reitz40055952014-07-22 22:58:42 +0200487@item rebase [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
Kevin Wolfe6184692011-01-17 15:35:28 +0100488
489Changes the backing file of an image. Only the formats @code{qcow2} and
490@code{qed} support changing the backing file.
491
492The backing file is changed to @var{backing_file} and (if the image format of
493@var{filename} supports this) the backing file format is changed to
Alex Bligha6166732012-10-16 13:46:18 +0100494@var{backing_fmt}. If @var{backing_file} is specified as ``'' (the empty
495string), then the image is rebased onto no backing file (i.e. it will exist
496independently of any backing file).
Kevin Wolfe6184692011-01-17 15:35:28 +0100497
Fam Zhenga16efd52017-08-04 22:36:58 +0800498If a relative path name is given, the backing file is looked up relative to
499the directory containing @var{filename}.
500
Max Reitz40055952014-07-22 22:58:42 +0200501@var{cache} specifies the cache mode to be used for @var{filename}, whereas
Stefan Hajnoczi3ba67962014-09-02 11:01:03 +0100502@var{src_cache} specifies the cache mode for reading backing files.
Max Reitz40055952014-07-22 22:58:42 +0200503
Kevin Wolfe6184692011-01-17 15:35:28 +0100504There are two different modes in which @code{rebase} can operate:
505@table @option
506@item Safe mode
507This is the default mode and performs a real rebase operation. The new backing
508file may differ from the old one and qemu-img rebase will take care of keeping
509the guest-visible content of @var{filename} unchanged.
510
511In order to achieve this, any clusters that differ between @var{backing_file}
512and the old backing file of @var{filename} are merged into @var{filename}
513before actually changing the backing file.
514
515Note that the safe mode is an expensive operation, comparable to converting
516an image. It only works if the old backing file still exists.
517
518@item Unsafe mode
519qemu-img uses the unsafe mode if @code{-u} is specified. In this mode, only the
520backing file name and format of @var{filename} is changed without any checks
521on the file contents. The user must take care of specifying the correct new
522backing file, or the guest-visible content of the image will be corrupted.
523
524This mode is useful for renaming or moving the backing file to somewhere else.
525It can be used without an accessible old backing file, i.e. you can use it to
526fix an image whose backing file has already been moved/renamed.
527@end table
528
Richard W.M. Jones9fda6ab2012-05-21 14:58:05 +0100529You can use @code{rebase} to perform a ``diff'' operation on two
530disk images. This can be useful when you have copied or cloned
531a guest, and you want to get back to a thin image on top of a
532template or base image.
533
534Say that @code{base.img} has been cloned as @code{modified.img} by
535copying it, and that the @code{modified.img} guest has run so there
536are now some changes compared to @code{base.img}. To construct a thin
537image called @code{diff.qcow2} that contains just the differences, do:
538
539@example
540qemu-img create -f qcow2 -b modified.img diff.qcow2
541qemu-img rebase -b base.img diff.qcow2
542@end example
543
544At this point, @code{modified.img} can be discarded, since
545@code{base.img + diff.qcow2} contains the same information.
546
Pavel Butsykin4ffca892017-09-18 15:42:27 +0300547@item resize [--shrink] [--preallocation=@var{prealloc}] @var{filename} [+ | -]@var{size}
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +0100548
549Change the disk image as if it had been created with @var{size}.
550
551Before using this command to shrink a disk image, you MUST use file system and
552partitioning tools inside the VM to reduce allocated file systems and partition
553sizes accordingly. Failure to do so will result in data loss!
554
Pavel Butsykin4ffca892017-09-18 15:42:27 +0300555When shrinking images, the @code{--shrink} option must be given. This informs
556qemu-img that the user acknowledges all loss of data beyond the truncated
557image's end.
558
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +0100559After using this command to grow a disk image, you must use file system and
560partitioning tools inside the VM to actually begin using the new space on the
561device.
Max Reitz6f176b42013-09-03 10:09:50 +0200562
Max Reitzdc5f6902017-06-13 22:20:55 +0200563When growing an image, the @code{--preallocation} option may be used to specify
564how the additional image area should be allocated on the host. See the format
565description in the @code{NOTES} section which values are allowed. Using this
566option may result in slightly more data being allocated than necessary.
567
Max Reitz76a3a342014-10-27 11:12:51 +0100568@item amend [-p] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
Max Reitz6f176b42013-09-03 10:09:50 +0200569
570Amends the image format specific @var{options} for the image file
571@var{filename}. Not all file formats support this operation.
bellardacd935e2004-11-15 22:57:26 +0000572@end table
Kevin Wolfd3067b02012-11-21 14:21:47 +0100573@c man end
bellardacd935e2004-11-15 22:57:26 +0000574
Kevin Wolfd3067b02012-11-21 14:21:47 +0100575@ignore
576@c man begin NOTES
Kevin Wolff932c042009-10-28 12:49:15 +0100577Supported image file formats:
578
579@table @option
580@item raw
581
582Raw disk image format (default). This format has the advantage of
583being simple and easily exportable to all other emulators. If your
584file system supports @emph{holes} (for example in ext2 or ext3 on
585Linux or NTFS on Windows), then only the written sectors will reserve
586space. Use @code{qemu-img info} to know the real size used by the
587image or @code{ls -ls} on Unix/Linux.
588
Hu Tao06247422014-09-10 17:05:48 +0800589Supported options:
590@table @code
591@item preallocation
592Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
593@code{falloc} mode preallocates space for image by calling posix_fallocate().
594@code{full} mode preallocates space for image by writing zeros to underlying
595storage.
596@end table
597
Kevin Wolff932c042009-10-28 12:49:15 +0100598@item qcow2
599QEMU image format, the most versatile format. Use it to have smaller
600images (useful if your filesystem does not supports holes, for example
601on Windows), optional AES encryption, zlib based compression and
602support of multiple VM snapshots.
Kevin Wolf8063d0f2009-10-28 12:49:16 +0100603
Kevin Wolf3e032362009-10-28 12:49:17 +0100604Supported options:
605@table @code
Kevin Wolfd3067b02012-11-21 14:21:47 +0100606@item compat
Stefan Hajnoczi7fa9e1f2014-01-06 12:39:01 +0800607Determines the qcow2 version to use. @code{compat=0.10} uses the
608traditional image format that can be read by any QEMU since 0.10.
Kevin Wolfd3067b02012-11-21 14:21:47 +0100609@code{compat=1.1} enables image format extensions that only QEMU 1.1 and
Stefan Hajnoczi7fa9e1f2014-01-06 12:39:01 +0800610newer understand (this is the default). Amongst others, this includes zero
611clusters, which allow efficient copy-on-read for sparse images.
Kevin Wolfd3067b02012-11-21 14:21:47 +0100612
Kevin Wolf3e032362009-10-28 12:49:17 +0100613@item backing_file
614File name of a base image (see @option{create} subcommand)
615@item backing_fmt
616Image format of the base image
617@item encryption
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000618If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
Kevin Wolf3e032362009-10-28 12:49:17 +0100619
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000620The use of encryption in qcow and qcow2 images is considered to be flawed by
621modern cryptography standards, suffering from a number of design problems:
622
623@itemize @minus
Daniel P. Berrange0b4ee902017-06-23 17:24:02 +0100624@item
625The AES-CBC cipher is used with predictable initialization vectors based
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000626on the sector number. This makes it vulnerable to chosen plaintext attacks
627which can reveal the existence of encrypted data.
Daniel P. Berrange0b4ee902017-06-23 17:24:02 +0100628@item
629The user passphrase is directly used as the encryption key. A poorly
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000630chosen or short passphrase will compromise the security of the encryption.
Daniel P. Berrange0b4ee902017-06-23 17:24:02 +0100631@item
632In the event of the passphrase being compromised there is no way to
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000633change the passphrase to protect data in any qcow images. The files must
634be cloned, using a different encryption passphrase in the new file. The
635original file must then be securely erased using a program like shred,
636though even this is ineffective with many modern storage technologies.
Daniel P. Berrange0b4ee902017-06-23 17:24:02 +0100637@item
638Initialization vectors used to encrypt sectors are based on the
639guest virtual sector number, instead of the host physical sector. When
640a disk image has multiple internal snapshots this means that data in
641multiple physical sectors is encrypted with the same initialization
642vector. With the CBC mode, this opens the possibility of watermarking
643attacks if the attack can collect multiple sectors encrypted with the
644same IV and some predictable data. Having multiple qcow2 images with
645the same passphrase also exposes this weakness since the passphrase
646is directly used as the key.
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000647@end itemize
648
649Use of qcow / qcow2 encryption is thus strongly discouraged. Users are
650recommended to use an alternative encryption technology such as the
651Linux dm-crypt / LUKS system.
Kevin Wolf3e032362009-10-28 12:49:17 +0100652
653@item cluster_size
654Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
655sizes can improve the image file size whereas larger cluster sizes generally
656provide better performance.
657
658@item preallocation
Hu Tao0e4271b2014-09-10 17:05:49 +0800659Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
660@code{full}). An image with preallocated metadata is initially larger but can
661improve performance when the image needs to grow. @code{falloc} and @code{full}
662preallocations are like the same options of @code{raw} format, but sets up
663metadata also.
Kevin Wolf3e032362009-10-28 12:49:17 +0100664
Kevin Wolfd3067b02012-11-21 14:21:47 +0100665@item lazy_refcounts
666If this option is set to @code{on}, reference count updates are postponed with
667the goal of avoiding metadata I/O and improving performance. This is
668particularly interesting with @option{cache=writethrough} which doesn't batch
669metadata updates. The tradeoff is that after a host crash, the reference count
670tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
671check -r all} is required, which may take some time.
672
673This option can only be enabled if @code{compat=1.1} is specified.
674
Chunyan Liu4ab15592014-06-30 14:29:58 +0800675@item nocow
Chunyan Liubc3a7f92014-07-02 12:27:29 +0800676If this option is set to @code{on}, it will turn off COW of the file. It's only
Chunyan Liu4ab15592014-06-30 14:29:58 +0800677valid on btrfs, no effect on other file systems.
678
679Btrfs has low performance when hosting a VM image file, even more when the guest
680on the VM also using btrfs as file system. Turning off COW is a way to mitigate
681this bad performance. Generally there are two ways to turn off COW on btrfs:
682a) Disable it by mounting with nodatacow, then all newly created files will be
683NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
684does.
685
686Note: this option is only valid to new or empty files. If there is an existing
687file which is COW and has data blocks already, it couldn't be changed to NOCOW
688by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
Chunyan Liubc3a7f92014-07-02 12:27:29 +0800689the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
Chunyan Liu4ab15592014-06-30 14:29:58 +0800690
Kevin Wolf3e032362009-10-28 12:49:17 +0100691@end table
692
Kevin Wolfd3067b02012-11-21 14:21:47 +0100693@item Other
694QEMU also supports various other image file formats for compatibility with
Jeff Cody8282db12013-12-17 13:56:06 -0500695older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), VHDX,
696qcow1 and QED. For a full list of supported formats see @code{qemu-img --help}.
Kevin Wolfd3067b02012-11-21 14:21:47 +0100697For a more detailed description of these formats, see the QEMU Emulation User
698Documentation.
Stefan Hajnoczif0858002012-06-13 14:29:15 +0100699
Kevin Wolfd3067b02012-11-21 14:21:47 +0100700The main purpose of the block drivers for these formats is image conversion.
701For running VMs, it is recommended to convert the disk images to either raw or
702qcow2 in order to achieve good performance.
Kevin Wolff932c042009-10-28 12:49:15 +0100703@end table
704
705
bellardacd935e2004-11-15 22:57:26 +0000706@c man end
707
bellardacd935e2004-11-15 22:57:26 +0000708@setfilename qemu-img
709@settitle QEMU disk image utility
710
711@c man begin SEEALSO
712The HTML documentation of QEMU for more precise information and Linux
713user mode emulator invocation.
714@c man end
715
716@c man begin AUTHOR
717Fabrice Bellard
718@c man end
719
720@end ignore