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

<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage mediumproperty
-->
<!--
    Copyright (C) 2006-2023 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: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</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 id="vboxmanage-mediumproperty-description">
    <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 id="vboxmanage-mediumproperty-examples">
    <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>