VIRT-VIEWER

Section: User Contributed Perl Documentation (1)
Updated: 2012-06-22
Index Return to Main Contents

NAME

virt-viewer - display the graphical console for a virtual machine

SYNOPSIS

virt-viewer [OPTIONS] DOMAIN-NAME|ID|UUID

DESCRIPTION

virt-viewer is a minimal tool for displaying the graphical console of a virtual machine. The console is accessed using the VNC or SPICE protocol. The guest can be referred to based on its name, ID, or UUID. If the guest is not already running, then the viewer can be told to wait until is starts before attempting to connect to the console The viewer can connect to remote hosts to lookup the console information and then also connect to the remote console using the same network transport.

OPTIONS

The following options are accepted when running "virt-viewer":

-h, --help: Display command line help summary
-V, --version: Display program version number
-v, --verbose: Display information about the connection
-c URI, --connect=URI: Specify the hypervisor connection URI
-w, --wait: Wait for the domain to start up before attempting to connect to the console
-r, --reconnect: Automatically reconnect to the domain if it shuts down and restarts
-z PCT, --zoom=PCT: Zoom level of the display window in percentage. Range 10-200.
-d, --direct: Do not attempt to tunnel the console over SSH, even if the main connection URI used SSH.
-a, --attach: Use libvirt to directly attach to a local display, instead of making a TCP/UNIX socket connection. This avoids the need to authentication with the remote display, if authentication with libvirt is already allowed. This option does not work with remote displays.
-f, --full-screen: Start with the window maximised to fullscreen
--debug: Print debugging information

EXAMPLES

To connect to the guest called 'demo' running under Xen

   virt-viewer demo

To connect to the guest with ID 7 running under QEMU

   virt-viewer --connect qemu:///system 7

To wait for the guest with UUID 66ab33c0-6919-a3f7-e659-16c82d248521 to startup and then connect, also reconnecting upon restart of VM

   virt-viewer --reconnect --wait 66ab33c0-6919-a3f7-e659-16c82d248521

To connect to a remote console using TLS

   virt-viewer --connect xen://example.org/ demo

To connect to a remote host using SSH, lookup the guest config and then make a direct non-tunnelled connection of the console

   virt-viewer --direct --connect xen+ssh://root@example.org/ demo

AUTHOR

Written by Daniel P. Berrange, based on the GTK-VNC example program gvncviewer.

BUGS

Report bugs to the mailing list "http://www.redhat.com/mailman/listinfo/virt-tools-list"

COPYRIGHT

Copyright (C) 2007-2008 Red Hat, Inc., and various contributors. This is free software. You may redistribute copies of it under the terms of the GNU General Public License "http://www.gnu.org/licenses/gpl.html". There is NO WARRANTY, to the extent permitted by law.

This document was created by man2html, using the manual pages.
Time: 05:29:12 GMT, December 24, 2015