2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter C<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form C<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to run C<guestfs_umount_all> followed by
286 C<guestfs_sync> when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
308 ("get_verbose", (RBool "verbose", [], []), -1, [],
312 This returns the verbose messages flag.");
314 ("is_ready", (RBool "ready", [], []), -1, [],
315 [InitNone, Always, TestOutputTrue (
317 "is ready to accept commands",
319 This returns true iff this handle is ready to accept commands
320 (in the C<READY> state).
322 For more information on states, see L<guestfs(3)>.");
324 ("is_config", (RBool "config", [], []), -1, [],
325 [InitNone, Always, TestOutputFalse (
327 "is in configuration state",
329 This returns true iff this handle is being configured
330 (in the C<CONFIG> state).
332 For more information on states, see L<guestfs(3)>.");
334 ("is_launching", (RBool "launching", [], []), -1, [],
335 [InitNone, Always, TestOutputFalse (
336 [["is_launching"]])],
337 "is launching subprocess",
339 This returns true iff this handle is launching the subprocess
340 (in the C<LAUNCHING> state).
342 For more information on states, see L<guestfs(3)>.");
344 ("is_busy", (RBool "busy", [], []), -1, [],
345 [InitNone, Always, TestOutputFalse (
347 "is busy processing a command",
349 This returns true iff this handle is busy processing a command
350 (in the C<BUSY> state).
352 For more information on states, see L<guestfs(3)>.");
354 ("get_state", (RInt "state", [], []), -1, [],
356 "get the current state",
358 This returns the current state as an opaque integer. This is
359 only useful for printing debug and internal error messages.
361 For more information on states, see L<guestfs(3)>.");
363 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
364 [InitNone, Always, TestOutputInt (
365 [["set_memsize"; "500"];
366 ["get_memsize"]], 500)],
367 "set memory allocated to the qemu subprocess",
369 This sets the memory size in megabytes allocated to the
370 qemu subprocess. This only has any effect if called before
373 You can also change this by setting the environment
374 variable C<LIBGUESTFS_MEMSIZE> before the handle is
377 For more information on the architecture of libguestfs,
378 see L<guestfs(3)>.");
380 ("get_memsize", (RInt "memsize", [], []), -1, [],
381 [InitNone, Always, TestOutputIntOp (
382 [["get_memsize"]], ">=", 256)],
383 "get memory allocated to the qemu subprocess",
385 This gets the memory size in megabytes allocated to the
388 If C<guestfs_set_memsize> was not called
389 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
390 then this returns the compiled-in default value for memsize.
392 For more information on the architecture of libguestfs,
393 see L<guestfs(3)>.");
395 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
396 [InitNone, Always, TestOutputIntOp (
397 [["get_pid"]], ">=", 1)],
398 "get PID of qemu subprocess",
400 Return the process ID of the qemu subprocess. If there is no
401 qemu subprocess, then this will return an error.
403 This is an internal call used for debugging and testing.");
405 ("version", (RStruct ("version", "version"), [], []), -1, [],
406 [InitNone, Always, TestOutputStruct (
407 [["version"]], [CompareWithInt ("major", 1)])],
408 "get the library version number",
410 Return the libguestfs version number that the program is linked
413 Note that because of dynamic linking this is not necessarily
414 the version of libguestfs that you compiled against. You can
415 compile the program, and then at runtime dynamically link
416 against a completely different C<libguestfs.so> library.
418 This call was added in version C<1.0.58>. In previous
419 versions of libguestfs there was no way to get the version
420 number. From C code you can use dynamic linker functions
421 to find out if this symbol exists (if it doesn't, then
422 it's an earlier version).
424 The call returns a structure with four elements. The first
425 three (C<major>, C<minor> and C<release>) are numbers and
426 correspond to the usual version triplet. The fourth element
427 (C<extra>) is a string and is normally empty, but may be
428 used for distro-specific information.
430 To construct the original version string:
431 C<$major.$minor.$release$extra>
433 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
435 I<Note:> Don't use this call to test for availability
436 of features. In enterprise distributions we backport
437 features from later versions into earlier versions,
438 making this an unreliable way to test for features.
439 Use C<guestfs_available> instead.");
441 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
442 [InitNone, Always, TestOutputTrue (
443 [["set_selinux"; "true"];
445 "set SELinux enabled or disabled at appliance boot",
447 This sets the selinux flag that is passed to the appliance
448 at boot time. The default is C<selinux=0> (disabled).
450 Note that if SELinux is enabled, it is always in
451 Permissive mode (C<enforcing=0>).
453 For more information on the architecture of libguestfs,
454 see L<guestfs(3)>.");
456 ("get_selinux", (RBool "selinux", [], []), -1, [],
458 "get SELinux enabled flag",
460 This returns the current setting of the selinux flag which
461 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
463 For more information on the architecture of libguestfs,
464 see L<guestfs(3)>.");
466 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
467 [InitNone, Always, TestOutputFalse (
468 [["set_trace"; "false"];
470 "enable or disable command traces",
472 If the command trace flag is set to 1, then commands are
473 printed on stderr before they are executed in a format
474 which is very similar to the one used by guestfish. In
475 other words, you can run a program with this enabled, and
476 you will get out a script which you can feed to guestfish
477 to perform the same set of actions.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
486 ("get_trace", (RBool "trace", [], []), -1, [],
488 "get command trace enabled flag",
490 Return the command trace flag.");
492 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
493 [InitNone, Always, TestOutputFalse (
494 [["set_direct"; "false"];
496 "enable or disable direct appliance mode",
498 If the direct appliance mode flag is enabled, then stdin and
499 stdout are passed directly through to the appliance once it
502 One consequence of this is that log messages aren't caught
503 by the library and handled by C<guestfs_set_log_message_callback>,
504 but go straight to stdout.
506 You probably don't want to use this unless you know what you
509 The default is disabled.");
511 ("get_direct", (RBool "direct", [], []), -1, [],
513 "get direct appliance mode flag",
515 Return the direct appliance mode flag.");
517 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
518 [InitNone, Always, TestOutputTrue (
519 [["set_recovery_proc"; "true"];
520 ["get_recovery_proc"]])],
521 "enable or disable the recovery process",
523 If this is called with the parameter C<false> then
524 C<guestfs_launch> does not create a recovery process. The
525 purpose of the recovery process is to stop runaway qemu
526 processes in the case where the main program aborts abruptly.
528 This only has any effect if called before C<guestfs_launch>,
529 and the default is true.
531 About the only time when you would want to disable this is
532 if the main process will fork itself into the background
533 (\"daemonize\" itself). In this case the recovery process
534 thinks that the main program has disappeared and so kills
535 qemu, which is not very helpful.");
537 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
539 "get recovery process enabled flag",
541 Return the recovery process enabled flag.");
543 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
545 "add a drive specifying the QEMU block emulation to use",
547 This is the same as C<guestfs_add_drive> but it allows you
548 to specify the QEMU interface emulation to use at run time.");
550 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
552 "add a drive read-only specifying the QEMU block emulation to use",
554 This is the same as C<guestfs_add_drive_ro> but it allows you
555 to specify the QEMU interface emulation to use at run time.");
557 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
558 [InitISOFS, Always, TestOutput (
559 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
560 InitISOFS, Always, TestOutput (
561 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
562 InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-win32.exe"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/lib-i586.so"]], "i386");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/lib-sparc.so"]], "sparc");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-win32.dll"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
582 "detect the architecture of a binary file",
584 This detects the architecture of the binary C<filename>,
585 and returns it if known.
587 Currently defined architectures are:
593 This string is returned for all 32 bit i386, i486, i586, i686 binaries
594 irrespective of the precise processor requirements of the binary.
606 64 bit SPARC V9 and above.
622 Libguestfs may return other architecture strings in future.
624 The function works on at least the following types of files:
630 many types of Un*x and Linux binary
634 many types of Un*x and Linux shared library
638 Windows Win32 and Win64 binaries
642 Windows Win32 and Win64 DLLs
644 Win32 binaries and DLLs return C<i386>.
646 Win64 binaries and DLLs return C<x86_64>.
654 Linux new-style initrd images
658 some non-x86 Linux vmlinuz kernels
662 What it can't do currently:
668 static libraries (libfoo.a)
672 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
676 x86 Linux vmlinuz kernels
678 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
679 compressed code, and are horribly hard to unpack. If you want to find
680 the architecture of a kernel, use the architecture of the associated
681 initrd or kernel module(s) instead.
685 ("inspect_os", (RStringList "roots", [], []), -1, [],
687 "inspect disk and return list of operating systems found",
689 This function uses other libguestfs functions and certain
690 heuristics to inspect the disk(s) (usually disks belonging to
691 a virtual machine), looking for operating systems.
693 The list returned is empty if no operating systems were found.
695 If one operating system was found, then this returns a list with
696 a single element, which is the name of the root filesystem of
697 this operating system. It is also possible for this function
698 to return a list containing more than one element, indicating
699 a dual-boot or multi-boot virtual machine, with each element being
700 the root filesystem of one of the operating systems.
702 You can pass the root string(s) returned to other
703 C<guestfs_inspect_get_*> functions in order to query further
704 information about each operating system, such as the name
707 This function uses other libguestfs features such as
708 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
709 and unmount filesystems and look at the contents. This should
710 be called with no disks currently mounted. The function may also
711 use Augeas, so any existing Augeas handle will be closed.
713 This function cannot decrypt encrypted disks. The caller
714 must do that first (supplying the necessary keys) if the
717 Please read L<guestfs(3)/INSPECTION> for more details.
719 See also C<guestfs_list_filesystems>.");
721 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
723 "get type of inspected operating system",
725 This function should only be called with a root device string
726 as returned by C<guestfs_inspect_os>.
728 This returns the type of the inspected operating system.
729 Currently defined types are:
735 Any Linux-based operating system.
739 Any Microsoft Windows operating system.
743 The operating system type could not be determined.
747 Future versions of libguestfs may return other strings here.
748 The caller should be prepared to handle any string.
750 Please read L<guestfs(3)/INSPECTION> for more details.");
752 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
754 "get architecture of inspected operating system",
756 This function should only be called with a root device string
757 as returned by C<guestfs_inspect_os>.
759 This returns the architecture of the inspected operating system.
760 The possible return values are listed under
761 C<guestfs_file_architecture>.
763 If the architecture could not be determined, then the
764 string C<unknown> is returned.
766 Please read L<guestfs(3)/INSPECTION> for more details.");
768 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
770 "get distro of inspected operating system",
772 This function should only be called with a root device string
773 as returned by C<guestfs_inspect_os>.
775 This returns the distro (distribution) of the inspected operating
778 Currently defined distros are:
788 Debian or a Debian-derived distro such as Ubuntu.
806 =item \"redhat-based\"
808 Some Red Hat-derived distro.
812 Red Hat Enterprise Linux and some derivatives.
816 Windows does not have distributions. This string is
817 returned if the OS type is Windows.
825 The distro could not be determined.
829 Future versions of libguestfs may return other strings here.
830 The caller should be prepared to handle any string.
832 Please read L<guestfs(3)/INSPECTION> for more details.");
834 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
836 "get major version of inspected operating system",
838 This function should only be called with a root device string
839 as returned by C<guestfs_inspect_os>.
841 This returns the major version number of the inspected operating
844 Windows uses a consistent versioning scheme which is I<not>
845 reflected in the popular public names used by the operating system.
846 Notably the operating system known as \"Windows 7\" is really
847 version 6.1 (ie. major = 6, minor = 1). You can find out the
848 real versions corresponding to releases of Windows by consulting
851 If the version could not be determined, then C<0> is returned.
853 Please read L<guestfs(3)/INSPECTION> for more details.");
855 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
857 "get minor version of inspected operating system",
859 This function should only be called with a root device string
860 as returned by C<guestfs_inspect_os>.
862 This returns the minor version number of the inspected operating
865 If the version could not be determined, then C<0> is returned.
867 Please read L<guestfs(3)/INSPECTION> for more details.
868 See also C<guestfs_inspect_get_major_version>.");
870 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
872 "get product name of inspected operating system",
874 This function should only be called with a root device string
875 as returned by C<guestfs_inspect_os>.
877 This returns the product name of the inspected operating
878 system. The product name is generally some freeform string
879 which can be displayed to the user, but should not be
882 If the product name could not be determined, then the
883 string C<unknown> is returned.
885 Please read L<guestfs(3)/INSPECTION> for more details.");
887 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
889 "get mountpoints of inspected operating system",
891 This function should only be called with a root device string
892 as returned by C<guestfs_inspect_os>.
894 This returns a hash of where we think the filesystems
895 associated with this operating system should be mounted.
896 Callers should note that this is at best an educated guess
897 made by reading configuration files such as C</etc/fstab>.
899 Each element in the returned hashtable has a key which
900 is the path of the mountpoint (eg. C</boot>) and a value
901 which is the filesystem that would be mounted there
904 Non-mounted devices such as swap devices are I<not>
905 returned in this list.
907 Please read L<guestfs(3)/INSPECTION> for more details.
908 See also C<guestfs_inspect_get_filesystems>.");
910 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
912 "get filesystems associated with inspected operating system",
914 This function should only be called with a root device string
915 as returned by C<guestfs_inspect_os>.
917 This returns a list of all the filesystems that we think
918 are associated with this operating system. This includes
919 the root filesystem, other ordinary filesystems, and
920 non-mounted devices like swap partitions.
922 In the case of a multi-boot virtual machine, it is possible
923 for a filesystem to be shared between operating systems.
925 Please read L<guestfs(3)/INSPECTION> for more details.
926 See also C<guestfs_inspect_get_mountpoints>.");
928 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
930 "set enable network flag",
932 If C<network> is true, then the network is enabled in the
933 libguestfs appliance. The default is false.
935 This affects whether commands are able to access the network
936 (see L<guestfs(3)/RUNNING COMMANDS>).
938 You must call this before calling C<guestfs_launch>, otherwise
941 ("get_network", (RBool "network", [], []), -1, [],
943 "get enable network flag",
945 This returns the enable network flag.");
947 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
951 This inspection command looks for filesystems on partitions,
952 block devices and logical volumes, returning a list of devices
953 containing filesystems and their type.
955 The return value is a hash, where the keys are the devices
956 containing filesystems, and the values are the filesystem types.
959 \"/dev/sda1\" => \"ntfs\"
960 \"/dev/sda2\" => \"ext2\"
961 \"/dev/vg_guest/lv_root\" => \"ext4\"
962 \"/dev/vg_guest/lv_swap\" => \"swap\"
964 The value can have the special value \"unknown\", meaning the
965 content of the device is undetermined or empty.
966 \"swap\" means a Linux swap partition.
968 This command runs other libguestfs commands, which might include
969 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
970 use this soon after launch and only when nothing is mounted.
972 Not all of the filesystems returned will be mountable. In
973 particular, swap partitions are returned in the list. Also
974 this command does not check that each filesystem
975 found is valid and mountable, and some filesystems might
976 be mountable but require special options. Filesystems may
977 not all belong to a single logical operating system
978 (use C<guestfs_inspect_os> to look for OSes).");
980 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
982 "add an image to examine or modify",
984 This function adds a virtual machine disk image C<filename> to
985 libguestfs. The first time you call this function, the disk
986 appears as C</dev/sda>, the second time as C</dev/sdb>, and
989 You don't necessarily need to be root when using libguestfs. However
990 you obviously do need sufficient permissions to access the filename
991 for whatever operations you want to perform (ie. read access if you
992 just want to read the image or write access if you want to modify the
995 This call checks that C<filename> exists.
997 The optional arguments are:
1003 If true then the image is treated as read-only. Writes are still
1004 allowed, but they are stored in a temporary snapshot overlay which
1005 is discarded at the end. The disk that you add is not modified.
1009 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1010 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1011 Possible formats include C<raw> and C<qcow2>.
1013 Automatic detection of the format opens you up to a potential
1014 security hole when dealing with untrusted raw-format images.
1015 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1020 This rarely-used option lets you emulate the behaviour of the
1021 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1025 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1027 "get Windows systemroot of inspected operating system",
1029 This function should only be called with a root device string
1030 as returned by C<guestfs_inspect_os>.
1032 This returns the Windows systemroot of the inspected guest.
1033 The systemroot is a directory path such as C</WINDOWS>.
1035 This call assumes that the guest is Windows and that the
1036 systemroot could be determined by inspection. If this is not
1037 the case then an error is returned.
1039 Please read L<guestfs(3)/INSPECTION> for more details.");
1041 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1043 "return list of operating systems found by last inspection",
1045 This function is a convenient way to get the list of root
1046 devices, as returned from a previous call to C<guestfs_inspect_os>,
1047 but without redoing the whole inspection process.
1049 This returns an empty list if either no root devices were
1050 found or the caller has not called C<guestfs_inspect_os>.
1052 Please read L<guestfs(3)/INSPECTION> for more details.");
1054 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1056 "debug the QEMU command line (internal use only)",
1058 This returns the internal QEMU command line. 'debug' commands are
1059 not part of the formal API and can be removed or changed at any time.");
1063 (* daemon_functions are any functions which cause some action
1064 * to take place in the daemon.
1067 let daemon_functions = [
1068 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1069 [InitEmpty, Always, TestOutput (
1070 [["part_disk"; "/dev/sda"; "mbr"];
1071 ["mkfs"; "ext2"; "/dev/sda1"];
1072 ["mount"; "/dev/sda1"; "/"];
1073 ["write"; "/new"; "new file contents"];
1074 ["cat"; "/new"]], "new file contents")],
1075 "mount a guest disk at a position in the filesystem",
1077 Mount a guest disk at a position in the filesystem. Block devices
1078 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1079 the guest. If those block devices contain partitions, they will have
1080 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1083 The rules are the same as for L<mount(2)>: A filesystem must
1084 first be mounted on C</> before others can be mounted. Other
1085 filesystems can only be mounted on directories which already
1088 The mounted filesystem is writable, if we have sufficient permissions
1089 on the underlying device.
1092 When you use this call, the filesystem options C<sync> and C<noatime>
1093 are set implicitly. This was originally done because we thought it
1094 would improve reliability, but it turns out that I<-o sync> has a
1095 very large negative performance impact and negligible effect on
1096 reliability. Therefore we recommend that you avoid using
1097 C<guestfs_mount> in any code that needs performance, and instead
1098 use C<guestfs_mount_options> (use an empty string for the first
1099 parameter if you don't want any options).");
1101 ("sync", (RErr, [], []), 2, [],
1102 [ InitEmpty, Always, TestRun [["sync"]]],
1103 "sync disks, writes are flushed through to the disk image",
1105 This syncs the disk, so that any writes are flushed through to the
1106 underlying disk image.
1108 You should always call this if you have modified a disk image, before
1109 closing the handle.");
1111 ("touch", (RErr, [Pathname "path"], []), 3, [],
1112 [InitBasicFS, Always, TestOutputTrue (
1114 ["exists"; "/new"]])],
1115 "update file timestamps or create a new file",
1117 Touch acts like the L<touch(1)> command. It can be used to
1118 update the timestamps on a file, or, if the file does not exist,
1119 to create a new zero-length file.
1121 This command only works on regular files, and will fail on other
1122 file types such as directories, symbolic links, block special etc.");
1124 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1125 [InitISOFS, Always, TestOutput (
1126 [["cat"; "/known-2"]], "abcdef\n")],
1127 "list the contents of a file",
1129 Return the contents of the file named C<path>.
1131 Note that this function cannot correctly handle binary files
1132 (specifically, files containing C<\\0> character which is treated
1133 as end of string). For those you need to use the C<guestfs_read_file>
1134 or C<guestfs_download> functions which have a more complex interface.");
1136 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1137 [], (* XXX Tricky to test because it depends on the exact format
1138 * of the 'ls -l' command, which changes between F10 and F11.
1140 "list the files in a directory (long format)",
1142 List the files in C<directory> (relative to the root directory,
1143 there is no cwd) in the format of 'ls -la'.
1145 This command is mostly useful for interactive sessions. It
1146 is I<not> intended that you try to parse the output string.");
1148 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1149 [InitBasicFS, Always, TestOutputList (
1151 ["touch"; "/newer"];
1152 ["touch"; "/newest"];
1153 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1154 "list the files in a directory",
1156 List the files in C<directory> (relative to the root directory,
1157 there is no cwd). The '.' and '..' entries are not returned, but
1158 hidden files are shown.
1160 This command is mostly useful for interactive sessions. Programs
1161 should probably use C<guestfs_readdir> instead.");
1163 ("list_devices", (RStringList "devices", [], []), 7, [],
1164 [InitEmpty, Always, TestOutputListOfDevices (
1165 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1166 "list the block devices",
1168 List all the block devices.
1170 The full block device names are returned, eg. C</dev/sda>.
1172 See also C<guestfs_list_filesystems>.");
1174 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1175 [InitBasicFS, Always, TestOutputListOfDevices (
1176 [["list_partitions"]], ["/dev/sda1"]);
1177 InitEmpty, Always, TestOutputListOfDevices (
1178 [["part_init"; "/dev/sda"; "mbr"];
1179 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1180 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1181 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1182 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1183 "list the partitions",
1185 List all the partitions detected on all block devices.
1187 The full partition device names are returned, eg. C</dev/sda1>
1189 This does not return logical volumes. For that you will need to
1190 call C<guestfs_lvs>.
1192 See also C<guestfs_list_filesystems>.");
1194 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1195 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1196 [["pvs"]], ["/dev/sda1"]);
1197 InitEmpty, Always, TestOutputListOfDevices (
1198 [["part_init"; "/dev/sda"; "mbr"];
1199 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1200 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1201 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1202 ["pvcreate"; "/dev/sda1"];
1203 ["pvcreate"; "/dev/sda2"];
1204 ["pvcreate"; "/dev/sda3"];
1205 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1206 "list the LVM physical volumes (PVs)",
1208 List all the physical volumes detected. This is the equivalent
1209 of the L<pvs(8)> command.
1211 This returns a list of just the device names that contain
1212 PVs (eg. C</dev/sda2>).
1214 See also C<guestfs_pvs_full>.");
1216 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1217 [InitBasicFSonLVM, Always, TestOutputList (
1219 InitEmpty, Always, TestOutputList (
1220 [["part_init"; "/dev/sda"; "mbr"];
1221 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1222 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1223 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1224 ["pvcreate"; "/dev/sda1"];
1225 ["pvcreate"; "/dev/sda2"];
1226 ["pvcreate"; "/dev/sda3"];
1227 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1228 ["vgcreate"; "VG2"; "/dev/sda3"];
1229 ["vgs"]], ["VG1"; "VG2"])],
1230 "list the LVM volume groups (VGs)",
1232 List all the volumes groups detected. This is the equivalent
1233 of the L<vgs(8)> command.
1235 This returns a list of just the volume group names that were
1236 detected (eg. C<VolGroup00>).
1238 See also C<guestfs_vgs_full>.");
1240 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1241 [InitBasicFSonLVM, Always, TestOutputList (
1242 [["lvs"]], ["/dev/VG/LV"]);
1243 InitEmpty, Always, TestOutputList (
1244 [["part_init"; "/dev/sda"; "mbr"];
1245 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1246 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1247 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1248 ["pvcreate"; "/dev/sda1"];
1249 ["pvcreate"; "/dev/sda2"];
1250 ["pvcreate"; "/dev/sda3"];
1251 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1252 ["vgcreate"; "VG2"; "/dev/sda3"];
1253 ["lvcreate"; "LV1"; "VG1"; "50"];
1254 ["lvcreate"; "LV2"; "VG1"; "50"];
1255 ["lvcreate"; "LV3"; "VG2"; "50"];
1256 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1257 "list the LVM logical volumes (LVs)",
1259 List all the logical volumes detected. This is the equivalent
1260 of the L<lvs(8)> command.
1262 This returns a list of the logical volume device names
1263 (eg. C</dev/VolGroup00/LogVol00>).
1265 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1267 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1268 [], (* XXX how to test? *)
1269 "list the LVM physical volumes (PVs)",
1271 List all the physical volumes detected. This is the equivalent
1272 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1274 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1275 [], (* XXX how to test? *)
1276 "list the LVM volume groups (VGs)",
1278 List all the volumes groups detected. This is the equivalent
1279 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1281 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1282 [], (* XXX how to test? *)
1283 "list the LVM logical volumes (LVs)",
1285 List all the logical volumes detected. This is the equivalent
1286 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1288 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1289 [InitISOFS, Always, TestOutputList (
1290 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1291 InitISOFS, Always, TestOutputList (
1292 [["read_lines"; "/empty"]], [])],
1293 "read file as lines",
1295 Return the contents of the file named C<path>.
1297 The file contents are returned as a list of lines. Trailing
1298 C<LF> and C<CRLF> character sequences are I<not> returned.
1300 Note that this function cannot correctly handle binary files
1301 (specifically, files containing C<\\0> character which is treated
1302 as end of line). For those you need to use the C<guestfs_read_file>
1303 function which has a more complex interface.");
1305 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1306 [], (* XXX Augeas code needs tests. *)
1307 "create a new Augeas handle",
1309 Create a new Augeas handle for editing configuration files.
1310 If there was any previous Augeas handle associated with this
1311 guestfs session, then it is closed.
1313 You must call this before using any other C<guestfs_aug_*>
1316 C<root> is the filesystem root. C<root> must not be NULL,
1319 The flags are the same as the flags defined in
1320 E<lt>augeas.hE<gt>, the logical I<or> of the following
1325 =item C<AUG_SAVE_BACKUP> = 1
1327 Keep the original file with a C<.augsave> extension.
1329 =item C<AUG_SAVE_NEWFILE> = 2
1331 Save changes into a file with extension C<.augnew>, and
1332 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1334 =item C<AUG_TYPE_CHECK> = 4
1336 Typecheck lenses (can be expensive).
1338 =item C<AUG_NO_STDINC> = 8
1340 Do not use standard load path for modules.
1342 =item C<AUG_SAVE_NOOP> = 16
1344 Make save a no-op, just record what would have been changed.
1346 =item C<AUG_NO_LOAD> = 32
1348 Do not load the tree in C<guestfs_aug_init>.
1352 To close the handle, you can call C<guestfs_aug_close>.
1354 To find out more about Augeas, see L<http://augeas.net/>.");
1356 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1357 [], (* XXX Augeas code needs tests. *)
1358 "close the current Augeas handle",
1360 Close the current Augeas handle and free up any resources
1361 used by it. After calling this, you have to call
1362 C<guestfs_aug_init> again before you can use any other
1363 Augeas functions.");
1365 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1366 [], (* XXX Augeas code needs tests. *)
1367 "define an Augeas variable",
1369 Defines an Augeas variable C<name> whose value is the result
1370 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1373 On success this returns the number of nodes in C<expr>, or
1374 C<0> if C<expr> evaluates to something which is not a nodeset.");
1376 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1377 [], (* XXX Augeas code needs tests. *)
1378 "define an Augeas node",
1380 Defines a variable C<name> whose value is the result of
1383 If C<expr> evaluates to an empty nodeset, a node is created,
1384 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1385 C<name> will be the nodeset containing that single node.
1387 On success this returns a pair containing the
1388 number of nodes in the nodeset, and a boolean flag
1389 if a node was created.");
1391 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1392 [], (* XXX Augeas code needs tests. *)
1393 "look up the value of an Augeas path",
1395 Look up the value associated with C<path>. If C<path>
1396 matches exactly one node, the C<value> is returned.");
1398 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1399 [], (* XXX Augeas code needs tests. *)
1400 "set Augeas path to value",
1402 Set the value associated with C<path> to C<val>.
1404 In the Augeas API, it is possible to clear a node by setting
1405 the value to NULL. Due to an oversight in the libguestfs API
1406 you cannot do that with this call. Instead you must use the
1407 C<guestfs_aug_clear> call.");
1409 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1410 [], (* XXX Augeas code needs tests. *)
1411 "insert a sibling Augeas node",
1413 Create a new sibling C<label> for C<path>, inserting it into
1414 the tree before or after C<path> (depending on the boolean
1417 C<path> must match exactly one existing node in the tree, and
1418 C<label> must be a label, ie. not contain C</>, C<*> or end
1419 with a bracketed index C<[N]>.");
1421 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1422 [], (* XXX Augeas code needs tests. *)
1423 "remove an Augeas path",
1425 Remove C<path> and all of its children.
1427 On success this returns the number of entries which were removed.");
1429 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1430 [], (* XXX Augeas code needs tests. *)
1433 Move the node C<src> to C<dest>. C<src> must match exactly
1434 one node. C<dest> is overwritten if it exists.");
1436 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1437 [], (* XXX Augeas code needs tests. *)
1438 "return Augeas nodes which match augpath",
1440 Returns a list of paths which match the path expression C<path>.
1441 The returned paths are sufficiently qualified so that they match
1442 exactly one node in the current tree.");
1444 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1445 [], (* XXX Augeas code needs tests. *)
1446 "write all pending Augeas changes to disk",
1448 This writes all pending changes to disk.
1450 The flags which were passed to C<guestfs_aug_init> affect exactly
1451 how files are saved.");
1453 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1454 [], (* XXX Augeas code needs tests. *)
1455 "load files into the tree",
1457 Load files into the tree.
1459 See C<aug_load> in the Augeas documentation for the full gory
1462 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1463 [], (* XXX Augeas code needs tests. *)
1464 "list Augeas nodes under augpath",
1466 This is just a shortcut for listing C<guestfs_aug_match>
1467 C<path/*> and sorting the resulting nodes into alphabetical order.");
1469 ("rm", (RErr, [Pathname "path"], []), 29, [],
1470 [InitBasicFS, Always, TestRun
1473 InitBasicFS, Always, TestLastFail
1475 InitBasicFS, Always, TestLastFail
1480 Remove the single file C<path>.");
1482 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1483 [InitBasicFS, Always, TestRun
1486 InitBasicFS, Always, TestLastFail
1487 [["rmdir"; "/new"]];
1488 InitBasicFS, Always, TestLastFail
1490 ["rmdir"; "/new"]]],
1491 "remove a directory",
1493 Remove the single directory C<path>.");
1495 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1496 [InitBasicFS, Always, TestOutputFalse
1498 ["mkdir"; "/new/foo"];
1499 ["touch"; "/new/foo/bar"];
1501 ["exists"; "/new"]]],
1502 "remove a file or directory recursively",
1504 Remove the file or directory C<path>, recursively removing the
1505 contents if its a directory. This is like the C<rm -rf> shell
1508 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1509 [InitBasicFS, Always, TestOutputTrue
1511 ["is_dir"; "/new"]];
1512 InitBasicFS, Always, TestLastFail
1513 [["mkdir"; "/new/foo/bar"]]],
1514 "create a directory",
1516 Create a directory named C<path>.");
1518 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1519 [InitBasicFS, Always, TestOutputTrue
1520 [["mkdir_p"; "/new/foo/bar"];
1521 ["is_dir"; "/new/foo/bar"]];
1522 InitBasicFS, Always, TestOutputTrue
1523 [["mkdir_p"; "/new/foo/bar"];
1524 ["is_dir"; "/new/foo"]];
1525 InitBasicFS, Always, TestOutputTrue
1526 [["mkdir_p"; "/new/foo/bar"];
1527 ["is_dir"; "/new"]];
1528 (* Regression tests for RHBZ#503133: *)
1529 InitBasicFS, Always, TestRun
1531 ["mkdir_p"; "/new"]];
1532 InitBasicFS, Always, TestLastFail
1534 ["mkdir_p"; "/new"]]],
1535 "create a directory and parents",
1537 Create a directory named C<path>, creating any parent directories
1538 as necessary. This is like the C<mkdir -p> shell command.");
1540 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1541 [], (* XXX Need stat command to test *)
1544 Change the mode (permissions) of C<path> to C<mode>. Only
1545 numeric modes are supported.
1547 I<Note>: When using this command from guestfish, C<mode>
1548 by default would be decimal, unless you prefix it with
1549 C<0> to get octal, ie. use C<0700> not C<700>.
1551 The mode actually set is affected by the umask.");
1553 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1554 [], (* XXX Need stat command to test *)
1555 "change file owner and group",
1557 Change the file owner to C<owner> and group to C<group>.
1559 Only numeric uid and gid are supported. If you want to use
1560 names, you will need to locate and parse the password file
1561 yourself (Augeas support makes this relatively easy).");
1563 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1564 [InitISOFS, Always, TestOutputTrue (
1565 [["exists"; "/empty"]]);
1566 InitISOFS, Always, TestOutputTrue (
1567 [["exists"; "/directory"]])],
1568 "test if file or directory exists",
1570 This returns C<true> if and only if there is a file, directory
1571 (or anything) with the given C<path> name.
1573 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1575 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1576 [InitISOFS, Always, TestOutputTrue (
1577 [["is_file"; "/known-1"]]);
1578 InitISOFS, Always, TestOutputFalse (
1579 [["is_file"; "/directory"]])],
1580 "test if a regular file",
1582 This returns C<true> if and only if there is a regular file
1583 with the given C<path> name. Note that it returns false for
1584 other objects like directories.
1586 See also C<guestfs_stat>.");
1588 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1589 [InitISOFS, Always, TestOutputFalse (
1590 [["is_dir"; "/known-3"]]);
1591 InitISOFS, Always, TestOutputTrue (
1592 [["is_dir"; "/directory"]])],
1593 "test if a directory",
1595 This returns C<true> if and only if there is a directory
1596 with the given C<path> name. Note that it returns false for
1597 other objects like files.
1599 See also C<guestfs_stat>.");
1601 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1602 [InitEmpty, Always, TestOutputListOfDevices (
1603 [["part_init"; "/dev/sda"; "mbr"];
1604 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1605 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1606 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1607 ["pvcreate"; "/dev/sda1"];
1608 ["pvcreate"; "/dev/sda2"];
1609 ["pvcreate"; "/dev/sda3"];
1610 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1611 "create an LVM physical volume",
1613 This creates an LVM physical volume on the named C<device>,
1614 where C<device> should usually be a partition name such
1617 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1618 [InitEmpty, Always, TestOutputList (
1619 [["part_init"; "/dev/sda"; "mbr"];
1620 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1621 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1622 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1623 ["pvcreate"; "/dev/sda1"];
1624 ["pvcreate"; "/dev/sda2"];
1625 ["pvcreate"; "/dev/sda3"];
1626 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1627 ["vgcreate"; "VG2"; "/dev/sda3"];
1628 ["vgs"]], ["VG1"; "VG2"])],
1629 "create an LVM volume group",
1631 This creates an LVM volume group called C<volgroup>
1632 from the non-empty list of physical volumes C<physvols>.");
1634 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1635 [InitEmpty, Always, TestOutputList (
1636 [["part_init"; "/dev/sda"; "mbr"];
1637 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1638 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1639 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1640 ["pvcreate"; "/dev/sda1"];
1641 ["pvcreate"; "/dev/sda2"];
1642 ["pvcreate"; "/dev/sda3"];
1643 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1644 ["vgcreate"; "VG2"; "/dev/sda3"];
1645 ["lvcreate"; "LV1"; "VG1"; "50"];
1646 ["lvcreate"; "LV2"; "VG1"; "50"];
1647 ["lvcreate"; "LV3"; "VG2"; "50"];
1648 ["lvcreate"; "LV4"; "VG2"; "50"];
1649 ["lvcreate"; "LV5"; "VG2"; "50"];
1651 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1652 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1653 "create an LVM logical volume",
1655 This creates an LVM logical volume called C<logvol>
1656 on the volume group C<volgroup>, with C<size> megabytes.");
1658 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1659 [InitEmpty, Always, TestOutput (
1660 [["part_disk"; "/dev/sda"; "mbr"];
1661 ["mkfs"; "ext2"; "/dev/sda1"];
1662 ["mount_options"; ""; "/dev/sda1"; "/"];
1663 ["write"; "/new"; "new file contents"];
1664 ["cat"; "/new"]], "new file contents")],
1665 "make a filesystem",
1667 This creates a filesystem on C<device> (usually a partition
1668 or LVM logical volume). The filesystem type is C<fstype>, for
1671 ("sfdisk", (RErr, [Device "device";
1672 Int "cyls"; Int "heads"; Int "sectors";
1673 StringList "lines"], []), 43, [DangerWillRobinson],
1675 "create partitions on a block device",
1677 This is a direct interface to the L<sfdisk(8)> program for creating
1678 partitions on block devices.
1680 C<device> should be a block device, for example C</dev/sda>.
1682 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1683 and sectors on the device, which are passed directly to sfdisk as
1684 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1685 of these, then the corresponding parameter is omitted. Usually for
1686 'large' disks, you can just pass C<0> for these, but for small
1687 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1688 out the right geometry and you will need to tell it.
1690 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1691 information refer to the L<sfdisk(8)> manpage.
1693 To create a single partition occupying the whole disk, you would
1694 pass C<lines> as a single element list, when the single element being
1695 the string C<,> (comma).
1697 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1698 C<guestfs_part_init>");
1700 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1701 (* Regression test for RHBZ#597135. *)
1702 [InitBasicFS, Always, TestLastFail
1703 [["write_file"; "/new"; "abc"; "10000"]]],
1706 This call creates a file called C<path>. The contents of the
1707 file is the string C<content> (which can contain any 8 bit data),
1708 with length C<size>.
1710 As a special case, if C<size> is C<0>
1711 then the length is calculated using C<strlen> (so in this case
1712 the content cannot contain embedded ASCII NULs).
1714 I<NB.> Owing to a bug, writing content containing ASCII NUL
1715 characters does I<not> work, even if the length is specified.");
1717 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1718 [InitEmpty, Always, TestOutputListOfDevices (
1719 [["part_disk"; "/dev/sda"; "mbr"];
1720 ["mkfs"; "ext2"; "/dev/sda1"];
1721 ["mount_options"; ""; "/dev/sda1"; "/"];
1722 ["mounts"]], ["/dev/sda1"]);
1723 InitEmpty, Always, TestOutputList (
1724 [["part_disk"; "/dev/sda"; "mbr"];
1725 ["mkfs"; "ext2"; "/dev/sda1"];
1726 ["mount_options"; ""; "/dev/sda1"; "/"];
1729 "unmount a filesystem",
1731 This unmounts the given filesystem. The filesystem may be
1732 specified either by its mountpoint (path) or the device which
1733 contains the filesystem.");
1735 ("mounts", (RStringList "devices", [], []), 46, [],
1736 [InitBasicFS, Always, TestOutputListOfDevices (
1737 [["mounts"]], ["/dev/sda1"])],
1738 "show mounted filesystems",
1740 This returns the list of currently mounted filesystems. It returns
1741 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1743 Some internal mounts are not shown.
1745 See also: C<guestfs_mountpoints>");
1747 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1748 [InitBasicFS, Always, TestOutputList (
1751 (* check that umount_all can unmount nested mounts correctly: *)
1752 InitEmpty, Always, TestOutputList (
1753 [["part_init"; "/dev/sda"; "mbr"];
1754 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1755 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1756 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1757 ["mkfs"; "ext2"; "/dev/sda1"];
1758 ["mkfs"; "ext2"; "/dev/sda2"];
1759 ["mkfs"; "ext2"; "/dev/sda3"];
1760 ["mount_options"; ""; "/dev/sda1"; "/"];
1762 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1763 ["mkdir"; "/mp1/mp2"];
1764 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1765 ["mkdir"; "/mp1/mp2/mp3"];
1768 "unmount all filesystems",
1770 This unmounts all mounted filesystems.
1772 Some internal mounts are not unmounted by this call.");
1774 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1776 "remove all LVM LVs, VGs and PVs",
1778 This command removes all LVM logical volumes, volume groups
1779 and physical volumes.");
1781 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
1782 [InitISOFS, Always, TestOutput (
1783 [["file"; "/empty"]], "empty");
1784 InitISOFS, Always, TestOutput (
1785 [["file"; "/known-1"]], "ASCII text");
1786 InitISOFS, Always, TestLastFail (
1787 [["file"; "/notexists"]]);
1788 InitISOFS, Always, TestOutput (
1789 [["file"; "/abssymlink"]], "symbolic link");
1790 InitISOFS, Always, TestOutput (
1791 [["file"; "/directory"]], "directory")],
1792 "determine file type",
1794 This call uses the standard L<file(1)> command to determine
1795 the type or contents of the file.
1797 This call will also transparently look inside various types
1800 The exact command which runs is C<file -zb path>. Note in
1801 particular that the filename is not prepended to the output
1804 This command can also be used on C</dev/> devices
1805 (and partitions, LV names). You can for example use this
1806 to determine if a device contains a filesystem, although
1807 it's usually better to use C<guestfs_vfs_type>.
1809 If the C<path> does not begin with C</dev/> then
1810 this command only works for the content of regular files.
1811 For other file types (directory, symbolic link etc) it
1812 will just return the string C<directory> etc.");
1814 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
1815 [InitBasicFS, Always, TestOutput (
1816 [["upload"; "test-command"; "/test-command"];
1817 ["chmod"; "0o755"; "/test-command"];
1818 ["command"; "/test-command 1"]], "Result1");
1819 InitBasicFS, Always, TestOutput (
1820 [["upload"; "test-command"; "/test-command"];
1821 ["chmod"; "0o755"; "/test-command"];
1822 ["command"; "/test-command 2"]], "Result2\n");
1823 InitBasicFS, Always, TestOutput (
1824 [["upload"; "test-command"; "/test-command"];
1825 ["chmod"; "0o755"; "/test-command"];
1826 ["command"; "/test-command 3"]], "\nResult3");
1827 InitBasicFS, Always, TestOutput (
1828 [["upload"; "test-command"; "/test-command"];
1829 ["chmod"; "0o755"; "/test-command"];
1830 ["command"; "/test-command 4"]], "\nResult4\n");
1831 InitBasicFS, Always, TestOutput (
1832 [["upload"; "test-command"; "/test-command"];
1833 ["chmod"; "0o755"; "/test-command"];
1834 ["command"; "/test-command 5"]], "\nResult5\n\n");
1835 InitBasicFS, Always, TestOutput (
1836 [["upload"; "test-command"; "/test-command"];
1837 ["chmod"; "0o755"; "/test-command"];
1838 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1839 InitBasicFS, Always, TestOutput (
1840 [["upload"; "test-command"; "/test-command"];
1841 ["chmod"; "0o755"; "/test-command"];
1842 ["command"; "/test-command 7"]], "");
1843 InitBasicFS, Always, TestOutput (
1844 [["upload"; "test-command"; "/test-command"];
1845 ["chmod"; "0o755"; "/test-command"];
1846 ["command"; "/test-command 8"]], "\n");
1847 InitBasicFS, Always, TestOutput (
1848 [["upload"; "test-command"; "/test-command"];
1849 ["chmod"; "0o755"; "/test-command"];
1850 ["command"; "/test-command 9"]], "\n\n");
1851 InitBasicFS, Always, TestOutput (
1852 [["upload"; "test-command"; "/test-command"];
1853 ["chmod"; "0o755"; "/test-command"];
1854 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1855 InitBasicFS, Always, TestOutput (
1856 [["upload"; "test-command"; "/test-command"];
1857 ["chmod"; "0o755"; "/test-command"];
1858 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1859 InitBasicFS, Always, TestLastFail (
1860 [["upload"; "test-command"; "/test-command"];
1861 ["chmod"; "0o755"; "/test-command"];
1862 ["command"; "/test-command"]])],
1863 "run a command from the guest filesystem",
1865 This call runs a command from the guest filesystem. The
1866 filesystem must be mounted, and must contain a compatible
1867 operating system (ie. something Linux, with the same
1868 or compatible processor architecture).
1870 The single parameter is an argv-style list of arguments.
1871 The first element is the name of the program to run.
1872 Subsequent elements are parameters. The list must be
1873 non-empty (ie. must contain a program name). Note that
1874 the command runs directly, and is I<not> invoked via
1875 the shell (see C<guestfs_sh>).
1877 The return value is anything printed to I<stdout> by
1880 If the command returns a non-zero exit status, then
1881 this function returns an error message. The error message
1882 string is the content of I<stderr> from the command.
1884 The C<$PATH> environment variable will contain at least
1885 C</usr/bin> and C</bin>. If you require a program from
1886 another location, you should provide the full path in the
1889 Shared libraries and data files required by the program
1890 must be available on filesystems which are mounted in the
1891 correct places. It is the caller's responsibility to ensure
1892 all filesystems that are needed are mounted at the right
1895 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
1896 [InitBasicFS, Always, TestOutputList (
1897 [["upload"; "test-command"; "/test-command"];
1898 ["chmod"; "0o755"; "/test-command"];
1899 ["command_lines"; "/test-command 1"]], ["Result1"]);
1900 InitBasicFS, Always, TestOutputList (
1901 [["upload"; "test-command"; "/test-command"];
1902 ["chmod"; "0o755"; "/test-command"];
1903 ["command_lines"; "/test-command 2"]], ["Result2"]);
1904 InitBasicFS, Always, TestOutputList (
1905 [["upload"; "test-command"; "/test-command"];
1906 ["chmod"; "0o755"; "/test-command"];
1907 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1908 InitBasicFS, Always, TestOutputList (
1909 [["upload"; "test-command"; "/test-command"];
1910 ["chmod"; "0o755"; "/test-command"];
1911 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1912 InitBasicFS, Always, TestOutputList (
1913 [["upload"; "test-command"; "/test-command"];
1914 ["chmod"; "0o755"; "/test-command"];
1915 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1916 InitBasicFS, Always, TestOutputList (
1917 [["upload"; "test-command"; "/test-command"];
1918 ["chmod"; "0o755"; "/test-command"];
1919 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1920 InitBasicFS, Always, TestOutputList (
1921 [["upload"; "test-command"; "/test-command"];
1922 ["chmod"; "0o755"; "/test-command"];
1923 ["command_lines"; "/test-command 7"]], []);
1924 InitBasicFS, Always, TestOutputList (
1925 [["upload"; "test-command"; "/test-command"];
1926 ["chmod"; "0o755"; "/test-command"];
1927 ["command_lines"; "/test-command 8"]], [""]);
1928 InitBasicFS, Always, TestOutputList (
1929 [["upload"; "test-command"; "/test-command"];
1930 ["chmod"; "0o755"; "/test-command"];
1931 ["command_lines"; "/test-command 9"]], ["";""]);
1932 InitBasicFS, Always, TestOutputList (
1933 [["upload"; "test-command"; "/test-command"];
1934 ["chmod"; "0o755"; "/test-command"];
1935 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1936 InitBasicFS, Always, TestOutputList (
1937 [["upload"; "test-command"; "/test-command"];
1938 ["chmod"; "0o755"; "/test-command"];
1939 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1940 "run a command, returning lines",
1942 This is the same as C<guestfs_command>, but splits the
1943 result into a list of lines.
1945 See also: C<guestfs_sh_lines>");
1947 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
1948 [InitISOFS, Always, TestOutputStruct (
1949 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1950 "get file information",
1952 Returns file information for the given C<path>.
1954 This is the same as the C<stat(2)> system call.");
1956 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
1957 [InitISOFS, Always, TestOutputStruct (
1958 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1959 "get file information for a symbolic link",
1961 Returns file information for the given C<path>.
1963 This is the same as C<guestfs_stat> except that if C<path>
1964 is a symbolic link, then the link is stat-ed, not the file it
1967 This is the same as the C<lstat(2)> system call.");
1969 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
1970 [InitISOFS, Always, TestOutputStruct (
1971 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1972 "get file system statistics",
1974 Returns file system statistics for any mounted file system.
1975 C<path> should be a file or directory in the mounted file system
1976 (typically it is the mount point itself, but it doesn't need to be).
1978 This is the same as the C<statvfs(2)> system call.");
1980 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
1982 "get ext2/ext3/ext4 superblock details",
1984 This returns the contents of the ext2, ext3 or ext4 filesystem
1985 superblock on C<device>.
1987 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1988 manpage for more details. The list of fields returned isn't
1989 clearly defined, and depends on both the version of C<tune2fs>
1990 that libguestfs was built against, and the filesystem itself.");
1992 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
1993 [InitEmpty, Always, TestOutputTrue (
1994 [["blockdev_setro"; "/dev/sda"];
1995 ["blockdev_getro"; "/dev/sda"]])],
1996 "set block device to read-only",
1998 Sets the block device named C<device> to read-only.
2000 This uses the L<blockdev(8)> command.");
2002 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2003 [InitEmpty, Always, TestOutputFalse (
2004 [["blockdev_setrw"; "/dev/sda"];
2005 ["blockdev_getro"; "/dev/sda"]])],
2006 "set block device to read-write",
2008 Sets the block device named C<device> to read-write.
2010 This uses the L<blockdev(8)> command.");
2012 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2013 [InitEmpty, Always, TestOutputTrue (
2014 [["blockdev_setro"; "/dev/sda"];
2015 ["blockdev_getro"; "/dev/sda"]])],
2016 "is block device set to read-only",
2018 Returns a boolean indicating if the block device is read-only
2019 (true if read-only, false if not).
2021 This uses the L<blockdev(8)> command.");
2023 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2024 [InitEmpty, Always, TestOutputInt (
2025 [["blockdev_getss"; "/dev/sda"]], 512)],
2026 "get sectorsize of block device",
2028 This returns the size of sectors on a block device.
2029 Usually 512, but can be larger for modern devices.
2031 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2034 This uses the L<blockdev(8)> command.");
2036 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2037 [InitEmpty, Always, TestOutputInt (
2038 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2039 "get blocksize of block device",
2041 This returns the block size of a device.
2043 (Note this is different from both I<size in blocks> and
2044 I<filesystem block size>).
2046 This uses the L<blockdev(8)> command.");
2048 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2050 "set blocksize of block device",
2052 This sets the block size of a device.
2054 (Note this is different from both I<size in blocks> and
2055 I<filesystem block size>).
2057 This uses the L<blockdev(8)> command.");
2059 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2060 [InitEmpty, Always, TestOutputInt (
2061 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2062 "get total size of device in 512-byte sectors",
2064 This returns the size of the device in units of 512-byte sectors
2065 (even if the sectorsize isn't 512 bytes ... weird).
2067 See also C<guestfs_blockdev_getss> for the real sector size of
2068 the device, and C<guestfs_blockdev_getsize64> for the more
2069 useful I<size in bytes>.
2071 This uses the L<blockdev(8)> command.");
2073 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2074 [InitEmpty, Always, TestOutputInt (
2075 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2076 "get total size of device in bytes",
2078 This returns the size of the device in bytes.
2080 See also C<guestfs_blockdev_getsz>.
2082 This uses the L<blockdev(8)> command.");
2084 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2085 [InitEmpty, Always, TestRun
2086 [["blockdev_flushbufs"; "/dev/sda"]]],
2087 "flush device buffers",
2089 This tells the kernel to flush internal buffers associated
2092 This uses the L<blockdev(8)> command.");
2094 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2095 [InitEmpty, Always, TestRun
2096 [["blockdev_rereadpt"; "/dev/sda"]]],
2097 "reread partition table",
2099 Reread the partition table on C<device>.
2101 This uses the L<blockdev(8)> command.");
2103 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2104 [InitBasicFS, Always, TestOutput (
2105 (* Pick a file from cwd which isn't likely to change. *)
2106 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2107 ["checksum"; "md5"; "/COPYING.LIB"]],
2108 Digest.to_hex (Digest.file "COPYING.LIB"))],
2109 "upload a file from the local machine",
2111 Upload local file C<filename> to C<remotefilename> on the
2114 C<filename> can also be a named pipe.
2116 See also C<guestfs_download>.");
2118 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2119 [InitBasicFS, Always, TestOutput (
2120 (* Pick a file from cwd which isn't likely to change. *)
2121 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2122 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2123 ["upload"; "testdownload.tmp"; "/upload"];
2124 ["checksum"; "md5"; "/upload"]],
2125 Digest.to_hex (Digest.file "COPYING.LIB"))],
2126 "download a file to the local machine",
2128 Download file C<remotefilename> and save it as C<filename>
2129 on the local machine.
2131 C<filename> can also be a named pipe.
2133 See also C<guestfs_upload>, C<guestfs_cat>.");
2135 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2136 [InitISOFS, Always, TestOutput (
2137 [["checksum"; "crc"; "/known-3"]], "2891671662");
2138 InitISOFS, Always, TestLastFail (
2139 [["checksum"; "crc"; "/notexists"]]);
2140 InitISOFS, Always, TestOutput (
2141 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2142 InitISOFS, Always, TestOutput (
2143 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2144 InitISOFS, Always, TestOutput (
2145 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2146 InitISOFS, Always, TestOutput (
2147 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2148 InitISOFS, Always, TestOutput (
2149 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2150 InitISOFS, Always, TestOutput (
2151 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2152 (* Test for RHBZ#579608, absolute symbolic links. *)
2153 InitISOFS, Always, TestOutput (
2154 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2155 "compute MD5, SHAx or CRC checksum of file",
2157 This call computes the MD5, SHAx or CRC checksum of the
2160 The type of checksum to compute is given by the C<csumtype>
2161 parameter which must have one of the following values:
2167 Compute the cyclic redundancy check (CRC) specified by POSIX
2168 for the C<cksum> command.
2172 Compute the MD5 hash (using the C<md5sum> program).
2176 Compute the SHA1 hash (using the C<sha1sum> program).
2180 Compute the SHA224 hash (using the C<sha224sum> program).
2184 Compute the SHA256 hash (using the C<sha256sum> program).
2188 Compute the SHA384 hash (using the C<sha384sum> program).
2192 Compute the SHA512 hash (using the C<sha512sum> program).
2196 The checksum is returned as a printable string.
2198 To get the checksum for a device, use C<guestfs_checksum_device>.
2200 To get the checksums for many files, use C<guestfs_checksums_out>.");
2202 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2203 [InitBasicFS, Always, TestOutput (
2204 [["tar_in"; "../images/helloworld.tar"; "/"];
2205 ["cat"; "/hello"]], "hello\n")],
2206 "unpack tarfile to directory",
2208 This command uploads and unpacks local file C<tarfile> (an
2209 I<uncompressed> tar file) into C<directory>.
2211 To upload a compressed tarball, use C<guestfs_tgz_in>
2212 or C<guestfs_txz_in>.");
2214 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2216 "pack directory into tarfile",
2218 This command packs the contents of C<directory> and downloads
2219 it to local file C<tarfile>.
2221 To download a compressed tarball, use C<guestfs_tgz_out>
2222 or C<guestfs_txz_out>.");
2224 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2225 [InitBasicFS, Always, TestOutput (
2226 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2227 ["cat"; "/hello"]], "hello\n")],
2228 "unpack compressed tarball to directory",
2230 This command uploads and unpacks local file C<tarball> (a
2231 I<gzip compressed> tar file) into C<directory>.
2233 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2235 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2237 "pack directory into compressed tarball",
2239 This command packs the contents of C<directory> and downloads
2240 it to local file C<tarball>.
2242 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2244 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2245 [InitBasicFS, Always, TestLastFail (
2247 ["mount_ro"; "/dev/sda1"; "/"];
2248 ["touch"; "/new"]]);
2249 InitBasicFS, Always, TestOutput (
2250 [["write"; "/new"; "data"];
2252 ["mount_ro"; "/dev/sda1"; "/"];
2253 ["cat"; "/new"]], "data")],
2254 "mount a guest disk, read-only",
2256 This is the same as the C<guestfs_mount> command, but it
2257 mounts the filesystem with the read-only (I<-o ro>) flag.");
2259 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2261 "mount a guest disk with mount options",
2263 This is the same as the C<guestfs_mount> command, but it
2264 allows you to set the mount options as for the
2265 L<mount(8)> I<-o> flag.
2267 If the C<options> parameter is an empty string, then
2268 no options are passed (all options default to whatever
2269 the filesystem uses).");
2271 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2273 "mount a guest disk with mount options and vfstype",
2275 This is the same as the C<guestfs_mount> command, but it
2276 allows you to set both the mount options and the vfstype
2277 as for the L<mount(8)> I<-o> and I<-t> flags.");
2279 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2281 "debugging and internals",
2283 The C<guestfs_debug> command exposes some internals of
2284 C<guestfsd> (the guestfs daemon) that runs inside the
2287 There is no comprehensive help for this command. You have
2288 to look at the file C<daemon/debug.c> in the libguestfs source
2289 to find out what you can do.");
2291 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2292 [InitEmpty, Always, TestOutputList (
2293 [["part_disk"; "/dev/sda"; "mbr"];
2294 ["pvcreate"; "/dev/sda1"];
2295 ["vgcreate"; "VG"; "/dev/sda1"];
2296 ["lvcreate"; "LV1"; "VG"; "50"];
2297 ["lvcreate"; "LV2"; "VG"; "50"];
2298 ["lvremove"; "/dev/VG/LV1"];
2299 ["lvs"]], ["/dev/VG/LV2"]);
2300 InitEmpty, Always, TestOutputList (
2301 [["part_disk"; "/dev/sda"; "mbr"];
2302 ["pvcreate"; "/dev/sda1"];
2303 ["vgcreate"; "VG"; "/dev/sda1"];
2304 ["lvcreate"; "LV1"; "VG"; "50"];
2305 ["lvcreate"; "LV2"; "VG"; "50"];
2306 ["lvremove"; "/dev/VG"];
2308 InitEmpty, Always, TestOutputList (
2309 [["part_disk"; "/dev/sda"; "mbr"];
2310 ["pvcreate"; "/dev/sda1"];
2311 ["vgcreate"; "VG"; "/dev/sda1"];
2312 ["lvcreate"; "LV1"; "VG"; "50"];
2313 ["lvcreate"; "LV2"; "VG"; "50"];
2314 ["lvremove"; "/dev/VG"];
2316 "remove an LVM logical volume",
2318 Remove an LVM logical volume C<device>, where C<device> is
2319 the path to the LV, such as C</dev/VG/LV>.
2321 You can also remove all LVs in a volume group by specifying
2322 the VG name, C</dev/VG>.");
2324 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2325 [InitEmpty, Always, TestOutputList (
2326 [["part_disk"; "/dev/sda"; "mbr"];
2327 ["pvcreate"; "/dev/sda1"];
2328 ["vgcreate"; "VG"; "/dev/sda1"];
2329 ["lvcreate"; "LV1"; "VG"; "50"];
2330 ["lvcreate"; "LV2"; "VG"; "50"];
2333 InitEmpty, Always, TestOutputList (
2334 [["part_disk"; "/dev/sda"; "mbr"];
2335 ["pvcreate"; "/dev/sda1"];
2336 ["vgcreate"; "VG"; "/dev/sda1"];
2337 ["lvcreate"; "LV1"; "VG"; "50"];
2338 ["lvcreate"; "LV2"; "VG"; "50"];
2341 "remove an LVM volume group",
2343 Remove an LVM volume group C<vgname>, (for example C<VG>).
2345 This also forcibly removes all logical volumes in the volume
2348 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2349 [InitEmpty, Always, TestOutputListOfDevices (
2350 [["part_disk"; "/dev/sda"; "mbr"];
2351 ["pvcreate"; "/dev/sda1"];
2352 ["vgcreate"; "VG"; "/dev/sda1"];
2353 ["lvcreate"; "LV1"; "VG"; "50"];
2354 ["lvcreate"; "LV2"; "VG"; "50"];
2356 ["pvremove"; "/dev/sda1"];
2358 InitEmpty, Always, TestOutputListOfDevices (
2359 [["part_disk"; "/dev/sda"; "mbr"];
2360 ["pvcreate"; "/dev/sda1"];
2361 ["vgcreate"; "VG"; "/dev/sda1"];
2362 ["lvcreate"; "LV1"; "VG"; "50"];
2363 ["lvcreate"; "LV2"; "VG"; "50"];
2365 ["pvremove"; "/dev/sda1"];
2367 InitEmpty, Always, TestOutputListOfDevices (
2368 [["part_disk"; "/dev/sda"; "mbr"];
2369 ["pvcreate"; "/dev/sda1"];
2370 ["vgcreate"; "VG"; "/dev/sda1"];
2371 ["lvcreate"; "LV1"; "VG"; "50"];
2372 ["lvcreate"; "LV2"; "VG"; "50"];
2374 ["pvremove"; "/dev/sda1"];
2376 "remove an LVM physical volume",
2378 This wipes a physical volume C<device> so that LVM will no longer
2381 The implementation uses the C<pvremove> command which refuses to
2382 wipe physical volumes that contain any volume groups, so you have
2383 to remove those first.");
2385 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2386 [InitBasicFS, Always, TestOutput (
2387 [["set_e2label"; "/dev/sda1"; "testlabel"];
2388 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2389 "set the ext2/3/4 filesystem label",
2391 This sets the ext2/3/4 filesystem label of the filesystem on
2392 C<device> to C<label>. Filesystem labels are limited to
2395 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2396 to return the existing label on a filesystem.");
2398 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2400 "get the ext2/3/4 filesystem label",
2402 This returns the ext2/3/4 filesystem label of the filesystem on
2405 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2406 (let uuid = uuidgen () in
2407 [InitBasicFS, Always, TestOutput (
2408 [["set_e2uuid"; "/dev/sda1"; uuid];
2409 ["get_e2uuid"; "/dev/sda1"]], uuid);
2410 InitBasicFS, Always, TestOutput (
2411 [["set_e2uuid"; "/dev/sda1"; "clear"];
2412 ["get_e2uuid"; "/dev/sda1"]], "");
2413 (* We can't predict what UUIDs will be, so just check the commands run. *)
2414 InitBasicFS, Always, TestRun (
2415 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2416 InitBasicFS, Always, TestRun (
2417 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2418 "set the ext2/3/4 filesystem UUID",
2420 This sets the ext2/3/4 filesystem UUID of the filesystem on
2421 C<device> to C<uuid>. The format of the UUID and alternatives
2422 such as C<clear>, C<random> and C<time> are described in the
2423 L<tune2fs(8)> manpage.
2425 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2426 to return the existing UUID of a filesystem.");
2428 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2429 (* Regression test for RHBZ#597112. *)
2430 (let uuid = uuidgen () in
2431 [InitBasicFS, Always, TestOutput (
2432 [["mke2journal"; "1024"; "/dev/sdb"];
2433 ["set_e2uuid"; "/dev/sdb"; uuid];
2434 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2435 "get the ext2/3/4 filesystem UUID",
2437 This returns the ext2/3/4 filesystem UUID of the filesystem on
2440 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2441 [InitBasicFS, Always, TestOutputInt (
2442 [["umount"; "/dev/sda1"];
2443 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2444 InitBasicFS, Always, TestOutputInt (
2445 [["umount"; "/dev/sda1"];
2446 ["zero"; "/dev/sda1"];
2447 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2448 "run the filesystem checker",
2450 This runs the filesystem checker (fsck) on C<device> which
2451 should have filesystem type C<fstype>.
2453 The returned integer is the status. See L<fsck(8)> for the
2454 list of status codes from C<fsck>.
2462 Multiple status codes can be summed together.
2466 A non-zero return code can mean \"success\", for example if
2467 errors have been corrected on the filesystem.
2471 Checking or repairing NTFS volumes is not supported
2476 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2478 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2479 [InitBasicFS, Always, TestOutput (
2480 [["umount"; "/dev/sda1"];
2481 ["zero"; "/dev/sda1"];
2482 ["file"; "/dev/sda1"]], "data")],
2483 "write zeroes to the device",
2485 This command writes zeroes over the first few blocks of C<device>.
2487 How many blocks are zeroed isn't specified (but it's I<not> enough
2488 to securely wipe the device). It should be sufficient to remove
2489 any partition tables, filesystem superblocks and so on.
2491 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2493 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2495 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2496 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2498 [InitBasicFS, Always, TestOutputTrue (
2499 [["mkdir_p"; "/boot/grub"];
2500 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2501 ["grub_install"; "/"; "/dev/vda"];
2502 ["is_dir"; "/boot"]])],
2505 This command installs GRUB (the Grand Unified Bootloader) on
2506 C<device>, with the root directory being C<root>.
2508 Note: If grub-install reports the error
2509 \"No suitable drive was found in the generated device map.\"
2510 it may be that you need to create a C</boot/grub/device.map>
2511 file first that contains the mapping between grub device names
2512 and Linux device names. It is usually sufficient to create
2517 replacing C</dev/vda> with the name of the installation device.");
2519 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2520 [InitBasicFS, Always, TestOutput (
2521 [["write"; "/old"; "file content"];
2522 ["cp"; "/old"; "/new"];
2523 ["cat"; "/new"]], "file content");
2524 InitBasicFS, Always, TestOutputTrue (
2525 [["write"; "/old"; "file content"];
2526 ["cp"; "/old"; "/new"];
2527 ["is_file"; "/old"]]);
2528 InitBasicFS, Always, TestOutput (
2529 [["write"; "/old"; "file content"];
2531 ["cp"; "/old"; "/dir/new"];
2532 ["cat"; "/dir/new"]], "file content")],
2535 This copies a file from C<src> to C<dest> where C<dest> is
2536 either a destination filename or destination directory.");
2538 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2539 [InitBasicFS, Always, TestOutput (
2540 [["mkdir"; "/olddir"];
2541 ["mkdir"; "/newdir"];
2542 ["write"; "/olddir/file"; "file content"];
2543 ["cp_a"; "/olddir"; "/newdir"];
2544 ["cat"; "/newdir/olddir/file"]], "file content")],
2545 "copy a file or directory recursively",
2547 This copies a file or directory from C<src> to C<dest>
2548 recursively using the C<cp -a> command.");
2550 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2551 [InitBasicFS, Always, TestOutput (
2552 [["write"; "/old"; "file content"];
2553 ["mv"; "/old"; "/new"];
2554 ["cat"; "/new"]], "file content");
2555 InitBasicFS, Always, TestOutputFalse (
2556 [["write"; "/old"; "file content"];
2557 ["mv"; "/old"; "/new"];
2558 ["is_file"; "/old"]])],
2561 This moves a file from C<src> to C<dest> where C<dest> is
2562 either a destination filename or destination directory.");
2564 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2565 [InitEmpty, Always, TestRun (
2566 [["drop_caches"; "3"]])],
2567 "drop kernel page cache, dentries and inodes",
2569 This instructs the guest kernel to drop its page cache,
2570 and/or dentries and inode caches. The parameter C<whattodrop>
2571 tells the kernel what precisely to drop, see
2572 L<http://linux-mm.org/Drop_Caches>
2574 Setting C<whattodrop> to 3 should drop everything.
2576 This automatically calls L<sync(2)> before the operation,
2577 so that the maximum guest memory is freed.");
2579 ("dmesg", (RString "kmsgs", [], []), 91, [],
2580 [InitEmpty, Always, TestRun (
2582 "return kernel messages",
2584 This returns the kernel messages (C<dmesg> output) from
2585 the guest kernel. This is sometimes useful for extended
2586 debugging of problems.
2588 Another way to get the same information is to enable
2589 verbose messages with C<guestfs_set_verbose> or by setting
2590 the environment variable C<LIBGUESTFS_DEBUG=1> before
2591 running the program.");
2593 ("ping_daemon", (RErr, [], []), 92, [],
2594 [InitEmpty, Always, TestRun (
2595 [["ping_daemon"]])],
2596 "ping the guest daemon",
2598 This is a test probe into the guestfs daemon running inside
2599 the qemu subprocess. Calling this function checks that the
2600 daemon responds to the ping message, without affecting the daemon
2601 or attached block device(s) in any other way.");
2603 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2604 [InitBasicFS, Always, TestOutputTrue (
2605 [["write"; "/file1"; "contents of a file"];
2606 ["cp"; "/file1"; "/file2"];
2607 ["equal"; "/file1"; "/file2"]]);
2608 InitBasicFS, Always, TestOutputFalse (
2609 [["write"; "/file1"; "contents of a file"];
2610 ["write"; "/file2"; "contents of another file"];
2611 ["equal"; "/file1"; "/file2"]]);
2612 InitBasicFS, Always, TestLastFail (
2613 [["equal"; "/file1"; "/file2"]])],
2614 "test if two files have equal contents",
2616 This compares the two files C<file1> and C<file2> and returns
2617 true if their content is exactly equal, or false otherwise.
2619 The external L<cmp(1)> program is used for the comparison.");
2621 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2622 [InitISOFS, Always, TestOutputList (
2623 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2624 InitISOFS, Always, TestOutputList (
2625 [["strings"; "/empty"]], []);
2626 (* Test for RHBZ#579608, absolute symbolic links. *)
2627 InitISOFS, Always, TestRun (
2628 [["strings"; "/abssymlink"]])],
2629 "print the printable strings in a file",
2631 This runs the L<strings(1)> command on a file and returns
2632 the list of printable strings found.");
2634 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2635 [InitISOFS, Always, TestOutputList (
2636 [["strings_e"; "b"; "/known-5"]], []);
2637 InitBasicFS, Always, TestOutputList (
2638 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2639 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2640 "print the printable strings in a file",
2642 This is like the C<guestfs_strings> command, but allows you to
2643 specify the encoding of strings that are looked for in
2644 the source file C<path>.
2646 Allowed encodings are:
2652 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2653 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2657 Single 8-bit-byte characters.
2661 16-bit big endian strings such as those encoded in
2662 UTF-16BE or UCS-2BE.
2664 =item l (lower case letter L)
2666 16-bit little endian such as UTF-16LE and UCS-2LE.
2667 This is useful for examining binaries in Windows guests.
2671 32-bit big endian such as UCS-4BE.
2675 32-bit little endian such as UCS-4LE.
2679 The returned strings are transcoded to UTF-8.");
2681 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2682 [InitISOFS, Always, TestOutput (
2683 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2684 (* Test for RHBZ#501888c2 regression which caused large hexdump
2685 * commands to segfault.
2687 InitISOFS, Always, TestRun (
2688 [["hexdump"; "/100krandom"]]);
2689 (* Test for RHBZ#579608, absolute symbolic links. *)
2690 InitISOFS, Always, TestRun (
2691 [["hexdump"; "/abssymlink"]])],
2692 "dump a file in hexadecimal",
2694 This runs C<hexdump -C> on the given C<path>. The result is
2695 the human-readable, canonical hex dump of the file.");
2697 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2698 [InitNone, Always, TestOutput (
2699 [["part_disk"; "/dev/sda"; "mbr"];
2700 ["mkfs"; "ext3"; "/dev/sda1"];
2701 ["mount_options"; ""; "/dev/sda1"; "/"];
2702 ["write"; "/new"; "test file"];
2703 ["umount"; "/dev/sda1"];
2704 ["zerofree"; "/dev/sda1"];
2705 ["mount_options"; ""; "/dev/sda1"; "/"];
2706 ["cat"; "/new"]], "test file")],
2707 "zero unused inodes and disk blocks on ext2/3 filesystem",
2709 This runs the I<zerofree> program on C<device>. This program
2710 claims to zero unused inodes and disk blocks on an ext2/3
2711 filesystem, thus making it possible to compress the filesystem
2714 You should B<not> run this program if the filesystem is
2717 It is possible that using this program can damage the filesystem
2718 or data on the filesystem.");
2720 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2722 "resize an LVM physical volume",
2724 This resizes (expands or shrinks) an existing LVM physical
2725 volume to match the new size of the underlying device.");
2727 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2728 Int "cyls"; Int "heads"; Int "sectors";
2729 String "line"], []), 99, [DangerWillRobinson],
2731 "modify a single partition on a block device",
2733 This runs L<sfdisk(8)> option to modify just the single
2734 partition C<n> (note: C<n> counts from 1).
2736 For other parameters, see C<guestfs_sfdisk>. You should usually
2737 pass C<0> for the cyls/heads/sectors parameters.
2739 See also: C<guestfs_part_add>");
2741 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2743 "display the partition table",
2745 This displays the partition table on C<device>, in the
2746 human-readable output of the L<sfdisk(8)> command. It is
2747 not intended to be parsed.
2749 See also: C<guestfs_part_list>");
2751 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2753 "display the kernel geometry",
2755 This displays the kernel's idea of the geometry of C<device>.
2757 The result is in human-readable format, and not designed to
2760 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2762 "display the disk geometry from the partition table",
2764 This displays the disk geometry of C<device> read from the
2765 partition table. Especially in the case where the underlying
2766 block device has been resized, this can be different from the
2767 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2769 The result is in human-readable format, and not designed to
2772 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2774 "activate or deactivate all volume groups",
2776 This command activates or (if C<activate> is false) deactivates
2777 all logical volumes in all volume groups.
2778 If activated, then they are made known to the
2779 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2780 then those devices disappear.
2782 This command is the same as running C<vgchange -a y|n>");
2784 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
2786 "activate or deactivate some volume groups",
2788 This command activates or (if C<activate> is false) deactivates
2789 all logical volumes in the listed volume groups C<volgroups>.
2790 If activated, then they are made known to the
2791 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2792 then those devices disappear.
2794 This command is the same as running C<vgchange -a y|n volgroups...>
2796 Note that if C<volgroups> is an empty list then B<all> volume groups
2797 are activated or deactivated.");
2799 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
2800 [InitNone, Always, TestOutput (
2801 [["part_disk"; "/dev/sda"; "mbr"];
2802 ["pvcreate"; "/dev/sda1"];
2803 ["vgcreate"; "VG"; "/dev/sda1"];
2804 ["lvcreate"; "LV"; "VG"; "10"];
2805 ["mkfs"; "ext2"; "/dev/VG/LV"];
2806 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2807 ["write"; "/new"; "test content"];
2809 ["lvresize"; "/dev/VG/LV"; "20"];
2810 ["e2fsck_f"; "/dev/VG/LV"];
2811 ["resize2fs"; "/dev/VG/LV"];
2812 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2813 ["cat"; "/new"]], "test content");
2814 InitNone, Always, TestRun (
2815 (* Make an LV smaller to test RHBZ#587484. *)
2816 [["part_disk"; "/dev/sda"; "mbr"];
2817 ["pvcreate"; "/dev/sda1"];
2818 ["vgcreate"; "VG"; "/dev/sda1"];
2819 ["lvcreate"; "LV"; "VG"; "20"];
2820 ["lvresize"; "/dev/VG/LV"; "10"]])],
2821 "resize an LVM logical volume",
2823 This resizes (expands or shrinks) an existing LVM logical
2824 volume to C<mbytes>. When reducing, data in the reduced part
2827 ("resize2fs", (RErr, [Device "device"], []), 106, [],
2828 [], (* lvresize tests this *)
2829 "resize an ext2, ext3 or ext4 filesystem",
2831 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2832 the underlying device.
2834 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2835 on the C<device> before calling this command. For unknown reasons
2836 C<resize2fs> sometimes gives an error about this and sometimes not.
2837 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2838 calling this function.");
2840 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
2841 [InitBasicFS, Always, TestOutputList (
2842 [["find"; "/"]], ["lost+found"]);
2843 InitBasicFS, Always, TestOutputList (
2847 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2848 InitBasicFS, Always, TestOutputList (
2849 [["mkdir_p"; "/a/b/c"];
2850 ["touch"; "/a/b/c/d"];
2851 ["find"; "/a/b/"]], ["c"; "c/d"])],
2852 "find all files and directories",
2854 This command lists out all files and directories, recursively,
2855 starting at C<directory>. It is essentially equivalent to
2856 running the shell command C<find directory -print> but some
2857 post-processing happens on the output, described below.
2859 This returns a list of strings I<without any prefix>. Thus
2860 if the directory structure was:
2866 then the returned list from C<guestfs_find> C</tmp> would be
2874 If C<directory> is not a directory, then this command returns
2877 The returned list is sorted.
2879 See also C<guestfs_find0>.");
2881 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
2882 [], (* lvresize tests this *)
2883 "check an ext2/ext3 filesystem",
2885 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2886 filesystem checker on C<device>, noninteractively (C<-p>),
2887 even if the filesystem appears to be clean (C<-f>).
2889 This command is only needed because of C<guestfs_resize2fs>
2890 (q.v.). Normally you should use C<guestfs_fsck>.");
2892 ("sleep", (RErr, [Int "secs"], []), 109, [],
2893 [InitNone, Always, TestRun (
2895 "sleep for some seconds",
2897 Sleep for C<secs> seconds.");
2899 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
2900 [InitNone, Always, TestOutputInt (
2901 [["part_disk"; "/dev/sda"; "mbr"];
2902 ["mkfs"; "ntfs"; "/dev/sda1"];
2903 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2904 InitNone, Always, TestOutputInt (
2905 [["part_disk"; "/dev/sda"; "mbr"];
2906 ["mkfs"; "ext2"; "/dev/sda1"];
2907 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2908 "probe NTFS volume",
2910 This command runs the L<ntfs-3g.probe(8)> command which probes
2911 an NTFS C<device> for mountability. (Not all NTFS volumes can
2912 be mounted read-write, and some cannot be mounted at all).
2914 C<rw> is a boolean flag. Set it to true if you want to test
2915 if the volume can be mounted read-write. Set it to false if
2916 you want to test if the volume can be mounted read-only.
2918 The return value is an integer which C<0> if the operation
2919 would succeed, or some non-zero value documented in the
2920 L<ntfs-3g.probe(8)> manual page.");
2922 ("sh", (RString "output", [String "command"], []), 111, [],
2923 [], (* XXX needs tests *)
2924 "run a command via the shell",
2926 This call runs a command from the guest filesystem via the
2929 This is like C<guestfs_command>, but passes the command to:
2931 /bin/sh -c \"command\"
2933 Depending on the guest's shell, this usually results in
2934 wildcards being expanded, shell expressions being interpolated
2937 All the provisos about C<guestfs_command> apply to this call.");
2939 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
2940 [], (* XXX needs tests *)
2941 "run a command via the shell returning lines",
2943 This is the same as C<guestfs_sh>, but splits the result
2944 into a list of lines.
2946 See also: C<guestfs_command_lines>");
2948 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
2949 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2950 * code in stubs.c, since all valid glob patterns must start with "/".
2951 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2953 [InitBasicFS, Always, TestOutputList (
2954 [["mkdir_p"; "/a/b/c"];
2955 ["touch"; "/a/b/c/d"];
2956 ["touch"; "/a/b/c/e"];
2957 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2958 InitBasicFS, Always, TestOutputList (
2959 [["mkdir_p"; "/a/b/c"];
2960 ["touch"; "/a/b/c/d"];
2961 ["touch"; "/a/b/c/e"];
2962 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2963 InitBasicFS, Always, TestOutputList (
2964 [["mkdir_p"; "/a/b/c"];
2965 ["touch"; "/a/b/c/d"];
2966 ["touch"; "/a/b/c/e"];
2967 ["glob_expand"; "/a/*/x/*"]], [])],
2968 "expand a wildcard path",
2970 This command searches for all the pathnames matching
2971 C<pattern> according to the wildcard expansion rules
2974 If no paths match, then this returns an empty list
2975 (note: not an error).
2977 It is just a wrapper around the C L<glob(3)> function
2978 with flags C<GLOB_MARK|GLOB_BRACE>.
2979 See that manual page for more details.");
2981 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
2982 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2983 [["scrub_device"; "/dev/sdc"]])],
2984 "scrub (securely wipe) a device",
2986 This command writes patterns over C<device> to make data retrieval
2989 It is an interface to the L<scrub(1)> program. See that
2990 manual page for more details.");
2992 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
2993 [InitBasicFS, Always, TestRun (
2994 [["write"; "/file"; "content"];
2995 ["scrub_file"; "/file"]])],
2996 "scrub (securely wipe) a file",
2998 This command writes patterns over a file to make data retrieval
3001 The file is I<removed> after scrubbing.
3003 It is an interface to the L<scrub(1)> program. See that
3004 manual page for more details.");
3006 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3007 [], (* XXX needs testing *)
3008 "scrub (securely wipe) free space",
3010 This command creates the directory C<dir> and then fills it
3011 with files until the filesystem is full, and scrubs the files
3012 as for C<guestfs_scrub_file>, and deletes them.
3013 The intention is to scrub any free space on the partition
3016 It is an interface to the L<scrub(1)> program. See that
3017 manual page for more details.");
3019 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3020 [InitBasicFS, Always, TestRun (
3022 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
3023 "create a temporary directory",
3025 This command creates a temporary directory. The
3026 C<template> parameter should be a full pathname for the
3027 temporary directory name with the final six characters being
3030 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3031 the second one being suitable for Windows filesystems.
3033 The name of the temporary directory that was created
3036 The temporary directory is created with mode 0700
3037 and is owned by root.
3039 The caller is responsible for deleting the temporary
3040 directory and its contents after use.
3042 See also: L<mkdtemp(3)>");
3044 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3045 [InitISOFS, Always, TestOutputInt (
3046 [["wc_l"; "/10klines"]], 10000);
3047 (* Test for RHBZ#579608, absolute symbolic links. *)
3048 InitISOFS, Always, TestOutputInt (
3049 [["wc_l"; "/abssymlink"]], 10000)],
3050 "count lines in a file",
3052 This command counts the lines in a file, using the
3053 C<wc -l> external command.");
3055 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3056 [InitISOFS, Always, TestOutputInt (
3057 [["wc_w"; "/10klines"]], 10000)],
3058 "count words in a file",
3060 This command counts the words in a file, using the
3061 C<wc -w> external command.");
3063 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3064 [InitISOFS, Always, TestOutputInt (
3065 [["wc_c"; "/100kallspaces"]], 102400)],
3066 "count characters in a file",
3068 This command counts the characters in a file, using the
3069 C<wc -c> external command.");
3071 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3072 [InitISOFS, Always, TestOutputList (
3073 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3074 (* Test for RHBZ#579608, absolute symbolic links. *)
3075 InitISOFS, Always, TestOutputList (
3076 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3077 "return first 10 lines of a file",
3079 This command returns up to the first 10 lines of a file as
3080 a list of strings.");
3082 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3083 [InitISOFS, Always, TestOutputList (
3084 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3085 InitISOFS, Always, TestOutputList (
3086 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3087 InitISOFS, Always, TestOutputList (
3088 [["head_n"; "0"; "/10klines"]], [])],
3089 "return first N lines of a file",
3091 If the parameter C<nrlines> is a positive number, this returns the first
3092 C<nrlines> lines of the file C<path>.
3094 If the parameter C<nrlines> is a negative number, this returns lines
3095 from the file C<path>, excluding the last C<nrlines> lines.
3097 If the parameter C<nrlines> is zero, this returns an empty list.");
3099 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3100 [InitISOFS, Always, TestOutputList (
3101 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3102 "return last 10 lines of a file",
3104 This command returns up to the last 10 lines of a file as
3105 a list of strings.");
3107 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3108 [InitISOFS, Always, TestOutputList (
3109 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3110 InitISOFS, Always, TestOutputList (
3111 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3112 InitISOFS, Always, TestOutputList (
3113 [["tail_n"; "0"; "/10klines"]], [])],
3114 "return last N lines of a file",
3116 If the parameter C<nrlines> is a positive number, this returns the last
3117 C<nrlines> lines of the file C<path>.
3119 If the parameter C<nrlines> is a negative number, this returns lines
3120 from the file C<path>, starting with the C<-nrlines>th line.
3122 If the parameter C<nrlines> is zero, this returns an empty list.");
3124 ("df", (RString "output", [], []), 125, [],
3125 [], (* XXX Tricky to test because it depends on the exact format
3126 * of the 'df' command and other imponderables.
3128 "report file system disk space usage",
3130 This command runs the C<df> command to report disk space used.
3132 This command is mostly useful for interactive sessions. It
3133 is I<not> intended that you try to parse the output string.
3134 Use C<statvfs> from programs.");
3136 ("df_h", (RString "output", [], []), 126, [],
3137 [], (* XXX Tricky to test because it depends on the exact format
3138 * of the 'df' command and other imponderables.
3140 "report file system disk space usage (human readable)",
3142 This command runs the C<df -h> command to report disk space used
3143 in human-readable format.
3145 This command is mostly useful for interactive sessions. It
3146 is I<not> intended that you try to parse the output string.
3147 Use C<statvfs> from programs.");
3149 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3150 [InitISOFS, Always, TestOutputInt (
3151 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3152 "estimate file space usage",
3154 This command runs the C<du -s> command to estimate file space
3157 C<path> can be a file or a directory. If C<path> is a directory
3158 then the estimate includes the contents of the directory and all
3159 subdirectories (recursively).
3161 The result is the estimated size in I<kilobytes>
3162 (ie. units of 1024 bytes).");
3164 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3165 [InitISOFS, Always, TestOutputList (
3166 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3167 "list files in an initrd",
3169 This command lists out files contained in an initrd.
3171 The files are listed without any initial C</> character. The
3172 files are listed in the order they appear (not necessarily
3173 alphabetical). Directory names are listed as separate items.
3175 Old Linux kernels (2.4 and earlier) used a compressed ext2
3176 filesystem as initrd. We I<only> support the newer initramfs
3177 format (compressed cpio files).");
3179 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3181 "mount a file using the loop device",
3183 This command lets you mount C<file> (a filesystem image
3184 in a file) on a mount point. It is entirely equivalent to
3185 the command C<mount -o loop file mountpoint>.");
3187 ("mkswap", (RErr, [Device "device"], []), 130, [],
3188 [InitEmpty, Always, TestRun (
3189 [["part_disk"; "/dev/sda"; "mbr"];
3190 ["mkswap"; "/dev/sda1"]])],
3191 "create a swap partition",
3193 Create a swap partition on C<device>.");
3195 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3196 [InitEmpty, Always, TestRun (
3197 [["part_disk"; "/dev/sda"; "mbr"];
3198 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3199 "create a swap partition with a label",
3201 Create a swap partition on C<device> with label C<label>.
3203 Note that you cannot attach a swap label to a block device
3204 (eg. C</dev/sda>), just to a partition. This appears to be
3205 a limitation of the kernel or swap tools.");
3207 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3208 (let uuid = uuidgen () in
3209 [InitEmpty, Always, TestRun (
3210 [["part_disk"; "/dev/sda"; "mbr"];
3211 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3212 "create a swap partition with an explicit UUID",
3214 Create a swap partition on C<device> with UUID C<uuid>.");
3216 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3217 [InitBasicFS, Always, TestOutputStruct (
3218 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3219 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3220 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3221 InitBasicFS, Always, TestOutputStruct (
3222 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3223 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3224 "make block, character or FIFO devices",
3226 This call creates block or character special devices, or
3227 named pipes (FIFOs).
3229 The C<mode> parameter should be the mode, using the standard
3230 constants. C<devmajor> and C<devminor> are the
3231 device major and minor numbers, only used when creating block
3232 and character special devices.
3234 Note that, just like L<mknod(2)>, the mode must be bitwise
3235 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3236 just creates a regular file). These constants are
3237 available in the standard Linux header files, or you can use
3238 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3239 which are wrappers around this command which bitwise OR
3240 in the appropriate constant for you.
3242 The mode actually set is affected by the umask.");
3244 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3245 [InitBasicFS, Always, TestOutputStruct (
3246 [["mkfifo"; "0o777"; "/node"];
3247 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3248 "make FIFO (named pipe)",
3250 This call creates a FIFO (named pipe) called C<path> with
3251 mode C<mode>. It is just a convenient wrapper around
3254 The mode actually set is affected by the umask.");
3256 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3257 [InitBasicFS, Always, TestOutputStruct (
3258 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3259 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3260 "make block device node",
3262 This call creates a block device node called C<path> with
3263 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3264 It is just a convenient wrapper around C<guestfs_mknod>.
3266 The mode actually set is affected by the umask.");
3268 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3269 [InitBasicFS, Always, TestOutputStruct (
3270 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3271 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3272 "make char device node",
3274 This call creates a char device node called C<path> with
3275 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3276 It is just a convenient wrapper around C<guestfs_mknod>.
3278 The mode actually set is affected by the umask.");
3280 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3281 [InitEmpty, Always, TestOutputInt (
3282 [["umask"; "0o22"]], 0o22)],
3283 "set file mode creation mask (umask)",
3285 This function sets the mask used for creating new files and
3286 device nodes to C<mask & 0777>.
3288 Typical umask values would be C<022> which creates new files
3289 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3290 C<002> which creates new files with permissions like
3291 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3293 The default umask is C<022>. This is important because it
3294 means that directories and device nodes will be created with
3295 C<0644> or C<0755> mode even if you specify C<0777>.
3297 See also C<guestfs_get_umask>,
3298 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3300 This call returns the previous umask.");
3302 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3304 "read directories entries",
3306 This returns the list of directory entries in directory C<dir>.
3308 All entries in the directory are returned, including C<.> and
3309 C<..>. The entries are I<not> sorted, but returned in the same
3310 order as the underlying filesystem.
3312 Also this call returns basic file type information about each
3313 file. The C<ftyp> field will contain one of the following characters:
3351 The L<readdir(3)> call returned a C<d_type> field with an
3356 This function is primarily intended for use by programs. To
3357 get a simple list of names, use C<guestfs_ls>. To get a printable
3358 directory for human consumption, use C<guestfs_ll>.");
3360 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3362 "create partitions on a block device",
3364 This is a simplified interface to the C<guestfs_sfdisk>
3365 command, where partition sizes are specified in megabytes
3366 only (rounded to the nearest cylinder) and you don't need
3367 to specify the cyls, heads and sectors parameters which
3368 were rarely if ever used anyway.
3370 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3371 and C<guestfs_part_disk>");
3373 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3375 "determine file type inside a compressed file",
3377 This command runs C<file> after first decompressing C<path>
3380 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3382 Since 1.0.63, use C<guestfs_file> instead which can now
3383 process compressed files.");
3385 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3387 "list extended attributes of a file or directory",
3389 This call lists the extended attributes of the file or directory
3392 At the system call level, this is a combination of the
3393 L<listxattr(2)> and L<getxattr(2)> calls.
3395 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3397 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3399 "list extended attributes of a file or directory",
3401 This is the same as C<guestfs_getxattrs>, but if C<path>
3402 is a symbolic link, then it returns the extended attributes
3403 of the link itself.");
3405 ("setxattr", (RErr, [String "xattr";
3406 String "val"; Int "vallen"; (* will be BufferIn *)
3407 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3409 "set extended attribute of a file or directory",
3411 This call sets the extended attribute named C<xattr>
3412 of the file C<path> to the value C<val> (of length C<vallen>).
3413 The value is arbitrary 8 bit data.
3415 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3417 ("lsetxattr", (RErr, [String "xattr";
3418 String "val"; Int "vallen"; (* will be BufferIn *)
3419 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3421 "set extended attribute of a file or directory",
3423 This is the same as C<guestfs_setxattr>, but if C<path>
3424 is a symbolic link, then it sets an extended attribute
3425 of the link itself.");
3427 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3429 "remove extended attribute of a file or directory",
3431 This call removes the extended attribute named C<xattr>
3432 of the file C<path>.
3434 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3436 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3438 "remove extended attribute of a file or directory",
3440 This is the same as C<guestfs_removexattr>, but if C<path>
3441 is a symbolic link, then it removes an extended attribute
3442 of the link itself.");
3444 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3448 This call is similar to C<guestfs_mounts>. That call returns
3449 a list of devices. This one returns a hash table (map) of
3450 device name to directory where the device is mounted.");
3452 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3453 (* This is a special case: while you would expect a parameter
3454 * of type "Pathname", that doesn't work, because it implies
3455 * NEED_ROOT in the generated calling code in stubs.c, and
3456 * this function cannot use NEED_ROOT.
3459 "create a mountpoint",
3461 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3462 specialized calls that can be used to create extra mountpoints
3463 before mounting the first filesystem.
3465 These calls are I<only> necessary in some very limited circumstances,
3466 mainly the case where you want to mount a mix of unrelated and/or
3467 read-only filesystems together.
3469 For example, live CDs often contain a \"Russian doll\" nest of
3470 filesystems, an ISO outer layer, with a squashfs image inside, with
3471 an ext2/3 image inside that. You can unpack this as follows
3474 add-ro Fedora-11-i686-Live.iso
3478 mkmountpoint /ext3fs
3480 mount-loop /cd/LiveOS/squashfs.img /sqsh
3481 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3483 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3485 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3486 You may get unexpected errors if you try to mix these calls. It is
3487 safest to manually unmount filesystems and remove mountpoints after use.
3489 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3490 longest first, so for this to work for manual mountpoints, you
3491 must ensure that the innermost mountpoints have the longest
3492 pathnames, as in the example code above.
3494 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3496 Autosync [see C<guestfs_set_autosync>, this is set by default on
3497 handles] means that C<guestfs_umount_all> is called when the handle
3498 is closed which can also trigger these issues.");
3500 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3502 "remove a mountpoint",
3504 This calls removes a mountpoint that was previously created
3505 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3506 for full details.");
3508 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3509 [InitISOFS, Always, TestOutputBuffer (
3510 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3511 (* Test various near large, large and too large files (RHBZ#589039). *)
3512 InitBasicFS, Always, TestLastFail (
3514 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3515 ["read_file"; "/a"]]);
3516 InitBasicFS, Always, TestLastFail (
3518 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3519 ["read_file"; "/a"]]);
3520 InitBasicFS, Always, TestLastFail (
3522 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3523 ["read_file"; "/a"]])],
3526 This calls returns the contents of the file C<path> as a
3529 Unlike C<guestfs_cat>, this function can correctly
3530 handle files that contain embedded ASCII NUL characters.
3531 However unlike C<guestfs_download>, this function is limited
3532 in the total size of file that can be handled.");
3534 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3535 [InitISOFS, Always, TestOutputList (
3536 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3537 InitISOFS, Always, TestOutputList (
3538 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3539 (* Test for RHBZ#579608, absolute symbolic links. *)
3540 InitISOFS, Always, TestOutputList (
3541 [["grep"; "nomatch"; "/abssymlink"]], [])],
3542 "return lines matching a pattern",
3544 This calls the external C<grep> program and returns the
3547 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3548 [InitISOFS, Always, TestOutputList (
3549 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3550 "return lines matching a pattern",
3552 This calls the external C<egrep> program and returns the
3555 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3556 [InitISOFS, Always, TestOutputList (
3557 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3558 "return lines matching a pattern",
3560 This calls the external C<fgrep> program and returns the
3563 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3564 [InitISOFS, Always, TestOutputList (
3565 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3566 "return lines matching a pattern",
3568 This calls the external C<grep -i> program and returns the
3571 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3572 [InitISOFS, Always, TestOutputList (
3573 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3574 "return lines matching a pattern",
3576 This calls the external C<egrep -i> program and returns the
3579 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3580 [InitISOFS, Always, TestOutputList (
3581 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3582 "return lines matching a pattern",
3584 This calls the external C<fgrep -i> program and returns the
3587 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3588 [InitISOFS, Always, TestOutputList (
3589 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3590 "return lines matching a pattern",
3592 This calls the external C<zgrep> program and returns the
3595 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3596 [InitISOFS, Always, TestOutputList (
3597 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3598 "return lines matching a pattern",
3600 This calls the external C<zegrep> program and returns the
3603 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3604 [InitISOFS, Always, TestOutputList (
3605 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3606 "return lines matching a pattern",
3608 This calls the external C<zfgrep> program and returns the
3611 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3612 [InitISOFS, Always, TestOutputList (
3613 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3614 "return lines matching a pattern",
3616 This calls the external C<zgrep -i> program and returns the
3619 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3620 [InitISOFS, Always, TestOutputList (
3621 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3622 "return lines matching a pattern",
3624 This calls the external C<zegrep -i> program and returns the
3627 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3628 [InitISOFS, Always, TestOutputList (
3629 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3630 "return lines matching a pattern",
3632 This calls the external C<zfgrep -i> program and returns the
3635 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3636 [InitISOFS, Always, TestOutput (
3637 [["realpath"; "/../directory"]], "/directory")],
3638 "canonicalized absolute pathname",
3640 Return the canonicalized absolute pathname of C<path>. The
3641 returned path has no C<.>, C<..> or symbolic link path elements.");
3643 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3644 [InitBasicFS, Always, TestOutputStruct (
3647 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3648 "create a hard link",
3650 This command creates a hard link using the C<ln> command.");
3652 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3653 [InitBasicFS, Always, TestOutputStruct (
3656 ["ln_f"; "/a"; "/b"];
3657 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3658 "create a hard link",
3660 This command creates a hard link using the C<ln -f> command.
3661 The C<-f> option removes the link (C<linkname>) if it exists already.");
3663 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3664 [InitBasicFS, Always, TestOutputStruct (
3666 ["ln_s"; "a"; "/b"];
3667 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3668 "create a symbolic link",
3670 This command creates a symbolic link using the C<ln -s> command.");
3672 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3673 [InitBasicFS, Always, TestOutput (
3674 [["mkdir_p"; "/a/b"];
3675 ["touch"; "/a/b/c"];
3676 ["ln_sf"; "../d"; "/a/b/c"];
3677 ["readlink"; "/a/b/c"]], "../d")],
3678 "create a symbolic link",
3680 This command creates a symbolic link using the C<ln -sf> command,
3681 The C<-f> option removes the link (C<linkname>) if it exists already.");
3683 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3684 [] (* XXX tested above *),
3685 "read the target of a symbolic link",
3687 This command reads the target of a symbolic link.");
3689 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3690 [InitBasicFS, Always, TestOutputStruct (
3691 [["fallocate"; "/a"; "1000000"];
3692 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3693 "preallocate a file in the guest filesystem",
3695 This command preallocates a file (containing zero bytes) named
3696 C<path> of size C<len> bytes. If the file exists already, it
3699 Do not confuse this with the guestfish-specific
3700 C<alloc> command which allocates a file in the host and
3701 attaches it as a device.");
3703 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3704 [InitPartition, Always, TestRun (
3705 [["mkswap"; "/dev/sda1"];
3706 ["swapon_device"; "/dev/sda1"];
3707 ["swapoff_device"; "/dev/sda1"]])],
3708 "enable swap on device",
3710 This command enables the libguestfs appliance to use the
3711 swap device or partition named C<device>. The increased
3712 memory is made available for all commands, for example
3713 those run using C<guestfs_command> or C<guestfs_sh>.
3715 Note that you should not swap to existing guest swap
3716 partitions unless you know what you are doing. They may
3717 contain hibernation information, or other information that
3718 the guest doesn't want you to trash. You also risk leaking
3719 information about the host to the guest this way. Instead,
3720 attach a new host device to the guest and swap on that.");
3722 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3723 [], (* XXX tested by swapon_device *)
3724 "disable swap on device",
3726 This command disables the libguestfs appliance swap
3727 device or partition named C<device>.
3728 See C<guestfs_swapon_device>.");
3730 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3731 [InitBasicFS, Always, TestRun (
3732 [["fallocate"; "/swap"; "8388608"];
3733 ["mkswap_file"; "/swap"];
3734 ["swapon_file"; "/swap"];
3735 ["swapoff_file"; "/swap"]])],
3736 "enable swap on file",
3738 This command enables swap to a file.
3739 See C<guestfs_swapon_device> for other notes.");
3741 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3742 [], (* XXX tested by swapon_file *)
3743 "disable swap on file",
3745 This command disables the libguestfs appliance swap on file.");
3747 ("swapon_label", (RErr, [String "label"], []), 174, [],
3748 [InitEmpty, Always, TestRun (
3749 [["part_disk"; "/dev/sdb"; "mbr"];
3750 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3751 ["swapon_label"; "swapit"];
3752 ["swapoff_label"; "swapit"];
3753 ["zero"; "/dev/sdb"];
3754 ["blockdev_rereadpt"; "/dev/sdb"]])],
3755 "enable swap on labeled swap partition",
3757 This command enables swap to a labeled swap partition.
3758 See C<guestfs_swapon_device> for other notes.");
3760 ("swapoff_label", (RErr, [String "label"], []), 175, [],
3761 [], (* XXX tested by swapon_label *)
3762 "disable swap on labeled swap partition",
3764 This command disables the libguestfs appliance swap on
3765 labeled swap partition.");
3767 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3768 (let uuid = uuidgen () in
3769 [InitEmpty, Always, TestRun (
3770 [["mkswap_U"; uuid; "/dev/sdb"];
3771 ["swapon_uuid"; uuid];
3772 ["swapoff_uuid"; uuid]])]),
3773 "enable swap on swap partition by UUID",
3775 This command enables swap to a swap partition with the given UUID.
3776 See C<guestfs_swapon_device> for other notes.");
3778 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3779 [], (* XXX tested by swapon_uuid *)
3780 "disable swap on swap partition by UUID",
3782 This command disables the libguestfs appliance swap partition
3783 with the given UUID.");
3785 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
3786 [InitBasicFS, Always, TestRun (
3787 [["fallocate"; "/swap"; "8388608"];
3788 ["mkswap_file"; "/swap"]])],
3789 "create a swap file",
3793 This command just writes a swap file signature to an existing
3794 file. To create the file itself, use something like C<guestfs_fallocate>.");
3796 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
3797 [InitISOFS, Always, TestRun (
3798 [["inotify_init"; "0"]])],
3799 "create an inotify handle",
3801 This command creates a new inotify handle.
3802 The inotify subsystem can be used to notify events which happen to
3803 objects in the guest filesystem.
3805 C<maxevents> is the maximum number of events which will be
3806 queued up between calls to C<guestfs_inotify_read> or
3807 C<guestfs_inotify_files>.
3808 If this is passed as C<0>, then the kernel (or previously set)
3809 default is used. For Linux 2.6.29 the default was 16384 events.
3810 Beyond this limit, the kernel throws away events, but records
3811 the fact that it threw them away by setting a flag
3812 C<IN_Q_OVERFLOW> in the returned structure list (see
3813 C<guestfs_inotify_read>).
3815 Before any events are generated, you have to add some
3816 watches to the internal watch list. See:
3817 C<guestfs_inotify_add_watch>,
3818 C<guestfs_inotify_rm_watch> and
3819 C<guestfs_inotify_watch_all>.
3821 Queued up events should be read periodically by calling
3822 C<guestfs_inotify_read>
3823 (or C<guestfs_inotify_files> which is just a helpful
3824 wrapper around C<guestfs_inotify_read>). If you don't
3825 read the events out often enough then you risk the internal
3828 The handle should be closed after use by calling
3829 C<guestfs_inotify_close>. This also removes any
3830 watches automatically.
3832 See also L<inotify(7)> for an overview of the inotify interface
3833 as exposed by the Linux kernel, which is roughly what we expose
3834 via libguestfs. Note that there is one global inotify handle
3835 per libguestfs instance.");
3837 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
3838 [InitBasicFS, Always, TestOutputList (
3839 [["inotify_init"; "0"];
3840 ["inotify_add_watch"; "/"; "1073741823"];
3843 ["inotify_files"]], ["a"; "b"])],
3844 "add an inotify watch",
3846 Watch C<path> for the events listed in C<mask>.
3848 Note that if C<path> is a directory then events within that
3849 directory are watched, but this does I<not> happen recursively
3850 (in subdirectories).
3852 Note for non-C or non-Linux callers: the inotify events are
3853 defined by the Linux kernel ABI and are listed in
3854 C</usr/include/sys/inotify.h>.");
3856 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
3858 "remove an inotify watch",
3860 Remove a previously defined inotify watch.
3861 See C<guestfs_inotify_add_watch>.");
3863 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
3865 "return list of inotify events",
3867 Return the complete queue of events that have happened
3868 since the previous read call.
3870 If no events have happened, this returns an empty list.
3872 I<Note>: In order to make sure that all events have been
3873 read, you must call this function repeatedly until it
3874 returns an empty list. The reason is that the call will
3875 read events up to the maximum appliance-to-host message
3876 size and leave remaining events in the queue.");
3878 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
3880 "return list of watched files that had events",
3882 This function is a helpful wrapper around C<guestfs_inotify_read>
3883 which just returns a list of pathnames of objects that were
3884 touched. The returned pathnames are sorted and deduplicated.");
3886 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
3888 "close the inotify handle",
3890 This closes the inotify handle which was previously
3891 opened by inotify_init. It removes all watches, throws
3892 away any pending events, and deallocates all resources.");
3894 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
3896 "set SELinux security context",
3898 This sets the SELinux security context of the daemon
3899 to the string C<context>.
3901 See the documentation about SELINUX in L<guestfs(3)>.");
3903 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
3905 "get SELinux security context",
3907 This gets the SELinux security context of the daemon.
3909 See the documentation about SELINUX in L<guestfs(3)>,
3910 and C<guestfs_setcon>");
3912 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
3913 [InitEmpty, Always, TestOutput (
3914 [["part_disk"; "/dev/sda"; "mbr"];
3915 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3916 ["mount_options"; ""; "/dev/sda1"; "/"];
3917 ["write"; "/new"; "new file contents"];
3918 ["cat"; "/new"]], "new file contents");
3919 InitEmpty, Always, TestRun (
3920 [["part_disk"; "/dev/sda"; "mbr"];
3921 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3922 InitEmpty, Always, TestLastFail (
3923 [["part_disk"; "/dev/sda"; "mbr"];
3924 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3925 InitEmpty, Always, TestLastFail (
3926 [["part_disk"; "/dev/sda"; "mbr"];
3927 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3928 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3929 [["part_disk"; "/dev/sda"; "mbr"];
3930 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3931 "make a filesystem with block size",
3933 This call is similar to C<guestfs_mkfs>, but it allows you to
3934 control the block size of the resulting filesystem. Supported
3935 block sizes depend on the filesystem type, but typically they
3936 are C<1024>, C<2048> or C<4096> only.
3938 For VFAT and NTFS the C<blocksize> parameter is treated as
3939 the requested cluster size.");
3941 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
3942 [InitEmpty, Always, TestOutput (
3943 [["part_init"; "/dev/sda"; "mbr"];
3944 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
3945 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
3946 ["mke2journal"; "4096"; "/dev/sda1"];
3947 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3948 ["mount_options"; ""; "/dev/sda2"; "/"];
3949 ["write"; "/new"; "new file contents"];
3950 ["cat"; "/new"]], "new file contents")],
3951 "make ext2/3/4 external journal",
3953 This creates an ext2 external journal on C<device>. It is equivalent
3956 mke2fs -O journal_dev -b blocksize device");
3958 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
3959 [InitEmpty, Always, TestOutput (
3960 [["part_init"; "/dev/sda"; "mbr"];
3961 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
3962 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
3963 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3964 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3965 ["mount_options"; ""; "/dev/sda2"; "/"];
3966 ["write"; "/new"; "new file contents"];
3967 ["cat"; "/new"]], "new file contents")],
3968 "make ext2/3/4 external journal with label",
3970 This creates an ext2 external journal on C<device> with label C<label>.");
3972 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
3973 (let uuid = uuidgen () in
3974 [InitEmpty, Always, TestOutput (
3975 [["part_init"; "/dev/sda"; "mbr"];
3976 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
3977 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
3978 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3979 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3980 ["mount_options"; ""; "/dev/sda2"; "/"];
3981 ["write"; "/new"; "new file contents"];
3982 ["cat"; "/new"]], "new file contents")]),
3983 "make ext2/3/4 external journal with UUID",
3985 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3987 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
3989 "make ext2/3/4 filesystem with external journal",
3991 This creates an ext2/3/4 filesystem on C<device> with
3992 an external journal on C<journal>. It is equivalent
3995 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3997 See also C<guestfs_mke2journal>.");
3999 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4001 "make ext2/3/4 filesystem with external journal",
4003 This creates an ext2/3/4 filesystem on C<device> with
4004 an external journal on the journal labeled C<label>.
4006 See also C<guestfs_mke2journal_L>.");
4008 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4010 "make ext2/3/4 filesystem with external journal",
4012 This creates an ext2/3/4 filesystem on C<device> with
4013 an external journal on the journal with UUID C<uuid>.
4015 See also C<guestfs_mke2journal_U>.");
4017 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4018 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4019 "load a kernel module",
4021 This loads a kernel module in the appliance.
4023 The kernel module must have been whitelisted when libguestfs
4024 was built (see C<appliance/kmod.whitelist.in> in the source).");
4026 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4027 [InitNone, Always, TestOutput (
4028 [["echo_daemon"; "This is a test"]], "This is a test"
4030 "echo arguments back to the client",
4032 This command concatenates the list of C<words> passed with single spaces
4033 between them and returns the resulting string.
4035 You can use this command to test the connection through to the daemon.
4037 See also C<guestfs_ping_daemon>.");
4039 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4040 [], (* There is a regression test for this. *)
4041 "find all files and directories, returning NUL-separated list",
4043 This command lists out all files and directories, recursively,
4044 starting at C<directory>, placing the resulting list in the
4045 external file called C<files>.
4047 This command works the same way as C<guestfs_find> with the
4048 following exceptions:
4054 The resulting list is written to an external file.
4058 Items (filenames) in the result are separated
4059 by C<\\0> characters. See L<find(1)> option I<-print0>.
4063 This command is not limited in the number of names that it
4068 The result list is not sorted.
4072 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4073 [InitISOFS, Always, TestOutput (
4074 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4075 InitISOFS, Always, TestOutput (
4076 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4077 InitISOFS, Always, TestOutput (
4078 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4079 InitISOFS, Always, TestLastFail (
4080 [["case_sensitive_path"; "/Known-1/"]]);
4081 InitBasicFS, Always, TestOutput (
4083 ["mkdir"; "/a/bbb"];
4084 ["touch"; "/a/bbb/c"];
4085 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4086 InitBasicFS, Always, TestOutput (
4088 ["mkdir"; "/a/bbb"];
4089 ["touch"; "/a/bbb/c"];
4090 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4091 InitBasicFS, Always, TestLastFail (
4093 ["mkdir"; "/a/bbb"];
4094 ["touch"; "/a/bbb/c"];
4095 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4096 "return true path on case-insensitive filesystem",
4098 This can be used to resolve case insensitive paths on
4099 a filesystem which is case sensitive. The use case is
4100 to resolve paths which you have read from Windows configuration
4101 files or the Windows Registry, to the true path.
4103 The command handles a peculiarity of the Linux ntfs-3g
4104 filesystem driver (and probably others), which is that although
4105 the underlying filesystem is case-insensitive, the driver
4106 exports the filesystem to Linux as case-sensitive.
4108 One consequence of this is that special directories such
4109 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4110 (or other things) depending on the precise details of how
4111 they were created. In Windows itself this would not be
4114 Bug or feature? You decide:
4115 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4117 This function resolves the true case of each element in the
4118 path and returns the case-sensitive path.
4120 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4121 might return C<\"/WINDOWS/system32\"> (the exact return value
4122 would depend on details of how the directories were originally
4123 created under Windows).
4126 This function does not handle drive names, backslashes etc.
4128 See also C<guestfs_realpath>.");
4130 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4131 [InitBasicFS, Always, TestOutput (
4132 [["vfs_type"; "/dev/sda1"]], "ext2")],
4133 "get the Linux VFS type corresponding to a mounted device",
4135 This command gets the filesystem type corresponding to
4136 the filesystem on C<device>.
4138 For most filesystems, the result is the name of the Linux
4139 VFS module which would be used to mount this filesystem
4140 if you mounted it without specifying the filesystem type.
4141 For example a string such as C<ext3> or C<ntfs>.");
4143 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4144 [InitBasicFS, Always, TestOutputStruct (
4145 [["write"; "/test"; "some stuff so size is not zero"];
4146 ["truncate"; "/test"];
4147 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4148 "truncate a file to zero size",
4150 This command truncates C<path> to a zero-length file. The
4151 file must exist already.");
4153 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4154 [InitBasicFS, Always, TestOutputStruct (
4155 [["touch"; "/test"];
4156 ["truncate_size"; "/test"; "1000"];
4157 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4158 "truncate a file to a particular size",
4160 This command truncates C<path> to size C<size> bytes. The file
4163 If the current file size is less than C<size> then
4164 the file is extended to the required size with zero bytes.
4165 This creates a sparse file (ie. disk blocks are not allocated
4166 for the file until you write to it). To create a non-sparse
4167 file of zeroes, use C<guestfs_fallocate64> instead.");
4169 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4170 [InitBasicFS, Always, TestOutputStruct (
4171 [["touch"; "/test"];
4172 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4173 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4174 "set timestamp of a file with nanosecond precision",
4176 This command sets the timestamps of a file with nanosecond
4179 C<atsecs, atnsecs> are the last access time (atime) in secs and
4180 nanoseconds from the epoch.
4182 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4183 secs and nanoseconds from the epoch.
4185 If the C<*nsecs> field contains the special value C<-1> then
4186 the corresponding timestamp is set to the current time. (The
4187 C<*secs> field is ignored in this case).
4189 If the C<*nsecs> field contains the special value C<-2> then
4190 the corresponding timestamp is left unchanged. (The
4191 C<*secs> field is ignored in this case).");
4193 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4194 [InitBasicFS, Always, TestOutputStruct (
4195 [["mkdir_mode"; "/test"; "0o111"];
4196 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4197 "create a directory with a particular mode",
4199 This command creates a directory, setting the initial permissions
4200 of the directory to C<mode>.
4202 For common Linux filesystems, the actual mode which is set will
4203 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4204 interpret the mode in other ways.
4206 See also C<guestfs_mkdir>, C<guestfs_umask>");
4208 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4210 "change file owner and group",
4212 Change the file owner to C<owner> and group to C<group>.
4213 This is like C<guestfs_chown> but if C<path> is a symlink then
4214 the link itself is changed, not the target.
4216 Only numeric uid and gid are supported. If you want to use
4217 names, you will need to locate and parse the password file
4218 yourself (Augeas support makes this relatively easy).");
4220 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4222 "lstat on multiple files",
4224 This call allows you to perform the C<guestfs_lstat> operation
4225 on multiple files, where all files are in the directory C<path>.
4226 C<names> is the list of files from this directory.
4228 On return you get a list of stat structs, with a one-to-one
4229 correspondence to the C<names> list. If any name did not exist
4230 or could not be lstat'd, then the C<ino> field of that structure
4233 This call is intended for programs that want to efficiently
4234 list a directory contents without making many round-trips.
4235 See also C<guestfs_lxattrlist> for a similarly efficient call
4236 for getting extended attributes. Very long directory listings
4237 might cause the protocol message size to be exceeded, causing
4238 this call to fail. The caller must split up such requests
4239 into smaller groups of names.");
4241 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4243 "lgetxattr on multiple files",
4245 This call allows you to get the extended attributes
4246 of multiple files, where all files are in the directory C<path>.
4247 C<names> is the list of files from this directory.
4249 On return you get a flat list of xattr structs which must be
4250 interpreted sequentially. The first xattr struct always has a zero-length
4251 C<attrname>. C<attrval> in this struct is zero-length
4252 to indicate there was an error doing C<lgetxattr> for this
4253 file, I<or> is a C string which is a decimal number
4254 (the number of following attributes for this file, which could
4255 be C<\"0\">). Then after the first xattr struct are the
4256 zero or more attributes for the first named file.
4257 This repeats for the second and subsequent files.
4259 This call is intended for programs that want to efficiently
4260 list a directory contents without making many round-trips.
4261 See also C<guestfs_lstatlist> for a similarly efficient call
4262 for getting standard stats. Very long directory listings
4263 might cause the protocol message size to be exceeded, causing
4264 this call to fail. The caller must split up such requests
4265 into smaller groups of names.");
4267 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4269 "readlink on multiple files",
4271 This call allows you to do a C<readlink> operation
4272 on multiple files, where all files are in the directory C<path>.
4273 C<names> is the list of files from this directory.
4275 On return you get a list of strings, with a one-to-one
4276 correspondence to the C<names> list. Each string is the
4277 value of the symbolic link.
4279 If the C<readlink(2)> operation fails on any name, then
4280 the corresponding result string is the empty string C<\"\">.
4281 However the whole operation is completed even if there
4282 were C<readlink(2)> errors, and so you can call this
4283 function with names where you don't know if they are
4284 symbolic links already (albeit slightly less efficient).
4286 This call is intended for programs that want to efficiently
4287 list a directory contents without making many round-trips.
4288 Very long directory listings might cause the protocol
4289 message size to be exceeded, causing
4290 this call to fail. The caller must split up such requests
4291 into smaller groups of names.");
4293 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4294 [InitISOFS, Always, TestOutputBuffer (
4295 [["pread"; "/known-4"; "1"; "3"]], "\n");
4296 InitISOFS, Always, TestOutputBuffer (
4297 [["pread"; "/empty"; "0"; "100"]], "")],
4298 "read part of a file",
4300 This command lets you read part of a file. It reads C<count>
4301 bytes of the file, starting at C<offset>, from file C<path>.
4303 This may read fewer bytes than requested. For further details
4304 see the L<pread(2)> system call.
4306 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4308 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4309 [InitEmpty, Always, TestRun (
4310 [["part_init"; "/dev/sda"; "gpt"]])],
4311 "create an empty partition table",
4313 This creates an empty partition table on C<device> of one of the
4314 partition types listed below. Usually C<parttype> should be
4315 either C<msdos> or C<gpt> (for large disks).
4317 Initially there are no partitions. Following this, you should
4318 call C<guestfs_part_add> for each partition required.
4320 Possible values for C<parttype> are:
4324 =item B<efi> | B<gpt>
4326 Intel EFI / GPT partition table.
4328 This is recommended for >= 2 TB partitions that will be accessed
4329 from Linux and Intel-based Mac OS X. It also has limited backwards
4330 compatibility with the C<mbr> format.
4332 =item B<mbr> | B<msdos>
4334 The standard PC \"Master Boot Record\" (MBR) format used
4335 by MS-DOS and Windows. This partition type will B<only> work
4336 for device sizes up to 2 TB. For large disks we recommend
4341 Other partition table types that may work but are not
4350 =item B<amiga> | B<rdb>
4352 Amiga \"Rigid Disk Block\" format.
4360 DASD, used on IBM mainframes.
4368 Old Mac partition format. Modern Macs use C<gpt>.
4372 NEC PC-98 format, common in Japan apparently.
4380 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4381 [InitEmpty, Always, TestRun (
4382 [["part_init"; "/dev/sda"; "mbr"];
4383 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4384 InitEmpty, Always, TestRun (
4385 [["part_init"; "/dev/sda"; "gpt"];
4386 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4387 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4388 InitEmpty, Always, TestRun (
4389 [["part_init"; "/dev/sda"; "mbr"];
4390 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4391 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4392 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4393 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4394 "add a partition to the device",
4396 This command adds a partition to C<device>. If there is no partition
4397 table on the device, call C<guestfs_part_init> first.
4399 The C<prlogex> parameter is the type of partition. Normally you
4400 should pass C<p> or C<primary> here, but MBR partition tables also
4401 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4404 C<startsect> and C<endsect> are the start and end of the partition
4405 in I<sectors>. C<endsect> may be negative, which means it counts
4406 backwards from the end of the disk (C<-1> is the last sector).
4408 Creating a partition which covers the whole disk is not so easy.
4409 Use C<guestfs_part_disk> to do that.");
4411 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4412 [InitEmpty, Always, TestRun (
4413 [["part_disk"; "/dev/sda"; "mbr"]]);
4414 InitEmpty, Always, TestRun (
4415 [["part_disk"; "/dev/sda"; "gpt"]])],
4416 "partition whole disk with a single primary partition",
4418 This command is simply a combination of C<guestfs_part_init>
4419 followed by C<guestfs_part_add> to create a single primary partition
4420 covering the whole disk.
4422 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4423 but other possible values are described in C<guestfs_part_init>.");
4425 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4426 [InitEmpty, Always, TestRun (
4427 [["part_disk"; "/dev/sda"; "mbr"];
4428 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4429 "make a partition bootable",
4431 This sets the bootable flag on partition numbered C<partnum> on
4432 device C<device>. Note that partitions are numbered from 1.
4434 The bootable flag is used by some operating systems (notably
4435 Windows) to determine which partition to boot from. It is by
4436 no means universally recognized.");
4438 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4439 [InitEmpty, Always, TestRun (
4440 [["part_disk"; "/dev/sda"; "gpt"];
4441 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4442 "set partition name",
4444 This sets the partition name on partition numbered C<partnum> on
4445 device C<device>. Note that partitions are numbered from 1.
4447 The partition name can only be set on certain types of partition
4448 table. This works on C<gpt> but not on C<mbr> partitions.");
4450 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4451 [], (* XXX Add a regression test for this. *)
4452 "list partitions on a device",
4454 This command parses the partition table on C<device> and
4455 returns the list of partitions found.
4457 The fields in the returned structure are:
4463 Partition number, counting from 1.
4467 Start of the partition I<in bytes>. To get sectors you have to
4468 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4472 End of the partition in bytes.
4476 Size of the partition in bytes.
4480 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4481 [InitEmpty, Always, TestOutput (
4482 [["part_disk"; "/dev/sda"; "gpt"];
4483 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4484 "get the partition table type",
4486 This command examines the partition table on C<device> and
4487 returns the partition table type (format) being used.
4489 Common return values include: C<msdos> (a DOS/Windows style MBR
4490 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4491 values are possible, although unusual. See C<guestfs_part_init>
4494 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4495 [InitBasicFS, Always, TestOutputBuffer (
4496 [["fill"; "0x63"; "10"; "/test"];
4497 ["read_file"; "/test"]], "cccccccccc")],
4498 "fill a file with octets",
4500 This command creates a new file called C<path>. The initial
4501 content of the file is C<len> octets of C<c>, where C<c>
4502 must be a number in the range C<[0..255]>.
4504 To fill a file with zero bytes (sparsely), it is
4505 much more efficient to use C<guestfs_truncate_size>.
4506 To create a file with a pattern of repeating bytes
4507 use C<guestfs_fill_pattern>.");
4509 ("available", (RErr, [StringList "groups"], []), 216, [],
4510 [InitNone, Always, TestRun [["available"; ""]]],
4511 "test availability of some parts of the API",
4513 This command is used to check the availability of some
4514 groups of functionality in the appliance, which not all builds of
4515 the libguestfs appliance will be able to provide.
4517 The libguestfs groups, and the functions that those
4518 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4519 You can also fetch this list at runtime by calling
4520 C<guestfs_available_all_groups>.
4522 The argument C<groups> is a list of group names, eg:
4523 C<[\"inotify\", \"augeas\"]> would check for the availability of
4524 the Linux inotify functions and Augeas (configuration file
4527 The command returns no error if I<all> requested groups are available.
4529 It fails with an error if one or more of the requested
4530 groups is unavailable in the appliance.
4532 If an unknown group name is included in the
4533 list of groups then an error is always returned.
4541 You must call C<guestfs_launch> before calling this function.
4543 The reason is because we don't know what groups are
4544 supported by the appliance/daemon until it is running and can
4549 If a group of functions is available, this does not necessarily
4550 mean that they will work. You still have to check for errors
4551 when calling individual API functions even if they are
4556 It is usually the job of distro packagers to build
4557 complete functionality into the libguestfs appliance.
4558 Upstream libguestfs, if built from source with all
4559 requirements satisfied, will support everything.
4563 This call was added in version C<1.0.80>. In previous
4564 versions of libguestfs all you could do would be to speculatively
4565 execute a command to find out if the daemon implemented it.
4566 See also C<guestfs_version>.
4570 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4571 [InitBasicFS, Always, TestOutputBuffer (
4572 [["write"; "/src"; "hello, world"];
4573 ["dd"; "/src"; "/dest"];
4574 ["read_file"; "/dest"]], "hello, world")],
4575 "copy from source to destination using dd",
4577 This command copies from one source device or file C<src>
4578 to another destination device or file C<dest>. Normally you
4579 would use this to copy to or from a device or partition, for
4580 example to duplicate a filesystem.
4582 If the destination is a device, it must be as large or larger
4583 than the source file or device, otherwise the copy will fail.
4584 This command cannot do partial copies (see C<guestfs_copy_size>).");
4586 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4587 [InitBasicFS, Always, TestOutputInt (
4588 [["write"; "/file"; "hello, world"];
4589 ["filesize"; "/file"]], 12)],
4590 "return the size of the file in bytes",
4592 This command returns the size of C<file> in bytes.
4594 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4595 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4596 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4598 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4599 [InitBasicFSonLVM, Always, TestOutputList (
4600 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4601 ["lvs"]], ["/dev/VG/LV2"])],
4602 "rename an LVM logical volume",
4604 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4606 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4607 [InitBasicFSonLVM, Always, TestOutputList (
4609 ["vg_activate"; "false"; "VG"];
4610 ["vgrename"; "VG"; "VG2"];
4611 ["vg_activate"; "true"; "VG2"];
4612 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4613 ["vgs"]], ["VG2"])],
4614 "rename an LVM volume group",
4616 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4618 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4619 [InitISOFS, Always, TestOutputBuffer (
4620 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4621 "list the contents of a single file in an initrd",
4623 This command unpacks the file C<filename> from the initrd file
4624 called C<initrdpath>. The filename must be given I<without> the
4625 initial C</> character.
4627 For example, in guestfish you could use the following command
4628 to examine the boot script (usually called C</init>)
4629 contained in a Linux initrd or initramfs image:
4631 initrd-cat /boot/initrd-<version>.img init
4633 See also C<guestfs_initrd_list>.");
4635 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4637 "get the UUID of a physical volume",
4639 This command returns the UUID of the LVM PV C<device>.");
4641 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4643 "get the UUID of a volume group",
4645 This command returns the UUID of the LVM VG named C<vgname>.");
4647 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4649 "get the UUID of a logical volume",
4651 This command returns the UUID of the LVM LV C<device>.");
4653 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4655 "get the PV UUIDs containing the volume group",
4657 Given a VG called C<vgname>, this returns the UUIDs of all
4658 the physical volumes that this volume group resides on.
4660 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4661 calls to associate physical volumes and volume groups.
4663 See also C<guestfs_vglvuuids>.");
4665 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4667 "get the LV UUIDs of all LVs in the volume group",
4669 Given a VG called C<vgname>, this returns the UUIDs of all
4670 the logical volumes created in this volume group.
4672 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4673 calls to associate logical volumes and volume groups.
4675 See also C<guestfs_vgpvuuids>.");
4677 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4678 [InitBasicFS, Always, TestOutputBuffer (
4679 [["write"; "/src"; "hello, world"];
4680 ["copy_size"; "/src"; "/dest"; "5"];
4681 ["read_file"; "/dest"]], "hello")],
4682 "copy size bytes from source to destination using dd",
4684 This command copies exactly C<size> bytes from one source device
4685 or file C<src> to another destination device or file C<dest>.
4687 Note this will fail if the source is too short or if the destination
4688 is not large enough.");
4690 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4691 [InitBasicFSonLVM, Always, TestRun (
4692 [["zero_device"; "/dev/VG/LV"]])],
4693 "write zeroes to an entire device",
4695 This command writes zeroes over the entire C<device>. Compare
4696 with C<guestfs_zero> which just zeroes the first few blocks of
4699 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4700 [InitBasicFS, Always, TestOutput (
4701 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4702 ["cat"; "/hello"]], "hello\n")],
4703 "unpack compressed tarball to directory",
4705 This command uploads and unpacks local file C<tarball> (an
4706 I<xz compressed> tar file) into C<directory>.");
4708 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4710 "pack directory into compressed tarball",
4712 This command packs the contents of C<directory> and downloads
4713 it to local file C<tarball> (as an xz compressed tar archive).");
4715 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4717 "resize an NTFS filesystem",
4719 This command resizes an NTFS filesystem, expanding or
4720 shrinking it to the size of the underlying device.
4721 See also L<ntfsresize(8)>.");
4723 ("vgscan", (RErr, [], []), 232, [],
4724 [InitEmpty, Always, TestRun (
4726 "rescan for LVM physical volumes, volume groups and logical volumes",
4728 This rescans all block devices and rebuilds the list of LVM
4729 physical volumes, volume groups and logical volumes.");
4731 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
4732 [InitEmpty, Always, TestRun (
4733 [["part_init"; "/dev/sda"; "mbr"];
4734 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4735 ["part_del"; "/dev/sda"; "1"]])],
4736 "delete a partition",
4738 This command deletes the partition numbered C<partnum> on C<device>.
4740 Note that in the case of MBR partitioning, deleting an
4741 extended partition also deletes any logical partitions
4744 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
4745 [InitEmpty, Always, TestOutputTrue (
4746 [["part_init"; "/dev/sda"; "mbr"];
4747 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4748 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4749 ["part_get_bootable"; "/dev/sda"; "1"]])],
4750 "return true if a partition is bootable",
4752 This command returns true if the partition C<partnum> on
4753 C<device> has the bootable flag set.
4755 See also C<guestfs_part_set_bootable>.");
4757 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
4758 [InitEmpty, Always, TestOutputInt (
4759 [["part_init"; "/dev/sda"; "mbr"];
4760 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4761 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4762 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4763 "get the MBR type byte (ID byte) from a partition",
4765 Returns the MBR type byte (also known as the ID byte) from
4766 the numbered partition C<partnum>.
4768 Note that only MBR (old DOS-style) partitions have type bytes.
4769 You will get undefined results for other partition table
4770 types (see C<guestfs_part_get_parttype>).");
4772 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
4773 [], (* tested by part_get_mbr_id *)
4774 "set the MBR type byte (ID byte) of a partition",
4776 Sets the MBR type byte (also known as the ID byte) of
4777 the numbered partition C<partnum> to C<idbyte>. Note
4778 that the type bytes quoted in most documentation are
4779 in fact hexadecimal numbers, but usually documented
4780 without any leading \"0x\" which might be confusing.
4782 Note that only MBR (old DOS-style) partitions have type bytes.
4783 You will get undefined results for other partition table
4784 types (see C<guestfs_part_get_parttype>).");
4786 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
4787 [InitISOFS, Always, TestOutputFileMD5 (
4788 [["checksum_device"; "md5"; "/dev/sdd"]],
4789 "../images/test.iso")],
4790 "compute MD5, SHAx or CRC checksum of the contents of a device",
4792 This call computes the MD5, SHAx or CRC checksum of the
4793 contents of the device named C<device>. For the types of
4794 checksums supported see the C<guestfs_checksum> command.");
4796 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
4797 [InitNone, Always, TestRun (
4798 [["part_disk"; "/dev/sda"; "mbr"];
4799 ["pvcreate"; "/dev/sda1"];
4800 ["vgcreate"; "VG"; "/dev/sda1"];
4801 ["lvcreate"; "LV"; "VG"; "10"];
4802 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4803 "expand an LV to fill free space",
4805 This expands an existing logical volume C<lv> so that it fills
4806 C<pc>% of the remaining free space in the volume group. Commonly
4807 you would call this with pc = 100 which expands the logical volume
4808 as much as possible, using all remaining free space in the volume
4811 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
4812 [], (* XXX Augeas code needs tests. *)
4813 "clear Augeas path",
4815 Set the value associated with C<path> to C<NULL>. This
4816 is the same as the L<augtool(1)> C<clear> command.");
4818 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
4819 [InitEmpty, Always, TestOutputInt (
4820 [["get_umask"]], 0o22)],
4821 "get the current umask",
4823 Return the current umask. By default the umask is C<022>
4824 unless it has been set by calling C<guestfs_umask>.");
4826 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
4828 "upload a file to the appliance (internal use only)",
4830 The C<guestfs_debug_upload> command uploads a file to
4831 the libguestfs appliance.
4833 There is no comprehensive help for this command. You have
4834 to look at the file C<daemon/debug.c> in the libguestfs source
4835 to find out what it is for.");
4837 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
4838 [InitBasicFS, Always, TestOutput (
4839 [["base64_in"; "../images/hello.b64"; "/hello"];
4840 ["cat"; "/hello"]], "hello\n")],
4841 "upload base64-encoded data to file",
4843 This command uploads base64-encoded data from C<base64file>
4846 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
4848 "download file and encode as base64",
4850 This command downloads the contents of C<filename>, writing
4851 it out to local file C<base64file> encoded as base64.");
4853 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
4855 "compute MD5, SHAx or CRC checksum of files in a directory",
4857 This command computes the checksums of all regular files in
4858 C<directory> and then emits a list of those checksums to
4859 the local output file C<sumsfile>.
4861 This can be used for verifying the integrity of a virtual
4862 machine. However to be properly secure you should pay
4863 attention to the output of the checksum command (it uses
4864 the ones from GNU coreutils). In particular when the
4865 filename is not printable, coreutils uses a special
4866 backslash syntax. For more information, see the GNU
4867 coreutils info file.");
4869 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
4870 [InitBasicFS, Always, TestOutputBuffer (
4871 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4872 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4873 "fill a file with a repeating pattern of bytes",
4875 This function is like C<guestfs_fill> except that it creates
4876 a new file of length C<len> containing the repeating pattern
4877 of bytes in C<pattern>. The pattern is truncated if necessary
4878 to ensure the length of the file is exactly C<len> bytes.");
4880 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
4881 [InitBasicFS, Always, TestOutput (
4882 [["write"; "/new"; "new file contents"];
4883 ["cat"; "/new"]], "new file contents");
4884 InitBasicFS, Always, TestOutput (
4885 [["write"; "/new"; "\nnew file contents\n"];
4886 ["cat"; "/new"]], "\nnew file contents\n");
4887 InitBasicFS, Always, TestOutput (
4888 [["write"; "/new"; "\n\n"];
4889 ["cat"; "/new"]], "\n\n");
4890 InitBasicFS, Always, TestOutput (
4891 [["write"; "/new"; ""];
4892 ["cat"; "/new"]], "");
4893 InitBasicFS, Always, TestOutput (
4894 [["write"; "/new"; "\n\n\n"];
4895 ["cat"; "/new"]], "\n\n\n");
4896 InitBasicFS, Always, TestOutput (
4897 [["write"; "/new"; "\n"];
4898 ["cat"; "/new"]], "\n")],
4899 "create a new file",
4901 This call creates a file called C<path>. The content of the
4902 file is the string C<content> (which can contain any 8 bit data).");
4904 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
4905 [InitBasicFS, Always, TestOutput (
4906 [["write"; "/new"; "new file contents"];
4907 ["pwrite"; "/new"; "data"; "4"];
4908 ["cat"; "/new"]], "new data contents");
4909 InitBasicFS, Always, TestOutput (
4910 [["write"; "/new"; "new file contents"];
4911 ["pwrite"; "/new"; "is extended"; "9"];
4912 ["cat"; "/new"]], "new file is extended");
4913 InitBasicFS, Always, TestOutput (
4914 [["write"; "/new"; "new file contents"];
4915 ["pwrite"; "/new"; ""; "4"];
4916 ["cat"; "/new"]], "new file contents")],
4917 "write to part of a file",
4919 This command writes to part of a file. It writes the data
4920 buffer C<content> to the file C<path> starting at offset C<offset>.
4922 This command implements the L<pwrite(2)> system call, and like
4923 that system call it may not write the full data requested. The
4924 return value is the number of bytes that were actually written
4925 to the file. This could even be 0, although short writes are
4926 unlikely for regular files in ordinary circumstances.
4928 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
4930 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
4932 "resize an ext2, ext3 or ext4 filesystem (with size)",
4934 This command is the same as C<guestfs_resize2fs> except that it
4935 allows you to specify the new size (in bytes) explicitly.");
4937 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
4939 "resize an LVM physical volume (with size)",
4941 This command is the same as C<guestfs_pvresize> except that it
4942 allows you to specify the new size (in bytes) explicitly.");
4944 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
4946 "resize an NTFS filesystem (with size)",
4948 This command is the same as C<guestfs_ntfsresize> except that it
4949 allows you to specify the new size (in bytes) explicitly.");
4951 ("available_all_groups", (RStringList "groups", [], []), 251, [],
4952 [InitNone, Always, TestRun [["available_all_groups"]]],
4953 "return a list of all optional groups",
4955 This command returns a list of all optional groups that this
4956 daemon knows about. Note this returns both supported and unsupported
4957 groups. To find out which ones the daemon can actually support
4958 you have to call C<guestfs_available> on each member of the
4961 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4963 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
4964 [InitBasicFS, Always, TestOutputStruct (
4965 [["fallocate64"; "/a"; "1000000"];
4966 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4967 "preallocate a file in the guest filesystem",
4969 This command preallocates a file (containing zero bytes) named
4970 C<path> of size C<len> bytes. If the file exists already, it
4973 Note that this call allocates disk blocks for the file.
4974 To create a sparse file use C<guestfs_truncate_size> instead.
4976 The deprecated call C<guestfs_fallocate> does the same,
4977 but owing to an oversight it only allowed 30 bit lengths
4978 to be specified, effectively limiting the maximum size
4979 of files created through that call to 1GB.
4981 Do not confuse this with the guestfish-specific
4982 C<alloc> and C<sparse> commands which create
4983 a file in the host and attach it as a device.");
4985 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
4986 [InitBasicFS, Always, TestOutput (
4987 [["set_e2label"; "/dev/sda1"; "LTEST"];
4988 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4989 "get the filesystem label",
4991 This returns the filesystem label of the filesystem on
4994 If the filesystem is unlabeled, this returns the empty string.
4996 To find a filesystem from the label, use C<guestfs_findfs_label>.");
4998 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
4999 (let uuid = uuidgen () in
5000 [InitBasicFS, Always, TestOutput (
5001 [["set_e2uuid"; "/dev/sda1"; uuid];
5002 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5003 "get the filesystem UUID",
5005 This returns the filesystem UUID of the filesystem on
5008 If the filesystem does not have a UUID, this returns the empty string.
5010 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5012 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5013 (* Can't be tested with the current framework because
5014 * the VG is being used by the mounted filesystem, so
5015 * the vgchange -an command we do first will fail.
5018 "set LVM device filter",
5020 This sets the LVM device filter so that LVM will only be
5021 able to \"see\" the block devices in the list C<devices>,
5022 and will ignore all other attached block devices.
5024 Where disk image(s) contain duplicate PVs or VGs, this
5025 command is useful to get LVM to ignore the duplicates, otherwise
5026 LVM can get confused. Note also there are two types
5027 of duplication possible: either cloned PVs/VGs which have
5028 identical UUIDs; or VGs that are not cloned but just happen
5029 to have the same name. In normal operation you cannot
5030 create this situation, but you can do it outside LVM, eg.
5031 by cloning disk images or by bit twiddling inside the LVM
5034 This command also clears the LVM cache and performs a volume
5037 You can filter whole block devices or individual partitions.
5039 You cannot use this if any VG is currently in use (eg.
5040 contains a mounted filesystem), even if you are not
5041 filtering out that VG.");
5043 ("lvm_clear_filter", (RErr, [], []), 256, [],
5044 [], (* see note on lvm_set_filter *)
5045 "clear LVM device filter",
5047 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5048 will be able to see every block device.
5050 This command also clears the LVM cache and performs a volume
5053 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5055 "open a LUKS-encrypted block device",
5057 This command opens a block device which has been encrypted
5058 according to the Linux Unified Key Setup (LUKS) standard.
5060 C<device> is the encrypted block device or partition.
5062 The caller must supply one of the keys associated with the
5063 LUKS block device, in the C<key> parameter.
5065 This creates a new block device called C</dev/mapper/mapname>.
5066 Reads and writes to this block device are decrypted from and
5067 encrypted to the underlying C<device> respectively.
5069 If this block device contains LVM volume groups, then
5070 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5071 will make them visible.");
5073 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5075 "open a LUKS-encrypted block device read-only",
5077 This is the same as C<guestfs_luks_open> except that a read-only
5078 mapping is created.");
5080 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5082 "close a LUKS device",
5084 This closes a LUKS device that was created earlier by
5085 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5086 C<device> parameter must be the name of the LUKS mapping
5087 device (ie. C</dev/mapper/mapname>) and I<not> the name
5088 of the underlying block device.");
5090 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5092 "format a block device as a LUKS encrypted device",
5094 This command erases existing data on C<device> and formats
5095 the device as a LUKS encrypted device. C<key> is the
5096 initial key, which is added to key slot C<slot>. (LUKS
5097 supports 8 key slots, numbered 0-7).");
5099 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5101 "format a block device as a LUKS encrypted device",
5103 This command is the same as C<guestfs_luks_format> but
5104 it also allows you to set the C<cipher> used.");
5106 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5108 "add a key on a LUKS encrypted device",
5110 This command adds a new key on LUKS device C<device>.
5111 C<key> is any existing key, and is used to access the device.
5112 C<newkey> is the new key to add. C<keyslot> is the key slot
5113 that will be replaced.
5115 Note that if C<keyslot> already contains a key, then this
5116 command will fail. You have to use C<guestfs_luks_kill_slot>
5117 first to remove that key.");
5119 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5121 "remove a key from a LUKS encrypted device",
5123 This command deletes the key in key slot C<keyslot> from the
5124 encrypted LUKS device C<device>. C<key> must be one of the
5127 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5128 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5129 [["is_lv"; "/dev/VG/LV"]]);
5130 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5131 [["is_lv"; "/dev/sda1"]])],
5132 "test if device is a logical volume",
5134 This command tests whether C<device> is a logical volume, and
5135 returns true iff this is the case.");
5137 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5139 "find a filesystem by UUID",
5141 This command searches the filesystems and returns the one
5142 which has the given UUID. An error is returned if no such
5143 filesystem can be found.
5145 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5147 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5149 "find a filesystem by label",
5151 This command searches the filesystems and returns the one
5152 which has the given label. An error is returned if no such
5153 filesystem can be found.
5155 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5157 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5158 [InitISOFS, Always, TestOutputFalse (
5159 [["is_chardev"; "/directory"]]);
5160 InitBasicFS, Always, TestOutputTrue (
5161 [["mknod_c"; "0o777"; "99"; "66"; "/test"];
5162 ["is_chardev"; "/test"]])],
5163 "test if character device",
5165 This returns C<true> if and only if there is a character device
5166 with the given C<path> name.
5168 See also C<guestfs_stat>.");
5170 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5171 [InitISOFS, Always, TestOutputFalse (
5172 [["is_blockdev"; "/directory"]]);
5173 InitBasicFS, Always, TestOutputTrue (
5174 [["mknod_b"; "0o777"; "99"; "66"; "/test"];
5175 ["is_blockdev"; "/test"]])],
5176 "test if block device",
5178 This returns C<true> if and only if there is a block device
5179 with the given C<path> name.
5181 See also C<guestfs_stat>.");
5183 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5184 [InitISOFS, Always, TestOutputFalse (
5185 [["is_fifo"; "/directory"]]);
5186 InitBasicFS, Always, TestOutputTrue (
5187 [["mkfifo"; "0o777"; "/test"];
5188 ["is_fifo"; "/test"]])],
5189 "test if FIFO (named pipe)",
5191 This returns C<true> if and only if there is a FIFO (named pipe)
5192 with the given C<path> name.
5194 See also C<guestfs_stat>.");
5196 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5197 [InitISOFS, Always, TestOutputFalse (
5198 [["is_symlink"; "/directory"]]);
5199 InitISOFS, Always, TestOutputTrue (
5200 [["is_symlink"; "/abssymlink"]])],
5201 "test if symbolic link",
5203 This returns C<true> if and only if there is a symbolic link
5204 with the given C<path> name.
5206 See also C<guestfs_stat>.");
5208 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5209 (* XXX Need a positive test for sockets. *)
5210 [InitISOFS, Always, TestOutputFalse (
5211 [["is_socket"; "/directory"]])],
5214 This returns C<true> if and only if there is a Unix domain socket
5215 with the given C<path> name.
5217 See also C<guestfs_stat>.");
5219 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5220 [InitPartition, Always, TestOutputDevice (
5221 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5222 InitEmpty, Always, TestLastFail (
5223 [["part_to_dev"; "/dev/sda"]])],
5224 "convert partition name to device name",
5226 This function takes a partition name (eg. \"/dev/sdb1\") and
5227 removes the partition number, returning the device name
5230 The named partition must exist, for example as a string returned
5231 from C<guestfs_list_partitions>.");
5233 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [],
5234 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5235 [InitBasicFS, Always, TestOutput (
5236 [["upload_offset"; "../COPYING.LIB"; "/COPYING.LIB"; "0"];
5237 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5238 "upload a file from the local machine with offset",
5240 Upload local file C<filename> to C<remotefilename> on the
5243 C<remotefilename> is overwritten starting at the byte C<offset>
5244 specified. The intention is to overwrite parts of existing
5245 files or devices, although if a non-existant file is specified
5246 then it is created with a \"hole\" before C<offset>. The
5247 size of the data written is implicit in the size of the
5250 Note that there is no limit on the amount of data that
5251 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5252 and this call always writes the full amount unless an
5255 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5257 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5258 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5259 let offset = string_of_int 100 in
5260 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5261 [InitBasicFS, Always, TestOutput (
5262 (* Pick a file from cwd which isn't likely to change. *)
5263 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
5264 ["download_offset"; "/COPYING.LIB"; "testdownload.tmp"; offset; size];
5265 ["upload_offset"; "testdownload.tmp"; "/COPYING.LIB"; offset];
5266 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5267 "download a file to the local machine with offset and size",
5269 Download file C<remotefilename> and save it as C<filename>
5270 on the local machine.
5272 C<remotefilename> is read for C<size> bytes starting at C<offset>
5273 (this region must be within the file or device).
5275 Note that there is no limit on the amount of data that
5276 can be downloaded with this call, unlike with C<guestfs_pread>,
5277 and this call always reads the full amount unless an
5280 See also C<guestfs_download>, C<guestfs_pread>.");
5282 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5283 [InitPartition, Always, TestOutputList (
5284 [["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"];
5285 ["blockdev_rereadpt"; "/dev/sda"];
5286 ["list_partitions"]], [])],
5287 "write to part of a device",
5289 This command writes to part of a device. It writes the data
5290 buffer C<content> to C<device> starting at offset C<offset>.
5292 This command implements the L<pwrite(2)> system call, and like
5293 that system call it may not write the full data requested
5294 (although short writes to disk devices and partitions are
5295 probably impossible with standard Linux kernels).
5297 See also C<guestfs_pwrite>.");
5299 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5300 [InitEmpty, Always, TestOutputBuffer (
5301 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5302 "read part of a device",
5304 This command lets you read part of a file. It reads C<count>
5305 bytes of C<device>, starting at C<offset>.
5307 This may read fewer bytes than requested. For further details
5308 see the L<pread(2)> system call.
5310 See also C<guestfs_pread>.");
5312 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5313 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5314 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5315 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5316 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5317 "get canonical name of an LV",
5319 This converts alternative naming schemes for LVs that you
5320 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5321 is converted to C</dev/VG/LV>.
5323 This command returns an error if the C<lvname> parameter does
5324 not refer to a logical volume.
5326 See also C<guestfs_is_lv>.");
5330 let all_functions = non_daemon_functions @ daemon_functions
5332 (* In some places we want the functions to be displayed sorted
5333 * alphabetically, so this is useful:
5335 let all_functions_sorted = List.sort action_compare all_functions
5337 (* This is used to generate the src/MAX_PROC_NR file which
5338 * contains the maximum procedure number, a surrogate for the
5339 * ABI version number. See src/Makefile.am for the details.
5342 let proc_nrs = List.map (
5343 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5344 ) daemon_functions in
5345 List.fold_left max 0 proc_nrs
5347 (* Non-API meta-commands available only in guestfish.
5349 * Note (1): style, proc_nr and tests fields are all meaningless.
5350 * The only fields which are actually used are the shortname,
5351 * FishAlias flags, shortdesc and longdesc.
5353 * Note (2): to refer to other commands, use L</shortname>.
5355 * Note (3): keep this list sorted by shortname.
5357 let fish_commands = [
5358 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5359 "allocate and add a disk file",
5360 " alloc filename size
5362 This creates an empty (zeroed) file of the given size, and then adds
5363 so it can be further examined.
5365 For more advanced image creation, see L<qemu-img(1)> utility.
5367 Size can be specified using standard suffixes, eg. C<1M>.
5369 To create a sparse file, use L</sparse> instead. To create a
5370 prepared disk image, see L</PREPARED DISK IMAGES>.");
5372 ("copy_in", (RErr,[], []), -1, [], [],
5373 "copy local files or directories into an image",
5374 " copy-in local [local ...] /remotedir
5376 C<copy-in> copies local files or directories recursively into the disk
5377 image, placing them in the directory called C</remotedir> (which must
5378 exist). This guestfish meta-command turns into a sequence of
5379 L</tar-in> and other commands as necessary.
5381 Multiple local files and directories can be specified, but the last
5382 parameter must always be a remote directory. Wildcards cannot be
5385 ("copy_out", (RErr,[], []), -1, [], [],
5386 "copy remote files or directories out of an image",
5387 " copy-out remote [remote ...] localdir
5389 C<copy-out> copies remote files or directories recursively out of the
5390 disk image, placing them on the host disk in a local directory called
5391 C<localdir> (which must exist). This guestfish meta-command turns
5392 into a sequence of L</download>, L</tar-out> and other commands as
5395 Multiple remote files and directories can be specified, but the last
5396 parameter must always be a local directory. To download to the
5397 current directory, use C<.> as in:
5401 Wildcards cannot be used in the ordinary command, but you can use
5402 them with the help of L</glob> like this:
5404 glob copy-out /home/* .");
5406 ("echo", (RErr,[], []), -1, [], [],
5407 "display a line of text",
5410 This echos the parameters to the terminal.");
5412 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5416 This is used to edit a file. It downloads the file, edits it
5417 locally using your editor, then uploads the result.
5419 The editor is C<$EDITOR>. However if you use the alternate
5420 commands C<vi> or C<emacs> you will get those corresponding
5423 ("glob", (RErr,[], []), -1, [], [],
5424 "expand wildcards in command",
5425 " glob command args...
5427 Expand wildcards in any paths in the args list, and run C<command>
5428 repeatedly on each matching path.
5430 See L</WILDCARDS AND GLOBBING>.");
5432 ("hexedit", (RErr,[], []), -1, [], [],
5433 "edit with a hex editor",
5434 " hexedit <filename|device>
5435 hexedit <filename|device> <max>
5436 hexedit <filename|device> <start> <max>
5438 Use hexedit (a hex editor) to edit all or part of a binary file
5441 This command works by downloading potentially the whole file or
5442 device, editing it locally, then uploading it. If the file or
5443 device is large, you have to specify which part you wish to edit
5444 by using C<max> and/or C<start> C<max> parameters.
5445 C<start> and C<max> are specified in bytes, with the usual
5446 modifiers allowed such as C<1M> (1 megabyte).
5448 For example to edit the first few sectors of a disk you
5453 which would allow you to edit anywhere within the first megabyte
5456 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5458 hexedit /dev/sda1 0x400 0x400
5460 (assuming the superblock is in the standard location).
5462 This command requires the external L<hexedit(1)> program. You
5463 can specify another program to use by setting the C<HEXEDITOR>
5464 environment variable.
5466 See also L</hexdump>.");
5468 ("lcd", (RErr,[], []), -1, [], [],
5469 "change working directory",
5472 Change the local directory, ie. the current directory of guestfish
5475 Note that C<!cd> won't do what you might expect.");
5477 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5481 Opens the manual page for guestfish.");
5483 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5489 This is used to view a file.
5491 The default viewer is C<$PAGER>. However if you use the alternate
5492 command C<less> you will get the C<less> command specifically.");
5494 ("reopen", (RErr,[], []), -1, [], [],
5495 "close and reopen libguestfs handle",
5498 Close and reopen the libguestfs handle. It is not necessary to use
5499 this normally, because the handle is closed properly when guestfish
5500 exits. However this is occasionally useful for testing.");
5502 ("sparse", (RErr,[], []), -1, [], [],
5503 "create a sparse disk image and add",
5504 " sparse filename size
5506 This creates an empty sparse file of the given size, and then adds
5507 so it can be further examined.
5509 In all respects it works the same as the L</alloc> command, except that
5510 the image file is allocated sparsely, which means that disk blocks are
5511 not assigned to the file until they are needed. Sparse disk files
5512 only use space when written to, but they are slower and there is a
5513 danger you could run out of real disk space during a write operation.
5515 For more advanced image creation, see L<qemu-img(1)> utility.
5517 Size can be specified using standard suffixes, eg. C<1M>.");
5519 ("supported", (RErr,[], []), -1, [], [],
5520 "list supported groups of commands",
5523 This command returns a list of the optional groups
5524 known to the daemon, and indicates which ones are
5525 supported by this build of the libguestfs appliance.
5527 See also L<guestfs(3)/AVAILABILITY>.");
5529 ("time", (RErr,[], []), -1, [], [],
5530 "print elapsed time taken to run a command",
5531 " time command args...
5533 Run the command as usual, but print the elapsed time afterwards. This
5534 can be useful for benchmarking operations.");