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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage mediumproperty
-->
<!--
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-mediumproperty" lang="en">
<refentryinfo>
<pubdate>$Date: 2022-08-22 19:43:14 +0200 (Mon, 22 Aug 2022) $</pubdate>
<title>VBoxManage mediumproperty</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-mediumproperty</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-mediumproperty</refname>
<refpurpose>manage medium properties</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-mediumproperty-set">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage mediumproperty</command>
<group>
<arg choice="plain">disk</arg>
<arg choice="plain">dvd</arg>
<arg choice="plain">floppy</arg>
</group>
<arg choice="plain">set</arg>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>filename</replaceable></arg>
</group>
<arg choice="req"><replaceable>property-name</replaceable></arg>
<arg choice="req"><replaceable>property-value</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-mediumproperty-get">
<command>VBoxManage mediumproperty</command>
<group>
<arg choice="plain">disk</arg>
<arg choice="plain">dvd</arg>
<arg choice="plain">floppy</arg>
</group>
<arg choice="plain">get</arg>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>filename</replaceable></arg>
</group>
<arg choice="req"><replaceable>property-name</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-mediumproperty-delete">
<command>VBoxManage mediumproperty</command>
<group>
<arg choice="plain">disk</arg>
<arg choice="plain">dvd</arg>
<arg choice="plain">floppy</arg>
</group>
<arg choice="plain">delete</arg>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>filename</replaceable></arg>
</group>
<arg choice="req"><replaceable>property-name</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>VBoxManage mediumproperty</command> command enables
you to set, retrieve, or delete a medium property.
</para>
<refsect2 id="vboxmanage-mediumproperty-set">
<title>Set a Medium Property</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage mediumproperty set</command> command
enables you to set a medium property.
</para>
<variablelist>
<varlistentry>
<term><literal>disk | dvd | 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></listitem>
</varlistentry>
<varlistentry>
<term><replaceable>property-name</replaceable></term>
<listitem><para>
Specifies the name of the property.
</para></listitem>
</varlistentry>
<varlistentry>
<term><replaceable>property-value</replaceable></term>
<listitem><para>
Specifies the value of the specified property.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-mediumproperty-get">
<title>Retrieve a Medium Property Value</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage mediumproperty get</command> command
enables you to retrieve the value of a medium property.
</para>
<variablelist>
<varlistentry>
<term><literal>disk | dvd | 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></listitem>
</varlistentry>
<varlistentry>
<term><replaceable>property-name</replaceable></term>
<listitem><para>
Specifies the name of the property.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-mediumproperty-delete">
<title>Delete a Medium Property</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage mediumproperty delete</command> command
enables you to delete a medium property.
</para>
<variablelist>
<varlistentry>
<term><literal>disk | dvd | 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></listitem>
</varlistentry>
<varlistentry>
<term><replaceable>property-name</replaceable></term>
<listitem><para>
Specifies the name of the property.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL" />
<para>
The following command sets the property called
<literal>prop1</literal> to <literal>val1</literal> for the
<filename>ol7.vdi</filename> disk image.
</para>
<screen>$ VBoxManage mediumproperty disk set ol7.vdi prop1 val1</screen>
<para>
The following command gets the value of the property called
<literal>prop1</literal> for the <filename>ol7.vdi</filename> disk
image.
</para>
<screen>$ VBoxManage mediumproperty disk get ol7.vdi prop1</screen>
</refsect1>
</refentry>
|
