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