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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage setproperty
-->
<!--
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-setproperty" lang="en">
<refentryinfo>
<pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate>
<title>VBoxManage setproperty</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-setproperty</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-setproperty</refname>
<refpurpose>change global settings</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<cmdsynopsis id="synopsis-vboxmanage-setproperty">
<command>VBoxManage setproperty</command>
<arg choice="req"><replaceable>property-name</replaceable></arg>
<arg choice="req"><replaceable>property-value</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>VBoxManage setproperty</command> command enables you
to change global settings that affect the entire &product-name;
installation. Some of these settings correspond to the settings in
the <emphasis role="bold">Preferences</emphasis> dialog in the
VirtualBox Manager.
</para>
<para>
The following properties are available:
</para>
<variablelist>
<varlistentry>
<term><literal>autostartdbpath</literal></term>
<listitem><para>
Specifies the path to the autostart database. Valid values
are <literal>null</literal>, which disables the autostart
database, or the name of the folder that contains the
database. See <xref linkend="autostart" />.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>defaultfrontend</literal></term>
<listitem><para>
Specifies the global default VM frontend. Valid values are
<literal>default</literal>, which specifies the default
frontend, or the name of the frontend to use.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>hwvirtexclusive</literal></term>
<listitem><para>
Specifies whether &product-name; makes exclusive use of the
Intel VT-x or AMD-V hardware virtualization extensions of
the host system's processor. See <xref linkend="hwvirt" />.
</para><para>
Valid values are as follows:
</para><itemizedlist>
<listitem><para>
<literal>on</literal> enables &product-name; to make
exclusive use of these extensions. This is the default
value.
</para></listitem>
<listitem><para>
<literal>off</literal> shares these extensions with
other hypervisors that run simultaneously. Note that
disabling this setting has negative performance
implications.
</para></listitem>
</itemizedlist></listitem>
</varlistentry>
<varlistentry>
<term><literal>language</literal></term>
<listitem><para>
Specifies the user language used to translate API messages.
Valid values are <literal>C</literal>, which means no
translation or language code in form either <literal>ll</literal>
or <literal>ll_CC</literal>, where <literal>ll</literal> is
language 2 letters code in lower case and
<literal>CC</literal> is country 2 letter code in upper case.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>logginglevel</literal></term>
<listitem><para>
Specifies the VBoxSVC release logging details. See
<ulink url="http://www.virtualbox.org/wiki/VBoxLogging" />.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>loghistorycount</literal></term>
<listitem><para>
Specifies the number of rotated VM logs to retain.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>machinefolder</literal></term>
<listitem><para>
Specifies the default folder in which virtual machine (VM)
definitions are stored. Valid values are
<literal>default</literal>, which specifies the default
storage folder, or the name of the folder to use. See
<xref linkend="vboxconfigdata" />.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>proxymode</literal></term>
<listitem><para>
Configures the mode for an HTTP proxy server. Valid values
are as follows:
</para><variablelist>
<varlistentry>
<term><literal>manual</literal></term>
<listitem><para>
Configure the URL of a HTTP proxy server manually,
using the <literal>proxyurl</literal> property value.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>noproxy</literal></term>
<listitem><para>
Do not use an HTTP proxy server. A direct connection
to the Internet is used.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>system</literal></term>
<listitem><para>
Detect the proxy settings automatically for the host
network. This is the default value.
</para></listitem>
</varlistentry>
</variablelist></listitem>
</varlistentry>
<varlistentry>
<term><literal>proxyurl</literal></term>
<listitem><para>
Specifies the URL for an HTTP proxy server when you specify
a manual proxy by setting the <literal>proxymode</literal>
property to <literal>manual</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>vrdeauthlibrary</literal></term>
<listitem><para>
Specifies which library to use when external authentication
has been configured for a particular VM. Valid values are
<literal>default</literal>, which specifies the default
library, or the name of the library to use. See
<xref linkend="vbox-auth" />.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>vrdeextpack</literal></term>
<listitem><para>
Specifies the library that implements the VirtualBox Remote
Desktop Extension (RDE). Valid values are
<literal>null</literal>, which disables the RDE, or the name
of the library to use.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>websrvauthlibrary</literal></term>
<listitem><para>
Specifies which library the web service uses to authenticate
users. Valid values are <literal>default</literal>, which
specifies the default library, <literal>null</literal>,
which disables authentication, or the name of the library to
use. For information about the &product-name; web service,
see <xref linkend="VirtualBoxAPI" />.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL" />
<para>
The following command configures &product-name; to use the
specified HTTP proxy server.
</para>
<screen>$ VBoxManage setproperty proxymode manual
$ VBoxManage setproperty proxyurl "http://myproxy.com:8080"</screen>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<xref linkend="vboxmanage-startvm" />
</para>
</refsect1>
</refentry>
|
