libvirt-tck man page

libvirt-tck — libvirt Technology Compatability Kit


 # libvirt-tck [OPTIONS]

Run with default config, probing for URI to use

 # libvirt-tck

Run with a custom config

 # libvirt-tck --config /etc/libvirt/other.cfg

Run with verbose progress information

 # libvirt-tck -v

Generate a formal XML document of results

 # libvirt-tck --format xml


The "libvirt-tck" (libvirt Technology Compatability Kit) command provides the primary mechanism to run the functional, integration test suite for libvirt drivers.


There now follows a few words of warning

The test suite needs to have a completely 'clean' initial starting state. If your host already has virtual machines defined and/or running this will cause problems. The test suite will detect this and refuse to run, allowing you to remove any preexisting guests. Alternatively you can pass the --force option and libvirt will DELETE EVERYTHING it finds.


The warning is now complete, continue reading


If invoked without any arguments the test suite will run using the default configuration file from "/etc/libvirt-tck/default.cfg" and will allow libvirt to probe for the hypervisor driver to run. If a reliably repeatable test result set is desired, it is recommended to always give an explicit libvirt connection URI to choose the driver. The following options are available when running the "libvirt-tck" command

-v, --verbose

Display fine details of individual test progresss. Without this only the name of each test will be printed, along with details of failures.

-q, --quiet

Do not display any information about test progress, not even the name of each test case

-c, --config FILE

Specify the name of the configuration file to use, rather than the default "/etc/libvirt-tck/default.cfg"

--format text|html|xml

Choose the output format for the test results. The default format is "text", producing human readable results on the console. The "html" option dumps an HTML file of results to STDOUT, while the "xml" option generates a formal XML document of results.


Forcably remove all running guest domains and all persistent guest domain configuration files before running any tests. The test suite requires a pristine install, so all existing managed objects must be removed before running. This switch will instruct libvirt-tck to automatically remove all guest domains. YOU WILL NOT GET YOUR EXISTING GUEST DOMAINS BACK IF THIS HAPPENS. THEY WILL BE GONE FOREVER. USE AT YOUR OWN RISK.

-t, --testdir PATH

Specify an alternate directory path in which to find the test scripts to be run. If omitted, defaults to "/usr/share/libvirt-tck/tests"

-a, --archive FILE

Generate an archive containing all the raw test results. The filename given should end in either ".bz", ".tar.gz" or ".tgz"


Written by Daniel P. Berrange <>


Probably. Report any bugs found to your OS distribution's bug tracker or the libvirt mailing list <>


Copyright (C) 2009 Daniel P. Berrange Copyright (C) 2009 Red Hat, Inc.

"libvirt-tck" is distributed under the terms of the GNU GPL v2+. This is free software; see the source for copying conditions.  There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR PURPOSE.

See Also

"prove". If you need more fine grained control over running the tests, then set the LIBVIRT_TCK_CONFIG environment variable to point to your configuration file, and then run the "prove" command passing in the path to the test scripts to run.


2018-02-09 perl v5.26.1 User Contributed Perl Documentation