VirtualBox

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

Last change on this file since 86820 was 82969, checked in by vboxsync, 5 years ago

Copyright year updates - manual ones.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.0 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage discardstate
4
5 Copyright (C) 2006-2020 Oracle Corporation
6
7 This file is part of VirtualBox Open Source Edition (OSE), as
8 available from http://www.virtualbox.org. This file is free software;
9 you can redistribute it and/or modify it under the terms of the GNU
10 General Public License (GPL) as published by the Free Software
11 Foundation, in version 2 as it comes in the "COPYING" file of the
12 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14 -->
15<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
16 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
17<!ENTITY % all.entities SYSTEM "all-entities.ent">
18%all.entities;
19]>
20<refentry id="vboxmanage-discardstate" lang="en">
21 <refentryinfo>
22 <pubdate>August 2019</pubdate>
23 <title>VBoxManage discardstate</title>
24 </refentryinfo>
25
26 <refmeta>
27 <refentrytitle>VBoxManage-discardstate</refentrytitle>
28 <manvolnum>1</manvolnum>
29 </refmeta>
30
31 <refnamediv>
32 <refname>VBoxManage-discardstate</refname>
33 <refpurpose>discard the saved state of a virtual machine</refpurpose>
34 <refclass>Oracle VM VirtualBox</refclass>
35 </refnamediv>
36
37 <refsynopsisdiv>
38 <cmdsynopsis id="synopsis-vboxmanage-discardstate">
39<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
40 <command>VBoxManage discardstate</command>
41 <group choice="req">
42 <arg choice="plain"><replaceable>uuid</replaceable></arg>
43 <arg choice="plain"><replaceable>vmname</replaceable></arg>
44 </group>
45 </cmdsynopsis>
46 </refsynopsisdiv>
47
48 <refsect1>
49 <title>Description</title>
50 <para>
51 The <command>VBoxManage discardstate</command> command discards
52 the saved state of a virtual machine (VM) that is not currently
53 running. This command causes the VM's operating system to restart
54 the next time you start the VM.
55 </para>
56 <note>
57 <para>
58 Where possible, avoid performing this action. The effects of
59 this command are equivalent to unplugging the power cable on a
60 physical machine.
61 </para>
62 </note>
63 <variablelist>
64 <varlistentry>
65 <term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term>
66 <listitem><para>
67 Specifies the Universally Unique Identifier (UUID) or name
68 of the VM.
69 </para></listitem>
70 </varlistentry>
71 </variablelist>
72 </refsect1>
73
74 <refsect1>
75 <title>Examples</title>
76 <remark role="help-scope" condition="GLOBAL" />
77 <para>
78 The following command discards the saved state file for the VM
79 called <filename>vm2</filename>. When you next start the VM, the
80 VM's operating system is restarted.
81 </para>
82<screen>$ VBoxManage discardstate vm2</screen>
83 </refsect1>
84
85 <refsect1>
86 <title>See Also</title>
87 <para>
88 <xref linkend="vboxmanage-adoptstate"/>
89 </para>
90 </refsect1>
91</refentry>
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette