summaryrefslogtreecommitdiff
path: root/devdocs/vagrant/cli%2Frdp.html
blob: 9fef162729f7eb60c5efcd905e63a34641b05744 (plain)
1
2
3
4
5
6
7
8
9
10
<h1 id="rdp">  RDP </h1> <p><strong>Command: <code>vagrant rdp</code></strong></p> <p>This will start an RDP client for a remote desktop session with the guest. This only works for Vagrant environments that support remote desktop, which is typically only Windows.</p> <h2 id="raw-arguments">  Raw Arguments </h2> <p>You can pass raw arguments through to your RDP client on the command-line by appending it after a <code>--</code>. Vagrant just passes these through. For example:</p> <div class="highlight"><pre class="highlight plaintext">$ vagrant rdp -- /span
</pre></div>
<p>The above command on Windows will execute <code>mstsc.exe /span config.rdp</code>, allowing your RDP to span multiple desktops.</p> <p>On Darwin hosts, such as Mac OS X, the additional arguments are added to the generated RDP configuration file. Since these files can contain multiple options with different spacing, you <em>must</em> quote multiple arguments. For example:</p> <div class="highlight"><pre class="highlight plaintext">$ vagrant rdp -- "screen mode id:i:0" "other config:s:value"
</pre></div>
<p>Note that as of the publishing of this guide, the Microsoft RDP Client for Mac does <em>not</em> perform validation on the configuration file. This means if you specify an invalid configuration option or make a typographical error, the client will silently ignore the error and continue!</p><div class="_attribution">
  <p class="_attribution-p">
    &copy; 2010&ndash;2018 Mitchell Hashimoto<br>Licensed under the MPL 2.0 License.<br>
    <a href="https://www.vagrantup.com/docs/cli/rdp.html" class="_attribution-link">https://www.vagrantup.com/docs/cli/rdp.html</a>
  </p>
</div>