blob: 7327f5eb11a0811b966cf4f73ed7159bdcf7989b (
plain)
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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage setextradata
-->
<!--
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-setextradata" lang="en">
<refentryinfo>
<pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
<title>VBoxManage setextradata</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-setextradata</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-setextradata</refname>
<refpurpose>set a keyword value that is associated with a virtual machine or
configuration</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-setextradata">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage setextradata</command>
<group choice="req">
<arg choice="plain">global</arg>
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="req"><replaceable>keyword</replaceable></arg>
<arg><replaceable>value</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>VBoxManage setextradata</command> command enables you
to set a keyword value that is associated with a virtual machine
(VM) or with an &product-name; configuration.
</para>
<variablelist>
<varlistentry>
<term><literal>global</literal></term>
<listitem><para>
Sets 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><replaceable>keyword</replaceable></term>
<listitem><para>
Specifies the keyword for which to set its value.
</para></listitem>
</varlistentry>
<varlistentry>
<term><replaceable>value</replaceable></term>
<listitem><para>
Specifies the keyword value. Specifying no value removes the
keyword.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL"/>
<para>
The following command sets the <literal>installdate</literal>
keyword value for the <literal>Fedora5</literal> VM to
<literal>2019.01.01</literal>:
</para>
<screen>$ VBoxManage setextradata Fedora5 installdate 2019.01.01</screen>
<para>
The following command unsets the value of the
<literal>installdate</literal> keyword for the
<literal>Fedora5</literal> VM:
</para>
<screen>$ VBoxManage setextradata Fedora5 installdate</screen>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<xref linkend="vboxmanage-getextradata" />
</para>
</refsect1>
</refentry>
|
