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.
747 The operating system type could not be determined.
751 Future versions of libguestfs may return other strings here.
752 The caller should be prepared to handle any string.
754 Please read L<guestfs(3)/INSPECTION> for more details.");
756 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
758 "get architecture of inspected operating system",
760 This function should only be called with a root device string
761 as returned by C<guestfs_inspect_os>.
763 This returns the architecture of the inspected operating system.
764 The possible return values are listed under
765 C<guestfs_file_architecture>.
767 If the architecture could not be determined, then the
768 string C<unknown> is returned.
770 Please read L<guestfs(3)/INSPECTION> for more details.");
772 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
774 "get distro of inspected operating system",
776 This function should only be called with a root device string
777 as returned by C<guestfs_inspect_os>.
779 This returns the distro (distribution) of the inspected operating
782 Currently defined distros are:
818 =item \"redhat-based\"
820 Some Red Hat-derived distro.
824 Red Hat Enterprise Linux and some derivatives.
832 The distro could not be determined.
836 Windows does not have distributions. This string is
837 returned if the OS type is Windows.
841 Future versions of libguestfs may return other strings here.
842 The caller should be prepared to handle any string.
844 Please read L<guestfs(3)/INSPECTION> for more details.");
846 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
848 "get major version of inspected operating system",
850 This function should only be called with a root device string
851 as returned by C<guestfs_inspect_os>.
853 This returns the major version number of the inspected operating
856 Windows uses a consistent versioning scheme which is I<not>
857 reflected in the popular public names used by the operating system.
858 Notably the operating system known as \"Windows 7\" is really
859 version 6.1 (ie. major = 6, minor = 1). You can find out the
860 real versions corresponding to releases of Windows by consulting
863 If the version could not be determined, then C<0> is returned.
865 Please read L<guestfs(3)/INSPECTION> for more details.");
867 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
869 "get minor version of inspected operating system",
871 This function should only be called with a root device string
872 as returned by C<guestfs_inspect_os>.
874 This returns the minor version number of the inspected operating
877 If the version could not be determined, then C<0> is returned.
879 Please read L<guestfs(3)/INSPECTION> for more details.
880 See also C<guestfs_inspect_get_major_version>.");
882 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
884 "get product name of inspected operating system",
886 This function should only be called with a root device string
887 as returned by C<guestfs_inspect_os>.
889 This returns the product name of the inspected operating
890 system. The product name is generally some freeform string
891 which can be displayed to the user, but should not be
894 If the product name could not be determined, then the
895 string C<unknown> is returned.
897 Please read L<guestfs(3)/INSPECTION> for more details.");
899 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
901 "get mountpoints of inspected operating system",
903 This function should only be called with a root device string
904 as returned by C<guestfs_inspect_os>.
906 This returns a hash of where we think the filesystems
907 associated with this operating system should be mounted.
908 Callers should note that this is at best an educated guess
909 made by reading configuration files such as C</etc/fstab>.
911 Each element in the returned hashtable has a key which
912 is the path of the mountpoint (eg. C</boot>) and a value
913 which is the filesystem that would be mounted there
916 Non-mounted devices such as swap devices are I<not>
917 returned in this list.
919 Please read L<guestfs(3)/INSPECTION> for more details.
920 See also C<guestfs_inspect_get_filesystems>.");
922 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
924 "get filesystems associated with inspected operating system",
926 This function should only be called with a root device string
927 as returned by C<guestfs_inspect_os>.
929 This returns a list of all the filesystems that we think
930 are associated with this operating system. This includes
931 the root filesystem, other ordinary filesystems, and
932 non-mounted devices like swap partitions.
934 In the case of a multi-boot virtual machine, it is possible
935 for a filesystem to be shared between operating systems.
937 Please read L<guestfs(3)/INSPECTION> for more details.
938 See also C<guestfs_inspect_get_mountpoints>.");
940 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
942 "set enable network flag",
944 If C<network> is true, then the network is enabled in the
945 libguestfs appliance. The default is false.
947 This affects whether commands are able to access the network
948 (see L<guestfs(3)/RUNNING COMMANDS>).
950 You must call this before calling C<guestfs_launch>, otherwise
953 ("get_network", (RBool "network", [], []), -1, [],
955 "get enable network flag",
957 This returns the enable network flag.");
959 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
963 This inspection command looks for filesystems on partitions,
964 block devices and logical volumes, returning a list of devices
965 containing filesystems and their type.
967 The return value is a hash, where the keys are the devices
968 containing filesystems, and the values are the filesystem types.
971 \"/dev/sda1\" => \"ntfs\"
972 \"/dev/sda2\" => \"ext2\"
973 \"/dev/vg_guest/lv_root\" => \"ext4\"
974 \"/dev/vg_guest/lv_swap\" => \"swap\"
976 The value can have the special value \"unknown\", meaning the
977 content of the device is undetermined or empty.
978 \"swap\" means a Linux swap partition.
980 This command runs other libguestfs commands, which might include
981 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
982 use this soon after launch and only when nothing is mounted.
984 Not all of the filesystems returned will be mountable. In
985 particular, swap partitions are returned in the list. Also
986 this command does not check that each filesystem
987 found is valid and mountable, and some filesystems might
988 be mountable but require special options. Filesystems may
989 not all belong to a single logical operating system
990 (use C<guestfs_inspect_os> to look for OSes).");
992 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
994 "add an image to examine or modify",
996 This function adds a virtual machine disk image C<filename> to
997 libguestfs. The first time you call this function, the disk
998 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1001 You don't necessarily need to be root when using libguestfs. However
1002 you obviously do need sufficient permissions to access the filename
1003 for whatever operations you want to perform (ie. read access if you
1004 just want to read the image or write access if you want to modify the
1007 This call checks that C<filename> exists.
1009 The optional arguments are:
1015 If true then the image is treated as read-only. Writes are still
1016 allowed, but they are stored in a temporary snapshot overlay which
1017 is discarded at the end. The disk that you add is not modified.
1021 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1022 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1023 Possible formats include C<raw> and C<qcow2>.
1025 Automatic detection of the format opens you up to a potential
1026 security hole when dealing with untrusted raw-format images.
1027 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1032 This rarely-used option lets you emulate the behaviour of the
1033 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1037 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1039 "get Windows systemroot of inspected operating system",
1041 This function should only be called with a root device string
1042 as returned by C<guestfs_inspect_os>.
1044 This returns the Windows systemroot of the inspected guest.
1045 The systemroot is a directory path such as C</WINDOWS>.
1047 This call assumes that the guest is Windows and that the
1048 systemroot could be determined by inspection. If this is not
1049 the case then an error is returned.
1051 Please read L<guestfs(3)/INSPECTION> for more details.");
1053 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1055 "return list of operating systems found by last inspection",
1057 This function is a convenient way to get the list of root
1058 devices, as returned from a previous call to C<guestfs_inspect_os>,
1059 but without redoing the whole inspection process.
1061 This returns an empty list if either no root devices were
1062 found or the caller has not called C<guestfs_inspect_os>.
1064 Please read L<guestfs(3)/INSPECTION> for more details.");
1066 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1068 "debug the QEMU command line (internal use only)",
1070 This returns the internal QEMU command line. 'debug' commands are
1071 not part of the formal API and can be removed or changed at any time.");
1073 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"]), -1, [FishAlias "domain"],
1075 "add the disk(s) from a named libvirt domain",
1077 This function adds the disk(s) attached to the named libvirt
1078 domain C<dom>. It works by connecting to libvirt, requesting
1079 the domain and domain XML from libvirt, parsing it for disks,
1080 and calling C<guestfs_add_drive_opts> on each one.
1082 The number of disks added is returned. This operation is atomic:
1083 if an error is returned, then no disks are added.
1085 This function does some minimal checks to make sure the libvirt
1086 domain is not running (unless C<readonly> is true). In a future
1087 version we will try to acquire the libvirt lock on each disk.
1089 Disks must be accessible locally. This often means that adding disks
1090 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1091 will fail unless those disks are accessible via the same device path
1094 The optional C<libvirturi> parameter sets the libvirt URI
1095 (see L<http://libvirt.org/uri.html>). If this is not set then
1096 we connect to the default libvirt URI (or one set through an
1097 environment variable, see the libvirt documentation for full
1098 details). If you are using the C API directly then it is more
1099 flexible to create the libvirt connection object yourself, get
1100 the domain object, and call C<guestfs_add_libvirt_dom>.
1102 The other optional parameters are passed directly through to
1103 C<guestfs_add_drive_opts>.");
1106 This interface is not quite baked yet. -- RWMJ 2010-11-11
1107 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"]), -1, [NotInFish],
1109 "add the disk(s) from a libvirt domain",
1111 This function adds the disk(s) attached to the libvirt domain C<dom>.
1112 It works by requesting the domain XML from libvirt, parsing it for
1113 disks, and calling C<guestfs_add_drive_opts> on each one.
1115 In the C API we declare C<void *dom>, but really it has type
1116 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1118 The number of disks added is returned. This operation is atomic:
1119 if an error is returned, then no disks are added.
1121 This function does some minimal checks to make sure the libvirt
1122 domain is not running (unless C<readonly> is true). In a future
1123 version we will try to acquire the libvirt lock on each disk.
1125 Disks must be accessible locally. This often means that adding disks
1126 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1127 will fail unless those disks are accessible via the same device path
1130 The optional parameters are passed directly through to
1131 C<guestfs_add_drive_opts>.");
1134 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1136 "get package format used by the operating system",
1138 This function should only be called with a root device string
1139 as returned by C<guestfs_inspect_os>.
1141 This function and C<guestfs_inspect_get_package_management> return
1142 the package format and package management tool used by the
1143 inspected operating system. For example for Fedora these
1144 functions would return C<rpm> (package format) and
1145 C<yum> (package management).
1147 This returns the string C<unknown> if we could not determine the
1148 package format I<or> if the operating system does not have
1149 a real packaging system (eg. Windows).
1151 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1152 Future versions of libguestfs may return other strings.
1154 Please read L<guestfs(3)/INSPECTION> for more details.");
1156 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1158 "get package management tool used by the operating system",
1160 This function should only be called with a root device string
1161 as returned by C<guestfs_inspect_os>.
1163 C<guestfs_inspect_get_package_format> and this function return
1164 the package format and package management tool used by the
1165 inspected operating system. For example for Fedora these
1166 functions would return C<rpm> (package format) and
1167 C<yum> (package management).
1169 This returns the string C<unknown> if we could not determine the
1170 package management tool I<or> if the operating system does not have
1171 a real packaging system (eg. Windows).
1173 Possible strings include: C<yum>, C<up2date>,
1174 C<apt> (for all Debian derivatives),
1175 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1176 Future versions of libguestfs may return other strings.
1178 Please read L<guestfs(3)/INSPECTION> for more details.");
1180 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1182 "get list of applications installed in the operating system",
1184 This function should only be called with a root device string
1185 as returned by C<guestfs_inspect_os>.
1187 Return the list of applications installed in the operating system.
1189 I<Note:> This call works differently from other parts of the
1190 inspection API. You have to call C<guestfs_inspect_os>, then
1191 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1192 before calling this. Listing applications is a significantly
1193 more difficult operation which requires access to the full
1194 filesystem. Also note that unlike the other
1195 C<guestfs_inspect_get_*> calls which are just returning
1196 data cached in the libguestfs handle, this call actually reads
1197 parts of the mounted filesystems during the call.
1199 This returns an empty list if the inspection code was not able
1200 to determine the list of applications.
1202 The application structure contains the following fields:
1208 The name of the application. For Red Hat-derived and Debian-derived
1209 Linux guests, this is the package name.
1211 =item C<app_display_name>
1213 The display name of the application, sometimes localized to the
1214 install language of the guest operating system.
1216 If unavailable this is returned as an empty string C<\"\">.
1217 Callers needing to display something can use C<app_name> instead.
1221 For package managers which use epochs, this contains the epoch of
1222 the package (an integer). If unavailable, this is returned as C<0>.
1224 =item C<app_version>
1226 The version string of the application or package. If unavailable
1227 this is returned as an empty string C<\"\">.
1229 =item C<app_release>
1231 The release string of the application or package, for package
1232 managers that use this. If unavailable this is returned as an
1233 empty string C<\"\">.
1235 =item C<app_install_path>
1237 The installation path of the application (on operating systems
1238 such as Windows which use installation paths). This path is
1239 in the format used by the guest operating system, it is not
1242 If unavailable this is returned as an empty string C<\"\">.
1244 =item C<app_trans_path>
1246 The install path translated into a libguestfs path.
1247 If unavailable this is returned as an empty string C<\"\">.
1249 =item C<app_publisher>
1251 The name of the publisher of the application, for package
1252 managers that use this. If unavailable this is returned
1253 as an empty string C<\"\">.
1257 The URL (eg. upstream URL) of the application.
1258 If unavailable this is returned as an empty string C<\"\">.
1260 =item C<app_source_package>
1262 For packaging systems which support this, the name of the source
1263 package. If unavailable this is returned as an empty string C<\"\">.
1265 =item C<app_summary>
1267 A short (usually one line) description of the application or package.
1268 If unavailable this is returned as an empty string C<\"\">.
1270 =item C<app_description>
1272 A longer description of the application or package.
1273 If unavailable this is returned as an empty string C<\"\">.
1277 Please read L<guestfs(3)/INSPECTION> for more details.");
1281 (* daemon_functions are any functions which cause some action
1282 * to take place in the daemon.
1285 let daemon_functions = [
1286 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1287 [InitEmpty, Always, TestOutput (
1288 [["part_disk"; "/dev/sda"; "mbr"];
1289 ["mkfs"; "ext2"; "/dev/sda1"];
1290 ["mount"; "/dev/sda1"; "/"];
1291 ["write"; "/new"; "new file contents"];
1292 ["cat"; "/new"]], "new file contents")],
1293 "mount a guest disk at a position in the filesystem",
1295 Mount a guest disk at a position in the filesystem. Block devices
1296 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1297 the guest. If those block devices contain partitions, they will have
1298 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1301 The rules are the same as for L<mount(2)>: A filesystem must
1302 first be mounted on C</> before others can be mounted. Other
1303 filesystems can only be mounted on directories which already
1306 The mounted filesystem is writable, if we have sufficient permissions
1307 on the underlying device.
1310 When you use this call, the filesystem options C<sync> and C<noatime>
1311 are set implicitly. This was originally done because we thought it
1312 would improve reliability, but it turns out that I<-o sync> has a
1313 very large negative performance impact and negligible effect on
1314 reliability. Therefore we recommend that you avoid using
1315 C<guestfs_mount> in any code that needs performance, and instead
1316 use C<guestfs_mount_options> (use an empty string for the first
1317 parameter if you don't want any options).");
1319 ("sync", (RErr, [], []), 2, [],
1320 [ InitEmpty, Always, TestRun [["sync"]]],
1321 "sync disks, writes are flushed through to the disk image",
1323 This syncs the disk, so that any writes are flushed through to the
1324 underlying disk image.
1326 You should always call this if you have modified a disk image, before
1327 closing the handle.");
1329 ("touch", (RErr, [Pathname "path"], []), 3, [],
1330 [InitBasicFS, Always, TestOutputTrue (
1332 ["exists"; "/new"]])],
1333 "update file timestamps or create a new file",
1335 Touch acts like the L<touch(1)> command. It can be used to
1336 update the timestamps on a file, or, if the file does not exist,
1337 to create a new zero-length file.
1339 This command only works on regular files, and will fail on other
1340 file types such as directories, symbolic links, block special etc.");
1342 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1343 [InitISOFS, Always, TestOutput (
1344 [["cat"; "/known-2"]], "abcdef\n")],
1345 "list the contents of a file",
1347 Return the contents of the file named C<path>.
1349 Note that this function cannot correctly handle binary files
1350 (specifically, files containing C<\\0> character which is treated
1351 as end of string). For those you need to use the C<guestfs_read_file>
1352 or C<guestfs_download> functions which have a more complex interface.");
1354 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1355 [], (* XXX Tricky to test because it depends on the exact format
1356 * of the 'ls -l' command, which changes between F10 and F11.
1358 "list the files in a directory (long format)",
1360 List the files in C<directory> (relative to the root directory,
1361 there is no cwd) in the format of 'ls -la'.
1363 This command is mostly useful for interactive sessions. It
1364 is I<not> intended that you try to parse the output string.");
1366 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1367 [InitBasicFS, Always, TestOutputList (
1369 ["touch"; "/newer"];
1370 ["touch"; "/newest"];
1371 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1372 "list the files in a directory",
1374 List the files in C<directory> (relative to the root directory,
1375 there is no cwd). The '.' and '..' entries are not returned, but
1376 hidden files are shown.
1378 This command is mostly useful for interactive sessions. Programs
1379 should probably use C<guestfs_readdir> instead.");
1381 ("list_devices", (RStringList "devices", [], []), 7, [],
1382 [InitEmpty, Always, TestOutputListOfDevices (
1383 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1384 "list the block devices",
1386 List all the block devices.
1388 The full block device names are returned, eg. C</dev/sda>.
1390 See also C<guestfs_list_filesystems>.");
1392 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1393 [InitBasicFS, Always, TestOutputListOfDevices (
1394 [["list_partitions"]], ["/dev/sda1"]);
1395 InitEmpty, Always, TestOutputListOfDevices (
1396 [["part_init"; "/dev/sda"; "mbr"];
1397 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1398 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1399 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1400 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1401 "list the partitions",
1403 List all the partitions detected on all block devices.
1405 The full partition device names are returned, eg. C</dev/sda1>
1407 This does not return logical volumes. For that you will need to
1408 call C<guestfs_lvs>.
1410 See also C<guestfs_list_filesystems>.");
1412 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1413 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1414 [["pvs"]], ["/dev/sda1"]);
1415 InitEmpty, Always, TestOutputListOfDevices (
1416 [["part_init"; "/dev/sda"; "mbr"];
1417 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1418 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1419 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1420 ["pvcreate"; "/dev/sda1"];
1421 ["pvcreate"; "/dev/sda2"];
1422 ["pvcreate"; "/dev/sda3"];
1423 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1424 "list the LVM physical volumes (PVs)",
1426 List all the physical volumes detected. This is the equivalent
1427 of the L<pvs(8)> command.
1429 This returns a list of just the device names that contain
1430 PVs (eg. C</dev/sda2>).
1432 See also C<guestfs_pvs_full>.");
1434 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1435 [InitBasicFSonLVM, Always, TestOutputList (
1437 InitEmpty, Always, TestOutputList (
1438 [["part_init"; "/dev/sda"; "mbr"];
1439 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1440 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1441 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1442 ["pvcreate"; "/dev/sda1"];
1443 ["pvcreate"; "/dev/sda2"];
1444 ["pvcreate"; "/dev/sda3"];
1445 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1446 ["vgcreate"; "VG2"; "/dev/sda3"];
1447 ["vgs"]], ["VG1"; "VG2"])],
1448 "list the LVM volume groups (VGs)",
1450 List all the volumes groups detected. This is the equivalent
1451 of the L<vgs(8)> command.
1453 This returns a list of just the volume group names that were
1454 detected (eg. C<VolGroup00>).
1456 See also C<guestfs_vgs_full>.");
1458 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1459 [InitBasicFSonLVM, Always, TestOutputList (
1460 [["lvs"]], ["/dev/VG/LV"]);
1461 InitEmpty, Always, TestOutputList (
1462 [["part_init"; "/dev/sda"; "mbr"];
1463 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1464 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1465 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1466 ["pvcreate"; "/dev/sda1"];
1467 ["pvcreate"; "/dev/sda2"];
1468 ["pvcreate"; "/dev/sda3"];
1469 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1470 ["vgcreate"; "VG2"; "/dev/sda3"];
1471 ["lvcreate"; "LV1"; "VG1"; "50"];
1472 ["lvcreate"; "LV2"; "VG1"; "50"];
1473 ["lvcreate"; "LV3"; "VG2"; "50"];
1474 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1475 "list the LVM logical volumes (LVs)",
1477 List all the logical volumes detected. This is the equivalent
1478 of the L<lvs(8)> command.
1480 This returns a list of the logical volume device names
1481 (eg. C</dev/VolGroup00/LogVol00>).
1483 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1485 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1486 [], (* XXX how to test? *)
1487 "list the LVM physical volumes (PVs)",
1489 List all the physical volumes detected. This is the equivalent
1490 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1492 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1493 [], (* XXX how to test? *)
1494 "list the LVM volume groups (VGs)",
1496 List all the volumes groups detected. This is the equivalent
1497 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1499 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1500 [], (* XXX how to test? *)
1501 "list the LVM logical volumes (LVs)",
1503 List all the logical volumes detected. This is the equivalent
1504 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1506 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1507 [InitISOFS, Always, TestOutputList (
1508 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1509 InitISOFS, Always, TestOutputList (
1510 [["read_lines"; "/empty"]], [])],
1511 "read file as lines",
1513 Return the contents of the file named C<path>.
1515 The file contents are returned as a list of lines. Trailing
1516 C<LF> and C<CRLF> character sequences are I<not> returned.
1518 Note that this function cannot correctly handle binary files
1519 (specifically, files containing C<\\0> character which is treated
1520 as end of line). For those you need to use the C<guestfs_read_file>
1521 function which has a more complex interface.");
1523 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1524 [], (* XXX Augeas code needs tests. *)
1525 "create a new Augeas handle",
1527 Create a new Augeas handle for editing configuration files.
1528 If there was any previous Augeas handle associated with this
1529 guestfs session, then it is closed.
1531 You must call this before using any other C<guestfs_aug_*>
1534 C<root> is the filesystem root. C<root> must not be NULL,
1537 The flags are the same as the flags defined in
1538 E<lt>augeas.hE<gt>, the logical I<or> of the following
1543 =item C<AUG_SAVE_BACKUP> = 1
1545 Keep the original file with a C<.augsave> extension.
1547 =item C<AUG_SAVE_NEWFILE> = 2
1549 Save changes into a file with extension C<.augnew>, and
1550 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1552 =item C<AUG_TYPE_CHECK> = 4
1554 Typecheck lenses (can be expensive).
1556 =item C<AUG_NO_STDINC> = 8
1558 Do not use standard load path for modules.
1560 =item C<AUG_SAVE_NOOP> = 16
1562 Make save a no-op, just record what would have been changed.
1564 =item C<AUG_NO_LOAD> = 32
1566 Do not load the tree in C<guestfs_aug_init>.
1570 To close the handle, you can call C<guestfs_aug_close>.
1572 To find out more about Augeas, see L<http://augeas.net/>.");
1574 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1575 [], (* XXX Augeas code needs tests. *)
1576 "close the current Augeas handle",
1578 Close the current Augeas handle and free up any resources
1579 used by it. After calling this, you have to call
1580 C<guestfs_aug_init> again before you can use any other
1581 Augeas functions.");
1583 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1584 [], (* XXX Augeas code needs tests. *)
1585 "define an Augeas variable",
1587 Defines an Augeas variable C<name> whose value is the result
1588 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1591 On success this returns the number of nodes in C<expr>, or
1592 C<0> if C<expr> evaluates to something which is not a nodeset.");
1594 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1595 [], (* XXX Augeas code needs tests. *)
1596 "define an Augeas node",
1598 Defines a variable C<name> whose value is the result of
1601 If C<expr> evaluates to an empty nodeset, a node is created,
1602 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1603 C<name> will be the nodeset containing that single node.
1605 On success this returns a pair containing the
1606 number of nodes in the nodeset, and a boolean flag
1607 if a node was created.");
1609 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1610 [], (* XXX Augeas code needs tests. *)
1611 "look up the value of an Augeas path",
1613 Look up the value associated with C<path>. If C<path>
1614 matches exactly one node, the C<value> is returned.");
1616 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1617 [], (* XXX Augeas code needs tests. *)
1618 "set Augeas path to value",
1620 Set the value associated with C<path> to C<val>.
1622 In the Augeas API, it is possible to clear a node by setting
1623 the value to NULL. Due to an oversight in the libguestfs API
1624 you cannot do that with this call. Instead you must use the
1625 C<guestfs_aug_clear> call.");
1627 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1628 [], (* XXX Augeas code needs tests. *)
1629 "insert a sibling Augeas node",
1631 Create a new sibling C<label> for C<path>, inserting it into
1632 the tree before or after C<path> (depending on the boolean
1635 C<path> must match exactly one existing node in the tree, and
1636 C<label> must be a label, ie. not contain C</>, C<*> or end
1637 with a bracketed index C<[N]>.");
1639 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1640 [], (* XXX Augeas code needs tests. *)
1641 "remove an Augeas path",
1643 Remove C<path> and all of its children.
1645 On success this returns the number of entries which were removed.");
1647 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1648 [], (* XXX Augeas code needs tests. *)
1651 Move the node C<src> to C<dest>. C<src> must match exactly
1652 one node. C<dest> is overwritten if it exists.");
1654 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1655 [], (* XXX Augeas code needs tests. *)
1656 "return Augeas nodes which match augpath",
1658 Returns a list of paths which match the path expression C<path>.
1659 The returned paths are sufficiently qualified so that they match
1660 exactly one node in the current tree.");
1662 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1663 [], (* XXX Augeas code needs tests. *)
1664 "write all pending Augeas changes to disk",
1666 This writes all pending changes to disk.
1668 The flags which were passed to C<guestfs_aug_init> affect exactly
1669 how files are saved.");
1671 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1672 [], (* XXX Augeas code needs tests. *)
1673 "load files into the tree",
1675 Load files into the tree.
1677 See C<aug_load> in the Augeas documentation for the full gory
1680 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1681 [], (* XXX Augeas code needs tests. *)
1682 "list Augeas nodes under augpath",
1684 This is just a shortcut for listing C<guestfs_aug_match>
1685 C<path/*> and sorting the resulting nodes into alphabetical order.");
1687 ("rm", (RErr, [Pathname "path"], []), 29, [],
1688 [InitBasicFS, Always, TestRun
1691 InitBasicFS, Always, TestLastFail
1693 InitBasicFS, Always, TestLastFail
1698 Remove the single file C<path>.");
1700 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1701 [InitBasicFS, Always, TestRun
1704 InitBasicFS, Always, TestLastFail
1705 [["rmdir"; "/new"]];
1706 InitBasicFS, Always, TestLastFail
1708 ["rmdir"; "/new"]]],
1709 "remove a directory",
1711 Remove the single directory C<path>.");
1713 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1714 [InitBasicFS, Always, TestOutputFalse
1716 ["mkdir"; "/new/foo"];
1717 ["touch"; "/new/foo/bar"];
1719 ["exists"; "/new"]]],
1720 "remove a file or directory recursively",
1722 Remove the file or directory C<path>, recursively removing the
1723 contents if its a directory. This is like the C<rm -rf> shell
1726 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1727 [InitBasicFS, Always, TestOutputTrue
1729 ["is_dir"; "/new"]];
1730 InitBasicFS, Always, TestLastFail
1731 [["mkdir"; "/new/foo/bar"]]],
1732 "create a directory",
1734 Create a directory named C<path>.");
1736 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1737 [InitBasicFS, Always, TestOutputTrue
1738 [["mkdir_p"; "/new/foo/bar"];
1739 ["is_dir"; "/new/foo/bar"]];
1740 InitBasicFS, Always, TestOutputTrue
1741 [["mkdir_p"; "/new/foo/bar"];
1742 ["is_dir"; "/new/foo"]];
1743 InitBasicFS, Always, TestOutputTrue
1744 [["mkdir_p"; "/new/foo/bar"];
1745 ["is_dir"; "/new"]];
1746 (* Regression tests for RHBZ#503133: *)
1747 InitBasicFS, Always, TestRun
1749 ["mkdir_p"; "/new"]];
1750 InitBasicFS, Always, TestLastFail
1752 ["mkdir_p"; "/new"]]],
1753 "create a directory and parents",
1755 Create a directory named C<path>, creating any parent directories
1756 as necessary. This is like the C<mkdir -p> shell command.");
1758 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1759 [], (* XXX Need stat command to test *)
1762 Change the mode (permissions) of C<path> to C<mode>. Only
1763 numeric modes are supported.
1765 I<Note>: When using this command from guestfish, C<mode>
1766 by default would be decimal, unless you prefix it with
1767 C<0> to get octal, ie. use C<0700> not C<700>.
1769 The mode actually set is affected by the umask.");
1771 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1772 [], (* XXX Need stat command to test *)
1773 "change file owner and group",
1775 Change the file owner to C<owner> and group to C<group>.
1777 Only numeric uid and gid are supported. If you want to use
1778 names, you will need to locate and parse the password file
1779 yourself (Augeas support makes this relatively easy).");
1781 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1782 [InitISOFS, Always, TestOutputTrue (
1783 [["exists"; "/empty"]]);
1784 InitISOFS, Always, TestOutputTrue (
1785 [["exists"; "/directory"]])],
1786 "test if file or directory exists",
1788 This returns C<true> if and only if there is a file, directory
1789 (or anything) with the given C<path> name.
1791 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1793 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1794 [InitISOFS, Always, TestOutputTrue (
1795 [["is_file"; "/known-1"]]);
1796 InitISOFS, Always, TestOutputFalse (
1797 [["is_file"; "/directory"]])],
1798 "test if a regular file",
1800 This returns C<true> if and only if there is a regular file
1801 with the given C<path> name. Note that it returns false for
1802 other objects like directories.
1804 See also C<guestfs_stat>.");
1806 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1807 [InitISOFS, Always, TestOutputFalse (
1808 [["is_dir"; "/known-3"]]);
1809 InitISOFS, Always, TestOutputTrue (
1810 [["is_dir"; "/directory"]])],
1811 "test if a directory",
1813 This returns C<true> if and only if there is a directory
1814 with the given C<path> name. Note that it returns false for
1815 other objects like files.
1817 See also C<guestfs_stat>.");
1819 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1820 [InitEmpty, Always, TestOutputListOfDevices (
1821 [["part_init"; "/dev/sda"; "mbr"];
1822 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1823 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1824 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1825 ["pvcreate"; "/dev/sda1"];
1826 ["pvcreate"; "/dev/sda2"];
1827 ["pvcreate"; "/dev/sda3"];
1828 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1829 "create an LVM physical volume",
1831 This creates an LVM physical volume on the named C<device>,
1832 where C<device> should usually be a partition name such
1835 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1836 [InitEmpty, Always, TestOutputList (
1837 [["part_init"; "/dev/sda"; "mbr"];
1838 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1839 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1840 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1841 ["pvcreate"; "/dev/sda1"];
1842 ["pvcreate"; "/dev/sda2"];
1843 ["pvcreate"; "/dev/sda3"];
1844 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1845 ["vgcreate"; "VG2"; "/dev/sda3"];
1846 ["vgs"]], ["VG1"; "VG2"])],
1847 "create an LVM volume group",
1849 This creates an LVM volume group called C<volgroup>
1850 from the non-empty list of physical volumes C<physvols>.");
1852 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1853 [InitEmpty, Always, TestOutputList (
1854 [["part_init"; "/dev/sda"; "mbr"];
1855 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1856 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1857 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1858 ["pvcreate"; "/dev/sda1"];
1859 ["pvcreate"; "/dev/sda2"];
1860 ["pvcreate"; "/dev/sda3"];
1861 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1862 ["vgcreate"; "VG2"; "/dev/sda3"];
1863 ["lvcreate"; "LV1"; "VG1"; "50"];
1864 ["lvcreate"; "LV2"; "VG1"; "50"];
1865 ["lvcreate"; "LV3"; "VG2"; "50"];
1866 ["lvcreate"; "LV4"; "VG2"; "50"];
1867 ["lvcreate"; "LV5"; "VG2"; "50"];
1869 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1870 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1871 "create an LVM logical volume",
1873 This creates an LVM logical volume called C<logvol>
1874 on the volume group C<volgroup>, with C<size> megabytes.");
1876 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1877 [InitEmpty, Always, TestOutput (
1878 [["part_disk"; "/dev/sda"; "mbr"];
1879 ["mkfs"; "ext2"; "/dev/sda1"];
1880 ["mount_options"; ""; "/dev/sda1"; "/"];
1881 ["write"; "/new"; "new file contents"];
1882 ["cat"; "/new"]], "new file contents")],
1883 "make a filesystem",
1885 This creates a filesystem on C<device> (usually a partition
1886 or LVM logical volume). The filesystem type is C<fstype>, for
1889 ("sfdisk", (RErr, [Device "device";
1890 Int "cyls"; Int "heads"; Int "sectors";
1891 StringList "lines"], []), 43, [DangerWillRobinson],
1893 "create partitions on a block device",
1895 This is a direct interface to the L<sfdisk(8)> program for creating
1896 partitions on block devices.
1898 C<device> should be a block device, for example C</dev/sda>.
1900 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1901 and sectors on the device, which are passed directly to sfdisk as
1902 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1903 of these, then the corresponding parameter is omitted. Usually for
1904 'large' disks, you can just pass C<0> for these, but for small
1905 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1906 out the right geometry and you will need to tell it.
1908 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1909 information refer to the L<sfdisk(8)> manpage.
1911 To create a single partition occupying the whole disk, you would
1912 pass C<lines> as a single element list, when the single element being
1913 the string C<,> (comma).
1915 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1916 C<guestfs_part_init>");
1918 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1919 (* Regression test for RHBZ#597135. *)
1920 [InitBasicFS, Always, TestLastFail
1921 [["write_file"; "/new"; "abc"; "10000"]]],
1924 This call creates a file called C<path>. The contents of the
1925 file is the string C<content> (which can contain any 8 bit data),
1926 with length C<size>.
1928 As a special case, if C<size> is C<0>
1929 then the length is calculated using C<strlen> (so in this case
1930 the content cannot contain embedded ASCII NULs).
1932 I<NB.> Owing to a bug, writing content containing ASCII NUL
1933 characters does I<not> work, even if the length is specified.");
1935 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1936 [InitEmpty, Always, TestOutputListOfDevices (
1937 [["part_disk"; "/dev/sda"; "mbr"];
1938 ["mkfs"; "ext2"; "/dev/sda1"];
1939 ["mount_options"; ""; "/dev/sda1"; "/"];
1940 ["mounts"]], ["/dev/sda1"]);
1941 InitEmpty, Always, TestOutputList (
1942 [["part_disk"; "/dev/sda"; "mbr"];
1943 ["mkfs"; "ext2"; "/dev/sda1"];
1944 ["mount_options"; ""; "/dev/sda1"; "/"];
1947 "unmount a filesystem",
1949 This unmounts the given filesystem. The filesystem may be
1950 specified either by its mountpoint (path) or the device which
1951 contains the filesystem.");
1953 ("mounts", (RStringList "devices", [], []), 46, [],
1954 [InitBasicFS, Always, TestOutputListOfDevices (
1955 [["mounts"]], ["/dev/sda1"])],
1956 "show mounted filesystems",
1958 This returns the list of currently mounted filesystems. It returns
1959 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1961 Some internal mounts are not shown.
1963 See also: C<guestfs_mountpoints>");
1965 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1966 [InitBasicFS, Always, TestOutputList (
1969 (* check that umount_all can unmount nested mounts correctly: *)
1970 InitEmpty, Always, TestOutputList (
1971 [["part_init"; "/dev/sda"; "mbr"];
1972 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1973 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1974 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1975 ["mkfs"; "ext2"; "/dev/sda1"];
1976 ["mkfs"; "ext2"; "/dev/sda2"];
1977 ["mkfs"; "ext2"; "/dev/sda3"];
1978 ["mount_options"; ""; "/dev/sda1"; "/"];
1980 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1981 ["mkdir"; "/mp1/mp2"];
1982 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1983 ["mkdir"; "/mp1/mp2/mp3"];
1986 "unmount all filesystems",
1988 This unmounts all mounted filesystems.
1990 Some internal mounts are not unmounted by this call.");
1992 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1994 "remove all LVM LVs, VGs and PVs",
1996 This command removes all LVM logical volumes, volume groups
1997 and physical volumes.");
1999 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2000 [InitISOFS, Always, TestOutput (
2001 [["file"; "/empty"]], "empty");
2002 InitISOFS, Always, TestOutput (
2003 [["file"; "/known-1"]], "ASCII text");
2004 InitISOFS, Always, TestLastFail (
2005 [["file"; "/notexists"]]);
2006 InitISOFS, Always, TestOutput (
2007 [["file"; "/abssymlink"]], "symbolic link");
2008 InitISOFS, Always, TestOutput (
2009 [["file"; "/directory"]], "directory")],
2010 "determine file type",
2012 This call uses the standard L<file(1)> command to determine
2013 the type or contents of the file.
2015 This call will also transparently look inside various types
2018 The exact command which runs is C<file -zb path>. Note in
2019 particular that the filename is not prepended to the output
2022 This command can also be used on C</dev/> devices
2023 (and partitions, LV names). You can for example use this
2024 to determine if a device contains a filesystem, although
2025 it's usually better to use C<guestfs_vfs_type>.
2027 If the C<path> does not begin with C</dev/> then
2028 this command only works for the content of regular files.
2029 For other file types (directory, symbolic link etc) it
2030 will just return the string C<directory> etc.");
2032 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2033 [InitBasicFS, Always, TestOutput (
2034 [["upload"; "test-command"; "/test-command"];
2035 ["chmod"; "0o755"; "/test-command"];
2036 ["command"; "/test-command 1"]], "Result1");
2037 InitBasicFS, Always, TestOutput (
2038 [["upload"; "test-command"; "/test-command"];
2039 ["chmod"; "0o755"; "/test-command"];
2040 ["command"; "/test-command 2"]], "Result2\n");
2041 InitBasicFS, Always, TestOutput (
2042 [["upload"; "test-command"; "/test-command"];
2043 ["chmod"; "0o755"; "/test-command"];
2044 ["command"; "/test-command 3"]], "\nResult3");
2045 InitBasicFS, Always, TestOutput (
2046 [["upload"; "test-command"; "/test-command"];
2047 ["chmod"; "0o755"; "/test-command"];
2048 ["command"; "/test-command 4"]], "\nResult4\n");
2049 InitBasicFS, Always, TestOutput (
2050 [["upload"; "test-command"; "/test-command"];
2051 ["chmod"; "0o755"; "/test-command"];
2052 ["command"; "/test-command 5"]], "\nResult5\n\n");
2053 InitBasicFS, Always, TestOutput (
2054 [["upload"; "test-command"; "/test-command"];
2055 ["chmod"; "0o755"; "/test-command"];
2056 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
2057 InitBasicFS, Always, TestOutput (
2058 [["upload"; "test-command"; "/test-command"];
2059 ["chmod"; "0o755"; "/test-command"];
2060 ["command"; "/test-command 7"]], "");
2061 InitBasicFS, Always, TestOutput (
2062 [["upload"; "test-command"; "/test-command"];
2063 ["chmod"; "0o755"; "/test-command"];
2064 ["command"; "/test-command 8"]], "\n");
2065 InitBasicFS, Always, TestOutput (
2066 [["upload"; "test-command"; "/test-command"];
2067 ["chmod"; "0o755"; "/test-command"];
2068 ["command"; "/test-command 9"]], "\n\n");
2069 InitBasicFS, Always, TestOutput (
2070 [["upload"; "test-command"; "/test-command"];
2071 ["chmod"; "0o755"; "/test-command"];
2072 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
2073 InitBasicFS, Always, TestOutput (
2074 [["upload"; "test-command"; "/test-command"];
2075 ["chmod"; "0o755"; "/test-command"];
2076 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
2077 InitBasicFS, Always, TestLastFail (
2078 [["upload"; "test-command"; "/test-command"];
2079 ["chmod"; "0o755"; "/test-command"];
2080 ["command"; "/test-command"]])],
2081 "run a command from the guest filesystem",
2083 This call runs a command from the guest filesystem. The
2084 filesystem must be mounted, and must contain a compatible
2085 operating system (ie. something Linux, with the same
2086 or compatible processor architecture).
2088 The single parameter is an argv-style list of arguments.
2089 The first element is the name of the program to run.
2090 Subsequent elements are parameters. The list must be
2091 non-empty (ie. must contain a program name). Note that
2092 the command runs directly, and is I<not> invoked via
2093 the shell (see C<guestfs_sh>).
2095 The return value is anything printed to I<stdout> by
2098 If the command returns a non-zero exit status, then
2099 this function returns an error message. The error message
2100 string is the content of I<stderr> from the command.
2102 The C<$PATH> environment variable will contain at least
2103 C</usr/bin> and C</bin>. If you require a program from
2104 another location, you should provide the full path in the
2107 Shared libraries and data files required by the program
2108 must be available on filesystems which are mounted in the
2109 correct places. It is the caller's responsibility to ensure
2110 all filesystems that are needed are mounted at the right
2113 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2114 [InitBasicFS, Always, TestOutputList (
2115 [["upload"; "test-command"; "/test-command"];
2116 ["chmod"; "0o755"; "/test-command"];
2117 ["command_lines"; "/test-command 1"]], ["Result1"]);
2118 InitBasicFS, Always, TestOutputList (
2119 [["upload"; "test-command"; "/test-command"];
2120 ["chmod"; "0o755"; "/test-command"];
2121 ["command_lines"; "/test-command 2"]], ["Result2"]);
2122 InitBasicFS, Always, TestOutputList (
2123 [["upload"; "test-command"; "/test-command"];
2124 ["chmod"; "0o755"; "/test-command"];
2125 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
2126 InitBasicFS, Always, TestOutputList (
2127 [["upload"; "test-command"; "/test-command"];
2128 ["chmod"; "0o755"; "/test-command"];
2129 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
2130 InitBasicFS, Always, TestOutputList (
2131 [["upload"; "test-command"; "/test-command"];
2132 ["chmod"; "0o755"; "/test-command"];
2133 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
2134 InitBasicFS, Always, TestOutputList (
2135 [["upload"; "test-command"; "/test-command"];
2136 ["chmod"; "0o755"; "/test-command"];
2137 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
2138 InitBasicFS, Always, TestOutputList (
2139 [["upload"; "test-command"; "/test-command"];
2140 ["chmod"; "0o755"; "/test-command"];
2141 ["command_lines"; "/test-command 7"]], []);
2142 InitBasicFS, Always, TestOutputList (
2143 [["upload"; "test-command"; "/test-command"];
2144 ["chmod"; "0o755"; "/test-command"];
2145 ["command_lines"; "/test-command 8"]], [""]);
2146 InitBasicFS, Always, TestOutputList (
2147 [["upload"; "test-command"; "/test-command"];
2148 ["chmod"; "0o755"; "/test-command"];
2149 ["command_lines"; "/test-command 9"]], ["";""]);
2150 InitBasicFS, Always, TestOutputList (
2151 [["upload"; "test-command"; "/test-command"];
2152 ["chmod"; "0o755"; "/test-command"];
2153 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
2154 InitBasicFS, Always, TestOutputList (
2155 [["upload"; "test-command"; "/test-command"];
2156 ["chmod"; "0o755"; "/test-command"];
2157 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
2158 "run a command, returning lines",
2160 This is the same as C<guestfs_command>, but splits the
2161 result into a list of lines.
2163 See also: C<guestfs_sh_lines>");
2165 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2166 [InitISOFS, Always, TestOutputStruct (
2167 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2168 "get file information",
2170 Returns file information for the given C<path>.
2172 This is the same as the C<stat(2)> system call.");
2174 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2175 [InitISOFS, Always, TestOutputStruct (
2176 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2177 "get file information for a symbolic link",
2179 Returns file information for the given C<path>.
2181 This is the same as C<guestfs_stat> except that if C<path>
2182 is a symbolic link, then the link is stat-ed, not the file it
2185 This is the same as the C<lstat(2)> system call.");
2187 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2188 [InitISOFS, Always, TestOutputStruct (
2189 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2190 "get file system statistics",
2192 Returns file system statistics for any mounted file system.
2193 C<path> should be a file or directory in the mounted file system
2194 (typically it is the mount point itself, but it doesn't need to be).
2196 This is the same as the C<statvfs(2)> system call.");
2198 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2200 "get ext2/ext3/ext4 superblock details",
2202 This returns the contents of the ext2, ext3 or ext4 filesystem
2203 superblock on C<device>.
2205 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2206 manpage for more details. The list of fields returned isn't
2207 clearly defined, and depends on both the version of C<tune2fs>
2208 that libguestfs was built against, and the filesystem itself.");
2210 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2211 [InitEmpty, Always, TestOutputTrue (
2212 [["blockdev_setro"; "/dev/sda"];
2213 ["blockdev_getro"; "/dev/sda"]])],
2214 "set block device to read-only",
2216 Sets the block device named C<device> to read-only.
2218 This uses the L<blockdev(8)> command.");
2220 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2221 [InitEmpty, Always, TestOutputFalse (
2222 [["blockdev_setrw"; "/dev/sda"];
2223 ["blockdev_getro"; "/dev/sda"]])],
2224 "set block device to read-write",
2226 Sets the block device named C<device> to read-write.
2228 This uses the L<blockdev(8)> command.");
2230 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2231 [InitEmpty, Always, TestOutputTrue (
2232 [["blockdev_setro"; "/dev/sda"];
2233 ["blockdev_getro"; "/dev/sda"]])],
2234 "is block device set to read-only",
2236 Returns a boolean indicating if the block device is read-only
2237 (true if read-only, false if not).
2239 This uses the L<blockdev(8)> command.");
2241 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2242 [InitEmpty, Always, TestOutputInt (
2243 [["blockdev_getss"; "/dev/sda"]], 512)],
2244 "get sectorsize of block device",
2246 This returns the size of sectors on a block device.
2247 Usually 512, but can be larger for modern devices.
2249 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2252 This uses the L<blockdev(8)> command.");
2254 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2255 [InitEmpty, Always, TestOutputInt (
2256 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2257 "get blocksize of block device",
2259 This returns the block size of a device.
2261 (Note this is different from both I<size in blocks> and
2262 I<filesystem block size>).
2264 This uses the L<blockdev(8)> command.");
2266 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2268 "set blocksize of block device",
2270 This sets the block size of a device.
2272 (Note this is different from both I<size in blocks> and
2273 I<filesystem block size>).
2275 This uses the L<blockdev(8)> command.");
2277 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2278 [InitEmpty, Always, TestOutputInt (
2279 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2280 "get total size of device in 512-byte sectors",
2282 This returns the size of the device in units of 512-byte sectors
2283 (even if the sectorsize isn't 512 bytes ... weird).
2285 See also C<guestfs_blockdev_getss> for the real sector size of
2286 the device, and C<guestfs_blockdev_getsize64> for the more
2287 useful I<size in bytes>.
2289 This uses the L<blockdev(8)> command.");
2291 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2292 [InitEmpty, Always, TestOutputInt (
2293 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2294 "get total size of device in bytes",
2296 This returns the size of the device in bytes.
2298 See also C<guestfs_blockdev_getsz>.
2300 This uses the L<blockdev(8)> command.");
2302 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2303 [InitEmpty, Always, TestRun
2304 [["blockdev_flushbufs"; "/dev/sda"]]],
2305 "flush device buffers",
2307 This tells the kernel to flush internal buffers associated
2310 This uses the L<blockdev(8)> command.");
2312 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2313 [InitEmpty, Always, TestRun
2314 [["blockdev_rereadpt"; "/dev/sda"]]],
2315 "reread partition table",
2317 Reread the partition table on C<device>.
2319 This uses the L<blockdev(8)> command.");
2321 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2322 [InitBasicFS, Always, TestOutput (
2323 (* Pick a file from cwd which isn't likely to change. *)
2324 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2325 ["checksum"; "md5"; "/COPYING.LIB"]],
2326 Digest.to_hex (Digest.file "COPYING.LIB"))],
2327 "upload a file from the local machine",
2329 Upload local file C<filename> to C<remotefilename> on the
2332 C<filename> can also be a named pipe.
2334 See also C<guestfs_download>.");
2336 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2337 [InitBasicFS, Always, TestOutput (
2338 (* Pick a file from cwd which isn't likely to change. *)
2339 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2340 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2341 ["upload"; "testdownload.tmp"; "/upload"];
2342 ["checksum"; "md5"; "/upload"]],
2343 Digest.to_hex (Digest.file "COPYING.LIB"))],
2344 "download a file to the local machine",
2346 Download file C<remotefilename> and save it as C<filename>
2347 on the local machine.
2349 C<filename> can also be a named pipe.
2351 See also C<guestfs_upload>, C<guestfs_cat>.");
2353 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2354 [InitISOFS, Always, TestOutput (
2355 [["checksum"; "crc"; "/known-3"]], "2891671662");
2356 InitISOFS, Always, TestLastFail (
2357 [["checksum"; "crc"; "/notexists"]]);
2358 InitISOFS, Always, TestOutput (
2359 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2360 InitISOFS, Always, TestOutput (
2361 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2362 InitISOFS, Always, TestOutput (
2363 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2364 InitISOFS, Always, TestOutput (
2365 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2366 InitISOFS, Always, TestOutput (
2367 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2368 InitISOFS, Always, TestOutput (
2369 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2370 (* Test for RHBZ#579608, absolute symbolic links. *)
2371 InitISOFS, Always, TestOutput (
2372 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2373 "compute MD5, SHAx or CRC checksum of file",
2375 This call computes the MD5, SHAx or CRC checksum of the
2378 The type of checksum to compute is given by the C<csumtype>
2379 parameter which must have one of the following values:
2385 Compute the cyclic redundancy check (CRC) specified by POSIX
2386 for the C<cksum> command.
2390 Compute the MD5 hash (using the C<md5sum> program).
2394 Compute the SHA1 hash (using the C<sha1sum> program).
2398 Compute the SHA224 hash (using the C<sha224sum> program).
2402 Compute the SHA256 hash (using the C<sha256sum> program).
2406 Compute the SHA384 hash (using the C<sha384sum> program).
2410 Compute the SHA512 hash (using the C<sha512sum> program).
2414 The checksum is returned as a printable string.
2416 To get the checksum for a device, use C<guestfs_checksum_device>.
2418 To get the checksums for many files, use C<guestfs_checksums_out>.");
2420 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2421 [InitBasicFS, Always, TestOutput (
2422 [["tar_in"; "../images/helloworld.tar"; "/"];
2423 ["cat"; "/hello"]], "hello\n")],
2424 "unpack tarfile to directory",
2426 This command uploads and unpacks local file C<tarfile> (an
2427 I<uncompressed> tar file) into C<directory>.
2429 To upload a compressed tarball, use C<guestfs_tgz_in>
2430 or C<guestfs_txz_in>.");
2432 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2434 "pack directory into tarfile",
2436 This command packs the contents of C<directory> and downloads
2437 it to local file C<tarfile>.
2439 To download a compressed tarball, use C<guestfs_tgz_out>
2440 or C<guestfs_txz_out>.");
2442 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2443 [InitBasicFS, Always, TestOutput (
2444 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2445 ["cat"; "/hello"]], "hello\n")],
2446 "unpack compressed tarball to directory",
2448 This command uploads and unpacks local file C<tarball> (a
2449 I<gzip compressed> tar file) into C<directory>.
2451 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2453 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2455 "pack directory into compressed tarball",
2457 This command packs the contents of C<directory> and downloads
2458 it to local file C<tarball>.
2460 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2462 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2463 [InitBasicFS, Always, TestLastFail (
2465 ["mount_ro"; "/dev/sda1"; "/"];
2466 ["touch"; "/new"]]);
2467 InitBasicFS, Always, TestOutput (
2468 [["write"; "/new"; "data"];
2470 ["mount_ro"; "/dev/sda1"; "/"];
2471 ["cat"; "/new"]], "data")],
2472 "mount a guest disk, read-only",
2474 This is the same as the C<guestfs_mount> command, but it
2475 mounts the filesystem with the read-only (I<-o ro>) flag.");
2477 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2479 "mount a guest disk with mount options",
2481 This is the same as the C<guestfs_mount> command, but it
2482 allows you to set the mount options as for the
2483 L<mount(8)> I<-o> flag.
2485 If the C<options> parameter is an empty string, then
2486 no options are passed (all options default to whatever
2487 the filesystem uses).");
2489 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2491 "mount a guest disk with mount options and vfstype",
2493 This is the same as the C<guestfs_mount> command, but it
2494 allows you to set both the mount options and the vfstype
2495 as for the L<mount(8)> I<-o> and I<-t> flags.");
2497 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2499 "debugging and internals",
2501 The C<guestfs_debug> command exposes some internals of
2502 C<guestfsd> (the guestfs daemon) that runs inside the
2505 There is no comprehensive help for this command. You have
2506 to look at the file C<daemon/debug.c> in the libguestfs source
2507 to find out what you can do.");
2509 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2510 [InitEmpty, Always, TestOutputList (
2511 [["part_disk"; "/dev/sda"; "mbr"];
2512 ["pvcreate"; "/dev/sda1"];
2513 ["vgcreate"; "VG"; "/dev/sda1"];
2514 ["lvcreate"; "LV1"; "VG"; "50"];
2515 ["lvcreate"; "LV2"; "VG"; "50"];
2516 ["lvremove"; "/dev/VG/LV1"];
2517 ["lvs"]], ["/dev/VG/LV2"]);
2518 InitEmpty, Always, TestOutputList (
2519 [["part_disk"; "/dev/sda"; "mbr"];
2520 ["pvcreate"; "/dev/sda1"];
2521 ["vgcreate"; "VG"; "/dev/sda1"];
2522 ["lvcreate"; "LV1"; "VG"; "50"];
2523 ["lvcreate"; "LV2"; "VG"; "50"];
2524 ["lvremove"; "/dev/VG"];
2526 InitEmpty, Always, TestOutputList (
2527 [["part_disk"; "/dev/sda"; "mbr"];
2528 ["pvcreate"; "/dev/sda1"];
2529 ["vgcreate"; "VG"; "/dev/sda1"];
2530 ["lvcreate"; "LV1"; "VG"; "50"];
2531 ["lvcreate"; "LV2"; "VG"; "50"];
2532 ["lvremove"; "/dev/VG"];
2534 "remove an LVM logical volume",
2536 Remove an LVM logical volume C<device>, where C<device> is
2537 the path to the LV, such as C</dev/VG/LV>.
2539 You can also remove all LVs in a volume group by specifying
2540 the VG name, C</dev/VG>.");
2542 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2543 [InitEmpty, Always, TestOutputList (
2544 [["part_disk"; "/dev/sda"; "mbr"];
2545 ["pvcreate"; "/dev/sda1"];
2546 ["vgcreate"; "VG"; "/dev/sda1"];
2547 ["lvcreate"; "LV1"; "VG"; "50"];
2548 ["lvcreate"; "LV2"; "VG"; "50"];
2551 InitEmpty, Always, TestOutputList (
2552 [["part_disk"; "/dev/sda"; "mbr"];
2553 ["pvcreate"; "/dev/sda1"];
2554 ["vgcreate"; "VG"; "/dev/sda1"];
2555 ["lvcreate"; "LV1"; "VG"; "50"];
2556 ["lvcreate"; "LV2"; "VG"; "50"];
2559 "remove an LVM volume group",
2561 Remove an LVM volume group C<vgname>, (for example C<VG>).
2563 This also forcibly removes all logical volumes in the volume
2566 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2567 [InitEmpty, Always, TestOutputListOfDevices (
2568 [["part_disk"; "/dev/sda"; "mbr"];
2569 ["pvcreate"; "/dev/sda1"];
2570 ["vgcreate"; "VG"; "/dev/sda1"];
2571 ["lvcreate"; "LV1"; "VG"; "50"];
2572 ["lvcreate"; "LV2"; "VG"; "50"];
2574 ["pvremove"; "/dev/sda1"];
2576 InitEmpty, Always, TestOutputListOfDevices (
2577 [["part_disk"; "/dev/sda"; "mbr"];
2578 ["pvcreate"; "/dev/sda1"];
2579 ["vgcreate"; "VG"; "/dev/sda1"];
2580 ["lvcreate"; "LV1"; "VG"; "50"];
2581 ["lvcreate"; "LV2"; "VG"; "50"];
2583 ["pvremove"; "/dev/sda1"];
2585 InitEmpty, Always, TestOutputListOfDevices (
2586 [["part_disk"; "/dev/sda"; "mbr"];
2587 ["pvcreate"; "/dev/sda1"];
2588 ["vgcreate"; "VG"; "/dev/sda1"];
2589 ["lvcreate"; "LV1"; "VG"; "50"];
2590 ["lvcreate"; "LV2"; "VG"; "50"];
2592 ["pvremove"; "/dev/sda1"];
2594 "remove an LVM physical volume",
2596 This wipes a physical volume C<device> so that LVM will no longer
2599 The implementation uses the C<pvremove> command which refuses to
2600 wipe physical volumes that contain any volume groups, so you have
2601 to remove those first.");
2603 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2604 [InitBasicFS, Always, TestOutput (
2605 [["set_e2label"; "/dev/sda1"; "testlabel"];
2606 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2607 "set the ext2/3/4 filesystem label",
2609 This sets the ext2/3/4 filesystem label of the filesystem on
2610 C<device> to C<label>. Filesystem labels are limited to
2613 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2614 to return the existing label on a filesystem.");
2616 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2618 "get the ext2/3/4 filesystem label",
2620 This returns the ext2/3/4 filesystem label of the filesystem on
2623 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2624 (let uuid = uuidgen () in
2625 [InitBasicFS, Always, TestOutput (
2626 [["set_e2uuid"; "/dev/sda1"; uuid];
2627 ["get_e2uuid"; "/dev/sda1"]], uuid);
2628 InitBasicFS, Always, TestOutput (
2629 [["set_e2uuid"; "/dev/sda1"; "clear"];
2630 ["get_e2uuid"; "/dev/sda1"]], "");
2631 (* We can't predict what UUIDs will be, so just check the commands run. *)
2632 InitBasicFS, Always, TestRun (
2633 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2634 InitBasicFS, Always, TestRun (
2635 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2636 "set the ext2/3/4 filesystem UUID",
2638 This sets the ext2/3/4 filesystem UUID of the filesystem on
2639 C<device> to C<uuid>. The format of the UUID and alternatives
2640 such as C<clear>, C<random> and C<time> are described in the
2641 L<tune2fs(8)> manpage.
2643 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2644 to return the existing UUID of a filesystem.");
2646 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2647 (* Regression test for RHBZ#597112. *)
2648 (let uuid = uuidgen () in
2649 [InitBasicFS, Always, TestOutput (
2650 [["mke2journal"; "1024"; "/dev/sdb"];
2651 ["set_e2uuid"; "/dev/sdb"; uuid];
2652 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2653 "get the ext2/3/4 filesystem UUID",
2655 This returns the ext2/3/4 filesystem UUID of the filesystem on
2658 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2659 [InitBasicFS, Always, TestOutputInt (
2660 [["umount"; "/dev/sda1"];
2661 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2662 InitBasicFS, Always, TestOutputInt (
2663 [["umount"; "/dev/sda1"];
2664 ["zero"; "/dev/sda1"];
2665 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2666 "run the filesystem checker",
2668 This runs the filesystem checker (fsck) on C<device> which
2669 should have filesystem type C<fstype>.
2671 The returned integer is the status. See L<fsck(8)> for the
2672 list of status codes from C<fsck>.
2680 Multiple status codes can be summed together.
2684 A non-zero return code can mean \"success\", for example if
2685 errors have been corrected on the filesystem.
2689 Checking or repairing NTFS volumes is not supported
2694 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2696 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2697 [InitBasicFS, Always, TestOutput (
2698 [["umount"; "/dev/sda1"];
2699 ["zero"; "/dev/sda1"];
2700 ["file"; "/dev/sda1"]], "data")],
2701 "write zeroes to the device",
2703 This command writes zeroes over the first few blocks of C<device>.
2705 How many blocks are zeroed isn't specified (but it's I<not> enough
2706 to securely wipe the device). It should be sufficient to remove
2707 any partition tables, filesystem superblocks and so on.
2709 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2711 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2713 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2714 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2716 [InitBasicFS, Always, TestOutputTrue (
2717 [["mkdir_p"; "/boot/grub"];
2718 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2719 ["grub_install"; "/"; "/dev/vda"];
2720 ["is_dir"; "/boot"]])],
2723 This command installs GRUB (the Grand Unified Bootloader) on
2724 C<device>, with the root directory being C<root>.
2726 Note: If grub-install reports the error
2727 \"No suitable drive was found in the generated device map.\"
2728 it may be that you need to create a C</boot/grub/device.map>
2729 file first that contains the mapping between grub device names
2730 and Linux device names. It is usually sufficient to create
2735 replacing C</dev/vda> with the name of the installation device.");
2737 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2738 [InitBasicFS, Always, TestOutput (
2739 [["write"; "/old"; "file content"];
2740 ["cp"; "/old"; "/new"];
2741 ["cat"; "/new"]], "file content");
2742 InitBasicFS, Always, TestOutputTrue (
2743 [["write"; "/old"; "file content"];
2744 ["cp"; "/old"; "/new"];
2745 ["is_file"; "/old"]]);
2746 InitBasicFS, Always, TestOutput (
2747 [["write"; "/old"; "file content"];
2749 ["cp"; "/old"; "/dir/new"];
2750 ["cat"; "/dir/new"]], "file content")],
2753 This copies a file from C<src> to C<dest> where C<dest> is
2754 either a destination filename or destination directory.");
2756 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2757 [InitBasicFS, Always, TestOutput (
2758 [["mkdir"; "/olddir"];
2759 ["mkdir"; "/newdir"];
2760 ["write"; "/olddir/file"; "file content"];
2761 ["cp_a"; "/olddir"; "/newdir"];
2762 ["cat"; "/newdir/olddir/file"]], "file content")],
2763 "copy a file or directory recursively",
2765 This copies a file or directory from C<src> to C<dest>
2766 recursively using the C<cp -a> command.");
2768 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2769 [InitBasicFS, Always, TestOutput (
2770 [["write"; "/old"; "file content"];
2771 ["mv"; "/old"; "/new"];
2772 ["cat"; "/new"]], "file content");
2773 InitBasicFS, Always, TestOutputFalse (
2774 [["write"; "/old"; "file content"];
2775 ["mv"; "/old"; "/new"];
2776 ["is_file"; "/old"]])],
2779 This moves a file from C<src> to C<dest> where C<dest> is
2780 either a destination filename or destination directory.");
2782 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2783 [InitEmpty, Always, TestRun (
2784 [["drop_caches"; "3"]])],
2785 "drop kernel page cache, dentries and inodes",
2787 This instructs the guest kernel to drop its page cache,
2788 and/or dentries and inode caches. The parameter C<whattodrop>
2789 tells the kernel what precisely to drop, see
2790 L<http://linux-mm.org/Drop_Caches>
2792 Setting C<whattodrop> to 3 should drop everything.
2794 This automatically calls L<sync(2)> before the operation,
2795 so that the maximum guest memory is freed.");
2797 ("dmesg", (RString "kmsgs", [], []), 91, [],
2798 [InitEmpty, Always, TestRun (
2800 "return kernel messages",
2802 This returns the kernel messages (C<dmesg> output) from
2803 the guest kernel. This is sometimes useful for extended
2804 debugging of problems.
2806 Another way to get the same information is to enable
2807 verbose messages with C<guestfs_set_verbose> or by setting
2808 the environment variable C<LIBGUESTFS_DEBUG=1> before
2809 running the program.");
2811 ("ping_daemon", (RErr, [], []), 92, [],
2812 [InitEmpty, Always, TestRun (
2813 [["ping_daemon"]])],
2814 "ping the guest daemon",
2816 This is a test probe into the guestfs daemon running inside
2817 the qemu subprocess. Calling this function checks that the
2818 daemon responds to the ping message, without affecting the daemon
2819 or attached block device(s) in any other way.");
2821 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2822 [InitBasicFS, Always, TestOutputTrue (
2823 [["write"; "/file1"; "contents of a file"];
2824 ["cp"; "/file1"; "/file2"];
2825 ["equal"; "/file1"; "/file2"]]);
2826 InitBasicFS, Always, TestOutputFalse (
2827 [["write"; "/file1"; "contents of a file"];
2828 ["write"; "/file2"; "contents of another file"];
2829 ["equal"; "/file1"; "/file2"]]);
2830 InitBasicFS, Always, TestLastFail (
2831 [["equal"; "/file1"; "/file2"]])],
2832 "test if two files have equal contents",
2834 This compares the two files C<file1> and C<file2> and returns
2835 true if their content is exactly equal, or false otherwise.
2837 The external L<cmp(1)> program is used for the comparison.");
2839 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2840 [InitISOFS, Always, TestOutputList (
2841 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2842 InitISOFS, Always, TestOutputList (
2843 [["strings"; "/empty"]], []);
2844 (* Test for RHBZ#579608, absolute symbolic links. *)
2845 InitISOFS, Always, TestRun (
2846 [["strings"; "/abssymlink"]])],
2847 "print the printable strings in a file",
2849 This runs the L<strings(1)> command on a file and returns
2850 the list of printable strings found.");
2852 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2853 [InitISOFS, Always, TestOutputList (
2854 [["strings_e"; "b"; "/known-5"]], []);
2855 InitBasicFS, Always, TestOutputList (
2856 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2857 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2858 "print the printable strings in a file",
2860 This is like the C<guestfs_strings> command, but allows you to
2861 specify the encoding of strings that are looked for in
2862 the source file C<path>.
2864 Allowed encodings are:
2870 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2871 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2875 Single 8-bit-byte characters.
2879 16-bit big endian strings such as those encoded in
2880 UTF-16BE or UCS-2BE.
2882 =item l (lower case letter L)
2884 16-bit little endian such as UTF-16LE and UCS-2LE.
2885 This is useful for examining binaries in Windows guests.
2889 32-bit big endian such as UCS-4BE.
2893 32-bit little endian such as UCS-4LE.
2897 The returned strings are transcoded to UTF-8.");
2899 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2900 [InitISOFS, Always, TestOutput (
2901 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2902 (* Test for RHBZ#501888c2 regression which caused large hexdump
2903 * commands to segfault.
2905 InitISOFS, Always, TestRun (
2906 [["hexdump"; "/100krandom"]]);
2907 (* Test for RHBZ#579608, absolute symbolic links. *)
2908 InitISOFS, Always, TestRun (
2909 [["hexdump"; "/abssymlink"]])],
2910 "dump a file in hexadecimal",
2912 This runs C<hexdump -C> on the given C<path>. The result is
2913 the human-readable, canonical hex dump of the file.");
2915 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2916 [InitNone, Always, TestOutput (
2917 [["part_disk"; "/dev/sda"; "mbr"];
2918 ["mkfs"; "ext3"; "/dev/sda1"];
2919 ["mount_options"; ""; "/dev/sda1"; "/"];
2920 ["write"; "/new"; "test file"];
2921 ["umount"; "/dev/sda1"];
2922 ["zerofree"; "/dev/sda1"];
2923 ["mount_options"; ""; "/dev/sda1"; "/"];
2924 ["cat"; "/new"]], "test file")],
2925 "zero unused inodes and disk blocks on ext2/3 filesystem",
2927 This runs the I<zerofree> program on C<device>. This program
2928 claims to zero unused inodes and disk blocks on an ext2/3
2929 filesystem, thus making it possible to compress the filesystem
2932 You should B<not> run this program if the filesystem is
2935 It is possible that using this program can damage the filesystem
2936 or data on the filesystem.");
2938 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2940 "resize an LVM physical volume",
2942 This resizes (expands or shrinks) an existing LVM physical
2943 volume to match the new size of the underlying device.");
2945 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2946 Int "cyls"; Int "heads"; Int "sectors";
2947 String "line"], []), 99, [DangerWillRobinson],
2949 "modify a single partition on a block device",
2951 This runs L<sfdisk(8)> option to modify just the single
2952 partition C<n> (note: C<n> counts from 1).
2954 For other parameters, see C<guestfs_sfdisk>. You should usually
2955 pass C<0> for the cyls/heads/sectors parameters.
2957 See also: C<guestfs_part_add>");
2959 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2961 "display the partition table",
2963 This displays the partition table on C<device>, in the
2964 human-readable output of the L<sfdisk(8)> command. It is
2965 not intended to be parsed.
2967 See also: C<guestfs_part_list>");
2969 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2971 "display the kernel geometry",
2973 This displays the kernel's idea of the geometry of C<device>.
2975 The result is in human-readable format, and not designed to
2978 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2980 "display the disk geometry from the partition table",
2982 This displays the disk geometry of C<device> read from the
2983 partition table. Especially in the case where the underlying
2984 block device has been resized, this can be different from the
2985 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2987 The result is in human-readable format, and not designed to
2990 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2992 "activate or deactivate all volume groups",
2994 This command activates or (if C<activate> is false) deactivates
2995 all logical volumes in all volume groups.
2996 If activated, then they are made known to the
2997 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2998 then those devices disappear.
3000 This command is the same as running C<vgchange -a y|n>");
3002 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3004 "activate or deactivate some volume groups",
3006 This command activates or (if C<activate> is false) deactivates
3007 all logical volumes in the listed volume groups C<volgroups>.
3008 If activated, then they are made known to the
3009 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3010 then those devices disappear.
3012 This command is the same as running C<vgchange -a y|n volgroups...>
3014 Note that if C<volgroups> is an empty list then B<all> volume groups
3015 are activated or deactivated.");
3017 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3018 [InitNone, Always, TestOutput (
3019 [["part_disk"; "/dev/sda"; "mbr"];
3020 ["pvcreate"; "/dev/sda1"];
3021 ["vgcreate"; "VG"; "/dev/sda1"];
3022 ["lvcreate"; "LV"; "VG"; "10"];
3023 ["mkfs"; "ext2"; "/dev/VG/LV"];
3024 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3025 ["write"; "/new"; "test content"];
3027 ["lvresize"; "/dev/VG/LV"; "20"];
3028 ["e2fsck_f"; "/dev/VG/LV"];
3029 ["resize2fs"; "/dev/VG/LV"];
3030 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3031 ["cat"; "/new"]], "test content");
3032 InitNone, Always, TestRun (
3033 (* Make an LV smaller to test RHBZ#587484. *)
3034 [["part_disk"; "/dev/sda"; "mbr"];
3035 ["pvcreate"; "/dev/sda1"];
3036 ["vgcreate"; "VG"; "/dev/sda1"];
3037 ["lvcreate"; "LV"; "VG"; "20"];
3038 ["lvresize"; "/dev/VG/LV"; "10"]])],
3039 "resize an LVM logical volume",
3041 This resizes (expands or shrinks) an existing LVM logical
3042 volume to C<mbytes>. When reducing, data in the reduced part
3045 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3046 [], (* lvresize tests this *)
3047 "resize an ext2, ext3 or ext4 filesystem",
3049 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3050 the underlying device.
3052 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3053 on the C<device> before calling this command. For unknown reasons
3054 C<resize2fs> sometimes gives an error about this and sometimes not.
3055 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3056 calling this function.");
3058 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3059 [InitBasicFS, Always, TestOutputList (
3060 [["find"; "/"]], ["lost+found"]);
3061 InitBasicFS, Always, TestOutputList (
3065 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3066 InitBasicFS, Always, TestOutputList (
3067 [["mkdir_p"; "/a/b/c"];
3068 ["touch"; "/a/b/c/d"];
3069 ["find"; "/a/b/"]], ["c"; "c/d"])],
3070 "find all files and directories",
3072 This command lists out all files and directories, recursively,
3073 starting at C<directory>. It is essentially equivalent to
3074 running the shell command C<find directory -print> but some
3075 post-processing happens on the output, described below.
3077 This returns a list of strings I<without any prefix>. Thus
3078 if the directory structure was:
3084 then the returned list from C<guestfs_find> C</tmp> would be
3092 If C<directory> is not a directory, then this command returns
3095 The returned list is sorted.
3097 See also C<guestfs_find0>.");
3099 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3100 [], (* lvresize tests this *)
3101 "check an ext2/ext3 filesystem",
3103 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3104 filesystem checker on C<device>, noninteractively (C<-p>),
3105 even if the filesystem appears to be clean (C<-f>).
3107 This command is only needed because of C<guestfs_resize2fs>
3108 (q.v.). Normally you should use C<guestfs_fsck>.");
3110 ("sleep", (RErr, [Int "secs"], []), 109, [],
3111 [InitNone, Always, TestRun (
3113 "sleep for some seconds",
3115 Sleep for C<secs> seconds.");
3117 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3118 [InitNone, Always, TestOutputInt (
3119 [["part_disk"; "/dev/sda"; "mbr"];
3120 ["mkfs"; "ntfs"; "/dev/sda1"];
3121 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3122 InitNone, Always, TestOutputInt (
3123 [["part_disk"; "/dev/sda"; "mbr"];
3124 ["mkfs"; "ext2"; "/dev/sda1"];
3125 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3126 "probe NTFS volume",
3128 This command runs the L<ntfs-3g.probe(8)> command which probes
3129 an NTFS C<device> for mountability. (Not all NTFS volumes can
3130 be mounted read-write, and some cannot be mounted at all).
3132 C<rw> is a boolean flag. Set it to true if you want to test
3133 if the volume can be mounted read-write. Set it to false if
3134 you want to test if the volume can be mounted read-only.
3136 The return value is an integer which C<0> if the operation
3137 would succeed, or some non-zero value documented in the
3138 L<ntfs-3g.probe(8)> manual page.");
3140 ("sh", (RString "output", [String "command"], []), 111, [],
3141 [], (* XXX needs tests *)
3142 "run a command via the shell",
3144 This call runs a command from the guest filesystem via the
3147 This is like C<guestfs_command>, but passes the command to:
3149 /bin/sh -c \"command\"
3151 Depending on the guest's shell, this usually results in
3152 wildcards being expanded, shell expressions being interpolated
3155 All the provisos about C<guestfs_command> apply to this call.");
3157 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3158 [], (* XXX needs tests *)
3159 "run a command via the shell returning lines",
3161 This is the same as C<guestfs_sh>, but splits the result
3162 into a list of lines.
3164 See also: C<guestfs_command_lines>");
3166 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3167 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3168 * code in stubs.c, since all valid glob patterns must start with "/".
3169 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3171 [InitBasicFS, Always, TestOutputList (
3172 [["mkdir_p"; "/a/b/c"];
3173 ["touch"; "/a/b/c/d"];
3174 ["touch"; "/a/b/c/e"];
3175 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3176 InitBasicFS, Always, TestOutputList (
3177 [["mkdir_p"; "/a/b/c"];
3178 ["touch"; "/a/b/c/d"];
3179 ["touch"; "/a/b/c/e"];
3180 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3181 InitBasicFS, Always, TestOutputList (
3182 [["mkdir_p"; "/a/b/c"];
3183 ["touch"; "/a/b/c/d"];
3184 ["touch"; "/a/b/c/e"];
3185 ["glob_expand"; "/a/*/x/*"]], [])],
3186 "expand a wildcard path",
3188 This command searches for all the pathnames matching
3189 C<pattern> according to the wildcard expansion rules
3192 If no paths match, then this returns an empty list
3193 (note: not an error).
3195 It is just a wrapper around the C L<glob(3)> function
3196 with flags C<GLOB_MARK|GLOB_BRACE>.
3197 See that manual page for more details.");
3199 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3200 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3201 [["scrub_device"; "/dev/sdc"]])],
3202 "scrub (securely wipe) a device",
3204 This command writes patterns over C<device> to make data retrieval
3207 It is an interface to the L<scrub(1)> program. See that
3208 manual page for more details.");
3210 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3211 [InitBasicFS, Always, TestRun (
3212 [["write"; "/file"; "content"];
3213 ["scrub_file"; "/file"]])],
3214 "scrub (securely wipe) a file",
3216 This command writes patterns over a file to make data retrieval
3219 The file is I<removed> after scrubbing.
3221 It is an interface to the L<scrub(1)> program. See that
3222 manual page for more details.");
3224 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3225 [], (* XXX needs testing *)
3226 "scrub (securely wipe) free space",
3228 This command creates the directory C<dir> and then fills it
3229 with files until the filesystem is full, and scrubs the files
3230 as for C<guestfs_scrub_file>, and deletes them.
3231 The intention is to scrub any free space on the partition
3234 It is an interface to the L<scrub(1)> program. See that
3235 manual page for more details.");
3237 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3238 [InitBasicFS, Always, TestRun (
3240 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
3241 "create a temporary directory",
3243 This command creates a temporary directory. The
3244 C<template> parameter should be a full pathname for the
3245 temporary directory name with the final six characters being
3248 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3249 the second one being suitable for Windows filesystems.
3251 The name of the temporary directory that was created
3254 The temporary directory is created with mode 0700
3255 and is owned by root.
3257 The caller is responsible for deleting the temporary
3258 directory and its contents after use.
3260 See also: L<mkdtemp(3)>");
3262 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3263 [InitISOFS, Always, TestOutputInt (
3264 [["wc_l"; "/10klines"]], 10000);
3265 (* Test for RHBZ#579608, absolute symbolic links. *)
3266 InitISOFS, Always, TestOutputInt (
3267 [["wc_l"; "/abssymlink"]], 10000)],
3268 "count lines in a file",
3270 This command counts the lines in a file, using the
3271 C<wc -l> external command.");
3273 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3274 [InitISOFS, Always, TestOutputInt (
3275 [["wc_w"; "/10klines"]], 10000)],
3276 "count words in a file",
3278 This command counts the words in a file, using the
3279 C<wc -w> external command.");
3281 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3282 [InitISOFS, Always, TestOutputInt (
3283 [["wc_c"; "/100kallspaces"]], 102400)],
3284 "count characters in a file",
3286 This command counts the characters in a file, using the
3287 C<wc -c> external command.");
3289 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3290 [InitISOFS, Always, TestOutputList (
3291 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3292 (* Test for RHBZ#579608, absolute symbolic links. *)
3293 InitISOFS, Always, TestOutputList (
3294 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3295 "return first 10 lines of a file",
3297 This command returns up to the first 10 lines of a file as
3298 a list of strings.");
3300 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3301 [InitISOFS, Always, TestOutputList (
3302 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3303 InitISOFS, Always, TestOutputList (
3304 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3305 InitISOFS, Always, TestOutputList (
3306 [["head_n"; "0"; "/10klines"]], [])],
3307 "return first N lines of a file",
3309 If the parameter C<nrlines> is a positive number, this returns the first
3310 C<nrlines> lines of the file C<path>.
3312 If the parameter C<nrlines> is a negative number, this returns lines
3313 from the file C<path>, excluding the last C<nrlines> lines.
3315 If the parameter C<nrlines> is zero, this returns an empty list.");
3317 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3318 [InitISOFS, Always, TestOutputList (
3319 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3320 "return last 10 lines of a file",
3322 This command returns up to the last 10 lines of a file as
3323 a list of strings.");
3325 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3326 [InitISOFS, Always, TestOutputList (
3327 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3328 InitISOFS, Always, TestOutputList (
3329 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3330 InitISOFS, Always, TestOutputList (
3331 [["tail_n"; "0"; "/10klines"]], [])],
3332 "return last N lines of a file",
3334 If the parameter C<nrlines> is a positive number, this returns the last
3335 C<nrlines> lines of the file C<path>.
3337 If the parameter C<nrlines> is a negative number, this returns lines
3338 from the file C<path>, starting with the C<-nrlines>th line.
3340 If the parameter C<nrlines> is zero, this returns an empty list.");
3342 ("df", (RString "output", [], []), 125, [],
3343 [], (* XXX Tricky to test because it depends on the exact format
3344 * of the 'df' command and other imponderables.
3346 "report file system disk space usage",
3348 This command runs the C<df> command to report disk space used.
3350 This command is mostly useful for interactive sessions. It
3351 is I<not> intended that you try to parse the output string.
3352 Use C<statvfs> from programs.");
3354 ("df_h", (RString "output", [], []), 126, [],
3355 [], (* XXX Tricky to test because it depends on the exact format
3356 * of the 'df' command and other imponderables.
3358 "report file system disk space usage (human readable)",
3360 This command runs the C<df -h> command to report disk space used
3361 in human-readable format.
3363 This command is mostly useful for interactive sessions. It
3364 is I<not> intended that you try to parse the output string.
3365 Use C<statvfs> from programs.");
3367 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3368 [InitISOFS, Always, TestOutputInt (
3369 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3370 "estimate file space usage",
3372 This command runs the C<du -s> command to estimate file space
3375 C<path> can be a file or a directory. If C<path> is a directory
3376 then the estimate includes the contents of the directory and all
3377 subdirectories (recursively).
3379 The result is the estimated size in I<kilobytes>
3380 (ie. units of 1024 bytes).");
3382 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3383 [InitISOFS, Always, TestOutputList (
3384 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3385 "list files in an initrd",
3387 This command lists out files contained in an initrd.
3389 The files are listed without any initial C</> character. The
3390 files are listed in the order they appear (not necessarily
3391 alphabetical). Directory names are listed as separate items.
3393 Old Linux kernels (2.4 and earlier) used a compressed ext2
3394 filesystem as initrd. We I<only> support the newer initramfs
3395 format (compressed cpio files).");
3397 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3399 "mount a file using the loop device",
3401 This command lets you mount C<file> (a filesystem image
3402 in a file) on a mount point. It is entirely equivalent to
3403 the command C<mount -o loop file mountpoint>.");
3405 ("mkswap", (RErr, [Device "device"], []), 130, [],
3406 [InitEmpty, Always, TestRun (
3407 [["part_disk"; "/dev/sda"; "mbr"];
3408 ["mkswap"; "/dev/sda1"]])],
3409 "create a swap partition",
3411 Create a swap partition on C<device>.");
3413 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3414 [InitEmpty, Always, TestRun (
3415 [["part_disk"; "/dev/sda"; "mbr"];
3416 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3417 "create a swap partition with a label",
3419 Create a swap partition on C<device> with label C<label>.
3421 Note that you cannot attach a swap label to a block device
3422 (eg. C</dev/sda>), just to a partition. This appears to be
3423 a limitation of the kernel or swap tools.");
3425 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3426 (let uuid = uuidgen () in
3427 [InitEmpty, Always, TestRun (
3428 [["part_disk"; "/dev/sda"; "mbr"];
3429 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3430 "create a swap partition with an explicit UUID",
3432 Create a swap partition on C<device> with UUID C<uuid>.");
3434 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3435 [InitBasicFS, Always, TestOutputStruct (
3436 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3437 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3438 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3439 InitBasicFS, Always, TestOutputStruct (
3440 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3441 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3442 "make block, character or FIFO devices",
3444 This call creates block or character special devices, or
3445 named pipes (FIFOs).
3447 The C<mode> parameter should be the mode, using the standard
3448 constants. C<devmajor> and C<devminor> are the
3449 device major and minor numbers, only used when creating block
3450 and character special devices.
3452 Note that, just like L<mknod(2)>, the mode must be bitwise
3453 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3454 just creates a regular file). These constants are
3455 available in the standard Linux header files, or you can use
3456 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3457 which are wrappers around this command which bitwise OR
3458 in the appropriate constant for you.
3460 The mode actually set is affected by the umask.");
3462 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3463 [InitBasicFS, Always, TestOutputStruct (
3464 [["mkfifo"; "0o777"; "/node"];
3465 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3466 "make FIFO (named pipe)",
3468 This call creates a FIFO (named pipe) called C<path> with
3469 mode C<mode>. It is just a convenient wrapper around
3472 The mode actually set is affected by the umask.");
3474 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3475 [InitBasicFS, Always, TestOutputStruct (
3476 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3477 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3478 "make block device node",
3480 This call creates a block device node called C<path> with
3481 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3482 It is just a convenient wrapper around C<guestfs_mknod>.
3484 The mode actually set is affected by the umask.");
3486 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3487 [InitBasicFS, Always, TestOutputStruct (
3488 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3489 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3490 "make char device node",
3492 This call creates a char device node called C<path> with
3493 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3494 It is just a convenient wrapper around C<guestfs_mknod>.
3496 The mode actually set is affected by the umask.");
3498 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3499 [InitEmpty, Always, TestOutputInt (
3500 [["umask"; "0o22"]], 0o22)],
3501 "set file mode creation mask (umask)",
3503 This function sets the mask used for creating new files and
3504 device nodes to C<mask & 0777>.
3506 Typical umask values would be C<022> which creates new files
3507 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3508 C<002> which creates new files with permissions like
3509 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3511 The default umask is C<022>. This is important because it
3512 means that directories and device nodes will be created with
3513 C<0644> or C<0755> mode even if you specify C<0777>.
3515 See also C<guestfs_get_umask>,
3516 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3518 This call returns the previous umask.");
3520 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3522 "read directories entries",
3524 This returns the list of directory entries in directory C<dir>.
3526 All entries in the directory are returned, including C<.> and
3527 C<..>. The entries are I<not> sorted, but returned in the same
3528 order as the underlying filesystem.
3530 Also this call returns basic file type information about each
3531 file. The C<ftyp> field will contain one of the following characters:
3569 The L<readdir(3)> call returned a C<d_type> field with an
3574 This function is primarily intended for use by programs. To
3575 get a simple list of names, use C<guestfs_ls>. To get a printable
3576 directory for human consumption, use C<guestfs_ll>.");
3578 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3580 "create partitions on a block device",
3582 This is a simplified interface to the C<guestfs_sfdisk>
3583 command, where partition sizes are specified in megabytes
3584 only (rounded to the nearest cylinder) and you don't need
3585 to specify the cyls, heads and sectors parameters which
3586 were rarely if ever used anyway.
3588 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3589 and C<guestfs_part_disk>");
3591 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3593 "determine file type inside a compressed file",
3595 This command runs C<file> after first decompressing C<path>
3598 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3600 Since 1.0.63, use C<guestfs_file> instead which can now
3601 process compressed files.");
3603 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3605 "list extended attributes of a file or directory",
3607 This call lists the extended attributes of the file or directory
3610 At the system call level, this is a combination of the
3611 L<listxattr(2)> and L<getxattr(2)> calls.
3613 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3615 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3617 "list extended attributes of a file or directory",
3619 This is the same as C<guestfs_getxattrs>, but if C<path>
3620 is a symbolic link, then it returns the extended attributes
3621 of the link itself.");
3623 ("setxattr", (RErr, [String "xattr";
3624 String "val"; Int "vallen"; (* will be BufferIn *)
3625 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3627 "set extended attribute of a file or directory",
3629 This call sets the extended attribute named C<xattr>
3630 of the file C<path> to the value C<val> (of length C<vallen>).
3631 The value is arbitrary 8 bit data.
3633 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3635 ("lsetxattr", (RErr, [String "xattr";
3636 String "val"; Int "vallen"; (* will be BufferIn *)
3637 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3639 "set extended attribute of a file or directory",
3641 This is the same as C<guestfs_setxattr>, but if C<path>
3642 is a symbolic link, then it sets an extended attribute
3643 of the link itself.");
3645 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3647 "remove extended attribute of a file or directory",
3649 This call removes the extended attribute named C<xattr>
3650 of the file C<path>.
3652 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3654 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3656 "remove extended attribute of a file or directory",
3658 This is the same as C<guestfs_removexattr>, but if C<path>
3659 is a symbolic link, then it removes an extended attribute
3660 of the link itself.");
3662 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3666 This call is similar to C<guestfs_mounts>. That call returns
3667 a list of devices. This one returns a hash table (map) of
3668 device name to directory where the device is mounted.");
3670 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3671 (* This is a special case: while you would expect a parameter
3672 * of type "Pathname", that doesn't work, because it implies
3673 * NEED_ROOT in the generated calling code in stubs.c, and
3674 * this function cannot use NEED_ROOT.
3677 "create a mountpoint",
3679 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3680 specialized calls that can be used to create extra mountpoints
3681 before mounting the first filesystem.
3683 These calls are I<only> necessary in some very limited circumstances,
3684 mainly the case where you want to mount a mix of unrelated and/or
3685 read-only filesystems together.
3687 For example, live CDs often contain a \"Russian doll\" nest of
3688 filesystems, an ISO outer layer, with a squashfs image inside, with
3689 an ext2/3 image inside that. You can unpack this as follows
3692 add-ro Fedora-11-i686-Live.iso
3696 mkmountpoint /ext3fs
3698 mount-loop /cd/LiveOS/squashfs.img /sqsh
3699 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3701 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3703 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3704 You may get unexpected errors if you try to mix these calls. It is
3705 safest to manually unmount filesystems and remove mountpoints after use.
3707 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3708 longest first, so for this to work for manual mountpoints, you
3709 must ensure that the innermost mountpoints have the longest
3710 pathnames, as in the example code above.
3712 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3714 Autosync [see C<guestfs_set_autosync>, this is set by default on
3715 handles] means that C<guestfs_umount_all> is called when the handle
3716 is closed which can also trigger these issues.");
3718 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3720 "remove a mountpoint",
3722 This calls removes a mountpoint that was previously created
3723 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3724 for full details.");
3726 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3727 [InitISOFS, Always, TestOutputBuffer (
3728 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3729 (* Test various near large, large and too large files (RHBZ#589039). *)
3730 InitBasicFS, Always, TestLastFail (
3732 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3733 ["read_file"; "/a"]]);
3734 InitBasicFS, Always, TestLastFail (
3736 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3737 ["read_file"; "/a"]]);
3738 InitBasicFS, Always, TestLastFail (
3740 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3741 ["read_file"; "/a"]])],
3744 This calls returns the contents of the file C<path> as a
3747 Unlike C<guestfs_cat>, this function can correctly
3748 handle files that contain embedded ASCII NUL characters.
3749 However unlike C<guestfs_download>, this function is limited
3750 in the total size of file that can be handled.");
3752 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3753 [InitISOFS, Always, TestOutputList (
3754 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3755 InitISOFS, Always, TestOutputList (
3756 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3757 (* Test for RHBZ#579608, absolute symbolic links. *)
3758 InitISOFS, Always, TestOutputList (
3759 [["grep"; "nomatch"; "/abssymlink"]], [])],
3760 "return lines matching a pattern",
3762 This calls the external C<grep> program and returns the
3765 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3766 [InitISOFS, Always, TestOutputList (
3767 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3768 "return lines matching a pattern",
3770 This calls the external C<egrep> program and returns the
3773 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3774 [InitISOFS, Always, TestOutputList (
3775 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3776 "return lines matching a pattern",
3778 This calls the external C<fgrep> program and returns the
3781 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3782 [InitISOFS, Always, TestOutputList (
3783 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3784 "return lines matching a pattern",
3786 This calls the external C<grep -i> program and returns the
3789 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3790 [InitISOFS, Always, TestOutputList (
3791 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3792 "return lines matching a pattern",
3794 This calls the external C<egrep -i> program and returns the
3797 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3798 [InitISOFS, Always, TestOutputList (
3799 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3800 "return lines matching a pattern",
3802 This calls the external C<fgrep -i> program and returns the
3805 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3806 [InitISOFS, Always, TestOutputList (
3807 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3808 "return lines matching a pattern",
3810 This calls the external C<zgrep> program and returns the
3813 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3814 [InitISOFS, Always, TestOutputList (
3815 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3816 "return lines matching a pattern",
3818 This calls the external C<zegrep> program and returns the
3821 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3822 [InitISOFS, Always, TestOutputList (
3823 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3824 "return lines matching a pattern",
3826 This calls the external C<zfgrep> program and returns the
3829 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3830 [InitISOFS, Always, TestOutputList (
3831 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3832 "return lines matching a pattern",
3834 This calls the external C<zgrep -i> program and returns the
3837 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3838 [InitISOFS, Always, TestOutputList (
3839 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3840 "return lines matching a pattern",
3842 This calls the external C<zegrep -i> program and returns the
3845 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3846 [InitISOFS, Always, TestOutputList (
3847 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3848 "return lines matching a pattern",
3850 This calls the external C<zfgrep -i> program and returns the
3853 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3854 [InitISOFS, Always, TestOutput (
3855 [["realpath"; "/../directory"]], "/directory")],
3856 "canonicalized absolute pathname",
3858 Return the canonicalized absolute pathname of C<path>. The
3859 returned path has no C<.>, C<..> or symbolic link path elements.");
3861 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3862 [InitBasicFS, Always, TestOutputStruct (
3865 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3866 "create a hard link",
3868 This command creates a hard link using the C<ln> command.");
3870 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3871 [InitBasicFS, Always, TestOutputStruct (
3874 ["ln_f"; "/a"; "/b"];
3875 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3876 "create a hard link",
3878 This command creates a hard link using the C<ln -f> command.
3879 The C<-f> option removes the link (C<linkname>) if it exists already.");
3881 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3882 [InitBasicFS, Always, TestOutputStruct (
3884 ["ln_s"; "a"; "/b"];
3885 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3886 "create a symbolic link",
3888 This command creates a symbolic link using the C<ln -s> command.");
3890 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3891 [InitBasicFS, Always, TestOutput (
3892 [["mkdir_p"; "/a/b"];
3893 ["touch"; "/a/b/c"];
3894 ["ln_sf"; "../d"; "/a/b/c"];
3895 ["readlink"; "/a/b/c"]], "../d")],
3896 "create a symbolic link",
3898 This command creates a symbolic link using the C<ln -sf> command,
3899 The C<-f> option removes the link (C<linkname>) if it exists already.");
3901 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3902 [] (* XXX tested above *),
3903 "read the target of a symbolic link",
3905 This command reads the target of a symbolic link.");
3907 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3908 [InitBasicFS, Always, TestOutputStruct (
3909 [["fallocate"; "/a"; "1000000"];
3910 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3911 "preallocate a file in the guest filesystem",
3913 This command preallocates a file (containing zero bytes) named
3914 C<path> of size C<len> bytes. If the file exists already, it
3917 Do not confuse this with the guestfish-specific
3918 C<alloc> command which allocates a file in the host and
3919 attaches it as a device.");
3921 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3922 [InitPartition, Always, TestRun (
3923 [["mkswap"; "/dev/sda1"];
3924 ["swapon_device"; "/dev/sda1"];
3925 ["swapoff_device"; "/dev/sda1"]])],
3926 "enable swap on device",
3928 This command enables the libguestfs appliance to use the
3929 swap device or partition named C<device>. The increased
3930 memory is made available for all commands, for example
3931 those run using C<guestfs_command> or C<guestfs_sh>.
3933 Note that you should not swap to existing guest swap
3934 partitions unless you know what you are doing. They may
3935 contain hibernation information, or other information that
3936 the guest doesn't want you to trash. You also risk leaking
3937 information about the host to the guest this way. Instead,
3938 attach a new host device to the guest and swap on that.");
3940 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3941 [], (* XXX tested by swapon_device *)
3942 "disable swap on device",
3944 This command disables the libguestfs appliance swap
3945 device or partition named C<device>.
3946 See C<guestfs_swapon_device>.");
3948 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3949 [InitBasicFS, Always, TestRun (
3950 [["fallocate"; "/swap"; "8388608"];
3951 ["mkswap_file"; "/swap"];
3952 ["swapon_file"; "/swap"];
3953 ["swapoff_file"; "/swap"]])],
3954 "enable swap on file",
3956 This command enables swap to a file.
3957 See C<guestfs_swapon_device> for other notes.");
3959 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3960 [], (* XXX tested by swapon_file *)
3961 "disable swap on file",
3963 This command disables the libguestfs appliance swap on file.");
3965 ("swapon_label", (RErr, [String "label"], []), 174, [],
3966 [InitEmpty, Always, TestRun (
3967 [["part_disk"; "/dev/sdb"; "mbr"];
3968 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3969 ["swapon_label"; "swapit"];
3970 ["swapoff_label"; "swapit"];
3971 ["zero"; "/dev/sdb"];
3972 ["blockdev_rereadpt"; "/dev/sdb"]])],
3973 "enable swap on labeled swap partition",
3975 This command enables swap to a labeled swap partition.
3976 See C<guestfs_swapon_device> for other notes.");
3978 ("swapoff_label", (RErr, [String "label"], []), 175, [],
3979 [], (* XXX tested by swapon_label *)
3980 "disable swap on labeled swap partition",
3982 This command disables the libguestfs appliance swap on
3983 labeled swap partition.");
3985 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3986 (let uuid = uuidgen () in
3987 [InitEmpty, Always, TestRun (
3988 [["mkswap_U"; uuid; "/dev/sdb"];
3989 ["swapon_uuid"; uuid];
3990 ["swapoff_uuid"; uuid]])]),
3991 "enable swap on swap partition by UUID",
3993 This command enables swap to a swap partition with the given UUID.
3994 See C<guestfs_swapon_device> for other notes.");
3996 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3997 [], (* XXX tested by swapon_uuid *)
3998 "disable swap on swap partition by UUID",
4000 This command disables the libguestfs appliance swap partition
4001 with the given UUID.");
4003 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4004 [InitBasicFS, Always, TestRun (
4005 [["fallocate"; "/swap"; "8388608"];
4006 ["mkswap_file"; "/swap"]])],
4007 "create a swap file",
4011 This command just writes a swap file signature to an existing
4012 file. To create the file itself, use something like C<guestfs_fallocate>.");
4014 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4015 [InitISOFS, Always, TestRun (
4016 [["inotify_init"; "0"]])],
4017 "create an inotify handle",
4019 This command creates a new inotify handle.
4020 The inotify subsystem can be used to notify events which happen to
4021 objects in the guest filesystem.
4023 C<maxevents> is the maximum number of events which will be
4024 queued up between calls to C<guestfs_inotify_read> or
4025 C<guestfs_inotify_files>.
4026 If this is passed as C<0>, then the kernel (or previously set)
4027 default is used. For Linux 2.6.29 the default was 16384 events.
4028 Beyond this limit, the kernel throws away events, but records
4029 the fact that it threw them away by setting a flag
4030 C<IN_Q_OVERFLOW> in the returned structure list (see
4031 C<guestfs_inotify_read>).
4033 Before any events are generated, you have to add some
4034 watches to the internal watch list. See:
4035 C<guestfs_inotify_add_watch>,
4036 C<guestfs_inotify_rm_watch> and
4037 C<guestfs_inotify_watch_all>.
4039 Queued up events should be read periodically by calling
4040 C<guestfs_inotify_read>
4041 (or C<guestfs_inotify_files> which is just a helpful
4042 wrapper around C<guestfs_inotify_read>). If you don't
4043 read the events out often enough then you risk the internal
4046 The handle should be closed after use by calling
4047 C<guestfs_inotify_close>. This also removes any
4048 watches automatically.
4050 See also L<inotify(7)> for an overview of the inotify interface
4051 as exposed by the Linux kernel, which is roughly what we expose
4052 via libguestfs. Note that there is one global inotify handle
4053 per libguestfs instance.");
4055 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4056 [InitBasicFS, Always, TestOutputList (
4057 [["inotify_init"; "0"];
4058 ["inotify_add_watch"; "/"; "1073741823"];
4061 ["inotify_files"]], ["a"; "b"])],
4062 "add an inotify watch",
4064 Watch C<path> for the events listed in C<mask>.
4066 Note that if C<path> is a directory then events within that
4067 directory are watched, but this does I<not> happen recursively
4068 (in subdirectories).
4070 Note for non-C or non-Linux callers: the inotify events are
4071 defined by the Linux kernel ABI and are listed in
4072 C</usr/include/sys/inotify.h>.");
4074 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4076 "remove an inotify watch",
4078 Remove a previously defined inotify watch.
4079 See C<guestfs_inotify_add_watch>.");
4081 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4083 "return list of inotify events",
4085 Return the complete queue of events that have happened
4086 since the previous read call.
4088 If no events have happened, this returns an empty list.
4090 I<Note>: In order to make sure that all events have been
4091 read, you must call this function repeatedly until it
4092 returns an empty list. The reason is that the call will
4093 read events up to the maximum appliance-to-host message
4094 size and leave remaining events in the queue.");
4096 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4098 "return list of watched files that had events",
4100 This function is a helpful wrapper around C<guestfs_inotify_read>
4101 which just returns a list of pathnames of objects that were
4102 touched. The returned pathnames are sorted and deduplicated.");
4104 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4106 "close the inotify handle",
4108 This closes the inotify handle which was previously
4109 opened by inotify_init. It removes all watches, throws
4110 away any pending events, and deallocates all resources.");
4112 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4114 "set SELinux security context",
4116 This sets the SELinux security context of the daemon
4117 to the string C<context>.
4119 See the documentation about SELINUX in L<guestfs(3)>.");
4121 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4123 "get SELinux security context",
4125 This gets the SELinux security context of the daemon.
4127 See the documentation about SELINUX in L<guestfs(3)>,
4128 and C<guestfs_setcon>");
4130 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
4131 [InitEmpty, Always, TestOutput (
4132 [["part_disk"; "/dev/sda"; "mbr"];
4133 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4134 ["mount_options"; ""; "/dev/sda1"; "/"];
4135 ["write"; "/new"; "new file contents"];
4136 ["cat"; "/new"]], "new file contents");
4137 InitEmpty, Always, TestRun (
4138 [["part_disk"; "/dev/sda"; "mbr"];
4139 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4140 InitEmpty, Always, TestLastFail (
4141 [["part_disk"; "/dev/sda"; "mbr"];
4142 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4143 InitEmpty, Always, TestLastFail (
4144 [["part_disk"; "/dev/sda"; "mbr"];
4145 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4146 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4147 [["part_disk"; "/dev/sda"; "mbr"];
4148 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4149 "make a filesystem with block size",
4151 This call is similar to C<guestfs_mkfs>, but it allows you to
4152 control the block size of the resulting filesystem. Supported
4153 block sizes depend on the filesystem type, but typically they
4154 are C<1024>, C<2048> or C<4096> only.
4156 For VFAT and NTFS the C<blocksize> parameter is treated as
4157 the requested cluster size.");
4159 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4160 [InitEmpty, Always, TestOutput (
4161 [["part_init"; "/dev/sda"; "mbr"];
4162 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4163 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4164 ["mke2journal"; "4096"; "/dev/sda1"];
4165 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4166 ["mount_options"; ""; "/dev/sda2"; "/"];
4167 ["write"; "/new"; "new file contents"];
4168 ["cat"; "/new"]], "new file contents")],
4169 "make ext2/3/4 external journal",
4171 This creates an ext2 external journal on C<device>. It is equivalent
4174 mke2fs -O journal_dev -b blocksize device");
4176 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4177 [InitEmpty, Always, TestOutput (
4178 [["part_init"; "/dev/sda"; "mbr"];
4179 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4180 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4181 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4182 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4183 ["mount_options"; ""; "/dev/sda2"; "/"];
4184 ["write"; "/new"; "new file contents"];
4185 ["cat"; "/new"]], "new file contents")],
4186 "make ext2/3/4 external journal with label",
4188 This creates an ext2 external journal on C<device> with label C<label>.");
4190 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4191 (let uuid = uuidgen () in
4192 [InitEmpty, Always, TestOutput (
4193 [["part_init"; "/dev/sda"; "mbr"];
4194 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4195 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4196 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4197 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4198 ["mount_options"; ""; "/dev/sda2"; "/"];
4199 ["write"; "/new"; "new file contents"];
4200 ["cat"; "/new"]], "new file contents")]),
4201 "make ext2/3/4 external journal with UUID",
4203 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4205 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4207 "make ext2/3/4 filesystem with external journal",
4209 This creates an ext2/3/4 filesystem on C<device> with
4210 an external journal on C<journal>. It is equivalent
4213 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4215 See also C<guestfs_mke2journal>.");
4217 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4219 "make ext2/3/4 filesystem with external journal",
4221 This creates an ext2/3/4 filesystem on C<device> with
4222 an external journal on the journal labeled C<label>.
4224 See also C<guestfs_mke2journal_L>.");
4226 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4228 "make ext2/3/4 filesystem with external journal",
4230 This creates an ext2/3/4 filesystem on C<device> with
4231 an external journal on the journal with UUID C<uuid>.
4233 See also C<guestfs_mke2journal_U>.");
4235 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4236 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4237 "load a kernel module",
4239 This loads a kernel module in the appliance.
4241 The kernel module must have been whitelisted when libguestfs
4242 was built (see C<appliance/kmod.whitelist.in> in the source).");
4244 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4245 [InitNone, Always, TestOutput (
4246 [["echo_daemon"; "This is a test"]], "This is a test"
4248 "echo arguments back to the client",
4250 This command concatenates the list of C<words> passed with single spaces
4251 between them and returns the resulting string.
4253 You can use this command to test the connection through to the daemon.
4255 See also C<guestfs_ping_daemon>.");
4257 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4258 [], (* There is a regression test for this. *)
4259 "find all files and directories, returning NUL-separated list",
4261 This command lists out all files and directories, recursively,
4262 starting at C<directory>, placing the resulting list in the
4263 external file called C<files>.
4265 This command works the same way as C<guestfs_find> with the
4266 following exceptions:
4272 The resulting list is written to an external file.
4276 Items (filenames) in the result are separated
4277 by C<\\0> characters. See L<find(1)> option I<-print0>.
4281 This command is not limited in the number of names that it
4286 The result list is not sorted.
4290 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4291 [InitISOFS, Always, TestOutput (
4292 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4293 InitISOFS, Always, TestOutput (
4294 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4295 InitISOFS, Always, TestOutput (
4296 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4297 InitISOFS, Always, TestLastFail (
4298 [["case_sensitive_path"; "/Known-1/"]]);
4299 InitBasicFS, Always, TestOutput (
4301 ["mkdir"; "/a/bbb"];
4302 ["touch"; "/a/bbb/c"];
4303 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4304 InitBasicFS, Always, TestOutput (
4306 ["mkdir"; "/a/bbb"];
4307 ["touch"; "/a/bbb/c"];
4308 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4309 InitBasicFS, Always, TestLastFail (
4311 ["mkdir"; "/a/bbb"];
4312 ["touch"; "/a/bbb/c"];
4313 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4314 "return true path on case-insensitive filesystem",
4316 This can be used to resolve case insensitive paths on
4317 a filesystem which is case sensitive. The use case is
4318 to resolve paths which you have read from Windows configuration
4319 files or the Windows Registry, to the true path.
4321 The command handles a peculiarity of the Linux ntfs-3g
4322 filesystem driver (and probably others), which is that although
4323 the underlying filesystem is case-insensitive, the driver
4324 exports the filesystem to Linux as case-sensitive.
4326 One consequence of this is that special directories such
4327 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4328 (or other things) depending on the precise details of how
4329 they were created. In Windows itself this would not be
4332 Bug or feature? You decide:
4333 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4335 This function resolves the true case of each element in the
4336 path and returns the case-sensitive path.
4338 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4339 might return C<\"/WINDOWS/system32\"> (the exact return value
4340 would depend on details of how the directories were originally
4341 created under Windows).
4344 This function does not handle drive names, backslashes etc.
4346 See also C<guestfs_realpath>.");
4348 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4349 [InitBasicFS, Always, TestOutput (
4350 [["vfs_type"; "/dev/sda1"]], "ext2")],
4351 "get the Linux VFS type corresponding to a mounted device",
4353 This command gets the filesystem type corresponding to
4354 the filesystem on C<device>.
4356 For most filesystems, the result is the name of the Linux
4357 VFS module which would be used to mount this filesystem
4358 if you mounted it without specifying the filesystem type.
4359 For example a string such as C<ext3> or C<ntfs>.");
4361 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4362 [InitBasicFS, Always, TestOutputStruct (
4363 [["write"; "/test"; "some stuff so size is not zero"];
4364 ["truncate"; "/test"];
4365 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4366 "truncate a file to zero size",
4368 This command truncates C<path> to a zero-length file. The
4369 file must exist already.");
4371 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4372 [InitBasicFS, Always, TestOutputStruct (
4373 [["touch"; "/test"];
4374 ["truncate_size"; "/test"; "1000"];
4375 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4376 "truncate a file to a particular size",
4378 This command truncates C<path> to size C<size> bytes. The file
4381 If the current file size is less than C<size> then
4382 the file is extended to the required size with zero bytes.
4383 This creates a sparse file (ie. disk blocks are not allocated
4384 for the file until you write to it). To create a non-sparse
4385 file of zeroes, use C<guestfs_fallocate64> instead.");
4387 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4388 [InitBasicFS, Always, TestOutputStruct (
4389 [["touch"; "/test"];
4390 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4391 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4392 "set timestamp of a file with nanosecond precision",
4394 This command sets the timestamps of a file with nanosecond
4397 C<atsecs, atnsecs> are the last access time (atime) in secs and
4398 nanoseconds from the epoch.
4400 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4401 secs and nanoseconds from the epoch.
4403 If the C<*nsecs> field contains the special value C<-1> then
4404 the corresponding timestamp is set to the current time. (The
4405 C<*secs> field is ignored in this case).
4407 If the C<*nsecs> field contains the special value C<-2> then
4408 the corresponding timestamp is left unchanged. (The
4409 C<*secs> field is ignored in this case).");
4411 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4412 [InitBasicFS, Always, TestOutputStruct (
4413 [["mkdir_mode"; "/test"; "0o111"];
4414 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4415 "create a directory with a particular mode",
4417 This command creates a directory, setting the initial permissions
4418 of the directory to C<mode>.
4420 For common Linux filesystems, the actual mode which is set will
4421 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4422 interpret the mode in other ways.
4424 See also C<guestfs_mkdir>, C<guestfs_umask>");
4426 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4428 "change file owner and group",
4430 Change the file owner to C<owner> and group to C<group>.
4431 This is like C<guestfs_chown> but if C<path> is a symlink then
4432 the link itself is changed, not the target.
4434 Only numeric uid and gid are supported. If you want to use
4435 names, you will need to locate and parse the password file
4436 yourself (Augeas support makes this relatively easy).");
4438 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4440 "lstat on multiple files",
4442 This call allows you to perform the C<guestfs_lstat> operation
4443 on multiple files, where all files are in the directory C<path>.
4444 C<names> is the list of files from this directory.
4446 On return you get a list of stat structs, with a one-to-one
4447 correspondence to the C<names> list. If any name did not exist
4448 or could not be lstat'd, then the C<ino> field of that structure
4451 This call is intended for programs that want to efficiently
4452 list a directory contents without making many round-trips.
4453 See also C<guestfs_lxattrlist> for a similarly efficient call
4454 for getting extended attributes. Very long directory listings
4455 might cause the protocol message size to be exceeded, causing
4456 this call to fail. The caller must split up such requests
4457 into smaller groups of names.");
4459 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4461 "lgetxattr on multiple files",
4463 This call allows you to get the extended attributes
4464 of multiple files, where all files are in the directory C<path>.
4465 C<names> is the list of files from this directory.
4467 On return you get a flat list of xattr structs which must be
4468 interpreted sequentially. The first xattr struct always has a zero-length
4469 C<attrname>. C<attrval> in this struct is zero-length
4470 to indicate there was an error doing C<lgetxattr> for this
4471 file, I<or> is a C string which is a decimal number
4472 (the number of following attributes for this file, which could
4473 be C<\"0\">). Then after the first xattr struct are the
4474 zero or more attributes for the first named file.
4475 This repeats for the second and subsequent files.
4477 This call is intended for programs that want to efficiently
4478 list a directory contents without making many round-trips.
4479 See also C<guestfs_lstatlist> for a similarly efficient call
4480 for getting standard stats. Very long directory listings
4481 might cause the protocol message size to be exceeded, causing
4482 this call to fail. The caller must split up such requests
4483 into smaller groups of names.");
4485 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4487 "readlink on multiple files",
4489 This call allows you to do a C<readlink> operation
4490 on multiple files, where all files are in the directory C<path>.
4491 C<names> is the list of files from this directory.
4493 On return you get a list of strings, with a one-to-one
4494 correspondence to the C<names> list. Each string is the
4495 value of the symbolic link.
4497 If the C<readlink(2)> operation fails on any name, then
4498 the corresponding result string is the empty string C<\"\">.
4499 However the whole operation is completed even if there
4500 were C<readlink(2)> errors, and so you can call this
4501 function with names where you don't know if they are
4502 symbolic links already (albeit slightly less efficient).
4504 This call is intended for programs that want to efficiently
4505 list a directory contents without making many round-trips.
4506 Very long directory listings might cause the protocol
4507 message size to be exceeded, causing
4508 this call to fail. The caller must split up such requests
4509 into smaller groups of names.");
4511 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4512 [InitISOFS, Always, TestOutputBuffer (
4513 [["pread"; "/known-4"; "1"; "3"]], "\n");
4514 InitISOFS, Always, TestOutputBuffer (
4515 [["pread"; "/empty"; "0"; "100"]], "")],
4516 "read part of a file",
4518 This command lets you read part of a file. It reads C<count>
4519 bytes of the file, starting at C<offset>, from file C<path>.
4521 This may read fewer bytes than requested. For further details
4522 see the L<pread(2)> system call.
4524 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4526 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4527 [InitEmpty, Always, TestRun (
4528 [["part_init"; "/dev/sda"; "gpt"]])],
4529 "create an empty partition table",
4531 This creates an empty partition table on C<device> of one of the
4532 partition types listed below. Usually C<parttype> should be
4533 either C<msdos> or C<gpt> (for large disks).
4535 Initially there are no partitions. Following this, you should
4536 call C<guestfs_part_add> for each partition required.
4538 Possible values for C<parttype> are:
4542 =item B<efi> | B<gpt>
4544 Intel EFI / GPT partition table.
4546 This is recommended for >= 2 TB partitions that will be accessed
4547 from Linux and Intel-based Mac OS X. It also has limited backwards
4548 compatibility with the C<mbr> format.
4550 =item B<mbr> | B<msdos>
4552 The standard PC \"Master Boot Record\" (MBR) format used
4553 by MS-DOS and Windows. This partition type will B<only> work
4554 for device sizes up to 2 TB. For large disks we recommend
4559 Other partition table types that may work but are not
4568 =item B<amiga> | B<rdb>
4570 Amiga \"Rigid Disk Block\" format.
4578 DASD, used on IBM mainframes.
4586 Old Mac partition format. Modern Macs use C<gpt>.
4590 NEC PC-98 format, common in Japan apparently.
4598 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4599 [InitEmpty, Always, TestRun (
4600 [["part_init"; "/dev/sda"; "mbr"];
4601 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4602 InitEmpty, Always, TestRun (
4603 [["part_init"; "/dev/sda"; "gpt"];
4604 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4605 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4606 InitEmpty, Always, TestRun (
4607 [["part_init"; "/dev/sda"; "mbr"];
4608 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4609 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4610 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4611 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4612 "add a partition to the device",
4614 This command adds a partition to C<device>. If there is no partition
4615 table on the device, call C<guestfs_part_init> first.
4617 The C<prlogex> parameter is the type of partition. Normally you
4618 should pass C<p> or C<primary> here, but MBR partition tables also
4619 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4622 C<startsect> and C<endsect> are the start and end of the partition
4623 in I<sectors>. C<endsect> may be negative, which means it counts
4624 backwards from the end of the disk (C<-1> is the last sector).
4626 Creating a partition which covers the whole disk is not so easy.
4627 Use C<guestfs_part_disk> to do that.");
4629 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4630 [InitEmpty, Always, TestRun (
4631 [["part_disk"; "/dev/sda"; "mbr"]]);
4632 InitEmpty, Always, TestRun (
4633 [["part_disk"; "/dev/sda"; "gpt"]])],
4634 "partition whole disk with a single primary partition",
4636 This command is simply a combination of C<guestfs_part_init>
4637 followed by C<guestfs_part_add> to create a single primary partition
4638 covering the whole disk.
4640 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4641 but other possible values are described in C<guestfs_part_init>.");
4643 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4644 [InitEmpty, Always, TestRun (
4645 [["part_disk"; "/dev/sda"; "mbr"];
4646 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4647 "make a partition bootable",
4649 This sets the bootable flag on partition numbered C<partnum> on
4650 device C<device>. Note that partitions are numbered from 1.
4652 The bootable flag is used by some operating systems (notably
4653 Windows) to determine which partition to boot from. It is by
4654 no means universally recognized.");
4656 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4657 [InitEmpty, Always, TestRun (
4658 [["part_disk"; "/dev/sda"; "gpt"];
4659 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4660 "set partition name",
4662 This sets the partition name on partition numbered C<partnum> on
4663 device C<device>. Note that partitions are numbered from 1.
4665 The partition name can only be set on certain types of partition
4666 table. This works on C<gpt> but not on C<mbr> partitions.");
4668 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4669 [], (* XXX Add a regression test for this. *)
4670 "list partitions on a device",
4672 This command parses the partition table on C<device> and
4673 returns the list of partitions found.
4675 The fields in the returned structure are:
4681 Partition number, counting from 1.
4685 Start of the partition I<in bytes>. To get sectors you have to
4686 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4690 End of the partition in bytes.
4694 Size of the partition in bytes.
4698 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4699 [InitEmpty, Always, TestOutput (
4700 [["part_disk"; "/dev/sda"; "gpt"];
4701 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4702 "get the partition table type",
4704 This command examines the partition table on C<device> and
4705 returns the partition table type (format) being used.
4707 Common return values include: C<msdos> (a DOS/Windows style MBR
4708 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4709 values are possible, although unusual. See C<guestfs_part_init>
4712 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4713 [InitBasicFS, Always, TestOutputBuffer (
4714 [["fill"; "0x63"; "10"; "/test"];
4715 ["read_file"; "/test"]], "cccccccccc")],
4716 "fill a file with octets",
4718 This command creates a new file called C<path>. The initial
4719 content of the file is C<len> octets of C<c>, where C<c>
4720 must be a number in the range C<[0..255]>.
4722 To fill a file with zero bytes (sparsely), it is
4723 much more efficient to use C<guestfs_truncate_size>.
4724 To create a file with a pattern of repeating bytes
4725 use C<guestfs_fill_pattern>.");
4727 ("available", (RErr, [StringList "groups"], []), 216, [],
4728 [InitNone, Always, TestRun [["available"; ""]]],
4729 "test availability of some parts of the API",
4731 This command is used to check the availability of some
4732 groups of functionality in the appliance, which not all builds of
4733 the libguestfs appliance will be able to provide.
4735 The libguestfs groups, and the functions that those
4736 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4737 You can also fetch this list at runtime by calling
4738 C<guestfs_available_all_groups>.
4740 The argument C<groups> is a list of group names, eg:
4741 C<[\"inotify\", \"augeas\"]> would check for the availability of
4742 the Linux inotify functions and Augeas (configuration file
4745 The command returns no error if I<all> requested groups are available.
4747 It fails with an error if one or more of the requested
4748 groups is unavailable in the appliance.
4750 If an unknown group name is included in the
4751 list of groups then an error is always returned.
4759 You must call C<guestfs_launch> before calling this function.
4761 The reason is because we don't know what groups are
4762 supported by the appliance/daemon until it is running and can
4767 If a group of functions is available, this does not necessarily
4768 mean that they will work. You still have to check for errors
4769 when calling individual API functions even if they are
4774 It is usually the job of distro packagers to build
4775 complete functionality into the libguestfs appliance.
4776 Upstream libguestfs, if built from source with all
4777 requirements satisfied, will support everything.
4781 This call was added in version C<1.0.80>. In previous
4782 versions of libguestfs all you could do would be to speculatively
4783 execute a command to find out if the daemon implemented it.
4784 See also C<guestfs_version>.
4788 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4789 [InitBasicFS, Always, TestOutputBuffer (
4790 [["write"; "/src"; "hello, world"];
4791 ["dd"; "/src"; "/dest"];
4792 ["read_file"; "/dest"]], "hello, world")],
4793 "copy from source to destination using dd",
4795 This command copies from one source device or file C<src>
4796 to another destination device or file C<dest>. Normally you
4797 would use this to copy to or from a device or partition, for
4798 example to duplicate a filesystem.
4800 If the destination is a device, it must be as large or larger
4801 than the source file or device, otherwise the copy will fail.
4802 This command cannot do partial copies (see C<guestfs_copy_size>).");
4804 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4805 [InitBasicFS, Always, TestOutputInt (
4806 [["write"; "/file"; "hello, world"];
4807 ["filesize"; "/file"]], 12)],
4808 "return the size of the file in bytes",
4810 This command returns the size of C<file> in bytes.
4812 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4813 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4814 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4816 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4817 [InitBasicFSonLVM, Always, TestOutputList (
4818 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4819 ["lvs"]], ["/dev/VG/LV2"])],
4820 "rename an LVM logical volume",
4822 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4824 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4825 [InitBasicFSonLVM, Always, TestOutputList (
4827 ["vg_activate"; "false"; "VG"];
4828 ["vgrename"; "VG"; "VG2"];
4829 ["vg_activate"; "true"; "VG2"];
4830 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4831 ["vgs"]], ["VG2"])],
4832 "rename an LVM volume group",
4834 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4836 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4837 [InitISOFS, Always, TestOutputBuffer (
4838 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4839 "list the contents of a single file in an initrd",
4841 This command unpacks the file C<filename> from the initrd file
4842 called C<initrdpath>. The filename must be given I<without> the
4843 initial C</> character.
4845 For example, in guestfish you could use the following command
4846 to examine the boot script (usually called C</init>)
4847 contained in a Linux initrd or initramfs image:
4849 initrd-cat /boot/initrd-<version>.img init
4851 See also C<guestfs_initrd_list>.");
4853 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4855 "get the UUID of a physical volume",
4857 This command returns the UUID of the LVM PV C<device>.");
4859 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4861 "get the UUID of a volume group",
4863 This command returns the UUID of the LVM VG named C<vgname>.");
4865 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4867 "get the UUID of a logical volume",
4869 This command returns the UUID of the LVM LV C<device>.");
4871 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4873 "get the PV UUIDs containing the volume group",
4875 Given a VG called C<vgname>, this returns the UUIDs of all
4876 the physical volumes that this volume group resides on.
4878 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4879 calls to associate physical volumes and volume groups.
4881 See also C<guestfs_vglvuuids>.");
4883 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4885 "get the LV UUIDs of all LVs in the volume group",
4887 Given a VG called C<vgname>, this returns the UUIDs of all
4888 the logical volumes created in this volume group.
4890 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4891 calls to associate logical volumes and volume groups.
4893 See also C<guestfs_vgpvuuids>.");
4895 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4896 [InitBasicFS, Always, TestOutputBuffer (
4897 [["write"; "/src"; "hello, world"];
4898 ["copy_size"; "/src"; "/dest"; "5"];
4899 ["read_file"; "/dest"]], "hello")],
4900 "copy size bytes from source to destination using dd",
4902 This command copies exactly C<size> bytes from one source device
4903 or file C<src> to another destination device or file C<dest>.
4905 Note this will fail if the source is too short or if the destination
4906 is not large enough.");
4908 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4909 [InitBasicFSonLVM, Always, TestRun (
4910 [["zero_device"; "/dev/VG/LV"]])],
4911 "write zeroes to an entire device",
4913 This command writes zeroes over the entire C<device>. Compare
4914 with C<guestfs_zero> which just zeroes the first few blocks of
4917 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4918 [InitBasicFS, Always, TestOutput (
4919 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4920 ["cat"; "/hello"]], "hello\n")],
4921 "unpack compressed tarball to directory",
4923 This command uploads and unpacks local file C<tarball> (an
4924 I<xz compressed> tar file) into C<directory>.");
4926 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4928 "pack directory into compressed tarball",
4930 This command packs the contents of C<directory> and downloads
4931 it to local file C<tarball> (as an xz compressed tar archive).");
4933 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4935 "resize an NTFS filesystem",
4937 This command resizes an NTFS filesystem, expanding or
4938 shrinking it to the size of the underlying device.
4939 See also L<ntfsresize(8)>.");
4941 ("vgscan", (RErr, [], []), 232, [],
4942 [InitEmpty, Always, TestRun (
4944 "rescan for LVM physical volumes, volume groups and logical volumes",
4946 This rescans all block devices and rebuilds the list of LVM
4947 physical volumes, volume groups and logical volumes.");
4949 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
4950 [InitEmpty, Always, TestRun (
4951 [["part_init"; "/dev/sda"; "mbr"];
4952 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4953 ["part_del"; "/dev/sda"; "1"]])],
4954 "delete a partition",
4956 This command deletes the partition numbered C<partnum> on C<device>.
4958 Note that in the case of MBR partitioning, deleting an
4959 extended partition also deletes any logical partitions
4962 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
4963 [InitEmpty, Always, TestOutputTrue (
4964 [["part_init"; "/dev/sda"; "mbr"];
4965 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4966 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4967 ["part_get_bootable"; "/dev/sda"; "1"]])],
4968 "return true if a partition is bootable",
4970 This command returns true if the partition C<partnum> on
4971 C<device> has the bootable flag set.
4973 See also C<guestfs_part_set_bootable>.");
4975 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
4976 [InitEmpty, Always, TestOutputInt (
4977 [["part_init"; "/dev/sda"; "mbr"];
4978 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4979 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4980 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4981 "get the MBR type byte (ID byte) from a partition",
4983 Returns the MBR type byte (also known as the ID byte) from
4984 the numbered partition C<partnum>.
4986 Note that only MBR (old DOS-style) partitions have type bytes.
4987 You will get undefined results for other partition table
4988 types (see C<guestfs_part_get_parttype>).");
4990 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
4991 [], (* tested by part_get_mbr_id *)
4992 "set the MBR type byte (ID byte) of a partition",
4994 Sets the MBR type byte (also known as the ID byte) of
4995 the numbered partition C<partnum> to C<idbyte>. Note
4996 that the type bytes quoted in most documentation are
4997 in fact hexadecimal numbers, but usually documented
4998 without any leading \"0x\" which might be confusing.
5000 Note that only MBR (old DOS-style) partitions have type bytes.
5001 You will get undefined results for other partition table
5002 types (see C<guestfs_part_get_parttype>).");
5004 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5005 [InitISOFS, Always, TestOutputFileMD5 (
5006 [["checksum_device"; "md5"; "/dev/sdd"]],
5007 "../images/test.iso")],
5008 "compute MD5, SHAx or CRC checksum of the contents of a device",
5010 This call computes the MD5, SHAx or CRC checksum of the
5011 contents of the device named C<device>. For the types of
5012 checksums supported see the C<guestfs_checksum> command.");
5014 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5015 [InitNone, Always, TestRun (
5016 [["part_disk"; "/dev/sda"; "mbr"];
5017 ["pvcreate"; "/dev/sda1"];
5018 ["vgcreate"; "VG"; "/dev/sda1"];
5019 ["lvcreate"; "LV"; "VG"; "10"];
5020 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5021 "expand an LV to fill free space",
5023 This expands an existing logical volume C<lv> so that it fills
5024 C<pc>% of the remaining free space in the volume group. Commonly
5025 you would call this with pc = 100 which expands the logical volume
5026 as much as possible, using all remaining free space in the volume
5029 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5030 [], (* XXX Augeas code needs tests. *)
5031 "clear Augeas path",
5033 Set the value associated with C<path> to C<NULL>. This
5034 is the same as the L<augtool(1)> C<clear> command.");
5036 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5037 [InitEmpty, Always, TestOutputInt (
5038 [["get_umask"]], 0o22)],
5039 "get the current umask",
5041 Return the current umask. By default the umask is C<022>
5042 unless it has been set by calling C<guestfs_umask>.");
5044 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5046 "upload a file to the appliance (internal use only)",
5048 The C<guestfs_debug_upload> command uploads a file to
5049 the libguestfs appliance.
5051 There is no comprehensive help for this command. You have
5052 to look at the file C<daemon/debug.c> in the libguestfs source
5053 to find out what it is for.");
5055 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5056 [InitBasicFS, Always, TestOutput (
5057 [["base64_in"; "../images/hello.b64"; "/hello"];
5058 ["cat"; "/hello"]], "hello\n")],
5059 "upload base64-encoded data to file",
5061 This command uploads base64-encoded data from C<base64file>
5064 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5066 "download file and encode as base64",
5068 This command downloads the contents of C<filename>, writing
5069 it out to local file C<base64file> encoded as base64.");
5071 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5073 "compute MD5, SHAx or CRC checksum of files in a directory",
5075 This command computes the checksums of all regular files in
5076 C<directory> and then emits a list of those checksums to
5077 the local output file C<sumsfile>.
5079 This can be used for verifying the integrity of a virtual
5080 machine. However to be properly secure you should pay
5081 attention to the output of the checksum command (it uses
5082 the ones from GNU coreutils). In particular when the
5083 filename is not printable, coreutils uses a special
5084 backslash syntax. For more information, see the GNU
5085 coreutils info file.");
5087 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5088 [InitBasicFS, Always, TestOutputBuffer (
5089 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
5090 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
5091 "fill a file with a repeating pattern of bytes",
5093 This function is like C<guestfs_fill> except that it creates
5094 a new file of length C<len> containing the repeating pattern
5095 of bytes in C<pattern>. The pattern is truncated if necessary
5096 to ensure the length of the file is exactly C<len> bytes.");
5098 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5099 [InitBasicFS, Always, TestOutput (
5100 [["write"; "/new"; "new file contents"];
5101 ["cat"; "/new"]], "new file contents");
5102 InitBasicFS, Always, TestOutput (
5103 [["write"; "/new"; "\nnew file contents\n"];
5104 ["cat"; "/new"]], "\nnew file contents\n");
5105 InitBasicFS, Always, TestOutput (
5106 [["write"; "/new"; "\n\n"];
5107 ["cat"; "/new"]], "\n\n");
5108 InitBasicFS, Always, TestOutput (
5109 [["write"; "/new"; ""];
5110 ["cat"; "/new"]], "");
5111 InitBasicFS, Always, TestOutput (
5112 [["write"; "/new"; "\n\n\n"];
5113 ["cat"; "/new"]], "\n\n\n");
5114 InitBasicFS, Always, TestOutput (
5115 [["write"; "/new"; "\n"];
5116 ["cat"; "/new"]], "\n")],
5117 "create a new file",
5119 This call creates a file called C<path>. The content of the
5120 file is the string C<content> (which can contain any 8 bit data).");
5122 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5123 [InitBasicFS, Always, TestOutput (
5124 [["write"; "/new"; "new file contents"];
5125 ["pwrite"; "/new"; "data"; "4"];
5126 ["cat"; "/new"]], "new data contents");
5127 InitBasicFS, Always, TestOutput (
5128 [["write"; "/new"; "new file contents"];
5129 ["pwrite"; "/new"; "is extended"; "9"];
5130 ["cat"; "/new"]], "new file is extended");
5131 InitBasicFS, Always, TestOutput (
5132 [["write"; "/new"; "new file contents"];
5133 ["pwrite"; "/new"; ""; "4"];
5134 ["cat"; "/new"]], "new file contents")],
5135 "write to part of a file",
5137 This command writes to part of a file. It writes the data
5138 buffer C<content> to the file C<path> starting at offset C<offset>.
5140 This command implements the L<pwrite(2)> system call, and like
5141 that system call it may not write the full data requested. The
5142 return value is the number of bytes that were actually written
5143 to the file. This could even be 0, although short writes are
5144 unlikely for regular files in ordinary circumstances.
5146 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5148 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5150 "resize an ext2, ext3 or ext4 filesystem (with size)",
5152 This command is the same as C<guestfs_resize2fs> except that it
5153 allows you to specify the new size (in bytes) explicitly.");
5155 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5157 "resize an LVM physical volume (with size)",
5159 This command is the same as C<guestfs_pvresize> except that it
5160 allows you to specify the new size (in bytes) explicitly.");
5162 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5164 "resize an NTFS filesystem (with size)",
5166 This command is the same as C<guestfs_ntfsresize> except that it
5167 allows you to specify the new size (in bytes) explicitly.");
5169 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5170 [InitNone, Always, TestRun [["available_all_groups"]]],
5171 "return a list of all optional groups",
5173 This command returns a list of all optional groups that this
5174 daemon knows about. Note this returns both supported and unsupported
5175 groups. To find out which ones the daemon can actually support
5176 you have to call C<guestfs_available> on each member of the
5179 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5181 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5182 [InitBasicFS, Always, TestOutputStruct (
5183 [["fallocate64"; "/a"; "1000000"];
5184 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
5185 "preallocate a file in the guest filesystem",
5187 This command preallocates a file (containing zero bytes) named
5188 C<path> of size C<len> bytes. If the file exists already, it
5191 Note that this call allocates disk blocks for the file.
5192 To create a sparse file use C<guestfs_truncate_size> instead.
5194 The deprecated call C<guestfs_fallocate> does the same,
5195 but owing to an oversight it only allowed 30 bit lengths
5196 to be specified, effectively limiting the maximum size
5197 of files created through that call to 1GB.
5199 Do not confuse this with the guestfish-specific
5200 C<alloc> and C<sparse> commands which create
5201 a file in the host and attach it as a device.");
5203 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5204 [InitBasicFS, Always, TestOutput (
5205 [["set_e2label"; "/dev/sda1"; "LTEST"];
5206 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5207 "get the filesystem label",
5209 This returns the filesystem label of the filesystem on
5212 If the filesystem is unlabeled, this returns the empty string.
5214 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5216 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5217 (let uuid = uuidgen () in
5218 [InitBasicFS, Always, TestOutput (
5219 [["set_e2uuid"; "/dev/sda1"; uuid];
5220 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5221 "get the filesystem UUID",
5223 This returns the filesystem UUID of the filesystem on
5226 If the filesystem does not have a UUID, this returns the empty string.
5228 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5230 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5231 (* Can't be tested with the current framework because
5232 * the VG is being used by the mounted filesystem, so
5233 * the vgchange -an command we do first will fail.
5236 "set LVM device filter",
5238 This sets the LVM device filter so that LVM will only be
5239 able to \"see\" the block devices in the list C<devices>,
5240 and will ignore all other attached block devices.
5242 Where disk image(s) contain duplicate PVs or VGs, this
5243 command is useful to get LVM to ignore the duplicates, otherwise
5244 LVM can get confused. Note also there are two types
5245 of duplication possible: either cloned PVs/VGs which have
5246 identical UUIDs; or VGs that are not cloned but just happen
5247 to have the same name. In normal operation you cannot
5248 create this situation, but you can do it outside LVM, eg.
5249 by cloning disk images or by bit twiddling inside the LVM
5252 This command also clears the LVM cache and performs a volume
5255 You can filter whole block devices or individual partitions.
5257 You cannot use this if any VG is currently in use (eg.
5258 contains a mounted filesystem), even if you are not
5259 filtering out that VG.");
5261 ("lvm_clear_filter", (RErr, [], []), 256, [],
5262 [], (* see note on lvm_set_filter *)
5263 "clear LVM device filter",
5265 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5266 will be able to see every block device.
5268 This command also clears the LVM cache and performs a volume
5271 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5273 "open a LUKS-encrypted block device",
5275 This command opens a block device which has been encrypted
5276 according to the Linux Unified Key Setup (LUKS) standard.
5278 C<device> is the encrypted block device or partition.
5280 The caller must supply one of the keys associated with the
5281 LUKS block device, in the C<key> parameter.
5283 This creates a new block device called C</dev/mapper/mapname>.
5284 Reads and writes to this block device are decrypted from and
5285 encrypted to the underlying C<device> respectively.
5287 If this block device contains LVM volume groups, then
5288 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5289 will make them visible.");
5291 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5293 "open a LUKS-encrypted block device read-only",
5295 This is the same as C<guestfs_luks_open> except that a read-only
5296 mapping is created.");
5298 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5300 "close a LUKS device",
5302 This closes a LUKS device that was created earlier by
5303 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5304 C<device> parameter must be the name of the LUKS mapping
5305 device (ie. C</dev/mapper/mapname>) and I<not> the name
5306 of the underlying block device.");
5308 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5310 "format a block device as a LUKS encrypted device",
5312 This command erases existing data on C<device> and formats
5313 the device as a LUKS encrypted device. C<key> is the
5314 initial key, which is added to key slot C<slot>. (LUKS
5315 supports 8 key slots, numbered 0-7).");
5317 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5319 "format a block device as a LUKS encrypted device",
5321 This command is the same as C<guestfs_luks_format> but
5322 it also allows you to set the C<cipher> used.");
5324 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5326 "add a key on a LUKS encrypted device",
5328 This command adds a new key on LUKS device C<device>.
5329 C<key> is any existing key, and is used to access the device.
5330 C<newkey> is the new key to add. C<keyslot> is the key slot
5331 that will be replaced.
5333 Note that if C<keyslot> already contains a key, then this
5334 command will fail. You have to use C<guestfs_luks_kill_slot>
5335 first to remove that key.");
5337 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5339 "remove a key from a LUKS encrypted device",
5341 This command deletes the key in key slot C<keyslot> from the
5342 encrypted LUKS device C<device>. C<key> must be one of the
5345 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5346 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5347 [["is_lv"; "/dev/VG/LV"]]);
5348 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5349 [["is_lv"; "/dev/sda1"]])],
5350 "test if device is a logical volume",
5352 This command tests whether C<device> is a logical volume, and
5353 returns true iff this is the case.");
5355 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5357 "find a filesystem by UUID",
5359 This command searches the filesystems and returns the one
5360 which has the given UUID. An error is returned if no such
5361 filesystem can be found.
5363 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5365 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5367 "find a filesystem by label",
5369 This command searches the filesystems and returns the one
5370 which has the given label. An error is returned if no such
5371 filesystem can be found.
5373 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5375 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5376 [InitISOFS, Always, TestOutputFalse (
5377 [["is_chardev"; "/directory"]]);
5378 InitBasicFS, Always, TestOutputTrue (
5379 [["mknod_c"; "0o777"; "99"; "66"; "/test"];
5380 ["is_chardev"; "/test"]])],
5381 "test if character device",
5383 This returns C<true> if and only if there is a character device
5384 with the given C<path> name.
5386 See also C<guestfs_stat>.");
5388 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5389 [InitISOFS, Always, TestOutputFalse (
5390 [["is_blockdev"; "/directory"]]);
5391 InitBasicFS, Always, TestOutputTrue (
5392 [["mknod_b"; "0o777"; "99"; "66"; "/test"];
5393 ["is_blockdev"; "/test"]])],
5394 "test if block device",
5396 This returns C<true> if and only if there is a block device
5397 with the given C<path> name.
5399 See also C<guestfs_stat>.");
5401 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5402 [InitISOFS, Always, TestOutputFalse (
5403 [["is_fifo"; "/directory"]]);
5404 InitBasicFS, Always, TestOutputTrue (
5405 [["mkfifo"; "0o777"; "/test"];
5406 ["is_fifo"; "/test"]])],
5407 "test if FIFO (named pipe)",
5409 This returns C<true> if and only if there is a FIFO (named pipe)
5410 with the given C<path> name.
5412 See also C<guestfs_stat>.");
5414 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5415 [InitISOFS, Always, TestOutputFalse (
5416 [["is_symlink"; "/directory"]]);
5417 InitISOFS, Always, TestOutputTrue (
5418 [["is_symlink"; "/abssymlink"]])],
5419 "test if symbolic link",
5421 This returns C<true> if and only if there is a symbolic link
5422 with the given C<path> name.
5424 See also C<guestfs_stat>.");
5426 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5427 (* XXX Need a positive test for sockets. *)
5428 [InitISOFS, Always, TestOutputFalse (
5429 [["is_socket"; "/directory"]])],
5432 This returns C<true> if and only if there is a Unix domain socket
5433 with the given C<path> name.
5435 See also C<guestfs_stat>.");
5437 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5438 [InitPartition, Always, TestOutputDevice (
5439 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5440 InitEmpty, Always, TestLastFail (
5441 [["part_to_dev"; "/dev/sda"]])],
5442 "convert partition name to device name",
5444 This function takes a partition name (eg. \"/dev/sdb1\") and
5445 removes the partition number, returning the device name
5448 The named partition must exist, for example as a string returned
5449 from C<guestfs_list_partitions>.");
5451 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [],
5452 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5453 [InitBasicFS, Always, TestOutput (
5454 [["upload_offset"; "../COPYING.LIB"; "/COPYING.LIB"; "0"];
5455 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5456 "upload a file from the local machine with offset",
5458 Upload local file C<filename> to C<remotefilename> on the
5461 C<remotefilename> is overwritten starting at the byte C<offset>
5462 specified. The intention is to overwrite parts of existing
5463 files or devices, although if a non-existant file is specified
5464 then it is created with a \"hole\" before C<offset>. The
5465 size of the data written is implicit in the size of the
5468 Note that there is no limit on the amount of data that
5469 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5470 and this call always writes the full amount unless an
5473 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5475 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5476 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5477 let offset = string_of_int 100 in
5478 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5479 [InitBasicFS, Always, TestOutput (
5480 (* Pick a file from cwd which isn't likely to change. *)
5481 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
5482 ["download_offset"; "/COPYING.LIB"; "testdownload.tmp"; offset; size];
5483 ["upload_offset"; "testdownload.tmp"; "/COPYING.LIB"; offset];
5484 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5485 "download a file to the local machine with offset and size",
5487 Download file C<remotefilename> and save it as C<filename>
5488 on the local machine.
5490 C<remotefilename> is read for C<size> bytes starting at C<offset>
5491 (this region must be within the file or device).
5493 Note that there is no limit on the amount of data that
5494 can be downloaded with this call, unlike with C<guestfs_pread>,
5495 and this call always reads the full amount unless an
5498 See also C<guestfs_download>, C<guestfs_pread>.");
5500 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5501 [InitPartition, Always, TestOutputList (
5502 [["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"];
5503 ["blockdev_rereadpt"; "/dev/sda"];
5504 ["list_partitions"]], [])],
5505 "write to part of a device",
5507 This command writes to part of a device. It writes the data
5508 buffer C<content> to C<device> starting at offset C<offset>.
5510 This command implements the L<pwrite(2)> system call, and like
5511 that system call it may not write the full data requested
5512 (although short writes to disk devices and partitions are
5513 probably impossible with standard Linux kernels).
5515 See also C<guestfs_pwrite>.");
5517 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5518 [InitEmpty, Always, TestOutputBuffer (
5519 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5520 "read part of a device",
5522 This command lets you read part of a file. It reads C<count>
5523 bytes of C<device>, starting at C<offset>.
5525 This may read fewer bytes than requested. For further details
5526 see the L<pread(2)> system call.
5528 See also C<guestfs_pread>.");
5530 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5531 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5532 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5533 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5534 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5535 "get canonical name of an LV",
5537 This converts alternative naming schemes for LVs that you
5538 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5539 is converted to C</dev/VG/LV>.
5541 This command returns an error if the C<lvname> parameter does
5542 not refer to a logical volume.
5544 See also C<guestfs_is_lv>.");
5548 let all_functions = non_daemon_functions @ daemon_functions
5550 (* In some places we want the functions to be displayed sorted
5551 * alphabetically, so this is useful:
5553 let all_functions_sorted = List.sort action_compare all_functions
5555 (* This is used to generate the src/MAX_PROC_NR file which
5556 * contains the maximum procedure number, a surrogate for the
5557 * ABI version number. See src/Makefile.am for the details.
5560 let proc_nrs = List.map (
5561 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5562 ) daemon_functions in
5563 List.fold_left max 0 proc_nrs
5565 (* Non-API meta-commands available only in guestfish.
5567 * Note (1): style, proc_nr and tests fields are all meaningless.
5568 * The only fields which are actually used are the shortname,
5569 * FishAlias flags, shortdesc and longdesc.
5571 * Note (2): to refer to other commands, use L</shortname>.
5573 * Note (3): keep this list sorted by shortname.
5575 let fish_commands = [
5576 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5577 "allocate and add a disk file",
5578 " alloc filename size
5580 This creates an empty (zeroed) file of the given size, and then adds
5581 so it can be further examined.
5583 For more advanced image creation, see L<qemu-img(1)> utility.
5585 Size can be specified using standard suffixes, eg. C<1M>.
5587 To create a sparse file, use L</sparse> instead. To create a
5588 prepared disk image, see L</PREPARED DISK IMAGES>.");
5590 ("copy_in", (RErr,[], []), -1, [], [],
5591 "copy local files or directories into an image",
5592 " copy-in local [local ...] /remotedir
5594 C<copy-in> copies local files or directories recursively into the disk
5595 image, placing them in the directory called C</remotedir> (which must
5596 exist). This guestfish meta-command turns into a sequence of
5597 L</tar-in> and other commands as necessary.
5599 Multiple local files and directories can be specified, but the last
5600 parameter must always be a remote directory. Wildcards cannot be
5603 ("copy_out", (RErr,[], []), -1, [], [],
5604 "copy remote files or directories out of an image",
5605 " copy-out remote [remote ...] localdir
5607 C<copy-out> copies remote files or directories recursively out of the
5608 disk image, placing them on the host disk in a local directory called
5609 C<localdir> (which must exist). This guestfish meta-command turns
5610 into a sequence of L</download>, L</tar-out> and other commands as
5613 Multiple remote files and directories can be specified, but the last
5614 parameter must always be a local directory. To download to the
5615 current directory, use C<.> as in:
5619 Wildcards cannot be used in the ordinary command, but you can use
5620 them with the help of L</glob> like this:
5622 glob copy-out /home/* .");
5624 ("echo", (RErr,[], []), -1, [], [],
5625 "display a line of text",
5628 This echos the parameters to the terminal.");
5630 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5634 This is used to edit a file. It downloads the file, edits it
5635 locally using your editor, then uploads the result.
5637 The editor is C<$EDITOR>. However if you use the alternate
5638 commands C<vi> or C<emacs> you will get those corresponding
5641 ("glob", (RErr,[], []), -1, [], [],
5642 "expand wildcards in command",
5643 " glob command args...
5645 Expand wildcards in any paths in the args list, and run C<command>
5646 repeatedly on each matching path.
5648 See L</WILDCARDS AND GLOBBING>.");
5650 ("hexedit", (RErr,[], []), -1, [], [],
5651 "edit with a hex editor",
5652 " hexedit <filename|device>
5653 hexedit <filename|device> <max>
5654 hexedit <filename|device> <start> <max>
5656 Use hexedit (a hex editor) to edit all or part of a binary file
5659 This command works by downloading potentially the whole file or
5660 device, editing it locally, then uploading it. If the file or
5661 device is large, you have to specify which part you wish to edit
5662 by using C<max> and/or C<start> C<max> parameters.
5663 C<start> and C<max> are specified in bytes, with the usual
5664 modifiers allowed such as C<1M> (1 megabyte).
5666 For example to edit the first few sectors of a disk you
5671 which would allow you to edit anywhere within the first megabyte
5674 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5676 hexedit /dev/sda1 0x400 0x400
5678 (assuming the superblock is in the standard location).
5680 This command requires the external L<hexedit(1)> program. You
5681 can specify another program to use by setting the C<HEXEDITOR>
5682 environment variable.
5684 See also L</hexdump>.");
5686 ("lcd", (RErr,[], []), -1, [], [],
5687 "change working directory",
5690 Change the local directory, ie. the current directory of guestfish
5693 Note that C<!cd> won't do what you might expect.");
5695 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5699 Opens the manual page for guestfish.");
5701 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5707 This is used to view a file.
5709 The default viewer is C<$PAGER>. However if you use the alternate
5710 command C<less> you will get the C<less> command specifically.");
5712 ("reopen", (RErr,[], []), -1, [], [],
5713 "close and reopen libguestfs handle",
5716 Close and reopen the libguestfs handle. It is not necessary to use
5717 this normally, because the handle is closed properly when guestfish
5718 exits. However this is occasionally useful for testing.");
5720 ("sparse", (RErr,[], []), -1, [], [],
5721 "create a sparse disk image and add",
5722 " sparse filename size
5724 This creates an empty sparse file of the given size, and then adds
5725 so it can be further examined.
5727 In all respects it works the same as the L</alloc> command, except that
5728 the image file is allocated sparsely, which means that disk blocks are
5729 not assigned to the file until they are needed. Sparse disk files
5730 only use space when written to, but they are slower and there is a
5731 danger you could run out of real disk space during a write operation.
5733 For more advanced image creation, see L<qemu-img(1)> utility.
5735 Size can be specified using standard suffixes, eg. C<1M>.");
5737 ("supported", (RErr,[], []), -1, [], [],
5738 "list supported groups of commands",
5741 This command returns a list of the optional groups
5742 known to the daemon, and indicates which ones are
5743 supported by this build of the libguestfs appliance.
5745 See also L<guestfs(3)/AVAILABILITY>.");
5747 ("time", (RErr,[], []), -1, [], [],
5748 "print elapsed time taken to run a command",
5749 " time command args...
5751 Run the command as usual, but print the elapsed time afterwards. This
5752 can be useful for benchmarking operations.");