blob: 81cc5a49e55d46c0307765131cb4e83be1a13c65 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage unregistervm
-->
<!--
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-unregistervm" lang="en">
<refentryinfo>
<pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
<title>VBoxManage unregistervm</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-unregistervm</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-unregistervm</refname>
<refpurpose>unregister a virtual machine</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-unregistervm">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage unregistervm</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg>--delete</arg>
<arg>--delete-all</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>VBoxManage unregistervm</command> command unregisters
a virtual machine (VM).
</para>
<variablelist>
<varlistentry>
<term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term>
<listitem><para>
Specifies the name or Universally Unique Identifier (UUID)
of the VM.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--delete</option></term>
<listitem><para>
Deletes the following files related to the VM automatically:
</para><itemizedlist>
<listitem><para>
All hard disk image files, including differencing files.
</para></listitem>
<listitem><para>
All saved state files that the machine created,
including one for each snapshot.
</para></listitem>
<listitem><para>
XML VM machine definition file and its backups.
</para></listitem>
<listitem><para>
VM log files.
</para></listitem>
<listitem><para>
The empty directory associated with the unregistered VM.
</para></listitem>
</itemizedlist></listitem>
</varlistentry>
<varlistentry>
<term><option>--delete-all</option></term>
<listitem><para>
Deletes the files described in the <option>--delete</option> option,
as well as all DVDs and Floppy disks located in the VM folder and
attached only to this VM.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL" />
<para>
The following command unregisters a VM called
<literal>vm2</literal>.
</para>
<screen>$ VBoxManage unregistervm vm2</screen>
<para>
The following command unregisters a VM called
<literal>vm3</literal>. All files associated with the VM are
deleted.
</para>
<screen>$ VBoxManage unregistervm vm3 --delete
%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%</screen>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<xref linkend="vboxmanage-registervm" />
</para>
</refsect1>
</refentry>
|
