source: vbox/trunk/doc/manual/en_US/man_VBoxManage-discardstate.xml@ 98108

<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage discardstate
-->
<!--
    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-discardstate" lang="en">
  <refentryinfo>
    <pubdate>$Date: 2023-01-17 14:15:46 +0000 (Tue, 17 Jan 2023) $</pubdate>
    <title>VBoxManage discardstate</title>
  </refentryinfo>

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

  <refnamediv>
    <refname>VBoxManage-discardstate</refname>
    <refpurpose>discard the saved state of a virtual machine</refpurpose>
    <refclass>&product-name;</refclass>
  </refnamediv>

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

  <refsect1>
    <title>Description</title>
    <para>
      The <command>VBoxManage discardstate</command> command discards
      the saved state of a virtual machine (VM) that is not currently
      running. This command causes the VM's operating system to restart
      the next time you start the VM.
    </para>
    <note>
      <para>
        Where possible, avoid performing this action. The effects of
        this command are equivalent to unplugging the power cable on a
        physical machine.
      </para>
    </note>
    <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>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <remark role="help-scope" condition="GLOBAL" />
    <para>
      The following command discards the saved state file for the VM
      called <filename>vm2</filename>. When you next start the VM, the
      VM's operating system is restarted.
    </para>
<screen>$ VBoxManage discardstate vm2</screen>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <xref linkend="vboxmanage-adoptstate"/>
    </para>
  </refsect1>
</refentry>