VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-mediumproperty.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: 8.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage mediumproperty
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-mediumproperty" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage mediumproperty</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-mediumproperty</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-mediumproperty</refname>
44 <refpurpose>manage medium properties</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-mediumproperty-set">
50<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
51 <command>VBoxManage mediumproperty</command>
52 <group>
53 <arg choice="plain">disk</arg>
54 <arg choice="plain">dvd</arg>
55 <arg choice="plain">floppy</arg>
56 </group>
57 <arg choice="plain">set</arg>
58 <group choice="req">
59 <arg choice="plain"><replaceable>uuid</replaceable></arg>
60 <arg choice="plain"><replaceable>filename</replaceable></arg>
61 </group>
62 <arg choice="req"><replaceable>property-name</replaceable></arg>
63 <arg choice="req"><replaceable>property-value</replaceable></arg>
64 </cmdsynopsis>
65
66 <cmdsynopsis id="synopsis-vboxmanage-mediumproperty-get">
67 <command>VBoxManage mediumproperty</command>
68 <group>
69 <arg choice="plain">disk</arg>
70 <arg choice="plain">dvd</arg>
71 <arg choice="plain">floppy</arg>
72 </group>
73 <arg choice="plain">get</arg>
74 <group choice="req">
75 <arg choice="plain"><replaceable>uuid</replaceable></arg>
76 <arg choice="plain"><replaceable>filename</replaceable></arg>
77 </group>
78 <arg choice="req"><replaceable>property-name</replaceable></arg>
79 </cmdsynopsis>
80
81 <cmdsynopsis id="synopsis-vboxmanage-mediumproperty-delete">
82 <command>VBoxManage mediumproperty</command>
83 <group>
84 <arg choice="plain">disk</arg>
85 <arg choice="plain">dvd</arg>
86 <arg choice="plain">floppy</arg>
87 </group>
88 <arg choice="plain">delete</arg>
89 <group choice="req">
90 <arg choice="plain"><replaceable>uuid</replaceable></arg>
91 <arg choice="plain"><replaceable>filename</replaceable></arg>
92 </group>
93 <arg choice="req"><replaceable>property-name</replaceable></arg>
94 </cmdsynopsis>
95 </refsynopsisdiv>
96
97 <refsect1 id="vboxmanage-mediumproperty-description">
98 <title>Description</title>
99 <para>
100 The <command>VBoxManage mediumproperty</command> command enables
101 you to set, retrieve, or delete a medium property.
102 </para>
103 <refsect2 id="vboxmanage-mediumproperty-set">
104 <title>Set a Medium Property</title>
105 <remark role="help-copy-synopsis"/>
106 <para>
107 The <command>VBoxManage mediumproperty set</command> command
108 enables you to set a medium property.
109 </para>
110 <variablelist>
111 <varlistentry>
112 <term><literal>disk | dvd | floppy</literal></term>
113 <listitem><para>
114 Specifies the type of medium. Valid values are
115 <literal>disk</literal> (hard drive),
116 <literal>dvd</literal>, or <literal>floppy</literal>.
117 </para></listitem>
118 </varlistentry>
119 <varlistentry>
120 <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
121 <listitem><para>
122 Specifies the Universally Unique Identifier (UUID) or
123 absolute path name of the medium or image.
124 </para></listitem>
125 </varlistentry>
126 <varlistentry>
127 <term><replaceable>property-name</replaceable></term>
128 <listitem><para>
129 Specifies the name of the property.
130 </para></listitem>
131 </varlistentry>
132 <varlistentry>
133 <term><replaceable>property-value</replaceable></term>
134 <listitem><para>
135 Specifies the value of the specified property.
136 </para></listitem>
137 </varlistentry>
138 </variablelist>
139 </refsect2>
140 <refsect2 id="vboxmanage-mediumproperty-get">
141 <title>Retrieve a Medium Property Value</title>
142 <remark role="help-copy-synopsis"/>
143 <para>
144 The <command>VBoxManage mediumproperty get</command> command
145 enables you to retrieve the value of a medium property.
146 </para>
147 <variablelist>
148 <varlistentry>
149 <term><literal>disk | dvd | floppy</literal></term>
150 <listitem><para>
151 Specifies the type of medium. Valid values are
152 <literal>disk</literal> (hard drive),
153 <literal>dvd</literal>, or <literal>floppy</literal>.
154 </para></listitem>
155 </varlistentry>
156 <varlistentry>
157 <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
158 <listitem><para>
159 Specifies the Universally Unique Identifier (UUID) or
160 absolute path name of the medium or image.
161 </para></listitem>
162 </varlistentry>
163 <varlistentry>
164 <term><replaceable>property-name</replaceable></term>
165 <listitem><para>
166 Specifies the name of the property.
167 </para></listitem>
168 </varlistentry>
169 </variablelist>
170 </refsect2>
171 <refsect2 id="vboxmanage-mediumproperty-delete">
172 <title>Delete a Medium Property</title>
173 <remark role="help-copy-synopsis"/>
174 <para>
175 The <command>VBoxManage mediumproperty delete</command> command
176 enables you to delete a medium property.
177 </para>
178 <variablelist>
179 <varlistentry>
180 <term><literal>disk | dvd | floppy</literal></term>
181 <listitem><para>
182 Specifies the type of medium. Valid values are
183 <literal>disk</literal> (hard drive),
184 <literal>dvd</literal>, or <literal>floppy</literal>.
185 </para></listitem>
186 </varlistentry>
187 <varlistentry>
188 <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
189 <listitem><para>
190 Specifies the Universally Unique Identifier (UUID) or
191 absolute path name of the medium or image.
192 </para></listitem>
193 </varlistentry>
194 <varlistentry>
195 <term><replaceable>property-name</replaceable></term>
196 <listitem><para>
197 Specifies the name of the property.
198 </para></listitem>
199 </varlistentry>
200 </variablelist>
201 </refsect2>
202 </refsect1>
203
204 <refsect1 id="vboxmanage-mediumproperty-examples">
205 <title>Examples</title>
206 <remark role="help-scope" condition="GLOBAL" />
207 <para>
208 The following command sets the property called
209 <literal>prop1</literal> to <literal>val1</literal> for the
210 <filename>ol7.vdi</filename> disk image.
211 </para>
212<screen>$ VBoxManage mediumproperty disk set ol7.vdi prop1 val1</screen>
213 <para>
214 The following command gets the value of the property called
215 <literal>prop1</literal> for the <filename>ol7.vdi</filename> disk
216 image.
217 </para>
218<screen>$ VBoxManage mediumproperty disk get ol7.vdi prop1</screen>
219 </refsect1>
220</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