2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter C<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form C<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to run C<guestfs_umount_all> followed by
286 C<guestfs_sync> when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
308 ("get_verbose", (RBool "verbose", [], []), -1, [],
312 This returns the verbose messages flag.");
314 ("is_ready", (RBool "ready", [], []), -1, [],
315 [InitNone, Always, TestOutputTrue (
317 "is ready to accept commands",
319 This returns true iff this handle is ready to accept commands
320 (in the C<READY> state).
322 For more information on states, see L<guestfs(3)>.");
324 ("is_config", (RBool "config", [], []), -1, [],
325 [InitNone, Always, TestOutputFalse (
327 "is in configuration state",
329 This returns true iff this handle is being configured
330 (in the C<CONFIG> state).
332 For more information on states, see L<guestfs(3)>.");
334 ("is_launching", (RBool "launching", [], []), -1, [],
335 [InitNone, Always, TestOutputFalse (
336 [["is_launching"]])],
337 "is launching subprocess",
339 This returns true iff this handle is launching the subprocess
340 (in the C<LAUNCHING> state).
342 For more information on states, see L<guestfs(3)>.");
344 ("is_busy", (RBool "busy", [], []), -1, [],
345 [InitNone, Always, TestOutputFalse (
347 "is busy processing a command",
349 This returns true iff this handle is busy processing a command
350 (in the C<BUSY> state).
352 For more information on states, see L<guestfs(3)>.");
354 ("get_state", (RInt "state", [], []), -1, [],
356 "get the current state",
358 This returns the current state as an opaque integer. This is
359 only useful for printing debug and internal error messages.
361 For more information on states, see L<guestfs(3)>.");
363 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
364 [InitNone, Always, TestOutputInt (
365 [["set_memsize"; "500"];
366 ["get_memsize"]], 500)],
367 "set memory allocated to the qemu subprocess",
369 This sets the memory size in megabytes allocated to the
370 qemu subprocess. This only has any effect if called before
373 You can also change this by setting the environment
374 variable C<LIBGUESTFS_MEMSIZE> before the handle is
377 For more information on the architecture of libguestfs,
378 see L<guestfs(3)>.");
380 ("get_memsize", (RInt "memsize", [], []), -1, [],
381 [InitNone, Always, TestOutputIntOp (
382 [["get_memsize"]], ">=", 256)],
383 "get memory allocated to the qemu subprocess",
385 This gets the memory size in megabytes allocated to the
388 If C<guestfs_set_memsize> was not called
389 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
390 then this returns the compiled-in default value for memsize.
392 For more information on the architecture of libguestfs,
393 see L<guestfs(3)>.");
395 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
396 [InitNone, Always, TestOutputIntOp (
397 [["get_pid"]], ">=", 1)],
398 "get PID of qemu subprocess",
400 Return the process ID of the qemu subprocess. If there is no
401 qemu subprocess, then this will return an error.
403 This is an internal call used for debugging and testing.");
405 ("version", (RStruct ("version", "version"), [], []), -1, [],
406 [InitNone, Always, TestOutputStruct (
407 [["version"]], [CompareWithInt ("major", 1)])],
408 "get the library version number",
410 Return the libguestfs version number that the program is linked
413 Note that because of dynamic linking this is not necessarily
414 the version of libguestfs that you compiled against. You can
415 compile the program, and then at runtime dynamically link
416 against a completely different C<libguestfs.so> library.
418 This call was added in version C<1.0.58>. In previous
419 versions of libguestfs there was no way to get the version
420 number. From C code you can use dynamic linker functions
421 to find out if this symbol exists (if it doesn't, then
422 it's an earlier version).
424 The call returns a structure with four elements. The first
425 three (C<major>, C<minor> and C<release>) are numbers and
426 correspond to the usual version triplet. The fourth element
427 (C<extra>) is a string and is normally empty, but may be
428 used for distro-specific information.
430 To construct the original version string:
431 C<$major.$minor.$release$extra>
433 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
435 I<Note:> Don't use this call to test for availability
436 of features. In enterprise distributions we backport
437 features from later versions into earlier versions,
438 making this an unreliable way to test for features.
439 Use C<guestfs_available> instead.");
441 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
442 [InitNone, Always, TestOutputTrue (
443 [["set_selinux"; "true"];
445 "set SELinux enabled or disabled at appliance boot",
447 This sets the selinux flag that is passed to the appliance
448 at boot time. The default is C<selinux=0> (disabled).
450 Note that if SELinux is enabled, it is always in
451 Permissive mode (C<enforcing=0>).
453 For more information on the architecture of libguestfs,
454 see L<guestfs(3)>.");
456 ("get_selinux", (RBool "selinux", [], []), -1, [],
458 "get SELinux enabled flag",
460 This returns the current setting of the selinux flag which
461 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
463 For more information on the architecture of libguestfs,
464 see L<guestfs(3)>.");
466 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
467 [InitNone, Always, TestOutputFalse (
468 [["set_trace"; "false"];
470 "enable or disable command traces",
472 If the command trace flag is set to 1, then commands are
473 printed on stderr before they are executed in a format
474 which is very similar to the one used by guestfish. In
475 other words, you can run a program with this enabled, and
476 you will get out a script which you can feed to guestfish
477 to perform the same set of actions.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
486 ("get_trace", (RBool "trace", [], []), -1, [],
488 "get command trace enabled flag",
490 Return the command trace flag.");
492 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
493 [InitNone, Always, TestOutputFalse (
494 [["set_direct"; "false"];
496 "enable or disable direct appliance mode",
498 If the direct appliance mode flag is enabled, then stdin and
499 stdout are passed directly through to the appliance once it
502 One consequence of this is that log messages aren't caught
503 by the library and handled by C<guestfs_set_log_message_callback>,
504 but go straight to stdout.
506 You probably don't want to use this unless you know what you
509 The default is disabled.");
511 ("get_direct", (RBool "direct", [], []), -1, [],
513 "get direct appliance mode flag",
515 Return the direct appliance mode flag.");
517 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
518 [InitNone, Always, TestOutputTrue (
519 [["set_recovery_proc"; "true"];
520 ["get_recovery_proc"]])],
521 "enable or disable the recovery process",
523 If this is called with the parameter C<false> then
524 C<guestfs_launch> does not create a recovery process. The
525 purpose of the recovery process is to stop runaway qemu
526 processes in the case where the main program aborts abruptly.
528 This only has any effect if called before C<guestfs_launch>,
529 and the default is true.
531 About the only time when you would want to disable this is
532 if the main process will fork itself into the background
533 (\"daemonize\" itself). In this case the recovery process
534 thinks that the main program has disappeared and so kills
535 qemu, which is not very helpful.");
537 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
539 "get recovery process enabled flag",
541 Return the recovery process enabled flag.");
543 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
545 "add a drive specifying the QEMU block emulation to use",
547 This is the same as C<guestfs_add_drive> but it allows you
548 to specify the QEMU interface emulation to use at run time.");
550 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
552 "add a drive read-only specifying the QEMU block emulation to use",
554 This is the same as C<guestfs_add_drive_ro> but it allows you
555 to specify the QEMU interface emulation to use at run time.");
557 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
558 [InitISOFS, Always, TestOutput (
559 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
560 InitISOFS, Always, TestOutput (
561 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
562 InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-win32.exe"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/lib-i586.so"]], "i386");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/lib-sparc.so"]], "sparc");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-win32.dll"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
582 "detect the architecture of a binary file",
584 This detects the architecture of the binary C<filename>,
585 and returns it if known.
587 Currently defined architectures are:
593 This string is returned for all 32 bit i386, i486, i586, i686 binaries
594 irrespective of the precise processor requirements of the binary.
606 64 bit SPARC V9 and above.
622 Libguestfs may return other architecture strings in future.
624 The function works on at least the following types of files:
630 many types of Un*x and Linux binary
634 many types of Un*x and Linux shared library
638 Windows Win32 and Win64 binaries
642 Windows Win32 and Win64 DLLs
644 Win32 binaries and DLLs return C<i386>.
646 Win64 binaries and DLLs return C<x86_64>.
654 Linux new-style initrd images
658 some non-x86 Linux vmlinuz kernels
662 What it can't do currently:
668 static libraries (libfoo.a)
672 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
676 x86 Linux vmlinuz kernels
678 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
679 compressed code, and are horribly hard to unpack. If you want to find
680 the architecture of a kernel, use the architecture of the associated
681 initrd or kernel module(s) instead.
685 ("inspect_os", (RStringList "roots", [], []), -1, [],
687 "inspect disk and return list of operating systems found",
689 This function uses other libguestfs functions and certain
690 heuristics to inspect the disk(s) (usually disks belonging to
691 a virtual machine), looking for operating systems.
693 The list returned is empty if no operating systems were found.
695 If one operating system was found, then this returns a list with
696 a single element, which is the name of the root filesystem of
697 this operating system. It is also possible for this function
698 to return a list containing more than one element, indicating
699 a dual-boot or multi-boot virtual machine, with each element being
700 the root filesystem of one of the operating systems.
702 You can pass the root string(s) returned to other
703 C<guestfs_inspect_get_*> functions in order to query further
704 information about each operating system, such as the name
707 This function uses other libguestfs features such as
708 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
709 and unmount filesystems and look at the contents. This should
710 be called with no disks currently mounted. The function may also
711 use Augeas, so any existing Augeas handle will be closed.
713 This function cannot decrypt encrypted disks. The caller
714 must do that first (supplying the necessary keys) if the
717 Please read L<guestfs(3)/INSPECTION> for more details.
719 See also C<guestfs_list_filesystems>.");
721 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
723 "get type of inspected operating system",
725 This function should only be called with a root device string
726 as returned by C<guestfs_inspect_os>.
728 This returns the type of the inspected operating system.
729 Currently defined types are:
735 Any Linux-based operating system.
739 Any Microsoft Windows operating system.
743 The operating system type could not be determined.
747 Future versions of libguestfs may return other strings here.
748 The caller should be prepared to handle any string.
750 Please read L<guestfs(3)/INSPECTION> for more details.");
752 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
754 "get architecture of inspected operating system",
756 This function should only be called with a root device string
757 as returned by C<guestfs_inspect_os>.
759 This returns the architecture of the inspected operating system.
760 The possible return values are listed under
761 C<guestfs_file_architecture>.
763 If the architecture could not be determined, then the
764 string C<unknown> is returned.
766 Please read L<guestfs(3)/INSPECTION> for more details.");
768 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
770 "get distro of inspected operating system",
772 This function should only be called with a root device string
773 as returned by C<guestfs_inspect_os>.
775 This returns the distro (distribution) of the inspected operating
778 Currently defined distros are:
788 Debian or a Debian-derived distro such as Ubuntu.
806 =item \"redhat-based\"
808 Some Red Hat-derived distro.
812 Red Hat Enterprise Linux and some derivatives.
816 Windows does not have distributions. This string is
817 returned if the OS type is Windows.
825 The distro could not be determined.
829 Future versions of libguestfs may return other strings here.
830 The caller should be prepared to handle any string.
832 Please read L<guestfs(3)/INSPECTION> for more details.");
834 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
836 "get major version of inspected operating system",
838 This function should only be called with a root device string
839 as returned by C<guestfs_inspect_os>.
841 This returns the major version number of the inspected operating
844 Windows uses a consistent versioning scheme which is I<not>
845 reflected in the popular public names used by the operating system.
846 Notably the operating system known as \"Windows 7\" is really
847 version 6.1 (ie. major = 6, minor = 1). You can find out the
848 real versions corresponding to releases of Windows by consulting
851 If the version could not be determined, then C<0> is returned.
853 Please read L<guestfs(3)/INSPECTION> for more details.");
855 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
857 "get minor version of inspected operating system",
859 This function should only be called with a root device string
860 as returned by C<guestfs_inspect_os>.
862 This returns the minor version number of the inspected operating
865 If the version could not be determined, then C<0> is returned.
867 Please read L<guestfs(3)/INSPECTION> for more details.
868 See also C<guestfs_inspect_get_major_version>.");
870 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
872 "get product name of inspected operating system",
874 This function should only be called with a root device string
875 as returned by C<guestfs_inspect_os>.
877 This returns the product name of the inspected operating
878 system. The product name is generally some freeform string
879 which can be displayed to the user, but should not be
882 If the product name could not be determined, then the
883 string C<unknown> is returned.
885 Please read L<guestfs(3)/INSPECTION> for more details.");
887 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
889 "get mountpoints of inspected operating system",
891 This function should only be called with a root device string
892 as returned by C<guestfs_inspect_os>.
894 This returns a hash of where we think the filesystems
895 associated with this operating system should be mounted.
896 Callers should note that this is at best an educated guess
897 made by reading configuration files such as C</etc/fstab>.
899 Each element in the returned hashtable has a key which
900 is the path of the mountpoint (eg. C</boot>) and a value
901 which is the filesystem that would be mounted there
904 Non-mounted devices such as swap devices are I<not>
905 returned in this list.
907 Please read L<guestfs(3)/INSPECTION> for more details.
908 See also C<guestfs_inspect_get_filesystems>.");
910 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
912 "get filesystems associated with inspected operating system",
914 This function should only be called with a root device string
915 as returned by C<guestfs_inspect_os>.
917 This returns a list of all the filesystems that we think
918 are associated with this operating system. This includes
919 the root filesystem, other ordinary filesystems, and
920 non-mounted devices like swap partitions.
922 In the case of a multi-boot virtual machine, it is possible
923 for a filesystem to be shared between operating systems.
925 Please read L<guestfs(3)/INSPECTION> for more details.
926 See also C<guestfs_inspect_get_mountpoints>.");
928 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
930 "set enable network flag",
932 If C<network> is true, then the network is enabled in the
933 libguestfs appliance. The default is false.
935 This affects whether commands are able to access the network
936 (see L<guestfs(3)/RUNNING COMMANDS>).
938 You must call this before calling C<guestfs_launch>, otherwise
941 ("get_network", (RBool "network", [], []), -1, [],
943 "get enable network flag",
945 This returns the enable network flag.");
947 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
951 This inspection command looks for filesystems on partitions,
952 block devices and logical volumes, returning a list of devices
953 containing filesystems and their type.
955 The return value is a hash, where the keys are the devices
956 containing filesystems, and the values are the filesystem types.
959 \"/dev/sda1\" => \"ntfs\"
960 \"/dev/sda2\" => \"ext2\"
961 \"/dev/vg_guest/lv_root\" => \"ext4\"
962 \"/dev/vg_guest/lv_swap\" => \"swap\"
964 The value can have the special value \"unknown\", meaning the
965 content of the device is undetermined or empty.
966 \"swap\" means a Linux swap partition.
968 This command runs other libguestfs commands, which might include
969 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
970 use this soon after launch and only when nothing is mounted.
972 Not all of the filesystems returned will be mountable. In
973 particular, swap partitions are returned in the list. Also
974 this command does not check that each filesystem
975 found is valid and mountable, and some filesystems might
976 be mountable but require special options. Filesystems may
977 not all belong to a single logical operating system
978 (use C<guestfs_inspect_os> to look for OSes).");
980 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
982 "add an image to examine or modify",
984 This function adds a virtual machine disk image C<filename> to
985 libguestfs. The first time you call this function, the disk
986 appears as C</dev/sda>, the second time as C</dev/sdb>, and
989 You don't necessarily need to be root when using libguestfs. However
990 you obviously do need sufficient permissions to access the filename
991 for whatever operations you want to perform (ie. read access if you
992 just want to read the image or write access if you want to modify the
995 This call checks that C<filename> exists.
997 The optional arguments are:
1003 If true then the image is treated as read-only. Writes are still
1004 allowed, but they are stored in a temporary snapshot overlay which
1005 is discarded at the end. The disk that you add is not modified.
1009 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1010 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1011 Possible formats include C<raw> and C<qcow2>.
1013 Automatic detection of the format opens you up to a potential
1014 security hole when dealing with untrusted raw-format images.
1015 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1020 This rarely-used option lets you emulate the behaviour of the
1021 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1025 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1027 "get Windows systemroot of inspected operating system",
1029 This function should only be called with a root device string
1030 as returned by C<guestfs_inspect_os>.
1032 This returns the Windows systemroot of the inspected guest.
1033 The systemroot is a directory path such as C</WINDOWS>.
1035 This call assumes that the guest is Windows and that the
1036 systemroot could be determined by inspection. If this is not
1037 the case then an error is returned.
1039 Please read L<guestfs(3)/INSPECTION> for more details.");
1041 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1043 "return list of operating systems found by last inspection",
1045 This function is a convenient way to get the list of root
1046 devices, as returned from a previous call to C<guestfs_inspect_os>,
1047 but without redoing the whole inspection process.
1049 This returns an empty list if either no root devices were
1050 found or the caller has not called C<guestfs_inspect_os>.
1052 Please read L<guestfs(3)/INSPECTION> for more details.");
1054 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1056 "debug the QEMU command line (internal use only)",
1058 This returns the internal QEMU command line. 'debug' commands are
1059 not part of the formal API and can be removed or changed at any time.");
1061 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"]), -1, [FishAlias "domain"],
1063 "add the disk(s) from a named libvirt domain",
1065 This function adds the disk(s) attached to the named libvirt
1066 domain C<dom>. It works by connecting to libvirt, requesting
1067 the domain and domain XML from libvirt, parsing it for disks,
1068 and calling C<guestfs_add_drive_opts> on each one.
1070 The number of disks added is returned. This operation is atomic:
1071 if an error is returned, then no disks are added.
1073 This function does some minimal checks to make sure the libvirt
1074 domain is not running (unless C<readonly> is true). In a future
1075 version we will try to acquire the libvirt lock on each disk.
1077 Disks must be accessible locally. This often means that adding disks
1078 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1079 will fail unless those disks are accessible via the same device path
1082 The optional C<libvirturi> parameter sets the libvirt URI
1083 (see L<http://libvirt.org/uri.html>). If this is not set then
1084 we connect to the default libvirt URI (or one set through an
1085 environment variable, see the libvirt documentation for full
1086 details). If you are using the C API directly then it is more
1087 flexible to create the libvirt connection object yourself, get
1088 the domain object, and call C<guestfs_add_libvirt_dom>.
1090 The other optional parameters are passed directly through to
1091 C<guestfs_add_drive_opts>.");
1094 This interface is not quite baked yet. -- RWMJ 2010-11-11
1095 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"]), -1, [NotInFish],
1097 "add the disk(s) from a libvirt domain",
1099 This function adds the disk(s) attached to the libvirt domain C<dom>.
1100 It works by requesting the domain XML from libvirt, parsing it for
1101 disks, and calling C<guestfs_add_drive_opts> on each one.
1103 In the C API we declare C<void *dom>, but really it has type
1104 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1106 The number of disks added is returned. This operation is atomic:
1107 if an error is returned, then no disks are added.
1109 This function does some minimal checks to make sure the libvirt
1110 domain is not running (unless C<readonly> is true). In a future
1111 version we will try to acquire the libvirt lock on each disk.
1113 Disks must be accessible locally. This often means that adding disks
1114 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1115 will fail unless those disks are accessible via the same device path
1118 The optional parameters are passed directly through to
1119 C<guestfs_add_drive_opts>.");
1122 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1124 "get package format used by the operating system",
1126 This function should only be called with a root device string
1127 as returned by C<guestfs_inspect_os>.
1129 This function and C<guestfs_inspect_get_package_management> return
1130 the package format and package management tool used by the
1131 inspected operating system. For example for Fedora these
1132 functions would return C<rpm> (package format) and
1133 C<yum> (package management).
1135 This returns the string C<unknown> if we could not determine the
1136 package format I<or> if the operating system does not have
1137 a real packaging system (eg. Windows).
1139 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1140 Future versions of libguestfs may return other strings.
1142 Please read L<guestfs(3)/INSPECTION> for more details.");
1144 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1146 "get package management tool used by the operating system",
1148 This function should only be called with a root device string
1149 as returned by C<guestfs_inspect_os>.
1151 C<guestfs_inspect_get_package_format> and this function return
1152 the package format and package management tool used by the
1153 inspected operating system. For example for Fedora these
1154 functions would return C<rpm> (package format) and
1155 C<yum> (package management).
1157 This returns the string C<unknown> if we could not determine the
1158 package management tool I<or> if the operating system does not have
1159 a real packaging system (eg. Windows).
1161 Possible strings include: C<yum>, C<up2date>,
1162 C<apt> (for all Debian derivatives),
1163 C<portage>, C<pisi>, C<pacman>.
1164 Future versions of libguestfs may return other strings.
1166 Please read L<guestfs(3)/INSPECTION> for more details.");
1170 (* daemon_functions are any functions which cause some action
1171 * to take place in the daemon.
1174 let daemon_functions = [
1175 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1176 [InitEmpty, Always, TestOutput (
1177 [["part_disk"; "/dev/sda"; "mbr"];
1178 ["mkfs"; "ext2"; "/dev/sda1"];
1179 ["mount"; "/dev/sda1"; "/"];
1180 ["write"; "/new"; "new file contents"];
1181 ["cat"; "/new"]], "new file contents")],
1182 "mount a guest disk at a position in the filesystem",
1184 Mount a guest disk at a position in the filesystem. Block devices
1185 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1186 the guest. If those block devices contain partitions, they will have
1187 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1190 The rules are the same as for L<mount(2)>: A filesystem must
1191 first be mounted on C</> before others can be mounted. Other
1192 filesystems can only be mounted on directories which already
1195 The mounted filesystem is writable, if we have sufficient permissions
1196 on the underlying device.
1199 When you use this call, the filesystem options C<sync> and C<noatime>
1200 are set implicitly. This was originally done because we thought it
1201 would improve reliability, but it turns out that I<-o sync> has a
1202 very large negative performance impact and negligible effect on
1203 reliability. Therefore we recommend that you avoid using
1204 C<guestfs_mount> in any code that needs performance, and instead
1205 use C<guestfs_mount_options> (use an empty string for the first
1206 parameter if you don't want any options).");
1208 ("sync", (RErr, [], []), 2, [],
1209 [ InitEmpty, Always, TestRun [["sync"]]],
1210 "sync disks, writes are flushed through to the disk image",
1212 This syncs the disk, so that any writes are flushed through to the
1213 underlying disk image.
1215 You should always call this if you have modified a disk image, before
1216 closing the handle.");
1218 ("touch", (RErr, [Pathname "path"], []), 3, [],
1219 [InitBasicFS, Always, TestOutputTrue (
1221 ["exists"; "/new"]])],
1222 "update file timestamps or create a new file",
1224 Touch acts like the L<touch(1)> command. It can be used to
1225 update the timestamps on a file, or, if the file does not exist,
1226 to create a new zero-length file.
1228 This command only works on regular files, and will fail on other
1229 file types such as directories, symbolic links, block special etc.");
1231 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1232 [InitISOFS, Always, TestOutput (
1233 [["cat"; "/known-2"]], "abcdef\n")],
1234 "list the contents of a file",
1236 Return the contents of the file named C<path>.
1238 Note that this function cannot correctly handle binary files
1239 (specifically, files containing C<\\0> character which is treated
1240 as end of string). For those you need to use the C<guestfs_read_file>
1241 or C<guestfs_download> functions which have a more complex interface.");
1243 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1244 [], (* XXX Tricky to test because it depends on the exact format
1245 * of the 'ls -l' command, which changes between F10 and F11.
1247 "list the files in a directory (long format)",
1249 List the files in C<directory> (relative to the root directory,
1250 there is no cwd) in the format of 'ls -la'.
1252 This command is mostly useful for interactive sessions. It
1253 is I<not> intended that you try to parse the output string.");
1255 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1256 [InitBasicFS, Always, TestOutputList (
1258 ["touch"; "/newer"];
1259 ["touch"; "/newest"];
1260 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1261 "list the files in a directory",
1263 List the files in C<directory> (relative to the root directory,
1264 there is no cwd). The '.' and '..' entries are not returned, but
1265 hidden files are shown.
1267 This command is mostly useful for interactive sessions. Programs
1268 should probably use C<guestfs_readdir> instead.");
1270 ("list_devices", (RStringList "devices", [], []), 7, [],
1271 [InitEmpty, Always, TestOutputListOfDevices (
1272 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1273 "list the block devices",
1275 List all the block devices.
1277 The full block device names are returned, eg. C</dev/sda>.
1279 See also C<guestfs_list_filesystems>.");
1281 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1282 [InitBasicFS, Always, TestOutputListOfDevices (
1283 [["list_partitions"]], ["/dev/sda1"]);
1284 InitEmpty, Always, TestOutputListOfDevices (
1285 [["part_init"; "/dev/sda"; "mbr"];
1286 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1287 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1288 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1289 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1290 "list the partitions",
1292 List all the partitions detected on all block devices.
1294 The full partition device names are returned, eg. C</dev/sda1>
1296 This does not return logical volumes. For that you will need to
1297 call C<guestfs_lvs>.
1299 See also C<guestfs_list_filesystems>.");
1301 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1302 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1303 [["pvs"]], ["/dev/sda1"]);
1304 InitEmpty, Always, TestOutputListOfDevices (
1305 [["part_init"; "/dev/sda"; "mbr"];
1306 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1307 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1308 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1309 ["pvcreate"; "/dev/sda1"];
1310 ["pvcreate"; "/dev/sda2"];
1311 ["pvcreate"; "/dev/sda3"];
1312 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1313 "list the LVM physical volumes (PVs)",
1315 List all the physical volumes detected. This is the equivalent
1316 of the L<pvs(8)> command.
1318 This returns a list of just the device names that contain
1319 PVs (eg. C</dev/sda2>).
1321 See also C<guestfs_pvs_full>.");
1323 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1324 [InitBasicFSonLVM, Always, TestOutputList (
1326 InitEmpty, Always, TestOutputList (
1327 [["part_init"; "/dev/sda"; "mbr"];
1328 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1329 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1330 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1331 ["pvcreate"; "/dev/sda1"];
1332 ["pvcreate"; "/dev/sda2"];
1333 ["pvcreate"; "/dev/sda3"];
1334 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1335 ["vgcreate"; "VG2"; "/dev/sda3"];
1336 ["vgs"]], ["VG1"; "VG2"])],
1337 "list the LVM volume groups (VGs)",
1339 List all the volumes groups detected. This is the equivalent
1340 of the L<vgs(8)> command.
1342 This returns a list of just the volume group names that were
1343 detected (eg. C<VolGroup00>).
1345 See also C<guestfs_vgs_full>.");
1347 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1348 [InitBasicFSonLVM, Always, TestOutputList (
1349 [["lvs"]], ["/dev/VG/LV"]);
1350 InitEmpty, Always, TestOutputList (
1351 [["part_init"; "/dev/sda"; "mbr"];
1352 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1353 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1354 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1355 ["pvcreate"; "/dev/sda1"];
1356 ["pvcreate"; "/dev/sda2"];
1357 ["pvcreate"; "/dev/sda3"];
1358 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1359 ["vgcreate"; "VG2"; "/dev/sda3"];
1360 ["lvcreate"; "LV1"; "VG1"; "50"];
1361 ["lvcreate"; "LV2"; "VG1"; "50"];
1362 ["lvcreate"; "LV3"; "VG2"; "50"];
1363 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1364 "list the LVM logical volumes (LVs)",
1366 List all the logical volumes detected. This is the equivalent
1367 of the L<lvs(8)> command.
1369 This returns a list of the logical volume device names
1370 (eg. C</dev/VolGroup00/LogVol00>).
1372 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1374 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1375 [], (* XXX how to test? *)
1376 "list the LVM physical volumes (PVs)",
1378 List all the physical volumes detected. This is the equivalent
1379 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1381 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1382 [], (* XXX how to test? *)
1383 "list the LVM volume groups (VGs)",
1385 List all the volumes groups detected. This is the equivalent
1386 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1388 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1389 [], (* XXX how to test? *)
1390 "list the LVM logical volumes (LVs)",
1392 List all the logical volumes detected. This is the equivalent
1393 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1395 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1396 [InitISOFS, Always, TestOutputList (
1397 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1398 InitISOFS, Always, TestOutputList (
1399 [["read_lines"; "/empty"]], [])],
1400 "read file as lines",
1402 Return the contents of the file named C<path>.
1404 The file contents are returned as a list of lines. Trailing
1405 C<LF> and C<CRLF> character sequences are I<not> returned.
1407 Note that this function cannot correctly handle binary files
1408 (specifically, files containing C<\\0> character which is treated
1409 as end of line). For those you need to use the C<guestfs_read_file>
1410 function which has a more complex interface.");
1412 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1413 [], (* XXX Augeas code needs tests. *)
1414 "create a new Augeas handle",
1416 Create a new Augeas handle for editing configuration files.
1417 If there was any previous Augeas handle associated with this
1418 guestfs session, then it is closed.
1420 You must call this before using any other C<guestfs_aug_*>
1423 C<root> is the filesystem root. C<root> must not be NULL,
1426 The flags are the same as the flags defined in
1427 E<lt>augeas.hE<gt>, the logical I<or> of the following
1432 =item C<AUG_SAVE_BACKUP> = 1
1434 Keep the original file with a C<.augsave> extension.
1436 =item C<AUG_SAVE_NEWFILE> = 2
1438 Save changes into a file with extension C<.augnew>, and
1439 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1441 =item C<AUG_TYPE_CHECK> = 4
1443 Typecheck lenses (can be expensive).
1445 =item C<AUG_NO_STDINC> = 8
1447 Do not use standard load path for modules.
1449 =item C<AUG_SAVE_NOOP> = 16
1451 Make save a no-op, just record what would have been changed.
1453 =item C<AUG_NO_LOAD> = 32
1455 Do not load the tree in C<guestfs_aug_init>.
1459 To close the handle, you can call C<guestfs_aug_close>.
1461 To find out more about Augeas, see L<http://augeas.net/>.");
1463 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1464 [], (* XXX Augeas code needs tests. *)
1465 "close the current Augeas handle",
1467 Close the current Augeas handle and free up any resources
1468 used by it. After calling this, you have to call
1469 C<guestfs_aug_init> again before you can use any other
1470 Augeas functions.");
1472 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1473 [], (* XXX Augeas code needs tests. *)
1474 "define an Augeas variable",
1476 Defines an Augeas variable C<name> whose value is the result
1477 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1480 On success this returns the number of nodes in C<expr>, or
1481 C<0> if C<expr> evaluates to something which is not a nodeset.");
1483 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1484 [], (* XXX Augeas code needs tests. *)
1485 "define an Augeas node",
1487 Defines a variable C<name> whose value is the result of
1490 If C<expr> evaluates to an empty nodeset, a node is created,
1491 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1492 C<name> will be the nodeset containing that single node.
1494 On success this returns a pair containing the
1495 number of nodes in the nodeset, and a boolean flag
1496 if a node was created.");
1498 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1499 [], (* XXX Augeas code needs tests. *)
1500 "look up the value of an Augeas path",
1502 Look up the value associated with C<path>. If C<path>
1503 matches exactly one node, the C<value> is returned.");
1505 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1506 [], (* XXX Augeas code needs tests. *)
1507 "set Augeas path to value",
1509 Set the value associated with C<path> to C<val>.
1511 In the Augeas API, it is possible to clear a node by setting
1512 the value to NULL. Due to an oversight in the libguestfs API
1513 you cannot do that with this call. Instead you must use the
1514 C<guestfs_aug_clear> call.");
1516 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1517 [], (* XXX Augeas code needs tests. *)
1518 "insert a sibling Augeas node",
1520 Create a new sibling C<label> for C<path>, inserting it into
1521 the tree before or after C<path> (depending on the boolean
1524 C<path> must match exactly one existing node in the tree, and
1525 C<label> must be a label, ie. not contain C</>, C<*> or end
1526 with a bracketed index C<[N]>.");
1528 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1529 [], (* XXX Augeas code needs tests. *)
1530 "remove an Augeas path",
1532 Remove C<path> and all of its children.
1534 On success this returns the number of entries which were removed.");
1536 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1537 [], (* XXX Augeas code needs tests. *)
1540 Move the node C<src> to C<dest>. C<src> must match exactly
1541 one node. C<dest> is overwritten if it exists.");
1543 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1544 [], (* XXX Augeas code needs tests. *)
1545 "return Augeas nodes which match augpath",
1547 Returns a list of paths which match the path expression C<path>.
1548 The returned paths are sufficiently qualified so that they match
1549 exactly one node in the current tree.");
1551 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1552 [], (* XXX Augeas code needs tests. *)
1553 "write all pending Augeas changes to disk",
1555 This writes all pending changes to disk.
1557 The flags which were passed to C<guestfs_aug_init> affect exactly
1558 how files are saved.");
1560 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1561 [], (* XXX Augeas code needs tests. *)
1562 "load files into the tree",
1564 Load files into the tree.
1566 See C<aug_load> in the Augeas documentation for the full gory
1569 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1570 [], (* XXX Augeas code needs tests. *)
1571 "list Augeas nodes under augpath",
1573 This is just a shortcut for listing C<guestfs_aug_match>
1574 C<path/*> and sorting the resulting nodes into alphabetical order.");
1576 ("rm", (RErr, [Pathname "path"], []), 29, [],
1577 [InitBasicFS, Always, TestRun
1580 InitBasicFS, Always, TestLastFail
1582 InitBasicFS, Always, TestLastFail
1587 Remove the single file C<path>.");
1589 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1590 [InitBasicFS, Always, TestRun
1593 InitBasicFS, Always, TestLastFail
1594 [["rmdir"; "/new"]];
1595 InitBasicFS, Always, TestLastFail
1597 ["rmdir"; "/new"]]],
1598 "remove a directory",
1600 Remove the single directory C<path>.");
1602 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1603 [InitBasicFS, Always, TestOutputFalse
1605 ["mkdir"; "/new/foo"];
1606 ["touch"; "/new/foo/bar"];
1608 ["exists"; "/new"]]],
1609 "remove a file or directory recursively",
1611 Remove the file or directory C<path>, recursively removing the
1612 contents if its a directory. This is like the C<rm -rf> shell
1615 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1616 [InitBasicFS, Always, TestOutputTrue
1618 ["is_dir"; "/new"]];
1619 InitBasicFS, Always, TestLastFail
1620 [["mkdir"; "/new/foo/bar"]]],
1621 "create a directory",
1623 Create a directory named C<path>.");
1625 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1626 [InitBasicFS, Always, TestOutputTrue
1627 [["mkdir_p"; "/new/foo/bar"];
1628 ["is_dir"; "/new/foo/bar"]];
1629 InitBasicFS, Always, TestOutputTrue
1630 [["mkdir_p"; "/new/foo/bar"];
1631 ["is_dir"; "/new/foo"]];
1632 InitBasicFS, Always, TestOutputTrue
1633 [["mkdir_p"; "/new/foo/bar"];
1634 ["is_dir"; "/new"]];
1635 (* Regression tests for RHBZ#503133: *)
1636 InitBasicFS, Always, TestRun
1638 ["mkdir_p"; "/new"]];
1639 InitBasicFS, Always, TestLastFail
1641 ["mkdir_p"; "/new"]]],
1642 "create a directory and parents",
1644 Create a directory named C<path>, creating any parent directories
1645 as necessary. This is like the C<mkdir -p> shell command.");
1647 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1648 [], (* XXX Need stat command to test *)
1651 Change the mode (permissions) of C<path> to C<mode>. Only
1652 numeric modes are supported.
1654 I<Note>: When using this command from guestfish, C<mode>
1655 by default would be decimal, unless you prefix it with
1656 C<0> to get octal, ie. use C<0700> not C<700>.
1658 The mode actually set is affected by the umask.");
1660 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1661 [], (* XXX Need stat command to test *)
1662 "change file owner and group",
1664 Change the file owner to C<owner> and group to C<group>.
1666 Only numeric uid and gid are supported. If you want to use
1667 names, you will need to locate and parse the password file
1668 yourself (Augeas support makes this relatively easy).");
1670 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1671 [InitISOFS, Always, TestOutputTrue (
1672 [["exists"; "/empty"]]);
1673 InitISOFS, Always, TestOutputTrue (
1674 [["exists"; "/directory"]])],
1675 "test if file or directory exists",
1677 This returns C<true> if and only if there is a file, directory
1678 (or anything) with the given C<path> name.
1680 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1682 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1683 [InitISOFS, Always, TestOutputTrue (
1684 [["is_file"; "/known-1"]]);
1685 InitISOFS, Always, TestOutputFalse (
1686 [["is_file"; "/directory"]])],
1687 "test if a regular file",
1689 This returns C<true> if and only if there is a regular file
1690 with the given C<path> name. Note that it returns false for
1691 other objects like directories.
1693 See also C<guestfs_stat>.");
1695 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1696 [InitISOFS, Always, TestOutputFalse (
1697 [["is_dir"; "/known-3"]]);
1698 InitISOFS, Always, TestOutputTrue (
1699 [["is_dir"; "/directory"]])],
1700 "test if a directory",
1702 This returns C<true> if and only if there is a directory
1703 with the given C<path> name. Note that it returns false for
1704 other objects like files.
1706 See also C<guestfs_stat>.");
1708 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1709 [InitEmpty, Always, TestOutputListOfDevices (
1710 [["part_init"; "/dev/sda"; "mbr"];
1711 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1712 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1713 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1714 ["pvcreate"; "/dev/sda1"];
1715 ["pvcreate"; "/dev/sda2"];
1716 ["pvcreate"; "/dev/sda3"];
1717 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1718 "create an LVM physical volume",
1720 This creates an LVM physical volume on the named C<device>,
1721 where C<device> should usually be a partition name such
1724 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1725 [InitEmpty, Always, TestOutputList (
1726 [["part_init"; "/dev/sda"; "mbr"];
1727 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1728 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1729 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1730 ["pvcreate"; "/dev/sda1"];
1731 ["pvcreate"; "/dev/sda2"];
1732 ["pvcreate"; "/dev/sda3"];
1733 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1734 ["vgcreate"; "VG2"; "/dev/sda3"];
1735 ["vgs"]], ["VG1"; "VG2"])],
1736 "create an LVM volume group",
1738 This creates an LVM volume group called C<volgroup>
1739 from the non-empty list of physical volumes C<physvols>.");
1741 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1742 [InitEmpty, Always, TestOutputList (
1743 [["part_init"; "/dev/sda"; "mbr"];
1744 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1745 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1746 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1747 ["pvcreate"; "/dev/sda1"];
1748 ["pvcreate"; "/dev/sda2"];
1749 ["pvcreate"; "/dev/sda3"];
1750 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1751 ["vgcreate"; "VG2"; "/dev/sda3"];
1752 ["lvcreate"; "LV1"; "VG1"; "50"];
1753 ["lvcreate"; "LV2"; "VG1"; "50"];
1754 ["lvcreate"; "LV3"; "VG2"; "50"];
1755 ["lvcreate"; "LV4"; "VG2"; "50"];
1756 ["lvcreate"; "LV5"; "VG2"; "50"];
1758 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1759 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1760 "create an LVM logical volume",
1762 This creates an LVM logical volume called C<logvol>
1763 on the volume group C<volgroup>, with C<size> megabytes.");
1765 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1766 [InitEmpty, Always, TestOutput (
1767 [["part_disk"; "/dev/sda"; "mbr"];
1768 ["mkfs"; "ext2"; "/dev/sda1"];
1769 ["mount_options"; ""; "/dev/sda1"; "/"];
1770 ["write"; "/new"; "new file contents"];
1771 ["cat"; "/new"]], "new file contents")],
1772 "make a filesystem",
1774 This creates a filesystem on C<device> (usually a partition
1775 or LVM logical volume). The filesystem type is C<fstype>, for
1778 ("sfdisk", (RErr, [Device "device";
1779 Int "cyls"; Int "heads"; Int "sectors";
1780 StringList "lines"], []), 43, [DangerWillRobinson],
1782 "create partitions on a block device",
1784 This is a direct interface to the L<sfdisk(8)> program for creating
1785 partitions on block devices.
1787 C<device> should be a block device, for example C</dev/sda>.
1789 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1790 and sectors on the device, which are passed directly to sfdisk as
1791 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1792 of these, then the corresponding parameter is omitted. Usually for
1793 'large' disks, you can just pass C<0> for these, but for small
1794 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1795 out the right geometry and you will need to tell it.
1797 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1798 information refer to the L<sfdisk(8)> manpage.
1800 To create a single partition occupying the whole disk, you would
1801 pass C<lines> as a single element list, when the single element being
1802 the string C<,> (comma).
1804 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1805 C<guestfs_part_init>");
1807 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1808 (* Regression test for RHBZ#597135. *)
1809 [InitBasicFS, Always, TestLastFail
1810 [["write_file"; "/new"; "abc"; "10000"]]],
1813 This call creates a file called C<path>. The contents of the
1814 file is the string C<content> (which can contain any 8 bit data),
1815 with length C<size>.
1817 As a special case, if C<size> is C<0>
1818 then the length is calculated using C<strlen> (so in this case
1819 the content cannot contain embedded ASCII NULs).
1821 I<NB.> Owing to a bug, writing content containing ASCII NUL
1822 characters does I<not> work, even if the length is specified.");
1824 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1825 [InitEmpty, Always, TestOutputListOfDevices (
1826 [["part_disk"; "/dev/sda"; "mbr"];
1827 ["mkfs"; "ext2"; "/dev/sda1"];
1828 ["mount_options"; ""; "/dev/sda1"; "/"];
1829 ["mounts"]], ["/dev/sda1"]);
1830 InitEmpty, Always, TestOutputList (
1831 [["part_disk"; "/dev/sda"; "mbr"];
1832 ["mkfs"; "ext2"; "/dev/sda1"];
1833 ["mount_options"; ""; "/dev/sda1"; "/"];
1836 "unmount a filesystem",
1838 This unmounts the given filesystem. The filesystem may be
1839 specified either by its mountpoint (path) or the device which
1840 contains the filesystem.");
1842 ("mounts", (RStringList "devices", [], []), 46, [],
1843 [InitBasicFS, Always, TestOutputListOfDevices (
1844 [["mounts"]], ["/dev/sda1"])],
1845 "show mounted filesystems",
1847 This returns the list of currently mounted filesystems. It returns
1848 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1850 Some internal mounts are not shown.
1852 See also: C<guestfs_mountpoints>");
1854 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1855 [InitBasicFS, Always, TestOutputList (
1858 (* check that umount_all can unmount nested mounts correctly: *)
1859 InitEmpty, Always, TestOutputList (
1860 [["part_init"; "/dev/sda"; "mbr"];
1861 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1862 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1863 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1864 ["mkfs"; "ext2"; "/dev/sda1"];
1865 ["mkfs"; "ext2"; "/dev/sda2"];
1866 ["mkfs"; "ext2"; "/dev/sda3"];
1867 ["mount_options"; ""; "/dev/sda1"; "/"];
1869 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1870 ["mkdir"; "/mp1/mp2"];
1871 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1872 ["mkdir"; "/mp1/mp2/mp3"];
1875 "unmount all filesystems",
1877 This unmounts all mounted filesystems.
1879 Some internal mounts are not unmounted by this call.");
1881 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1883 "remove all LVM LVs, VGs and PVs",
1885 This command removes all LVM logical volumes, volume groups
1886 and physical volumes.");
1888 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
1889 [InitISOFS, Always, TestOutput (
1890 [["file"; "/empty"]], "empty");
1891 InitISOFS, Always, TestOutput (
1892 [["file"; "/known-1"]], "ASCII text");
1893 InitISOFS, Always, TestLastFail (
1894 [["file"; "/notexists"]]);
1895 InitISOFS, Always, TestOutput (
1896 [["file"; "/abssymlink"]], "symbolic link");
1897 InitISOFS, Always, TestOutput (
1898 [["file"; "/directory"]], "directory")],
1899 "determine file type",
1901 This call uses the standard L<file(1)> command to determine
1902 the type or contents of the file.
1904 This call will also transparently look inside various types
1907 The exact command which runs is C<file -zb path>. Note in
1908 particular that the filename is not prepended to the output
1911 This command can also be used on C</dev/> devices
1912 (and partitions, LV names). You can for example use this
1913 to determine if a device contains a filesystem, although
1914 it's usually better to use C<guestfs_vfs_type>.
1916 If the C<path> does not begin with C</dev/> then
1917 this command only works for the content of regular files.
1918 For other file types (directory, symbolic link etc) it
1919 will just return the string C<directory> etc.");
1921 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
1922 [InitBasicFS, Always, TestOutput (
1923 [["upload"; "test-command"; "/test-command"];
1924 ["chmod"; "0o755"; "/test-command"];
1925 ["command"; "/test-command 1"]], "Result1");
1926 InitBasicFS, Always, TestOutput (
1927 [["upload"; "test-command"; "/test-command"];
1928 ["chmod"; "0o755"; "/test-command"];
1929 ["command"; "/test-command 2"]], "Result2\n");
1930 InitBasicFS, Always, TestOutput (
1931 [["upload"; "test-command"; "/test-command"];
1932 ["chmod"; "0o755"; "/test-command"];
1933 ["command"; "/test-command 3"]], "\nResult3");
1934 InitBasicFS, Always, TestOutput (
1935 [["upload"; "test-command"; "/test-command"];
1936 ["chmod"; "0o755"; "/test-command"];
1937 ["command"; "/test-command 4"]], "\nResult4\n");
1938 InitBasicFS, Always, TestOutput (
1939 [["upload"; "test-command"; "/test-command"];
1940 ["chmod"; "0o755"; "/test-command"];
1941 ["command"; "/test-command 5"]], "\nResult5\n\n");
1942 InitBasicFS, Always, TestOutput (
1943 [["upload"; "test-command"; "/test-command"];
1944 ["chmod"; "0o755"; "/test-command"];
1945 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1946 InitBasicFS, Always, TestOutput (
1947 [["upload"; "test-command"; "/test-command"];
1948 ["chmod"; "0o755"; "/test-command"];
1949 ["command"; "/test-command 7"]], "");
1950 InitBasicFS, Always, TestOutput (
1951 [["upload"; "test-command"; "/test-command"];
1952 ["chmod"; "0o755"; "/test-command"];
1953 ["command"; "/test-command 8"]], "\n");
1954 InitBasicFS, Always, TestOutput (
1955 [["upload"; "test-command"; "/test-command"];
1956 ["chmod"; "0o755"; "/test-command"];
1957 ["command"; "/test-command 9"]], "\n\n");
1958 InitBasicFS, Always, TestOutput (
1959 [["upload"; "test-command"; "/test-command"];
1960 ["chmod"; "0o755"; "/test-command"];
1961 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1962 InitBasicFS, Always, TestOutput (
1963 [["upload"; "test-command"; "/test-command"];
1964 ["chmod"; "0o755"; "/test-command"];
1965 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1966 InitBasicFS, Always, TestLastFail (
1967 [["upload"; "test-command"; "/test-command"];
1968 ["chmod"; "0o755"; "/test-command"];
1969 ["command"; "/test-command"]])],
1970 "run a command from the guest filesystem",
1972 This call runs a command from the guest filesystem. The
1973 filesystem must be mounted, and must contain a compatible
1974 operating system (ie. something Linux, with the same
1975 or compatible processor architecture).
1977 The single parameter is an argv-style list of arguments.
1978 The first element is the name of the program to run.
1979 Subsequent elements are parameters. The list must be
1980 non-empty (ie. must contain a program name). Note that
1981 the command runs directly, and is I<not> invoked via
1982 the shell (see C<guestfs_sh>).
1984 The return value is anything printed to I<stdout> by
1987 If the command returns a non-zero exit status, then
1988 this function returns an error message. The error message
1989 string is the content of I<stderr> from the command.
1991 The C<$PATH> environment variable will contain at least
1992 C</usr/bin> and C</bin>. If you require a program from
1993 another location, you should provide the full path in the
1996 Shared libraries and data files required by the program
1997 must be available on filesystems which are mounted in the
1998 correct places. It is the caller's responsibility to ensure
1999 all filesystems that are needed are mounted at the right
2002 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2003 [InitBasicFS, Always, TestOutputList (
2004 [["upload"; "test-command"; "/test-command"];
2005 ["chmod"; "0o755"; "/test-command"];
2006 ["command_lines"; "/test-command 1"]], ["Result1"]);
2007 InitBasicFS, Always, TestOutputList (
2008 [["upload"; "test-command"; "/test-command"];
2009 ["chmod"; "0o755"; "/test-command"];
2010 ["command_lines"; "/test-command 2"]], ["Result2"]);
2011 InitBasicFS, Always, TestOutputList (
2012 [["upload"; "test-command"; "/test-command"];
2013 ["chmod"; "0o755"; "/test-command"];
2014 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
2015 InitBasicFS, Always, TestOutputList (
2016 [["upload"; "test-command"; "/test-command"];
2017 ["chmod"; "0o755"; "/test-command"];
2018 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
2019 InitBasicFS, Always, TestOutputList (
2020 [["upload"; "test-command"; "/test-command"];
2021 ["chmod"; "0o755"; "/test-command"];
2022 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
2023 InitBasicFS, Always, TestOutputList (
2024 [["upload"; "test-command"; "/test-command"];
2025 ["chmod"; "0o755"; "/test-command"];
2026 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
2027 InitBasicFS, Always, TestOutputList (
2028 [["upload"; "test-command"; "/test-command"];
2029 ["chmod"; "0o755"; "/test-command"];
2030 ["command_lines"; "/test-command 7"]], []);
2031 InitBasicFS, Always, TestOutputList (
2032 [["upload"; "test-command"; "/test-command"];
2033 ["chmod"; "0o755"; "/test-command"];
2034 ["command_lines"; "/test-command 8"]], [""]);
2035 InitBasicFS, Always, TestOutputList (
2036 [["upload"; "test-command"; "/test-command"];
2037 ["chmod"; "0o755"; "/test-command"];
2038 ["command_lines"; "/test-command 9"]], ["";""]);
2039 InitBasicFS, Always, TestOutputList (
2040 [["upload"; "test-command"; "/test-command"];
2041 ["chmod"; "0o755"; "/test-command"];
2042 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
2043 InitBasicFS, Always, TestOutputList (
2044 [["upload"; "test-command"; "/test-command"];
2045 ["chmod"; "0o755"; "/test-command"];
2046 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
2047 "run a command, returning lines",
2049 This is the same as C<guestfs_command>, but splits the
2050 result into a list of lines.
2052 See also: C<guestfs_sh_lines>");
2054 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2055 [InitISOFS, Always, TestOutputStruct (
2056 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2057 "get file information",
2059 Returns file information for the given C<path>.
2061 This is the same as the C<stat(2)> system call.");
2063 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2064 [InitISOFS, Always, TestOutputStruct (
2065 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2066 "get file information for a symbolic link",
2068 Returns file information for the given C<path>.
2070 This is the same as C<guestfs_stat> except that if C<path>
2071 is a symbolic link, then the link is stat-ed, not the file it
2074 This is the same as the C<lstat(2)> system call.");
2076 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2077 [InitISOFS, Always, TestOutputStruct (
2078 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2079 "get file system statistics",
2081 Returns file system statistics for any mounted file system.
2082 C<path> should be a file or directory in the mounted file system
2083 (typically it is the mount point itself, but it doesn't need to be).
2085 This is the same as the C<statvfs(2)> system call.");
2087 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2089 "get ext2/ext3/ext4 superblock details",
2091 This returns the contents of the ext2, ext3 or ext4 filesystem
2092 superblock on C<device>.
2094 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2095 manpage for more details. The list of fields returned isn't
2096 clearly defined, and depends on both the version of C<tune2fs>
2097 that libguestfs was built against, and the filesystem itself.");
2099 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2100 [InitEmpty, Always, TestOutputTrue (
2101 [["blockdev_setro"; "/dev/sda"];
2102 ["blockdev_getro"; "/dev/sda"]])],
2103 "set block device to read-only",
2105 Sets the block device named C<device> to read-only.
2107 This uses the L<blockdev(8)> command.");
2109 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2110 [InitEmpty, Always, TestOutputFalse (
2111 [["blockdev_setrw"; "/dev/sda"];
2112 ["blockdev_getro"; "/dev/sda"]])],
2113 "set block device to read-write",
2115 Sets the block device named C<device> to read-write.
2117 This uses the L<blockdev(8)> command.");
2119 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2120 [InitEmpty, Always, TestOutputTrue (
2121 [["blockdev_setro"; "/dev/sda"];
2122 ["blockdev_getro"; "/dev/sda"]])],
2123 "is block device set to read-only",
2125 Returns a boolean indicating if the block device is read-only
2126 (true if read-only, false if not).
2128 This uses the L<blockdev(8)> command.");
2130 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2131 [InitEmpty, Always, TestOutputInt (
2132 [["blockdev_getss"; "/dev/sda"]], 512)],
2133 "get sectorsize of block device",
2135 This returns the size of sectors on a block device.
2136 Usually 512, but can be larger for modern devices.
2138 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2141 This uses the L<blockdev(8)> command.");
2143 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2144 [InitEmpty, Always, TestOutputInt (
2145 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2146 "get blocksize of block device",
2148 This returns the block size of a device.
2150 (Note this is different from both I<size in blocks> and
2151 I<filesystem block size>).
2153 This uses the L<blockdev(8)> command.");
2155 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2157 "set blocksize of block device",
2159 This sets the block size of a device.
2161 (Note this is different from both I<size in blocks> and
2162 I<filesystem block size>).
2164 This uses the L<blockdev(8)> command.");
2166 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2167 [InitEmpty, Always, TestOutputInt (
2168 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2169 "get total size of device in 512-byte sectors",
2171 This returns the size of the device in units of 512-byte sectors
2172 (even if the sectorsize isn't 512 bytes ... weird).
2174 See also C<guestfs_blockdev_getss> for the real sector size of
2175 the device, and C<guestfs_blockdev_getsize64> for the more
2176 useful I<size in bytes>.
2178 This uses the L<blockdev(8)> command.");
2180 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2181 [InitEmpty, Always, TestOutputInt (
2182 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2183 "get total size of device in bytes",
2185 This returns the size of the device in bytes.
2187 See also C<guestfs_blockdev_getsz>.
2189 This uses the L<blockdev(8)> command.");
2191 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2192 [InitEmpty, Always, TestRun
2193 [["blockdev_flushbufs"; "/dev/sda"]]],
2194 "flush device buffers",
2196 This tells the kernel to flush internal buffers associated
2199 This uses the L<blockdev(8)> command.");
2201 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2202 [InitEmpty, Always, TestRun
2203 [["blockdev_rereadpt"; "/dev/sda"]]],
2204 "reread partition table",
2206 Reread the partition table on C<device>.
2208 This uses the L<blockdev(8)> command.");
2210 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2211 [InitBasicFS, Always, TestOutput (
2212 (* Pick a file from cwd which isn't likely to change. *)
2213 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2214 ["checksum"; "md5"; "/COPYING.LIB"]],
2215 Digest.to_hex (Digest.file "COPYING.LIB"))],
2216 "upload a file from the local machine",
2218 Upload local file C<filename> to C<remotefilename> on the
2221 C<filename> can also be a named pipe.
2223 See also C<guestfs_download>.");
2225 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2226 [InitBasicFS, Always, TestOutput (
2227 (* Pick a file from cwd which isn't likely to change. *)
2228 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2229 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2230 ["upload"; "testdownload.tmp"; "/upload"];
2231 ["checksum"; "md5"; "/upload"]],
2232 Digest.to_hex (Digest.file "COPYING.LIB"))],
2233 "download a file to the local machine",
2235 Download file C<remotefilename> and save it as C<filename>
2236 on the local machine.
2238 C<filename> can also be a named pipe.
2240 See also C<guestfs_upload>, C<guestfs_cat>.");
2242 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2243 [InitISOFS, Always, TestOutput (
2244 [["checksum"; "crc"; "/known-3"]], "2891671662");
2245 InitISOFS, Always, TestLastFail (
2246 [["checksum"; "crc"; "/notexists"]]);
2247 InitISOFS, Always, TestOutput (
2248 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2249 InitISOFS, Always, TestOutput (
2250 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2251 InitISOFS, Always, TestOutput (
2252 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2253 InitISOFS, Always, TestOutput (
2254 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2255 InitISOFS, Always, TestOutput (
2256 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2257 InitISOFS, Always, TestOutput (
2258 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2259 (* Test for RHBZ#579608, absolute symbolic links. *)
2260 InitISOFS, Always, TestOutput (
2261 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2262 "compute MD5, SHAx or CRC checksum of file",
2264 This call computes the MD5, SHAx or CRC checksum of the
2267 The type of checksum to compute is given by the C<csumtype>
2268 parameter which must have one of the following values:
2274 Compute the cyclic redundancy check (CRC) specified by POSIX
2275 for the C<cksum> command.
2279 Compute the MD5 hash (using the C<md5sum> program).
2283 Compute the SHA1 hash (using the C<sha1sum> program).
2287 Compute the SHA224 hash (using the C<sha224sum> program).
2291 Compute the SHA256 hash (using the C<sha256sum> program).
2295 Compute the SHA384 hash (using the C<sha384sum> program).
2299 Compute the SHA512 hash (using the C<sha512sum> program).
2303 The checksum is returned as a printable string.
2305 To get the checksum for a device, use C<guestfs_checksum_device>.
2307 To get the checksums for many files, use C<guestfs_checksums_out>.");
2309 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2310 [InitBasicFS, Always, TestOutput (
2311 [["tar_in"; "../images/helloworld.tar"; "/"];
2312 ["cat"; "/hello"]], "hello\n")],
2313 "unpack tarfile to directory",
2315 This command uploads and unpacks local file C<tarfile> (an
2316 I<uncompressed> tar file) into C<directory>.
2318 To upload a compressed tarball, use C<guestfs_tgz_in>
2319 or C<guestfs_txz_in>.");
2321 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2323 "pack directory into tarfile",
2325 This command packs the contents of C<directory> and downloads
2326 it to local file C<tarfile>.
2328 To download a compressed tarball, use C<guestfs_tgz_out>
2329 or C<guestfs_txz_out>.");
2331 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2332 [InitBasicFS, Always, TestOutput (
2333 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2334 ["cat"; "/hello"]], "hello\n")],
2335 "unpack compressed tarball to directory",
2337 This command uploads and unpacks local file C<tarball> (a
2338 I<gzip compressed> tar file) into C<directory>.
2340 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2342 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2344 "pack directory into compressed tarball",
2346 This command packs the contents of C<directory> and downloads
2347 it to local file C<tarball>.
2349 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2351 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2352 [InitBasicFS, Always, TestLastFail (
2354 ["mount_ro"; "/dev/sda1"; "/"];
2355 ["touch"; "/new"]]);
2356 InitBasicFS, Always, TestOutput (
2357 [["write"; "/new"; "data"];
2359 ["mount_ro"; "/dev/sda1"; "/"];
2360 ["cat"; "/new"]], "data")],
2361 "mount a guest disk, read-only",
2363 This is the same as the C<guestfs_mount> command, but it
2364 mounts the filesystem with the read-only (I<-o ro>) flag.");
2366 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2368 "mount a guest disk with mount options",
2370 This is the same as the C<guestfs_mount> command, but it
2371 allows you to set the mount options as for the
2372 L<mount(8)> I<-o> flag.
2374 If the C<options> parameter is an empty string, then
2375 no options are passed (all options default to whatever
2376 the filesystem uses).");
2378 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2380 "mount a guest disk with mount options and vfstype",
2382 This is the same as the C<guestfs_mount> command, but it
2383 allows you to set both the mount options and the vfstype
2384 as for the L<mount(8)> I<-o> and I<-t> flags.");
2386 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2388 "debugging and internals",
2390 The C<guestfs_debug> command exposes some internals of
2391 C<guestfsd> (the guestfs daemon) that runs inside the
2394 There is no comprehensive help for this command. You have
2395 to look at the file C<daemon/debug.c> in the libguestfs source
2396 to find out what you can do.");
2398 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2399 [InitEmpty, Always, TestOutputList (
2400 [["part_disk"; "/dev/sda"; "mbr"];
2401 ["pvcreate"; "/dev/sda1"];
2402 ["vgcreate"; "VG"; "/dev/sda1"];
2403 ["lvcreate"; "LV1"; "VG"; "50"];
2404 ["lvcreate"; "LV2"; "VG"; "50"];
2405 ["lvremove"; "/dev/VG/LV1"];
2406 ["lvs"]], ["/dev/VG/LV2"]);
2407 InitEmpty, Always, TestOutputList (
2408 [["part_disk"; "/dev/sda"; "mbr"];
2409 ["pvcreate"; "/dev/sda1"];
2410 ["vgcreate"; "VG"; "/dev/sda1"];
2411 ["lvcreate"; "LV1"; "VG"; "50"];
2412 ["lvcreate"; "LV2"; "VG"; "50"];
2413 ["lvremove"; "/dev/VG"];
2415 InitEmpty, Always, TestOutputList (
2416 [["part_disk"; "/dev/sda"; "mbr"];
2417 ["pvcreate"; "/dev/sda1"];
2418 ["vgcreate"; "VG"; "/dev/sda1"];
2419 ["lvcreate"; "LV1"; "VG"; "50"];
2420 ["lvcreate"; "LV2"; "VG"; "50"];
2421 ["lvremove"; "/dev/VG"];
2423 "remove an LVM logical volume",
2425 Remove an LVM logical volume C<device>, where C<device> is
2426 the path to the LV, such as C</dev/VG/LV>.
2428 You can also remove all LVs in a volume group by specifying
2429 the VG name, C</dev/VG>.");
2431 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2432 [InitEmpty, Always, TestOutputList (
2433 [["part_disk"; "/dev/sda"; "mbr"];
2434 ["pvcreate"; "/dev/sda1"];
2435 ["vgcreate"; "VG"; "/dev/sda1"];
2436 ["lvcreate"; "LV1"; "VG"; "50"];
2437 ["lvcreate"; "LV2"; "VG"; "50"];
2440 InitEmpty, Always, TestOutputList (
2441 [["part_disk"; "/dev/sda"; "mbr"];
2442 ["pvcreate"; "/dev/sda1"];
2443 ["vgcreate"; "VG"; "/dev/sda1"];
2444 ["lvcreate"; "LV1"; "VG"; "50"];
2445 ["lvcreate"; "LV2"; "VG"; "50"];
2448 "remove an LVM volume group",
2450 Remove an LVM volume group C<vgname>, (for example C<VG>).
2452 This also forcibly removes all logical volumes in the volume
2455 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2456 [InitEmpty, Always, TestOutputListOfDevices (
2457 [["part_disk"; "/dev/sda"; "mbr"];
2458 ["pvcreate"; "/dev/sda1"];
2459 ["vgcreate"; "VG"; "/dev/sda1"];
2460 ["lvcreate"; "LV1"; "VG"; "50"];
2461 ["lvcreate"; "LV2"; "VG"; "50"];
2463 ["pvremove"; "/dev/sda1"];
2465 InitEmpty, Always, TestOutputListOfDevices (
2466 [["part_disk"; "/dev/sda"; "mbr"];
2467 ["pvcreate"; "/dev/sda1"];
2468 ["vgcreate"; "VG"; "/dev/sda1"];
2469 ["lvcreate"; "LV1"; "VG"; "50"];
2470 ["lvcreate"; "LV2"; "VG"; "50"];
2472 ["pvremove"; "/dev/sda1"];
2474 InitEmpty, Always, TestOutputListOfDevices (
2475 [["part_disk"; "/dev/sda"; "mbr"];
2476 ["pvcreate"; "/dev/sda1"];
2477 ["vgcreate"; "VG"; "/dev/sda1"];
2478 ["lvcreate"; "LV1"; "VG"; "50"];
2479 ["lvcreate"; "LV2"; "VG"; "50"];
2481 ["pvremove"; "/dev/sda1"];
2483 "remove an LVM physical volume",
2485 This wipes a physical volume C<device> so that LVM will no longer
2488 The implementation uses the C<pvremove> command which refuses to
2489 wipe physical volumes that contain any volume groups, so you have
2490 to remove those first.");
2492 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2493 [InitBasicFS, Always, TestOutput (
2494 [["set_e2label"; "/dev/sda1"; "testlabel"];
2495 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2496 "set the ext2/3/4 filesystem label",
2498 This sets the ext2/3/4 filesystem label of the filesystem on
2499 C<device> to C<label>. Filesystem labels are limited to
2502 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2503 to return the existing label on a filesystem.");
2505 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2507 "get the ext2/3/4 filesystem label",
2509 This returns the ext2/3/4 filesystem label of the filesystem on
2512 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2513 (let uuid = uuidgen () in
2514 [InitBasicFS, Always, TestOutput (
2515 [["set_e2uuid"; "/dev/sda1"; uuid];
2516 ["get_e2uuid"; "/dev/sda1"]], uuid);
2517 InitBasicFS, Always, TestOutput (
2518 [["set_e2uuid"; "/dev/sda1"; "clear"];
2519 ["get_e2uuid"; "/dev/sda1"]], "");
2520 (* We can't predict what UUIDs will be, so just check the commands run. *)
2521 InitBasicFS, Always, TestRun (
2522 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2523 InitBasicFS, Always, TestRun (
2524 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2525 "set the ext2/3/4 filesystem UUID",
2527 This sets the ext2/3/4 filesystem UUID of the filesystem on
2528 C<device> to C<uuid>. The format of the UUID and alternatives
2529 such as C<clear>, C<random> and C<time> are described in the
2530 L<tune2fs(8)> manpage.
2532 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2533 to return the existing UUID of a filesystem.");
2535 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2536 (* Regression test for RHBZ#597112. *)
2537 (let uuid = uuidgen () in
2538 [InitBasicFS, Always, TestOutput (
2539 [["mke2journal"; "1024"; "/dev/sdb"];
2540 ["set_e2uuid"; "/dev/sdb"; uuid];
2541 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2542 "get the ext2/3/4 filesystem UUID",
2544 This returns the ext2/3/4 filesystem UUID of the filesystem on
2547 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2548 [InitBasicFS, Always, TestOutputInt (
2549 [["umount"; "/dev/sda1"];
2550 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2551 InitBasicFS, Always, TestOutputInt (
2552 [["umount"; "/dev/sda1"];
2553 ["zero"; "/dev/sda1"];
2554 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2555 "run the filesystem checker",
2557 This runs the filesystem checker (fsck) on C<device> which
2558 should have filesystem type C<fstype>.
2560 The returned integer is the status. See L<fsck(8)> for the
2561 list of status codes from C<fsck>.
2569 Multiple status codes can be summed together.
2573 A non-zero return code can mean \"success\", for example if
2574 errors have been corrected on the filesystem.
2578 Checking or repairing NTFS volumes is not supported
2583 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2585 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2586 [InitBasicFS, Always, TestOutput (
2587 [["umount"; "/dev/sda1"];
2588 ["zero"; "/dev/sda1"];
2589 ["file"; "/dev/sda1"]], "data")],
2590 "write zeroes to the device",
2592 This command writes zeroes over the first few blocks of C<device>.
2594 How many blocks are zeroed isn't specified (but it's I<not> enough
2595 to securely wipe the device). It should be sufficient to remove
2596 any partition tables, filesystem superblocks and so on.
2598 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2600 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2602 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2603 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2605 [InitBasicFS, Always, TestOutputTrue (
2606 [["mkdir_p"; "/boot/grub"];
2607 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2608 ["grub_install"; "/"; "/dev/vda"];
2609 ["is_dir"; "/boot"]])],
2612 This command installs GRUB (the Grand Unified Bootloader) on
2613 C<device>, with the root directory being C<root>.
2615 Note: If grub-install reports the error
2616 \"No suitable drive was found in the generated device map.\"
2617 it may be that you need to create a C</boot/grub/device.map>
2618 file first that contains the mapping between grub device names
2619 and Linux device names. It is usually sufficient to create
2624 replacing C</dev/vda> with the name of the installation device.");
2626 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2627 [InitBasicFS, Always, TestOutput (
2628 [["write"; "/old"; "file content"];
2629 ["cp"; "/old"; "/new"];
2630 ["cat"; "/new"]], "file content");
2631 InitBasicFS, Always, TestOutputTrue (
2632 [["write"; "/old"; "file content"];
2633 ["cp"; "/old"; "/new"];
2634 ["is_file"; "/old"]]);
2635 InitBasicFS, Always, TestOutput (
2636 [["write"; "/old"; "file content"];
2638 ["cp"; "/old"; "/dir/new"];
2639 ["cat"; "/dir/new"]], "file content")],
2642 This copies a file from C<src> to C<dest> where C<dest> is
2643 either a destination filename or destination directory.");
2645 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2646 [InitBasicFS, Always, TestOutput (
2647 [["mkdir"; "/olddir"];
2648 ["mkdir"; "/newdir"];
2649 ["write"; "/olddir/file"; "file content"];
2650 ["cp_a"; "/olddir"; "/newdir"];
2651 ["cat"; "/newdir/olddir/file"]], "file content")],
2652 "copy a file or directory recursively",
2654 This copies a file or directory from C<src> to C<dest>
2655 recursively using the C<cp -a> command.");
2657 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2658 [InitBasicFS, Always, TestOutput (
2659 [["write"; "/old"; "file content"];
2660 ["mv"; "/old"; "/new"];
2661 ["cat"; "/new"]], "file content");
2662 InitBasicFS, Always, TestOutputFalse (
2663 [["write"; "/old"; "file content"];
2664 ["mv"; "/old"; "/new"];
2665 ["is_file"; "/old"]])],
2668 This moves a file from C<src> to C<dest> where C<dest> is
2669 either a destination filename or destination directory.");
2671 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2672 [InitEmpty, Always, TestRun (
2673 [["drop_caches"; "3"]])],
2674 "drop kernel page cache, dentries and inodes",
2676 This instructs the guest kernel to drop its page cache,
2677 and/or dentries and inode caches. The parameter C<whattodrop>
2678 tells the kernel what precisely to drop, see
2679 L<http://linux-mm.org/Drop_Caches>
2681 Setting C<whattodrop> to 3 should drop everything.
2683 This automatically calls L<sync(2)> before the operation,
2684 so that the maximum guest memory is freed.");
2686 ("dmesg", (RString "kmsgs", [], []), 91, [],
2687 [InitEmpty, Always, TestRun (
2689 "return kernel messages",
2691 This returns the kernel messages (C<dmesg> output) from
2692 the guest kernel. This is sometimes useful for extended
2693 debugging of problems.
2695 Another way to get the same information is to enable
2696 verbose messages with C<guestfs_set_verbose> or by setting
2697 the environment variable C<LIBGUESTFS_DEBUG=1> before
2698 running the program.");
2700 ("ping_daemon", (RErr, [], []), 92, [],
2701 [InitEmpty, Always, TestRun (
2702 [["ping_daemon"]])],
2703 "ping the guest daemon",
2705 This is a test probe into the guestfs daemon running inside
2706 the qemu subprocess. Calling this function checks that the
2707 daemon responds to the ping message, without affecting the daemon
2708 or attached block device(s) in any other way.");
2710 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2711 [InitBasicFS, Always, TestOutputTrue (
2712 [["write"; "/file1"; "contents of a file"];
2713 ["cp"; "/file1"; "/file2"];
2714 ["equal"; "/file1"; "/file2"]]);
2715 InitBasicFS, Always, TestOutputFalse (
2716 [["write"; "/file1"; "contents of a file"];
2717 ["write"; "/file2"; "contents of another file"];
2718 ["equal"; "/file1"; "/file2"]]);
2719 InitBasicFS, Always, TestLastFail (
2720 [["equal"; "/file1"; "/file2"]])],
2721 "test if two files have equal contents",
2723 This compares the two files C<file1> and C<file2> and returns
2724 true if their content is exactly equal, or false otherwise.
2726 The external L<cmp(1)> program is used for the comparison.");
2728 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2729 [InitISOFS, Always, TestOutputList (
2730 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2731 InitISOFS, Always, TestOutputList (
2732 [["strings"; "/empty"]], []);
2733 (* Test for RHBZ#579608, absolute symbolic links. *)
2734 InitISOFS, Always, TestRun (
2735 [["strings"; "/abssymlink"]])],
2736 "print the printable strings in a file",
2738 This runs the L<strings(1)> command on a file and returns
2739 the list of printable strings found.");
2741 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2742 [InitISOFS, Always, TestOutputList (
2743 [["strings_e"; "b"; "/known-5"]], []);
2744 InitBasicFS, Always, TestOutputList (
2745 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2746 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2747 "print the printable strings in a file",
2749 This is like the C<guestfs_strings> command, but allows you to
2750 specify the encoding of strings that are looked for in
2751 the source file C<path>.
2753 Allowed encodings are:
2759 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2760 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2764 Single 8-bit-byte characters.
2768 16-bit big endian strings such as those encoded in
2769 UTF-16BE or UCS-2BE.
2771 =item l (lower case letter L)
2773 16-bit little endian such as UTF-16LE and UCS-2LE.
2774 This is useful for examining binaries in Windows guests.
2778 32-bit big endian such as UCS-4BE.
2782 32-bit little endian such as UCS-4LE.
2786 The returned strings are transcoded to UTF-8.");
2788 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2789 [InitISOFS, Always, TestOutput (
2790 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2791 (* Test for RHBZ#501888c2 regression which caused large hexdump
2792 * commands to segfault.
2794 InitISOFS, Always, TestRun (
2795 [["hexdump"; "/100krandom"]]);
2796 (* Test for RHBZ#579608, absolute symbolic links. *)
2797 InitISOFS, Always, TestRun (
2798 [["hexdump"; "/abssymlink"]])],
2799 "dump a file in hexadecimal",
2801 This runs C<hexdump -C> on the given C<path>. The result is
2802 the human-readable, canonical hex dump of the file.");
2804 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2805 [InitNone, Always, TestOutput (
2806 [["part_disk"; "/dev/sda"; "mbr"];
2807 ["mkfs"; "ext3"; "/dev/sda1"];
2808 ["mount_options"; ""; "/dev/sda1"; "/"];
2809 ["write"; "/new"; "test file"];
2810 ["umount"; "/dev/sda1"];
2811 ["zerofree"; "/dev/sda1"];
2812 ["mount_options"; ""; "/dev/sda1"; "/"];
2813 ["cat"; "/new"]], "test file")],
2814 "zero unused inodes and disk blocks on ext2/3 filesystem",
2816 This runs the I<zerofree> program on C<device>. This program
2817 claims to zero unused inodes and disk blocks on an ext2/3
2818 filesystem, thus making it possible to compress the filesystem
2821 You should B<not> run this program if the filesystem is
2824 It is possible that using this program can damage the filesystem
2825 or data on the filesystem.");
2827 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2829 "resize an LVM physical volume",
2831 This resizes (expands or shrinks) an existing LVM physical
2832 volume to match the new size of the underlying device.");
2834 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2835 Int "cyls"; Int "heads"; Int "sectors";
2836 String "line"], []), 99, [DangerWillRobinson],
2838 "modify a single partition on a block device",
2840 This runs L<sfdisk(8)> option to modify just the single
2841 partition C<n> (note: C<n> counts from 1).
2843 For other parameters, see C<guestfs_sfdisk>. You should usually
2844 pass C<0> for the cyls/heads/sectors parameters.
2846 See also: C<guestfs_part_add>");
2848 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2850 "display the partition table",
2852 This displays the partition table on C<device>, in the
2853 human-readable output of the L<sfdisk(8)> command. It is
2854 not intended to be parsed.
2856 See also: C<guestfs_part_list>");
2858 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2860 "display the kernel geometry",
2862 This displays the kernel's idea of the geometry of C<device>.
2864 The result is in human-readable format, and not designed to
2867 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2869 "display the disk geometry from the partition table",
2871 This displays the disk geometry of C<device> read from the
2872 partition table. Especially in the case where the underlying
2873 block device has been resized, this can be different from the
2874 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2876 The result is in human-readable format, and not designed to
2879 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2881 "activate or deactivate all volume groups",
2883 This command activates or (if C<activate> is false) deactivates
2884 all logical volumes in all volume groups.
2885 If activated, then they are made known to the
2886 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2887 then those devices disappear.
2889 This command is the same as running C<vgchange -a y|n>");
2891 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
2893 "activate or deactivate some volume groups",
2895 This command activates or (if C<activate> is false) deactivates
2896 all logical volumes in the listed volume groups C<volgroups>.
2897 If activated, then they are made known to the
2898 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2899 then those devices disappear.
2901 This command is the same as running C<vgchange -a y|n volgroups...>
2903 Note that if C<volgroups> is an empty list then B<all> volume groups
2904 are activated or deactivated.");
2906 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
2907 [InitNone, Always, TestOutput (
2908 [["part_disk"; "/dev/sda"; "mbr"];
2909 ["pvcreate"; "/dev/sda1"];
2910 ["vgcreate"; "VG"; "/dev/sda1"];
2911 ["lvcreate"; "LV"; "VG"; "10"];
2912 ["mkfs"; "ext2"; "/dev/VG/LV"];
2913 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2914 ["write"; "/new"; "test content"];
2916 ["lvresize"; "/dev/VG/LV"; "20"];
2917 ["e2fsck_f"; "/dev/VG/LV"];
2918 ["resize2fs"; "/dev/VG/LV"];
2919 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2920 ["cat"; "/new"]], "test content");
2921 InitNone, Always, TestRun (
2922 (* Make an LV smaller to test RHBZ#587484. *)
2923 [["part_disk"; "/dev/sda"; "mbr"];
2924 ["pvcreate"; "/dev/sda1"];
2925 ["vgcreate"; "VG"; "/dev/sda1"];
2926 ["lvcreate"; "LV"; "VG"; "20"];
2927 ["lvresize"; "/dev/VG/LV"; "10"]])],
2928 "resize an LVM logical volume",
2930 This resizes (expands or shrinks) an existing LVM logical
2931 volume to C<mbytes>. When reducing, data in the reduced part
2934 ("resize2fs", (RErr, [Device "device"], []), 106, [],
2935 [], (* lvresize tests this *)
2936 "resize an ext2, ext3 or ext4 filesystem",
2938 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2939 the underlying device.
2941 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2942 on the C<device> before calling this command. For unknown reasons
2943 C<resize2fs> sometimes gives an error about this and sometimes not.
2944 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2945 calling this function.");
2947 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
2948 [InitBasicFS, Always, TestOutputList (
2949 [["find"; "/"]], ["lost+found"]);
2950 InitBasicFS, Always, TestOutputList (
2954 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2955 InitBasicFS, Always, TestOutputList (
2956 [["mkdir_p"; "/a/b/c"];
2957 ["touch"; "/a/b/c/d"];
2958 ["find"; "/a/b/"]], ["c"; "c/d"])],
2959 "find all files and directories",
2961 This command lists out all files and directories, recursively,
2962 starting at C<directory>. It is essentially equivalent to
2963 running the shell command C<find directory -print> but some
2964 post-processing happens on the output, described below.
2966 This returns a list of strings I<without any prefix>. Thus
2967 if the directory structure was:
2973 then the returned list from C<guestfs_find> C</tmp> would be
2981 If C<directory> is not a directory, then this command returns
2984 The returned list is sorted.
2986 See also C<guestfs_find0>.");
2988 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
2989 [], (* lvresize tests this *)
2990 "check an ext2/ext3 filesystem",
2992 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2993 filesystem checker on C<device>, noninteractively (C<-p>),
2994 even if the filesystem appears to be clean (C<-f>).
2996 This command is only needed because of C<guestfs_resize2fs>
2997 (q.v.). Normally you should use C<guestfs_fsck>.");
2999 ("sleep", (RErr, [Int "secs"], []), 109, [],
3000 [InitNone, Always, TestRun (
3002 "sleep for some seconds",
3004 Sleep for C<secs> seconds.");
3006 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3007 [InitNone, Always, TestOutputInt (
3008 [["part_disk"; "/dev/sda"; "mbr"];
3009 ["mkfs"; "ntfs"; "/dev/sda1"];
3010 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3011 InitNone, Always, TestOutputInt (
3012 [["part_disk"; "/dev/sda"; "mbr"];
3013 ["mkfs"; "ext2"; "/dev/sda1"];
3014 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3015 "probe NTFS volume",
3017 This command runs the L<ntfs-3g.probe(8)> command which probes
3018 an NTFS C<device> for mountability. (Not all NTFS volumes can
3019 be mounted read-write, and some cannot be mounted at all).
3021 C<rw> is a boolean flag. Set it to true if you want to test
3022 if the volume can be mounted read-write. Set it to false if
3023 you want to test if the volume can be mounted read-only.
3025 The return value is an integer which C<0> if the operation
3026 would succeed, or some non-zero value documented in the
3027 L<ntfs-3g.probe(8)> manual page.");
3029 ("sh", (RString "output", [String "command"], []), 111, [],
3030 [], (* XXX needs tests *)
3031 "run a command via the shell",
3033 This call runs a command from the guest filesystem via the
3036 This is like C<guestfs_command>, but passes the command to:
3038 /bin/sh -c \"command\"
3040 Depending on the guest's shell, this usually results in
3041 wildcards being expanded, shell expressions being interpolated
3044 All the provisos about C<guestfs_command> apply to this call.");
3046 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3047 [], (* XXX needs tests *)
3048 "run a command via the shell returning lines",
3050 This is the same as C<guestfs_sh>, but splits the result
3051 into a list of lines.
3053 See also: C<guestfs_command_lines>");
3055 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3056 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3057 * code in stubs.c, since all valid glob patterns must start with "/".
3058 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3060 [InitBasicFS, Always, TestOutputList (
3061 [["mkdir_p"; "/a/b/c"];
3062 ["touch"; "/a/b/c/d"];
3063 ["touch"; "/a/b/c/e"];
3064 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3065 InitBasicFS, Always, TestOutputList (
3066 [["mkdir_p"; "/a/b/c"];
3067 ["touch"; "/a/b/c/d"];
3068 ["touch"; "/a/b/c/e"];
3069 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3070 InitBasicFS, Always, TestOutputList (
3071 [["mkdir_p"; "/a/b/c"];
3072 ["touch"; "/a/b/c/d"];
3073 ["touch"; "/a/b/c/e"];
3074 ["glob_expand"; "/a/*/x/*"]], [])],
3075 "expand a wildcard path",
3077 This command searches for all the pathnames matching
3078 C<pattern> according to the wildcard expansion rules
3081 If no paths match, then this returns an empty list
3082 (note: not an error).
3084 It is just a wrapper around the C L<glob(3)> function
3085 with flags C<GLOB_MARK|GLOB_BRACE>.
3086 See that manual page for more details.");
3088 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3089 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3090 [["scrub_device"; "/dev/sdc"]])],
3091 "scrub (securely wipe) a device",
3093 This command writes patterns over C<device> to make data retrieval
3096 It is an interface to the L<scrub(1)> program. See that
3097 manual page for more details.");
3099 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3100 [InitBasicFS, Always, TestRun (
3101 [["write"; "/file"; "content"];
3102 ["scrub_file"; "/file"]])],
3103 "scrub (securely wipe) a file",
3105 This command writes patterns over a file to make data retrieval
3108 The file is I<removed> after scrubbing.
3110 It is an interface to the L<scrub(1)> program. See that
3111 manual page for more details.");
3113 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3114 [], (* XXX needs testing *)
3115 "scrub (securely wipe) free space",
3117 This command creates the directory C<dir> and then fills it
3118 with files until the filesystem is full, and scrubs the files
3119 as for C<guestfs_scrub_file>, and deletes them.
3120 The intention is to scrub any free space on the partition
3123 It is an interface to the L<scrub(1)> program. See that
3124 manual page for more details.");
3126 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3127 [InitBasicFS, Always, TestRun (
3129 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
3130 "create a temporary directory",
3132 This command creates a temporary directory. The
3133 C<template> parameter should be a full pathname for the
3134 temporary directory name with the final six characters being
3137 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3138 the second one being suitable for Windows filesystems.
3140 The name of the temporary directory that was created
3143 The temporary directory is created with mode 0700
3144 and is owned by root.
3146 The caller is responsible for deleting the temporary
3147 directory and its contents after use.
3149 See also: L<mkdtemp(3)>");
3151 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3152 [InitISOFS, Always, TestOutputInt (
3153 [["wc_l"; "/10klines"]], 10000);
3154 (* Test for RHBZ#579608, absolute symbolic links. *)
3155 InitISOFS, Always, TestOutputInt (
3156 [["wc_l"; "/abssymlink"]], 10000)],
3157 "count lines in a file",
3159 This command counts the lines in a file, using the
3160 C<wc -l> external command.");
3162 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3163 [InitISOFS, Always, TestOutputInt (
3164 [["wc_w"; "/10klines"]], 10000)],
3165 "count words in a file",
3167 This command counts the words in a file, using the
3168 C<wc -w> external command.");
3170 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3171 [InitISOFS, Always, TestOutputInt (
3172 [["wc_c"; "/100kallspaces"]], 102400)],
3173 "count characters in a file",
3175 This command counts the characters in a file, using the
3176 C<wc -c> external command.");
3178 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3179 [InitISOFS, Always, TestOutputList (
3180 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3181 (* Test for RHBZ#579608, absolute symbolic links. *)
3182 InitISOFS, Always, TestOutputList (
3183 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3184 "return first 10 lines of a file",
3186 This command returns up to the first 10 lines of a file as
3187 a list of strings.");
3189 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3190 [InitISOFS, Always, TestOutputList (
3191 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3192 InitISOFS, Always, TestOutputList (
3193 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3194 InitISOFS, Always, TestOutputList (
3195 [["head_n"; "0"; "/10klines"]], [])],
3196 "return first N lines of a file",
3198 If the parameter C<nrlines> is a positive number, this returns the first
3199 C<nrlines> lines of the file C<path>.
3201 If the parameter C<nrlines> is a negative number, this returns lines
3202 from the file C<path>, excluding the last C<nrlines> lines.
3204 If the parameter C<nrlines> is zero, this returns an empty list.");
3206 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3207 [InitISOFS, Always, TestOutputList (
3208 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3209 "return last 10 lines of a file",
3211 This command returns up to the last 10 lines of a file as
3212 a list of strings.");
3214 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3215 [InitISOFS, Always, TestOutputList (
3216 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3217 InitISOFS, Always, TestOutputList (
3218 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3219 InitISOFS, Always, TestOutputList (
3220 [["tail_n"; "0"; "/10klines"]], [])],
3221 "return last N lines of a file",
3223 If the parameter C<nrlines> is a positive number, this returns the last
3224 C<nrlines> lines of the file C<path>.
3226 If the parameter C<nrlines> is a negative number, this returns lines
3227 from the file C<path>, starting with the C<-nrlines>th line.
3229 If the parameter C<nrlines> is zero, this returns an empty list.");
3231 ("df", (RString "output", [], []), 125, [],
3232 [], (* XXX Tricky to test because it depends on the exact format
3233 * of the 'df' command and other imponderables.
3235 "report file system disk space usage",
3237 This command runs the C<df> command to report disk space used.
3239 This command is mostly useful for interactive sessions. It
3240 is I<not> intended that you try to parse the output string.
3241 Use C<statvfs> from programs.");
3243 ("df_h", (RString "output", [], []), 126, [],
3244 [], (* XXX Tricky to test because it depends on the exact format
3245 * of the 'df' command and other imponderables.
3247 "report file system disk space usage (human readable)",
3249 This command runs the C<df -h> command to report disk space used
3250 in human-readable format.
3252 This command is mostly useful for interactive sessions. It
3253 is I<not> intended that you try to parse the output string.
3254 Use C<statvfs> from programs.");
3256 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3257 [InitISOFS, Always, TestOutputInt (
3258 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3259 "estimate file space usage",
3261 This command runs the C<du -s> command to estimate file space
3264 C<path> can be a file or a directory. If C<path> is a directory
3265 then the estimate includes the contents of the directory and all
3266 subdirectories (recursively).
3268 The result is the estimated size in I<kilobytes>
3269 (ie. units of 1024 bytes).");
3271 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3272 [InitISOFS, Always, TestOutputList (
3273 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3274 "list files in an initrd",
3276 This command lists out files contained in an initrd.
3278 The files are listed without any initial C</> character. The
3279 files are listed in the order they appear (not necessarily
3280 alphabetical). Directory names are listed as separate items.
3282 Old Linux kernels (2.4 and earlier) used a compressed ext2
3283 filesystem as initrd. We I<only> support the newer initramfs
3284 format (compressed cpio files).");
3286 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3288 "mount a file using the loop device",
3290 This command lets you mount C<file> (a filesystem image
3291 in a file) on a mount point. It is entirely equivalent to
3292 the command C<mount -o loop file mountpoint>.");
3294 ("mkswap", (RErr, [Device "device"], []), 130, [],
3295 [InitEmpty, Always, TestRun (
3296 [["part_disk"; "/dev/sda"; "mbr"];
3297 ["mkswap"; "/dev/sda1"]])],
3298 "create a swap partition",
3300 Create a swap partition on C<device>.");
3302 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3303 [InitEmpty, Always, TestRun (
3304 [["part_disk"; "/dev/sda"; "mbr"];
3305 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3306 "create a swap partition with a label",
3308 Create a swap partition on C<device> with label C<label>.
3310 Note that you cannot attach a swap label to a block device
3311 (eg. C</dev/sda>), just to a partition. This appears to be
3312 a limitation of the kernel or swap tools.");
3314 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3315 (let uuid = uuidgen () in
3316 [InitEmpty, Always, TestRun (
3317 [["part_disk"; "/dev/sda"; "mbr"];
3318 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3319 "create a swap partition with an explicit UUID",
3321 Create a swap partition on C<device> with UUID C<uuid>.");
3323 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3324 [InitBasicFS, Always, TestOutputStruct (
3325 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3326 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3327 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3328 InitBasicFS, Always, TestOutputStruct (
3329 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3330 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3331 "make block, character or FIFO devices",
3333 This call creates block or character special devices, or
3334 named pipes (FIFOs).
3336 The C<mode> parameter should be the mode, using the standard
3337 constants. C<devmajor> and C<devminor> are the
3338 device major and minor numbers, only used when creating block
3339 and character special devices.
3341 Note that, just like L<mknod(2)>, the mode must be bitwise
3342 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3343 just creates a regular file). These constants are
3344 available in the standard Linux header files, or you can use
3345 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3346 which are wrappers around this command which bitwise OR
3347 in the appropriate constant for you.
3349 The mode actually set is affected by the umask.");
3351 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3352 [InitBasicFS, Always, TestOutputStruct (
3353 [["mkfifo"; "0o777"; "/node"];
3354 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3355 "make FIFO (named pipe)",
3357 This call creates a FIFO (named pipe) called C<path> with
3358 mode C<mode>. It is just a convenient wrapper around
3361 The mode actually set is affected by the umask.");
3363 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3364 [InitBasicFS, Always, TestOutputStruct (
3365 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3366 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3367 "make block device node",
3369 This call creates a block device node called C<path> with
3370 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3371 It is just a convenient wrapper around C<guestfs_mknod>.
3373 The mode actually set is affected by the umask.");
3375 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3376 [InitBasicFS, Always, TestOutputStruct (
3377 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3378 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3379 "make char device node",
3381 This call creates a char device node called C<path> with
3382 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3383 It is just a convenient wrapper around C<guestfs_mknod>.
3385 The mode actually set is affected by the umask.");
3387 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3388 [InitEmpty, Always, TestOutputInt (
3389 [["umask"; "0o22"]], 0o22)],
3390 "set file mode creation mask (umask)",
3392 This function sets the mask used for creating new files and
3393 device nodes to C<mask & 0777>.
3395 Typical umask values would be C<022> which creates new files
3396 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3397 C<002> which creates new files with permissions like
3398 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3400 The default umask is C<022>. This is important because it
3401 means that directories and device nodes will be created with
3402 C<0644> or C<0755> mode even if you specify C<0777>.
3404 See also C<guestfs_get_umask>,
3405 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3407 This call returns the previous umask.");
3409 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3411 "read directories entries",
3413 This returns the list of directory entries in directory C<dir>.
3415 All entries in the directory are returned, including C<.> and
3416 C<..>. The entries are I<not> sorted, but returned in the same
3417 order as the underlying filesystem.
3419 Also this call returns basic file type information about each
3420 file. The C<ftyp> field will contain one of the following characters:
3458 The L<readdir(3)> call returned a C<d_type> field with an
3463 This function is primarily intended for use by programs. To
3464 get a simple list of names, use C<guestfs_ls>. To get a printable
3465 directory for human consumption, use C<guestfs_ll>.");
3467 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3469 "create partitions on a block device",
3471 This is a simplified interface to the C<guestfs_sfdisk>
3472 command, where partition sizes are specified in megabytes
3473 only (rounded to the nearest cylinder) and you don't need
3474 to specify the cyls, heads and sectors parameters which
3475 were rarely if ever used anyway.
3477 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3478 and C<guestfs_part_disk>");
3480 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3482 "determine file type inside a compressed file",
3484 This command runs C<file> after first decompressing C<path>
3487 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3489 Since 1.0.63, use C<guestfs_file> instead which can now
3490 process compressed files.");
3492 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3494 "list extended attributes of a file or directory",
3496 This call lists the extended attributes of the file or directory
3499 At the system call level, this is a combination of the
3500 L<listxattr(2)> and L<getxattr(2)> calls.
3502 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3504 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3506 "list extended attributes of a file or directory",
3508 This is the same as C<guestfs_getxattrs>, but if C<path>
3509 is a symbolic link, then it returns the extended attributes
3510 of the link itself.");
3512 ("setxattr", (RErr, [String "xattr";
3513 String "val"; Int "vallen"; (* will be BufferIn *)
3514 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3516 "set extended attribute of a file or directory",
3518 This call sets the extended attribute named C<xattr>
3519 of the file C<path> to the value C<val> (of length C<vallen>).
3520 The value is arbitrary 8 bit data.
3522 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3524 ("lsetxattr", (RErr, [String "xattr";
3525 String "val"; Int "vallen"; (* will be BufferIn *)
3526 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3528 "set extended attribute of a file or directory",
3530 This is the same as C<guestfs_setxattr>, but if C<path>
3531 is a symbolic link, then it sets an extended attribute
3532 of the link itself.");
3534 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3536 "remove extended attribute of a file or directory",
3538 This call removes the extended attribute named C<xattr>
3539 of the file C<path>.
3541 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3543 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3545 "remove extended attribute of a file or directory",
3547 This is the same as C<guestfs_removexattr>, but if C<path>
3548 is a symbolic link, then it removes an extended attribute
3549 of the link itself.");
3551 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3555 This call is similar to C<guestfs_mounts>. That call returns
3556 a list of devices. This one returns a hash table (map) of
3557 device name to directory where the device is mounted.");
3559 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3560 (* This is a special case: while you would expect a parameter
3561 * of type "Pathname", that doesn't work, because it implies
3562 * NEED_ROOT in the generated calling code in stubs.c, and
3563 * this function cannot use NEED_ROOT.
3566 "create a mountpoint",
3568 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3569 specialized calls that can be used to create extra mountpoints
3570 before mounting the first filesystem.
3572 These calls are I<only> necessary in some very limited circumstances,
3573 mainly the case where you want to mount a mix of unrelated and/or
3574 read-only filesystems together.
3576 For example, live CDs often contain a \"Russian doll\" nest of
3577 filesystems, an ISO outer layer, with a squashfs image inside, with
3578 an ext2/3 image inside that. You can unpack this as follows
3581 add-ro Fedora-11-i686-Live.iso
3585 mkmountpoint /ext3fs
3587 mount-loop /cd/LiveOS/squashfs.img /sqsh
3588 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3590 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3592 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3593 You may get unexpected errors if you try to mix these calls. It is
3594 safest to manually unmount filesystems and remove mountpoints after use.
3596 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3597 longest first, so for this to work for manual mountpoints, you
3598 must ensure that the innermost mountpoints have the longest
3599 pathnames, as in the example code above.
3601 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3603 Autosync [see C<guestfs_set_autosync>, this is set by default on
3604 handles] means that C<guestfs_umount_all> is called when the handle
3605 is closed which can also trigger these issues.");
3607 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3609 "remove a mountpoint",
3611 This calls removes a mountpoint that was previously created
3612 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3613 for full details.");
3615 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3616 [InitISOFS, Always, TestOutputBuffer (
3617 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3618 (* Test various near large, large and too large files (RHBZ#589039). *)
3619 InitBasicFS, Always, TestLastFail (
3621 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3622 ["read_file"; "/a"]]);
3623 InitBasicFS, Always, TestLastFail (
3625 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3626 ["read_file"; "/a"]]);
3627 InitBasicFS, Always, TestLastFail (
3629 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3630 ["read_file"; "/a"]])],
3633 This calls returns the contents of the file C<path> as a
3636 Unlike C<guestfs_cat>, this function can correctly
3637 handle files that contain embedded ASCII NUL characters.
3638 However unlike C<guestfs_download>, this function is limited
3639 in the total size of file that can be handled.");
3641 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3642 [InitISOFS, Always, TestOutputList (
3643 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3644 InitISOFS, Always, TestOutputList (
3645 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3646 (* Test for RHBZ#579608, absolute symbolic links. *)
3647 InitISOFS, Always, TestOutputList (
3648 [["grep"; "nomatch"; "/abssymlink"]], [])],
3649 "return lines matching a pattern",
3651 This calls the external C<grep> program and returns the
3654 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3655 [InitISOFS, Always, TestOutputList (
3656 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3657 "return lines matching a pattern",
3659 This calls the external C<egrep> program and returns the
3662 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3663 [InitISOFS, Always, TestOutputList (
3664 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3665 "return lines matching a pattern",
3667 This calls the external C<fgrep> program and returns the
3670 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3671 [InitISOFS, Always, TestOutputList (
3672 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3673 "return lines matching a pattern",
3675 This calls the external C<grep -i> program and returns the
3678 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3679 [InitISOFS, Always, TestOutputList (
3680 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3681 "return lines matching a pattern",
3683 This calls the external C<egrep -i> program and returns the
3686 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3687 [InitISOFS, Always, TestOutputList (
3688 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3689 "return lines matching a pattern",
3691 This calls the external C<fgrep -i> program and returns the
3694 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3695 [InitISOFS, Always, TestOutputList (
3696 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3697 "return lines matching a pattern",
3699 This calls the external C<zgrep> program and returns the
3702 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3703 [InitISOFS, Always, TestOutputList (
3704 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3705 "return lines matching a pattern",
3707 This calls the external C<zegrep> program and returns the
3710 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3711 [InitISOFS, Always, TestOutputList (
3712 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3713 "return lines matching a pattern",
3715 This calls the external C<zfgrep> program and returns the
3718 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3719 [InitISOFS, Always, TestOutputList (
3720 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3721 "return lines matching a pattern",
3723 This calls the external C<zgrep -i> program and returns the
3726 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3727 [InitISOFS, Always, TestOutputList (
3728 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3729 "return lines matching a pattern",
3731 This calls the external C<zegrep -i> program and returns the
3734 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3735 [InitISOFS, Always, TestOutputList (
3736 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3737 "return lines matching a pattern",
3739 This calls the external C<zfgrep -i> program and returns the
3742 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3743 [InitISOFS, Always, TestOutput (
3744 [["realpath"; "/../directory"]], "/directory")],
3745 "canonicalized absolute pathname",
3747 Return the canonicalized absolute pathname of C<path>. The
3748 returned path has no C<.>, C<..> or symbolic link path elements.");
3750 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3751 [InitBasicFS, Always, TestOutputStruct (
3754 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3755 "create a hard link",
3757 This command creates a hard link using the C<ln> command.");
3759 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3760 [InitBasicFS, Always, TestOutputStruct (
3763 ["ln_f"; "/a"; "/b"];
3764 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3765 "create a hard link",
3767 This command creates a hard link using the C<ln -f> command.
3768 The C<-f> option removes the link (C<linkname>) if it exists already.");
3770 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3771 [InitBasicFS, Always, TestOutputStruct (
3773 ["ln_s"; "a"; "/b"];
3774 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3775 "create a symbolic link",
3777 This command creates a symbolic link using the C<ln -s> command.");
3779 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3780 [InitBasicFS, Always, TestOutput (
3781 [["mkdir_p"; "/a/b"];
3782 ["touch"; "/a/b/c"];
3783 ["ln_sf"; "../d"; "/a/b/c"];
3784 ["readlink"; "/a/b/c"]], "../d")],
3785 "create a symbolic link",
3787 This command creates a symbolic link using the C<ln -sf> command,
3788 The C<-f> option removes the link (C<linkname>) if it exists already.");
3790 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3791 [] (* XXX tested above *),
3792 "read the target of a symbolic link",
3794 This command reads the target of a symbolic link.");
3796 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3797 [InitBasicFS, Always, TestOutputStruct (
3798 [["fallocate"; "/a"; "1000000"];
3799 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3800 "preallocate a file in the guest filesystem",
3802 This command preallocates a file (containing zero bytes) named
3803 C<path> of size C<len> bytes. If the file exists already, it
3806 Do not confuse this with the guestfish-specific
3807 C<alloc> command which allocates a file in the host and
3808 attaches it as a device.");
3810 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3811 [InitPartition, Always, TestRun (
3812 [["mkswap"; "/dev/sda1"];
3813 ["swapon_device"; "/dev/sda1"];
3814 ["swapoff_device"; "/dev/sda1"]])],
3815 "enable swap on device",
3817 This command enables the libguestfs appliance to use the
3818 swap device or partition named C<device>. The increased
3819 memory is made available for all commands, for example
3820 those run using C<guestfs_command> or C<guestfs_sh>.
3822 Note that you should not swap to existing guest swap
3823 partitions unless you know what you are doing. They may
3824 contain hibernation information, or other information that
3825 the guest doesn't want you to trash. You also risk leaking
3826 information about the host to the guest this way. Instead,
3827 attach a new host device to the guest and swap on that.");
3829 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3830 [], (* XXX tested by swapon_device *)
3831 "disable swap on device",
3833 This command disables the libguestfs appliance swap
3834 device or partition named C<device>.
3835 See C<guestfs_swapon_device>.");
3837 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3838 [InitBasicFS, Always, TestRun (
3839 [["fallocate"; "/swap"; "8388608"];
3840 ["mkswap_file"; "/swap"];
3841 ["swapon_file"; "/swap"];
3842 ["swapoff_file"; "/swap"]])],
3843 "enable swap on file",
3845 This command enables swap to a file.
3846 See C<guestfs_swapon_device> for other notes.");
3848 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3849 [], (* XXX tested by swapon_file *)
3850 "disable swap on file",
3852 This command disables the libguestfs appliance swap on file.");
3854 ("swapon_label", (RErr, [String "label"], []), 174, [],
3855 [InitEmpty, Always, TestRun (
3856 [["part_disk"; "/dev/sdb"; "mbr"];
3857 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3858 ["swapon_label"; "swapit"];
3859 ["swapoff_label"; "swapit"];
3860 ["zero"; "/dev/sdb"];
3861 ["blockdev_rereadpt"; "/dev/sdb"]])],
3862 "enable swap on labeled swap partition",
3864 This command enables swap to a labeled swap partition.
3865 See C<guestfs_swapon_device> for other notes.");
3867 ("swapoff_label", (RErr, [String "label"], []), 175, [],
3868 [], (* XXX tested by swapon_label *)
3869 "disable swap on labeled swap partition",
3871 This command disables the libguestfs appliance swap on
3872 labeled swap partition.");
3874 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3875 (let uuid = uuidgen () in
3876 [InitEmpty, Always, TestRun (
3877 [["mkswap_U"; uuid; "/dev/sdb"];
3878 ["swapon_uuid"; uuid];
3879 ["swapoff_uuid"; uuid]])]),
3880 "enable swap on swap partition by UUID",
3882 This command enables swap to a swap partition with the given UUID.
3883 See C<guestfs_swapon_device> for other notes.");
3885 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3886 [], (* XXX tested by swapon_uuid *)
3887 "disable swap on swap partition by UUID",
3889 This command disables the libguestfs appliance swap partition
3890 with the given UUID.");
3892 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
3893 [InitBasicFS, Always, TestRun (
3894 [["fallocate"; "/swap"; "8388608"];
3895 ["mkswap_file"; "/swap"]])],
3896 "create a swap file",
3900 This command just writes a swap file signature to an existing
3901 file. To create the file itself, use something like C<guestfs_fallocate>.");
3903 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
3904 [InitISOFS, Always, TestRun (
3905 [["inotify_init"; "0"]])],
3906 "create an inotify handle",
3908 This command creates a new inotify handle.
3909 The inotify subsystem can be used to notify events which happen to
3910 objects in the guest filesystem.
3912 C<maxevents> is the maximum number of events which will be
3913 queued up between calls to C<guestfs_inotify_read> or
3914 C<guestfs_inotify_files>.
3915 If this is passed as C<0>, then the kernel (or previously set)
3916 default is used. For Linux 2.6.29 the default was 16384 events.
3917 Beyond this limit, the kernel throws away events, but records
3918 the fact that it threw them away by setting a flag
3919 C<IN_Q_OVERFLOW> in the returned structure list (see
3920 C<guestfs_inotify_read>).
3922 Before any events are generated, you have to add some
3923 watches to the internal watch list. See:
3924 C<guestfs_inotify_add_watch>,
3925 C<guestfs_inotify_rm_watch> and
3926 C<guestfs_inotify_watch_all>.
3928 Queued up events should be read periodically by calling
3929 C<guestfs_inotify_read>
3930 (or C<guestfs_inotify_files> which is just a helpful
3931 wrapper around C<guestfs_inotify_read>). If you don't
3932 read the events out often enough then you risk the internal
3935 The handle should be closed after use by calling
3936 C<guestfs_inotify_close>. This also removes any
3937 watches automatically.
3939 See also L<inotify(7)> for an overview of the inotify interface
3940 as exposed by the Linux kernel, which is roughly what we expose
3941 via libguestfs. Note that there is one global inotify handle
3942 per libguestfs instance.");
3944 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
3945 [InitBasicFS, Always, TestOutputList (
3946 [["inotify_init"; "0"];
3947 ["inotify_add_watch"; "/"; "1073741823"];
3950 ["inotify_files"]], ["a"; "b"])],
3951 "add an inotify watch",
3953 Watch C<path> for the events listed in C<mask>.
3955 Note that if C<path> is a directory then events within that
3956 directory are watched, but this does I<not> happen recursively
3957 (in subdirectories).
3959 Note for non-C or non-Linux callers: the inotify events are
3960 defined by the Linux kernel ABI and are listed in
3961 C</usr/include/sys/inotify.h>.");
3963 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
3965 "remove an inotify watch",
3967 Remove a previously defined inotify watch.
3968 See C<guestfs_inotify_add_watch>.");
3970 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
3972 "return list of inotify events",
3974 Return the complete queue of events that have happened
3975 since the previous read call.
3977 If no events have happened, this returns an empty list.
3979 I<Note>: In order to make sure that all events have been
3980 read, you must call this function repeatedly until it
3981 returns an empty list. The reason is that the call will
3982 read events up to the maximum appliance-to-host message
3983 size and leave remaining events in the queue.");
3985 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
3987 "return list of watched files that had events",
3989 This function is a helpful wrapper around C<guestfs_inotify_read>
3990 which just returns a list of pathnames of objects that were
3991 touched. The returned pathnames are sorted and deduplicated.");
3993 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
3995 "close the inotify handle",
3997 This closes the inotify handle which was previously
3998 opened by inotify_init. It removes all watches, throws
3999 away any pending events, and deallocates all resources.");
4001 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4003 "set SELinux security context",
4005 This sets the SELinux security context of the daemon
4006 to the string C<context>.
4008 See the documentation about SELINUX in L<guestfs(3)>.");
4010 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4012 "get SELinux security context",
4014 This gets the SELinux security context of the daemon.
4016 See the documentation about SELINUX in L<guestfs(3)>,
4017 and C<guestfs_setcon>");
4019 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
4020 [InitEmpty, Always, TestOutput (
4021 [["part_disk"; "/dev/sda"; "mbr"];
4022 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4023 ["mount_options"; ""; "/dev/sda1"; "/"];
4024 ["write"; "/new"; "new file contents"];
4025 ["cat"; "/new"]], "new file contents");
4026 InitEmpty, Always, TestRun (
4027 [["part_disk"; "/dev/sda"; "mbr"];
4028 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4029 InitEmpty, Always, TestLastFail (
4030 [["part_disk"; "/dev/sda"; "mbr"];
4031 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4032 InitEmpty, Always, TestLastFail (
4033 [["part_disk"; "/dev/sda"; "mbr"];
4034 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4035 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4036 [["part_disk"; "/dev/sda"; "mbr"];
4037 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4038 "make a filesystem with block size",
4040 This call is similar to C<guestfs_mkfs>, but it allows you to
4041 control the block size of the resulting filesystem. Supported
4042 block sizes depend on the filesystem type, but typically they
4043 are C<1024>, C<2048> or C<4096> only.
4045 For VFAT and NTFS the C<blocksize> parameter is treated as
4046 the requested cluster size.");
4048 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4049 [InitEmpty, Always, TestOutput (
4050 [["part_init"; "/dev/sda"; "mbr"];
4051 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4052 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4053 ["mke2journal"; "4096"; "/dev/sda1"];
4054 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4055 ["mount_options"; ""; "/dev/sda2"; "/"];
4056 ["write"; "/new"; "new file contents"];
4057 ["cat"; "/new"]], "new file contents")],
4058 "make ext2/3/4 external journal",
4060 This creates an ext2 external journal on C<device>. It is equivalent
4063 mke2fs -O journal_dev -b blocksize device");
4065 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4066 [InitEmpty, Always, TestOutput (
4067 [["part_init"; "/dev/sda"; "mbr"];
4068 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4069 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4070 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4071 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4072 ["mount_options"; ""; "/dev/sda2"; "/"];
4073 ["write"; "/new"; "new file contents"];
4074 ["cat"; "/new"]], "new file contents")],
4075 "make ext2/3/4 external journal with label",
4077 This creates an ext2 external journal on C<device> with label C<label>.");
4079 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4080 (let uuid = uuidgen () in
4081 [InitEmpty, Always, TestOutput (
4082 [["part_init"; "/dev/sda"; "mbr"];
4083 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4084 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4085 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4086 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4087 ["mount_options"; ""; "/dev/sda2"; "/"];
4088 ["write"; "/new"; "new file contents"];
4089 ["cat"; "/new"]], "new file contents")]),
4090 "make ext2/3/4 external journal with UUID",
4092 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4094 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4096 "make ext2/3/4 filesystem with external journal",
4098 This creates an ext2/3/4 filesystem on C<device> with
4099 an external journal on C<journal>. It is equivalent
4102 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4104 See also C<guestfs_mke2journal>.");
4106 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4108 "make ext2/3/4 filesystem with external journal",
4110 This creates an ext2/3/4 filesystem on C<device> with
4111 an external journal on the journal labeled C<label>.
4113 See also C<guestfs_mke2journal_L>.");
4115 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4117 "make ext2/3/4 filesystem with external journal",
4119 This creates an ext2/3/4 filesystem on C<device> with
4120 an external journal on the journal with UUID C<uuid>.
4122 See also C<guestfs_mke2journal_U>.");
4124 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4125 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4126 "load a kernel module",
4128 This loads a kernel module in the appliance.
4130 The kernel module must have been whitelisted when libguestfs
4131 was built (see C<appliance/kmod.whitelist.in> in the source).");
4133 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4134 [InitNone, Always, TestOutput (
4135 [["echo_daemon"; "This is a test"]], "This is a test"
4137 "echo arguments back to the client",
4139 This command concatenates the list of C<words> passed with single spaces
4140 between them and returns the resulting string.
4142 You can use this command to test the connection through to the daemon.
4144 See also C<guestfs_ping_daemon>.");
4146 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4147 [], (* There is a regression test for this. *)
4148 "find all files and directories, returning NUL-separated list",
4150 This command lists out all files and directories, recursively,
4151 starting at C<directory>, placing the resulting list in the
4152 external file called C<files>.
4154 This command works the same way as C<guestfs_find> with the
4155 following exceptions:
4161 The resulting list is written to an external file.
4165 Items (filenames) in the result are separated
4166 by C<\\0> characters. See L<find(1)> option I<-print0>.
4170 This command is not limited in the number of names that it
4175 The result list is not sorted.
4179 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4180 [InitISOFS, Always, TestOutput (
4181 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4182 InitISOFS, Always, TestOutput (
4183 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4184 InitISOFS, Always, TestOutput (
4185 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4186 InitISOFS, Always, TestLastFail (
4187 [["case_sensitive_path"; "/Known-1/"]]);
4188 InitBasicFS, Always, TestOutput (
4190 ["mkdir"; "/a/bbb"];
4191 ["touch"; "/a/bbb/c"];
4192 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4193 InitBasicFS, Always, TestOutput (
4195 ["mkdir"; "/a/bbb"];
4196 ["touch"; "/a/bbb/c"];
4197 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4198 InitBasicFS, Always, TestLastFail (
4200 ["mkdir"; "/a/bbb"];
4201 ["touch"; "/a/bbb/c"];
4202 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4203 "return true path on case-insensitive filesystem",
4205 This can be used to resolve case insensitive paths on
4206 a filesystem which is case sensitive. The use case is
4207 to resolve paths which you have read from Windows configuration
4208 files or the Windows Registry, to the true path.
4210 The command handles a peculiarity of the Linux ntfs-3g
4211 filesystem driver (and probably others), which is that although
4212 the underlying filesystem is case-insensitive, the driver
4213 exports the filesystem to Linux as case-sensitive.
4215 One consequence of this is that special directories such
4216 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4217 (or other things) depending on the precise details of how
4218 they were created. In Windows itself this would not be
4221 Bug or feature? You decide:
4222 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4224 This function resolves the true case of each element in the
4225 path and returns the case-sensitive path.
4227 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4228 might return C<\"/WINDOWS/system32\"> (the exact return value
4229 would depend on details of how the directories were originally
4230 created under Windows).
4233 This function does not handle drive names, backslashes etc.
4235 See also C<guestfs_realpath>.");
4237 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4238 [InitBasicFS, Always, TestOutput (
4239 [["vfs_type"; "/dev/sda1"]], "ext2")],
4240 "get the Linux VFS type corresponding to a mounted device",
4242 This command gets the filesystem type corresponding to
4243 the filesystem on C<device>.
4245 For most filesystems, the result is the name of the Linux
4246 VFS module which would be used to mount this filesystem
4247 if you mounted it without specifying the filesystem type.
4248 For example a string such as C<ext3> or C<ntfs>.");
4250 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4251 [InitBasicFS, Always, TestOutputStruct (
4252 [["write"; "/test"; "some stuff so size is not zero"];
4253 ["truncate"; "/test"];
4254 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4255 "truncate a file to zero size",
4257 This command truncates C<path> to a zero-length file. The
4258 file must exist already.");
4260 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4261 [InitBasicFS, Always, TestOutputStruct (
4262 [["touch"; "/test"];
4263 ["truncate_size"; "/test"; "1000"];
4264 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4265 "truncate a file to a particular size",
4267 This command truncates C<path> to size C<size> bytes. The file
4270 If the current file size is less than C<size> then
4271 the file is extended to the required size with zero bytes.
4272 This creates a sparse file (ie. disk blocks are not allocated
4273 for the file until you write to it). To create a non-sparse
4274 file of zeroes, use C<guestfs_fallocate64> instead.");
4276 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4277 [InitBasicFS, Always, TestOutputStruct (
4278 [["touch"; "/test"];
4279 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4280 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4281 "set timestamp of a file with nanosecond precision",
4283 This command sets the timestamps of a file with nanosecond
4286 C<atsecs, atnsecs> are the last access time (atime) in secs and
4287 nanoseconds from the epoch.
4289 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4290 secs and nanoseconds from the epoch.
4292 If the C<*nsecs> field contains the special value C<-1> then
4293 the corresponding timestamp is set to the current time. (The
4294 C<*secs> field is ignored in this case).
4296 If the C<*nsecs> field contains the special value C<-2> then
4297 the corresponding timestamp is left unchanged. (The
4298 C<*secs> field is ignored in this case).");
4300 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4301 [InitBasicFS, Always, TestOutputStruct (
4302 [["mkdir_mode"; "/test"; "0o111"];
4303 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4304 "create a directory with a particular mode",
4306 This command creates a directory, setting the initial permissions
4307 of the directory to C<mode>.
4309 For common Linux filesystems, the actual mode which is set will
4310 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4311 interpret the mode in other ways.
4313 See also C<guestfs_mkdir>, C<guestfs_umask>");
4315 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4317 "change file owner and group",
4319 Change the file owner to C<owner> and group to C<group>.
4320 This is like C<guestfs_chown> but if C<path> is a symlink then
4321 the link itself is changed, not the target.
4323 Only numeric uid and gid are supported. If you want to use
4324 names, you will need to locate and parse the password file
4325 yourself (Augeas support makes this relatively easy).");
4327 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4329 "lstat on multiple files",
4331 This call allows you to perform the C<guestfs_lstat> operation
4332 on multiple files, where all files are in the directory C<path>.
4333 C<names> is the list of files from this directory.
4335 On return you get a list of stat structs, with a one-to-one
4336 correspondence to the C<names> list. If any name did not exist
4337 or could not be lstat'd, then the C<ino> field of that structure
4340 This call is intended for programs that want to efficiently
4341 list a directory contents without making many round-trips.
4342 See also C<guestfs_lxattrlist> for a similarly efficient call
4343 for getting extended attributes. Very long directory listings
4344 might cause the protocol message size to be exceeded, causing
4345 this call to fail. The caller must split up such requests
4346 into smaller groups of names.");
4348 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4350 "lgetxattr on multiple files",
4352 This call allows you to get the extended attributes
4353 of multiple files, where all files are in the directory C<path>.
4354 C<names> is the list of files from this directory.
4356 On return you get a flat list of xattr structs which must be
4357 interpreted sequentially. The first xattr struct always has a zero-length
4358 C<attrname>. C<attrval> in this struct is zero-length
4359 to indicate there was an error doing C<lgetxattr> for this
4360 file, I<or> is a C string which is a decimal number
4361 (the number of following attributes for this file, which could
4362 be C<\"0\">). Then after the first xattr struct are the
4363 zero or more attributes for the first named file.
4364 This repeats for the second and subsequent files.
4366 This call is intended for programs that want to efficiently
4367 list a directory contents without making many round-trips.
4368 See also C<guestfs_lstatlist> for a similarly efficient call
4369 for getting standard stats. Very long directory listings
4370 might cause the protocol message size to be exceeded, causing
4371 this call to fail. The caller must split up such requests
4372 into smaller groups of names.");
4374 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4376 "readlink on multiple files",
4378 This call allows you to do a C<readlink> operation
4379 on multiple files, where all files are in the directory C<path>.
4380 C<names> is the list of files from this directory.
4382 On return you get a list of strings, with a one-to-one
4383 correspondence to the C<names> list. Each string is the
4384 value of the symbolic link.
4386 If the C<readlink(2)> operation fails on any name, then
4387 the corresponding result string is the empty string C<\"\">.
4388 However the whole operation is completed even if there
4389 were C<readlink(2)> errors, and so you can call this
4390 function with names where you don't know if they are
4391 symbolic links already (albeit slightly less efficient).
4393 This call is intended for programs that want to efficiently
4394 list a directory contents without making many round-trips.
4395 Very long directory listings might cause the protocol
4396 message size to be exceeded, causing
4397 this call to fail. The caller must split up such requests
4398 into smaller groups of names.");
4400 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4401 [InitISOFS, Always, TestOutputBuffer (
4402 [["pread"; "/known-4"; "1"; "3"]], "\n");
4403 InitISOFS, Always, TestOutputBuffer (
4404 [["pread"; "/empty"; "0"; "100"]], "")],
4405 "read part of a file",
4407 This command lets you read part of a file. It reads C<count>
4408 bytes of the file, starting at C<offset>, from file C<path>.
4410 This may read fewer bytes than requested. For further details
4411 see the L<pread(2)> system call.
4413 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4415 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4416 [InitEmpty, Always, TestRun (
4417 [["part_init"; "/dev/sda"; "gpt"]])],
4418 "create an empty partition table",
4420 This creates an empty partition table on C<device> of one of the
4421 partition types listed below. Usually C<parttype> should be
4422 either C<msdos> or C<gpt> (for large disks).
4424 Initially there are no partitions. Following this, you should
4425 call C<guestfs_part_add> for each partition required.
4427 Possible values for C<parttype> are:
4431 =item B<efi> | B<gpt>
4433 Intel EFI / GPT partition table.
4435 This is recommended for >= 2 TB partitions that will be accessed
4436 from Linux and Intel-based Mac OS X. It also has limited backwards
4437 compatibility with the C<mbr> format.
4439 =item B<mbr> | B<msdos>
4441 The standard PC \"Master Boot Record\" (MBR) format used
4442 by MS-DOS and Windows. This partition type will B<only> work
4443 for device sizes up to 2 TB. For large disks we recommend
4448 Other partition table types that may work but are not
4457 =item B<amiga> | B<rdb>
4459 Amiga \"Rigid Disk Block\" format.
4467 DASD, used on IBM mainframes.
4475 Old Mac partition format. Modern Macs use C<gpt>.
4479 NEC PC-98 format, common in Japan apparently.
4487 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4488 [InitEmpty, Always, TestRun (
4489 [["part_init"; "/dev/sda"; "mbr"];
4490 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4491 InitEmpty, Always, TestRun (
4492 [["part_init"; "/dev/sda"; "gpt"];
4493 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4494 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4495 InitEmpty, Always, TestRun (
4496 [["part_init"; "/dev/sda"; "mbr"];
4497 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4498 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4499 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4500 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4501 "add a partition to the device",
4503 This command adds a partition to C<device>. If there is no partition
4504 table on the device, call C<guestfs_part_init> first.
4506 The C<prlogex> parameter is the type of partition. Normally you
4507 should pass C<p> or C<primary> here, but MBR partition tables also
4508 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4511 C<startsect> and C<endsect> are the start and end of the partition
4512 in I<sectors>. C<endsect> may be negative, which means it counts
4513 backwards from the end of the disk (C<-1> is the last sector).
4515 Creating a partition which covers the whole disk is not so easy.
4516 Use C<guestfs_part_disk> to do that.");
4518 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4519 [InitEmpty, Always, TestRun (
4520 [["part_disk"; "/dev/sda"; "mbr"]]);
4521 InitEmpty, Always, TestRun (
4522 [["part_disk"; "/dev/sda"; "gpt"]])],
4523 "partition whole disk with a single primary partition",
4525 This command is simply a combination of C<guestfs_part_init>
4526 followed by C<guestfs_part_add> to create a single primary partition
4527 covering the whole disk.
4529 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4530 but other possible values are described in C<guestfs_part_init>.");
4532 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4533 [InitEmpty, Always, TestRun (
4534 [["part_disk"; "/dev/sda"; "mbr"];
4535 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4536 "make a partition bootable",
4538 This sets the bootable flag on partition numbered C<partnum> on
4539 device C<device>. Note that partitions are numbered from 1.
4541 The bootable flag is used by some operating systems (notably
4542 Windows) to determine which partition to boot from. It is by
4543 no means universally recognized.");
4545 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4546 [InitEmpty, Always, TestRun (
4547 [["part_disk"; "/dev/sda"; "gpt"];
4548 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4549 "set partition name",
4551 This sets the partition name on partition numbered C<partnum> on
4552 device C<device>. Note that partitions are numbered from 1.
4554 The partition name can only be set on certain types of partition
4555 table. This works on C<gpt> but not on C<mbr> partitions.");
4557 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4558 [], (* XXX Add a regression test for this. *)
4559 "list partitions on a device",
4561 This command parses the partition table on C<device> and
4562 returns the list of partitions found.
4564 The fields in the returned structure are:
4570 Partition number, counting from 1.
4574 Start of the partition I<in bytes>. To get sectors you have to
4575 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4579 End of the partition in bytes.
4583 Size of the partition in bytes.
4587 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4588 [InitEmpty, Always, TestOutput (
4589 [["part_disk"; "/dev/sda"; "gpt"];
4590 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4591 "get the partition table type",
4593 This command examines the partition table on C<device> and
4594 returns the partition table type (format) being used.
4596 Common return values include: C<msdos> (a DOS/Windows style MBR
4597 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4598 values are possible, although unusual. See C<guestfs_part_init>
4601 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4602 [InitBasicFS, Always, TestOutputBuffer (
4603 [["fill"; "0x63"; "10"; "/test"];
4604 ["read_file"; "/test"]], "cccccccccc")],
4605 "fill a file with octets",
4607 This command creates a new file called C<path>. The initial
4608 content of the file is C<len> octets of C<c>, where C<c>
4609 must be a number in the range C<[0..255]>.
4611 To fill a file with zero bytes (sparsely), it is
4612 much more efficient to use C<guestfs_truncate_size>.
4613 To create a file with a pattern of repeating bytes
4614 use C<guestfs_fill_pattern>.");
4616 ("available", (RErr, [StringList "groups"], []), 216, [],
4617 [InitNone, Always, TestRun [["available"; ""]]],
4618 "test availability of some parts of the API",
4620 This command is used to check the availability of some
4621 groups of functionality in the appliance, which not all builds of
4622 the libguestfs appliance will be able to provide.
4624 The libguestfs groups, and the functions that those
4625 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4626 You can also fetch this list at runtime by calling
4627 C<guestfs_available_all_groups>.
4629 The argument C<groups> is a list of group names, eg:
4630 C<[\"inotify\", \"augeas\"]> would check for the availability of
4631 the Linux inotify functions and Augeas (configuration file
4634 The command returns no error if I<all> requested groups are available.
4636 It fails with an error if one or more of the requested
4637 groups is unavailable in the appliance.
4639 If an unknown group name is included in the
4640 list of groups then an error is always returned.
4648 You must call C<guestfs_launch> before calling this function.
4650 The reason is because we don't know what groups are
4651 supported by the appliance/daemon until it is running and can
4656 If a group of functions is available, this does not necessarily
4657 mean that they will work. You still have to check for errors
4658 when calling individual API functions even if they are
4663 It is usually the job of distro packagers to build
4664 complete functionality into the libguestfs appliance.
4665 Upstream libguestfs, if built from source with all
4666 requirements satisfied, will support everything.
4670 This call was added in version C<1.0.80>. In previous
4671 versions of libguestfs all you could do would be to speculatively
4672 execute a command to find out if the daemon implemented it.
4673 See also C<guestfs_version>.
4677 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4678 [InitBasicFS, Always, TestOutputBuffer (
4679 [["write"; "/src"; "hello, world"];
4680 ["dd"; "/src"; "/dest"];
4681 ["read_file"; "/dest"]], "hello, world")],
4682 "copy from source to destination using dd",
4684 This command copies from one source device or file C<src>
4685 to another destination device or file C<dest>. Normally you
4686 would use this to copy to or from a device or partition, for
4687 example to duplicate a filesystem.
4689 If the destination is a device, it must be as large or larger
4690 than the source file or device, otherwise the copy will fail.
4691 This command cannot do partial copies (see C<guestfs_copy_size>).");
4693 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4694 [InitBasicFS, Always, TestOutputInt (
4695 [["write"; "/file"; "hello, world"];
4696 ["filesize"; "/file"]], 12)],
4697 "return the size of the file in bytes",
4699 This command returns the size of C<file> in bytes.
4701 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4702 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4703 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4705 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4706 [InitBasicFSonLVM, Always, TestOutputList (
4707 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4708 ["lvs"]], ["/dev/VG/LV2"])],
4709 "rename an LVM logical volume",
4711 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4713 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4714 [InitBasicFSonLVM, Always, TestOutputList (
4716 ["vg_activate"; "false"; "VG"];
4717 ["vgrename"; "VG"; "VG2"];
4718 ["vg_activate"; "true"; "VG2"];
4719 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4720 ["vgs"]], ["VG2"])],
4721 "rename an LVM volume group",
4723 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4725 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4726 [InitISOFS, Always, TestOutputBuffer (
4727 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4728 "list the contents of a single file in an initrd",
4730 This command unpacks the file C<filename> from the initrd file
4731 called C<initrdpath>. The filename must be given I<without> the
4732 initial C</> character.
4734 For example, in guestfish you could use the following command
4735 to examine the boot script (usually called C</init>)
4736 contained in a Linux initrd or initramfs image:
4738 initrd-cat /boot/initrd-<version>.img init
4740 See also C<guestfs_initrd_list>.");
4742 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4744 "get the UUID of a physical volume",
4746 This command returns the UUID of the LVM PV C<device>.");
4748 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4750 "get the UUID of a volume group",
4752 This command returns the UUID of the LVM VG named C<vgname>.");
4754 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4756 "get the UUID of a logical volume",
4758 This command returns the UUID of the LVM LV C<device>.");
4760 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4762 "get the PV UUIDs containing the volume group",
4764 Given a VG called C<vgname>, this returns the UUIDs of all
4765 the physical volumes that this volume group resides on.
4767 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4768 calls to associate physical volumes and volume groups.
4770 See also C<guestfs_vglvuuids>.");
4772 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4774 "get the LV UUIDs of all LVs in the volume group",
4776 Given a VG called C<vgname>, this returns the UUIDs of all
4777 the logical volumes created in this volume group.
4779 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4780 calls to associate logical volumes and volume groups.
4782 See also C<guestfs_vgpvuuids>.");
4784 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4785 [InitBasicFS, Always, TestOutputBuffer (
4786 [["write"; "/src"; "hello, world"];
4787 ["copy_size"; "/src"; "/dest"; "5"];
4788 ["read_file"; "/dest"]], "hello")],
4789 "copy size bytes from source to destination using dd",
4791 This command copies exactly C<size> bytes from one source device
4792 or file C<src> to another destination device or file C<dest>.
4794 Note this will fail if the source is too short or if the destination
4795 is not large enough.");
4797 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4798 [InitBasicFSonLVM, Always, TestRun (
4799 [["zero_device"; "/dev/VG/LV"]])],
4800 "write zeroes to an entire device",
4802 This command writes zeroes over the entire C<device>. Compare
4803 with C<guestfs_zero> which just zeroes the first few blocks of
4806 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4807 [InitBasicFS, Always, TestOutput (
4808 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4809 ["cat"; "/hello"]], "hello\n")],
4810 "unpack compressed tarball to directory",
4812 This command uploads and unpacks local file C<tarball> (an
4813 I<xz compressed> tar file) into C<directory>.");
4815 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4817 "pack directory into compressed tarball",
4819 This command packs the contents of C<directory> and downloads
4820 it to local file C<tarball> (as an xz compressed tar archive).");
4822 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4824 "resize an NTFS filesystem",
4826 This command resizes an NTFS filesystem, expanding or
4827 shrinking it to the size of the underlying device.
4828 See also L<ntfsresize(8)>.");
4830 ("vgscan", (RErr, [], []), 232, [],
4831 [InitEmpty, Always, TestRun (
4833 "rescan for LVM physical volumes, volume groups and logical volumes",
4835 This rescans all block devices and rebuilds the list of LVM
4836 physical volumes, volume groups and logical volumes.");
4838 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
4839 [InitEmpty, Always, TestRun (
4840 [["part_init"; "/dev/sda"; "mbr"];
4841 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4842 ["part_del"; "/dev/sda"; "1"]])],
4843 "delete a partition",
4845 This command deletes the partition numbered C<partnum> on C<device>.
4847 Note that in the case of MBR partitioning, deleting an
4848 extended partition also deletes any logical partitions
4851 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
4852 [InitEmpty, Always, TestOutputTrue (
4853 [["part_init"; "/dev/sda"; "mbr"];
4854 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4855 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4856 ["part_get_bootable"; "/dev/sda"; "1"]])],
4857 "return true if a partition is bootable",
4859 This command returns true if the partition C<partnum> on
4860 C<device> has the bootable flag set.
4862 See also C<guestfs_part_set_bootable>.");
4864 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
4865 [InitEmpty, Always, TestOutputInt (
4866 [["part_init"; "/dev/sda"; "mbr"];
4867 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4868 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4869 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4870 "get the MBR type byte (ID byte) from a partition",
4872 Returns the MBR type byte (also known as the ID byte) from
4873 the numbered partition C<partnum>.
4875 Note that only MBR (old DOS-style) partitions have type bytes.
4876 You will get undefined results for other partition table
4877 types (see C<guestfs_part_get_parttype>).");
4879 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
4880 [], (* tested by part_get_mbr_id *)
4881 "set the MBR type byte (ID byte) of a partition",
4883 Sets the MBR type byte (also known as the ID byte) of
4884 the numbered partition C<partnum> to C<idbyte>. Note
4885 that the type bytes quoted in most documentation are
4886 in fact hexadecimal numbers, but usually documented
4887 without any leading \"0x\" which might be confusing.
4889 Note that only MBR (old DOS-style) partitions have type bytes.
4890 You will get undefined results for other partition table
4891 types (see C<guestfs_part_get_parttype>).");
4893 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
4894 [InitISOFS, Always, TestOutputFileMD5 (
4895 [["checksum_device"; "md5"; "/dev/sdd"]],
4896 "../images/test.iso")],
4897 "compute MD5, SHAx or CRC checksum of the contents of a device",
4899 This call computes the MD5, SHAx or CRC checksum of the
4900 contents of the device named C<device>. For the types of
4901 checksums supported see the C<guestfs_checksum> command.");
4903 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
4904 [InitNone, Always, TestRun (
4905 [["part_disk"; "/dev/sda"; "mbr"];
4906 ["pvcreate"; "/dev/sda1"];
4907 ["vgcreate"; "VG"; "/dev/sda1"];
4908 ["lvcreate"; "LV"; "VG"; "10"];
4909 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4910 "expand an LV to fill free space",
4912 This expands an existing logical volume C<lv> so that it fills
4913 C<pc>% of the remaining free space in the volume group. Commonly
4914 you would call this with pc = 100 which expands the logical volume
4915 as much as possible, using all remaining free space in the volume
4918 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
4919 [], (* XXX Augeas code needs tests. *)
4920 "clear Augeas path",
4922 Set the value associated with C<path> to C<NULL>. This
4923 is the same as the L<augtool(1)> C<clear> command.");
4925 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
4926 [InitEmpty, Always, TestOutputInt (
4927 [["get_umask"]], 0o22)],
4928 "get the current umask",
4930 Return the current umask. By default the umask is C<022>
4931 unless it has been set by calling C<guestfs_umask>.");
4933 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
4935 "upload a file to the appliance (internal use only)",
4937 The C<guestfs_debug_upload> command uploads a file to
4938 the libguestfs appliance.
4940 There is no comprehensive help for this command. You have
4941 to look at the file C<daemon/debug.c> in the libguestfs source
4942 to find out what it is for.");
4944 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
4945 [InitBasicFS, Always, TestOutput (
4946 [["base64_in"; "../images/hello.b64"; "/hello"];
4947 ["cat"; "/hello"]], "hello\n")],
4948 "upload base64-encoded data to file",
4950 This command uploads base64-encoded data from C<base64file>
4953 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
4955 "download file and encode as base64",
4957 This command downloads the contents of C<filename>, writing
4958 it out to local file C<base64file> encoded as base64.");
4960 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
4962 "compute MD5, SHAx or CRC checksum of files in a directory",
4964 This command computes the checksums of all regular files in
4965 C<directory> and then emits a list of those checksums to
4966 the local output file C<sumsfile>.
4968 This can be used for verifying the integrity of a virtual
4969 machine. However to be properly secure you should pay
4970 attention to the output of the checksum command (it uses
4971 the ones from GNU coreutils). In particular when the
4972 filename is not printable, coreutils uses a special
4973 backslash syntax. For more information, see the GNU
4974 coreutils info file.");
4976 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
4977 [InitBasicFS, Always, TestOutputBuffer (
4978 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4979 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4980 "fill a file with a repeating pattern of bytes",
4982 This function is like C<guestfs_fill> except that it creates
4983 a new file of length C<len> containing the repeating pattern
4984 of bytes in C<pattern>. The pattern is truncated if necessary
4985 to ensure the length of the file is exactly C<len> bytes.");
4987 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
4988 [InitBasicFS, Always, TestOutput (
4989 [["write"; "/new"; "new file contents"];
4990 ["cat"; "/new"]], "new file contents");
4991 InitBasicFS, Always, TestOutput (
4992 [["write"; "/new"; "\nnew file contents\n"];
4993 ["cat"; "/new"]], "\nnew file contents\n");
4994 InitBasicFS, Always, TestOutput (
4995 [["write"; "/new"; "\n\n"];
4996 ["cat"; "/new"]], "\n\n");
4997 InitBasicFS, Always, TestOutput (
4998 [["write"; "/new"; ""];
4999 ["cat"; "/new"]], "");
5000 InitBasicFS, Always, TestOutput (
5001 [["write"; "/new"; "\n\n\n"];
5002 ["cat"; "/new"]], "\n\n\n");
5003 InitBasicFS, Always, TestOutput (
5004 [["write"; "/new"; "\n"];
5005 ["cat"; "/new"]], "\n")],
5006 "create a new file",
5008 This call creates a file called C<path>. The content of the
5009 file is the string C<content> (which can contain any 8 bit data).");
5011 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5012 [InitBasicFS, Always, TestOutput (
5013 [["write"; "/new"; "new file contents"];
5014 ["pwrite"; "/new"; "data"; "4"];
5015 ["cat"; "/new"]], "new data contents");
5016 InitBasicFS, Always, TestOutput (
5017 [["write"; "/new"; "new file contents"];
5018 ["pwrite"; "/new"; "is extended"; "9"];
5019 ["cat"; "/new"]], "new file is extended");
5020 InitBasicFS, Always, TestOutput (
5021 [["write"; "/new"; "new file contents"];
5022 ["pwrite"; "/new"; ""; "4"];
5023 ["cat"; "/new"]], "new file contents")],
5024 "write to part of a file",
5026 This command writes to part of a file. It writes the data
5027 buffer C<content> to the file C<path> starting at offset C<offset>.
5029 This command implements the L<pwrite(2)> system call, and like
5030 that system call it may not write the full data requested. The
5031 return value is the number of bytes that were actually written
5032 to the file. This could even be 0, although short writes are
5033 unlikely for regular files in ordinary circumstances.
5035 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5037 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5039 "resize an ext2, ext3 or ext4 filesystem (with size)",
5041 This command is the same as C<guestfs_resize2fs> except that it
5042 allows you to specify the new size (in bytes) explicitly.");
5044 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5046 "resize an LVM physical volume (with size)",
5048 This command is the same as C<guestfs_pvresize> except that it
5049 allows you to specify the new size (in bytes) explicitly.");
5051 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5053 "resize an NTFS filesystem (with size)",
5055 This command is the same as C<guestfs_ntfsresize> except that it
5056 allows you to specify the new size (in bytes) explicitly.");
5058 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5059 [InitNone, Always, TestRun [["available_all_groups"]]],
5060 "return a list of all optional groups",
5062 This command returns a list of all optional groups that this
5063 daemon knows about. Note this returns both supported and unsupported
5064 groups. To find out which ones the daemon can actually support
5065 you have to call C<guestfs_available> on each member of the
5068 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5070 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5071 [InitBasicFS, Always, TestOutputStruct (
5072 [["fallocate64"; "/a"; "1000000"];
5073 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
5074 "preallocate a file in the guest filesystem",
5076 This command preallocates a file (containing zero bytes) named
5077 C<path> of size C<len> bytes. If the file exists already, it
5080 Note that this call allocates disk blocks for the file.
5081 To create a sparse file use C<guestfs_truncate_size> instead.
5083 The deprecated call C<guestfs_fallocate> does the same,
5084 but owing to an oversight it only allowed 30 bit lengths
5085 to be specified, effectively limiting the maximum size
5086 of files created through that call to 1GB.
5088 Do not confuse this with the guestfish-specific
5089 C<alloc> and C<sparse> commands which create
5090 a file in the host and attach it as a device.");
5092 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5093 [InitBasicFS, Always, TestOutput (
5094 [["set_e2label"; "/dev/sda1"; "LTEST"];
5095 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5096 "get the filesystem label",
5098 This returns the filesystem label of the filesystem on
5101 If the filesystem is unlabeled, this returns the empty string.
5103 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5105 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5106 (let uuid = uuidgen () in
5107 [InitBasicFS, Always, TestOutput (
5108 [["set_e2uuid"; "/dev/sda1"; uuid];
5109 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5110 "get the filesystem UUID",
5112 This returns the filesystem UUID of the filesystem on
5115 If the filesystem does not have a UUID, this returns the empty string.
5117 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5119 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5120 (* Can't be tested with the current framework because
5121 * the VG is being used by the mounted filesystem, so
5122 * the vgchange -an command we do first will fail.
5125 "set LVM device filter",
5127 This sets the LVM device filter so that LVM will only be
5128 able to \"see\" the block devices in the list C<devices>,
5129 and will ignore all other attached block devices.
5131 Where disk image(s) contain duplicate PVs or VGs, this
5132 command is useful to get LVM to ignore the duplicates, otherwise
5133 LVM can get confused. Note also there are two types
5134 of duplication possible: either cloned PVs/VGs which have
5135 identical UUIDs; or VGs that are not cloned but just happen
5136 to have the same name. In normal operation you cannot
5137 create this situation, but you can do it outside LVM, eg.
5138 by cloning disk images or by bit twiddling inside the LVM
5141 This command also clears the LVM cache and performs a volume
5144 You can filter whole block devices or individual partitions.
5146 You cannot use this if any VG is currently in use (eg.
5147 contains a mounted filesystem), even if you are not
5148 filtering out that VG.");
5150 ("lvm_clear_filter", (RErr, [], []), 256, [],
5151 [], (* see note on lvm_set_filter *)
5152 "clear LVM device filter",
5154 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5155 will be able to see every block device.
5157 This command also clears the LVM cache and performs a volume
5160 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5162 "open a LUKS-encrypted block device",
5164 This command opens a block device which has been encrypted
5165 according to the Linux Unified Key Setup (LUKS) standard.
5167 C<device> is the encrypted block device or partition.
5169 The caller must supply one of the keys associated with the
5170 LUKS block device, in the C<key> parameter.
5172 This creates a new block device called C</dev/mapper/mapname>.
5173 Reads and writes to this block device are decrypted from and
5174 encrypted to the underlying C<device> respectively.
5176 If this block device contains LVM volume groups, then
5177 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5178 will make them visible.");
5180 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5182 "open a LUKS-encrypted block device read-only",
5184 This is the same as C<guestfs_luks_open> except that a read-only
5185 mapping is created.");
5187 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5189 "close a LUKS device",
5191 This closes a LUKS device that was created earlier by
5192 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5193 C<device> parameter must be the name of the LUKS mapping
5194 device (ie. C</dev/mapper/mapname>) and I<not> the name
5195 of the underlying block device.");
5197 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5199 "format a block device as a LUKS encrypted device",
5201 This command erases existing data on C<device> and formats
5202 the device as a LUKS encrypted device. C<key> is the
5203 initial key, which is added to key slot C<slot>. (LUKS
5204 supports 8 key slots, numbered 0-7).");
5206 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5208 "format a block device as a LUKS encrypted device",
5210 This command is the same as C<guestfs_luks_format> but
5211 it also allows you to set the C<cipher> used.");
5213 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5215 "add a key on a LUKS encrypted device",
5217 This command adds a new key on LUKS device C<device>.
5218 C<key> is any existing key, and is used to access the device.
5219 C<newkey> is the new key to add. C<keyslot> is the key slot
5220 that will be replaced.
5222 Note that if C<keyslot> already contains a key, then this
5223 command will fail. You have to use C<guestfs_luks_kill_slot>
5224 first to remove that key.");
5226 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5228 "remove a key from a LUKS encrypted device",
5230 This command deletes the key in key slot C<keyslot> from the
5231 encrypted LUKS device C<device>. C<key> must be one of the
5234 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5235 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5236 [["is_lv"; "/dev/VG/LV"]]);
5237 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5238 [["is_lv"; "/dev/sda1"]])],
5239 "test if device is a logical volume",
5241 This command tests whether C<device> is a logical volume, and
5242 returns true iff this is the case.");
5244 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5246 "find a filesystem by UUID",
5248 This command searches the filesystems and returns the one
5249 which has the given UUID. An error is returned if no such
5250 filesystem can be found.
5252 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5254 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5256 "find a filesystem by label",
5258 This command searches the filesystems and returns the one
5259 which has the given label. An error is returned if no such
5260 filesystem can be found.
5262 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5264 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5265 [InitISOFS, Always, TestOutputFalse (
5266 [["is_chardev"; "/directory"]]);
5267 InitBasicFS, Always, TestOutputTrue (
5268 [["mknod_c"; "0o777"; "99"; "66"; "/test"];
5269 ["is_chardev"; "/test"]])],
5270 "test if character device",
5272 This returns C<true> if and only if there is a character device
5273 with the given C<path> name.
5275 See also C<guestfs_stat>.");
5277 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5278 [InitISOFS, Always, TestOutputFalse (
5279 [["is_blockdev"; "/directory"]]);
5280 InitBasicFS, Always, TestOutputTrue (
5281 [["mknod_b"; "0o777"; "99"; "66"; "/test"];
5282 ["is_blockdev"; "/test"]])],
5283 "test if block device",
5285 This returns C<true> if and only if there is a block device
5286 with the given C<path> name.
5288 See also C<guestfs_stat>.");
5290 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5291 [InitISOFS, Always, TestOutputFalse (
5292 [["is_fifo"; "/directory"]]);
5293 InitBasicFS, Always, TestOutputTrue (
5294 [["mkfifo"; "0o777"; "/test"];
5295 ["is_fifo"; "/test"]])],
5296 "test if FIFO (named pipe)",
5298 This returns C<true> if and only if there is a FIFO (named pipe)
5299 with the given C<path> name.
5301 See also C<guestfs_stat>.");
5303 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5304 [InitISOFS, Always, TestOutputFalse (
5305 [["is_symlink"; "/directory"]]);
5306 InitISOFS, Always, TestOutputTrue (
5307 [["is_symlink"; "/abssymlink"]])],
5308 "test if symbolic link",
5310 This returns C<true> if and only if there is a symbolic link
5311 with the given C<path> name.
5313 See also C<guestfs_stat>.");
5315 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5316 (* XXX Need a positive test for sockets. *)
5317 [InitISOFS, Always, TestOutputFalse (
5318 [["is_socket"; "/directory"]])],
5321 This returns C<true> if and only if there is a Unix domain socket
5322 with the given C<path> name.
5324 See also C<guestfs_stat>.");
5326 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5327 [InitPartition, Always, TestOutputDevice (
5328 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5329 InitEmpty, Always, TestLastFail (
5330 [["part_to_dev"; "/dev/sda"]])],
5331 "convert partition name to device name",
5333 This function takes a partition name (eg. \"/dev/sdb1\") and
5334 removes the partition number, returning the device name
5337 The named partition must exist, for example as a string returned
5338 from C<guestfs_list_partitions>.");
5340 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [],
5341 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5342 [InitBasicFS, Always, TestOutput (
5343 [["upload_offset"; "../COPYING.LIB"; "/COPYING.LIB"; "0"];
5344 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5345 "upload a file from the local machine with offset",
5347 Upload local file C<filename> to C<remotefilename> on the
5350 C<remotefilename> is overwritten starting at the byte C<offset>
5351 specified. The intention is to overwrite parts of existing
5352 files or devices, although if a non-existant file is specified
5353 then it is created with a \"hole\" before C<offset>. The
5354 size of the data written is implicit in the size of the
5357 Note that there is no limit on the amount of data that
5358 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5359 and this call always writes the full amount unless an
5362 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5364 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5365 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5366 let offset = string_of_int 100 in
5367 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5368 [InitBasicFS, Always, TestOutput (
5369 (* Pick a file from cwd which isn't likely to change. *)
5370 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
5371 ["download_offset"; "/COPYING.LIB"; "testdownload.tmp"; offset; size];
5372 ["upload_offset"; "testdownload.tmp"; "/COPYING.LIB"; offset];
5373 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5374 "download a file to the local machine with offset and size",
5376 Download file C<remotefilename> and save it as C<filename>
5377 on the local machine.
5379 C<remotefilename> is read for C<size> bytes starting at C<offset>
5380 (this region must be within the file or device).
5382 Note that there is no limit on the amount of data that
5383 can be downloaded with this call, unlike with C<guestfs_pread>,
5384 and this call always reads the full amount unless an
5387 See also C<guestfs_download>, C<guestfs_pread>.");
5389 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5390 [InitPartition, Always, TestOutputList (
5391 [["pwrite_device"; "/dev/sda"; "\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"; "446"];
5392 ["blockdev_rereadpt"; "/dev/sda"];
5393 ["list_partitions"]], [])],
5394 "write to part of a device",
5396 This command writes to part of a device. It writes the data
5397 buffer C<content> to C<device> starting at offset C<offset>.
5399 This command implements the L<pwrite(2)> system call, and like
5400 that system call it may not write the full data requested
5401 (although short writes to disk devices and partitions are
5402 probably impossible with standard Linux kernels).
5404 See also C<guestfs_pwrite>.");
5406 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5407 [InitEmpty, Always, TestOutputBuffer (
5408 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5409 "read part of a device",
5411 This command lets you read part of a file. It reads C<count>
5412 bytes of C<device>, starting at C<offset>.
5414 This may read fewer bytes than requested. For further details
5415 see the L<pread(2)> system call.
5417 See also C<guestfs_pread>.");
5419 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5420 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5421 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5422 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5423 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5424 "get canonical name of an LV",
5426 This converts alternative naming schemes for LVs that you
5427 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5428 is converted to C</dev/VG/LV>.
5430 This command returns an error if the C<lvname> parameter does
5431 not refer to a logical volume.
5433 See also C<guestfs_is_lv>.");
5437 let all_functions = non_daemon_functions @ daemon_functions
5439 (* In some places we want the functions to be displayed sorted
5440 * alphabetically, so this is useful:
5442 let all_functions_sorted = List.sort action_compare all_functions
5444 (* This is used to generate the src/MAX_PROC_NR file which
5445 * contains the maximum procedure number, a surrogate for the
5446 * ABI version number. See src/Makefile.am for the details.
5449 let proc_nrs = List.map (
5450 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5451 ) daemon_functions in
5452 List.fold_left max 0 proc_nrs
5454 (* Non-API meta-commands available only in guestfish.
5456 * Note (1): style, proc_nr and tests fields are all meaningless.
5457 * The only fields which are actually used are the shortname,
5458 * FishAlias flags, shortdesc and longdesc.
5460 * Note (2): to refer to other commands, use L</shortname>.
5462 * Note (3): keep this list sorted by shortname.
5464 let fish_commands = [
5465 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5466 "allocate and add a disk file",
5467 " alloc filename size
5469 This creates an empty (zeroed) file of the given size, and then adds
5470 so it can be further examined.
5472 For more advanced image creation, see L<qemu-img(1)> utility.
5474 Size can be specified using standard suffixes, eg. C<1M>.
5476 To create a sparse file, use L</sparse> instead. To create a
5477 prepared disk image, see L</PREPARED DISK IMAGES>.");
5479 ("copy_in", (RErr,[], []), -1, [], [],
5480 "copy local files or directories into an image",
5481 " copy-in local [local ...] /remotedir
5483 C<copy-in> copies local files or directories recursively into the disk
5484 image, placing them in the directory called C</remotedir> (which must
5485 exist). This guestfish meta-command turns into a sequence of
5486 L</tar-in> and other commands as necessary.
5488 Multiple local files and directories can be specified, but the last
5489 parameter must always be a remote directory. Wildcards cannot be
5492 ("copy_out", (RErr,[], []), -1, [], [],
5493 "copy remote files or directories out of an image",
5494 " copy-out remote [remote ...] localdir
5496 C<copy-out> copies remote files or directories recursively out of the
5497 disk image, placing them on the host disk in a local directory called
5498 C<localdir> (which must exist). This guestfish meta-command turns
5499 into a sequence of L</download>, L</tar-out> and other commands as
5502 Multiple remote files and directories can be specified, but the last
5503 parameter must always be a local directory. To download to the
5504 current directory, use C<.> as in:
5508 Wildcards cannot be used in the ordinary command, but you can use
5509 them with the help of L</glob> like this:
5511 glob copy-out /home/* .");
5513 ("echo", (RErr,[], []), -1, [], [],
5514 "display a line of text",
5517 This echos the parameters to the terminal.");
5519 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5523 This is used to edit a file. It downloads the file, edits it
5524 locally using your editor, then uploads the result.
5526 The editor is C<$EDITOR>. However if you use the alternate
5527 commands C<vi> or C<emacs> you will get those corresponding
5530 ("glob", (RErr,[], []), -1, [], [],
5531 "expand wildcards in command",
5532 " glob command args...
5534 Expand wildcards in any paths in the args list, and run C<command>
5535 repeatedly on each matching path.
5537 See L</WILDCARDS AND GLOBBING>.");
5539 ("hexedit", (RErr,[], []), -1, [], [],
5540 "edit with a hex editor",
5541 " hexedit <filename|device>
5542 hexedit <filename|device> <max>
5543 hexedit <filename|device> <start> <max>
5545 Use hexedit (a hex editor) to edit all or part of a binary file
5548 This command works by downloading potentially the whole file or
5549 device, editing it locally, then uploading it. If the file or
5550 device is large, you have to specify which part you wish to edit
5551 by using C<max> and/or C<start> C<max> parameters.
5552 C<start> and C<max> are specified in bytes, with the usual
5553 modifiers allowed such as C<1M> (1 megabyte).
5555 For example to edit the first few sectors of a disk you
5560 which would allow you to edit anywhere within the first megabyte
5563 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5565 hexedit /dev/sda1 0x400 0x400
5567 (assuming the superblock is in the standard location).
5569 This command requires the external L<hexedit(1)> program. You
5570 can specify another program to use by setting the C<HEXEDITOR>
5571 environment variable.
5573 See also L</hexdump>.");
5575 ("lcd", (RErr,[], []), -1, [], [],
5576 "change working directory",
5579 Change the local directory, ie. the current directory of guestfish
5582 Note that C<!cd> won't do what you might expect.");
5584 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5588 Opens the manual page for guestfish.");
5590 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5596 This is used to view a file.
5598 The default viewer is C<$PAGER>. However if you use the alternate
5599 command C<less> you will get the C<less> command specifically.");
5601 ("reopen", (RErr,[], []), -1, [], [],
5602 "close and reopen libguestfs handle",
5605 Close and reopen the libguestfs handle. It is not necessary to use
5606 this normally, because the handle is closed properly when guestfish
5607 exits. However this is occasionally useful for testing.");
5609 ("sparse", (RErr,[], []), -1, [], [],
5610 "create a sparse disk image and add",
5611 " sparse filename size
5613 This creates an empty sparse file of the given size, and then adds
5614 so it can be further examined.
5616 In all respects it works the same as the L</alloc> command, except that
5617 the image file is allocated sparsely, which means that disk blocks are
5618 not assigned to the file until they are needed. Sparse disk files
5619 only use space when written to, but they are slower and there is a
5620 danger you could run out of real disk space during a write operation.
5622 For more advanced image creation, see L<qemu-img(1)> utility.
5624 Size can be specified using standard suffixes, eg. C<1M>.");
5626 ("supported", (RErr,[], []), -1, [], [],
5627 "list supported groups of commands",
5630 This command returns a list of the optional groups
5631 known to the daemon, and indicates which ones are
5632 supported by this build of the libguestfs appliance.
5634 See also L<guestfs(3)/AVAILABILITY>.");
5636 ("time", (RErr,[], []), -1, [], [],
5637 "print elapsed time taken to run a command",
5638 " time command args...
5640 Run the command as usual, but print the elapsed time afterwards. This
5641 can be useful for benchmarking operations.");