1libguestfs-test-tool(1) Virtualization Support libguestfs-test-tool(1)
2
6 libguestfs-test-tool - Diagnostics for libguestfs
7
9 libguestfs-test-tool [--options]
10
12 libguestfs-test-tool is a test program shipped with libguestfs to allow
13 you to check basic libguestfs functionality is working. This is needed
14 because libguestfs occasionally breaks for reasons beyond our control:
15 usually because of changes in the underlying qemu or kernel packages,
16 or the host environment.
17 If you suspect a problem in libguestfs, then just run:
19 libguestfs-test-tool
21 It will print lots of diagnostic messages.
23 If it runs to completion successfully, you will see this near the end:
25 ===== TEST FINISHED OK =====
27 and the test tool will exit with code 0.
29 If it fails (and/or exits with non-zero error code), please paste the
31 complete, unedited output of the test tool into a bug report. More
32 information about reporting bugs can be found on the
33 http://libguestfs.org/ website.
34
36 --help
37 Display short usage information and exit.
38 --qemu qemu_binary
40 If you have downloaded another qemu binary, point this option at
41 the full path of the binary to try it.
42 --qemudir qemu_source_dir
44 If you have compiled qemu from source, point this option at the
45 source directory to try it.
46 -t N
48 --timeout N
49 Set the launch timeout to "N" seconds. The default is 600 seconds
50 (10 minutes) which does not usually need to be adjusted.
51 -V
53 --version
54 Display the libguestfs version number and exit.
55
57 If you have compiled another version of qemu from source and would like
58 to try that, then you can use the --qemudir option to point to the qemu
59 source directory.
60 If you have downloaded a qemu binary from somewhere, use the --qemu
62 option to point to the binary.
63 Note when using these options, you can ignore the business of qemu
65 wrapper scripts ("QEMU WRAPPERS" in guestfs(3)), since libguestfs-test-
66 tool writes a wrapper script for you if one is needed.
67
69 If you are using supermin / febootstrap ≥ 3.8 then you can select which
70 kernel libguestfs tries. You do this by setting the environment
71 variables "SUPERMIN_KERNEL" and/or "SUPERMIN_MODULES"
72 ("FEBOOTSTRAP_KERNEL" and "FEBOOTSTRAP_MODULES" if still using the old
73 febootstrap 3.21 program).
74 Refer to "ENVIRONMENT VARIABLES" in supermin-helper(8) for further
76 information.
77
79 To find out which attach-method is the default in your libguestfs
80 package, do:
81 unset LIBGUESTFS_ATTACH_METHOD
83 guestfish get-attach-method
84 If you are using the libvirt attach-method, then you can try out a
86 different (eg. upstream) version of libvirt by running these commands
87 (not as root):
88 killall libvirtd lt-libvirtd
90 ~/path/to/libvirt/run libguestfs-test-tool
91 The first command kills any session "libvirtd" process(es) that may be
93 running on the machine. The second command uses libvirt's "run" script
94 (in the top-level libvirt build directory) to set some environment
95 variables so that the alternate version of libvirt is used to run the
96 program.
97
99 To find out which attach-method is the default in your libguestfs
100 package, do:
101 unset LIBGUESTFS_ATTACH_METHOD
103 guestfish get-attach-method
104 If you are using the libvirt attach-method, you can try without (ie.
106 libguestfs directly launching qemu) by doing:
107 export LIBGUESTFS_ATTACH_METHOD=appliance
109 Or if you are using the default (appliance) attach-method, then you can
111 try libvirt:
112 export LIBGUESTFS_ATTACH_METHOD=libvirt
114 or with libvirt and a specific libvirt URI:
116 export LIBGUESTFS_ATTACH_METHOD=libvirt:qemu:///session
118
120 To find out which attach-method is the default in your libguestfs
121 package, do:
122 LIBGUESTFS_ATTACH_METHOD= guestfish get-attach-method
124 To find out if SELinux is being used, do:
126 getenforce
128 If you are using libvirt, SELinux and sVirt, then you can try to see if
130 changing SELinux to "permissive" mode makes any difference. Use this
131 command as root:
132 setenforce Permissive
134 If this makes a difference, look in the audit logs for recent failures
136 ("AVCs"):
137 ausearch -m avc -ts recent
139 You can convert AVCs into suggested SELinux policy rules using tools
141 like audit2allow(1). For more information, see the "Security Enhanced
142 Linux User Guide".
143 To reenable SELinux and sVirt, do:
145 setenforce Enforcing
147
149 Refer to "APPLIANCE BOOT PROCESS" in guestfs(3) to understand the
150 messages produced by libguestfs-test-tool and/or possible errors.
151
153 libguestfs-test-tool returns 0 if the tests completed without error, or
154 1 if there was an error.
155
157 For the full list of environment variables which may affect libguestfs,
158 please see the guestfs(3) manual page.
159
161 guestfs(3), http://libguestfs.org/, http://qemu.org/.
162
164 Richard W.M. Jones ("rjones at redhat dot com")
165
167 Copyright (C) 2009-2013 Red Hat Inc.
168
170 This program is free software; you can redistribute it and/or modify it
171 under the terms of the GNU General Public License as published by the
172 Free Software Foundation; either version 2 of the License, or (at your
173 option) any later version.
174 This program is distributed in the hope that it will be useful, but
176 WITHOUT ANY WARRANTY; without even the implied warranty of
177 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
178 General Public License for more details.
179 You should have received a copy of the GNU General Public License along
181 with this program; if not, write to the Free Software Foundation, Inc.,
182 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
183
185 To get a list of bugs against libguestfs, use this link:
186 https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools
187 To report a new bug against libguestfs, use this link:
189 https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools
190 When reporting a bug, please supply:
192 · The version of libguestfs.
194 · Where you got libguestfs (eg. which Linux distro, compiled from
196 source, etc)
197 · Describe the bug accurately and give a way to reproduce it.
199 · Run libguestfs-test-tool(1) and paste the complete, unedited output
201 into the bug report.
202libguestfs-1.20.11 2013-08-27 libguestfs-test-tool(1)