VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-closemedium.xml@ 103068

Last change on this file since 103068 was 99513, checked in by vboxsync, 20 months ago

manual,VBoxManage,isomaker/viso: Require all refsect1 and refsect2 elements to have @id attributes in manpages (refentry) to make these predictable and the split up topic files easier to handle for the docs team. Also requires these @id values to start with the refentry @id + '-'. Corrected a few bogus ones. Because 'controlvm' has too many sub-commands, HELP_SCOPE_ IDs will not be generated for 'See Also' and 'Examples' sections. bugref:10302

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage closemedium
4-->
5<!--
6 Copyright (C) 2006-2023 Oracle and/or its affiliates.
7
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
25-->
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-closemedium" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage closemedium</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-closemedium</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-closemedium</refname>
44 <refpurpose>remove a hard disk, DVD, or floppy image from the media registry</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-closemedium">
50<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
51 <command>VBoxManage closemedium</command>
52 <group>
53 <arg choice="plain">disk</arg>
54 <arg choice="plain">dvd</arg>
55 <arg choice="plain">floppy</arg>
56 </group>
57 <group choice="req">
58 <arg choice="plain"><replaceable>uuid</replaceable></arg>
59 <arg choice="plain"><replaceable>filename</replaceable></arg>
60 </group>
61 <arg>--delete</arg>
62 </cmdsynopsis>
63 </refsynopsisdiv>
64
65 <refsect1 id="vboxmanage-closemedium-description">
66 <title>Description</title>
67 <para>
68 The <command>VBoxManage closemedium</command> command removes a
69 hard disk, DVD, or floppy image from the list of known media used
70 by &product-name;. The image is then unavailable for selection in
71 the Virtual Media Manager.
72 </para>
73 <para>
74 To use this command, the image must not be attached to any VMs.
75 </para>
76 <para>
77 Optionally, you can request that the image be deleted.
78 </para>
79 <variablelist>
80 <varlistentry>
81 <term>disk|dvd|floppy</term>
82 <listitem><para>
83 Specifies the type of medium. Valid values are
84 <literal>disk</literal> (hard drive),
85 <literal>dvd</literal>, or <literal>floppy</literal>.
86 </para></listitem>
87 </varlistentry>
88 <varlistentry>
89 <term><replaceable>uuid</replaceable>|<replaceable>filename</replaceable></term>
90 <listitem><para>
91 Specifies the Universally Unique Identifier (UUID) or
92 absolute path name of the medium or image.
93 </para></listitem>
94 </varlistentry>
95 <varlistentry>
96 <term><option>--delete</option></term>
97 <listitem><para>
98 Deletes the image file.
99 </para></listitem>
100 </varlistentry>
101 </variablelist>
102 </refsect1>
103
104 <refsect1 id="vboxmanage-closemedium-examples">
105 <title>Examples</title>
106 <remark role="help-scope" condition="GLOBAL" />
107 <para>
108 The following command removes the disk image file called
109 <filename>disk01.vdi</filename> from the registry.
110 </para>
111<screen>$ VBoxManage closemedium disk01.vdi</screen>
112 <para>
113 The following command removes the disk image file called
114 <filename>disk01.vdi</filename> from the registry and deletes the
115 image file.
116 </para>
117<screen>$ VBoxManage closemedium disk01.vdi --delete</screen>
118 </refsect1>
119</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