GET /api/v3/vms/actions/getremoteaccessfile

Get MSTSC (RDP) file for a specific VM.

Given a Windows VM, the request returns the content of an .rdp file, that on Windows machines (or Linux with FreeRDP, or Macs with Microsoft Remote Access) will open a remote desktop session to the given VM.

Request Path

GET /api/v3/vms/actions/getremoteaccessfile?vmId=VM123ABC&desktopWidth=1024&desktopHeight=768

Request Payload

None.

Parameters

vmID The VM to generate RDP file.
desktopHeight The height resolution of the remote access session.
desktopWidth The width resolution of the remote access session.

Response example

{
    "rdpFileContent": "username:s:shrpnt\\administrator\r\nfull address:s:uvo1wbqnjqlfnx40fhq.vm.cld.dev\r\ngatewayusagemethod:i:4\r\naudiomode:i:0\r\nredirectprinters:i:1\r\nredirectsmartcards:i:1\r\nredirectclipboard:i:1\r\nredirectposdevices:i:0\r\nredirectdirectx:i:1\r\nauthentication level:i:2\r\nprompt for credentials:i:0\r\nnegotiate security layer:i:1\r\ndisable menu anims:i:1\r\ndisable themes:i:0\r\ndisable cursor setting:i:0\r\nconnection type:i:2\r\ndisable wallpaper:i:1\r\nallow font smoothing:i:0\r\nallow desktop composition:i:0\r\nvideoplaybackmode:i:1\r\ncompression:i:1\r\nscreen mode id:i:2\r\ndesktopwidth:i:\r\ndesktopheight:i:\r\n",
    "clearTextPassword": "Jc9Rvp0093"
}

rdpFileContent is the content of .rdp file.
You can’t supply passwords in .rdp files, so the password is given in clearTextPassword.