| 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>
|
|---|
| 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
|
|---|
| 18 | <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>
|
|---|
| 29 | VRDP is a backwards-compatible extension to Microsoft's Remote
|
|---|
| 30 | Desktop Protocol (RDP). As a result, you can use any standard RDP
|
|---|
| 31 | client to control the remote VM.
|
|---|
| 32 | </p>
|
|---|
| 33 | <p>
|
|---|
| 34 | Even when the extension is installed, the VRDP server is disabled
|
|---|
| 35 | by default. It can easily be enabled on a per-VM basis either from
|
|---|
| 36 | <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> in the <b outputclass="bold">Display</b>
|
|---|
| 37 | settings, see <xref href="settings-display.dita">Display Settings</xref>, or with the
|
|---|
| 38 | <userinput>VBoxManage</userinput> command, as follows:
|
|---|
| 39 | </p>
|
|---|
| 40 | <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --vrde on</pre>
|
|---|
| 41 | <p>
|
|---|
| 42 | By default, the VRDP server uses TCP port <codeph>3389</codeph>.
|
|---|
| 43 | You will need to change the default port if you run more than one
|
|---|
| 44 | VRDP server, since the port can only be used by one server at a
|
|---|
| 45 | time. You might also need to change it on Windows hosts since the
|
|---|
| 46 | default port might already be used by the RDP server that is built
|
|---|
| 47 | into Windows itself. Ports 5000 through 5050 are typically not
|
|---|
| 48 | used and might be a good choice.
|
|---|
| 49 | </p>
|
|---|
| 50 | <p>
|
|---|
| 51 | The port can be changed either in the
|
|---|
| 52 | <b outputclass="bold">Display</b> settings of the graphical
|
|---|
| 53 | user interface or with the <codeph>--vrde-port</codeph> option of
|
|---|
| 54 | the <userinput>VBoxManage modifyvm</userinput> command. You can
|
|---|
| 55 | specify a comma-separated list of ports or ranges of ports. Use a
|
|---|
| 56 | dash between two port numbers to specify a range. The VRDP server
|
|---|
| 57 | will bind to <i>one</i> of the available ports from
|
|---|
| 58 | the specified list. For example, <userinput>VBoxManage modifyvm
|
|---|
| 59 | <varname>VM-name</varname> --vrde-port
|
|---|
| 60 | 5000,5010-5012</userinput> configures the server to bind to one of
|
|---|
| 61 | the ports 5000, 5010, 5011, or 5012. See
|
|---|
| 62 | <xref href="vboxmanage-modifyvm.dita">VBoxManage modifyvm</xref>.
|
|---|
| 63 | </p>
|
|---|
| 64 | <p>
|
|---|
| 65 | The actual port used by a running VM can be either queried with
|
|---|
| 66 | the <userinput>VBoxManage showvminfo</userinput> command or seen in
|
|---|
| 67 | <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> on the <b outputclass="bold">Runtime</b> tab of
|
|---|
| 68 | the <b outputclass="bold">Session Information</b> dialog,
|
|---|
| 69 | which is accessible from the
|
|---|
| 70 | <b outputclass="bold">Machine</b> menu of the VM window.
|
|---|
| 71 | </p>
|
|---|
| 72 | <p>
|
|---|
| 73 | <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports IPv6. If the host OS supports IPv6 the
|
|---|
| 74 | VRDP server will automatically listen for IPv6 connections in
|
|---|
| 75 | addition to IPv4.
|
|---|
| 76 | </p>
|
|---|
| 77 | </body>
|
|---|
| 78 | </topic>
|
|---|
