KVM Virtualization: Start VNC Remote Access For Guest Operating Systems

Posted on in Categories , , , , last updated May 6, 2017

I‘m running a KVM virtual machine (FreeBSD 7 and Fedora Linux 13 desktop) under Redhat Enterprise Linux 5.5. However, I’m not getting the remote access via VNC (Virtual Network Computing) to access my Fedora Linux graphical desktop or FreeBSD console. How do I turn on VNC support without reinstalling both operating systems?

You need to attach your vncserver with the guest operating system console. This can be done using any one of the following method:

Method # 1: Command Line Option

Normally, QEMU (/usr/libexec/qemu-kvm) uses SDL to display the VGA output. With the -vnc option option, you can have QEMU listen on VNC display display and redirect the VGA display over the VNC session. When using the VNC display, you must use the -k parameter to set the keyboard layout if you are not using en-us. Valid syntax for the display is as follows:

-vnc :0
-vnc 192.168.1.5:0
-vnc 0.0.0.0:5
-vnc 0.0.0.0:1 -k en-us
####  Require that password based authentication is used for client connections ####
-vnc 0.0.0.0:1,password -k en-us

In the following example start centos1 guest vm using vnc

 /usr/libexec/qemu-kvm -S -M rhel5.4.0 -m 1024 -smp 1 -vnc 0.0.0.0:1 -k en-us -name centos1 -monitor pty -boot c -drive file=/var/lib/libvirt/images/centos1.img

Method # 2: qemu-kvm VM Config File (Recommended)

You need to edit your VM config file which is in XML format. The config file is located at /etc/libvirt/qemu directory. In this example, edit centos1.xml as follows:
# vi /etc/libvirt/qemu/centos1.xml
Append the following line before final </devices>:

 <graphics type='vnc' port='-1' autoport='yes' keymap='en-us'/>

Here is my sample config file:

<domain type='kvm'>
  <name>centos1</name>
  <uuid>88d067cf-e5f7-7229-f35f-472a9c884864</uuid>
  <memory>1048576</memory>
  <currentMemory>1048576</currentMemory>
  <vcpu>1</vcpu>
  <os>
    <type arch='x86_64' machine='rhel5.4.0'>hvm</type>
    <boot dev='hd'/>
  </os>
  <features>
    <acpi/>
    <apic/>
    <pae/>
  </features>
  <clock offset='utc'/>
  <on_poweroff>destroy</on_poweroff>
  <on_reboot>restart</on_reboot>
  <on_crash>restart</on_crash>
  <devices>
    <emulator>/usr/libexec/qemu-kvm</emulator>
    <disk type='file' device='disk'>
      <driver name='qemu' cache='none'/>
      <source file='/emc/vms/images/host302.f02.dc05.corplan.nixcraft.net.in/c/centos1.img'/>
      <target dev='vda' bus='virtio'/>
    </disk>
    <interface type='bridge'>
      <mac address='xx:yy:zz:ee:f4:63'/>
      <source bridge='br0'/>
      <model type='virtio'/>
    </interface>
    <interface type='bridge'>
      <mac address='54:52:xx:yy:zz:ee'/>
      <source bridge='br1'/>
      <model type='virtio'/>
    </interface>
    <serial type='pty'>
      <target port='0'/>
    </serial>
    <console type='pty'>
      <target port='0'/>
    </console>
    <graphics type='vnc' port='-1' autoport='yes' keymap='en-us'/>
  </devices>
</domain>

Finally, restart your libvirtd:
# /etc/init.d/libvirtd restart
# virsh shutdown centos1
# virsh start centos1

How Do I Use VNC Client?

Type your VNC (KVM) server ip and port:

Fig.01: Connecting to KVM Guest Using VNC Client
Fig.01: Connecting to KVM Guest Using VNC Client

Once connected you can view your desktop:
Fig.02: RHEL 6 Guest Beta Desktop Over VNC Session Running Under KVM
Fig.02: RHEL 6 Guest Beta Desktop Over VNC Session Running Under KVM

Make sure you browse the desktop using ssh tunnel or over some sort of VPN session.

How Do I Find Out Current VNC Setting For Any Given Domain / VM?

Type the following command:
# virsh vncdisplay domainName
# virsh vncdisplay 3
# virsh vncdisplay centos1

Sample outputs:

:2

How Do I Password Protect My VNC Session?

The passwd attribute provides a VNC password in clear text (so make sure your xml config file is only readable by root user). Edit centos1.xml file as follows:

 <graphics type='vnc' port='-1' autoport='yes' passwd='YOUR-PASSWORD-HERE' keymap='en-us'/>

OR

 <graphics type='vnc' port='-1' autoport='yes' listen='192.168.1.5' passwd='YOUR-PASSWORD-HERE' keymap='en-us'/>

Where,

  • type=’vnc’: The graphics element has a mandatory type attribute which takes the value “sdl”, “vnc”, “rdp” or “desktop”. In this case it is set to VNC for remote access.
  • autoport=’yes’: The autoport attribute is the new preferred syntax for indicating autoallocation of the TCP port to use.
  • passwd=’YOUR-PASSWORD-HERE’: The passwd attribute provides a VNC password in clear text.
  • keymap=’en-us’: The keymap attribute specifies the keymap to use.
  • listen=’192.168.1.5′: The listen attribute is an IP address for the server to listen on.

Save and close the file. Restart services as follows:
# /etc/init.d/libvirtd restart
# virsh start centos1

This entry is 14 of 14 in the CentOS / Redhat (RHEL) KVM Virtulization series. Keep reading the rest of the series:
  1. CentOS / Redhat: Install KVM Virtualization Software
  2. CentOS / Redhat: KVM Bridged Network Configuration
  3. KVM virt-manager: Install CentOS As Guest Operating System
  4. KVM virt-install: Install FreeBSD / CentOS As Guest Operating System
  5. KVM: Install CentOS / RHEL Using Kickstart File (Automated Installation)
  6. Troubleshooting KVM Virtualization Problem With Log Files
  7. KVM Virsh: Redirect FreeBSD Console To A Serial Port
  8. KVM: Starting / Stopping Guest Operating Systems With virsh Command
  9. Linux KVM: Disable virbr0 NAT Interface
  10. FreeBSD / OpeBSD Running in KVM Does Not Accept FTP Traffic
  11. KVM: Start a Virtual Machine / Guest At Boot Time
  12. KVM virt-install: Install OpenBSD As Guest Operating System
  13. Linux KVM: OpenBSD Guest Hangs At Starting tty Flags
  14. KVM Virtualization: Start VNC Remote Access For Guest Operating Systems

Posted by: Vivek Gite

The author is the creator of nixCraft and a seasoned sysadmin and a trainer for the Linux operating system/Unix shell scripting. He has worked with global clients and in various industries, including IT, education, defense and space research, and the nonprofit sector. Follow him on Twitter, Facebook, Google+.

16 comment

  1. Would love to see someone tackle using PCI passthrough with a KVM instance. I’m having a really difficult time getting it to work and would love to know if I’m doing something wrong or trying to get a card that just doesn’t want to work with KVM going.

  2. Thanks for the write up. This _almost_ works for me. When I connect, I get the VNC window open, but it immediately closes. The VNC client process has terminated or died or exited cleanly…I don’t know. I don’t get an opportunity to enter the password or anything.
    I am using RealVNC client and connecting via an SSH tunnel (socks 5 proxy through a jump host). I know the SSH config works fine with RealVNC because I can connect to a Mac on the same network.
    Any ideas?

    1. Hello Jeff, i have the exact same problem :-( VNC connects, i can see the window for less than one second and then the connection is closed again. Did you already find a solution? I’ll continue searching and post any possible solutions here.

  3. Thanks for the tutorial, it was helpful, though it’s still not working for me.

    I got KVM’s VNC server running alright with both methods above, however my mouse is not synchronized with the virtual machine mouse. It makes it virtually impossible to use it because as soon as my physical cursor leaves the VNC window, my VNC client stops sending its location to the VNC server. Full screen behaves much the same way as well. All VNC clients here seem to have this problem.

    So far I have found no solution for this. Some forums say adding “-usbdevice tablet” to the QEMU command line, however best I can tell this does one thing and one thing only: disable the mouse. Granted my guest OS is not Linux, but I see even you have this problem on your screenshot.

    How do you solve this problem?

Leave a Comment