1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage movevm
|
---|
4 | -->
|
---|
5 | <!--
|
---|
6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
7 |
|
---|
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
|
---|
25 | -->
|
---|
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-movevm" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
34 | <title>VBoxManage movevm</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-movevm</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-movevm</refname>
|
---|
44 | <refpurpose>move a virtual machine to a new location on the host system</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <cmdsynopsis id="synopsis-vboxmanage-movevm">
|
---|
50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
51 | <command>VBoxManage movevm</command>
|
---|
52 | <group choice="req">
|
---|
53 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
54 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
---|
55 | </group>
|
---|
56 | <arg>--type=basic</arg>
|
---|
57 | <arg>--folder=<replaceable>folder-name</replaceable></arg>
|
---|
58 | </cmdsynopsis>
|
---|
59 | </refsynopsisdiv>
|
---|
60 |
|
---|
61 | <refsect1 id="vboxmanage-movevm-description">
|
---|
62 | <title>Description</title>
|
---|
63 | <para>
|
---|
64 | The <command>VBoxManage movevm</command> command moves a virtual
|
---|
65 | machine (VM) to a new location on the host system.
|
---|
66 | </para>
|
---|
67 | <para>
|
---|
68 | When moved, all of the files that are associated with the VM, such
|
---|
69 | as settings files and disk image files, are moved to the new
|
---|
70 | location. The &product-name; configuration is updated
|
---|
71 | automatically.
|
---|
72 | </para>
|
---|
73 | <variablelist>
|
---|
74 | <varlistentry>
|
---|
75 | <term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
|
---|
76 | <listitem><para>
|
---|
77 | Specifies the Universally Unique Identifier (UUID) or name
|
---|
78 | of the VM to move.
|
---|
79 | </para></listitem>
|
---|
80 | </varlistentry>
|
---|
81 | <varlistentry>
|
---|
82 | <term><option>--type=basic</option></term>
|
---|
83 | <listitem><para>
|
---|
84 | Specifies the type of the move operation. So far
|
---|
85 | <literal>basic</literal> is the only recognized value and also
|
---|
86 | the default if not specified.
|
---|
87 | </para></listitem>
|
---|
88 | </varlistentry>
|
---|
89 | <varlistentry>
|
---|
90 | <term><option>--folder=<replaceable>folder-name</replaceable></option></term>
|
---|
91 | <listitem><para>
|
---|
92 | Specifies a full path name or relative path name of the new
|
---|
93 | location on the host file system. Not specifying the option
|
---|
94 | or specifying the current location is allowed, and moves
|
---|
95 | disk images and other parts of the VM to this location if
|
---|
96 | they are currently in other locations.
|
---|
97 | </para></listitem>
|
---|
98 | </varlistentry>
|
---|
99 | </variablelist>
|
---|
100 | </refsect1>
|
---|
101 |
|
---|
102 | <refsect1 id="vboxmanage-movevm-examples">
|
---|
103 | <title>Examples</title>
|
---|
104 | <remark role="help-scope" condition="GLOBAL" />
|
---|
105 | <para>
|
---|
106 | The following command moves the <filename>ol7</filename> VM to a
|
---|
107 | new location on the host system.
|
---|
108 | </para>
|
---|
109 | <screen>$ VBoxManage movevm ol7 --folder "/home/testuser/vms" --type basic
|
---|
110 | 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
|
---|
111 | Machine has been successfully moved into /home/testuser/vms</screen>
|
---|
112 | </refsect1>
|
---|
113 | </refentry>
|
---|