VirtualBox

Changeset 105335 in vbox


Ignore:
Timestamp:
Jul 16, 2024 8:01:22 AM (5 months ago)
Author:
vboxsync
Message:

FE/Qt: bugref:10705. Merging r6149 from doc team's repo.

Location:
trunk/doc/manual/en_US/dita/topics
Files:
141 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/dita/topics/addhostonlysolaris.dita

    r99797 r105335  
    66 
    77  <body>
    8     <p>
    9       By default <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides you with one host-only network
    10       interface. Adding more host-only network interfaces on Oracle
    11       Solaris hosts requires manual configuration. Here is how to add
    12       another host-only network interface.
    13     </p>
    14     <p>
    15       Begin by stopping all running VMs. Then, unplumb the existing
    16       "vboxnet0" interface by execute the following command as root:
    17     </p>
     8    <p>By default <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides you with one host-only network
     9      interface. Adding more host-only network interfaces on Oracle Solaris hosts requires manual configuration. Here is
     10      how to add another host-only network interface. </p>
     11    <p>Begin by stopping all running VMs. Then, unplumb the existing "vboxnet0" interface by execute the following
     12      command as root: </p>
    1813    <pre xml:space="preserve"># ifconfig vboxnet0 unplumb</pre>
    19     <p>
    20       If you have several vboxnet interfaces, you will need to unplumb
    21       all of them. Once all vboxnet interfaces are unplumbed, remove the
    22       driver by executing the following command as root:
    23     </p>
     14    <p>If you have several vboxnet interfaces, you will need to unplumb all of them. Once all vboxnet interfaces are
     15      unplumbed, remove the driver by executing the following command as root: </p>
    2416    <pre xml:space="preserve"># rem_drv vboxnet</pre>
    25     <p>
    26       Edit the file
    27       <filepath>/platform/i86pc/kernel/drv/vboxnet.conf</filepath> and
    28       add a line for the new interface we want to add as shown below:
    29     </p>
     17    <p>Edit the file <filepath>/platform/i86pc/kernel/drv/vboxnet.conf</filepath> and add a line for the new interface
     18      we want to add as shown below: </p>
    3019    <pre xml:space="preserve">name="vboxnet" parent="pseudo" instance=1;
    3120name="vboxnet" parent="pseudo" instance=2;</pre>
    32     <p>
    33       Add as many of these lines as required with each line having a
    34       unique instance number.
    35     </p>
    36     <p>
    37       Next, reload the vboxnet driver by executing the following command
    38       as root:
    39     </p>
     21    <p>Add as many of these lines as required with each line having a unique instance number. </p>
     22    <p>Next, reload the vboxnet driver by executing the following command as root: </p>
    4023    <pre xml:space="preserve"># add_drv vboxnet</pre>
    41     <p>
    42       On Oracle Solaris 11.1 and newer hosts you may want to rename the
    43       default vanity interface name. To check what name has been
    44       assigned, execute:
    45     </p>
     24    <p>On Oracle Solaris 11.1 and newer hosts you may want to rename the default vanity interface name. To check what
     25      name has been assigned, execute: </p>
    4626    <pre xml:space="preserve">$ dladm show-phys
    4727LINK              MEDIA                STATE      SPEED  DUPLEX    DEVICE
    … …  
    5535    </p>
    5636    <pre xml:space="preserve"># dladm rename-link net2 vboxnet1</pre>
    57     <p>
    58       Now plumb all the interfaces using <userinput>ifconfig
    59       vboxnet<varname>X</varname> plumb</userinput>, where
    60       <varname>X</varname> would be 1 in this case. Once the
    61       interface is plumbed, it may be configured like any other network
    62       interface. Refer to the <userinput>ifconfig</userinput> documentation
    63       for further details.
    64     </p>
    65     <p>
    66       To make the settings for the newly added interfaces persistent
    67       across reboots, you will need to edit the files
    68       <filepath>/etc/inet/netmasks</filepath>, and if you are using NWAM
    69       <filepath>/etc/nwam/llp</filepath> and add the appropriate entries
    70       to set the netmask and static IP for each of those interfaces. The
    71       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> installer only updates these configuration files
    72       for the one "vboxnet0" interface it creates by default.
    73     </p>
     37    <p>Now plumb all the interfaces using <userinput>ifconfig vboxnet<varname>X</varname> plumb</userinput>, where
     38        <varname>X</varname> would be 1 in this case. Once the interface is plumbed, it may be configured like any other
     39      network interface. Refer to the <userinput>ifconfig</userinput> documentation for further details. </p>
     40    <p>To make the settings for the newly added interfaces persistent across reboots, you will need to edit the files
     41        <filepath>/etc/inet/netmasks</filepath>, and if you are using NWAM <filepath>/etc/nwam/llp</filepath> and add
     42      the appropriate entries to set the netmask and static IP for each of those interfaces. The <ph
     43        conkeyref="vbox-conkeyref-phrases/product-name"/> installer only updates these configuration files for the one
     44      "vboxnet0" interface it creates by default. </p>
    7445  </body>
    7546 

  • trunk/doc/manual/en_US/dita/topics/autologon.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides Guest Addition modules for Windows, Linux,
    9       and Oracle Solaris to enable automated logins on the guest.
    10     </p>
    11     <p> When a guest operating system is running in a virtual machine, it might be required to
    12       perform coordinated and automated logins using credentials passed from the host. Credentials
    13       are user name, password, and domain name, where each value might be empty. </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides Guest Addition modules for Windows, Linux, and
     8      Oracle Solaris to enable automated logins on the guest. </p>
     9    <p>When a guest operating system is running in a virtual machine, it might be required to perform coordinated and
     10      automated logins using credentials passed from the host. Credentials are user name, password, and domain name,
     11      where each value might be empty. </p>
    1412  </body>
    1513</topic>

  • trunk/doc/manual/en_US/dita/topics/autologon_unix.dita

    r105176 r105335  
    55 
    66  <body>
    7     <p>
    8         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a custom PAM module (Pluggable
    9         Authentication Module) which can be used to perform automated
    10         guest logins on platforms which support this framework.
    11         Virtually all modern Linux and UNIX distributions rely on PAM.
    12       </p>
    13     <p>
    14         For automated logins on Ubuntu, or Ubuntu-derived, distributions
    15         using LightDM as the display manager. See
    16         <xref href="autologon_unix_lightdm.dita#autologon_unix_lightdm"/>.
    17       </p>
    18     <p>
    19         The <filepath>pam_vbox.so</filepath> module itself
    20         <i>does not</i> do an actual verification of the
    21         credentials passed to the guest OS. Instead it relies on other
    22         modules such as <filepath>pam_unix.so</filepath> or
    23         <filepath>pam_unix2.so</filepath> down in the PAM stack to do
    24         the actual validation using the credentials retrieved by
    25         <filepath>pam_vbox.so</filepath>. Therefore
    26         <filepath>pam_vbox.so</filepath> has to be on top of the
    27         authentication PAM service list.
    28       </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a custom PAM module (Pluggable Authentication
     8      Module) which can be used to perform automated guest logins on platforms which support this framework. Virtually
     9      all modern Linux and UNIX distributions rely on PAM. </p>
     10    <p>For automated logins on Ubuntu, or Ubuntu-derived, distributions using LightDM as the display manager. See <xref
     11        href="autologon_unix_lightdm.dita#autologon_unix_lightdm"/>. </p>
     12    <p>The <filepath>pam_vbox.so</filepath> module itself <i>does not</i> do an actual verification of the credentials
     13      passed to the guest OS. Instead it relies on other modules such as <filepath>pam_unix.so</filepath> or
     14        <filepath>pam_unix2.so</filepath> down in the PAM stack to do the actual validation using the credentials
     15      retrieved by <filepath>pam_vbox.so</filepath>. Therefore <filepath>pam_vbox.so</filepath> has to be on top of the
     16      authentication PAM service list. </p>
    2917    <note>
    30       <p>
    31           The <filepath>pam_vbox.so</filepath> module only supports the
    32           <codeph>auth</codeph> primitive. Other primitives such as
    33           <codeph>account</codeph>, <codeph>session</codeph>, or
    34           <codeph>password</codeph> are not supported.
    35         </p>
     18      <p>The <filepath>pam_vbox.so</filepath> module only supports the <codeph>auth</codeph> primitive. Other primitives
     19        such as <codeph>account</codeph>, <codeph>session</codeph>, or <codeph>password</codeph> are not supported. </p>
    3620    </note>
    37     <p> The <filepath>pam_vbox.so</filepath> module is shipped as part of the Guest Additions but it
    38       is not installed or activated on the guest OS by default. In order to install it, it has to be
    39       copied from <filepath>/opt/VBoxGuestAdditions-<varname>version</varname>/other/</filepath> to
    40       the security modules directory. This is usually <filepath>/lib/security/</filepath> on 32-bit
    41       Linux guests or <filepath>/lib64/security/</filepath> on 64-bit Linux guests. Please refer to
    42       your guest OS documentation for the correct PAM module directory. </p>
    43     <p>
    44         For example, to use <filepath>pam_vbox.so</filepath> with a
    45         Ubuntu Linux guest OS and the GNOME Desktop Manager (GDM) to log
    46         in users automatically with the credentials passed by the host,
    47         configure the guest OS as follows:
    48       </p>
     21    <p>The <filepath>pam_vbox.so</filepath> module is shipped as part of the Guest Additions but it is not installed or
     22      activated on the guest OS by default. In order to install it, it has to be copied from
     23          <filepath>/opt/VBoxGuestAdditions-<varname>version</varname>/other/</filepath> to the security modules
     24      directory. This is usually <filepath>/lib/security/</filepath> on 32-bit Linux guests or
     25        <filepath>/lib64/security/</filepath> on 64-bit Linux guests. Please refer to your guest OS documentation for
     26      the correct PAM module directory. </p>
     27    <p>For example, to use <filepath>pam_vbox.so</filepath> with a Ubuntu Linux guest OS and the GNOME Desktop Manager
     28      (GDM) to log in users automatically with the credentials passed by the host, configure the guest OS as follows: </p>
    4929    <ol>
    5030      <li>
    51         <p>
    52             Copy the <filepath>pam_vbox.so</filepath> module to the
    53             security modules directory. In this case,
    54             <filepath>/lib/security</filepath>.
    55           </p>
     31        <p>Copy the <filepath>pam_vbox.so</filepath> module to the security modules directory. In this case,
     32            <filepath>/lib/security</filepath>. </p>
    5633      </li>
    5734      <li>
    58         <p>
    59             Edit the PAM configuration file for GDM, found at
    60             <filepath>/etc/pam.d/gdm</filepath>. Add the line
    61             <codeph>auth requisite pam_vbox.so</codeph> at the top.
    62             Additionally, in most Linux distributions there is a file
    63             called <filepath>/etc/pam.d/common-auth</filepath>. This
    64             file is included in many other services, like the GDM file
    65             mentioned above. There you also have to add the line
    66             <codeph>auth requisite pam_vbox.so</codeph>.
    67           </p>
     35        <p>Edit the PAM configuration file for GDM, found at <filepath>/etc/pam.d/gdm</filepath>. Add the line
     36            <codeph>auth requisite pam_vbox.so</codeph> at the top. Additionally, in most Linux distributions there is a
     37          file called <filepath>/etc/pam.d/common-auth</filepath>. This file is included in many other services, like
     38          the GDM file mentioned above. There you also have to add the line <codeph>auth requisite pam_vbox.so</codeph>. </p>
    6839      </li>
    6940      <li>
    7041        <p> If authentication against the shadow database using <filepath>pam_unix.so</filepath> or
    71             <filepath>pam_unix2.so</filepath> is required, the argument
    72             <codeph>try_first_pass</codeph> for <filepath>pam_unix.so</filepath> or
    73             <codeph>use_first_pass</codeph> for <filepath>pam_unix2.so</filepath> is needed in order
    74           to pass the credentials from the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    75           module to the shadow database authentication module. For Ubuntu, this must be added to
     42            <filepath>pam_unix2.so</filepath> is required, the argument <codeph>try_first_pass</codeph> for
     43            <filepath>pam_unix.so</filepath> or <codeph>use_first_pass</codeph> for <filepath>pam_unix2.so</filepath> is
     44          needed in order to pass the credentials from the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> module
     45          to the shadow database authentication module. For Ubuntu, this must be added to
    7646            <filepath>/etc/pam.d/common-auth</filepath>, to the end of the line referencing
    77             <filepath>pam_unix.so</filepath>. This argument tells the PAM module to use credentials
    78           already present in the stack, such as the ones provided by the <ph
    79             conkeyref="vbox-conkeyref-phrases/product-name"/> PAM module. </p>
     47            <filepath>pam_unix.so</filepath>. This argument tells the PAM module to use credentials already present in
     48          the stack, such as the ones provided by the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> PAM module. </p>
    8049      </li>
    8150    </ol>
    8251    <note type="caution">
    83       <p>
    84           An incorrectly configured PAM stack can effectively prevent
    85           you from logging into your guest system.
    86         </p>
     52      <p>An incorrectly configured PAM stack can effectively prevent you from logging into your guest system. </p>
    8753    </note>
    88     <p>
    89         To make deployment easier, you can pass the argument
    90         <codeph>debug</codeph> right after the
    91         <filepath>pam_vbox.so</filepath> statement. Debug log output
    92         will then be recorded using syslog.
    93       </p>
     54    <p>To make deployment easier, you can pass the argument <codeph>debug</codeph> right after the
     55        <filepath>pam_vbox.so</filepath> statement. Debug log output will then be recorded using syslog. </p>
    9456    <note>
    95       <p>
    96           By default, <userinput>pam_vbox</userinput> does not wait for
    97           credentials to arrive from the host. When a login prompt is
    98           shown, for example by GDM/KDM or the text console, and
    99           <userinput>pam_vbox</userinput> does not yet have credentials it
    100           does not wait until they arrive. Instead the next module in
    101           the PAM stack, depending on the PAM configuration, will have
    102           the chance for authentication.
    103         </p>
     57      <p>By default, <userinput>pam_vbox</userinput> does not wait for credentials to arrive from the host. When a login
     58        prompt is shown, for example by GDM/KDM or the text console, and <userinput>pam_vbox</userinput> does not yet
     59        have credentials it does not wait until they arrive. Instead the next module in the PAM stack, depending on the
     60        PAM configuration, will have the chance for authentication. </p>
    10461    </note>
    10562    <p><userinput>pam_vbox</userinput> supports various guest property
    … …  
    164121    </ul>
    165122    <note>
    166       <p>
    167           If a <userinput>pam_vbox</userinput> guest property does not have
    168           the correct flag set (<codeph>RDONLYGUEST</codeph>) the
    169           property is ignored and, depending on the property, a default
    170           value will be used. This can result in pam_vbox not waiting
    171           for credentials. Consult the appropriate syslog file for more
    172           information and use the <codeph>debug</codeph> option.
    173         </p>
     123      <p>If a <userinput>pam_vbox</userinput> guest property does not have the correct flag set
     124          (<codeph>RDONLYGUEST</codeph>) the property is ignored and, depending on the property, a default value will be
     125        used. This can result in pam_vbox not waiting for credentials. Consult the appropriate syslog file for more
     126        information and use the <codeph>debug</codeph> option. </p>
    174127    </note>
    175128  </body>

  • trunk/doc/manual/en_US/dita/topics/autologon_unix_lightdm.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8           <ph conkeyref="vbox-conkeyref-phrases/product-name"/> comes with a greeter module, named
    9           <userinput>vbox-greeter</userinput>, that can be used with
    10           LightDM. LightDM is the default display manager for Ubuntu
    11           Linux and therefore can also be used for automated guest
    12           logins.
    13         </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> comes with a greeter module, named
     8        <userinput>vbox-greeter</userinput>, that can be used with LightDM. LightDM is the default display manager for
     9      Ubuntu Linux and therefore can also be used for automated guest logins. </p>
    1410    <p><userinput>vbox-greeter</userinput> does not need the
    1511          <userinput>pam_vbox</userinput> module described in
    … …  
    1915          used together on the same guest.
    2016        </p>
    21     <p>
    22           As with the <userinput>pam_vbox</userinput> module,
    23           <userinput>vbox-greeter</userinput> is shipped as part of the
    24           Guest Additions but it is not installed or activated on the
    25           guest OS by default. To install
    26           <userinput>vbox-greeter</userinput> automatically upon Guest
    27           Additions installation, use the
    28           <codeph>--with-autologon</codeph> option when starting the
    29           <userinput>VBoxLinuxAdditions.run</userinput> file:
    30         </p>
     17    <p>As with the <userinput>pam_vbox</userinput> module, <userinput>vbox-greeter</userinput> is shipped as part of the
     18      Guest Additions but it is not installed or activated on the guest OS by default. To install
     19        <userinput>vbox-greeter</userinput> automatically upon Guest Additions installation, use the
     20        <codeph>--with-autologon</codeph> option when starting the <userinput>VBoxLinuxAdditions.run</userinput> file: </p>
    3121    <pre xml:space="preserve"># ./VBoxLinuxAdditions.run -- --with-autologon</pre>
    32     <p>
    33           For manual or postponed installation, copy the
    34           <filepath>vbox-greeter.desktop</filepath> file from
    35           <filepath>/opt/VBoxGuestAdditions-<varname>version</varname>/other/</filepath>
    36           to the <filepath>xgreeters</filepath> directory, which is
    37           usually <filepath>/usr/share/xgreeters/</filepath>. See your
    38           guest OS documentation for the name of the correct LightDM
    39           greeter directory.
    40         </p>
    41     <p>
    42           The <userinput>vbox-greeter</userinput> module is installed by the
    43           <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions installer and is located in
    44           <filepath>/usr/sbin/</filepath>. To enable
    45           <userinput>vbox-greeter</userinput> as the standard greeter
    46           module, edit the file
    47           <filepath>/etc/lightdm/lightdm.conf</filepath> as follows:
    48         </p>
     22    <p>For manual or postponed installation, copy the <filepath>vbox-greeter.desktop</filepath> file from
     23          <filepath>/opt/VBoxGuestAdditions-<varname>version</varname>/other/</filepath> to the
     24        <filepath>xgreeters</filepath> directory, which is usually <filepath>/usr/share/xgreeters/</filepath>. See your
     25      guest OS documentation for the name of the correct LightDM greeter directory. </p>
     26    <p>The <userinput>vbox-greeter</userinput> module is installed by the <ph
     27        conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions installer and is located in
     28        <filepath>/usr/sbin/</filepath>. To enable <userinput>vbox-greeter</userinput> as the standard greeter module,
     29      edit the file <filepath>/etc/lightdm/lightdm.conf</filepath> as follows: </p>
    4930    <pre xml:space="preserve">[SeatDefaults]
    5031greeter-session=vbox-greeter</pre>
    … …  
    5233      <ul>
    5334        <li>
    54           <p>
    55                 The LightDM server must be fully restarted in order for
    56                 <userinput>vbox-greeter</userinput> to be used as the
    57                 default greeter. As <codeph>root</codeph> on Ubuntu,
    58                 run <userinput>service lightdm --full-restart</userinput> or
    59                 restart the guest.
    60               </p>
     35          <p>The LightDM server must be fully restarted in order for <userinput>vbox-greeter</userinput> to be used as
     36            the default greeter. As <codeph>root</codeph> on Ubuntu, run <userinput>service lightdm
     37              --full-restart</userinput> or restart the guest. </p>
    6138        </li>
    6239        <li>
    … …  
    7047      </ul>
    7148    </note>
    72     <p>
    73           There are numerous guest properties which can be used to
    74           further customize the login experience. For automatically
    75           logging in users, the same guest properties apply as for
    76           <userinput>pam_vbox</userinput>. See
    77           <xref href="autologon_unix.dita#autologon_unix"/>.
    78         </p>
    79     <p>
    80           In addition to the previously mentioned guest properties,
    81           <userinput>vbox-greeter</userinput> enables you to further
    82           customize its user interface. The following guest properties
    83           are located in the
    84           <filepath>/VirtualBox/GuestAdd/Greeter/</filepath> directory:
    85         </p>
     49    <p>There are numerous guest properties which can be used to further customize the login experience. For
     50      automatically logging in users, the same guest properties apply as for <userinput>pam_vbox</userinput>. See <xref
     51        href="autologon_unix.dita#autologon_unix"/>. </p>
     52    <p>In addition to the previously mentioned guest properties, <userinput>vbox-greeter</userinput> enables you to
     53      further customize its user interface. The following guest properties are located in the
     54        <filepath>/VirtualBox/GuestAdd/Greeter/</filepath> directory: </p>
    8655    <ul>
    8756      <li>
    … …  
    142111    </ul>
    143112    <note>
    144       <p>
    145             The same restrictions for the guest properties above apply
    146             as for the ones specified in the <codeph>pam_vbox</codeph>
    147             section.
    148           </p>
     113      <p>The same restrictions for the guest properties above apply as for the ones specified in the
     114          <codeph>pam_vbox</codeph> section. </p>
    149115    </note>
    150116  </body>

  • trunk/doc/manual/en_US/dita/topics/autologon_win.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         Windows provides a modular system login subsystem, called
    9         Winlogon, which can be customized and extended by means of
    10         so-called GINA (Graphical Identification and Authentication)
    11         modules. In Windows Vista and later releases, the GINA modules
    12         were replaced with a new mechanism called credential providers.
    13         The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions for Windows come with both, a
    14         GINA and a credential provider module, and therefore enable any
    15         Windows guest to perform automated logins.
    16       </p>
    17     <p>
    18         To activate the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GINA or credential provider
    19         module, install the Guest Additions using the command line
    20         switch <codeph>/with_autologon</codeph>. All the following
    21         manual steps required for installing these modules will be then
    22         done by the installer.
    23       </p>
    24     <p>
    25         To manually install the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GINA module, extract the
    26         Guest Additions as shown in
    27         <xref href="windows-guest-file-extraction.dita">Manual File Extraction</xref>, and copy the
    28         <filepath>VBoxGINA.dll</filepath> file to the Windows
    29         <filepath>SYSTEM32</filepath> directory. In the registry, create
    30         the following key with a value of
    31         <filepath>VBoxGINA.dll</filepath>:
    32       </p>
     7    <p>Windows provides a modular system login subsystem, called Winlogon, which can be customized and extended by means
     8      of so-called GINA (Graphical Identification and Authentication) modules. In Windows Vista and later releases, the
     9      GINA modules were replaced with a new mechanism called credential providers. The <ph
     10        conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions for Windows come with both, a GINA and a
     11      credential provider module, and therefore enable any Windows guest to perform automated logins. </p>
     12    <p>To activate the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GINA or credential provider module, install
     13      the Guest Additions using the command line switch <codeph>/with_autologon</codeph>. All the following manual steps
     14      required for installing these modules will be then done by the installer. </p>
     15    <p>To manually install the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GINA module, extract the Guest
     16      Additions as shown in <xref href="windows-guest-file-extraction.dita">Manual File Extraction</xref>, and copy the
     17        <filepath>VBoxGINA.dll</filepath> file to the Windows <filepath>SYSTEM32</filepath> directory. In the registry,
     18      create the following key with a value of <filepath>VBoxGINA.dll</filepath>: </p>
    3319    <pre xml:space="preserve">HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon\GinaDLL</pre>
    3420    <note>
    35       <p>
    36           The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GINA module is implemented as a wrapper
    37           around the <filepath>MSGINA.DLL</filepath> standard Windows
    38           GINA module. As a result, it might not work correctly with
    39           third-party GINA modules.
    40         </p>
     21      <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GINA module is implemented as a wrapper around the
     22          <filepath>MSGINA.DLL</filepath> standard Windows GINA module. As a result, it might not work correctly with
     23        third-party GINA modules. </p>
    4124    </note>
    42     <p>
    43         To manually install the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> credential provider
    44         module, extract the Guest Additions as shown in
    45         <xref href="windows-guest-file-extraction.dita">Manual File Extraction</xref> and copy the
    46         <filepath>VBoxCredProv.dll</filepath> file to the Windows
    47         <filepath>SYSTEM32</filepath> directory. In the registry, create
    48         the following keys:
    49       </p>
     25    <p>To manually install the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> credential provider module, extract
     26      the Guest Additions as shown in <xref href="windows-guest-file-extraction.dita">Manual File Extraction</xref> and
     27      copy the <filepath>VBoxCredProv.dll</filepath> file to the Windows <filepath>SYSTEM32</filepath> directory. In the
     28      registry, create the following keys: </p>
    5029    <pre xml:space="preserve">HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\
    5130Authentication\Credential Providers\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B}
    … …  
    5433
    5534HKEY_CLASSES_ROOT\CLSID\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B}\InprocServer32</pre>
    56     <p>
    57         All default values, the key named <codeph>Default</codeph>,
    58         must be set to <codeph>VBoxCredProv</codeph>.
    59       </p>
    60     <p>
    61         Create the following string and assign it a value of
    62         <codeph>Apartment</codeph>.
    63       </p>
     35    <p>All default values, the key named <codeph>Default</codeph>, must be set to <codeph>VBoxCredProv</codeph>. </p>
     36    <p>Create the following string and assign it a value of <codeph>Apartment</codeph>. </p>
    6437    <pre xml:space="preserve">HKEY_CLASSES_ROOT\CLSID\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B}\InprocServer32\ThreadingModel</pre>
    6538    <p>
    … …  
    6841      </p>
    6942    <pre xml:space="preserve">$ VBoxManage controlvm "Windows XP" setcredentials "John Doe" "secretpassword" "DOMTEST"</pre>
    70     <p>
    71         While the VM is running, the credentials can be queried by the
    72         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> login modules, GINA or credential provider, using
    73         the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions device driver. When Windows
    74         is in <i>logged out</i> mode, the login modules
    75         will constantly poll for credentials and if they are present, a
    76         login will be attempted. After retrieving the credentials, the
    77         login modules will erase them so that the above command will
    78         have to be repeated for subsequent logins.
    79       </p>
    80     <p>
    81         For security reasons, credentials are not stored in any
    82         persistent manner and will be lost when the VM is reset. Also,
    83         the credentials are write-only. There is no way to retrieve the
    84         credentials from the host side. Credentials can be reset from
    85         the host side by setting empty values.
    86       </p>
    87     <p>
    88         Depending on the Windows guest version, the following
    89         restrictions apply:
    90       </p>
     43    <p>While the VM is running, the credentials can be queried by the <ph
     44        conkeyref="vbox-conkeyref-phrases/product-name"/> login modules, GINA or credential provider, using the <ph
     45        conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions device driver. When Windows is in <i>logged
     46        out</i> mode, the login modules will constantly poll for credentials and if they are present, a login will be
     47      attempted. After retrieving the credentials, the login modules will erase them so that the above command will have
     48      to be repeated for subsequent logins. </p>
     49    <p>For security reasons, credentials are not stored in any persistent manner and will be lost when the VM is reset.
     50      Also, the credentials are write-only. There is no way to retrieve the credentials from the host side. Credentials
     51      can be reset from the host side by setting empty values. </p>
     52    <p>Depending on the Windows guest version, the following restrictions apply: </p>
    9153    <ul>
    9254      <li>
    93         <p>
    94             For <b outputclass="bold">Windows XP guests.</b> The
    95             login subsystem needs to be configured to use the classic
    96             login dialog, as the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GINA module does not
    97             support the Windows XP-style welcome dialog.
    98           </p>
     55        <p>For <b outputclass="bold">Windows XP guests.</b> The login subsystem needs to be configured to use the
     56          classic login dialog, as the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GINA module does not
     57          support the Windows XP-style welcome dialog. </p>
    9958      </li>
    10059      <li>
    … …  
    11271      </li>
    11372      <li>
    114         <p>
    115             Automatic login handling of the built-in
    116             <b outputclass="bold">Windows Remote Desktop
    117             Service</b>, formerly known as Terminal Services, is
    118             disabled by default. To enable it, create the following
    119             registry key with a <codeph>DWORD</codeph> value of
    120             <codeph>1</codeph>.
    121           </p>
     73        <p>Automatic login handling of the built-in <b outputclass="bold">Windows Remote Desktop Service</b>, formerly
     74          known as Terminal Services, is disabled by default. To enable it, create the following registry key with a
     75            <codeph>DWORD</codeph> value of <codeph>1</codeph>. </p>
    12276        <pre xml:space="preserve">HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\VirtualBox Guest Additions\AutoLogon</pre>
    12377      </li>
    12478    </ul>
    125     <p>
    126         The following command forces <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to keep the
    127         credentials after they were read by the guest and on VM reset:
    128       </p>
     79    <p>The following command forces <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to keep the credentials after
     80      they were read by the guest and on VM reset: </p>
    12981    <pre xml:space="preserve">$ VBoxManage setextradata "Windows XP" VBoxInternal/Devices/VMMDev/0/Config/KeepCredentials 1</pre>
    130     <p>
    131         Note that this is a potential security risk, as a malicious
    132         application running on the guest could request this information
    133         using the proper interface.
    134       </p>
     82    <p>Note that this is a potential security risk, as a malicious application running on the guest could request this
     83      information using the proper interface. </p>
    13584  </body>
    13685 

  • trunk/doc/manual/en_US/dita/topics/autostart-linux.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         On Linux, the autostart service is activated by setting two
    9         variables in <filepath>/etc/default/virtualbox</filepath>. The
    10         first one is <codeph>VBOXAUTOSTART_DB</codeph> which contains
    11         an absolute path to the autostart database directory. The
    12         directory should have write access for every user who should be
    13         able to start virtual machines automatically. Furthermore the
    14         directory should have the sticky bit set. The second variable is
    15         <codeph>VBOXAUTOSTART_CONFIG</codeph> which points the service
    16         to the autostart configuration file which is used during boot to
    17         determine whether to allow individual users to start a VM
    18         automatically and configure startup delays. The configuration
    19         file can be placed in <filepath>/etc/vbox</filepath> and
    20         contains several options. One is
    21         <codeph>default_policy</codeph> which controls whether the
    22         autostart service allows or denies to start a VM for users which
    23         are not in the exception list. The exception list starts with
    24         <codeph>exception_list</codeph> and contains a comma separated
    25         list with usernames. Furthermore a separate startup delay can be
    26         configured for every user to avoid overloading the host. A
    27         sample configuration is given below:
    28       </p>
     7    <p>On Linux, the autostart service is activated by setting two variables in
     8                <filepath>/etc/default/virtualbox</filepath>. The first one is <codeph>VBOXAUTOSTART_DB</codeph> which
     9            contains an absolute path to the autostart database directory. The directory should have write access for
     10            every user who should be able to start virtual machines automatically. Furthermore the directory should have
     11            the sticky bit set. The second variable is <codeph>VBOXAUTOSTART_CONFIG</codeph> which points the service to
     12            the autostart configuration file which is used during boot to determine whether to allow individual users to
     13            start a VM automatically and configure startup delays. The configuration file can be placed in
     14                <filepath>/etc/vbox</filepath> and contains several options. One is <codeph>default_policy</codeph>
     15            which controls whether the autostart service allows or denies to start a VM for users which are not in the
     16            exception list. The exception list starts with <codeph>exception_list</codeph> and contains a comma
     17            separated list with usernames. Furthermore a separate startup delay can be configured for every user to
     18            avoid overloading the host. A sample configuration is given below: </p>
    2919    <pre xml:space="preserve"># Default policy is to deny starting a VM, the other option is "allow".
    3020default_policy = deny
    … …  
    4333}
    4434</pre>
    45     <p>
    46         Any user who wants to enable autostart for individual machines
    47         must set the path to the autostart database directory with the
    48         following command:
    49       </p>
     35    <p>Any user who wants to enable autostart for individual machines must set the path to the autostart database
     36            directory with the following command: </p>
    5037    <pre xml:space="preserve">VBoxManage setproperty autostartdbpath <varname>autostart-directory</varname>
    5138                  </pre>

  • trunk/doc/manual/en_US/dita/topics/autostart-osx.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         On macOS, launchd is used to start the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> autostart
    9         service. An example configuration file can be found in
    10         <filepath>/Applications/VirtualBox.app/Contents/MacOS/org.virtualbox.vboxautostart.plist</filepath>.
    11         To enable the service copy the file to
    12         <filepath>/Library/LaunchDaemons</filepath> and change the
    13         <codeph>Disabled</codeph> key from <codeph>true</codeph> to
    14         <codeph>false</codeph>. Furthermore replace the second
    15         parameter to an existing configuration file which has the same
    16         format as on Linux, see <xref href="autostart-linux.dita#autostart-linux"/>.
    17       </p>
    18     <p>
    19         To manually start the service use the following command:
    20       </p>
     7    <p>On macOS, launchd is used to start the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> autostart service.
     8      An example configuration file can be found in
     9        <filepath>/Applications/VirtualBox.app/Contents/MacOS/org.virtualbox.vboxautostart.plist</filepath>. To enable
     10      the service copy the file to <filepath>/Library/LaunchDaemons</filepath> and change the <codeph>Disabled</codeph>
     11      key from <codeph>true</codeph> to <codeph>false</codeph>. Furthermore replace the second parameter to an existing
     12      configuration file which has the same format as on Linux, see <xref href="autostart-linux.dita#autostart-linux"/>. </p>
     13    <p>To manually start the service use the following command: </p>
    2114    <pre xml:space="preserve"># launchctl load /Library/LaunchDaemons/org.virtualbox.vboxautostart.plist</pre>
    22     <p>
    23         For additional information on how launchd services can be
    24         configured see:
    25       </p>
     15    <p>For additional information on how launchd services can be configured see: </p>
    2616    <p><ph>http://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html</ph>.
    2717      </p>

  • trunk/doc/manual/en_US/dita/topics/autostart-solaris.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         On Oracle Solaris hosts, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> autostart daemon is
    9         integrated into the SMF framework. To enable it you must point
    10         the service to an existing configuration file which has the same
    11         format as on Linux, see <xref href="autostart-linux.dita#autostart-linux"/>. For
    12         example:
    13       </p>
     7    <p>On Oracle Solaris hosts, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> autostart daemon is integrated
     8      into the SMF framework. To enable it you must point the service to an existing configuration file which has the
     9      same format as on Linux, see <xref href="autostart-linux.dita#autostart-linux"/>. For example: </p>
    1410    <pre xml:space="preserve"># svccfg -s svc:/application/virtualbox/autostart:default setprop \
    1511  config/config=/etc/vbox/autostart.cfg</pre>
    16     <p>
    17         When everything is configured correctly you can start the
    18         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> autostart service with the following command:
    19       </p>
     12    <p>When everything is configured correctly you can start the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     13      autostart service with the following command: </p>
    2014    <pre xml:space="preserve"># svcadm enable svc:/application/virtualbox/autostart:default</pre>
    21     <p>
    22         For more information about SMF, see the Oracle Solaris
    23         documentation.
    24       </p>
     15    <p>For more information about SMF, see the Oracle Solaris documentation. </p>
    2516  </body>
    2617 

  • trunk/doc/manual/en_US/dita/topics/autostart-windows.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8         On Windows, autostart functionality consist of two components.
    9         The first component is a configuration file where the
    10         administrator can both set a delayed start for the VMs and
    11         temporarily disable autostarting for a particular user. The
    12         configuration file should be located in a folder accessible by
    13         all required users but it should have permissions allowing only
    14         reading by everyone but administrators. The configuration file
    15         contains several options. The <codeph>default_policy</codeph>
    16         controls whether the autostart service allows or denies starting
    17         of a VM for users that are not in the exception list. The
    18         exception list starts with <codeph>exception_list</codeph> and
    19         contains a comma separated list with usernames. Furthermore, a
    20         separate startup delay can be configured for every user to avoid
    21         overloading the host. A sample configuration is given below:
    22       </p>
     7    <p>On Windows, autostart functionality consist of two components. The first component is a configuration file where
     8      the administrator can both set a delayed start for the VMs and temporarily disable autostarting for a particular
     9      user. The configuration file should be located in a folder accessible by all required users but it should have
     10      permissions allowing only reading by everyone but administrators. The configuration file contains several options.
     11      The <codeph>default_policy</codeph> controls whether the autostart service allows or denies starting of a VM for
     12      users that are not in the exception list. The exception list starts with <codeph>exception_list</codeph> and
     13      contains a comma separated list with usernames. Furthermore, a separate startup delay can be configured for every
     14      user to avoid overloading the host. A sample configuration is given below: </p>
    2315    <pre xml:space="preserve">    # Default policy is to deny starting a VM, the other option is "allow".
    2416    default_policy = deny
    … …  
    3729    }
    3830</pre>
    39     <p>
    40         The user name can be specified using the following forms:
    41         "user", "domain\user", ".\user" and "user@domain". An
    42         administrator must add the
    43         <codeph>VBOXAUTOSTART_CONFIG</codeph> environment variable
    44         into system variables containing the path to the configuration
    45         file described above. The environment variable tells the
    46         autostart services which configuration file is used.
    47       </p>
    48     <p>
    49         The second component of autostart functionality is a Windows
    50         service. Every instance of this works on behalf of a particular
    51         user using their credentials.
    52       </p>
    53     <p>
    54         To enable autostarting for a particular user, a member of the
    55         administrators group must run the following command:
    56       </p>
     31    <p>The user name can be specified using the following forms: "user", "domain\user", ".\user" and "user@domain". An
     32      administrator must add the <codeph>VBOXAUTOSTART_CONFIG</codeph> environment variable into system variables
     33      containing the path to the configuration file described above. The environment variable tells the autostart
     34      services which configuration file is used. </p>
     35    <p>The second component of autostart functionality is a Windows service. Every instance of this works on behalf of a
     36      particular user using their credentials. </p>
     37    <p>To enable autostarting for a particular user, a member of the administrators group must run the following
     38      command: </p>
    5739    <pre xml:space="preserve">VBoxAutostartSvc install --user=<varname>user</varname> [--password-file=<varname>password_file</varname>]</pre>
    58     <p>
    59         The password file should contain the password followed by a line
    60         break. The rest of the file is ignored. The user will be asked
    61         for a password if the password file is not specified.
    62       </p>
    63     <p>
    64         To disable autostarting for particular user, a member of the
    65         administrators group must run the following command:
    66       </p>
     40    <p>The password file should contain the password followed by a line break. The rest of the file is ignored. The user
     41      will be asked for a password if the password file is not specified. </p>
     42    <p>To disable autostarting for particular user, a member of the administrators group must run the following command: </p>
    6743    <pre xml:space="preserve">VBoxAutostartSvc delete --user=<varname>user</varname>
    6844                  </pre>
    69     <p>
    70         If a user has changed their password then a member of the
    71         administrators group must either reinstall the service or change
    72         the service credentials using Windows Service Manager. Due to
    73         Windows security policies, the autostart service cannot be
    74         installed for users with empty passwords.
    75       </p>
    76     <p> Finally, the user should define which VMs should be started at boot. The user should run the
    77       following command for every VM they want to start at boot: </p>
     45    <p>If a user has changed their password then a member of the administrators group must either reinstall the service
     46      or change the service credentials using Windows Service Manager. Due to Windows security policies, the autostart
     47      service cannot be installed for users with empty passwords. </p>
     48    <p>Finally, the user should define which VMs should be started at boot. The user should run the following command
     49      for every VM they want to start at boot: </p>
    7850    <pre xml:space="preserve">VBoxManage modifyvm <varname>VM name or UUID</varname> --autostart-enabled on</pre>
    79     <p>
    80         The user can remove a particular VM from the VMs starting at
    81         boot by running the following command:
    82       </p>
     51    <p>The user can remove a particular VM from the VMs starting at boot by running the following command: </p>
    8352    <pre xml:space="preserve">VBoxManage modifyvm <varname>VM name or UUID</varname> --autostart-enabled off</pre>
    8453    <note>
    85       <p> On Windows hosts, starting VMs by using the autostart service might cause some issues, as
    86         the virtual machines are starting within the same session as VBoxSVC. For more information
    87         see <xref href="vboxsvc-session-0.dita#vboxsvc-session-0"/>. </p>
     54      <p>On Windows hosts, starting VMs by using the autostart service might cause some issues, as the virtual machines
     55        are starting within the same session as VBoxSVC. For more information see <xref
     56          href="vboxsvc-session-0.dita#vboxsvc-session-0"/>. </p>
    8857    </note>
    8958  </body>

  • trunk/doc/manual/en_US/dita/topics/autostart.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8       You can start VMs automatically during system boot on Linux,
    9       Oracle Solaris, and macOS platforms for all users.
    10     </p>
     7    <p>You can start VMs automatically during system boot on Linux, Oracle Solaris, and macOS platforms for all users. </p>
    118  </body>
    129</topic>

  • trunk/doc/manual/en_US/dita/topics/changeacpicust.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       You can configure <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to present up to four custom ACPI
    9       tables to the guest. Use a command such as the following to
    10       configure custom ACPI tables. Note that
    11       <codeph>CustomTable1</codeph>, <codeph>CustomTable2</codeph>,
    12       and <codeph>CustomTable3</codeph> are available in addition to
    13       <codeph>CustomTable0</codeph>.
    14     </p>
     7    <p>You can configure <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to present up to four custom ACPI tables
     8      to the guest. Use a command such as the following to configure custom ACPI tables. Note that
     9        <codeph>CustomTable1</codeph>, <codeph>CustomTable2</codeph>, and <codeph>CustomTable3</codeph> are available in
     10      addition to <codeph>CustomTable0</codeph>. </p>
    1511    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    1612"VBoxInternal/Devices/acpi/0/Config/CustomTable0" "/<varname>path-to-table</varname>.bin"</pre>
    17     <p>
    18       Configuring custom ACPI tables can for example avoid the need for
    19       asking for a new product key on Windows Vista, Windows 7, Windows
    20       8 and later guests. On Linux hosts, one of the system's ACPI
    21       tables can be read from
    22       <filepath>/sys/firmware/acpi/tables/</filepath>.
    23     </p>
     13    <p>Configuring custom ACPI tables can for example avoid the need for asking for a new product key on Windows Vista,
     14      Windows 7, Windows 8 and later guests. On Linux hosts, one of the system's ACPI tables can be read from
     15        <filepath>/sys/firmware/acpi/tables/</filepath>. </p>
    2416  </body>
    2517 

  • trunk/doc/manual/en_US/dita/topics/changedmi.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       The DMI data that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides to guests can be changed
    9       for a specific VM. Use the following commands to configure the DMI
    10       BIOS information. In case your VM is configured to use EFI
    11       firmware you need to replace <codeph>pcbios</codeph> by
    12       <codeph>efi</codeph> in the keys.
    13     </p>
     7    <p>The DMI data that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides to guests can be changed for a
     8      specific VM. Use the following commands to configure the DMI BIOS information. In case your VM is configured to
     9      use EFI firmware you need to replace <codeph>pcbios</codeph> by <codeph>efi</codeph> in the keys. </p>
    1410    <ul>
    1511      <li>
    16         <p>
    17           DMI BIOS information (type 0)
    18         </p>
     12        <p>DMI BIOS information (type 0) </p>
    1913        <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    2014"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVendor"        "BIOS Vendor"
    … …  
    3327      </li>
    3428      <li>
    35         <p>
    36           DMI system information (type 1)
    37         </p>
     29        <p>DMI system information (type 1) </p>
    3830        <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    3931"VBoxInternal/Devices/pcbios/0/Config/DmiSystemVendor"      "System Vendor"
    … …  
    5345      </li>
    5446      <li>
    55         <p>
    56           DMI board information (type 2)
    57         </p>
     47        <p>DMI board information (type 2) </p>
    5848        <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    5949"VBoxInternal/Devices/pcbios/0/Config/DmiBoardVendor"       "Board Vendor"
    … …  
    7262      </li>
    7363      <li>
    74         <p>
    75           DMI system enclosure or chassis (type 3)
    76         </p>
     64        <p>DMI system enclosure or chassis (type 3) </p>
    7765        <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    7866"VBoxInternal/Devices/pcbios/0/Config/DmiChassisVendor"     "Chassis Vendor"
    … …  
    8775      </li>
    8876      <li>
    89         <p>
    90           DMI processor information (type 4)
    91         </p>
     77        <p>DMI processor information (type 4) </p>
    9278        <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    9379"VBoxInternal/Devices/pcbios/0/Config/DmiProcManufacturer"  "GenuineIntel"
    … …  
    9682      </li>
    9783      <li>
    98         <p>
    99           DMI OEM strings (type 11)
    100         </p>
     84        <p>DMI OEM strings (type 11) </p>
    10185        <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    10286"VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxVer"        "vboxVer_1.2.3"
    … …  
    10589      </li>
    10690    </ul>
    107     <p>
    108       If a DMI string is not set, the default value of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is
    109       used. To set an empty string use
    110       <codeph>"&lt;EMPTY&gt;"</codeph>.
    111     </p>
    112     <p>
    113       Note that in the above list, all quoted parameters (DmiBIOSVendor,
    114       DmiBIOSVersion but not DmiBIOSReleaseMajor) are expected to be
    115       strings. If such a string is a valid number, the parameter is
    116       treated as number and the VM will most probably refuse to start
    117       with an <codeph>VERR_CFGM_NOT_STRING</codeph> error. In that
    118       case, use
    119       <codeph>"string:<varname>value</varname>"</codeph>. For
    120       example:
    121     </p>
     91    <p>If a DMI string is not set, the default value of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is used.
     92      To set an empty string use <codeph>"&lt;EMPTY&gt;"</codeph>. </p>
     93    <p>Note that in the above list, all quoted parameters (DmiBIOSVendor, DmiBIOSVersion but not DmiBIOSReleaseMajor)
     94      are expected to be strings. If such a string is a valid number, the parameter is treated as number and the VM will
     95      most probably refuse to start with an <codeph>VERR_CFGM_NOT_STRING</codeph> error. In that case, use
     96          <codeph>"string:<varname>value</varname>"</codeph>. For example: </p>
    12297    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    12398"VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial"      "string:1234"</pre>
    124     <p>
    125       Changing this information can be necessary to provide the DMI
    126       information of the host to the guest to prevent Windows from
    127       asking for a new product key. On Linux hosts, the DMI BIOS
    128       information can be obtained with the following command:
    129     </p>
     99    <p>Changing this information can be necessary to provide the DMI information of the host to the guest to prevent
     100      Windows from asking for a new product key. On Linux hosts, the DMI BIOS information can be obtained with the
     101      following command: </p>
    130102    <pre xml:space="preserve">$ dmidecode -t0</pre>
    131     <p>
    132       The DMI system information can be obtained as follows:
    133     </p>
     103    <p>The DMI system information can be obtained as follows: </p>
    134104    <pre xml:space="preserve">$ dmidecode -t1</pre>
    135105  </body>

  • trunk/doc/manual/en_US/dita/topics/changetimesync.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions ensure that the guest's
    9         system time is synchronized with the host time. There are
    10         several parameters which can be tuned. The parameters can be set
    11         for a specific VM using the following command:
    12       </p>
     7    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions ensure that the guest's system time is
     8      synchronized with the host time. There are several parameters which can be tuned. The parameters can be set for a
     9      specific VM using the following command: </p>
    1310    <pre xml:space="preserve">$ VBoxManage guestproperty set <varname>VM-name</varname> "/VirtualBox/GuestAdd/VBoxService/<varname>property</varname>" <varname>value</varname>
    1411                  </pre>
    … …  
    2017          </dt>
    2118        <dd>
    22           <p>
    23               Specifies the interval at which to synchronize the time
    24               with the host. The default is 10000 ms (10 seconds).
    25             </p>
     19          <p>Specifies the interval at which to synchronize the time with the host. The default is 10000 ms (10
     20            seconds). </p>
    2621        </dd>
    2722      </dlentry>
    … …  
    3025          </dt>
    3126        <dd>
    32           <p>
    33               The minimum absolute drift value measured in milliseconds
    34               to make adjustments for. The default is 1000 ms on OS/2
    35               and 100 ms elsewhere.
    36             </p>
     27          <p>The minimum absolute drift value measured in milliseconds to make adjustments for. The default is 1000 ms
     28            on OS/2 and 100 ms elsewhere. </p>
    3729        </dd>
    3830      </dlentry>
    … …  
    4133          </dt>
    4234        <dd>
    43           <p>
    44               The factor to multiply the time query latency with to
    45               calculate the dynamic minimum adjust time. The default is
    46               8 times, which means as follows:
    47             </p>
    48           <p>
    49               Measure the time it takes to determine the host time, the
    50               guest has to contact the VM host service which may take
    51               some time. Multiply this value by 8 and do an adjustment
    52               only if the time difference between host and guest is
    53               bigger than this value. Do not do any time adjustment
    54               otherwise.
    55             </p>
     35          <p>The factor to multiply the time query latency with to calculate the dynamic minimum adjust time. The
     36            default is 8 times, which means as follows: </p>
     37          <p>Measure the time it takes to determine the host time, the guest has to contact the VM host service which
     38            may take some time. Multiply this value by 8 and do an adjustment only if the time difference between host
     39            and guest is bigger than this value. Do not do any time adjustment otherwise. </p>
    5640        </dd>
    5741      </dlentry>
    … …  
    6044          </dt>
    6145        <dd>
    62           <p>
    63               The max host timer query latency to accept. The default is
    64               250 ms.
    65             </p>
     46          <p>The max host timer query latency to accept. The default is 250 ms. </p>
    6647        </dd>
    6748      </dlentry>
    … …  
    7051          </dt>
    7152        <dd>
    72           <p>
    73               The absolute drift threshold, given as milliseconds where
    74               to start setting the time instead of trying to smoothly
    75               adjust it. The default is 20 minutes.
    76             </p>
     53          <p>The absolute drift threshold, given as milliseconds where to start setting the time instead of trying to
     54            smoothly adjust it. The default is 20 minutes. </p>
    7755        </dd>
    7856      </dlentry>
    … …  
    8159          </dt>
    8260        <dd>
    83           <p>
    84               Set the time when starting the time sync service.
    85             </p>
     61          <p>Set the time when starting the time sync service. </p>
    8662        </dd>
    8763      </dlentry>
    … …  
    9066          </dt>
    9167        <dd>
    92           <p>
    93               Set the time after the VM was restored from a saved state
    94               when passing 1 as parameter. This is the default. Disable
    95               by passing 0. In the latter case, the time will be
    96               adjusted smoothly, which can take a long time.
    97             </p>
     68          <p>Set the time after the VM was restored from a saved state when passing 1 as parameter. This is the default.
     69            Disable by passing 0. In the latter case, the time will be adjusted smoothly, which can take a long time. </p>
    9870        </dd>
    9971      </dlentry>
    10072    </dl>
    101     <p>
    102         All these parameters can be specified as command line parameters
    103         to <codeph>VBoxService</codeph> as well.
    104       </p>
     73    <p>All these parameters can be specified as command line parameters to <codeph>VBoxService</codeph> as well. </p>
    10574  </body>
    10675 

  • trunk/doc/manual/en_US/dita/topics/changetscmode.dita

    r99797 r105335  
    66 
    77  <body>
    8     <p>
    9         By default, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> keeps all sources of time visible to
    10         the guest synchronized to a single time source, the monotonic
    11         host time. This reflects the assumptions of many guest operating
    12         systems, which expect all time sources to reflect "wall clock"
    13         time. In special circumstances it may be useful however to make
    14         the time stamp counter (TSC) in the guest reflect the time
    15         actually spent executing the guest.
    16       </p>
    17     <p>
    18         This special TSC handling mode can be enabled on a per-VM basis,
    19         and for best results must be used only in combination with
    20         hardware virtualization. To enable this mode use the following
    21         command:
    22       </p>
     8    <p>By default, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> keeps all sources of time visible to the guest
     9      synchronized to a single time source, the monotonic host time. This reflects the assumptions of many guest
     10      operating systems, which expect all time sources to reflect "wall clock" time. In special circumstances it may be
     11      useful however to make the time stamp counter (TSC) in the guest reflect the time actually spent executing the
     12      guest. </p>
     13    <p>This special TSC handling mode can be enabled on a per-VM basis, and for best results must be used only in
     14      combination with hardware virtualization. To enable this mode use the following command: </p>
    2315    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> "VBoxInternal/TM/TSCTiedToExecution" 1</pre>
    24     <p>
    25         To revert to the default TSC handling mode use:
    26       </p>
     16    <p>To revert to the default TSC handling mode use: </p>
    2717    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> "VBoxInternal/TM/TSCTiedToExecution"</pre>
    28     <p>
    29         Note that if you use the special TSC handling mode with a guest
    30         operating system which is very strict about the consistency of
    31         time sources you may get a warning or error message about the
    32         timing inconsistency. It may also cause clocks to become
    33         unreliable with some guest operating systems depending on how
    34         they use the TSC.
    35       </p>
     18    <p>Note that if you use the special TSC handling mode with a guest operating system which is very strict about the
     19      consistency of time sources you may get a warning or error message about the timing inconsistency. It may also
     20      cause clocks to become unreliable with some guest operating systems depending on how they use the TSC. </p>
    3621  </body>
    3722 

  • trunk/doc/manual/en_US/dita/topics/changevpd.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> reports vendor product data for its virtual hard
    9         disks which consist of hard disk serial number, firmware
    10         revision and model number. These can be changed using the
    11         following commands:
    12       </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> reports vendor product data for its virtual hard disks
     8            which consist of hard disk serial number, firmware revision and model number. These can be changed using the
     9            following commands: </p>
    1310    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    1411"VBoxInternal/Devices/ahci/0/Config/Port0/SerialNumber" "serial"
    … …  
    1714$ VBoxManage setextradata <varname>VM-name</varname> \
    1815"VBoxInternal/Devices/ahci/0/Config/Port0/ModelNumber" "model"</pre>
    19     <p> The serial number is a 20 byte alphanumeric string, the firmware revision an 8 byte
    20             alphanumeric string and the model number a 40 byte alphanumeric string. Instead of
    21             Port0, referring to the first port, specify the required SATA hard disk port. </p>
    22     <p>
    23         The above commands apply to virtual machines with an AHCI (SATA)
    24         controller. The commands for virtual machines with an IDE
    25         controller are:
    26       </p>
     16    <p>The serial number is a 20 byte alphanumeric string, the firmware revision an 8 byte alphanumeric string and the
     17            model number a 40 byte alphanumeric string. Instead of Port0, referring to the first port, specify the
     18            required SATA hard disk port. </p>
     19    <p>The above commands apply to virtual machines with an AHCI (SATA) controller. The commands for virtual machines
     20            with an IDE controller are: </p>
    2721    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    2822"VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/SerialNumber" "serial"
    … …  
    3125$ VBoxManage setextradata <varname>VM-name</varname> \
    3226"VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/ModelNumber" "model"</pre>
    33     <p> For hard disks, you can mark the drive as having a nonrotational medium by using the
    34             following command: </p>
     27    <p>For hard disks, you can mark the drive as having a nonrotational medium by using the following command: </p>
    3528    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    3629"VBoxInternal/Devices/ahci/0/Config/Port0/NonRotational" "1"</pre>
    37     <p>
    38         Additional three parameters are needed for CD/DVD drives to
    39         report the vendor product data:
    40       </p>
     30    <p>Additional three parameters are needed for CD/DVD drives to report the vendor product data: </p>
    4131    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    4232"VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIVendorId" "vendor"
    … …  
    4535VBoxManage setextradata <varname>VM-name</varname> \
    4636"VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIRevision" "revision"</pre>
    47     <p> The vendor id is an 8 byte alphanumeric string, the product id an 16 byte alphanumeric
    48             string and the revision a 4 byte alphanumeric string. Instead of Port0, referring to the
    49             first port, specify the required SATA hard disk port. </p>
     37    <p>The vendor id is an 8 byte alphanumeric string, the product id an 16 byte alphanumeric string and the revision a
     38            4 byte alphanumeric string. Instead of Port0, referring to the first port, specify the required SATA hard
     39            disk port. </p>
    5040  </body>
    5141 

  • trunk/doc/manual/en_US/dita/topics/cloningvdis.dita

    r105300 r105335  
    55 
    66  <body>
    7     <p> You can duplicate hard disk image files on the same host to quickly produce a second virtual
    8       machine with the same OS setup. However, you should <i>only</i> make copies of virtual disk
    9       images using the utility supplied with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. See <xref
    10         href="vboxmanage-clonemedium.dita"/>. This is because <ph conkeyref="vbox-conkeyref-phrases/product-name"/> assigns a UUID to
    11       each disk image, which is also stored inside the image, and <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will refuse
    12       to work with two images that use the same number. If you do accidentally try to reimport a
    13       disk image which you copied normally, you can make a second copy using the
    14         <userinput>VBoxManage clonevm</userinput> command and import that instead. </p>
    15     <p>
    16       Note that Linux distributions identify the boot hard disk from the
    17       ID of the drive. The ID <ph conkeyref="vbox-conkeyref-phrases/product-name"/> reports for a drive is
    18       determined from the UUID of the virtual disk image. So if you
    19       clone a disk image and try to boot the copied image the guest
    20       might not be able to determine its own boot disk as the UUID
    21       changed. In this case you have to adapt the disk ID in your boot
    22       loader script, for example
    23       <filepath>/boot/grub/menu.lst</filepath>. The disk ID looks like
    24       the following:
    25     </p>
     7    <p>You can duplicate hard disk image files on the same host to quickly produce a second virtual machine with the
     8      same OS setup. However, you should <i>only</i> make copies of virtual disk images using the utility supplied with
     9        <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. See <xref href="vboxmanage-clonemedium.dita"/>. This is
     10      because <ph conkeyref="vbox-conkeyref-phrases/product-name"/> assigns a UUID to each disk image, which is also
     11      stored inside the image, and <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will refuse to work with two
     12      images that use the same number. If you do accidentally try to reimport a disk image which you copied normally,
     13      you can make a second copy using the <userinput>VBoxManage clonevm</userinput> command and import that instead. </p>
     14    <p>Note that Linux distributions identify the boot hard disk from the ID of the drive. The ID <ph
     15        conkeyref="vbox-conkeyref-phrases/product-name"/> reports for a drive is determined from the UUID of the virtual
     16      disk image. So if you clone a disk image and try to boot the copied image the guest might not be able to determine
     17      its own boot disk as the UUID changed. In this case you have to adapt the disk ID in your boot loader script, for
     18      example <filepath>/boot/grub/menu.lst</filepath>. The disk ID looks like the following: </p>
    2619    <pre xml:space="preserve">scsi-SATA_VBOX_HARDDISK_VB5cfdb1e2-c251e503</pre>
    27     <p>
    28       The ID for the copied image can be determined as follows:
    29     </p>
     20    <p>The ID for the copied image can be determined as follows: </p>
    3021    <pre xml:space="preserve">hdparm -i /dev/sda</pre>
    3122  </body>

  • trunk/doc/manual/en_US/dita/topics/config-vm-selector-menu.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         You can disable certain entries in the global settings page of
    9         the VM selector:
    10       </p>
     7    <p>You can disable certain entries in the global settings page of the VM selector: </p>
    118    <pre xml:space="preserve">$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages <varname>property</varname>[,<varname>property</varname>...]</pre>
    129    <p><varname>property</varname> is one of the following:
    … …  
    10299      </dlentry>
    103100    </dl>
    104     <p>
    105         This is a global setting. You can specify any combination of
    106         properties. To restore the default behavior, use the following
    107         command:
    108       </p>
     101    <p>This is a global setting. You can specify any combination of properties. To restore the default behavior, use the
     102      following command: </p>
    109103    <pre xml:space="preserve">$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages</pre>
    110104  </body>

  • trunk/doc/manual/en_US/dita/topics/config-vm-window-menu.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         You can disable certain menu actions in the VM window:
    9       </p>
     7    <p>You can disable certain menu actions in the VM window: </p>
    108    <pre xml:space="preserve">VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeMenus OPTION[,OPTION...]</pre>
    119    <p>
    … …  
    1917        </dt>
    2018        <dd>
    21           <p>
    22               Do not show any menu in the VM window.
    23             </p>
     19          <p>Do not show any menu in the VM window. </p>
    2420        </dd>
    2521      </dlentry>
    … …  
    2925        </dt>
    3026        <dd>
    31           <p>
    32               Do not show
    33               <b outputclass="bold">Application/File</b> menu in
    34               the VM window.
    35             </p>
     27          <p>Do not show <b outputclass="bold">Application/File</b> menu in the VM window. </p>
    3628        </dd>
    3729      </dlentry>
    … …  
    4133        </dt>
    4234        <dd>
    43           <p>
    44               Do not show the <b outputclass="bold">Machine</b>
    45               menu in the VM window.
    46             </p>
     35          <p>Do not show the <b outputclass="bold">Machine</b> menu in the VM window. </p>
    4736        </dd>
    4837      </dlentry>
    … …  
    5241        </dt>
    5342        <dd>
    54           <p>
    55               Do not show the <b outputclass="bold">View</b> menu
    56               in the VM window.
    57             </p>
     43          <p>Do not show the <b outputclass="bold">View</b> menu in the VM window. </p>
    5844        </dd>
    5945      </dlentry>
    … …  
    6349        </dt>
    6450        <dd>
    65           <p>
    66               Do not show <b outputclass="bold">Input</b> menu in
    67               the VM window.
    68             </p>
     51          <p>Do not show <b outputclass="bold">Input</b> menu in the VM window. </p>
    6952        </dd>
    7053      </dlentry>
    … …  
    7457        </dt>
    7558        <dd>
    76           <p>
    77               Do not show the <b outputclass="bold">Devices</b>
    78               menu in the VM window.
    79             </p>
     59          <p>Do not show the <b outputclass="bold">Devices</b> menu in the VM window. </p>
    8060        </dd>
    8161      </dlentry>
    … …  
    8565        </dt>
    8666        <dd>
    87           <p>
    88               Do not show the <b outputclass="bold">Help</b> menu
    89               in the VM window.
    90             </p>
     67          <p>Do not show the <b outputclass="bold">Help</b> menu in the VM window. </p>
    9168        </dd>
    9269      </dlentry>
    … …  
    9673        </dt>
    9774        <dd>
    98           <p>
    99               Do not show the <b outputclass="bold">Debug</b>
    100               menu in the VM window. The Debug menu is only visible if
    101               the GUI was started with special command line parameters
    102               or environment variable settings.
    103             </p>
     75          <p>Do not show the <b outputclass="bold">Debug</b> menu in the VM window. The Debug menu is only visible if
     76            the GUI was started with special command line parameters or environment variable settings. </p>
    10477        </dd>
    10578      </dlentry>
    10679    </dl>
    107     <p>
    108         This is a per-VM or global setting. Any combination of the above
    109         is allowed. To restore the default behavior, use the following
    110         command:
    111       </p>
     80    <p>This is a per-VM or global setting. Any combination of the above is allowed. To restore the default behavior, use
     81      the following command: </p>
    11282    <pre xml:space="preserve">VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeMenus</pre>
    113     <p>
    114         You can also disable certain menu actions of certain menus. Use
    115         the following command to disable certain actions of the
    116         <b outputclass="bold">Application</b> menu. This is only
    117         available on macOS hosts.
    118       </p>
     83    <p>You can also disable certain menu actions of certain menus. Use the following command to disable certain actions
     84      of the <b outputclass="bold">Application</b> menu. This is only available on macOS hosts. </p>
    11985    <pre xml:space="preserve">VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeApplicationMenuActions OPTION[,OPTION...]</pre>
    120     <p>
    121         where <codeph>OPTION</codeph> is one of the following
    122         keywords:
    123       </p>
     86    <p>where <codeph>OPTION</codeph> is one of the following keywords: </p>
    12487    <dl>
    12588      <dlentry>
    … …  
    12891        </dt>
    12992        <dd>
    130           <p>
    131               Do not show any menu item in this menu.
    132             </p>
     93          <p>Do not show any menu item in this menu. </p>
    13394        </dd>
    13495      </dlentry>
    … …  
    13798          <codeph>About</codeph>
    13899        </dt>
    139         <dd>
    140           <p>
    141               Do not show the <b outputclass="bold">About</b>
    142               menu item in this menu.
    143             </p>
    144         </dd>
     100        <dd>Do not show the <b outputclass="bold">About</b> menu item in this menu. </dd>
    145101      </dlentry>
    146102      <dlentry>
    … …  
    149105        </dt>
    150106        <dd>
    151           <p>
    152               Do not show the
    153               <b outputclass="bold">Preferences</b> menu item in
    154               this menu.
    155             </p>
     107          <p>Do not show the <b outputclass="bold">Preferences</b> menu item in this menu. </p>
    156108        </dd>
    157109      </dlentry>
    … …  
    161113        </dt>
    162114        <dd>
    163           <p>
    164               Do not show the <b outputclass="bold">Network Operations
    165               Manager</b> menu item in this menu.
    166             </p>
     115          <p>Do not show the <b outputclass="bold">Network Operations Manager</b> menu item in this menu. </p>
    167116        </dd>
    168117      </dlentry>
    … …  
    172121        </dt>
    173122        <dd>
    174           <p>
    175               Do not show the <b outputclass="bold">Reset All
    176               Warnings</b> menu item in this menu.
    177             </p>
     123          <p>Do not show the <b outputclass="bold">Reset All Warnings</b> menu item in this menu. </p>
    178124        </dd>
    179125      </dlentry>
    … …  
    183129        </dt>
    184130        <dd>
    185           <p>
    186               Do not show the <b outputclass="bold">Close</b>
    187               menu item in this menu.
    188             </p>
     131          <p>Do not show the <b outputclass="bold">Close</b> menu item in this menu. </p>
    189132        </dd>
    190133      </dlentry>
    191134    </dl>
    192     <p>
    193         This is a per-VM or global setting. Any combination of the above
    194         is allowed. To restore the default behavior, use the following
    195         command:
    196       </p>
     135    <p>This is a per-VM or global setting. Any combination of the above is allowed. To restore the default behavior, use
     136      the following command: </p>
    197137    <pre xml:space="preserve">VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeMenus</pre>
    198138    <p>

  • trunk/doc/manual/en_US/dita/topics/config-vm-window-status-bar.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         You can disable certain status bar items:
    9       </p>
     7    <p>You can disable certain status bar items: </p>
    108    <pre xml:space="preserve">VBoxManage setextradata "VM name"|global GUI/RestrictedStatusBarIndicators OPTION[,OPTION...]</pre>
    11     <p>
    12         where <codeph>OPTION</codeph> is one of the following
    13         keywords:
    14       </p>
     9    <p>where <codeph>OPTION</codeph> is one of the following keywords: </p>
    1510    <dl>
    1611      <dlentry>
    … …  
    1914        </dt>
    2015        <dd>
    21           <p>
    22               Do not show the hard disk icon in the VM window status
    23               bar. By default the hard disk icon is only shown if the VM
    24               configuration contains one or more hard disks.
    25             </p>
     16          <p>Do not show the hard disk icon in the VM window status bar. By default the hard disk icon is only shown if
     17            the VM configuration contains one or more hard disks. </p>
    2618        </dd>
    2719      </dlentry>
    … …  
    3123        </dt>
    3224        <dd>
    33           <p>
    34               Do not show the CD icon in the VM window status bar. By
    35               default the CD icon is only shown if the VM configuration
    36               contains one or more CD drives.
    37             </p>
     25          <p>Do not show the CD icon in the VM window status bar. By default the CD icon is only shown if the VM
     26            configuration contains one or more CD drives. </p>
    3827        </dd>
    3928      </dlentry>
    … …  
    4332        </dt>
    4433        <dd>
    45           <p>
    46               Do not show the floppy icon in the VM window status bar.
    47               By default the floppy icon is only shown if the VM
    48               configuration contains one or more floppy drives.
    49             </p>
     34          <p>Do not show the floppy icon in the VM window status bar. By default the floppy icon is only shown if the VM
     35            configuration contains one or more floppy drives. </p>
    5036        </dd>
    5137      </dlentry>
    … …  
    5541        </dt>
    5642        <dd>
    57           <p>
    58               Do not show the network icon in the VM window status bar.
    59               By default the network icon is only shown if the VM
    60               configuration contains one or more active network
    61               adapters.
    62             </p>
     43          <p>Do not show the network icon in the VM window status bar. By default the network icon is only shown if the
     44            VM configuration contains one or more active network adapters. </p>
    6345        </dd>
    6446      </dlentry>
    … …  
    6850        </dt>
    6951        <dd>
    70           <p>
    71               Do not show the USB icon in the status bar.
    72             </p>
     52          <p>Do not show the USB icon in the status bar. </p>
    7353        </dd>
    7454      </dlentry>
    … …  
    7858        </dt>
    7959        <dd>
    80           <p>
    81               Do not show the shared folders icon in the status bar.
    82             </p>
     60          <p>Do not show the shared folders icon in the status bar. </p>
    8361        </dd>
    8462      </dlentry>
    … …  
    8866        </dt>
    8967        <dd>
    90           <p>
    91               Do not show the capture icon in the status bar.
    92             </p>
     68          <p>Do not show the capture icon in the status bar. </p>
    9369        </dd>
    9470      </dlentry>
    … …  
    9874        </dt>
    9975        <dd>
    100           <p>
    101               Do not show the CPU features icon in the status bar.
    102             </p>
     76          <p>Do not show the CPU features icon in the status bar. </p>
    10377        </dd>
    10478      </dlentry>
    … …  
    10882        </dt>
    10983        <dd>
    110           <p>
    111               Do not show the mouse icon in the status bar.
    112             </p>
     84          <p>Do not show the mouse icon in the status bar. </p>
    11385        </dd>
    11486      </dlentry>
    … …  
    11890        </dt>
    11991        <dd>
    120           <p>
    121               Do not show the keyboard icon in the status bar.
    122             </p>
     92          <p>Do not show the keyboard icon in the status bar. </p>
    12393        </dd>
    12494      </dlentry>
    12595    </dl>
    126     <p>
    127         This is a per-VM or global setting. Any combination of the above
    128         is allowed. If all options are specified, no icons are displayed
    129         in the status bar of the VM window. To restore the default
    130         behavior, use
    131       </p>
     96    <p>This is a per-VM or global setting. Any combination of the above is allowed. If all options are specified, no
     97      icons are displayed in the status bar of the VM window. To restore the default behavior, use </p>
    13298    <pre xml:space="preserve">VBoxManage setextradata "VM name"|global GUI/RestrictedStatusBarIndicators</pre>
    13399  </body>

  • trunk/doc/manual/en_US/dita/topics/config-vm-window-visual-modes.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         You can disable certain VM visual modes:
    9       </p>
     7    <p>You can disable certain VM visual modes: </p>
    108    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> GUI/RestrictedVisualStates <varname>property</varname>[,<varname>property</varname>...]</pre>
    119    <p><varname>property</varname> is one of the following:
    … …  
    1715        </dt>
    1816        <dd>
    19           <p>
    20               Do not allow to switch the VM into full screen mode.
    21             </p>
     17          <p>Do not allow to switch the VM into full screen mode. </p>
    2218        </dd>
    2319      </dlentry>
    … …  
    2723        </dt>
    2824        <dd>
    29           <p>
    30               Do not allow to switch the VM into seamless mode.
    31             </p>
     25          <p>Do not allow to switch the VM into seamless mode. </p>
    3226        </dd>
    3327      </dlentry>
    … …  
    3731        </dt>
    3832        <dd>
    39           <p>
    40               Do not allow to switch the VM into scale mode.
    41             </p>
     33          <p>Do not allow to switch the VM into scale mode. </p>
    4234        </dd>
    4335      </dlentry>
    4436    </dl>
    45     <p>
    46         This is a per-VM setting. You can specify any combination of
    47         properties. To restore the default behavior, use the following
    48         command:
    49       </p>
     37    <p>This is a per-VM setting. You can specify any combination of properties. To restore the default behavior, use the
     38      following command: </p>
    5039    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> GUI/RestrictedVisualStates</pre>
    5140  </body>

  • trunk/doc/manual/en_US/dita/topics/cpuhotplug.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       With virtual machines running modern server operating systems,
    9       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports CPU hot-plugging.
    10     </p>
    11     <p>
    12       On a physical computer CPU hot-plugging would mean that a CPU can
    13       be added or removed while the machine is running. <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    14       supports adding and removing of virtual CPUs while a virtual
    15       machine is running.
    16     </p>
    17     <p>
    18       CPU hot-plugging works only with guest operating systems that
    19       support the feature. So far this applies only to Linux and Windows
    20       Server. Windows supports only hot-add, while Linux supports
    21       hot-add and hot-remove. To use this feature with more than 8 CPUs,
    22       a 64-bit Linux guest is required.
    23     </p>
    24     <p>
    25       CPU hot-plugging is done using the <userinput>VBoxManage</userinput>
    26       command-line interface. First, hot-plugging needs to be enabled
    27       for a virtual machine:
    28     </p>
     7    <p>With virtual machines running modern server operating systems, <ph
     8        conkeyref="vbox-conkeyref-phrases/product-name"/> supports CPU hot-plugging. </p>
     9    <p>On a physical computer CPU hot-plugging would mean that a CPU can be added or removed while the machine is
     10      running. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports adding and removing of virtual CPUs while
     11      a virtual machine is running. </p>
     12    <p>CPU hot-plugging works only with guest operating systems that support the feature. So far this applies only to
     13      Linux and Windows Server. Windows supports only hot-add, while Linux supports hot-add and hot-remove. To use this
     14      feature with more than 8 CPUs, a 64-bit Linux guest is required. </p>
     15    <p>CPU hot-plugging is done using the <userinput>VBoxManage</userinput> command-line interface. First, hot-plugging
     16      needs to be enabled for a virtual machine: </p>
    2917    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --cpu-hotplug on</pre>
    30     <p>
    31       The <codeph>--cpus</codeph> option is used to specify the maximum
    32       number of CPUs that the virtual machine can have:
    33     </p>
     18    <p>The <codeph>--cpus</codeph> option is used to specify the maximum number of CPUs that the virtual machine can
     19      have: </p>
    3420    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --cpus 8</pre>
    35     <p>
    36       When the VM is off, you can then add and remove virtual CPUs with
    37       the <userinput>VBoxManage modifyvm --plug-cpu</userinput> and
    38       <userinput>VBoxManage modifyvm --unplug-cpu</userinput> commands,
    39       which take the number of the virtual CPU as a parameter, as
    40       follows:
    41     </p>
     21    <p>When the VM is off, you can then add and remove virtual CPUs with the <userinput>VBoxManage modifyvm
     22        --plug-cpu</userinput> and <userinput>VBoxManage modifyvm --unplug-cpu</userinput> commands, which take the
     23      number of the virtual CPU as a parameter, as follows: </p>
    4224    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --plug-cpu 3
    4325$ VBoxManage modifyvm <varname>VM-name</varname> --unplug-cpu 3</pre>
    44     <p>
    45       Note that CPU 0 can never be removed.
    46     </p>
    47     <p>
    48       While the VM is running, CPUs can be added and removed with the
    49       <userinput>VBoxManage controlvm plugcpu</userinput> and
    50       <userinput>VBoxManage controlvm unplugcpu</userinput> commands
    51       instead, as follows:
    52     </p>
     26    <p>Note that CPU 0 can never be removed. </p>
     27    <p>While the VM is running, CPUs can be added and removed with the <userinput>VBoxManage controlvm
     28        plugcpu</userinput> and <userinput>VBoxManage controlvm unplugcpu</userinput> commands instead, as follows: </p>
    5329    <pre xml:space="preserve">$ VBoxManage controlvm <varname>VM-name</varname> plugcpu 3
    5430$ VBoxManage controlvm <varname>VM-name</varname> unplugcpu 3</pre>
    55     <p>
    56       See <xref href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref> and
    57       <xref href="vboxmanage-controlvm.dita">VBoxManage controlvm</xref> for details.
    58     </p>
    59     <p>
    60       With Linux guests, the following applies:
    61     </p>
    62     <p>
    63       To prevent ejection while the CPU is still used it has to be
    64       ejected from within the guest before. The Linux Guest Additions
    65       contain a service which receives hot-remove events and ejects the
    66       CPU. Also, after a CPU is added to the VM it is not automatically
    67       used by Linux. The Linux Guest Additions service will take care of
    68       that if installed. If not a CPU can be started with the following
    69       command:
    70     </p>
     31    <p>See <xref href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref> and <xref href="vboxmanage-controlvm.dita"
     32        >VBoxManage controlvm</xref> for details. </p>
     33    <p>With Linux guests, the following applies: </p>
     34    <p>To prevent ejection while the CPU is still used it has to be ejected from within the guest before. The Linux
     35      Guest Additions contain a service which receives hot-remove events and ejects the CPU. Also, after a CPU is added
     36      to the VM it is not automatically used by Linux. The Linux Guest Additions service will take care of that if
     37      installed. If not a CPU can be started with the following command: </p>
    7138    <pre xml:space="preserve">$ echo 1 &gt; /sys/devices/system/cpu/cpu&lt;id&gt;/online</pre>
    7239  </body>

  • trunk/doc/manual/en_US/dita/topics/create-floppy-disk-image.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         Use the <b outputclass="bold">Floppy Disk Creator</b>
    9         tool to create a floppy disk image.
    10       </p>
     7    <p>Use the <b outputclass="bold">Floppy Disk Creator</b> tool to create a floppy disk image. </p>
    118    <ol>
    129      <li>
    13         <p>
    14             Display the <b outputclass="bold">Floppy Disks</b>
    15             tab in Virtual Media Manager and click
    16             <b outputclass="bold">Create</b>.
    17           </p>
    18         <p>
    19             The <b outputclass="bold">Floppy Disk Creator</b>
    20             tool is shown.
    21           </p>
     10        <p>Display the <b outputclass="bold">Floppy Disks</b> tab in Virtual Media Manager and click <b
     11            outputclass="bold">Create</b>. </p>
     12        <p>The <b outputclass="bold">Floppy Disk Creator</b> tool is shown. </p>
    2213      </li>
    2314      <li>
    24         <p>
    25             Configure the following settings:
    26           </p>
     15        <p>Configure the following settings: </p>
    2716        <ul>
    2817          <li>
    … …  
    4534      </li>
    4635      <li>
    47         <p>
    48             Create the floppy disk image file.
    49           </p>
    50         <p>
    51             Click <b outputclass="bold">Create</b>.
    52           </p>
    53         <p>
    54             The floppy disk image is created in the specified location
    55             and added to the <b outputclass="bold">Floppy
    56             Disks</b> tab in Virtual Media Manager.
    57           </p>
     36        <p>Create the floppy disk image file. </p>
     37        <p>Click <b outputclass="bold">Create</b>. </p>
     38        <p>The floppy disk image is created in the specified location and added to the <b outputclass="bold">Floppy
     39            Disks</b> tab in Virtual Media Manager. </p>
    5840      </li>
    5941    </ol>

  • trunk/doc/manual/en_US/dita/topics/create-optical-disk-image.dita

    r105134 r105335  
    55  <!-- 7.1: Can now import VISO files-->
    66  <body>
    7     <p>
    8         Use the <b outputclass="bold">VISO Creator</b> tool to
    9         create a virtual optical disk image. This enables you to create
    10         a virtual ISO from selected files on the host.
    11       </p>
     7    <p>Use the <b outputclass="bold">VISO Creator</b> tool to create a virtual optical disk image. This enables you to
     8      create a virtual ISO from selected files on the host. </p>
    129    <ol>
    1310      <li>
    14         <p>
    15             Display the <b outputclass="bold">Optical Disks</b>
    16             tab in Virtual Media Manager and click
    17             <b outputclass="bold">Create</b>.
    18           </p>
    19         <p>
    20             The <b outputclass="bold">VISO Creator</b> tool is
    21             shown.
    22           </p>
     11        <p>Display the <b outputclass="bold">Optical Disks</b> tab in Virtual Media Manager and click <b
     12            outputclass="bold">Create</b>. </p>
     13        <p>The <b outputclass="bold">VISO Creator</b> tool is shown. </p>
    2314      </li>
    2415      <li>
    25         <p>
    26             Create the virtual ISO file.
    27           </p>
     16        <p>Create the virtual ISO file. </p>
    2817        <ol>
    2918          <li>
    30             <p>
    31                 Configure the name of the ISO file.
    32               </p>
    33             <p>
    34                 Click <b outputclass="bold">Settings</b> and select the <b>VISO Options</b> tab.
    35                 Enter the name in the <b outputclass="bold">Viso
    36                 Name</b> field.
    37               </p>
     19            <p>Configure the name of the ISO file. </p>
     20            <p>Click <b outputclass="bold">Settings</b> and select the <b>VISO Options</b> tab. Enter the name in the <b
     21                outputclass="bold">Viso Name</b> field. </p>
    3822          </li>
    3923          <li>
    40             <p>
    41                 Add files to your virtual ISO.
    42               </p>
    43             <p>
    44                 In the <b outputclass="bold">Host File System</b>
    45                 pane, select files to copy from the host system to the
    46                 virtual ISO.
    47               </p>
    48             <p>
    49                 Click <b outputclass="bold">Add Items To
    50                 VISO</b>. The files are displayed in the
    51                 <b outputclass="bold">VISO Content</b> pane.
    52               </p>
    53             <p>
    54                 The following file operations are also available:
    55               </p>
     24            <p>Add files to your virtual ISO. </p>
     25            <p>In the <b outputclass="bold">Host File System</b> pane, select files to copy from the host system to the
     26              virtual ISO. </p>
     27            <p>Click <b outputclass="bold">Add Items To VISO</b>. The files are displayed in the <b outputclass="bold"
     28                >VISO Content</b> pane. </p>
     29            <p>The following file operations are also available: </p>
    5630            <ul>
    5731              <li>
    58                 <p>
    59                     To create folders on the virtual ISO, click
    60                     <b outputclass="bold">Create New
    61                     Directory</b>.
    62                   </p>
     32                <p>To create folders on the virtual ISO, click <b outputclass="bold">Create New Directory</b>. </p>
    6333              </li>
    6434              <li>
    65                 <p>
    66                     To remove files from the virtual ISO, select files
    67                     in the <b outputclass="bold">VISO Content</b>
    68                     pane and click <b outputclass="bold">Remove Items
    69                     From VISO</b>.
    70                   </p>
     35                <p>To remove files from the virtual ISO, select files in the <b outputclass="bold">VISO Content</b> pane
     36                  and click <b outputclass="bold">Remove Items From VISO</b>. </p>
    7137              </li>
    7238              <li>
    73                 <p>
    74                     To remove <i>all</i> files from the
    75                     virtual ISO, click <b outputclass="bold">Reset the
    76                     VISO Content</b>.
    77                   </p>
     39                <p>To remove <i>all</i> files from the virtual ISO, click <b outputclass="bold">Reset the VISO
     40                    Content</b>. </p>
    7841              </li>
    7942              <li>
    80                 <p> To import <i>all</i> file content from an existing ISO into the virtual ISO,
    81                   highlight the ISO file name and click <b>Import Selected ISO into the VISO
    82                     Content</b>. The imported ISO is opened and content is listed in the <b
    83                     outputclass="bold">VISO Content</b> pane.</p>
     43                <p>To import <i>all</i> file content from an existing ISO into the virtual ISO, highlight the ISO file
     44                  name and click <b>Import Selected ISO into the VISO Content</b>. The imported ISO is opened and
     45                  content is listed in the <b outputclass="bold">VISO Content</b> pane.</p>
    8446                <p>To remove files from the imported ISO, select the files in the <b>Viso
    8547                    Content</b> pane and click <b>Remove Selected Item(s) from VISO</b>.</p>
    … …  
    9052      </li>
    9153      <li>
    92         <p>
    93             Create the virtual ISO image.
    94           </p>
    95         <p>
    96             Click <b outputclass="bold">Save and Close</b>.
    97           </p>
    98         <p>
    99             A virtual ISO file with the specified name and content is
    100             created.
    101           </p>
     54        <p>Create the virtual ISO image. </p>
     55        <p>Click <b outputclass="bold">Save and Close</b>. </p>
     56        <p>A virtual ISO file with the specified name and content is created. </p>
    10257      </li>
    10358    </ol>

  • trunk/doc/manual/en_US/dita/topics/create-virtual-hard-disk-image.dita

    r99182 r105335  
    55 
    66  <body>
    7     <p>
    8         Use the <b outputclass="bold">Create Virtual Hard
    9         Disk</b> wizard to create a hard disk image.
    10       </p>
     7    <p>Use the <b outputclass="bold">Create Virtual Hard Disk</b> wizard to create a hard disk image. </p>
    118    <ol>
    129      <li>
    13         <p>
    14             Display the <b outputclass="bold">Hard Disks</b> tab
    15             in Virtual Media Manager and click
    16             <b outputclass="bold">Create</b>.
    17           </p>
    18         <p>
    19             The <b outputclass="bold">Create Virtual Hard
    20             Disk</b> wizard is shown.
    21           </p>
     10        <p>Display the <b outputclass="bold">Hard Disks</b> tab in Virtual Media Manager and click <b outputclass="bold"
     11            >Create</b>. </p>
     12        <p>The <b outputclass="bold">Create Virtual Hard Disk</b> wizard is shown. </p>
    2213        <fig id="fig-virtual-hard-disk-wizard">
    2314          <title>Create Virtual Hard Disk Wizard</title>
    … …  
    3324      </li>
    3425      <li>
    35         <p>
    36             On the <b outputclass="bold">Virtual Hard Disk File
    37             Type</b> page, select a file type for the new virtual
    38             hard disk image.
    39           </p>
     26        <p>On the <b outputclass="bold">Virtual Hard Disk File Type</b> page, select a file type for the new virtual
     27          hard disk image. </p>
    4028        <p>
    4129            Click <b outputclass="bold">Next</b>.
    … …  
    4331      </li>
    4432      <li>
    45         <p>
    46             On the <b outputclass="bold">Storage on Physical Hard
    47             Disk</b> page, select whether the size of the virtual
    48             hard disk file is dynamically allocated or is of fixed size.
    49           </p>
    50         <p>
    51             Click <b outputclass="bold">Next</b>.
    52           </p>
     33        <p>On the <b outputclass="bold">Storage on Physical Hard Disk</b> page, select whether the size of the virtual
     34          hard disk file is dynamically allocated or is of fixed size. </p>
     35        <p>Click <b outputclass="bold">Next</b>. </p>
    5336      </li>
    5437      <li>
    55         <p>
    56             On the <b outputclass="bold">File Location and
    57             Size</b> page, configure the location of the virtual
    58             hard disk file and use the slider to set the size limit for
    59             the virtual hard disk.
    60           </p>
    61         <p>
    62             Click <b outputclass="bold">Finish</b> to create the
    63             virtual hard disk file.
    64           </p>
    65         <p>
    66             The virtual hard disk image is created in the specified
    67             location and added to the <b outputclass="bold">Hard
    68             Disks</b> tab in Virtual Media Manager.
    69           </p>
     38        <p>On the <b outputclass="bold">File Location and Size</b> page, configure the location of the virtual hard disk
     39          file and use the slider to set the size limit for the virtual hard disk. </p>
     40        <p>Click <b outputclass="bold">Finish</b> to create the virtual hard disk file. </p>
     41        <p>The virtual hard disk image is created in the specified location and added to the <b outputclass="bold">Hard
     42            Disks</b> tab in Virtual Media Manager. </p>
    7043      </li>
    7144    </ol>

  • trunk/doc/manual/en_US/dita/topics/create-vm-wizard-virtual-hard-disk.dita

    r105134 r105335  
    4545                the hard disk in the new VM. </p>
    4646            </li>
     47            <li><p><b outputclass="bold">Pre-Allocate Full Size.</b> This setting determines the type of image file used
     48                for the disk image. Select this setting to use a <i>fixed-size file</i> for the disk image. Otherwise,
     49                  <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will use a <i>dynamically allocated file</i> for
     50                the disk image. </p><p>The different types of image file behave as follows: </p><ul id="ul_j3n_y1r_pbc">
    4751            <li>
    48               <p><b outputclass="bold">Pre-Allocate Full Size.</b> This setting determines the type
    49                 of image file used for the disk image. Select this setting to use a <i>fixed-size
    50                   file</i> for the disk image. Otherwise, <ph
    51                   conkeyref="vbox-conkeyref-phrases/product-name"/> will use a <i>dynamically
    52                   allocated file</i> for the disk image. </p>
    53               <p>The different types of image file behave as follows: </p>
    54               <ul id="ul_j3n_y1r_pbc">
    55                 <li>
    56                   <p><b outputclass="bold">Dynamically allocated file.</b> This type of image file
    57                     only grows in size when the guest actually stores data on its virtual hard disk.
    58                     Therefore, this file is small initially. As the drive is filled with data, the
    59                     file grows to the specified size. </p>
     52                  <p><b outputclass="bold">Dynamically allocated file.</b> This type of image file only grows in size
     53                    when the guest actually stores data on its virtual hard disk. Therefore, this file is small
     54                    initially. As the drive is filled with data, the file grows to the specified size. </p>
    6055                </li>
    6156                <li>
    62                   <p><b outputclass="bold">Fixed-size file.</b> This type of image file immediately
    63                     occupies the file specified, even if only a fraction of that virtual hard disk
    64                     space is actually in use. While occupying much more space, a fixed-size file
    65                     incurs less overhead and is therefore slightly faster than a dynamically
    66                     allocated file. </p>
     57                  <p><b outputclass="bold">Fixed-size file.</b> This type of image file immediately occupies the file
     58                    specified, even if only a fraction of that virtual hard disk space is actually in use. While
     59                    occupying much more space, a fixed-size file incurs less overhead and is therefore slightly faster
     60                    than a dynamically allocated file. </p>
    6761                </li>
     62              </ul>For more details about the differences, see <xref href="vdidetails.dita#vdidetails"/>. </li>
    6863              </ul>
    69               <p> For more details about the differences, see <xref
    70                   href="vdidetails.dita#vdidetails"/>. </p>
    7164            </li>
    72           </ul>
    73         </li>
    7465      </ol></p>
    7566    <section id="section_bdq_h1r_pbc">

  • trunk/doc/manual/en_US/dita/topics/customize-vm-manager.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         There are several advanced customization settings for locking
    9         down <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. Locking down means removing some features that
    10         the user should not see.
    11       </p>
     7    <p>There are several advanced customization settings for locking down <ph
     8        conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. Locking down means removing some features that the user should
     9      not see. </p>
    1210    <pre xml:space="preserve">VBoxManage setextradata global GUI/Customizations <varname>property</varname>[,<varname>property</varname> ...]</pre>
    1311    <p><varname>property</varname> is one of the following
    … …  
    4745      </dlentry>
    4846    </dl>
    49     <p>
    50         To disable any of these <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> customizations use the
    51         following command:
    52       </p>
     47    <p>To disable any of these <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> customizations use the following
     48      command: </p>
    5349    <pre xml:space="preserve">$ VBoxManage setextradata global GUI/Customizations</pre>
    5450  </body>

  • trunk/doc/manual/en_US/dita/topics/customize-vm-selector.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         The following per-machine VM extradata settings can be used to
    9         change the behavior of the VM selector window in respect of
    10         certain VMs:
    11       </p>
     7    <p>The following per-machine VM extradata settings can be used to change the behavior of the VM selector window in
     8      respect of certain VMs: </p>
    129    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname>
    1310                     <varname>property</varname> true</pre>
    … …  
    7269      </dlentry>
    7370    </dl>
    74     <p>
    75         Note that these settings do not prevent the user from
    76         reconfiguring the VM by using the <userinput>VBoxManage
    77         modifyvm</userinput> command.
    78       </p>
     71    <p>Note that these settings do not prevent the user from reconfiguring the VM by using the <userinput>VBoxManage
     72        modifyvm</userinput> command. </p>
    7973  </body>
    8074 

  • trunk/doc/manual/en_US/dita/topics/customvesa.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         Apart from the standard VESA resolutions, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    9         VESA BIOS enables you to add up to 16 custom video modes which
    10         will be reported to the guest operating system. When using
    11         Windows guests with the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions, a custom
    12         graphics driver will be used instead of the fallback VESA
    13         solution so this information does not apply.
    14       </p>
    15     <p>
    16         Additional video modes can be configured for each VM using the
    17         extra data facility. The extra data key is called
     7    <p>Apart from the standard VESA resolutions, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VESA BIOS
     8      enables you to add up to 16 custom video modes which will be reported to the guest operating system. When using
     9      Windows guests with the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions, a custom graphics
     10      driver will be used instead of the fallback VESA solution so this information does not apply. </p>
     11    <p>Additional video modes can be configured for each VM using the extra data facility. The extra data key is called
    1812        <codeph>CustomVideoMode<varname>x</varname>
    19                      </codeph>
    20         with <varname>x</varname> being a number from 1 to 16.
    21         Please note that modes will be read from 1 until either the
    22         following number is not defined or 16 is reached. The following
    23         example adds a video mode that corresponds to the native display
    24         resolution of many notebook computers:
    25       </p>
     13      </codeph> with <varname>x</varname> being a number from 1 to 16. Please note that modes will be read from 1 until
     14      either the following number is not defined or 16 is reached. The following example adds a video mode that
     15      corresponds to the native display resolution of many notebook computers: </p>
    2616    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> "CustomVideoMode1" "1400x1050x16"</pre>
    27     <p>
    28         The VESA mode IDs for custom video modes start at
    29         <codeph>0x160</codeph>. In order to use the above defined
    30         custom video mode, the following command line has to be supplied
    31         to Linux:
    32       </p>
     17    <p>The VESA mode IDs for custom video modes start at <codeph>0x160</codeph>. In order to use the above defined
     18      custom video mode, the following command line has to be supplied to Linux: </p>
    3319    <pre xml:space="preserve">vga = 0x200 | 0x160
    3420vga = 864</pre>
    35     <p>
    36         For guest operating systems with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions,
    37         a custom video mode can be set using the video mode hint
    38         feature.
    39       </p>
     21    <p>For guest operating systems with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions, a custom
     22      video mode can be set using the video mode hint feature. </p>
    4023  </body>
    4124 

  • trunk/doc/manual/en_US/dita/topics/diffimages.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       The previous section mentioned differencing images and how they
    9       are used with snapshots, immutable images, and multiple disk
    10       attachments. This section describes in more detail how
    11       differencing images work.
    12     </p>
    13     <p>
    14       A differencing image is a special disk image that only holds the
    15       differences to another image. A differencing image by itself is
    16       useless, it must always refer to another image. The differencing
    17       image is then typically referred to as a
    18       <i>child</i>, which holds the differences to its
    19       <i>parent</i>.
    20     </p>
    21     <p>
    22       When a differencing image is active, it receives all write
    23       operations from the virtual machine instead of its parent. The
    24       differencing image only contains the sectors of the virtual hard
    25       disk that have changed since the differencing image was created.
    26       When the machine reads a sector from such a virtual hard disk, it
    27       looks into the differencing image first. If the sector is present,
    28       it is returned from there. If not, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> looks into the
    29       parent. In other words, the parent becomes
    30       <i>read-only</i>. It is never written to again, but
    31       it is read from if a sector has not changed.
    32     </p>
    33     <p>
    34       Differencing images can be chained. If another differencing image
    35       is created for a virtual disk that already has a differencing
    36       image, then it becomes a <i>grandchild</i> of the
    37       original parent. The first differencing image then becomes
    38       read-only as well, and write operations only go to the
    39       second-level differencing image. When reading from the virtual
    40       disk, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to look into the second differencing
    41       image first, then into the first if the sector was not found, and
    42       then into the original image.
    43     </p>
    44     <p>
    45       There can be an unlimited number of differencing images, and each
    46       image can have more than one child. As a result, the differencing
    47       images can form a complex tree with parents, siblings, and
    48       children, depending on how complex your machine configuration is.
    49       Write operations always go to the one <i>active</i>
    50       differencing image that is attached to the machine, and for read
    51       operations, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> may need to look up all the parents in
    52       the chain until the sector in question is found. You can view such
    53       a tree in the Virtual Media Manager.
    54     </p>
     7    <p>The previous section mentioned differencing images and how they are used with snapshots, immutable images, and
     8      multiple disk attachments. This section describes in more detail how differencing images work. </p>
     9    <p>A differencing image is a special disk image that only holds the differences to another image. A differencing
     10      image by itself is useless, it must always refer to another image. The differencing image is then typically
     11      referred to as a <i>child</i>, which holds the differences to its <i>parent</i>. </p>
     12    <p>When a differencing image is active, it receives all write operations from the virtual machine instead of its
     13      parent. The differencing image only contains the sectors of the virtual hard disk that have changed since the
     14      differencing image was created. When the machine reads a sector from such a virtual hard disk, it looks into the
     15      differencing image first. If the sector is present, it is returned from there. If not, <ph
     16        conkeyref="vbox-conkeyref-phrases/product-name"/> looks into the parent. In other words, the parent becomes
     17        <i>read-only</i>. It is never written to again, but it is read from if a sector has not changed. </p>
     18    <p>Differencing images can be chained. If another differencing image is created for a virtual disk that already has
     19      a differencing image, then it becomes a <i>grandchild</i> of the original parent. The first differencing image
     20      then becomes read-only as well, and write operations only go to the second-level differencing image. When reading
     21      from the virtual disk, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to look into the second
     22      differencing image first, then into the first if the sector was not found, and then into the original image. </p>
     23    <p>There can be an unlimited number of differencing images, and each image can have more than one child. As a
     24      result, the differencing images can form a complex tree with parents, siblings, and children, depending on how
     25      complex your machine configuration is. Write operations always go to the one <i>active</i> differencing image that
     26      is attached to the machine, and for read operations, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> may
     27      need to look up all the parents in the chain until the sector in question is found. You can view such a tree in
     28      the Virtual Media Manager. </p>
    5529    <fig id="fig-diff-images">
    5630      <title>Differencing Images, Shown in Virtual Media Manager</title>
    … …  
    6438      </image>
    6539    </fig>
    66     <p> In all of these situations, from the point of view of the virtual machine, the virtual hard
    67       disk behaves like any other disk. While the virtual machine is running, there is a slight
    68       runtime I/O overhead because <ph conkeyref="vbox-conkeyref-phrases/product-name"/> might need
    69       to look up sectors several times. This is not noticeable however since the tables with sector
    70       information are always kept in memory and can be looked up quickly. </p>
    71     <p>
    72       Differencing images are used in the following situations:
    73     </p>
     40    <p>In all of these situations, from the point of view of the virtual machine, the virtual hard disk behaves like any
     41      other disk. While the virtual machine is running, there is a slight runtime I/O overhead because <ph
     42        conkeyref="vbox-conkeyref-phrases/product-name"/> might need to look up sectors several times. This is not
     43      noticeable however since the tables with sector information are always kept in memory and can be looked up
     44      quickly. </p>
     45    <p>Differencing images are used in the following situations: </p>
    7446    <ul>
    7547      <li>
    … …  
    8557          image is created and attached, forming a chain or tree.
    8658        </p>
    87         <p>
    88           In the above screenshot, you see that the original disk image
    89           is now attached to a snapshot, representing the state of the
    90           disk when the snapshot was taken.
    91         </p>
    92         <p>
    93           If you <i>restore</i> a snapshot, and want to go
    94           back to the exact machine state that was stored in the
    95           snapshot, the following happens:
    96         </p>
     59        <p>In the above screenshot, you see that the original disk image is now attached to a snapshot, representing the
     60          state of the disk when the snapshot was taken. </p>
     61        <p>If you <i>restore</i> a snapshot, and want to go back to the exact machine state that was stored in the
     62          snapshot, the following happens: </p>
    9763        <ul>
    9864          <li>
    99             <p>
    100               <ph conkeyref="vbox-conkeyref-phrases/product-name"/> copies the virtual machine settings that
    101               were copied into the snapshot back to the virtual machine.
    102               As a result, if you have made changes to the machine
    103               configuration since taking the snapshot, they are undone.
    104             </p>
     65            <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> copies the virtual machine settings that were
     66              copied into the snapshot back to the virtual machine. As a result, if you have made changes to the machine
     67              configuration since taking the snapshot, they are undone. </p>
    10568          </li>
    10669          <li>
    107             <p>
    108               If the snapshot was taken while the machine was running,
    109               it contains a saved machine state, and that state is
    110               restored as well. After restoring the snapshot, the
    111               machine will then be in Saved state and resume execution
    112               from there when it is next started. Otherwise the machine
    113               will be in Powered Off state and do a full boot.
    114             </p>
     70            <p>If the snapshot was taken while the machine was running, it contains a saved machine state, and that
     71              state is restored as well. After restoring the snapshot, the machine will then be in Saved state and
     72              resume execution from there when it is next started. Otherwise the machine will be in Powered Off state
     73              and do a full boot. </p>
    11574          </li>
    11675          <li>
    117             <p>
    118               For each disk image attached to the machine, the
    119               differencing image holding all the write operations since
    120               the current snapshot was taken is thrown away, and the
    121               original parent image is made active again. If you
    122               restored the root snapshot, then this will be the root
    123               disk image for each attachment. Otherwise, some other
    124               differencing image descended from it. This effectively
    125               restores the old machine state.
    126             </p>
     76            <p>For each disk image attached to the machine, the differencing image holding all the write operations
     77              since the current snapshot was taken is thrown away, and the original parent image is made active again.
     78              If you restored the root snapshot, then this will be the root disk image for each attachment. Otherwise,
     79              some other differencing image descended from it. This effectively restores the old machine state. </p>
    12780          </li>
    12881        </ul>
    129         <p>
    130           If you later <i>delete</i> a snapshot in order
    131           to free disk space, for each disk attachment, one of the
    132           differencing images becomes obsolete. In this case, the
    133           differencing image of the disk attachment cannot simply be
    134           deleted. Instead, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to look at each sector
    135           of the differencing image and needs to copy it back into its
    136           parent. This is called "merging" images and can be a
    137           potentially lengthy process, depending on how large the
    138           differencing image is. It can also temporarily need a
    139           considerable amount of extra disk space, before the
    140           differencing image obsoleted by the merge operation is
    141           deleted.
    142         </p>
     82        <p>If you later <i>delete</i> a snapshot in order to free disk space, for each disk attachment, one of the
     83          differencing images becomes obsolete. In this case, the differencing image of the disk attachment cannot
     84          simply be deleted. Instead, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to look at each sector
     85          of the differencing image and needs to copy it back into its parent. This is called "merging" images and can
     86          be a potentially lengthy process, depending on how large the differencing image is. It can also temporarily
     87          need a considerable amount of extra disk space, before the differencing image obsoleted by the merge operation
     88          is deleted. </p>
    14389      </li>
    14490      <li>

  • trunk/doc/manual/en_US/dita/topics/disabletimesync.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         Once installed and started, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions
    9         will try to synchronize the guest time with the host time. This
    10         can be prevented by forbidding the guest service from reading
    11         the host clock:
    12       </p>
     7    <p>Once installed and started, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions will try to
     8      synchronize the guest time with the host time. This can be prevented by forbidding the guest service from reading
     9      the host clock: </p>
    1310    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> "VBoxInternal/Devices/VMMDev/0/Config/GetHostTimeDisabled" 1</pre>
    1411  </body>

  • trunk/doc/manual/en_US/dita/topics/diskencryption-decryption.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         In some circumstances it might be required to decrypt previously
    9         encrypted images. This can be done in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> for a complete
    10         VM or using <userinput>VBoxManage</userinput> with the following
    11         command:
    12       </p>
     7    <p>In some circumstances it might be required to decrypt previously encrypted images. This can be done in <ph
     8        conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> for a complete VM or using <userinput>VBoxManage</userinput> with
     9      the following command: </p>
    1310    <pre xml:space="preserve">VBoxManage encryptmedium <varname>uuid</varname>|<varname>filename</varname> --oldpassword <varname>file</varname>|-</pre>
    14     <p>
    15         The only required parameter is the password the image was
    16         encrypted with. The options are the same as for encrypting
    17         images.
    18       </p>
     11    <p>The only required parameter is the password the image was encrypted with. The options are the same as for
     12      encrypting images. </p>
    1913  </body>
    2014 

  • trunk/doc/manual/en_US/dita/topics/diskencryption-encryption.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         Encrypting disk images can be done either using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or
    9         the <userinput>VBoxManage</userinput>. While <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> is easier to
    10         use, it works on a per VM basis and encrypts all disk images
    11         attached to the specific VM. With <userinput>VBoxManage</userinput>
    12         one can encrypt individual images, including all differencing
    13         images. To encrypt an unencrypted medium with
    14         <userinput>VBoxManage</userinput>, use:
    15       </p>
     7    <p>Encrypting disk images can be done either using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or the
     8        <userinput>VBoxManage</userinput>. While <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> is easier to use, it
     9      works on a per VM basis and encrypts all disk images attached to the specific VM. With
     10        <userinput>VBoxManage</userinput> one can encrypt individual images, including all differencing images. To
     11      encrypt an unencrypted medium with <userinput>VBoxManage</userinput>, use: </p>
    1612    <pre xml:space="preserve">VBoxManage encryptmedium <varname>uuid</varname>|<varname>filename</varname> \
    1713--newpassword <varname>filename</varname>|- --cipher <varname>cipher-ID</varname> --newpasswordid "<varname>ID</varname>
    1814                  </pre>
    19     <p>
    20         To supply the encryption password point
    21         <userinput>VBoxManage</userinput> to the file where the password is
    22         stored or specify <codeph>-</codeph> to let <userinput>VBoxManage</userinput> ask you
    23         for the password on the command line.
    24       </p>
    25     <p>
    26         The cipher parameter specifies the cipher to use for encryption
    27         and can be either <codeph>AES-XTS128-PLAIN64</codeph> or
    28         <codeph>AES-XTS256-PLAIN64</codeph>. The specified password
    29         identifier can be freely chosen by the user and is used for
    30         correct identification when supplying multiple passwords during
    31         VM startup.
    32       </p>
    33     <p>
    34         If the user uses the same password when encrypting multiple
    35         images and also the same password identifier, the user needs to
    36         supply the password only once during VM startup.
    37       </p>
     15    <p>To supply the encryption password point <userinput>VBoxManage</userinput> to the file where the password is
     16      stored or specify <codeph>-</codeph> to let <userinput>VBoxManage</userinput> ask you for the password on the
     17      command line. </p>
     18    <p>The cipher parameter specifies the cipher to use for encryption and can be either
     19        <codeph>AES-XTS128-PLAIN64</codeph> or <codeph>AES-XTS256-PLAIN64</codeph>. The specified password identifier
     20      can be freely chosen by the user and is used for correct identification when supplying multiple passwords during
     21      VM startup. </p>
     22    <p>If the user uses the same password when encrypting multiple images and also the same password identifier, the
     23      user needs to supply the password only once during VM startup. </p>
    3824  </body>
    3925 

  • trunk/doc/manual/en_US/dita/topics/diskencryption-limitations.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         There are some limitations the user needs to be aware of when
    9         using this feature:
    10       </p>
     7    <p>There are some limitations the user needs to be aware of when using this feature: </p>
    118    <ul>
    129      <li>
    13         <p>
    14             This feature is part of the <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/>,
    15             which needs to be installed. Otherwise disk encryption is
    16             unavailable.
    17           </p>
     10        <p>This feature is part of the <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/>, which needs to be installed.
     11          Otherwise disk encryption is unavailable. </p>
    1812      </li>
    1913      <li>
    20         <p>
    21             Since encryption works only on the stored user data, it is
    22             currently not possible to check for metadata integrity of
    23             the disk image. Attackers might destroy data by removing or
    24             changing blocks of data in the image or change metadata
    25             items such as the disk size.
    26           </p>
     14        <p>Since encryption works only on the stored user data, it is currently not possible to check for metadata
     15          integrity of the disk image. Attackers might destroy data by removing or changing blocks of data in the image
     16          or change metadata items such as the disk size. </p>
    2717      </li>
    2818      <li>
    29         <p>
    30             Exporting appliances which contain encrypted disk images is
    31             not possible because the OVF specification does not support
    32             this. All images are therefore decrypted during export.
    33           </p>
     19        <p>Exporting appliances which contain encrypted disk images is not possible because the OVF specification does
     20          not support this. All images are therefore decrypted during export. </p>
    3421      </li>
    3522      <li>
    36         <p>
    37             The DEK is kept in memory while the VM is running to be able
    38             to decrypt data read and encrypt data written by the guest.
    39             While this should be obvious the user needs to be aware of
    40             this because an attacker might be able to extract the key on
    41             a compromised host and decrypt the data.
    42           </p>
     23        <p>The DEK is kept in memory while the VM is running to be able to decrypt data read and encrypt data written by
     24          the guest. While this should be obvious the user needs to be aware of this because an attacker might be able
     25          to extract the key on a compromised host and decrypt the data. </p>
    4326      </li>
    4427      <li>
    45         <p>
    46             When encrypting or decrypting the images, the password is
    47             passed in clear text using the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> API. This
    48             needs to be kept in mind, especially when using third party
    49             API clients which make use of the webservice where the
    50             password might be transmitted over the network. The use of
    51             HTTPS is mandatory in such a case.
    52           </p>
     28        <p>When encrypting or decrypting the images, the password is passed in clear text using the <ph
     29            conkeyref="vbox-conkeyref-phrases/product-name"/> API. This needs to be kept in mind, especially when using
     30          third party API clients which make use of the webservice where the password might be transmitted over the
     31          network. The use of HTTPS is mandatory in such a case. </p>
    5332      </li>
    5433      <li>
    55         <p>
    56             Encrypting images with differencing images is only possible
    57             if there are no snapshots or a linear chain of snapshots.
    58             This limitation may be addressed in a future <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    59             version.
    60           </p>
     34        <p>Encrypting images with differencing images is only possible if there are no snapshots or a linear chain of
     35          snapshots. This limitation may be addressed in a future <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     36          version. </p>
    6137      </li>
    6238      <li>
    63         <p>
    64             The disk encryption feature can protect the content of the
    65             disks configured for a VM only. It does not cover any other
    66             data related to a VM, including saved state or the
    67             configuration file itself.
    68           </p>
     39        <p>The disk encryption feature can protect the content of the disks configured for a VM only. It does not cover
     40          any other data related to a VM, including saved state or the configuration file itself. </p>
    6941      </li>
    7042    </ul>

  • trunk/doc/manual/en_US/dita/topics/diskencryption-startvm.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         When a VM is started using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, a dialog will open where
    9         the user needs to enter all passwords for all encrypted images
    10         attached to the VM. If another frontend like VBoxHeadless is
    11         used, the VM will be paused as soon as the guest tries to access
    12         an encrypted disk. The user needs to provide the passwords
    13         through <userinput>VBoxManage</userinput> using the following
    14         command:
    15       </p>
     7    <p>When a VM is started using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, a dialog will open where the user
     8      needs to enter all passwords for all encrypted images attached to the VM. If another frontend like VBoxHeadless is
     9      used, the VM will be paused as soon as the guest tries to access an encrypted disk. The user needs to provide the
     10      passwords through <userinput>VBoxManage</userinput> using the following command: </p>
    1611    <pre xml:space="preserve">VBoxManage controlvm <varname>uuid</varname>|<varname>vmname</varname> addencpassword <varname>ID</varname>
    1712                     <varname>password</varname> [--removeonsuspend yes|no]</pre>

  • trunk/doc/manual/en_US/dita/topics/diskencryption.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to transparently encrypt the data
    9       stored in hard disk images for the guest. It does not depend on a
    10       specific image format to be used. Images which have the data
    11       encrypted are not portable between <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and other
    12       virtualization software.
    13     </p>
    14     <p>
    15       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the AES algorithm in XTS mode and supports
    16       128-bit or 256-bit data encryption keys (DEK). The DEK is stored
    17       encrypted in the medium properties and is decrypted during VM
    18       startup by entering a password which was chosen when the image was
    19       encrypted.
    20     </p>
    21     <p> Since the DEK is stored as part of the VM configuration file, it is important that it is
    22       kept safe. Losing the DEK means that the data stored in the disk images is lost irrecoverably.
    23       Having complete and up-to-date backups of all data related to the VM is the responsibility of
    24       the user. </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to transparently encrypt the data stored in
     8      hard disk images for the guest. It does not depend on a specific image format to be used. Images which have the
     9      data encrypted are not portable between <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and other
     10      virtualization software. </p>
     11    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the AES algorithm in XTS mode and supports 128-bit or
     12      256-bit data encryption keys (DEK). The DEK is stored encrypted in the medium properties and is decrypted during
     13      VM startup by entering a password which was chosen when the image was encrypted. </p>
     14    <p>Since the DEK is stored as part of the VM configuration file, it is important that it is kept safe. Losing the
     15      DEK means that the data stored in the disk images is lost irrecoverably. Having complete and up-to-date backups of
     16      all data related to the VM is the responsibility of the user. </p>
    2517  </body>
    2618</topic>

  • trunk/doc/manual/en_US/dita/topics/gimdebug.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8       This section covers debugging of guest operating systems using
    9       interfaces supported by paravirtualization providers.
    10     </p>
     7    <p>This section covers debugging of guest operating systems using interfaces supported by paravirtualization
     8      providers. </p>
    119    <note>
    12       <p>
    13         Paravirtualized debugging significantly alter guest operating
    14         system behaviour and should only be used by expert users for
    15         debugging and diagnostics.
    16       </p>
     10      <p>Paravirtualized debugging significantly alter guest operating system behaviour and should only be used by
     11        expert users for debugging and diagnostics. </p>
    1712    </note>
    18     <p>
    19       These debug options are specified as a string of key-value pairs
    20       separated by commas. An empty string disables paravirtualized
    21       debugging.
    22     </p>
     13    <p>These debug options are specified as a string of key-value pairs separated by commas. An empty string disables
     14      paravirtualized debugging. </p>
    2315  </body>
    2416</topic>

  • trunk/doc/manual/en_US/dita/topics/gimdebughyperv-windows-setup.dita

    r98549 r105335  
    66 
    77  <body>
    8     <p>
    9           Windows supports debugging over a serial cable, USB, IEEE 1394
    10           Firewire, and Ethernet. USB and IEEE 1394 are not applicable
    11           for virtual machines, and Ethernet requires Windows 8 or
    12           later. While a serial connection is universally usable, it is
    13           slow.
    14         </p>
    15     <p>
    16           Debugging using the Hyper-V debug transport, supported on
    17           Windows Vista and later, offers significant benefits. It
    18           provides excellent performance due to direct host-to-guest
    19           transfers, it is easy to set up and requires minimal support
    20           from the hypervisor. It can be used with the debugger running
    21           on the same host as the VM or with the debugger and VM on
    22           separate machines connected over a network.
    23         </p>
     8    <p>Windows supports debugging over a serial cable, USB, IEEE 1394 Firewire, and Ethernet. USB and IEEE 1394 are not
     9      applicable for virtual machines, and Ethernet requires Windows 8 or later. While a serial connection is
     10      universally usable, it is slow. </p>
     11    <p>Debugging using the Hyper-V debug transport, supported on Windows Vista and later, offers significant benefits.
     12      It provides excellent performance due to direct host-to-guest transfers, it is easy to set up and requires minimal
     13      support from the hypervisor. It can be used with the debugger running on the same host as the VM or with the
     14      debugger and VM on separate machines connected over a network. </p>
    2415    <p>
    2516      <b outputclass="bold">Prerequisites</b>
    … …  
    2718    <ul>
    2819      <li>
    29         <p>
    30               A VM configured for Hyper-V paravirtualization running a
    31               Windows Vista or newer Windows guest. You can check the
    32               effective paravirtualization provider for your VM with the
    33               output of the following <userinput>VBoxManage</userinput>
    34               command:
    35             </p>
     20        <p>A VM configured for Hyper-V paravirtualization running a Windows Vista or newer Windows guest. You can check
     21          the effective paravirtualization provider for your VM with the output of the following
     22            <userinput>VBoxManage</userinput> command: </p>
    3623        <pre xml:space="preserve">$ VBoxManage showvminfo <varname>VM-name</varname>
    3724                           </pre>
    3825      </li>
    3926      <li>
    40         <p>
    41               A sufficiently up-to-date version of the Microsoft WinDbg
    42               debugger required to debug the version of Windows in your
    43               VM.
    44             </p>
     27        <p>A sufficiently up-to-date version of the Microsoft WinDbg debugger required to debug the version of Windows
     28          in your VM. </p>
    4529      </li>
    4630      <li>
    47         <p>
    48               While Windows 8 and newer Windows guests ship with Hyper-V
    49               debug support, Windows 7 and Vista do not. To use Hyper-V
    50               debugging with a Windows 7 or Vista guest, copy the file
    51               <filepath>kdvm.dll</filepath> from a Windows 8.0
    52               installation. This file is typically located in
    53               <filepath>C:\Windows\System32</filepath>. Copy it to the
    54               same location in your Windows 7/Vista guest. Make sure you
    55               copy the 32-bit or 64-bit version of the DLL which matches
    56               your guest OS.
    57             </p>
     31        <p>While Windows 8 and newer Windows guests ship with Hyper-V debug support, Windows 7 and Vista do not. To use
     32          Hyper-V debugging with a Windows 7 or Vista guest, copy the file <filepath>kdvm.dll</filepath> from a Windows
     33          8.0 installation. This file is typically located in <filepath>C:\Windows\System32</filepath>. Copy it to the
     34          same location in your Windows 7/Vista guest. Make sure you copy the 32-bit or 64-bit version of the DLL which
     35          matches your guest OS. </p>
    5836        <note>
    59           <p>
    60                 Only Windows 8.0 ships <filepath>kdvm.dll</filepath>.
    61                 Windows 8.1 and newer Windows versions do not.
    62               </p>
     37          <p>Only Windows 8.0 ships <filepath>kdvm.dll</filepath>. Windows 8.1 and newer Windows versions do not. </p>
    6338        </note>
    6439      </li>
    … …  
    6944    <ol>
    7045      <li>
    71         <p>
    72               Power off the VM.
    73             </p>
     46        <p>Power off the VM. </p>
    7447      </li>
    7548      <li>
    76         <p>
    77               Enable the debug options with the following
    78               <userinput>VBoxManage</userinput> command:
    79             </p>
     49        <p>Enable the debug options with the following <userinput>VBoxManage</userinput> command: </p>
    8050        <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --paravirt-debug "enabled=1"</pre>
    81         <p>
    82               The above command assumes your debugger will connect to
    83               your host machine on UDP port 50000. However, if you need
    84               to run the debugger on a remote machine you may specify
    85               the remote address and port here. For example:
    86             </p>
     51        <p>The above command assumes your debugger will connect to your host machine on UDP port 50000. However, if you
     52          need to run the debugger on a remote machine you may specify the remote address and port here. For example: </p>
    8753        <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> \
    8854--paravirt-debug "enabled=1,address=192.168.32.1,port=55000"</pre>
    89         <p>
    90               See <xref href="gimdebughyperv.dita#gimdebughyperv"/> for the complete set
    91               of options.
    92             </p>
     55        <p>See <xref href="gimdebughyperv.dita#gimdebughyperv"/> for the complete set of options. </p>
    9356      </li>
    9457      <li>
    95         <p>
    96               Start the VM.
    97             </p>
     58        <p>Start the VM. </p>
    9859      </li>
    9960      <li>
    100         <p>
    101               In the guest, start an elevated command prompt and execute
    102               the following commands:
    103             </p>
     61        <p>In the guest, start an elevated command prompt and execute the following commands: </p>
    10462        <ul>
    10563          <li>
    106             <p>
    107                   For a Windows 8 or newer Windows guest:
    108                 </p>
     64            <p>For a Windows 8 or newer Windows guest: </p>
    10965            <pre xml:space="preserve">bcdedit /dbgsettings net hostip:5.5.5.5 port:50000 key:1.2.3.4</pre>
    11066          </li>
    11167          <li>
    112             <p>
    113                   For a Windows 7 or Vista guest:
    114                 </p>
     68            <p>For a Windows 7 or Vista guest: </p>
    11569            <pre xml:space="preserve">bcdedit /set loadoptions host_ip=5.5.5.5,host_port=50000,encryption_key=1.2.3.4</pre>
    11670            <pre xml:space="preserve">bcdedit /set dbgtransport kdvm.dll</pre>
    117             <p>
    118                   The IP address and port in the
    119                   <userinput>bcdedit</userinput> command are ignored when
    120                   using the Hyper-V debug transport. Any valid IP and a
    121                   port number greater than 49151 and lower than 65536
    122                   can be entered.
    123                 </p>
    124             <p>
    125                   The encryption key in the <userinput>bcdedit</userinput>
    126                   command is relevant and must be valid. The key
    127                   "1.2.3.4" used in the above example is valid and may
    128                   be used if security is not a concern. If you do not
    129                   specify any encryption key, <userinput>bcdedit</userinput>
    130                   will generate one for you and you will need to copy
    131                   this key to later enter in Microsoft WinDbg on the
    132                   remote end. This encryption key is used to encrypt the
    133                   debug data exchanged between Windows and the debugger.
    134                 </p>
     71            <p>The IP address and port in the <userinput>bcdedit</userinput> command are ignored when using the Hyper-V
     72              debug transport. Any valid IP and a port number greater than 49151 and lower than 65536 can be entered. </p>
     73            <p>The encryption key in the <userinput>bcdedit</userinput> command is relevant and must be valid. The key
     74              "1.2.3.4" used in the above example is valid and may be used if security is not a concern. If you do not
     75              specify any encryption key, <userinput>bcdedit</userinput> will generate one for you and you will need to
     76              copy this key to later enter in Microsoft WinDbg on the remote end. This encryption key is used to encrypt
     77              the debug data exchanged between Windows and the debugger. </p>
    13578          </li>
    13679          <li>
    137             <p>
    138                   Run one or more of the following commands to enable
    139                   debugging for the appropriate phase or component of
    140                   your Windows guest:
    141                 </p>
     80            <p>Run one or more of the following commands to enable debugging for the appropriate phase or component of
     81              your Windows guest: </p>
    14282            <pre xml:space="preserve">bcdedit /set debug on</pre>
    14383            <pre xml:space="preserve">bcdedit /set bootdebug on</pre>
    14484            <pre xml:space="preserve">bcdedit /set {bootmgr} bootdebug on</pre>
    145             <p>
    146                   Please note that the <userinput>bootdebug</userinput>
    147                   options are only effective on Windows 8 or newer when
    148                   using the Hyper-V debug transport. Refer to Microsoft
    149                   Windows documentation for detailed explanation of
    150                   <userinput>bcdedit</userinput> options.
    151                 </p>
     85            <p>Please note that the <userinput>bootdebug</userinput> options are only effective on Windows 8 or newer
     86              when using the Hyper-V debug transport. Refer to Microsoft Windows documentation for detailed explanation
     87              of <userinput>bcdedit</userinput> options. </p>
    15288          </li>
    15389        </ul>
    15490      </li>
    15591      <li>
    156         <p>
    157               Start Microsoft WinDbg on your host machine or remote
    158               host.
    159             </p>
    160         <p>
    161               From the <b outputclass="bold">File</b> menu,
    162               select <b outputclass="bold">Kernel Debug</b>. On
    163               the <b outputclass="bold">NET</b> tab, specify the
    164               UDP port number you used in the
    165               <codeph>paravirtdebug</codeph> options. If you did not
    166               specify any, leave it as 50000. Ensure that the UDP port
    167               is not blocked by a firewall or other security software.
    168             </p>
    169         <p>
    170               In the <b outputclass="bold">Key</b> field, enter
    171               <codeph>1.2.3.4</codeph> or the encryption key from the
    172               <userinput>bcdedit</userinput> command in your Windows guest.
    173             </p>
    174         <p>
    175               Click <b outputclass="bold">OK</b> to start
    176               listening for connections. Microsoft WinDbg typically
    177               shows a Waiting to Reconnect message during this phase.
    178             </p>
    179         <p>
    180               Alternatively, to directly start a debug session, run
    181               WinDbg from the command line as follows :
    182             </p>
     92        <p>Start Microsoft WinDbg on your host machine or remote host. </p>
     93        <p>From the <b outputclass="bold">File</b> menu, select <b outputclass="bold">Kernel Debug</b>. On the <b
     94            outputclass="bold">NET</b> tab, specify the UDP port number you used in the <codeph>paravirtdebug</codeph>
     95          options. If you did not specify any, leave it as 50000. Ensure that the UDP port is not blocked by a firewall
     96          or other security software. </p>
     97        <p>In the <b outputclass="bold">Key</b> field, enter <codeph>1.2.3.4</codeph> or the encryption key from the
     98            <userinput>bcdedit</userinput> command in your Windows guest. </p>
     99        <p>Click <b outputclass="bold">OK</b> to start listening for connections. Microsoft WinDbg typically shows a
     100          Waiting to Reconnect message during this phase. </p>
     101        <p>Alternatively, to directly start a debug session, run WinDbg from the command line as follows : </p>
    183102        <pre xml:space="preserve">windbg.exe -k net:port=50000,key=1.2.3.4</pre>
    184         <p>
    185               See the WinDbg documentation for the complete command line
    186               syntax.
    187             </p>
     103        <p>See the WinDbg documentation for the complete command line syntax. </p>
    188104      </li>
    189105      <li>
    190         <p>
    191               Reboot your Windows guest and it should then connect as a
    192               debuggee with Microsoft WinDbg.
    193             </p>
     106        <p>Reboot your Windows guest and it should then connect as a debuggee with Microsoft WinDbg. </p>
    194107      </li>
    195108    </ol>

  • trunk/doc/manual/en_US/dita/topics/gimdebughyperv.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         All of the options listed below are optional, and thus the
    9         default value specified will be used when the corresponding
    10         key-value pair is not specified.
    11       </p>
     7    <p>All of the options listed below are optional, and thus the default value specified will be used when the
     8            corresponding key-value pair is not specified. </p>
    129    <ul>
    1310      <li>
    14         <p>
    15             Key:
    16             <b outputclass="bold"><codeph>enabled</codeph></b>
     11        <p>Key: <b outputclass="bold"><codeph>enabled</codeph></b>
    1712                        </p>
    18         <p>
    19             Value: <codeph>0</codeph> or <codeph>1</codeph>
     13        <p>Value: <codeph>0</codeph> or <codeph>1</codeph>
    2014                        </p>
    21         <p>
    22             Default: <codeph>0</codeph>
     15        <p>Default: <codeph>0</codeph>
    2316                        </p>
    24         <p>
    25             Specify <codeph>1</codeph> to enable the Hyper-V debug
    26             interface. If this key-value pair is not specified or the
    27             value is not <codeph>1</codeph>, the Hyper-V debug
    28             interface is disabled regardless of other key-value pairs
    29             being present.
    30           </p>
     17        <p>Specify <codeph>1</codeph> to enable the Hyper-V debug interface. If this key-value pair is not specified or
     18                    the value is not <codeph>1</codeph>, the Hyper-V debug interface is disabled regardless of other
     19                    key-value pairs being present. </p>
    3120      </li>
    3221      <li>
    33         <p>
    34             Key:
    35             <b outputclass="bold"><codeph>address</codeph></b>
     22        <p>Key: <b outputclass="bold"><codeph>address</codeph></b>
    3623                        </p>
    37         <p>
    38             Value: IPv4 address
    39           </p>
    40         <p>
    41             Default: 127.0.0.1
    42           </p>
    43         <p>
    44             Specify the IPv4 address where the remote debugger is
    45             connected.
    46           </p>
     24        <p>Value: IPv4 address </p>
     25        <p>Default: 127.0.0.1 </p>
     26        <p>Specify the IPv4 address where the remote debugger is connected. </p>
    4727      </li>
    4828      <li>
    49         <p>
    50             Key:
    51             <b outputclass="bold"><codeph>port</codeph></b>
     29        <p>Key: <b outputclass="bold"><codeph>port</codeph></b>
    5230                        </p>
    53         <p>
    54             Value: UDP port number
    55           </p>
    56         <p>
    57             Default: 50000
    58           </p>
    59         <p>
    60             Specify the UDP port number where the remote debugger is
    61             connected.
    62           </p>
     31        <p>Value: UDP port number </p>
     32        <p>Default: 50000 </p>
     33        <p>Specify the UDP port number where the remote debugger is connected. </p>
    6334      </li>
    6435      <li>
    65         <p>
    66             Key:
    67             <b outputclass="bold"><codeph>vendor</codeph></b>
     36        <p>Key: <b outputclass="bold"><codeph>vendor</codeph></b>
    6837                        </p>
    69         <p>
    70             Value: Hyper-V vendor signature reported by CPUID to the
    71             guest
     38        <p>Value: Hyper-V vendor signature reported by CPUID to the guest </p>
     39        <p>Default: When debugging is enabled: <codeph>Microsoft Hv</codeph>, otherwise: <codeph>VBoxVBoxVBox</codeph>
    7240          </p>
    73         <p>
    74             Default: When debugging is enabled: <codeph>Microsoft
    75             Hv</codeph>, otherwise: <codeph>VBoxVBoxVBox</codeph>
    76                         </p>
    77         <p>
    78             Specify the Hyper-V vendor signature which is exposed to the
    79             guest by CPUID. For debugging Microsoft Windows guests, it
    80             is required the hypervisor reports the Microsoft vendor.
    81           </p>
     41        <p>Specify the Hyper-V vendor signature which is exposed to the guest by CPUID. For debugging Microsoft Windows
     42                    guests, it is required the hypervisor reports the Microsoft vendor. </p>
    8243      </li>
    8344      <li>
    84         <p>
    85             Key:
    86             <b outputclass="bold"><codeph>hypercallinterface</codeph></b>
     45        <p>Key: <b outputclass="bold"><codeph>hypercallinterface</codeph></b>
    8746                        </p>
    88         <p>
    89             Value: <codeph>0</codeph> or <codeph>1</codeph>
     47        <p>Value: <codeph>0</codeph> or <codeph>1</codeph>
    9048                        </p>
    91         <p>
    92             Default: <codeph>0</codeph>
     49        <p>Default: <codeph>0</codeph>
    9350                        </p>
    94         <p>
    95             Specify whether hypercalls should be suggested for
    96             initiating debug data transfers between host and guest
    97             rather than MSRs when requested by the guest.
    98           </p>
     51        <p>Specify whether hypercalls should be suggested for initiating debug data transfers between host and guest
     52                    rather than MSRs when requested by the guest. </p>
    9953      </li>
    10054      <li>
    101         <p>
    102             Key: <b outputclass="bold"><codeph>vsinterface</codeph></b>
     55        <p>Key: <b outputclass="bold"><codeph>vsinterface</codeph></b>
    10356                        </p>
    104         <p>
    105             Value: <codeph>0</codeph> or <codeph>1</codeph>
     57        <p>Value: <codeph>0</codeph> or <codeph>1</codeph>
    10658                        </p>
    107         <p>
    108             Default: When debugging is enabled, <codeph>1</codeph>,
    109             otherwise <codeph>0</codeph>
     59        <p>Default: When debugging is enabled, <codeph>1</codeph>, otherwise <codeph>0</codeph>
    11060                        </p>
    111         <p>
    112             Specify whether to expose the VS#1 virtualization service
    113             interface to the guest. This interface is required for
    114             debugging Microsoft Windows 10 32-bit guests, but is
    115             optional for other Windows versions.
    116           </p>
     61        <p>Specify whether to expose the VS#1 virtualization service interface to the guest. This interface is required
     62                    for debugging Microsoft Windows 10 32-bit guests, but is optional for other Windows versions. </p>
    11763      </li>
    11864    </ul>

  • trunk/doc/manual/en_US/dita/topics/guestadd-clipboard.dita

    r105134 r105335  
    66  <body>
    77    <!-- 7.1: Shared clipboard check box; clarify operation with dev -->
    8     <p>
    9       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to copy clipboard content from the host
    10       to the guest, and vice versa. For this to work the latest version
    11       of the Guest Additions must be installed on the guest.
    12     </p>   
    13     <p>
    14       To use the <userinput>VBoxManage</userinput> command to control the
    15       current clipboard mode, see <xref href="vboxmanage.dita#vboxmanage"/>. The
    16       <userinput>modifyvm</userinput> and <userinput>controlvm</userinput>
    17       commands enable setting of a VM's current clipboard mode from
    18       the command line.
    19     </p>
     8    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to copy clipboard content from the host to the
     9      guest, and vice versa. For this to work the latest version of the Guest Additions must be installed on the
     10      guest.</p>   
     11    <p>To use the <userinput>VBoxManage</userinput> command to control the current clipboard mode, see <xref
     12        href="vboxmanage.dita#vboxmanage"/>. The <userinput>modifyvm</userinput> and <userinput>controlvm</userinput>
     13      commands enable setting of a VM's current clipboard mode from the command line.</p>
    2014  </body>
    2115</topic>

  • trunk/doc/manual/en_US/dita/topics/guestxorgsetup.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         This section assumes that you are familiar with configuring the
    9         X.Org server using xorg.conf and optionally the newer mechanisms
    10         using hal or udev and xorg.conf.d. If not you can learn about
    11         them by studying the documentation which comes with X.Org.
     7    <p>This section assumes that you are familiar with configuring the X.Org server using xorg.conf and optionally the
     8      newer mechanisms using hal or udev and xorg.conf.d. If not you can learn about them by studying the documentation
     9      which comes with X.Org. </p>
     10    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions includes drivers for X.Org. By default
     11      these drivers are in the following directory: </p>
     12    <p><filepath>/opt/VBoxGuestAdditions-<varname>version</varname>/other/</filepath>
    1213      </p>
    13     <p>
    14         The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions includes drivers for X.Org.
    15         By default these drivers are in the following directory:
    16       </p>
    17     <p>
    18       <filepath>/opt/VBoxGuestAdditions-<varname>version</varname>/other/</filepath>
    19     </p>
    20     <p>
    21         The correct versions for the X server are symbolically linked
    22         into the X.Org driver directories.
    23       </p>
    24     <p>
    25         For graphics integration to work correctly, the X server must
    26         load the <codeph>vboxvideo</codeph> driver. Many recent X
    27         server versions look for it automatically if they see that they
    28         are running in <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. For an optimal user experience,
    29         the guest kernel drivers must be loaded and the Guest Additions
    30         tool <userinput>VBoxClient</userinput> must be running as a client
    31         in the X session.
    32       </p>
    33     <p>
    34         For mouse integration to work correctly, the guest kernel
    35         drivers must be loaded. In addition, for legacy X servers the
    36         correct <codeph>vboxmouse</codeph> driver must be loaded and
    37         associated with <filepath>/dev/mouse</filepath> or
    38         <filepath>/dev/psaux</filepath>. For most guests, a driver for a
    39         PS/2 mouse must be loaded and the correct vboxmouse driver must
    40         be associated with <filepath>/dev/vboxguest</filepath>.
    41       </p>
    42     <p>
    43         The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guest graphics driver can use any graphics
    44         configuration for which the virtual resolution fits into the
    45         virtual video memory allocated to the virtual machine, minus a
    46         small amount used by the guest driver, as described in
    47         <xref href="settings-display.dita">Display Settings</xref>. The driver will offer a
    48         range of standard modes at least up to the default guest
    49         resolution for all active guest monitors. The default mode can
    50         be changed by setting the output property VBOX_MODE to
    51         "&lt;width&gt;x&lt;height&gt;" for any guest monitor. When
    52         VBoxClient and the kernel drivers are active this is done
    53         automatically when the host requests a mode change. The driver
    54         for older versions can only receive new modes by querying the
    55         host for requests at regular intervals.
    56       </p>
    57     <p>
    58         With legacy X Servers before version 1.3, you can also add your
    59         own modes to the X server configuration file. Add them to the
    60         "Modes" list in the "Display" subsection of the "Screen"
    61         section. For example, the following section has a custom
    62         2048x800 resolution mode added:
    63       </p>
     14    <p>The correct versions for the X server are symbolically linked into the X.Org driver directories. </p>
     15    <p>For graphics integration to work correctly, the X server must load the <codeph>vboxvideo</codeph> driver. Many
     16      recent X server versions look for it automatically if they see that they are running in <ph
     17        conkeyref="vbox-conkeyref-phrases/product-name"/>. For an optimal user experience, the guest kernel drivers must
     18      be loaded and the Guest Additions tool <userinput>VBoxClient</userinput> must be running as a client in the X
     19      session. </p>
     20    <p>For mouse integration to work correctly, the guest kernel drivers must be loaded. In addition, for legacy X
     21      servers the correct <codeph>vboxmouse</codeph> driver must be loaded and associated with
     22        <filepath>/dev/mouse</filepath> or <filepath>/dev/psaux</filepath>. For most guests, a driver for a PS/2 mouse
     23      must be loaded and the correct vboxmouse driver must be associated with <filepath>/dev/vboxguest</filepath>. </p>
     24    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guest graphics driver can use any graphics
     25      configuration for which the virtual resolution fits into the virtual video memory allocated to the virtual
     26      machine, minus a small amount used by the guest driver, as described in <xref href="settings-display.dita">Display
     27        Settings</xref>. The driver will offer a range of standard modes at least up to the default guest resolution for
     28      all active guest monitors. The default mode can be changed by setting the output property VBOX_MODE to
     29      "&lt;width&gt;x&lt;height&gt;" for any guest monitor. When VBoxClient and the kernel drivers are active this is
     30      done automatically when the host requests a mode change. The driver for older versions can only receive new modes
     31      by querying the host for requests at regular intervals. </p>
     32    <p>With legacy X Servers before version 1.3, you can also add your own modes to the X server configuration file. Add
     33      them to the "Modes" list in the "Display" subsection of the "Screen" section. For example, the following section
     34      has a custom 2048x800 resolution mode added: </p>
    6435    <pre xml:space="preserve">Section "Screen"
    6536        Identifier    "Default Screen"

  • trunk/doc/manual/en_US/dita/topics/guru-meditation-action.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         A VM runs into a Guru Meditation if there is a problem which
    9         cannot be fixed by other means than terminating the process. The
    10         default is to show a message window which instructs the user to
    11         open a bug report.
    12       </p>
    13     <p>
    14         This behavior can be configured as follows:
    15       </p>
     7    <p>A VM runs into a Guru Meditation if there is a problem which cannot be fixed by other means than terminating the
     8      process. The default is to show a message window which instructs the user to open a bug report. </p>
     9    <p>This behavior can be configured as follows: </p>
    1610    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> GUI/GuruMeditationHandler <varname>mode</varname>
    1711                  </pre>
    … …  
    2418        </dt>
    2519        <dd>
    26           <p>
    27               A message window is shown. After the user confirmed, the
    28               VM is terminated.
    29             </p>
     20          <p>A message window is shown. After the user confirmed, the VM is terminated. </p>
    3021        </dd>
    3122      </dlentry>
    … …  
    3526        </dt>
    3627        <dd>
    37           <p>
    38               The VM is immediately powered-off without showing any
    39               message window. The VM logfile will show information about
    40               what happened.
    41             </p>
     28          <p>The VM is immediately powered-off without showing any message window. The VM logfile will show information
     29            about what happened. </p>
    4230        </dd>
    4331      </dlentry>
    … …  
    4735        </dt>
    4836        <dd>
    49           <p>
    50               The VM is left in stuck mode. Execution is stopped but no
    51               message window is shown. The VM has to be powered off
    52               manually.
    53             </p>
     37          <p>The VM is left in stuck mode. Execution is stopped but no message window is shown. The VM has to be powered
     38            off manually. </p>
    5439        </dd>
    5540      </dlentry>
    5641    </dl>
    57     <p>
    58         This is a per-VM setting.
    59       </p>
     42    <p>This is a per-VM setting. </p>
    6043  </body>
    6144 

  • trunk/doc/manual/en_US/dita/topics/harddiskcontrollers.dita

    r105303 r105335  
    55 
    66  <body>
    7     <p>
    8       In a computing device, hard disks and CD/DVD drives are connected
    9       to a device called a hard disk controller, which drives hard disk
    10       operation and data transfers. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can emulate the most
    11       common types of hard disk controllers typically found in computing
    12       devices: IDE, SATA (AHCI), SCSI, SAS, USB-based, NVMe and
    13       virtio-scsi mass storage devices.
    14     </p>
     7    <p>In a computing device, hard disks and CD/DVD drives are connected to a device called a hard disk controller,
     8      which drives hard disk operation and data transfers. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can
     9      emulate the most common types of hard disk controllers typically found in computing devices: IDE, SATA (AHCI),
     10      SCSI, SAS, USB-based, NVMe and virtio-scsi mass storage devices. </p>
    1511    <ul>
    1612      <li>
    … …  
    2319          a result, support for up to four IDE devices was most common: primary device 0, primary
    2420          device 1, secondary device 0, and secondary device 1. </p>
    25         <p>
    26           In <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, each virtual machine may have one IDE
    27           controller enabled, which gives you up to four virtual storage
    28           devices that you can attach to the machine. By default, one of
    29           these virtual storage devices, device 0 on the secondary
    30           channel, is preconfigured to be the virtual machine's virtual
    31           CD/DVD drive. However, you can change the default setting.
    32         </p>
    33         <p>
    34           Even if your guest OS has no support for SCSI or SATA devices,
    35           it should always be able to see an IDE controller.
    36         </p>
    37         <p>
    38           You can also select which exact type of IDE controller
    39           hardware <ph conkeyref="vbox-conkeyref-phrases/product-name"/> should present to the virtual machine:
    40           PIIX3, PIIX4, or ICH6. This makes no difference in terms of
    41           performance, but if you import a virtual machine from another
    42           virtualization product, the OS in that machine may expect a
    43           particular controller type and crash if it is not found.
    44         </p>
    45         <p>
    46           After you have created a new virtual machine with the
    47           <b outputclass="bold">New Virtual Machine</b> wizard in
     21        <p>In <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, each virtual machine may have one IDE controller
     22          enabled, which gives you up to four virtual storage devices that you can attach to the machine. By default,
     23          one of these virtual storage devices, device 0 on the secondary channel, is preconfigured to be the virtual
     24          machine's virtual CD/DVD drive. However, you can change the default setting. </p>
     25        <p>Even if your guest OS has no support for SCSI or SATA devices, it should always be able to see an IDE
     26          controller. </p>
     27        <p>You can also select which exact type of IDE controller hardware <ph
     28            conkeyref="vbox-conkeyref-phrases/product-name"/> should present to the virtual machine: PIIX3, PIIX4, or
     29          ICH6. This makes no difference in terms of performance, but if you import a virtual machine from another
     30          virtualization product, the OS in that machine may expect a particular controller type and crash if it is not
     31          found. </p>
     32        <p>After you have created a new virtual machine with the <b outputclass="bold">New Virtual Machine</b> wizard in
    4833          <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, you will typically see one IDE controller in the
    49           machine's <b outputclass="bold">Storage</b> settings.
    50           The virtual CD/DVD drive will be attached to one of the four
    51           ports of this controller.
    52         </p>
     34          machine's <b outputclass="bold">Storage</b> settings. The virtual CD/DVD drive will be attached to one of the
     35          four ports of this controller. </p>
    5336      </li>
    5437      <li>
    … …  
    6043          is called Advanced Host Controller Interface (AHCI).
    6144        </p>
    62         <p>
    63           Like a real SATA controller, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s virtual SATA
    64           controller operates faster and also consumes fewer CPU
    65           resources than the virtual IDE controller. Also, this enables
    66           you to connect up to 30 virtual hard disks to one machine
    67           instead of just three, when compared to the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> IDE
    68           controller with a DVD drive attached.
    69         </p>
     45        <p>Like a real SATA controller, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s virtual SATA controller
     46          operates faster and also consumes fewer CPU resources than the virtual IDE controller. Also, this enables you
     47          to connect up to 30 virtual hard disks to one machine instead of just three, when compared to the <ph
     48            conkeyref="vbox-conkeyref-phrases/product-name"/> IDE controller with a DVD drive attached. </p>
    7049        <p>
    7150          For this reason, depending on the selected guest OS,
    … …  
    7655        </p>
    7756        <note>
    78           <p>
    79             The entire SATA controller and the virtual disks attached to
    80             it, including those in IDE compatibility mode, will not be
    81             seen by OSes that do not have device support for AHCI. In
    82             particular, <i>there is no support for AHCI in
    83             Windows versions before Windows Vista</i>. Legacy
    84             Windows versions such as Windows XP, even with SP3
    85             installed, will not see such disks unless you install
    86             additional drivers. It is possible to switch from IDE to
    87             SATA after installation by installing the SATA drivers and
    88             changing the controller type in the VM
    89             <b outputclass="bold">Settings</b> window.
    90           </p>
    91           <p>
    92             <ph conkeyref="vbox-conkeyref-phrases/product-name"/> recommends the Intel Matrix Storage drivers,
    93             which can be downloaded from
    94             <ph>http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101</ph>.
    95           </p>
     57          <p>The entire SATA controller and the virtual disks attached to it, including those in IDE compatibility mode,
     58            will not be seen by OSes that do not have device support for AHCI. In particular, <i>there is no support for
     59              AHCI in Windows versions before Windows Vista</i>. Legacy Windows versions such as Windows XP, even with
     60            SP3 installed, will not see such disks unless you install additional drivers. It is possible to switch from
     61            IDE to SATA after installation by installing the SATA drivers and changing the controller type in the VM <b
     62              outputclass="bold">Settings</b> window. </p>
     63          <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> recommends the Intel Matrix Storage drivers, which
     64            can be downloaded from <ph>http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101</ph>. </p>
    9665        </note>
    97         <p>
    98           To add a SATA controller to a machine for which it has not
    99           been enabled by default, either because it was created by an
    100           earlier version of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, or because SATA is not
    101           supported by default by the selected guest OS, do the
    102           following. Go to the <b outputclass="bold">Storage</b>
    103           page of the machine's
    104           <b outputclass="bold">Settings</b> window, click
    105           <b outputclass="bold">Add Controller</b> under the
    106           Storage Tree box and then select <b outputclass="bold">Add
    107           SATA Controller</b>. The new controller appears as a
    108           separate PCI device in the virtual machine, and you can add
    109           virtual disks to it.
    110         </p>
     66        <p>To add a SATA controller to a machine for which it has not been enabled by default, either because it was
     67          created by an earlier version of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, or because SATA is not
     68          supported by default by the selected guest OS, do the following. Go to the <b outputclass="bold">Storage</b>
     69          page of the machine's <b outputclass="bold">Settings</b> window, click <b outputclass="bold">Add
     70            Controller</b> under the Storage Tree box and then select <b outputclass="bold">Add SATA Controller</b>. The
     71          new controller appears as a separate PCI device in the virtual machine, and you can add virtual disks to it. </p>
    11172        <p> To change the IDE compatibility mode settings for the SATA controller, see <xref
    11273            href="vboxmanage-storagectl.dita"/>. </p>
    … …  
    12283          servers.
    12384        </p>
    124         <p>
    125           Primarily for compatibility with other virtualization
    126           software, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> optionally supports LSI Logic and
    127           BusLogic SCSI controllers, to each of which up to fifteen
    128           virtual hard disks can be attached.
    129         </p>
    130         <p>
    131           To enable a SCSI controller, on the
    132           <b outputclass="bold">Storage</b> page of a virtual
    133           machine's <b outputclass="bold">Settings</b> window,
    134           click <b outputclass="bold">Add Controller</b> under
    135           the Storage Tree box and then select <b outputclass="bold">Add
    136           SCSI Controller</b>. The new controller appears as a
    137           separate PCI device in the virtual machine.
    138         </p>
     85        <p>Primarily for compatibility with other virtualization software, <ph
     86            conkeyref="vbox-conkeyref-phrases/product-name"/> optionally supports LSI Logic and BusLogic SCSI
     87          controllers, to each of which up to fifteen virtual hard disks can be attached. </p>
     88        <p>To enable a SCSI controller, on the <b outputclass="bold">Storage</b> page of a virtual machine's <b
     89            outputclass="bold">Settings</b> window, click <b outputclass="bold">Add Controller</b> under the Storage
     90          Tree box and then select <b outputclass="bold">Add SCSI Controller</b>. The new controller appears as a
     91          separate PCI device in the virtual machine. </p>
    13992        <note>
    140           <p>
    141             As with the other controller types, a SCSI controller will
    142             only be seen by OSes with device support for it. Windows
    143             2003 and later ships with drivers for the LSI Logic
    144             controller, while Windows NT 4.0 and Windows 2000 ships with
    145             drivers for the BusLogic controller. Windows XP ships with
    146             drivers for neither.
    147           </p>
     93          <p>As with the other controller types, a SCSI controller will only be seen by OSes with device support for it.
     94            Windows 2003 and later ships with drivers for the LSI Logic controller, while Windows NT 4.0 and Windows
     95            2000 ships with drivers for the BusLogic controller. Windows XP ships with drivers for neither. </p>
    14896        </note>
    14997      </li>
    … …  
    156104          is to IDE: it enables more reliable and faster connections.
    157105        </p>
    158         <p>
    159           To support high-end guests which require SAS controllers,
    160           <ph conkeyref="vbox-conkeyref-phrases/product-name"/> emulates a LSI Logic SAS controller, which can
    161           be enabled much the same way as a SCSI controller. At this
    162           time, up to 255 devices can be connected to the SAS
    163           controller.
    164         </p>
     106        <p>To support high-end guests which require SAS controllers, <ph conkeyref="vbox-conkeyref-phrases/product-name"
     107          /> emulates a LSI Logic SAS controller, which can be enabled much the same way as a SCSI controller. At this
     108          time, up to 255 devices can be connected to the SAS controller. </p>
    165109        <note>
    166           <p>
    167             As with SATA, the SAS controller will only be seen by OSes
    168             with device support for it. In particular, <i>there
    169             is no support for SAS in Windows before Windows
    170             Vista</i>. So Windows XP, even SP3, will not see such
    171             disks unless you install additional drivers.
    172           </p>
     110          <p>As with SATA, the SAS controller will only be seen by OSes with device support for it. In particular,
     111              <i>there is no support for SAS in Windows before Windows Vista</i>. So Windows XP, even SP3, will not see
     112            such disks unless you install additional drivers. </p>
    173113        </note>
    174114      </li>
    175115      <li>
    176         <p>
    177           The <b outputclass="bold">USB mass storage device
    178           class</b> is a standard to connect external storage
    179           devices like hard disks or flash drives to a host through USB.
    180           All major OSes support these devices and ship generic drivers
    181           making third-party drivers superfluous. In particular, legacy
    182           OSes without support for SATA controllers may benefit from USB
    183           mass storage devices.
    184         </p>
    185         <p>
    186           The virtual USB storage controller offered by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    187           works differently to the other storage controller types. While
    188           most storage controllers appear as a single PCI device to the
    189           guest with multiple disks attached to it, the USB-based
    190           storage controller does not appear as virtual storage
    191           controller. Each disk attached to the controller appears as a
    192           dedicated USB device to the guest.
    193         </p>
     116        <p>The <b outputclass="bold">USB mass storage device class</b> is a standard to connect external storage devices
     117          like hard disks or flash drives to a host through USB. All major OSes support these devices and ship generic
     118          drivers making third-party drivers superfluous. In particular, legacy OSes without support for SATA
     119          controllers may benefit from USB mass storage devices. </p>
     120        <p>The virtual USB storage controller offered by <ph conkeyref="vbox-conkeyref-phrases/product-name"/> works
     121          differently to the other storage controller types. While most storage controllers appear as a single PCI
     122          device to the guest with multiple disks attached to it, the USB-based storage controller does not appear as
     123          virtual storage controller. Each disk attached to the controller appears as a dedicated USB device to the
     124          guest. </p>
    194125        <note>
    195           <p>
    196             Booting from drives attached using USB is only supported
    197             when EFI is used as the BIOS lacks USB support.
    198           </p>
     126          <p>Booting from drives attached using USB is only supported when EFI is used as the BIOS lacks USB support. </p>
    199127        </note>
    200128      </li>
    … …  
    211139          update.
    212140        </p>
    213         <p>
    214           The NVMe controller is part of the extension pack.
    215         </p>
     141        <p>The NVMe controller is part of the extension pack. </p>
    216142        <note>
    217           <p>
    218             Booting from drives attached using NVMe is only supported
    219             when EFI is used as the BIOS lacks the appropriate driver.
    220           </p>
     143          <p>Booting from drives attached using NVMe is only supported when EFI is used as the BIOS lacks the
     144            appropriate driver. </p>
    221145        </note>
    222146      </li>
    … …  
    229153        </p>
    230154        <note>
    231           <p>
    232             The virtio-scsi controller will only be seen by OSes with
    233             device support for it. In particular, <i>there is no
    234             built-in support in Windows</i>. So Windows will not
    235             see such disks unless you install additional drivers.
    236           </p>
     155          <p>The virtio-scsi controller will only be seen by OSes with device support for it. In particular, <i>there is
     156              no built-in support in Windows</i>. So Windows will not see such disks unless you install additional
     157            drivers. </p>
    237158        </note>
    238159      </li>
    239160    </ul>
    240     <p>
    241       In summary, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> gives you the following categories of
    242       virtual storage slots:
    243     </p>
     161    <p>In summary, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> gives you the following categories of virtual
     162      storage slots: </p>
    244163    <ul>
    245164      <li>
    246         <p>
    247           Four slots attached to the traditional IDE controller, which
    248           are always present. One of these is typically a virtual CD/DVD
    249           drive.
    250         </p>
     165        <p>Four slots attached to the traditional IDE controller, which are always present. One of these is typically a
     166          virtual CD/DVD drive. </p>
    251167      </li>
    252168      <li>
    253         <p>
    254           30 slots attached to the SATA controller, if enabled and
    255           supported by the guest OS.
    256         </p>
     169        <p>30 slots attached to the SATA controller, if enabled and supported by the guest OS. </p>
    257170      </li>
    258171      <li>
    259         <p>
    260           15 slots attached to the SCSI controller, if enabled and
    261           supported by the guest OS.
    262         </p>
     172        <p>15 slots attached to the SCSI controller, if enabled and supported by the guest OS. </p>
    263173      </li>
    264174      <li>
    265         <p>
    266           Up to 255 slots attached to the SAS controller, if enabled and
    267           supported by the guest OS.
    268         </p>
     175        <p>Up to 255 slots attached to the SAS controller, if enabled and supported by the guest OS. </p>
    269176      </li>
    270177      <li>
    271         <p>
    272           Eight slots attached to the virtual USB controller, if enabled
    273           and supported by the guest OS.
    274         </p>
     178        <p>Eight slots attached to the virtual USB controller, if enabled and supported by the guest OS. </p>
    275179      </li>
    276180      <li>
    277         <p>
    278           Up to 255 slots attached to the NVMe controller, if enabled
    279           and supported by the guest OS.
    280         </p>
     181        <p>Up to 255 slots attached to the NVMe controller, if enabled and supported by the guest OS. </p>
    281182      </li>
    282183      <li>
    283         <p>
    284           Up to 256 slots attached to the virtio-scsi controller, if
    285           enabled and supported by the guest OS.
    286         </p>
     184        <p>Up to 256 slots attached to the virtio-scsi controller, if enabled and supported by the guest OS. </p>
    287185      </li>
    288186    </ul>
    289     <p>
    290       Given this large choice of storage controllers, you may not know
    291       which one to choose. In general, you should avoid IDE unless it is
    292       the only controller supported by your guest. Whether you use SATA,
    293       SCSI, or SAS does not make any real difference. The variety of
    294       controllers is only supplied by <ph conkeyref="vbox-conkeyref-phrases/product-name"/> for compatibility
    295       with existing hardware and other hypervisors.
    296     </p>
     187    <p>Given this large choice of storage controllers, you may not know which one to choose. In general, you should
     188      avoid IDE unless it is the only controller supported by your guest. Whether you use SATA, SCSI, or SAS does not
     189      make any real difference. The variety of controllers is only supplied by <ph
     190        conkeyref="vbox-conkeyref-phrases/product-name"/> for compatibility with existing hardware and other
     191      hypervisors. </p>
    297192  </body>
    298193 

  • trunk/doc/manual/en_US/dita/topics/hdimagewrites.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       For each virtual disk image supported by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you can
    9       determine separately how it should be affected by write operations
    10       from a virtual machine and snapshot operations. This applies to
    11       all of the aforementioned image formats (VDI, VMDK, VHD, or HDD)
    12       and irrespective of whether an image is fixed-size or dynamically
    13       allocated.
    14     </p>
    15     <p> By default, images are in <i>normal</i> mode. To mark an existing image with one of the
    16       nonstandard modes listed below, use <userinput>VBoxManage modifymedium</userinput>. See <xref
    17         href="vboxmanage-modifymedium.dita"/>. Alternatively, use <userinput>VBoxManage
    18         storageattach</userinput> to attach the image to a VM and specify the
     7    <p>For each virtual disk image supported by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you can determine
     8      separately how it should be affected by write operations from a virtual machine and snapshot operations. This
     9      applies to all of the aforementioned image formats (VDI, VMDK, VHD, or HDD) and irrespective of whether an image
     10      is fixed-size or dynamically allocated. </p>
     11    <p>By default, images are in <i>normal</i> mode. To mark an existing image with one of the nonstandard modes listed
     12      below, use <userinput>VBoxManage modifymedium</userinput>. See <xref href="vboxmanage-modifymedium.dita"/>.
     13      Alternatively, use <userinput>VBoxManage storageattach</userinput> to attach the image to a VM and specify the
    1914        <codeph>--mtype</codeph> argument. See <xref href="vboxmanage-storageattach.dita"/>. </p>
    20     <p>
    21       The available virtual disk image modes are as follows:
    22     </p>
     15    <p>The available virtual disk image modes are as follows: </p>
    2316    <ul>
    2417      <li>
    … …  
    2720          disk. This is the default image mode.
    2821        </p>
    29         <p>
    30           When you take a snapshot of your virtual machine as described
    31           in <xref href="snapshots.dita#snapshots"/>, the state of a normal hard
    32           disk is recorded together with the snapshot, and when
    33           reverting to the snapshot, its state will be fully reset.
    34         </p>
    35         <p>
    36           The image file itself is not reset. Instead, when a snapshot
    37           is taken, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> <i>freezes</i> the
    38           image file and no longer writes to it. For the write
    39           operations from the VM, a second,
    40           <i>differencing</i> image file is created which
    41           receives only the changes to the original image. See
    42           <xref href="diffimages.dita#diffimages"/>.
    43         </p>
    44         <p>
    45           While you can attach the same normal image to more than one
    46           virtual machine, only one of these virtual machines attached
    47           to the same image file can be executed simultaneously, as
    48           otherwise there would be conflicts if several machines write
    49           to the same image file.
    50         </p>
     22        <p>When you take a snapshot of your virtual machine as described in <xref href="snapshots.dita#snapshots"/>, the
     23          state of a normal hard disk is recorded together with the snapshot, and when reverting to the snapshot, its
     24          state will be fully reset. </p>
     25        <p>The image file itself is not reset. Instead, when a snapshot is taken, <ph
     26            conkeyref="vbox-conkeyref-phrases/product-name"/>
     27          <i>freezes</i> the image file and no longer writes to it. For the write operations from the VM, a second,
     28            <i>differencing</i> image file is created which receives only the changes to the original image. See <xref
     29            href="diffimages.dita#diffimages"/>. </p>
     30        <p>While you can attach the same normal image to more than one virtual machine, only one of these virtual
     31          machines attached to the same image file can be executed simultaneously, as otherwise there would be conflicts
     32          if several machines write to the same image file. </p>
    5133      </li>
    5234      <li>
    … …  
    7153        </p>
    7254        <note type="caution">
    73           <p>
    74             This is an expert feature, and misuse can lead to data loss,
    75             as regular filesystems are not prepared to handle
    76             simultaneous changes by several parties.
    77           </p>
     55          <p>This is an expert feature, and misuse can lead to data loss, as regular filesystems are not prepared to
     56            handle simultaneous changes by several parties. </p>
    7857        </note>
    7958      </li>
    … …  
    8665          virtual machines without restrictions.
    8766        </p>
    88         <p>
    89           Creating an immutable image makes little sense since it would
    90           be initially empty and lose its contents with every machine
    91           restart. You would have a disk that is always unformatted when
    92           the machine starts up. Instead, you can first create a normal
    93           image and then later mark it as immutable when you decide that
    94           the contents are useful.
    95         </p>
    96         <p>
    97           If you take a snapshot of a machine with immutable images,
    98           then on every machine power-up, those images are reset to the
    99           state of the last (current) snapshot, instead of the state of
    100           the original immutable image.
    101         </p>
     67        <p>Creating an immutable image makes little sense since it would be initially empty and lose its contents with
     68          every machine restart. You would have a disk that is always unformatted when the machine starts up. Instead,
     69          you can first create a normal image and then later mark it as immutable when you decide that the contents are
     70          useful. </p>
     71        <p>If you take a snapshot of a machine with immutable images, then on every machine power-up, those images are
     72          reset to the state of the last (current) snapshot, instead of the state of the original immutable image. </p>
    10273        <note>
    103           <p>
    104             As a special exception, immutable images are
    105             <i>not</i> reset if they are attached to a
    106             machine in a saved state or whose last snapshot was taken
    107             while the machine was running. This is called an
    108             <i>online snapshot</i>. As a result, if the
    109             machine's current snapshot is an online snapshot, its
    110             immutable images behave exactly like the a normal image. To
    111             reenable the automatic resetting of such images, delete the
    112             current snapshot of the machine.
    113           </p>
     74          <p>As a special exception, immutable images are <i>not</i> reset if they are attached to a machine in a saved
     75            state or whose last snapshot was taken while the machine was running. This is called an <i>online
     76              snapshot</i>. As a result, if the machine's current snapshot is an online snapshot, its immutable images
     77            behave exactly like the a normal image. To reenable the automatic resetting of such images, delete the
     78            current snapshot of the machine. </p>
    11479        </note>
    115         <p>
    116           <ph conkeyref="vbox-conkeyref-phrases/product-name"/> never writes to an immutable image directly at
    117           all. All write operations from the machine are directed to a
    118           differencing image. The next time the VM is powered on, the
    119           differencing image is reset so that every time the VM starts,
    120           its immutable images have exactly the same content.
    121         </p>
    122         <p>
    123           The differencing image is only reset when the machine is
    124           powered on from within <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, not when you reboot by
    125           requesting a reboot from within the machine. This is also why
    126           immutable images behave as described above when snapshots are
    127           also present, which use differencing images as well.
    128         </p>
    129         <p> If the automatic discarding of the differencing image on VM startup does not fit your
    130           needs, you can turn it off using the <codeph>autoreset</codeph> parameter of
    131             <userinput>VBoxManage modifymedium</userinput>. See <xref
    132             href="vboxmanage-modifymedium.dita"/>. </p>
     80        <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> never writes to an immutable image directly at all. All
     81          write operations from the machine are directed to a differencing image. The next time the VM is powered on,
     82          the differencing image is reset so that every time the VM starts, its immutable images have exactly the same
     83          content. </p>
     84        <p>The differencing image is only reset when the machine is powered on from within <ph
     85            conkeyref="vbox-conkeyref-phrases/product-name"/>, not when you reboot by requesting a reboot from within
     86          the machine. This is also why immutable images behave as described above when snapshots are also present,
     87          which use differencing images as well. </p>
     88        <p>If the automatic discarding of the differencing image on VM startup does not fit your needs, you can turn it
     89          off using the <codeph>autoreset</codeph> parameter of <userinput>VBoxManage modifymedium</userinput>. See
     90            <xref href="vboxmanage-modifymedium.dita"/>. </p>
    13391      </li>
    13492      <li>
    … …  
    143101          image.
    144102        </p>
    145         <p>
    146           Technically, a multiattach image behaves identically to an
    147           immutable image except the differencing image is not reset
    148           every time the machine starts.
    149         </p>
    150         <p>
    151           This mode is useful for sharing files which are almost never
    152           written, for instance picture galleries, where every guest
    153           changes only a small amount of data and the majority of the
    154           disk content remains unchanged. The modified blocks are stored
    155           in differencing images which remain relatively small and the
    156           shared content is stored only once at the host.
    157         </p>
     103        <p>Technically, a multiattach image behaves identically to an immutable image except the differencing image is
     104          not reset every time the machine starts. </p>
     105        <p>This mode is useful for sharing files which are almost never written, for instance picture galleries, where
     106          every guest changes only a small amount of data and the majority of the disk content remains unchanged. The
     107          modified blocks are stored in differencing images which remain relatively small and the shared content is
     108          stored only once at the host. </p>
    158109      </li>
    159110      <li>
    … …  
    164115      </li>
    165116    </ul>
    166     <p>
    167       The following scenario illustrates the differences between the
    168       various image modes, with respect to snapshots.
    169     </p>
    170     <p>
    171       Assume you have installed your guest OS in your VM, and you have
    172       taken a snapshot. Later, your VM is infected with a virus and you
    173       would like to go back to the snapshot. With a normal hard disk
    174       image, you simply restore the snapshot, and the earlier state of
    175       your hard disk image will be restored as well and your virus
    176       infection will be undone. With an immutable hard disk, all it
    177       takes is to shut down and power on your VM, and the virus
    178       infection will be discarded. With a write-through image however,
    179       you cannot easily undo the virus infection by means of
    180       virtualization, but will have to disinfect your virtual machine
    181       like a real computer.
    182     </p>
    183     <p>
    184       You might find write-through images useful if you want to preserve
    185       critical data irrespective of snapshots. As you can attach more
    186       than one image to a VM, you may want to have one immutable image
    187       for the OS and one write-through image for your data files.
    188     </p>
     117    <p>The following scenario illustrates the differences between the various image modes, with respect to snapshots. </p>
     118    <p>Assume you have installed your guest OS in your VM, and you have taken a snapshot. Later, your VM is infected
     119      with a virus and you would like to go back to the snapshot. With a normal hard disk image, you simply restore the
     120      snapshot, and the earlier state of your hard disk image will be restored as well and your virus infection will be
     121      undone. With an immutable hard disk, all it takes is to shut down and power on your VM, and the virus infection
     122      will be discarded. With a write-through image however, you cannot easily undo the virus infection by means of
     123      virtualization, but will have to disinfect your virtual machine like a real computer. </p>
     124    <p>You might find write-through images useful if you want to preserve critical data irrespective of snapshots. As
     125      you can attach more than one image to a VM, you may want to have one immutable image for the OS and one
     126      write-through image for your data files. </p>
    189127  </body>
    190128 

  • trunk/doc/manual/en_US/dita/topics/headless-vm-steps.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8         The following instructions describe how to create a virtual
    9         machine on a headless server over a network connection. This
    10         example creates a virtual machine, establishes an RDP connection
    11         and installs a guest operating system. All of these tasks are
    12         done without having to touch the headless server. You need the
    13         following prerequisites:
    14       </p>
     7    <p>The following instructions describe how to create a virtual machine on a headless server over a network
     8      connection. This example creates a virtual machine, establishes an RDP connection and installs a guest operating
     9      system. All of these tasks are done without having to touch the headless server. You need the following
     10      prerequisites: </p>
    1511    <ul>
    1612      <li>
    17         <p>
    18             <ph conkeyref="vbox-conkeyref-phrases/product-name"/> on a server machine with a supported host
    19             operating system. The <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/> for the
    20             VRDP server must be installed, see <xref href="vrde.dita#vrde"/>.
    21             The procedures assume a Linux server is used.
    22           </p>
     13        <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> on a server machine with a supported host operating
     14          system. The <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/> for the VRDP server must be installed, see <xref
     15            href="vrde.dita#vrde"/>. The procedures assume a Linux server is used. </p>
    2316      </li>
    2417      <li>
    25         <p>
    26             An ISO file accessible from the server, containing the
    27             installation data for the guest operating system to install.
    28             Windows XP is used in the example.
    29           </p>
     18        <p>An ISO file accessible from the server, containing the installation data for the guest operating system to
     19          install. Windows XP is used in the example. </p>
    3020      </li>
    3121      <li>
    32         <p>
    33             A terminal connection to that host through which you can
    34             access a command line, such as <userinput>ssh</userinput>.
    35           </p>
     22        <p>A terminal connection to that host through which you can access a command line, such as
     23            <userinput>ssh</userinput>. </p>
    3624      </li>
    3725      <li>
    38         <p>
    39             An RDP viewer on the remote client. See
    40             <xref href="rdp-viewers.dita#rdp-viewers"/> for examples.
    41           </p>
     26        <p>An RDP viewer on the remote client. See <xref href="rdp-viewers.dita#rdp-viewers"/> for examples. </p>
    4227      </li>
    4328    </ul>
    44     <p>
    45         Note that on the server machine, since we will only use the
    46         headless server, Qt and the X Window system are not required.
    47       </p>
     29    <p>Note that on the server machine, since we will only use the headless server, Qt and the X Window system are not
     30      required. </p>
    4831    <ol>
    4932      <li>
    50         <p>
    51             On the headless server, create a new virtual machine. For
    52             example:
    53           </p>
     33        <p>On the headless server, create a new virtual machine. For example: </p>
    5434        <pre xml:space="preserve">VBoxManage createvm --name "Windows XP" --ostype WindowsXP --register</pre>
    55         <p>
    56             If you do not specify <codeph>--register</codeph>, you will
    57             have to manually use the <userinput>registervm</userinput>
    58             command later.
    59           </p>
    60         <p>
    61             You do not need to specify <codeph>--ostype</codeph>, but
    62             doing so selects some sensible default values for certain VM
    63             parameters. For example, the RAM size and the type of the
    64             virtual network device. To get a complete list of supported
    65             operating systems you can use the following command:
    66           </p>
     35        <p>If you do not specify <codeph>--register</codeph>, you will have to manually use the
     36            <userinput>registervm</userinput> command later. </p>
     37        <p>You do not need to specify <codeph>--ostype</codeph>, but doing so selects some sensible default values for
     38          certain VM parameters. For example, the RAM size and the type of the virtual network device. To get a complete
     39          list of supported operating systems you can use the following command: </p>
    6740        <pre xml:space="preserve">VBoxManage list ostypes</pre>
    6841      </li>
    6942      <li>
    70         <p> Ensure the settings for the VM are appropriate for the guest operating system that we
    71           will install. For example: </p>
     43        <p>Ensure the settings for the VM are appropriate for the guest operating system that we will install. For
     44          example: </p>
    7245        <pre xml:space="preserve">VBoxManage modifyvm "Windows XP" --memory 256 --acpi on --boot1 dvd --nic1 nat</pre>
    7346      </li>
    7447      <li>
    75         <p>
    76             Create a virtual hard disk for the VM. For example, to
    77             create a 10 GB virtual hard disk:
    78           </p>
     48        <p>Create a virtual hard disk for the VM. For example, to create a 10 GB virtual hard disk: </p>
    7949        <pre xml:space="preserve">VBoxManage createhd --filename "WinXP.vdi" --size 10000</pre>
    8050      </li>
    8151      <li>
    82         <p>
    83             Add an IDE Controller to the new VM. For example:
    84           </p>
     52        <p>Add an IDE Controller to the new VM. For example: </p>
    8553        <pre xml:space="preserve">VBoxManage storagectl "Windows XP" --name "IDE Controller"
    8654  --add ide --controller PIIX4</pre>
    8755      </li>
    8856      <li>
    89         <p>
    90             Set the VDI file you created as the first virtual hard disk
    91             of the new VM. For example:
    92           </p>
     57        <p>Set the VDI file you created as the first virtual hard disk of the new VM. For example: </p>
    9358        <pre xml:space="preserve">VBoxManage storageattach "Windows XP" --storagectl "IDE Controller"
    9459 --port 0 --device 0 --type hdd --medium "WinXP.vdi"</pre>
    9560      </li>
    9661      <li>
    97         <p>
    98             Attach the ISO file that contains the operating system
    99             installation that you want to install later to the virtual
    100             machine. This is done so that the VM can boot from it.
    101           </p>
     62        <p>Attach the ISO file that contains the operating system installation that you want to install later to the
     63          virtual machine. This is done so that the VM can boot from it. </p>
    10264        <pre xml:space="preserve">VBoxManage storageattach "Windows XP" --storagectl "IDE Controller"
    10365 --port 0 --device 1 --type dvddrive --medium /full/path/to/iso.iso</pre>
    10466      </li>
    10567      <li>
    106         <p>
    107             Enable the VirtualBox Remote Desktop Extension, the VRDP
    108             server, as follows:
    109           </p>
     68        <p>Enable the VirtualBox Remote Desktop Extension, the VRDP server, as follows: </p>
    11069        <pre xml:space="preserve">VBoxManage modifyvm "Windows XP" --vrde on</pre>
    11170      </li>
    11271      <li>
    113         <p>
    114             Start the virtual machine using the
    115             <userinput>VBoxHeadless</userinput> command:
    116           </p>
     72        <p>Start the virtual machine using the <userinput>VBoxHeadless</userinput> command: </p>
    11773        <pre xml:space="preserve">VBoxHeadless --startvm "Windows XP"</pre>
    118         <p>
    119             If the configuration steps worked, you should see a
    120             copyright notice. If you are returned to the command line,
    121             then something did not work correctly.
    122           </p>
     74        <p>If the configuration steps worked, you should see a copyright notice. If you are returned to the command
     75          line, then something did not work correctly. </p>
    12376      </li>
    12477      <li>
    125         <p>
    126             On the client machine, start the RDP viewer and connect to
    127             the server. See <xref href="rdp-viewers.dita#rdp-viewers"/> for details
    128             of how to use various common RDP viewers.
    129           </p>
    130         <p>
    131             The installation routine of your guest operating system
    132             should be displayed in the RDP viewer.
    133           </p>
     78        <p>On the client machine, start the RDP viewer and connect to the server. See <xref
     79            href="rdp-viewers.dita#rdp-viewers"/> for details of how to use various common RDP viewers. </p>
     80        <p>The installation routine of your guest operating system should be displayed in the RDP viewer. </p>
    13481      </li>
    13582    </ol>

  • trunk/doc/manual/en_US/dita/topics/heartbeatservice.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> ships a simple heartbeat service. Once the Guest
    9       Additions are active, the guest sends frequent heartbeat pings to
    10       the host. If the guest stops sending the heartbeat pings without
    11       properly terminating the service, the VM process will log this
    12       event in the VBox.log file. In the future it might be possible to
    13       configure dedicated actions but for now there is only a warning in
    14       the log file.
    15     </p>
    16     <p>
    17       There are two parameters to configure. The <i>heartbeat
    18       interval</i> defines the time between two heartbeat pings.
    19       The default value is 2 seconds, that is, the heartbeat service of
    20       the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions will send a heartbeat ping
    21       every two seconds. The value in nanoseconds can be configured like
    22       this:
    23     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> ships a simple heartbeat service. Once the Guest Additions
     8      are active, the guest sends frequent heartbeat pings to the host. If the guest stops sending the heartbeat pings
     9      without properly terminating the service, the VM process will log this event in the VBox.log file. In the future
     10      it might be possible to configure dedicated actions but for now there is only a warning in the log file. </p>
     11    <p>There are two parameters to configure. The <i>heartbeat interval</i> defines the time between two heartbeat
     12      pings. The default value is 2 seconds, that is, the heartbeat service of the <ph
     13        conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions will send a heartbeat ping every two seconds.
     14      The value in nanoseconds can be configured like this: </p>
    2415    <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
    2516VBoxInternal/Devices/VMMDev/0/Config/HeartbeatInterval 2000000000</pre>
    26     <p>
    27       The <i>heartbeat timeout</i> defines the time the
    28       host waits starting from the last heartbeat ping before it defines
    29       the guest as unresponsive. The default value is 2 times the
    30       heartbeat interval (4 seconds) and can be configured as following,
    31       in nanoseconds:
    32     </p>
     17    <p>The <i>heartbeat timeout</i> defines the time the host waits starting from the last heartbeat ping before it
     18      defines the guest as unresponsive. The default value is 2 times the heartbeat interval (4 seconds) and can be
     19      configured as following, in nanoseconds: </p>
    3320    <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
    3421VBoxInternal/Devices/VMMDev/0/Config/HeartbeatTimeout 4000000000</pre>
    35     <p>
    36       If the heartbeat timeout expires, there will be a log message like
    37       <i>VMMDev: HeartBeatCheckTimer: Guest seems to be
    38       unresponsive. Last heartbeat received 5 seconds ago.</i> If
    39       another heartbeat ping arrives after this warning, there will be a
    40       log message like <i>VMMDev: GuestHeartBeat: Guest is
    41       alive.</i>
     22    <p>If the heartbeat timeout expires, there will be a log message like <i>VMMDev: HeartBeatCheckTimer: Guest seems to
     23        be unresponsive. Last heartbeat received 5 seconds ago.</i> If another heartbeat ping arrives after this
     24      warning, there will be a log message like <i>VMMDev: GuestHeartBeat: Guest is alive.</i>
    4225               </p>
    4326  </body>

  • trunk/doc/manual/en_US/dita/topics/hidledssync.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8       This feature makes the host keyboard indicators (LEDs) match those
    9       of the VM's emulated keyboard when the machine window is active.
    10       It is currently implemented for macOS and Windows hosts. This
    11       feature is enabled by default on supported host OSes. You can
    12       disable this feature by running the following command:
    13     </p>
     7    <p>This feature makes the host keyboard indicators (LEDs) match those of the VM's emulated keyboard when the machine
     8      window is active. It is currently implemented for macOS and Windows hosts. This feature is enabled by default on
     9      supported host OSes. You can disable this feature by running the following command: </p>
    1410    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> GUI/HidLedsSync 0</pre>
    15     <p>
    16       This is a per-VM setting that is enabled by default.
    17     </p>
     11    <p>This is a per-VM setting that is enabled by default. </p>
    1812  </body>
    1913 

  • trunk/doc/manual/en_US/dita/topics/host-key-customize.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         To disable all Host key combinations, open the preferences and
    9         change the Host key to None. This might be useful when using
    10         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> in a kiosk mode.
    11       </p>
     7    <p>To disable all Host key combinations, open the preferences and change the Host key to None. This might be useful
     8      when using <ph conkeyref="vbox-conkeyref-phrases/product-name"/> in a kiosk mode. </p>
    129    <p>
    1310        To redefine or disable certain Host key actions, use the
    … …  
    1512      </p>
    1613    <pre xml:space="preserve">$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...."</pre>
    17     <p>
    18         The following table shows the possible Host key actions,
    19         together with their default Host key shortcut. Setting an action
    20         to None will disable that Host key action.
    21       </p>
     14    <p>The following table shows the possible Host key actions, together with their default Host key shortcut. Setting
     15      an action to None will disable that Host key action. </p>
    2216    <table id="table-host-key-customize">
    2317      <title>Host Key Customization</title>
    … …  
    410404      </tgroup>
    411405    </table>
    412     <p>
    413         To disable full screen mode and seamless mode, use the following
    414         command:
    415       </p>
     406    <p>To disable full screen mode and seamless mode, use the following command: </p>
    416407    <pre xml:space="preserve">$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"</pre>
    417408  </body>

  • trunk/doc/manual/en_US/dita/topics/hostpowertweaks.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       Some host power management events are handled by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>.
    9       The actual behavior depends on the platform:
    10     </p>
     7    <p>Some host power management events are handled by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. The
     8      actual behavior depends on the platform: </p>
    119    <ul>
    1210      <li>
    … …  
    2321          generated when the host woke up from the suspended state.
    2422        </p>
    25         <p>
    26           This event is currently only handled on Windows hosts and Mac
    27           OS X hosts. When this event is generated, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will
    28           resume all VMs which are where paused before.
    29         </p>
     23        <p>This event is currently only handled on Windows hosts and Mac OS X hosts. When this event is generated, <ph
     24            conkeyref="vbox-conkeyref-phrases/product-name"/> will resume all VMs which are where paused before. </p>
    3025      </li>
    3126      <li>
    … …  
    3429          charged.
    3530        </p>
    36         <p>
    37           This event is currently only handled on Windows hosts and Mac
    38           OS X hosts. When this event is generated, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will
    39           save the state and terminate all VMs in preparation of a
    40           potential host powerdown.
    41         </p>
    42         <p>
    43           The behavior can be configured. By executing the following
    44           command, no VM is saved:
    45         </p>
     31        <p>This event is currently only handled on Windows hosts and Mac OS X hosts. When this event is generated, <ph
     32            conkeyref="vbox-conkeyref-phrases/product-name"/> will save the state and terminate all VMs in preparation
     33          of a potential host powerdown. </p>
     34        <p>The behavior can be configured. By executing the following command, no VM is saved: </p>
    4635        <pre xml:space="preserve">$ VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 0</pre>
    47         <p>
    48           This is a global setting as well as a per-VM setting. The
    49           per-VM value has higher precedence than the global value. The
    50           following command will save the state of all VMs but will not
    51           save the state of VM "foo":
    52         </p>
     36        <p>This is a global setting as well as a per-VM setting. The per-VM value has higher precedence than the global
     37          value. The following command will save the state of all VMs but will not save the state of VM "foo": </p>
    5338        <pre xml:space="preserve">$ VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 1
    5439$ VBoxManage setextradata "foo" "VBoxInternal2/SavestateOnBatteryLow" 0</pre>
    55         <p>
    56           The first line is actually not required as by default the
    57           savestate action is performed.
    58         </p>
     40        <p>The first line is actually not required as by default the savestate action is performed. </p>
    5941      </li>
    6042    </ul>

  • trunk/doc/manual/en_US/dita/topics/hyperv-support.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can be used on a Windows host where Hyper-V is
    9       running. This is an experimental feature.
    10     </p>
    11     <p>
    12       No configuration is required. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> detects Hyper-V
    13       automatically and uses Hyper-V as the virtualization engine for
    14       the host system. The CPU icon in the VM window status bar
    15       indicates that Hyper-V is being used.
    16     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can be used on a Windows host where Hyper-V is running.
     8      This is an experimental feature. </p>
     9    <p>No configuration is required. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> detects Hyper-V automatically
     10      and uses Hyper-V as the virtualization engine for the host system. The CPU icon in the VM window status bar
     11      indicates that Hyper-V is being used. </p>
    1712    <note>
    18       <p>
    19         When using this feature, some host systems might experience
    20         significant <ph conkeyref="vbox-conkeyref-phrases/product-name"/> performance degradation.
    21       </p>
     13      <p>When using this feature, some host systems might experience significant <ph
     14          conkeyref="vbox-conkeyref-phrases/product-name"/> performance degradation. </p>
    2215    </note>
    2316  </body>

  • trunk/doc/manual/en_US/dita/topics/iocaching.dita

    r105300 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can optionally disable the I/O caching that the
    9       host OS would otherwise perform on disk image files.
    10     </p>
    11     <p>
    12       Traditionally, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has opened disk image files as
    13       normal files, which results in them being cached by the host OS
    14       like any other file. The main advantage of this is speed: when the
    15       guest OS writes to disk and the host OS cache uses delayed
    16       writing, the write operation can be reported as completed to the
    17       guest OS quickly while the host OS can perform the operation
    18       asynchronously. Also, when you start a VM a second time and have
    19       enough memory available for the OS to use for caching, large parts
    20       of the virtual disk may be in system memory, and the VM can access
    21       the data much faster.
    22     </p>
    23     <p>
    24       Note that this applies only to image files. Buffering does not
    25       occur for virtual disks residing on remote iSCSI storage, which is
    26       the more common scenario in enterprise-class setups. See
    27       <xref href="storage-iscsi.dita#storage-iscsi"/>.
    28     </p>
    29     <p>
    30       While buffering is a useful default setting for virtualizing a few
    31       machines on a desktop computer, there are some disadvantages to
    32       this approach:
    33     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can optionally disable the I/O caching that the host OS
     8      would otherwise perform on disk image files. </p>
     9    <p>Traditionally, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has opened disk image files as normal files,
     10      which results in them being cached by the host OS like any other file. The main advantage of this is speed: when
     11      the guest OS writes to disk and the host OS cache uses delayed writing, the write operation can be reported as
     12      completed to the guest OS quickly while the host OS can perform the operation asynchronously. Also, when you start
     13      a VM a second time and have enough memory available for the OS to use for caching, large parts of the virtual disk
     14      may be in system memory, and the VM can access the data much faster. </p>
     15    <p>Note that this applies only to image files. Buffering does not occur for virtual disks residing on remote iSCSI
     16      storage, which is the more common scenario in enterprise-class setups. See <xref
     17        href="storage-iscsi.dita#storage-iscsi"/>. </p>
     18    <p>While buffering is a useful default setting for virtualizing a few machines on a desktop computer, there are some
     19      disadvantages to this approach: </p>
    3420    <ul>
    3521      <li>
    36         <p>
    37           Delayed writing through the host OS cache is less secure. When
    38           the guest OS writes data, it considers the data written even
    39           though it has not yet arrived on a physical disk. If for some
    40           reason the write does not happen, such as power failure or
    41           host crash, the likelihood of data loss increases.
    42         </p>
     22        <p>Delayed writing through the host OS cache is less secure. When the guest OS writes data, it considers the
     23          data written even though it has not yet arrived on a physical disk. If for some reason the write does not
     24          happen, such as power failure or host crash, the likelihood of data loss increases. </p>
    4325      </li>
    4426      <li>
    45         <p>
    46           Disk image files tend to be very large. Caching them can
    47           therefore quickly use up the entire host OS cache. Depending
    48           on the efficiency of the host OS caching, this may slow down
    49           the host immensely, especially if several VMs run at the same
    50           time. For example, on Linux hosts, host caching may result in
    51           Linux delaying all writes until the host cache is nearly full
    52           and then writing out all these changes at once, possibly
    53           stalling VM execution for minutes. This can result in I/O
    54           errors in the guest as I/O requests time out there.
    55         </p>
     27        <p>Disk image files tend to be very large. Caching them can therefore quickly use up the entire host OS cache.
     28          Depending on the efficiency of the host OS caching, this may slow down the host immensely, especially if
     29          several VMs run at the same time. For example, on Linux hosts, host caching may result in Linux delaying all
     30          writes until the host cache is nearly full and then writing out all these changes at once, possibly stalling
     31          VM execution for minutes. This can result in I/O errors in the guest as I/O requests time out there. </p>
    5632      </li>
    5733      <li>
    58         <p>
    59           Physical memory is often wasted as guest OSes typically have
    60           their own I/O caches, which may result in the data being
    61           cached twice, in both the guest and the host caches, for
    62           little effect.
    63         </p>
     34        <p>Physical memory is often wasted as guest OSes typically have their own I/O caches, which may result in the
     35          data being cached twice, in both the guest and the host caches, for little effect. </p>
    6436      </li>
    6537    </ul>
    66     <p>
    67       If you decide to disable host I/O caching for the above reasons,
    68       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses its own small cache to buffer writes, but no
    69       read caching since this is typically already performed by the
    70       guest OS. In addition, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> fully supports asynchronous
    71       I/O for its virtual SATA, SCSI, and SAS controllers through
    72       multiple I/O threads.
    73     </p>
    74     <p>
    75       Since asynchronous I/O is not supported by IDE controllers, for
    76       performance reasons, you may want to leave host caching enabled
    77       for your VM's virtual IDE controllers.
    78     </p>
    79     <p>
    80       For this reason, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to configure whether
    81       the host I/O cache is used for each I/O controller separately.
    82       Either select the <b outputclass="bold">Use Host I/O
    83       Cache</b> check box in the
    84       <b outputclass="bold">Storage</b> settings for a given
    85       virtual storage controller, or use the following
    86       <userinput>VBoxManage</userinput> command to disable the host I/O
    87       cache for a virtual storage controller:
    88     </p>
     38    <p>If you decide to disable host I/O caching for the above reasons, <ph
     39        conkeyref="vbox-conkeyref-phrases/product-name"/> uses its own small cache to buffer writes, but no read caching
     40      since this is typically already performed by the guest OS. In addition, <ph
     41        conkeyref="vbox-conkeyref-phrases/product-name"/> fully supports asynchronous I/O for its virtual SATA, SCSI,
     42      and SAS controllers through multiple I/O threads. </p>
     43    <p>Since asynchronous I/O is not supported by IDE controllers, for performance reasons, you may want to leave host
     44      caching enabled for your VM's virtual IDE controllers. </p>
     45    <p>For this reason, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to configure whether the host
     46      I/O cache is used for each I/O controller separately. Either select the <b outputclass="bold">Use Host I/O
     47        Cache</b> check box in the <b outputclass="bold">Storage</b> settings for a given virtual storage controller, or
     48      use the following <userinput>VBoxManage</userinput> command to disable the host I/O cache for a virtual storage
     49      controller: </p>
    8950    <pre xml:space="preserve">VBoxManage storagectl "VM name" --name &lt;controllername&gt; --hostiocache off</pre>
    9051    <p> See <xref href="vboxmanage-storagectl.dita"/>. </p>
    91     <p>
    92       For the above reasons, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses SATA controllers by
    93       default for new virtual machines.
    94     </p>
     52    <p>For the above reasons, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses SATA controllers by default for
     53      new virtual machines. </p>
    9554  </body>
    9655 

  • trunk/doc/manual/en_US/dita/topics/iscsi-intnet.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         As an experimental feature, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables access to an
    9         iSCSI target running in a virtual machine which is configured to
    10         use Internal Networking mode. See
    11         <xref href="storage-iscsi.dita">iSCSI Servers</xref>,
    12         <xref href="network_internal.dita">Internal Networking</xref>, and
    13         <xref href="vboxmanage-storageattach.dita">VBoxManage storageattach</xref>.
    14       </p>
    15     <p>
    16         The IP stack accessing Internal Networking must be configured in
    17         the virtual machine which accesses the iSCSI target. A free
    18         static IP and a MAC address not used by other virtual machines
    19         must be chosen. In the example below, adapt the name of the
    20         virtual machine, the MAC address, the IP configuration, and the
    21         Internal Networking name (MyIntNet) according to your needs. The
    22         following eight commands must first be issued:
    23       </p>
     7    <p>As an experimental feature, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables access to an iSCSI
     8      target running in a virtual machine which is configured to use Internal Networking mode. See <xref
     9        href="storage-iscsi.dita">iSCSI Servers</xref>, <xref href="network_internal.dita">Internal Networking</xref>,
     10      and <xref href="vboxmanage-storageattach.dita">VBoxManage storageattach</xref>. </p>
     11    <p>The IP stack accessing Internal Networking must be configured in the virtual machine which accesses the iSCSI
     12      target. A free static IP and a MAC address not used by other virtual machines must be chosen. In the example
     13      below, adapt the name of the virtual machine, the MAC address, the IP configuration, and the Internal Networking
     14      name (MyIntNet) according to your needs. The following eight commands must first be issued: </p>
    2415    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    2516VBoxInternal/Devices/IntNetIP/0/Trusted 1
    … …  
    3829$ VBoxManage setextradata <varname>VM-name</varname> \
    3930VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/IsService 1</pre>
    40     <p>
    41         Finally the iSCSI disk must be attached with the
    42         <codeph>--intnet</codeph> option to tell the iSCSI initiator to
    43         use internal networking, as follows:
    44       </p>
     31    <p>Finally the iSCSI disk must be attached with the <codeph>--intnet</codeph> option to tell the iSCSI initiator to
     32      use internal networking, as follows: </p>
    4533    <pre xml:space="preserve">$ VBoxManage storageattach ... --medium iscsi --server 10.0.9.30 \
    4634--target iqn.2008-12.com.sun:sampletarget --intnet</pre>
    47     <p>
    48         Compared to a regular iSCSI setup, the IP address of the target
    49         <i>must</i> be specified as a numeric IP address,
    50         as there is no DNS resolver for internal networking.
    51       </p>
    52     <p>
    53         The virtual machine with the iSCSI target should be started
    54         before the VM using it is powered on. If a virtual machine using
    55         an iSCSI disk is started without having the iSCSI target powered
    56         up, it can take up to 200 seconds to detect this situation. The
    57         VM will fail to power up.
    58       </p>
     35    <p>Compared to a regular iSCSI setup, the IP address of the target <i>must</i> be specified as a numeric IP address,
     36      as there is no DNS resolver for internal networking. </p>
     37    <p>The virtual machine with the iSCSI target should be started before the VM using it is powered on. If a virtual
     38      machine using an iSCSI disk is started without having the iSCSI target powered up, it can take up to 200 seconds
     39      to detect this situation. The VM will fail to power up. </p>
    5940  </body>
    6041 

  • trunk/doc/manual/en_US/dita/topics/legacy-fullscreen-mode.dita

    r105293 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses special window manager facilities
    9       to switch a multiscreen machine to full-screen on a multimonitor host system. However, not all
    10       window managers provide these facilities correctly. <ph
    11         conkeyref="vbox-conkeyref-phrases/product-name"/> can be configured to use a legacy method
    12       of switching to full-screen mode instead, by using the command: </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses special window manager facilities to switch a
     8      multiscreen machine to full-screen on a multimonitor host system. However, not all window managers provide these
     9      facilities correctly. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can be configured to use a legacy
     10      method of switching to full-screen mode instead, by using the command: </p>
    1311    <pre xml:space="preserve">VBoxManage setextradata global GUI/Fullscreen/LegacyMode true</pre>
    14     <p>
    15         You can go back to the default method by using the following
    16         command:
    17       </p>
     12    <p>You can go back to the default method by using the following command: </p>
    1813    <pre xml:space="preserve">VBoxManage setextradata global GUI/Fullscreen/LegacyMode</pre>
    19     <p>
    20         This is a global setting.
    21       </p>
     14    <p>This is a global setting. </p>
    2215  </body>
    2316 

  • trunk/doc/manual/en_US/dita/topics/linux-guest-manual-setup.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions contain several different
    9         drivers. If you do not want to configure them all, use the
    10         following command to install the Guest Additions:
    11       </p>
     7    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions contain several different drivers. If
     8      you do not want to configure them all, use the following command to install the Guest Additions: </p>
    129    <pre xml:space="preserve">$ sh ./VBoxLinuxAdditions.run no_setup</pre>
    13     <p>
    14         After running this script, run the <userinput>rcvboxadd
    15         setup</userinput> command as <codeph>root</codeph> to compile
    16         the kernel modules.
    17       </p>
    18     <p>
    19         On some 64-bit guests, you must replace <filepath>lib</filepath>
    20         with <filepath>lib64</filepath>. On older guests that do not run
    21         the <userinput>udev</userinput> service, you must add the
    22         <userinput>vboxadd</userinput> service to the default runlevel to
    23         ensure that the modules are loaded.
    24       </p>
    25     <p>
    26         To set up the time synchronization service, add the
    27         <userinput>vboxadd-service</userinput> service to the default
    28         runlevel. To set up the X11 and OpenGL part of the Guest
    29         Additions, run the <userinput>rcvboxadd-x11 setup</userinput>
    30         command. Note that you do not need to enable additional
    31         services.
    32       </p>
    33     <p>
    34         Use the <userinput>rcvboxadd setup</userinput> to recompile the
    35         guest kernel modules.
    36       </p>
    37     <p>
    38         After compilation, reboot your guest to ensure that the new
    39         modules are loaded.
    40       </p>
     10    <p>After running this script, run the <userinput>rcvboxadd setup</userinput> command as <codeph>root</codeph> to
     11      compile the kernel modules. </p>
     12    <p>On some 64-bit guests, you must replace <filepath>lib</filepath> with <filepath>lib64</filepath>. On older guests
     13      that do not run the <userinput>udev</userinput> service, you must add the <userinput>vboxadd</userinput> service
     14      to the default runlevel to ensure that the modules are loaded. </p>
     15    <p>To set up the time synchronization service, add the <userinput>vboxadd-service</userinput> service to the default
     16      runlevel. To set up the X11 and OpenGL part of the Guest Additions, run the <userinput>rcvboxadd-x11
     17        setup</userinput> command. Note that you do not need to enable additional services. </p>
     18    <p>Use the <userinput>rcvboxadd setup</userinput> to recompile the guest kernel modules. </p>
     19    <p>After compilation, reboot your guest to ensure that the new modules are loaded. </p>
    4120  </body>
    4221 

  • trunk/doc/manual/en_US/dita/topics/max-resolution-guests.dita

    r99797 r105335  
    66 
    77  <body>
    8     <p>
    9         When guest systems with the Guest Additions installed are
    10         started using the graphical frontend, the normal <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    11         application, they will not be allowed to use screen resolutions
    12         greater than the host's screen size unless the user manually
    13         resizes them by dragging the window, switching to full screen or
    14         seamless mode or sending a video mode hint using
    15         <userinput>VBoxManage</userinput>. This behavior is what most users
    16         will want, but if you have different needs, you can change it by
    17         issuing one of the following commands from the command line:
    18       </p>
     8    <p>When guest systems with the Guest Additions installed are started using the graphical frontend, the normal <ph
     9        conkeyref="vbox-conkeyref-phrases/product-name"/> application, they will not be allowed to use screen
     10      resolutions greater than the host's screen size unless the user manually resizes them by dragging the window,
     11      switching to full screen or seamless mode or sending a video mode hint using <userinput>VBoxManage</userinput>.
     12      This behavior is what most users will want, but if you have different needs, you can change it by issuing one of
     13      the following commands from the command line: </p>
    1914    <ul>
    2015      <li>
    21         <p>
    22             Remove all limits on guest resolutions.
    23           </p>
     16        <p>Remove all limits on guest resolutions. </p>
    2417        <pre xml:space="preserve">VBoxManage setextradata global GUI/MaxGuestResolution any</pre>
    2518      </li>
    2619      <li>
    27         <p>
    28             Manually specify a maximum resolution.
    29           </p>
     20        <p>Manually specify a maximum resolution. </p>
    3021        <pre xml:space="preserve">VBoxManage setextradata global GUI/MaxGuestResolution <varname>width</varname>x<varname>height</varname>
    3122                        </pre>
    3223      </li>
    3324      <li>
    34         <p>
    35             Restore the default settings to all guest VMs.
    36           </p>
     25        <p>Restore the default settings to all guest VMs. </p>
    3726        <pre xml:space="preserve">VBoxManage setextradata global GUI/MaxGuestResolution auto</pre>
    3827      </li>

  • trunk/doc/manual/en_US/dita/topics/mouse-capture.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8         By default, the mouse is captured if the user clicks on the
    9         guest window and the guest expects relative mouse coordinates at
    10         this time. This happens if the pointing device is configured as
    11         PS/2 mouse and the guest has not yet started the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    12         Guest Additions. For instance, the guest is booting or the Guest
    13         Additions are not installed, or if the pointing device is
    14         configured as a USB tablet but the guest has no USB driver
    15         loaded yet. Once the Guest Additions become active or the USB
    16         guest driver is started, the mouse capture is automatically
    17         released.
    18       </p>
    19     <p> The default behavior is sometimes not appropriate. Therefore it can be configured as
    20       follows: </p>
     7    <p>By default, the mouse is captured if the user clicks on the guest window and the guest expects relative mouse
     8      coordinates at this time. This happens if the pointing device is configured as PS/2 mouse and the guest has not
     9      yet started the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions. For instance, the guest is
     10      booting or the Guest Additions are not installed, or if the pointing device is configured as a USB tablet but the
     11      guest has no USB driver loaded yet. Once the Guest Additions become active or the USB guest driver is started, the
     12      mouse capture is automatically released. </p>
     13    <p>The default behavior is sometimes not appropriate. Therefore it can be configured as follows: </p>
    2114    <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> GUI/MouseCapturePolicy <varname>mode</varname>
    2215                  </pre>
    … …  
    2922        </dt>
    3023        <dd>
    31           <p>
    32               The default behavior as described above.
    33             </p>
     24          <p>The default behavior as described above. </p>
    3425        </dd>
    3526      </dlentry>
    … …  
    3930        </dt>
    4031        <dd>
    41           <p>
    42               The mouse is only captured if the Host Key is toggled.
    43             </p>
     32          <p>The mouse is only captured if the Host Key is toggled. </p>
    4433        </dd>
    4534      </dlentry>
    … …  
    4938        </dt>
    5039        <dd>
    51           <p>
    52               The mouse is never captured, also not by toggling the Host
    53               Key
    54             </p>
     40          <p>The mouse is never captured, also not by toggling the Host Key </p>
    5541        </dd>
    5642      </dlentry>
    5743    </dl>
    58     <p>
    59         This is a per-VM setting.
    60       </p>
     44    <p>This is a per-VM setting. </p>
    6145  </body>
    6246 

  • trunk/doc/manual/en_US/dita/topics/nat-address-config.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         In NAT mode, the guest network interface is assigned to the IPv4
    9         range <codeph>10.0.<varname>x</varname>.0/24</codeph>
    10         by default where <varname>x</varname> corresponds to the
    11         instance of the NAT interface +2. So
    12         <varname>x</varname> is 2 when there is only one NAT
    13         instance active. In that case the guest is assigned to the
    14         address <codeph>10.0.2.15</codeph>, the gateway is set to
    15         <codeph>10.0.2.2</codeph> and the name server can be found at
    16         <codeph>10.0.2.3</codeph>.
    17       </p>
    18     <p>
    19         If the NAT network needs to be changed, use the following
    20         command:
    21       </p>
     7    <p>In NAT mode, the guest network interface is assigned to the IPv4 range
     8        <codeph>10.0.<varname>x</varname>.0/24</codeph> by default where <varname>x</varname> corresponds to the
     9      instance of the NAT interface +2. So <varname>x</varname> is 2 when there is only one NAT instance active. In that
     10      case the guest is assigned to the address <codeph>10.0.2.15</codeph>, the gateway is set to
     11        <codeph>10.0.2.2</codeph> and the name server can be found at <codeph>10.0.2.3</codeph>. </p>
     12    <p>If the NAT network needs to be changed, use the following command: </p>
    2213    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> \
    2314--natnet1 "192.168/16"</pre>
    24     <p>
    25         This command would reserve the network addresses from
    26         <codeph>192.168.0.0</codeph> to
    27         <codeph>192.168.254.254</codeph> for the first NAT network
    28         instance of <varname>VM-name</varname> The guest IP
    29         would be assigned to <codeph>192.168.0.15</codeph> and the
    30         default gateway could be found at
    31         <codeph>192.168.0.2</codeph>.
    32       </p>
     15    <p>This command would reserve the network addresses from <codeph>192.168.0.0</codeph> to
     16        <codeph>192.168.254.254</codeph> for the first NAT network instance of <varname>VM-name</varname> The guest IP
     17      would be assigned to <codeph>192.168.0.15</codeph> and the default gateway could be found at
     18        <codeph>192.168.0.2</codeph>. </p>
    3319  </body>
    3420 

  • trunk/doc/manual/en_US/dita/topics/nat-adv-alias.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         By default, the NAT core uses aliasing and uses random ports
    9         when generating an alias for a connection. This works well for
    10         the most protocols like SSH, FTP and so on. Though some
    11         protocols might need a more transparent behavior or may depend
    12         on the real port number the packet was sent from. You can change
    13         the NAT mode by using the following commands:
    14       </p>
     7    <p>By default, the NAT core uses aliasing and uses random ports when generating an alias for a connection. This
     8      works well for the most protocols like SSH, FTP and so on. Though some protocols might need a more transparent
     9      behavior or may depend on the real port number the packet was sent from. You can change the NAT mode by using the
     10      following commands: </p>
    1511    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> \
    1612--nataliasmode1 proxyonly</pre>
    1713    <pre xml:space="preserve">$ VBoxManage modifyvm "Linux Guest" --nataliasmode1 sameports</pre>
    18     <p>
    19         The first example disables aliasing and switches NAT into
    20         transparent mode, the second example enforces preserving of port
    21         values. These modes can be combined if necessary.
    22       </p>
     14    <p>The first example disables aliasing and switches NAT into transparent mode, the second example enforces
     15      preserving of port values. These modes can be combined if necessary. </p>
    2316  </body>
    2417 

  • trunk/doc/manual/en_US/dita/topics/nat-adv-dns.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p> The NAT engine by default offers the same DNS servers to the guest that are configured on
    8       the host. In some scenarios, it can be appropriate to hide the DNS server IPs from the guest,
    9       for example when this information can change on the host due to expiring DHCP leases. In this
    10       case, you can tell the NAT engine to act as DNS proxy using the following command: </p>
     7    <p>The NAT engine by default offers the same DNS servers to the guest that are configured on the host. In some
     8      scenarios, it can be appropriate to hide the DNS server IPs from the guest, for example when this information can
     9      change on the host due to expiring DHCP leases. In this case, you can tell the NAT engine to act as DNS proxy
     10      using the following command: </p>
    1111    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --natdnsproxy1 on</pre>
    1212  </body>

  • trunk/doc/manual/en_US/dita/topics/nat-adv-settings.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> NAT stack performance is often determined by
    9         its interaction with the host's TCP/IP stack and the size of
    10         several buffers, <codeph>SO_RCVBUF</codeph> and
    11         <codeph>SO_SNDBUF</codeph>. For certain setups users might
    12         want to adjust the buffer size for a better performance. This
    13         can by achieved using the following commands, where values are
    14         in kilobytes and can range from 8 to 1024:
    15       </p>
     7    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> NAT stack performance is often determined by its
     8      interaction with the host's TCP/IP stack and the size of several buffers, <codeph>SO_RCVBUF</codeph> and
     9        <codeph>SO_SNDBUF</codeph>. For certain setups users might want to adjust the buffer size for a better
     10      performance. This can by achieved using the following commands, where values are in kilobytes and can range from 8
     11      to 1024: </p>
    1612    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> \
    1713--natsettings1 16000,128,128,0,0</pre>
    18     <p>
    19         This example illustrates tuning the NAT settings. The first
    20         parameter is the MTU, then the size of the socket's send buffer
    21         and the size of the socket's receive buffer, the initial size of
    22         the TCP send window, and lastly the initial size of the TCP
    23         receive window. Note that specifying zero means fallback to the
    24         default value.
    25       </p>
    26     <p>
    27         Each of these buffers has a default size of 64KB and default MTU
    28         is 1500.
    29       </p>
     14    <p>This example illustrates tuning the NAT settings. The first parameter is the MTU, then the size of the socket's
     15      send buffer and the size of the socket's receive buffer, the initial size of the TCP send window, and lastly the
     16      initial size of the TCP receive window. Note that specifying zero means fallback to the default value. </p>
     17    <p>Each of these buffers has a default size of 64KB and default MTU is 1500. </p>
    3018  </body>
    3119 

  • trunk/doc/manual/en_US/dita/topics/nat-adv-tftp.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         For network booting in NAT mode, by default <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses
    9         a built-in TFTP server at the IP address 10.0.2.4. This default
    10         behavior should work fine for typical remote-booting scenarios.
    11         However, it is possible to change the boot server IP and the
    12         location of the boot image with the following commands:
    13       </p>
     7    <p>For network booting in NAT mode, by default <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses a built-in
     8      TFTP server at the IP address 10.0.2.4. This default behavior should work fine for typical remote-booting
     9      scenarios. However, it is possible to change the boot server IP and the location of the boot image with the
     10      following commands: </p>
    1411    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> \
    1512--nattftpserver1 10.0.2.2

  • trunk/doc/manual/en_US/dita/topics/nat-bind-sockets.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         By default, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s NAT engine will route TCP/IP
    9         packets through the default interface assigned by the host's
    10         TCP/IP stack. The technical reason for this is that the NAT
    11         engine uses sockets for communication. If you want to change
    12         this behavior, you can tell the NAT engine to bind to a
    13         particular IP address instead. For example, use the following
    14         command:
    15       </p>
     7    <p>By default, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s NAT engine will route TCP/IP packets through
     8      the default interface assigned by the host's TCP/IP stack. The technical reason for this is that the NAT engine
     9      uses sockets for communication. If you want to change this behavior, you can tell the NAT engine to bind to a
     10      particular IP address instead. For example, use the following command: </p>
    1611    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> \
    1712--natbindip1 "10.45.0.2"</pre>
    18     <p>
    19         After this, all outgoing traffic will be sent through the
    20         interface with the IP address 10.45.0.2. Ensure that this
    21         interface is up and running before changing the NAT bind
    22         address.
    23       </p>
     13    <p>After this, all outgoing traffic will be sent through the interface with the IP address 10.45.0.2. Ensure that
     14      this interface is up and running before changing the NAT bind address. </p>
    2415  </body>
    2516 

  • trunk/doc/manual/en_US/dita/topics/nat-limitations.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8         There are some limitations of NAT mode which users should be
    9         aware of, as follows:
    10       </p>
     7    <p>There are some limitations of NAT mode which users should be aware of, as follows: </p>
    118    <ul>
    129      <li>
    … …  
    4744      </li>
    4845    </ul>
    49     <p> These limitations normally do not affect standard network use. But the presence of NAT has
    50       also subtle effects that may interfere with protocols that are normally working. One example
    51       is NFS, where the server is often configured to refuse connections from non-privileged ports,
    52       which are those ports above 1024. </p>
     46    <p>These limitations normally do not affect standard network use. But the presence of NAT has also subtle effects
     47      that may interfere with protocols that are normally working. One example is NFS, where the server is often
     48      configured to refuse connections from non-privileged ports, which are those ports above 1024. </p>
    5349  </body>
    5450 

  • trunk/doc/manual/en_US/dita/topics/nat-tftp.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         PXE booting is now supported in NAT mode. The NAT DHCP server
    9         provides a boot file name of the form
    10         <filepath><varname>vmname</varname>.pxe</filepath> if
    11         the directory <codeph>TFTP</codeph> exists in the directory
    12         where the user's <filepath>VirtualBox.xml</filepath> file is
    13         kept. It is the responsibility of the user to provide
    14         <filepath><varname>vmname</varname>.pxe</filepath>.
    15       </p>
     7    <p>PXE booting is now supported in NAT mode. The NAT DHCP server provides a boot file name of the form
     8          <filepath><varname>vmname</varname>.pxe</filepath> if the directory <codeph>TFTP</codeph> exists in the
     9      directory where the user's <filepath>VirtualBox.xml</filepath> file is kept. It is the responsibility of the user
     10      to provide <filepath><varname>vmname</varname>.pxe</filepath>. </p>
    1611  </body>
    1712 

  • trunk/doc/manual/en_US/dita/topics/nat_host_resolver_name_intercepting.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8           In some cases it might be useful to intercept the name
    9           resolving mechanism, providing a user-defined IP address on a
    10           particular DNS request. The intercepting mechanism enables the
    11           user to map not only a single host but domains and even more
    12           complex naming conventions if required.
    13         </p>
    14     <p>
    15           The following command sets a rule for mapping a name to a
    16           specified IP:
    17         </p>
     7    <p>In some cases it might be useful to intercept the name resolving mechanism, providing a user-defined IP address
     8      on a particular DNS request. The intercepting mechanism enables the user to map not only a single host but domains
     9      and even more complex naming conventions if required. </p>
     10    <p>The following command sets a rule for mapping a name to a specified IP: </p>
    1811    <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
    1912"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
    … …  
    2417<varname>unique-rule-name</varname>/HostName" <varname>hostname</varname>
    2518                     </pre>
    26     <p>
    27           The following command sets a rule for mapping a pattern name
    28           to a specified IP:
    29         </p>
     19    <p>The following command sets a rule for mapping a pattern name to a specified IP: </p>
    3020    <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
    3121"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
    … …  
    3626<varname>unique-rule-name</varname>/HostNamePattern" <varname>hostpattern</varname>
    3727                     </pre>
    38     <p>
    39           The host name pattern can include the following wildcard
    40           characters: pipe (<codeph>|</codeph>), question mark
    41           (<codeph>?</codeph>), and asterisk (<codeph>*</codeph>).
    42         </p>
    43     <p>
    44           This example demonstrates how to instruct the host-resolver
    45           mechanism to resolve all domain and probably some mirrors of
    46           www.blocked-site.info site with IP 127.0.0.1:
    47         </p>
     28    <p>The host name pattern can include the following wildcard characters: pipe (<codeph>|</codeph>), question mark
     29        (<codeph>?</codeph>), and asterisk (<codeph>*</codeph>). </p>
     30    <p>This example demonstrates how to instruct the host-resolver mechanism to resolve all domain and probably some
     31      mirrors of www.blocked-site.info site with IP 127.0.0.1: </p>
    4832    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    4933"VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/all_blocked_site/HostIP" 127.0.0.1
    5034$ VBoxManage setextradata <varname>VM-name</varname> \
    5135"VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/all_blocked_site/HostNamePattern" "*.blocked-site.*|*.fb.org"</pre>
    52     <p>
    53           The host resolver mechanism should be enabled to use
    54           user-defined mapping rules, otherwise they do not have any
    55           effect.
    56         </p>
     36    <p>The host resolver mechanism should be enabled to use user-defined mapping rules, otherwise they do not have any
     37      effect. </p>
    5738  </body>
    5839 

  • trunk/doc/manual/en_US/dita/topics/nat_host_resolver_proxy.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         For resolving network names, the DHCP server of the NAT engine
    9         offers a list of registered DNS servers of the host. If for some
    10         reason you need to hide this DNS server list and use the host's
    11         resolver settings, thereby forcing the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> NAT engine
    12         to intercept DNS requests and forward them to host's resolver,
    13         use the following command:
    14       </p>
     7    <p>For resolving network names, the DHCP server of the NAT engine offers a list of registered DNS servers of the
     8      host. If for some reason you need to hide this DNS server list and use the host's resolver settings, thereby
     9      forcing the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> NAT engine to intercept DNS requests and forward
     10      them to host's resolver, use the following command: </p>
    1511    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --natdnshostresolver1 on</pre>
    16     <p>
    17         Note that this setting is similar to the DNS proxy mode, however
    18         whereas the proxy mode just forwards DNS requests to the
    19         appropriate servers, the resolver mode will interpret the DNS
    20         requests and use the host's DNS API to query the information and
    21         return it to the guest.
    22       </p>
     12    <p>Note that this setting is similar to the DNS proxy mode, however whereas the proxy mode just forwards DNS
     13      requests to the appropriate servers, the resolver mode will interpret the DNS requests and use the host's DNS API
     14      to query the information and return it to the guest. </p>
    2315  </body>
    2416</topic>

  • trunk/doc/manual/en_US/dita/topics/natforward.dita

    r105293 r105335  
    55 
    66  <body>
    7     <p>
    8         As the virtual machine is connected to a private network
    9         internal to <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and invisible to the host, network
    10         services on the guest are not accessible to the host machine or
    11         to other computers on the same network. However, like a physical
    12         router, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can make selected services available to
    13         the world outside the guest through <i>port
    14         forwarding</i>. This means that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> listens to
    15         certain ports on the host and resends all packets which arrive
    16         there to the guest, on the same or a different port.
    17       </p>
    18     <p>
    19         To an application on the host or other physical or virtual
    20         machines on the network, it looks as though the service being
    21         proxied is actually running on the host. This also means that
    22         you cannot run the same service on the same ports on the host.
    23         However, you still gain the advantages of running the service in
    24         a virtual machine. For example, services on the host machine or
    25         on other virtual machines cannot be compromised or crashed by a
    26         vulnerability or a bug in the service, and the service can run
    27         in a different operating system than the host system.
    28       </p>
    29     <p>
    30         To configure port forwarding you can use the graphical
    31         <b outputclass="bold">Port Forwarding</b> editor which
    32         can be found in the <b outputclass="bold">Network</b>
    33         settings dialog for network adaptors configured to use NAT.
    34         Here, you can map host ports to guest ports to allow network
    35         traffic to be routed to a specific port in the guest.
    36       </p>
    37     <p> Alternatively, the command line tool <userinput>VBoxManage</userinput> can be used. See
    38         <xref href="vboxmanage-modifyvm.dita"/>. </p>
    39     <p>
    40         You will need to know which ports on the guest the service uses
    41         and to decide which ports to use on the host. You may want to
    42         use the same ports on the guest and on the host. You can use any
    43         ports on the host which are not already in use by a service. For
    44         example, to set up incoming NAT connections to an
    45         <userinput>ssh</userinput> server in the guest, use the following
    46         command:
    47       </p>
     7    <p>As the virtual machine is connected to a private network internal to <ph
     8        conkeyref="vbox-conkeyref-phrases/product-name"/> and invisible to the host, network services on the guest are
     9      not accessible to the host machine or to other computers on the same network. However, like a physical router, <ph
     10        conkeyref="vbox-conkeyref-phrases/product-name"/> can make selected services available to the world outside the
     11      guest through <i>port forwarding</i>. This means that <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     12      listens to certain ports on the host and resends all packets which arrive there to the guest, on the same or a
     13      different port. </p>
     14    <p>To an application on the host or other physical or virtual machines on the network, it looks as though the
     15      service being proxied is actually running on the host. This also means that you cannot run the same service on the
     16      same ports on the host. However, you still gain the advantages of running the service in a virtual machine. For
     17      example, services on the host machine or on other virtual machines cannot be compromised or crashed by a
     18      vulnerability or a bug in the service, and the service can run in a different operating system than the host
     19      system. </p>
     20    <p>To configure port forwarding you can use the graphical <b outputclass="bold">Port Forwarding</b> editor which can
     21      be found in the <b outputclass="bold">Network</b> settings dialog for network adaptors configured to use NAT.
     22      Here, you can map host ports to guest ports to allow network traffic to be routed to a specific port in the guest. </p>
     23    <p>Alternatively, the command line tool <userinput>VBoxManage</userinput> can be used. See <xref
     24        href="vboxmanage-modifyvm.dita"/>. </p>
     25    <p>You will need to know which ports on the guest the service uses and to decide which ports to use on the host. You
     26      may want to use the same ports on the guest and on the host. You can use any ports on the host which are not
     27      already in use by a service. For example, to set up incoming NAT connections to an <userinput>ssh</userinput>
     28      server in the guest, use the following command: </p>
    4829    <pre xml:space="preserve">VBoxManage modifyvm "VM name" --nat-pf1 "guestssh,tcp,,2222,,22"</pre>
    49     <p>
    50         In the above example, all TCP traffic arriving on port 2222 on
    51         any host interface will be forwarded to port 22 in the guest.
    52         The protocol name <codeph>tcp</codeph> is a mandatory
    53         attribute defining which protocol should be used for forwarding,
    54         <codeph>udp</codeph> could also be used. The name
    55         <codeph>guestssh</codeph> is purely descriptive and will be
    56         auto-generated if omitted. The number after
    57         <codeph>--nat-pf</codeph> denotes the network card, as with
    58         other <userinput>VBoxManage</userinput> commands.
    59       </p>
    60     <p>
    61         To remove this forwarding rule, use the following command:
    62       </p>
     30    <p>In the above example, all TCP traffic arriving on port 2222 on any host interface will be forwarded to port 22 in
     31      the guest. The protocol name <codeph>tcp</codeph> is a mandatory attribute defining which protocol should be used
     32      for forwarding, <codeph>udp</codeph> could also be used. The name <codeph>guestssh</codeph> is purely descriptive
     33      and will be auto-generated if omitted. The number after <codeph>--nat-pf</codeph> denotes the network card, as
     34      with other <userinput>VBoxManage</userinput> commands. </p>
     35    <p>To remove this forwarding rule, use the following command: </p>
    6336    <pre xml:space="preserve">VBoxManage modifyvm "VM name" --natpf1 delete "guestssh"</pre>
    64     <p>
    65         If for some reason the guest uses a static assigned IP address
    66         not leased from the built-in DHCP server, it is required to
    67         specify the guest IP when registering the forwarding rule, as
    68         follows:
    69       </p>
     37    <p>If for some reason the guest uses a static assigned IP address not leased from the built-in DHCP server, it is
     38      required to specify the guest IP when registering the forwarding rule, as follows: </p>
    7039    <pre xml:space="preserve">VBoxManage modifyvm "VM name" --natpf1 "guestssh,tcp,,2222,10.0.2.19,22"</pre>
    71     <p>
    72         This example is identical to the previous one, except that the
    73         NAT engine is being told that the guest can be found at the
    74         10.0.2.19 address.
    75       </p>
    76     <p>
    77         To forward <i>all</i> incoming traffic from a
    78         specific host interface to the guest, specify the IP of that
    79         host interface as follows:
    80       </p>
     40    <p>This example is identical to the previous one, except that the NAT engine is being told that the guest can be
     41      found at the 10.0.2.19 address. </p>
     42    <p>To forward <i>all</i> incoming traffic from a specific host interface to the guest, specify the IP of that host
     43      interface as follows: </p>
    8144    <pre xml:space="preserve">VBoxManage modifyvm "VM name" --natpf1 "guestssh,tcp,127.0.0.1,2222,,22"</pre>
    82     <p>
    83         This example forwards all TCP traffic arriving on the localhost
    84         interface at 127.0.0.1 through port 2222 to port 22 in the
    85         guest.
    86       </p>
     45    <p>This example forwards all TCP traffic arriving on the localhost interface at 127.0.0.1 through port 2222 to port
     46      22 in the guest. </p>
    8747    <p> It is possible to configure incoming NAT connections while the VM is running, see <xref
    8848        href="vboxmanage-controlvm.dita"/>. </p>

  • trunk/doc/manual/en_US/dita/topics/nested-virt.dita

    r105303 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports <i>nested
    9       virtualization</i>. This feature enables the passthrough of
    10       hardware virtualization functions to the guest VM. That means that
    11       you can install a hypervisor, such as <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, Oracle VM
    12       Server or KVM, on an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guest. You can then create and
    13       run VMs within the guest VM.
    14     </p>
    15     <p>
    16       Hardware virtualization features not present on the host CPU will
    17       not be exposed to the guest. In addition, some features such as
    18       nested paging are not yet supported for passthrough to the guest.
    19     </p>
    20     <p>
    21       You can enable the nested virtualization feature in one of the
    22       following ways:
    23     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports <i>nested virtualization</i>. This feature enables
     8      the passthrough of hardware virtualization functions to the guest VM. That means that you can install a
     9      hypervisor, such as <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, Oracle VM Server or KVM, on an <ph
     10        conkeyref="vbox-conkeyref-phrases/product-name"/> guest. You can then create and run VMs within the guest VM. </p>
     11    <p>Hardware virtualization features not present on the host CPU will not be exposed to the guest. In addition, some
     12      features such as nested paging are not yet supported for passthrough to the guest. </p>
     13    <p>You can enable the nested virtualization feature in one of the following ways: </p>
    2414    <ul>
    2515      <li>
    26         <p>
    27           From <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, select the <b outputclass="bold">Enable
    28           Nested VT-x/AMD-V</b> check box on the
    29           <b outputclass="bold">Processor</b> tab. To disable the
    30           feature, deselect the check box.
    31         </p>
     16        <p>From <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, select the <b outputclass="bold">Enable Nested
     17            VT-x/AMD-V</b> check box on the <b outputclass="bold">Processor</b> tab. To disable the feature, deselect
     18          the check box. </p>
    3219      </li>
    3320      <li>
    34         <p> Use the <codeph>--nested-hw-virt</codeph> option of the <userinput>VBoxManage
    35             modifyvm</userinput> command to enable or disable nested virtualization. See <xref
    36             href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref>. </p>
     21        <p>Use the <codeph>--nested-hw-virt</codeph> option of the <userinput>VBoxManage modifyvm</userinput> command to
     22          enable or disable nested virtualization. See <xref href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref>. </p>
    3723      </li>
    3824    </ul>

  • trunk/doc/manual/en_US/dita/topics/network-manager-cloud-network-tab.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         The Cloud Networks tab in Network Manager lists all cloud
    9         networks that are currently in use.
    10       </p>
     7    <p>The Cloud Networks tab in Network Manager lists all cloud networks that are currently in use. </p>
    118    <ul>
    129      <li>
    13         <p>
    14             Click <b outputclass="bold">Create</b> to add a new
    15             cloud network to the list.
    16           </p>
     10        <p>Click <b outputclass="bold">Create</b> to add a new cloud network to the list. </p>
    1711      </li>
    1812      <li>
    19         <p>
    20             Click <b outputclass="bold">Remove</b> to remove a
    21             cloud network from the list.
    22           </p>
     13        <p>Click <b outputclass="bold">Remove</b> to remove a cloud network from the list. </p>
    2314      </li>
    2415      <li>
    25         <p>
    26             Click <b outputclass="bold">Properties</b> to show or
    27             hide settings for the selected cloud network.
    28           </p>
     16        <p>Click <b outputclass="bold">Properties</b> to show or hide settings for the selected cloud network. </p>
    2917      </li>
    3018    </ul>
    31     <p>
    32         To configure a cloud network, select the network name in the
    33         <b outputclass="bold">Name</b> field and specify the
    34         following:
    35       </p>
     19    <p>To configure a cloud network, select the network name in the <b outputclass="bold">Name</b> field and specify the
     20      following: </p>
    3621    <ul>
    3722      <li>
    … …  
    5641            subnets on <ph conkeyref="vbox-conkeyref-phrases/oci"/> that are available for tunneling traffic.
    5742          </p>
    58         <p>
    59             See <xref href="cloud-using-cloud-networks.dita#cloud-using-cloud-networks"/> for details
    60             of how you can use the <userinput>VBoxManage cloud</userinput>
    61             command to create and configure a virtual cloud network
    62             (VCN) on <ph conkeyref="vbox-conkeyref-phrases/oci"/>.
    63           </p>
     43        <p>See <xref href="cloud-using-cloud-networks.dita#cloud-using-cloud-networks"/> for details of how you can use
     44          the <userinput>VBoxManage cloud</userinput> command to create and configure a virtual cloud network (VCN) on
     45            <ph conkeyref="vbox-conkeyref-phrases/oci"/>. </p>
    6446      </li>
    6547    </ul>

  • trunk/doc/manual/en_US/dita/topics/network-manager-host-only-tab.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         The Host-Only Networks tab in Network Manager lists all
    9         host-only networks that are currently in use.
    10       </p>
     7    <p>The Host-Only Networks tab in Network Manager lists all host-only networks that are currently in use. </p>
    118    <ul>
    129      <li>
    13         <p>
    14             Click <b outputclass="bold">Create</b> to add a new
    15             host-only network to the list.
    16           </p>
     10        <p>Click <b outputclass="bold">Create</b> to add a new host-only network to the list. </p>
    1711      </li>
    1812      <li>
    19         <p>
    20             Click <b outputclass="bold">Remove</b> to remove a
    21             host-only network from the list.
    22           </p>
     13        <p>Click <b outputclass="bold">Remove</b> to remove a host-only network from the list. </p>
    2314      </li>
    2415      <li>
    25         <p>
    26             Click <b outputclass="bold">Properties</b> to show or
    27             hide settings for the selected host-only network.
    28           </p>
     16        <p>Click <b outputclass="bold">Properties</b> to show or hide settings for the selected host-only network. </p>
    2917      </li>
    3018    </ul>
    31     <p>
    32         To configure a host-only network, select the network name in the
    33         <b outputclass="bold">Name</b> field and do the
    34         following:
    35       </p>
     19    <p>To configure a host-only network, select the network name in the <b outputclass="bold">Name</b> field and do the
     20      following: </p>
    3621    <ul>
    3722      <li>
    38         <p>
    39             Use the <b outputclass="bold">Adapter</b> tab to
    40             configure the network adapter for the host-only network.
    41           </p>
     23        <p>Use the <b outputclass="bold">Adapter</b> tab to configure the network adapter for the host-only network. </p>
    4224      </li>
    4325      <li>
    44         <p>
    45             Use the <b outputclass="bold">DHCP Server</b> tab to
    46             configure settings for the DHCP server used by the host-only
    47             network. The DHCP server is built into <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and
    48             manages IP addresses for the network automatically.
    49           </p>
     26        <p>Use the <b outputclass="bold">DHCP Server</b> tab to configure settings for the DHCP server used by the
     27          host-only network. The DHCP server is built into <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and
     28          manages IP addresses for the network automatically. </p>
    5029      </li>
    5130    </ul>

  • trunk/doc/manual/en_US/dita/topics/network-manager-nat-network-tab.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8         The NAT Networks tab in Network Manager lists all NAT networks
    9         that are currently in use.
    10       </p>
     7    <p>The NAT Networks tab in Network Manager lists all NAT networks that are currently in use. </p>
    118    <ul>
    129      <li>
    … …  
    2926      </li>
    3027    </ul>
    31     <p>
    32         To configure a NAT network, select the network name in the
    33         <b outputclass="bold">Name</b> field and do the
    34         following:
    35       </p>
     28    <p>To configure a NAT network, select the network name in the <b outputclass="bold">Name</b> field and do the
     29      following: </p>
    3630    <ul>
    3731      <li>
    38         <p>
    39             Use the <b outputclass="bold">General Options</b> tab
    40             to configure the network settings used by the NAT network.
    41             For example, the network address and mask of the NAT service
    42             interface.
    43           </p>
     32        <p>Use the <b outputclass="bold">General Options</b> tab to configure the network settings used by the NAT
     33          network. For example, the network address and mask of the NAT service interface. </p>
    4434      </li>
    4535      <li>
    46         <p>
    47             Use the <b outputclass="bold">Port Forwarding</b> tab
    48             to configure port forwarding rules used by the NAT network.
    49           </p>
     36        <p>Use the <b outputclass="bold">Port Forwarding</b> tab to configure port forwarding rules used by the NAT
     37          network. </p>
    5038      </li>
    5139    </ul>

  • trunk/doc/manual/en_US/dita/topics/network-manager.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       The <b outputclass="bold">Network Manager</b> tool in
    9       <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> enables you to create, delete, and configure the
    10       following types of networks used by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>:
    11     </p>
     7    <p>The <b outputclass="bold">Network Manager</b> tool in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> enables
     8      you to create, delete, and configure the following types of networks used by <ph
     9        conkeyref="vbox-conkeyref-phrases/product-name"/>: </p>
    1210    <ul>
    1311      <li>
    14         <p>
    15           Host-only networks. See
    16           <xref href="network-manager-host-only-tab.dita#network-manager-host-only-tab"/>.
    17         </p>
     12        <p>Host-only networks. See <xref href="network-manager-host-only-tab.dita#network-manager-host-only-tab"/>. </p>
    1813      </li>
    1914      <li>
    20         <p>
    21           NAT networks. See
    22           <xref href="network-manager-nat-network-tab.dita#network-manager-nat-network-tab"/>.
    23         </p>
     15        <p>NAT networks. See <xref href="network-manager-nat-network-tab.dita#network-manager-nat-network-tab"/>. </p>
    2416      </li>
    2517      <li>
    26         <p>
    27           Cloud networks. See
    28           <xref href="network-manager-cloud-network-tab.dita#network-manager-cloud-network-tab"/>.
    29         </p>
     18        <p>Cloud networks. See <xref href="network-manager-cloud-network-tab.dita#network-manager-cloud-network-tab"/>. </p>
    3019      </li>
    3120    </ul>
    32     <p>
    33       To display the Network Manager, go to the global
    34       <b outputclass="bold">Tools</b> menu and click
    35       <b outputclass="bold">Network</b>.
    36     </p>
     21    <p>To display the Network Manager, go to the global <b outputclass="bold">Tools</b> menu and click <b
     22        outputclass="bold">Network</b>. </p>
    3723  </body>
    3824</topic>

  • trunk/doc/manual/en_US/dita/topics/network_bandwidth_limit.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports limiting of the maximum bandwidth used for
    9       network transmission. Several network adapters of one VM may share
    10       limits through bandwidth groups. It is possible to have more than
    11       one such limit.
    12     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports limiting of the maximum bandwidth used for network
     8      transmission. Several network adapters of one VM may share limits through bandwidth groups. It is possible to have
     9      more than one such limit. </p>
    1310    <note>
    14       <p>
    15         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> shapes VM traffic only in the transmit direction,
    16         delaying the packets being sent by virtual machines. It does not
    17         limit the traffic being received by virtual machines.
    18       </p>
     11      <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> shapes VM traffic only in the transmit direction,
     12        delaying the packets being sent by virtual machines. It does not limit the traffic being received by virtual
     13        machines. </p>
    1914    </note>
    20     <p>
    21       Limits are configured through <userinput>VBoxManage</userinput>. The
    22       following example creates a bandwidth group named Limit, sets the
    23       limit to 20 Mbps and assigns the group to the first and second
    24       adapters of the VM:
    25     </p>
     15    <p>Limits are configured through <userinput>VBoxManage</userinput>. The following example creates a bandwidth group
     16      named Limit, sets the limit to 20 Mbps and assigns the group to the first and second adapters of the VM: </p>
    2617    <pre xml:space="preserve">VBoxManage bandwidthctl "VM name" add Limit --type network --limit 20m
    2718VBoxManage modifyvm "VM name" --nicbandwidthgroup1 Limit
    2819VBoxManage modifyvm "VM name" --nicbandwidthgroup2 Limit</pre>
    29     <p>
    30       All adapters in a group share the bandwidth limit, meaning that in
    31       the example above the bandwidth of both adapters combined can
    32       never exceed 20 Mbps. However, if one adapter does not require
    33       bandwidth the other can use the remaining bandwidth of its group.
    34     </p>
    35     <p>
    36       The limits for each group can be changed while the VM is running,
    37       with changes being picked up immediately. The following example
    38       changes the limit for the group created in the previous example to
    39       100 Kbps:
    40     </p>
     20    <p>All adapters in a group share the bandwidth limit, meaning that in the example above the bandwidth of both
     21      adapters combined can never exceed 20 Mbps. However, if one adapter does not require bandwidth the other can use
     22      the remaining bandwidth of its group. </p>
     23    <p>The limits for each group can be changed while the VM is running, with changes being picked up immediately. The
     24      following example changes the limit for the group created in the previous example to 100 Kbps: </p>
    4125    <pre xml:space="preserve">VBoxManage bandwidthctl "VM name" set Limit --limit 100k</pre>
    42     <p>
    43       To completely disable shaping for the first adapter of VM use the
    44       following command:
    45     </p>
     26    <p>To completely disable shaping for the first adapter of VM use the following command: </p>
    4627    <pre xml:space="preserve">VBoxManage modifyvm "VM name" --nicbandwidthgroup1 none</pre>
    47     <p>
    48       It is also possible to disable shaping for all adapters assigned
    49       to a bandwidth group while VM is running, by specifying the zero
    50       limit for the group. For example, for the bandwidth group named
    51       Limit:
    52     </p>
     28    <p>It is also possible to disable shaping for all adapters assigned to a bandwidth group while VM is running, by
     29      specifying the zero limit for the group. For example, for the bandwidth group named Limit: </p>
    5330    <pre xml:space="preserve">VBoxManage bandwidthctl "VM name" set Limit --limit 0</pre>
    5431  </body>

  • trunk/doc/manual/en_US/dita/topics/network_bridged.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       With bridged networking, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses a device driver on
    9       your <i>host</i> system that filters data from your
    10       physical network adapter. This driver is therefore called a
    11       <i>net filter</i> driver. This enables
    12       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to intercept data from the physical network and
    13       inject data into it, effectively creating a new network interface
    14       in software. When a guest is using such a new software interface,
    15       it looks to the host system as though the guest were physically
    16       connected to the interface using a network cable. The host can
    17       send data to the guest through that interface and receive data
    18       from it. This means that you can set up routing or bridging
    19       between the guest and the rest of your network.
    20     </p>
     7    <p>With bridged networking, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses a device driver on your
     8        <i>host</i> system that filters data from your physical network adapter. This driver is therefore called a
     9        <i>net filter</i> driver. This enables <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to intercept data
     10      from the physical network and inject data into it, effectively creating a new network interface in software. When
     11      a guest is using such a new software interface, it looks to the host system as though the guest were physically
     12      connected to the interface using a network cable. The host can send data to the guest through that interface and
     13      receive data from it. This means that you can set up routing or bridging between the guest and the rest of your
     14      network. </p>
    2115    <note>
    22       <p>
    23         Even though TAP interfaces are no longer necessary on Linux for
    24         bridged networking, you <i>can</i> still use TAP
    25         interfaces for certain advanced setups, since you can connect a
    26         VM to any host interface.
    27       </p>
     16      <p>Even though TAP interfaces are no longer necessary on Linux for bridged networking, you <i>can</i> still use
     17        TAP interfaces for certain advanced setups, since you can connect a VM to any host interface. </p>
    2818    </note>
    29     <p>
    30       To enable bridged networking, open the
    31       <b outputclass="bold">Settings</b> dialog of a virtual
    32       machine, go to the <b outputclass="bold">Network</b> page
    33       and select <b outputclass="bold">Bridged Network</b> in the
    34       drop-down list for the <b outputclass="bold">Attached
    35       To</b> field. Select a host interface from the list at the
    36       bottom of the page, which contains the physical network interfaces
    37       of your systems. On a typical MacBook, for example, this will
    38       allow you to select between en1: AirPort, which is the wireless
    39       interface, and en0: Ethernet, which represents the interface with
    40       a network cable.
    41     </p>
     19    <p>To enable bridged networking, open the <b outputclass="bold">Settings</b> dialog of a virtual machine, go to the
     20        <b outputclass="bold">Network</b> page and select <b outputclass="bold">Bridged Network</b> in the drop-down
     21      list for the <b outputclass="bold">Attached To</b> field. Select a host interface from the list at the bottom of
     22      the page, which contains the physical network interfaces of your systems. On a typical MacBook, for example, this
     23      will allow you to select between en1: AirPort, which is the wireless interface, and en0: Ethernet, which
     24      represents the interface with a network cable. </p>
    4225    <note>
    43       <p>
    44         Bridging to a wireless interface is done differently from
    45         bridging to a wired interface, because most wireless adapters do
    46         not support promiscuous mode. All traffic has to use the MAC
    47         address of the host's wireless adapter, and therefore
    48         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to replace the source MAC address in the
    49         Ethernet header of an outgoing packet to make sure the reply
    50         will be sent to the host interface. When <ph conkeyref="vbox-conkeyref-phrases/product-name"/> sees an
    51         incoming packet with a destination IP address that belongs to
    52         one of the virtual machine adapters it replaces the destination
    53         MAC address in the Ethernet header with the VM adapter's MAC
    54         address and passes it on. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> examines ARP and DHCP
    55         packets in order to learn the IP addresses of virtual machines.
    56       </p>
     26      <p>Bridging to a wireless interface is done differently from bridging to a wired interface, because most wireless
     27        adapters do not support promiscuous mode. All traffic has to use the MAC address of the host's wireless adapter,
     28        and therefore <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to replace the source MAC address in
     29        the Ethernet header of an outgoing packet to make sure the reply will be sent to the host interface. When <ph
     30          conkeyref="vbox-conkeyref-phrases/product-name"/> sees an incoming packet with a destination IP address that
     31        belongs to one of the virtual machine adapters it replaces the destination MAC address in the Ethernet header
     32        with the VM adapter's MAC address and passes it on. <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     33        examines ARP and DHCP packets in order to learn the IP addresses of virtual machines. </p>
    5734    </note>
    58     <p>
    59       Depending on your host operating system, the following limitations
    60       apply:
    61     </p>
     35    <p>Depending on your host operating system, the following limitations apply: </p>
    6236    <ul>
    6337      <li>
    … …  
    9468          Oracle Solaris 11.
    9569        </p>
    96         <p>
    97           On Oracle Solaris 11 hosts build 159 and above, it is possible
    98           to use Oracle Solaris Crossbow Virtual Network Interfaces
    99           (VNICs) directly with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> without any additional
    100           configuration other than each VNIC must be exclusive for every
    101           guest network interface.
    102         </p>
    103         <p>
    104           When using VLAN interfaces with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, they must be
    105           named according to the PPA-hack naming scheme, such as
    106           e1000g513001. Otherwise, the guest may receive packets in an
    107           unexpected format.
    108         </p>
     70        <p>On Oracle Solaris 11 hosts build 159 and above, it is possible to use Oracle Solaris Crossbow Virtual Network
     71          Interfaces (VNICs) directly with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> without any additional
     72          configuration other than each VNIC must be exclusive for every guest network interface. </p>
     73        <p>When using VLAN interfaces with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, they must be named
     74          according to the PPA-hack naming scheme, such as e1000g513001. Otherwise, the guest may receive packets in an
     75          unexpected format. </p>
    10976      </li>
    11077    </ul>

  • trunk/doc/manual/en_US/dita/topics/network_cloud.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       Cloud networks can be used for connections from a local VM to a
    9       subnet on a remote <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance. See
    10       <xref href="network-manager-cloud-network-tab.dita#network-manager-cloud-network-tab"/> for details of
    11       how to create and configure a cloud network using the Network
    12       Manager tool in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>.
    13     </p>
    14     <p>
    15       To enable a cloud network interface for a virtual machine, do
    16       either of the following:
    17     </p>
     7    <p>Cloud networks can be used for connections from a local VM to a subnet on a remote <ph
     8        conkeyref="vbox-conkeyref-phrases/oci"/> instance. See <xref
     9        href="network-manager-cloud-network-tab.dita#network-manager-cloud-network-tab"/> for details of how to create
     10      and configure a cloud network using the Network Manager tool in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p>
     11    <p>To enable a cloud network interface for a virtual machine, do either of the following: </p>
    1812    <ul>
    1913      <li>
    20         <p>
    21           Go to the <b outputclass="bold">Network</b> page in the
    22           virtual machine's <b outputclass="bold">Settings</b>
    23           dialog and select an <b outputclass="bold">Adapter</b>
    24           tab. Ensure that the <b outputclass="bold">Enable Network
    25           Adapter</b> check box is selected and choose
    26           <b outputclass="bold">Cloud Network</b> for the
    27           <b outputclass="bold">Attached To</b> field.
    28         </p>
     14        <p>Go to the <b outputclass="bold">Network</b> page in the virtual machine's <b outputclass="bold">Settings</b>
     15          dialog and select an <b outputclass="bold">Adapter</b> tab. Ensure that the <b outputclass="bold">Enable
     16            Network Adapter</b> check box is selected and choose <b outputclass="bold">Cloud Network</b> for the <b
     17            outputclass="bold">Attached To</b> field. </p>
    2918      </li>
    3019      <li>
    31         <p> On the command line, use <userinput>VBoxManage modifyvm vmname --nic
    32               <varname>x</varname> cloud</userinput>. See <xref href="vboxmanage-modifyvm.dita"/>. </p>
     20        <p>On the command line, use <userinput>VBoxManage modifyvm vmname --nic <varname>x</varname> cloud</userinput>.
     21          See <xref href="vboxmanage-modifyvm.dita"/>. </p>
    3322      </li>
    3423    </ul>

  • trunk/doc/manual/en_US/dita/topics/network_hostonly.dita

    r105293 r105335  
    55 
    66  <body>
    7     <p>
    8       Host-only networking can be thought of as a hybrid between the
    9       bridged and internal networking modes. As with bridged networking,
    10       the virtual machines can talk to each other and the host as if
    11       they were connected through a physical Ethernet switch. As with
    12       internal networking, a physical networking interface need not be
    13       present, and the virtual machines cannot talk to the world outside
    14       the host since they are not connected to a physical networking
    15       interface.
    16     </p>
    17     <p>
    18       When host-only networking is used, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates a new
    19       software interface on the host which then appears next to your
    20       existing network interfaces. In other words, whereas with bridged
    21       networking an existing physical interface is used to attach
    22       virtual machines to, with host-only networking a new
    23       <i>loopback</i> interface is created on the host.
    24       And whereas with internal networking, the traffic between the
    25       virtual machines cannot be seen, the traffic on the loopback
    26       interface on the host can be intercepted.
    27     </p>
     7    <p>Host-only networking can be thought of as a hybrid between the bridged and internal networking modes. As with
     8      bridged networking, the virtual machines can talk to each other and the host as if they were connected through a
     9      physical Ethernet switch. As with internal networking, a physical networking interface need not be present, and
     10      the virtual machines cannot talk to the world outside the host since they are not connected to a physical
     11      networking interface. </p>
     12    <p>When host-only networking is used, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates a new software
     13      interface on the host which then appears next to your existing network interfaces. In other words, whereas with
     14      bridged networking an existing physical interface is used to attach virtual machines to, with host-only networking
     15      a new <i>loopback</i> interface is created on the host. And whereas with internal networking, the traffic between
     16      the virtual machines cannot be seen, the traffic on the loopback interface on the host can be intercepted. </p>
    2817    <note>
    29       <p>
    30         Hosts running recent macOS versions do not support host-only
    31         adapters. These adapters are replaced by host-only networks,
    32         which define a network mask and an IP address range, where the
    33         host network interface receives the lowest address in the range.
    34       </p>
    35       <p>
    36         The host network interface gets added and removed dynamically by
    37         the operating system, whenever a host-only network is used by
    38         virtual machines.
    39       </p>
    40       <p>
    41         On macOS hosts, choose the <b outputclass="bold">Host-Only
    42         Network</b> option when configuring a network adapter.
    43         The <b outputclass="bold">Host-Only Adapter</b> option is
    44         provided for legacy support.
    45       </p>
     18      <p>Hosts running recent macOS versions do not support host-only adapters. These adapters are replaced by host-only
     19        networks, which define a network mask and an IP address range, where the host network interface receives the
     20        lowest address in the range. </p>
     21      <p>The host network interface gets added and removed dynamically by the operating system, whenever a host-only
     22        network is used by virtual machines. </p>
     23      <p>On macOS hosts, choose the <b outputclass="bold">Host-Only Network</b> option when configuring a network
     24        adapter. The <b outputclass="bold">Host-Only Adapter</b> option is provided for legacy support. </p>
    4625    </note>
    47     <p>
    48       Host-only networking is particularly useful for preconfigured
    49       virtual appliances, where multiple virtual machines are shipped
    50       together and designed to cooperate. For example, one virtual
    51       machine may contain a web server and a second one a database, and
    52       since they are intended to talk to each other, the appliance can
    53       instruct <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to set up a host-only network for the two.
    54       A second, bridged, network would then connect the web server to
    55       the outside world to serve data to, but the outside world cannot
    56       connect to the database.
    57     </p>
    58     <p>
    59       To enable a host-only network interface for a virtual machine, do
    60       either of the following:
    61     </p>
     26    <p>Host-only networking is particularly useful for preconfigured virtual appliances, where multiple virtual machines
     27      are shipped together and designed to cooperate. For example, one virtual machine may contain a web server and a
     28      second one a database, and since they are intended to talk to each other, the appliance can instruct <ph
     29        conkeyref="vbox-conkeyref-phrases/product-name"/> to set up a host-only network for the two. A second, bridged,
     30      network would then connect the web server to the outside world to serve data to, but the outside world cannot
     31      connect to the database. </p>
     32    <p>To enable a host-only network interface for a virtual machine, do either of the following: </p>
    6233    <ul>
    6334      <li>
    64         <p>
    65           Go to the <b outputclass="bold">Network</b> page in the
    66           virtual machine's <b outputclass="bold">Settings</b>
    67           dialog and select an <b outputclass="bold">Adapter</b>
    68           tab. Ensure that the <b outputclass="bold">Enable Network
    69           Adapter</b> check box is selected and choose
    70           <b outputclass="bold">Host-Only Adapter</b> for the
    71           <b outputclass="bold">Attached To</b> field.
    72         </p>
     35        <p>Go to the <b outputclass="bold">Network</b> page in the virtual machine's <b outputclass="bold">Settings</b>
     36          dialog and select an <b outputclass="bold">Adapter</b> tab. Ensure that the <b outputclass="bold">Enable
     37            Network Adapter</b> check box is selected and choose <b outputclass="bold">Host-Only Adapter</b> for the <b
     38            outputclass="bold">Attached To</b> field. </p>
    7339      </li>
    7440      <li>
    75         <p> On the command line, use <userinput>VBoxManage modifyvm vmname --nic
    76               <varname>x</varname> hostonly</userinput>. See <xref href="vboxmanage-modifyvm.dita"
    77           />. </p>
     41        <p>On the command line, use <userinput>VBoxManage modifyvm vmname --nic <varname>x</varname>
     42            hostonly</userinput>. See <xref href="vboxmanage-modifyvm.dita"/>. </p>
    7843      </li>
    7944    </ul>
    80     <p>
    81       For host-only networking, as with internal networking, you may
    82       find the DHCP server useful that is built into <ph conkeyref="vbox-conkeyref-phrases/product-name"/>.
    83       This is enabled by default and manages the IP addresses in the
    84       host-only network. Without the DHCP server you would need to
    85       configure all IP addresses statically.
    86     </p>
     45    <p>For host-only networking, as with internal networking, you may find the DHCP server useful that is built into <ph
     46        conkeyref="vbox-conkeyref-phrases/product-name"/>. This is enabled by default and manages the IP addresses in
     47      the host-only network. Without the DHCP server you would need to configure all IP addresses statically. </p>
    8748    <ul>
    8849      <li>
    89         <p>
    90           In <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> you can configure the DHCP server by choosing
    91           <b outputclass="bold">File</b>,
    92           <b outputclass="bold">Tools</b>,
    93           <b outputclass="bold">Network Manager</b>. The Network
    94           Manager window lists all host-only networks which are
    95           presently in use. Select the network name and then use the
    96           <b outputclass="bold">DHCP Server</b> tab to configure
    97           DHCP server settings. See <xref href="network-manager.dita#network-manager"/>.
    98         </p>
     50        <p>In <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> you can configure the DHCP server by choosing <b
     51            outputclass="bold">File</b>, <b outputclass="bold">Tools</b>, <b outputclass="bold">Network Manager</b>. The
     52          Network Manager window lists all host-only networks which are presently in use. Select the network name and
     53          then use the <b outputclass="bold">DHCP Server</b> tab to configure DHCP server settings. See <xref
     54            href="network-manager.dita#network-manager"/>. </p>
    9955      </li>
    10056      <li>
    101         <p> Alternatively, you can use the <userinput>VBoxManage dhcpserver</userinput> command. See
    102             <xref href="vboxmanage-dhcpserver.dita"/>. </p>
     57        <p>Alternatively, you can use the <userinput>VBoxManage dhcpserver</userinput> command. See <xref
     58            href="vboxmanage-dhcpserver.dita"/>. </p>
    10359      </li>
    10460    </ul>
    10561    <note>
    106       <p>
    107         On Linux and macOS hosts the number of host-only interfaces is
    108         limited to 128. There is no such limit for Oracle Solaris and
    109         Windows hosts.
    110       </p>
     62      <p>On Linux and macOS hosts the number of host-only interfaces is limited to 128. There is no such limit for
     63        Oracle Solaris and Windows hosts. </p>
    11164    </note>
    112     <p> On Linux, macOS and Solaris <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will only
    113       allow IP addresses in 192.168.56.0/21 range to be assigned to host-only adapters. For IPv6
    114       only link-local addresses are allowed. If other ranges are required, they can be enabled by
    115       creating <filepath>/etc/vbox/networks.conf</filepath> and specifying allowed ranges there. For
    116       example, to allow 10.0.0.0/8 and 192.168.0.0/16 IPv4 ranges as well as 2001::/64 range put the
    117       following lines into <filepath>/etc/vbox/networks.conf</filepath>: </p>
     65    <p>On Linux, macOS and Solaris <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will only allow IP addresses in
     66      192.168.56.0/21 range to be assigned to host-only adapters. For IPv6 only link-local addresses are allowed. If
     67      other ranges are required, they can be enabled by creating <filepath>/etc/vbox/networks.conf</filepath> and
     68      specifying allowed ranges there. For example, to allow 10.0.0.0/8 and 192.168.0.0/16 IPv4 ranges as well as
     69      2001::/64 range put the following lines into <filepath>/etc/vbox/networks.conf</filepath>: </p>
    11870    <pre xml:space="preserve">      * 10.0.0.0/8 192.168.0.0/16
    11971      * 2001::/64
    12072      </pre>
    121     <p>
    122       Lines starting with the hash <userinput>#</userinput> are ignored. The
    123       following example allows any addresses, effectively disabling
    124       range control:
    125     </p>
     73    <p>Lines starting with the hash <userinput>#</userinput> are ignored. The following example allows any addresses,
     74      effectively disabling range control: </p>
    12675    <pre xml:space="preserve">      * 0.0.0.0/0 ::/0
    12776      </pre>
    128     <p>
    129       If the file exists, but no ranges are specified in it, no
    130       addresses will be assigned to host-only adapters. The following
    131       example effectively disables all ranges:
    132     </p>
     77    <p>If the file exists, but no ranges are specified in it, no addresses will be assigned to host-only adapters. The
     78      following example effectively disables all ranges: </p>
    13379    <pre xml:space="preserve">      # No addresses are allowed for host-only adapters
    13480      </pre>

  • trunk/doc/manual/en_US/dita/topics/network_nat.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       Network Address Translation (NAT) is the simplest way of accessing
    9       an external network from a virtual machine. Usually, it does not
    10       require any configuration on the host network and guest system.
    11       For this reason, it is the default networking mode in
    12       <ph conkeyref="vbox-conkeyref-phrases/product-name"/>.
    13     </p>
    14     <p>
    15       A virtual machine with NAT enabled acts much like a real computer
    16       that connects to the Internet through a router. The router, in
    17       this case, is the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> networking engine, which maps
    18       traffic from and to the virtual machine transparently. In
    19       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> this router is placed between each virtual machine
    20       and the host. This separation maximizes security since by default
    21       virtual machines cannot talk to each other.
    22     </p>
    23     <p>
    24       The disadvantage of NAT mode is that, much like a private network
    25       behind a router, the virtual machine is invisible and unreachable
    26       from the outside internet. You cannot run a server this way unless
    27       you set up port forwarding. See <xref href="natforward.dita#natforward"/>.
    28     </p>
    29     <p>
    30       The network frames sent out by the guest operating system are
    31       received by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s NAT engine, which extracts the TCP/IP
    32       data and resends it using the host operating system. To an
    33       application on the host, or to another computer on the same
    34       network as the host, it looks like the data was sent by the
    35       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> application on the host, using an IP address
    36       belonging to the host. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> listens for replies to the
    37       packages sent, and repacks and resends them to the guest machine
    38       on its private network.
    39     </p>
     7    <p>Network Address Translation (NAT) is the simplest way of accessing an external network from a virtual machine.
     8      Usually, it does not require any configuration on the host network and guest system. For this reason, it is the
     9      default networking mode in <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p>
     10    <p>A virtual machine with NAT enabled acts much like a real computer that connects to the Internet through a router.
     11      The router, in this case, is the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> networking engine, which
     12      maps traffic from and to the virtual machine transparently. In <ph conkeyref="vbox-conkeyref-phrases/product-name"
     13      /> this router is placed between each virtual machine and the host. This separation maximizes security since by
     14      default virtual machines cannot talk to each other. </p>
     15    <p>The disadvantage of NAT mode is that, much like a private network behind a router, the virtual machine is
     16      invisible and unreachable from the outside internet. You cannot run a server this way unless you set up port
     17      forwarding. See <xref href="natforward.dita#natforward"/>. </p>
     18    <p>The network frames sent out by the guest operating system are received by <ph
     19        conkeyref="vbox-conkeyref-phrases/product-name"/>'s NAT engine, which extracts the TCP/IP data and resends it
     20      using the host operating system. To an application on the host, or to another computer on the same network as the
     21      host, it looks like the data was sent by the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> application on
     22      the host, using an IP address belonging to the host. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> listens
     23      for replies to the packages sent, and repacks and resends them to the guest machine on its private network. </p>
    4024    <note>
    41       <p>
    42         Even though the NAT engine separates the VM from the host, the
    43         VM has access to the host's loopback interface and the network
    44         services running on it. The host's loopback interface is
    45         accessible as IP address 10.0.2.2. This access to the host's
    46         loopback interface can be extremely useful in some cases, for
    47         example when running a web application under development in the
    48         VM and the database server on the loopback interface on the
    49         host.
    50       </p>
     25      <p>Even though the NAT engine separates the VM from the host, the VM has access to the host's loopback interface
     26        and the network services running on it. The host's loopback interface is accessible as IP address 10.0.2.2. This
     27        access to the host's loopback interface can be extremely useful in some cases, for example when running a web
     28        application under development in the VM and the database server on the loopback interface on the host. </p>
    5129    </note>
    52     <p>
    53       The virtual machine receives its network address and configuration
    54       on the private network from a DHCP server integrated into
    55       <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. The IP address thus assigned to the virtual
    56       machine is usually on a completely different network than the
    57       host. As more than one card of a virtual machine can be set up to
    58       use NAT, the first card is connected to the private network
    59       10.0.2.0, the second card to the network 10.0.3.0 and so on. If
    60       you need to change the guest-assigned IP range, see
    61       <xref href="changenat.dita">Fine Tuning the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> NAT Engine</xref>.
    62     </p>
     30    <p>The virtual machine receives its network address and configuration on the private network from a DHCP server
     31      integrated into <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. The IP address thus assigned to the virtual
     32      machine is usually on a completely different network than the host. As more than one card of a virtual machine can
     33      be set up to use NAT, the first card is connected to the private network 10.0.2.0, the second card to the network
     34      10.0.3.0 and so on. If you need to change the guest-assigned IP range, see <xref href="changenat.dita">Fine Tuning
     35        the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> NAT Engine</xref>. </p>
    6336  </body>
    6437</topic>

  • trunk/doc/manual/en_US/dita/topics/network_nat_service.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       The Network Address Translation (NAT) service works in a similar
    9       way to a home router, grouping the systems using it into a network
    10       and preventing systems outside of this network from directly
    11       accessing systems inside it, but letting systems inside
    12       communicate with each other and with systems outside using TCP and
    13       UDP over IPv4 and IPv6.
    14     </p>
    15     <p>
    16       A NAT service is attached to an internal network. Virtual machines
    17       which are to make use of it should be attached to that internal
    18       network. The name of internal network is chosen when the NAT
    19       service is created and the internal network will be created if it
    20       does not already exist. The following is an example command to
    21       create a NAT network:
    22     </p>
     7    <p>The Network Address Translation (NAT) service works in a similar way to a home router, grouping the systems using
     8      it into a network and preventing systems outside of this network from directly accessing systems inside it, but
     9      letting systems inside communicate with each other and with systems outside using TCP and UDP over IPv4 and IPv6. </p>
     10    <p>A NAT service is attached to an internal network. Virtual machines which are to make use of it should be attached
     11      to that internal network. The name of internal network is chosen when the NAT service is created and the internal
     12      network will be created if it does not already exist. The following is an example command to create a NAT network: </p>
    2313    <pre xml:space="preserve">VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable</pre>
    24     <p>
    25       Here, natnet1 is the name of the internal network to be used and
    26       192.168.15.0/24 is the network address and mask of the NAT service
    27       interface. By default in this static configuration the gateway
    28       will be assigned the address 192.168.15.1, the address following
    29       the interface address, though this is subject to change. To attach
    30       a DHCP server to the internal network, modify the example command
    31       as follows:
    32     </p>
     14    <p>Here, natnet1 is the name of the internal network to be used and 192.168.15.0/24 is the network address and mask
     15      of the NAT service interface. By default in this static configuration the gateway will be assigned the address
     16      192.168.15.1, the address following the interface address, though this is subject to change. To attach a DHCP
     17      server to the internal network, modify the example command as follows: </p>
    3318    <pre xml:space="preserve">VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable --dhcp on</pre>
    34     <p>
    35       To add a DHCP server to an existing network, use the following
    36       command:
    37     </p>
     19    <p>To add a DHCP server to an existing network, use the following command: </p>
    3820    <pre xml:space="preserve">VBoxManage natnetwork modify --netname natnet1 --dhcp on</pre>
    39     <p>
    40       To disable the DHCP server, use the following command:
    41     </p>
     21    <p>To disable the DHCP server, use the following command: </p>
    4222    <pre xml:space="preserve">VBoxManage natnetwork modify --netname natnet1 --dhcp off</pre>
    43     <p>
    44       A DHCP server provides a list of registered nameservers, but does
    45       not map servers from the 127/8 network.
    46     </p>
    47     <p>
    48       To start the NAT service, use the following command:
    49     </p>
     23    <p>A DHCP server provides a list of registered nameservers, but does not map servers from the 127/8 network. </p>
     24    <p>To start the NAT service, use the following command: </p>
    5025    <pre xml:space="preserve">VBoxManage natnetwork start --netname natnet1</pre>
    51     <p>
    52       If the network has a DHCP server attached then it will start
    53       together with the NAT network service.
    54     </p>
    55     <p>
    56       To stop the NAT network service, together with any DHCP server:
    57     </p>
     26    <p>If the network has a DHCP server attached then it will start together with the NAT network service. </p>
     27    <p>To stop the NAT network service, together with any DHCP server: </p>
    5828    <pre xml:space="preserve">VBoxManage natnetwork stop --netname natnet1</pre>
    59     <p>
    60       To delete the NAT network service:
    61     </p>
     29    <p>To delete the NAT network service: </p>
    6230    <pre xml:space="preserve">VBoxManage natnetwork remove --netname natnet1</pre>
    63     <p>
    64       This command does not remove the DHCP server if one is enabled on
    65       the internal network.
    66     </p>
    67     <p>
    68       Port-forwarding is supported, using the
    69       <codeph>--port-forward-4</codeph> switch for IPv4 and
    70       <codeph>--port-forward-6</codeph> for IPv6. For example:
    71     </p>
     31    <p>This command does not remove the DHCP server if one is enabled on the internal network. </p>
     32    <p>Port-forwarding is supported, using the <codeph>--port-forward-4</codeph> switch for IPv4 and
     33        <codeph>--port-forward-6</codeph> for IPv6. For example: </p>
    7234    <pre xml:space="preserve">VBoxManage natnetwork modify \
    7335  --netname natnet1 --port-forward-4 "ssh:tcp:[]:1022:[192.168.15.5]:22"</pre>
    74     <p>
    75       This adds a port-forwarding rule from the host's TCP 1022 port to
    76       the port 22 on the guest with IP address 192.168.15.5. Host port,
    77       guest port and guest IP are mandatory. To delete the rule, use the
    78       following command:
    79     </p>
     36    <p>This adds a port-forwarding rule from the host's TCP 1022 port to the port 22 on the guest with IP address
     37      192.168.15.5. Host port, guest port and guest IP are mandatory. To delete the rule, use the following command: </p>
    8038    <pre xml:space="preserve">VBoxManage natnetwork modify --netname natnet1 --port-forward-4 delete ssh</pre>
    81     <p>
    82       It is possible to bind a NAT service to specified interface. For
    83       example:
    84     </p>
     39    <p>It is possible to bind a NAT service to specified interface. For example: </p>
    8540    <pre xml:space="preserve">VBoxManage setextradata global "NAT/win-nat-test-0/SourceIp4" 192.168.1.185</pre>
    86     <p>
    87       To see the list of registered NAT networks, use the following
    88       command:
    89     </p>
     41    <p>To see the list of registered NAT networks, use the following command: </p>
    9042    <pre xml:space="preserve">VBoxManage list natnetworks</pre>
    91     <p>
    92       NAT networks can also be created, deleted, and configured using
    93       the Network Manager tool in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. Click
    94       <b outputclass="bold">File</b>, <b outputclass="bold">
    95       Tools</b>, <b outputclass="bold">Network
    96       Manager</b>. See <xref href="network-manager.dita#network-manager"/>.
    97     </p>
     43    <p>NAT networks can also be created, deleted, and configured using the Network Manager tool in <ph
     44        conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. Click <b outputclass="bold">File</b>, <b outputclass="bold">
     45        Tools</b>, <b outputclass="bold">Network Manager</b>. See <xref href="network-manager.dita#network-manager"/>. </p>
    9846    <note>
    99       <p>
    100         Even though the NAT service separates the VM from the host, the
    101         VM has access to the host's loopback interface and the network
    102         services running on it. The host's loopback interface is
    103         accessible as IP address 10.0.2.2 (assuming the default
    104         configuration, in other configurations it's the respective
    105         address in the configured IPv4 or IPv6 network range). This
    106         access to the host's loopback interface can be extremely useful
    107         in some cases, for example when running a web application under
    108         development in the VM and the database server on the loopback
    109         interface on the host.
    110       </p>
     47      <p>Even though the NAT service separates the VM from the host, the VM has access to the host's loopback interface
     48        and the network services running on it. The host's loopback interface is accessible as IP address 10.0.2.2
     49        (assuming the default configuration, in other configurations it's the respective address in the configured IPv4
     50        or IPv6 network range). This access to the host's loopback interface can be extremely useful in some cases, for
     51        example when running a web application under development in the VM and the database server on the loopback
     52        interface on the host. </p>
    11153    </note>
    11254  </body>

  • trunk/doc/manual/en_US/dita/topics/network_performance.dita

    r105134 r105335  
    66           
    77            <body>
    8                <p>
    9       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a variety of virtual network adapters that
    10       can be attached to the host's network in a number of ways.
    11       Depending on which types of adapters and attachments are used the
    12       network performance will be different. Performance-wise the virtio
    13       network adapter is preferable over Intel PRO/1000 emulated
    14       adapters, which are preferred over the PCNet family of adapters.
    15       Both virtio and Intel PRO/1000 adapters enjoy the benefit of
    16       segmentation and checksum offloading. Segmentation offloading is
    17       essential for high performance as it allows for less context
    18       switches, dramatically increasing the sizes of packets that cross
    19       the VM/host boundary.
    20     </p>
     8               <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a variety of virtual network adapters
     9      that can be attached to the host's network in a number of ways. Depending on which types of adapters and
     10      attachments are used the network performance will be different. Performance-wise the virtio network adapter is
     11      preferable over Intel PRO/1000 emulated adapters, which are preferred over the PCNet family of adapters. Both
     12      virtio and Intel PRO/1000 adapters enjoy the benefit of segmentation and checksum offloading. Segmentation
     13      offloading is essential for high performance as it allows for less context switches, dramatically increasing the
     14      sizes of packets that cross the VM/host boundary. </p>
    2115               <note>
    22                   <p>
    23         Neither virtio nor Intel PRO/1000 drivers for Windows XP support
    24         segmentation offloading. Therefore Windows XP guests never reach
    25         the same transmission rates as other guest types. Refer to MS
    26         Knowledge base article 842264 for additional information.
    27       </p>
     16                  <p>Neither virtio nor Intel PRO/1000 drivers for Windows XP support segmentation offloading. Therefore
     17        Windows XP guests never reach the same transmission rates as other guest types. Refer to MS Knowledge base
     18        article 842264 for additional information. </p>
    2819               </note>
    29                <p> Three attachment types: Internal, Bridged, and Host-Only, have nearly identical
    30       performance. The Internal type is slightly faster and uses less CPU cycles as the packets
    31       never reach the host's network stack. The NAT attachment type is the slowest and most secure
    32       of all attachment types, as it provides network address translation. The generic driver
    33       attachment is special and cannot be considered as an alternative to other attachment types. </p>
    34                <p>
    35       The number of CPUs assigned to VM does not improve network
    36       performance and in some cases may hurt it due to increased
    37       concurrency in the guest.
    38     </p>
    39                <p>
    40       Here is a short summary of things to check in order to improve
    41       network performance:
    42     </p>
     20               <p>Three attachment types: Internal, Bridged, and Host-Only, have nearly identical performance. The
     21      Internal type is slightly faster and uses less CPU cycles as the packets never reach the host's network stack. The
     22      NAT attachment type is the slowest and most secure of all attachment types, as it provides network address
     23      translation. The generic driver attachment is special and cannot be considered as an alternative to other
     24      attachment types. </p>
     25               <p>The number of CPUs assigned to VM does not improve network performance and in some cases may hurt it
     26      due to increased concurrency in the guest. </p>
     27               <p>Here is a short summary of things to check in order to improve network performance: </p>
    4328               <ul>
    4429                  <li>
    45                      <p>
    46           Whenever possible use the virtio network adapter. Otherwise,
    47           use one of the Intel PRO/1000 adapters.
    48         </p>
     30                     <p>Whenever possible use the virtio network adapter. Otherwise, use one of the Intel PRO/1000
     31          adapters. </p>
    4932                  </li>
    5033                  <li>
    51                      <p>
    52           Use a Bridged attachment instead of NAT.
    53         </p>
     34                     <p>Use a Bridged attachment instead of NAT. </p>
    5435                  </li>
    5536                  <li>
    56                      <p> Ensure segmentation offloading is enabled in the guest OS. Usually it will
    57           be enabled by default. You can check and modify offloading settings using the
    58             <userinput>ethtool</userinput> command on Linux guests. </p>
     37                     <p>Ensure segmentation offloading is enabled in the guest OS. Usually it will be enabled by
     38          default. You can check and modify offloading settings using the <userinput>ethtool</userinput> command on
     39          Linux guests. </p>
    5940                  </li>
    6041                  <li>
    61                      <p>
    62           Perform a full detailed analysis of network traffic on the
    63           VM's network adaptor using a third party tool such as
    64           Wireshark. To do this, a promiscuous mode policy needs to be
    65           used on the VM's network adaptor. Use of this mode is only
    66           possible on the following network types: NAT Network, Bridged
    67           Adapter, Internal Network, and Host-Only Adapter.
    68         </p>
    69                      <p> To setup a promiscuous mode policy, either select from the drop down list
    70           located in the <b outputclass="bold">Network Settings</b> dialog for the network adaptor
    71           or use the command line tool <userinput>VBoxManage</userinput>. See <xref
    72             href="vboxmanage-modifyvm.dita"/>. </p>
    73                      <p>
    74           Promiscuous mode policies are as follows:
    75         </p>
     42                     <p>Perform a full detailed analysis of network traffic on the VM's network adaptor using a third
     43          party tool such as Wireshark. To do this, a promiscuous mode policy needs to be used on the VM's network
     44          adaptor. Use of this mode is only possible on the following network types: NAT Network, Bridged Adapter,
     45          Internal Network, and Host-Only Adapter. </p>
     46                     <p>To setup a promiscuous mode policy, either select from the drop down list located in the <b
     47            outputclass="bold">Network Settings</b> dialog for the network adaptor or use the command line tool
     48            <userinput>VBoxManage</userinput>. See <xref href="vboxmanage-modifyvm.dita"/>. </p>
     49                     <p>Promiscuous mode policies are as follows: </p>
    7650                     <ul>
    7751                        <li>
    78                            <p>
    79                               <codeph>deny</codeph>, which hides any traffic not
    80               intended for the VM's network adaptor. This is the default
    81               setting.
    82             </p>
     52                           <p><codeph>deny</codeph>, which hides any traffic not intended for the VM's network adaptor.
     53              This is the default setting. </p>
    8354                        </li>
    8455                        <li>
    85                            <p>
    86                               <codeph>allow-vms</codeph>, which hides all host traffic
    87               from the VM's network adaptor, but allows it to see
    88               traffic from and to other VMs.
    89             </p>
     56                           <p><codeph>allow-vms</codeph>, which hides all host traffic from the VM's network adaptor,
     57              but allows it to see traffic from and to other VMs. </p>
    9058                        </li>
    9159                        <li>
    92                            <p>
    93                               <codeph>allow-all</codeph>, which removes all
    94               restrictions. The VM's network adaptor sees all traffic.
    95             </p>
     60                           <p><codeph>allow-all</codeph>, which removes all restrictions. The VM's network adaptor sees
     61              all traffic. </p>
    9662                        </li>
    9763                     </ul>

  • trunk/doc/manual/en_US/dita/topics/network_udp_tunnel.dita

    r98549 r105335  
    55 
    66  <body>
    7     <p>
    8       This networking mode enables you to interconnect virtual machines
    9       running on different hosts.
    10     </p>
    11     <p>
    12       Technically this is done by encapsulating Ethernet frames sent or
    13       received by the guest network card into UDP/IP datagrams, and
    14       sending them over any network available to the host.
    15     </p>
    16     <p>
    17       UDP Tunnel mode has the following parameters:
    18     </p>
     7    <p>This networking mode enables you to interconnect virtual machines running on different hosts. </p>
     8    <p>Technically this is done by encapsulating Ethernet frames sent or received by the guest network card into UDP/IP
     9      datagrams, and sending them over any network available to the host. </p>
     10    <p>UDP Tunnel mode has the following parameters: </p>
    1911    <ul>
    2012      <li>
    … …  
    3628      </li>
    3729    </ul>
    38     <p>
    39       When interconnecting two virtual machines on two different hosts,
    40       their IP addresses must be swapped. On a single host, source and
    41       destination UDP ports must be swapped.
    42     </p>
    43     <p>
    44       In the following example, host 1 uses the IP address 10.0.0.1 and
    45       host 2 uses IP address 10.0.0.2. To configure using the
    46       command-line:
    47     </p>
     30    <p>When interconnecting two virtual machines on two different hosts, their IP addresses must be swapped. On a single
     31      host, source and destination UDP ports must be swapped. </p>
     32    <p>In the following example, host 1 uses the IP address 10.0.0.1 and host 2 uses IP address 10.0.0.2. To configure
     33      using the command-line: </p>
    4834    <pre xml:space="preserve">        VBoxManage modifyvm "VM 01 on host 1" --nic&lt;x&gt; generic
    4935        VBoxManage modifyvm "VM 01 on host 1" --nic-generic-drv&lt;x&gt; UDPTunnel
    … …  
    5642        VBoxManage modifyvm "VM 02 on host 2" --nic-property&lt;y&gt; sport=10002
    5743        VBoxManage modifyvm "VM 02 on host 2" --nic-property&lt;y&gt; dport=10001</pre>
    58     <p>
    59       Of course, you can always interconnect two virtual machines on the
    60       same host, by setting the destination address parameter to
    61       127.0.0.1 on both. It will act similarly to an internal network in
    62       this case. However, the host can see the network traffic which it
    63       could not in the normal internal network case.
    64     </p>
     44    <p>Of course, you can always interconnect two virtual machines on the same host, by setting the destination address
     45      parameter to 127.0.0.1 on both. It will act similarly to an internal network in this case. However, the host can
     46      see the network traffic which it could not in the normal internal network case. </p>
    6547    <note>
    66       <p>
    67         On UNIX-based hosts, such as Linux, Oracle Solaris, and Mac OS
    68         X, it is not possible to bind to ports below 1024 from
    69         applications that are not run by <codeph>root</codeph>. As a
    70         result, if you try to configure such a source UDP port, the VM
    71         will refuse to start.
    72       </p>
     48      <p>On UNIX-based hosts, such as Linux, Oracle Solaris, and Mac OS X, it is not possible to bind to ports below
     49        1024 from applications that are not run by <codeph>root</codeph>. As a result, if you try to configure such a
     50        source UDP port, the VM will refuse to start. </p>
    7351    </note>
    7452  </body>

  • trunk/doc/manual/en_US/dita/topics/network_vde.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       Virtual Distributed Ethernet (VDE) is a flexible, virtual network
    9       infrastructure system, spanning across multiple hosts in a secure
    10       way. It enables L2/L3 switching, including spanning-tree protocol,
    11       VLANs, and WAN emulation. It is an optional part of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    12       which is only included in the source code.
    13     </p>
    14     <p>
    15       VDE is a project developed by Renzo Davoli, Associate Professor at
    16       the University of Bologna, Italy.
    17     </p>
    18     <p>
    19       The basic building blocks of the infrastructure are VDE switches,
    20       VDE plugs, and VDE wires which interconnect the switches.
    21     </p>
    22     <p>
    23       The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VDE driver has a single parameter: VDE network.
    24       This is the name of the VDE network switch socket to which the VM
    25       will be connected.
    26     </p>
    27     <p>
    28       The following basic example shows how to connect a virtual machine
    29       to a VDE switch.
    30     </p>
     7    <p>Virtual Distributed Ethernet (VDE) is a flexible, virtual network infrastructure system, spanning across multiple
     8      hosts in a secure way. It enables L2/L3 switching, including spanning-tree protocol, VLANs, and WAN emulation. It
     9      is an optional part of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> which is only included in the source
     10      code. </p>
     11    <p>VDE is a project developed by Renzo Davoli, Associate Professor at the University of Bologna, Italy. </p>
     12    <p>The basic building blocks of the infrastructure are VDE switches, VDE plugs, and VDE wires which interconnect the
     13      switches. </p>
     14    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VDE driver has a single parameter: VDE network. This is
     15      the name of the VDE network switch socket to which the VM will be connected. </p>
     16    <p>The following basic example shows how to connect a virtual machine to a VDE switch. </p>
    3117    <ol>
    3218      <li>
    … …  
    6652      </li>
    6753    </ol>
    68     <p>
    69       VDE is available on Linux and FreeBSD hosts only. It is only
    70       available if the VDE software and the VDE plugin library from the
    71       VirtualSquare project are installed on the host system.
    72     </p>
     54    <p>VDE is available on Linux and FreeBSD hosts only. It is only available if the VDE software and the VDE plugin
     55      library from the VirtualSquare project are installed on the host system. </p>
    7356    <note>
    74       <p>
    75         For Linux hosts, the shared library libvdeplug.so must be
    76         available in the search path for shared libraries.
    77       </p>
     57      <p>For Linux hosts, the shared library libvdeplug.so must be available in the search path for shared libraries. </p>
    7858    </note>
    79     <p>
    80       For more information on setting up VDE networks, please see the
    81       documentation accompanying the software. See also
    82       <ph>http://wiki.virtualsquare.org</ph>.
    83     </p>
     59    <p>For more information on setting up VDE networks, please see the documentation accompanying the software. See also
     60        <ph>http://wiki.virtualsquare.org</ph>. </p>
    8461  </body>
    8562 

  • trunk/doc/manual/en_US/dita/topics/networkingdetails.dita

    r105293 r105335  
    55 
    66  <body>
    7     <p>
    8     As mentioned in <xref href="settings-network.dita#settings-network"/>, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    9     provides up to eight virtual PCI Ethernet cards for each virtual
    10     machine. For each such card, you can individually select the
    11     following:
    12   </p>
     7    <p>As mentioned in <xref href="settings-network.dita#settings-network"/>, <ph
     8        conkeyref="vbox-conkeyref-phrases/product-name"/> provides up to eight virtual PCI Ethernet cards for each
     9      virtual machine. For each such card, you can individually select the following: </p>
    1310    <ul>
    1411      <li>
    15         <p>
    16         The hardware that will be virtualized.
    17       </p>
     12        <p>The hardware that will be virtualized. </p>
    1813      </li>
    1914      <li>
    20         <p>
    21         The virtualization mode that the virtual card operates in, with
    22         respect to your physical networking hardware on the host.
    23       </p>
     15        <p>The virtualization mode that the virtual card operates in, with respect to your physical networking hardware
     16          on the host. </p>
    2417      </li>
    2518    </ul>
    26     <p> Four of the network cards can be configured in the <b outputclass="bold">Network</b> section
    27       of the <b outputclass="bold">Settings</b> window in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. You can configure all
    28       eight network cards on the command line using <userinput>VBoxManage modifyvm</userinput>. See
    29         <xref href="vboxmanage-modifyvm.dita"/>. </p>
    30     <p>
    31     This chapter explains the various networking settings in more
    32     detail.
    33   </p>
     19    <p>Four of the network cards can be configured in the <b outputclass="bold">Network</b> section of the <b
     20        outputclass="bold">Settings</b> window in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. You can configure
     21      all eight network cards on the command line using <userinput>VBoxManage modifyvm</userinput>. See <xref
     22        href="vboxmanage-modifyvm.dita"/>. </p>
     23    <p>This chapter explains the various networking settings in more detail. </p>
    3424  </body>
    3525</topic>

  • trunk/doc/manual/en_US/dita/topics/networkingmodes.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       Each of the networking adapters can be separately configured to
    9       operate in one of the following modes:
    10     </p>
     7    <p>Each of the networking adapters can be separately configured to operate in one of the following modes: </p>
    118    <ul>
    129      <li>
    … …  
    9592      </li>
    9693    </ul>
    97     <p>
    98       The following table provides an overview of the most important
    99       networking modes.
    100     </p>
     94    <p>The following table provides an overview of the most important networking modes. </p>
    10195    <table id="table-networking-modes">
    10296      <title>Overview of Networking Modes</title>
    … …  
    305299      </tgroup>
    306300    </table>
    307     <p>
    308       The following sections describe the available network modes in
    309       more detail.
    310     </p>
     301    <p>The following sections describe the available network modes in more detail. </p>
    311302  </body>
    312303 

  • trunk/doc/manual/en_US/dita/topics/nichardware.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       For each card, you can individually select what kind of
    9       <i>hardware</i> will be presented to the virtual
    10       machine. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can virtualize the following types of
    11       networking hardware:
    12     </p>
     7    <p>For each card, you can individually select what kind of <i>hardware</i> will be presented to the virtual machine.
     8        <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can virtualize the following types of networking hardware: </p>
    139    <ul>
    1410      <li>
    15         <p>
    16           AMD PCNet PCI II (Am79C970A)
    17         </p>
     11        <p>AMD PCNet PCI II (Am79C970A) </p>
    1812      </li>
    1913      <li>
    20         <p>
    21           AMD PCNet FAST III (Am79C973), the default setting
    22         </p>
     14        <p>AMD PCNet FAST III (Am79C973), the default setting </p>
    2315      </li>
    2416      <li>
    25         <p>
    26           Intel PRO/1000 MT Desktop (82540EM)
    27         </p>
     17        <p>Intel PRO/1000 MT Desktop (82540EM) </p>
    2818      </li>
    2919      <li>
    30         <p>
    31           Intel PRO/1000 T Server (82543GC)
    32         </p>
     20        <p>Intel PRO/1000 T Server (82543GC) </p>
    3321      </li>
    3422      <li>
    35         <p>
    36           Intel PRO/1000 MT Server (82545EM)
    37         </p>
     23        <p>Intel PRO/1000 MT Server (82545EM) </p>
    3824      </li>
    3925      <li>
    40         <p>
    41           Paravirtualized network adapter (virtio-net)
    42         </p>
     26        <p>Paravirtualized network adapter (virtio-net) </p>
    4327      </li>
    4428    </ul>
    45     <p>
    46       The PCNet FAST III is the default because it is supported by
    47       nearly all operating systems, as well as by the GNU GRUB boot
    48       manager. As an exception, the Intel PRO/1000 family adapters are
    49       chosen for some guest operating system types that no longer ship
    50       with drivers for the PCNet card, such as Windows Vista.
    51     </p>
    52     <p>
    53       The Intel PRO/1000 MT Desktop type works with Windows Vista and
    54       later versions. The T Server variant of the Intel PRO/1000 card is
    55       recognized by Windows XP guests without additional driver
    56       installation. The MT Server variant facilitates OVF imports from
    57       other platforms.
    58     </p>
    59     <p>
    60       The Paravirtualized network adapter (virtio-net) is special. If
    61       you select this adapter, then <ph conkeyref="vbox-conkeyref-phrases/product-name"/> does
    62       <i>not</i> virtualize common networking hardware
    63       that is supported by common guest operating systems. Instead,
    64       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> expects a special software interface for
    65       virtualized environments to be provided by the guest, thus
    66       avoiding the complexity of emulating networking hardware and
    67       improving network performance. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides support for
    68       the industry-standard <i>virtio</i> networking
    69       drivers, which are part of the open source KVM project.
    70     </p>
    71     <p>
    72       The virtio networking drivers are available for the following
    73       guest operating systems:
    74     </p>
     29    <p>The PCNet FAST III is the default because it is supported by nearly all operating systems, as well as by the GNU
     30      GRUB boot manager. As an exception, the Intel PRO/1000 family adapters are chosen for some guest operating system
     31      types that no longer ship with drivers for the PCNet card, such as Windows Vista. </p>
     32    <p>The Intel PRO/1000 MT Desktop type works with Windows Vista and later versions. The T Server variant of the Intel
     33      PRO/1000 card is recognized by Windows XP guests without additional driver installation. The MT Server variant
     34      facilitates OVF imports from other platforms. </p>
     35    <p>The Paravirtualized network adapter (virtio-net) is special. If you select this adapter, then <ph
     36        conkeyref="vbox-conkeyref-phrases/product-name"/> does <i>not</i> virtualize common networking hardware that is
     37      supported by common guest operating systems. Instead, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     38      expects a special software interface for virtualized environments to be provided by the guest, thus avoiding the
     39      complexity of emulating networking hardware and improving network performance. <ph
     40        conkeyref="vbox-conkeyref-phrases/product-name"/> provides support for the industry-standard <i>virtio</i>
     41      networking drivers, which are part of the open source KVM project. </p>
     42    <p>The virtio networking drivers are available for the following guest operating systems: </p>
    7543    <ul>
    7644      <li>
    77         <p>
    78           Linux kernels version 2.6.25 or later can be configured to
    79           provide virtio support. Some distributions have also
    80           back-ported virtio to older kernels.
    81         </p>
     45        <p>Linux kernels version 2.6.25 or later can be configured to provide virtio support. Some distributions have
     46          also back-ported virtio to older kernels. </p>
    8247      </li>
    8348      <li>
    84         <p>
    85           For Windows 2000, XP, and Vista, virtio drivers can be
    86           downloaded and installed from the KVM project web page:
    87         </p>
     49        <p>For Windows 2000, XP, and Vista, virtio drivers can be downloaded and installed from the KVM project web
     50          page: </p>
    8851        <p><ph>http://www.linux-kvm.org/page/WindowsGuestDrivers</ph>.
    8952        </p>
    9053      </li>
    9154    </ul>
    92     <p>
    93       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also has limited support for <i>jumbo
    94       frames</i>. These are networking packets with more than
    95       1500 bytes of data, provided that you use the Intel card
    96       virtualization and bridged networking. Jumbo frames are not
    97       supported with the AMD networking devices. In those cases, jumbo
    98       packets will silently be dropped for both the transmit and the
    99       receive direction. Guest operating systems trying to use this
    100       feature will observe this as a packet loss, which may lead to
    101       unexpected application behavior in the guest. This does not cause
    102       problems with guest operating systems in their default
    103       configuration, as jumbo frames need to be explicitly enabled.
    104     </p>
     55    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> also has limited support for <i>jumbo frames</i>. These are
     56      networking packets with more than 1500 bytes of data, provided that you use the Intel card virtualization and
     57      bridged networking. Jumbo frames are not supported with the AMD networking devices. In those cases, jumbo packets
     58      will silently be dropped for both the transmit and the receive direction. Guest operating systems trying to use
     59      this feature will observe this as a packet loss, which may lead to unexpected application behavior in the guest.
     60      This does not cause problems with guest operating systems in their default configuration, as jumbo frames need to
     61      be explicitly enabled. </p>
    10562  </body>
    10663 

  • trunk/doc/manual/en_US/dita/topics/otherextpacks.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       Another extension pack called VNC is available. This extension
    9       pack is open source and replaces the previous integration of the
    10       VNC remote access protocol. This is experimental code, and is
    11       initially available in the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> source code package
    12       only. It is to a large portion code contributed by users, and is
    13       not supported in any way by Oracle.
    14     </p>
    15     <p>
    16       The keyboard handling is severely limited, and only the US
    17       keyboard layout works. Other keyboard layouts will have at least
    18       some keys which produce the wrong results, often with quite
    19       surprising effects, and for layouts which have significant
    20       differences to the US keyboard layout it is most likely unusable.
    21     </p>
    22     <p>
    23       It is possible to install both the <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/>
    24       and VNC, but only one VRDE module can be active at any time. The
    25       following command switches to the VNC VRDE module in VNC:
    26     </p>
     7    <p>Another extension pack called VNC is available. This extension pack is open source and replaces the previous
     8      integration of the VNC remote access protocol. This is experimental code, and is initially available in the <ph
     9        conkeyref="vbox-conkeyref-phrases/product-name"/> source code package only. It is to a large portion code
     10      contributed by users, and is not supported in any way by Oracle. </p>
     11    <p>The keyboard handling is severely limited, and only the US keyboard layout works. Other keyboard layouts will
     12      have at least some keys which produce the wrong results, often with quite surprising effects, and for layouts
     13      which have significant differences to the US keyboard layout it is most likely unusable. </p>
     14    <p>It is possible to install both the <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/> and VNC, but only one VRDE
     15      module can be active at any time. The following command switches to the VNC VRDE module in VNC: </p>
    2716    <pre xml:space="preserve">VBoxManage setproperty vrdeextpack VNC</pre>
    28     <p>
    29       Configuring the remote access works very similarly to VRDP, see
    30       <xref href="vrde.dita#vrde"/>, with some limitations. VNC does not
    31       support specifying several port numbers, and the authentication is
    32       done differently. VNC can only deal with password authentication,
    33       and there is no option to use password hashes. This leaves no
    34       other choice than having a clear-text password in the VM
    35       configuration, which can be set with the following command:
    36     </p>
     17    <p>Configuring the remote access works very similarly to VRDP, see <xref href="vrde.dita#vrde"/>, with some
     18      limitations. VNC does not support specifying several port numbers, and the authentication is done differently. VNC
     19      can only deal with password authentication, and there is no option to use password hashes. This leaves no other
     20      choice than having a clear-text password in the VM configuration, which can be set with the following command: </p>
    3721    <pre xml:space="preserve">VBoxManage modifyvm <varname>VM-name</varname> --vrde-property VNCPassword=secret</pre>
    38     <p>
    39       The user is responsible for keeping this password secret, and it
    40       should be removed when a VM configuration is passed to another
    41       person, for whatever purpose. Some VNC servers claim to have
    42       encrypted passwords in the configuration. This is not true
    43       encryption, it is only concealing the passwords, which is only as
    44       secure as using clear-text passwords.
    45     </p>
    46     <p>
    47       The following command switches back to VRDP, if installed:
    48     </p>
     22    <p>The user is responsible for keeping this password secret, and it should be removed when a VM configuration is
     23      passed to another person, for whatever purpose. Some VNC servers claim to have encrypted passwords in the
     24      configuration. This is not true encryption, it is only concealing the passwords, which is only as secure as using
     25      clear-text passwords. </p>
     26    <p>The following command switches back to VRDP, if installed: </p>
    4927    <pre xml:space="preserve">VBoxManage setproperty vrdeextpack "<ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/>"</pre>
    5028  </body>

  • trunk/doc/manual/en_US/dita/topics/pcspeaker_passthrough.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       As an experimental feature, primarily due to being limited to
    9       Linux host only and unknown Linux distribution coverage,
    10       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports passing through the PC speaker to the
    11       host. The PC speaker, sometimes called the system speaker, is a
    12       way to produce audible feedback such as beeps without the need for
    13       regular audio and sound card support.
    14     </p>
    15     <p>
    16       The PC speaker passthrough feature in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> handles beeps
    17       only. Advanced PC speaker use by the VM, such as PCM audio, will
    18       not work, resulting in undefined host behavior.
    19     </p>
    20     <p>
    21       Producing beeps on Linux is a very complex topic. <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    22       offers a collection of options, in an attempt to make this work
    23       deterministically and reliably on as many Linux distributions and
    24       system configurations as possible. These are summarized in the
    25       following table.
    26     </p>
     7    <p>As an experimental feature, primarily due to being limited to Linux host only and unknown Linux distribution
     8      coverage, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports passing through the PC speaker to the
     9      host. The PC speaker, sometimes called the system speaker, is a way to produce audible feedback such as beeps
     10      without the need for regular audio and sound card support. </p>
     11    <p>The PC speaker passthrough feature in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> handles beeps only.
     12      Advanced PC speaker use by the VM, such as PCM audio, will not work, resulting in undefined host behavior. </p>
     13    <p>Producing beeps on Linux is a very complex topic. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> offers a
     14      collection of options, in an attempt to make this work deterministically and reliably on as many Linux
     15      distributions and system configurations as possible. These are summarized in the following table. </p>
    2716    <table id="table-pcspeaker-config">
    2817      <title>PC Speaker Configuration Options</title>
    … …  
    173162      </tgroup>
    174163    </table>
    175     <p>
    176       To enable PC speaker passthrough use the following command:
    177     </p>
     164    <p>To enable PC speaker passthrough use the following command: </p>
    178165    <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> "VBoxInternal/Devices/i8254/0/Config/PassthroughSpeaker" <varname>N</varname>
    179166               </pre>
    180     <p>
    181       Replace <varname>N</varname> with the code representing
    182       the case you want to use. Changing this setting takes effect when
    183       you next start the VM. It is safe to enable PC speaker passthrough
    184       on all host OSes. It will only have an effect on Linux.
    185     </p>
    186     <p>
    187       The VM log file, <filepath>VBox.log</filepath>, contains lines
    188       with the prefix <codeph>PIT: speaker:</codeph> showing the PC
    189       speaker passthrough setup activities. It gives hints which device
    190       it picked or why it failed.
    191     </p>
    192     <p>
    193       Enabling PC speaker passthrough for the VM is usually the simple
    194       part. The real difficulty is making sure that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can
    195       access the necessary device, because in a typical Linux install
    196       most of them can only be accessed by user <codeph>root</codeph>.
    197       You should follow the preferred way to persistently change this,
    198       such as by referring to your distribution's documentation. Since
    199       there are countless Linux distribution variants, we can only give
    200       the general hints that there is often a way to give the X11
    201       session user access to additional devices, or you need to find a
    202       working solution using a udev configuration file. If everything
    203       fails you might try setting the permissions using a script which
    204       is run late enough in the host system startup.
    205     </p>
    206     <p>
    207       Sometimes additional rules are applied by the kernel to limit
    208       access. For example, that the VM process must have the same
    209       controlling terminal as the device configured to be used for
    210       beeping, something which is often very difficult to achieve for
    211       GUI applications such as <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. The table above contains
    212       some hints, but in general refer to the Linux documentation.
    213     </p>
    214     <p> If you have trouble getting any beeps even if the device permissions are set up and VBox.log
    215       confirms that it uses evdev or console for the PC speaker control, check if your system has a
    216       PC speaker. Some systems do not have one. Other complications can arise from Linux rerouting
    217       the PC speaker output to a sound card. Check if the beeps are audible if you connect speakers
    218       to your sound card. Today almost all systems have one. Finally, check if the audio mixer
    219       control has a channel named <i>beep</i>, which could be hidden in the mixer settings, and that
    220       it is not muted. </p>
     167    <p>Replace <varname>N</varname> with the code representing the case you want to use. Changing this setting takes
     168      effect when you next start the VM. It is safe to enable PC speaker passthrough on all host OSes. It will only have
     169      an effect on Linux. </p>
     170    <p>The VM log file, <filepath>VBox.log</filepath>, contains lines with the prefix <codeph>PIT: speaker:</codeph>
     171      showing the PC speaker passthrough setup activities. It gives hints which device it picked or why it failed. </p>
     172    <p>Enabling PC speaker passthrough for the VM is usually the simple part. The real difficulty is making sure that
     173        <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can access the necessary device, because in a typical
     174      Linux install most of them can only be accessed by user <codeph>root</codeph>. You should follow the preferred way
     175      to persistently change this, such as by referring to your distribution's documentation. Since there are countless
     176      Linux distribution variants, we can only give the general hints that there is often a way to give the X11 session
     177      user access to additional devices, or you need to find a working solution using a udev configuration file. If
     178      everything fails you might try setting the permissions using a script which is run late enough in the host system
     179      startup. </p>
     180    <p>Sometimes additional rules are applied by the kernel to limit access. For example, that the VM process must have
     181      the same controlling terminal as the device configured to be used for beeping, something which is often very
     182      difficult to achieve for GUI applications such as <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. The table
     183      above contains some hints, but in general refer to the Linux documentation. </p>
     184    <p>If you have trouble getting any beeps even if the device permissions are set up and VBox.log confirms that it
     185      uses evdev or console for the PC speaker control, check if your system has a PC speaker. Some systems do not have
     186      one. Other complications can arise from Linux rerouting the PC speaker output to a sound card. Check if the beeps
     187      are audible if you connect speakers to your sound card. Today almost all systems have one. Finally, check if the
     188      audio mixer control has a channel named <i>beep</i>, which could be hidden in the mixer settings, and that it is
     189      not muted. </p>
    221190  </body>
    222191 

  • trunk/doc/manual/en_US/dita/topics/rawdisk-access-disk-partitions.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8           This <i>raw partition support</i> is quite
    9           similar to the full hard disk access described above. However,
    10           in this case, any partitioning information will be stored
    11           inside the VMDK image. This means that you can install a
    12           different boot loader in the virtual hard disk without
    13           affecting the host's partitioning information. While the guest
    14           will be able to <i>see</i> all partitions that
    15           exist on the physical disk, access will be filtered in that
    16           reading from partitions for which no access is allowed the
    17           partitions will only yield zeroes, and all writes to them are
    18           ignored.
    19         </p>
    20     <p>
    21           To create a special image for raw partition support, which
    22           will contain a small amount of data, on a Linux host, use the
    23           command:
    24         </p>
     7    <p>This <i>raw partition support</i> is quite similar to the full hard disk access described above. However, in this
     8            case, any partitioning information will be stored inside the VMDK image. This means that you can install a
     9            different boot loader in the virtual hard disk without affecting the host's partitioning information. While
     10            the guest will be able to <i>see</i> all partitions that exist on the physical disk, access will be filtered
     11            in that reading from partitions for which no access is allowed the partitions will only yield zeroes, and
     12            all writes to them are ignored. </p>
     13    <p>To create a special image for raw partition support, which will contain a small amount of data, on a Linux host,
     14            use the command: </p>
    2515    <pre xml:space="preserve">$ VBoxManage createmedium disk --filename <varname>path-to-file</varname>.vmdk --format=VMDK
    2616--variant RawDisk --property RawDrive=/dev/sda --property Partitions=1,5</pre>
    27     <p>
    28           The command is identical to the one for full hard disk access,
    29           except for the additional <codeph>--property</codeph>
    30           Partitions=1,5 parameter. This example would create
    31           the image
    32           <filepath><varname>path-to-file</varname>.vmdk</filepath>,
    33           which must be absolute, and partitions 1 and 5 of
    34           <filepath>/dev/sda</filepath> would be made accessible to the
    35           guest.
    36         </p>
    37     <p>
    38           <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the same partition numbering as your Linux
    39           host. As a result, the numbers given in the above example
    40           would refer to the first primary partition and the first
    41           logical drive in the extended partition, respectively.
    42         </p>
    43     <p>
    44           On a Windows host, instead of the above device specification,
    45           use for example <filepath>\\.\PhysicalDrive0</filepath>. On a
    46           macOS host, instead of the above device specification use
    47           <filepath>/dev/rdisk1</filepath>, for example. Note that on OS
    48           X you can only use partitions which are not mounted. Unmount
    49           the respective disk first using <i>diskutil unmountDisk
    50           <filepath>/dev/diskX</filepath>
    51                         </i>. Partition numbers
    52           are the same on Linux, Windows, and macOS hosts.
    53         </p>
    54     <p>
    55           The numbers for the list of partitions can be taken from the
    56           output of the following command:
    57         </p>
     17    <p>The command is identical to the one for full hard disk access, except for the additional
     18                <codeph>--property</codeph> Partitions=1,5 parameter. This example would create the image
     19                    <filepath><varname>path-to-file</varname>.vmdk</filepath>, which must be absolute, and partitions 1
     20            and 5 of <filepath>/dev/sda</filepath> would be made accessible to the guest. </p>
     21    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the same partition numbering as your Linux host. As a
     22            result, the numbers given in the above example would refer to the first primary partition and the first
     23            logical drive in the extended partition, respectively. </p>
     24    <p>On a Windows host, instead of the above device specification, use for example
     25                <filepath>\\.\PhysicalDrive0</filepath>. On a macOS host, instead of the above device specification use
     26                <filepath>/dev/rdisk1</filepath>, for example. Note that on OS X you can only use partitions which are
     27            not mounted. Unmount the respective disk first using <i>diskutil unmountDisk <filepath>/dev/diskX</filepath>
     28            </i>. Partition numbers are the same on Linux, Windows, and macOS hosts. </p>
     29    <p>The numbers for the list of partitions can be taken from the output of the following command: </p>
    5830    <pre xml:space="preserve">$ VBoxManage list hostdrives</pre>
    59     <p>
    60           The output lists available drives and their partitions with
    61           the partition types and sizes to give the user enough
    62           information to identify the partitions necessary for the
    63           guest.
    64         </p>
    65     <p>
    66           Images which give access to individual partitions are specific
    67           to a particular host disk setup. You cannot transfer these
    68           images to another host. Also, whenever the host partitioning
    69           changes, the image <i>must be recreated</i>.
    70         </p>
    71     <p>
    72           Creating the image requires read/write access for the given
    73           device. Read/write access is also later needed when using the
    74           image from a virtual machine. If this is not feasible, there
    75           is a special variant for raw partition access, currently only
    76           available on Linux hosts, that avoids having to give the
    77           current user access to the entire disk. To set up such an
    78           image, use:
    79         </p>
     31    <p>The output lists available drives and their partitions with the partition types and sizes to give the user enough
     32            information to identify the partitions necessary for the guest. </p>
     33    <p>Images which give access to individual partitions are specific to a particular host disk setup. You cannot
     34            transfer these images to another host. Also, whenever the host partitioning changes, the image <i>must be
     35                recreated</i>. </p>
     36    <p>Creating the image requires read/write access for the given device. Read/write access is also later needed when
     37            using the image from a virtual machine. If this is not feasible, there is a special variant for raw
     38            partition access, currently only available on Linux hosts, that avoids having to give the current user
     39            access to the entire disk. To set up such an image, use: </p>
    8040    <pre xml:space="preserve">$ VBoxManage createmedium disk --filename <varname>path-to-file</varname>.vmdk --format=VMDK
    8141--variant RawDisk --property RawDrive=/dev/sda --property Partitions=1,5
    8242--property Relative=1</pre>
    83     <p>
    84           When used from a virtual machine, the image will then refer
    85           not to the entire disk, but only to the individual partitions.
    86           In this example, <filepath>/dev/sda1</filepath> and
    87           <filepath>/dev/sda5</filepath>. As a consequence, read/write
    88           access is only required for the affected partitions, not for
    89           the entire disk. During creation however, read-only access to
    90           the entire disk is required to obtain the partitioning
    91           information.
    92         </p>
    93     <p>
    94           In some configurations it may be necessary to change the MBR
    95           code of the created image. For example, to replace the Linux
    96           boot loader that is used on the host by another boot loader.
    97           This enables for example the guest to boot directly to
    98           Windows, while the host boots Linux from the "same" disk. For
    99           this purpose the <codeph>--property-file</codeph>
    100           BootSector=<varname>path-to-file-with-boot-sector</varname>
    101           parameter is provided. It specifies a file name from which to
    102           take the MBR code. The partition table is not modified at all,
    103           so a MBR file from a system with totally different
    104           partitioning can be used. An example of this is:
    105         </p>
     43    <p>When used from a virtual machine, the image will then refer not to the entire disk, but only to the individual
     44            partitions. In this example, <filepath>/dev/sda1</filepath> and <filepath>/dev/sda5</filepath>. As a
     45            consequence, read/write access is only required for the affected partitions, not for the entire disk. During
     46            creation however, read-only access to the entire disk is required to obtain the partitioning information. </p>
     47    <p>In some configurations it may be necessary to change the MBR code of the created image. For example, to replace
     48            the Linux boot loader that is used on the host by another boot loader. This enables for example the guest to
     49            boot directly to Windows, while the host boots Linux from the "same" disk. For this purpose the
     50                <codeph>--property-file</codeph> BootSector=<varname>path-to-file-with-boot-sector</varname> parameter
     51            is provided. It specifies a file name from which to take the MBR code. The partition table is not modified
     52            at all, so a MBR file from a system with totally different partitioning can be used. An example of this is: </p>
    10653    <pre xml:space="preserve">$ VBoxManage createmedium disk --filename <varname>path-to-file</varname>.vmdk --format=VMDK
    10754--variant RawDisk --property RawDrive=/dev/sda --property Partitions=1,5
    10855--property-file BootSector=winxp.mbr</pre>
    109     <p>
    110           The modified MBR will be stored inside the image, not on the
    111           host disk.
    112         </p>
    113     <p>
    114           The created image can be attached to a storage controller in a
    115           VM configuration as usual.
    116         </p>
     56    <p>The modified MBR will be stored inside the image, not on the host disk. </p>
     57    <p>The created image can be attached to a storage controller in a VM configuration as usual. </p>
    11758  </body>
    11859 

  • trunk/doc/manual/en_US/dita/topics/rawdisk-access-entire-physical-disk.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8           While this variant is the simplest to set up, you must be
    9           aware that this will give a guest operating system direct and
    10           full access to an <i>entire physical disk</i>.
    11           If your <i>host</i> operating system is also
    12           booted from this disk, please take special care to not access
    13           the partition from the guest at all. On the positive side, the
    14           physical disk can be repartitioned in arbitrary ways without
    15           having to recreate the image file that gives access to the raw
    16           disk.
    17         </p>
    18     <p>
    19           On a Linux host, to create an image that represents an entire
    20           physical hard disk which will not contain any actual data, as
    21           this will all be stored on the physical disk, use the
    22           following command:
    23         </p>
     7    <p>While this variant is the simplest to set up, you must be aware that this will give a guest operating system
     8      direct and full access to an <i>entire physical disk</i>. If your <i>host</i> operating system is also booted from
     9      this disk, please take special care to not access the partition from the guest at all. On the positive side, the
     10      physical disk can be repartitioned in arbitrary ways without having to recreate the image file that gives access
     11      to the raw disk. </p>
     12    <p>On a Linux host, to create an image that represents an entire physical hard disk which will not contain any
     13      actual data, as this will all be stored on the physical disk, use the following command: </p>
    2414    <pre xml:space="preserve">$ VBoxManage createmedium disk --filename <varname>path-to-file</varname>.vmdk --format=VMDK
    2515 --variant RawDisk --property RawDrive=/dev/sda</pre>
    26     <p>
    27           This creates the
    28           <filepath><varname>path-to-file</varname>.vmdk</filepath>
    29           file image that must be an absolute path. All data is read and
    30           written from <filepath>/dev/sda</filepath>.
    31         </p>
    32     <p>
    33           On a Windows host, instead of the above device specification,
    34           for example use <filepath>\\.\PhysicalDrive0</filepath>. On a
    35           macOS host, instead of the above device specification use for
    36           example <filepath>/dev/rdisk1</filepath>. Note that on Mac OS
    37           X you can only get access to an entire disk if no volume is
    38           mounted from it.
    39         </p>
    40     <p>
    41           Creating the image requires read/write access for the given
    42           device. Read/write access is also later needed when using the
    43           image from a virtual machine. On some host platforms, such as
    44           Windows, raw disk access may be restricted and not permitted
    45           by the host OS in some situations.
    46         </p>
    47     <p>
    48           Just like with regular disk images, this does not
    49           automatically attach the newly created image to a virtual
    50           machine. This can be done as follows:
    51         </p>
     16    <p>This creates the <filepath><varname>path-to-file</varname>.vmdk</filepath> file image that must be an absolute
     17      path. All data is read and written from <filepath>/dev/sda</filepath>. </p>
     18    <p>On a Windows host, instead of the above device specification, for example use
     19        <filepath>\\.\PhysicalDrive0</filepath>. On a macOS host, instead of the above device specification use for
     20      example <filepath>/dev/rdisk1</filepath>. Note that on Mac OS X you can only get access to an entire disk if no
     21      volume is mounted from it. </p>
     22    <p>Creating the image requires read/write access for the given device. Read/write access is also later needed when
     23      using the image from a virtual machine. On some host platforms, such as Windows, raw disk access may be restricted
     24      and not permitted by the host OS in some situations. </p>
     25    <p>Just like with regular disk images, this does not automatically attach the newly created image to a virtual
     26      machine. This can be done as follows: </p>
    5227    <pre xml:space="preserve">$ VBoxManage storageattach WindowsXP --storagectl "IDE Controller" \
    5328 --port 0 --device 0 --type hdd --medium <varname>path-to-file</varname>.vmdk</pre>
    54     <p>
    55           When this is done the selected virtual machine will boot from
    56           the specified physical disk.
    57         </p>
     29    <p>When this is done the selected virtual machine will boot from the specified physical disk. </p>
    5830  </body>
    5931 

  • trunk/doc/manual/en_US/dita/topics/rawdisk.dita

    r105176 r105335  
    55 
    66  <body>
    7     <p>
    8         As an alternative to using virtual disk images as described in
    9         <xref href="storage.dita">Virtual Storage</xref>, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can also present
    10         either entire physical hard disks or selected partitions as
    11         virtual disks to virtual machines.
    12       </p>
    13     <p>
    14         With <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, this type of access is called <i>raw
    15         hard disk access</i>. It enables a guest operating system
    16         to access its virtual hard disk without going through the host
    17         OS file system. The actual performance difference for image
    18         files compared to raw disk varies greatly depending on the
    19         overhead of the host file system, whether dynamically growing
    20         images are used, and on host OS caching strategies. The caching
    21         indirectly also affects other aspects such as failure behavior.
    22         For example, whether the virtual disk contains all data written
    23         before a host OS crash. Consult your host OS documentation for
    24         details on this.
    25       </p>
     7    <p>As an alternative to using virtual disk images as described in <xref href="storage.dita">Virtual Storage</xref>,
     8        <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can also present either entire physical hard disks or
     9      selected partitions as virtual disks to virtual machines. </p>
     10    <p>With <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, this type of access is called <i>raw hard disk
     11        access</i>. It enables a guest operating system to access its virtual hard disk without going through the host
     12      OS file system. The actual performance difference for image files compared to raw disk varies greatly depending on
     13      the overhead of the host file system, whether dynamically growing images are used, and on host OS caching
     14      strategies. The caching indirectly also affects other aspects such as failure behavior. For example, whether the
     15      virtual disk contains all data written before a host OS crash. Consult your host OS documentation for details on
     16      this. </p>
    2617    <note type="caution">
    27       <p>
    28           Raw hard disk access is for expert users only. Incorrect use
    29           or use of an outdated configuration can lead to
    30           <b outputclass="bold">total loss of data</b> on the
    31           physical disk. Most importantly, <i>do not</i>
    32           attempt to boot the partition with the currently running host
    33           operating system in a guest. This will lead to severe data
    34           corruption.
    35         </p>
     18      <p>Raw hard disk access is for expert users only. Incorrect use or use of an outdated configuration can lead to <b
     19          outputclass="bold">total loss of data</b> on the physical disk. Most importantly, <i>do not</i> attempt to
     20        boot the partition with the currently running host operating system in a guest. This will lead to severe data
     21        corruption. </p>
    3622    </note>
    37     <p>
    38         Raw hard disk access, both for entire disks and individual
    39         partitions, is implemented as part of the VMDK image format
    40         support. As a result, you will need to create a special VMDK
    41         image file which defines where the data will be stored. After
    42         creating such a special VMDK image, you can use it like a
    43         regular virtual disk image. For example, you can use the Virtual
    44         Media Manager, see <xref href="virtual-media-manager.dita">The Virtual Media Manager</xref>, or
    45         <userinput>VBoxManage</userinput> to assign the image to a virtual
    46         machine.
    47       </p>
     23    <p>Raw hard disk access, both for entire disks and individual partitions, is implemented as part of the VMDK image
     24      format support. As a result, you will need to create a special VMDK image file which defines where the data will
     25      be stored. After creating such a special VMDK image, you can use it like a regular virtual disk image. For
     26      example, you can use the Virtual Media Manager, see <xref href="virtual-media-manager.dita">The Virtual Media
     27        Manager</xref>, or <userinput>VBoxManage</userinput> to assign the image to a virtual machine. </p>
    4828  </body>
    4929</topic>

  • trunk/doc/manual/en_US/dita/topics/rdp-viewers.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p> Since VRDP is backward-compatible to RDP, you can use any standard RDP viewer to connect to
    8       such a remote virtual machine. For this to work, you must specify the IP address of your
    9         <i>host</i> system, not of the virtual machine, as the server address to connect to. You
    10       must also specify the port number that the VRDP server is using. </p>
    11     <p>
    12         The following examples are for the most common RDP viewers:
    13       </p>
     7    <p>Since VRDP is backward-compatible to RDP, you can use any standard RDP viewer to connect to such a remote virtual
     8      machine. For this to work, you must specify the IP address of your <i>host</i> system, not of the virtual machine,
     9      as the server address to connect to. You must also specify the port number that the VRDP server is using. </p>
     10    <p>The following examples are for the most common RDP viewers: </p>
    1411    <ul>
    1512      <li>
    16         <p>
    17             On Windows, you can use the Microsoft Terminal Services
    18             Connector, <userinput>mstsc.exe</userinput>, that is included
    19             with Windows. Press the Windows key + R, to display the
    20             <b outputclass="bold">Run</b> dialog. Enter
    21             <userinput>mstsc</userinput> to start the program. You can also
    22             find the program in <b outputclass="bold">Start</b>,
    23             <b outputclass="bold">All Programs</b>,
    24             <b outputclass="bold">Accessories</b>,
    25             <b outputclass="bold">Remote Desktop Connection</b>.
    26             If you use the <b outputclass="bold">Run</b> dialog,
    27             you can enter options directly. For example:
    28           </p>
     13        <p>On Windows, you can use the Microsoft Terminal Services Connector, <userinput>mstsc.exe</userinput>, that is
     14          included with Windows. Press the Windows key + R, to display the <b outputclass="bold">Run</b> dialog. Enter
     15            <userinput>mstsc</userinput> to start the program. You can also find the program in <b outputclass="bold"
     16            >Start</b>, <b outputclass="bold">All Programs</b>, <b outputclass="bold">Accessories</b>, <b
     17            outputclass="bold">Remote Desktop Connection</b>. If you use the <b outputclass="bold">Run</b> dialog, you
     18          can enter options directly. For example: </p>
    2919        <pre xml:space="preserve">mstsc 1.2.3.4:3389</pre>
    30         <p>
    31             Replace <codeph>1.2.3.4</codeph> with the host IP address,
    32             and <codeph>3389</codeph> with a different port, if
    33             necessary.
    34           </p>
     20        <p>Replace <codeph>1.2.3.4</codeph> with the host IP address, and <codeph>3389</codeph> with a different port,
     21          if necessary. </p>
    3522        <note>
    3623          <ul>
    3724            <li>
    38               <p>
    39                   IPv6 addresses must be enclosed in square brackets to
    40                   specify a port. For example: <codeph>mstsc
     25              <p>IPv6 addresses must be enclosed in square brackets to specify a port. For example: <codeph>mstsc
    4126                  [fe80::1:2:3:4]:3389</codeph>
    4227                                 </p>
    4328            </li>
    4429            <li>
    45               <p>
    46                   When connecting to localhost in order to test the
    47                   connection, the addresses <codeph>localhost</codeph>
    48                   and <codeph>127.0.0.1</codeph> might not work using
    49                   <userinput>mstsc.exe</userinput>. Instead, the address
    50                   <codeph>127.0.0.2[:3389]</codeph> has to be used.
    51                 </p>
     30              <p>When connecting to localhost in order to test the connection, the addresses <codeph>localhost</codeph>
     31                and <codeph>127.0.0.1</codeph> might not work using <userinput>mstsc.exe</userinput>. Instead, the
     32                address <codeph>127.0.0.2[:3389]</codeph> has to be used. </p>
    5233            </li>
    5334          </ul>
    … …  
    5536      </li>
    5637      <li>
    57         <p>
    58             On other systems, you can use the standard open source
    59             <userinput>rdesktop</userinput> program. This ships with most
    60             Linux distributions.
    61           </p>
    62         <p>
    63             With <userinput>rdesktop</userinput>, use a command line such as
    64             the following:
    65           </p>
     38        <p>On other systems, you can use the standard open source <userinput>rdesktop</userinput> program. This ships
     39          with most Linux distributions. </p>
     40        <p>With <userinput>rdesktop</userinput>, use a command line such as the following: </p>
    6641        <pre xml:space="preserve">$ rdesktop -a 16 -N 1.2.3.4:3389</pre>
    67         <p>
    68             Replace <codeph>1.2.3.4</codeph> with the host IP address,
    69             and <codeph>3389</codeph> with a different port, if
    70             necessary. The <codeph>-a</codeph> 16 option requests a
    71             color depth of 16 bits per pixel, which we recommend. For
    72             best performance, after installation of the guest operating
    73             system, you should set its display color depth to the same
    74             value. The <codeph>-N</codeph> option enables use of the
    75             NumPad keys.
    76           </p>
     42        <p>Replace <codeph>1.2.3.4</codeph> with the host IP address, and <codeph>3389</codeph> with a different port,
     43          if necessary. The <codeph>-a</codeph> 16 option requests a color depth of 16 bits per pixel, which we
     44          recommend. For best performance, after installation of the guest operating system, you should set its display
     45          color depth to the same value. The <codeph>-N</codeph> option enables use of the NumPad keys. </p>
    7746      </li>
    7847      <li>
    79         <p>
    80             You can use the Remmina remote desktop client with VRDP.
    81             This application is included with some Linux distributions,
    82             such as Debian and Ubuntu.
    83           </p>
     48        <p>You can use the Remmina remote desktop client with VRDP. This application is included with some Linux
     49          distributions, such as Debian and Ubuntu. </p>
    8450      </li>
    8551      <li>
    86         <p>
    87             If you run the KDE desktop, you can use
    88             <userinput>krdc</userinput>, the KDE RDP viewer. A typical
    89             command line is as follows:
    90           </p>
     52        <p>If you run the KDE desktop, you can use <userinput>krdc</userinput>, the KDE RDP viewer. A typical command
     53          line is as follows: </p>
    9154        <pre xml:space="preserve">$ krdc rdp://1.2.3.4:3389</pre>
    92         <p>
    93             Replace <codeph>1.2.3.4</codeph> with the host IP address,
    94             and <codeph>3389</codeph> with a different port, if
    95             necessary. The <codeph>rdp:// </codeph> prefix is required
    96             with <userinput>krdc</userinput> to switch it into RDP mode.
    97           </p>
     55        <p>Replace <codeph>1.2.3.4</codeph> with the host IP address, and <codeph>3389</codeph> with a different port,
     56          if necessary. The <codeph>rdp:// </codeph> prefix is required with <userinput>krdc</userinput> to switch it
     57          into RDP mode. </p>
    9858      </li>
    9959      <li>
    100         <p>
    101             With Sun Ray thin clients you can use
    102             <userinput>uttsc</userinput>, which is part of the Sun Ray
    103             Windows Connector package. See the Sun Ray documentation for
    104             details.
    105           </p>
     60        <p>With Sun Ray thin clients you can use <userinput>uttsc</userinput>, which is part of the Sun Ray Windows
     61          Connector package. See the Sun Ray documentation for details. </p>
    10662      </li>
    10763    </ul>

  • trunk/doc/manual/en_US/dita/topics/restrict-network-attachments.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         It is possible to remove networking modes from <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    9         GUI. To do this, use the following command:
    10       </p>
     7    <p>It is possible to remove networking modes from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GUI. To do
     8      this, use the following command: </p>
    119    <pre xml:space="preserve">VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes <varname>property</varname>[,<varname>property</varname>...]</pre>
    1210    <p><varname>property</varname> is one of the following:
    … …  
    1816        </dt>
    1917        <dd>
    20           <p>
    21               Remove the <b outputclass="bold">NAT</b> option
    22               from the GUI.
    23             </p>
     18          <p>Remove the <b outputclass="bold">NAT</b> option from the GUI. </p>
    2419        </dd>
    2520      </dlentry>
    … …  
    2924        </dt>
    3025        <dd>
    31           <p>
    32               Remove the <b outputclass="bold">NAT network</b>
    33               option from the GUI.
    34             </p>
     26          <p>Remove the <b outputclass="bold">NAT network</b> option from the GUI. </p>
    3527        </dd>
    3628      </dlentry>
    … …  
    4032        </dt>
    4133        <dd>
    42           <p>
    43               Remove the <b outputclass="bold">Bridged
    44               networking</b> option from the GUI.
    45             </p>
     34          <p>Remove the <b outputclass="bold">Bridged networking</b> option from the GUI. </p>
    4635        </dd>
    4736      </dlentry>
    … …  
    5140        </dt>
    5241        <dd>
    53           <p>
    54               Remove the <b outputclass="bold">Internal
    55               networking</b> option from the GUI.
    56             </p>
     42          <p>Remove the <b outputclass="bold">Internal networking</b> option from the GUI. </p>
    5743        </dd>
    5844      </dlentry>
    … …  
    6248        </dt>
    6349        <dd>
    64           <p>
    65               Remove the <b outputclass="bold">Host Only
    66               networking</b> option from the GUI.
    67             </p>
     50          <p>Remove the <b outputclass="bold">Host Only networking</b> option from the GUI. </p>
    6851        </dd>
    6952      </dlentry>
    … …  
    7356        </dt>
    7457        <dd>
    75           <p>
    76               Remove the <b outputclass="bold">Generic
    77               networking</b> option from the GUI.
    78             </p>
     58          <p>Remove the <b outputclass="bold">Generic networking</b> option from the GUI. </p>
    7959        </dd>
    8060      </dlentry>
    8161    </dl>
    82     <p>
    83         This is a global setting. You can specify any combination of
    84         properties. To restore the default behavior, use the following
    85         command:
    86       </p>
     62    <p>This is a global setting. You can specify any combination of properties. To restore the default behavior, use the
     63      following command: </p>
    8764    <pre xml:space="preserve">VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes</pre>
    8865  </body>

  • trunk/doc/manual/en_US/dita/topics/solariscodedumper.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is capable of producing its own core files for
    9       extensive debugging when things go wrong. Currently this is only
    10       available on Oracle Solaris hosts.
    11     </p>
    12     <p>
    13       The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper can be enabled using the following
    14       command:
    15     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> is capable of producing its own core files for extensive
     8      debugging when things go wrong. Currently this is only available on Oracle Solaris hosts. </p>
     9    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper can be enabled using the following command: </p>
    1610    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> VBoxInternal2/CoreDumpEnabled 1</pre>
    17     <p>
    18       You can specify which directory to use for core dumps with this
    19       command, as follows:
    20     </p>
     11    <p>You can specify which directory to use for core dumps with this command, as follows: </p>
    2112    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> VBoxInternal2/CoreDumpDir <varname>path-to-directory</varname>
    2213               </pre>
    2314    <p> Ensure the directory you specify is on a volume with sufficient free space and that the <ph
    24         conkeyref="vbox-conkeyref-phrases/product-name"/> process has sufficient permissions to
    25       write files to this directory. If you skip this command and do not specify any core dump
    26       directory, the current directory of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    27       executable will be used. This would most likely fail when writing cores as they are protected
    28       with root permissions. It is recommended you explicitly set a core dump directory. </p>
    29     <p>
    30       You must specify when the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper should be
    31       triggered. This is done using the following commands:
    32     </p>
     15        conkeyref="vbox-conkeyref-phrases/product-name"/> process has sufficient permissions to write files to this
     16      directory. If you skip this command and do not specify any core dump directory, the current directory of the <ph
     17        conkeyref="vbox-conkeyref-phrases/product-name"/> executable will be used. This would most likely fail when
     18      writing cores as they are protected with root permissions. It is recommended you explicitly set a core dump
     19      directory. </p>
     20    <p>You must specify when the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper should be triggered.
     21      This is done using the following commands: </p>
    3322    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> VBoxInternal2/CoreDumpReplaceSystemDump 1
    3423$ VBoxManage setextradata <varname>VM-name</varname> VBoxInternal2/CoreDumpLive 1</pre>
    35     <p>
    36       At least one of the above two commands will have to be provided if
    37       you have enabled the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper.
    38     </p>
    39     <p>
    40       Setting <codeph>CoreDumpReplaceSystemDump</codeph> sets up the
    41       VM to override the host's core dumping mechanism and in the event
    42       of any crash only the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper would produce the
    43       core file.
    44     </p>
    45     <p>
    46       Setting <codeph>CoreDumpLive</codeph> sets up the VM to produce
    47       cores whenever the VM process receives a
    48       <codeph>SIGUSR2</codeph> signal. After producing the core file,
    49       the VM will not be terminated and will continue to run. You can
    50       thus take cores of the VM process using the following command:
    51     </p>
     24    <p>At least one of the above two commands will have to be provided if you have enabled the <ph
     25        conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper. </p>
     26    <p>Setting <codeph>CoreDumpReplaceSystemDump</codeph> sets up the VM to override the host's core dumping mechanism
     27      and in the event of any crash only the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper would
     28      produce the core file. </p>
     29    <p>Setting <codeph>CoreDumpLive</codeph> sets up the VM to produce cores whenever the VM process receives a
     30        <codeph>SIGUSR2</codeph> signal. After producing the core file, the VM will not be terminated and will continue
     31      to run. You can thus take cores of the VM process using the following command: </p>
    5232    <pre xml:space="preserve">$ kill -s SIGUSR2 <varname>VM-process-id</varname>
    5333               </pre>
    54     <p>
    55       The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper creates core files of the form
     34    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper creates core files of the form
    5635      <filepath>core.vb.<varname>process-name</varname>.<varname>process-ID</varname>
    57                   </filepath>
    58       such as <filepath>core.vb.VBoxHeadless.11321</filepath>.
    59     </p>
     36      </filepath> such as <filepath>core.vb.VBoxHeadless.11321</filepath>. </p>
    6037  </body>
    6138 

  • trunk/doc/manual/en_US/dita/topics/sse412passthrough.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8       To provide SSE 4.1/SSE 4.2 support to guests, the host CPU has to
    9       implement these instruction sets. The instruction sets are exposed
    10       to guests by default, but it is possible to disable the
    11       instructions for certain guests by using the following commands:
    12     </p>
     7    <p>To provide SSE 4.1/SSE 4.2 support to guests, the host CPU has to implement these instruction sets. The
     8      instruction sets are exposed to guests by default, but it is possible to disable the instructions for certain
     9      guests by using the following commands: </p>
    1310    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \
    1411VBoxInternal/CPUM/IsaExts/SSE4.1 0
    1512$ VBoxManage setextradata <varname>VM-name</varname> \
    1613VBoxInternal/CPUM/IsaExts/SSE4.2 0</pre>
    17     <p>
    18       These are per-VM settings which are enabled by default.
    19     </p>
     14    <p>These are per-VM settings which are enabled by default. </p>
    2015  </body>
    2116 

  • trunk/doc/manual/en_US/dita/topics/storage-bandwidth-limit.dita

    r99797 r105335  
    66           
    77            <body>
    8                <p>
    9       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports limiting of the maximum bandwidth used for
    10       asynchronous I/O. Additionally it supports sharing limits through
    11       bandwidth groups for several images. It is possible to have more
    12       than one such limit.
    13     </p>
    14                <p>
    15       Limits are configured using <userinput>VBoxManage</userinput>. The
    16       example below creates a bandwidth group named Limit, sets the
    17       limit to 20 MB per second, and assigns the group to the attached
    18       disks of the VM:
    19     </p>
     8               <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports limiting of the maximum bandwidth used
     9      for asynchronous I/O. Additionally it supports sharing limits through bandwidth groups for several images. It is
     10      possible to have more than one such limit. </p>
     11               <p>Limits are configured using <userinput>VBoxManage</userinput>. The example below creates a bandwidth
     12      group named Limit, sets the limit to 20 MB per second, and assigns the group to the attached disks of the VM: </p>
    2013               <pre xml:space="preserve">VBoxManage bandwidthctl "VM name" add Limit --type disk --limit 20M
    2114VBoxManage storageattach "VM name" --storagectl "SATA" --port 0 --device 0 --type hdd
    … …  
    2316VBoxManage storageattach "VM name" --storagectl "SATA" --port 1 --device 0 --type hdd
    2417                                   --medium disk2.vdi --bandwidthgroup Limit</pre>
    25                <p>
    26       All disks in a group share the bandwidth limit, meaning that in
    27       the example above the bandwidth of both images combined can never
    28       exceed 20 MBps. However, if one disk does not require bandwidth
    29       the other can use the remaining bandwidth of its group.
    30     </p>
    31                <p>
    32       The limits for each group can be changed while the VM is running,
    33       with changes being picked up immediately. The example below
    34       changes the limit for the group created in the example above to 10
    35       MBps:
    36     </p>
     18               <p>All disks in a group share the bandwidth limit, meaning that in the example above the bandwidth of
     19      both images combined can never exceed 20 MBps. However, if one disk does not require bandwidth the other can use
     20      the remaining bandwidth of its group. </p>
     21               <p>The limits for each group can be changed while the VM is running, with changes being picked up
     22      immediately. The example below changes the limit for the group created in the example above to 10 MBps: </p>
    3723               <pre xml:space="preserve">VBoxManage bandwidthctl "VM name" set Limit --limit 10M</pre>
    3824            </body>

  • trunk/doc/manual/en_US/dita/topics/storage-cds.dita

    r99797 r105335  
    66           
    77            <body>
    8                <p>
    9       Virtual CD/DVD drives by default support only reading. The medium
    10       configuration is changeable at runtime. You can select between the
    11       following options to provide the medium data:
    12     </p>
     8               <p>Virtual CD/DVD drives by default support only reading. The medium configuration is changeable at
     9      runtime. You can select between the following options to provide the medium data: </p>
    1310               <ul>
    1411                  <li>
    15                      <p>
    16                         <b outputclass="bold">Host Drive</b> defines that the
    17           guest can read from the medium in the host drive.
    18         </p>
     12                     <p><b outputclass="bold">Host Drive</b> defines that the guest can read from the medium in the host
     13          drive. </p>
    1914                  </li>
    2015                  <li>
    21                      <p>
    22                         <b outputclass="bold">Image file</b> gives the guest
    23           read-only access to the data in the image. This is typically
    24           an ISO file.
    25         </p>
     16                     <p><b outputclass="bold">Image file</b> gives the guest read-only access to the data in the image.
     17          This is typically an ISO file. </p>
    2618                  </li>
    2719                  <li>
    28                      <p>
    29                         <b outputclass="bold">Empty</b> means a drive without
    30           an inserted medium.
    31         </p>
     20                     <p><b outputclass="bold">Empty</b> means a drive without an inserted medium. </p>
    3221                  </li>
    3322               </ul>
    34                <p>
    35       Changing between the above, or changing a medium in the host drive
    36       that is accessed by a machine, or changing an image file will
    37       signal a medium change to the guest OS. The guest OS can then
    38       react to the change, for example by starting an installation
    39       program.
    40     </p>
    41                <p>
    42       Medium changes can be prevented by the guest, and <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    43       reflects that by locking the host drive if appropriate. You can
    44       force a medium removal in such situations by using the VirtualBox
    45       Manager or the <userinput>VBoxManage</userinput> command line tool.
    46       Effectively this is the equivalent of the emergency eject which
    47       many CD/DVD drives provide, with all associated side effects. The
    48       guest OS can issue error messages, just like on real hardware, and
    49       guest applications may misbehave. Use this with caution.
    50     </p>
     23               <p>Changing between the above, or changing a medium in the host drive that is accessed by a machine, or
     24      changing an image file will signal a medium change to the guest OS. The guest OS can then react to the change, for
     25      example by starting an installation program. </p>
     26               <p>Medium changes can be prevented by the guest, and <ph conkeyref="vbox-conkeyref-phrases/product-name"
     27      /> reflects that by locking the host drive if appropriate. You can force a medium removal in such situations by
     28      using the VirtualBox Manager or the <userinput>VBoxManage</userinput> command line tool. Effectively this is the
     29      equivalent of the emergency eject which many CD/DVD drives provide, with all associated side effects. The guest OS
     30      can issue error messages, just like on real hardware, and guest applications may misbehave. Use this with caution. </p>
    5131               <note>
    52                   <p>
    53         The identification string of the drive provided to the guest,
    54         displayed by configuration tools such as the Windows Device
    55         Manager, is always VBOX CD-ROM, irrespective of the current
    56         configuration of the virtual drive. This is to prevent hardware
    57         detection from being triggered in the guest OS every time the
    58         configuration is changed.
    59       </p>
     32                  <p>The identification string of the drive provided to the guest, displayed by configuration tools such
     33        as the Windows Device Manager, is always VBOX CD-ROM, irrespective of the current configuration of the virtual
     34        drive. This is to prevent hardware detection from being triggered in the guest OS every time the configuration
     35        is changed. </p>
    6036               </note>
    61                <p>
    62       The standard CD/DVD emulation enables reading of standard data CD
    63       and DVD formats only. As an experimental feature, for additional
    64       capabilities, it is possible to give the guest direct access to
    65       the CD/DVD host drive by enabling <i>passthrough</i>
    66       mode. Depending on the host hardware, this may potentially enable
    67       the following things to work:
    68     </p>
     37               <p>The standard CD/DVD emulation enables reading of standard data CD and DVD formats only. As an
     38      experimental feature, for additional capabilities, it is possible to give the guest direct access to the CD/DVD
     39      host drive by enabling <i>passthrough</i> mode. Depending on the host hardware, this may potentially enable the
     40      following things to work: </p>
    6941               <ul>
    7042                  <li>
    71                      <p>
    72           CD/DVD writing from within the guest, if the host DVD drive is
    73           a CD/DVD writer
    74         </p>
     43                     <p>CD/DVD writing from within the guest, if the host DVD drive is a CD/DVD writer </p>
    7544                  </li>
    7645                  <li>
    77                      <p>
    78           Playing audio CDs
    79         </p>
     46                     <p>Playing audio CDs </p>
    8047                  </li>
    8148                  <li>
    82                      <p>
    83           Playing encrypted DVDs
    84         </p>
     49                     <p>Playing encrypted DVDs </p>
    8550                  </li>
    8651               </ul>
    87                <p> To enable host drive passthrough you can use the <codeph>--passthrough</codeph>
    88       option of the <userinput>VBoxManage storageattach</userinput> command. See <xref
    89         href="vboxmanage-storageattach.dita"/>. </p>
    90                <p>
    91       Even if passthrough is enabled, unsafe commands, such as updating
    92       the drive firmware, will be blocked. Video CD formats are never
    93       supported, not even in passthrough mode, and cannot be played from
    94       a virtual machine.
    95     </p>
    96                <p>
    97       On Oracle Solaris hosts, passthrough requires running
    98       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> with real root permissions due to security measures
    99       enforced by the host.
    100     </p>
     52               <p>To enable host drive passthrough you can use the <codeph>--passthrough</codeph> option of the
     53        <userinput>VBoxManage storageattach</userinput> command. See <xref href="vboxmanage-storageattach.dita"/>. </p>
     54               <p>Even if passthrough is enabled, unsafe commands, such as updating the drive firmware, will be blocked.
     55      Video CD formats are never supported, not even in passthrough mode, and cannot be played from a virtual machine. </p>
     56               <p>On Oracle Solaris hosts, passthrough requires running <ph
     57        conkeyref="vbox-conkeyref-phrases/product-name"/> with real root permissions due to security measures enforced
     58      by the host. </p>
    10159            </body>
    10260           

  • trunk/doc/manual/en_US/dita/topics/storage-iscsi.dita

    r99797 r105335  
    66           
    77            <body>
    8                <p>
    9       iSCSI stands for <i>Internet SCSI</i> and is a
    10       standard that supports use of the SCSI protocol over Internet
    11       (TCP/IP) connections. Especially with the advent of Gigabit
    12       Ethernet, it has become affordable to attach iSCSI storage servers
    13       simply as remote hard disks to a computer network. In iSCSI
    14       terminology, the server providing storage resources is called an
    15       <i>iSCSI target</i>, while the client connecting to
    16       the server and accessing its resources is called an
    17       <i>iSCSI initiator</i>.
    18     </p>
    19                <p>
    20       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can transparently present iSCSI remote storage to a
    21       virtual machine as a virtual hard disk. The guest OS will not see
    22       any difference between a virtual disk image (VDI file) and an
    23       iSCSI target. To achieve this, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has an integrated
    24       iSCSI initiator.
    25     </p>
    26                <p> <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s iSCSI support has been developed according to the iSCSI
    27       standard and should work with all standard-conforming iSCSI targets. To use an iSCSI target
    28       with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you must use the command line. See <xref
     8               <p>iSCSI stands for <i>Internet SCSI</i> and is a standard that supports use of the SCSI protocol over
     9      Internet (TCP/IP) connections. Especially with the advent of Gigabit Ethernet, it has become affordable to attach
     10      iSCSI storage servers simply as remote hard disks to a computer network. In iSCSI terminology, the server
     11      providing storage resources is called an <i>iSCSI target</i>, while the client connecting to the server and
     12      accessing its resources is called an <i>iSCSI initiator</i>. </p>
     13               <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can transparently present iSCSI remote storage
     14      to a virtual machine as a virtual hard disk. The guest OS will not see any difference between a virtual disk image
     15      (VDI file) and an iSCSI target. To achieve this, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has an
     16      integrated iSCSI initiator. </p>
     17               <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s iSCSI support has been developed according to
     18      the iSCSI standard and should work with all standard-conforming iSCSI targets. To use an iSCSI target with <ph
     19        conkeyref="vbox-conkeyref-phrases/product-name"/>, you must use the command line. See <xref
    2920        href="vboxmanage-storageattach.dita"/>. </p>
    3021            </body>

  • trunk/doc/manual/en_US/dita/topics/storage.dita

    r99797 r105335  
    66         
    77         <body>
    8             <p>
    9     As the virtual machine will most probably expect to see a hard disk
    10     built into its virtual computer, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> must be able to
    11     present real storage to the guest as a virtual hard disk. There are
    12     presently three methods by which to achieve this:
    13   </p>
     8            <p>As the virtual machine will most probably expect to see a hard disk built into its virtual computer, <ph
     9        conkeyref="vbox-conkeyref-phrases/product-name"/> must be able to present real storage to the guest as a virtual
     10      hard disk. There are presently three methods by which to achieve this: </p>
    1411            <ul>
    1512               <li>
    16                   <p>
    17         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can use large image files on a real hard disk and
    18         present them to a guest as a virtual hard disk. This is the most
    19         common method, described in <xref href="vdidetails.dita#vdidetails"/>.
    20       </p>
     13                  <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can use large image files on a real hard disk
     14          and present them to a guest as a virtual hard disk. This is the most common method, described in <xref
     15            href="vdidetails.dita#vdidetails"/>. </p>
    2116               </li>
    2217               <li>

  • trunk/doc/manual/en_US/dita/topics/sysprep.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p> Microsoft offers a system preparation tool called Sysprep, to prepare a Windows system for
    8       deployment or redistribution. Some Windows releases include Sysprep on the installation
    9       medium, but the tool is also available for download from the Microsoft website. In a standard
    10       For most Windows versions, Sysprep is included in a default installation. Sysprep mainly
    11       consists of an executable called <userinput>sysprep.exe</userinput> which is invoked by the
    12       user to put the Windows installation into preparation mode. </p>
    13     <p>
    14         The Guest Additions offer a way to launch a system preparation
    15         on the guest operating system in an automated way, controlled
    16         from the host system. See
    17         <xref href="guestadd-guestcontrol.dita">Guest Control of Applications</xref> for details of how to
    18         use this feature with the special identifier
    19         <codeph>sysprep</codeph> as the program to execute, along with
    20         the user name <codeph>sysprep</codeph> and password
    21         <codeph>sysprep</codeph> for the credentials. Sysprep is then
    22         started with the required system rights.
    23       </p>
     7    <p>Microsoft offers a system preparation tool called Sysprep, to prepare a Windows system for deployment or
     8      redistribution. Some Windows releases include Sysprep on the installation medium, but the tool is also available
     9      for download from the Microsoft website. In a standard For most Windows versions, Sysprep is included in a default
     10      installation. Sysprep mainly consists of an executable called <userinput>sysprep.exe</userinput> which is invoked
     11      by the user to put the Windows installation into preparation mode. </p>
     12    <p>The Guest Additions offer a way to launch a system preparation on the guest operating system in an automated way,
     13      controlled from the host system. See <xref href="guestadd-guestcontrol.dita">Guest Control of Applications</xref>
     14      for details of how to use this feature with the special identifier <codeph>sysprep</codeph> as the program to
     15      execute, along with the user name <codeph>sysprep</codeph> and password <codeph>sysprep</codeph> for the
     16      credentials. Sysprep is then started with the required system rights. </p>
    2417    <note>
    25       <p>
    26           Specifying the location of <userinput>sysprep.exe</userinput> is
    27           <b outputclass="bold">not possible</b>. Instead the
    28           following paths are used, based on the Windows release:
    29         </p>
     18      <p>Specifying the location of <userinput>sysprep.exe</userinput> is <b outputclass="bold">not possible</b>.
     19        Instead the following paths are used, based on the Windows release: </p>
    3020      <ul>
    3121        <li>
    … …  
    4030        </li>
    4131      </ul>
    42       <p>
    43           The Guest Additions will automatically use the appropriate
    44           path to execute the system preparation tool.
    45         </p>
     32      <p>The Guest Additions will automatically use the appropriate path to execute the system preparation tool. </p>
    4633    </note>
    4734  </body>

  • trunk/doc/manual/en_US/dita/topics/teleporting.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports <i>teleporting</i>.
    9       Teleporting is moving a virtual machine over a network from one
    10       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> host to another, while the virtual machine is
    11       running. This works regardless of the host operating system that
    12       is running on the hosts. You can teleport virtual machines between
    13       Oracle Solaris and macOS hosts, for example.
    14     </p>
    15     <p>
    16       Teleporting requires that a machine be currently running on one
    17       host, which is called the <i>source</i>. The host to
    18       which the virtual machine will be teleported is called the
    19       <i>target</i>. The machine on the target is then
    20       configured to wait for the source to contact the target. The
    21       machine's running state will then be transferred from the source
    22       to the target with minimal downtime.
    23     </p>
    24     <p>
    25       Teleporting happens over any TCP/IP network. The source and the
    26       target only need to agree on a TCP/IP port which is specified in
    27       the teleporting settings.
    28     </p>
    29     <p>
    30       At this time, there are a few prerequisites for this to work, as
    31       follows:
    32     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports <i>teleporting</i>. Teleporting is moving a
     8      virtual machine over a network from one <ph conkeyref="vbox-conkeyref-phrases/product-name"/> host to another,
     9      while the virtual machine is running. This works regardless of the host operating system that is running on the
     10      hosts. You can teleport virtual machines between Oracle Solaris and macOS hosts, for example. </p>
     11    <p>Teleporting requires that a machine be currently running on one host, which is called the <i>source</i>. The host
     12      to which the virtual machine will be teleported is called the <i>target</i>. The machine on the target is then
     13      configured to wait for the source to contact the target. The machine's running state will then be transferred from
     14      the source to the target with minimal downtime. </p>
     15    <p>Teleporting happens over any TCP/IP network. The source and the target only need to agree on a TCP/IP port which
     16      is specified in the teleporting settings. </p>
     17    <p>At this time, there are a few prerequisites for this to work, as follows: </p>
    3318    <ul>
    3419      <li>
    35         <p>
    36           On the target host, you must configure a virtual machine in
    37           <ph conkeyref="vbox-conkeyref-phrases/product-name"/> with exactly the same hardware settings as the
    38           machine on the source that you want to teleport. This does not
    39           apply to settings which are merely descriptive, such as the VM
    40           name, but obviously for teleporting to work, the target
    41           machine must have the same amount of memory and other hardware
    42           settings. Otherwise teleporting will fail with an error
    43           message.
    44         </p>
     20        <p>On the target host, you must configure a virtual machine in <ph
     21            conkeyref="vbox-conkeyref-phrases/product-name"/> with exactly the same hardware settings as the machine on
     22          the source that you want to teleport. This does not apply to settings which are merely descriptive, such as
     23          the VM name, but obviously for teleporting to work, the target machine must have the same amount of memory and
     24          other hardware settings. Otherwise teleporting will fail with an error message. </p>
    4525      </li>
    4626      <li>
    47         <p>
    48           The two virtual machines on the source and the target must
    49           share the same storage, hard disks as well as floppy disks and
    50           CD/DVD images. This means that they either use the same iSCSI
    51           targets or that the storage resides somewhere on the network
    52           and both hosts have access to it using NFS or SMB/CIFS.
    53         </p>
    54         <p>
    55           This also means that neither the source nor the target machine
    56           can have any snapshots.
    57         </p>
     27        <p>The two virtual machines on the source and the target must share the same storage, hard disks as well as
     28          floppy disks and CD/DVD images. This means that they either use the same iSCSI targets or that the storage
     29          resides somewhere on the network and both hosts have access to it using NFS or SMB/CIFS. </p>
     30        <p>This also means that neither the source nor the target machine can have any snapshots. </p>
    5831      </li>
    5932    </ul>
    60     <p>
    61       To configure teleporting, perform the following steps:
    62     </p>
     33    <p>To configure teleporting, perform the following steps: </p>
    6334    <ol>
    6435      <li>
    65         <p>
    66           On the <i>target</i> host, configure the virtual
    67           machine to wait for a teleport request to arrive when it is
    68           started, instead of actually attempting to start the machine.
    69           This is done with the following <userinput>VBoxManage</userinput>
    70           command:
    71         </p>
     36        <p>On the <i>target</i> host, configure the virtual machine to wait for a teleport request to arrive when it is
     37          started, instead of actually attempting to start the machine. This is done with the following
     38            <userinput>VBoxManage</userinput> command: </p>
    7239        <pre xml:space="preserve">VBoxManage modifyvm <varname>targetvmname</varname> --teleporter on --teleporter-port <varname>port</varname>
    7340                     </pre>
    … …  
    8047      </li>
    8148      <li>
    82         <p>
    83           Start the VM on the target host. Instead of running, the VM
    84           shows a progress dialog, indicating that it is waiting for a
    85           teleport request to arrive.
    86         </p>
     49        <p>Start the VM on the target host. Instead of running, the VM shows a progress dialog, indicating that it is
     50          waiting for a teleport request to arrive. </p>
    8751      </li>
    8852      <li>
    89         <p>
    90           Start the VM on the <i>source</i> host as usual.
    91           When it is running and you want it to be teleported, issue the
    92           following command on the source host:
    93         </p>
     53        <p>Start the VM on the <i>source</i> host as usual. When it is running and you want it to be teleported, issue
     54          the following command on the source host: </p>
    9455        <pre xml:space="preserve">VBoxManage controlvm <varname>sourcevmname</varname> teleport --host <varname>targethost</varname> --port <varname>port</varname>
    9556                     </pre>
    96         <p>
    97           where <varname>sourcevmname</varname> is the name of
    98           the virtual machine on the source host, which is the machine
    99           that is currently running.
    100           <varname>targethost</varname> is the host or IP name
    101           of the target host on which the machine is waiting for the
    102           teleport request, and <varname>port</varname> must be
    103           the same number as specified in the command on the target
    104           host. See <xref href="vboxmanage-controlvm.dita">VBoxManage controlvm</xref>.
    105         </p>
     57        <p>where <varname>sourcevmname</varname> is the name of the virtual machine on the source host, which is the
     58          machine that is currently running. <varname>targethost</varname> is the host or IP name of the target host on
     59          which the machine is waiting for the teleport request, and <varname>port</varname> must be the same number as
     60          specified in the command on the target host. See <xref href="vboxmanage-controlvm.dita">VBoxManage
     61            controlvm</xref>. </p>
    10662      </li>
    10763    </ol>
    108     <p>
    109       For testing, you can also teleport machines on the same host. In
    110       that case, use localhost as the hostname on both the source and
    111       the target host.
    112     </p>
     64    <p>For testing, you can also teleport machines on the same host. In that case, use localhost as the hostname on both
     65      the source and the target host. </p>
    11366    <note>
    114       <p>
    115         In rare cases, if the CPUs of the source and the target are very
    116         different, teleporting can fail with an error message, or the
    117         target may hang. This may happen especially if the VM is running
    118         application software that is highly optimized to run on a
    119         particular CPU without correctly checking that certain CPU
    120         features are actually present. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> filters what CPU
    121         capabilities are presented to the guest operating system.
    122         Advanced users can attempt to restrict these virtual CPU
    123         capabilities with the <userinput>VBoxManage modifyvm
    124         --cpuid-portability-level</userinput> command. See
    125         <xref href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref>.
    126       </p>
     67      <p>In rare cases, if the CPUs of the source and the target are very different, teleporting can fail with an error
     68        message, or the target may hang. This may happen especially if the VM is running application software that is
     69        highly optimized to run on a particular CPU without correctly checking that certain CPU features are actually
     70        present. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> filters what CPU capabilities are presented to
     71        the guest operating system. Advanced users can attempt to restrict these virtual CPU capabilities with the
     72          <userinput>VBoxManage modifyvm --cpuid-portability-level</userinput> command. See <xref
     73          href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref>. </p>
    12774    </note>
    12875  </body>

  • trunk/doc/manual/en_US/dita/topics/terminate-vm-action.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         You can disallow certain actions when terminating a VM. To
    9         disallow specific actions, use the following command:
    10       </p>
     7    <p>You can disallow certain actions when terminating a VM. To disallow specific actions, use the following command: </p>
    118    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> GUI/RestrictedCloseActions <varname>property</varname>[,<varname>property</varname>...]</pre>
    129    <p><varname>property</varname> is one of the following:
    … …  
    1815        </dt>
    1916        <dd>
    20           <p>
    21               Do not allow the user to save the VM state when
    22               terminating the VM.
    23             </p>
     17          <p>Do not allow the user to save the VM state when terminating the VM. </p>
    2418        </dd>
    2519      </dlentry>
    … …  
    2923        </dt>
    3024        <dd>
    31           <p>
    32               Do not allow the user to shutdown the VM by sending the
    33               ACPI power-off event to the guest.
    34             </p>
     25          <p>Do not allow the user to shutdown the VM by sending the ACPI power-off event to the guest. </p>
    3526        </dd>
    3627      </dlentry>
    … …  
    4031        </dt>
    4132        <dd>
    42           <p>
    43               Do not allow the user to power off the VM.
    44             </p>
     33          <p>Do not allow the user to power off the VM. </p>
    4534        </dd>
    4635      </dlentry>
    … …  
    5039        </dt>
    5140        <dd>
    52           <p>
    53               Do not allow the user to return to the last snapshot when
    54               powering off the VM.
    55             </p>
     41          <p>Do not allow the user to return to the last snapshot when powering off the VM. </p>
    5642        </dd>
    5743      </dlentry>
    … …  
    6147        </dt>
    6248        <dd>
    63           <p>
    64               Do not allow the user to detach from the VM process if the
    65               VM was started in separate mode.
    66             </p>
     49          <p>Do not allow the user to detach from the VM process if the VM was started in separate mode. </p>
    6750        </dd>
    6851      </dlentry>
    6952    </dl>
    70     <p>
    71         This is a per-VM setting. You can specify any combination of
    72         properties. If all properties are specified, the VM cannot be
    73         shut down.
    74       </p>
     53    <p>This is a per-VM setting. You can specify any combination of properties. If all properties are specified, the VM
     54      cannot be shut down. </p>
    7555  </body>
    7656 

  • trunk/doc/manual/en_US/dita/topics/terminate-vm-default-action.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         You can define a specific action for terminating a VM. In
    9         contrast to the setting decribed in the previous section, this
    10         setting allows only one action when the user terminates the VM.
    11         No exit menu is shown. Use the following command:
    12       </p>
     7    <p>You can define a specific action for terminating a VM. In contrast to the setting decribed in the previous
     8      section, this setting allows only one action when the user terminates the VM. No exit menu is shown. Use the
     9      following command: </p>
    1310    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> GUI/DefaultCloseAction <varname>action</varname>
    1411                  </pre>
    … …  
    2118        </dt>
    2219        <dd>
    23           <p>
    24               Save the VM state before terminating the VM process.
    25             </p>
     20          <p>Save the VM state before terminating the VM process. </p>
    2621        </dd>
    2722      </dlentry>
    … …  
    3126        </dt>
    3227        <dd>
    33           <p>
    34               The VM is shut down by sending the ACPI power-off event to
    35               the guest.
    36             </p>
     28          <p>The VM is shut down by sending the ACPI power-off event to the guest. </p>
    3729        </dd>
    3830      </dlentry>
    … …  
    4234        </dt>
    4335        <dd>
    44           <p>
    45               The VM is powered off.
    46             </p>
     36          <p>The VM is powered off. </p>
    4737        </dd>
    4838      </dlentry>
    … …  
    5242        </dt>
    5343        <dd>
    54           <p>
    55               The VM is powered off and the saved state returns to the
    56               last snapshot.
    57             </p>
     44          <p>The VM is powered off and the saved state returns to the last snapshot. </p>
    5845        </dd>
    5946      </dlentry>
    … …  
    6350        </dt>
    6451        <dd>
    65           <p>
    66               Terminate the frontend but leave the VM process running.
    67             </p>
     52          <p>Terminate the frontend but leave the VM process running. </p>
    6853        </dd>
    6954      </dlentry>
    7055    </dl>
    71     <p>
    72         This is a per-VM setting. You can specify any combination of
    73         properties. If all properties are specified, the VM cannot be
    74         shut down.
    75       </p>
     56    <p>This is a per-VM setting. You can specify any combination of properties. If all properties are specified, the VM
     57      cannot be shut down. </p>
    7658  </body>
    7759 

  • trunk/doc/manual/en_US/dita/topics/usb-over-rdp.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         As a special feature additional to the VRDP support,
    9         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also supports remote USB devices over the wire.
    10         That is, an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guest that runs on one computer can
    11         access the USB devices of the remote computer on which the VRDP
    12         data is being displayed the same way as USB devices that are
    13         connected to the actual host. This enables running of virtual
    14         machines on an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> host that acts as a server, where
    15         a client can connect from elsewhere that needs only a network
    16         adapter and a display capable of running an RDP viewer. When USB
    17         devices are plugged into the client, the remote <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    18         server can access them.
    19       </p>
    20     <p>
    21         For these remote USB devices, the same filter rules apply as for
    22         other USB devices. See <xref href="settings-usb.dita">USB Settings</xref>. All you
    23         have to do is specify Remote, or Any, when setting up these
    24         rules.
    25       </p>
    26     <p>
    27         Accessing remote USB devices is only possible if the RDP client
    28         supports this extension. Some versions of
    29         <userinput>uttsc</userinput>, a client tailored for the use with Sun
    30         Ray thin clients, support accessing remote USB devices. RDP
    31         clients for other platforms will be provided in future
    32         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> versions.
    33       </p>
     7    <p>As a special feature additional to the VRDP support, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also
     8      supports remote USB devices over the wire. That is, an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guest
     9      that runs on one computer can access the USB devices of the remote computer on which the VRDP data is being
     10      displayed the same way as USB devices that are connected to the actual host. This enables running of virtual
     11      machines on an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> host that acts as a server, where a client
     12      can connect from elsewhere that needs only a network adapter and a display capable of running an RDP viewer. When
     13      USB devices are plugged into the client, the remote <ph conkeyref="vbox-conkeyref-phrases/product-name"/> server
     14      can access them. </p>
     15    <p>For these remote USB devices, the same filter rules apply as for other USB devices. See <xref
     16        href="settings-usb.dita">USB Settings</xref>. All you have to do is specify Remote, or Any, when setting up
     17      these rules. </p>
     18    <p>Accessing remote USB devices is only possible if the RDP client supports this extension. Some versions of
     19        <userinput>uttsc</userinput>, a client tailored for the use with Sun Ray thin clients, support accessing remote
     20      USB devices. RDP clients for other platforms will be provided in future <ph
     21        conkeyref="vbox-conkeyref-phrases/product-name"/> versions. </p>
    3422  </body>
    3523 

  • trunk/doc/manual/en_US/dita/topics/usbip-security.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         The communication between the server and client is unencrypted
    9         and there is no authorization required to access exported
    10         devices. An attacker might sniff sensitive data or gain control
    11         over a device. To mitigate this risk, the device should be
    12         exposed over a local network to which only trusted clients have
    13         access. To access the device remotely over a public network, a
    14         VPN solution should be used to provide the required level of
    15         security protection.
    16       </p>
     7    <p>The communication between the server and client is unencrypted and there is no authorization required to access
     8      exported devices. An attacker might sniff sensitive data or gain control over a device. To mitigate this risk, the
     9      device should be exposed over a local network to which only trusted clients have access. To access the device
     10      remotely over a public network, a VPN solution should be used to provide the required level of security
     11      protection. </p>
    1712  </body>
    1813 

  • trunk/doc/manual/en_US/dita/topics/usbip-setup-server.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         This section gives a brief overview on how to set up a Linux
    9         based system to act as a USB device server. The system on the
    10         server requires that the <filepath>usbip-core.ko</filepath> and
    11         <filepath>usbip-host.ko</filepath> kernel drivers are available,
    12         and that the USB/IP tools package is installed. The particular
    13         installation method for the necessary tools depends on which
    14         distribution is used. For example, for Debian based systems, use
    15         the following command to install the required tools:
    16       </p>
     7    <p>This section gives a brief overview on how to set up a Linux based system to act as a USB device server. The
     8      system on the server requires that the <filepath>usbip-core.ko</filepath> and <filepath>usbip-host.ko</filepath>
     9      kernel drivers are available, and that the USB/IP tools package is installed. The particular installation method
     10      for the necessary tools depends on which distribution is used. For example, for Debian based systems, use the
     11      following command to install the required tools: </p>
    1712    <pre xml:space="preserve">$ apt-get install usbip-utils</pre>
    18     <p>
    19         To check whether the necessary tools are already installed use
    20         the following command:
    21       </p>
     13    <p>To check whether the necessary tools are already installed use the following command: </p>
    2214    <pre xml:space="preserve">$ usbip list -l
    2315      </pre>
    24     <p>
    25         This should produce output similar to that shown in the example
    26         below:
    27       </p>
     16    <p>This should produce output similar to that shown in the example below: </p>
    2817    <pre xml:space="preserve"> - busid 4-2 (0bda:0301)
    2918   Realtek Semiconductor Corp. : multicard reader (0bda:0301)
    … …  
    3221   Logitech, Inc. : Unifying Receiver (046d:c52b)
    3322      </pre>
    34     <p>
    35         If everything is installed, the USB/IP server needs to be
    36         started as <codeph>root</codeph> using the following command:
    37       </p>
     23    <p>If everything is installed, the USB/IP server needs to be started as <codeph>root</codeph> using the following
     24      command: </p>
    3825    <pre xml:space="preserve"># usbipd -D</pre>
    39     <p>
    40         See the documentation for the installed distribution to
    41         determine how to start the service when the system boots.
    42       </p>
    43     <p>
    44         By default, no device on the server is exported. This must be
    45         done manually for each device. To export a device use the
    46         following command:
    47       </p>
     26    <p>See the documentation for the installed distribution to determine how to start the service when the system boots. </p>
     27    <p>By default, no device on the server is exported. This must be done manually for each device. To export a device
     28      use the following command: </p>
    4829    <pre xml:space="preserve"># usbip bind -b "bus identifier"</pre>
    49     <p>
    50         To export the multicard reader in the previous example:
    51       </p>
     30    <p>To export the multicard reader in the previous example: </p>
    5231    <pre xml:space="preserve"># usbip bind -b 4-2</pre>
    5332  </body>

  • trunk/doc/manual/en_US/dita/topics/usbip.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports passing through USB devices which are
    9       exposed over the network using the USB over IP protocol without
    10       the need to configure the client side provided by the kernel and
    11       usbip tools. Furthermore, this feature works with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    12       running on any supported host, rather than just Linux alone, as is
    13       the case with the official client.
    14     </p>
    15     <p>
    16       To enable support for passing through USB/IP devices, use the
    17       following command to add the device server that exports the
    18       devices:
    19     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports passing through USB devices which are exposed over
     8      the network using the USB over IP protocol without the need to configure the client side provided by the kernel
     9      and usbip tools. Furthermore, this feature works with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     10      running on any supported host, rather than just Linux alone, as is the case with the official client. </p>
     11    <p>To enable support for passing through USB/IP devices, use the following command to add the device server that
     12      exports the devices: </p>
    2013    <pre xml:space="preserve">VBoxManage usbdevsource add <varname>unique-name</varname> --backend <varname>USBIP</varname> --address <varname>device-server</varname>[:<varname>port</varname>]</pre>
    21     <p>
    22       USB devices exported on the device server are then accessible
    23       through <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or <userinput>VBoxManage</userinput>, like any USB
    24       devices attached locally. This can be used multiple times to
    25       access different device servers.
    26     </p>
     14    <p>USB devices exported on the device server are then accessible through <ph
     15        conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or <userinput>VBoxManage</userinput>, like any USB devices
     16      attached locally. This can be used multiple times to access different device servers. </p>
    2717    <p>
    2818      To remove a device server, the following command can be used:
    2919    </p>
    30     <pre xml:space="preserve">$ VBoxManage usbdevsource remove <varname>unique-name</varname>
    31                </pre>
     20    <pre xml:space="preserve">$ VBoxManage usbdevsource remove <varname>unique-name</varname>            </pre>
    3221  </body>
    3322</topic>

  • trunk/doc/manual/en_US/dita/topics/usbtrafficcapturing.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       You can capture USB traffic for single USB devices or on the root
    9       hub level, which captures the traffic of all USB devices attached
    10       to the root hub. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> stores the traffic in a format
    11       which is compatible with Wireshark. To capture the traffic of a
    12       specific USB device it must be attached to the VM with
    13       <userinput>VBoxManage</userinput> using the following command:
    14     </p>
     7    <p>You can capture USB traffic for single USB devices or on the root hub level, which captures the traffic of all
     8      USB devices attached to the root hub. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> stores the traffic in
     9      a format which is compatible with Wireshark. To capture the traffic of a specific USB device it must be attached
     10      to the VM with <userinput>VBoxManage</userinput> using the following command: </p>
    1511    <pre xml:space="preserve">VBoxManage controlvm <varname>VM-name</varname> usbattach <varname>device uuid</varname>|<varname>address</varname> --capturefile <varname>filename</varname>
    1612               </pre>
    17     <p>
    18       In order to enable capturing on the root hub use the following
    19       command while the VM is not running:
    20     </p>
     13    <p>In order to enable capturing on the root hub use the following command while the VM is not running: </p>
    2114    <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> \
    2215VBoxInternal/Devices/usb-ehci/0/LUN#0/Config/CaptureFilename <varname>filename</varname>
    2316               </pre>
    24     <p>
    25       The command above enables capturing on the root hub attached to
    26       the EHCI controller. To enable it for the OHCI or XHCI controller
    27       replace <codeph>usb-ehci</codeph> with
    28       <codeph>usb-ohci</codeph> or <codeph>usb-xhci</codeph>,
    29       respectively.
    30     </p>
     17    <p>The command above enables capturing on the root hub attached to the EHCI controller. To enable it for the OHCI or
     18      XHCI controller replace <codeph>usb-ehci</codeph> with <codeph>usb-ohci</codeph> or <codeph>usb-xhci</codeph>,
     19      respectively. </p>
    3120  </body>
    3221 

  • trunk/doc/manual/en_US/dita/topics/vbox-auth.dita

    r105303 r105335  
    55 
    66  <body>
    7     <p> For each virtual machine that is remotely accessible using RDP, you can individually
    8       determine if and how client connections are authenticated. For this, use the
    9         <userinput>VBoxManage modifyvm</userinput> command with the
    10         <codeph>--vrde-auth-type</codeph> option. See <xref href="vboxmanage-modifyvm.dita"
    11         >VBoxManage modifyvm</xref>. The following methods of authentication are available: </p>
     7    <p>For each virtual machine that is remotely accessible using RDP, you can individually determine if and how client
     8      connections are authenticated. For this, use the <userinput>VBoxManage modifyvm</userinput> command with the
     9        <codeph>--vrde-auth-type</codeph> option. See <xref href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref>.
     10      The following methods of authentication are available: </p>
    1211    <ul>
    1312      <li>
    14         <p>
    15             The <b outputclass="bold">null</b> method means that
    16             there is no authentication at all. Any client can connect to
    17             the VRDP server and thus the virtual machine. This is very
    18             insecure and only to be recommended for private networks.
    19           </p>
     13        <p>The <b outputclass="bold">null</b> method means that there is no authentication at all. Any client can
     14          connect to the VRDP server and thus the virtual machine. This is very insecure and only to be recommended for
     15          private networks. </p>
    2016      </li>
    2117      <li>
    22         <p>
    23             The <b outputclass="bold">external</b> method
    24             provides external authentication through a special
    25             authentication library. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> ships with two
    26             special authentication libraries:
    27           </p>
     18        <p>The <b outputclass="bold">external</b> method provides external authentication through a special
     19          authentication library. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> ships with two special
     20          authentication libraries: </p>
    2821        <ol>
    2922          <li>
    30             <p>
    31                 The default authentication library,
    32                 <userinput>VBoxAuth</userinput>, authenticates against user
    33                 credentials of the hosts. Depending on the host
    34                 platform, this means the following:
    35               </p>
     23            <p>The default authentication library, <userinput>VBoxAuth</userinput>, authenticates against user
     24              credentials of the hosts. Depending on the host platform, this means the following: </p>
    3625            <ul>
    3726              <li>
    38                 <p>
    39                     On Linux hosts, <userinput>VBoxAuth.so</userinput>
    40                     authenticates users against the host's PAM system.
    41                   </p>
     27                <p>On Linux hosts, <userinput>VBoxAuth.so</userinput> authenticates users against the host's PAM system. </p>
    4228              </li>
    4329              <li>
    44                 <p>
    45                     On Windows hosts, <userinput>VBoxAuth.dll</userinput>
    46                     authenticates users against the host's WinLogon
    47                     system.
    48                   </p>
     30                <p>On Windows hosts, <userinput>VBoxAuth.dll</userinput> authenticates users against the host's WinLogon
     31                  system. </p>
    4932              </li>
    5033              <li>
    51                 <p>
    52                     On macOS hosts, <userinput>VBoxAuth.dylib</userinput>
    53                     authenticates users against the host's directory
    54                     service.
    55                   </p>
     34                <p>On macOS hosts, <userinput>VBoxAuth.dylib</userinput> authenticates users against the host's
     35                  directory service. </p>
    5636              </li>
    5737            </ul>
    58             <p>
    59                 In other words, the external method by default performs
    60                 authentication with the user accounts that exist on the
    61                 host system. Any user with valid authentication
    62                 credentials is accepted. For example, the username does
    63                 not have to correspond to the user running the VM.
    64               </p>
     38            <p>In other words, the external method by default performs authentication with the user accounts that exist
     39              on the host system. Any user with valid authentication credentials is accepted. For example, the username
     40              does not have to correspond to the user running the VM. </p>
    6541          </li>
    6642          <li>
    67             <p>
    68                 An additional library called
    69                 <userinput>VBoxAuthSimple</userinput> performs
    70                 authentication against credentials configured in the
    71                 <codeph>extradata</codeph> section of a virtual
    72                 machine's XML settings file. This is probably the
    73                 simplest way to get authentication that does not depend
    74                 on a running and supported guest. The following steps
    75                 are required:
    76               </p>
     43            <p>An additional library called <userinput>VBoxAuthSimple</userinput> performs authentication against
     44              credentials configured in the <codeph>extradata</codeph> section of a virtual machine's XML settings file.
     45              This is probably the simplest way to get authentication that does not depend on a running and supported
     46              guest. The following steps are required: </p>
    7747            <ol>
    7848              <li>
    79                 <p>
    80                     Enable <userinput>VBoxAuthSimple</userinput> with the
    81                     following command:
    82                   </p>
     49                <p>Enable <userinput>VBoxAuthSimple</userinput> with the following command: </p>
    8350                <pre xml:space="preserve">VBoxManage setproperty vrdeauthlibrary "VBoxAuthSimple"</pre>
    8451              </li>
    8552              <li>
    86                 <p>
    87                     To enable the library for a particular VM, you must
    88                     switch authentication to external, as follows:
    89                   </p>
     53                <p>To enable the library for a particular VM, you must switch authentication to external, as follows: </p>
    9054                <pre xml:space="preserve">VBoxManage modifyvm <varname>VM-name</varname> --vrde-auth-type external</pre>
    91                 <p>
    92                     Replace <varname>VM-name</varname> with the
    93                     VM name or UUID.
    94                   </p>
     55                <p>Replace <varname>VM-name</varname> with the VM name or UUID. </p>
    9556              </li>
    9657              <li>
    97                 <p>
    98                     You then need to configure users and passwords by
    99                     writing items into the machine's extradata. Since
    100                     the XML machine settings file, into whose
    101                     <codeph>extradata</codeph> section the password
    102                     needs to be written, is a plain text file,
    103                     <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses hashes to encrypt passwords. The
    104                     following command must be used:
    105                   </p>
     58                <p>You then need to configure users and passwords by writing items into the machine's extradata. Since
     59                  the XML machine settings file, into whose <codeph>extradata</codeph> section the password needs to be
     60                  written, is a plain text file, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses hashes to
     61                  encrypt passwords. The following command must be used: </p>
    10662                <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> "VBoxAuthSimple/users/<varname>user</varname>" <varname>hash</varname>
    10763                                    </pre>
    108                 <p>
    109                     Replace <varname>VM-name</varname> with the
    110                     VM name or UUID, <varname>user</varname>
    111                     with the user name who should be allowed to log in
    112                     and <varname>hash</varname> with the
    113                     encrypted password. The following command example
    114                     obtains the hash value for the password
    115                     <codeph>secret</codeph>:
    116                   </p>
     64                <p>Replace <varname>VM-name</varname> with the VM name or UUID, <varname>user</varname> with the user
     65                  name who should be allowed to log in and <varname>hash</varname> with the encrypted password. The
     66                  following command example obtains the hash value for the password <codeph>secret</codeph>: </p>
    11767                <pre xml:space="preserve">$ VBoxManage internalcommands passwordhash "secret"
    118682bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b</pre>
    119                 <p>
    120                     You then use <userinput>VBoxManage
    121                     setextradata</userinput> to store this value in the
    122                     machine's <codeph>extradata</codeph> section.
    123                   </p>
    124                 <p>
    125                     As a combined example, to set the password for the
    126                     user <codeph>john</codeph> and the machine
    127                     <codeph>My VM</codeph> to
    128                     <codeph>secret</codeph>, use this command:
    129                   </p>
     69                <p>You then use <userinput>VBoxManage setextradata</userinput> to store this value in the machine's
     70                    <codeph>extradata</codeph> section. </p>
     71                <p>As a combined example, to set the password for the user <codeph>john</codeph> and the machine
     72                    <codeph>My VM</codeph> to <codeph>secret</codeph>, use this command: </p>
    13073                <pre xml:space="preserve">VBoxManage setextradata "My VM" "VBoxAuthSimple/users/john"
    13174    2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b</pre>
    … …  
    13679      </li>
    13780      <li>
    138         <p>
    139             The <b outputclass="bold">guest</b> authentication
    140             method performs authentication with a special component that
    141             comes with the Guest Additions. As a result, authentication
    142             is not performed on the host, but with the guest user
    143             accounts.
    144           </p>
    145         <p>
    146             This method is currently still in testing and not yet
    147             supported.
    148           </p>
     81        <p>The <b outputclass="bold">guest</b> authentication method performs authentication with a special component
     82          that comes with the Guest Additions. As a result, authentication is not performed on the host, but with the
     83          guest user accounts. </p>
     84        <p>This method is currently still in testing and not yet supported. </p>
    14985      </li>
    15086    </ul>
    151     <p>
    152         In addition to the methods described above, you can replace the
    153         default external authentication module with any other module.
    154         For this, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a well-defined interface that
    155         enables you to write your own authentication module. This is
    156         described in detail in the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Software Development
    157         Kit (SDK) reference. See <xref href="VirtualBoxAPI.dita#VirtualBoxAPI"/>.
    158       </p>
     87    <p>In addition to the methods described above, you can replace the default external authentication module with any
     88      other module. For this, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a well-defined interface
     89      that enables you to write your own authentication module. This is described in detail in the <ph
     90        conkeyref="vbox-conkeyref-phrases/product-name"/> Software Development Kit (SDK) reference. See <xref
     91        href="VirtualBoxAPI.dita#VirtualBoxAPI"/>. </p>
    15992  </body>
    16093 

  • trunk/doc/manual/en_US/dita/topics/vboxandsolzvmm.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       Oracle Solaris kernel zones on x86-based systems make use of
    9       hardware-assisted virtualization features like <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    10       does. However, for kernel zones and <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to share this
    11       hardware resource, they need to cooperate.
    12     </p>
    13     <p>
    14       By default, due to performance reasons, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> acquires
    15       the hardware-assisted virtualization resource (VT-x/AMD-V)
    16       globally on the host machine and uses it until the last
    17       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM that requires it is powered off. This prevents
    18       other software from using VT-x/AMD-V during the time
    19       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has taken control of it.
    20     </p>
    21     <p>
    22       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can be instructed to relinquish use of
    23       hardware-assisted virtualization features when not executing guest
    24       code, thereby allowing kernel zones to make use of them. To do
    25       this, shutdown all <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VMs and execute the following
    26       command:
    27     </p>
     7    <p>Oracle Solaris kernel zones on x86-based systems make use of hardware-assisted virtualization features like <ph
     8        conkeyref="vbox-conkeyref-phrases/product-name"/> does. However, for kernel zones and <ph
     9        conkeyref="vbox-conkeyref-phrases/product-name"/> to share this hardware resource, they need to cooperate. </p>
     10    <p>By default, due to performance reasons, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> acquires the
     11      hardware-assisted virtualization resource (VT-x/AMD-V) globally on the host machine and uses it until the last <ph
     12        conkeyref="vbox-conkeyref-phrases/product-name"/> VM that requires it is powered off. This prevents other
     13      software from using VT-x/AMD-V during the time <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has taken
     14      control of it. </p>
     15    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can be instructed to relinquish use of hardware-assisted
     16      virtualization features when not executing guest code, thereby allowing kernel zones to make use of them. To do
     17      this, shutdown all <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VMs and execute the following command: </p>
    2818    <pre xml:space="preserve">$ VBoxManage setproperty hwvirtexclusive off</pre>
    29     <p>
    30       This command needs to be executed only once as the setting is
    31       stored as part of the global <ph conkeyref="vbox-conkeyref-phrases/product-name"/> settings which will
    32       continue to persist across host-reboots and <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    33       upgrades.
    34     </p>
     19    <p>This command needs to be executed only once as the setting is stored as part of the global <ph
     20        conkeyref="vbox-conkeyref-phrases/product-name"/> settings which will continue to persist across host-reboots
     21      and <ph conkeyref="vbox-conkeyref-phrases/product-name"/> upgrades. </p>
    3522  </body>
    3623 

  • trunk/doc/manual/en_US/dita/topics/vboxbowsolaris11.dita

    r105134 r105335  
    66 
    77  <body>
    8     <p>
    9       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> includes a network filter driver that utilizes
    10       Oracle Solaris 11's Crossbow functionality. By default, this new
    11       driver is installed for Oracle Solaris 11 hosts that have support
    12       for it.
    13     </p>
    14     <p>
    15       To force installation of the older STREAMS based network filter
    16       driver, execute as root the following command before installing
    17       the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package:
    18     </p>
     8    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> includes a network filter driver that utilizes Oracle
     9      Solaris 11's Crossbow functionality. By default, this new driver is installed for Oracle Solaris 11 hosts that
     10      have support for it. </p>
     11    <p>To force installation of the older STREAMS based network filter driver, execute as root the following command
     12      before installing the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package: </p>
    1913    <pre xml:space="preserve">$ touch /etc/vboxinst_vboxflt</pre>
    20     <p>
    21       To force installation of the Crossbow based network filter driver,
    22       execute as root the following command before installing the
    23       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package:
    24     </p>
     14    <p>To force installation of the Crossbow based network filter driver, execute as root the following command before
     15      installing the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package: </p>
    2516    <pre xml:space="preserve">$ touch /etc/vboxinst_vboxbow</pre>
    26     <p>
    27       To check which driver is currently being used by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>,
    28       execute:
    29     </p>
     17    <p>To check which driver is currently being used by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, execute: </p>
    3018    <pre xml:space="preserve">$ modinfo | grep vbox</pre>
    31     <p> If the output contains <i>vboxbow</i>, it indicates <ph
    32         conkeyref="vbox-conkeyref-phrases/product-name"/> is using the Crossbow network filter
    33       driver, while the name <i>vboxflt</i> indicates usage of the older STREAMS network filter. </p>
     19    <p>If the output contains <i>vboxbow</i>, it indicates <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is
     20      using the Crossbow network filter driver, while the name <i>vboxflt</i> indicates usage of the older STREAMS
     21      network filter. </p>
    3422  </body>
    3523 

  • trunk/doc/manual/en_US/dita/topics/vboxbowvnictemplates.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports Virtual Network Interface (VNIC) templates
    9       for configuring VMs over VLANs. An <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VNIC template is
    10       a VNIC whose name starts with
    11       <filepath>vboxvnic_template</filepath>. The string is
    12       case-sensitive.
    13     </p>
    14     <p>
    15       On Oracle Solaris 11 hosts, when Crossbow-based bridged networking
    16       is used, a VNIC template may be used to specify the VLAN ID to use
    17       while bridging over a network link.
    18     </p>
    19     <p>
    20       The following is an example of how to use a VNIC template to
    21       configure a VM over a VLAN. Create an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VNIC
    22       template, by executing as root:
    23     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports Virtual Network Interface (VNIC) templates for
     8      configuring VMs over VLANs. An <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VNIC template is a VNIC whose
     9      name starts with <filepath>vboxvnic_template</filepath>. The string is case-sensitive. </p>
     10    <p>On Oracle Solaris 11 hosts, when Crossbow-based bridged networking is used, a VNIC template may be used to
     11      specify the VLAN ID to use while bridging over a network link. </p>
     12    <p>The following is an example of how to use a VNIC template to configure a VM over a VLAN. Create an <ph
     13        conkeyref="vbox-conkeyref-phrases/product-name"/> VNIC template, by executing as root: </p>
    2414    <pre xml:space="preserve"># dladm create-vnic -t -l nge0 -v 23 vboxvnic_template0</pre>
    25     <p>
    26       This will create a temporary VNIC template over interface
    27       <userinput>nge0</userinput> with the VLAN ID 23. To create VNIC
    28       templates that are persistent across host reboots, skip the
    29       <codeph>-t</codeph> parameter in the above command. You may check
    30       the current state of links using the following command:
    31     </p>
     15    <p>This will create a temporary VNIC template over interface <userinput>nge0</userinput> with the VLAN ID 23. To
     16      create VNIC templates that are persistent across host reboots, skip the <codeph>-t</codeph> parameter in the above
     17      command. You may check the current state of links using the following command: </p>
    3218    <pre xml:space="preserve">$ dladm show-link
    3319LINK        CLASS     MTU    STATE    BRIDGE     OVER
    … …  
    3925LINK         OVER         SPEED  MACADDRESS        MACADDRTYPE         VID
    4026vboxvnic_template0 nge0   1000   2:8:20:25:12:75   random              23</pre>
    41     <p>
    42       Once the VNIC template is created, any VMs that need to be on VLAN
    43       23 over the interface <userinput>nge0</userinput> can be configured to
    44       bridge using this VNIC template.
    45     </p>
    46     <p>
    47       VNIC templates makes managing VMs on VLANs simpler and efficient.
    48       The VLAN details are not stored as part of every VM's
    49       configuration but rather inherited from the VNIC template while
    50       starting the VM. The VNIC template itself can be modified anytime
    51       using the <userinput>dladm</userinput> command.
    52     </p>
    53     <p>
    54       VNIC templates can be created with additional properties such as
    55       bandwidth limits and CPU fanout. Refer to your Oracle Solaris
    56       network documentation for details. The additional properties are
    57       also applied to VMs which bridge using the VNIC template.
    58     </p>
     27    <p>Once the VNIC template is created, any VMs that need to be on VLAN 23 over the interface
     28        <userinput>nge0</userinput> can be configured to bridge using this VNIC template. </p>
     29    <p>VNIC templates makes managing VMs on VLANs simpler and efficient. The VLAN details are not stored as part of
     30      every VM's configuration but rather inherited from the VNIC template while starting the VM. The VNIC template
     31      itself can be modified anytime using the <userinput>dladm</userinput> command. </p>
     32    <p>VNIC templates can be created with additional properties such as bandwidth limits and CPU fanout. Refer to your
     33      Oracle Solaris network documentation for details. The additional properties are also applied to VMs which bridge
     34      using the VNIC template. </p>
    5935  </body>
    6036 

  • trunk/doc/manual/en_US/dita/topics/vboxexpertstoragemgmt.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       In case the snapshot model of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is not sufficient it
    9       is possible to enable a special mode which makes it possible to
    10       reconfigure storage attachments while the VM is paused. The user
    11       has to make sure that the disk data stays consistent to the guest
    12       because unlike with hotplugging the guest is not informed about
    13       detached or newly attached media.
    14     </p>
    15     <p>
    16       The expert storage management mode can be enabled per VM
    17       executing:
    18     </p>
     7    <p>In case the snapshot model of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is not sufficient it is
     8      possible to enable a special mode which makes it possible to reconfigure storage attachments while the VM is
     9      paused. The user has to make sure that the disk data stays consistent to the guest because unlike with hotplugging
     10      the guest is not informed about detached or newly attached media. </p>
     11    <p>The expert storage management mode can be enabled per VM executing: </p>
    1912    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> "VBoxInternal2/SilentReconfigureWhilePaused" 1</pre>
    20     <p>
    21       You can reconfigure storage attachments later while the VM is
    22       paused by using the <userinput>VBoxManage storageattach</userinput>
    23       command.
    24     </p>
     13    <p>You can reconfigure storage attachments later while the VM is paused by using the <userinput>VBoxManage
     14        storageattach</userinput> command. </p>
    2515  </body>
    2616 

  • trunk/doc/manual/en_US/dita/topics/vboxheadless.dita

    r105294 r105335  
    55 
    66  <body>
    7     <p>
    8         While any VM started from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> is capable of running
    9         virtual machines remotely, it is not convenient to have to run
    10         the full GUI if you never want to have VMs displayed locally in
    11         the first place. In particular, if you are running server
    12         hardware whose only purpose is to host VMs, and all your VMs are
    13         supposed to run remotely over VRDP, then it is pointless to have
    14         a graphical user interface on the server at all. This is
    15         especially true for Linux or Oracle Solaris hosts, as the
    16         <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> comes with dependencies on the Qt and SDL libraries.
    17         This is inconvenient if you would rather not have the X Window
    18         system on your server at all.
    19       </p>
    20     <p>
    21         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> therefore comes with a front end called
    22         <userinput>VBoxHeadless</userinput>, which produces no visible
    23         output on the host at all, but still can optionally deliver VRDP
    24         data. This front end has no dependencies on the X Window system
    25         on Linux and Oracle Solaris hosts.
    26       </p>
     7    <p>While any VM started from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> is capable of running virtual
     8      machines remotely, it is not convenient to have to run the full GUI if you never want to have VMs displayed
     9      locally in the first place. In particular, if you are running server hardware whose only purpose is to host VMs,
     10      and all your VMs are supposed to run remotely over VRDP, then it is pointless to have a graphical user interface
     11      on the server at all. This is especially true for Linux or Oracle Solaris hosts, as the <ph
     12        conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> comes with dependencies on the Qt and SDL libraries. This is
     13      inconvenient if you would rather not have the X Window system on your server at all. </p>
     14    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> therefore comes with a front end called
     15        <userinput>VBoxHeadless</userinput>, which produces no visible output on the host at all, but still can
     16      optionally deliver VRDP data. This front end has no dependencies on the X Window system on Linux and Oracle
     17      Solaris hosts. </p>
    2718    <note>
    28       <p> In legacy releases of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, the headless
    29         server was called <userinput>VBoxVRDP</userinput>. For backward compatibility, the <ph
    30           conkeyref="vbox-conkeyref-phrases/product-name"/> installation still includes an
    31         executable with that name. </p>
     19      <p>In legacy releases of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, the headless server was called
     20          <userinput>VBoxVRDP</userinput>. For backward compatibility, the <ph
     21          conkeyref="vbox-conkeyref-phrases/product-name"/> installation still includes an executable with that name. </p>
    3222    </note>
    33     <p>
    34         To start a virtual machine with <userinput>VBoxHeadless</userinput>,
    35         you have the following options:
    36       </p>
     23    <p>To start a virtual machine with <userinput>VBoxHeadless</userinput>, you have the following options: </p>
    3724    <ul>
    3825      <li>
    39         <p>
    40             Use the <userinput>VBoxManage</userinput> command, as follows:
    41           </p>
     26        <p>Use the <userinput>VBoxManage</userinput> command, as follows: </p>
    4227        <pre xml:space="preserve">$ VBoxManage startvm <varname>VM-name</varname> --type headless</pre>
    43         <p>
    44             The <codeph>--type</codeph> option causes <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to
    45             use <userinput>VBoxHeadless</userinput> as the front end to the
    46             internal virtualization engine, instead of the Qt front end.
    47           </p>
     28        <p>The <codeph>--type</codeph> option causes <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to use
     29            <userinput>VBoxHeadless</userinput> as the front end to the internal virtualization engine, instead of the
     30          Qt front end. </p>
    4831      </li>
    4932      <li>
    50         <p>
    51             Use the <userinput>VBoxHeadless</userinput> command, as follows:
    52           </p>
     33        <p>Use the <userinput>VBoxHeadless</userinput> command, as follows: </p>
    5334        <pre xml:space="preserve">VBoxHeadless --startvm <varname>uuid</varname>|<varname>vmname</varname>
    5435                        </pre>
    55         <p>
    56             This way of starting the VM helps troubleshooting problems
    57             reported by <userinput>VBoxManage startvm</userinput>, because
    58             you can sometimes see more detailed error messages,
    59             especially for early failures before the VM execution is
    60             started. In normal situations <userinput>VBoxManage
    61             startvm</userinput> is preferred, since it runs the VM
    62             directly as a background process which has to be done
    63             explicitly when directly starting with
    64             <userinput>VBoxHeadless</userinput>.
    65           </p>
     36        <p>This way of starting the VM helps troubleshooting problems reported by <userinput>VBoxManage
     37            startvm</userinput>, because you can sometimes see more detailed error messages, especially for early
     38          failures before the VM execution is started. In normal situations <userinput>VBoxManage startvm</userinput> is
     39          preferred, since it runs the VM directly as a background process which has to be done explicitly when directly
     40          starting with <userinput>VBoxHeadless</userinput>. </p>
    6641      </li>
    6742      <li>
    68         <p>
    69             Start <userinput>VBoxHeadless</userinput> from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, by
    70             pressing the Shift key when starting a virtual machine or by
    71             selecting <b outputclass="bold">Headless Start</b>
    72             from the <b outputclass="bold">Machine</b> menu.
    73           </p>
     43        <p>Start <userinput>VBoxHeadless</userinput> from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, by pressing
     44          the Shift key when starting a virtual machine or by selecting <b outputclass="bold">Headless Start</b> from
     45          the <b outputclass="bold">Machine</b> menu. </p>
    7446      </li>
    7547    </ul>
    76     <p>
    77         When you use the <userinput>VBoxHeadless</userinput> command to
    78         start a VM, the VRDP server will be enabled according to the VM
    79         configuration. You can override the VM's setting using
    80         <codeph>--vrde</codeph> command line parameter. To enable the
    81         VRDP server, start the VM as follows:
    82       </p>
     48    <p>When you use the <userinput>VBoxHeadless</userinput> command to start a VM, the VRDP server will be enabled
     49      according to the VM configuration. You can override the VM's setting using <codeph>--vrde</codeph> command line
     50      parameter. To enable the VRDP server, start the VM as follows: </p>
    8351    <pre xml:space="preserve">VBoxHeadless --startvm <varname>uuid</varname>|<varname>vmname</varname> --vrde on</pre>
    84     <p>
    85         To disable the VRDP server:
    86       </p>
     52    <p>To disable the VRDP server: </p>
    8753    <pre xml:space="preserve">VBoxHeadless --startvm <varname>uuid</varname>|<varname>vmname</varname> --vrde off</pre>
    88     <p>
    89         To have the VRDP server enabled depending on the VM
    90         configuration, as for other front ends:
    91       </p>
     54    <p>To have the VRDP server enabled depending on the VM configuration, as for other front ends: </p>
    9255    <pre xml:space="preserve">VBoxHeadless --startvm <varname>uuid</varname>|<varname>vmname</varname> --vrde config</pre>
    93     <p>
    94         This command is the same as the following:
    95       </p>
     56    <p>This command is the same as the following: </p>
    9657    <pre xml:space="preserve">VBoxHeadless --startvm <varname>uuid</varname>|<varname>vmname</varname>
    9758                  </pre>
    98     <p>
    99         If you start the VM with <userinput>VBoxManage startvm</userinput>
    100         then the configuration settings of the VM are always used.
    101       </p>
     59    <p>If you start the VM with <userinput>VBoxManage startvm</userinput> then the configuration settings of the VM are
     60      always used. </p>
    10261  </body>
    10362 

  • trunk/doc/manual/en_US/dita/topics/vboxsvc-session-0-known-issues.dita

    r99797 r105335  
    77    <ul>
    88      <li>
    9         <p>
    10             Due to different Windows sessions having their own set of
    11             resources, there might be some issues with accessing network
    12             shares created in the interactive user session when at least
    13             one of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> processes are running in session
    14             0.
    15           </p>
    16         <p>
    17             For accessing network shares within session 0, a possible
    18             workaround is to establish permanent access to the share and
    19             then restart the host.
    20           </p>
     9        <p>Due to different Windows sessions having their own set of resources, there might be some issues with
     10          accessing network shares created in the interactive user session when at least one of the <ph
     11            conkeyref="vbox-conkeyref-phrases/product-name"/> processes are running in session 0. </p>
     12        <p>For accessing network shares within session 0, a possible workaround is to establish permanent access to the
     13          share and then restart the host. </p>
    2114      </li>
    2215    </ul>

  • trunk/doc/manual/en_US/dita/topics/vboxsvc-session-0.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports executing the VBoxSVC in Windows session
    9       0. This allows VBoxSVC to run like a regular Windows service,
    10       which in turn enables headless VMs to continue running even if the
    11       user logs out.
    12 
    13       <note><p>
    14           This is currently an experimental feature.
    15         </p></note>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports executing the VBoxSVC in Windows session 0. This
     8      allows VBoxSVC to run like a regular Windows service, which in turn enables headless VMs to continue running even
     9      if the user logs out. <note>
     10        <p>This is currently an experimental feature. </p>
     11      </note>
    1612               </p>
    17     <p>
    18       The feature is disabled by default and can be enabled by creating
    19       a REG_DWORD value <codeph>ServerSession0</codeph> in the key
    20       <codeph>HKEY_LOCAL_MACHINE\Software\Oracle\VirtualBox\VBoxSDS</codeph>
    21       of the Windows registry. Specify <codeph>1</codeph> as the
    22       value's data to enable the feature, or <codeph>0</codeph> to
    23       disable the feature. A host reboot is needed in order to make the
    24       change effective.
    25     </p>
     13    <p>The feature is disabled by default and can be enabled by creating a REG_DWORD value
     14        <codeph>ServerSession0</codeph> in the key
     15        <codeph>HKEY_LOCAL_MACHINE\Software\Oracle\VirtualBox\VBoxSDS</codeph> of the Windows registry. Specify
     16        <codeph>1</codeph> as the value's data to enable the feature, or <codeph>0</codeph> to disable the feature. A
     17      host reboot is needed in order to make the change effective. </p>
    2618  </body>
    2719</topic>

  • trunk/doc/manual/en_US/dita/topics/vboxwatchdog-ballonctrl.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p> The memory ballooning control inflates and deflates the memory balloon of VMs based on the
    8       VMs free memory and the requested maximum balloon size. </p>
    9     <p>
    10         To set up the memory ballooning control the maximum ballooning
    11         size a VM can reach needs to be set. This can be specified using
    12         the command line, as follows:
    13       </p>
     7    <p>The memory ballooning control inflates and deflates the memory balloon of VMs based on the VMs free memory and
     8      the requested maximum balloon size. </p>
     9    <p>To set up the memory ballooning control the maximum ballooning size a VM can reach needs to be set. This can be
     10      specified using the command line, as follows: </p>
    1411    <pre xml:space="preserve">--balloon-max &lt;Size in MB&gt;</pre>
    15     <p>
    16         Using a per-VM basis extradata value, as follows:
    17       </p>
     12    <p>Using a per-VM basis extradata value, as follows: </p>
    1813    <pre xml:space="preserve">VBoxManage setextradata &lt;VM-Name&gt; VBoxInternal2/Watchdog/BalloonCtrl/BalloonSizeMax &lt;Size in MB&gt;</pre>
    19     <p>
    20         Using a global extradata value, as follows:
    21       </p>
     14    <p>Using a global extradata value, as follows: </p>
    2215    <pre xml:space="preserve">VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonSizeMax &lt;Size in MB&gt;</pre>
    2316    <note>
    24       <p>
    25           If no maximum ballooning size is specified by at least one of
    26           the parameters above, no ballooning will be performed at all.
    27         </p>
     17      <p>If no maximum ballooning size is specified by at least one of the parameters above, no ballooning will be
     18        performed at all. </p>
    2819    </note>
    29     <p>
    30         Setting the ballooning increment in MB can be either done using
    31         command line, as follows:
    32       </p>
     20    <p>Setting the ballooning increment in MB can be either done using command line, as follows: </p>
    3321    <pre xml:space="preserve">--balloon-inc &lt;Size in MB&gt;</pre>
    34     <p>
    35         Using a global extradata value, as follows:
    36       </p>
     22    <p>Using a global extradata value, as follows: </p>
    3723    <pre xml:space="preserve">VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonIncrementMB &lt;Size in MB&gt;</pre>
    38     <p>
    39         The default ballooning increment is 256 MB if not specified.
    40       </p>
    41     <p>
    42         The same options apply for a ballooning decrement. Using the
    43         command line, as follows:
    44       </p>
     24    <p>The default ballooning increment is 256 MB if not specified. </p>
     25    <p>The same options apply for a ballooning decrement. Using the command line, as follows: </p>
    4526    <pre xml:space="preserve">--balloon-dec &lt;Size in MB&gt;</pre>
    46     <p>
    47         Using a global extradata value, as follows:
    48       </p>
     27    <p>Using a global extradata value, as follows: </p>
    4928    <pre xml:space="preserve">VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonDecrementMB &lt;Size in MB&gt;</pre>
    50     <p>
    51         The default ballooning decrement is 128 MB if not specified.
    52       </p>
    53     <p>
    54         The lower limit in MB for a balloon can be defined using the
    55         command line, as follows:
    56       </p>
     29    <p>The default ballooning decrement is 128 MB if not specified. </p>
     30    <p>The lower limit in MB for a balloon can be defined using the command line, as follows: </p>
    5731    <pre xml:space="preserve">--balloon-lower-limit &lt;Size in MB&gt;</pre>
    58     <p>
    59         Using a global extradata value, as follows:
    60       </p>
     32    <p>Using a global extradata value, as follows: </p>
    6133    <pre xml:space="preserve">VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonLowerLimitMB &lt;Size in MB&gt;</pre>
    62     <p>
    63         The default lower limit is 128 MB if not specified.
    64       </p>
     34    <p>The default lower limit is 128 MB if not specified. </p>
    6535  </body>
    6636 

  • trunk/doc/manual/en_US/dita/topics/vboxwatchdog-hostisln.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8         To detect whether a host is being isolated, that is, the host
    9         cannot reach the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> server instance anymore, the
    10         host needs to set an alternating value to a global extradata
    11         value within a time period. If this value is not set within that
    12         time period a timeout occurred and the so-called host isolation
    13         response will be performed to the VMs handled. Which VMs are
    14         handled can be controlled by defining VM groups and assigning
    15         VMs to those groups. By default no groups are set, meaning that
    16         all VMs on the server will be handled when no host response is
    17         received within 30 seconds.
    18       </p>
    19     <p>
    20         Set the groups handled by the host isolation detection using the
    21         following command line:
    22       </p>
     7    <p>To detect whether a host is being isolated, that is, the host cannot reach the <ph
     8        conkeyref="vbox-conkeyref-phrases/product-name"/> server instance anymore, the host needs to set an alternating
     9      value to a global extradata value within a time period. If this value is not set within that time period a timeout
     10      occurred and the so-called host isolation response will be performed to the VMs handled. Which VMs are handled can
     11      be controlled by defining VM groups and assigning VMs to those groups. By default no groups are set, meaning that
     12      all VMs on the server will be handled when no host response is received within 30 seconds. </p>
     13    <p>Set the groups handled by the host isolation detection using the following command line: </p>
    2314    <pre xml:space="preserve">--apimon-groups=&lt;string[,stringN]&gt;</pre>
    24     <p>
    25         Using a global extradata value, as follows:
    26       </p>
     15    <p>Using a global extradata value, as follows: </p>
    2716    <pre xml:space="preserve">VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/Groups &lt;string[,stringN]&gt;</pre>
    28     <p>
    29         Set the host isolation timeout using the following command line:
    30       </p>
     17    <p>Set the host isolation timeout using the following command line: </p>
    3118    <pre xml:space="preserve">--apimon-isln-timeout=&lt;ms&gt;</pre>
    32     <p>
    33         Using a global extradata value, as follows:
    34       </p>
     19    <p>Using a global extradata value, as follows: </p>
    3520    <pre xml:space="preserve">VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/IsolationTimeoutMS &lt;ms&gt;</pre>
    36     <p>
    37         Set the actual host isolation response using the following
    38         command line:
    39       </p>
     21    <p>Set the actual host isolation response using the following command line: </p>
    4022    <pre xml:space="preserve">--apimon-isln-response=&lt;cmd&gt;</pre>
    41     <p>
    42         Using a global extradata value, as follows:
    43       </p>
     23    <p>Using a global extradata value, as follows: </p>
    4424    <pre xml:space="preserve">VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/IsolationResponse &lt;cmd&gt;</pre>
    45     <p>
    46         The following response commands are available:
    47       </p>
     25    <p>The following response commands are available: </p>
    4826    <ul>
    4927      <li>

  • trunk/doc/manual/en_US/dita/topics/vboxwatchdog-linux.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         On Linux, the watchdog service can be automatically started
    9         during host boot by adding appropriate parameters to the file
    10         <filepath>/etc/default/virtualbox</filepath>. There is one
    11         mandatory parameter, <codeph>VBOXWATCHDOG_USER</codeph>, which
    12         must be set to the user which will later start the VMs. For
    13         backward compatibility you can also specify
    14         <codeph>VBOXBALLOONCTRL_USER</codeph>.
    15       </p>
    16     <p>
    17         The parameters in the following table all start with the
    18         <codeph>VBOXWATCHDOG_</codeph> prefix string. For example:
    19         <codeph>VBOXWATCHDOG_BALLOON_INTERVAL</codeph> and
    20         <codeph>VBOXWATCHDOG_LOGSIZE</codeph>. Legacy parameters such
    21         as <codeph>VBOXBALLOONCTRL_INTERVAL</codeph> can still be
    22         used.
    23       </p>
     7    <p>On Linux, the watchdog service can be automatically started during host boot by adding appropriate parameters to
     8      the file <filepath>/etc/default/virtualbox</filepath>. There is one mandatory parameter,
     9        <codeph>VBOXWATCHDOG_USER</codeph>, which must be set to the user which will later start the VMs. For backward
     10      compatibility you can also specify <codeph>VBOXBALLOONCTRL_USER</codeph>. </p>
     11    <p>The parameters in the following table all start with the <codeph>VBOXWATCHDOG_</codeph> prefix string. For
     12      example: <codeph>VBOXWATCHDOG_BALLOON_INTERVAL</codeph> and <codeph>VBOXWATCHDOG_LOGSIZE</codeph>. Legacy
     13      parameters such as <codeph>VBOXBALLOONCTRL_INTERVAL</codeph> can still be used. </p>
    2414    <table id="table-vboxwatchdog-config-params">
    2515      <title><ph conkeyref="vbox-conkeyref-phrases/product-name"/> Watchdog Configuration Parameters</title>

  • trunk/doc/manual/en_US/dita/topics/vboxwatchdog-moreinfo.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         For more advanced options and parameters like verbose logging
    9         check the built-in command line help accessible with
    10         <codeph>--help</codeph>.
    11       </p>
     7    <p>For more advanced options and parameters like verbose logging check the built-in command line help accessible
     8      with <codeph>--help</codeph>. </p>
    129  </body>
    1310 

  • trunk/doc/manual/en_US/dita/topics/vboxwatchdog-solaris.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         On Oracle Solaris hosts, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> watchdog service
    9         daemon is integrated into the SMF framework. You can change the
    10         parameters, but do not have to if the defaults already match
    11         your needs:
    12       </p>
     7    <p>On Oracle Solaris hosts, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> watchdog service daemon is
     8      integrated into the SMF framework. You can change the parameters, but do not have to if the defaults already match
     9      your needs: </p>
    1310    <pre xml:space="preserve">svccfg -s svc:/application/virtualbox/balloonctrl:default setprop \
    1411  config/balloon_interval=10000
    … …  
    2421      </p>
    2522    <pre xml:space="preserve">svcadm refresh svc:/application/virtualbox/balloonctrl:default</pre>
    26     <p>
    27         If you forget the above command then the previous settings will
    28         be used when enabling the service. Check the current property
    29         settings with the following command:
    30       </p>
     23    <p>If you forget the above command then the previous settings will be used when enabling the service. Check the
     24      current property settings with the following command: </p>
    3125    <pre xml:space="preserve">svcprop -p config svc:/application/virtualbox/balloonctrl:default</pre>
    32     <p>
    33         When everything is configured correctly you can start the
    34         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> watchdog service with the following command:
    35       </p>
     26    <p>When everything is configured correctly you can start the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     27      watchdog service with the following command: </p>
    3628    <pre xml:space="preserve">svcadm enable svc:/application/virtualbox/balloonctrl:default</pre>
    37     <p>
    38         For more information about SMF, please refer to the Oracle
    39         Solaris documentation.
    40       </p>
     29    <p>For more information about SMF, please refer to the Oracle Solaris documentation. </p>
    4130  </body>
    4231 

  • trunk/doc/manual/en_US/dita/topics/vboxwatchdog.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       The memory ballooning service, formerly known as
    9       <userinput>VBoxBalloonCtrl</userinput>, was renamed to VBoxWatchdog.
    10       This service now incorporates the following host services that are
    11       meant to be run in a server environment:
    12     </p>
     7    <p>The memory ballooning service, formerly known as <userinput>VBoxBalloonCtrl</userinput>, was renamed to
     8      VBoxWatchdog. This service now incorporates the following host services that are meant to be run in a server
     9      environment: </p>
    1310    <ul>
    1411      <li>
    … …  
    1916          dynamically require more or less memory during runtime.
    2017        </p>
    21         <p>
    22           The service periodically checks a VM's current memory balloon
    23           and its free guest RAM and automatically adjusts the current
    24           memory balloon by inflating or deflating it accordingly. This
    25           handling only applies to running VMs having recent Guest
    26           Additions installed.
    27         </p>
     18        <p>The service periodically checks a VM's current memory balloon and its free guest RAM and automatically
     19          adjusts the current memory balloon by inflating or deflating it accordingly. This handling only applies to
     20          running VMs having recent Guest Additions installed. </p>
    2821      </li>
    2922      <li>
    … …  
    3629      </li>
    3730    </ul>
    38     <p>
    39       All configuration values can be either specified using the command
    40       line or global extradata, whereas command line values always have
    41       a higher priority when set. Some of the configuration values also
    42       be specified on a per-VM basis. So the overall lookup order is:
    43       command line, per-VM basis extradata if available, global
    44       extradata.
    45     </p>
     31    <p>All configuration values can be either specified using the command line or global extradata, whereas command line
     32      values always have a higher priority when set. Some of the configuration values also be specified on a per-VM
     33      basis. So the overall lookup order is: command line, per-VM basis extradata if available, global extradata. </p>
    4634  </body>
    4735</topic>

  • trunk/doc/manual/en_US/dita/topics/vboxwebsrv-daemon.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8       The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> web service, <userinput>vboxwebsrv</userinput>, is
    9       used for controlling <ph conkeyref="vbox-conkeyref-phrases/product-name"/> remotely. It is documented in
    10       detail in the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Software Development Kit (SDK). See
    11       <xref href="VirtualBoxAPI.dita#VirtualBoxAPI"/>. Web service start scripts are
    12       available for supported host operating systems. The following
    13       sections describe how to use the scripts. The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> web
    14       service is never started automatically as a result of a standard
    15       installation.
    16     </p>
     7    <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> web service, <userinput>vboxwebsrv</userinput>, is used
     8      for controlling <ph conkeyref="vbox-conkeyref-phrases/product-name"/> remotely. It is documented in detail in the
     9        <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Software Development Kit (SDK). See <xref
     10        href="VirtualBoxAPI.dita#VirtualBoxAPI"/>. Web service start scripts are available for supported host operating
     11      systems. The following sections describe how to use the scripts. The <ph
     12        conkeyref="vbox-conkeyref-phrases/product-name"/> web service is never started automatically as a result of a
     13      standard installation. </p>
    1714  </body>
    1815</topic>

  • trunk/doc/manual/en_US/dita/topics/vboxwebsrv-linux.dita

    r99182 r105335  
    55 
    66  <body>
    7     <p>
    8         On Linux, the web service can be automatically started during
    9         host boot by adding appropriate parameters to the file
    10         <filepath>/etc/default/virtualbox</filepath>. There is one
    11         mandatory parameter, <codeph>VBOXWEB_USER</codeph>, which must
    12         be set to the user which will later start the VMs. The
    13         parameters in the following table all start with the
    14         <codeph>VBOXWEB_</codeph> prefix string. For example:
    15         <codeph>VBOXWEB_HOST</codeph> and
    16         <codeph>VBOXWEB_PORT</codeph>.
    17       </p>
     7    <p>On Linux, the web service can be automatically started during host boot by adding appropriate parameters to the
     8      file <filepath>/etc/default/virtualbox</filepath>. There is one mandatory parameter,
     9      <codeph>VBOXWEB_USER</codeph>, which must be set to the user which will later start the VMs. The parameters in the
     10      following table all start with the <codeph>VBOXWEB_</codeph> prefix string. For example:
     11        <codeph>VBOXWEB_HOST</codeph> and <codeph>VBOXWEB_PORT</codeph>. </p>
    1812    <table id="table-websrv-config-params">
    1913      <title>Web Service Configuration Parameters</title>
    … …  
    303297      </tgroup>
    304298    </table>
    305     <p>
    306         Setting the parameter <codeph>SSL_KEYFILE</codeph> enables the
    307         SSL/TLS support. Using encryption is strongly encouraged, as
    308         otherwise everything, including passwords, is transferred in
    309         clear text.
    310       </p>
     299    <p>Setting the parameter <codeph>SSL_KEYFILE</codeph> enables the SSL/TLS support. Using encryption is strongly
     300      encouraged, as otherwise everything, including passwords, is transferred in clear text. </p>
    311301  </body>
    312302 

  • trunk/doc/manual/en_US/dita/topics/vboxwebsrv-osx.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         On macOS, launchd is used to start the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    9         webservice. An example configuration file can be found in
    10         <filepath>$HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</filepath>.
    11         It can be enabled by changing the <codeph>Disabled</codeph>
    12         key from <codeph>true</codeph> to <codeph>false</codeph>. To
    13         manually start the service use the following command:
    14       </p>
     7    <p>On macOS, launchd is used to start the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> webservice. An
     8      example configuration file can be found in
     9        <filepath>$HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</filepath>. It can be enabled by changing
     10      the <codeph>Disabled</codeph> key from <codeph>true</codeph> to <codeph>false</codeph>. To manually start the
     11      service use the following command: </p>
    1512    <pre xml:space="preserve">launchctl load ~/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</pre>
    16     <p>
    17         For additional information on how launchd services could be
    18         configured see:
    19       </p>
     13    <p>For additional information on how launchd services could be configured see: </p>
    2014    <p><ph>https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html</ph>.
    2115      </p>

  • trunk/doc/manual/en_US/dita/topics/vboxwebsrv-solaris.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         On Oracle Solaris hosts, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> web service daemon
    9         is integrated into the SMF framework. You can change the
    10         parameters, but do not have to if the defaults below already
    11         match your needs:
    12       </p>
     7    <p>On Oracle Solaris hosts, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> web service daemon is
     8      integrated into the SMF framework. You can change the parameters, but do not have to if the defaults below already
     9      match your needs: </p>
    1310    <pre xml:space="preserve">svccfg -s svc:/application/virtualbox/webservice:default setprop config/host=localhost
    1411svccfg -s svc:/application/virtualbox/webservice:default setprop config/port=18083
    1512svccfg -s svc:/application/virtualbox/webservice:default setprop config/user=root</pre>
    16     <p>
    17         The table in <xref href="vboxwebsrv-linux.dita#vboxwebsrv-linux"/> showing the
    18         parameter names and defaults also applies for Oracle Solaris.
    19         The parameter names must be changed to lowercase and a prefix of
    20         <codeph>config/</codeph> has to be added. For example:
    21         <codeph>config/user</codeph> or
    22         <codeph>config/ssl_keyfile</codeph>. If you make any change,
    23         do not forget to run the following command to put the changes
    24         into effect immediately:
    25       </p>
     13    <p>The table in <xref href="vboxwebsrv-linux.dita#vboxwebsrv-linux"/> showing the parameter names and defaults also
     14      applies for Oracle Solaris. The parameter names must be changed to lowercase and a prefix of
     15        <codeph>config/</codeph> has to be added. For example: <codeph>config/user</codeph> or
     16        <codeph>config/ssl_keyfile</codeph>. If you make any change, do not forget to run the following command to put
     17      the changes into effect immediately: </p>
    2618    <pre xml:space="preserve">svcadm refresh svc:/application/virtualbox/webservice:default</pre>
    27     <p>
    28         If you forget the above command then the previous settings are
    29         used when enabling the service. Check the current property
    30         settings as follows:
    31       </p>
     19    <p>If you forget the above command then the previous settings are used when enabling the service. Check the current
     20      property settings as follows: </p>
    3221    <pre xml:space="preserve">svcprop -p config svc:/application/virtualbox/webservice:default</pre>
    33     <p>
    34         When everything is configured correctly you can start the
    35         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> web service with the following command:
    36       </p>
     22    <p>When everything is configured correctly you can start the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     23      web service with the following command: </p>
    3724    <pre xml:space="preserve">svcadm enable svc:/application/virtualbox/webservice:default</pre>
    38     <p>
    39         For more information about SMF, please refer to the Oracle
    40         Solaris documentation.
    41       </p>
     25    <p>For more information about SMF, please refer to the Oracle Solaris documentation. </p>
    4226  </body>
    4327 

  • trunk/doc/manual/en_US/dita/topics/vdidetails.dita

    r99797 r105335  
    66           
    77            <body>
    8                <p>
    9       Disk image files reside on the host system and are seen by the
    10       guest systems as hard disks of a certain geometry. When a guest OS
    11       reads from or writes to a hard disk, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> redirects the
    12       request to the image file.
    13     </p>
    14                <p>
    15       Like a physical disk, a virtual disk has a size, or capacity,
    16       which must be specified when the image file is created. As opposed
    17       to a physical disk however, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to expand
    18       an image file after creation, even if it has data already. See
    19       <xref href="vboxmanage-modifymedium.dita"/>.
    20     </p>
     8               <p>Disk image files reside on the host system and are seen by the guest systems as hard disks of a
     9      certain geometry. When a guest OS reads from or writes to a hard disk, <ph
     10        conkeyref="vbox-conkeyref-phrases/product-name"/> redirects the request to the image file. </p>
     11               <p>Like a physical disk, a virtual disk has a size, or capacity, which must be specified when the image
     12      file is created. As opposed to a physical disk however, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     13      enables you to expand an image file after creation, even if it has data already. See <xref
     14        href="vboxmanage-modifymedium.dita"/>. </p>
    2115               <p>
    2216      <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports the following types of disk image files:
    … …  
    2418               <ul>
    2519                  <li>
    26                      <p>
    27                         <b outputclass="bold">VDI.</b> Normally, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    28           uses its own container format for guest hard disks. This is
    29           called a Virtual Disk Image (VDI) file. This format is used
    30           when you create a new virtual machine with a new disk.
    31         </p>
     20                     <p><b outputclass="bold">VDI.</b> Normally, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     21          uses its own container format for guest hard disks. This is called a Virtual Disk Image (VDI) file. This
     22          format is used when you create a new virtual machine with a new disk. </p>
    3223                  </li>
    3324                  <li>
    34                      <p>
    35                         <b outputclass="bold">VMDK.</b> <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also
    36           fully supports the popular and open VMDK container format that
    37           is used by many other virtualization products, such as VMware.
    38         </p>
     25                     <p><b outputclass="bold">VMDK.</b>
     26          <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also fully supports the popular and open VMDK container
     27          format that is used by many other virtualization products, such as VMware. </p>
    3928                  </li>
    4029                  <li>
    41                      <p>
    42                         <b outputclass="bold">VHD.</b> <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also
    43           fully supports the VHD format used by Microsoft.
    44         </p>
     30                     <p><b outputclass="bold">VHD.</b>
     31          <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also fully supports the VHD format used by Microsoft. </p>
    4532                  </li>
    4633                  <li>
    47                      <p>
    48                         <b outputclass="bold">HDD.</b> Image files of Parallels
    49           version 2 (HDD format) are also supported.
    50         </p>
    51                      <p>
    52           Due to lack of documentation of the format, newer versions
    53           such as 3 and 4 are not supported. You can however convert
    54           such image files to version 2 format using tools provided by
    55           Parallels.
    56         </p>
     34                     <p><b outputclass="bold">HDD.</b> Image files of Parallels version 2 (HDD format) are also
     35          supported. </p>
     36                     <p>Due to lack of documentation of the format, newer versions such as 3 and 4 are not supported.
     37          You can however convert such image files to version 2 format using tools provided by Parallels. </p>
    5738                  </li>
    5839               </ul>
    59                <p>
    60       Irrespective of the disk capacity and format, as mentioned in
    61       <xref href="create-vm-wizard.dita#create-vm-wizard"/>, there are two options for
    62       creating a disk image: fixed-size or dynamically allocated.
    63     </p>
     40               <p>Irrespective of the disk capacity and format, as mentioned in <xref
     41        href="create-vm-wizard.dita#create-vm-wizard"/>, there are two options for creating a disk image: fixed-size or
     42      dynamically allocated. </p>
    6443               <ul>
    6544                  <li>
    66                      <p>
    67                         <b outputclass="bold">Fixed-size.</b> If you create a
    68           fixed-size image, an image file will be created on your host
    69           system which has roughly the same size as the virtual disk's
    70           capacity. So, for a 10 GB disk, you will have a 10 GB file.
    71           Note that the creation of a fixed-size image can take a long
    72           time depending on the size of the image and the write
    73           performance of your hard disk.
    74         </p>
     45                     <p><b outputclass="bold">Fixed-size.</b> If you create a fixed-size image, an image file will be
     46          created on your host system which has roughly the same size as the virtual disk's capacity. So, for a 10 GB
     47          disk, you will have a 10 GB file. Note that the creation of a fixed-size image can take a long time depending
     48          on the size of the image and the write performance of your hard disk. </p>
    7549                  </li>
    7650                  <li>
    77                      <p>
    78                         <b outputclass="bold">Dynamically allocated.</b> For
    79           more flexible storage management, use a dynamically allocated
    80           image. This will initially be very small and not occupy any
    81           space for unused virtual disk sectors, but will grow every
    82           time a disk sector is written to for the first time, until the
    83           drive reaches the maximum capacity chosen when the drive was
    84           created. While this format takes less space initially, the
    85           fact that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to expand the image file
    86           consumes additional computing resources, so until the disk
    87           file size has stabilized, write operations may be slower than
    88           with fixed size disks. However, after a time the rate of
    89           growth will slow and the average penalty for write operations
    90           will be negligible.
    91         </p>
     51                     <p><b outputclass="bold">Dynamically allocated.</b> For more flexible storage management, use a
     52          dynamically allocated image. This will initially be very small and not occupy any space for unused virtual
     53          disk sectors, but will grow every time a disk sector is written to for the first time, until the drive reaches
     54          the maximum capacity chosen when the drive was created. While this format takes less space initially, the fact
     55          that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to expand the image file consumes additional
     56          computing resources, so until the disk file size has stabilized, write operations may be slower than with
     57          fixed size disks. However, after a time the rate of growth will slow and the average penalty for write
     58          operations will be negligible. </p>
    9259                  </li>
    9360               </ul>

  • trunk/doc/manual/en_US/dita/topics/virtual-media-manager.dita

    r99797 r105335  
    66           
    77            <body>
    8                <p>
    9       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> keeps track of all the hard disk, CD/DVD-ROM, and
    10       floppy disk images which are in use by virtual machines. These are
    11       often referred to as <i>known media</i> and come
    12       from two sources:
    13     </p>
     8               <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> keeps track of all the hard disk, CD/DVD-ROM,
     9      and floppy disk images which are in use by virtual machines. These are often referred to as <i>known media</i> and
     10      come from two sources: </p>
    1411               <ul>
    1512                  <li>
    16                      <p>
    17           All media currently attached to virtual machines.
    18         </p>
     13                     <p>All media currently attached to virtual machines. </p>
    1914                  </li>
    2015                  <li>
    21                      <p>
    22           Registered media, for compatibility with legacy <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    23           versions.
    24         </p>
     16                     <p>Registered media, for compatibility with legacy <ph
     17            conkeyref="vbox-conkeyref-phrases/product-name"/> versions. </p>
    2518                  </li>
    2619               </ul>
    27                <p>
    28       The known media can be viewed and changed using the
    29       <b outputclass="bold">Virtual Media Manager</b> tool, which
    30       you access by clicking <b outputclass="bold">Media</b> on
    31       the global <b outputclass="bold">Tools</b> menu in
    32       <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>.
    33     </p>
     20               <p>The known media can be viewed and changed using the <b outputclass="bold">Virtual Media Manager</b>
     21      tool, which you access by clicking <b outputclass="bold">Media</b> on the global <b outputclass="bold">Tools</b>
     22      menu in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p>
    3423              <fig id="fig-virtual-media-manager">
    3524                <title>The Virtual Media Manager, Showing Hard Disk Images</title>
    … …  
    4332                </image>
    4433              </fig>
    45                <p>
    46       The known media are conveniently grouped in separate tabs for the
    47       supported formats. These formats are:
    48     </p>
     34               <p>The known media are conveniently grouped in separate tabs for the supported formats. These formats
     35      are: </p>
    4936               <ul>
    5037                  <li>
    … …  
    6653                  </li>
    6754               </ul>
    68                <p>
    69       For each image, the Virtual Media Manager shows you the full path
    70       of the image file and other information, such as the virtual
    71       machine the image is currently attached to.
    72     </p>
    73                <p>
    74       The Virtual Media Manager enables you to do the following:
    75     </p>
     55               <p>For each image, the Virtual Media Manager shows you the full path of the image file and other
     56      information, such as the virtual machine the image is currently attached to. </p>
     57               <p>The Virtual Media Manager enables you to do the following: </p>
    7658               <ul>
    7759                  <li>
    78                      <p>
    79                         <b outputclass="bold">Add</b> an image to the known
    80           media.
    81         </p>
     60                     <p><b outputclass="bold">Add</b> an image to the known media. </p>
    8261                  </li>
    8362                  <li>
    84                      <p>
    85                         <b outputclass="bold">Create</b> a new disk image.
    86         </p>
     63                     <p><b outputclass="bold">Create</b> a new disk image. </p>
    8764                     <ul>
    8865                        <li>
    89                            <p>
    90               For hard disks, the <b outputclass="bold">Create Virtual
    91               Hard Disk</b> wizard is shown. See
    92               <xref href="create-virtual-hard-disk-image.dita#create-virtual-hard-disk-image"/>.
    93             </p>
     66                           <p>For hard disks, the <b outputclass="bold">Create Virtual Hard Disk</b> wizard is shown.
     67              See <xref href="create-virtual-hard-disk-image.dita#create-virtual-hard-disk-image"/>. </p>
    9468                        </li>
    9569                        <li>
    96                            <p>
    97               For optical disks, the <b outputclass="bold">VISO
    98               Creator</b> tool is shown. See
    99               <xref href="create-optical-disk-image.dita#create-optical-disk-image"/>.
    100             </p>
     70                           <p>For optical disks, the <b outputclass="bold">VISO Creator</b> tool is shown. See <xref
     71                href="create-optical-disk-image.dita#create-optical-disk-image"/>. </p>
    10172                        </li>
    10273                        <li>
    103                            <p>
    104               For floppy disks, the <b outputclass="bold">Floppy Disk
    105               Creator</b> tool is shown. See
    106               <xref href="create-floppy-disk-image.dita#create-floppy-disk-image"/>.
    107             </p>
     74                           <p>For floppy disks, the <b outputclass="bold">Floppy Disk Creator</b> tool is shown. See
     75                <xref href="create-floppy-disk-image.dita#create-floppy-disk-image"/>. </p>
    10876                        </li>
    10977                     </ul>
    11078                  </li>
    11179                  <li>
    112                      <p>
    113                         <b outputclass="bold">Copy</b> an image to create
    114           another one.
    115         </p>
    116                      <p>
    117           For virtual hard disks, you can specify one of the following
    118           target types: VDI, VHD, or VMDK.
    119         </p>
     80                     <p><b outputclass="bold">Copy</b> an image to create another one. </p>
     81                     <p>For virtual hard disks, you can specify one of the following target types: VDI, VHD, or VMDK. </p>
    12082                  </li>
    12183                  <li>
    122                      <p>
    123                         <b outputclass="bold">Move</b> an image to another
    124           location.
    125         </p>
    126                      <p>
    127           A file dialog prompts you for the new image file location.
    128         </p>
    129                      <p>
    130           When you use the Virtual Media Manager to move a disk image,
    131           <ph conkeyref="vbox-conkeyref-phrases/product-name"/> updates all related configuration files
    132           automatically.
    133         </p>
     84                     <p><b outputclass="bold">Move</b> an image to another location. </p>
     85                     <p>A file dialog prompts you for the new image file location. </p>
     86                     <p>When you use the Virtual Media Manager to move a disk image, <ph
     87            conkeyref="vbox-conkeyref-phrases/product-name"/> updates all related configuration files automatically. </p>
    13488                     <note>
    135                         <p>
    136             Always use the Virtual Media Manager or the
    137             <userinput>VBoxManage modifymedium</userinput> command to move a
    138             disk image.
    139           </p>
    140                         <p>
    141             If you use a file management feature of the host OS to move
    142             a disk image to a new location, run the <userinput>VBoxManage
    143               modifymedium --setlocation</userinput>                       
    144             command to configure the new path of the disk image on the
    145             host file system. This command updates the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    146             configuration automatically.
    147           </p>
     89                        <p>Always use the Virtual Media Manager or the <userinput>VBoxManage modifymedium</userinput>
     90            command to move a disk image. </p>
     91                        <p>If you use a file management feature of the host OS to move a disk image to a new location,
     92            run the <userinput>VBoxManage modifymedium --setlocation</userinput> command to configure the new path of
     93            the disk image on the host file system. This command updates the <ph
     94              conkeyref="vbox-conkeyref-phrases/product-name"/> configuration automatically. </p>
    14895                     </note>
    14996                  </li>
    15097                  <li>
    151                      <p>
    152                         <b outputclass="bold">Remove</b> an image from the
    153           known media. You can optionally delete the image file when
    154           removing the image.
    155         </p>
     98                     <p><b outputclass="bold">Remove</b> an image from the known media. You can optionally delete the
     99          image file when removing the image. </p>
    156100                  </li>
    157101                  <li>
    158                      <p>
    159                         <b outputclass="bold">Release</b> an image to detach it
    160           from a VM. This action only applies if the image is currently
    161           attached to a VM as a virtual hard disk.
    162         </p>
     102                     <p><b outputclass="bold">Release</b> an image to detach it from a VM. This action only applies if
     103          the image is currently attached to a VM as a virtual hard disk. </p>
    163104                  </li>
    164105                  <li>
    165                      <p>
    166                         <b outputclass="bold">Clear</b> all inaccessible disk
    167           images from the list. The disk images are released from the
    168           VMs they are attached to and removed from the known media.
    169         </p>
     106                     <p><b outputclass="bold">Clear</b> all inaccessible disk images from the list. The disk images are
     107          released from the VMs they are attached to and removed from the known media. </p>
    170108                     <note>
    171109                        <p>
    … …  
    175113                  </li>
    176114                  <li>
    177                      <p>
    178                         <b outputclass="bold">Search</b> for an image by name
    179           or UUID.
    180         </p>
     115                     <p><b outputclass="bold">Search</b> for an image by name or UUID. </p>
    181116                  </li>
    182117                  <li>
    183                      <p>
    184           View and edit the <b outputclass="bold">Properties</b>
    185           of a disk image.
    186         </p>
    187                      <p>
    188           Available properties include the following:
    189         </p>
     118                     <p>View and edit the <b outputclass="bold">Properties</b> of a disk image. </p>
     119                     <p>Available properties include the following: </p>
    190120                     <ul>
    191121                        <li>
    192                            <p>
    193                               <b outputclass="bold">Type:</b> Specifies the
    194               snapshot behavior of the disk. See
    195               <xref href="hdimagewrites.dita#hdimagewrites"/>.
    196             </p>
     122                           <p><b outputclass="bold">Type:</b> Specifies the snapshot behavior of the disk. See <xref
     123                href="hdimagewrites.dita#hdimagewrites"/>. </p>
    197124                        </li>
    198125                        <li>
    199                            <p>
    200                               <b outputclass="bold">Location:</b> Specifies the
    201               location of the disk image file on the host system. You
    202               can use a file dialog to browse for the disk image
    203               location.
    204             </p>
     126                           <p><b outputclass="bold">Location:</b> Specifies the location of the disk image file on the
     127              host system. You can use a file dialog to browse for the disk image location. </p>
    205128                        </li>
    206129                        <li>
    207                            <p>
    208                               <b outputclass="bold">Description:</b> Specifies a
    209               short description of the disk image.
    210             </p>
     130                           <p><b outputclass="bold">Description:</b> Specifies a short description of the disk image. </p>
    211131                        </li>
    212132                        <li>
    213                            <p>
    214                               <b outputclass="bold">Size:</b> Specifies the size
    215               of the disk image. You can use the slider to increase or
    216               decrease the disk image size.
    217             </p>
     133                           <p><b outputclass="bold">Size:</b> Specifies the size of the disk image. You can use the
     134              slider to increase or decrease the disk image size. </p>
    218135                        </li>
    219136                        <li>
    220                            <p>
    221                               <b outputclass="bold">Information:</b> Specifies
    222               detailed information about the disk image.
    223             </p>
     137                           <p><b outputclass="bold">Information:</b> Specifies detailed information about the disk
     138              image. </p>
    224139                        </li>
    225140                     </ul>
    226141                  </li>
    227142                  <li>
    228                      <p>
    229                         <b outputclass="bold">Refresh</b> the property values
    230           of the selected disk image.
    231         </p>
     143                     <p><b outputclass="bold">Refresh</b> the property values of the selected disk image. </p>
    232144                  </li>
    233145               </ul>
    234                <p>
    235       To perform these actions, highlight the medium in the Virtual
    236       Media Manager and then do one of the following:
    237     </p>
     146               <p>To perform these actions, highlight the medium in the Virtual Media Manager and then do one of the
     147      following: </p>
    238148               <ul>
    239149                  <li>
    240                      <p>
    241           Click an icon in the Virtual Media Manager toolbar.
    242         </p>
     150                     <p>Click an icon in the Virtual Media Manager toolbar. </p>
    243151                  </li>
    244152                  <li>
    245                      <p>
    246           Right-click the medium and select an option.
    247         </p>
     153                     <p>Right-click the medium and select an option. </p>
    248154                  </li>
    249155               </ul>
    250                <p>
    251       Use the <b outputclass="bold">Storage</b> page in a VM's
    252       <b outputclass="bold">Settings</b> window to create a new
    253       disk image. By default, disk images are stored in the VM's folder.
    254     </p>
    255                <p>
    256       You can copy hard disk image files to other host systems and then
    257       import them in to VMs from the host system. However, some Windows
    258       guest OSes may require that you configure the new VM in a similar
    259       way to the old one.
    260     </p>
     156               <p>Use the <b outputclass="bold">Storage</b> page in a VM's <b outputclass="bold">Settings</b> window to
     157      create a new disk image. By default, disk images are stored in the VM's folder. </p>
     158               <p>You can copy hard disk image files to other host systems and then import them in to VMs from the host
     159      system. However, some Windows guest OSes may require that you configure the new VM in a similar way to the old
     160      one. </p>
    261161               <note>
    262                   <p>
    263         Do not simply make copies of virtual disk images. If you import
    264         such a second copy into a VM, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> issues an error
    265         because <ph conkeyref="vbox-conkeyref-phrases/product-name"/> assigns a universally unique identifier
    266         (UUID) to each disk image to ensure that it is only used one
    267         time. See <xref href="cloningvdis.dita#cloningvdis"/>. Also, if you want to
    268         copy a VM to another system, use the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> import and
    269         export features. See <xref href="ovf.dita#ovf"/>.
    270       </p>
     162                  <p>Do not simply make copies of virtual disk images. If you import such a second copy into a VM, <ph
     163          conkeyref="vbox-conkeyref-phrases/product-name"/> issues an error because <ph
     164          conkeyref="vbox-conkeyref-phrases/product-name"/> assigns a universally unique identifier (UUID) to each disk
     165        image to ensure that it is only used one time. See <xref href="cloningvdis.dita#cloningvdis"/>. Also, if you
     166        want to copy a VM to another system, use the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> import and
     167        export features. See <xref href="ovf.dita#ovf"/>. </p>
    271168               </note>
    272169            </body>

  • trunk/doc/manual/en_US/dita/topics/vmencryption-addpassword.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         When <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has just started up the encrypted VM cannot
    9         be opened and it stays inaccessible. Also, the encrypted VM
    10         stays inaccessible if it was just registered without a password
    11         or the password is incorrect. The user needs to provide the
    12         password using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or with the following
    13         <userinput>VBoxManage</userinput> command:
    14       </p>
     7    <p>When <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has just started up the encrypted VM cannot be opened
     8      and it stays inaccessible. Also, the encrypted VM stays inaccessible if it was just registered without a password
     9      or the password is incorrect. The user needs to provide the password using <ph
     10        conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or with the following <userinput>VBoxManage</userinput> command: </p>
    1511    <pre xml:space="preserve">VBoxManage encryptvm <varname>uuid</varname>|<varname>vmname</varname> addpassword --password <varname>filename</varname>|- --password-id <varname>ID</varname>
    1612                  </pre>
    17     <p>
    18         To supply the encryption password point
    19         <userinput>VBoxManage</userinput> to the file where the password is
    20         stored or specify <codeph>-</codeph> to let
    21         <userinput>VBoxManage</userinput> prompt for the password on the
    22         command line.
    23       </p>
    24     <p>
    25         If <varname>ID</varname> is the same as the password
    26         identifier supplied when encrypting the VM it updates the
    27         accessibility state.
    28       </p>
    29     <p>
    30         To remove the entered password from the VM memory, use
    31         <userinput>VBoxManage</userinput> as follows:
    32       </p>
     13    <p>To supply the encryption password point <userinput>VBoxManage</userinput> to the file where the password is
     14      stored or specify <codeph>-</codeph> to let <userinput>VBoxManage</userinput> prompt for the password on the
     15      command line. </p>
     16    <p>If <varname>ID</varname> is the same as the password identifier supplied when encrypting the VM it updates the
     17      accessibility state. </p>
     18    <p>To remove the entered password from the VM memory, use <userinput>VBoxManage</userinput> as follows: </p>
    3319    <pre xml:space="preserve">VBoxManage encryptvm <varname>uuid</varname>|<varname>vmname</varname> removepassword <varname>ID</varname>
    3420                  </pre>
    35     <p>
    36         If <varname>ID</varname> is the same as the password
    37         identifier supplied when encrypting the VM it updates the
    38         accessibility state.
    39       </p>
     21    <p>If <varname>ID</varname> is the same as the password identifier supplied when encrypting the VM it updates the
     22      accessibility state. </p>
    4023    <note>
    41       <p>
    42           If a machine becomes inaccessible all passwords are purged.
    43           You have to add required passwords again, using the
    44           <userinput>VBoxManage encryptvm
    45           <varname>vmname</varname> addpassword</userinput>
    46           command. See <xref href="#vmencryption-addpassword"/>.
    47         </p>
     24      <p>If a machine becomes inaccessible all passwords are purged. You have to add required passwords again, using the
     25          <userinput>VBoxManage encryptvm <varname>vmname</varname> addpassword</userinput> command. See <xref
     26          href="#vmencryption-addpassword"/>. </p>
    4827    </note>
    4928  </body>

  • trunk/doc/manual/en_US/dita/topics/vmencryption-decryption.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         In some circumstances it might be required to decrypt previously
    9         encrypted VMs. This can be done in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or using
    10         <userinput>VBoxManage</userinput> with the following command:
    11       </p>
     7    <p>In some circumstances it might be required to decrypt previously encrypted VMs. This can be done in <ph
     8        conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or using <userinput>VBoxManage</userinput> with the following
     9      command: </p>
    1210    <pre xml:space="preserve">VBoxManage encryptvm <varname>uuid</varname>|<varname>vmname</varname> setencryption --old-password <varname>file</varname>|-</pre>
    13     <p>
    14         The only required parameter is the password the VM was encrypted
    15         with. The options are the same as for encrypting VMs.
    16       </p>
     11    <p>The only required parameter is the password the VM was encrypted with. The options are the same as for encrypting
     12      VMs. </p>
    1713  </body>
    1814 

  • trunk/doc/manual/en_US/dita/topics/vmencryption-encryption.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         Encrypting a VM can be done either using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or the
    9         <userinput>VBoxManage</userinput>. To encrypt an unencrypted VM with
    10         <userinput>VBoxManage</userinput>, use:
    11       </p>
     7    <p>Encrypting a VM can be done either using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or the
     8        <userinput>VBoxManage</userinput>. To encrypt an unencrypted VM with <userinput>VBoxManage</userinput>, use: </p>
    129    <pre xml:space="preserve">VBoxManage encryptvm <varname>uuid</varname>|<varname>vmname</varname> setencryption --new-password <varname>filename</varname>|- \
    1310--cipher <varname>cipher-ID</varname> --new-password-id <varname>ID</varname>
    1411                  </pre>
    15     <p>
    16         To supply the encryption password, point
    17         <userinput>VBoxManage</userinput> to the file where the password is
    18         stored or specify <codeph>-</codeph> to let
    19         <userinput>VBoxManage</userinput> prompt for the password on the
    20         command line.
    21       </p>
    22     <p>
    23         The cipher parameter specifies the cipher to use for encryption
    24         and can be either <codeph>AES-128</codeph> or
    25         <codeph>AES-256</codeph>. The appropriate mode of operation,
    26         such as GCM, CTR, or XTS will be selected by the VM depending on
    27         the encrypting component. The specified password identifier can
    28         be freely chosen by the user and is used for correct
    29         identification when supplying multiple passwords for the VM.
    30       </p>
     12    <p>To supply the encryption password, point <userinput>VBoxManage</userinput> to the file where the password is
     13      stored or specify <codeph>-</codeph> to let <userinput>VBoxManage</userinput> prompt for the password on the
     14      command line. </p>
     15    <p>The cipher parameter specifies the cipher to use for encryption and can be either <codeph>AES-128</codeph> or
     16        <codeph>AES-256</codeph>. The appropriate mode of operation, such as GCM, CTR, or XTS will be selected by the VM
     17      depending on the encrypting component. The specified password identifier can be freely chosen by the user and is
     18      used for correct identification when supplying multiple passwords for the VM. </p>
    3119  </body>
    3220 

  • trunk/doc/manual/en_US/dita/topics/vmencryption-limitations.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         There are some limitations the user needs to be aware of when
    9         using this feature:
    10       </p>
     7    <p>There are some limitations the user needs to be aware of when using this feature: </p>
    118    <ul>
    129      <li>
    13         <p>
    14             Exporting appliances containing an encrypted VM is not
    15             possible, because the OVF specification does not support
    16             this. The VM is therefore decrypted during export.
    17           </p>
     10        <p>Exporting appliances containing an encrypted VM is not possible, because the OVF specification does not
     11          support this. The VM is therefore decrypted during export. </p>
    1812      </li>
    1913      <li>
    20         <p>
    21             The DEK is kept in memory while the VM is running to be able
    22             to encrypt and decrypt VM data. While this should be obvious
    23             the user needs to be aware of this because an attacker might
    24             be able to extract the key on a compromised host and decrypt
    25             the data.
    26           </p>
     14        <p>The DEK is kept in memory while the VM is running to be able to encrypt and decrypt VM data. While this
     15          should be obvious the user needs to be aware of this because an attacker might be able to extract the key on a
     16          compromised host and decrypt the data. </p>
    2717      </li>
    2818      <li>
    29         <p>
    30             When encrypting or decrypting the VM, the password is passed
    31             in clear text using the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> API. This needs to be
    32             kept in mind, especially when using third party API clients
    33             which make use of the web service where the password might
    34             be transmitted over the network. The use of HTTPS is
    35             mandatory in such a case.
    36           </p>
     19        <p>When encrypting or decrypting the VM, the password is passed in clear text using the <ph
     20            conkeyref="vbox-conkeyref-phrases/product-name"/> API. This needs to be kept in mind, especially when using
     21          third party API clients which make use of the web service where the password might be transmitted over the
     22          network. The use of HTTPS is mandatory in such a case. </p>
    3723      </li>
    3824    </ul>

  • trunk/doc/manual/en_US/dita/topics/vmencryption.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to transparently encrypt the VM data
    9       stored in the configuration file, saved state, and EFI boot data
    10       for the guest.
    11     </p>
    12     <p>
    13       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the AES algorithm in various modes. The
    14       selected mode depends on the encrypting component of the VM.
    15       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports 128-bit or 256-bit data encryption keys
    16       (DEK). The DEK is stored encrypted in the VM configuration file
    17       and is decrypted during VM startup.
    18     </p>
    19     <p> Since the DEK is stored as part of the VM configuration file, it is important that the file
    20       is kept safe. Losing the DEK means that the data stored in the VM is lost irrecoverably.
    21       Having complete and up-to-date backups of all data related to the VM is the responsibility of
    22       the user. </p>
    23     <p>
    24       The VM, even if it is encrypted, may contain media encrypted with
    25       different passwords. To deal with this, the password for the VM
    26       has a password identifier, in the same way as passwords for media.
    27       The password ID is an arbitrary string which uniquely identifies
    28       the password in the VM and its media. You can use the same
    29       password and ID for both the VM and its media.
    30     </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to transparently encrypt the VM data stored in
     8      the configuration file, saved state, and EFI boot data for the guest. </p>
     9    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the AES algorithm in various modes. The selected mode
     10      depends on the encrypting component of the VM. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports
     11      128-bit or 256-bit data encryption keys (DEK). The DEK is stored encrypted in the VM configuration file and is
     12      decrypted during VM startup. </p>
     13    <p>Since the DEK is stored as part of the VM configuration file, it is important that the file is kept safe. Losing
     14      the DEK means that the data stored in the VM is lost irrecoverably. Having complete and up-to-date backups of all
     15      data related to the VM is the responsibility of the user. </p>
     16    <p>The VM, even if it is encrypted, may contain media encrypted with different passwords. To deal with this, the
     17      password for the VM has a password identifier, in the same way as passwords for media. The password ID is an
     18      arbitrary string which uniquely identifies the password in the VM and its media. You can use the same password and
     19      ID for both the VM and its media. </p>
    3120  </body>
    3221</topic>

  • trunk/doc/manual/en_US/dita/topics/vrde-crypt.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8         RDP features data stream encryption, which is based on the RC4
    9         symmetric cipher, with keys up to 128-bit. The RC4 keys are
    10         replaced at regular intervals, every 4096 packets.
    11       </p>
    12     <p>
    13         RDP provides the following different authentication methods:
    14       </p>
     7    <p>RDP features data stream encryption, which is based on the RC4 symmetric cipher, with keys up to 128-bit. The RC4
     8      keys are replaced at regular intervals, every 4096 packets. </p>
     9    <p>RDP provides the following different authentication methods: </p>
    1510    <ul>
    1611      <li>
    … …  
    4136            certificate to the client.
    4237          </p>
    43         <p> The <codeph>Security/Method</codeph> VRDE property sets the required security method,
    44           which is used for a connection. Valid values are as follows: </p>
     38        <p>The <codeph>Security/Method</codeph> VRDE property sets the required security method, which is used for a
     39          connection. Valid values are as follows: </p>
    4540        <ul>
    4641          <li>
    … …  
    6661          </li>
    6762        </ul>
    68         <p>
    69             For example, the following command enables a client to use
    70             either Standard or Enhanced RDP Security connection:
    71           </p>
     63        <p>For example, the following command enables a client to use either Standard or Enhanced RDP Security
     64          connection: </p>
    7265        <pre xml:space="preserve">vboxmanage modifyvm <varname>VM-name</varname> --vrde-property "Security/Method=negotiate"</pre>
    73         <p>
    74             If the <codeph>Security/Method</codeph> property is set to
    75             either Negotiate or TLS, the TLS protocol will be
    76             automatically used by the server, if the client supports
    77             TLS. However, in order to use TLS the server must possess
    78             the Server Certificate, the Server Private Key and the
    79             Certificate Authority (CA) Certificate. The following
    80             example shows how to generate a server certificate.
    81           </p>
     66        <p>If the <codeph>Security/Method</codeph> property is set to either Negotiate or TLS, the TLS protocol will be
     67          automatically used by the server, if the client supports TLS. However, in order to use TLS the server must
     68          possess the Server Certificate, the Server Private Key and the Certificate Authority (CA) Certificate. The
     69          following example shows how to generate a server certificate. </p>
    8270        <ol>
    8371          <li>
    84             <p>
    85                 Create a CA self signed certificate.
    86               </p>
     72            <p>Create a CA self signed certificate. </p>
    8773            <pre xml:space="preserve">openssl req -new -x509 -days 365 -extensions v3_ca \
    8874  -keyout ca_key_private.pem -out ca_cert.pem</pre>
    8975          </li>
    9076          <li>
    91             <p>
    92                 Generate a server private key and a request for signing.
    93               </p>
     77            <p>Generate a server private key and a request for signing. </p>
    9478            <pre xml:space="preserve">openssl genrsa -out server_key_private.pem
    9579openssl req -new -key server_key_private.pem -out server_req.pem</pre>
    9680          </li>
    9781          <li>
    98             <p>
    99                 Generate the server certificate.
    100               </p>
     82            <p>Generate the server certificate. </p>
    10183            <pre xml:space="preserve">openssl x509 -req -days 365 -in server_req.pem \
    10284  -CA ca_cert.pem -CAkey ca_key_private.pem -set_serial 01 -out server_cert.pem</pre>
    10385          </li>
    10486        </ol>
    105         <p>
    106             The server must be configured to access the required files.
    107             For example:
    108           </p>
     87        <p>The server must be configured to access the required files. For example: </p>
    10988        <pre xml:space="preserve">vboxmanage modifyvm <varname>VM-name</varname> \
    11089  --vrde-property "Security/CACertificate=path/ca_cert.pem"</pre>
    … …  
    11594      </li>
    11695    </ul>
    117     <p>
    118         As the client that connects to the server determines what type
    119         of encryption will be used, with <userinput>rdesktop</userinput>,
    120         the Linux RDP viewer, use the <codeph>-4</codeph> or
    121         <codeph>-5</codeph> options.
    122       </p>
     96    <p>As the client that connects to the server determines what type of encryption will be used, with
     97        <userinput>rdesktop</userinput>, the Linux RDP viewer, use the <codeph>-4</codeph> or <codeph>-5</codeph>
     98      options. </p>
    12399  </body>
    124100 

  • trunk/doc/manual/en_US/dita/topics/vrde-customization.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         You can disable display output, mouse and keyboard input, audio,
    9         remote USB, or clipboard individually in the VRDP server.
    10       </p>
    11     <p>
    12         The following commands change the corresponding server settings:
    13       </p>
     7    <p>You can disable display output, mouse and keyboard input, audio, remote USB, or clipboard individually in the
     8      VRDP server. </p>
     9    <p>The following commands change the corresponding server settings: </p>
    1410    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --vrde-property Client/DisableDisplay=1
    1511$ VBoxManage modifyvm <varname>VM-name</varname> --vrde-property Client/DisableInput=1
    … …  
    1814$ VBoxManage modifyvm <varname>VM-name</varname> --vrde-property Client/DisableClipboard=1
    1915$ VBoxManage modifyvm <varname>VM-name</varname> --vrde-property Client/DisableUpstreamAudio=1</pre>
    20     <p>
    21         To reenable a feature, use a similar command without the
    22         trailing 1. For example:
    23       </p>
     16    <p>To reenable a feature, use a similar command without the trailing 1. For example: </p>
    2417    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --vrde-property Client/DisableDisplay=</pre>
    2518  </body>

  • trunk/doc/manual/en_US/dita/topics/vrde-multiconnection.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         The VRDP server of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports multiple simultaneous
    9         connections to the same running VM from different clients. All
    10         connected clients see the same screen output and share a mouse
    11         pointer and keyboard focus. This is similar to several people
    12         using the same computer at the same time, taking turns at the
    13         keyboard.
    14       </p>
    15     <p>
    16         The following command enables multiple connection mode:
    17       </p>
     7    <p>The VRDP server of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports multiple simultaneous
     8      connections to the same running VM from different clients. All connected clients see the same screen output and
     9      share a mouse pointer and keyboard focus. This is similar to several people using the same computer at the same
     10      time, taking turns at the keyboard. </p>
     11    <p>The following command enables multiple connection mode: </p>
    1812    <pre xml:space="preserve">VBoxManage modifyvm <varname>VM-name</varname> --vrde-multi-con on</pre>
    1913  </body>

  • trunk/doc/manual/en_US/dita/topics/vrde-multimonitor.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         To access two or more remote VM displays you have to enable the
    9         VRDP multiconnection mode. See
    10         <xref href="vrde-multiconnection.dita#vrde-multiconnection"/>.
    11       </p>
    12     <p>
    13         The RDP client can select the virtual monitor number to connect
    14         to using the <codeph>domain</codeph> login parameter
    15         (<codeph>-d</codeph>). If the parameter ends with
    16         <codeph>@</codeph> followed by a number, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
    17         interprets this number as the screen index. The primary guest
    18         screen is selected with <codeph>@1</codeph>, the first
    19         secondary screen is <codeph>@2</codeph>, and so on.
    20       </p>
    21     <p>
    22         The Microsoft RDP 6 client does not let you specify a separate
    23         domain name. Instead, enter
    24         <codeph><varname>domain</varname>\<varname>username</varname></codeph>
    25         in the <b outputclass="bold">Username</b> field. For
    26         example, <codeph>@2\<varname>name</varname>
    27                      </codeph>.
    28         <varname>name</varname> must be supplied, and must be
    29         the name used to log in if the VRDP server is set up to require
    30         credentials. If it is not, you may use any text as the username.
    31       </p>
     7    <p>To access two or more remote VM displays you have to enable the VRDP multiconnection mode. See <xref
     8        href="vrde-multiconnection.dita#vrde-multiconnection"/>. </p>
     9    <p>The RDP client can select the virtual monitor number to connect to using the <codeph>domain</codeph> login
     10      parameter (<codeph>-d</codeph>). If the parameter ends with <codeph>@</codeph> followed by a number, <ph
     11        conkeyref="vbox-conkeyref-phrases/product-name"/> interprets this number as the screen index. The primary guest
     12      screen is selected with <codeph>@1</codeph>, the first secondary screen is <codeph>@2</codeph>, and so on. </p>
     13    <p>The Microsoft RDP 6 client does not let you specify a separate domain name. Instead, enter
     14          <codeph><varname>domain</varname>\<varname>username</varname></codeph> in the <b outputclass="bold"
     15        >Username</b> field. For example, <codeph>@2\<varname>name</varname>
     16      </codeph>. <varname>name</varname> must be supplied, and must be the name used to log in if the VRDP server is set
     17      up to require credentials. If it is not, you may use any text as the username. </p>
    3218  </body>
    3319 

  • trunk/doc/manual/en_US/dita/topics/vrde-videochannel.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         The VRDP server can redirect video streams from the guest to the
    9         RDP client. Video frames are compressed using the JPEG algorithm
    10         allowing a higher compression ratio than standard RDP bitmap
    11         compression methods. It is possible to increase the compression
    12         ratio by lowering the video quality.
    13       </p>
    14     <p>
    15         The VRDP server automatically detects video streams in a guest
    16         as frequently updated rectangular areas. As a result, this
    17         method works with any guest operating system without having to
    18         install additional software in the guest. In particular, the
    19         Guest Additions are not required.
    20       </p>
    21     <p>
    22         On the client side, however, currently only the Windows 7 Remote
    23         Desktop Connection client supports this feature. If a client
    24         does not support video redirection, the VRDP server falls back
    25         to regular bitmap updates.
    26       </p>
    27     <p>
    28         The following command enables video redirection:
    29       </p>
     7    <p>The VRDP server can redirect video streams from the guest to the RDP client. Video frames are compressed using
     8      the JPEG algorithm allowing a higher compression ratio than standard RDP bitmap compression methods. It is
     9      possible to increase the compression ratio by lowering the video quality. </p>
     10    <p>The VRDP server automatically detects video streams in a guest as frequently updated rectangular areas. As a
     11      result, this method works with any guest operating system without having to install additional software in the
     12      guest. In particular, the Guest Additions are not required. </p>
     13    <p>On the client side, however, currently only the Windows 7 Remote Desktop Connection client supports this feature.
     14      If a client does not support video redirection, the VRDP server falls back to regular bitmap updates. </p>
     15    <p>The following command enables video redirection: </p>
    3016    <pre xml:space="preserve">VBoxManage modifyvm <varname>VM-name</varname> --vrde-video-channel on</pre>
    31     <p>
    32         The quality of the video is defined as a value from 10 to 100
    33         percent, representing a JPEG compression level, where lower
    34         numbers mean lower quality but higher compression. The quality
    35         can be changed using the following command:
    36       </p>
     17    <p>The quality of the video is defined as a value from 10 to 100 percent, representing a JPEG compression level,
     18      where lower numbers mean lower quality but higher compression. The quality can be changed using the following
     19      command: </p>
    3720    <pre xml:space="preserve">VBoxManage modifyvm <varname>VM-name</varname> --vrde-video-channel-quality 75</pre>
    3821  </body>

  • trunk/doc/manual/en_US/dita/topics/vrde.dita

    r105134 r105335  
    55 
    66  <body>
    7     <p>
    8       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can display virtual machines remotely, meaning that
    9       a virtual machine can execute on one computer even though the
    10       machine will be displayed on a second computer, and the machine
    11       will be controlled from there as well, as if the virtual machine
    12       was running on that second computer.
    13     </p>
    14     <p>
    15       For maximum flexibility, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> implements remote machine
    16       display through a generic extension interface called the
    17       VirtualBox Remote Desktop Extension (VRDE). The base open source
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can display virtual machines remotely, meaning that a
     8      virtual machine can execute on one computer even though the machine will be displayed on a second computer, and
     9      the machine will be controlled from there as well, as if the virtual machine was running on that second computer. </p>
     10    <p>For maximum flexibility, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> implements remote machine display
     11      through a generic extension interface called the VirtualBox Remote Desktop Extension (VRDE). The base open source
    1812      <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package only provides this interface, while
    19       implementations can be supplied by third parties with
    20       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> extension packages, which must be installed
    21       separately from the base package. See
    22       <xref href="intro-installing.dita">Installing <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and Extension Packs</xref>.
    23     </p>
    24     <p>
    25       Oracle provides support for the VirtualBox Remote Display Protocol
    26       (VRDP) in such an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> extension package.
    27     </p>
    28     <p> VRDP is a backward-compatible extension to Microsoft's Remote Desktop Protocol (RDP). As a
    29       result, you can use any standard RDP client to control the remote VM. </p>
    30     <p>
    31       Even when the extension is installed, the VRDP server is disabled
    32       by default. It can easily be enabled on a per-VM basis either from
    33       <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> in the <b outputclass="bold">Display</b>
    34       settings, see <xref href="settings-display.dita">Display Settings</xref>, or with the
    35       <userinput>VBoxManage</userinput> command, as follows:
    36     </p>
     13      implementations can be supplied by third parties with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
     14      extension packages, which must be installed separately from the base package. See <xref
     15        href="intro-installing.dita">Installing <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and Extension
     16        Packs</xref>. </p>
     17    <p>Oracle provides support for the VirtualBox Remote Display Protocol (VRDP) in such an <ph
     18        conkeyref="vbox-conkeyref-phrases/product-name"/> extension package. </p>
     19    <p>VRDP is a backward-compatible extension to Microsoft's Remote Desktop Protocol (RDP). As a result, you can use
     20      any standard RDP client to control the remote VM. </p>
     21    <p>Even when the extension is installed, the VRDP server is disabled by default. It can easily be enabled on a
     22      per-VM basis either from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> in the <b outputclass="bold"
     23        >Display</b> settings, see <xref href="settings-display.dita">Display Settings</xref>, or with the
     24        <userinput>VBoxManage</userinput> command, as follows: </p>
    3725    <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --vrde on</pre>
    38     <p>
    39       By default, the VRDP server uses TCP port <codeph>3389</codeph>.
    40       You will need to change the default port if you run more than one
    41       VRDP server, since the port can only be used by one server at a
    42       time. You might also need to change it on Windows hosts since the
    43       default port might already be used by the RDP server that is built
    44       into Windows itself. Ports 5000 through 5050 are typically not
    45       used and might be a good choice.
    46     </p>
    47     <p>
    48       The port can be changed either in the
    49       <b outputclass="bold">Display</b> settings of the graphical
    50       user interface or with the <codeph>--vrde-port</codeph> option of
    51       the <userinput>VBoxManage modifyvm</userinput> command. You can
    52       specify a comma-separated list of ports or ranges of ports. Use a
    53       dash between two port numbers to specify a range. The VRDP server
    54       will bind to <i>one</i> of the available ports from
    55       the specified list. For example, <userinput>VBoxManage modifyvm
    56       <varname>VM-name</varname> --vrde-port
    57       5000,5010-5012</userinput> configures the server to bind to one of
    58       the ports 5000, 5010, 5011, or 5012. See
    59       <xref href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref>.
    60     </p>
    61     <p>
    62       The actual port used by a running VM can be either queried with
    63       the <userinput>VBoxManage showvminfo</userinput> command or seen in
    64       <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> on the <b outputclass="bold">Runtime</b> tab of
    65       the <b outputclass="bold">Session Information</b> dialog,
    66       which is accessible from the
    67       <b outputclass="bold">Machine</b> menu of the VM window.
    68     </p>
    69     <p>
    70       <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports IPv6. If the host OS supports IPv6 the
    71       VRDP server will automatically listen for IPv6 connections in
    72       addition to IPv4.
    73     </p>
     26    <p>By default, the VRDP server uses TCP port <codeph>3389</codeph>. You will need to change the default port if you
     27      run more than one VRDP server, since the port can only be used by one server at a time. You might also need to
     28      change it on Windows hosts since the default port might already be used by the RDP server that is built into
     29      Windows itself. Ports 5000 through 5050 are typically not used and might be a good choice. </p>
     30    <p>The port can be changed either in the <b outputclass="bold">Display</b> settings of the graphical user interface
     31      or with the <codeph>--vrde-port</codeph> option of the <userinput>VBoxManage modifyvm</userinput> command. You can
     32      specify a comma-separated list of ports or ranges of ports. Use a dash between two port numbers to specify a
     33      range. The VRDP server will bind to <i>one</i> of the available ports from the specified list. For example,
     34        <userinput>VBoxManage modifyvm <varname>VM-name</varname> --vrde-port 5000,5010-5012</userinput> configures the
     35      server to bind to one of the ports 5000, 5010, 5011, or 5012. See <xref href="vboxmanage-modifyvm.dita">VBoxManage
     36        modifyvm</xref>. </p>
     37    <p>The actual port used by a running VM can be either queried with the <userinput>VBoxManage showvminfo</userinput>
     38      command or seen in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> on the <b outputclass="bold">Runtime</b> tab
     39      of the <b outputclass="bold">Session Information</b> dialog, which is accessible from the <b outputclass="bold"
     40        >Machine</b> menu of the VM window. </p>
     41    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports IPv6. If the host OS supports IPv6 the VRDP server
     42      will automatically listen for IPv6 connections in addition to IPv4. </p>
    7443  </body>
    7544</topic>

  • trunk/doc/manual/en_US/dita/topics/warpguest.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         For certain purposes it can be useful to accelerate or to slow
    9         down the virtual guest clock. This can be achieved as follows:
    10       </p>
     7    <p>For certain purposes it can be useful to accelerate or to slow down the virtual guest clock. This can be achieved
     8      as follows: </p>
    119    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> "VBoxInternal/TM/WarpDrivePercentage" 200</pre>
    12     <p>
    13         The above example will double the speed of the guest clock while
    14       </p>
     10    <p>The above example will double the speed of the guest clock while </p>
    1511    <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> "VBoxInternal/TM/WarpDrivePercentage" 50</pre>
    16     <p>
    17         will halve the speed of the guest clock. Note that changing the
    18         rate of the virtual clock can confuse the guest and can even
    19         lead to abnormal guest behavior. For instance, a higher clock
    20         rate means shorter timeouts for virtual devices with the result
    21         that a slightly increased response time of a virtual device due
    22         to an increased host load can cause guest failures. Note further
    23         that any time synchronization mechanism will frequently try to
    24         resynchronize the guest clock with the reference clock, which is
    25         the host clock if the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions are active.
    26         Therefore any time synchronization should be disabled if the
    27         rate of the guest clock is changed as described above. See
    28         <xref href="changetimesync.dita#changetimesync"/>.
    29       </p>
     12    <p>will halve the speed of the guest clock. Note that changing the rate of the virtual clock can confuse the guest
     13      and can even lead to abnormal guest behavior. For instance, a higher clock rate means shorter timeouts for virtual
     14      devices with the result that a slightly increased response time of a virtual device due to an increased host load
     15      can cause guest failures. Note further that any time synchronization mechanism will frequently try to
     16      resynchronize the guest clock with the reference clock, which is the host clock if the <ph
     17        conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions are active. Therefore any time synchronization
     18      should be disabled if the rate of the guest clock is changed as described above. See <xref
     19        href="changetimesync.dita#changetimesync"/>. </p>
    3020  </body>
    3121 

  • trunk/doc/manual/en_US/dita/topics/webcam-linux-hosts.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         When the webcam is detached from the host the emulated webcam
    9         device is automatically detached from the guest only if the
    10         webcam is streaming video. If the emulated webcam is inactive it
    11         should be manually detached using the <userinput>VBoxManage
    12         controlvm <varname>VM-name</varname> webcam
    13         detach</userinput> command.
    14       </p>
    15     <p>
    16         Aliases <filepath>.0</filepath> and <filepath>.1</filepath> are
    17         mapped to <filepath>/dev/video0</filepath>, alias
    18         <filepath>.2</filepath> is mapped to
    19         <filepath>/dev/video1</filepath> and so forth.
    20       </p>
     7    <p>When the webcam is detached from the host the emulated webcam device is automatically detached from the guest
     8      only if the webcam is streaming video. If the emulated webcam is inactive it should be manually detached using the
     9        <userinput>VBoxManage controlvm <varname>VM-name</varname> webcam detach</userinput> command. </p>
     10    <p>Aliases <filepath>.0</filepath> and <filepath>.1</filepath> are mapped to <filepath>/dev/video0</filepath>, alias
     11        <filepath>.2</filepath> is mapped to <filepath>/dev/video1</filepath> and so forth. </p>
    2112  </body>
    2213 

  • trunk/doc/manual/en_US/dita/topics/webcam-mac-hosts.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         When the webcam device is detached from the host, the emulated
    9         webcam device remains attached to the guest and must be manually
    10         detached using the <userinput>VBoxManage controlvm
    11         <varname>VM-name</varname> webcam detach</userinput>
    12         command.
    13       </p>
     7    <p>When the webcam device is detached from the host, the emulated webcam device remains attached to the guest and
     8      must be manually detached using the <userinput>VBoxManage controlvm <varname>VM-name</varname> webcam
     9        detach</userinput> command. </p>
    1410  </body>
    1511 

  • trunk/doc/manual/en_US/dita/topics/webcam-using-guest.dita

    r99797 r105335  
    55 
    66  <body>
    7     <p>
    8         <ph conkeyref="vbox-conkeyref-phrases/product-name"/> includes a feature called <i>webcam
    9         passthrough</i>, which enables a guest to use a host
    10         webcam. This complements the general USB passthrough support
    11         which was the typical way of using host webcams in legacy
    12         releases. The webcam passthrough support can handle non-USB
    13         video sources in theory, but this is completely untested.
    14       </p>
     7    <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> includes a feature called <i>webcam passthrough</i>, which
     8      enables a guest to use a host webcam. This complements the general USB passthrough support which was the typical
     9      way of using host webcams in legacy releases. The webcam passthrough support can handle non-USB video sources in
     10      theory, but this is completely untested. </p>
    1511    <note>
    16       <p>
    17           The webcam passthrough module is shipped as part of the
    18         <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/>, which must be installed
    19           separately. See <xref href="intro-installing.dita">Installing <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and Extension Packs</xref>.
    20         </p>
     12      <p>The webcam passthrough module is shipped as part of the <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/>,
     13        which must be installed separately. See <xref href="intro-installing.dita">Installing <ph
     14            conkeyref="vbox-conkeyref-phrases/product-name"/> and Extension Packs</xref>. </p>
    2115    </note>
    22     <p>
    23         The host webcam can be attached to the VM using the
    24         <b outputclass="bold">Devices</b> menu in the VM menu
    25         bar. The <b outputclass="bold">Webcams</b> menu contains
    26         a list of available video input devices on the host. Clicking on
    27         a webcam name attaches or detaches the corresponding host
    28         device.
    29       </p>
    30     <p>
    31         The <userinput>VBoxManage</userinput> command line tool can be used
    32         to enable webcam passthrough. Please see the host-specific
    33         sections below for additional details. The following commands
    34         are available:
    35       </p>
     16    <p>The host webcam can be attached to the VM using the <b outputclass="bold">Devices</b> menu in the VM menu bar.
     17      The <b outputclass="bold">Webcams</b> menu contains a list of available video input devices on the host. Clicking
     18      on a webcam name attaches or detaches the corresponding host device. </p>
     19    <p>The <userinput>VBoxManage</userinput> command line tool can be used to enable webcam passthrough. Please see the
     20      host-specific sections below for additional details. The following commands are available: </p>
    3621    <ul>
    3722      <li>
    38         <p>
    39             Get a list of host webcams, or other video input devices:
    40           </p>
     23        <p>Get a list of host webcams, or other video input devices: </p>
    4124        <pre xml:space="preserve">$ VBoxManage list webcams</pre>
    4225        <p>
    … …  
    4528        <pre xml:space="preserve">alias "user friendly name"
    4629host path or identifier</pre>
    47         <p>
    48             The alias can be used as a shortcut in other commands. Alias
    49             '.0' means the default video input device on the host. Alias
    50             '.1', '.2'means first, second video input device, and so on.
    51             The device order is host-specific.
    52           </p>
     30        <p>The alias can be used as a shortcut in other commands. Alias '.0' means the default video input device on the
     31          host. Alias '.1', '.2'means first, second video input device, and so on. The device order is host-specific. </p>
    5332      </li>
    5433      <li>
    55         <p>
    56             Attach a webcam to a running VM, as follows:
    57           </p>
     34        <p>Attach a webcam to a running VM, as follows: </p>
    5835        <pre xml:space="preserve">VBoxManage controlvm <varname>VM name</varname> webcam attach [<varname>host_path</varname>|<varname>alias</varname> [<varname>settings</varname>]]</pre>
    59         <p>
    60             This attaches a USB webcam device to the guest.
    61           </p>
    62         <p>
    63             The <codeph>settings</codeph> parameter is a string
    64             <codeph>Setting1=Value1;Setting2=Value2</codeph>, which
    65             enables you to configure the emulated webcam device. The
    66             following settings are supported:
    67           </p>
     36        <p>This attaches a USB webcam device to the guest. </p>
     37        <p>The <codeph>settings</codeph> parameter is a string <codeph>Setting1=Value1;Setting2=Value2</codeph>, which
     38          enables you to configure the emulated webcam device. The following settings are supported: </p>
    6839        <ul>
    6940          <li>
    … …  
    8960      </li>
    9061      <li>
    91         <p>
    92             Detach a webcam from a running VM, as follows:
    93           </p>
     62        <p>Detach a webcam from a running VM, as follows: </p>
    9463        <pre xml:space="preserve">VBoxManage controlvm <varname>VM-name</varname> webcam detach [<varname>host_path</varname>|<varname>alias</varname>]</pre>
    9564      </li>
    9665      <li>
    97         <p>
    98             List the webcams attached to a running VM, as follows:
    99           </p>
     66        <p>List the webcams attached to a running VM, as follows: </p>
    10067        <pre xml:space="preserve">VBoxManage controlvm <varname>VM-name</varname> webcam list</pre>
    101         <p>
    102             The output contains the path or alias which was used in the
    103             <userinput>webcam attach</userinput> command for each attached
    104             webcam.
    105           </p>
     68        <p>The output contains the path or alias which was used in the <userinput>webcam attach</userinput> command for
     69          each attached webcam. </p>
    10670      </li>
    10771    </ul>

  • trunk/doc/manual/en_US/dita/topics/webcam-win-hosts.dita

    r99016 r105335  
    55 
    66  <body>
    7     <p>
    8         When the webcam device is detached from the host, the emulated
    9         webcam device is automatically detached from the guest.
    10       </p>
     7    <p>When the webcam device is detached from the host, the emulated webcam device is automatically detached from the
     8      guest. </p>
    119  </body>
    1210 
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette