File: virt-sparsify.1

package info (click to toggle)
libguestfs 1%3A1.18.1-1%2Bdeb7u3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 49,156 kB
  • sloc: ansic: 282,408; ml: 22,707; sh: 16,121; perl: 5,946; java: 5,047; cs: 4,329; makefile: 3,191; haskell: 2,564; erlang: 1,510; python: 1,502; xml: 509; ruby: 217; pascal: 142; cpp: 11
file content (342 lines) | stat: -rw-r--r-- 13,120 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "virt-sparsify 1"
.TH virt-sparsify 1 "2012-06-01" "libguestfs-1.18.1" "Virtualization Support"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "名前"
.IX Header "名前"
virt-sparsify \- 仮想マシンのディスクをスパースにします
.SH "書式"
.IX Header "書式"
.Vb 1
\& virt\-sparsify [\-\-options] indisk outdisk
.Ve
.SH "説明"
.IX Header "説明"
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.
.PP
Virt-sparsify can locate and sparsify free space in most filesystems
(eg. ext2/3/4, btrfs, \s-1NTFS\s0, etc.), and also in \s-1LVM\s0 physical volumes.
.PP
Virt-sparsify はさまざまなディスクフォーマットを変換することができます。例えば、raw ディスクイメージをシンプロビジョニングされた
qcow2 イメージに変換することができます。
.PP
Virt-sparsify can operate on any disk image, not just ones from virtual
machines.  If a virtual machine has more than one attached disk, you must
sparsify each one separately.
.SS "\s-1IMPORTANT\s0 \s-1LIMITATIONS\s0"
.IX Subsection "IMPORTANT LIMITATIONS"
.IP "\(bu" 4
Virt-sparsify does not do in-place modifications.  It copies from a source
image to a destination image, leaving the source unchanged.  \fICheck that
the sparsification was successful before deleting the source image\fR.
.IP "\(bu" 4
The virtual machine \fImust be shut down\fR before using this tool.
.IP "\(bu" 4
Virt-sparsify may require up to 2x the virtual size of the source disk image
(1 temporary copy + 1 destination image).  This is in the worst case and
usually much less space is required.
.IP "\(bu" 4
Virt-sparsify cannot resize disk images.  To do that, use \fIvirt\-resize\fR\|(1).
.IP "\(bu" 4
virt-sparsify は暗号化されたディスクを処理できません。 libguestfs
は暗号化されたディスクをサポートしますが、暗号化されたディスク自体はスパース化できません。
.IP "\(bu" 4
Virt-sparsify cannot yet sparsify the space between partitions.  Note that
this space is often used for critical items like bootloaders so it's not
really unused.
.PP
You may also want to read the manual pages for the associated tools
\&\fIvirt\-filesystems\fR\|(1) and \fIvirt\-df\fR\|(1) before starting.
.SH "例"
.IX Header "例"
一般的な使用法は次のとおりです:
.PP
.Vb 1
\& virt\-sparsify indisk outdisk
.Ve
.PP
which copies \f(CW\*(C`indisk\*(C'\fR to \f(CW\*(C`outdisk\*(C'\fR, making the output sparse.  \f(CW\*(C`outdisk\*(C'\fR
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.
.PP
形式を変換するには \fI\-\-convert\fR オプションを使用します:
.PP
.Vb 1
\& virt\-sparsify disk.raw \-\-convert qcow2 disk.qcow2
.Ve
.PP
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:
.PP
.Vb 1
\& virt\-sparsify \-\-ignore /dev/sda1 indisk outdisk
.Ve
.PP
ディスクイメージにあるファイルシステムの一覧を取得するには \fIvirt\-filesystems\fR\|(1) を参照してください。
.SH "オプション"
.IX Header "オプション"
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
ヘルプを表示します。
.IP "\fB\-\-compress\fR" 4
.IX Item "--compress"
出力ファイルを圧縮します。これは 出力形式が \f(CW\*(C`qcow2\*(C'\fR の場合 \fIのみ\fR 機能します。
.IP "\fB\-\-convert\fR raw" 4
.IX Item "--convert raw"
.PD 0
.IP "\fB\-\-convert\fR qcow2" 4
.IX Item "--convert qcow2"
.IP "\fB\-\-convert\fR [other formats]" 4
.IX Item "--convert [other formats]"
.PD
Use \f(CW\*(C`output\-format\*(C'\fR as the format for the destination image.  If this is
not specified, then the input format is used.
.Sp
サポートされる既知の動作済み出力形式は次のとおりです: \f(CW\*(C`raw\*(C'\fR, \f(CW\*(C`qcow2\*(C'\fR, \f(CW\*(C`vdi\*(C'\fR。
.Sp
\&\fIqemu\-img\fR\|(1) プログラムによりサポートされるすべての形式を使用できます。たとえば、\f(CW\*(C`vmdk\*(C'\fR ですが、他の形式のサポートは \s-1QEMU\s0
に依存します。
.Sp
Specifying the \fI\-\-convert\fR option is usually a good idea, because then
virt-sparsify doesn't need to try to guess the input format.
.Sp
出力形式を詳細に調整します。関連項目: \fI\-\-compress\fR, \fI\-o\fR.
.IP "\fB\-\-debug\-gc\fR" 4
.IX Item "--debug-gc"
ガベージコレクションおよびメモリー割り当てをデバッグします。これは virt-sparsify におけるメモリー問題または OCaml
libguestfs バインドをデバッグするときのみ有用です。
.IP "\fB\-\-format\fR raw" 4
.IX Item "--format raw"
.PD 0
.IP "\fB\-\-format\fR qcow2" 4
.IX Item "--format qcow2"
.PD
Specify the format of the input disk image.  If this flag is not given then
it is auto-detected from the image itself.
.Sp
If working with untrusted raw-format guest disk images, you should ensure
the format is always specified.
.IP "\fB\-\-ignore\fR filesystem" 4
.IX Item "--ignore filesystem"
.PD 0
.IP "\fB\-\-ignore\fR volgroup" 4
.IX Item "--ignore volgroup"
.PD
Ignore the named filesystem.  Free space on the filesystem will not be
zeroed, but existing blocks of zeroes will still be sparsified.
.Sp
In the second form, this ignores the named volume group.  Use the volume
group name without the \f(CW\*(C`/dev/\*(C'\fR prefix, eg. \fI\-\-ignore vg_foo\fR
.Sp
このオプションは複数回指定できます。
.IP "\fB\-\-machine\-readable\fR" 4
.IX Item "--machine-readable"
このオプションは、他のプログラムにより解析されるときに、よりマシンに易しい出力を作成するために使用されます。以下の \*(L"マシン可読な出力\*(R" 参照。
.IP "\fB\-o\fR option[,option,...]" 4
.IX Item "-o option[,option,...]"
Pass \fI\-o\fR option(s) to the \fIqemu\-img\fR\|(1) command to fine-tune the output
format.  Options available depend on the output format (see \fI\-\-convert\fR)
and the installed version of the qemu-img program.
.Sp
You should use \fI\-o\fR at most once.  To pass multiple options, separate them
with commas, eg:
.Sp
.Vb 2
\& virt\-sparsify \-\-convert qcow2 \e
\&   \-o cluster_size=512,preallocation=metadata ...
.Ve
.IP "\fB\-q\fR" 4
.IX Item "-q"
.PD 0
.IP "\fB\-\-quiet\fR" 4
.IX Item "--quiet"
.PD
This disables progress bars and other unnecessary output.
.IP "\fB\-v\fR" 4
.IX Item "-v"
.PD 0
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
.PD
デバッグ用の冗長なメッセージを有効にします。
.IP "\fB\-V\fR" 4
.IX Item "-V"
.PD 0
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
.PD
バージョン番号を表示して終了します。
.IP "\fB\-x\fR" 4
.IX Item "-x"
libguestfs \s-1API\s0 呼び出しのトレースを有効にします。
.IP "\fB\-\-zero\fR パーティション" 4
.IX Item "--zero パーティション"
.PD 0
.IP "\fB\-\-zero\fR 論理ボリューム" 4
.IX Item "--zero 論理ボリューム"
.PD
仮想マシンにある名前付きパーティションまたは論理ボリュームの内容をゼロ上書きします。デバイスにあるすべてのデータは失われます。しかし、スパース化は素晴らしいことです!このオプションを複数回指定できます。
.SH "マシン可読な出力"
.IX Header "マシン可読な出力"
The \fI\-\-machine\-readable\fR option can be used to make the output more machine
friendly, which is useful when calling virt-sparsify from other programs,
GUIs etc.
.PP
このオプションを使用するには 2 通りの方法があります。
.PP
Firstly use the option on its own to query the capabilities of the
virt-sparsify binary.  Typical output looks like this:
.PP
.Vb 4
\& $ virt\-sparsify \-\-machine\-readable
\& virt\-sparsify
\& ntfs
\& btrfs
.Ve
.PP
A list of features is printed, one per line, and the program exits with
status 0.
.PP
Secondly use the option in conjunction with other options to make the
regular program output more machine friendly.
.PP
At the moment this means:
.IP "1." 4
Progress bar messages can be parsed from stdout by looking for this regular
expression:
.Sp
.Vb 1
\& ^[0\-9]+/[0\-9]+$
.Ve
.IP "2." 4
The calling program should treat messages sent to stdout (except for
progress bar messages) as status messages.  They can be logged and/or
displayed to the user.
.IP "3." 4
The calling program should treat messages sent to stderr as error messages.
In addition, virt-sparsify exits with a non-zero status code if there was a
fatal error.
.PP
All versions of virt-sparsify have supported the \fI\-\-machine\-readable\fR
option.
.SH "終了ステータス"
.IX Header "終了ステータス"
このプログラムは、成功すると 0 を、エラーがあると 0 以外を返します。
.SH "環境変数"
.IX Header "環境変数"
.IP "\s-1TMPDIR\s0" 4
.IX Item "TMPDIR"
Location of the temporary directory used for the potentially large temporary
overlay file.
.Sp
You should ensure there is enough free space in the worst case for a full
copy of the source disk (\fIvirtual\fR size), or else set \f(CW$TMPDIR\fR to point
to another directory that has enough space.
.Sp
この初期値は \f(CW\*(C`/tmp\*(C'\fR です。
.Sp
Note that if \f(CW$TMPDIR\fR is a tmpfs (eg. if \f(CW\*(C`/tmp\*(C'\fR is on tmpfs, or if you
use \f(CW\*(C`TMPDIR=/dev/shm\*(C'\fR), tmpfs defaults to a maximum size of \fIhalf\fR of
physical \s-1RAM\s0.  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:
.Sp
.Vb 1
\& mount \-o remount,size=10G /tmp
.Ve
.PP
他の環境変数は \*(L"環境変数\*(R" in \fIguestfs\fR\|(3) を参照してください。
.SH "関連項目"
.IX Header "関連項目"
\&\fIvirt\-filesystems\fR\|(1), \fIvirt\-df\fR\|(1), \fIvirt\-resize\fR\|(1), \fIvirt\-rescue\fR\|(1),
\&\fIguestfs\fR\|(3), \fIguestfish\fR\|(1), \fItruncate\fR\|(1), \fIfallocate\fR\|(1),
\&\fIqemu\-img\fR\|(1), <http://libguestfs.org/>.
.SH "著者"
.IX Header "著者"
Richard W.M. Jones <http://people.redhat.com/~rjones/>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2011 Red Hat Inc.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of the \s-1GNU\s0 General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful, but \s-1WITHOUT\s0
\&\s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or
\&\s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the \s-1GNU\s0 General Public License for
more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51
Franklin Street, Fifth Floor, Boston, \s-1MA\s0 02110\-1301 \s-1USA\s0.