[82044] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
| 3 | manpage, user manual, usage: VBoxManage adoptstate
|
---|
[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-adoptstate" lang="en">
|
---|
| 32 | <refentryinfo>
|
---|
[94172] | 33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
[82044] | 34 | <title>VBoxManage adoptstate</title>
|
---|
| 35 | </refentryinfo>
|
---|
| 36 |
|
---|
| 37 | <refmeta>
|
---|
| 38 | <refentrytitle>VBoxManage-adoptstate</refentrytitle>
|
---|
| 39 | <manvolnum>1</manvolnum>
|
---|
| 40 | </refmeta>
|
---|
| 41 |
|
---|
| 42 | <refnamediv>
|
---|
| 43 | <refname>VBoxManage-adoptstate</refname>
|
---|
| 44 | <refpurpose>change a virtual machine's state based on a saved state file</refpurpose>
|
---|
[94172] | 45 | <refclass>&product-name;</refclass>
|
---|
[82044] | 46 | </refnamediv>
|
---|
| 47 |
|
---|
| 48 | <refsynopsisdiv>
|
---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-adoptstate">
|
---|
| 50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
| 51 | <command>VBoxManage adoptstate</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 choice="req"><replaceable>state-filename</replaceable></arg>
|
---|
| 57 | </cmdsynopsis>
|
---|
| 58 | </refsynopsisdiv>
|
---|
| 59 |
|
---|
[99513] | 60 | <refsect1 id="vboxmanage-adoptstate-description">
|
---|
[82044] | 61 | <title>Description</title>
|
---|
| 62 | <para>
|
---|
| 63 | The <command>VBoxManage adoptstate</command> command enables you
|
---|
| 64 | to change the state of a virtual machine (VM) to a state described
|
---|
| 65 | in a saved state file (<filename>.sav</filename>). This action is
|
---|
| 66 | referred to as a VM <emphasis>adopting</emphasis> a saved state
|
---|
| 67 | file. The saved state file must be separate from the VM
|
---|
| 68 | configuration.
|
---|
| 69 | </para>
|
---|
| 70 | <para>
|
---|
| 71 | When you start the VM after adopting the saved state, the VM
|
---|
| 72 | restores its state from the saved state file.
|
---|
| 73 | </para>
|
---|
| 74 | <para>
|
---|
| 75 | Only use this command for custom deployments.
|
---|
| 76 | </para>
|
---|
| 77 | <variablelist>
|
---|
| 78 | <varlistentry>
|
---|
[99154] | 79 | <term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
|
---|
[82044] | 80 | <listitem><para>
|
---|
| 81 | Specifies the Universally Unique Identifier (UUID) or name
|
---|
| 82 | of the VM.
|
---|
| 83 | </para></listitem>
|
---|
| 84 | </varlistentry>
|
---|
| 85 | <varlistentry>
|
---|
| 86 | <term><replaceable>state-filename</replaceable></term>
|
---|
| 87 | <listitem><para>
|
---|
| 88 | Specifies the name of the saved state file.
|
---|
| 89 | </para></listitem>
|
---|
| 90 | </varlistentry>
|
---|
| 91 | </variablelist>
|
---|
| 92 | </refsect1>
|
---|
| 93 |
|
---|
[99513] | 94 | <refsect1 id="vboxmanage-adoptstate-examples">
|
---|
[82044] | 95 | <title>Examples</title>
|
---|
| 96 | <remark role="help-scope" condition="GLOBAL" />
|
---|
| 97 | <para>
|
---|
[94172] | 98 | The following command adopts a saved state file called
|
---|
| 99 | <filename>mystate.sav</filename> by a VM called <literal>vm2</literal>.
|
---|
| 100 | A subsequent start of the VM called <literal>vm2</literal> restores the
|
---|
| 101 | state from the saved state file <filename>mystate.sav</filename>.
|
---|
[82044] | 102 | </para>
|
---|
| 103 | <screen>$ VBoxManage adoptstate vm2 /home/user/mystate.sav</screen>
|
---|
| 104 | </refsect1>
|
---|
| 105 |
|
---|
[99513] | 106 | <refsect1 id="vboxmanage-adoptstate-see-also">
|
---|
[82044] | 107 | <title>See Also</title>
|
---|
| 108 | <para>
|
---|
| 109 | <xref linkend="vboxmanage-discardstate"/>
|
---|
| 110 | </para>
|
---|
| 111 | </refsect1>
|
---|
| 112 | </refentry>
|
---|