VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-mediumproperty.xml@ 94200

Last change on this file since 94200 was 94200, checked in by vboxsync, 3 years ago

doc/manual,FE/VBoxManage: Convert mediumproperty command to refentry documentation, ​bugref:9186

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage mediumproperty
4
5 Copyright (C) 2006-2020 Oracle Corporation
6
7 This file is part of VirtualBox Open Source Edition (OSE), as
8 available from http://www.virtualbox.org. This file is free software;
9 you can redistribute it and/or modify it under the terms of the GNU
10 General Public License (GPL) as published by the Free Software
11 Foundation, in version 2 as it comes in the "COPYING" file of the
12 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14 -->
15<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
16 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
17<!ENTITY % all.entities SYSTEM "all-entities.ent">
18%all.entities;
19]>
20<refentry id="vboxmanage-mediumproperty" lang="en">
21 <refentryinfo>
22 <pubdate>$Date: 2022-03-12 19:24:38 +0000 (Sat, 12 Mar 2022) $</pubdate>
23 <title>VBoxManage mediumproperty</title>
24 </refentryinfo>
25
26 <refmeta>
27 <refentrytitle>VBoxManage-mediumproperty</refentrytitle>
28 <manvolnum>1</manvolnum>
29 </refmeta>
30
31 <refnamediv>
32 <refname>VBoxManage-mediumproperty</refname>
33 <refpurpose>manage medium properties</refpurpose>
34 <refclass>&product-name;</refclass>
35 </refnamediv>
36
37 <refsynopsisdiv>
38 <cmdsynopsis id="synopsis-vboxmanage-mediumproperty-set">
39<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
40 <command>VBoxManage mediumproperty</command>
41 <group>
42 <arg choice="plain">disk</arg>
43 <arg choice="plain">dvd</arg>
44 <arg choice="plain">floppy</arg>
45 </group>
46 <arg choice="plain">set</arg>
47 <group choice="req">
48 <arg choice="plain"><replaceable>uuid</replaceable></arg>
49 <arg choice="plain"><replaceable>filename</replaceable></arg>
50 </group>
51 <arg choice="req"><replaceable>property-name</replaceable></arg>
52 <arg choice="req"><replaceable>property-value</replaceable></arg>
53 </cmdsynopsis>
54
55 <cmdsynopsis id="synopsis-vboxmanage-mediumproperty-get">
56 <command>VBoxManage mediumproperty</command>
57 <group>
58 <arg choice="plain">disk</arg>
59 <arg choice="plain">dvd</arg>
60 <arg choice="plain">floppy</arg>
61 </group>
62 <arg choice="plain">get</arg>
63 <group choice="req">
64 <arg choice="plain"><replaceable>uuid</replaceable></arg>
65 <arg choice="plain"><replaceable>filename</replaceable></arg>
66 </group>
67 <arg choice="req"><replaceable>property-name</replaceable></arg>
68 </cmdsynopsis>
69
70 <cmdsynopsis id="synopsis-vboxmanage-mediumproperty-delete">
71 <command>VBoxManage mediumproperty</command>
72 <group>
73 <arg choice="plain">disk</arg>
74 <arg choice="plain">dvd</arg>
75 <arg choice="plain">floppy</arg>
76 </group>
77 <arg choice="plain">delete</arg>
78 <group choice="req">
79 <arg choice="plain"><replaceable>uuid</replaceable></arg>
80 <arg choice="plain"><replaceable>filename</replaceable></arg>
81 </group>
82 <arg choice="req"><replaceable>property-name</replaceable></arg>
83 </cmdsynopsis>
84 </refsynopsisdiv>
85
86 <refsect1>
87 <title>Description</title>
88 <para>
89 The <command>VBoxManage mediumproperty</command> command enables
90 you to set, retrieve, or delete a medium property.
91 </para>
92 <refsect2 id="vboxmanage-mediumproperty-set">
93 <title>Set a Medium Property</title>
94 <remark role="help-copy-synopsis"/>
95 <para>
96 The <command>VBoxManage mediumproperty set</command> command
97 enables you to set a medium property.
98 </para>
99 <variablelist>
100 <varlistentry>
101 <term><literal>disk | dvd | floppy</literal></term>
102 <listitem><para>
103 Specifies the type of medium. Valid values are
104 <literal>disk</literal> (hard drive),
105 <literal>dvd</literal>, or <literal>floppy</literal>.
106 </para></listitem>
107 </varlistentry>
108 <varlistentry>
109 <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
110 <listitem><para>
111 Specifies the Universally Unique Identifier (UUID) or
112 absolute path name of the medium or image.
113 </para></listitem>
114 </varlistentry>
115 <varlistentry>
116 <term><replaceable>property-name</replaceable></term>
117 <listitem><para>
118 Specifies the name of the property.
119 </para></listitem>
120 </varlistentry>
121 <varlistentry>
122 <term><replaceable>property-value</replaceable></term>
123 <listitem><para>
124 Specifies the value of the specified property.
125 </para></listitem>
126 </varlistentry>
127 </variablelist>
128 </refsect2>
129 <refsect2 id="vboxmanage-mediumproperty-get">
130 <title>Retrieve a Medium Property Value</title>
131 <remark role="help-copy-synopsis"/>
132 <para>
133 The <command>VBoxManage mediumproperty get</command> command
134 enables you to retrieve the value of a medium property.
135 </para>
136 <variablelist>
137 <varlistentry>
138 <term><literal>disk | dvd | floppy</literal></term>
139 <listitem><para>
140 Specifies the type of medium. Valid values are
141 <literal>disk</literal> (hard drive),
142 <literal>dvd</literal>, or <literal>floppy</literal>.
143 </para></listitem>
144 </varlistentry>
145 <varlistentry>
146 <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
147 <listitem><para>
148 Specifies the Universally Unique Identifier (UUID) or
149 absolute path name of the medium or image.
150 </para></listitem>
151 </varlistentry>
152 <varlistentry>
153 <term><replaceable>property-name</replaceable></term>
154 <listitem><para>
155 Specifies the name of the property.
156 </para></listitem>
157 </varlistentry>
158 </variablelist>
159 </refsect2>
160 <refsect2 id="vboxmanage-mediumproperty-delete">
161 <title>Delete a Medium Property</title>
162 <remark role="help-copy-synopsis"/>
163 <para>
164 The <command>VBoxManage mediumproperty delete</command> command
165 enables you to delete a medium property.
166 </para>
167 <variablelist>
168 <varlistentry>
169 <term><literal>disk | dvd | floppy</literal></term>
170 <listitem><para>
171 Specifies the type of medium. Valid values are
172 <literal>disk</literal> (hard drive),
173 <literal>dvd</literal>, or <literal>floppy</literal>.
174 </para></listitem>
175 </varlistentry>
176 <varlistentry>
177 <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term>
178 <listitem><para>
179 Specifies the Universally Unique Identifier (UUID) or
180 absolute path name of the medium or image.
181 </para></listitem>
182 </varlistentry>
183 <varlistentry>
184 <term><replaceable>property-name</replaceable></term>
185 <listitem><para>
186 Specifies the name of the property.
187 </para></listitem>
188 </varlistentry>
189 </variablelist>
190 </refsect2>
191 </refsect1>
192
193 <refsect1>
194 <title>Examples</title>
195 <remark role="help-scope" condition="GLOBAL" />
196 <para>
197 The following command sets the property called
198 <literal>prop1</literal> to <literal>val1</literal> for the
199 <filename>ol7.vdi</filename> disk image.
200 </para>
201<screen>$ VBoxManage mediumproperty disk set ol7.vdi prop1 val1</screen>
202 <para>
203 The following command gets the value of the property called
204 <literal>prop1</literal> for the <filename>ol7.vdi</filename> disk
205 image.
206 </para>
207<screen>$ VBoxManage mediumproperty disk get ol7.vdi prop1</screen>
208 </refsect1>
209</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