Example¶

Opening a file with the following content will start remote-viewer in fullscreen and connect to the host "betsiboka" using the SPICE protocol:

 [virt-viewer]
 type=spice
 host=betsiboka
 port=5900
 fullscreen=1

Key list¶

"version" (string)

If remote-viewer version number isn't greater or equal to the required version, an error is raised with the expected version.

The version format accepted is a list of integers separated by '.'. It can be followed by a dash '-' and an additional build number with the same format.

Version comparison is done by comparing each integer from the list one by one. If any of the component is not a number, the version comparison will fail and consider that the 2 versions are considered to be the same.

"versions" (osid:version list)

This is a list of osid:version couples separated by ';'. osid is an arbitrary string, version is a version number in the same format as in the 'version' field. A given couple indicates that remote-viewer builds matching the given 'osid' (fedora22, debian7, ...) must be at least version 'version'. For consistency, it's recommended to use libosinfo OS shortids as the osid.

"newer-version-url" (string)

If specified, this field is an URL which will be displayed to the user when a version check fails.

"type" (string, mandatory)

The session type, either "spice", "vnc" or "ovirt".

"host" (string, mandatory)

The server host to connect to.

"port" (integer)

The server port to connect to.

"tls-port" (integer)

The server TLS/SSL port to connect to.

"username" (string)

The username for the session authentication.

"password" (string)

The password for the session authentication.

"disable-channels" (string list)

The list of session channels to disable.

The current SPICE channels are: main, display, inputs, cursor, playback, record, smartcard, usbredir.

"tls-ciphers" (string)

Set the cipher list to use for the secure connection, in textual OpenSSL cipher list format. (see ciphers(1))

"title" (string)

String to present in the window title.

"fullscreen" (boolean)

Opens the client windows in fullscreen.

"ca" (string)

CA certificate in PEM format (using "\n" to separate the lines). This will be used to verify the SSL certificate used for SPICE TLS sessions.

"host-subject" (string)

Verify the certificate subject matches with the given subject.

"toggle-fullscreen" (hotkey string)

Key binding for entering and leaving fullscreen mode. (see HOTKEY for description of expected string)

"release-cursor" (hotkey string)

Key binding for releasing cursor grab. (see HOTKEY for description of expected string)

"smartcard-insert" (hotkey string)

Key binding for inserting emulated smartcard. (see HOTKEY for description of expected string)

"smartcard-remove" (hotkey string)

Key binding for removing emulated smartcard. (see HOTKEY for description of expected string)

"color-depth" (integer)

Set the color depth of the guest display (16 or 32).

"disable-effects" (string list)

A list of desktop effects to disable in the remote guest.

The effects that can be disabled with SPICE are: wallpaper, font-smooth, animation or all.

"enable-smartcard" (boolean)

Set to 1 to enable client smartcard redirection.

"enable-usbredir" (boolean)

Set to 1 to enable client USB device redirection.

"enable-usb-autoshare" (boolean)

Set to 1 to enable client USB devices auto-sharing.

"usb-filter" (string)

Set a string specifying a filter to use to determine which USB devices to autoconnect when plugged in, a filter consists of one or more rules. Where each rule has the form of:

"class,vendor,product,version,allow"

Use -1 for class/vendor/product/version to accept any value.

And the rules themselves are concatenated like this:

"rule1|rule2|rule3"

"secure-channels" (string list)

The list of session channels to secure.

The current SPICE channels are: main, display, inputs, cursor, playback, record, smartcard, usbredir.

"delete-this-file" (boolean)

Set to 1 for the client to remove this connection file (if it can't, it will fail silently)

"proxy" (string)

A proxy URL to tunnel the connection through.

At the time of writing this documentation, the only supported proxy method with Spice is HTTP CONNECT.

For example, to tunnel connection through foobar host HTTP proxy on port 8080, use the value "http://foobar:8080".

oVirt Support¶

The connection file can also carry some oVirt-specific options when oVirt support is compiled in. These options are used to interact with oVirt REST API. This is currently only used in order to show a menu allowing to change the CD image being used by the virtual machine from remote-viewer user interface. These options go in an optional [ovirt] group.

"host" (string, mandatory)

The oVirt instance to connect to. This corresponds to the hostname one would connect to access the oVirt user or admin portal.

"vm-guid" (string, mandatory)

GUID of the oVirt virtual machine to connect to.

"jsessionid" (string)

Value to set the 'jsessionid' cookie to. Setting this authentication cookie to a valid value will allow to interact with the oVirt REST API without being asked for credentials.

"ca" (string)

CA certificate in PEM format (using "\n" to separate the lines). This will be used to validate the certificate used for the oVirt REST https session remote-viewer will establish.