1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage getextradata
-->
<!--
Copyright (C) 2006-2024 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: 2024-09-16 23:42:41 +0200 (Mon, 16 Sep 2024) $</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="req">
<arg choice="plain"><replaceable>keyword</replaceable></arg>
<arg choice="plain">enumerate</arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="vboxmanage-getextradata-description">
<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><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></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 id="vboxmanage-getextradata-examples">
<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-2024 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/LastItemSelected, Value: m=OracleLinux7u4
Key: GUI/LastWindowPosition, Value: 951,510,960,520
Key: GUI/SplitterSizes, Value: 318,637
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, 2022-10-10, stable, 7.0.0
Key: GUI/VirtualMediaManager/Details/Expanded, Value: true</screen>
</refsect1>
<refsect1 id="vboxmanage-getextradata-see-also">
<title>See Also</title>
<para>
<xref linkend="vboxmanage-setextradata" />
</para>
</refsect1>
</refentry>
|