1virt-v2v-inspector(1) Virtualization Support virt-v2v-inspector(1)
2
6 virt-v2v-inspector - Estimate disk space needed before virt-v2v
7 conversion
8
10 virt-v2v-inspector [-i* options] guest [-O output.xml]
11
13 Virt-v2v-inspector is a companion tool for virt-v2v(1) which can be
14 used before conversion to estimate the number of output disks and disk
15 space that will be required to complete the virt-v2v conversion. The
16 common use for this is to preallocate target disks on management
17 systems that need this (like Kubevirt).
18 This manual page only documents the estimation feature, not all of the
20 -i* options which are the same as virt-v2v. You should read
21 virt-v2v(1) first.
22 Selecting the input guest
24 You can run virt-v2v-inspector with the same -i* options as virt-v2v.
25 (Don't use any -o* options). This will select the guest that you want
26 to estimate.
27 For example to estimate the space required for a guest in a stored
29 local disk called filename.img you could do:
30 virt-v2v-inspector -i disk filename.img
32 Output
34 The output from this tool is an XML document.
35 • Fields which are annotated with an "estimated='true'" attribute are
37 estimated. Virt-v2v cannot always know exactly the final size of
38 some things, such as the exact real size of the output disk, since
39 there might be small perturbations between runs. Estimates are
40 usually very close to the final values.
41 • Numbers representing sizes are always given in bytes.
43 • By default the output is written to stdout. This is useful when
45 using the program interactively. However if you want to use this
46 tool from another program it is better to send the output to a
47 specific file using -O output.xml
48 <?xml version='1.0' encoding='utf-8'?>
50 <v2v-inspection>
51 <program>virt-v2v-inspector</program>
52 <package>virt-v2v</package>
53 <version>2.1.9</version>
54 The <program>, <package> and <version> elements refer to the current
56 version of virt-v2v-inspector and are useful for debugging. Make sure
57 you use the same version of virt-v2v-inspector and virt-v2v.
58 <disks>
60 <disk index='0'>
61 <virtual-size>6442450944</virtual-size>
62 <allocated estimated='true'>1400897536</allocated>
63 </disk>
64 <disk index='1'>
65 <virtual-size>6442450944</virtual-size>
66 <allocated estimated='true'>45131520</allocated>
67 </disk>
68 </disks>
69 The <disks> element lists information about each guest disk. The
71 example virtual machine above has two disks. <virtual-size> describes
72 the size of the disk as seen from inside the guest, while <allocated>
73 is an estimate of how much storage will be needed on the host after
74 conversion. This is assuming you use -oa sparse - see the notes below.
75 <operatingsystem>
77 <name>linux</name>
78 <distro>fedora</distro>
79 <osinfo>fedora32</osinfo>
80 <arch>x86_64</arch>
81 [...]
82 </operatingsystem>
83 The <operatingsystem> element lists information about the guest
85 operating system gleaned during conversion, in a manner similar to the
86 virt-inspector(1) tool from guestfs-tools.
87 Output allocation mode and output format
89 Virt-v2v supports selecting the output allocation mode (-oa option) and
90 output format (-of option, eg. -of qcow2). Since it is difficult to
91 predict the effect of these options on the actual space occupied by the
92 final image this tool does not account for them.
93 As a rule of thumb:
95 virt-v2v -oa preallocated
97 causes the disk images on the target to consume their full virtual
98 size (excluding the effect of zero allocations will depends so much
99 on the underlying storage that it is often hard even for experts to
100 predict).
101 virt-v2v -of qcow2
103 uses the QCOW2 format where supported which means that the apparent
104 size of the file will be equal to its sparse size, but otherwise
105 should not affect estimates very much.
106
108 --help
109 Display help.
110 -O output.xml
112 Write the output to a file called output.xml.
113 -O -
115 Write the output to stdout. This is also the default if the -O
116 option is omitted.
117 -v
119 --verbose
120 Enable verbose messages for debugging.
121 -V
123 --version
124 Display version number and exit.
125 -x Enable tracing of libguestfs API calls.
127 -i ...
129 -ic ...
130 -if ...
131 -io ...
132 -ip ...
133 -it ...
134 All of the -i* options supported by virt-v2v and also supported by
135 virt-v2v-inspector.
136 -b ...
138 --bridge ...
139 --colors
140 --colours
141 --echo-keys
142 --key ...
143 --keys-from-stdin
144 --mac ...
145 --machine-readable
146 --machine-readable=format
147 -n ...
148 --network ...
149 -q
150 --quiet
151 --root ...
152 --wrap
153 These options work in the same way as the equivalent virt-v2v
154 options.
155
157 Files used are the same as for virt-v2v. See "FILES" in virt-v2v(1).
158
160 Environment variables used are the same as for virt-v2v. See
161 "ENVIRONMENT VARIABLES" in virt-v2v(1).
162
164 virt-v2v(1), virt-p2v(1), virt-inspector(1), guestfs(3), guestfish(1),
165 qemu-img(1), nbdkit(1), http://libguestfs.org/.
166
168 Matthew Booth
169 Cédric Bosdonnat
171 Laszlo Ersek
173 Tomáš Golembiovský
175 Shahar Havivi
177 Richard W.M. Jones
179 Roman Kagan
181 Mike Latimer
183 Nir Soffer
185 Pino Toscano
187 Xiaodai Wang
189 Ming Xie
191 Tingting Zheng
193
195 Copyright (C) 2009-2022 Red Hat Inc.
196
198 This program is free software; you can redistribute it and/or modify it
199 under the terms of the GNU General Public License as published by the
200 Free Software Foundation; either version 2 of the License, or (at your
201 option) any later version.
202 This program is distributed in the hope that it will be useful, but
204 WITHOUT ANY WARRANTY; without even the implied warranty of
205 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
206 General Public License for more details.
207 You should have received a copy of the GNU General Public License along
209 with this program; if not, write to the Free Software Foundation, Inc.,
210 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
211
213 To get a list of bugs against libguestfs, use this link:
214 https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools
215 To report a new bug against libguestfs, use this link:
217 https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools
218 When reporting a bug, please supply:
220 • The version of libguestfs.
222 • Where you got libguestfs (eg. which Linux distro, compiled from
224 source, etc)
225 • Describe the bug accurately and give a way to reproduce it.
227 • Run libguestfs-test-tool(1) and paste the complete, unedited output
229 into the bug report.
230virt-v2v-2.3.6 2023-11-02 virt-v2v-inspector(1)