summaryrefslogtreecommitdiffstats
path: root/doc/manual/en_US/man_VBoxManage-getextradata.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/en_US/man_VBoxManage-getextradata.xml')
-rw-r--r--doc/manual/en_US/man_VBoxManage-getextradata.xml151
1 files changed, 151 insertions, 0 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-getextradata.xml b/doc/manual/en_US/man_VBoxManage-getextradata.xml
new file mode 100644
index 00000000..3c70b6ef
--- /dev/null
+++ b/doc/manual/en_US/man_VBoxManage-getextradata.xml
@@ -0,0 +1,151 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ manpage, user manual, usage: VBoxManage getextradata
+-->
+<!--
+ 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-getextradata" lang="en">
+ <refentryinfo>
+ <pubdate>$Date: 2022-08-22 19:43:14 +0200 (Mon, 22 Aug 2022) $</pubdate>
+ <title>VBoxManage getextradata</title>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>VBoxManage-getextradata</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>VBoxManage-getextradata</refname>
+ <refpurpose>view keyword values that are associated with a virtual machine or
+ configuration</refpurpose>
+ <refclass>&product-name;</refclass>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis id="synopsis-vboxmanage-getextradata">
+<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
+ <command>VBoxManage getextradata</command>
+ <group choice="req">
+ <arg choice="plain">global</arg>
+ <arg choice="plain"><replaceable>uuid</replaceable></arg>
+ <arg choice="plain"><replaceable>vmname</replaceable></arg>
+ </group>
+ <group choice="plain">
+ <arg choice="req"><replaceable>keyword</replaceable></arg>
+ <arg>enumerate</arg>
+ </group>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ The <command>VBoxManage getextradata</command> command enables you
+ to retrieve keyword data that is associated with a virtual machine
+ (VM) or with an &product-name; configuration.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><literal>global</literal></term>
+ <listitem><para>
+ Specifies to retrieve information about the configuration
+ rather than a VM.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></term>
+ <listitem><para>
+ Specifies the Universally Unique Identifier (UUID) or name
+ of the VM.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>enumerate</literal></term>
+ <listitem><para>
+ Shows all keyword values for the specified VM or
+ configuration.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><replaceable>keyword</replaceable></term>
+ <listitem><para>
+ Specifies the keyword for which to retrieve its value.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Examples</title>
+ <remark role="help-scope" condition="GLOBAL"/>
+ <para>
+ The following command retrieves the <literal>installdate</literal>
+ keyword value for the <literal>Fedora5</literal> VM:
+ </para>
+<screen>$ VBoxManage getextradata Fedora5 installdate
+VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
+Copyright (C) 2005-2022 Oracle and/or its affiliates
+
+Value: 2006.01.01</screen>
+ <para>
+ The following command retrieves the information for all keywords
+ of the <literal>OracleLinux7u4</literal> VM:
+ </para>
+<screen>$ VBoxManage getextradata OracleLinux7u4 enumerate
+Key: GUI/LastCloseAction, Value: PowerOff
+Key: GUI/LastGuestSizeHint, Value: 1048,696
+Key: GUI/LastNormalWindowPosition, Value: 851,286,1048,738</screen>
+ <para>
+ The following command retrieves the information for all keywords
+ in the configuration:
+ </para>
+<screen>$ VBoxManage getextradata global enumerate
+Key: GUI/Details/Elements, Value: general,system,preview,display,storage,audio,network,usb,sharedFolders,description
+Key: GUI/DetailsPageBoxes, Value: general,system,preview,display,storage,audio,network,usb,sharedFolders,description
+Key: GUI/GroupDefinitions/, Value: m=43349dd8-2aa3-41b8-988f-0e255ce68090,m=9ebcd81e-5231-48ce-a27d-28218757f3fe,m=c690e8b1-93a0-4c95-9cd7-6437fff93251,m=f7c1e10d-3722-4891-887e-07b3c4104946
+Key: GUI/HideDescriptionForWizards, Value: NewVM
+Key: GUI/LastItemSelected, Value: m=ol7u4
+Key: GUI/LastWindowPosition, Value: 951,510,960,520
+Key: GUI/RecentFolderCD, Value: C:/Users/user1
+Key: GUI/RecentListCD, Value: C:\Users\user1\V1.iso,C:\Users\user1\V2.iso,C:\Users\user1\V3.iso
+Key: GUI/SplitterSizes, Value: 318,637
+Key: GUI/SuppressMessages, Value: remindAboutMouseIntegration,remindAboutAutoCapture
+Key: GUI/Toolbar/MachineTools/Order, Value: Details
+Key: GUI/Tools/LastItemsSelected, Value: Welcome,Details
+Key: GUI/UpdateCheckCount, Value: 71
+Key: GUI/UpdateDate, Value: 1 d, 2019-04-10, stable, 5.2.22
+Key: GUI/VirtualMediaManager/Details/Expanded, Value: true</screen>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <xref linkend="vboxmanage-setextradata" />
+ </para>
+ </refsect1>
+</refentry>