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