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.
794 =item \"redhat-based\"
796 Some Red Hat-derived distro.
800 Red Hat Enterprise Linux and some derivatives.
804 Windows does not have distributions. This string is
805 returned if the OS type is Windows.
809 The distro could not be determined.
813 Future versions of libguestfs may return other strings here.
814 The caller should be prepared to handle any string.
816 Please read L<guestfs(3)/INSPECTION> for more details.");
818 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
820 "get major version of inspected operating system",
822 This function should only be called with a root device string
823 as returned by C<guestfs_inspect_os>.
825 This returns the major version number of the inspected operating
828 Windows uses a consistent versioning scheme which is I<not>
829 reflected in the popular public names used by the operating system.
830 Notably the operating system known as \"Windows 7\" is really
831 version 6.1 (ie. major = 6, minor = 1). You can find out the
832 real versions corresponding to releases of Windows by consulting
835 If the version could not be determined, then C<0> is returned.
837 Please read L<guestfs(3)/INSPECTION> for more details.");
839 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
841 "get minor version of inspected operating system",
843 This function should only be called with a root device string
844 as returned by C<guestfs_inspect_os>.
846 This returns the minor version number of the inspected operating
849 If the version could not be determined, then C<0> is returned.
851 Please read L<guestfs(3)/INSPECTION> for more details.
852 See also C<guestfs_inspect_get_major_version>.");
854 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
856 "get product name of inspected operating system",
858 This function should only be called with a root device string
859 as returned by C<guestfs_inspect_os>.
861 This returns the product name of the inspected operating
862 system. The product name is generally some freeform string
863 which can be displayed to the user, but should not be
866 If the product name could not be determined, then the
867 string C<unknown> is returned.
869 Please read L<guestfs(3)/INSPECTION> for more details.");
871 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
873 "get mountpoints of inspected operating system",
875 This function should only be called with a root device string
876 as returned by C<guestfs_inspect_os>.
878 This returns a hash of where we think the filesystems
879 associated with this operating system should be mounted.
880 Callers should note that this is at best an educated guess
881 made by reading configuration files such as C</etc/fstab>.
883 Each element in the returned hashtable has a key which
884 is the path of the mountpoint (eg. C</boot>) and a value
885 which is the filesystem that would be mounted there
888 Non-mounted devices such as swap devices are I<not>
889 returned in this list.
891 Please read L<guestfs(3)/INSPECTION> for more details.
892 See also C<guestfs_inspect_get_filesystems>.");
894 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
896 "get filesystems associated with inspected operating system",
898 This function should only be called with a root device string
899 as returned by C<guestfs_inspect_os>.
901 This returns a list of all the filesystems that we think
902 are associated with this operating system. This includes
903 the root filesystem, other ordinary filesystems, and
904 non-mounted devices like swap partitions.
906 In the case of a multi-boot virtual machine, it is possible
907 for a filesystem to be shared between operating systems.
909 Please read L<guestfs(3)/INSPECTION> for more details.
910 See also C<guestfs_inspect_get_mountpoints>.");
912 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
914 "set enable network flag",
916 If C<network> is true, then the network is enabled in the
917 libguestfs appliance. The default is false.
919 This affects whether commands are able to access the network
920 (see L<guestfs(3)/RUNNING COMMANDS>).
922 You must call this before calling C<guestfs_launch>, otherwise
925 ("get_network", (RBool "network", [], []), -1, [],
927 "get enable network flag",
929 This returns the enable network flag.");
931 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
935 This inspection command looks for filesystems on partitions,
936 block devices and logical volumes, returning a list of devices
937 containing filesystems and their type.
939 The return value is a hash, where the keys are the devices
940 containing filesystems, and the values are the filesystem types.
943 \"/dev/sda1\" => \"ntfs\"
944 \"/dev/sda2\" => \"ext2\"
945 \"/dev/vg_guest/lv_root\" => \"ext4\"
946 \"/dev/vg_guest/lv_swap\" => \"swap\"
948 The value can have the special value \"unknown\", meaning the
949 content of the device is undetermined or empty.
950 \"swap\" means a Linux swap partition.
952 This command runs other libguestfs commands, which might include
953 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
954 use this soon after launch and only when nothing is mounted.
956 Not all of the filesystems returned will be mountable. In
957 particular, swap partitions are returned in the list. Also
958 this command does not check that each filesystem
959 found is valid and mountable, and some filesystems might
960 be mountable but require special options. Filesystems may
961 not all belong to a single logical operating system
962 (use C<guestfs_inspect_os> to look for OSes).");
964 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
966 "add an image to examine or modify",
968 This function adds a virtual machine disk image C<filename> to
969 libguestfs. The first time you call this function, the disk
970 appears as C</dev/sda>, the second time as C</dev/sdb>, and
973 You don't necessarily need to be root when using libguestfs. However
974 you obviously do need sufficient permissions to access the filename
975 for whatever operations you want to perform (ie. read access if you
976 just want to read the image or write access if you want to modify the
979 This call checks that C<filename> exists.
981 The optional arguments are:
987 If true then the image is treated as read-only. Writes are still
988 allowed, but they are stored in a temporary snapshot overlay which
989 is discarded at the end. The disk that you add is not modified.
993 This forces the image format. If you omit this (or use C<guestfs_add_drive>
994 or C<guestfs_add_drive_ro>) then the format is automatically detected.
995 Possible formats include C<raw> and C<qcow2>.
997 Automatic detection of the format opens you up to a potential
998 security hole when dealing with untrusted raw-format images.
999 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1004 This rarely-used option lets you emulate the behaviour of the
1005 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1009 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1011 "get Windows systemroot of inspected operating system",
1013 This function should only be called with a root device string
1014 as returned by C<guestfs_inspect_os>.
1016 This returns the Windows systemroot of the inspected guest.
1017 The systemroot is a directory path such as C</WINDOWS>.
1019 This call assumes that the guest is Windows and that the
1020 systemroot could be determined by inspection. If this is not
1021 the case then an error is returned.
1023 Please read L<guestfs(3)/INSPECTION> for more details.");
1027 (* daemon_functions are any functions which cause some action
1028 * to take place in the daemon.
1031 let daemon_functions = [
1032 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1033 [InitEmpty, Always, TestOutput (
1034 [["part_disk"; "/dev/sda"; "mbr"];
1035 ["mkfs"; "ext2"; "/dev/sda1"];
1036 ["mount"; "/dev/sda1"; "/"];
1037 ["write"; "/new"; "new file contents"];
1038 ["cat"; "/new"]], "new file contents")],
1039 "mount a guest disk at a position in the filesystem",
1041 Mount a guest disk at a position in the filesystem. Block devices
1042 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1043 the guest. If those block devices contain partitions, they will have
1044 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1047 The rules are the same as for L<mount(2)>: A filesystem must
1048 first be mounted on C</> before others can be mounted. Other
1049 filesystems can only be mounted on directories which already
1052 The mounted filesystem is writable, if we have sufficient permissions
1053 on the underlying device.
1056 When you use this call, the filesystem options C<sync> and C<noatime>
1057 are set implicitly. This was originally done because we thought it
1058 would improve reliability, but it turns out that I<-o sync> has a
1059 very large negative performance impact and negligible effect on
1060 reliability. Therefore we recommend that you avoid using
1061 C<guestfs_mount> in any code that needs performance, and instead
1062 use C<guestfs_mount_options> (use an empty string for the first
1063 parameter if you don't want any options).");
1065 ("sync", (RErr, [], []), 2, [],
1066 [ InitEmpty, Always, TestRun [["sync"]]],
1067 "sync disks, writes are flushed through to the disk image",
1069 This syncs the disk, so that any writes are flushed through to the
1070 underlying disk image.
1072 You should always call this if you have modified a disk image, before
1073 closing the handle.");
1075 ("touch", (RErr, [Pathname "path"], []), 3, [],
1076 [InitBasicFS, Always, TestOutputTrue (
1078 ["exists"; "/new"]])],
1079 "update file timestamps or create a new file",
1081 Touch acts like the L<touch(1)> command. It can be used to
1082 update the timestamps on a file, or, if the file does not exist,
1083 to create a new zero-length file.
1085 This command only works on regular files, and will fail on other
1086 file types such as directories, symbolic links, block special etc.");
1088 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1089 [InitISOFS, Always, TestOutput (
1090 [["cat"; "/known-2"]], "abcdef\n")],
1091 "list the contents of a file",
1093 Return the contents of the file named C<path>.
1095 Note that this function cannot correctly handle binary files
1096 (specifically, files containing C<\\0> character which is treated
1097 as end of string). For those you need to use the C<guestfs_read_file>
1098 or C<guestfs_download> functions which have a more complex interface.");
1100 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1101 [], (* XXX Tricky to test because it depends on the exact format
1102 * of the 'ls -l' command, which changes between F10 and F11.
1104 "list the files in a directory (long format)",
1106 List the files in C<directory> (relative to the root directory,
1107 there is no cwd) in the format of 'ls -la'.
1109 This command is mostly useful for interactive sessions. It
1110 is I<not> intended that you try to parse the output string.");
1112 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1113 [InitBasicFS, Always, TestOutputList (
1115 ["touch"; "/newer"];
1116 ["touch"; "/newest"];
1117 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1118 "list the files in a directory",
1120 List the files in C<directory> (relative to the root directory,
1121 there is no cwd). The '.' and '..' entries are not returned, but
1122 hidden files are shown.
1124 This command is mostly useful for interactive sessions. Programs
1125 should probably use C<guestfs_readdir> instead.");
1127 ("list_devices", (RStringList "devices", [], []), 7, [],
1128 [InitEmpty, Always, TestOutputListOfDevices (
1129 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1130 "list the block devices",
1132 List all the block devices.
1134 The full block device names are returned, eg. C</dev/sda>.
1136 See also C<guestfs_list_filesystems>.");
1138 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1139 [InitBasicFS, Always, TestOutputListOfDevices (
1140 [["list_partitions"]], ["/dev/sda1"]);
1141 InitEmpty, Always, TestOutputListOfDevices (
1142 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1143 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1144 "list the partitions",
1146 List all the partitions detected on all block devices.
1148 The full partition device names are returned, eg. C</dev/sda1>
1150 This does not return logical volumes. For that you will need to
1151 call C<guestfs_lvs>.
1153 See also C<guestfs_list_filesystems>.");
1155 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1156 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1157 [["pvs"]], ["/dev/sda1"]);
1158 InitEmpty, Always, TestOutputListOfDevices (
1159 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1160 ["pvcreate"; "/dev/sda1"];
1161 ["pvcreate"; "/dev/sda2"];
1162 ["pvcreate"; "/dev/sda3"];
1163 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1164 "list the LVM physical volumes (PVs)",
1166 List all the physical volumes detected. This is the equivalent
1167 of the L<pvs(8)> command.
1169 This returns a list of just the device names that contain
1170 PVs (eg. C</dev/sda2>).
1172 See also C<guestfs_pvs_full>.");
1174 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1175 [InitBasicFSonLVM, Always, TestOutputList (
1177 InitEmpty, Always, TestOutputList (
1178 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1179 ["pvcreate"; "/dev/sda1"];
1180 ["pvcreate"; "/dev/sda2"];
1181 ["pvcreate"; "/dev/sda3"];
1182 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1183 ["vgcreate"; "VG2"; "/dev/sda3"];
1184 ["vgs"]], ["VG1"; "VG2"])],
1185 "list the LVM volume groups (VGs)",
1187 List all the volumes groups detected. This is the equivalent
1188 of the L<vgs(8)> command.
1190 This returns a list of just the volume group names that were
1191 detected (eg. C<VolGroup00>).
1193 See also C<guestfs_vgs_full>.");
1195 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1196 [InitBasicFSonLVM, Always, TestOutputList (
1197 [["lvs"]], ["/dev/VG/LV"]);
1198 InitEmpty, Always, TestOutputList (
1199 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1200 ["pvcreate"; "/dev/sda1"];
1201 ["pvcreate"; "/dev/sda2"];
1202 ["pvcreate"; "/dev/sda3"];
1203 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1204 ["vgcreate"; "VG2"; "/dev/sda3"];
1205 ["lvcreate"; "LV1"; "VG1"; "50"];
1206 ["lvcreate"; "LV2"; "VG1"; "50"];
1207 ["lvcreate"; "LV3"; "VG2"; "50"];
1208 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1209 "list the LVM logical volumes (LVs)",
1211 List all the logical volumes detected. This is the equivalent
1212 of the L<lvs(8)> command.
1214 This returns a list of the logical volume device names
1215 (eg. C</dev/VolGroup00/LogVol00>).
1217 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1219 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1220 [], (* XXX how to test? *)
1221 "list the LVM physical volumes (PVs)",
1223 List all the physical volumes detected. This is the equivalent
1224 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1226 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1227 [], (* XXX how to test? *)
1228 "list the LVM volume groups (VGs)",
1230 List all the volumes groups detected. This is the equivalent
1231 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1233 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1234 [], (* XXX how to test? *)
1235 "list the LVM logical volumes (LVs)",
1237 List all the logical volumes detected. This is the equivalent
1238 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1240 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1241 [InitISOFS, Always, TestOutputList (
1242 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1243 InitISOFS, Always, TestOutputList (
1244 [["read_lines"; "/empty"]], [])],
1245 "read file as lines",
1247 Return the contents of the file named C<path>.
1249 The file contents are returned as a list of lines. Trailing
1250 C<LF> and C<CRLF> character sequences are I<not> returned.
1252 Note that this function cannot correctly handle binary files
1253 (specifically, files containing C<\\0> character which is treated
1254 as end of line). For those you need to use the C<guestfs_read_file>
1255 function which has a more complex interface.");
1257 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1258 [], (* XXX Augeas code needs tests. *)
1259 "create a new Augeas handle",
1261 Create a new Augeas handle for editing configuration files.
1262 If there was any previous Augeas handle associated with this
1263 guestfs session, then it is closed.
1265 You must call this before using any other C<guestfs_aug_*>
1268 C<root> is the filesystem root. C<root> must not be NULL,
1271 The flags are the same as the flags defined in
1272 E<lt>augeas.hE<gt>, the logical I<or> of the following
1277 =item C<AUG_SAVE_BACKUP> = 1
1279 Keep the original file with a C<.augsave> extension.
1281 =item C<AUG_SAVE_NEWFILE> = 2
1283 Save changes into a file with extension C<.augnew>, and
1284 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1286 =item C<AUG_TYPE_CHECK> = 4
1288 Typecheck lenses (can be expensive).
1290 =item C<AUG_NO_STDINC> = 8
1292 Do not use standard load path for modules.
1294 =item C<AUG_SAVE_NOOP> = 16
1296 Make save a no-op, just record what would have been changed.
1298 =item C<AUG_NO_LOAD> = 32
1300 Do not load the tree in C<guestfs_aug_init>.
1304 To close the handle, you can call C<guestfs_aug_close>.
1306 To find out more about Augeas, see L<http://augeas.net/>.");
1308 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1309 [], (* XXX Augeas code needs tests. *)
1310 "close the current Augeas handle",
1312 Close the current Augeas handle and free up any resources
1313 used by it. After calling this, you have to call
1314 C<guestfs_aug_init> again before you can use any other
1315 Augeas functions.");
1317 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1318 [], (* XXX Augeas code needs tests. *)
1319 "define an Augeas variable",
1321 Defines an Augeas variable C<name> whose value is the result
1322 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1325 On success this returns the number of nodes in C<expr>, or
1326 C<0> if C<expr> evaluates to something which is not a nodeset.");
1328 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1329 [], (* XXX Augeas code needs tests. *)
1330 "define an Augeas node",
1332 Defines a variable C<name> whose value is the result of
1335 If C<expr> evaluates to an empty nodeset, a node is created,
1336 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1337 C<name> will be the nodeset containing that single node.
1339 On success this returns a pair containing the
1340 number of nodes in the nodeset, and a boolean flag
1341 if a node was created.");
1343 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1344 [], (* XXX Augeas code needs tests. *)
1345 "look up the value of an Augeas path",
1347 Look up the value associated with C<path>. If C<path>
1348 matches exactly one node, the C<value> is returned.");
1350 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1351 [], (* XXX Augeas code needs tests. *)
1352 "set Augeas path to value",
1354 Set the value associated with C<path> to C<val>.
1356 In the Augeas API, it is possible to clear a node by setting
1357 the value to NULL. Due to an oversight in the libguestfs API
1358 you cannot do that with this call. Instead you must use the
1359 C<guestfs_aug_clear> call.");
1361 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1362 [], (* XXX Augeas code needs tests. *)
1363 "insert a sibling Augeas node",
1365 Create a new sibling C<label> for C<path>, inserting it into
1366 the tree before or after C<path> (depending on the boolean
1369 C<path> must match exactly one existing node in the tree, and
1370 C<label> must be a label, ie. not contain C</>, C<*> or end
1371 with a bracketed index C<[N]>.");
1373 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1374 [], (* XXX Augeas code needs tests. *)
1375 "remove an Augeas path",
1377 Remove C<path> and all of its children.
1379 On success this returns the number of entries which were removed.");
1381 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1382 [], (* XXX Augeas code needs tests. *)
1385 Move the node C<src> to C<dest>. C<src> must match exactly
1386 one node. C<dest> is overwritten if it exists.");
1388 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1389 [], (* XXX Augeas code needs tests. *)
1390 "return Augeas nodes which match augpath",
1392 Returns a list of paths which match the path expression C<path>.
1393 The returned paths are sufficiently qualified so that they match
1394 exactly one node in the current tree.");
1396 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1397 [], (* XXX Augeas code needs tests. *)
1398 "write all pending Augeas changes to disk",
1400 This writes all pending changes to disk.
1402 The flags which were passed to C<guestfs_aug_init> affect exactly
1403 how files are saved.");
1405 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1406 [], (* XXX Augeas code needs tests. *)
1407 "load files into the tree",
1409 Load files into the tree.
1411 See C<aug_load> in the Augeas documentation for the full gory
1414 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1415 [], (* XXX Augeas code needs tests. *)
1416 "list Augeas nodes under augpath",
1418 This is just a shortcut for listing C<guestfs_aug_match>
1419 C<path/*> and sorting the resulting nodes into alphabetical order.");
1421 ("rm", (RErr, [Pathname "path"], []), 29, [],
1422 [InitBasicFS, Always, TestRun
1425 InitBasicFS, Always, TestLastFail
1427 InitBasicFS, Always, TestLastFail
1432 Remove the single file C<path>.");
1434 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1435 [InitBasicFS, Always, TestRun
1438 InitBasicFS, Always, TestLastFail
1439 [["rmdir"; "/new"]];
1440 InitBasicFS, Always, TestLastFail
1442 ["rmdir"; "/new"]]],
1443 "remove a directory",
1445 Remove the single directory C<path>.");
1447 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1448 [InitBasicFS, Always, TestOutputFalse
1450 ["mkdir"; "/new/foo"];
1451 ["touch"; "/new/foo/bar"];
1453 ["exists"; "/new"]]],
1454 "remove a file or directory recursively",
1456 Remove the file or directory C<path>, recursively removing the
1457 contents if its a directory. This is like the C<rm -rf> shell
1460 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1461 [InitBasicFS, Always, TestOutputTrue
1463 ["is_dir"; "/new"]];
1464 InitBasicFS, Always, TestLastFail
1465 [["mkdir"; "/new/foo/bar"]]],
1466 "create a directory",
1468 Create a directory named C<path>.");
1470 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1471 [InitBasicFS, Always, TestOutputTrue
1472 [["mkdir_p"; "/new/foo/bar"];
1473 ["is_dir"; "/new/foo/bar"]];
1474 InitBasicFS, Always, TestOutputTrue
1475 [["mkdir_p"; "/new/foo/bar"];
1476 ["is_dir"; "/new/foo"]];
1477 InitBasicFS, Always, TestOutputTrue
1478 [["mkdir_p"; "/new/foo/bar"];
1479 ["is_dir"; "/new"]];
1480 (* Regression tests for RHBZ#503133: *)
1481 InitBasicFS, Always, TestRun
1483 ["mkdir_p"; "/new"]];
1484 InitBasicFS, Always, TestLastFail
1486 ["mkdir_p"; "/new"]]],
1487 "create a directory and parents",
1489 Create a directory named C<path>, creating any parent directories
1490 as necessary. This is like the C<mkdir -p> shell command.");
1492 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1493 [], (* XXX Need stat command to test *)
1496 Change the mode (permissions) of C<path> to C<mode>. Only
1497 numeric modes are supported.
1499 I<Note>: When using this command from guestfish, C<mode>
1500 by default would be decimal, unless you prefix it with
1501 C<0> to get octal, ie. use C<0700> not C<700>.
1503 The mode actually set is affected by the umask.");
1505 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1506 [], (* XXX Need stat command to test *)
1507 "change file owner and group",
1509 Change the file owner to C<owner> and group to C<group>.
1511 Only numeric uid and gid are supported. If you want to use
1512 names, you will need to locate and parse the password file
1513 yourself (Augeas support makes this relatively easy).");
1515 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1516 [InitISOFS, Always, TestOutputTrue (
1517 [["exists"; "/empty"]]);
1518 InitISOFS, Always, TestOutputTrue (
1519 [["exists"; "/directory"]])],
1520 "test if file or directory exists",
1522 This returns C<true> if and only if there is a file, directory
1523 (or anything) with the given C<path> name.
1525 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1527 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1528 [InitISOFS, Always, TestOutputTrue (
1529 [["is_file"; "/known-1"]]);
1530 InitISOFS, Always, TestOutputFalse (
1531 [["is_file"; "/directory"]])],
1532 "test if a regular file",
1534 This returns C<true> if and only if there is a regular file
1535 with the given C<path> name. Note that it returns false for
1536 other objects like directories.
1538 See also C<guestfs_stat>.");
1540 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1541 [InitISOFS, Always, TestOutputFalse (
1542 [["is_dir"; "/known-3"]]);
1543 InitISOFS, Always, TestOutputTrue (
1544 [["is_dir"; "/directory"]])],
1545 "test if a directory",
1547 This returns C<true> if and only if there is a directory
1548 with the given C<path> name. Note that it returns false for
1549 other objects like files.
1551 See also C<guestfs_stat>.");
1553 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1554 [InitEmpty, Always, TestOutputListOfDevices (
1555 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1556 ["pvcreate"; "/dev/sda1"];
1557 ["pvcreate"; "/dev/sda2"];
1558 ["pvcreate"; "/dev/sda3"];
1559 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1560 "create an LVM physical volume",
1562 This creates an LVM physical volume on the named C<device>,
1563 where C<device> should usually be a partition name such
1566 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1567 [InitEmpty, Always, TestOutputList (
1568 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1569 ["pvcreate"; "/dev/sda1"];
1570 ["pvcreate"; "/dev/sda2"];
1571 ["pvcreate"; "/dev/sda3"];
1572 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1573 ["vgcreate"; "VG2"; "/dev/sda3"];
1574 ["vgs"]], ["VG1"; "VG2"])],
1575 "create an LVM volume group",
1577 This creates an LVM volume group called C<volgroup>
1578 from the non-empty list of physical volumes C<physvols>.");
1580 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1581 [InitEmpty, Always, TestOutputList (
1582 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1583 ["pvcreate"; "/dev/sda1"];
1584 ["pvcreate"; "/dev/sda2"];
1585 ["pvcreate"; "/dev/sda3"];
1586 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1587 ["vgcreate"; "VG2"; "/dev/sda3"];
1588 ["lvcreate"; "LV1"; "VG1"; "50"];
1589 ["lvcreate"; "LV2"; "VG1"; "50"];
1590 ["lvcreate"; "LV3"; "VG2"; "50"];
1591 ["lvcreate"; "LV4"; "VG2"; "50"];
1592 ["lvcreate"; "LV5"; "VG2"; "50"];
1594 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1595 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1596 "create an LVM logical volume",
1598 This creates an LVM logical volume called C<logvol>
1599 on the volume group C<volgroup>, with C<size> megabytes.");
1601 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1602 [InitEmpty, Always, TestOutput (
1603 [["part_disk"; "/dev/sda"; "mbr"];
1604 ["mkfs"; "ext2"; "/dev/sda1"];
1605 ["mount_options"; ""; "/dev/sda1"; "/"];
1606 ["write"; "/new"; "new file contents"];
1607 ["cat"; "/new"]], "new file contents")],
1608 "make a filesystem",
1610 This creates a filesystem on C<device> (usually a partition
1611 or LVM logical volume). The filesystem type is C<fstype>, for
1614 ("sfdisk", (RErr, [Device "device";
1615 Int "cyls"; Int "heads"; Int "sectors";
1616 StringList "lines"], []), 43, [DangerWillRobinson],
1618 "create partitions on a block device",
1620 This is a direct interface to the L<sfdisk(8)> program for creating
1621 partitions on block devices.
1623 C<device> should be a block device, for example C</dev/sda>.
1625 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1626 and sectors on the device, which are passed directly to sfdisk as
1627 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1628 of these, then the corresponding parameter is omitted. Usually for
1629 'large' disks, you can just pass C<0> for these, but for small
1630 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1631 out the right geometry and you will need to tell it.
1633 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1634 information refer to the L<sfdisk(8)> manpage.
1636 To create a single partition occupying the whole disk, you would
1637 pass C<lines> as a single element list, when the single element being
1638 the string C<,> (comma).
1640 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1641 C<guestfs_part_init>");
1643 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1644 (* Regression test for RHBZ#597135. *)
1645 [InitBasicFS, Always, TestLastFail
1646 [["write_file"; "/new"; "abc"; "10000"]]],
1649 This call creates a file called C<path>. The contents of the
1650 file is the string C<content> (which can contain any 8 bit data),
1651 with length C<size>.
1653 As a special case, if C<size> is C<0>
1654 then the length is calculated using C<strlen> (so in this case
1655 the content cannot contain embedded ASCII NULs).
1657 I<NB.> Owing to a bug, writing content containing ASCII NUL
1658 characters does I<not> work, even if the length is specified.");
1660 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1661 [InitEmpty, Always, TestOutputListOfDevices (
1662 [["part_disk"; "/dev/sda"; "mbr"];
1663 ["mkfs"; "ext2"; "/dev/sda1"];
1664 ["mount_options"; ""; "/dev/sda1"; "/"];
1665 ["mounts"]], ["/dev/sda1"]);
1666 InitEmpty, Always, TestOutputList (
1667 [["part_disk"; "/dev/sda"; "mbr"];
1668 ["mkfs"; "ext2"; "/dev/sda1"];
1669 ["mount_options"; ""; "/dev/sda1"; "/"];
1672 "unmount a filesystem",
1674 This unmounts the given filesystem. The filesystem may be
1675 specified either by its mountpoint (path) or the device which
1676 contains the filesystem.");
1678 ("mounts", (RStringList "devices", [], []), 46, [],
1679 [InitBasicFS, Always, TestOutputListOfDevices (
1680 [["mounts"]], ["/dev/sda1"])],
1681 "show mounted filesystems",
1683 This returns the list of currently mounted filesystems. It returns
1684 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1686 Some internal mounts are not shown.
1688 See also: C<guestfs_mountpoints>");
1690 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1691 [InitBasicFS, Always, TestOutputList (
1694 (* check that umount_all can unmount nested mounts correctly: *)
1695 InitEmpty, Always, TestOutputList (
1696 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1697 ["mkfs"; "ext2"; "/dev/sda1"];
1698 ["mkfs"; "ext2"; "/dev/sda2"];
1699 ["mkfs"; "ext2"; "/dev/sda3"];
1700 ["mount_options"; ""; "/dev/sda1"; "/"];
1702 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1703 ["mkdir"; "/mp1/mp2"];
1704 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1705 ["mkdir"; "/mp1/mp2/mp3"];
1708 "unmount all filesystems",
1710 This unmounts all mounted filesystems.
1712 Some internal mounts are not unmounted by this call.");
1714 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1716 "remove all LVM LVs, VGs and PVs",
1718 This command removes all LVM logical volumes, volume groups
1719 and physical volumes.");
1721 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
1722 [InitISOFS, Always, TestOutput (
1723 [["file"; "/empty"]], "empty");
1724 InitISOFS, Always, TestOutput (
1725 [["file"; "/known-1"]], "ASCII text");
1726 InitISOFS, Always, TestLastFail (
1727 [["file"; "/notexists"]]);
1728 InitISOFS, Always, TestOutput (
1729 [["file"; "/abssymlink"]], "symbolic link");
1730 InitISOFS, Always, TestOutput (
1731 [["file"; "/directory"]], "directory")],
1732 "determine file type",
1734 This call uses the standard L<file(1)> command to determine
1735 the type or contents of the file.
1737 This call will also transparently look inside various types
1740 The exact command which runs is C<file -zb path>. Note in
1741 particular that the filename is not prepended to the output
1744 This command can also be used on C</dev/> devices
1745 (and partitions, LV names). You can for example use this
1746 to determine if a device contains a filesystem, although
1747 it's usually better to use C<guestfs_vfs_type>.
1749 If the C<path> does not begin with C</dev/> then
1750 this command only works for the content of regular files.
1751 For other file types (directory, symbolic link etc) it
1752 will just return the string C<directory> etc.");
1754 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
1755 [InitBasicFS, Always, TestOutput (
1756 [["upload"; "test-command"; "/test-command"];
1757 ["chmod"; "0o755"; "/test-command"];
1758 ["command"; "/test-command 1"]], "Result1");
1759 InitBasicFS, Always, TestOutput (
1760 [["upload"; "test-command"; "/test-command"];
1761 ["chmod"; "0o755"; "/test-command"];
1762 ["command"; "/test-command 2"]], "Result2\n");
1763 InitBasicFS, Always, TestOutput (
1764 [["upload"; "test-command"; "/test-command"];
1765 ["chmod"; "0o755"; "/test-command"];
1766 ["command"; "/test-command 3"]], "\nResult3");
1767 InitBasicFS, Always, TestOutput (
1768 [["upload"; "test-command"; "/test-command"];
1769 ["chmod"; "0o755"; "/test-command"];
1770 ["command"; "/test-command 4"]], "\nResult4\n");
1771 InitBasicFS, Always, TestOutput (
1772 [["upload"; "test-command"; "/test-command"];
1773 ["chmod"; "0o755"; "/test-command"];
1774 ["command"; "/test-command 5"]], "\nResult5\n\n");
1775 InitBasicFS, Always, TestOutput (
1776 [["upload"; "test-command"; "/test-command"];
1777 ["chmod"; "0o755"; "/test-command"];
1778 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1779 InitBasicFS, Always, TestOutput (
1780 [["upload"; "test-command"; "/test-command"];
1781 ["chmod"; "0o755"; "/test-command"];
1782 ["command"; "/test-command 7"]], "");
1783 InitBasicFS, Always, TestOutput (
1784 [["upload"; "test-command"; "/test-command"];
1785 ["chmod"; "0o755"; "/test-command"];
1786 ["command"; "/test-command 8"]], "\n");
1787 InitBasicFS, Always, TestOutput (
1788 [["upload"; "test-command"; "/test-command"];
1789 ["chmod"; "0o755"; "/test-command"];
1790 ["command"; "/test-command 9"]], "\n\n");
1791 InitBasicFS, Always, TestOutput (
1792 [["upload"; "test-command"; "/test-command"];
1793 ["chmod"; "0o755"; "/test-command"];
1794 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1795 InitBasicFS, Always, TestOutput (
1796 [["upload"; "test-command"; "/test-command"];
1797 ["chmod"; "0o755"; "/test-command"];
1798 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1799 InitBasicFS, Always, TestLastFail (
1800 [["upload"; "test-command"; "/test-command"];
1801 ["chmod"; "0o755"; "/test-command"];
1802 ["command"; "/test-command"]])],
1803 "run a command from the guest filesystem",
1805 This call runs a command from the guest filesystem. The
1806 filesystem must be mounted, and must contain a compatible
1807 operating system (ie. something Linux, with the same
1808 or compatible processor architecture).
1810 The single parameter is an argv-style list of arguments.
1811 The first element is the name of the program to run.
1812 Subsequent elements are parameters. The list must be
1813 non-empty (ie. must contain a program name). Note that
1814 the command runs directly, and is I<not> invoked via
1815 the shell (see C<guestfs_sh>).
1817 The return value is anything printed to I<stdout> by
1820 If the command returns a non-zero exit status, then
1821 this function returns an error message. The error message
1822 string is the content of I<stderr> from the command.
1824 The C<$PATH> environment variable will contain at least
1825 C</usr/bin> and C</bin>. If you require a program from
1826 another location, you should provide the full path in the
1829 Shared libraries and data files required by the program
1830 must be available on filesystems which are mounted in the
1831 correct places. It is the caller's responsibility to ensure
1832 all filesystems that are needed are mounted at the right
1835 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
1836 [InitBasicFS, Always, TestOutputList (
1837 [["upload"; "test-command"; "/test-command"];
1838 ["chmod"; "0o755"; "/test-command"];
1839 ["command_lines"; "/test-command 1"]], ["Result1"]);
1840 InitBasicFS, Always, TestOutputList (
1841 [["upload"; "test-command"; "/test-command"];
1842 ["chmod"; "0o755"; "/test-command"];
1843 ["command_lines"; "/test-command 2"]], ["Result2"]);
1844 InitBasicFS, Always, TestOutputList (
1845 [["upload"; "test-command"; "/test-command"];
1846 ["chmod"; "0o755"; "/test-command"];
1847 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1848 InitBasicFS, Always, TestOutputList (
1849 [["upload"; "test-command"; "/test-command"];
1850 ["chmod"; "0o755"; "/test-command"];
1851 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1852 InitBasicFS, Always, TestOutputList (
1853 [["upload"; "test-command"; "/test-command"];
1854 ["chmod"; "0o755"; "/test-command"];
1855 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1856 InitBasicFS, Always, TestOutputList (
1857 [["upload"; "test-command"; "/test-command"];
1858 ["chmod"; "0o755"; "/test-command"];
1859 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1860 InitBasicFS, Always, TestOutputList (
1861 [["upload"; "test-command"; "/test-command"];
1862 ["chmod"; "0o755"; "/test-command"];
1863 ["command_lines"; "/test-command 7"]], []);
1864 InitBasicFS, Always, TestOutputList (
1865 [["upload"; "test-command"; "/test-command"];
1866 ["chmod"; "0o755"; "/test-command"];
1867 ["command_lines"; "/test-command 8"]], [""]);
1868 InitBasicFS, Always, TestOutputList (
1869 [["upload"; "test-command"; "/test-command"];
1870 ["chmod"; "0o755"; "/test-command"];
1871 ["command_lines"; "/test-command 9"]], ["";""]);
1872 InitBasicFS, Always, TestOutputList (
1873 [["upload"; "test-command"; "/test-command"];
1874 ["chmod"; "0o755"; "/test-command"];
1875 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1876 InitBasicFS, Always, TestOutputList (
1877 [["upload"; "test-command"; "/test-command"];
1878 ["chmod"; "0o755"; "/test-command"];
1879 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1880 "run a command, returning lines",
1882 This is the same as C<guestfs_command>, but splits the
1883 result into a list of lines.
1885 See also: C<guestfs_sh_lines>");
1887 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
1888 [InitISOFS, Always, TestOutputStruct (
1889 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1890 "get file information",
1892 Returns file information for the given C<path>.
1894 This is the same as the C<stat(2)> system call.");
1896 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
1897 [InitISOFS, Always, TestOutputStruct (
1898 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1899 "get file information for a symbolic link",
1901 Returns file information for the given C<path>.
1903 This is the same as C<guestfs_stat> except that if C<path>
1904 is a symbolic link, then the link is stat-ed, not the file it
1907 This is the same as the C<lstat(2)> system call.");
1909 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
1910 [InitISOFS, Always, TestOutputStruct (
1911 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1912 "get file system statistics",
1914 Returns file system statistics for any mounted file system.
1915 C<path> should be a file or directory in the mounted file system
1916 (typically it is the mount point itself, but it doesn't need to be).
1918 This is the same as the C<statvfs(2)> system call.");
1920 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
1922 "get ext2/ext3/ext4 superblock details",
1924 This returns the contents of the ext2, ext3 or ext4 filesystem
1925 superblock on C<device>.
1927 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1928 manpage for more details. The list of fields returned isn't
1929 clearly defined, and depends on both the version of C<tune2fs>
1930 that libguestfs was built against, and the filesystem itself.");
1932 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
1933 [InitEmpty, Always, TestOutputTrue (
1934 [["blockdev_setro"; "/dev/sda"];
1935 ["blockdev_getro"; "/dev/sda"]])],
1936 "set block device to read-only",
1938 Sets the block device named C<device> to read-only.
1940 This uses the L<blockdev(8)> command.");
1942 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
1943 [InitEmpty, Always, TestOutputFalse (
1944 [["blockdev_setrw"; "/dev/sda"];
1945 ["blockdev_getro"; "/dev/sda"]])],
1946 "set block device to read-write",
1948 Sets the block device named C<device> to read-write.
1950 This uses the L<blockdev(8)> command.");
1952 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
1953 [InitEmpty, Always, TestOutputTrue (
1954 [["blockdev_setro"; "/dev/sda"];
1955 ["blockdev_getro"; "/dev/sda"]])],
1956 "is block device set to read-only",
1958 Returns a boolean indicating if the block device is read-only
1959 (true if read-only, false if not).
1961 This uses the L<blockdev(8)> command.");
1963 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
1964 [InitEmpty, Always, TestOutputInt (
1965 [["blockdev_getss"; "/dev/sda"]], 512)],
1966 "get sectorsize of block device",
1968 This returns the size of sectors on a block device.
1969 Usually 512, but can be larger for modern devices.
1971 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1974 This uses the L<blockdev(8)> command.");
1976 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
1977 [InitEmpty, Always, TestOutputInt (
1978 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1979 "get blocksize of block device",
1981 This returns the block size of a device.
1983 (Note this is different from both I<size in blocks> and
1984 I<filesystem block size>).
1986 This uses the L<blockdev(8)> command.");
1988 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
1990 "set blocksize of block device",
1992 This sets the block size of a device.
1994 (Note this is different from both I<size in blocks> and
1995 I<filesystem block size>).
1997 This uses the L<blockdev(8)> command.");
1999 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2000 [InitEmpty, Always, TestOutputInt (
2001 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2002 "get total size of device in 512-byte sectors",
2004 This returns the size of the device in units of 512-byte sectors
2005 (even if the sectorsize isn't 512 bytes ... weird).
2007 See also C<guestfs_blockdev_getss> for the real sector size of
2008 the device, and C<guestfs_blockdev_getsize64> for the more
2009 useful I<size in bytes>.
2011 This uses the L<blockdev(8)> command.");
2013 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2014 [InitEmpty, Always, TestOutputInt (
2015 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2016 "get total size of device in bytes",
2018 This returns the size of the device in bytes.
2020 See also C<guestfs_blockdev_getsz>.
2022 This uses the L<blockdev(8)> command.");
2024 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2025 [InitEmpty, Always, TestRun
2026 [["blockdev_flushbufs"; "/dev/sda"]]],
2027 "flush device buffers",
2029 This tells the kernel to flush internal buffers associated
2032 This uses the L<blockdev(8)> command.");
2034 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2035 [InitEmpty, Always, TestRun
2036 [["blockdev_rereadpt"; "/dev/sda"]]],
2037 "reread partition table",
2039 Reread the partition table on C<device>.
2041 This uses the L<blockdev(8)> command.");
2043 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2044 [InitBasicFS, Always, TestOutput (
2045 (* Pick a file from cwd which isn't likely to change. *)
2046 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2047 ["checksum"; "md5"; "/COPYING.LIB"]],
2048 Digest.to_hex (Digest.file "COPYING.LIB"))],
2049 "upload a file from the local machine",
2051 Upload local file C<filename> to C<remotefilename> on the
2054 C<filename> can also be a named pipe.
2056 See also C<guestfs_download>.");
2058 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2059 [InitBasicFS, Always, TestOutput (
2060 (* Pick a file from cwd which isn't likely to change. *)
2061 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2062 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2063 ["upload"; "testdownload.tmp"; "/upload"];
2064 ["checksum"; "md5"; "/upload"]],
2065 Digest.to_hex (Digest.file "COPYING.LIB"))],
2066 "download a file to the local machine",
2068 Download file C<remotefilename> and save it as C<filename>
2069 on the local machine.
2071 C<filename> can also be a named pipe.
2073 See also C<guestfs_upload>, C<guestfs_cat>.");
2075 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2076 [InitISOFS, Always, TestOutput (
2077 [["checksum"; "crc"; "/known-3"]], "2891671662");
2078 InitISOFS, Always, TestLastFail (
2079 [["checksum"; "crc"; "/notexists"]]);
2080 InitISOFS, Always, TestOutput (
2081 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2082 InitISOFS, Always, TestOutput (
2083 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2084 InitISOFS, Always, TestOutput (
2085 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2086 InitISOFS, Always, TestOutput (
2087 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2088 InitISOFS, Always, TestOutput (
2089 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2090 InitISOFS, Always, TestOutput (
2091 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2092 (* Test for RHBZ#579608, absolute symbolic links. *)
2093 InitISOFS, Always, TestOutput (
2094 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2095 "compute MD5, SHAx or CRC checksum of file",
2097 This call computes the MD5, SHAx or CRC checksum of the
2100 The type of checksum to compute is given by the C<csumtype>
2101 parameter which must have one of the following values:
2107 Compute the cyclic redundancy check (CRC) specified by POSIX
2108 for the C<cksum> command.
2112 Compute the MD5 hash (using the C<md5sum> program).
2116 Compute the SHA1 hash (using the C<sha1sum> program).
2120 Compute the SHA224 hash (using the C<sha224sum> program).
2124 Compute the SHA256 hash (using the C<sha256sum> program).
2128 Compute the SHA384 hash (using the C<sha384sum> program).
2132 Compute the SHA512 hash (using the C<sha512sum> program).
2136 The checksum is returned as a printable string.
2138 To get the checksum for a device, use C<guestfs_checksum_device>.
2140 To get the checksums for many files, use C<guestfs_checksums_out>.");
2142 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2143 [InitBasicFS, Always, TestOutput (
2144 [["tar_in"; "../images/helloworld.tar"; "/"];
2145 ["cat"; "/hello"]], "hello\n")],
2146 "unpack tarfile to directory",
2148 This command uploads and unpacks local file C<tarfile> (an
2149 I<uncompressed> tar file) into C<directory>.
2151 To upload a compressed tarball, use C<guestfs_tgz_in>
2152 or C<guestfs_txz_in>.");
2154 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2156 "pack directory into tarfile",
2158 This command packs the contents of C<directory> and downloads
2159 it to local file C<tarfile>.
2161 To download a compressed tarball, use C<guestfs_tgz_out>
2162 or C<guestfs_txz_out>.");
2164 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2165 [InitBasicFS, Always, TestOutput (
2166 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2167 ["cat"; "/hello"]], "hello\n")],
2168 "unpack compressed tarball to directory",
2170 This command uploads and unpacks local file C<tarball> (a
2171 I<gzip compressed> tar file) into C<directory>.
2173 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2175 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2177 "pack directory into compressed tarball",
2179 This command packs the contents of C<directory> and downloads
2180 it to local file C<tarball>.
2182 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2184 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2185 [InitBasicFS, Always, TestLastFail (
2187 ["mount_ro"; "/dev/sda1"; "/"];
2188 ["touch"; "/new"]]);
2189 InitBasicFS, Always, TestOutput (
2190 [["write"; "/new"; "data"];
2192 ["mount_ro"; "/dev/sda1"; "/"];
2193 ["cat"; "/new"]], "data")],
2194 "mount a guest disk, read-only",
2196 This is the same as the C<guestfs_mount> command, but it
2197 mounts the filesystem with the read-only (I<-o ro>) flag.");
2199 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2201 "mount a guest disk with mount options",
2203 This is the same as the C<guestfs_mount> command, but it
2204 allows you to set the mount options as for the
2205 L<mount(8)> I<-o> flag.
2207 If the C<options> parameter is an empty string, then
2208 no options are passed (all options default to whatever
2209 the filesystem uses).");
2211 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2213 "mount a guest disk with mount options and vfstype",
2215 This is the same as the C<guestfs_mount> command, but it
2216 allows you to set both the mount options and the vfstype
2217 as for the L<mount(8)> I<-o> and I<-t> flags.");
2219 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [],
2221 "debugging and internals",
2223 The C<guestfs_debug> command exposes some internals of
2224 C<guestfsd> (the guestfs daemon) that runs inside the
2227 There is no comprehensive help for this command. You have
2228 to look at the file C<daemon/debug.c> in the libguestfs source
2229 to find out what you can do.");
2231 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2232 [InitEmpty, Always, TestOutputList (
2233 [["part_disk"; "/dev/sda"; "mbr"];
2234 ["pvcreate"; "/dev/sda1"];
2235 ["vgcreate"; "VG"; "/dev/sda1"];
2236 ["lvcreate"; "LV1"; "VG"; "50"];
2237 ["lvcreate"; "LV2"; "VG"; "50"];
2238 ["lvremove"; "/dev/VG/LV1"];
2239 ["lvs"]], ["/dev/VG/LV2"]);
2240 InitEmpty, Always, TestOutputList (
2241 [["part_disk"; "/dev/sda"; "mbr"];
2242 ["pvcreate"; "/dev/sda1"];
2243 ["vgcreate"; "VG"; "/dev/sda1"];
2244 ["lvcreate"; "LV1"; "VG"; "50"];
2245 ["lvcreate"; "LV2"; "VG"; "50"];
2246 ["lvremove"; "/dev/VG"];
2248 InitEmpty, Always, TestOutputList (
2249 [["part_disk"; "/dev/sda"; "mbr"];
2250 ["pvcreate"; "/dev/sda1"];
2251 ["vgcreate"; "VG"; "/dev/sda1"];
2252 ["lvcreate"; "LV1"; "VG"; "50"];
2253 ["lvcreate"; "LV2"; "VG"; "50"];
2254 ["lvremove"; "/dev/VG"];
2256 "remove an LVM logical volume",
2258 Remove an LVM logical volume C<device>, where C<device> is
2259 the path to the LV, such as C</dev/VG/LV>.
2261 You can also remove all LVs in a volume group by specifying
2262 the VG name, C</dev/VG>.");
2264 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2265 [InitEmpty, Always, TestOutputList (
2266 [["part_disk"; "/dev/sda"; "mbr"];
2267 ["pvcreate"; "/dev/sda1"];
2268 ["vgcreate"; "VG"; "/dev/sda1"];
2269 ["lvcreate"; "LV1"; "VG"; "50"];
2270 ["lvcreate"; "LV2"; "VG"; "50"];
2273 InitEmpty, Always, TestOutputList (
2274 [["part_disk"; "/dev/sda"; "mbr"];
2275 ["pvcreate"; "/dev/sda1"];
2276 ["vgcreate"; "VG"; "/dev/sda1"];
2277 ["lvcreate"; "LV1"; "VG"; "50"];
2278 ["lvcreate"; "LV2"; "VG"; "50"];
2281 "remove an LVM volume group",
2283 Remove an LVM volume group C<vgname>, (for example C<VG>).
2285 This also forcibly removes all logical volumes in the volume
2288 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2289 [InitEmpty, Always, TestOutputListOfDevices (
2290 [["part_disk"; "/dev/sda"; "mbr"];
2291 ["pvcreate"; "/dev/sda1"];
2292 ["vgcreate"; "VG"; "/dev/sda1"];
2293 ["lvcreate"; "LV1"; "VG"; "50"];
2294 ["lvcreate"; "LV2"; "VG"; "50"];
2296 ["pvremove"; "/dev/sda1"];
2298 InitEmpty, Always, TestOutputListOfDevices (
2299 [["part_disk"; "/dev/sda"; "mbr"];
2300 ["pvcreate"; "/dev/sda1"];
2301 ["vgcreate"; "VG"; "/dev/sda1"];
2302 ["lvcreate"; "LV1"; "VG"; "50"];
2303 ["lvcreate"; "LV2"; "VG"; "50"];
2305 ["pvremove"; "/dev/sda1"];
2307 InitEmpty, Always, TestOutputListOfDevices (
2308 [["part_disk"; "/dev/sda"; "mbr"];
2309 ["pvcreate"; "/dev/sda1"];
2310 ["vgcreate"; "VG"; "/dev/sda1"];
2311 ["lvcreate"; "LV1"; "VG"; "50"];
2312 ["lvcreate"; "LV2"; "VG"; "50"];
2314 ["pvremove"; "/dev/sda1"];
2316 "remove an LVM physical volume",
2318 This wipes a physical volume C<device> so that LVM will no longer
2321 The implementation uses the C<pvremove> command which refuses to
2322 wipe physical volumes that contain any volume groups, so you have
2323 to remove those first.");
2325 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2326 [InitBasicFS, Always, TestOutput (
2327 [["set_e2label"; "/dev/sda1"; "testlabel"];
2328 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2329 "set the ext2/3/4 filesystem label",
2331 This sets the ext2/3/4 filesystem label of the filesystem on
2332 C<device> to C<label>. Filesystem labels are limited to
2335 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2336 to return the existing label on a filesystem.");
2338 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2340 "get the ext2/3/4 filesystem label",
2342 This returns the ext2/3/4 filesystem label of the filesystem on
2345 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2346 (let uuid = uuidgen () in
2347 [InitBasicFS, Always, TestOutput (
2348 [["set_e2uuid"; "/dev/sda1"; uuid];
2349 ["get_e2uuid"; "/dev/sda1"]], uuid);
2350 InitBasicFS, Always, TestOutput (
2351 [["set_e2uuid"; "/dev/sda1"; "clear"];
2352 ["get_e2uuid"; "/dev/sda1"]], "");
2353 (* We can't predict what UUIDs will be, so just check the commands run. *)
2354 InitBasicFS, Always, TestRun (
2355 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2356 InitBasicFS, Always, TestRun (
2357 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2358 "set the ext2/3/4 filesystem UUID",
2360 This sets the ext2/3/4 filesystem UUID of the filesystem on
2361 C<device> to C<uuid>. The format of the UUID and alternatives
2362 such as C<clear>, C<random> and C<time> are described in the
2363 L<tune2fs(8)> manpage.
2365 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2366 to return the existing UUID of a filesystem.");
2368 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2369 (* Regression test for RHBZ#597112. *)
2370 (let uuid = uuidgen () in
2371 [InitBasicFS, Always, TestOutput (
2372 [["mke2journal"; "1024"; "/dev/sdb"];
2373 ["set_e2uuid"; "/dev/sdb"; uuid];
2374 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2375 "get the ext2/3/4 filesystem UUID",
2377 This returns the ext2/3/4 filesystem UUID of the filesystem on
2380 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2381 [InitBasicFS, Always, TestOutputInt (
2382 [["umount"; "/dev/sda1"];
2383 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2384 InitBasicFS, Always, TestOutputInt (
2385 [["umount"; "/dev/sda1"];
2386 ["zero"; "/dev/sda1"];
2387 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2388 "run the filesystem checker",
2390 This runs the filesystem checker (fsck) on C<device> which
2391 should have filesystem type C<fstype>.
2393 The returned integer is the status. See L<fsck(8)> for the
2394 list of status codes from C<fsck>.
2402 Multiple status codes can be summed together.
2406 A non-zero return code can mean \"success\", for example if
2407 errors have been corrected on the filesystem.
2411 Checking or repairing NTFS volumes is not supported
2416 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2418 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2419 [InitBasicFS, Always, TestOutput (
2420 [["umount"; "/dev/sda1"];
2421 ["zero"; "/dev/sda1"];
2422 ["file"; "/dev/sda1"]], "data")],
2423 "write zeroes to the device",
2425 This command writes zeroes over the first few blocks of C<device>.
2427 How many blocks are zeroed isn't specified (but it's I<not> enough
2428 to securely wipe the device). It should be sufficient to remove
2429 any partition tables, filesystem superblocks and so on.
2431 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2433 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2435 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2436 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2438 [InitBasicFS, Always, TestOutputTrue (
2439 [["mkdir_p"; "/boot/grub"];
2440 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2441 ["grub_install"; "/"; "/dev/vda"];
2442 ["is_dir"; "/boot"]])],
2445 This command installs GRUB (the Grand Unified Bootloader) on
2446 C<device>, with the root directory being C<root>.
2448 Note: If grub-install reports the error
2449 \"No suitable drive was found in the generated device map.\"
2450 it may be that you need to create a C</boot/grub/device.map>
2451 file first that contains the mapping between grub device names
2452 and Linux device names. It is usually sufficient to create
2457 replacing C</dev/vda> with the name of the installation device.");
2459 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2460 [InitBasicFS, Always, TestOutput (
2461 [["write"; "/old"; "file content"];
2462 ["cp"; "/old"; "/new"];
2463 ["cat"; "/new"]], "file content");
2464 InitBasicFS, Always, TestOutputTrue (
2465 [["write"; "/old"; "file content"];
2466 ["cp"; "/old"; "/new"];
2467 ["is_file"; "/old"]]);
2468 InitBasicFS, Always, TestOutput (
2469 [["write"; "/old"; "file content"];
2471 ["cp"; "/old"; "/dir/new"];
2472 ["cat"; "/dir/new"]], "file content")],
2475 This copies a file from C<src> to C<dest> where C<dest> is
2476 either a destination filename or destination directory.");
2478 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2479 [InitBasicFS, Always, TestOutput (
2480 [["mkdir"; "/olddir"];
2481 ["mkdir"; "/newdir"];
2482 ["write"; "/olddir/file"; "file content"];
2483 ["cp_a"; "/olddir"; "/newdir"];
2484 ["cat"; "/newdir/olddir/file"]], "file content")],
2485 "copy a file or directory recursively",
2487 This copies a file or directory from C<src> to C<dest>
2488 recursively using the C<cp -a> command.");
2490 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2491 [InitBasicFS, Always, TestOutput (
2492 [["write"; "/old"; "file content"];
2493 ["mv"; "/old"; "/new"];
2494 ["cat"; "/new"]], "file content");
2495 InitBasicFS, Always, TestOutputFalse (
2496 [["write"; "/old"; "file content"];
2497 ["mv"; "/old"; "/new"];
2498 ["is_file"; "/old"]])],
2501 This moves a file from C<src> to C<dest> where C<dest> is
2502 either a destination filename or destination directory.");
2504 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2505 [InitEmpty, Always, TestRun (
2506 [["drop_caches"; "3"]])],
2507 "drop kernel page cache, dentries and inodes",
2509 This instructs the guest kernel to drop its page cache,
2510 and/or dentries and inode caches. The parameter C<whattodrop>
2511 tells the kernel what precisely to drop, see
2512 L<http://linux-mm.org/Drop_Caches>
2514 Setting C<whattodrop> to 3 should drop everything.
2516 This automatically calls L<sync(2)> before the operation,
2517 so that the maximum guest memory is freed.");
2519 ("dmesg", (RString "kmsgs", [], []), 91, [],
2520 [InitEmpty, Always, TestRun (
2522 "return kernel messages",
2524 This returns the kernel messages (C<dmesg> output) from
2525 the guest kernel. This is sometimes useful for extended
2526 debugging of problems.
2528 Another way to get the same information is to enable
2529 verbose messages with C<guestfs_set_verbose> or by setting
2530 the environment variable C<LIBGUESTFS_DEBUG=1> before
2531 running the program.");
2533 ("ping_daemon", (RErr, [], []), 92, [],
2534 [InitEmpty, Always, TestRun (
2535 [["ping_daemon"]])],
2536 "ping the guest daemon",
2538 This is a test probe into the guestfs daemon running inside
2539 the qemu subprocess. Calling this function checks that the
2540 daemon responds to the ping message, without affecting the daemon
2541 or attached block device(s) in any other way.");
2543 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2544 [InitBasicFS, Always, TestOutputTrue (
2545 [["write"; "/file1"; "contents of a file"];
2546 ["cp"; "/file1"; "/file2"];
2547 ["equal"; "/file1"; "/file2"]]);
2548 InitBasicFS, Always, TestOutputFalse (
2549 [["write"; "/file1"; "contents of a file"];
2550 ["write"; "/file2"; "contents of another file"];
2551 ["equal"; "/file1"; "/file2"]]);
2552 InitBasicFS, Always, TestLastFail (
2553 [["equal"; "/file1"; "/file2"]])],
2554 "test if two files have equal contents",
2556 This compares the two files C<file1> and C<file2> and returns
2557 true if their content is exactly equal, or false otherwise.
2559 The external L<cmp(1)> program is used for the comparison.");
2561 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2562 [InitISOFS, Always, TestOutputList (
2563 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2564 InitISOFS, Always, TestOutputList (
2565 [["strings"; "/empty"]], []);
2566 (* Test for RHBZ#579608, absolute symbolic links. *)
2567 InitISOFS, Always, TestRun (
2568 [["strings"; "/abssymlink"]])],
2569 "print the printable strings in a file",
2571 This runs the L<strings(1)> command on a file and returns
2572 the list of printable strings found.");
2574 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2575 [InitISOFS, Always, TestOutputList (
2576 [["strings_e"; "b"; "/known-5"]], []);
2577 InitBasicFS, Always, TestOutputList (
2578 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2579 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2580 "print the printable strings in a file",
2582 This is like the C<guestfs_strings> command, but allows you to
2583 specify the encoding of strings that are looked for in
2584 the source file C<path>.
2586 Allowed encodings are:
2592 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2593 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2597 Single 8-bit-byte characters.
2601 16-bit big endian strings such as those encoded in
2602 UTF-16BE or UCS-2BE.
2604 =item l (lower case letter L)
2606 16-bit little endian such as UTF-16LE and UCS-2LE.
2607 This is useful for examining binaries in Windows guests.
2611 32-bit big endian such as UCS-4BE.
2615 32-bit little endian such as UCS-4LE.
2619 The returned strings are transcoded to UTF-8.");
2621 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2622 [InitISOFS, Always, TestOutput (
2623 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2624 (* Test for RHBZ#501888c2 regression which caused large hexdump
2625 * commands to segfault.
2627 InitISOFS, Always, TestRun (
2628 [["hexdump"; "/100krandom"]]);
2629 (* Test for RHBZ#579608, absolute symbolic links. *)
2630 InitISOFS, Always, TestRun (
2631 [["hexdump"; "/abssymlink"]])],
2632 "dump a file in hexadecimal",
2634 This runs C<hexdump -C> on the given C<path>. The result is
2635 the human-readable, canonical hex dump of the file.");
2637 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2638 [InitNone, Always, TestOutput (
2639 [["part_disk"; "/dev/sda"; "mbr"];
2640 ["mkfs"; "ext3"; "/dev/sda1"];
2641 ["mount_options"; ""; "/dev/sda1"; "/"];
2642 ["write"; "/new"; "test file"];
2643 ["umount"; "/dev/sda1"];
2644 ["zerofree"; "/dev/sda1"];
2645 ["mount_options"; ""; "/dev/sda1"; "/"];
2646 ["cat"; "/new"]], "test file")],
2647 "zero unused inodes and disk blocks on ext2/3 filesystem",
2649 This runs the I<zerofree> program on C<device>. This program
2650 claims to zero unused inodes and disk blocks on an ext2/3
2651 filesystem, thus making it possible to compress the filesystem
2654 You should B<not> run this program if the filesystem is
2657 It is possible that using this program can damage the filesystem
2658 or data on the filesystem.");
2660 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2662 "resize an LVM physical volume",
2664 This resizes (expands or shrinks) an existing LVM physical
2665 volume to match the new size of the underlying device.");
2667 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2668 Int "cyls"; Int "heads"; Int "sectors";
2669 String "line"], []), 99, [DangerWillRobinson],
2671 "modify a single partition on a block device",
2673 This runs L<sfdisk(8)> option to modify just the single
2674 partition C<n> (note: C<n> counts from 1).
2676 For other parameters, see C<guestfs_sfdisk>. You should usually
2677 pass C<0> for the cyls/heads/sectors parameters.
2679 See also: C<guestfs_part_add>");
2681 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2683 "display the partition table",
2685 This displays the partition table on C<device>, in the
2686 human-readable output of the L<sfdisk(8)> command. It is
2687 not intended to be parsed.
2689 See also: C<guestfs_part_list>");
2691 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2693 "display the kernel geometry",
2695 This displays the kernel's idea of the geometry of C<device>.
2697 The result is in human-readable format, and not designed to
2700 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2702 "display the disk geometry from the partition table",
2704 This displays the disk geometry of C<device> read from the
2705 partition table. Especially in the case where the underlying
2706 block device has been resized, this can be different from the
2707 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2709 The result is in human-readable format, and not designed to
2712 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2714 "activate or deactivate all volume groups",
2716 This command activates or (if C<activate> is false) deactivates
2717 all logical volumes in all volume groups.
2718 If activated, then they are made known to the
2719 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2720 then those devices disappear.
2722 This command is the same as running C<vgchange -a y|n>");
2724 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
2726 "activate or deactivate some volume groups",
2728 This command activates or (if C<activate> is false) deactivates
2729 all logical volumes in the listed volume groups C<volgroups>.
2730 If activated, then they are made known to the
2731 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2732 then those devices disappear.
2734 This command is the same as running C<vgchange -a y|n volgroups...>
2736 Note that if C<volgroups> is an empty list then B<all> volume groups
2737 are activated or deactivated.");
2739 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
2740 [InitNone, Always, TestOutput (
2741 [["part_disk"; "/dev/sda"; "mbr"];
2742 ["pvcreate"; "/dev/sda1"];
2743 ["vgcreate"; "VG"; "/dev/sda1"];
2744 ["lvcreate"; "LV"; "VG"; "10"];
2745 ["mkfs"; "ext2"; "/dev/VG/LV"];
2746 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2747 ["write"; "/new"; "test content"];
2749 ["lvresize"; "/dev/VG/LV"; "20"];
2750 ["e2fsck_f"; "/dev/VG/LV"];
2751 ["resize2fs"; "/dev/VG/LV"];
2752 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2753 ["cat"; "/new"]], "test content");
2754 InitNone, Always, TestRun (
2755 (* Make an LV smaller to test RHBZ#587484. *)
2756 [["part_disk"; "/dev/sda"; "mbr"];
2757 ["pvcreate"; "/dev/sda1"];
2758 ["vgcreate"; "VG"; "/dev/sda1"];
2759 ["lvcreate"; "LV"; "VG"; "20"];
2760 ["lvresize"; "/dev/VG/LV"; "10"]])],
2761 "resize an LVM logical volume",
2763 This resizes (expands or shrinks) an existing LVM logical
2764 volume to C<mbytes>. When reducing, data in the reduced part
2767 ("resize2fs", (RErr, [Device "device"], []), 106, [],
2768 [], (* lvresize tests this *)
2769 "resize an ext2, ext3 or ext4 filesystem",
2771 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2772 the underlying device.
2774 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2775 on the C<device> before calling this command. For unknown reasons
2776 C<resize2fs> sometimes gives an error about this and sometimes not.
2777 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2778 calling this function.");
2780 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
2781 [InitBasicFS, Always, TestOutputList (
2782 [["find"; "/"]], ["lost+found"]);
2783 InitBasicFS, Always, TestOutputList (
2787 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2788 InitBasicFS, Always, TestOutputList (
2789 [["mkdir_p"; "/a/b/c"];
2790 ["touch"; "/a/b/c/d"];
2791 ["find"; "/a/b/"]], ["c"; "c/d"])],
2792 "find all files and directories",
2794 This command lists out all files and directories, recursively,
2795 starting at C<directory>. It is essentially equivalent to
2796 running the shell command C<find directory -print> but some
2797 post-processing happens on the output, described below.
2799 This returns a list of strings I<without any prefix>. Thus
2800 if the directory structure was:
2806 then the returned list from C<guestfs_find> C</tmp> would be
2814 If C<directory> is not a directory, then this command returns
2817 The returned list is sorted.
2819 See also C<guestfs_find0>.");
2821 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
2822 [], (* lvresize tests this *)
2823 "check an ext2/ext3 filesystem",
2825 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2826 filesystem checker on C<device>, noninteractively (C<-p>),
2827 even if the filesystem appears to be clean (C<-f>).
2829 This command is only needed because of C<guestfs_resize2fs>
2830 (q.v.). Normally you should use C<guestfs_fsck>.");
2832 ("sleep", (RErr, [Int "secs"], []), 109, [],
2833 [InitNone, Always, TestRun (
2835 "sleep for some seconds",
2837 Sleep for C<secs> seconds.");
2839 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
2840 [InitNone, Always, TestOutputInt (
2841 [["part_disk"; "/dev/sda"; "mbr"];
2842 ["mkfs"; "ntfs"; "/dev/sda1"];
2843 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2844 InitNone, Always, TestOutputInt (
2845 [["part_disk"; "/dev/sda"; "mbr"];
2846 ["mkfs"; "ext2"; "/dev/sda1"];
2847 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2848 "probe NTFS volume",
2850 This command runs the L<ntfs-3g.probe(8)> command which probes
2851 an NTFS C<device> for mountability. (Not all NTFS volumes can
2852 be mounted read-write, and some cannot be mounted at all).
2854 C<rw> is a boolean flag. Set it to true if you want to test
2855 if the volume can be mounted read-write. Set it to false if
2856 you want to test if the volume can be mounted read-only.
2858 The return value is an integer which C<0> if the operation
2859 would succeed, or some non-zero value documented in the
2860 L<ntfs-3g.probe(8)> manual page.");
2862 ("sh", (RString "output", [String "command"], []), 111, [],
2863 [], (* XXX needs tests *)
2864 "run a command via the shell",
2866 This call runs a command from the guest filesystem via the
2869 This is like C<guestfs_command>, but passes the command to:
2871 /bin/sh -c \"command\"
2873 Depending on the guest's shell, this usually results in
2874 wildcards being expanded, shell expressions being interpolated
2877 All the provisos about C<guestfs_command> apply to this call.");
2879 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
2880 [], (* XXX needs tests *)
2881 "run a command via the shell returning lines",
2883 This is the same as C<guestfs_sh>, but splits the result
2884 into a list of lines.
2886 See also: C<guestfs_command_lines>");
2888 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
2889 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2890 * code in stubs.c, since all valid glob patterns must start with "/".
2891 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2893 [InitBasicFS, Always, TestOutputList (
2894 [["mkdir_p"; "/a/b/c"];
2895 ["touch"; "/a/b/c/d"];
2896 ["touch"; "/a/b/c/e"];
2897 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2898 InitBasicFS, Always, TestOutputList (
2899 [["mkdir_p"; "/a/b/c"];
2900 ["touch"; "/a/b/c/d"];
2901 ["touch"; "/a/b/c/e"];
2902 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2903 InitBasicFS, Always, TestOutputList (
2904 [["mkdir_p"; "/a/b/c"];
2905 ["touch"; "/a/b/c/d"];
2906 ["touch"; "/a/b/c/e"];
2907 ["glob_expand"; "/a/*/x/*"]], [])],
2908 "expand a wildcard path",
2910 This command searches for all the pathnames matching
2911 C<pattern> according to the wildcard expansion rules
2914 If no paths match, then this returns an empty list
2915 (note: not an error).
2917 It is just a wrapper around the C L<glob(3)> function
2918 with flags C<GLOB_MARK|GLOB_BRACE>.
2919 See that manual page for more details.");
2921 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
2922 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2923 [["scrub_device"; "/dev/sdc"]])],
2924 "scrub (securely wipe) a device",
2926 This command writes patterns over C<device> to make data retrieval
2929 It is an interface to the L<scrub(1)> program. See that
2930 manual page for more details.");
2932 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
2933 [InitBasicFS, Always, TestRun (
2934 [["write"; "/file"; "content"];
2935 ["scrub_file"; "/file"]])],
2936 "scrub (securely wipe) a file",
2938 This command writes patterns over a file to make data retrieval
2941 The file is I<removed> after scrubbing.
2943 It is an interface to the L<scrub(1)> program. See that
2944 manual page for more details.");
2946 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
2947 [], (* XXX needs testing *)
2948 "scrub (securely wipe) free space",
2950 This command creates the directory C<dir> and then fills it
2951 with files until the filesystem is full, and scrubs the files
2952 as for C<guestfs_scrub_file>, and deletes them.
2953 The intention is to scrub any free space on the partition
2956 It is an interface to the L<scrub(1)> program. See that
2957 manual page for more details.");
2959 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
2960 [InitBasicFS, Always, TestRun (
2962 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2963 "create a temporary directory",
2965 This command creates a temporary directory. The
2966 C<template> parameter should be a full pathname for the
2967 temporary directory name with the final six characters being
2970 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2971 the second one being suitable for Windows filesystems.
2973 The name of the temporary directory that was created
2976 The temporary directory is created with mode 0700
2977 and is owned by root.
2979 The caller is responsible for deleting the temporary
2980 directory and its contents after use.
2982 See also: L<mkdtemp(3)>");
2984 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
2985 [InitISOFS, Always, TestOutputInt (
2986 [["wc_l"; "/10klines"]], 10000);
2987 (* Test for RHBZ#579608, absolute symbolic links. *)
2988 InitISOFS, Always, TestOutputInt (
2989 [["wc_l"; "/abssymlink"]], 10000)],
2990 "count lines in a file",
2992 This command counts the lines in a file, using the
2993 C<wc -l> external command.");
2995 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
2996 [InitISOFS, Always, TestOutputInt (
2997 [["wc_w"; "/10klines"]], 10000)],
2998 "count words in a file",
3000 This command counts the words in a file, using the
3001 C<wc -w> external command.");
3003 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3004 [InitISOFS, Always, TestOutputInt (
3005 [["wc_c"; "/100kallspaces"]], 102400)],
3006 "count characters in a file",
3008 This command counts the characters in a file, using the
3009 C<wc -c> external command.");
3011 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3012 [InitISOFS, Always, TestOutputList (
3013 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3014 (* Test for RHBZ#579608, absolute symbolic links. *)
3015 InitISOFS, Always, TestOutputList (
3016 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3017 "return first 10 lines of a file",
3019 This command returns up to the first 10 lines of a file as
3020 a list of strings.");
3022 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3023 [InitISOFS, Always, TestOutputList (
3024 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3025 InitISOFS, Always, TestOutputList (
3026 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3027 InitISOFS, Always, TestOutputList (
3028 [["head_n"; "0"; "/10klines"]], [])],
3029 "return first N lines of a file",
3031 If the parameter C<nrlines> is a positive number, this returns the first
3032 C<nrlines> lines of the file C<path>.
3034 If the parameter C<nrlines> is a negative number, this returns lines
3035 from the file C<path>, excluding the last C<nrlines> lines.
3037 If the parameter C<nrlines> is zero, this returns an empty list.");
3039 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3040 [InitISOFS, Always, TestOutputList (
3041 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3042 "return last 10 lines of a file",
3044 This command returns up to the last 10 lines of a file as
3045 a list of strings.");
3047 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3048 [InitISOFS, Always, TestOutputList (
3049 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3050 InitISOFS, Always, TestOutputList (
3051 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3052 InitISOFS, Always, TestOutputList (
3053 [["tail_n"; "0"; "/10klines"]], [])],
3054 "return last N lines of a file",
3056 If the parameter C<nrlines> is a positive number, this returns the last
3057 C<nrlines> lines of the file C<path>.
3059 If the parameter C<nrlines> is a negative number, this returns lines
3060 from the file C<path>, starting with the C<-nrlines>th line.
3062 If the parameter C<nrlines> is zero, this returns an empty list.");
3064 ("df", (RString "output", [], []), 125, [],
3065 [], (* XXX Tricky to test because it depends on the exact format
3066 * of the 'df' command and other imponderables.
3068 "report file system disk space usage",
3070 This command runs the C<df> command to report disk space used.
3072 This command is mostly useful for interactive sessions. It
3073 is I<not> intended that you try to parse the output string.
3074 Use C<statvfs> from programs.");
3076 ("df_h", (RString "output", [], []), 126, [],
3077 [], (* XXX Tricky to test because it depends on the exact format
3078 * of the 'df' command and other imponderables.
3080 "report file system disk space usage (human readable)",
3082 This command runs the C<df -h> command to report disk space used
3083 in human-readable format.
3085 This command is mostly useful for interactive sessions. It
3086 is I<not> intended that you try to parse the output string.
3087 Use C<statvfs> from programs.");
3089 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3090 [InitISOFS, Always, TestOutputInt (
3091 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3092 "estimate file space usage",
3094 This command runs the C<du -s> command to estimate file space
3097 C<path> can be a file or a directory. If C<path> is a directory
3098 then the estimate includes the contents of the directory and all
3099 subdirectories (recursively).
3101 The result is the estimated size in I<kilobytes>
3102 (ie. units of 1024 bytes).");
3104 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3105 [InitISOFS, Always, TestOutputList (
3106 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3107 "list files in an initrd",
3109 This command lists out files contained in an initrd.
3111 The files are listed without any initial C</> character. The
3112 files are listed in the order they appear (not necessarily
3113 alphabetical). Directory names are listed as separate items.
3115 Old Linux kernels (2.4 and earlier) used a compressed ext2
3116 filesystem as initrd. We I<only> support the newer initramfs
3117 format (compressed cpio files).");
3119 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3121 "mount a file using the loop device",
3123 This command lets you mount C<file> (a filesystem image
3124 in a file) on a mount point. It is entirely equivalent to
3125 the command C<mount -o loop file mountpoint>.");
3127 ("mkswap", (RErr, [Device "device"], []), 130, [],
3128 [InitEmpty, Always, TestRun (
3129 [["part_disk"; "/dev/sda"; "mbr"];
3130 ["mkswap"; "/dev/sda1"]])],
3131 "create a swap partition",
3133 Create a swap partition on C<device>.");
3135 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3136 [InitEmpty, Always, TestRun (
3137 [["part_disk"; "/dev/sda"; "mbr"];
3138 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3139 "create a swap partition with a label",
3141 Create a swap partition on C<device> with label C<label>.
3143 Note that you cannot attach a swap label to a block device
3144 (eg. C</dev/sda>), just to a partition. This appears to be
3145 a limitation of the kernel or swap tools.");
3147 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3148 (let uuid = uuidgen () in
3149 [InitEmpty, Always, TestRun (
3150 [["part_disk"; "/dev/sda"; "mbr"];
3151 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3152 "create a swap partition with an explicit UUID",
3154 Create a swap partition on C<device> with UUID C<uuid>.");
3156 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3157 [InitBasicFS, Always, TestOutputStruct (
3158 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3159 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3160 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3161 InitBasicFS, Always, TestOutputStruct (
3162 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3163 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3164 "make block, character or FIFO devices",
3166 This call creates block or character special devices, or
3167 named pipes (FIFOs).
3169 The C<mode> parameter should be the mode, using the standard
3170 constants. C<devmajor> and C<devminor> are the
3171 device major and minor numbers, only used when creating block
3172 and character special devices.
3174 Note that, just like L<mknod(2)>, the mode must be bitwise
3175 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3176 just creates a regular file). These constants are
3177 available in the standard Linux header files, or you can use
3178 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3179 which are wrappers around this command which bitwise OR
3180 in the appropriate constant for you.
3182 The mode actually set is affected by the umask.");
3184 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3185 [InitBasicFS, Always, TestOutputStruct (
3186 [["mkfifo"; "0o777"; "/node"];
3187 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3188 "make FIFO (named pipe)",
3190 This call creates a FIFO (named pipe) called C<path> with
3191 mode C<mode>. It is just a convenient wrapper around
3194 The mode actually set is affected by the umask.");
3196 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3197 [InitBasicFS, Always, TestOutputStruct (
3198 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3199 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3200 "make block device node",
3202 This call creates a block device node called C<path> with
3203 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3204 It is just a convenient wrapper around C<guestfs_mknod>.
3206 The mode actually set is affected by the umask.");
3208 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3209 [InitBasicFS, Always, TestOutputStruct (
3210 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3211 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3212 "make char device node",
3214 This call creates a char device node called C<path> with
3215 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3216 It is just a convenient wrapper around C<guestfs_mknod>.
3218 The mode actually set is affected by the umask.");
3220 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3221 [InitEmpty, Always, TestOutputInt (
3222 [["umask"; "0o22"]], 0o22)],
3223 "set file mode creation mask (umask)",
3225 This function sets the mask used for creating new files and
3226 device nodes to C<mask & 0777>.
3228 Typical umask values would be C<022> which creates new files
3229 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3230 C<002> which creates new files with permissions like
3231 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3233 The default umask is C<022>. This is important because it
3234 means that directories and device nodes will be created with
3235 C<0644> or C<0755> mode even if you specify C<0777>.
3237 See also C<guestfs_get_umask>,
3238 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3240 This call returns the previous umask.");
3242 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3244 "read directories entries",
3246 This returns the list of directory entries in directory C<dir>.
3248 All entries in the directory are returned, including C<.> and
3249 C<..>. The entries are I<not> sorted, but returned in the same
3250 order as the underlying filesystem.
3252 Also this call returns basic file type information about each
3253 file. The C<ftyp> field will contain one of the following characters:
3291 The L<readdir(3)> call returned a C<d_type> field with an
3296 This function is primarily intended for use by programs. To
3297 get a simple list of names, use C<guestfs_ls>. To get a printable
3298 directory for human consumption, use C<guestfs_ll>.");
3300 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3302 "create partitions on a block device",
3304 This is a simplified interface to the C<guestfs_sfdisk>
3305 command, where partition sizes are specified in megabytes
3306 only (rounded to the nearest cylinder) and you don't need
3307 to specify the cyls, heads and sectors parameters which
3308 were rarely if ever used anyway.
3310 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3311 and C<guestfs_part_disk>");
3313 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3315 "determine file type inside a compressed file",
3317 This command runs C<file> after first decompressing C<path>
3320 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3322 Since 1.0.63, use C<guestfs_file> instead which can now
3323 process compressed files.");
3325 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3327 "list extended attributes of a file or directory",
3329 This call lists the extended attributes of the file or directory
3332 At the system call level, this is a combination of the
3333 L<listxattr(2)> and L<getxattr(2)> calls.
3335 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3337 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3339 "list extended attributes of a file or directory",
3341 This is the same as C<guestfs_getxattrs>, but if C<path>
3342 is a symbolic link, then it returns the extended attributes
3343 of the link itself.");
3345 ("setxattr", (RErr, [String "xattr";
3346 String "val"; Int "vallen"; (* will be BufferIn *)
3347 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3349 "set extended attribute of a file or directory",
3351 This call sets the extended attribute named C<xattr>
3352 of the file C<path> to the value C<val> (of length C<vallen>).
3353 The value is arbitrary 8 bit data.
3355 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3357 ("lsetxattr", (RErr, [String "xattr";
3358 String "val"; Int "vallen"; (* will be BufferIn *)
3359 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3361 "set extended attribute of a file or directory",
3363 This is the same as C<guestfs_setxattr>, but if C<path>
3364 is a symbolic link, then it sets an extended attribute
3365 of the link itself.");
3367 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3369 "remove extended attribute of a file or directory",
3371 This call removes the extended attribute named C<xattr>
3372 of the file C<path>.
3374 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3376 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3378 "remove extended attribute of a file or directory",
3380 This is the same as C<guestfs_removexattr>, but if C<path>
3381 is a symbolic link, then it removes an extended attribute
3382 of the link itself.");
3384 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3388 This call is similar to C<guestfs_mounts>. That call returns
3389 a list of devices. This one returns a hash table (map) of
3390 device name to directory where the device is mounted.");
3392 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3393 (* This is a special case: while you would expect a parameter
3394 * of type "Pathname", that doesn't work, because it implies
3395 * NEED_ROOT in the generated calling code in stubs.c, and
3396 * this function cannot use NEED_ROOT.
3399 "create a mountpoint",
3401 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3402 specialized calls that can be used to create extra mountpoints
3403 before mounting the first filesystem.
3405 These calls are I<only> necessary in some very limited circumstances,
3406 mainly the case where you want to mount a mix of unrelated and/or
3407 read-only filesystems together.
3409 For example, live CDs often contain a \"Russian doll\" nest of
3410 filesystems, an ISO outer layer, with a squashfs image inside, with
3411 an ext2/3 image inside that. You can unpack this as follows
3414 add-ro Fedora-11-i686-Live.iso
3418 mkmountpoint /ext3fs
3420 mount-loop /cd/LiveOS/squashfs.img /sqsh
3421 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3423 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3425 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3426 You may get unexpected errors if you try to mix these calls. It is
3427 safest to manually unmount filesystems and remove mountpoints after use.
3429 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3430 longest first, so for this to work for manual mountpoints, you
3431 must ensure that the innermost mountpoints have the longest
3432 pathnames, as in the example code above.
3434 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3436 Autosync [see C<guestfs_set_autosync>, this is set by default on
3437 handles] means that C<guestfs_umount_all> is called when the handle
3438 is closed which can also trigger these issues.");
3440 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3442 "remove a mountpoint",
3444 This calls removes a mountpoint that was previously created
3445 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3446 for full details.");
3448 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3449 [InitISOFS, Always, TestOutputBuffer (
3450 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3451 (* Test various near large, large and too large files (RHBZ#589039). *)
3452 InitBasicFS, Always, TestLastFail (
3454 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3455 ["read_file"; "/a"]]);
3456 InitBasicFS, Always, TestLastFail (
3458 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3459 ["read_file"; "/a"]]);
3460 InitBasicFS, Always, TestLastFail (
3462 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3463 ["read_file"; "/a"]])],
3466 This calls returns the contents of the file C<path> as a
3469 Unlike C<guestfs_cat>, this function can correctly
3470 handle files that contain embedded ASCII NUL characters.
3471 However unlike C<guestfs_download>, this function is limited
3472 in the total size of file that can be handled.");
3474 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3475 [InitISOFS, Always, TestOutputList (
3476 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3477 InitISOFS, Always, TestOutputList (
3478 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3479 (* Test for RHBZ#579608, absolute symbolic links. *)
3480 InitISOFS, Always, TestOutputList (
3481 [["grep"; "nomatch"; "/abssymlink"]], [])],
3482 "return lines matching a pattern",
3484 This calls the external C<grep> program and returns the
3487 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3488 [InitISOFS, Always, TestOutputList (
3489 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3490 "return lines matching a pattern",
3492 This calls the external C<egrep> program and returns the
3495 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3496 [InitISOFS, Always, TestOutputList (
3497 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3498 "return lines matching a pattern",
3500 This calls the external C<fgrep> program and returns the
3503 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3504 [InitISOFS, Always, TestOutputList (
3505 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3506 "return lines matching a pattern",
3508 This calls the external C<grep -i> program and returns the
3511 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3512 [InitISOFS, Always, TestOutputList (
3513 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3514 "return lines matching a pattern",
3516 This calls the external C<egrep -i> program and returns the
3519 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3520 [InitISOFS, Always, TestOutputList (
3521 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3522 "return lines matching a pattern",
3524 This calls the external C<fgrep -i> program and returns the
3527 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3528 [InitISOFS, Always, TestOutputList (
3529 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3530 "return lines matching a pattern",
3532 This calls the external C<zgrep> program and returns the
3535 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3536 [InitISOFS, Always, TestOutputList (
3537 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3538 "return lines matching a pattern",
3540 This calls the external C<zegrep> program and returns the
3543 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3544 [InitISOFS, Always, TestOutputList (
3545 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3546 "return lines matching a pattern",
3548 This calls the external C<zfgrep> program and returns the
3551 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3552 [InitISOFS, Always, TestOutputList (
3553 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3554 "return lines matching a pattern",
3556 This calls the external C<zgrep -i> program and returns the
3559 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3560 [InitISOFS, Always, TestOutputList (
3561 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3562 "return lines matching a pattern",
3564 This calls the external C<zegrep -i> program and returns the
3567 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3568 [InitISOFS, Always, TestOutputList (
3569 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3570 "return lines matching a pattern",
3572 This calls the external C<zfgrep -i> program and returns the
3575 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3576 [InitISOFS, Always, TestOutput (
3577 [["realpath"; "/../directory"]], "/directory")],
3578 "canonicalized absolute pathname",
3580 Return the canonicalized absolute pathname of C<path>. The
3581 returned path has no C<.>, C<..> or symbolic link path elements.");
3583 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3584 [InitBasicFS, Always, TestOutputStruct (
3587 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3588 "create a hard link",
3590 This command creates a hard link using the C<ln> command.");
3592 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3593 [InitBasicFS, Always, TestOutputStruct (
3596 ["ln_f"; "/a"; "/b"];
3597 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3598 "create a hard link",
3600 This command creates a hard link using the C<ln -f> command.
3601 The C<-f> option removes the link (C<linkname>) if it exists already.");
3603 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3604 [InitBasicFS, Always, TestOutputStruct (
3606 ["ln_s"; "a"; "/b"];
3607 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3608 "create a symbolic link",
3610 This command creates a symbolic link using the C<ln -s> command.");
3612 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3613 [InitBasicFS, Always, TestOutput (
3614 [["mkdir_p"; "/a/b"];
3615 ["touch"; "/a/b/c"];
3616 ["ln_sf"; "../d"; "/a/b/c"];
3617 ["readlink"; "/a/b/c"]], "../d")],
3618 "create a symbolic link",
3620 This command creates a symbolic link using the C<ln -sf> command,
3621 The C<-f> option removes the link (C<linkname>) if it exists already.");
3623 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3624 [] (* XXX tested above *),
3625 "read the target of a symbolic link",
3627 This command reads the target of a symbolic link.");
3629 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3630 [InitBasicFS, Always, TestOutputStruct (
3631 [["fallocate"; "/a"; "1000000"];
3632 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3633 "preallocate a file in the guest filesystem",
3635 This command preallocates a file (containing zero bytes) named
3636 C<path> of size C<len> bytes. If the file exists already, it
3639 Do not confuse this with the guestfish-specific
3640 C<alloc> command which allocates a file in the host and
3641 attaches it as a device.");
3643 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3644 [InitPartition, Always, TestRun (
3645 [["mkswap"; "/dev/sda1"];
3646 ["swapon_device"; "/dev/sda1"];
3647 ["swapoff_device"; "/dev/sda1"]])],
3648 "enable swap on device",
3650 This command enables the libguestfs appliance to use the
3651 swap device or partition named C<device>. The increased
3652 memory is made available for all commands, for example
3653 those run using C<guestfs_command> or C<guestfs_sh>.
3655 Note that you should not swap to existing guest swap
3656 partitions unless you know what you are doing. They may
3657 contain hibernation information, or other information that
3658 the guest doesn't want you to trash. You also risk leaking
3659 information about the host to the guest this way. Instead,
3660 attach a new host device to the guest and swap on that.");
3662 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3663 [], (* XXX tested by swapon_device *)
3664 "disable swap on device",
3666 This command disables the libguestfs appliance swap
3667 device or partition named C<device>.
3668 See C<guestfs_swapon_device>.");
3670 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3671 [InitBasicFS, Always, TestRun (
3672 [["fallocate"; "/swap"; "8388608"];
3673 ["mkswap_file"; "/swap"];
3674 ["swapon_file"; "/swap"];
3675 ["swapoff_file"; "/swap"]])],
3676 "enable swap on file",
3678 This command enables swap to a file.
3679 See C<guestfs_swapon_device> for other notes.");
3681 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3682 [], (* XXX tested by swapon_file *)
3683 "disable swap on file",
3685 This command disables the libguestfs appliance swap on file.");
3687 ("swapon_label", (RErr, [String "label"], []), 174, [],
3688 [InitEmpty, Always, TestRun (
3689 [["part_disk"; "/dev/sdb"; "mbr"];
3690 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3691 ["swapon_label"; "swapit"];
3692 ["swapoff_label"; "swapit"];
3693 ["zero"; "/dev/sdb"];
3694 ["blockdev_rereadpt"; "/dev/sdb"]])],
3695 "enable swap on labeled swap partition",
3697 This command enables swap to a labeled swap partition.
3698 See C<guestfs_swapon_device> for other notes.");
3700 ("swapoff_label", (RErr, [String "label"], []), 175, [],
3701 [], (* XXX tested by swapon_label *)
3702 "disable swap on labeled swap partition",
3704 This command disables the libguestfs appliance swap on
3705 labeled swap partition.");
3707 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3708 (let uuid = uuidgen () in
3709 [InitEmpty, Always, TestRun (
3710 [["mkswap_U"; uuid; "/dev/sdb"];
3711 ["swapon_uuid"; uuid];
3712 ["swapoff_uuid"; uuid]])]),
3713 "enable swap on swap partition by UUID",
3715 This command enables swap to a swap partition with the given UUID.
3716 See C<guestfs_swapon_device> for other notes.");
3718 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3719 [], (* XXX tested by swapon_uuid *)
3720 "disable swap on swap partition by UUID",
3722 This command disables the libguestfs appliance swap partition
3723 with the given UUID.");
3725 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
3726 [InitBasicFS, Always, TestRun (
3727 [["fallocate"; "/swap"; "8388608"];
3728 ["mkswap_file"; "/swap"]])],
3729 "create a swap file",
3733 This command just writes a swap file signature to an existing
3734 file. To create the file itself, use something like C<guestfs_fallocate>.");
3736 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
3737 [InitISOFS, Always, TestRun (
3738 [["inotify_init"; "0"]])],
3739 "create an inotify handle",
3741 This command creates a new inotify handle.
3742 The inotify subsystem can be used to notify events which happen to
3743 objects in the guest filesystem.
3745 C<maxevents> is the maximum number of events which will be
3746 queued up between calls to C<guestfs_inotify_read> or
3747 C<guestfs_inotify_files>.
3748 If this is passed as C<0>, then the kernel (or previously set)
3749 default is used. For Linux 2.6.29 the default was 16384 events.
3750 Beyond this limit, the kernel throws away events, but records
3751 the fact that it threw them away by setting a flag
3752 C<IN_Q_OVERFLOW> in the returned structure list (see
3753 C<guestfs_inotify_read>).
3755 Before any events are generated, you have to add some
3756 watches to the internal watch list. See:
3757 C<guestfs_inotify_add_watch>,
3758 C<guestfs_inotify_rm_watch> and
3759 C<guestfs_inotify_watch_all>.
3761 Queued up events should be read periodically by calling
3762 C<guestfs_inotify_read>
3763 (or C<guestfs_inotify_files> which is just a helpful
3764 wrapper around C<guestfs_inotify_read>). If you don't
3765 read the events out often enough then you risk the internal
3768 The handle should be closed after use by calling
3769 C<guestfs_inotify_close>. This also removes any
3770 watches automatically.
3772 See also L<inotify(7)> for an overview of the inotify interface
3773 as exposed by the Linux kernel, which is roughly what we expose
3774 via libguestfs. Note that there is one global inotify handle
3775 per libguestfs instance.");
3777 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
3778 [InitBasicFS, Always, TestOutputList (
3779 [["inotify_init"; "0"];
3780 ["inotify_add_watch"; "/"; "1073741823"];
3783 ["inotify_files"]], ["a"; "b"])],
3784 "add an inotify watch",
3786 Watch C<path> for the events listed in C<mask>.
3788 Note that if C<path> is a directory then events within that
3789 directory are watched, but this does I<not> happen recursively
3790 (in subdirectories).
3792 Note for non-C or non-Linux callers: the inotify events are
3793 defined by the Linux kernel ABI and are listed in
3794 C</usr/include/sys/inotify.h>.");
3796 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
3798 "remove an inotify watch",
3800 Remove a previously defined inotify watch.
3801 See C<guestfs_inotify_add_watch>.");
3803 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
3805 "return list of inotify events",
3807 Return the complete queue of events that have happened
3808 since the previous read call.
3810 If no events have happened, this returns an empty list.
3812 I<Note>: In order to make sure that all events have been
3813 read, you must call this function repeatedly until it
3814 returns an empty list. The reason is that the call will
3815 read events up to the maximum appliance-to-host message
3816 size and leave remaining events in the queue.");
3818 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
3820 "return list of watched files that had events",
3822 This function is a helpful wrapper around C<guestfs_inotify_read>
3823 which just returns a list of pathnames of objects that were
3824 touched. The returned pathnames are sorted and deduplicated.");
3826 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
3828 "close the inotify handle",
3830 This closes the inotify handle which was previously
3831 opened by inotify_init. It removes all watches, throws
3832 away any pending events, and deallocates all resources.");
3834 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
3836 "set SELinux security context",
3838 This sets the SELinux security context of the daemon
3839 to the string C<context>.
3841 See the documentation about SELINUX in L<guestfs(3)>.");
3843 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
3845 "get SELinux security context",
3847 This gets the SELinux security context of the daemon.
3849 See the documentation about SELINUX in L<guestfs(3)>,
3850 and C<guestfs_setcon>");
3852 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
3853 [InitEmpty, Always, TestOutput (
3854 [["part_disk"; "/dev/sda"; "mbr"];
3855 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3856 ["mount_options"; ""; "/dev/sda1"; "/"];
3857 ["write"; "/new"; "new file contents"];
3858 ["cat"; "/new"]], "new file contents");
3859 InitEmpty, Always, TestRun (
3860 [["part_disk"; "/dev/sda"; "mbr"];
3861 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3862 InitEmpty, Always, TestLastFail (
3863 [["part_disk"; "/dev/sda"; "mbr"];
3864 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3865 InitEmpty, Always, TestLastFail (
3866 [["part_disk"; "/dev/sda"; "mbr"];
3867 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3868 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3869 [["part_disk"; "/dev/sda"; "mbr"];
3870 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3871 "make a filesystem with block size",
3873 This call is similar to C<guestfs_mkfs>, but it allows you to
3874 control the block size of the resulting filesystem. Supported
3875 block sizes depend on the filesystem type, but typically they
3876 are C<1024>, C<2048> or C<4096> only.
3878 For VFAT and NTFS the C<blocksize> parameter is treated as
3879 the requested cluster size.");
3881 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
3882 [InitEmpty, Always, TestOutput (
3883 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3884 ["mke2journal"; "4096"; "/dev/sda1"];
3885 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3886 ["mount_options"; ""; "/dev/sda2"; "/"];
3887 ["write"; "/new"; "new file contents"];
3888 ["cat"; "/new"]], "new file contents")],
3889 "make ext2/3/4 external journal",
3891 This creates an ext2 external journal on C<device>. It is equivalent
3894 mke2fs -O journal_dev -b blocksize device");
3896 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
3897 [InitEmpty, Always, TestOutput (
3898 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3899 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3900 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3901 ["mount_options"; ""; "/dev/sda2"; "/"];
3902 ["write"; "/new"; "new file contents"];
3903 ["cat"; "/new"]], "new file contents")],
3904 "make ext2/3/4 external journal with label",
3906 This creates an ext2 external journal on C<device> with label C<label>.");
3908 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
3909 (let uuid = uuidgen () in
3910 [InitEmpty, Always, TestOutput (
3911 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3912 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3913 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3914 ["mount_options"; ""; "/dev/sda2"; "/"];
3915 ["write"; "/new"; "new file contents"];
3916 ["cat"; "/new"]], "new file contents")]),
3917 "make ext2/3/4 external journal with UUID",
3919 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3921 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
3923 "make ext2/3/4 filesystem with external journal",
3925 This creates an ext2/3/4 filesystem on C<device> with
3926 an external journal on C<journal>. It is equivalent
3929 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3931 See also C<guestfs_mke2journal>.");
3933 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
3935 "make ext2/3/4 filesystem with external journal",
3937 This creates an ext2/3/4 filesystem on C<device> with
3938 an external journal on the journal labeled C<label>.
3940 See also C<guestfs_mke2journal_L>.");
3942 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
3944 "make ext2/3/4 filesystem with external journal",
3946 This creates an ext2/3/4 filesystem on C<device> with
3947 an external journal on the journal with UUID C<uuid>.
3949 See also C<guestfs_mke2journal_U>.");
3951 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
3952 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3953 "load a kernel module",
3955 This loads a kernel module in the appliance.
3957 The kernel module must have been whitelisted when libguestfs
3958 was built (see C<appliance/kmod.whitelist.in> in the source).");
3960 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
3961 [InitNone, Always, TestOutput (
3962 [["echo_daemon"; "This is a test"]], "This is a test"
3964 "echo arguments back to the client",
3966 This command concatenates the list of C<words> passed with single spaces
3967 between them and returns the resulting string.
3969 You can use this command to test the connection through to the daemon.
3971 See also C<guestfs_ping_daemon>.");
3973 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
3974 [], (* There is a regression test for this. *)
3975 "find all files and directories, returning NUL-separated list",
3977 This command lists out all files and directories, recursively,
3978 starting at C<directory>, placing the resulting list in the
3979 external file called C<files>.
3981 This command works the same way as C<guestfs_find> with the
3982 following exceptions:
3988 The resulting list is written to an external file.
3992 Items (filenames) in the result are separated
3993 by C<\\0> characters. See L<find(1)> option I<-print0>.
3997 This command is not limited in the number of names that it
4002 The result list is not sorted.
4006 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4007 [InitISOFS, Always, TestOutput (
4008 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4009 InitISOFS, Always, TestOutput (
4010 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4011 InitISOFS, Always, TestOutput (
4012 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4013 InitISOFS, Always, TestLastFail (
4014 [["case_sensitive_path"; "/Known-1/"]]);
4015 InitBasicFS, Always, TestOutput (
4017 ["mkdir"; "/a/bbb"];
4018 ["touch"; "/a/bbb/c"];
4019 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4020 InitBasicFS, Always, TestOutput (
4022 ["mkdir"; "/a/bbb"];
4023 ["touch"; "/a/bbb/c"];
4024 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4025 InitBasicFS, Always, TestLastFail (
4027 ["mkdir"; "/a/bbb"];
4028 ["touch"; "/a/bbb/c"];
4029 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4030 "return true path on case-insensitive filesystem",
4032 This can be used to resolve case insensitive paths on
4033 a filesystem which is case sensitive. The use case is
4034 to resolve paths which you have read from Windows configuration
4035 files or the Windows Registry, to the true path.
4037 The command handles a peculiarity of the Linux ntfs-3g
4038 filesystem driver (and probably others), which is that although
4039 the underlying filesystem is case-insensitive, the driver
4040 exports the filesystem to Linux as case-sensitive.
4042 One consequence of this is that special directories such
4043 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4044 (or other things) depending on the precise details of how
4045 they were created. In Windows itself this would not be
4048 Bug or feature? You decide:
4049 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4051 This function resolves the true case of each element in the
4052 path and returns the case-sensitive path.
4054 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4055 might return C<\"/WINDOWS/system32\"> (the exact return value
4056 would depend on details of how the directories were originally
4057 created under Windows).
4060 This function does not handle drive names, backslashes etc.
4062 See also C<guestfs_realpath>.");
4064 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4065 [InitBasicFS, Always, TestOutput (
4066 [["vfs_type"; "/dev/sda1"]], "ext2")],
4067 "get the Linux VFS type corresponding to a mounted device",
4069 This command gets the filesystem type corresponding to
4070 the filesystem on C<device>.
4072 For most filesystems, the result is the name of the Linux
4073 VFS module which would be used to mount this filesystem
4074 if you mounted it without specifying the filesystem type.
4075 For example a string such as C<ext3> or C<ntfs>.");
4077 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4078 [InitBasicFS, Always, TestOutputStruct (
4079 [["write"; "/test"; "some stuff so size is not zero"];
4080 ["truncate"; "/test"];
4081 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4082 "truncate a file to zero size",
4084 This command truncates C<path> to a zero-length file. The
4085 file must exist already.");
4087 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4088 [InitBasicFS, Always, TestOutputStruct (
4089 [["touch"; "/test"];
4090 ["truncate_size"; "/test"; "1000"];
4091 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4092 "truncate a file to a particular size",
4094 This command truncates C<path> to size C<size> bytes. The file
4097 If the current file size is less than C<size> then
4098 the file is extended to the required size with zero bytes.
4099 This creates a sparse file (ie. disk blocks are not allocated
4100 for the file until you write to it). To create a non-sparse
4101 file of zeroes, use C<guestfs_fallocate64> instead.");
4103 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4104 [InitBasicFS, Always, TestOutputStruct (
4105 [["touch"; "/test"];
4106 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4107 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4108 "set timestamp of a file with nanosecond precision",
4110 This command sets the timestamps of a file with nanosecond
4113 C<atsecs, atnsecs> are the last access time (atime) in secs and
4114 nanoseconds from the epoch.
4116 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4117 secs and nanoseconds from the epoch.
4119 If the C<*nsecs> field contains the special value C<-1> then
4120 the corresponding timestamp is set to the current time. (The
4121 C<*secs> field is ignored in this case).
4123 If the C<*nsecs> field contains the special value C<-2> then
4124 the corresponding timestamp is left unchanged. (The
4125 C<*secs> field is ignored in this case).");
4127 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4128 [InitBasicFS, Always, TestOutputStruct (
4129 [["mkdir_mode"; "/test"; "0o111"];
4130 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4131 "create a directory with a particular mode",
4133 This command creates a directory, setting the initial permissions
4134 of the directory to C<mode>.
4136 For common Linux filesystems, the actual mode which is set will
4137 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4138 interpret the mode in other ways.
4140 See also C<guestfs_mkdir>, C<guestfs_umask>");
4142 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4144 "change file owner and group",
4146 Change the file owner to C<owner> and group to C<group>.
4147 This is like C<guestfs_chown> but if C<path> is a symlink then
4148 the link itself is changed, not the target.
4150 Only numeric uid and gid are supported. If you want to use
4151 names, you will need to locate and parse the password file
4152 yourself (Augeas support makes this relatively easy).");
4154 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4156 "lstat on multiple files",
4158 This call allows you to perform the C<guestfs_lstat> operation
4159 on multiple files, where all files are in the directory C<path>.
4160 C<names> is the list of files from this directory.
4162 On return you get a list of stat structs, with a one-to-one
4163 correspondence to the C<names> list. If any name did not exist
4164 or could not be lstat'd, then the C<ino> field of that structure
4167 This call is intended for programs that want to efficiently
4168 list a directory contents without making many round-trips.
4169 See also C<guestfs_lxattrlist> for a similarly efficient call
4170 for getting extended attributes. Very long directory listings
4171 might cause the protocol message size to be exceeded, causing
4172 this call to fail. The caller must split up such requests
4173 into smaller groups of names.");
4175 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4177 "lgetxattr on multiple files",
4179 This call allows you to get the extended attributes
4180 of multiple files, where all files are in the directory C<path>.
4181 C<names> is the list of files from this directory.
4183 On return you get a flat list of xattr structs which must be
4184 interpreted sequentially. The first xattr struct always has a zero-length
4185 C<attrname>. C<attrval> in this struct is zero-length
4186 to indicate there was an error doing C<lgetxattr> for this
4187 file, I<or> is a C string which is a decimal number
4188 (the number of following attributes for this file, which could
4189 be C<\"0\">). Then after the first xattr struct are the
4190 zero or more attributes for the first named file.
4191 This repeats for the second and subsequent files.
4193 This call is intended for programs that want to efficiently
4194 list a directory contents without making many round-trips.
4195 See also C<guestfs_lstatlist> for a similarly efficient call
4196 for getting standard stats. Very long directory listings
4197 might cause the protocol message size to be exceeded, causing
4198 this call to fail. The caller must split up such requests
4199 into smaller groups of names.");
4201 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4203 "readlink on multiple files",
4205 This call allows you to do a C<readlink> operation
4206 on multiple files, where all files are in the directory C<path>.
4207 C<names> is the list of files from this directory.
4209 On return you get a list of strings, with a one-to-one
4210 correspondence to the C<names> list. Each string is the
4211 value of the symbolic link.
4213 If the C<readlink(2)> operation fails on any name, then
4214 the corresponding result string is the empty string C<\"\">.
4215 However the whole operation is completed even if there
4216 were C<readlink(2)> errors, and so you can call this
4217 function with names where you don't know if they are
4218 symbolic links already (albeit slightly less efficient).
4220 This call is intended for programs that want to efficiently
4221 list a directory contents without making many round-trips.
4222 Very long directory listings might cause the protocol
4223 message size to be exceeded, causing
4224 this call to fail. The caller must split up such requests
4225 into smaller groups of names.");
4227 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4228 [InitISOFS, Always, TestOutputBuffer (
4229 [["pread"; "/known-4"; "1"; "3"]], "\n");
4230 InitISOFS, Always, TestOutputBuffer (
4231 [["pread"; "/empty"; "0"; "100"]], "")],
4232 "read part of a file",
4234 This command lets you read part of a file. It reads C<count>
4235 bytes of the file, starting at C<offset>, from file C<path>.
4237 This may read fewer bytes than requested. For further details
4238 see the L<pread(2)> system call.
4240 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4242 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4243 [InitEmpty, Always, TestRun (
4244 [["part_init"; "/dev/sda"; "gpt"]])],
4245 "create an empty partition table",
4247 This creates an empty partition table on C<device> of one of the
4248 partition types listed below. Usually C<parttype> should be
4249 either C<msdos> or C<gpt> (for large disks).
4251 Initially there are no partitions. Following this, you should
4252 call C<guestfs_part_add> for each partition required.
4254 Possible values for C<parttype> are:
4258 =item B<efi> | B<gpt>
4260 Intel EFI / GPT partition table.
4262 This is recommended for >= 2 TB partitions that will be accessed
4263 from Linux and Intel-based Mac OS X. It also has limited backwards
4264 compatibility with the C<mbr> format.
4266 =item B<mbr> | B<msdos>
4268 The standard PC \"Master Boot Record\" (MBR) format used
4269 by MS-DOS and Windows. This partition type will B<only> work
4270 for device sizes up to 2 TB. For large disks we recommend
4275 Other partition table types that may work but are not
4284 =item B<amiga> | B<rdb>
4286 Amiga \"Rigid Disk Block\" format.
4294 DASD, used on IBM mainframes.
4302 Old Mac partition format. Modern Macs use C<gpt>.
4306 NEC PC-98 format, common in Japan apparently.
4314 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4315 [InitEmpty, Always, TestRun (
4316 [["part_init"; "/dev/sda"; "mbr"];
4317 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4318 InitEmpty, Always, TestRun (
4319 [["part_init"; "/dev/sda"; "gpt"];
4320 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4321 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4322 InitEmpty, Always, TestRun (
4323 [["part_init"; "/dev/sda"; "mbr"];
4324 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4325 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4326 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4327 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4328 "add a partition to the device",
4330 This command adds a partition to C<device>. If there is no partition
4331 table on the device, call C<guestfs_part_init> first.
4333 The C<prlogex> parameter is the type of partition. Normally you
4334 should pass C<p> or C<primary> here, but MBR partition tables also
4335 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4338 C<startsect> and C<endsect> are the start and end of the partition
4339 in I<sectors>. C<endsect> may be negative, which means it counts
4340 backwards from the end of the disk (C<-1> is the last sector).
4342 Creating a partition which covers the whole disk is not so easy.
4343 Use C<guestfs_part_disk> to do that.");
4345 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4346 [InitEmpty, Always, TestRun (
4347 [["part_disk"; "/dev/sda"; "mbr"]]);
4348 InitEmpty, Always, TestRun (
4349 [["part_disk"; "/dev/sda"; "gpt"]])],
4350 "partition whole disk with a single primary partition",
4352 This command is simply a combination of C<guestfs_part_init>
4353 followed by C<guestfs_part_add> to create a single primary partition
4354 covering the whole disk.
4356 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4357 but other possible values are described in C<guestfs_part_init>.");
4359 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4360 [InitEmpty, Always, TestRun (
4361 [["part_disk"; "/dev/sda"; "mbr"];
4362 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4363 "make a partition bootable",
4365 This sets the bootable flag on partition numbered C<partnum> on
4366 device C<device>. Note that partitions are numbered from 1.
4368 The bootable flag is used by some operating systems (notably
4369 Windows) to determine which partition to boot from. It is by
4370 no means universally recognized.");
4372 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4373 [InitEmpty, Always, TestRun (
4374 [["part_disk"; "/dev/sda"; "gpt"];
4375 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4376 "set partition name",
4378 This sets the partition name on partition numbered C<partnum> on
4379 device C<device>. Note that partitions are numbered from 1.
4381 The partition name can only be set on certain types of partition
4382 table. This works on C<gpt> but not on C<mbr> partitions.");
4384 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4385 [], (* XXX Add a regression test for this. *)
4386 "list partitions on a device",
4388 This command parses the partition table on C<device> and
4389 returns the list of partitions found.
4391 The fields in the returned structure are:
4397 Partition number, counting from 1.
4401 Start of the partition I<in bytes>. To get sectors you have to
4402 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4406 End of the partition in bytes.
4410 Size of the partition in bytes.
4414 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4415 [InitEmpty, Always, TestOutput (
4416 [["part_disk"; "/dev/sda"; "gpt"];
4417 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4418 "get the partition table type",
4420 This command examines the partition table on C<device> and
4421 returns the partition table type (format) being used.
4423 Common return values include: C<msdos> (a DOS/Windows style MBR
4424 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4425 values are possible, although unusual. See C<guestfs_part_init>
4428 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4429 [InitBasicFS, Always, TestOutputBuffer (
4430 [["fill"; "0x63"; "10"; "/test"];
4431 ["read_file"; "/test"]], "cccccccccc")],
4432 "fill a file with octets",
4434 This command creates a new file called C<path>. The initial
4435 content of the file is C<len> octets of C<c>, where C<c>
4436 must be a number in the range C<[0..255]>.
4438 To fill a file with zero bytes (sparsely), it is
4439 much more efficient to use C<guestfs_truncate_size>.
4440 To create a file with a pattern of repeating bytes
4441 use C<guestfs_fill_pattern>.");
4443 ("available", (RErr, [StringList "groups"], []), 216, [],
4444 [InitNone, Always, TestRun [["available"; ""]]],
4445 "test availability of some parts of the API",
4447 This command is used to check the availability of some
4448 groups of functionality in the appliance, which not all builds of
4449 the libguestfs appliance will be able to provide.
4451 The libguestfs groups, and the functions that those
4452 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4453 You can also fetch this list at runtime by calling
4454 C<guestfs_available_all_groups>.
4456 The argument C<groups> is a list of group names, eg:
4457 C<[\"inotify\", \"augeas\"]> would check for the availability of
4458 the Linux inotify functions and Augeas (configuration file
4461 The command returns no error if I<all> requested groups are available.
4463 It fails with an error if one or more of the requested
4464 groups is unavailable in the appliance.
4466 If an unknown group name is included in the
4467 list of groups then an error is always returned.
4475 You must call C<guestfs_launch> before calling this function.
4477 The reason is because we don't know what groups are
4478 supported by the appliance/daemon until it is running and can
4483 If a group of functions is available, this does not necessarily
4484 mean that they will work. You still have to check for errors
4485 when calling individual API functions even if they are
4490 It is usually the job of distro packagers to build
4491 complete functionality into the libguestfs appliance.
4492 Upstream libguestfs, if built from source with all
4493 requirements satisfied, will support everything.
4497 This call was added in version C<1.0.80>. In previous
4498 versions of libguestfs all you could do would be to speculatively
4499 execute a command to find out if the daemon implemented it.
4500 See also C<guestfs_version>.
4504 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4505 [InitBasicFS, Always, TestOutputBuffer (
4506 [["write"; "/src"; "hello, world"];
4507 ["dd"; "/src"; "/dest"];
4508 ["read_file"; "/dest"]], "hello, world")],
4509 "copy from source to destination using dd",
4511 This command copies from one source device or file C<src>
4512 to another destination device or file C<dest>. Normally you
4513 would use this to copy to or from a device or partition, for
4514 example to duplicate a filesystem.
4516 If the destination is a device, it must be as large or larger
4517 than the source file or device, otherwise the copy will fail.
4518 This command cannot do partial copies (see C<guestfs_copy_size>).");
4520 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4521 [InitBasicFS, Always, TestOutputInt (
4522 [["write"; "/file"; "hello, world"];
4523 ["filesize"; "/file"]], 12)],
4524 "return the size of the file in bytes",
4526 This command returns the size of C<file> in bytes.
4528 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4529 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4530 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4532 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4533 [InitBasicFSonLVM, Always, TestOutputList (
4534 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4535 ["lvs"]], ["/dev/VG/LV2"])],
4536 "rename an LVM logical volume",
4538 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4540 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4541 [InitBasicFSonLVM, Always, TestOutputList (
4543 ["vg_activate"; "false"; "VG"];
4544 ["vgrename"; "VG"; "VG2"];
4545 ["vg_activate"; "true"; "VG2"];
4546 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4547 ["vgs"]], ["VG2"])],
4548 "rename an LVM volume group",
4550 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4552 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4553 [InitISOFS, Always, TestOutputBuffer (
4554 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4555 "list the contents of a single file in an initrd",
4557 This command unpacks the file C<filename> from the initrd file
4558 called C<initrdpath>. The filename must be given I<without> the
4559 initial C</> character.
4561 For example, in guestfish you could use the following command
4562 to examine the boot script (usually called C</init>)
4563 contained in a Linux initrd or initramfs image:
4565 initrd-cat /boot/initrd-<version>.img init
4567 See also C<guestfs_initrd_list>.");
4569 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4571 "get the UUID of a physical volume",
4573 This command returns the UUID of the LVM PV C<device>.");
4575 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4577 "get the UUID of a volume group",
4579 This command returns the UUID of the LVM VG named C<vgname>.");
4581 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4583 "get the UUID of a logical volume",
4585 This command returns the UUID of the LVM LV C<device>.");
4587 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4589 "get the PV UUIDs containing the volume group",
4591 Given a VG called C<vgname>, this returns the UUIDs of all
4592 the physical volumes that this volume group resides on.
4594 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4595 calls to associate physical volumes and volume groups.
4597 See also C<guestfs_vglvuuids>.");
4599 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4601 "get the LV UUIDs of all LVs in the volume group",
4603 Given a VG called C<vgname>, this returns the UUIDs of all
4604 the logical volumes created in this volume group.
4606 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4607 calls to associate logical volumes and volume groups.
4609 See also C<guestfs_vgpvuuids>.");
4611 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4612 [InitBasicFS, Always, TestOutputBuffer (
4613 [["write"; "/src"; "hello, world"];
4614 ["copy_size"; "/src"; "/dest"; "5"];
4615 ["read_file"; "/dest"]], "hello")],
4616 "copy size bytes from source to destination using dd",
4618 This command copies exactly C<size> bytes from one source device
4619 or file C<src> to another destination device or file C<dest>.
4621 Note this will fail if the source is too short or if the destination
4622 is not large enough.");
4624 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4625 [InitBasicFSonLVM, Always, TestRun (
4626 [["zero_device"; "/dev/VG/LV"]])],
4627 "write zeroes to an entire device",
4629 This command writes zeroes over the entire C<device>. Compare
4630 with C<guestfs_zero> which just zeroes the first few blocks of
4633 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4634 [InitBasicFS, Always, TestOutput (
4635 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4636 ["cat"; "/hello"]], "hello\n")],
4637 "unpack compressed tarball to directory",
4639 This command uploads and unpacks local file C<tarball> (an
4640 I<xz compressed> tar file) into C<directory>.");
4642 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4644 "pack directory into compressed tarball",
4646 This command packs the contents of C<directory> and downloads
4647 it to local file C<tarball> (as an xz compressed tar archive).");
4649 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4651 "resize an NTFS filesystem",
4653 This command resizes an NTFS filesystem, expanding or
4654 shrinking it to the size of the underlying device.
4655 See also L<ntfsresize(8)>.");
4657 ("vgscan", (RErr, [], []), 232, [],
4658 [InitEmpty, Always, TestRun (
4660 "rescan for LVM physical volumes, volume groups and logical volumes",
4662 This rescans all block devices and rebuilds the list of LVM
4663 physical volumes, volume groups and logical volumes.");
4665 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
4666 [InitEmpty, Always, TestRun (
4667 [["part_init"; "/dev/sda"; "mbr"];
4668 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4669 ["part_del"; "/dev/sda"; "1"]])],
4670 "delete a partition",
4672 This command deletes the partition numbered C<partnum> on C<device>.
4674 Note that in the case of MBR partitioning, deleting an
4675 extended partition also deletes any logical partitions
4678 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
4679 [InitEmpty, Always, TestOutputTrue (
4680 [["part_init"; "/dev/sda"; "mbr"];
4681 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4682 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4683 ["part_get_bootable"; "/dev/sda"; "1"]])],
4684 "return true if a partition is bootable",
4686 This command returns true if the partition C<partnum> on
4687 C<device> has the bootable flag set.
4689 See also C<guestfs_part_set_bootable>.");
4691 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
4692 [InitEmpty, Always, TestOutputInt (
4693 [["part_init"; "/dev/sda"; "mbr"];
4694 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4695 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4696 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4697 "get the MBR type byte (ID byte) from a partition",
4699 Returns the MBR type byte (also known as the ID byte) from
4700 the numbered partition C<partnum>.
4702 Note that only MBR (old DOS-style) partitions have type bytes.
4703 You will get undefined results for other partition table
4704 types (see C<guestfs_part_get_parttype>).");
4706 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
4707 [], (* tested by part_get_mbr_id *)
4708 "set the MBR type byte (ID byte) of a partition",
4710 Sets the MBR type byte (also known as the ID byte) of
4711 the numbered partition C<partnum> to C<idbyte>. Note
4712 that the type bytes quoted in most documentation are
4713 in fact hexadecimal numbers, but usually documented
4714 without any leading \"0x\" which might be confusing.
4716 Note that only MBR (old DOS-style) partitions have type bytes.
4717 You will get undefined results for other partition table
4718 types (see C<guestfs_part_get_parttype>).");
4720 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
4721 [InitISOFS, Always, TestOutputFileMD5 (
4722 [["checksum_device"; "md5"; "/dev/sdd"]],
4723 "../images/test.iso")],
4724 "compute MD5, SHAx or CRC checksum of the contents of a device",
4726 This call computes the MD5, SHAx or CRC checksum of the
4727 contents of the device named C<device>. For the types of
4728 checksums supported see the C<guestfs_checksum> command.");
4730 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
4731 [InitNone, Always, TestRun (
4732 [["part_disk"; "/dev/sda"; "mbr"];
4733 ["pvcreate"; "/dev/sda1"];
4734 ["vgcreate"; "VG"; "/dev/sda1"];
4735 ["lvcreate"; "LV"; "VG"; "10"];
4736 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4737 "expand an LV to fill free space",
4739 This expands an existing logical volume C<lv> so that it fills
4740 C<pc>% of the remaining free space in the volume group. Commonly
4741 you would call this with pc = 100 which expands the logical volume
4742 as much as possible, using all remaining free space in the volume
4745 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
4746 [], (* XXX Augeas code needs tests. *)
4747 "clear Augeas path",
4749 Set the value associated with C<path> to C<NULL>. This
4750 is the same as the L<augtool(1)> C<clear> command.");
4752 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
4753 [InitEmpty, Always, TestOutputInt (
4754 [["get_umask"]], 0o22)],
4755 "get the current umask",
4757 Return the current umask. By default the umask is C<022>
4758 unless it has been set by calling C<guestfs_umask>.");
4760 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [],
4762 "upload a file to the appliance (internal use only)",
4764 The C<guestfs_debug_upload> command uploads a file to
4765 the libguestfs appliance.
4767 There is no comprehensive help for this command. You have
4768 to look at the file C<daemon/debug.c> in the libguestfs source
4769 to find out what it is for.");
4771 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
4772 [InitBasicFS, Always, TestOutput (
4773 [["base64_in"; "../images/hello.b64"; "/hello"];
4774 ["cat"; "/hello"]], "hello\n")],
4775 "upload base64-encoded data to file",
4777 This command uploads base64-encoded data from C<base64file>
4780 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
4782 "download file and encode as base64",
4784 This command downloads the contents of C<filename>, writing
4785 it out to local file C<base64file> encoded as base64.");
4787 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
4789 "compute MD5, SHAx or CRC checksum of files in a directory",
4791 This command computes the checksums of all regular files in
4792 C<directory> and then emits a list of those checksums to
4793 the local output file C<sumsfile>.
4795 This can be used for verifying the integrity of a virtual
4796 machine. However to be properly secure you should pay
4797 attention to the output of the checksum command (it uses
4798 the ones from GNU coreutils). In particular when the
4799 filename is not printable, coreutils uses a special
4800 backslash syntax. For more information, see the GNU
4801 coreutils info file.");
4803 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
4804 [InitBasicFS, Always, TestOutputBuffer (
4805 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4806 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4807 "fill a file with a repeating pattern of bytes",
4809 This function is like C<guestfs_fill> except that it creates
4810 a new file of length C<len> containing the repeating pattern
4811 of bytes in C<pattern>. The pattern is truncated if necessary
4812 to ensure the length of the file is exactly C<len> bytes.");
4814 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
4815 [InitBasicFS, Always, TestOutput (
4816 [["write"; "/new"; "new file contents"];
4817 ["cat"; "/new"]], "new file contents");
4818 InitBasicFS, Always, TestOutput (
4819 [["write"; "/new"; "\nnew file contents\n"];
4820 ["cat"; "/new"]], "\nnew file contents\n");
4821 InitBasicFS, Always, TestOutput (
4822 [["write"; "/new"; "\n\n"];
4823 ["cat"; "/new"]], "\n\n");
4824 InitBasicFS, Always, TestOutput (
4825 [["write"; "/new"; ""];
4826 ["cat"; "/new"]], "");
4827 InitBasicFS, Always, TestOutput (
4828 [["write"; "/new"; "\n\n\n"];
4829 ["cat"; "/new"]], "\n\n\n");
4830 InitBasicFS, Always, TestOutput (
4831 [["write"; "/new"; "\n"];
4832 ["cat"; "/new"]], "\n")],
4833 "create a new file",
4835 This call creates a file called C<path>. The content of the
4836 file is the string C<content> (which can contain any 8 bit data).");
4838 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
4839 [InitBasicFS, Always, TestOutput (
4840 [["write"; "/new"; "new file contents"];
4841 ["pwrite"; "/new"; "data"; "4"];
4842 ["cat"; "/new"]], "new data contents");
4843 InitBasicFS, Always, TestOutput (
4844 [["write"; "/new"; "new file contents"];
4845 ["pwrite"; "/new"; "is extended"; "9"];
4846 ["cat"; "/new"]], "new file is extended");
4847 InitBasicFS, Always, TestOutput (
4848 [["write"; "/new"; "new file contents"];
4849 ["pwrite"; "/new"; ""; "4"];
4850 ["cat"; "/new"]], "new file contents")],
4851 "write to part of a file",
4853 This command writes to part of a file. It writes the data
4854 buffer C<content> to the file C<path> starting at offset C<offset>.
4856 This command implements the L<pwrite(2)> system call, and like
4857 that system call it may not write the full data requested. The
4858 return value is the number of bytes that were actually written
4859 to the file. This could even be 0, although short writes are
4860 unlikely for regular files in ordinary circumstances.
4862 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
4864 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
4866 "resize an ext2, ext3 or ext4 filesystem (with size)",
4868 This command is the same as C<guestfs_resize2fs> except that it
4869 allows you to specify the new size (in bytes) explicitly.");
4871 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
4873 "resize an LVM physical volume (with size)",
4875 This command is the same as C<guestfs_pvresize> except that it
4876 allows you to specify the new size (in bytes) explicitly.");
4878 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
4880 "resize an NTFS filesystem (with size)",
4882 This command is the same as C<guestfs_ntfsresize> except that it
4883 allows you to specify the new size (in bytes) explicitly.");
4885 ("available_all_groups", (RStringList "groups", [], []), 251, [],
4886 [InitNone, Always, TestRun [["available_all_groups"]]],
4887 "return a list of all optional groups",
4889 This command returns a list of all optional groups that this
4890 daemon knows about. Note this returns both supported and unsupported
4891 groups. To find out which ones the daemon can actually support
4892 you have to call C<guestfs_available> on each member of the
4895 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4897 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
4898 [InitBasicFS, Always, TestOutputStruct (
4899 [["fallocate64"; "/a"; "1000000"];
4900 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4901 "preallocate a file in the guest filesystem",
4903 This command preallocates a file (containing zero bytes) named
4904 C<path> of size C<len> bytes. If the file exists already, it
4907 Note that this call allocates disk blocks for the file.
4908 To create a sparse file use C<guestfs_truncate_size> instead.
4910 The deprecated call C<guestfs_fallocate> does the same,
4911 but owing to an oversight it only allowed 30 bit lengths
4912 to be specified, effectively limiting the maximum size
4913 of files created through that call to 1GB.
4915 Do not confuse this with the guestfish-specific
4916 C<alloc> and C<sparse> commands which create
4917 a file in the host and attach it as a device.");
4919 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
4920 [InitBasicFS, Always, TestOutput (
4921 [["set_e2label"; "/dev/sda1"; "LTEST"];
4922 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4923 "get the filesystem label",
4925 This returns the filesystem label of the filesystem on
4928 If the filesystem is unlabeled, this returns the empty string.
4930 To find a filesystem from the label, use C<guestfs_findfs_label>.");
4932 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
4933 (let uuid = uuidgen () in
4934 [InitBasicFS, Always, TestOutput (
4935 [["set_e2uuid"; "/dev/sda1"; uuid];
4936 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4937 "get the filesystem UUID",
4939 This returns the filesystem UUID of the filesystem on
4942 If the filesystem does not have a UUID, this returns the empty string.
4944 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
4946 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
4947 (* Can't be tested with the current framework because
4948 * the VG is being used by the mounted filesystem, so
4949 * the vgchange -an command we do first will fail.
4952 "set LVM device filter",
4954 This sets the LVM device filter so that LVM will only be
4955 able to \"see\" the block devices in the list C<devices>,
4956 and will ignore all other attached block devices.
4958 Where disk image(s) contain duplicate PVs or VGs, this
4959 command is useful to get LVM to ignore the duplicates, otherwise
4960 LVM can get confused. Note also there are two types
4961 of duplication possible: either cloned PVs/VGs which have
4962 identical UUIDs; or VGs that are not cloned but just happen
4963 to have the same name. In normal operation you cannot
4964 create this situation, but you can do it outside LVM, eg.
4965 by cloning disk images or by bit twiddling inside the LVM
4968 This command also clears the LVM cache and performs a volume
4971 You can filter whole block devices or individual partitions.
4973 You cannot use this if any VG is currently in use (eg.
4974 contains a mounted filesystem), even if you are not
4975 filtering out that VG.");
4977 ("lvm_clear_filter", (RErr, [], []), 256, [],
4978 [], (* see note on lvm_set_filter *)
4979 "clear LVM device filter",
4981 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
4982 will be able to see every block device.
4984 This command also clears the LVM cache and performs a volume
4987 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
4989 "open a LUKS-encrypted block device",
4991 This command opens a block device which has been encrypted
4992 according to the Linux Unified Key Setup (LUKS) standard.
4994 C<device> is the encrypted block device or partition.
4996 The caller must supply one of the keys associated with the
4997 LUKS block device, in the C<key> parameter.
4999 This creates a new block device called C</dev/mapper/mapname>.
5000 Reads and writes to this block device are decrypted from and
5001 encrypted to the underlying C<device> respectively.
5003 If this block device contains LVM volume groups, then
5004 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5005 will make them visible.");
5007 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5009 "open a LUKS-encrypted block device read-only",
5011 This is the same as C<guestfs_luks_open> except that a read-only
5012 mapping is created.");
5014 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5016 "close a LUKS device",
5018 This closes a LUKS device that was created earlier by
5019 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5020 C<device> parameter must be the name of the LUKS mapping
5021 device (ie. C</dev/mapper/mapname>) and I<not> the name
5022 of the underlying block device.");
5024 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5026 "format a block device as a LUKS encrypted device",
5028 This command erases existing data on C<device> and formats
5029 the device as a LUKS encrypted device. C<key> is the
5030 initial key, which is added to key slot C<slot>. (LUKS
5031 supports 8 key slots, numbered 0-7).");
5033 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5035 "format a block device as a LUKS encrypted device",
5037 This command is the same as C<guestfs_luks_format> but
5038 it also allows you to set the C<cipher> used.");
5040 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5042 "add a key on a LUKS encrypted device",
5044 This command adds a new key on LUKS device C<device>.
5045 C<key> is any existing key, and is used to access the device.
5046 C<newkey> is the new key to add. C<keyslot> is the key slot
5047 that will be replaced.
5049 Note that if C<keyslot> already contains a key, then this
5050 command will fail. You have to use C<guestfs_luks_kill_slot>
5051 first to remove that key.");
5053 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5055 "remove a key from a LUKS encrypted device",
5057 This command deletes the key in key slot C<keyslot> from the
5058 encrypted LUKS device C<device>. C<key> must be one of the
5061 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5062 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5063 [["is_lv"; "/dev/VG/LV"]]);
5064 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5065 [["is_lv"; "/dev/sda1"]])],
5066 "test if device is a logical volume",
5068 This command tests whether C<device> is a logical volume, and
5069 returns true iff this is the case.");
5071 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5073 "find a filesystem by UUID",
5075 This command searches the filesystems and returns the one
5076 which has the given UUID. An error is returned if no such
5077 filesystem can be found.
5079 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5081 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5083 "find a filesystem by label",
5085 This command searches the filesystems and returns the one
5086 which has the given label. An error is returned if no such
5087 filesystem can be found.
5089 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5091 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5092 [InitISOFS, Always, TestOutputFalse (
5093 [["is_chardev"; "/directory"]]);
5094 InitBasicFS, Always, TestOutputTrue (
5095 [["mknod_c"; "0o777"; "99"; "66"; "/test"];
5096 ["is_chardev"; "/test"]])],
5097 "test if character device",
5099 This returns C<true> if and only if there is a character device
5100 with the given C<path> name.
5102 See also C<guestfs_stat>.");
5104 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5105 [InitISOFS, Always, TestOutputFalse (
5106 [["is_blockdev"; "/directory"]]);
5107 InitBasicFS, Always, TestOutputTrue (
5108 [["mknod_b"; "0o777"; "99"; "66"; "/test"];
5109 ["is_blockdev"; "/test"]])],
5110 "test if block device",
5112 This returns C<true> if and only if there is a block device
5113 with the given C<path> name.
5115 See also C<guestfs_stat>.");
5117 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5118 [InitISOFS, Always, TestOutputFalse (
5119 [["is_fifo"; "/directory"]]);
5120 InitBasicFS, Always, TestOutputTrue (
5121 [["mkfifo"; "0o777"; "/test"];
5122 ["is_fifo"; "/test"]])],
5123 "test if FIFO (named pipe)",
5125 This returns C<true> if and only if there is a FIFO (named pipe)
5126 with the given C<path> name.
5128 See also C<guestfs_stat>.");
5130 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5131 [InitISOFS, Always, TestOutputFalse (
5132 [["is_symlink"; "/directory"]]);
5133 InitISOFS, Always, TestOutputTrue (
5134 [["is_symlink"; "/abssymlink"]])],
5135 "test if symbolic link",
5137 This returns C<true> if and only if there is a symbolic link
5138 with the given C<path> name.
5140 See also C<guestfs_stat>.");
5142 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5143 (* XXX Need a positive test for sockets. *)
5144 [InitISOFS, Always, TestOutputFalse (
5145 [["is_socket"; "/directory"]])],
5148 This returns C<true> if and only if there is a Unix domain socket
5149 with the given C<path> name.
5151 See also C<guestfs_stat>.");
5153 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5154 [InitPartition, Always, TestOutputDevice (
5155 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5156 InitEmpty, Always, TestLastFail (
5157 [["part_to_dev"; "/dev/sda"]])],
5158 "convert partition name to device name",
5160 This function takes a partition name (eg. \"/dev/sdb1\") and
5161 removes the partition number, returning the device name
5164 The named partition must exist, for example as a string returned
5165 from C<guestfs_list_partitions>.");
5167 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [],
5168 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5169 [InitBasicFS, Always, TestOutput (
5170 [["upload_offset"; "../COPYING.LIB"; "/COPYING.LIB"; "0"];
5171 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5172 "upload a file from the local machine with offset",
5174 Upload local file C<filename> to C<remotefilename> on the
5177 C<remotefilename> is overwritten starting at the byte C<offset>
5178 specified. The intention is to overwrite parts of existing
5179 files or devices, although if a non-existant file is specified
5180 then it is created with a \"hole\" before C<offset>. The
5181 size of the data written is implicit in the size of the
5184 Note that there is no limit on the amount of data that
5185 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5186 and this call always writes the full amount unless an
5189 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5191 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5192 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5193 let offset = string_of_int 100 in
5194 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5195 [InitBasicFS, Always, TestOutput (
5196 (* Pick a file from cwd which isn't likely to change. *)
5197 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
5198 ["download_offset"; "/COPYING.LIB"; "testdownload.tmp"; offset; size];
5199 ["upload_offset"; "testdownload.tmp"; "/COPYING.LIB"; offset];
5200 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5201 "download a file to the local machine with offset and size",
5203 Download file C<remotefilename> and save it as C<filename>
5204 on the local machine.
5206 C<remotefilename> is read for C<size> bytes starting at C<offset>
5207 (this region must be within the file or device).
5209 Note that there is no limit on the amount of data that
5210 can be downloaded with this call, unlike with C<guestfs_pread>,
5211 and this call always reads the full amount unless an
5214 See also C<guestfs_download>, C<guestfs_pread>.");
5216 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5217 [InitPartition, Always, TestOutputList (
5218 [["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"];
5219 ["blockdev_rereadpt"; "/dev/sda"];
5220 ["list_partitions"]], [])],
5221 "write to part of a device",
5223 This command writes to part of a device. It writes the data
5224 buffer C<content> to C<device> starting at offset C<offset>.
5226 This command implements the L<pwrite(2)> system call, and like
5227 that system call it may not write the full data requested
5228 (although short writes to disk devices and partitions are
5229 probably impossible with standard Linux kernels).
5231 See also C<guestfs_pwrite>.");
5233 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5234 [InitEmpty, Always, TestOutputBuffer (
5235 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5236 "read part of a device",
5238 This command lets you read part of a file. It reads C<count>
5239 bytes of C<device>, starting at C<offset>.
5241 This may read fewer bytes than requested. For further details
5242 see the L<pread(2)> system call.
5244 See also C<guestfs_pread>.");
5246 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5247 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5248 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5249 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5250 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5251 "get canonical name of an LV",
5253 This converts alternative naming schemes for LVs that you
5254 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5255 is converted to C</dev/VG/LV>.
5257 This command returns an error if the C<lvname> parameter does
5258 not refer to a logical volume.
5260 See also C<guestfs_is_lv>.");
5264 let all_functions = non_daemon_functions @ daemon_functions
5266 (* In some places we want the functions to be displayed sorted
5267 * alphabetically, so this is useful:
5269 let all_functions_sorted = List.sort action_compare all_functions
5271 (* This is used to generate the src/MAX_PROC_NR file which
5272 * contains the maximum procedure number, a surrogate for the
5273 * ABI version number. See src/Makefile.am for the details.
5276 let proc_nrs = List.map (
5277 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5278 ) daemon_functions in
5279 List.fold_left max 0 proc_nrs
5281 (* Non-API meta-commands available only in guestfish.
5283 * Note (1): style, proc_nr and tests fields are all meaningless.
5284 * The only fields which are actually used are the shortname,
5285 * FishAlias flags, shortdesc and longdesc.
5287 * Note (2): to refer to other commands, use L</shortname>.
5289 * Note (3): keep this list sorted by shortname.
5291 let fish_commands = [
5292 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5293 "allocate and add a disk file",
5294 " alloc filename size
5296 This creates an empty (zeroed) file of the given size, and then adds
5297 so it can be further examined.
5299 For more advanced image creation, see L<qemu-img(1)> utility.
5301 Size can be specified using standard suffixes, eg. C<1M>.
5303 To create a sparse file, use L</sparse> instead. To create a
5304 prepared disk image, see L</PREPARED DISK IMAGES>.");
5306 ("copy_in", (RErr,[], []), -1, [], [],
5307 "copy local files or directories into an image",
5308 " copy-in local [local ...] /remotedir
5310 C<copy-in> copies local files or directories recursively into the disk
5311 image, placing them in the directory called C</remotedir> (which must
5312 exist). This guestfish meta-command turns into a sequence of
5313 L</tar-in> and other commands as necessary.
5315 Multiple local files and directories can be specified, but the last
5316 parameter must always be a remote directory. Wildcards cannot be
5319 ("copy_out", (RErr,[], []), -1, [], [],
5320 "copy remote files or directories out of an image",
5321 " copy-out remote [remote ...] localdir
5323 C<copy-out> copies remote files or directories recursively out of the
5324 disk image, placing them on the host disk in a local directory called
5325 C<localdir> (which must exist). This guestfish meta-command turns
5326 into a sequence of L</download>, L</tar-out> and other commands as
5329 Multiple remote files and directories can be specified, but the last
5330 parameter must always be a local directory. To download to the
5331 current directory, use C<.> as in:
5335 Wildcards cannot be used in the ordinary command, but you can use
5336 them with the help of L</glob> like this:
5338 glob copy-out /home/* .");
5340 ("echo", (RErr,[], []), -1, [], [],
5341 "display a line of text",
5344 This echos the parameters to the terminal.");
5346 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5350 This is used to edit a file. It downloads the file, edits it
5351 locally using your editor, then uploads the result.
5353 The editor is C<$EDITOR>. However if you use the alternate
5354 commands C<vi> or C<emacs> you will get those corresponding
5357 ("glob", (RErr,[], []), -1, [], [],
5358 "expand wildcards in command",
5359 " glob command args...
5361 Expand wildcards in any paths in the args list, and run C<command>
5362 repeatedly on each matching path.
5364 See L</WILDCARDS AND GLOBBING>.");
5366 ("hexedit", (RErr,[], []), -1, [], [],
5367 "edit with a hex editor",
5368 " hexedit <filename|device>
5369 hexedit <filename|device> <max>
5370 hexedit <filename|device> <start> <max>
5372 Use hexedit (a hex editor) to edit all or part of a binary file
5375 This command works by downloading potentially the whole file or
5376 device, editing it locally, then uploading it. If the file or
5377 device is large, you have to specify which part you wish to edit
5378 by using C<max> and/or C<start> C<max> parameters.
5379 C<start> and C<max> are specified in bytes, with the usual
5380 modifiers allowed such as C<1M> (1 megabyte).
5382 For example to edit the first few sectors of a disk you
5387 which would allow you to edit anywhere within the first megabyte
5390 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5392 hexedit /dev/sda1 0x400 0x400
5394 (assuming the superblock is in the standard location).
5396 This command requires the external L<hexedit(1)> program. You
5397 can specify another program to use by setting the C<HEXEDITOR>
5398 environment variable.
5400 See also L</hexdump>.");
5402 ("lcd", (RErr,[], []), -1, [], [],
5403 "change working directory",
5406 Change the local directory, ie. the current directory of guestfish
5409 Note that C<!cd> won't do what you might expect.");
5411 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5415 Opens the manual page for guestfish.");
5417 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5423 This is used to view a file.
5425 The default viewer is C<$PAGER>. However if you use the alternate
5426 command C<less> you will get the C<less> command specifically.");
5428 ("reopen", (RErr,[], []), -1, [], [],
5429 "close and reopen libguestfs handle",
5432 Close and reopen the libguestfs handle. It is not necessary to use
5433 this normally, because the handle is closed properly when guestfish
5434 exits. However this is occasionally useful for testing.");
5436 ("sparse", (RErr,[], []), -1, [], [],
5437 "create a sparse disk image and add",
5438 " sparse filename size
5440 This creates an empty sparse file of the given size, and then adds
5441 so it can be further examined.
5443 In all respects it works the same as the L</alloc> command, except that
5444 the image file is allocated sparsely, which means that disk blocks are
5445 not assigned to the file until they are needed. Sparse disk files
5446 only use space when written to, but they are slower and there is a
5447 danger you could run out of real disk space during a write operation.
5449 For more advanced image creation, see L<qemu-img(1)> utility.
5451 Size can be specified using standard suffixes, eg. C<1M>.");
5453 ("supported", (RErr,[], []), -1, [], [],
5454 "list supported groups of commands",
5457 This command returns a list of the optional groups
5458 known to the daemon, and indicates which ones are
5459 supported by this build of the libguestfs appliance.
5461 See also L<guestfs(3)/AVAILABILITY>.");
5463 ("time", (RErr,[], []), -1, [], [],
5464 "print elapsed time taken to run a command",
5465 " time command args...
5467 Run the command as usual, but print the elapsed time afterwards. This
5468 can be useful for benchmarking operations.");