diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 14:19:18 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 14:19:18 +0000 |
commit | 4035b1bfb1e5843a539a8b624d21952b756974d1 (patch) | |
tree | f1e9cd5bf548cbc57ff2fddfb2b4aa9ae95587e2 /doc/manual/en_US/man_VBoxManage-mediumproperty.xml | |
parent | Initial commit. (diff) | |
download | virtualbox-4035b1bfb1e5843a539a8b624d21952b756974d1.tar.xz virtualbox-4035b1bfb1e5843a539a8b624d21952b756974d1.zip |
Adding upstream version 6.1.22-dfsg.upstream/6.1.22-dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manual/en_US/man_VBoxManage-mediumproperty.xml')
-rw-r--r-- | doc/manual/en_US/man_VBoxManage-mediumproperty.xml | 209 |
1 files changed, 209 insertions, 0 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-mediumproperty.xml b/doc/manual/en_US/man_VBoxManage-mediumproperty.xml new file mode 100644 index 00000000..726be99f --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-mediumproperty.xml @@ -0,0 +1,209 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + manpage, user manual, usage: VBoxManage mediumproperty + + Copyright (C) 2006-2020 Oracle Corporation + + This file is part of VirtualBox Open Source Edition (OSE), as + available from http://www.virtualbox.org. This file is free software; + you can redistribute it and/or modify it under the terms of the GNU + General Public License (GPL) as published by the Free Software + Foundation, in version 2 as it comes in the "COPYING" file of the + VirtualBox OSE distribution. VirtualBox OSE is distributed in the + hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. + --> +<!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>September 2019</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>Oracle VM VirtualBox</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> |