1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage setproperty
|
---|
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-setproperty" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
34 | <title>VBoxManage setproperty</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-setproperty</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-setproperty</refname>
|
---|
44 | <refpurpose>change global settings</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
50 | <cmdsynopsis id="synopsis-vboxmanage-setproperty">
|
---|
51 | <command>VBoxManage setproperty</command>
|
---|
52 | <arg choice="req"><replaceable>property-name</replaceable></arg>
|
---|
53 | <arg choice="req"><replaceable>property-value</replaceable></arg>
|
---|
54 | </cmdsynopsis>
|
---|
55 | </refsynopsisdiv>
|
---|
56 |
|
---|
57 | <refsect1 id="vboxmanage-setproperty-description">
|
---|
58 | <title>Description</title>
|
---|
59 | <para>
|
---|
60 | The <command>VBoxManage setproperty</command> command enables you
|
---|
61 | to change global settings that affect the entire &product-name;
|
---|
62 | installation. Some of these settings correspond to the settings in
|
---|
63 | the <emphasis role="bold">Preferences</emphasis> dialog in the
|
---|
64 | VirtualBox Manager.
|
---|
65 | </para>
|
---|
66 | <para>
|
---|
67 | The following properties are available:
|
---|
68 | </para>
|
---|
69 | <variablelist>
|
---|
70 | <varlistentry>
|
---|
71 | <term><literal>autostartdbpath</literal></term>
|
---|
72 | <listitem><para>
|
---|
73 | Specifies the path to the autostart database. Valid values
|
---|
74 | are <literal>null</literal>, which disables the autostart
|
---|
75 | database, or the name of the folder that contains the
|
---|
76 | database. See <xref linkend="autostart" />.
|
---|
77 | </para></listitem>
|
---|
78 | </varlistentry>
|
---|
79 | <varlistentry>
|
---|
80 | <term><literal>defaultfrontend</literal></term>
|
---|
81 | <listitem><para>
|
---|
82 | Specifies the global default VM frontend. Valid values are
|
---|
83 | <literal>default</literal>, which specifies the default
|
---|
84 | frontend, or the name of the frontend to use.
|
---|
85 | </para></listitem>
|
---|
86 | </varlistentry>
|
---|
87 | <varlistentry>
|
---|
88 | <term><literal>hwvirtexclusive</literal></term>
|
---|
89 | <listitem><para>
|
---|
90 | Specifies whether &product-name; makes exclusive use of the
|
---|
91 | Intel VT-x or AMD-V hardware virtualization extensions of
|
---|
92 | the host system's processor. See <xref linkend="hwvirt" />.
|
---|
93 | </para><para>
|
---|
94 | Valid values are as follows:
|
---|
95 | </para><itemizedlist>
|
---|
96 | <listitem><para>
|
---|
97 | <literal>on</literal> enables &product-name; to make
|
---|
98 | exclusive use of these extensions. This is the default
|
---|
99 | value.
|
---|
100 | </para></listitem>
|
---|
101 | <listitem><para>
|
---|
102 | <literal>off</literal> shares these extensions with
|
---|
103 | other hypervisors that run simultaneously. Note that
|
---|
104 | disabling this setting has negative performance
|
---|
105 | implications.
|
---|
106 | </para></listitem>
|
---|
107 | </itemizedlist></listitem>
|
---|
108 | </varlistentry>
|
---|
109 | <varlistentry>
|
---|
110 | <term><literal>language</literal></term>
|
---|
111 | <listitem><para>
|
---|
112 | Specifies the user language used to translate API messages.
|
---|
113 | Valid values are <literal>C</literal>, which means no
|
---|
114 | translation or language code in form either <literal>ll</literal>
|
---|
115 | or <literal>ll_CC</literal>, where <literal>ll</literal> is
|
---|
116 | language 2 letters code in lower case and
|
---|
117 | <literal>CC</literal> is country 2 letter code in upper case.
|
---|
118 | </para></listitem>
|
---|
119 | </varlistentry>
|
---|
120 | <varlistentry>
|
---|
121 | <term><literal>logginglevel</literal></term>
|
---|
122 | <listitem><para>
|
---|
123 | Specifies the VBoxSVC release logging details. See
|
---|
124 | <ulink url="http://www.virtualbox.org/wiki/VBoxLogging" />.
|
---|
125 | </para></listitem>
|
---|
126 | </varlistentry>
|
---|
127 | <varlistentry>
|
---|
128 | <term><literal>loghistorycount</literal></term>
|
---|
129 | <listitem><para>
|
---|
130 | Specifies the number of rotated VM logs to retain.
|
---|
131 | </para></listitem>
|
---|
132 | </varlistentry>
|
---|
133 | <varlistentry>
|
---|
134 | <term><literal>machinefolder</literal></term>
|
---|
135 | <listitem><para>
|
---|
136 | Specifies the default folder in which virtual machine (VM)
|
---|
137 | definitions are stored. Valid values are
|
---|
138 | <literal>default</literal>, which specifies the default
|
---|
139 | storage folder, or the name of the folder to use. See
|
---|
140 | <xref linkend="vboxconfigdata" />.
|
---|
141 | </para></listitem>
|
---|
142 | </varlistentry>
|
---|
143 | <varlistentry>
|
---|
144 | <term><literal>proxymode</literal></term>
|
---|
145 | <listitem><para>
|
---|
146 | Configures the mode for an HTTP proxy server. Valid values
|
---|
147 | are as follows:
|
---|
148 | </para><variablelist>
|
---|
149 | <varlistentry>
|
---|
150 | <term><literal>manual</literal></term>
|
---|
151 | <listitem><para>
|
---|
152 | Configure the URL of a HTTP proxy server manually,
|
---|
153 | using the <literal>proxyurl</literal> property value.
|
---|
154 | </para></listitem>
|
---|
155 | </varlistentry>
|
---|
156 | <varlistentry>
|
---|
157 | <term><literal>noproxy</literal></term>
|
---|
158 | <listitem><para>
|
---|
159 | Do not use an HTTP proxy server. A direct connection
|
---|
160 | to the Internet is used.
|
---|
161 | </para></listitem>
|
---|
162 | </varlistentry>
|
---|
163 | <varlistentry>
|
---|
164 | <term><literal>system</literal></term>
|
---|
165 | <listitem><para>
|
---|
166 | Detect the proxy settings automatically for the host
|
---|
167 | network. This is the default value.
|
---|
168 | </para></listitem>
|
---|
169 | </varlistentry>
|
---|
170 | </variablelist></listitem>
|
---|
171 | </varlistentry>
|
---|
172 | <varlistentry>
|
---|
173 | <term><literal>proxyurl</literal></term>
|
---|
174 | <listitem><para>
|
---|
175 | Specifies the URL for an HTTP proxy server when you specify
|
---|
176 | a manual proxy by setting the <literal>proxymode</literal>
|
---|
177 | property to <literal>manual</literal>.
|
---|
178 | </para></listitem>
|
---|
179 | </varlistentry>
|
---|
180 | <varlistentry>
|
---|
181 | <term><literal>vrdeauthlibrary</literal></term>
|
---|
182 | <listitem><para>
|
---|
183 | Specifies which library to use when external authentication
|
---|
184 | has been configured for a particular VM. Valid values are
|
---|
185 | <literal>default</literal>, which specifies the default
|
---|
186 | library, or the name of the library to use. See
|
---|
187 | <xref linkend="vbox-auth" />.
|
---|
188 | </para></listitem>
|
---|
189 | </varlistentry>
|
---|
190 | <varlistentry>
|
---|
191 | <term><literal>vrdeextpack</literal></term>
|
---|
192 | <listitem><para>
|
---|
193 | Specifies the library that implements the VirtualBox Remote
|
---|
194 | Desktop Extension (RDE). Valid values are
|
---|
195 | <literal>null</literal>, which disables the RDE, or the name
|
---|
196 | of the library to use.
|
---|
197 | </para></listitem>
|
---|
198 | </varlistentry>
|
---|
199 | <varlistentry>
|
---|
200 | <term><literal>websrvauthlibrary</literal></term>
|
---|
201 | <listitem><para>
|
---|
202 | Specifies which library the web service uses to authenticate
|
---|
203 | users. Valid values are <literal>default</literal>, which
|
---|
204 | specifies the default library, <literal>null</literal>,
|
---|
205 | which disables authentication, or the name of the library to
|
---|
206 | use. For information about the &product-name; web service,
|
---|
207 | see <xref linkend="VirtualBoxAPI" />.
|
---|
208 | </para></listitem>
|
---|
209 | </varlistentry>
|
---|
210 | </variablelist>
|
---|
211 | </refsect1>
|
---|
212 |
|
---|
213 | <refsect1 id="vboxmanage-setproperty-examples">
|
---|
214 | <title>Examples</title>
|
---|
215 | <remark role="help-scope" condition="GLOBAL" />
|
---|
216 | <para>
|
---|
217 | The following command configures &product-name; to use the
|
---|
218 | specified HTTP proxy server.
|
---|
219 | </para>
|
---|
220 | <screen>$ VBoxManage setproperty proxymode manual
|
---|
221 | $ VBoxManage setproperty proxyurl "http://myproxy.com:8080"</screen>
|
---|
222 | </refsect1>
|
---|
223 |
|
---|
224 | <refsect1 id="vboxmanage-setproperty-see-also">
|
---|
225 | <title>See Also</title>
|
---|
226 | <para>
|
---|
227 | <xref linkend="vboxmanage-startvm" />
|
---|
228 | </para>
|
---|
229 | </refsect1>
|
---|
230 | </refentry>
|
---|