[82044] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
[87075] | 3 | manpage, user manual, usage: VBoxManage showmediuminfo
|
---|
[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-showmediuminfo" lang="en">
|
---|
| 32 | <refentryinfo>
|
---|
[94197] | 33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
[82044] | 34 | <title>VBoxManage showmediuminfo</title>
|
---|
| 35 | </refentryinfo>
|
---|
| 36 |
|
---|
| 37 | <refmeta>
|
---|
| 38 | <refentrytitle>VBoxManage-showmediuminfo</refentrytitle>
|
---|
| 39 | <manvolnum>1</manvolnum>
|
---|
| 40 | </refmeta>
|
---|
| 41 |
|
---|
| 42 | <refnamediv>
|
---|
| 43 | <refname>VBoxManage-showmediuminfo</refname>
|
---|
| 44 | <refpurpose>show information about a medium</refpurpose>
|
---|
[94197] | 45 | <refclass>&product-name;</refclass>
|
---|
[82044] | 46 | </refnamediv>
|
---|
| 47 |
|
---|
| 48 | <refsynopsisdiv>
|
---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-showmediuminfo">
|
---|
| 50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
| 51 | <command>VBoxManage showmediuminfo</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 | </cmdsynopsis>
|
---|
| 62 | </refsynopsisdiv>
|
---|
| 63 |
|
---|
[99513] | 64 | <refsect1 id="vboxmanage-showmediuminfo-description">
|
---|
[82044] | 65 | <title>Description</title>
|
---|
| 66 | <para>
|
---|
| 67 | The <command>VBoxManage showmediuminfo</command> command shows the
|
---|
| 68 | following information about a medium:
|
---|
| 69 | </para>
|
---|
| 70 | <itemizedlist>
|
---|
| 71 | <listitem><para>
|
---|
| 72 | Size
|
---|
| 73 | </para></listitem>
|
---|
| 74 | <listitem><para>
|
---|
| 75 | Size on disk
|
---|
| 76 | </para></listitem>
|
---|
| 77 | <listitem><para>
|
---|
| 78 | Type
|
---|
| 79 | </para></listitem>
|
---|
| 80 | <listitem><para>
|
---|
| 81 | In use by virtual machines (VMs)
|
---|
| 82 | </para></listitem>
|
---|
| 83 | </itemizedlist>
|
---|
| 84 | <para>
|
---|
| 85 | The medium must be specified either by its UUID, if the medium is
|
---|
| 86 | registered, or by its filename. Registered images can be listed
|
---|
| 87 | using <command>VBoxManage list hdds</command>, <command>VBoxManage
|
---|
| 88 | list dvds</command>, or <command>VBoxManage list
|
---|
| 89 | floppies</command>, as appropriate.
|
---|
| 90 | </para>
|
---|
| 91 | <para>
|
---|
| 92 | For backward compatibility, you can also use the
|
---|
| 93 | <command>showvdiinfo</command> command to obtain information about
|
---|
| 94 | the medium.
|
---|
| 95 | </para>
|
---|
| 96 | <variablelist>
|
---|
| 97 | <varlistentry>
|
---|
| 98 | <term><literal>disk</literal> | <literal>dvd</literal> | <literal>floppy</literal></term>
|
---|
| 99 | <listitem><para>
|
---|
| 100 | Specifies the type of medium. Valid values are
|
---|
| 101 | <literal>disk</literal> (hard drive),
|
---|
| 102 | <literal>dvd</literal>, or <literal>floppy</literal>.
|
---|
| 103 | </para></listitem>
|
---|
| 104 | </varlistentry>
|
---|
| 105 | <varlistentry>
|
---|
| 106 | <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
|
---|
| 107 | <listitem><para>
|
---|
| 108 | Specifies the Universally Unique Identifier (UUID) or
|
---|
| 109 | absolute path name of the medium or image.
|
---|
| 110 | </para><para>
|
---|
| 111 | If the medium is registered, you can specify the UUID. You
|
---|
| 112 | can also list registered images by using the
|
---|
| 113 | <command>VBoxManage list hdds</command>, <command>VBoxManage
|
---|
| 114 | list dvds</command>, or <command>VBoxManage list
|
---|
| 115 | floppies</command> command.
|
---|
| 116 | </para></listitem>
|
---|
| 117 | </varlistentry>
|
---|
| 118 | </variablelist>
|
---|
| 119 | </refsect1>
|
---|
| 120 |
|
---|
[99513] | 121 | <refsect1 id="vboxmanage-showmediuminfo-examples">
|
---|
[82044] | 122 | <title>Examples</title>
|
---|
| 123 | <remark role="help-scope" condition="GLOBAL" />
|
---|
| 124 | <para>
|
---|
| 125 | The following command shows information about the
|
---|
| 126 | <filename>disk01.vdi</filename> disk image:
|
---|
| 127 | </para>
|
---|
| 128 | <screen>$ VBoxManage showmediuminfo disk01.vdi</screen>
|
---|
| 129 | <para>
|
---|
| 130 | The following command shows information about the
|
---|
| 131 | <filename>floppy01.img</filename> floppy disk image.
|
---|
| 132 | </para>
|
---|
| 133 | <screen>$ VBoxManage showmediuminfo floppy floppy01.img</screen>
|
---|
| 134 | </refsect1>
|
---|
| 135 |
|
---|
[99513] | 136 | <refsect1 id="vboxmanage-showmediuminfo-see-also">
|
---|
[82044] | 137 | <title>See Also</title>
|
---|
| 138 | <para>
|
---|
| 139 | <xref linkend="vboxmanage-list" />
|
---|
| 140 | </para>
|
---|
| 141 | </refsect1>
|
---|
| 142 | </refentry>
|
---|