119 lines
4.1 KiB
XML
119 lines
4.1 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
manpage, user manual, usage: VBoxManage closemedium
|
|
-->
|
|
<!--
|
|
Copyright (C) 2006-2024 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-closemedium" lang="en">
|
|
<refentryinfo>
|
|
<pubdate>$Date: 2024-09-16 16:03:52 +0200 (Mon, 16 Sep 2024) $</pubdate>
|
|
<title>VBoxManage closemedium</title>
|
|
</refentryinfo>
|
|
|
|
<refmeta>
|
|
<refentrytitle>VBoxManage-closemedium</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>VBoxManage-closemedium</refname>
|
|
<refpurpose>remove a hard disk, DVD, or floppy image from the media registry</refpurpose>
|
|
<refclass>&product-name;</refclass>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis id="synopsis-vboxmanage-closemedium">
|
|
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|
<command>VBoxManage closemedium</command>
|
|
<group>
|
|
<arg choice="plain">disk</arg>
|
|
<arg choice="plain">dvd</arg>
|
|
<arg choice="plain">floppy</arg>
|
|
</group>
|
|
<group choice="req">
|
|
<arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|
<arg choice="plain"><replaceable>filename</replaceable></arg>
|
|
</group>
|
|
<arg>--delete</arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 id="vboxmanage-closemedium-description">
|
|
<title>Description</title>
|
|
<para>
|
|
The <command>VBoxManage closemedium</command> command removes a
|
|
hard disk, DVD, or floppy image from the list of known media used
|
|
by &product-name;. The image is then unavailable for selection in
|
|
the Virtual Media Manager.
|
|
</para>
|
|
<para>
|
|
To use this command, the image must not be attached to any VMs.
|
|
</para>
|
|
<para>
|
|
Optionally, you can request that the image be deleted.
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>disk|dvd|floppy</term>
|
|
<listitem><para>
|
|
Specifies the type of medium. Valid values are
|
|
<literal>disk</literal> (hard drive),
|
|
<literal>dvd</literal>, or <literal>floppy</literal>.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><replaceable>uuid</replaceable>|<replaceable>filename</replaceable></term>
|
|
<listitem><para>
|
|
Specifies the Universally Unique Identifier (UUID) or
|
|
absolute path name of the medium or image.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>--delete</option></term>
|
|
<listitem><para>
|
|
Deletes the image file.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 id="vboxmanage-closemedium-examples">
|
|
<title>Examples</title>
|
|
<remark role="help-scope" condition="GLOBAL" />
|
|
<para>
|
|
The following command removes the disk image file called
|
|
<filename>disk01.vdi</filename> from the registry.
|
|
</para>
|
|
<screen>$ VBoxManage closemedium disk01.vdi</screen>
|
|
<para>
|
|
The following command removes the disk image file called
|
|
<filename>disk01.vdi</filename> from the registry and deletes the
|
|
image file.
|
|
</para>
|
|
<screen>$ VBoxManage closemedium disk01.vdi --delete</screen>
|
|
</refsect1>
|
|
</refentry>
|