112 lines
3.9 KiB
XML
112 lines
3.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
manpage, user manual, usage: VBoxManage adoptstate
|
|
-->
|
|
<!--
|
|
Copyright (C) 2006-2023 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-adoptstate" lang="en">
|
|
<refentryinfo>
|
|
<pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
|
|
<title>VBoxManage adoptstate</title>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>VBoxManage-adoptstate</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>VBoxManage-adoptstate</refname>
|
|
<refpurpose>change a virtual machine's state based on a saved state file</refpurpose>
|
|
<refclass>&product-name;</refclass>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis id="synopsis-vboxmanage-adoptstate">
|
|
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|
<command>VBoxManage adoptstate</command>
|
|
<group choice="req">
|
|
<arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|
<arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|
</group>
|
|
<arg choice="req"><replaceable>state-filename</replaceable></arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
The <command>VBoxManage adoptstate</command> command enables you
|
|
to change the state of a virtual machine (VM) to a state described
|
|
in a saved state file (<filename>.sav</filename>). This action is
|
|
referred to as a VM <emphasis>adopting</emphasis> a saved state
|
|
file. The saved state file must be separate from the VM
|
|
configuration.
|
|
</para>
|
|
<para>
|
|
When you start the VM after adopting the saved state, the VM
|
|
restores its state from the saved state file.
|
|
</para>
|
|
<para>
|
|
Only use this command for custom deployments.
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></term>
|
|
<listitem><para>
|
|
Specifies the Universally Unique Identifier (UUID) or name
|
|
of the VM.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><replaceable>state-filename</replaceable></term>
|
|
<listitem><para>
|
|
Specifies the name of the saved state file.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Examples</title>
|
|
<remark role="help-scope" condition="GLOBAL" />
|
|
<para>
|
|
The following command adopts a saved state file called
|
|
<filename>mystate.sav</filename> by a VM called <literal>vm2</literal>.
|
|
A subsequent start of the VM called <literal>vm2</literal> restores the
|
|
state from the saved state file <filename>mystate.sav</filename>.
|
|
</para>
|
|
<screen>$ VBoxManage adoptstate vm2 /home/user/mystate.sav</screen>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para>
|
|
<xref linkend="vboxmanage-discardstate"/>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|