summaryrefslogtreecommitdiffstats
path: root/doc/manual/en_US/man_VBoxManage-showmediuminfo.xml
blob: 9318504311b25035bc1350992df7a33a0c2dc4f4 (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
133
134
135
136
137
138
139
140
141
142
<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage showmediuminfo
-->
<!--
    Copyright (C) 2006-2022 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-showmediuminfo" lang="en">
  <refentryinfo>
    <pubdate>$Date: 2022-08-22 19:43:14 +0200 (Mon, 22 Aug 2022) $</pubdate>
    <title>VBoxManage showmediuminfo</title>
  </refentryinfo>

  <refmeta>
    <refentrytitle>VBoxManage-showmediuminfo</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>VBoxManage-showmediuminfo</refname>
    <refpurpose>show information about a medium</refpurpose>
    <refclass>&product-name;</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="synopsis-vboxmanage-showmediuminfo">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
      <command>VBoxManage showmediuminfo</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>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      The <command>VBoxManage showmediuminfo</command> command shows the
      following information about a medium:
    </para>
    <itemizedlist>
      <listitem><para>
          Size
        </para></listitem>
      <listitem><para>
          Size on disk
        </para></listitem>
      <listitem><para>
          Type
        </para></listitem>
      <listitem><para>
          In use by virtual machines (VMs)
        </para></listitem>
    </itemizedlist>
    <para>
      The medium must be specified either by its UUID, if the medium is
      registered, or by its filename. Registered images can be listed
      using <command>VBoxManage list hdds</command>, <command>VBoxManage
      list dvds</command>, or <command>VBoxManage list
      floppies</command>, as appropriate.
    </para>
    <para>
      For backward compatibility, you can also use the
      <command>showvdiinfo</command> command to obtain information about
      the medium.
    </para>
    <variablelist>
      <varlistentry>
        <term><literal>disk</literal> | <literal>dvd</literal> | <literal>floppy</literal></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><para>
            If the medium is registered, you can specify the UUID. You
            can also list registered images by using the
            <command>VBoxManage list hdds</command>, <command>VBoxManage
            list dvds</command>, or <command>VBoxManage list
            floppies</command> command.
          </para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <remark role="help-scope" condition="GLOBAL" />
    <para>
      The following command shows information about the
      <filename>disk01.vdi</filename> disk image:
    </para>
<screen>$ VBoxManage showmediuminfo disk01.vdi</screen>
    <para>
      The following command shows information about the
      <filename>floppy01.img</filename> floppy disk image.
    </para>
<screen>$ VBoxManage showmediuminfo floppy floppy01.img</screen>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <xref linkend="vboxmanage-list" />
    </para>
  </refsect1>
</refentry>