[82044] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
| 3 | manpage, user manual, usage: VBoxManage clonemedium
|
---|
[96300] | 4 | -->
|
---|
| 5 | <!--
|
---|
[98103] | 6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
[82044] | 7 |
|
---|
[96407] | 8 | This file is part of VirtualBox base platform packages, as
|
---|
| 9 | available from https://www.virtualbox.org.
|
---|
| 10 |
|
---|
| 11 | This program is free software; you can redistribute it and/or
|
---|
| 12 | modify it under the terms of the GNU General Public License
|
---|
| 13 | as published by the Free Software Foundation, in version 3 of the
|
---|
| 14 | License.
|
---|
| 15 |
|
---|
| 16 | This program is distributed in the hope that it will be useful, but
|
---|
| 17 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
| 19 | General Public License for more details.
|
---|
| 20 |
|
---|
| 21 | You should have received a copy of the GNU General Public License
|
---|
| 22 | along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
| 23 |
|
---|
| 24 | SPDX-License-Identifier: GPL-3.0-only
|
---|
[96300] | 25 | -->
|
---|
[82044] | 26 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 27 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
---|
| 28 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
---|
| 29 | %all.entities;
|
---|
| 30 | ]>
|
---|
| 31 | <refentry id="vboxmanage-clonemedium" lang="en">
|
---|
| 32 | <refentryinfo>
|
---|
[94199] | 33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
[82044] | 34 | <title>VBoxManage clonemedium</title>
|
---|
| 35 | </refentryinfo>
|
---|
| 36 |
|
---|
| 37 | <refmeta>
|
---|
| 38 | <refentrytitle>VBoxManage-clonemedium</refentrytitle>
|
---|
| 39 | <manvolnum>1</manvolnum>
|
---|
| 40 | </refmeta>
|
---|
| 41 |
|
---|
| 42 | <refnamediv>
|
---|
| 43 | <refname>VBoxManage-clonemedium</refname>
|
---|
| 44 | <refpurpose>create a clone of a medium</refpurpose>
|
---|
[94199] | 45 | <refclass>&product-name;</refclass>
|
---|
[82044] | 46 | </refnamediv>
|
---|
| 47 |
|
---|
| 48 | <refsynopsisdiv>
|
---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-clonemedium">
|
---|
| 50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
| 51 | <command>VBoxManage clonemedium</command>
|
---|
| 52 | <group choice="req">
|
---|
| 53 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
| 54 | <arg choice="plain"><replaceable>source-medium</replaceable></arg>
|
---|
| 55 | </group>
|
---|
| 56 | <group choice="req">
|
---|
| 57 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
| 58 | <arg choice="plain"><replaceable>target-medium</replaceable></arg>
|
---|
| 59 | </group>
|
---|
| 60 | <group>
|
---|
| 61 | <arg choice="plain">disk</arg>
|
---|
| 62 | <arg choice="plain">dvd</arg>
|
---|
| 63 | <arg choice="plain">floppy</arg>
|
---|
| 64 | </group>
|
---|
| 65 | <arg>--existing</arg>
|
---|
| 66 | <arg>--format=<group choice="plain">
|
---|
| 67 | <arg choice="plain">VDI</arg>
|
---|
| 68 | <arg choice="plain">VMDK</arg>
|
---|
| 69 | <arg choice="plain">VHD</arg>
|
---|
| 70 | <arg choice="plain">RAW</arg>
|
---|
| 71 | <arg choice="plain"><replaceable>other</replaceable></arg>
|
---|
| 72 | </group></arg>
|
---|
[99155] | 73 | <arg rep="repeat" role="compact">--variant=<group choice="plain">
|
---|
| 74 | <arg choice="plain">Standard</arg>
|
---|
| 75 | <arg choice="plain">Fixed</arg>
|
---|
| 76 | <arg choice="plain">Split2G</arg>
|
---|
| 77 | <arg choice="plain">Stream</arg>
|
---|
| 78 | <arg choice="plain">ESX</arg>
|
---|
| 79 | </group></arg> <!-- Value can be repated with comma separator. Difficult to express with docbook. -->
|
---|
[82044] | 80 | </cmdsynopsis>
|
---|
| 81 | </refsynopsisdiv>
|
---|
| 82 |
|
---|
[99513] | 83 | <refsect1 id="vboxmanage-clonemedium-description">
|
---|
[82044] | 84 | <title>Description</title>
|
---|
| 85 | <para>
|
---|
| 86 | The <command>VBoxManage clonemedium</command> command enables you
|
---|
| 87 | to clone an existing medium (virtual disk, DVD, or floppy), which
|
---|
| 88 | is typically an image file. Only the Universally Unique Identifier
|
---|
| 89 | (UUID) differs between the original image and the cloned image.
|
---|
| 90 | </para>
|
---|
| 91 | <para>
|
---|
| 92 | You can use the Virtual Media Manager to transfer the cloned image
|
---|
| 93 | to another host system or reimport it into &product-name;. See
|
---|
[97033] | 94 | <xref linkend="virtual-media-manager" /> and <xref linkend="cloningvdis" />.
|
---|
[82044] | 95 | </para>
|
---|
| 96 | <variablelist>
|
---|
| 97 | <varlistentry>
|
---|
| 98 | <term><replaceable>uuid</replaceable> | <replaceable>source-medium</replaceable></term>
|
---|
| 99 | <listitem><para>
|
---|
| 100 | Specifies the UUID or the absolute or relative file name of
|
---|
| 101 | the source medium to clone. You can specify the UUID of the
|
---|
| 102 | medium only if it is registered. Use the <command>VBoxManage
|
---|
| 103 | list hdds</command> command to list registered images.
|
---|
| 104 | </para></listitem>
|
---|
| 105 | </varlistentry>
|
---|
| 106 | <varlistentry>
|
---|
| 107 | <term><replaceable>uuid</replaceable> | <replaceable>target-medium</replaceable></term>
|
---|
| 108 | <listitem><para>
|
---|
| 109 | Specifies the UUID or the absolute or relative file name of
|
---|
| 110 | the target (clone) medium. You can specify the UUID of the
|
---|
| 111 | target medium only if it is registered. Use the
|
---|
| 112 | <command>VBoxManage list hdds</command> command to list
|
---|
| 113 | registered images.
|
---|
| 114 | </para></listitem>
|
---|
| 115 | </varlistentry>
|
---|
| 116 | <varlistentry>
|
---|
| 117 | <term><literal>disk</literal> | <literal>dvd</literal> | <literal>floppy</literal></term>
|
---|
| 118 | <listitem><para>
|
---|
| 119 | Specifies the type of the medium to clone. Valid values are
|
---|
| 120 | <literal>disk</literal>, <literal>dvd</literal>, and
|
---|
| 121 | <literal>floppy</literal>. The default value is
|
---|
| 122 | <literal>disk</literal>.
|
---|
| 123 | </para></listitem>
|
---|
| 124 | </varlistentry>
|
---|
| 125 | <varlistentry>
|
---|
| 126 | <term><option>--existing</option></term>
|
---|
| 127 | <listitem><para>
|
---|
| 128 | Performs the clone operation by overwriting an existing
|
---|
| 129 | target medium. The result is that only the portion of the
|
---|
| 130 | source medium that fits into the existing target medium is
|
---|
| 131 | copied.
|
---|
| 132 | </para><para>
|
---|
| 133 | If the target medium is smaller than the source, only the
|
---|
| 134 | portion of the source medium up to the size of the target
|
---|
| 135 | medium is copied.
|
---|
| 136 | </para><para>
|
---|
| 137 | If the target medium is larger than the source, the
|
---|
| 138 | remaining part of the target medium is unchanged.
|
---|
| 139 | </para></listitem>
|
---|
| 140 | </varlistentry>
|
---|
| 141 | <varlistentry>
|
---|
| 142 | <term><option>--format</option></term>
|
---|
| 143 | <listitem><para>
|
---|
| 144 | Specifies the file format of the target medium if it differs
|
---|
| 145 | from the format of the source medium. Valid values are
|
---|
| 146 | <literal>VDI</literal>, <literal>VMDK</literal>,
|
---|
| 147 | <literal>VHD</literal>, <literal>RAW</literal>, and
|
---|
| 148 | <replaceable>other</replaceable>.
|
---|
| 149 | </para><remark>
|
---|
| 150 | What file formats can <replaceable>other</replaceable> be?
|
---|
| 151 | </remark></listitem>
|
---|
| 152 | </varlistentry>
|
---|
| 153 | <varlistentry>
|
---|
[99155] | 154 | <term><option>--variant=Standard | Fixed | Split2G | Stream | ESX [,...]</option></term>
|
---|
[82044] | 155 | <listitem><para>
|
---|
| 156 | Specifies the file format variant for the target medium,
|
---|
| 157 | which is a comma-separated list of variants. Following are
|
---|
| 158 | the valid values:
|
---|
| 159 | </para><itemizedlist>
|
---|
| 160 | <listitem><para>
|
---|
| 161 | <literal>Standard</literal> is the default disk image
|
---|
| 162 | type, which has a dynamically allocated file size.
|
---|
| 163 | </para></listitem>
|
---|
| 164 | <listitem><para>
|
---|
| 165 | <literal>Fixed</literal> uses a disk image that has a
|
---|
| 166 | fixed file size.
|
---|
| 167 | </para></listitem>
|
---|
| 168 | <listitem><para>
|
---|
| 169 | <literal>Split2G</literal> indicates that the disk image
|
---|
| 170 | is split into 2GB segments. This value is for VMDK only.
|
---|
| 171 | </para></listitem>
|
---|
| 172 | <listitem><para>
|
---|
| 173 | <literal>Stream</literal> optimizes the disk image for
|
---|
| 174 | downloading. This value is for VMDK only.
|
---|
| 175 | </para></listitem>
|
---|
| 176 | <listitem><para>
|
---|
| 177 | <literal>ESX</literal> is used for some VMWare products.
|
---|
| 178 | This value is for VMDK only.
|
---|
| 179 | </para></listitem>
|
---|
| 180 | </itemizedlist><para>
|
---|
| 181 | Note that not all variant combinations are valid. Specifying
|
---|
| 182 | incompatible variant values in the list will produce an
|
---|
| 183 | error message.
|
---|
| 184 | </para></listitem>
|
---|
| 185 | </varlistentry>
|
---|
| 186 | </variablelist>
|
---|
| 187 | <note>
|
---|
| 188 | <para>
|
---|
| 189 | For compatibility with earlier versions of &product-name;, you
|
---|
| 190 | can use the <command>clonevdi</command> and
|
---|
| 191 | <command>clonehd</command> commands instead of the
|
---|
| 192 | <command>clonemedium</command> command.
|
---|
| 193 | </para>
|
---|
| 194 | </note>
|
---|
| 195 | </refsect1>
|
---|
| 196 |
|
---|
[99513] | 197 | <refsect1 id="vboxmanage-clonemedium-examples">
|
---|
[82044] | 198 | <title>Examples</title>
|
---|
| 199 | <remark role="help-scope" condition="GLOBAL" />
|
---|
| 200 | <para>
|
---|
| 201 | The following command creates a clone of the
|
---|
| 202 | <filename>disk01.vdi</filename> disk image file. The clone is
|
---|
| 203 | called <filename>disk02.vdi</filename>.
|
---|
| 204 | </para>
|
---|
| 205 | <screen>$ VBoxManage clonemedium disk01.vdi disk02.vdi</screen>
|
---|
| 206 | <para>
|
---|
| 207 | The following command creates a clone of the
|
---|
| 208 | <filename>disk01.vdi</filename> disk image file. The clone is in
|
---|
| 209 | VMDK format and is called <filename>disk02.vmdk</filename>.
|
---|
| 210 | </para>
|
---|
| 211 | <screen>$ VBoxManage clonemedium disk01.vdi disk02.vmdk --format VMDK</screen>
|
---|
| 212 | </refsect1>
|
---|
| 213 |
|
---|
[99513] | 214 | <refsect1 id="vboxmanage-clonemedium-see-also">
|
---|
[82044] | 215 | <title>See Also</title>
|
---|
| 216 | <para>
|
---|
| 217 | <xref linkend="vboxmanage-list" />
|
---|
| 218 | </para>
|
---|
| 219 | </refsect1>
|
---|
| 220 | </refentry>
|
---|