source: vbox/trunk/doc/manual/en_US/man_VBoxManage-movevm.xml@ 85683

<?xml version="1.0" encoding="UTF-8"?>
<!--
         manpage, user manual, usage: VBoxManage movevm

    Copyright (C) 2006-2020 Oracle Corporation

    This file is part of VirtualBox Open Source Edition (OSE), as
    available from http://www.virtualbox.org. This file is free software;
    you can redistribute it and/or modify it under the terms of the GNU
    General Public License (GPL) as published by the Free Software
    Foundation, in version 2 as it comes in the "COPYING" file of the
    VirtualBox OSE distribution. VirtualBox OSE is distributed in the
    hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 -->
<!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-movevm" lang="en">
  <refentryinfo>
    <pubdate>August 2019</pubdate>
    <title>VBoxManage movevm</title>
  </refentryinfo>

  <refmeta>
    <refentrytitle>VBoxManage-movevm</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>VBoxManage-movevm</refname>
    <refpurpose>move a virtual machine to a new location on the host system</refpurpose>
    <refclass>Oracle VM VirtualBox</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="synopsis-vboxmanage-movevm">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
      <command>VBoxManage movevm</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="req">--type=basic</arg>
      <arg>--folder=<replaceable>folder-name</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      The <command>VBoxManage movevm</command> command moves a virtual
      machine (VM) to a new location on the host system.
    </para>
    <para>
      When moved, all of the files that are associated with the VM, such
      as settings files and disk image files, are moved to the new
      location. The &product-name; configuration is updated
      automatically.
    </para>
    <variablelist>
      <varlistentry>
        <term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term>
        <listitem><para>
            Specifies the Universally Unique Identifier (UUID) or name
            of the VM to move.
          </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--type=basic</option></term>
        <listitem><para>
            Specifies that the type of the move operation is basic.
          </para></listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--folder=<replaceable>folder-name</replaceable></option></term>
        <listitem><para>
            Specifies a full path name or relative path name of the new
            location on the host file system.
          </para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <remark role="help-scope" condition="GLOBAL" />
    <para>
      The following command moves the <filename>ol7</filename> VM to a
      new location on the host system.
    </para>
<screen>$ VBoxManage movevm ol7 --folder "/home/testuser/vms" --type basic
0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
Machine has been successfully moved into /home/testuser/vms</screen>
  </refsect1>
</refentry>