| 1 | <?xml version='1.0' encoding='UTF-8'?>
|
|---|
| 2 | <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
|
|---|
| 3 | <topic xml:lang="en-us" id="vrde">
|
|---|
| 4 | <title>Remote Display (VRDP Support)</title>
|
|---|
| 5 |
|
|---|
| 6 | <body>
|
|---|
| 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
|
|---|
| 12 | <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package only provides this interface, while
|
|---|
| 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 conkeyref="vbox-conkeyref-phrases/product-name"/> extension package.</p>
|
|---|
| 18 | <p>VRDP is a backward-compatible extension to Microsoft's Remote Desktop Protocol (RDP). As a result, you can use any standard RDP client to control the remote VM.</p>
|
|---|
| 19 | <p>Even when the extension is installed, the VRDP server is disabled by default. It can easily be enabled on a
|
|---|
| 20 | per-VM basis either from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> in the <b outputclass="bold"
|
|---|
| 21 | >Display</b> settings, see <xref href="settings-display.dita">Display Settings</xref>, or with the
|
|---|
| 22 | <userinput>VBoxManage</userinput> command, as follows: </p>
|
|---|
| 23 | <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --vrde on</pre>
|
|---|
| 24 | <p>The RDP server in the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> extension pack supports only audio streams in format 22.05kHz stereo 16-bit. If the RDP client requests any other audio format there will be no audio.</p>
|
|---|
| 25 | <p>By default, the VRDP server uses TCP port <codeph>3389</codeph>. You will need to change the default port if you run more than one VRDP server, since the port can only be used by one server at a time. You might also need to change it on Windows hosts since the default port might already be used by the RDP server that is built into Windows itself. Ports 5000 through 5050 are typically not used and might be a good choice.</p>
|
|---|
| 26 | <p>The port can be changed either in the <b outputclass="bold">Display</b> settings of the graphical user interface or with the <codeph>--vrde-port</codeph> option of the <userinput>VBoxManage modifyvm</userinput> command. You can specify a comma-separated list of ports or ranges of ports. Use a dash between two port numbers to specify a range. The VRDP server will bind to <i>one</i> of the available ports from the specified list. For example, <userinput>VBoxManage modifyvm <varname>VM-name</varname> --vrde-port 5000,5010-5012</userinput> configures the server to bind to one of the ports 5000, 5010, 5011, or 5012. See <xref href="../cli_topics/vboxmanage-modifyvm.dita"/>.</p>
|
|---|
| 27 | <p>The actual port used by a running VM can be either queried with the <userinput>VBoxManage showvminfo</userinput>
|
|---|
| 28 | command or seen in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> on the <b outputclass="bold">Runtime</b> tab
|
|---|
| 29 | of the <b outputclass="bold">Session Information</b> dialog, which is accessible from the <b outputclass="bold"
|
|---|
| 30 | >Machine</b> menu of the VM window. </p>
|
|---|
| 31 | <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports IPv6. If the host OS supports IPv6 the VRDP server will automatically listen for IPv6 connections in addition to IPv4.</p>
|
|---|
| 32 | </body>
|
|---|
| 33 | </topic>
|
|---|
