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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage convertfromraw
-->
<!--
Copyright (C) 2006-2024 Oracle and/or its affiliates.
This file is part of VirtualBox base platform packages, as
available from https://www.virtualbox.org.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, in version 3 of the
License.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses>.
SPDX-License-Identifier: GPL-3.0-only
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
<refentry id="vboxmanage-convertfromraw" lang="en">
<refentryinfo>
<pubdate>$Date: 2024-09-16 16:03:52 +0200 (Mon, 16 Sep 2024) $</pubdate>
<title>VBoxManage convertfromraw</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-convertfromraw</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-convertfromraw</refname>
<refpurpose>convert a raw disk image to a virtual disk image</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<cmdsynopsis id="synopsis-vboxmanage-convertfromraw-file">
<command>VBoxManage convertfromraw</command>
<arg choice="req"><replaceable>inputfile</replaceable></arg>
<arg choice="req"><replaceable>outputfile</replaceable></arg>
<arg>--format=<group choice="plain">
<arg choice="plain">VDI</arg>
<arg choice="plain">VMDK</arg>
<arg choice="plain">VHD</arg>
</group></arg>
<arg>--uuid=<replaceable>uuid</replaceable></arg>
<arg rep="repeat" role="compact">--variant=<group choice="plain">
<arg choice="plain">Standard</arg>
<arg choice="plain">Fixed</arg>
<arg choice="plain">Split2G</arg>
<arg choice="plain">Stream</arg>
<arg choice="plain">ESX</arg>
</group></arg> <!-- Value can be repated with comma separator. Difficult to express with docbook. -->
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-convertfromraw-stdin">
<command>VBoxManage convertfromraw stdin</command>
<arg choice="req"><replaceable>outputfile</replaceable></arg>
<arg choice="req"><replaceable>bytes</replaceable></arg>
<arg>--format=<group choice="plain">
<arg choice="plain">VDI</arg>
<arg choice="plain">VMDK</arg>
<arg choice="plain">VHD</arg>
</group></arg>
<arg>--uuid=<replaceable>uuid</replaceable></arg>
<arg rep="repeat" role="compact">--variant=<group choice="plain">
<arg choice="plain">Standard</arg>
<arg choice="plain">Fixed</arg>
<arg choice="plain">Split2G</arg>
<arg choice="plain">Stream</arg>
<arg choice="plain">ESX</arg>
</group></arg> <!-- Value can be repated with comma separator. Difficult to express with docbook. -->
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="vboxmanage-convertfromraw-description">
<title>Description</title>
<para>
The <command>VBoxManage convertfromraw</command> command enables
you to convert a raw disk image to an &product-name; virtual disk
image (VDI).
</para>
<note>
<para>
For compatibility with earlier versions of &product-name;, you
can use the <command>VBoxManage convertdd</command> command
instead of the <command>VBoxManage convertfromraw</command>
command.
</para>
</note>
<refsect2 id="vboxmanage-convertfromraw-file">
<title>Convert a Raw Disk File to a Virtual Disk Image File</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage convertfromraw</command> command
converts the specified raw disk image input file to an
&product-name; VDI file.
</para>
<variablelist>
<varlistentry>
<term><replaceable>inputfile</replaceable></term>
<listitem><para>
Specifies the name of the raw disk image file to convert.
</para></listitem>
</varlistentry>
<varlistentry>
<term><replaceable>outputfile</replaceable></term>
<listitem><para>
Specifies the name of the file in which to write the VDI
output.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--format=VDI | VMDK | VHD</option></term>
<listitem><para>
Specifies the format of the disk image to create. Valid
values are <literal>VDI</literal>,
<literal>VMDK</literal>, and <literal>VHD</literal>. The
default format is <literal>VDI</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--uuid=<replaceable>uuid</replaceable></option></term>
<listitem><para>
Specifies the Universally Unique Identifier (UUID) of the
output file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--variant=Standard | Fixed | Split2G | Stream | ESX[,...]</option></term>
<listitem><para>
Specifies any required file format variants for the output
file. This is a comma-separated list of variant values.
Following are the valid values:
</para><itemizedlist>
<listitem><para>
<literal>Standard</literal> is the default disk image
type, which has a dynamically allocated file size.
</para></listitem>
<listitem><para>
<literal>Fixed</literal> uses a disk image that has a
fixed file size.
</para></listitem>
<listitem><para>
<literal>Split2G</literal> indicates that the disk
image is split into 2GB segments. This value is for
VMDK only.
</para></listitem>
<listitem><para>
<literal>Stream</literal> optimizes the disk image for
downloading. This value is for VMDK only.
</para></listitem>
<listitem><para>
<literal>ESX</literal> is used for some VMWare
products. This value is for VMDK only.
</para></listitem>
</itemizedlist><para>
Note that not all variant combinations are valid.
Specifying incompatible variant values in the list will
produce an error message.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-convertfromraw-stdin">
<title>Convert Raw Data From Standard Input to a Virtual Disk Image File</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage convertfromraw stdin</command> command
reads the content of the disk image from standard input.
Consider using this form of the command in a pipe sequence.
</para>
<variablelist>
<varlistentry>
<term><replaceable>outputfile</replaceable></term>
<listitem><para>
Specifies the name of the file in which to write the disk image
output.
</para></listitem>
</varlistentry>
<varlistentry>
<term><replaceable>bytes</replaceable></term>
<listitem><para>
Specifies the capacity of the target image name. This needs to be
given explicitly, because generally pipes do not support
querying the overall size of the data stream.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--format=VDI | VMDK | VHD</option></term>
<listitem><para>
Specifies the format of the disk image to create. Valid
values are <literal>VDI</literal>,
<literal>VMDK</literal>, and <literal>VHD</literal>. The
default format is <literal>VDI</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--uuid=<replaceable>uuid</replaceable></option></term>
<listitem><para>
Specifies the UUID of the output file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--variant=Standard,Fixed,Split2G,Stream,ESX</option></term>
<listitem><para>
Specifies any required file format variants for the output
file. This is a comma-separated list of variant values.
The list of valid values is:
</para><itemizedlist>
<listitem><para>
<literal>Standard</literal> is the default disk image
type, which has a dynamically allocated file size.
</para></listitem>
<listitem><para>
<literal>Fixed</literal> uses a disk image that has a
fixed file size.
</para></listitem>
<listitem><para>
<literal>Split2G</literal> indicates that the disk
image is split into 2GB segments. This value is for
VMDK only.
</para></listitem>
<listitem><para>
<literal>Stream</literal> optimizes the disk image for
downloading. This value is for VMDK only.
</para></listitem>
<listitem><para>
<literal>ESX</literal> is used for some VMWare
products. This value is for VMDK only.
</para></listitem>
</itemizedlist><para>
Note that not all variant combinations are valid.
Specifying incompatible variant values in the list will
produce an error message.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 id="vboxmanage-convertfromraw-examples">
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL" />
<para>
The following command converts the raw disk image input file
<filename>disk01.raw</filename>. The output file is a VDI disk
image called <filename>disk02.vdi</filename>.
</para>
<screen>$ VBoxManage convertfromraw disk01.raw disk02.vdi</screen>
<para>
The following command converts the raw disk image input file
<filename>disk01.raw</filename>. The output file is a VMDK disk
image called <filename>disk02.vmdk</filename>.
</para>
<screen>$ VBoxManage convertfromraw disk01.raw disk02.vmdk --format VMDK</screen>
<para>
The following command reads from disk <filename>/dev/sda</filename>
using a pipe and therefore needs the exact disk size in bytes as an
additional parameter, which is assumed to be <literal>10737418240</literal>.
The output file is a VDI disk image called <filename>disk.vdi</filename>.
</para>
<screen>$ dd if=/dev/sda bs=512 | VBoxManage convertfromraw stdin disk.vdi 10737418240</screen>
</refsect1>
</refentry>
|
