| We moved this page to our Documentation Portal. You can find the latest updates here. |
Question
How can I use my own VNC client with OnApp VMs?
Environment
OnApp 2.x,3.x, 4x, 5x
Answer
To use an alternate VNC, you will need to use API calls to retrieve the needed info. You can use the VMs' identifier in place of the ID (identifier given in URL after /virtual_machines/)
These are the API calls:
GET /virtual_machines/:virtual_machine_id/console.xml GET /virtual_machines/:id.xml
The first will start the console session and give you the port number to connect to. The second call - you are looking for remote_access_password.
Then, the VNC settings for the VM would be:
host - OnApp Control Panel IP port - given by console.xml password - use remote_access_password
GET calls to the API can be entered as URLs in a browser. There are also JSON variants of these calls.
For the 5.0 version of OnApp, the API calls are:
https://docs.onapp.com/display/50API/Open+VS+Console
https://docs.onapp.com/display/50API/Get+VS+Details
You are looking for this field for the remote access password.
remote_access_password — the password for the remote access