blob: 72dabd6b3e632a3a74c8f8f8ce185b80239df34d [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
John Snow6e6e55f2017-07-17 20:34:22 -0400247Note that a given backing file will be opened to check that it is valid. Use
248the @code{-u} option to enable unsafe backing file mode, which means that the
249image will be created even if the associated backing file cannot be opened. A
250matching backing file must be created or additional options be used to make the
251backing file specification valid when you want to use an image created this
252way.
253
Kevin Wolfeff44262009-06-04 15:39:39 +0200254The size can also be specified using the @var{size} option with @code{-o},
255it doesn't need to be specified separately in this case.
256
Max Reitz1b22bff2014-10-24 15:57:40 +0200257@item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
bellardacd935e2004-11-15 22:57:26 +0000258
Jeff Cody37222902014-01-24 09:02:37 -0500259Commit the changes recorded in @var{filename} in its base image or backing file.
260If the backing file is smaller than the snapshot, then the backing file will be
261resized to be the same size as the snapshot. If the snapshot is smaller than
262the backing file, the backing file will not be truncated. If you want the
263backing file to match the size of the smaller snapshot, you can safely truncate
264it yourself once the commit operation successfully completes.
bellardacd935e2004-11-15 22:57:26 +0000265
Max Reitz9a86fe42014-10-24 15:57:38 +0200266The image @var{filename} is emptied after the operation has succeeded. If you do
267not need @var{filename} afterwards and intend to drop it, you may skip emptying
268@var{filename} by specifying the @code{-d} flag.
269
Max Reitz1b22bff2014-10-24 15:57:40 +0200270If the backing chain of the given image file @var{filename} has more than one
271layer, the backing file into which the changes will be committed may be
272specified as @var{base} (which has to be part of @var{filename}'s backing
273chain). If @var{base} is not specified, the immediate backing file of the top
274image (which is @var{filename}) will be used. For reasons of consistency,
275explicitly specifying @var{base} will always imply @code{-d} (since emptying an
276image after committing to an indirect backing file would lead to different data
277being read from the image due to content in the intermediate backing chain
278overruling the commit target).
279
Max Reitz40055952014-07-22 22:58:42 +0200280@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 +0100281
282Check if two images have the same content. You can compare images with
283different format or settings.
284
285The format is probed unless you specify it by @var{-f} (used for
286@var{filename1}) and/or @var{-F} (used for @var{filename2}) option.
287
288By default, images with different size are considered identical if the larger
289image contains only unallocated and/or zeroed sectors in the area after the end
290of the other image. In addition, if any sector is not allocated in one image
291and contains only zero bytes in the second one, it is evaluated as equal. You
292can use Strict mode by specifying the @var{-s} option. When compare runs in
293Strict mode, it fails in case image size differs or a sector is allocated in
294one image and is not allocated in the second one.
295
296By default, compare prints out a result message. This message displays
297information that both images are same or the position of the first different
298byte. In addition, result message can report different image size in case
299Strict mode is used.
300
301Compare exits with @code{0} in case the images are equal and with @code{1}
302in case the images differ. Other exit codes mean an error occurred during
303execution and standard error output should contain an error message.
304The following table sumarizes all exit codes of the compare subcommand:
305
306@table @option
307
308@item 0
309Images are identical
310@item 1
311Images differ
312@item 2
313Error on opening an image
314@item 3
315Error on checking a sector allocation
316@item 4
317Error on reading data
318
319@end table
320
Max Reitz2b4c0a22017-04-26 15:46:49 +0200321@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 +0000322
Wenchao Xiaef806542013-12-04 17:10:57 +0800323Convert the disk image @var{filename} or a snapshot @var{snapshot_param}(@var{snapshot_id_or_name} is deprecated)
324to disk image @var{output_filename} using format @var{output_fmt}. It can be optionally compressed (@code{-c}
Kevin Wolfeff44262009-06-04 15:39:39 +0200325option) or use any format specific options like encryption (@code{-o} option).
bellardacd935e2004-11-15 22:57:26 +0000326
Kevin Wolf8063d0f2009-10-28 12:49:16 +0100327Only the formats @code{qcow} and @code{qcow2} support compression. The
bellardacd935e2004-11-15 22:57:26 +0000328compression is read-only. It means that if a compressed sector is
329rewritten, then it is rewritten as uncompressed data.
330
bellardacd935e2004-11-15 22:57:26 +0000331Image conversion is also useful to get smaller image when using a
Stefan Hajnoczi550830f2014-09-16 15:24:24 +0100332growable format such as @code{qcow}: the empty sectors are detected and
333suppressed from the destination image.
bellardacd935e2004-11-15 22:57:26 +0000334
Peter Lieven11b66992013-10-24 12:07:05 +0200335@var{sparse_size} indicates the consecutive number of bytes (defaults to 4k)
336that must contain only zeros for qemu-img to create a sparse image during
337conversion. If @var{sparse_size} is 0, the source will not be scanned for
338unallocated or zero sectors, and the destination image will always be
339fully allocated.
340
Kevin Wolf8063d0f2009-10-28 12:49:16 +0100341You can use the @var{backing_file} option to force the output image to be
342created as a copy on write image of the specified base image; the
343@var{backing_file} should have the same content as the input's base image,
344however the path, image format, etc may differ.
345
Alexandre Derumierb2e10492013-09-02 19:07:24 +0100346If the @code{-n} option is specified, the target volume creation will be
347skipped. This is useful for formats such as @code{rbd} if the target
348volume has already been created with site specific options that cannot
349be supplied through qemu-img.
350
Peter Lieven2d9187b2017-02-28 13:40:07 +0100351Out of order writes can be enabled with @code{-W} to improve performance.
352This is only recommended for preallocated devices like host devices or other
353raw block devices. Out of order write does not work in combination with
354creating compressed images.
355
356@var{num_coroutines} specifies how many coroutines work in parallel during
357the convert process (defaults to 8).
358
Reda Sallahif7c15532016-08-10 16:16:09 +0200359@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 +0200360
361Dd copies from @var{input} file to @var{output} file converting it from
362@var{fmt} format to @var{output_fmt} format.
363
364The data is by default read and written using blocks of 512 bytes but can be
365modified by specifying @var{block_size}. If count=@var{blocks} is specified
366dd will stop reading input after reading @var{blocks} input blocks.
367
368The size syntax is similar to dd(1)'s size syntax.
369
Kashyap Chamarthye5357562012-10-18 11:25:34 +0530370@item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
bellardacd935e2004-11-15 22:57:26 +0000371
372Give information about the disk image @var{filename}. Use it in
373particular to know the size reserved on disk which can be different
bellard19d36792006-08-07 21:34:34 +0000374from the displayed size. If VM snapshots are stored in the disk image,
Benoît Canetc054b3f2012-09-05 13:09:02 +0200375they are displayed too. The command can output in the format @var{ofmt}
376which is either @code{human} or @code{json}.
blueswir1d2c639d2009-01-24 18:19:25 +0000377
Kashyap Chamarthye5357562012-10-18 11:25:34 +0530378If a disk image has a backing file chain, information about each disk image in
379the chain can be recursively enumerated by using the option @code{--backing-chain}.
380
381For instance, if you have an image chain like:
382
383@example
384base.qcow2 <- snap1.qcow2 <- snap2.qcow2
385@end example
386
387To enumerate information about each disk image in the above chain, starting from top to base, do:
388
389@example
390qemu-img info --backing-chain snap2.qcow2
391@end example
392
Paolo Bonzinifacd6e22013-09-04 19:00:34 +0200393@item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
394
395Dump the metadata of image @var{filename} and its backing file chain.
396In particular, this commands dumps the allocation state of every sector
397of @var{filename}, together with the topmost file that allocates it in
398the backing file chain.
399
400Two option formats are possible. The default format (@code{human})
401only dumps known-nonzero areas of the file. Known-zero parts of the
402file are omitted altogether, and likewise for parts that are not allocated
403throughout the chain. @command{qemu-img} output will identify a file
404from where the data can be read, and the offset in the file. Each line
405will include four fields, the first three of which are hexadecimal
406numbers. For example the first line of:
407@example
408Offset Length Mapped to File
4090 0x20000 0x50000 /tmp/overlay.qcow2
4100x100000 0x10000 0x95380000 /tmp/backing.qcow2
411@end example
412@noindent
413means that 0x20000 (131072) bytes starting at offset 0 in the image are
414available in /tmp/overlay.qcow2 (opened in @code{raw} format) starting
415at offset 0x50000 (327680). Data that is compressed, encrypted, or
416otherwise not available in raw format will cause an error if @code{human}
417format is in use. Note that file names can include newlines, thus it is
418not safe to parse this output format in scripts.
419
420The alternative format @code{json} will return an array of dictionaries
421in JSON format. It will include similar information in
422the @code{start}, @code{length}, @code{offset} fields;
423it will also include other more specific information:
424@itemize @minus
425@item
426whether the sectors contain actual data or not (boolean field @code{data};
427if false, the sectors are either unallocated or stored as optimized
428all-zero clusters);
429
430@item
431whether the data is known to read as zero (boolean field @code{zero});
432
433@item
434in order to make the output shorter, the target file is expressed as
435a @code{depth}; for example, a depth of 2 refers to the backing file
436of the backing file of @var{filename}.
437@end itemize
438
439In JSON format, the @code{offset} field is optional; it is absent in
440cases where @code{human} format would omit the entry or exit with an error.
441If @code{data} is false and the @code{offset} field is present, the
442corresponding sectors in the file are not yet in use, but they are
443preallocated.
444
445For more information, consult @file{include/block/block.h} in QEMU's
446source code.
447
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +0100448@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}]
449
450Calculate the file size required for a new image. This information can be used
451to size logical volumes or SAN LUNs appropriately for the image that will be
452placed in them. The values reported are guaranteed to be large enough to fit
453the image. The command can output in the format @var{ofmt} which is either
454@code{human} or @code{json}.
455
456If the size @var{N} is given then act as if creating a new empty image file
457using @command{qemu-img create}. If @var{filename} is given then act as if
458converting an existing image file using @command{qemu-img convert}. The format
459of the new file is given by @var{output_fmt} while the format of an existing
460file is given by @var{fmt}.
461
462A snapshot in an existing image can be specified using @var{snapshot_param}.
463
464The following fields are reported:
465@example
466required size: 524288
467fully allocated size: 1074069504
468@end example
469
470The @code{required size} is the file size of the new image. It may be smaller
471than the virtual disk size if the image format supports compact representation.
472
473The @code{fully allocated size} is the file size of the new image once data has
474been written to all sectors. This is the maximum size that the image file can
475occupy with the exception of internal snapshots, dirty bitmaps, vmstate data,
476and other advanced image format features.
477
blueswir1d2c639d2009-01-24 18:19:25 +0000478@item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot} ] @var{filename}
479
480List, apply, create or delete snapshots in image @var{filename}.
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +0100481
Max Reitz40055952014-07-22 22:58:42 +0200482@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 +0100483
484Changes the backing file of an image. Only the formats @code{qcow2} and
485@code{qed} support changing the backing file.
486
487The backing file is changed to @var{backing_file} and (if the image format of
488@var{filename} supports this) the backing file format is changed to
Alex Bligha6166732012-10-16 13:46:18 +0100489@var{backing_fmt}. If @var{backing_file} is specified as ``'' (the empty
490string), then the image is rebased onto no backing file (i.e. it will exist
491independently of any backing file).
Kevin Wolfe6184692011-01-17 15:35:28 +0100492
Max Reitz40055952014-07-22 22:58:42 +0200493@var{cache} specifies the cache mode to be used for @var{filename}, whereas
Stefan Hajnoczi3ba67962014-09-02 11:01:03 +0100494@var{src_cache} specifies the cache mode for reading backing files.
Max Reitz40055952014-07-22 22:58:42 +0200495
Kevin Wolfe6184692011-01-17 15:35:28 +0100496There are two different modes in which @code{rebase} can operate:
497@table @option
498@item Safe mode
499This is the default mode and performs a real rebase operation. The new backing
500file may differ from the old one and qemu-img rebase will take care of keeping
501the guest-visible content of @var{filename} unchanged.
502
503In order to achieve this, any clusters that differ between @var{backing_file}
504and the old backing file of @var{filename} are merged into @var{filename}
505before actually changing the backing file.
506
507Note that the safe mode is an expensive operation, comparable to converting
508an image. It only works if the old backing file still exists.
509
510@item Unsafe mode
511qemu-img uses the unsafe mode if @code{-u} is specified. In this mode, only the
512backing file name and format of @var{filename} is changed without any checks
513on the file contents. The user must take care of specifying the correct new
514backing file, or the guest-visible content of the image will be corrupted.
515
516This mode is useful for renaming or moving the backing file to somewhere else.
517It can be used without an accessible old backing file, i.e. you can use it to
518fix an image whose backing file has already been moved/renamed.
519@end table
520
Richard W.M. Jones9fda6ab2012-05-21 14:58:05 +0100521You can use @code{rebase} to perform a ``diff'' operation on two
522disk images. This can be useful when you have copied or cloned
523a guest, and you want to get back to a thin image on top of a
524template or base image.
525
526Say that @code{base.img} has been cloned as @code{modified.img} by
527copying it, and that the @code{modified.img} guest has run so there
528are now some changes compared to @code{base.img}. To construct a thin
529image called @code{diff.qcow2} that contains just the differences, do:
530
531@example
532qemu-img create -f qcow2 -b modified.img diff.qcow2
533qemu-img rebase -b base.img diff.qcow2
534@end example
535
536At this point, @code{modified.img} can be discarded, since
537@code{base.img + diff.qcow2} contains the same information.
538
Max Reitzdc5f6902017-06-13 22:20:55 +0200539@item resize [--preallocation=@var{prealloc}] @var{filename} [+ | -]@var{size}
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +0100540
541Change the disk image as if it had been created with @var{size}.
542
543Before using this command to shrink a disk image, you MUST use file system and
544partitioning tools inside the VM to reduce allocated file systems and partition
545sizes accordingly. Failure to do so will result in data loss!
546
547After using this command to grow a disk image, you must use file system and
548partitioning tools inside the VM to actually begin using the new space on the
549device.
Max Reitz6f176b42013-09-03 10:09:50 +0200550
Max Reitzdc5f6902017-06-13 22:20:55 +0200551When growing an image, the @code{--preallocation} option may be used to specify
552how the additional image area should be allocated on the host. See the format
553description in the @code{NOTES} section which values are allowed. Using this
554option may result in slightly more data being allocated than necessary.
555
Max Reitz76a3a342014-10-27 11:12:51 +0100556@item amend [-p] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
Max Reitz6f176b42013-09-03 10:09:50 +0200557
558Amends the image format specific @var{options} for the image file
559@var{filename}. Not all file formats support this operation.
bellardacd935e2004-11-15 22:57:26 +0000560@end table
Kevin Wolfd3067b02012-11-21 14:21:47 +0100561@c man end
bellardacd935e2004-11-15 22:57:26 +0000562
Kevin Wolfd3067b02012-11-21 14:21:47 +0100563@ignore
564@c man begin NOTES
Kevin Wolff932c042009-10-28 12:49:15 +0100565Supported image file formats:
566
567@table @option
568@item raw
569
570Raw disk image format (default). This format has the advantage of
571being simple and easily exportable to all other emulators. If your
572file system supports @emph{holes} (for example in ext2 or ext3 on
573Linux or NTFS on Windows), then only the written sectors will reserve
574space. Use @code{qemu-img info} to know the real size used by the
575image or @code{ls -ls} on Unix/Linux.
576
Hu Tao06247422014-09-10 17:05:48 +0800577Supported options:
578@table @code
579@item preallocation
580Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
581@code{falloc} mode preallocates space for image by calling posix_fallocate().
582@code{full} mode preallocates space for image by writing zeros to underlying
583storage.
584@end table
585
Kevin Wolff932c042009-10-28 12:49:15 +0100586@item qcow2
587QEMU image format, the most versatile format. Use it to have smaller
588images (useful if your filesystem does not supports holes, for example
589on Windows), optional AES encryption, zlib based compression and
590support of multiple VM snapshots.
Kevin Wolf8063d0f2009-10-28 12:49:16 +0100591
Kevin Wolf3e032362009-10-28 12:49:17 +0100592Supported options:
593@table @code
Kevin Wolfd3067b02012-11-21 14:21:47 +0100594@item compat
Stefan Hajnoczi7fa9e1f2014-01-06 12:39:01 +0800595Determines the qcow2 version to use. @code{compat=0.10} uses the
596traditional image format that can be read by any QEMU since 0.10.
Kevin Wolfd3067b02012-11-21 14:21:47 +0100597@code{compat=1.1} enables image format extensions that only QEMU 1.1 and
Stefan Hajnoczi7fa9e1f2014-01-06 12:39:01 +0800598newer understand (this is the default). Amongst others, this includes zero
599clusters, which allow efficient copy-on-read for sparse images.
Kevin Wolfd3067b02012-11-21 14:21:47 +0100600
Kevin Wolf3e032362009-10-28 12:49:17 +0100601@item backing_file
602File name of a base image (see @option{create} subcommand)
603@item backing_fmt
604Image format of the base image
605@item encryption
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000606If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
Kevin Wolf3e032362009-10-28 12:49:17 +0100607
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000608The use of encryption in qcow and qcow2 images is considered to be flawed by
609modern cryptography standards, suffering from a number of design problems:
610
611@itemize @minus
Daniel P. Berrange0b4ee902017-06-23 17:24:02 +0100612@item
613The AES-CBC cipher is used with predictable initialization vectors based
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000614on the sector number. This makes it vulnerable to chosen plaintext attacks
615which can reveal the existence of encrypted data.
Daniel P. Berrange0b4ee902017-06-23 17:24:02 +0100616@item
617The user passphrase is directly used as the encryption key. A poorly
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000618chosen or short passphrase will compromise the security of the encryption.
Daniel P. Berrange0b4ee902017-06-23 17:24:02 +0100619@item
620In the event of the passphrase being compromised there is no way to
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000621change the passphrase to protect data in any qcow images. The files must
622be cloned, using a different encryption passphrase in the new file. The
623original file must then be securely erased using a program like shred,
624though even this is ineffective with many modern storage technologies.
Daniel P. Berrange0b4ee902017-06-23 17:24:02 +0100625@item
626Initialization vectors used to encrypt sectors are based on the
627guest virtual sector number, instead of the host physical sector. When
628a disk image has multiple internal snapshots this means that data in
629multiple physical sectors is encrypted with the same initialization
630vector. With the CBC mode, this opens the possibility of watermarking
631attacks if the attack can collect multiple sectors encrypted with the
632same IV and some predictable data. Having multiple qcow2 images with
633the same passphrase also exposes this weakness since the passphrase
634is directly used as the key.
Daniel P. Berrange136cd192014-01-22 15:47:10 +0000635@end itemize
636
637Use of qcow / qcow2 encryption is thus strongly discouraged. Users are
638recommended to use an alternative encryption technology such as the
639Linux dm-crypt / LUKS system.
Kevin Wolf3e032362009-10-28 12:49:17 +0100640
641@item cluster_size
642Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
643sizes can improve the image file size whereas larger cluster sizes generally
644provide better performance.
645
646@item preallocation
Hu Tao0e4271b2014-09-10 17:05:49 +0800647Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
648@code{full}). An image with preallocated metadata is initially larger but can
649improve performance when the image needs to grow. @code{falloc} and @code{full}
650preallocations are like the same options of @code{raw} format, but sets up
651metadata also.
Kevin Wolf3e032362009-10-28 12:49:17 +0100652
Kevin Wolfd3067b02012-11-21 14:21:47 +0100653@item lazy_refcounts
654If this option is set to @code{on}, reference count updates are postponed with
655the goal of avoiding metadata I/O and improving performance. This is
656particularly interesting with @option{cache=writethrough} which doesn't batch
657metadata updates. The tradeoff is that after a host crash, the reference count
658tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
659check -r all} is required, which may take some time.
660
661This option can only be enabled if @code{compat=1.1} is specified.
662
Chunyan Liu4ab15592014-06-30 14:29:58 +0800663@item nocow
Chunyan Liubc3a7f92014-07-02 12:27:29 +0800664If 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 +0800665valid on btrfs, no effect on other file systems.
666
667Btrfs has low performance when hosting a VM image file, even more when the guest
668on the VM also using btrfs as file system. Turning off COW is a way to mitigate
669this bad performance. Generally there are two ways to turn off COW on btrfs:
670a) Disable it by mounting with nodatacow, then all newly created files will be
671NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
672does.
673
674Note: this option is only valid to new or empty files. If there is an existing
675file which is COW and has data blocks already, it couldn't be changed to NOCOW
676by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
Chunyan Liubc3a7f92014-07-02 12:27:29 +0800677the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
Chunyan Liu4ab15592014-06-30 14:29:58 +0800678
Kevin Wolf3e032362009-10-28 12:49:17 +0100679@end table
680
Kevin Wolfd3067b02012-11-21 14:21:47 +0100681@item Other
682QEMU also supports various other image file formats for compatibility with
Jeff Cody8282db12013-12-17 13:56:06 -0500683older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), VHDX,
684qcow1 and QED. For a full list of supported formats see @code{qemu-img --help}.
Kevin Wolfd3067b02012-11-21 14:21:47 +0100685For a more detailed description of these formats, see the QEMU Emulation User
686Documentation.
Stefan Hajnoczif0858002012-06-13 14:29:15 +0100687
Kevin Wolfd3067b02012-11-21 14:21:47 +0100688The main purpose of the block drivers for these formats is image conversion.
689For running VMs, it is recommended to convert the disk images to either raw or
690qcow2 in order to achieve good performance.
Kevin Wolff932c042009-10-28 12:49:15 +0100691@end table
692
693
bellardacd935e2004-11-15 22:57:26 +0000694@c man end
695
bellardacd935e2004-11-15 22:57:26 +0000696@setfilename qemu-img
697@settitle QEMU disk image utility
698
699@c man begin SEEALSO
700The HTML documentation of QEMU for more precise information and Linux
701user mode emulator invocation.
702@c man end
703
704@c man begin AUTHOR
705Fabrice Bellard
706@c man end
707
708@end ignore