graphicsgraphics element has a mandatory type
- attribute which takes the value "sdl", "vnc", "spice", "rdp" or
- "desktop":
+
+ The graphics element has a mandatory type
+ attribute which takes the value sdl, vnc,
+ spice, rdp or desktop:
+
"sdl"display attribute for
- the display to use, an xauth attribute for
- the authentication identifier, and an
- optional fullscreen attribute accepting
- values 'yes' or 'no'.
+
+ This displays a window on the host desktop, it can take 3 optional
+ arguments: a display attribute for the display to use,
+ an xauth attribute for the authentication identifier,
+ and an optional fullscreen attribute accepting values
+ yes or no.
+
"vnc"port attribute
- specifies the TCP port number (with -1 as legacy syntax
- indicating that it should be
- auto-allocated). The autoport attribute is
- the new preferred syntax for indicating autoallocation of
- the TCP port to use. The listen attribute is
- an IP address for the server to listen
- on. The passwd attribute provides a VNC
- password in clear text. The keymap attribute
- specifies the keymap to use. It is possible to set a limit
- on the validity of the password be giving an
- timestamp passwdValidTo='2010-04-09T15:51:00'
- assumed to be in UTC. The connected attribute
- allows control of connected client during password changes.
- VNC accepts keep value only.
- since 0.9.3
- NB, this may not be supported by all hypervisors.sharePolicy attribute specifies vnc server
- display sharing policy. "allow-exclusive" allows clients to ask
- for exclusive access by dropping other connections. Connecting
- multiple clients in parallel requires all clients asking for a
- shared session (vncviewer: -Shared switch). This is the default
- value. "force-shared" disables exclusive client access, every
- connection has to specify -Shared switch for vncviewer. "ignore"
- welcomes every connection unconditionally
- since 1.0.6. socket attribute for listening on a unix
- domain socket path.Since 0.8.8
-
- For VNC WebSocket functionality, websocket
- attribute may be used to specify port to listen on (with
- -1 meaning auto-allocation and autoport
- having no effect due to security reasons).
- Since 1.0.6
- "spice"
- Starts a SPICE server. The port attribute
- specifies the TCP port number (with -1 as legacy syntax
- indicating that it should be auto-allocated),
- while tlsPort gives an alternative secure
- port number. The autoport attribute is the
- new preferred syntax for indicating autoallocation of
- needed port numbers. The listen attribute is
- an IP address for the server to listen
- on. The passwd attribute provides a SPICE
- password in clear text. The keymap
- attribute specifies the keymap to use. It is possible to
- set a limit on the validity of the password be giving an
- timestamp passwdValidTo='2010-04-09T15:51:00'
- assumed to be in UTC. The connected attribute
- allows control of connected client during password changes.
- SPICE accepts keep to keep client connected,
- disconnect to disconnect client and
- fail to fail changing password.
- Since 0.9.3
+ Starts a VNC server. The port attribute specifies
+ the TCP port number (with -1 as legacy syntax indicating that it
+ should be auto-allocated). The autoport attribute is
+ the new preferred syntax for indicating auto-allocation of the TCP
+ port to use. The listen attribute is an IP address
+ for the server to listen on. The passwd attribute
+ provides a VNC password in clear text. The keymap
+ attribute specifies the keymap to use. It is possible to set
+ a limit on the validity of the password by giving an timestamp
+ passwdValidTo='2010-04-09T15:51:00' assumed to be
+ in UTC. The connected attribute allows control of
+ connected client during password changes. VNC accepts
+ keep value only since 0.9.3.
NB, this may not be supported by all hypervisors.
- "spice" since 0.8.6.
- The defaultMode attribute sets the default channel
- security policy, valid values are secure,
- insecure and the default any
- (which is secure if possible, but falls back to insecure
- rather than erroring out if no secure path is
- available). "defaultMode" since
- 0.9.12.
- When SPICE has both a normal and TLS secured TCP port
- configured, it can be desirable to restrict what
- channels can be run on each port. This is achieved by
- adding one or more <channel> elements inside the
- main <graphics> element and setting the mode
- attribute to either secure or insecure.
- Setting the mode attribute overrides the default value as set
- by the defaultMode attribute. (Note that specifying
+ The optional sharePolicy attribute specifies vnc
+ server display sharing policy. allow-exclusive allows
+ clients to ask for exclusive access by dropping other connections.
+ Connecting multiple clients in parallel requires all clients asking
+ for a shared session (vncviewer: -Shared switch). This is
+ the default value. force-shared disables exclusive
+ client access, every connection has to specify -Shared switch for
+ vncviewer. ignore welcomes every connection
+ unconditionally since 1.0.6.
+
+ Rather than using listen/port, QEMU supports a socket
+ attribute for listening on a unix domain socket path
+ Since 0.8.8.
+
+ For VNC WebSocket functionality, websocket attribute
+ may be used to specify port to listen on (with -1 meaning
+ auto-allocation and autoport having no effect due to
+ security reasons) Since 1.0.6.
+
"spice" Since 0.8.6
+ Starts a SPICE server. The port attribute specifies
+ the TCP port number (with -1 as legacy syntax indicating that it
+ should be auto-allocated), while tlsPort gives
+ an alternative secure port number. The autoport
+ attribute is the new preferred syntax for indicating
+ auto-allocation of needed port numbers. The listen
+ attribute is an IP address for the server to listen on.
+ The passwd attribute provides a SPICE password in
+ clear text. The keymap attribute specifies the keymap
+ to use. It is possible to set a limit on the validity of
+ the password by giving an timestamp
+ passwdValidTo='2010-04-09T15:51:00' assumed to be in
+ UTC.
+
+ The connected attribute allows control of connected
+ client during password changes. SPICE accepts keep to
+ keep client connected, disconnect to disconnect client
+ and fail to fail changing password . NB, this may not
+ be supported by all hypervisors.
+ Since 0.9.3
+
+ The defaultMode attribute sets the default channel
+ security policy, valid values are secure,
+ insecure and the default any (which is
+ secure if possible, but falls back to insecure rather than erroring
+ out if no secure path is available).
+ Since 0.9.12
+
+ When SPICE has both a normal and TLS secured TCP port configured,
+ it can be desirable to restrict what channels can be run on each
+ port. This is achieved by adding one or more <channel>
+ elements inside the main <graphics>
+ element and setting the mode attribute to either
+ secure or insecure. Setting the mode
+ attribute overrides the default value as set by
+ the defaultMode attribute. (Note that specifying
any as mode discards the entry as the channel would
- inherit the default mode anyways)
- Valid channel names
- include main, display,
- inputs, cursor,
- playback, record
+ inherit the default mode anyways.) Valid channel names include
+ main, display, inputs,
+ cursor, playback, record
(all since 0.8.6);
- smartcard (since
- 0.8.8); and usbredir
- (since 0.9.12).
+ smartcard (since 0.8.8);
+ and usbredir (since 0.9.12).
<graphics type='spice' port='-1' tlsPort='-1' autoport='yes'>
@@ -5058,131 +5063,113 @@ qemu-kvm -net nic,model=? /dev/null
<gl enable='yes'/>
</graphics>
- Spice supports variable compression settings for audio,
- images and streaming, since
- 0.9.1. These settings are accessible via
- the compression attribute in all following
- elements: image to set image compression
- (accepts auto_glz, auto_lz,
- quic, glz, lz,
- off), jpeg for JPEG
- compression for images over wan
- (accepts auto, never,
- always), zlib for configuring
- wan image compression (accepts auto,
- never, always)
- and playback for enabling audio stream
- compression (accepts on or off).
+ Spice supports variable compression settings for audio, images and
+ streaming. These settings are accessible via the compression
+ attribute in all following elements: image to
+ set image compression (accepts auto_glz,
+ auto_lz, quic, glz,
+ lz, off), jpeg for JPEG
+ compression for images over wan (accepts auto,
+ never, always), zlib for
+ configuring wan image compression (accepts auto,
+ never, always) and playback
+ for enabling audio stream compression (accepts on or
+ off). Since 0.9.1
- Streaming mode is set by the streaming
- element, settings its mode attribute to one
- of filter, all
- or off, since 0.9.2.
+ Streaming mode is set by the streaming element,
+ settings its mode attribute to one of
+ filter, all or off.
+ Since 0.9.2
- Copy & Paste functionality (via Spice agent) is set
- by the clipboard element. It is enabled by
- default, and can be disabled by setting
- the copypaste property
- to no, since
- 0.9.3.
+ Copy & Paste functionality (via Spice agent) is set by the
+ clipboard element. It is enabled by default, and can
+ be disabled by setting the copypaste property to
+ no. Since 0.9.3
- Mouse mode is set by the mouse element,
- setting its mode attribute to one of
- server or client ,
- since 0.9.11. If no mode is
- specified, the qemu default will be used (client mode).
+ Mouse mode is set by the mouse element, setting its
+ mode attribute to one of server or
+ client. If no mode is specified, the qemu default will
+ be used (client mode). Since 0.9.11
File transfer functionality (via Spice agent) is set using the
- filetransfer element.
- It is enabled by default, and can be disabled by setting the
- enable property to no ,
- since since 1.2.2.
+ filetransfer element. It is enabled by default, and
+ can be disabled by setting the enable property to
+ no. Since 1.2.2
- Spice may provide accelerated server-side rendering with
- OpenGL. You can enable or disable OpenGL support explicitly with
- the gl element, by setting the
- enable property. (QEMU
- only, since 1.3.2).
+ Spice may provide accelerated server-side rendering with OpenGL.
+ You can enable or disable OpenGL support explicitly with
+ the gl element, by setting the enable
+ property. (QEMU only, since 1.3.2).
"rdp"port attribute
- specifies the TCP port number (with -1 as legacy syntax
- indicating that it should be
- auto-allocated). The autoport attribute is
- the new preferred syntax for indicating autoallocation of
- the TCP port to use. The replaceUser
- attribute is a boolean deciding whether multiple
- simultaneous connections to the VM are permitted.
- The multiUser attribute is a boolean deciding
- whether the existing connection must be dropped and a new
- connection must be established by the VRDP server, when a
- new client connects in single connection mode.
+
+ Starts a RDP server. The port attribute specifies the
+ TCP port number (with -1 as legacy syntax indicating that it should
+ be auto-allocated). The autoport attribute is the new
+ preferred syntax for indicating auto-allocation of the TCP port to
+ use. The replaceUser attribute is a boolean deciding
+ whether multiple simultaneous connections to the VM are permitted.
+ The multiUser attribute is a boolean deciding whether
+ the existing connection must be dropped and a new connection must
+ be established by the VRDP server, when a new client connects in
+ single connection mode.
+
"desktop"display
- and fullscreen.
+
+ This value is reserved for VirtualBox domains for the moment. It
+ displays a window on the host desktop, similarly to "sdl", but
+ using the VirtualBox viewer. Just like "sdl", it accepts
+ the optional attributes display and
+ fullscreen.
+
- Rather than putting the address information used to set up the
- listening socket for graphics types vnc
- and spice in
- the <graphics> listen attribute,
- a separate subelement of <graphics>,
- called <listen> can be specified (see the
- examples above)since
- 0.9.4. <listen> accepts the following
- attributes:
+ Graphics device uses a <listen> to set up where
+ the device should listen for clients. It has a mandatory attribute
+ type which specifies the listen type. Only vnc,
+ spice and rdp supports <listen>
+ element. Since 0.9.4.
+ Available types are:
typeaddress
- or network. This tells whether this listen
- element is specifying the address to be used directly, or by
- naming a network (which will then be used to determine an
- appropriate address for listening).
- addresstype='address', the address
- attribute will contain either an IP address or hostname (which
- will be resolved to an IP address via a DNS query) to listen
- on. In the "live" XML of a running domain, this attribute will
- be set to the IP address used for listening, even
- if type='network'.
+
+ Tells a graphics device to use an address specified in the
+ address attribute, which will contain either an IP address
+ or hostname (which will be resolved to an IP address via a DNS query)
+ to listen on.
+
networktype='network', the network
- attribute will contain the name of a network in libvirt's list
- of configured networks. The named network configuration will
- be examined to determine an appropriate listen address. For
- example, if the network has an IPv4 address in its
- configuration (e.g. if it has a forward type
- of route, nat, or no forward type
- (isolated)), the first IPv4 address listed in the network's
- configuration will be used. If the network is describing a
- host bridge, the first IPv4 address associated with that
- bridge device will be used, and if the network is describing
- one of the 'direct' (macvtap) modes, the first IPv4 address of
- the first forward dev will be used.
+
+ This is used to specify an existing network in the network
+ attribute from libvirt's list of configured networks. The named network
+ configuration will be examined to determine an appropriate listen
+ address and the address will be stored in live XML in address
+ attribute. For example, if the network has an IPv4 address in
+ its configuration (e.g. if it has a forward type of route,
+ nat, or no forward type (isolated)), the first IPv4
+ address listed in the network's configuration will be used.
+ If the network is describing a host bridge, the first IPv4 address
+ associated with that bridge device will be used, and if the network is
+ describing one of the 'direct' (macvtap) modes, the first IPv4 address
+ of the first forward dev will be used.
+