VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-getextradata.xml@ 103131

Last change on this file since 103131 was 99513, checked in by vboxsync, 20 months ago

manual,VBoxManage,isomaker/viso: Require all refsect1 and refsect2 elements to have @id attributes in manpages (refentry) to make these predictable and the split up topic files easier to handle for the docs team. Also requires these @id values to start with the refentry @id + '-'. Corrected a few bogus ones. Because 'controlvm' has too many sub-commands, HELP_SCOPE_ IDs will not be generated for 'See Also' and 'Examples' sections. bugref:10302

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage getextradata
4-->
5<!--
6 Copyright (C) 2006-2023 Oracle and/or its affiliates.
7
8 This file is part of VirtualBox base platform packages, as
9 available from https://www.virtualbox.org.
10
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License
13 as published by the Free Software Foundation, in version 3 of the
14 License.
15
16 This program is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, see <https://www.gnu.org/licenses>.
23
24 SPDX-License-Identifier: GPL-3.0-only
25-->
26<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
27 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
28<!ENTITY % all.entities SYSTEM "all-entities.ent">
29%all.entities;
30]>
31<refentry id="vboxmanage-getextradata" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage getextradata</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-getextradata</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-getextradata</refname>
44 <refpurpose>view keyword values that are associated with a virtual machine or
45 configuration</refpurpose>
46 <refclass>&product-name;</refclass>
47 </refnamediv>
48
49 <refsynopsisdiv>
50 <cmdsynopsis id="synopsis-vboxmanage-getextradata">
51<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
52 <command>VBoxManage getextradata</command>
53 <group choice="req">
54 <arg choice="plain">global</arg>
55 <arg choice="plain"><replaceable>uuid</replaceable></arg>
56 <arg choice="plain"><replaceable>vmname</replaceable></arg>
57 </group>
58 <group choice="req">
59 <arg choice="plain"><replaceable>keyword</replaceable></arg>
60 <arg choice="plain">enumerate</arg>
61 </group>
62 </cmdsynopsis>
63 </refsynopsisdiv>
64
65 <refsect1 id="vboxmanage-getextradata-description">
66 <title>Description</title>
67 <para>
68 The <command>VBoxManage getextradata</command> command enables you
69 to retrieve keyword data that is associated with a virtual machine
70 (VM) or with an &product-name; configuration.
71 </para>
72 <variablelist>
73 <varlistentry>
74 <term><literal>global</literal></term>
75 <listitem><para>
76 Specifies to retrieve information about the configuration
77 rather than a VM.
78 </para></listitem>
79 </varlistentry>
80 <varlistentry>
81 <term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
82 <listitem><para>
83 Specifies the Universally Unique Identifier (UUID) or name
84 of the VM.
85 </para></listitem>
86 </varlistentry>
87 <varlistentry>
88 <term><literal>enumerate</literal></term>
89 <listitem><para>
90 Shows all keyword values for the specified VM or
91 configuration.
92 </para></listitem>
93 </varlistentry>
94 <varlistentry>
95 <term><replaceable>keyword</replaceable></term>
96 <listitem><para>
97 Specifies the keyword for which to retrieve its value.
98 </para></listitem>
99 </varlistentry>
100 </variablelist>
101 </refsect1>
102
103 <refsect1 id="vboxmanage-getextradata-examples">
104 <title>Examples</title>
105 <remark role="help-scope" condition="GLOBAL"/>
106 <para>
107 The following command retrieves the <literal>installdate</literal>
108 keyword value for the <literal>Fedora5</literal> VM:
109 </para>
110<screen>$ VBoxManage getextradata Fedora5 installdate
111VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
112Copyright (C) 2005-2023 Oracle and/or its affiliates
113
114Value: 2006.01.01</screen>
115 <para>
116 The following command retrieves the information for all keywords
117 of the <literal>OracleLinux7u4</literal> VM:
118 </para>
119<screen>$ VBoxManage getextradata OracleLinux7u4 enumerate
120Key: GUI/LastCloseAction, Value: PowerOff
121Key: GUI/LastGuestSizeHint, Value: 1048,696
122Key: GUI/LastNormalWindowPosition, Value: 851,286,1048,738</screen>
123 <para>
124 The following command retrieves the information for all keywords
125 in the configuration:
126 </para>
127<screen>$ VBoxManage getextradata global enumerate
128Key: GUI/Details/Elements, Value: general,system,preview,display,storage,audio,network,usb,sharedFolders,description
129Key: GUI/DetailsPageBoxes, Value: general,system,preview,display,storage,audio,network,usb,sharedFolders,description
130Key: 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
131Key: GUI/HideDescriptionForWizards, Value: NewVM
132Key: GUI/LastItemSelected, Value: m=ol7u4
133Key: GUI/LastWindowPosition, Value: 951,510,960,520
134Key: GUI/RecentFolderCD, Value: C:/Users/user1
135Key: GUI/RecentListCD, Value: C:\Users\user1\V1.iso,C:\Users\user1\V2.iso,C:\Users\user1\V3.iso
136Key: GUI/SplitterSizes, Value: 318,637
137Key: GUI/SuppressMessages, Value: remindAboutMouseIntegration,remindAboutAutoCapture
138Key: GUI/Toolbar/MachineTools/Order, Value: Details
139Key: GUI/Tools/LastItemsSelected, Value: Welcome,Details
140Key: GUI/UpdateCheckCount, Value: 71
141Key: GUI/UpdateDate, Value: 1 d, 2019-04-10, stable, 5.2.22
142Key: GUI/VirtualMediaManager/Details/Expanded, Value: true</screen>
143 </refsect1>
144
145 <refsect1 id="vboxmanage-getextradata-see-also">
146 <title>See Also</title>
147 <para>
148 <xref linkend="vboxmanage-setextradata" />
149 </para>
150 </refsect1>
151</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