Nova currently provides support for VNC and SPICE graphical consoles. VNC in particular is the protocol employed natively by most popular hypervisors supported by Nova. Microsoft Hyper-V in this context is a remarkable exception, as it employs Remote Desktop Protocol (RDP) for graphical console access, based on Open Specifications.

Nova includes internally the required proxy solutions for VNC (novnc, xvpvnc) and SPICE, but this is not the case for RDP. Beside that, it's also desirable to leave third party the ability to choose a custom graphical console UI solution not necessarily included with Nova. In order to allow external tools to access graphical console protocol connection details, a public API has been provided.

Normal Response Code(s): 200

Error Response Code(s): badRequest (400), unauthorized (401), itemNotFound (404)

<?xml version="1.0" encoding="UTF-8"?>
<os-getConsoleConnectInfo/>

{
    "os-getConsoleConnectInfo": null
}

<?xml version='1.0' encoding='UTF-8'?>
<console>
    <instance_uuid>b48316c5-71e8-45e4-9884-6c78055b9b13</instance_uuid>
    <host>localhost</host>
    <port>3389</port>
    <internal_access_path>51af38c3-555e-4884-a314-6c8cdde37444</internal_access_path>
</console>

 {
    "console": {
        "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
        "host": "localhost",
        "port": 3389,
        "internal_access_path": "51af38c3-555e-4884-a314-6c8cdde37444"
    }
} 

Normal Response Code(s): 200

Error Response Code(s): badRequest (400), unauthorized (401), itemNotFound (404)

<?xml version="1.0" encoding="UTF-8"?>
<get_console_connect_info/>

{
    "get_console_connect_info": null
}

Same output as in the V2 API example

Same output as in the V2 API example