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