Lines Matching full:is
18 querying an image that is being modified by another process may encounter
46 *FILENAME* is a disk image filename.
48 *FMT* is the disk image format. It is guessed automatically in most
51 *SIZE* is the disk image size in bytes. Optional suffixes ``k`` or
53 1024M) and T (terabyte, 1024G) are supported. ``b`` is ignored.
55 *OUTPUT_FILENAME* is the destination disk image filename.
57 *OUTPUT_FMT* is the destination format.
59 *OPTIONS* is a comma separated list of format specific options in a
63 *SNAPSHOT_PARAM* is param used for internal snapshot, format is
74 is a QEMU user creatable object definition. See the :manpage:`qemu(1)`
76 object type is a ``secret``, which is used to supply passwords and/or
81 Indicates that the source *FILENAME* parameter is to be interpreted as a
82 full option string, not a plain filename. This parameter is mutually
88 a full option string, not a plain filename. This parameter is mutually
89 exclusive with the *-O* parameters. It is currently required to also use
97 get the image information (with 'info' subcommand) when the image is used by a
99 concurrent metadata changes, etc. This option is only allowed when opening
122 If the *-p* option is not used for a command that supports it, the
123 progress is reported when the process receives a ``SIGUSR1`` or
134 for ``qemu-img`` to create a sparse image during conversion. This value is
185 but is only recommended for preallocated devices like host devices or other
191 improve performance if the data is remote, such as with NFS or iSCSI backends,
206 .. option:: --target-is-zero
209 zeros. This parameter is mutually exclusive with a destination image
210 that has a backing file. It is required to also use the ``-n``
243 Is the name of the snapshot to create, apply or delete
279 Run a simple sequential I/O benchmark on the specified image. If ``-w`` is
280 specified, a write test is performed, otherwise a read test is performed.
282 A total number of *COUNT* I/O requests is performed, each *BUFFER_SIZE*
285 the current position by *STEP_SIZE*. If *STEP_SIZE* is not given,
286 *BUFFER_SIZE* is used for its value.
288 If *FLUSH_INTERVAL* is specified for a write test, the request queue is
289 drained and a flush is issued before new writes are made whenever the number of
290 remaining requests is a multiple of *FLUSH_INTERVAL*. If additionally
291 ``--no-drain`` is specified, a flush is issued without draining the request
294 if ``-i`` is specified, *AIO* option can be used to specify different
297 If ``-n`` is specified, the native AIO backend is used if possible. On
298 Linux, this option only works if ``-t none`` or ``-t directsync`` is
301 For write tests, by default a buffer filled with zeros is written. This can be
331 output in the format *OFMT* which is either ``human`` or ``json``.
332 The JSON output is an object of QAPI type ``ImageCheck``.
334 If ``-r`` is specified, qemu-img tries to repair any inconsistencies found
347 Check completed, the image is (now) consistent
351 Check completed, image is corrupted
353 Check completed, image has leaked clusters, but is not corrupted
357 If ``-r`` is specified, exit codes representing the image state refer to the
358 state after (the attempt at) repairing it. That is, a successful ``-r all``
364 If the backing file is smaller than the snapshot, then the backing file will be
365 resized to be the same size as the snapshot. If the snapshot is smaller than
370 The image *FILENAME* is emptied after the operation has succeeded. If you do
377 chain). If *BASE* is not specified, the immediate backing file of the top
378 image (which is *FILENAME*) will be used. Note that after a commit operation
383 The rate limit for the commit process is specified by ``-r``.
390 The format is probed unless you specify it by ``-f`` (used for
395 of the other image. In addition, if any sector is not allocated in one image
396 and contains only zero bytes in the second one, it is evaluated as equal. You
398 Strict mode, it fails in case image size differs or a sector is allocated in
399 one image and is not allocated in the second one.
404 Strict mode is used.
422 .. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [-…
430 compression is read-only. It means that if a compressed sector is
431 rewritten, then it is rewritten as uncompressed data.
433 Image conversion is also useful to get smaller image when using a
439 conversion. If *SPARSE_SIZE* is 0, the source will not be scanned for
448 If a relative path name is given, the backing file is looked up relative to
451 If the ``-n`` option is specified, the target volume creation will be
452 skipped. This is useful for formats such as ``rbd`` if the target
457 This is only recommended for preallocated devices like host devices or other
465 the original are also copied to the destination. If any bitmap is
467 ``--skip-broken-bitmaps`` is also specified to copy only the
476 If the option *BACKING_FILE* is specified, then the image will record
481 If a relative path name is given, the backing file is looked up relative to
484 Note that a given backing file will be opened to check that it is valid. Use
500 The data is by default read and written using blocks of 512 bytes but can be
501 modified by specifying *BLOCK_SIZE*. If count=\ *BLOCKS* is specified
504 The size syntax is similar to :manpage:`dd(1)`'s size syntax.
528 The command can output in the format *OFMT* which is either ``human`` or
529 ``json``. The JSON output is an object of QAPI type ``ImageInfo``; with
530 ``--backing-chain``, it is an array of ``ImageInfo`` objects.
546 shown as 0 if this information is unavailable, e.g. because there is no
553 Whether the image is encrypted (only present if so)
556 This is shown as ``no`` if the image is dirty and will have to be
557 auto-repaired the next time it is opened in qemu.
570 section is a textual representation of the respective
597 at offset 0x50000 (327680). Data that is compressed, encrypted, or
599 format is in use. Note that file names can include newlines, thus it is
610 - boolean field ``zero``: true if the data is known to read as zero
618 In JSON format, the ``offset`` field is optional; it is absent in
620 If ``data`` is false and the ``offset`` field is present, the
633 output in the format *OFMT* which is either ``human`` or ``json``.
634 The JSON output is an object of QAPI type ``BlockMeasureInfo``.
636 If the size *N* is given then act as if creating a new empty image file
637 using ``qemu-img create``. If *FILENAME* is given then act as if
639 of the new file is given by *OUTPUT_FMT* while the format of an existing
640 file is given by *FMT*.
652 The ``required size`` is the file size of the new image. It may be smaller
655 The ``fully allocated size`` is the file size of the new image once data has
656 been written to all sectors. This is the maximum size that the image file can
660 The ``bitmaps size`` is the additional size required in order to
662 data; the line is omitted if either source or destination lacks
663 bitmap support, or 0 if bitmaps are supported but there is nothing
675 The backing file is changed to *BACKING_FILE* and (if the image format of
676 *FILENAME* supports this) the backing file format is changed to
677 *BACKING_FMT*. If *BACKING_FILE* is specified as "" (the empty
678 string), then the image is rebased onto no backing file (i.e. it will exist
681 If a relative path name is given, the backing file is looked up relative to
690 This is the default mode and performs a real rebase operation. The
701 Note that the safe mode is an expensive operation, comparable to
706 ``qemu-img`` uses the unsafe mode if ``-u`` is specified. In this
707 mode, only the backing file name and format of *FILENAME* is changed
712 This mode is useful for renaming or moving the backing file to
794 newer understand (this is the default). Amongst others, this includes zero
806 cause the image to actually receive compressed writes. It is most commonly
812 ``compat=0.10``, only ``zlib`` compression is available.
815 If this option is set to ``on``, the image is encrypted with
818 The use of encryption in qcow and qcow2 images is considered to be
822 - The AES-CBC cipher is used with predictable initialization
827 - The user passphrase is directly used as the encryption key. A
831 - In the event of the passphrase being compromised there is no way
835 using a program like shred, though even this is ineffective with
841 means that data in multiple physical sectors is encrypted with
846 passphrase also exposes this weakness since the passphrase is
849 Use of qcow / qcow2 encryption is thus strongly discouraged. Users are
860 ``falloc``, ``full``). An image with preallocated metadata is
866 If this option is set to ``on``, reference count updates are
868 performance. This is particularly interesting with
870 updates. The tradeoff is that after a host crash, the reference
872 ``qemu-img check -r all`` is required, which may take some time.
874 This option can only be enabled if ``compat=1.1`` is specified.
877 If this option is set to ``on``, it will turn off COW of the file. It's
882 off COW is a way to mitigate this bad performance. Generally there
890 Note: this option is only valid to new or empty files. If there is
891 an existing file which is COW and has data blocks already, it
893 issue ``lsattr filename`` to check if the NOCOW flag is set or not
894 (Capital 'C' is NOCOW flag).
897 Filename where all guest data will be stored. If this option is used,
907 If this option is set to ``on``, QEMU will always keep the external data
911 the raw data file, including their offsets. Therefore, data that is visible
912 on the qcow2 node (i.e., to the guest) at some offset is visible at the same
918 If this option is ``off``, QEMU will use the data file to store data in an
920 accompanying qcow2 metadata. Where data is written will have no relation to
925 This option can only be enabled if ``data_file`` is set.
936 The main purpose of the block drivers for these formats is image
937 conversion. For running VMs, it is recommended to convert the disk