Manpages

名 前

virt-sparsify - 仮 想 マ シ ン の デ ィ ス ク を ス パ ー ス に し ま す

書 式

virt-sparsify [--options] indisk outdisk
virt-sparsify [--options] --in-place disk

説 明

Virt-sparsify is a tool which can make a virtual machine disk (or any disk image) sparse a.k.a. thin-provisioned. This means that free space within the disk image can be converted back to free space on the host.

Virt-sparsify can locate and sparsify free space in most filesystems (eg. ext2/3/4, btrfs, NTFS, etc.), and also in LVM physical volumes.

Virt-sparsify は さ ま ざ ま な デ ィ ス ク フ ォ ー マ ッ ト を 変 換 す る こ と が で き ま す 。 例 え ば 、 raw デ ィ ス ク イ メ ー ジ を シ ン プ ロ ビ ジ ョ ニ ン グ さ れ た qcow2 イ メ ー ジ に 変 換 す る こ と が で き ま す 。

Virt-sparsify can operate on any disk image, not just ones from virtual machines. However if a virtual machine has multiple disks and uses volume management, then virt-sparsify will work but not be very effective (http://bugzilla.redhat.com/887826).

IMPORTANT NOTE ABOUT SPARSE OUTPUT IMAGES
If the input is raw, then the default output is raw sparse. You must check the output size using a tool that understands sparseness such as "du -sh". It can make a huge difference:

$ ls -lh test1.img
-rw-rw-r--. 1 rjones rjones 100M Aug 8 08:08 test1.img
$ du -sh test1.img
3.6M test1.img

(見 た 目 の 容 量 100M と 実 際 の 容 量 3.6M を 比 較 し ま す )

IMPORTANT LIMITATIONS

If you are using the --in-place option, then large amounts of temporary space are not required.

You may also want to read the manual pages for the associated tools virt-filesystems(1) and virt-df(1) before starting.

例

一 般 的 な 使 用 法 は 次 の と お り で す :

virt-sparsify indisk outdisk

which copies "indisk" to "outdisk", making the output sparse. "outdisk" is created, or overwritten if it already exists. The format of the input disk is detected (eg. qcow2) and the same format is used for the output disk. 形 式 を 変 換 す る に は --convert オ プ シ ョ ン を 使 用 し ま す :

virt-sparsify disk.raw --convert qcow2 disk.qcow2

Virt-sparsify tries to zero and sparsify free space on every filesystem it can find within the source disk image. You can get it to ignore (don’t zero free space on) certain filesystems by doing:

virt-sparsify --ignore /dev/sda1 indisk outdisk デ ィ ス ク イ メ ー ジ に あ る フ ァ イ ル シ ス テ ム の 一 覧 を 取 得 す る に は virt-filesystems(1) を 参 照 し て く だ さ い 。

Since virt-sparsify ≥ 1.26, you can now sparsify a disk image in place by doing:

virt-sparsify --in-place disk.img

オ プ シ ョ ン

--help ヘ ル プ を 表 示 し ま す 。
--check-tmpdir ignore
--check-tmpdir continue
--check-tmpdir warn
--check-tmpdir fail

Check if "TMPDIR" or --tmp directory has enough space to complete the operation. This is just an estimate.

If the check indicates a problem, then you can either:

You cannot use this option and --in-place together.

--colors
--colours

Use ANSI colour sequences to colourize messages. This is the default when the output is a tty. If the output of the program is redirected to a file, ANSI colour sequences are disabled unless you use this option.

--compress 出 力 フ ァ イ ル を 圧 縮 し ま す 。 こ れ は 出 力 形 式 が "qcow2" の 場 合 の み 機 能 し ま す 。

You cannot use this option and --in-place together.

--convert raw
--convert qcow2
--convert [other formats]

Use "output-format" as the format for the destination image. If this is not specified, then the input format is used. サ ポ ー ト さ れ る 既 知 の 動 作 済 み 出 力 形 式 は 次 の と お り で す : "raw", "qcow2", "vdi"。

qemu-img(1) プ ロ グ ラ ム に よ り サ ポ ー ト さ れ る す べ て の 形 式 を 使 用 で き ま す 。 た と え ば 、 "vmdk" で す が 、 他 の 形 式 の サ ポ ー ト は QEMU に 依 存 し ま す 。

Specifying the --convert option is usually a good idea, because then virt-sparsify doesn’t need to try to guess the input format. 出 力 形 式 を 詳 細 に 調 整 し ま す 。 関 連 項 目 : --compress, -o.

You cannot use this option and --in-place together.

--echo-keys

When prompting for keys and passphrases, virt-sparsify normally turns echoing off so you cannot see what you are typing. If you are not worried about Tempest attacks and there is no one else in the room you can specify this flag to see what you are typing.

--format raw
--format qcow2

Specify the format of the input disk image. If this flag is not given then it is auto-detected from the image itself.

If working with untrusted raw-format guest disk images, you should ensure the format is always specified.

--ignore filesystem
--ignore volgroup

Ignore the named filesystem.

When not using --in-place: Free space on the filesystem will not be zeroed, but existing blocks of zeroes will still be sparsified.

When using --in-place, the filesystem is ignored completely.

In the second form, this ignores the named volume group. Use the volume group name without the /dev/ prefix, eg. --ignore vg_foo こ の オ プ シ ョ ン は 複 数 回 指 定 で き ま す 。

--in-place

Do in-place sparsification instead of copying sparsification. See "IN-PLACE SPARSIFICATION" below.

--key SELECTOR

Specify a key for LUKS, to automatically open a LUKS device when using the inspection.
--key NAME:key:KEY_STRING
--key UUID:key:KEY_STRING
--key all:key:KEY_STRING

"NAME" is the libguestfs device name (eg. "/dev/sda1"). "UUID" is the device UUID. "all" means try the key against any encrypted device.

Use the specified "KEY_STRING" as passphrase.

--key NAME:file:FILENAME
--key UUID:file:FILENAME
--key all:file:FILENAME

Read the passphrase from FILENAME.

--key NAME:clevis
--key UUID:clevis
--key all:clevis

Attempt passphrase-less unlocking for the device with Clevis, over the network. Please refer to "ENCRYPTED DISKS" in guestfs(3) for more information on network-bound disk encryption (NBDE).

Note that if any such option is present on the command line, QEMU user networking will be automatically enabled for the libguestfs appliance.

--keys-from-stdin

Read key or passphrase parameters from stdin. The default is to try to read passphrases from the user by opening /dev/tty.

If there are multiple encrypted devices then you may need to supply multiple keys on stdin, one per line.

--machine-readable
--machine-readable=format こ の オ プ シ ョ ン は 、 他 の プ ロ グ ラ ム に よ り 解 析 さ れ る と き に 、 よ り マ シ ン に 易 し い 出 力 を 作 成 す る た め に 使 用 さ れ ま す 。 以 下 の "マ シ ン 可 読 な 出 力 " 参 照 。
-o option[,option,...]

Pass -o option(s) to the qemu-img(1) command to fine-tune the output format. Options available depend on the output format (see --convert) and the installed version of the qemu-img program.

You should use -o at most once. To pass multiple options, separate them with commas, eg:

virt-sparsify --convert qcow2 \
-o cluster_size=512,preallocation=metadata ...

You cannot use this option and --in-place together.

--quiet

This disables progress bars and other unnecessary output.

--tmp block_device
--tmp dir

In copying mode only, use the named device or directory as the location of the temporary overlay (see also "TMPDIR" below).

If the parameter given is a block device, then the block device is written to directly. Note this erases the existing contents of the block device.

If the parameter is a directory, then this is the same as setting the "TMPDIR" environment variable.

You cannot use this option and --in-place together.

--tmp prebuilt:file

In copying mode only, the specialized option --tmp prebuilt:file (where "prebuilt:" is a literal string) causes virt-sparsify to use the qcow2 "file" as temporary space.

This option is used by oVirt which requires a specially formatted temporary file.

--verbose デ バ ッ グ 用 の 冗 長 な メ ッ セ ー ジ を 有 効 に し ま す 。

--version バ ー ジ ョ ン 番 号 を 表 示 し て 、 終 了 し ま す 。
--wrap

Wrap error, warning, and informative messages. This is the default when the output is a tty. If the output of the program is redirected to a file, wrapping is disabled unless you use this option.

--zero パ ー テ ィ シ ョ ン
--zero 論 理 ボ リ ュ ー ム 仮 想 マ シ ン に あ る 名 前 付 き パ ー テ ィ シ ョ ン ま た は 論 理 ボ リ ュ ー ム の 内 容 を ゼ ロ 上 書 き し ま す 。 デ バ イ ス に あ る す べ て の デ ー タ は 失 わ れ ま す 。 し か し 、 ス パ ー ス 化 は 素 晴 ら し い こ と で す ！ こ の オ プ シ ョ ン を 複 数 回 指 定 で き ま す 。

IN-PLACE SPARSIFICATION

Since virt-sparsify ≥ 1.26, the tool is able to do in-place sparsification (instead of copying from an input disk to an output disk). This is more efficient. It is not able to recover quite as much space as copying sparsification.

To use this mode, specify a disk image which will be modified in place:

virt-sparsify --in-place disk.img

Some options are not compatible with this mode: --convert, --compress and -o because they require wholesale disk format changes; --check-tmpdir because large amounts of temporary space are not required.

In-place sparsification works using discard (a.k.a trim or unmap) support.

マ シ ン 可 読 な 出 力

The --machine-readable option can be used to make the output more machine friendly, which is useful when calling virt-sparsify from other programs, GUIs etc. こ の オ プ シ ョ ン を 使 用 す る に は 2 通 り の 方 法 が あ り ま す 。

Firstly use the option on its own to query the capabilities of the virt-sparsify binary. Typical output looks like this:

$ virt-sparsify --machine-readable
virt-sparsify
ntfs
btrfs

A list of features is printed, one per line, and the program exits with status 0.

Secondly use the option in conjunction with other options to make the regular program output more machine friendly.

At the moment this means:

^[0-9]+/[0-9]+$

All versions of virt-sparsify have supported the --machine-readable option.

It is possible to specify a format string for controlling the output; see "ADVANCED MACHINE READABLE OUTPUT" in guestfs(3).

WINDOWS 8

Windows 8 "fast startup" can prevent virt-sparsify from working. See "WINDOWS HIBERNATION AND WINDOWS 8 FAST STARTUP" in guestfs(3).

環 境 変 数

TMPDIR

Location of the temporary directory used for the potentially large temporary overlay file.

In virt-sparsify ≥ 1.28, you can override this environment variable using the --tmp option.

You should ensure there is enough free space in the worst case for a full copy of the source disk (virtual size), or else set $TMPDIR to point to another directory that has enough space.

This defaults to /tmp.

Note that if $TMPDIR is a tmpfs (eg. if /tmp is on tmpfs, or if you use "TMPDIR=/dev/shm"), tmpfs defaults to a maximum size of half of physical RAM. If virt-sparsify exceeds this, it will hang. The solution is either to use a real disk, or to increase the maximum size of the tmpfs mountpoint, eg:

mount -o remount,size=10G /tmp

If you are using the --in-place option, then large amounts of temporary space are not required. 他 の 環 境 変 数 は "環 境 変 数 " in guestfs(3) を 参 照 し て く だ さ い 。

終 了 ス テ ー タ ス

This program returns 0 if the operation completed without errors. (This doesn’t necessarily mean that space could be freed up.)

A non-zero exit code indicates an error.

If the exit code is 3 and the --in-place option was used, that indicates that discard support is not available in libguestfs, so copying mode must be used instead.

関 連 項 目

virt-df(1), virt-filesystems(1), virt-resize(1), virt-rescue(1), guestfs(3), guestfish(1), truncate(1), fallocate(1), qemu-img(1), http://libguestfs.org/.

著 者

Richard W.M. Jones http://people.redhat.com/~rjones/

COPYRIGHT

Copyright (C) 2011-2023 Red Hat Inc.

LICENSE

BUGS

To get a list of bugs against libguestfs, use this link: https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools

To report a new bug against libguestfs, use this link: https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools

When reporting a bug, please supply: