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:
784 Debian or a Debian-derived distro such as Ubuntu.
790 =item \"redhat-based\"
792 Some Red Hat-derived distro.
796 Red Hat Enterprise Linux and some derivatives.
800 Windows does not have distributions. This string is
801 returned if the OS type is Windows.
805 The distro could not be determined.
809 Future versions of libguestfs may return other strings here.
810 The caller should be prepared to handle any string.
812 Please read L<guestfs(3)/INSPECTION> for more details.");
814 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
816 "get major version of inspected operating system",
818 This function should only be called with a root device string
819 as returned by C<guestfs_inspect_os>.
821 This returns the major version number of the inspected operating
824 Windows uses a consistent versioning scheme which is I<not>
825 reflected in the popular public names used by the operating system.
826 Notably the operating system known as \"Windows 7\" is really
827 version 6.1 (ie. major = 6, minor = 1). You can find out the
828 real versions corresponding to releases of Windows by consulting
831 If the version could not be determined, then C<0> is returned.
833 Please read L<guestfs(3)/INSPECTION> for more details.");
835 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
837 "get minor version of inspected operating system",
839 This function should only be called with a root device string
840 as returned by C<guestfs_inspect_os>.
842 This returns the minor version number of the inspected operating
845 If the version could not be determined, then C<0> is returned.
847 Please read L<guestfs(3)/INSPECTION> for more details.
848 See also C<guestfs_inspect_get_major_version>.");
850 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
852 "get product name of inspected operating system",
854 This function should only be called with a root device string
855 as returned by C<guestfs_inspect_os>.
857 This returns the product name of the inspected operating
858 system. The product name is generally some freeform string
859 which can be displayed to the user, but should not be
862 If the product name could not be determined, then the
863 string C<unknown> is returned.
865 Please read L<guestfs(3)/INSPECTION> for more details.");
867 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
869 "get mountpoints of inspected operating system",
871 This function should only be called with a root device string
872 as returned by C<guestfs_inspect_os>.
874 This returns a hash of where we think the filesystems
875 associated with this operating system should be mounted.
876 Callers should note that this is at best an educated guess
877 made by reading configuration files such as C</etc/fstab>.
879 Each element in the returned hashtable has a key which
880 is the path of the mountpoint (eg. C</boot>) and a value
881 which is the filesystem that would be mounted there
884 Non-mounted devices such as swap devices are I<not>
885 returned in this list.
887 Please read L<guestfs(3)/INSPECTION> for more details.
888 See also C<guestfs_inspect_get_filesystems>.");
890 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
892 "get filesystems associated with inspected operating system",
894 This function should only be called with a root device string
895 as returned by C<guestfs_inspect_os>.
897 This returns a list of all the filesystems that we think
898 are associated with this operating system. This includes
899 the root filesystem, other ordinary filesystems, and
900 non-mounted devices like swap partitions.
902 In the case of a multi-boot virtual machine, it is possible
903 for a filesystem to be shared between operating systems.
905 Please read L<guestfs(3)/INSPECTION> for more details.
906 See also C<guestfs_inspect_get_mountpoints>.");
908 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
910 "set enable network flag",
912 If C<network> is true, then the network is enabled in the
913 libguestfs appliance. The default is false.
915 This affects whether commands are able to access the network
916 (see L<guestfs(3)/RUNNING COMMANDS>).
918 You must call this before calling C<guestfs_launch>, otherwise
921 ("get_network", (RBool "network", [], []), -1, [],
923 "get enable network flag",
925 This returns the enable network flag.");
927 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
931 This inspection command looks for filesystems on partitions,
932 block devices and logical volumes, returning a list of devices
933 containing filesystems and their type.
935 The return value is a hash, where the keys are the devices
936 containing filesystems, and the values are the filesystem types.
939 \"/dev/sda1\" => \"ntfs\"
940 \"/dev/sda2\" => \"ext2\"
941 \"/dev/vg_guest/lv_root\" => \"ext4\"
942 \"/dev/vg_guest/lv_swap\" => \"swap\"
944 The value can have the special value \"unknown\", meaning the
945 content of the device is undetermined or empty.
946 \"swap\" means a Linux swap partition.
948 This command runs other libguestfs commands, which might include
949 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
950 use this soon after launch and only when nothing is mounted.
952 Not all of the filesystems returned will be mountable. In
953 particular, swap partitions are returned in the list. Also
954 this command does not check that each filesystem
955 found is valid and mountable, and some filesystems might
956 be mountable but require special options. Filesystems may
957 not all belong to a single logical operating system
958 (use C<guestfs_inspect_os> to look for OSes).");
960 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
962 "add an image to examine or modify",
964 This function adds a virtual machine disk image C<filename> to
965 libguestfs. The first time you call this function, the disk
966 appears as C</dev/sda>, the second time as C</dev/sdb>, and
969 You don't necessarily need to be root when using libguestfs. However
970 you obviously do need sufficient permissions to access the filename
971 for whatever operations you want to perform (ie. read access if you
972 just want to read the image or write access if you want to modify the
975 This call checks that C<filename> exists.
977 The optional arguments are:
983 If true then the image is treated as read-only. Writes are still
984 allowed, but they are stored in a temporary snapshot overlay which
985 is discarded at the end. The disk that you add is not modified.
989 This forces the image format. If you omit this (or use C<guestfs_add_drive>
990 or C<guestfs_add_drive_ro>) then the format is automatically detected.
991 Possible formats include C<raw> and C<qcow2>.
993 Automatic detection of the format opens you up to a potential
994 security hole when dealing with untrusted raw-format images.
995 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1000 This rarely-used option lets you emulate the behaviour of the
1001 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1005 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1007 "get Windows systemroot of inspected operating system",
1009 This function should only be called with a root device string
1010 as returned by C<guestfs_inspect_os>.
1012 This returns the Windows systemroot of the inspected guest.
1013 The systemroot is a directory path such as C</WINDOWS>.
1015 This call assumes that the guest is Windows and that the
1016 systemroot could be determined by inspection. If this is not
1017 the case then an error is returned.
1019 Please read L<guestfs(3)/INSPECTION> for more details.");
1023 (* daemon_functions are any functions which cause some action
1024 * to take place in the daemon.
1027 let daemon_functions = [
1028 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1029 [InitEmpty, Always, TestOutput (
1030 [["part_disk"; "/dev/sda"; "mbr"];
1031 ["mkfs"; "ext2"; "/dev/sda1"];
1032 ["mount"; "/dev/sda1"; "/"];
1033 ["write"; "/new"; "new file contents"];
1034 ["cat"; "/new"]], "new file contents")],
1035 "mount a guest disk at a position in the filesystem",
1037 Mount a guest disk at a position in the filesystem. Block devices
1038 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1039 the guest. If those block devices contain partitions, they will have
1040 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1043 The rules are the same as for L<mount(2)>: A filesystem must
1044 first be mounted on C</> before others can be mounted. Other
1045 filesystems can only be mounted on directories which already
1048 The mounted filesystem is writable, if we have sufficient permissions
1049 on the underlying device.
1052 When you use this call, the filesystem options C<sync> and C<noatime>
1053 are set implicitly. This was originally done because we thought it
1054 would improve reliability, but it turns out that I<-o sync> has a
1055 very large negative performance impact and negligible effect on
1056 reliability. Therefore we recommend that you avoid using
1057 C<guestfs_mount> in any code that needs performance, and instead
1058 use C<guestfs_mount_options> (use an empty string for the first
1059 parameter if you don't want any options).");
1061 ("sync", (RErr, [], []), 2, [],
1062 [ InitEmpty, Always, TestRun [["sync"]]],
1063 "sync disks, writes are flushed through to the disk image",
1065 This syncs the disk, so that any writes are flushed through to the
1066 underlying disk image.
1068 You should always call this if you have modified a disk image, before
1069 closing the handle.");
1071 ("touch", (RErr, [Pathname "path"], []), 3, [],
1072 [InitBasicFS, Always, TestOutputTrue (
1074 ["exists"; "/new"]])],
1075 "update file timestamps or create a new file",
1077 Touch acts like the L<touch(1)> command. It can be used to
1078 update the timestamps on a file, or, if the file does not exist,
1079 to create a new zero-length file.
1081 This command only works on regular files, and will fail on other
1082 file types such as directories, symbolic links, block special etc.");
1084 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1085 [InitISOFS, Always, TestOutput (
1086 [["cat"; "/known-2"]], "abcdef\n")],
1087 "list the contents of a file",
1089 Return the contents of the file named C<path>.
1091 Note that this function cannot correctly handle binary files
1092 (specifically, files containing C<\\0> character which is treated
1093 as end of string). For those you need to use the C<guestfs_read_file>
1094 or C<guestfs_download> functions which have a more complex interface.");
1096 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1097 [], (* XXX Tricky to test because it depends on the exact format
1098 * of the 'ls -l' command, which changes between F10 and F11.
1100 "list the files in a directory (long format)",
1102 List the files in C<directory> (relative to the root directory,
1103 there is no cwd) in the format of 'ls -la'.
1105 This command is mostly useful for interactive sessions. It
1106 is I<not> intended that you try to parse the output string.");
1108 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1109 [InitBasicFS, Always, TestOutputList (
1111 ["touch"; "/newer"];
1112 ["touch"; "/newest"];
1113 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1114 "list the files in a directory",
1116 List the files in C<directory> (relative to the root directory,
1117 there is no cwd). The '.' and '..' entries are not returned, but
1118 hidden files are shown.
1120 This command is mostly useful for interactive sessions. Programs
1121 should probably use C<guestfs_readdir> instead.");
1123 ("list_devices", (RStringList "devices", [], []), 7, [],
1124 [InitEmpty, Always, TestOutputListOfDevices (
1125 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1126 "list the block devices",
1128 List all the block devices.
1130 The full block device names are returned, eg. C</dev/sda>.
1132 See also C<guestfs_list_filesystems>.");
1134 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1135 [InitBasicFS, Always, TestOutputListOfDevices (
1136 [["list_partitions"]], ["/dev/sda1"]);
1137 InitEmpty, Always, TestOutputListOfDevices (
1138 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1139 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1140 "list the partitions",
1142 List all the partitions detected on all block devices.
1144 The full partition device names are returned, eg. C</dev/sda1>
1146 This does not return logical volumes. For that you will need to
1147 call C<guestfs_lvs>.
1149 See also C<guestfs_list_filesystems>.");
1151 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1152 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1153 [["pvs"]], ["/dev/sda1"]);
1154 InitEmpty, Always, TestOutputListOfDevices (
1155 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1156 ["pvcreate"; "/dev/sda1"];
1157 ["pvcreate"; "/dev/sda2"];
1158 ["pvcreate"; "/dev/sda3"];
1159 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1160 "list the LVM physical volumes (PVs)",
1162 List all the physical volumes detected. This is the equivalent
1163 of the L<pvs(8)> command.
1165 This returns a list of just the device names that contain
1166 PVs (eg. C</dev/sda2>).
1168 See also C<guestfs_pvs_full>.");
1170 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1171 [InitBasicFSonLVM, Always, TestOutputList (
1173 InitEmpty, Always, TestOutputList (
1174 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1175 ["pvcreate"; "/dev/sda1"];
1176 ["pvcreate"; "/dev/sda2"];
1177 ["pvcreate"; "/dev/sda3"];
1178 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1179 ["vgcreate"; "VG2"; "/dev/sda3"];
1180 ["vgs"]], ["VG1"; "VG2"])],
1181 "list the LVM volume groups (VGs)",
1183 List all the volumes groups detected. This is the equivalent
1184 of the L<vgs(8)> command.
1186 This returns a list of just the volume group names that were
1187 detected (eg. C<VolGroup00>).
1189 See also C<guestfs_vgs_full>.");
1191 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1192 [InitBasicFSonLVM, Always, TestOutputList (
1193 [["lvs"]], ["/dev/VG/LV"]);
1194 InitEmpty, Always, TestOutputList (
1195 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1196 ["pvcreate"; "/dev/sda1"];
1197 ["pvcreate"; "/dev/sda2"];
1198 ["pvcreate"; "/dev/sda3"];
1199 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1200 ["vgcreate"; "VG2"; "/dev/sda3"];
1201 ["lvcreate"; "LV1"; "VG1"; "50"];
1202 ["lvcreate"; "LV2"; "VG1"; "50"];
1203 ["lvcreate"; "LV3"; "VG2"; "50"];
1204 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1205 "list the LVM logical volumes (LVs)",
1207 List all the logical volumes detected. This is the equivalent
1208 of the L<lvs(8)> command.
1210 This returns a list of the logical volume device names
1211 (eg. C</dev/VolGroup00/LogVol00>).
1213 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1215 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1216 [], (* XXX how to test? *)
1217 "list the LVM physical volumes (PVs)",
1219 List all the physical volumes detected. This is the equivalent
1220 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1222 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1223 [], (* XXX how to test? *)
1224 "list the LVM volume groups (VGs)",
1226 List all the volumes groups detected. This is the equivalent
1227 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1229 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1230 [], (* XXX how to test? *)
1231 "list the LVM logical volumes (LVs)",
1233 List all the logical volumes detected. This is the equivalent
1234 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1236 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1237 [InitISOFS, Always, TestOutputList (
1238 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1239 InitISOFS, Always, TestOutputList (
1240 [["read_lines"; "/empty"]], [])],
1241 "read file as lines",
1243 Return the contents of the file named C<path>.
1245 The file contents are returned as a list of lines. Trailing
1246 C<LF> and C<CRLF> character sequences are I<not> returned.
1248 Note that this function cannot correctly handle binary files
1249 (specifically, files containing C<\\0> character which is treated
1250 as end of line). For those you need to use the C<guestfs_read_file>
1251 function which has a more complex interface.");
1253 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1254 [], (* XXX Augeas code needs tests. *)
1255 "create a new Augeas handle",
1257 Create a new Augeas handle for editing configuration files.
1258 If there was any previous Augeas handle associated with this
1259 guestfs session, then it is closed.
1261 You must call this before using any other C<guestfs_aug_*>
1264 C<root> is the filesystem root. C<root> must not be NULL,
1267 The flags are the same as the flags defined in
1268 E<lt>augeas.hE<gt>, the logical I<or> of the following
1273 =item C<AUG_SAVE_BACKUP> = 1
1275 Keep the original file with a C<.augsave> extension.
1277 =item C<AUG_SAVE_NEWFILE> = 2
1279 Save changes into a file with extension C<.augnew>, and
1280 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1282 =item C<AUG_TYPE_CHECK> = 4
1284 Typecheck lenses (can be expensive).
1286 =item C<AUG_NO_STDINC> = 8
1288 Do not use standard load path for modules.
1290 =item C<AUG_SAVE_NOOP> = 16
1292 Make save a no-op, just record what would have been changed.
1294 =item C<AUG_NO_LOAD> = 32
1296 Do not load the tree in C<guestfs_aug_init>.
1300 To close the handle, you can call C<guestfs_aug_close>.
1302 To find out more about Augeas, see L<http://augeas.net/>.");
1304 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1305 [], (* XXX Augeas code needs tests. *)
1306 "close the current Augeas handle",
1308 Close the current Augeas handle and free up any resources
1309 used by it. After calling this, you have to call
1310 C<guestfs_aug_init> again before you can use any other
1311 Augeas functions.");
1313 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1314 [], (* XXX Augeas code needs tests. *)
1315 "define an Augeas variable",
1317 Defines an Augeas variable C<name> whose value is the result
1318 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1321 On success this returns the number of nodes in C<expr>, or
1322 C<0> if C<expr> evaluates to something which is not a nodeset.");
1324 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1325 [], (* XXX Augeas code needs tests. *)
1326 "define an Augeas node",
1328 Defines a variable C<name> whose value is the result of
1331 If C<expr> evaluates to an empty nodeset, a node is created,
1332 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1333 C<name> will be the nodeset containing that single node.
1335 On success this returns a pair containing the
1336 number of nodes in the nodeset, and a boolean flag
1337 if a node was created.");
1339 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1340 [], (* XXX Augeas code needs tests. *)
1341 "look up the value of an Augeas path",
1343 Look up the value associated with C<path>. If C<path>
1344 matches exactly one node, the C<value> is returned.");
1346 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1347 [], (* XXX Augeas code needs tests. *)
1348 "set Augeas path to value",
1350 Set the value associated with C<path> to C<val>.
1352 In the Augeas API, it is possible to clear a node by setting
1353 the value to NULL. Due to an oversight in the libguestfs API
1354 you cannot do that with this call. Instead you must use the
1355 C<guestfs_aug_clear> call.");
1357 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1358 [], (* XXX Augeas code needs tests. *)
1359 "insert a sibling Augeas node",
1361 Create a new sibling C<label> for C<path>, inserting it into
1362 the tree before or after C<path> (depending on the boolean
1365 C<path> must match exactly one existing node in the tree, and
1366 C<label> must be a label, ie. not contain C</>, C<*> or end
1367 with a bracketed index C<[N]>.");
1369 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1370 [], (* XXX Augeas code needs tests. *)
1371 "remove an Augeas path",
1373 Remove C<path> and all of its children.
1375 On success this returns the number of entries which were removed.");
1377 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1378 [], (* XXX Augeas code needs tests. *)
1381 Move the node C<src> to C<dest>. C<src> must match exactly
1382 one node. C<dest> is overwritten if it exists.");
1384 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1385 [], (* XXX Augeas code needs tests. *)
1386 "return Augeas nodes which match augpath",
1388 Returns a list of paths which match the path expression C<path>.
1389 The returned paths are sufficiently qualified so that they match
1390 exactly one node in the current tree.");
1392 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1393 [], (* XXX Augeas code needs tests. *)
1394 "write all pending Augeas changes to disk",
1396 This writes all pending changes to disk.
1398 The flags which were passed to C<guestfs_aug_init> affect exactly
1399 how files are saved.");
1401 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1402 [], (* XXX Augeas code needs tests. *)
1403 "load files into the tree",
1405 Load files into the tree.
1407 See C<aug_load> in the Augeas documentation for the full gory
1410 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1411 [], (* XXX Augeas code needs tests. *)
1412 "list Augeas nodes under augpath",
1414 This is just a shortcut for listing C<guestfs_aug_match>
1415 C<path/*> and sorting the resulting nodes into alphabetical order.");
1417 ("rm", (RErr, [Pathname "path"], []), 29, [],
1418 [InitBasicFS, Always, TestRun
1421 InitBasicFS, Always, TestLastFail
1423 InitBasicFS, Always, TestLastFail
1428 Remove the single file C<path>.");
1430 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1431 [InitBasicFS, Always, TestRun
1434 InitBasicFS, Always, TestLastFail
1435 [["rmdir"; "/new"]];
1436 InitBasicFS, Always, TestLastFail
1438 ["rmdir"; "/new"]]],
1439 "remove a directory",
1441 Remove the single directory C<path>.");
1443 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1444 [InitBasicFS, Always, TestOutputFalse
1446 ["mkdir"; "/new/foo"];
1447 ["touch"; "/new/foo/bar"];
1449 ["exists"; "/new"]]],
1450 "remove a file or directory recursively",
1452 Remove the file or directory C<path>, recursively removing the
1453 contents if its a directory. This is like the C<rm -rf> shell
1456 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1457 [InitBasicFS, Always, TestOutputTrue
1459 ["is_dir"; "/new"]];
1460 InitBasicFS, Always, TestLastFail
1461 [["mkdir"; "/new/foo/bar"]]],
1462 "create a directory",
1464 Create a directory named C<path>.");
1466 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1467 [InitBasicFS, Always, TestOutputTrue
1468 [["mkdir_p"; "/new/foo/bar"];
1469 ["is_dir"; "/new/foo/bar"]];
1470 InitBasicFS, Always, TestOutputTrue
1471 [["mkdir_p"; "/new/foo/bar"];
1472 ["is_dir"; "/new/foo"]];
1473 InitBasicFS, Always, TestOutputTrue
1474 [["mkdir_p"; "/new/foo/bar"];
1475 ["is_dir"; "/new"]];
1476 (* Regression tests for RHBZ#503133: *)
1477 InitBasicFS, Always, TestRun
1479 ["mkdir_p"; "/new"]];
1480 InitBasicFS, Always, TestLastFail
1482 ["mkdir_p"; "/new"]]],
1483 "create a directory and parents",
1485 Create a directory named C<path>, creating any parent directories
1486 as necessary. This is like the C<mkdir -p> shell command.");
1488 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1489 [], (* XXX Need stat command to test *)
1492 Change the mode (permissions) of C<path> to C<mode>. Only
1493 numeric modes are supported.
1495 I<Note>: When using this command from guestfish, C<mode>
1496 by default would be decimal, unless you prefix it with
1497 C<0> to get octal, ie. use C<0700> not C<700>.
1499 The mode actually set is affected by the umask.");
1501 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1502 [], (* XXX Need stat command to test *)
1503 "change file owner and group",
1505 Change the file owner to C<owner> and group to C<group>.
1507 Only numeric uid and gid are supported. If you want to use
1508 names, you will need to locate and parse the password file
1509 yourself (Augeas support makes this relatively easy).");
1511 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1512 [InitISOFS, Always, TestOutputTrue (
1513 [["exists"; "/empty"]]);
1514 InitISOFS, Always, TestOutputTrue (
1515 [["exists"; "/directory"]])],
1516 "test if file or directory exists",
1518 This returns C<true> if and only if there is a file, directory
1519 (or anything) with the given C<path> name.
1521 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1523 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1524 [InitISOFS, Always, TestOutputTrue (
1525 [["is_file"; "/known-1"]]);
1526 InitISOFS, Always, TestOutputFalse (
1527 [["is_file"; "/directory"]])],
1528 "test if a regular file",
1530 This returns C<true> if and only if there is a regular file
1531 with the given C<path> name. Note that it returns false for
1532 other objects like directories.
1534 See also C<guestfs_stat>.");
1536 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1537 [InitISOFS, Always, TestOutputFalse (
1538 [["is_dir"; "/known-3"]]);
1539 InitISOFS, Always, TestOutputTrue (
1540 [["is_dir"; "/directory"]])],
1541 "test if a directory",
1543 This returns C<true> if and only if there is a directory
1544 with the given C<path> name. Note that it returns false for
1545 other objects like files.
1547 See also C<guestfs_stat>.");
1549 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1550 [InitEmpty, Always, TestOutputListOfDevices (
1551 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1552 ["pvcreate"; "/dev/sda1"];
1553 ["pvcreate"; "/dev/sda2"];
1554 ["pvcreate"; "/dev/sda3"];
1555 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1556 "create an LVM physical volume",
1558 This creates an LVM physical volume on the named C<device>,
1559 where C<device> should usually be a partition name such
1562 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1563 [InitEmpty, Always, TestOutputList (
1564 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1565 ["pvcreate"; "/dev/sda1"];
1566 ["pvcreate"; "/dev/sda2"];
1567 ["pvcreate"; "/dev/sda3"];
1568 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1569 ["vgcreate"; "VG2"; "/dev/sda3"];
1570 ["vgs"]], ["VG1"; "VG2"])],
1571 "create an LVM volume group",
1573 This creates an LVM volume group called C<volgroup>
1574 from the non-empty list of physical volumes C<physvols>.");
1576 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1577 [InitEmpty, Always, TestOutputList (
1578 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1579 ["pvcreate"; "/dev/sda1"];
1580 ["pvcreate"; "/dev/sda2"];
1581 ["pvcreate"; "/dev/sda3"];
1582 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1583 ["vgcreate"; "VG2"; "/dev/sda3"];
1584 ["lvcreate"; "LV1"; "VG1"; "50"];
1585 ["lvcreate"; "LV2"; "VG1"; "50"];
1586 ["lvcreate"; "LV3"; "VG2"; "50"];
1587 ["lvcreate"; "LV4"; "VG2"; "50"];
1588 ["lvcreate"; "LV5"; "VG2"; "50"];
1590 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1591 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1592 "create an LVM logical volume",
1594 This creates an LVM logical volume called C<logvol>
1595 on the volume group C<volgroup>, with C<size> megabytes.");
1597 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1598 [InitEmpty, Always, TestOutput (
1599 [["part_disk"; "/dev/sda"; "mbr"];
1600 ["mkfs"; "ext2"; "/dev/sda1"];
1601 ["mount_options"; ""; "/dev/sda1"; "/"];
1602 ["write"; "/new"; "new file contents"];
1603 ["cat"; "/new"]], "new file contents")],
1604 "make a filesystem",
1606 This creates a filesystem on C<device> (usually a partition
1607 or LVM logical volume). The filesystem type is C<fstype>, for
1610 ("sfdisk", (RErr, [Device "device";
1611 Int "cyls"; Int "heads"; Int "sectors";
1612 StringList "lines"], []), 43, [DangerWillRobinson],
1614 "create partitions on a block device",
1616 This is a direct interface to the L<sfdisk(8)> program for creating
1617 partitions on block devices.
1619 C<device> should be a block device, for example C</dev/sda>.
1621 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1622 and sectors on the device, which are passed directly to sfdisk as
1623 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1624 of these, then the corresponding parameter is omitted. Usually for
1625 'large' disks, you can just pass C<0> for these, but for small
1626 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1627 out the right geometry and you will need to tell it.
1629 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1630 information refer to the L<sfdisk(8)> manpage.
1632 To create a single partition occupying the whole disk, you would
1633 pass C<lines> as a single element list, when the single element being
1634 the string C<,> (comma).
1636 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1637 C<guestfs_part_init>");
1639 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1640 (* Regression test for RHBZ#597135. *)
1641 [InitBasicFS, Always, TestLastFail
1642 [["write_file"; "/new"; "abc"; "10000"]]],
1645 This call creates a file called C<path>. The contents of the
1646 file is the string C<content> (which can contain any 8 bit data),
1647 with length C<size>.
1649 As a special case, if C<size> is C<0>
1650 then the length is calculated using C<strlen> (so in this case
1651 the content cannot contain embedded ASCII NULs).
1653 I<NB.> Owing to a bug, writing content containing ASCII NUL
1654 characters does I<not> work, even if the length is specified.");
1656 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1657 [InitEmpty, Always, TestOutputListOfDevices (
1658 [["part_disk"; "/dev/sda"; "mbr"];
1659 ["mkfs"; "ext2"; "/dev/sda1"];
1660 ["mount_options"; ""; "/dev/sda1"; "/"];
1661 ["mounts"]], ["/dev/sda1"]);
1662 InitEmpty, Always, TestOutputList (
1663 [["part_disk"; "/dev/sda"; "mbr"];
1664 ["mkfs"; "ext2"; "/dev/sda1"];
1665 ["mount_options"; ""; "/dev/sda1"; "/"];
1668 "unmount a filesystem",
1670 This unmounts the given filesystem. The filesystem may be
1671 specified either by its mountpoint (path) or the device which
1672 contains the filesystem.");
1674 ("mounts", (RStringList "devices", [], []), 46, [],
1675 [InitBasicFS, Always, TestOutputListOfDevices (
1676 [["mounts"]], ["/dev/sda1"])],
1677 "show mounted filesystems",
1679 This returns the list of currently mounted filesystems. It returns
1680 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1682 Some internal mounts are not shown.
1684 See also: C<guestfs_mountpoints>");
1686 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1687 [InitBasicFS, Always, TestOutputList (
1690 (* check that umount_all can unmount nested mounts correctly: *)
1691 InitEmpty, Always, TestOutputList (
1692 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1693 ["mkfs"; "ext2"; "/dev/sda1"];
1694 ["mkfs"; "ext2"; "/dev/sda2"];
1695 ["mkfs"; "ext2"; "/dev/sda3"];
1696 ["mount_options"; ""; "/dev/sda1"; "/"];
1698 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1699 ["mkdir"; "/mp1/mp2"];
1700 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1701 ["mkdir"; "/mp1/mp2/mp3"];
1704 "unmount all filesystems",
1706 This unmounts all mounted filesystems.
1708 Some internal mounts are not unmounted by this call.");
1710 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1712 "remove all LVM LVs, VGs and PVs",
1714 This command removes all LVM logical volumes, volume groups
1715 and physical volumes.");
1717 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
1718 [InitISOFS, Always, TestOutput (
1719 [["file"; "/empty"]], "empty");
1720 InitISOFS, Always, TestOutput (
1721 [["file"; "/known-1"]], "ASCII text");
1722 InitISOFS, Always, TestLastFail (
1723 [["file"; "/notexists"]]);
1724 InitISOFS, Always, TestOutput (
1725 [["file"; "/abssymlink"]], "symbolic link");
1726 InitISOFS, Always, TestOutput (
1727 [["file"; "/directory"]], "directory")],
1728 "determine file type",
1730 This call uses the standard L<file(1)> command to determine
1731 the type or contents of the file.
1733 This call will also transparently look inside various types
1736 The exact command which runs is C<file -zb path>. Note in
1737 particular that the filename is not prepended to the output
1740 This command can also be used on C</dev/> devices
1741 (and partitions, LV names). You can for example use this
1742 to determine if a device contains a filesystem, although
1743 it's usually better to use C<guestfs_vfs_type>.
1745 If the C<path> does not begin with C</dev/> then
1746 this command only works for the content of regular files.
1747 For other file types (directory, symbolic link etc) it
1748 will just return the string C<directory> etc.");
1750 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
1751 [InitBasicFS, Always, TestOutput (
1752 [["upload"; "test-command"; "/test-command"];
1753 ["chmod"; "0o755"; "/test-command"];
1754 ["command"; "/test-command 1"]], "Result1");
1755 InitBasicFS, Always, TestOutput (
1756 [["upload"; "test-command"; "/test-command"];
1757 ["chmod"; "0o755"; "/test-command"];
1758 ["command"; "/test-command 2"]], "Result2\n");
1759 InitBasicFS, Always, TestOutput (
1760 [["upload"; "test-command"; "/test-command"];
1761 ["chmod"; "0o755"; "/test-command"];
1762 ["command"; "/test-command 3"]], "\nResult3");
1763 InitBasicFS, Always, TestOutput (
1764 [["upload"; "test-command"; "/test-command"];
1765 ["chmod"; "0o755"; "/test-command"];
1766 ["command"; "/test-command 4"]], "\nResult4\n");
1767 InitBasicFS, Always, TestOutput (
1768 [["upload"; "test-command"; "/test-command"];
1769 ["chmod"; "0o755"; "/test-command"];
1770 ["command"; "/test-command 5"]], "\nResult5\n\n");
1771 InitBasicFS, Always, TestOutput (
1772 [["upload"; "test-command"; "/test-command"];
1773 ["chmod"; "0o755"; "/test-command"];
1774 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1775 InitBasicFS, Always, TestOutput (
1776 [["upload"; "test-command"; "/test-command"];
1777 ["chmod"; "0o755"; "/test-command"];
1778 ["command"; "/test-command 7"]], "");
1779 InitBasicFS, Always, TestOutput (
1780 [["upload"; "test-command"; "/test-command"];
1781 ["chmod"; "0o755"; "/test-command"];
1782 ["command"; "/test-command 8"]], "\n");
1783 InitBasicFS, Always, TestOutput (
1784 [["upload"; "test-command"; "/test-command"];
1785 ["chmod"; "0o755"; "/test-command"];
1786 ["command"; "/test-command 9"]], "\n\n");
1787 InitBasicFS, Always, TestOutput (
1788 [["upload"; "test-command"; "/test-command"];
1789 ["chmod"; "0o755"; "/test-command"];
1790 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1791 InitBasicFS, Always, TestOutput (
1792 [["upload"; "test-command"; "/test-command"];
1793 ["chmod"; "0o755"; "/test-command"];
1794 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1795 InitBasicFS, Always, TestLastFail (
1796 [["upload"; "test-command"; "/test-command"];
1797 ["chmod"; "0o755"; "/test-command"];
1798 ["command"; "/test-command"]])],
1799 "run a command from the guest filesystem",
1801 This call runs a command from the guest filesystem. The
1802 filesystem must be mounted, and must contain a compatible
1803 operating system (ie. something Linux, with the same
1804 or compatible processor architecture).
1806 The single parameter is an argv-style list of arguments.
1807 The first element is the name of the program to run.
1808 Subsequent elements are parameters. The list must be
1809 non-empty (ie. must contain a program name). Note that
1810 the command runs directly, and is I<not> invoked via
1811 the shell (see C<guestfs_sh>).
1813 The return value is anything printed to I<stdout> by
1816 If the command returns a non-zero exit status, then
1817 this function returns an error message. The error message
1818 string is the content of I<stderr> from the command.
1820 The C<$PATH> environment variable will contain at least
1821 C</usr/bin> and C</bin>. If you require a program from
1822 another location, you should provide the full path in the
1825 Shared libraries and data files required by the program
1826 must be available on filesystems which are mounted in the
1827 correct places. It is the caller's responsibility to ensure
1828 all filesystems that are needed are mounted at the right
1831 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
1832 [InitBasicFS, Always, TestOutputList (
1833 [["upload"; "test-command"; "/test-command"];
1834 ["chmod"; "0o755"; "/test-command"];
1835 ["command_lines"; "/test-command 1"]], ["Result1"]);
1836 InitBasicFS, Always, TestOutputList (
1837 [["upload"; "test-command"; "/test-command"];
1838 ["chmod"; "0o755"; "/test-command"];
1839 ["command_lines"; "/test-command 2"]], ["Result2"]);
1840 InitBasicFS, Always, TestOutputList (
1841 [["upload"; "test-command"; "/test-command"];
1842 ["chmod"; "0o755"; "/test-command"];
1843 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1844 InitBasicFS, Always, TestOutputList (
1845 [["upload"; "test-command"; "/test-command"];
1846 ["chmod"; "0o755"; "/test-command"];
1847 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1848 InitBasicFS, Always, TestOutputList (
1849 [["upload"; "test-command"; "/test-command"];
1850 ["chmod"; "0o755"; "/test-command"];
1851 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1852 InitBasicFS, Always, TestOutputList (
1853 [["upload"; "test-command"; "/test-command"];
1854 ["chmod"; "0o755"; "/test-command"];
1855 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1856 InitBasicFS, Always, TestOutputList (
1857 [["upload"; "test-command"; "/test-command"];
1858 ["chmod"; "0o755"; "/test-command"];
1859 ["command_lines"; "/test-command 7"]], []);
1860 InitBasicFS, Always, TestOutputList (
1861 [["upload"; "test-command"; "/test-command"];
1862 ["chmod"; "0o755"; "/test-command"];
1863 ["command_lines"; "/test-command 8"]], [""]);
1864 InitBasicFS, Always, TestOutputList (
1865 [["upload"; "test-command"; "/test-command"];
1866 ["chmod"; "0o755"; "/test-command"];
1867 ["command_lines"; "/test-command 9"]], ["";""]);
1868 InitBasicFS, Always, TestOutputList (
1869 [["upload"; "test-command"; "/test-command"];
1870 ["chmod"; "0o755"; "/test-command"];
1871 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1872 InitBasicFS, Always, TestOutputList (
1873 [["upload"; "test-command"; "/test-command"];
1874 ["chmod"; "0o755"; "/test-command"];
1875 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1876 "run a command, returning lines",
1878 This is the same as C<guestfs_command>, but splits the
1879 result into a list of lines.
1881 See also: C<guestfs_sh_lines>");
1883 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
1884 [InitISOFS, Always, TestOutputStruct (
1885 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1886 "get file information",
1888 Returns file information for the given C<path>.
1890 This is the same as the C<stat(2)> system call.");
1892 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
1893 [InitISOFS, Always, TestOutputStruct (
1894 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1895 "get file information for a symbolic link",
1897 Returns file information for the given C<path>.
1899 This is the same as C<guestfs_stat> except that if C<path>
1900 is a symbolic link, then the link is stat-ed, not the file it
1903 This is the same as the C<lstat(2)> system call.");
1905 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
1906 [InitISOFS, Always, TestOutputStruct (
1907 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1908 "get file system statistics",
1910 Returns file system statistics for any mounted file system.
1911 C<path> should be a file or directory in the mounted file system
1912 (typically it is the mount point itself, but it doesn't need to be).
1914 This is the same as the C<statvfs(2)> system call.");
1916 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
1918 "get ext2/ext3/ext4 superblock details",
1920 This returns the contents of the ext2, ext3 or ext4 filesystem
1921 superblock on C<device>.
1923 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1924 manpage for more details. The list of fields returned isn't
1925 clearly defined, and depends on both the version of C<tune2fs>
1926 that libguestfs was built against, and the filesystem itself.");
1928 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
1929 [InitEmpty, Always, TestOutputTrue (
1930 [["blockdev_setro"; "/dev/sda"];
1931 ["blockdev_getro"; "/dev/sda"]])],
1932 "set block device to read-only",
1934 Sets the block device named C<device> to read-only.
1936 This uses the L<blockdev(8)> command.");
1938 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
1939 [InitEmpty, Always, TestOutputFalse (
1940 [["blockdev_setrw"; "/dev/sda"];
1941 ["blockdev_getro"; "/dev/sda"]])],
1942 "set block device to read-write",
1944 Sets the block device named C<device> to read-write.
1946 This uses the L<blockdev(8)> command.");
1948 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
1949 [InitEmpty, Always, TestOutputTrue (
1950 [["blockdev_setro"; "/dev/sda"];
1951 ["blockdev_getro"; "/dev/sda"]])],
1952 "is block device set to read-only",
1954 Returns a boolean indicating if the block device is read-only
1955 (true if read-only, false if not).
1957 This uses the L<blockdev(8)> command.");
1959 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
1960 [InitEmpty, Always, TestOutputInt (
1961 [["blockdev_getss"; "/dev/sda"]], 512)],
1962 "get sectorsize of block device",
1964 This returns the size of sectors on a block device.
1965 Usually 512, but can be larger for modern devices.
1967 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1970 This uses the L<blockdev(8)> command.");
1972 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
1973 [InitEmpty, Always, TestOutputInt (
1974 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1975 "get blocksize of block device",
1977 This returns the block size of a device.
1979 (Note this is different from both I<size in blocks> and
1980 I<filesystem block size>).
1982 This uses the L<blockdev(8)> command.");
1984 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
1986 "set blocksize of block device",
1988 This sets the block size of a device.
1990 (Note this is different from both I<size in blocks> and
1991 I<filesystem block size>).
1993 This uses the L<blockdev(8)> command.");
1995 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
1996 [InitEmpty, Always, TestOutputInt (
1997 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1998 "get total size of device in 512-byte sectors",
2000 This returns the size of the device in units of 512-byte sectors
2001 (even if the sectorsize isn't 512 bytes ... weird).
2003 See also C<guestfs_blockdev_getss> for the real sector size of
2004 the device, and C<guestfs_blockdev_getsize64> for the more
2005 useful I<size in bytes>.
2007 This uses the L<blockdev(8)> command.");
2009 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2010 [InitEmpty, Always, TestOutputInt (
2011 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2012 "get total size of device in bytes",
2014 This returns the size of the device in bytes.
2016 See also C<guestfs_blockdev_getsz>.
2018 This uses the L<blockdev(8)> command.");
2020 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2021 [InitEmpty, Always, TestRun
2022 [["blockdev_flushbufs"; "/dev/sda"]]],
2023 "flush device buffers",
2025 This tells the kernel to flush internal buffers associated
2028 This uses the L<blockdev(8)> command.");
2030 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2031 [InitEmpty, Always, TestRun
2032 [["blockdev_rereadpt"; "/dev/sda"]]],
2033 "reread partition table",
2035 Reread the partition table on C<device>.
2037 This uses the L<blockdev(8)> command.");
2039 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2040 [InitBasicFS, Always, TestOutput (
2041 (* Pick a file from cwd which isn't likely to change. *)
2042 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2043 ["checksum"; "md5"; "/COPYING.LIB"]],
2044 Digest.to_hex (Digest.file "COPYING.LIB"))],
2045 "upload a file from the local machine",
2047 Upload local file C<filename> to C<remotefilename> on the
2050 C<filename> can also be a named pipe.
2052 See also C<guestfs_download>.");
2054 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2055 [InitBasicFS, Always, TestOutput (
2056 (* Pick a file from cwd which isn't likely to change. *)
2057 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2058 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2059 ["upload"; "testdownload.tmp"; "/upload"];
2060 ["checksum"; "md5"; "/upload"]],
2061 Digest.to_hex (Digest.file "COPYING.LIB"))],
2062 "download a file to the local machine",
2064 Download file C<remotefilename> and save it as C<filename>
2065 on the local machine.
2067 C<filename> can also be a named pipe.
2069 See also C<guestfs_upload>, C<guestfs_cat>.");
2071 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2072 [InitISOFS, Always, TestOutput (
2073 [["checksum"; "crc"; "/known-3"]], "2891671662");
2074 InitISOFS, Always, TestLastFail (
2075 [["checksum"; "crc"; "/notexists"]]);
2076 InitISOFS, Always, TestOutput (
2077 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2078 InitISOFS, Always, TestOutput (
2079 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2080 InitISOFS, Always, TestOutput (
2081 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2082 InitISOFS, Always, TestOutput (
2083 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2084 InitISOFS, Always, TestOutput (
2085 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2086 InitISOFS, Always, TestOutput (
2087 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2088 (* Test for RHBZ#579608, absolute symbolic links. *)
2089 InitISOFS, Always, TestOutput (
2090 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2091 "compute MD5, SHAx or CRC checksum of file",
2093 This call computes the MD5, SHAx or CRC checksum of the
2096 The type of checksum to compute is given by the C<csumtype>
2097 parameter which must have one of the following values:
2103 Compute the cyclic redundancy check (CRC) specified by POSIX
2104 for the C<cksum> command.
2108 Compute the MD5 hash (using the C<md5sum> program).
2112 Compute the SHA1 hash (using the C<sha1sum> program).
2116 Compute the SHA224 hash (using the C<sha224sum> program).
2120 Compute the SHA256 hash (using the C<sha256sum> program).
2124 Compute the SHA384 hash (using the C<sha384sum> program).
2128 Compute the SHA512 hash (using the C<sha512sum> program).
2132 The checksum is returned as a printable string.
2134 To get the checksum for a device, use C<guestfs_checksum_device>.
2136 To get the checksums for many files, use C<guestfs_checksums_out>.");
2138 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2139 [InitBasicFS, Always, TestOutput (
2140 [["tar_in"; "../images/helloworld.tar"; "/"];
2141 ["cat"; "/hello"]], "hello\n")],
2142 "unpack tarfile to directory",
2144 This command uploads and unpacks local file C<tarfile> (an
2145 I<uncompressed> tar file) into C<directory>.
2147 To upload a compressed tarball, use C<guestfs_tgz_in>
2148 or C<guestfs_txz_in>.");
2150 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2152 "pack directory into tarfile",
2154 This command packs the contents of C<directory> and downloads
2155 it to local file C<tarfile>.
2157 To download a compressed tarball, use C<guestfs_tgz_out>
2158 or C<guestfs_txz_out>.");
2160 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2161 [InitBasicFS, Always, TestOutput (
2162 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2163 ["cat"; "/hello"]], "hello\n")],
2164 "unpack compressed tarball to directory",
2166 This command uploads and unpacks local file C<tarball> (a
2167 I<gzip compressed> tar file) into C<directory>.
2169 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2171 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2173 "pack directory into compressed tarball",
2175 This command packs the contents of C<directory> and downloads
2176 it to local file C<tarball>.
2178 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2180 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2181 [InitBasicFS, Always, TestLastFail (
2183 ["mount_ro"; "/dev/sda1"; "/"];
2184 ["touch"; "/new"]]);
2185 InitBasicFS, Always, TestOutput (
2186 [["write"; "/new"; "data"];
2188 ["mount_ro"; "/dev/sda1"; "/"];
2189 ["cat"; "/new"]], "data")],
2190 "mount a guest disk, read-only",
2192 This is the same as the C<guestfs_mount> command, but it
2193 mounts the filesystem with the read-only (I<-o ro>) flag.");
2195 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2197 "mount a guest disk with mount options",
2199 This is the same as the C<guestfs_mount> command, but it
2200 allows you to set the mount options as for the
2201 L<mount(8)> I<-o> flag.
2203 If the C<options> parameter is an empty string, then
2204 no options are passed (all options default to whatever
2205 the filesystem uses).");
2207 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2209 "mount a guest disk with mount options and vfstype",
2211 This is the same as the C<guestfs_mount> command, but it
2212 allows you to set both the mount options and the vfstype
2213 as for the L<mount(8)> I<-o> and I<-t> flags.");
2215 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [],
2217 "debugging and internals",
2219 The C<guestfs_debug> command exposes some internals of
2220 C<guestfsd> (the guestfs daemon) that runs inside the
2223 There is no comprehensive help for this command. You have
2224 to look at the file C<daemon/debug.c> in the libguestfs source
2225 to find out what you can do.");
2227 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2228 [InitEmpty, Always, TestOutputList (
2229 [["part_disk"; "/dev/sda"; "mbr"];
2230 ["pvcreate"; "/dev/sda1"];
2231 ["vgcreate"; "VG"; "/dev/sda1"];
2232 ["lvcreate"; "LV1"; "VG"; "50"];
2233 ["lvcreate"; "LV2"; "VG"; "50"];
2234 ["lvremove"; "/dev/VG/LV1"];
2235 ["lvs"]], ["/dev/VG/LV2"]);
2236 InitEmpty, Always, TestOutputList (
2237 [["part_disk"; "/dev/sda"; "mbr"];
2238 ["pvcreate"; "/dev/sda1"];
2239 ["vgcreate"; "VG"; "/dev/sda1"];
2240 ["lvcreate"; "LV1"; "VG"; "50"];
2241 ["lvcreate"; "LV2"; "VG"; "50"];
2242 ["lvremove"; "/dev/VG"];
2244 InitEmpty, Always, TestOutputList (
2245 [["part_disk"; "/dev/sda"; "mbr"];
2246 ["pvcreate"; "/dev/sda1"];
2247 ["vgcreate"; "VG"; "/dev/sda1"];
2248 ["lvcreate"; "LV1"; "VG"; "50"];
2249 ["lvcreate"; "LV2"; "VG"; "50"];
2250 ["lvremove"; "/dev/VG"];
2252 "remove an LVM logical volume",
2254 Remove an LVM logical volume C<device>, where C<device> is
2255 the path to the LV, such as C</dev/VG/LV>.
2257 You can also remove all LVs in a volume group by specifying
2258 the VG name, C</dev/VG>.");
2260 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2261 [InitEmpty, Always, TestOutputList (
2262 [["part_disk"; "/dev/sda"; "mbr"];
2263 ["pvcreate"; "/dev/sda1"];
2264 ["vgcreate"; "VG"; "/dev/sda1"];
2265 ["lvcreate"; "LV1"; "VG"; "50"];
2266 ["lvcreate"; "LV2"; "VG"; "50"];
2269 InitEmpty, Always, TestOutputList (
2270 [["part_disk"; "/dev/sda"; "mbr"];
2271 ["pvcreate"; "/dev/sda1"];
2272 ["vgcreate"; "VG"; "/dev/sda1"];
2273 ["lvcreate"; "LV1"; "VG"; "50"];
2274 ["lvcreate"; "LV2"; "VG"; "50"];
2277 "remove an LVM volume group",
2279 Remove an LVM volume group C<vgname>, (for example C<VG>).
2281 This also forcibly removes all logical volumes in the volume
2284 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2285 [InitEmpty, Always, TestOutputListOfDevices (
2286 [["part_disk"; "/dev/sda"; "mbr"];
2287 ["pvcreate"; "/dev/sda1"];
2288 ["vgcreate"; "VG"; "/dev/sda1"];
2289 ["lvcreate"; "LV1"; "VG"; "50"];
2290 ["lvcreate"; "LV2"; "VG"; "50"];
2292 ["pvremove"; "/dev/sda1"];
2294 InitEmpty, Always, TestOutputListOfDevices (
2295 [["part_disk"; "/dev/sda"; "mbr"];
2296 ["pvcreate"; "/dev/sda1"];
2297 ["vgcreate"; "VG"; "/dev/sda1"];
2298 ["lvcreate"; "LV1"; "VG"; "50"];
2299 ["lvcreate"; "LV2"; "VG"; "50"];
2301 ["pvremove"; "/dev/sda1"];
2303 InitEmpty, Always, TestOutputListOfDevices (
2304 [["part_disk"; "/dev/sda"; "mbr"];
2305 ["pvcreate"; "/dev/sda1"];
2306 ["vgcreate"; "VG"; "/dev/sda1"];
2307 ["lvcreate"; "LV1"; "VG"; "50"];
2308 ["lvcreate"; "LV2"; "VG"; "50"];
2310 ["pvremove"; "/dev/sda1"];
2312 "remove an LVM physical volume",
2314 This wipes a physical volume C<device> so that LVM will no longer
2317 The implementation uses the C<pvremove> command which refuses to
2318 wipe physical volumes that contain any volume groups, so you have
2319 to remove those first.");
2321 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2322 [InitBasicFS, Always, TestOutput (
2323 [["set_e2label"; "/dev/sda1"; "testlabel"];
2324 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2325 "set the ext2/3/4 filesystem label",
2327 This sets the ext2/3/4 filesystem label of the filesystem on
2328 C<device> to C<label>. Filesystem labels are limited to
2331 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2332 to return the existing label on a filesystem.");
2334 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2336 "get the ext2/3/4 filesystem label",
2338 This returns the ext2/3/4 filesystem label of the filesystem on
2341 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2342 (let uuid = uuidgen () in
2343 [InitBasicFS, Always, TestOutput (
2344 [["set_e2uuid"; "/dev/sda1"; uuid];
2345 ["get_e2uuid"; "/dev/sda1"]], uuid);
2346 InitBasicFS, Always, TestOutput (
2347 [["set_e2uuid"; "/dev/sda1"; "clear"];
2348 ["get_e2uuid"; "/dev/sda1"]], "");
2349 (* We can't predict what UUIDs will be, so just check the commands run. *)
2350 InitBasicFS, Always, TestRun (
2351 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2352 InitBasicFS, Always, TestRun (
2353 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2354 "set the ext2/3/4 filesystem UUID",
2356 This sets the ext2/3/4 filesystem UUID of the filesystem on
2357 C<device> to C<uuid>. The format of the UUID and alternatives
2358 such as C<clear>, C<random> and C<time> are described in the
2359 L<tune2fs(8)> manpage.
2361 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2362 to return the existing UUID of a filesystem.");
2364 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2365 (* Regression test for RHBZ#597112. *)
2366 (let uuid = uuidgen () in
2367 [InitBasicFS, Always, TestOutput (
2368 [["mke2journal"; "1024"; "/dev/sdb"];
2369 ["set_e2uuid"; "/dev/sdb"; uuid];
2370 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2371 "get the ext2/3/4 filesystem UUID",
2373 This returns the ext2/3/4 filesystem UUID of the filesystem on
2376 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2377 [InitBasicFS, Always, TestOutputInt (
2378 [["umount"; "/dev/sda1"];
2379 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2380 InitBasicFS, Always, TestOutputInt (
2381 [["umount"; "/dev/sda1"];
2382 ["zero"; "/dev/sda1"];
2383 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2384 "run the filesystem checker",
2386 This runs the filesystem checker (fsck) on C<device> which
2387 should have filesystem type C<fstype>.
2389 The returned integer is the status. See L<fsck(8)> for the
2390 list of status codes from C<fsck>.
2398 Multiple status codes can be summed together.
2402 A non-zero return code can mean \"success\", for example if
2403 errors have been corrected on the filesystem.
2407 Checking or repairing NTFS volumes is not supported
2412 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2414 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2415 [InitBasicFS, Always, TestOutput (
2416 [["umount"; "/dev/sda1"];
2417 ["zero"; "/dev/sda1"];
2418 ["file"; "/dev/sda1"]], "data")],
2419 "write zeroes to the device",
2421 This command writes zeroes over the first few blocks of C<device>.
2423 How many blocks are zeroed isn't specified (but it's I<not> enough
2424 to securely wipe the device). It should be sufficient to remove
2425 any partition tables, filesystem superblocks and so on.
2427 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2429 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2431 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2432 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2434 [InitBasicFS, Always, TestOutputTrue (
2435 [["mkdir_p"; "/boot/grub"];
2436 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2437 ["grub_install"; "/"; "/dev/vda"];
2438 ["is_dir"; "/boot"]])],
2441 This command installs GRUB (the Grand Unified Bootloader) on
2442 C<device>, with the root directory being C<root>.
2444 Note: If grub-install reports the error
2445 \"No suitable drive was found in the generated device map.\"
2446 it may be that you need to create a C</boot/grub/device.map>
2447 file first that contains the mapping between grub device names
2448 and Linux device names. It is usually sufficient to create
2453 replacing C</dev/vda> with the name of the installation device.");
2455 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2456 [InitBasicFS, Always, TestOutput (
2457 [["write"; "/old"; "file content"];
2458 ["cp"; "/old"; "/new"];
2459 ["cat"; "/new"]], "file content");
2460 InitBasicFS, Always, TestOutputTrue (
2461 [["write"; "/old"; "file content"];
2462 ["cp"; "/old"; "/new"];
2463 ["is_file"; "/old"]]);
2464 InitBasicFS, Always, TestOutput (
2465 [["write"; "/old"; "file content"];
2467 ["cp"; "/old"; "/dir/new"];
2468 ["cat"; "/dir/new"]], "file content")],
2471 This copies a file from C<src> to C<dest> where C<dest> is
2472 either a destination filename or destination directory.");
2474 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2475 [InitBasicFS, Always, TestOutput (
2476 [["mkdir"; "/olddir"];
2477 ["mkdir"; "/newdir"];
2478 ["write"; "/olddir/file"; "file content"];
2479 ["cp_a"; "/olddir"; "/newdir"];
2480 ["cat"; "/newdir/olddir/file"]], "file content")],
2481 "copy a file or directory recursively",
2483 This copies a file or directory from C<src> to C<dest>
2484 recursively using the C<cp -a> command.");
2486 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2487 [InitBasicFS, Always, TestOutput (
2488 [["write"; "/old"; "file content"];
2489 ["mv"; "/old"; "/new"];
2490 ["cat"; "/new"]], "file content");
2491 InitBasicFS, Always, TestOutputFalse (
2492 [["write"; "/old"; "file content"];
2493 ["mv"; "/old"; "/new"];
2494 ["is_file"; "/old"]])],
2497 This moves a file from C<src> to C<dest> where C<dest> is
2498 either a destination filename or destination directory.");
2500 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2501 [InitEmpty, Always, TestRun (
2502 [["drop_caches"; "3"]])],
2503 "drop kernel page cache, dentries and inodes",
2505 This instructs the guest kernel to drop its page cache,
2506 and/or dentries and inode caches. The parameter C<whattodrop>
2507 tells the kernel what precisely to drop, see
2508 L<http://linux-mm.org/Drop_Caches>
2510 Setting C<whattodrop> to 3 should drop everything.
2512 This automatically calls L<sync(2)> before the operation,
2513 so that the maximum guest memory is freed.");
2515 ("dmesg", (RString "kmsgs", [], []), 91, [],
2516 [InitEmpty, Always, TestRun (
2518 "return kernel messages",
2520 This returns the kernel messages (C<dmesg> output) from
2521 the guest kernel. This is sometimes useful for extended
2522 debugging of problems.
2524 Another way to get the same information is to enable
2525 verbose messages with C<guestfs_set_verbose> or by setting
2526 the environment variable C<LIBGUESTFS_DEBUG=1> before
2527 running the program.");
2529 ("ping_daemon", (RErr, [], []), 92, [],
2530 [InitEmpty, Always, TestRun (
2531 [["ping_daemon"]])],
2532 "ping the guest daemon",
2534 This is a test probe into the guestfs daemon running inside
2535 the qemu subprocess. Calling this function checks that the
2536 daemon responds to the ping message, without affecting the daemon
2537 or attached block device(s) in any other way.");
2539 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2540 [InitBasicFS, Always, TestOutputTrue (
2541 [["write"; "/file1"; "contents of a file"];
2542 ["cp"; "/file1"; "/file2"];
2543 ["equal"; "/file1"; "/file2"]]);
2544 InitBasicFS, Always, TestOutputFalse (
2545 [["write"; "/file1"; "contents of a file"];
2546 ["write"; "/file2"; "contents of another file"];
2547 ["equal"; "/file1"; "/file2"]]);
2548 InitBasicFS, Always, TestLastFail (
2549 [["equal"; "/file1"; "/file2"]])],
2550 "test if two files have equal contents",
2552 This compares the two files C<file1> and C<file2> and returns
2553 true if their content is exactly equal, or false otherwise.
2555 The external L<cmp(1)> program is used for the comparison.");
2557 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2558 [InitISOFS, Always, TestOutputList (
2559 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2560 InitISOFS, Always, TestOutputList (
2561 [["strings"; "/empty"]], []);
2562 (* Test for RHBZ#579608, absolute symbolic links. *)
2563 InitISOFS, Always, TestRun (
2564 [["strings"; "/abssymlink"]])],
2565 "print the printable strings in a file",
2567 This runs the L<strings(1)> command on a file and returns
2568 the list of printable strings found.");
2570 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2571 [InitISOFS, Always, TestOutputList (
2572 [["strings_e"; "b"; "/known-5"]], []);
2573 InitBasicFS, Always, TestOutputList (
2574 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2575 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2576 "print the printable strings in a file",
2578 This is like the C<guestfs_strings> command, but allows you to
2579 specify the encoding of strings that are looked for in
2580 the source file C<path>.
2582 Allowed encodings are:
2588 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2589 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2593 Single 8-bit-byte characters.
2597 16-bit big endian strings such as those encoded in
2598 UTF-16BE or UCS-2BE.
2600 =item l (lower case letter L)
2602 16-bit little endian such as UTF-16LE and UCS-2LE.
2603 This is useful for examining binaries in Windows guests.
2607 32-bit big endian such as UCS-4BE.
2611 32-bit little endian such as UCS-4LE.
2615 The returned strings are transcoded to UTF-8.");
2617 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2618 [InitISOFS, Always, TestOutput (
2619 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2620 (* Test for RHBZ#501888c2 regression which caused large hexdump
2621 * commands to segfault.
2623 InitISOFS, Always, TestRun (
2624 [["hexdump"; "/100krandom"]]);
2625 (* Test for RHBZ#579608, absolute symbolic links. *)
2626 InitISOFS, Always, TestRun (
2627 [["hexdump"; "/abssymlink"]])],
2628 "dump a file in hexadecimal",
2630 This runs C<hexdump -C> on the given C<path>. The result is
2631 the human-readable, canonical hex dump of the file.");
2633 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2634 [InitNone, Always, TestOutput (
2635 [["part_disk"; "/dev/sda"; "mbr"];
2636 ["mkfs"; "ext3"; "/dev/sda1"];
2637 ["mount_options"; ""; "/dev/sda1"; "/"];
2638 ["write"; "/new"; "test file"];
2639 ["umount"; "/dev/sda1"];
2640 ["zerofree"; "/dev/sda1"];
2641 ["mount_options"; ""; "/dev/sda1"; "/"];
2642 ["cat"; "/new"]], "test file")],
2643 "zero unused inodes and disk blocks on ext2/3 filesystem",
2645 This runs the I<zerofree> program on C<device>. This program
2646 claims to zero unused inodes and disk blocks on an ext2/3
2647 filesystem, thus making it possible to compress the filesystem
2650 You should B<not> run this program if the filesystem is
2653 It is possible that using this program can damage the filesystem
2654 or data on the filesystem.");
2656 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2658 "resize an LVM physical volume",
2660 This resizes (expands or shrinks) an existing LVM physical
2661 volume to match the new size of the underlying device.");
2663 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2664 Int "cyls"; Int "heads"; Int "sectors";
2665 String "line"], []), 99, [DangerWillRobinson],
2667 "modify a single partition on a block device",
2669 This runs L<sfdisk(8)> option to modify just the single
2670 partition C<n> (note: C<n> counts from 1).
2672 For other parameters, see C<guestfs_sfdisk>. You should usually
2673 pass C<0> for the cyls/heads/sectors parameters.
2675 See also: C<guestfs_part_add>");
2677 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2679 "display the partition table",
2681 This displays the partition table on C<device>, in the
2682 human-readable output of the L<sfdisk(8)> command. It is
2683 not intended to be parsed.
2685 See also: C<guestfs_part_list>");
2687 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2689 "display the kernel geometry",
2691 This displays the kernel's idea of the geometry of C<device>.
2693 The result is in human-readable format, and not designed to
2696 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2698 "display the disk geometry from the partition table",
2700 This displays the disk geometry of C<device> read from the
2701 partition table. Especially in the case where the underlying
2702 block device has been resized, this can be different from the
2703 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2705 The result is in human-readable format, and not designed to
2708 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2710 "activate or deactivate all volume groups",
2712 This command activates or (if C<activate> is false) deactivates
2713 all logical volumes in all volume groups.
2714 If activated, then they are made known to the
2715 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2716 then those devices disappear.
2718 This command is the same as running C<vgchange -a y|n>");
2720 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
2722 "activate or deactivate some volume groups",
2724 This command activates or (if C<activate> is false) deactivates
2725 all logical volumes in the listed volume groups C<volgroups>.
2726 If activated, then they are made known to the
2727 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2728 then those devices disappear.
2730 This command is the same as running C<vgchange -a y|n volgroups...>
2732 Note that if C<volgroups> is an empty list then B<all> volume groups
2733 are activated or deactivated.");
2735 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
2736 [InitNone, Always, TestOutput (
2737 [["part_disk"; "/dev/sda"; "mbr"];
2738 ["pvcreate"; "/dev/sda1"];
2739 ["vgcreate"; "VG"; "/dev/sda1"];
2740 ["lvcreate"; "LV"; "VG"; "10"];
2741 ["mkfs"; "ext2"; "/dev/VG/LV"];
2742 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2743 ["write"; "/new"; "test content"];
2745 ["lvresize"; "/dev/VG/LV"; "20"];
2746 ["e2fsck_f"; "/dev/VG/LV"];
2747 ["resize2fs"; "/dev/VG/LV"];
2748 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2749 ["cat"; "/new"]], "test content");
2750 InitNone, Always, TestRun (
2751 (* Make an LV smaller to test RHBZ#587484. *)
2752 [["part_disk"; "/dev/sda"; "mbr"];
2753 ["pvcreate"; "/dev/sda1"];
2754 ["vgcreate"; "VG"; "/dev/sda1"];
2755 ["lvcreate"; "LV"; "VG"; "20"];
2756 ["lvresize"; "/dev/VG/LV"; "10"]])],
2757 "resize an LVM logical volume",
2759 This resizes (expands or shrinks) an existing LVM logical
2760 volume to C<mbytes>. When reducing, data in the reduced part
2763 ("resize2fs", (RErr, [Device "device"], []), 106, [],
2764 [], (* lvresize tests this *)
2765 "resize an ext2, ext3 or ext4 filesystem",
2767 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2768 the underlying device.
2770 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2771 on the C<device> before calling this command. For unknown reasons
2772 C<resize2fs> sometimes gives an error about this and sometimes not.
2773 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2774 calling this function.");
2776 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
2777 [InitBasicFS, Always, TestOutputList (
2778 [["find"; "/"]], ["lost+found"]);
2779 InitBasicFS, Always, TestOutputList (
2783 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2784 InitBasicFS, Always, TestOutputList (
2785 [["mkdir_p"; "/a/b/c"];
2786 ["touch"; "/a/b/c/d"];
2787 ["find"; "/a/b/"]], ["c"; "c/d"])],
2788 "find all files and directories",
2790 This command lists out all files and directories, recursively,
2791 starting at C<directory>. It is essentially equivalent to
2792 running the shell command C<find directory -print> but some
2793 post-processing happens on the output, described below.
2795 This returns a list of strings I<without any prefix>. Thus
2796 if the directory structure was:
2802 then the returned list from C<guestfs_find> C</tmp> would be
2810 If C<directory> is not a directory, then this command returns
2813 The returned list is sorted.
2815 See also C<guestfs_find0>.");
2817 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
2818 [], (* lvresize tests this *)
2819 "check an ext2/ext3 filesystem",
2821 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2822 filesystem checker on C<device>, noninteractively (C<-p>),
2823 even if the filesystem appears to be clean (C<-f>).
2825 This command is only needed because of C<guestfs_resize2fs>
2826 (q.v.). Normally you should use C<guestfs_fsck>.");
2828 ("sleep", (RErr, [Int "secs"], []), 109, [],
2829 [InitNone, Always, TestRun (
2831 "sleep for some seconds",
2833 Sleep for C<secs> seconds.");
2835 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
2836 [InitNone, Always, TestOutputInt (
2837 [["part_disk"; "/dev/sda"; "mbr"];
2838 ["mkfs"; "ntfs"; "/dev/sda1"];
2839 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2840 InitNone, Always, TestOutputInt (
2841 [["part_disk"; "/dev/sda"; "mbr"];
2842 ["mkfs"; "ext2"; "/dev/sda1"];
2843 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2844 "probe NTFS volume",
2846 This command runs the L<ntfs-3g.probe(8)> command which probes
2847 an NTFS C<device> for mountability. (Not all NTFS volumes can
2848 be mounted read-write, and some cannot be mounted at all).
2850 C<rw> is a boolean flag. Set it to true if you want to test
2851 if the volume can be mounted read-write. Set it to false if
2852 you want to test if the volume can be mounted read-only.
2854 The return value is an integer which C<0> if the operation
2855 would succeed, or some non-zero value documented in the
2856 L<ntfs-3g.probe(8)> manual page.");
2858 ("sh", (RString "output", [String "command"], []), 111, [],
2859 [], (* XXX needs tests *)
2860 "run a command via the shell",
2862 This call runs a command from the guest filesystem via the
2865 This is like C<guestfs_command>, but passes the command to:
2867 /bin/sh -c \"command\"
2869 Depending on the guest's shell, this usually results in
2870 wildcards being expanded, shell expressions being interpolated
2873 All the provisos about C<guestfs_command> apply to this call.");
2875 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
2876 [], (* XXX needs tests *)
2877 "run a command via the shell returning lines",
2879 This is the same as C<guestfs_sh>, but splits the result
2880 into a list of lines.
2882 See also: C<guestfs_command_lines>");
2884 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
2885 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2886 * code in stubs.c, since all valid glob patterns must start with "/".
2887 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2889 [InitBasicFS, Always, TestOutputList (
2890 [["mkdir_p"; "/a/b/c"];
2891 ["touch"; "/a/b/c/d"];
2892 ["touch"; "/a/b/c/e"];
2893 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2894 InitBasicFS, Always, TestOutputList (
2895 [["mkdir_p"; "/a/b/c"];
2896 ["touch"; "/a/b/c/d"];
2897 ["touch"; "/a/b/c/e"];
2898 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2899 InitBasicFS, Always, TestOutputList (
2900 [["mkdir_p"; "/a/b/c"];
2901 ["touch"; "/a/b/c/d"];
2902 ["touch"; "/a/b/c/e"];
2903 ["glob_expand"; "/a/*/x/*"]], [])],
2904 "expand a wildcard path",
2906 This command searches for all the pathnames matching
2907 C<pattern> according to the wildcard expansion rules
2910 If no paths match, then this returns an empty list
2911 (note: not an error).
2913 It is just a wrapper around the C L<glob(3)> function
2914 with flags C<GLOB_MARK|GLOB_BRACE>.
2915 See that manual page for more details.");
2917 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
2918 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2919 [["scrub_device"; "/dev/sdc"]])],
2920 "scrub (securely wipe) a device",
2922 This command writes patterns over C<device> to make data retrieval
2925 It is an interface to the L<scrub(1)> program. See that
2926 manual page for more details.");
2928 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
2929 [InitBasicFS, Always, TestRun (
2930 [["write"; "/file"; "content"];
2931 ["scrub_file"; "/file"]])],
2932 "scrub (securely wipe) a file",
2934 This command writes patterns over a file to make data retrieval
2937 The file is I<removed> after scrubbing.
2939 It is an interface to the L<scrub(1)> program. See that
2940 manual page for more details.");
2942 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
2943 [], (* XXX needs testing *)
2944 "scrub (securely wipe) free space",
2946 This command creates the directory C<dir> and then fills it
2947 with files until the filesystem is full, and scrubs the files
2948 as for C<guestfs_scrub_file>, and deletes them.
2949 The intention is to scrub any free space on the partition
2952 It is an interface to the L<scrub(1)> program. See that
2953 manual page for more details.");
2955 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
2956 [InitBasicFS, Always, TestRun (
2958 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2959 "create a temporary directory",
2961 This command creates a temporary directory. The
2962 C<template> parameter should be a full pathname for the
2963 temporary directory name with the final six characters being
2966 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2967 the second one being suitable for Windows filesystems.
2969 The name of the temporary directory that was created
2972 The temporary directory is created with mode 0700
2973 and is owned by root.
2975 The caller is responsible for deleting the temporary
2976 directory and its contents after use.
2978 See also: L<mkdtemp(3)>");
2980 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
2981 [InitISOFS, Always, TestOutputInt (
2982 [["wc_l"; "/10klines"]], 10000);
2983 (* Test for RHBZ#579608, absolute symbolic links. *)
2984 InitISOFS, Always, TestOutputInt (
2985 [["wc_l"; "/abssymlink"]], 10000)],
2986 "count lines in a file",
2988 This command counts the lines in a file, using the
2989 C<wc -l> external command.");
2991 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
2992 [InitISOFS, Always, TestOutputInt (
2993 [["wc_w"; "/10klines"]], 10000)],
2994 "count words in a file",
2996 This command counts the words in a file, using the
2997 C<wc -w> external command.");
2999 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3000 [InitISOFS, Always, TestOutputInt (
3001 [["wc_c"; "/100kallspaces"]], 102400)],
3002 "count characters in a file",
3004 This command counts the characters in a file, using the
3005 C<wc -c> external command.");
3007 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3008 [InitISOFS, Always, TestOutputList (
3009 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3010 (* Test for RHBZ#579608, absolute symbolic links. *)
3011 InitISOFS, Always, TestOutputList (
3012 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3013 "return first 10 lines of a file",
3015 This command returns up to the first 10 lines of a file as
3016 a list of strings.");
3018 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3019 [InitISOFS, Always, TestOutputList (
3020 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3021 InitISOFS, Always, TestOutputList (
3022 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3023 InitISOFS, Always, TestOutputList (
3024 [["head_n"; "0"; "/10klines"]], [])],
3025 "return first N lines of a file",
3027 If the parameter C<nrlines> is a positive number, this returns the first
3028 C<nrlines> lines of the file C<path>.
3030 If the parameter C<nrlines> is a negative number, this returns lines
3031 from the file C<path>, excluding the last C<nrlines> lines.
3033 If the parameter C<nrlines> is zero, this returns an empty list.");
3035 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3036 [InitISOFS, Always, TestOutputList (
3037 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3038 "return last 10 lines of a file",
3040 This command returns up to the last 10 lines of a file as
3041 a list of strings.");
3043 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3044 [InitISOFS, Always, TestOutputList (
3045 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3046 InitISOFS, Always, TestOutputList (
3047 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3048 InitISOFS, Always, TestOutputList (
3049 [["tail_n"; "0"; "/10klines"]], [])],
3050 "return last N lines of a file",
3052 If the parameter C<nrlines> is a positive number, this returns the last
3053 C<nrlines> lines of the file C<path>.
3055 If the parameter C<nrlines> is a negative number, this returns lines
3056 from the file C<path>, starting with the C<-nrlines>th line.
3058 If the parameter C<nrlines> is zero, this returns an empty list.");
3060 ("df", (RString "output", [], []), 125, [],
3061 [], (* XXX Tricky to test because it depends on the exact format
3062 * of the 'df' command and other imponderables.
3064 "report file system disk space usage",
3066 This command runs the C<df> command to report disk space used.
3068 This command is mostly useful for interactive sessions. It
3069 is I<not> intended that you try to parse the output string.
3070 Use C<statvfs> from programs.");
3072 ("df_h", (RString "output", [], []), 126, [],
3073 [], (* XXX Tricky to test because it depends on the exact format
3074 * of the 'df' command and other imponderables.
3076 "report file system disk space usage (human readable)",
3078 This command runs the C<df -h> command to report disk space used
3079 in human-readable format.
3081 This command is mostly useful for interactive sessions. It
3082 is I<not> intended that you try to parse the output string.
3083 Use C<statvfs> from programs.");
3085 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3086 [InitISOFS, Always, TestOutputInt (
3087 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3088 "estimate file space usage",
3090 This command runs the C<du -s> command to estimate file space
3093 C<path> can be a file or a directory. If C<path> is a directory
3094 then the estimate includes the contents of the directory and all
3095 subdirectories (recursively).
3097 The result is the estimated size in I<kilobytes>
3098 (ie. units of 1024 bytes).");
3100 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3101 [InitISOFS, Always, TestOutputList (
3102 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3103 "list files in an initrd",
3105 This command lists out files contained in an initrd.
3107 The files are listed without any initial C</> character. The
3108 files are listed in the order they appear (not necessarily
3109 alphabetical). Directory names are listed as separate items.
3111 Old Linux kernels (2.4 and earlier) used a compressed ext2
3112 filesystem as initrd. We I<only> support the newer initramfs
3113 format (compressed cpio files).");
3115 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3117 "mount a file using the loop device",
3119 This command lets you mount C<file> (a filesystem image
3120 in a file) on a mount point. It is entirely equivalent to
3121 the command C<mount -o loop file mountpoint>.");
3123 ("mkswap", (RErr, [Device "device"], []), 130, [],
3124 [InitEmpty, Always, TestRun (
3125 [["part_disk"; "/dev/sda"; "mbr"];
3126 ["mkswap"; "/dev/sda1"]])],
3127 "create a swap partition",
3129 Create a swap partition on C<device>.");
3131 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3132 [InitEmpty, Always, TestRun (
3133 [["part_disk"; "/dev/sda"; "mbr"];
3134 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3135 "create a swap partition with a label",
3137 Create a swap partition on C<device> with label C<label>.
3139 Note that you cannot attach a swap label to a block device
3140 (eg. C</dev/sda>), just to a partition. This appears to be
3141 a limitation of the kernel or swap tools.");
3143 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3144 (let uuid = uuidgen () in
3145 [InitEmpty, Always, TestRun (
3146 [["part_disk"; "/dev/sda"; "mbr"];
3147 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3148 "create a swap partition with an explicit UUID",
3150 Create a swap partition on C<device> with UUID C<uuid>.");
3152 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3153 [InitBasicFS, Always, TestOutputStruct (
3154 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3155 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3156 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3157 InitBasicFS, Always, TestOutputStruct (
3158 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3159 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3160 "make block, character or FIFO devices",
3162 This call creates block or character special devices, or
3163 named pipes (FIFOs).
3165 The C<mode> parameter should be the mode, using the standard
3166 constants. C<devmajor> and C<devminor> are the
3167 device major and minor numbers, only used when creating block
3168 and character special devices.
3170 Note that, just like L<mknod(2)>, the mode must be bitwise
3171 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3172 just creates a regular file). These constants are
3173 available in the standard Linux header files, or you can use
3174 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3175 which are wrappers around this command which bitwise OR
3176 in the appropriate constant for you.
3178 The mode actually set is affected by the umask.");
3180 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3181 [InitBasicFS, Always, TestOutputStruct (
3182 [["mkfifo"; "0o777"; "/node"];
3183 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3184 "make FIFO (named pipe)",
3186 This call creates a FIFO (named pipe) called C<path> with
3187 mode C<mode>. It is just a convenient wrapper around
3190 The mode actually set is affected by the umask.");
3192 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3193 [InitBasicFS, Always, TestOutputStruct (
3194 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3195 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3196 "make block device node",
3198 This call creates a block device node called C<path> with
3199 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3200 It is just a convenient wrapper around C<guestfs_mknod>.
3202 The mode actually set is affected by the umask.");
3204 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3205 [InitBasicFS, Always, TestOutputStruct (
3206 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3207 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3208 "make char device node",
3210 This call creates a char device node called C<path> with
3211 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3212 It is just a convenient wrapper around C<guestfs_mknod>.
3214 The mode actually set is affected by the umask.");
3216 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3217 [InitEmpty, Always, TestOutputInt (
3218 [["umask"; "0o22"]], 0o22)],
3219 "set file mode creation mask (umask)",
3221 This function sets the mask used for creating new files and
3222 device nodes to C<mask & 0777>.
3224 Typical umask values would be C<022> which creates new files
3225 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3226 C<002> which creates new files with permissions like
3227 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3229 The default umask is C<022>. This is important because it
3230 means that directories and device nodes will be created with
3231 C<0644> or C<0755> mode even if you specify C<0777>.
3233 See also C<guestfs_get_umask>,
3234 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3236 This call returns the previous umask.");
3238 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3240 "read directories entries",
3242 This returns the list of directory entries in directory C<dir>.
3244 All entries in the directory are returned, including C<.> and
3245 C<..>. The entries are I<not> sorted, but returned in the same
3246 order as the underlying filesystem.
3248 Also this call returns basic file type information about each
3249 file. The C<ftyp> field will contain one of the following characters:
3287 The L<readdir(3)> call returned a C<d_type> field with an
3292 This function is primarily intended for use by programs. To
3293 get a simple list of names, use C<guestfs_ls>. To get a printable
3294 directory for human consumption, use C<guestfs_ll>.");
3296 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3298 "create partitions on a block device",
3300 This is a simplified interface to the C<guestfs_sfdisk>
3301 command, where partition sizes are specified in megabytes
3302 only (rounded to the nearest cylinder) and you don't need
3303 to specify the cyls, heads and sectors parameters which
3304 were rarely if ever used anyway.
3306 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3307 and C<guestfs_part_disk>");
3309 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3311 "determine file type inside a compressed file",
3313 This command runs C<file> after first decompressing C<path>
3316 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3318 Since 1.0.63, use C<guestfs_file> instead which can now
3319 process compressed files.");
3321 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3323 "list extended attributes of a file or directory",
3325 This call lists the extended attributes of the file or directory
3328 At the system call level, this is a combination of the
3329 L<listxattr(2)> and L<getxattr(2)> calls.
3331 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3333 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3335 "list extended attributes of a file or directory",
3337 This is the same as C<guestfs_getxattrs>, but if C<path>
3338 is a symbolic link, then it returns the extended attributes
3339 of the link itself.");
3341 ("setxattr", (RErr, [String "xattr";
3342 String "val"; Int "vallen"; (* will be BufferIn *)
3343 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3345 "set extended attribute of a file or directory",
3347 This call sets the extended attribute named C<xattr>
3348 of the file C<path> to the value C<val> (of length C<vallen>).
3349 The value is arbitrary 8 bit data.
3351 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3353 ("lsetxattr", (RErr, [String "xattr";
3354 String "val"; Int "vallen"; (* will be BufferIn *)
3355 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3357 "set extended attribute of a file or directory",
3359 This is the same as C<guestfs_setxattr>, but if C<path>
3360 is a symbolic link, then it sets an extended attribute
3361 of the link itself.");
3363 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3365 "remove extended attribute of a file or directory",
3367 This call removes the extended attribute named C<xattr>
3368 of the file C<path>.
3370 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3372 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3374 "remove extended attribute of a file or directory",
3376 This is the same as C<guestfs_removexattr>, but if C<path>
3377 is a symbolic link, then it removes an extended attribute
3378 of the link itself.");
3380 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3384 This call is similar to C<guestfs_mounts>. That call returns
3385 a list of devices. This one returns a hash table (map) of
3386 device name to directory where the device is mounted.");
3388 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3389 (* This is a special case: while you would expect a parameter
3390 * of type "Pathname", that doesn't work, because it implies
3391 * NEED_ROOT in the generated calling code in stubs.c, and
3392 * this function cannot use NEED_ROOT.
3395 "create a mountpoint",
3397 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3398 specialized calls that can be used to create extra mountpoints
3399 before mounting the first filesystem.
3401 These calls are I<only> necessary in some very limited circumstances,
3402 mainly the case where you want to mount a mix of unrelated and/or
3403 read-only filesystems together.
3405 For example, live CDs often contain a \"Russian doll\" nest of
3406 filesystems, an ISO outer layer, with a squashfs image inside, with
3407 an ext2/3 image inside that. You can unpack this as follows
3410 add-ro Fedora-11-i686-Live.iso
3414 mkmountpoint /ext3fs
3416 mount-loop /cd/LiveOS/squashfs.img /sqsh
3417 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3419 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3421 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3422 You may get unexpected errors if you try to mix these calls. It is
3423 safest to manually unmount filesystems and remove mountpoints after use.
3425 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3426 longest first, so for this to work for manual mountpoints, you
3427 must ensure that the innermost mountpoints have the longest
3428 pathnames, as in the example code above.
3430 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3432 Autosync [see C<guestfs_set_autosync>, this is set by default on
3433 handles] means that C<guestfs_umount_all> is called when the handle
3434 is closed which can also trigger these issues.");
3436 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3438 "remove a mountpoint",
3440 This calls removes a mountpoint that was previously created
3441 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3442 for full details.");
3444 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3445 [InitISOFS, Always, TestOutputBuffer (
3446 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3447 (* Test various near large, large and too large files (RHBZ#589039). *)
3448 InitBasicFS, Always, TestLastFail (
3450 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3451 ["read_file"; "/a"]]);
3452 InitBasicFS, Always, TestLastFail (
3454 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3455 ["read_file"; "/a"]]);
3456 InitBasicFS, Always, TestLastFail (
3458 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3459 ["read_file"; "/a"]])],
3462 This calls returns the contents of the file C<path> as a
3465 Unlike C<guestfs_cat>, this function can correctly
3466 handle files that contain embedded ASCII NUL characters.
3467 However unlike C<guestfs_download>, this function is limited
3468 in the total size of file that can be handled.");
3470 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3471 [InitISOFS, Always, TestOutputList (
3472 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3473 InitISOFS, Always, TestOutputList (
3474 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3475 (* Test for RHBZ#579608, absolute symbolic links. *)
3476 InitISOFS, Always, TestOutputList (
3477 [["grep"; "nomatch"; "/abssymlink"]], [])],
3478 "return lines matching a pattern",
3480 This calls the external C<grep> program and returns the
3483 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3484 [InitISOFS, Always, TestOutputList (
3485 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3486 "return lines matching a pattern",
3488 This calls the external C<egrep> program and returns the
3491 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3492 [InitISOFS, Always, TestOutputList (
3493 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3494 "return lines matching a pattern",
3496 This calls the external C<fgrep> program and returns the
3499 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3500 [InitISOFS, Always, TestOutputList (
3501 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3502 "return lines matching a pattern",
3504 This calls the external C<grep -i> program and returns the
3507 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3508 [InitISOFS, Always, TestOutputList (
3509 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3510 "return lines matching a pattern",
3512 This calls the external C<egrep -i> program and returns the
3515 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3516 [InitISOFS, Always, TestOutputList (
3517 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3518 "return lines matching a pattern",
3520 This calls the external C<fgrep -i> program and returns the
3523 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3524 [InitISOFS, Always, TestOutputList (
3525 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3526 "return lines matching a pattern",
3528 This calls the external C<zgrep> program and returns the
3531 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3532 [InitISOFS, Always, TestOutputList (
3533 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3534 "return lines matching a pattern",
3536 This calls the external C<zegrep> program and returns the
3539 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3540 [InitISOFS, Always, TestOutputList (
3541 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3542 "return lines matching a pattern",
3544 This calls the external C<zfgrep> program and returns the
3547 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3548 [InitISOFS, Always, TestOutputList (
3549 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3550 "return lines matching a pattern",
3552 This calls the external C<zgrep -i> program and returns the
3555 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3556 [InitISOFS, Always, TestOutputList (
3557 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3558 "return lines matching a pattern",
3560 This calls the external C<zegrep -i> program and returns the
3563 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3564 [InitISOFS, Always, TestOutputList (
3565 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3566 "return lines matching a pattern",
3568 This calls the external C<zfgrep -i> program and returns the
3571 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3572 [InitISOFS, Always, TestOutput (
3573 [["realpath"; "/../directory"]], "/directory")],
3574 "canonicalized absolute pathname",
3576 Return the canonicalized absolute pathname of C<path>. The
3577 returned path has no C<.>, C<..> or symbolic link path elements.");
3579 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3580 [InitBasicFS, Always, TestOutputStruct (
3583 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3584 "create a hard link",
3586 This command creates a hard link using the C<ln> command.");
3588 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3589 [InitBasicFS, Always, TestOutputStruct (
3592 ["ln_f"; "/a"; "/b"];
3593 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3594 "create a hard link",
3596 This command creates a hard link using the C<ln -f> command.
3597 The C<-f> option removes the link (C<linkname>) if it exists already.");
3599 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3600 [InitBasicFS, Always, TestOutputStruct (
3602 ["ln_s"; "a"; "/b"];
3603 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3604 "create a symbolic link",
3606 This command creates a symbolic link using the C<ln -s> command.");
3608 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3609 [InitBasicFS, Always, TestOutput (
3610 [["mkdir_p"; "/a/b"];
3611 ["touch"; "/a/b/c"];
3612 ["ln_sf"; "../d"; "/a/b/c"];
3613 ["readlink"; "/a/b/c"]], "../d")],
3614 "create a symbolic link",
3616 This command creates a symbolic link using the C<ln -sf> command,
3617 The C<-f> option removes the link (C<linkname>) if it exists already.");
3619 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3620 [] (* XXX tested above *),
3621 "read the target of a symbolic link",
3623 This command reads the target of a symbolic link.");
3625 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3626 [InitBasicFS, Always, TestOutputStruct (
3627 [["fallocate"; "/a"; "1000000"];
3628 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3629 "preallocate a file in the guest filesystem",
3631 This command preallocates a file (containing zero bytes) named
3632 C<path> of size C<len> bytes. If the file exists already, it
3635 Do not confuse this with the guestfish-specific
3636 C<alloc> command which allocates a file in the host and
3637 attaches it as a device.");
3639 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3640 [InitPartition, Always, TestRun (
3641 [["mkswap"; "/dev/sda1"];
3642 ["swapon_device"; "/dev/sda1"];
3643 ["swapoff_device"; "/dev/sda1"]])],
3644 "enable swap on device",
3646 This command enables the libguestfs appliance to use the
3647 swap device or partition named C<device>. The increased
3648 memory is made available for all commands, for example
3649 those run using C<guestfs_command> or C<guestfs_sh>.
3651 Note that you should not swap to existing guest swap
3652 partitions unless you know what you are doing. They may
3653 contain hibernation information, or other information that
3654 the guest doesn't want you to trash. You also risk leaking
3655 information about the host to the guest this way. Instead,
3656 attach a new host device to the guest and swap on that.");
3658 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3659 [], (* XXX tested by swapon_device *)
3660 "disable swap on device",
3662 This command disables the libguestfs appliance swap
3663 device or partition named C<device>.
3664 See C<guestfs_swapon_device>.");
3666 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3667 [InitBasicFS, Always, TestRun (
3668 [["fallocate"; "/swap"; "8388608"];
3669 ["mkswap_file"; "/swap"];
3670 ["swapon_file"; "/swap"];
3671 ["swapoff_file"; "/swap"]])],
3672 "enable swap on file",
3674 This command enables swap to a file.
3675 See C<guestfs_swapon_device> for other notes.");
3677 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3678 [], (* XXX tested by swapon_file *)
3679 "disable swap on file",
3681 This command disables the libguestfs appliance swap on file.");
3683 ("swapon_label", (RErr, [String "label"], []), 174, [],
3684 [InitEmpty, Always, TestRun (
3685 [["part_disk"; "/dev/sdb"; "mbr"];
3686 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3687 ["swapon_label"; "swapit"];
3688 ["swapoff_label"; "swapit"];
3689 ["zero"; "/dev/sdb"];
3690 ["blockdev_rereadpt"; "/dev/sdb"]])],
3691 "enable swap on labeled swap partition",
3693 This command enables swap to a labeled swap partition.
3694 See C<guestfs_swapon_device> for other notes.");
3696 ("swapoff_label", (RErr, [String "label"], []), 175, [],
3697 [], (* XXX tested by swapon_label *)
3698 "disable swap on labeled swap partition",
3700 This command disables the libguestfs appliance swap on
3701 labeled swap partition.");
3703 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3704 (let uuid = uuidgen () in
3705 [InitEmpty, Always, TestRun (
3706 [["mkswap_U"; uuid; "/dev/sdb"];
3707 ["swapon_uuid"; uuid];
3708 ["swapoff_uuid"; uuid]])]),
3709 "enable swap on swap partition by UUID",
3711 This command enables swap to a swap partition with the given UUID.
3712 See C<guestfs_swapon_device> for other notes.");
3714 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3715 [], (* XXX tested by swapon_uuid *)
3716 "disable swap on swap partition by UUID",
3718 This command disables the libguestfs appliance swap partition
3719 with the given UUID.");
3721 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
3722 [InitBasicFS, Always, TestRun (
3723 [["fallocate"; "/swap"; "8388608"];
3724 ["mkswap_file"; "/swap"]])],
3725 "create a swap file",
3729 This command just writes a swap file signature to an existing
3730 file. To create the file itself, use something like C<guestfs_fallocate>.");
3732 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
3733 [InitISOFS, Always, TestRun (
3734 [["inotify_init"; "0"]])],
3735 "create an inotify handle",
3737 This command creates a new inotify handle.
3738 The inotify subsystem can be used to notify events which happen to
3739 objects in the guest filesystem.
3741 C<maxevents> is the maximum number of events which will be
3742 queued up between calls to C<guestfs_inotify_read> or
3743 C<guestfs_inotify_files>.
3744 If this is passed as C<0>, then the kernel (or previously set)
3745 default is used. For Linux 2.6.29 the default was 16384 events.
3746 Beyond this limit, the kernel throws away events, but records
3747 the fact that it threw them away by setting a flag
3748 C<IN_Q_OVERFLOW> in the returned structure list (see
3749 C<guestfs_inotify_read>).
3751 Before any events are generated, you have to add some
3752 watches to the internal watch list. See:
3753 C<guestfs_inotify_add_watch>,
3754 C<guestfs_inotify_rm_watch> and
3755 C<guestfs_inotify_watch_all>.
3757 Queued up events should be read periodically by calling
3758 C<guestfs_inotify_read>
3759 (or C<guestfs_inotify_files> which is just a helpful
3760 wrapper around C<guestfs_inotify_read>). If you don't
3761 read the events out often enough then you risk the internal
3764 The handle should be closed after use by calling
3765 C<guestfs_inotify_close>. This also removes any
3766 watches automatically.
3768 See also L<inotify(7)> for an overview of the inotify interface
3769 as exposed by the Linux kernel, which is roughly what we expose
3770 via libguestfs. Note that there is one global inotify handle
3771 per libguestfs instance.");
3773 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
3774 [InitBasicFS, Always, TestOutputList (
3775 [["inotify_init"; "0"];
3776 ["inotify_add_watch"; "/"; "1073741823"];
3779 ["inotify_files"]], ["a"; "b"])],
3780 "add an inotify watch",
3782 Watch C<path> for the events listed in C<mask>.
3784 Note that if C<path> is a directory then events within that
3785 directory are watched, but this does I<not> happen recursively
3786 (in subdirectories).
3788 Note for non-C or non-Linux callers: the inotify events are
3789 defined by the Linux kernel ABI and are listed in
3790 C</usr/include/sys/inotify.h>.");
3792 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
3794 "remove an inotify watch",
3796 Remove a previously defined inotify watch.
3797 See C<guestfs_inotify_add_watch>.");
3799 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
3801 "return list of inotify events",
3803 Return the complete queue of events that have happened
3804 since the previous read call.
3806 If no events have happened, this returns an empty list.
3808 I<Note>: In order to make sure that all events have been
3809 read, you must call this function repeatedly until it
3810 returns an empty list. The reason is that the call will
3811 read events up to the maximum appliance-to-host message
3812 size and leave remaining events in the queue.");
3814 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
3816 "return list of watched files that had events",
3818 This function is a helpful wrapper around C<guestfs_inotify_read>
3819 which just returns a list of pathnames of objects that were
3820 touched. The returned pathnames are sorted and deduplicated.");
3822 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
3824 "close the inotify handle",
3826 This closes the inotify handle which was previously
3827 opened by inotify_init. It removes all watches, throws
3828 away any pending events, and deallocates all resources.");
3830 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
3832 "set SELinux security context",
3834 This sets the SELinux security context of the daemon
3835 to the string C<context>.
3837 See the documentation about SELINUX in L<guestfs(3)>.");
3839 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
3841 "get SELinux security context",
3843 This gets the SELinux security context of the daemon.
3845 See the documentation about SELINUX in L<guestfs(3)>,
3846 and C<guestfs_setcon>");
3848 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
3849 [InitEmpty, Always, TestOutput (
3850 [["part_disk"; "/dev/sda"; "mbr"];
3851 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3852 ["mount_options"; ""; "/dev/sda1"; "/"];
3853 ["write"; "/new"; "new file contents"];
3854 ["cat"; "/new"]], "new file contents");
3855 InitEmpty, Always, TestRun (
3856 [["part_disk"; "/dev/sda"; "mbr"];
3857 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3858 InitEmpty, Always, TestLastFail (
3859 [["part_disk"; "/dev/sda"; "mbr"];
3860 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3861 InitEmpty, Always, TestLastFail (
3862 [["part_disk"; "/dev/sda"; "mbr"];
3863 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3864 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3865 [["part_disk"; "/dev/sda"; "mbr"];
3866 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3867 "make a filesystem with block size",
3869 This call is similar to C<guestfs_mkfs>, but it allows you to
3870 control the block size of the resulting filesystem. Supported
3871 block sizes depend on the filesystem type, but typically they
3872 are C<1024>, C<2048> or C<4096> only.
3874 For VFAT and NTFS the C<blocksize> parameter is treated as
3875 the requested cluster size.");
3877 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
3878 [InitEmpty, Always, TestOutput (
3879 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3880 ["mke2journal"; "4096"; "/dev/sda1"];
3881 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3882 ["mount_options"; ""; "/dev/sda2"; "/"];
3883 ["write"; "/new"; "new file contents"];
3884 ["cat"; "/new"]], "new file contents")],
3885 "make ext2/3/4 external journal",
3887 This creates an ext2 external journal on C<device>. It is equivalent
3890 mke2fs -O journal_dev -b blocksize device");
3892 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
3893 [InitEmpty, Always, TestOutput (
3894 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3895 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3896 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3897 ["mount_options"; ""; "/dev/sda2"; "/"];
3898 ["write"; "/new"; "new file contents"];
3899 ["cat"; "/new"]], "new file contents")],
3900 "make ext2/3/4 external journal with label",
3902 This creates an ext2 external journal on C<device> with label C<label>.");
3904 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
3905 (let uuid = uuidgen () in
3906 [InitEmpty, Always, TestOutput (
3907 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3908 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3909 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3910 ["mount_options"; ""; "/dev/sda2"; "/"];
3911 ["write"; "/new"; "new file contents"];
3912 ["cat"; "/new"]], "new file contents")]),
3913 "make ext2/3/4 external journal with UUID",
3915 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3917 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
3919 "make ext2/3/4 filesystem with external journal",
3921 This creates an ext2/3/4 filesystem on C<device> with
3922 an external journal on C<journal>. It is equivalent
3925 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3927 See also C<guestfs_mke2journal>.");
3929 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
3931 "make ext2/3/4 filesystem with external journal",
3933 This creates an ext2/3/4 filesystem on C<device> with
3934 an external journal on the journal labeled C<label>.
3936 See also C<guestfs_mke2journal_L>.");
3938 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
3940 "make ext2/3/4 filesystem with external journal",
3942 This creates an ext2/3/4 filesystem on C<device> with
3943 an external journal on the journal with UUID C<uuid>.
3945 See also C<guestfs_mke2journal_U>.");
3947 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
3948 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3949 "load a kernel module",
3951 This loads a kernel module in the appliance.
3953 The kernel module must have been whitelisted when libguestfs
3954 was built (see C<appliance/kmod.whitelist.in> in the source).");
3956 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
3957 [InitNone, Always, TestOutput (
3958 [["echo_daemon"; "This is a test"]], "This is a test"
3960 "echo arguments back to the client",
3962 This command concatenates the list of C<words> passed with single spaces
3963 between them and returns the resulting string.
3965 You can use this command to test the connection through to the daemon.
3967 See also C<guestfs_ping_daemon>.");
3969 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
3970 [], (* There is a regression test for this. *)
3971 "find all files and directories, returning NUL-separated list",
3973 This command lists out all files and directories, recursively,
3974 starting at C<directory>, placing the resulting list in the
3975 external file called C<files>.
3977 This command works the same way as C<guestfs_find> with the
3978 following exceptions:
3984 The resulting list is written to an external file.
3988 Items (filenames) in the result are separated
3989 by C<\\0> characters. See L<find(1)> option I<-print0>.
3993 This command is not limited in the number of names that it
3998 The result list is not sorted.
4002 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4003 [InitISOFS, Always, TestOutput (
4004 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4005 InitISOFS, Always, TestOutput (
4006 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4007 InitISOFS, Always, TestOutput (
4008 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4009 InitISOFS, Always, TestLastFail (
4010 [["case_sensitive_path"; "/Known-1/"]]);
4011 InitBasicFS, Always, TestOutput (
4013 ["mkdir"; "/a/bbb"];
4014 ["touch"; "/a/bbb/c"];
4015 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4016 InitBasicFS, Always, TestOutput (
4018 ["mkdir"; "/a/bbb"];
4019 ["touch"; "/a/bbb/c"];
4020 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4021 InitBasicFS, Always, TestLastFail (
4023 ["mkdir"; "/a/bbb"];
4024 ["touch"; "/a/bbb/c"];
4025 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4026 "return true path on case-insensitive filesystem",
4028 This can be used to resolve case insensitive paths on
4029 a filesystem which is case sensitive. The use case is
4030 to resolve paths which you have read from Windows configuration
4031 files or the Windows Registry, to the true path.
4033 The command handles a peculiarity of the Linux ntfs-3g
4034 filesystem driver (and probably others), which is that although
4035 the underlying filesystem is case-insensitive, the driver
4036 exports the filesystem to Linux as case-sensitive.
4038 One consequence of this is that special directories such
4039 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4040 (or other things) depending on the precise details of how
4041 they were created. In Windows itself this would not be
4044 Bug or feature? You decide:
4045 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4047 This function resolves the true case of each element in the
4048 path and returns the case-sensitive path.
4050 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4051 might return C<\"/WINDOWS/system32\"> (the exact return value
4052 would depend on details of how the directories were originally
4053 created under Windows).
4056 This function does not handle drive names, backslashes etc.
4058 See also C<guestfs_realpath>.");
4060 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4061 [InitBasicFS, Always, TestOutput (
4062 [["vfs_type"; "/dev/sda1"]], "ext2")],
4063 "get the Linux VFS type corresponding to a mounted device",
4065 This command gets the filesystem type corresponding to
4066 the filesystem on C<device>.
4068 For most filesystems, the result is the name of the Linux
4069 VFS module which would be used to mount this filesystem
4070 if you mounted it without specifying the filesystem type.
4071 For example a string such as C<ext3> or C<ntfs>.");
4073 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4074 [InitBasicFS, Always, TestOutputStruct (
4075 [["write"; "/test"; "some stuff so size is not zero"];
4076 ["truncate"; "/test"];
4077 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4078 "truncate a file to zero size",
4080 This command truncates C<path> to a zero-length file. The
4081 file must exist already.");
4083 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4084 [InitBasicFS, Always, TestOutputStruct (
4085 [["touch"; "/test"];
4086 ["truncate_size"; "/test"; "1000"];
4087 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4088 "truncate a file to a particular size",
4090 This command truncates C<path> to size C<size> bytes. The file
4093 If the current file size is less than C<size> then
4094 the file is extended to the required size with zero bytes.
4095 This creates a sparse file (ie. disk blocks are not allocated
4096 for the file until you write to it). To create a non-sparse
4097 file of zeroes, use C<guestfs_fallocate64> instead.");
4099 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4100 [InitBasicFS, Always, TestOutputStruct (
4101 [["touch"; "/test"];
4102 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4103 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4104 "set timestamp of a file with nanosecond precision",
4106 This command sets the timestamps of a file with nanosecond
4109 C<atsecs, atnsecs> are the last access time (atime) in secs and
4110 nanoseconds from the epoch.
4112 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4113 secs and nanoseconds from the epoch.
4115 If the C<*nsecs> field contains the special value C<-1> then
4116 the corresponding timestamp is set to the current time. (The
4117 C<*secs> field is ignored in this case).
4119 If the C<*nsecs> field contains the special value C<-2> then
4120 the corresponding timestamp is left unchanged. (The
4121 C<*secs> field is ignored in this case).");
4123 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4124 [InitBasicFS, Always, TestOutputStruct (
4125 [["mkdir_mode"; "/test"; "0o111"];
4126 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4127 "create a directory with a particular mode",
4129 This command creates a directory, setting the initial permissions
4130 of the directory to C<mode>.
4132 For common Linux filesystems, the actual mode which is set will
4133 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4134 interpret the mode in other ways.
4136 See also C<guestfs_mkdir>, C<guestfs_umask>");
4138 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4140 "change file owner and group",
4142 Change the file owner to C<owner> and group to C<group>.
4143 This is like C<guestfs_chown> but if C<path> is a symlink then
4144 the link itself is changed, not the target.
4146 Only numeric uid and gid are supported. If you want to use
4147 names, you will need to locate and parse the password file
4148 yourself (Augeas support makes this relatively easy).");
4150 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4152 "lstat on multiple files",
4154 This call allows you to perform the C<guestfs_lstat> operation
4155 on multiple files, where all files are in the directory C<path>.
4156 C<names> is the list of files from this directory.
4158 On return you get a list of stat structs, with a one-to-one
4159 correspondence to the C<names> list. If any name did not exist
4160 or could not be lstat'd, then the C<ino> field of that structure
4163 This call is intended for programs that want to efficiently
4164 list a directory contents without making many round-trips.
4165 See also C<guestfs_lxattrlist> for a similarly efficient call
4166 for getting extended attributes. Very long directory listings
4167 might cause the protocol message size to be exceeded, causing
4168 this call to fail. The caller must split up such requests
4169 into smaller groups of names.");
4171 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4173 "lgetxattr on multiple files",
4175 This call allows you to get the extended attributes
4176 of multiple files, where all files are in the directory C<path>.
4177 C<names> is the list of files from this directory.
4179 On return you get a flat list of xattr structs which must be
4180 interpreted sequentially. The first xattr struct always has a zero-length
4181 C<attrname>. C<attrval> in this struct is zero-length
4182 to indicate there was an error doing C<lgetxattr> for this
4183 file, I<or> is a C string which is a decimal number
4184 (the number of following attributes for this file, which could
4185 be C<\"0\">). Then after the first xattr struct are the
4186 zero or more attributes for the first named file.
4187 This repeats for the second and subsequent files.
4189 This call is intended for programs that want to efficiently
4190 list a directory contents without making many round-trips.
4191 See also C<guestfs_lstatlist> for a similarly efficient call
4192 for getting standard stats. Very long directory listings
4193 might cause the protocol message size to be exceeded, causing
4194 this call to fail. The caller must split up such requests
4195 into smaller groups of names.");
4197 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4199 "readlink on multiple files",
4201 This call allows you to do a C<readlink> operation
4202 on multiple files, where all files are in the directory C<path>.
4203 C<names> is the list of files from this directory.
4205 On return you get a list of strings, with a one-to-one
4206 correspondence to the C<names> list. Each string is the
4207 value of the symbolic link.
4209 If the C<readlink(2)> operation fails on any name, then
4210 the corresponding result string is the empty string C<\"\">.
4211 However the whole operation is completed even if there
4212 were C<readlink(2)> errors, and so you can call this
4213 function with names where you don't know if they are
4214 symbolic links already (albeit slightly less efficient).
4216 This call is intended for programs that want to efficiently
4217 list a directory contents without making many round-trips.
4218 Very long directory listings might cause the protocol
4219 message size to be exceeded, causing
4220 this call to fail. The caller must split up such requests
4221 into smaller groups of names.");
4223 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4224 [InitISOFS, Always, TestOutputBuffer (
4225 [["pread"; "/known-4"; "1"; "3"]], "\n");
4226 InitISOFS, Always, TestOutputBuffer (
4227 [["pread"; "/empty"; "0"; "100"]], "")],
4228 "read part of a file",
4230 This command lets you read part of a file. It reads C<count>
4231 bytes of the file, starting at C<offset>, from file C<path>.
4233 This may read fewer bytes than requested. For further details
4234 see the L<pread(2)> system call.
4236 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4238 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4239 [InitEmpty, Always, TestRun (
4240 [["part_init"; "/dev/sda"; "gpt"]])],
4241 "create an empty partition table",
4243 This creates an empty partition table on C<device> of one of the
4244 partition types listed below. Usually C<parttype> should be
4245 either C<msdos> or C<gpt> (for large disks).
4247 Initially there are no partitions. Following this, you should
4248 call C<guestfs_part_add> for each partition required.
4250 Possible values for C<parttype> are:
4254 =item B<efi> | B<gpt>
4256 Intel EFI / GPT partition table.
4258 This is recommended for >= 2 TB partitions that will be accessed
4259 from Linux and Intel-based Mac OS X. It also has limited backwards
4260 compatibility with the C<mbr> format.
4262 =item B<mbr> | B<msdos>
4264 The standard PC \"Master Boot Record\" (MBR) format used
4265 by MS-DOS and Windows. This partition type will B<only> work
4266 for device sizes up to 2 TB. For large disks we recommend
4271 Other partition table types that may work but are not
4280 =item B<amiga> | B<rdb>
4282 Amiga \"Rigid Disk Block\" format.
4290 DASD, used on IBM mainframes.
4298 Old Mac partition format. Modern Macs use C<gpt>.
4302 NEC PC-98 format, common in Japan apparently.
4310 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4311 [InitEmpty, Always, TestRun (
4312 [["part_init"; "/dev/sda"; "mbr"];
4313 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4314 InitEmpty, Always, TestRun (
4315 [["part_init"; "/dev/sda"; "gpt"];
4316 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4317 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4318 InitEmpty, Always, TestRun (
4319 [["part_init"; "/dev/sda"; "mbr"];
4320 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4321 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4322 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4323 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4324 "add a partition to the device",
4326 This command adds a partition to C<device>. If there is no partition
4327 table on the device, call C<guestfs_part_init> first.
4329 The C<prlogex> parameter is the type of partition. Normally you
4330 should pass C<p> or C<primary> here, but MBR partition tables also
4331 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4334 C<startsect> and C<endsect> are the start and end of the partition
4335 in I<sectors>. C<endsect> may be negative, which means it counts
4336 backwards from the end of the disk (C<-1> is the last sector).
4338 Creating a partition which covers the whole disk is not so easy.
4339 Use C<guestfs_part_disk> to do that.");
4341 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4342 [InitEmpty, Always, TestRun (
4343 [["part_disk"; "/dev/sda"; "mbr"]]);
4344 InitEmpty, Always, TestRun (
4345 [["part_disk"; "/dev/sda"; "gpt"]])],
4346 "partition whole disk with a single primary partition",
4348 This command is simply a combination of C<guestfs_part_init>
4349 followed by C<guestfs_part_add> to create a single primary partition
4350 covering the whole disk.
4352 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4353 but other possible values are described in C<guestfs_part_init>.");
4355 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4356 [InitEmpty, Always, TestRun (
4357 [["part_disk"; "/dev/sda"; "mbr"];
4358 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4359 "make a partition bootable",
4361 This sets the bootable flag on partition numbered C<partnum> on
4362 device C<device>. Note that partitions are numbered from 1.
4364 The bootable flag is used by some operating systems (notably
4365 Windows) to determine which partition to boot from. It is by
4366 no means universally recognized.");
4368 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4369 [InitEmpty, Always, TestRun (
4370 [["part_disk"; "/dev/sda"; "gpt"];
4371 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4372 "set partition name",
4374 This sets the partition name on partition numbered C<partnum> on
4375 device C<device>. Note that partitions are numbered from 1.
4377 The partition name can only be set on certain types of partition
4378 table. This works on C<gpt> but not on C<mbr> partitions.");
4380 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4381 [], (* XXX Add a regression test for this. *)
4382 "list partitions on a device",
4384 This command parses the partition table on C<device> and
4385 returns the list of partitions found.
4387 The fields in the returned structure are:
4393 Partition number, counting from 1.
4397 Start of the partition I<in bytes>. To get sectors you have to
4398 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4402 End of the partition in bytes.
4406 Size of the partition in bytes.
4410 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4411 [InitEmpty, Always, TestOutput (
4412 [["part_disk"; "/dev/sda"; "gpt"];
4413 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4414 "get the partition table type",
4416 This command examines the partition table on C<device> and
4417 returns the partition table type (format) being used.
4419 Common return values include: C<msdos> (a DOS/Windows style MBR
4420 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4421 values are possible, although unusual. See C<guestfs_part_init>
4424 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4425 [InitBasicFS, Always, TestOutputBuffer (
4426 [["fill"; "0x63"; "10"; "/test"];
4427 ["read_file"; "/test"]], "cccccccccc")],
4428 "fill a file with octets",
4430 This command creates a new file called C<path>. The initial
4431 content of the file is C<len> octets of C<c>, where C<c>
4432 must be a number in the range C<[0..255]>.
4434 To fill a file with zero bytes (sparsely), it is
4435 much more efficient to use C<guestfs_truncate_size>.
4436 To create a file with a pattern of repeating bytes
4437 use C<guestfs_fill_pattern>.");
4439 ("available", (RErr, [StringList "groups"], []), 216, [],
4440 [InitNone, Always, TestRun [["available"; ""]]],
4441 "test availability of some parts of the API",
4443 This command is used to check the availability of some
4444 groups of functionality in the appliance, which not all builds of
4445 the libguestfs appliance will be able to provide.
4447 The libguestfs groups, and the functions that those
4448 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4449 You can also fetch this list at runtime by calling
4450 C<guestfs_available_all_groups>.
4452 The argument C<groups> is a list of group names, eg:
4453 C<[\"inotify\", \"augeas\"]> would check for the availability of
4454 the Linux inotify functions and Augeas (configuration file
4457 The command returns no error if I<all> requested groups are available.
4459 It fails with an error if one or more of the requested
4460 groups is unavailable in the appliance.
4462 If an unknown group name is included in the
4463 list of groups then an error is always returned.
4471 You must call C<guestfs_launch> before calling this function.
4473 The reason is because we don't know what groups are
4474 supported by the appliance/daemon until it is running and can
4479 If a group of functions is available, this does not necessarily
4480 mean that they will work. You still have to check for errors
4481 when calling individual API functions even if they are
4486 It is usually the job of distro packagers to build
4487 complete functionality into the libguestfs appliance.
4488 Upstream libguestfs, if built from source with all
4489 requirements satisfied, will support everything.
4493 This call was added in version C<1.0.80>. In previous
4494 versions of libguestfs all you could do would be to speculatively
4495 execute a command to find out if the daemon implemented it.
4496 See also C<guestfs_version>.
4500 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4501 [InitBasicFS, Always, TestOutputBuffer (
4502 [["write"; "/src"; "hello, world"];
4503 ["dd"; "/src"; "/dest"];
4504 ["read_file"; "/dest"]], "hello, world")],
4505 "copy from source to destination using dd",
4507 This command copies from one source device or file C<src>
4508 to another destination device or file C<dest>. Normally you
4509 would use this to copy to or from a device or partition, for
4510 example to duplicate a filesystem.
4512 If the destination is a device, it must be as large or larger
4513 than the source file or device, otherwise the copy will fail.
4514 This command cannot do partial copies (see C<guestfs_copy_size>).");
4516 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4517 [InitBasicFS, Always, TestOutputInt (
4518 [["write"; "/file"; "hello, world"];
4519 ["filesize"; "/file"]], 12)],
4520 "return the size of the file in bytes",
4522 This command returns the size of C<file> in bytes.
4524 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4525 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4526 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4528 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4529 [InitBasicFSonLVM, Always, TestOutputList (
4530 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4531 ["lvs"]], ["/dev/VG/LV2"])],
4532 "rename an LVM logical volume",
4534 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4536 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4537 [InitBasicFSonLVM, Always, TestOutputList (
4539 ["vg_activate"; "false"; "VG"];
4540 ["vgrename"; "VG"; "VG2"];
4541 ["vg_activate"; "true"; "VG2"];
4542 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4543 ["vgs"]], ["VG2"])],
4544 "rename an LVM volume group",
4546 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4548 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4549 [InitISOFS, Always, TestOutputBuffer (
4550 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4551 "list the contents of a single file in an initrd",
4553 This command unpacks the file C<filename> from the initrd file
4554 called C<initrdpath>. The filename must be given I<without> the
4555 initial C</> character.
4557 For example, in guestfish you could use the following command
4558 to examine the boot script (usually called C</init>)
4559 contained in a Linux initrd or initramfs image:
4561 initrd-cat /boot/initrd-<version>.img init
4563 See also C<guestfs_initrd_list>.");
4565 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4567 "get the UUID of a physical volume",
4569 This command returns the UUID of the LVM PV C<device>.");
4571 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4573 "get the UUID of a volume group",
4575 This command returns the UUID of the LVM VG named C<vgname>.");
4577 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4579 "get the UUID of a logical volume",
4581 This command returns the UUID of the LVM LV C<device>.");
4583 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4585 "get the PV UUIDs containing the volume group",
4587 Given a VG called C<vgname>, this returns the UUIDs of all
4588 the physical volumes that this volume group resides on.
4590 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4591 calls to associate physical volumes and volume groups.
4593 See also C<guestfs_vglvuuids>.");
4595 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4597 "get the LV UUIDs of all LVs in the volume group",
4599 Given a VG called C<vgname>, this returns the UUIDs of all
4600 the logical volumes created in this volume group.
4602 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4603 calls to associate logical volumes and volume groups.
4605 See also C<guestfs_vgpvuuids>.");
4607 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4608 [InitBasicFS, Always, TestOutputBuffer (
4609 [["write"; "/src"; "hello, world"];
4610 ["copy_size"; "/src"; "/dest"; "5"];
4611 ["read_file"; "/dest"]], "hello")],
4612 "copy size bytes from source to destination using dd",
4614 This command copies exactly C<size> bytes from one source device
4615 or file C<src> to another destination device or file C<dest>.
4617 Note this will fail if the source is too short or if the destination
4618 is not large enough.");
4620 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4621 [InitBasicFSonLVM, Always, TestRun (
4622 [["zero_device"; "/dev/VG/LV"]])],
4623 "write zeroes to an entire device",
4625 This command writes zeroes over the entire C<device>. Compare
4626 with C<guestfs_zero> which just zeroes the first few blocks of
4629 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4630 [InitBasicFS, Always, TestOutput (
4631 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4632 ["cat"; "/hello"]], "hello\n")],
4633 "unpack compressed tarball to directory",
4635 This command uploads and unpacks local file C<tarball> (an
4636 I<xz compressed> tar file) into C<directory>.");
4638 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4640 "pack directory into compressed tarball",
4642 This command packs the contents of C<directory> and downloads
4643 it to local file C<tarball> (as an xz compressed tar archive).");
4645 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4647 "resize an NTFS filesystem",
4649 This command resizes an NTFS filesystem, expanding or
4650 shrinking it to the size of the underlying device.
4651 See also L<ntfsresize(8)>.");
4653 ("vgscan", (RErr, [], []), 232, [],
4654 [InitEmpty, Always, TestRun (
4656 "rescan for LVM physical volumes, volume groups and logical volumes",
4658 This rescans all block devices and rebuilds the list of LVM
4659 physical volumes, volume groups and logical volumes.");
4661 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
4662 [InitEmpty, Always, TestRun (
4663 [["part_init"; "/dev/sda"; "mbr"];
4664 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4665 ["part_del"; "/dev/sda"; "1"]])],
4666 "delete a partition",
4668 This command deletes the partition numbered C<partnum> on C<device>.
4670 Note that in the case of MBR partitioning, deleting an
4671 extended partition also deletes any logical partitions
4674 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
4675 [InitEmpty, Always, TestOutputTrue (
4676 [["part_init"; "/dev/sda"; "mbr"];
4677 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4678 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4679 ["part_get_bootable"; "/dev/sda"; "1"]])],
4680 "return true if a partition is bootable",
4682 This command returns true if the partition C<partnum> on
4683 C<device> has the bootable flag set.
4685 See also C<guestfs_part_set_bootable>.");
4687 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
4688 [InitEmpty, Always, TestOutputInt (
4689 [["part_init"; "/dev/sda"; "mbr"];
4690 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4691 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4692 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4693 "get the MBR type byte (ID byte) from a partition",
4695 Returns the MBR type byte (also known as the ID byte) from
4696 the numbered partition C<partnum>.
4698 Note that only MBR (old DOS-style) partitions have type bytes.
4699 You will get undefined results for other partition table
4700 types (see C<guestfs_part_get_parttype>).");
4702 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
4703 [], (* tested by part_get_mbr_id *)
4704 "set the MBR type byte (ID byte) of a partition",
4706 Sets the MBR type byte (also known as the ID byte) of
4707 the numbered partition C<partnum> to C<idbyte>. Note
4708 that the type bytes quoted in most documentation are
4709 in fact hexadecimal numbers, but usually documented
4710 without any leading \"0x\" which might be confusing.
4712 Note that only MBR (old DOS-style) partitions have type bytes.
4713 You will get undefined results for other partition table
4714 types (see C<guestfs_part_get_parttype>).");
4716 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
4717 [InitISOFS, Always, TestOutputFileMD5 (
4718 [["checksum_device"; "md5"; "/dev/sdd"]],
4719 "../images/test.iso")],
4720 "compute MD5, SHAx or CRC checksum of the contents of a device",
4722 This call computes the MD5, SHAx or CRC checksum of the
4723 contents of the device named C<device>. For the types of
4724 checksums supported see the C<guestfs_checksum> command.");
4726 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
4727 [InitNone, Always, TestRun (
4728 [["part_disk"; "/dev/sda"; "mbr"];
4729 ["pvcreate"; "/dev/sda1"];
4730 ["vgcreate"; "VG"; "/dev/sda1"];
4731 ["lvcreate"; "LV"; "VG"; "10"];
4732 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4733 "expand an LV to fill free space",
4735 This expands an existing logical volume C<lv> so that it fills
4736 C<pc>% of the remaining free space in the volume group. Commonly
4737 you would call this with pc = 100 which expands the logical volume
4738 as much as possible, using all remaining free space in the volume
4741 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
4742 [], (* XXX Augeas code needs tests. *)
4743 "clear Augeas path",
4745 Set the value associated with C<path> to C<NULL>. This
4746 is the same as the L<augtool(1)> C<clear> command.");
4748 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
4749 [InitEmpty, Always, TestOutputInt (
4750 [["get_umask"]], 0o22)],
4751 "get the current umask",
4753 Return the current umask. By default the umask is C<022>
4754 unless it has been set by calling C<guestfs_umask>.");
4756 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [],
4758 "upload a file to the appliance (internal use only)",
4760 The C<guestfs_debug_upload> command uploads a file to
4761 the libguestfs appliance.
4763 There is no comprehensive help for this command. You have
4764 to look at the file C<daemon/debug.c> in the libguestfs source
4765 to find out what it is for.");
4767 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
4768 [InitBasicFS, Always, TestOutput (
4769 [["base64_in"; "../images/hello.b64"; "/hello"];
4770 ["cat"; "/hello"]], "hello\n")],
4771 "upload base64-encoded data to file",
4773 This command uploads base64-encoded data from C<base64file>
4776 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
4778 "download file and encode as base64",
4780 This command downloads the contents of C<filename>, writing
4781 it out to local file C<base64file> encoded as base64.");
4783 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
4785 "compute MD5, SHAx or CRC checksum of files in a directory",
4787 This command computes the checksums of all regular files in
4788 C<directory> and then emits a list of those checksums to
4789 the local output file C<sumsfile>.
4791 This can be used for verifying the integrity of a virtual
4792 machine. However to be properly secure you should pay
4793 attention to the output of the checksum command (it uses
4794 the ones from GNU coreutils). In particular when the
4795 filename is not printable, coreutils uses a special
4796 backslash syntax. For more information, see the GNU
4797 coreutils info file.");
4799 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
4800 [InitBasicFS, Always, TestOutputBuffer (
4801 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4802 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4803 "fill a file with a repeating pattern of bytes",
4805 This function is like C<guestfs_fill> except that it creates
4806 a new file of length C<len> containing the repeating pattern
4807 of bytes in C<pattern>. The pattern is truncated if necessary
4808 to ensure the length of the file is exactly C<len> bytes.");
4810 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
4811 [InitBasicFS, Always, TestOutput (
4812 [["write"; "/new"; "new file contents"];
4813 ["cat"; "/new"]], "new file contents");
4814 InitBasicFS, Always, TestOutput (
4815 [["write"; "/new"; "\nnew file contents\n"];
4816 ["cat"; "/new"]], "\nnew file contents\n");
4817 InitBasicFS, Always, TestOutput (
4818 [["write"; "/new"; "\n\n"];
4819 ["cat"; "/new"]], "\n\n");
4820 InitBasicFS, Always, TestOutput (
4821 [["write"; "/new"; ""];
4822 ["cat"; "/new"]], "");
4823 InitBasicFS, Always, TestOutput (
4824 [["write"; "/new"; "\n\n\n"];
4825 ["cat"; "/new"]], "\n\n\n");
4826 InitBasicFS, Always, TestOutput (
4827 [["write"; "/new"; "\n"];
4828 ["cat"; "/new"]], "\n")],
4829 "create a new file",
4831 This call creates a file called C<path>. The content of the
4832 file is the string C<content> (which can contain any 8 bit data).");
4834 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
4835 [InitBasicFS, Always, TestOutput (
4836 [["write"; "/new"; "new file contents"];
4837 ["pwrite"; "/new"; "data"; "4"];
4838 ["cat"; "/new"]], "new data contents");
4839 InitBasicFS, Always, TestOutput (
4840 [["write"; "/new"; "new file contents"];
4841 ["pwrite"; "/new"; "is extended"; "9"];
4842 ["cat"; "/new"]], "new file is extended");
4843 InitBasicFS, Always, TestOutput (
4844 [["write"; "/new"; "new file contents"];
4845 ["pwrite"; "/new"; ""; "4"];
4846 ["cat"; "/new"]], "new file contents")],
4847 "write to part of a file",
4849 This command writes to part of a file. It writes the data
4850 buffer C<content> to the file C<path> starting at offset C<offset>.
4852 This command implements the L<pwrite(2)> system call, and like
4853 that system call it may not write the full data requested. The
4854 return value is the number of bytes that were actually written
4855 to the file. This could even be 0, although short writes are
4856 unlikely for regular files in ordinary circumstances.
4858 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
4860 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
4862 "resize an ext2, ext3 or ext4 filesystem (with size)",
4864 This command is the same as C<guestfs_resize2fs> except that it
4865 allows you to specify the new size (in bytes) explicitly.");
4867 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
4869 "resize an LVM physical volume (with size)",
4871 This command is the same as C<guestfs_pvresize> except that it
4872 allows you to specify the new size (in bytes) explicitly.");
4874 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
4876 "resize an NTFS filesystem (with size)",
4878 This command is the same as C<guestfs_ntfsresize> except that it
4879 allows you to specify the new size (in bytes) explicitly.");
4881 ("available_all_groups", (RStringList "groups", [], []), 251, [],
4882 [InitNone, Always, TestRun [["available_all_groups"]]],
4883 "return a list of all optional groups",
4885 This command returns a list of all optional groups that this
4886 daemon knows about. Note this returns both supported and unsupported
4887 groups. To find out which ones the daemon can actually support
4888 you have to call C<guestfs_available> on each member of the
4891 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4893 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
4894 [InitBasicFS, Always, TestOutputStruct (
4895 [["fallocate64"; "/a"; "1000000"];
4896 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4897 "preallocate a file in the guest filesystem",
4899 This command preallocates a file (containing zero bytes) named
4900 C<path> of size C<len> bytes. If the file exists already, it
4903 Note that this call allocates disk blocks for the file.
4904 To create a sparse file use C<guestfs_truncate_size> instead.
4906 The deprecated call C<guestfs_fallocate> does the same,
4907 but owing to an oversight it only allowed 30 bit lengths
4908 to be specified, effectively limiting the maximum size
4909 of files created through that call to 1GB.
4911 Do not confuse this with the guestfish-specific
4912 C<alloc> and C<sparse> commands which create
4913 a file in the host and attach it as a device.");
4915 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
4916 [InitBasicFS, Always, TestOutput (
4917 [["set_e2label"; "/dev/sda1"; "LTEST"];
4918 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4919 "get the filesystem label",
4921 This returns the filesystem label of the filesystem on
4924 If the filesystem is unlabeled, this returns the empty string.
4926 To find a filesystem from the label, use C<guestfs_findfs_label>.");
4928 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
4929 (let uuid = uuidgen () in
4930 [InitBasicFS, Always, TestOutput (
4931 [["set_e2uuid"; "/dev/sda1"; uuid];
4932 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4933 "get the filesystem UUID",
4935 This returns the filesystem UUID of the filesystem on
4938 If the filesystem does not have a UUID, this returns the empty string.
4940 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
4942 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
4943 (* Can't be tested with the current framework because
4944 * the VG is being used by the mounted filesystem, so
4945 * the vgchange -an command we do first will fail.
4948 "set LVM device filter",
4950 This sets the LVM device filter so that LVM will only be
4951 able to \"see\" the block devices in the list C<devices>,
4952 and will ignore all other attached block devices.
4954 Where disk image(s) contain duplicate PVs or VGs, this
4955 command is useful to get LVM to ignore the duplicates, otherwise
4956 LVM can get confused. Note also there are two types
4957 of duplication possible: either cloned PVs/VGs which have
4958 identical UUIDs; or VGs that are not cloned but just happen
4959 to have the same name. In normal operation you cannot
4960 create this situation, but you can do it outside LVM, eg.
4961 by cloning disk images or by bit twiddling inside the LVM
4964 This command also clears the LVM cache and performs a volume
4967 You can filter whole block devices or individual partitions.
4969 You cannot use this if any VG is currently in use (eg.
4970 contains a mounted filesystem), even if you are not
4971 filtering out that VG.");
4973 ("lvm_clear_filter", (RErr, [], []), 256, [],
4974 [], (* see note on lvm_set_filter *)
4975 "clear LVM device filter",
4977 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
4978 will be able to see every block device.
4980 This command also clears the LVM cache and performs a volume
4983 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
4985 "open a LUKS-encrypted block device",
4987 This command opens a block device which has been encrypted
4988 according to the Linux Unified Key Setup (LUKS) standard.
4990 C<device> is the encrypted block device or partition.
4992 The caller must supply one of the keys associated with the
4993 LUKS block device, in the C<key> parameter.
4995 This creates a new block device called C</dev/mapper/mapname>.
4996 Reads and writes to this block device are decrypted from and
4997 encrypted to the underlying C<device> respectively.
4999 If this block device contains LVM volume groups, then
5000 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5001 will make them visible.");
5003 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5005 "open a LUKS-encrypted block device read-only",
5007 This is the same as C<guestfs_luks_open> except that a read-only
5008 mapping is created.");
5010 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5012 "close a LUKS device",
5014 This closes a LUKS device that was created earlier by
5015 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5016 C<device> parameter must be the name of the LUKS mapping
5017 device (ie. C</dev/mapper/mapname>) and I<not> the name
5018 of the underlying block device.");
5020 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5022 "format a block device as a LUKS encrypted device",
5024 This command erases existing data on C<device> and formats
5025 the device as a LUKS encrypted device. C<key> is the
5026 initial key, which is added to key slot C<slot>. (LUKS
5027 supports 8 key slots, numbered 0-7).");
5029 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5031 "format a block device as a LUKS encrypted device",
5033 This command is the same as C<guestfs_luks_format> but
5034 it also allows you to set the C<cipher> used.");
5036 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5038 "add a key on a LUKS encrypted device",
5040 This command adds a new key on LUKS device C<device>.
5041 C<key> is any existing key, and is used to access the device.
5042 C<newkey> is the new key to add. C<keyslot> is the key slot
5043 that will be replaced.
5045 Note that if C<keyslot> already contains a key, then this
5046 command will fail. You have to use C<guestfs_luks_kill_slot>
5047 first to remove that key.");
5049 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5051 "remove a key from a LUKS encrypted device",
5053 This command deletes the key in key slot C<keyslot> from the
5054 encrypted LUKS device C<device>. C<key> must be one of the
5057 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5058 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5059 [["is_lv"; "/dev/VG/LV"]]);
5060 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5061 [["is_lv"; "/dev/sda1"]])],
5062 "test if device is a logical volume",
5064 This command tests whether C<device> is a logical volume, and
5065 returns true iff this is the case.");
5067 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5069 "find a filesystem by UUID",
5071 This command searches the filesystems and returns the one
5072 which has the given UUID. An error is returned if no such
5073 filesystem can be found.
5075 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5077 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5079 "find a filesystem by label",
5081 This command searches the filesystems and returns the one
5082 which has the given label. An error is returned if no such
5083 filesystem can be found.
5085 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5087 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5088 [InitISOFS, Always, TestOutputFalse (
5089 [["is_chardev"; "/directory"]]);
5090 InitBasicFS, Always, TestOutputTrue (
5091 [["mknod_c"; "0o777"; "99"; "66"; "/test"];
5092 ["is_chardev"; "/test"]])],
5093 "test if character device",
5095 This returns C<true> if and only if there is a character device
5096 with the given C<path> name.
5098 See also C<guestfs_stat>.");
5100 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5101 [InitISOFS, Always, TestOutputFalse (
5102 [["is_blockdev"; "/directory"]]);
5103 InitBasicFS, Always, TestOutputTrue (
5104 [["mknod_b"; "0o777"; "99"; "66"; "/test"];
5105 ["is_blockdev"; "/test"]])],
5106 "test if block device",
5108 This returns C<true> if and only if there is a block device
5109 with the given C<path> name.
5111 See also C<guestfs_stat>.");
5113 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5114 [InitISOFS, Always, TestOutputFalse (
5115 [["is_fifo"; "/directory"]]);
5116 InitBasicFS, Always, TestOutputTrue (
5117 [["mkfifo"; "0o777"; "/test"];
5118 ["is_fifo"; "/test"]])],
5119 "test if FIFO (named pipe)",
5121 This returns C<true> if and only if there is a FIFO (named pipe)
5122 with the given C<path> name.
5124 See also C<guestfs_stat>.");
5126 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5127 [InitISOFS, Always, TestOutputFalse (
5128 [["is_symlink"; "/directory"]]);
5129 InitISOFS, Always, TestOutputTrue (
5130 [["is_symlink"; "/abssymlink"]])],
5131 "test if symbolic link",
5133 This returns C<true> if and only if there is a symbolic link
5134 with the given C<path> name.
5136 See also C<guestfs_stat>.");
5138 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5139 (* XXX Need a positive test for sockets. *)
5140 [InitISOFS, Always, TestOutputFalse (
5141 [["is_socket"; "/directory"]])],
5144 This returns C<true> if and only if there is a Unix domain socket
5145 with the given C<path> name.
5147 See also C<guestfs_stat>.");
5149 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5150 [InitPartition, Always, TestOutputDevice (
5151 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5152 InitEmpty, Always, TestLastFail (
5153 [["part_to_dev"; "/dev/sda"]])],
5154 "convert partition name to device name",
5156 This function takes a partition name (eg. \"/dev/sdb1\") and
5157 removes the partition number, returning the device name
5160 The named partition must exist, for example as a string returned
5161 from C<guestfs_list_partitions>.");
5163 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [],
5164 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5165 [InitBasicFS, Always, TestOutput (
5166 [["upload_offset"; "../COPYING.LIB"; "/COPYING.LIB"; "0"];
5167 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5168 "upload a file from the local machine with offset",
5170 Upload local file C<filename> to C<remotefilename> on the
5173 C<remotefilename> is overwritten starting at the byte C<offset>
5174 specified. The intention is to overwrite parts of existing
5175 files or devices, although if a non-existant file is specified
5176 then it is created with a \"hole\" before C<offset>. The
5177 size of the data written is implicit in the size of the
5180 Note that there is no limit on the amount of data that
5181 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5182 and this call always writes the full amount unless an
5185 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5187 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5188 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5189 let offset = string_of_int 100 in
5190 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5191 [InitBasicFS, Always, TestOutput (
5192 (* Pick a file from cwd which isn't likely to change. *)
5193 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
5194 ["download_offset"; "/COPYING.LIB"; "testdownload.tmp"; offset; size];
5195 ["upload_offset"; "testdownload.tmp"; "/COPYING.LIB"; offset];
5196 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5197 "download a file to the local machine with offset and size",
5199 Download file C<remotefilename> and save it as C<filename>
5200 on the local machine.
5202 C<remotefilename> is read for C<size> bytes starting at C<offset>
5203 (this region must be within the file or device).
5205 Note that there is no limit on the amount of data that
5206 can be downloaded with this call, unlike with C<guestfs_pread>,
5207 and this call always reads the full amount unless an
5210 See also C<guestfs_download>, C<guestfs_pread>.");
5212 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5213 [InitPartition, Always, TestOutputList (
5214 [["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"];
5215 ["blockdev_rereadpt"; "/dev/sda"];
5216 ["list_partitions"]], [])],
5217 "write to part of a device",
5219 This command writes to part of a device. It writes the data
5220 buffer C<content> to C<device> starting at offset C<offset>.
5222 This command implements the L<pwrite(2)> system call, and like
5223 that system call it may not write the full data requested
5224 (although short writes to disk devices and partitions are
5225 probably impossible with standard Linux kernels).
5227 See also C<guestfs_pwrite>.");
5229 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5230 [InitEmpty, Always, TestOutputBuffer (
5231 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5232 "read part of a device",
5234 This command lets you read part of a file. It reads C<count>
5235 bytes of C<device>, starting at C<offset>.
5237 This may read fewer bytes than requested. For further details
5238 see the L<pread(2)> system call.
5240 See also C<guestfs_pread>.");
5242 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5243 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5244 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5245 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5246 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5247 "get canonical name of an LV",
5249 This converts alternative naming schemes for LVs that you
5250 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5251 is converted to C</dev/VG/LV>.
5253 This command returns an error if the C<lvname> parameter does
5254 not refer to a logical volume.
5256 See also C<guestfs_is_lv>.");
5260 let all_functions = non_daemon_functions @ daemon_functions
5262 (* In some places we want the functions to be displayed sorted
5263 * alphabetically, so this is useful:
5265 let all_functions_sorted = List.sort action_compare all_functions
5267 (* This is used to generate the src/MAX_PROC_NR file which
5268 * contains the maximum procedure number, a surrogate for the
5269 * ABI version number. See src/Makefile.am for the details.
5272 let proc_nrs = List.map (
5273 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5274 ) daemon_functions in
5275 List.fold_left max 0 proc_nrs
5277 (* Non-API meta-commands available only in guestfish.
5279 * Note (1): style, proc_nr and tests fields are all meaningless.
5280 * The only fields which are actually used are the shortname,
5281 * FishAlias flags, shortdesc and longdesc.
5283 * Note (2): to refer to other commands, use L</shortname>.
5285 * Note (3): keep this list sorted by shortname.
5287 let fish_commands = [
5288 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5289 "allocate and add a disk file",
5290 " alloc filename size
5292 This creates an empty (zeroed) file of the given size, and then adds
5293 so it can be further examined.
5295 For more advanced image creation, see L<qemu-img(1)> utility.
5297 Size can be specified using standard suffixes, eg. C<1M>.
5299 To create a sparse file, use L</sparse> instead. To create a
5300 prepared disk image, see L</PREPARED DISK IMAGES>.");
5302 ("copy_in", (RErr,[], []), -1, [], [],
5303 "copy local files or directories into an image",
5304 " copy-in local [local ...] /remotedir
5306 C<copy-in> copies local files or directories recursively into the disk
5307 image, placing them in the directory called C</remotedir> (which must
5308 exist). This guestfish meta-command turns into a sequence of
5309 L</tar-in> and other commands as necessary.
5311 Multiple local files and directories can be specified, but the last
5312 parameter must always be a remote directory. Wildcards cannot be
5315 ("copy_out", (RErr,[], []), -1, [], [],
5316 "copy remote files or directories out of an image",
5317 " copy-out remote [remote ...] localdir
5319 C<copy-out> copies remote files or directories recursively out of the
5320 disk image, placing them on the host disk in a local directory called
5321 C<localdir> (which must exist). This guestfish meta-command turns
5322 into a sequence of L</download>, L</tar-out> and other commands as
5325 Multiple remote files and directories can be specified, but the last
5326 parameter must always be a local directory. To download to the
5327 current directory, use C<.> as in:
5331 Wildcards cannot be used in the ordinary command, but you can use
5332 them with the help of L</glob> like this:
5334 glob copy-out /home/* .");
5336 ("echo", (RErr,[], []), -1, [], [],
5337 "display a line of text",
5340 This echos the parameters to the terminal.");
5342 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5346 This is used to edit a file. It downloads the file, edits it
5347 locally using your editor, then uploads the result.
5349 The editor is C<$EDITOR>. However if you use the alternate
5350 commands C<vi> or C<emacs> you will get those corresponding
5353 ("glob", (RErr,[], []), -1, [], [],
5354 "expand wildcards in command",
5355 " glob command args...
5357 Expand wildcards in any paths in the args list, and run C<command>
5358 repeatedly on each matching path.
5360 See L</WILDCARDS AND GLOBBING>.");
5362 ("hexedit", (RErr,[], []), -1, [], [],
5363 "edit with a hex editor",
5364 " hexedit <filename|device>
5365 hexedit <filename|device> <max>
5366 hexedit <filename|device> <start> <max>
5368 Use hexedit (a hex editor) to edit all or part of a binary file
5371 This command works by downloading potentially the whole file or
5372 device, editing it locally, then uploading it. If the file or
5373 device is large, you have to specify which part you wish to edit
5374 by using C<max> and/or C<start> C<max> parameters.
5375 C<start> and C<max> are specified in bytes, with the usual
5376 modifiers allowed such as C<1M> (1 megabyte).
5378 For example to edit the first few sectors of a disk you
5383 which would allow you to edit anywhere within the first megabyte
5386 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5388 hexedit /dev/sda1 0x400 0x400
5390 (assuming the superblock is in the standard location).
5392 This command requires the external L<hexedit(1)> program. You
5393 can specify another program to use by setting the C<HEXEDITOR>
5394 environment variable.
5396 See also L</hexdump>.");
5398 ("lcd", (RErr,[], []), -1, [], [],
5399 "change working directory",
5402 Change the local directory, ie. the current directory of guestfish
5405 Note that C<!cd> won't do what you might expect.");
5407 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5411 Opens the manual page for guestfish.");
5413 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5419 This is used to view a file.
5421 The default viewer is C<$PAGER>. However if you use the alternate
5422 command C<less> you will get the C<less> command specifically.");
5424 ("reopen", (RErr,[], []), -1, [], [],
5425 "close and reopen libguestfs handle",
5428 Close and reopen the libguestfs handle. It is not necessary to use
5429 this normally, because the handle is closed properly when guestfish
5430 exits. However this is occasionally useful for testing.");
5432 ("sparse", (RErr,[], []), -1, [], [],
5433 "create a sparse disk image and add",
5434 " sparse filename size
5436 This creates an empty sparse file of the given size, and then adds
5437 so it can be further examined.
5439 In all respects it works the same as the L</alloc> command, except that
5440 the image file is allocated sparsely, which means that disk blocks are
5441 not assigned to the file until they are needed. Sparse disk files
5442 only use space when written to, but they are slower and there is a
5443 danger you could run out of real disk space during a write operation.
5445 For more advanced image creation, see L<qemu-img(1)> utility.
5447 Size can be specified using standard suffixes, eg. C<1M>.");
5449 ("supported", (RErr,[], []), -1, [], [],
5450 "list supported groups of commands",
5453 This command returns a list of the optional groups
5454 known to the daemon, and indicates which ones are
5455 supported by this build of the libguestfs appliance.
5457 See also L<guestfs(3)/AVAILABILITY>.");
5459 ("time", (RErr,[], []), -1, [], [],
5460 "print elapsed time taken to run a command",
5461 " time command args...
5463 Run the command as usual, but print the elapsed time afterwards. This
5464 can be useful for benchmarking operations.");