2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter C<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form C<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to run C<guestfs_umount_all> followed by
286 C<guestfs_sync> when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
308 ("get_verbose", (RBool "verbose", [], []), -1, [],
312 This returns the verbose messages flag.");
314 ("is_ready", (RBool "ready", [], []), -1, [],
315 [InitNone, Always, TestOutputTrue (
317 "is ready to accept commands",
319 This returns true iff this handle is ready to accept commands
320 (in the C<READY> state).
322 For more information on states, see L<guestfs(3)>.");
324 ("is_config", (RBool "config", [], []), -1, [],
325 [InitNone, Always, TestOutputFalse (
327 "is in configuration state",
329 This returns true iff this handle is being configured
330 (in the C<CONFIG> state).
332 For more information on states, see L<guestfs(3)>.");
334 ("is_launching", (RBool "launching", [], []), -1, [],
335 [InitNone, Always, TestOutputFalse (
336 [["is_launching"]])],
337 "is launching subprocess",
339 This returns true iff this handle is launching the subprocess
340 (in the C<LAUNCHING> state).
342 For more information on states, see L<guestfs(3)>.");
344 ("is_busy", (RBool "busy", [], []), -1, [],
345 [InitNone, Always, TestOutputFalse (
347 "is busy processing a command",
349 This returns true iff this handle is busy processing a command
350 (in the C<BUSY> state).
352 For more information on states, see L<guestfs(3)>.");
354 ("get_state", (RInt "state", [], []), -1, [],
356 "get the current state",
358 This returns the current state as an opaque integer. This is
359 only useful for printing debug and internal error messages.
361 For more information on states, see L<guestfs(3)>.");
363 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
364 [InitNone, Always, TestOutputInt (
365 [["set_memsize"; "500"];
366 ["get_memsize"]], 500)],
367 "set memory allocated to the qemu subprocess",
369 This sets the memory size in megabytes allocated to the
370 qemu subprocess. This only has any effect if called before
373 You can also change this by setting the environment
374 variable C<LIBGUESTFS_MEMSIZE> before the handle is
377 For more information on the architecture of libguestfs,
378 see L<guestfs(3)>.");
380 ("get_memsize", (RInt "memsize", [], []), -1, [],
381 [InitNone, Always, TestOutputIntOp (
382 [["get_memsize"]], ">=", 256)],
383 "get memory allocated to the qemu subprocess",
385 This gets the memory size in megabytes allocated to the
388 If C<guestfs_set_memsize> was not called
389 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
390 then this returns the compiled-in default value for memsize.
392 For more information on the architecture of libguestfs,
393 see L<guestfs(3)>.");
395 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
396 [InitNone, Always, TestOutputIntOp (
397 [["get_pid"]], ">=", 1)],
398 "get PID of qemu subprocess",
400 Return the process ID of the qemu subprocess. If there is no
401 qemu subprocess, then this will return an error.
403 This is an internal call used for debugging and testing.");
405 ("version", (RStruct ("version", "version"), [], []), -1, [],
406 [InitNone, Always, TestOutputStruct (
407 [["version"]], [CompareWithInt ("major", 1)])],
408 "get the library version number",
410 Return the libguestfs version number that the program is linked
413 Note that because of dynamic linking this is not necessarily
414 the version of libguestfs that you compiled against. You can
415 compile the program, and then at runtime dynamically link
416 against a completely different C<libguestfs.so> library.
418 This call was added in version C<1.0.58>. In previous
419 versions of libguestfs there was no way to get the version
420 number. From C code you can use dynamic linker functions
421 to find out if this symbol exists (if it doesn't, then
422 it's an earlier version).
424 The call returns a structure with four elements. The first
425 three (C<major>, C<minor> and C<release>) are numbers and
426 correspond to the usual version triplet. The fourth element
427 (C<extra>) is a string and is normally empty, but may be
428 used for distro-specific information.
430 To construct the original version string:
431 C<$major.$minor.$release$extra>
433 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
435 I<Note:> Don't use this call to test for availability
436 of features. In enterprise distributions we backport
437 features from later versions into earlier versions,
438 making this an unreliable way to test for features.
439 Use C<guestfs_available> instead.");
441 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
442 [InitNone, Always, TestOutputTrue (
443 [["set_selinux"; "true"];
445 "set SELinux enabled or disabled at appliance boot",
447 This sets the selinux flag that is passed to the appliance
448 at boot time. The default is C<selinux=0> (disabled).
450 Note that if SELinux is enabled, it is always in
451 Permissive mode (C<enforcing=0>).
453 For more information on the architecture of libguestfs,
454 see L<guestfs(3)>.");
456 ("get_selinux", (RBool "selinux", [], []), -1, [],
458 "get SELinux enabled flag",
460 This returns the current setting of the selinux flag which
461 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
463 For more information on the architecture of libguestfs,
464 see L<guestfs(3)>.");
466 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
467 [InitNone, Always, TestOutputFalse (
468 [["set_trace"; "false"];
470 "enable or disable command traces",
472 If the command trace flag is set to 1, then commands are
473 printed on stderr before they are executed in a format
474 which is very similar to the one used by guestfish. In
475 other words, you can run a program with this enabled, and
476 you will get out a script which you can feed to guestfish
477 to perform the same set of actions.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
486 ("get_trace", (RBool "trace", [], []), -1, [],
488 "get command trace enabled flag",
490 Return the command trace flag.");
492 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
493 [InitNone, Always, TestOutputFalse (
494 [["set_direct"; "false"];
496 "enable or disable direct appliance mode",
498 If the direct appliance mode flag is enabled, then stdin and
499 stdout are passed directly through to the appliance once it
502 One consequence of this is that log messages aren't caught
503 by the library and handled by C<guestfs_set_log_message_callback>,
504 but go straight to stdout.
506 You probably don't want to use this unless you know what you
509 The default is disabled.");
511 ("get_direct", (RBool "direct", [], []), -1, [],
513 "get direct appliance mode flag",
515 Return the direct appliance mode flag.");
517 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
518 [InitNone, Always, TestOutputTrue (
519 [["set_recovery_proc"; "true"];
520 ["get_recovery_proc"]])],
521 "enable or disable the recovery process",
523 If this is called with the parameter C<false> then
524 C<guestfs_launch> does not create a recovery process. The
525 purpose of the recovery process is to stop runaway qemu
526 processes in the case where the main program aborts abruptly.
528 This only has any effect if called before C<guestfs_launch>,
529 and the default is true.
531 About the only time when you would want to disable this is
532 if the main process will fork itself into the background
533 (\"daemonize\" itself). In this case the recovery process
534 thinks that the main program has disappeared and so kills
535 qemu, which is not very helpful.");
537 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
539 "get recovery process enabled flag",
541 Return the recovery process enabled flag.");
543 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
545 "add a drive specifying the QEMU block emulation to use",
547 This is the same as C<guestfs_add_drive> but it allows you
548 to specify the QEMU interface emulation to use at run time.");
550 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
552 "add a drive read-only specifying the QEMU block emulation to use",
554 This is the same as C<guestfs_add_drive_ro> but it allows you
555 to specify the QEMU interface emulation to use at run time.");
557 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
558 [InitISOFS, Always, TestOutput (
559 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
560 InitISOFS, Always, TestOutput (
561 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
562 InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-win32.exe"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/lib-i586.so"]], "i386");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/lib-sparc.so"]], "sparc");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-win32.dll"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
582 "detect the architecture of a binary file",
584 This detects the architecture of the binary C<filename>,
585 and returns it if known.
587 Currently defined architectures are:
593 This string is returned for all 32 bit i386, i486, i586, i686 binaries
594 irrespective of the precise processor requirements of the binary.
606 64 bit SPARC V9 and above.
622 Libguestfs may return other architecture strings in future.
624 The function works on at least the following types of files:
630 many types of Un*x and Linux binary
634 many types of Un*x and Linux shared library
638 Windows Win32 and Win64 binaries
642 Windows Win32 and Win64 DLLs
644 Win32 binaries and DLLs return C<i386>.
646 Win64 binaries and DLLs return C<x86_64>.
654 Linux new-style initrd images
658 some non-x86 Linux vmlinuz kernels
662 What it can't do currently:
668 static libraries (libfoo.a)
672 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
676 x86 Linux vmlinuz kernels
678 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
679 compressed code, and are horribly hard to unpack. If you want to find
680 the architecture of a kernel, use the architecture of the associated
681 initrd or kernel module(s) instead.
685 ("inspect_os", (RStringList "roots", [], []), -1, [],
687 "inspect disk and return list of operating systems found",
689 This function uses other libguestfs functions and certain
690 heuristics to inspect the disk(s) (usually disks belonging to
691 a virtual machine), looking for operating systems.
693 The list returned is empty if no operating systems were found.
695 If one operating system was found, then this returns a list with
696 a single element, which is the name of the root filesystem of
697 this operating system. It is also possible for this function
698 to return a list containing more than one element, indicating
699 a dual-boot or multi-boot virtual machine, with each element being
700 the root filesystem of one of the operating systems.
702 You can pass the root string(s) returned to other
703 C<guestfs_inspect_get_*> functions in order to query further
704 information about each operating system, such as the name
707 This function uses other libguestfs features such as
708 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
709 and unmount filesystems and look at the contents. This should
710 be called with no disks currently mounted. The function may also
711 use Augeas, so any existing Augeas handle will be closed.
713 This function cannot decrypt encrypted disks. The caller
714 must do that first (supplying the necessary keys) if the
717 Please read L<guestfs(3)/INSPECTION> for more details.
719 See also C<guestfs_list_filesystems>.");
721 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
723 "get type of inspected operating system",
725 This function should only be called with a root device string
726 as returned by C<guestfs_inspect_os>.
728 This returns the type of the inspected operating system.
729 Currently defined types are:
735 Any Linux-based operating system.
739 Any Microsoft Windows operating system.
743 The operating system type could not be determined.
747 Future versions of libguestfs may return other strings here.
748 The caller should be prepared to handle any string.
750 Please read L<guestfs(3)/INSPECTION> for more details.");
752 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
754 "get architecture of inspected operating system",
756 This function should only be called with a root device string
757 as returned by C<guestfs_inspect_os>.
759 This returns the architecture of the inspected operating system.
760 The possible return values are listed under
761 C<guestfs_file_architecture>.
763 If the architecture could not be determined, then the
764 string C<unknown> is returned.
766 Please read L<guestfs(3)/INSPECTION> for more details.");
768 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
770 "get distro of inspected operating system",
772 This function should only be called with a root device string
773 as returned by C<guestfs_inspect_os>.
775 This returns the distro (distribution) of the inspected operating
778 Currently defined distros are:
788 Debian or a Debian-derived distro such as Ubuntu.
798 =item \"redhat-based\"
800 Some Red Hat-derived distro.
804 Red Hat Enterprise Linux and some derivatives.
808 Windows does not have distributions. This string is
809 returned if the OS type is Windows.
813 The distro could not be determined.
817 Future versions of libguestfs may return other strings here.
818 The caller should be prepared to handle any string.
820 Please read L<guestfs(3)/INSPECTION> for more details.");
822 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
824 "get major version of inspected operating system",
826 This function should only be called with a root device string
827 as returned by C<guestfs_inspect_os>.
829 This returns the major version number of the inspected operating
832 Windows uses a consistent versioning scheme which is I<not>
833 reflected in the popular public names used by the operating system.
834 Notably the operating system known as \"Windows 7\" is really
835 version 6.1 (ie. major = 6, minor = 1). You can find out the
836 real versions corresponding to releases of Windows by consulting
839 If the version could not be determined, then C<0> is returned.
841 Please read L<guestfs(3)/INSPECTION> for more details.");
843 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
845 "get minor version of inspected operating system",
847 This function should only be called with a root device string
848 as returned by C<guestfs_inspect_os>.
850 This returns the minor version number of the inspected operating
853 If the version could not be determined, then C<0> is returned.
855 Please read L<guestfs(3)/INSPECTION> for more details.
856 See also C<guestfs_inspect_get_major_version>.");
858 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
860 "get product name of inspected operating system",
862 This function should only be called with a root device string
863 as returned by C<guestfs_inspect_os>.
865 This returns the product name of the inspected operating
866 system. The product name is generally some freeform string
867 which can be displayed to the user, but should not be
870 If the product name could not be determined, then the
871 string C<unknown> is returned.
873 Please read L<guestfs(3)/INSPECTION> for more details.");
875 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
877 "get mountpoints of inspected operating system",
879 This function should only be called with a root device string
880 as returned by C<guestfs_inspect_os>.
882 This returns a hash of where we think the filesystems
883 associated with this operating system should be mounted.
884 Callers should note that this is at best an educated guess
885 made by reading configuration files such as C</etc/fstab>.
887 Each element in the returned hashtable has a key which
888 is the path of the mountpoint (eg. C</boot>) and a value
889 which is the filesystem that would be mounted there
892 Non-mounted devices such as swap devices are I<not>
893 returned in this list.
895 Please read L<guestfs(3)/INSPECTION> for more details.
896 See also C<guestfs_inspect_get_filesystems>.");
898 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
900 "get filesystems associated with inspected operating system",
902 This function should only be called with a root device string
903 as returned by C<guestfs_inspect_os>.
905 This returns a list of all the filesystems that we think
906 are associated with this operating system. This includes
907 the root filesystem, other ordinary filesystems, and
908 non-mounted devices like swap partitions.
910 In the case of a multi-boot virtual machine, it is possible
911 for a filesystem to be shared between operating systems.
913 Please read L<guestfs(3)/INSPECTION> for more details.
914 See also C<guestfs_inspect_get_mountpoints>.");
916 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
918 "set enable network flag",
920 If C<network> is true, then the network is enabled in the
921 libguestfs appliance. The default is false.
923 This affects whether commands are able to access the network
924 (see L<guestfs(3)/RUNNING COMMANDS>).
926 You must call this before calling C<guestfs_launch>, otherwise
929 ("get_network", (RBool "network", [], []), -1, [],
931 "get enable network flag",
933 This returns the enable network flag.");
935 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
939 This inspection command looks for filesystems on partitions,
940 block devices and logical volumes, returning a list of devices
941 containing filesystems and their type.
943 The return value is a hash, where the keys are the devices
944 containing filesystems, and the values are the filesystem types.
947 \"/dev/sda1\" => \"ntfs\"
948 \"/dev/sda2\" => \"ext2\"
949 \"/dev/vg_guest/lv_root\" => \"ext4\"
950 \"/dev/vg_guest/lv_swap\" => \"swap\"
952 The value can have the special value \"unknown\", meaning the
953 content of the device is undetermined or empty.
954 \"swap\" means a Linux swap partition.
956 This command runs other libguestfs commands, which might include
957 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
958 use this soon after launch and only when nothing is mounted.
960 Not all of the filesystems returned will be mountable. In
961 particular, swap partitions are returned in the list. Also
962 this command does not check that each filesystem
963 found is valid and mountable, and some filesystems might
964 be mountable but require special options. Filesystems may
965 not all belong to a single logical operating system
966 (use C<guestfs_inspect_os> to look for OSes).");
968 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
970 "add an image to examine or modify",
972 This function adds a virtual machine disk image C<filename> to
973 libguestfs. The first time you call this function, the disk
974 appears as C</dev/sda>, the second time as C</dev/sdb>, and
977 You don't necessarily need to be root when using libguestfs. However
978 you obviously do need sufficient permissions to access the filename
979 for whatever operations you want to perform (ie. read access if you
980 just want to read the image or write access if you want to modify the
983 This call checks that C<filename> exists.
985 The optional arguments are:
991 If true then the image is treated as read-only. Writes are still
992 allowed, but they are stored in a temporary snapshot overlay which
993 is discarded at the end. The disk that you add is not modified.
997 This forces the image format. If you omit this (or use C<guestfs_add_drive>
998 or C<guestfs_add_drive_ro>) then the format is automatically detected.
999 Possible formats include C<raw> and C<qcow2>.
1001 Automatic detection of the format opens you up to a potential
1002 security hole when dealing with untrusted raw-format images.
1003 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1008 This rarely-used option lets you emulate the behaviour of the
1009 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1013 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1015 "get Windows systemroot of inspected operating system",
1017 This function should only be called with a root device string
1018 as returned by C<guestfs_inspect_os>.
1020 This returns the Windows systemroot of the inspected guest.
1021 The systemroot is a directory path such as C</WINDOWS>.
1023 This call assumes that the guest is Windows and that the
1024 systemroot could be determined by inspection. If this is not
1025 the case then an error is returned.
1027 Please read L<guestfs(3)/INSPECTION> for more details.");
1031 (* daemon_functions are any functions which cause some action
1032 * to take place in the daemon.
1035 let daemon_functions = [
1036 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1037 [InitEmpty, Always, TestOutput (
1038 [["part_disk"; "/dev/sda"; "mbr"];
1039 ["mkfs"; "ext2"; "/dev/sda1"];
1040 ["mount"; "/dev/sda1"; "/"];
1041 ["write"; "/new"; "new file contents"];
1042 ["cat"; "/new"]], "new file contents")],
1043 "mount a guest disk at a position in the filesystem",
1045 Mount a guest disk at a position in the filesystem. Block devices
1046 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1047 the guest. If those block devices contain partitions, they will have
1048 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1051 The rules are the same as for L<mount(2)>: A filesystem must
1052 first be mounted on C</> before others can be mounted. Other
1053 filesystems can only be mounted on directories which already
1056 The mounted filesystem is writable, if we have sufficient permissions
1057 on the underlying device.
1060 When you use this call, the filesystem options C<sync> and C<noatime>
1061 are set implicitly. This was originally done because we thought it
1062 would improve reliability, but it turns out that I<-o sync> has a
1063 very large negative performance impact and negligible effect on
1064 reliability. Therefore we recommend that you avoid using
1065 C<guestfs_mount> in any code that needs performance, and instead
1066 use C<guestfs_mount_options> (use an empty string for the first
1067 parameter if you don't want any options).");
1069 ("sync", (RErr, [], []), 2, [],
1070 [ InitEmpty, Always, TestRun [["sync"]]],
1071 "sync disks, writes are flushed through to the disk image",
1073 This syncs the disk, so that any writes are flushed through to the
1074 underlying disk image.
1076 You should always call this if you have modified a disk image, before
1077 closing the handle.");
1079 ("touch", (RErr, [Pathname "path"], []), 3, [],
1080 [InitBasicFS, Always, TestOutputTrue (
1082 ["exists"; "/new"]])],
1083 "update file timestamps or create a new file",
1085 Touch acts like the L<touch(1)> command. It can be used to
1086 update the timestamps on a file, or, if the file does not exist,
1087 to create a new zero-length file.
1089 This command only works on regular files, and will fail on other
1090 file types such as directories, symbolic links, block special etc.");
1092 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1093 [InitISOFS, Always, TestOutput (
1094 [["cat"; "/known-2"]], "abcdef\n")],
1095 "list the contents of a file",
1097 Return the contents of the file named C<path>.
1099 Note that this function cannot correctly handle binary files
1100 (specifically, files containing C<\\0> character which is treated
1101 as end of string). For those you need to use the C<guestfs_read_file>
1102 or C<guestfs_download> functions which have a more complex interface.");
1104 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1105 [], (* XXX Tricky to test because it depends on the exact format
1106 * of the 'ls -l' command, which changes between F10 and F11.
1108 "list the files in a directory (long format)",
1110 List the files in C<directory> (relative to the root directory,
1111 there is no cwd) in the format of 'ls -la'.
1113 This command is mostly useful for interactive sessions. It
1114 is I<not> intended that you try to parse the output string.");
1116 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1117 [InitBasicFS, Always, TestOutputList (
1119 ["touch"; "/newer"];
1120 ["touch"; "/newest"];
1121 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1122 "list the files in a directory",
1124 List the files in C<directory> (relative to the root directory,
1125 there is no cwd). The '.' and '..' entries are not returned, but
1126 hidden files are shown.
1128 This command is mostly useful for interactive sessions. Programs
1129 should probably use C<guestfs_readdir> instead.");
1131 ("list_devices", (RStringList "devices", [], []), 7, [],
1132 [InitEmpty, Always, TestOutputListOfDevices (
1133 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1134 "list the block devices",
1136 List all the block devices.
1138 The full block device names are returned, eg. C</dev/sda>.
1140 See also C<guestfs_list_filesystems>.");
1142 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1143 [InitBasicFS, Always, TestOutputListOfDevices (
1144 [["list_partitions"]], ["/dev/sda1"]);
1145 InitEmpty, Always, TestOutputListOfDevices (
1146 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1147 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1148 "list the partitions",
1150 List all the partitions detected on all block devices.
1152 The full partition device names are returned, eg. C</dev/sda1>
1154 This does not return logical volumes. For that you will need to
1155 call C<guestfs_lvs>.
1157 See also C<guestfs_list_filesystems>.");
1159 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1160 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1161 [["pvs"]], ["/dev/sda1"]);
1162 InitEmpty, Always, TestOutputListOfDevices (
1163 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1164 ["pvcreate"; "/dev/sda1"];
1165 ["pvcreate"; "/dev/sda2"];
1166 ["pvcreate"; "/dev/sda3"];
1167 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1168 "list the LVM physical volumes (PVs)",
1170 List all the physical volumes detected. This is the equivalent
1171 of the L<pvs(8)> command.
1173 This returns a list of just the device names that contain
1174 PVs (eg. C</dev/sda2>).
1176 See also C<guestfs_pvs_full>.");
1178 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1179 [InitBasicFSonLVM, Always, TestOutputList (
1181 InitEmpty, Always, TestOutputList (
1182 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1183 ["pvcreate"; "/dev/sda1"];
1184 ["pvcreate"; "/dev/sda2"];
1185 ["pvcreate"; "/dev/sda3"];
1186 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1187 ["vgcreate"; "VG2"; "/dev/sda3"];
1188 ["vgs"]], ["VG1"; "VG2"])],
1189 "list the LVM volume groups (VGs)",
1191 List all the volumes groups detected. This is the equivalent
1192 of the L<vgs(8)> command.
1194 This returns a list of just the volume group names that were
1195 detected (eg. C<VolGroup00>).
1197 See also C<guestfs_vgs_full>.");
1199 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1200 [InitBasicFSonLVM, Always, TestOutputList (
1201 [["lvs"]], ["/dev/VG/LV"]);
1202 InitEmpty, Always, TestOutputList (
1203 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1204 ["pvcreate"; "/dev/sda1"];
1205 ["pvcreate"; "/dev/sda2"];
1206 ["pvcreate"; "/dev/sda3"];
1207 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1208 ["vgcreate"; "VG2"; "/dev/sda3"];
1209 ["lvcreate"; "LV1"; "VG1"; "50"];
1210 ["lvcreate"; "LV2"; "VG1"; "50"];
1211 ["lvcreate"; "LV3"; "VG2"; "50"];
1212 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1213 "list the LVM logical volumes (LVs)",
1215 List all the logical volumes detected. This is the equivalent
1216 of the L<lvs(8)> command.
1218 This returns a list of the logical volume device names
1219 (eg. C</dev/VolGroup00/LogVol00>).
1221 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1223 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1224 [], (* XXX how to test? *)
1225 "list the LVM physical volumes (PVs)",
1227 List all the physical volumes detected. This is the equivalent
1228 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1230 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1231 [], (* XXX how to test? *)
1232 "list the LVM volume groups (VGs)",
1234 List all the volumes groups detected. This is the equivalent
1235 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1237 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1238 [], (* XXX how to test? *)
1239 "list the LVM logical volumes (LVs)",
1241 List all the logical volumes detected. This is the equivalent
1242 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1244 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1245 [InitISOFS, Always, TestOutputList (
1246 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1247 InitISOFS, Always, TestOutputList (
1248 [["read_lines"; "/empty"]], [])],
1249 "read file as lines",
1251 Return the contents of the file named C<path>.
1253 The file contents are returned as a list of lines. Trailing
1254 C<LF> and C<CRLF> character sequences are I<not> returned.
1256 Note that this function cannot correctly handle binary files
1257 (specifically, files containing C<\\0> character which is treated
1258 as end of line). For those you need to use the C<guestfs_read_file>
1259 function which has a more complex interface.");
1261 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1262 [], (* XXX Augeas code needs tests. *)
1263 "create a new Augeas handle",
1265 Create a new Augeas handle for editing configuration files.
1266 If there was any previous Augeas handle associated with this
1267 guestfs session, then it is closed.
1269 You must call this before using any other C<guestfs_aug_*>
1272 C<root> is the filesystem root. C<root> must not be NULL,
1275 The flags are the same as the flags defined in
1276 E<lt>augeas.hE<gt>, the logical I<or> of the following
1281 =item C<AUG_SAVE_BACKUP> = 1
1283 Keep the original file with a C<.augsave> extension.
1285 =item C<AUG_SAVE_NEWFILE> = 2
1287 Save changes into a file with extension C<.augnew>, and
1288 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1290 =item C<AUG_TYPE_CHECK> = 4
1292 Typecheck lenses (can be expensive).
1294 =item C<AUG_NO_STDINC> = 8
1296 Do not use standard load path for modules.
1298 =item C<AUG_SAVE_NOOP> = 16
1300 Make save a no-op, just record what would have been changed.
1302 =item C<AUG_NO_LOAD> = 32
1304 Do not load the tree in C<guestfs_aug_init>.
1308 To close the handle, you can call C<guestfs_aug_close>.
1310 To find out more about Augeas, see L<http://augeas.net/>.");
1312 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1313 [], (* XXX Augeas code needs tests. *)
1314 "close the current Augeas handle",
1316 Close the current Augeas handle and free up any resources
1317 used by it. After calling this, you have to call
1318 C<guestfs_aug_init> again before you can use any other
1319 Augeas functions.");
1321 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1322 [], (* XXX Augeas code needs tests. *)
1323 "define an Augeas variable",
1325 Defines an Augeas variable C<name> whose value is the result
1326 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1329 On success this returns the number of nodes in C<expr>, or
1330 C<0> if C<expr> evaluates to something which is not a nodeset.");
1332 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1333 [], (* XXX Augeas code needs tests. *)
1334 "define an Augeas node",
1336 Defines a variable C<name> whose value is the result of
1339 If C<expr> evaluates to an empty nodeset, a node is created,
1340 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1341 C<name> will be the nodeset containing that single node.
1343 On success this returns a pair containing the
1344 number of nodes in the nodeset, and a boolean flag
1345 if a node was created.");
1347 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1348 [], (* XXX Augeas code needs tests. *)
1349 "look up the value of an Augeas path",
1351 Look up the value associated with C<path>. If C<path>
1352 matches exactly one node, the C<value> is returned.");
1354 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1355 [], (* XXX Augeas code needs tests. *)
1356 "set Augeas path to value",
1358 Set the value associated with C<path> to C<val>.
1360 In the Augeas API, it is possible to clear a node by setting
1361 the value to NULL. Due to an oversight in the libguestfs API
1362 you cannot do that with this call. Instead you must use the
1363 C<guestfs_aug_clear> call.");
1365 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1366 [], (* XXX Augeas code needs tests. *)
1367 "insert a sibling Augeas node",
1369 Create a new sibling C<label> for C<path>, inserting it into
1370 the tree before or after C<path> (depending on the boolean
1373 C<path> must match exactly one existing node in the tree, and
1374 C<label> must be a label, ie. not contain C</>, C<*> or end
1375 with a bracketed index C<[N]>.");
1377 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1378 [], (* XXX Augeas code needs tests. *)
1379 "remove an Augeas path",
1381 Remove C<path> and all of its children.
1383 On success this returns the number of entries which were removed.");
1385 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1386 [], (* XXX Augeas code needs tests. *)
1389 Move the node C<src> to C<dest>. C<src> must match exactly
1390 one node. C<dest> is overwritten if it exists.");
1392 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1393 [], (* XXX Augeas code needs tests. *)
1394 "return Augeas nodes which match augpath",
1396 Returns a list of paths which match the path expression C<path>.
1397 The returned paths are sufficiently qualified so that they match
1398 exactly one node in the current tree.");
1400 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1401 [], (* XXX Augeas code needs tests. *)
1402 "write all pending Augeas changes to disk",
1404 This writes all pending changes to disk.
1406 The flags which were passed to C<guestfs_aug_init> affect exactly
1407 how files are saved.");
1409 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1410 [], (* XXX Augeas code needs tests. *)
1411 "load files into the tree",
1413 Load files into the tree.
1415 See C<aug_load> in the Augeas documentation for the full gory
1418 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1419 [], (* XXX Augeas code needs tests. *)
1420 "list Augeas nodes under augpath",
1422 This is just a shortcut for listing C<guestfs_aug_match>
1423 C<path/*> and sorting the resulting nodes into alphabetical order.");
1425 ("rm", (RErr, [Pathname "path"], []), 29, [],
1426 [InitBasicFS, Always, TestRun
1429 InitBasicFS, Always, TestLastFail
1431 InitBasicFS, Always, TestLastFail
1436 Remove the single file C<path>.");
1438 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1439 [InitBasicFS, Always, TestRun
1442 InitBasicFS, Always, TestLastFail
1443 [["rmdir"; "/new"]];
1444 InitBasicFS, Always, TestLastFail
1446 ["rmdir"; "/new"]]],
1447 "remove a directory",
1449 Remove the single directory C<path>.");
1451 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1452 [InitBasicFS, Always, TestOutputFalse
1454 ["mkdir"; "/new/foo"];
1455 ["touch"; "/new/foo/bar"];
1457 ["exists"; "/new"]]],
1458 "remove a file or directory recursively",
1460 Remove the file or directory C<path>, recursively removing the
1461 contents if its a directory. This is like the C<rm -rf> shell
1464 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1465 [InitBasicFS, Always, TestOutputTrue
1467 ["is_dir"; "/new"]];
1468 InitBasicFS, Always, TestLastFail
1469 [["mkdir"; "/new/foo/bar"]]],
1470 "create a directory",
1472 Create a directory named C<path>.");
1474 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1475 [InitBasicFS, Always, TestOutputTrue
1476 [["mkdir_p"; "/new/foo/bar"];
1477 ["is_dir"; "/new/foo/bar"]];
1478 InitBasicFS, Always, TestOutputTrue
1479 [["mkdir_p"; "/new/foo/bar"];
1480 ["is_dir"; "/new/foo"]];
1481 InitBasicFS, Always, TestOutputTrue
1482 [["mkdir_p"; "/new/foo/bar"];
1483 ["is_dir"; "/new"]];
1484 (* Regression tests for RHBZ#503133: *)
1485 InitBasicFS, Always, TestRun
1487 ["mkdir_p"; "/new"]];
1488 InitBasicFS, Always, TestLastFail
1490 ["mkdir_p"; "/new"]]],
1491 "create a directory and parents",
1493 Create a directory named C<path>, creating any parent directories
1494 as necessary. This is like the C<mkdir -p> shell command.");
1496 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1497 [], (* XXX Need stat command to test *)
1500 Change the mode (permissions) of C<path> to C<mode>. Only
1501 numeric modes are supported.
1503 I<Note>: When using this command from guestfish, C<mode>
1504 by default would be decimal, unless you prefix it with
1505 C<0> to get octal, ie. use C<0700> not C<700>.
1507 The mode actually set is affected by the umask.");
1509 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1510 [], (* XXX Need stat command to test *)
1511 "change file owner and group",
1513 Change the file owner to C<owner> and group to C<group>.
1515 Only numeric uid and gid are supported. If you want to use
1516 names, you will need to locate and parse the password file
1517 yourself (Augeas support makes this relatively easy).");
1519 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1520 [InitISOFS, Always, TestOutputTrue (
1521 [["exists"; "/empty"]]);
1522 InitISOFS, Always, TestOutputTrue (
1523 [["exists"; "/directory"]])],
1524 "test if file or directory exists",
1526 This returns C<true> if and only if there is a file, directory
1527 (or anything) with the given C<path> name.
1529 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1531 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1532 [InitISOFS, Always, TestOutputTrue (
1533 [["is_file"; "/known-1"]]);
1534 InitISOFS, Always, TestOutputFalse (
1535 [["is_file"; "/directory"]])],
1536 "test if a regular file",
1538 This returns C<true> if and only if there is a regular file
1539 with the given C<path> name. Note that it returns false for
1540 other objects like directories.
1542 See also C<guestfs_stat>.");
1544 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1545 [InitISOFS, Always, TestOutputFalse (
1546 [["is_dir"; "/known-3"]]);
1547 InitISOFS, Always, TestOutputTrue (
1548 [["is_dir"; "/directory"]])],
1549 "test if a directory",
1551 This returns C<true> if and only if there is a directory
1552 with the given C<path> name. Note that it returns false for
1553 other objects like files.
1555 See also C<guestfs_stat>.");
1557 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1558 [InitEmpty, Always, TestOutputListOfDevices (
1559 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1560 ["pvcreate"; "/dev/sda1"];
1561 ["pvcreate"; "/dev/sda2"];
1562 ["pvcreate"; "/dev/sda3"];
1563 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1564 "create an LVM physical volume",
1566 This creates an LVM physical volume on the named C<device>,
1567 where C<device> should usually be a partition name such
1570 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1571 [InitEmpty, Always, TestOutputList (
1572 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1573 ["pvcreate"; "/dev/sda1"];
1574 ["pvcreate"; "/dev/sda2"];
1575 ["pvcreate"; "/dev/sda3"];
1576 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1577 ["vgcreate"; "VG2"; "/dev/sda3"];
1578 ["vgs"]], ["VG1"; "VG2"])],
1579 "create an LVM volume group",
1581 This creates an LVM volume group called C<volgroup>
1582 from the non-empty list of physical volumes C<physvols>.");
1584 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1585 [InitEmpty, Always, TestOutputList (
1586 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1587 ["pvcreate"; "/dev/sda1"];
1588 ["pvcreate"; "/dev/sda2"];
1589 ["pvcreate"; "/dev/sda3"];
1590 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1591 ["vgcreate"; "VG2"; "/dev/sda3"];
1592 ["lvcreate"; "LV1"; "VG1"; "50"];
1593 ["lvcreate"; "LV2"; "VG1"; "50"];
1594 ["lvcreate"; "LV3"; "VG2"; "50"];
1595 ["lvcreate"; "LV4"; "VG2"; "50"];
1596 ["lvcreate"; "LV5"; "VG2"; "50"];
1598 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1599 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1600 "create an LVM logical volume",
1602 This creates an LVM logical volume called C<logvol>
1603 on the volume group C<volgroup>, with C<size> megabytes.");
1605 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1606 [InitEmpty, Always, TestOutput (
1607 [["part_disk"; "/dev/sda"; "mbr"];
1608 ["mkfs"; "ext2"; "/dev/sda1"];
1609 ["mount_options"; ""; "/dev/sda1"; "/"];
1610 ["write"; "/new"; "new file contents"];
1611 ["cat"; "/new"]], "new file contents")],
1612 "make a filesystem",
1614 This creates a filesystem on C<device> (usually a partition
1615 or LVM logical volume). The filesystem type is C<fstype>, for
1618 ("sfdisk", (RErr, [Device "device";
1619 Int "cyls"; Int "heads"; Int "sectors";
1620 StringList "lines"], []), 43, [DangerWillRobinson],
1622 "create partitions on a block device",
1624 This is a direct interface to the L<sfdisk(8)> program for creating
1625 partitions on block devices.
1627 C<device> should be a block device, for example C</dev/sda>.
1629 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1630 and sectors on the device, which are passed directly to sfdisk as
1631 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1632 of these, then the corresponding parameter is omitted. Usually for
1633 'large' disks, you can just pass C<0> for these, but for small
1634 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1635 out the right geometry and you will need to tell it.
1637 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1638 information refer to the L<sfdisk(8)> manpage.
1640 To create a single partition occupying the whole disk, you would
1641 pass C<lines> as a single element list, when the single element being
1642 the string C<,> (comma).
1644 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1645 C<guestfs_part_init>");
1647 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1648 (* Regression test for RHBZ#597135. *)
1649 [InitBasicFS, Always, TestLastFail
1650 [["write_file"; "/new"; "abc"; "10000"]]],
1653 This call creates a file called C<path>. The contents of the
1654 file is the string C<content> (which can contain any 8 bit data),
1655 with length C<size>.
1657 As a special case, if C<size> is C<0>
1658 then the length is calculated using C<strlen> (so in this case
1659 the content cannot contain embedded ASCII NULs).
1661 I<NB.> Owing to a bug, writing content containing ASCII NUL
1662 characters does I<not> work, even if the length is specified.");
1664 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1665 [InitEmpty, Always, TestOutputListOfDevices (
1666 [["part_disk"; "/dev/sda"; "mbr"];
1667 ["mkfs"; "ext2"; "/dev/sda1"];
1668 ["mount_options"; ""; "/dev/sda1"; "/"];
1669 ["mounts"]], ["/dev/sda1"]);
1670 InitEmpty, Always, TestOutputList (
1671 [["part_disk"; "/dev/sda"; "mbr"];
1672 ["mkfs"; "ext2"; "/dev/sda1"];
1673 ["mount_options"; ""; "/dev/sda1"; "/"];
1676 "unmount a filesystem",
1678 This unmounts the given filesystem. The filesystem may be
1679 specified either by its mountpoint (path) or the device which
1680 contains the filesystem.");
1682 ("mounts", (RStringList "devices", [], []), 46, [],
1683 [InitBasicFS, Always, TestOutputListOfDevices (
1684 [["mounts"]], ["/dev/sda1"])],
1685 "show mounted filesystems",
1687 This returns the list of currently mounted filesystems. It returns
1688 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1690 Some internal mounts are not shown.
1692 See also: C<guestfs_mountpoints>");
1694 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1695 [InitBasicFS, Always, TestOutputList (
1698 (* check that umount_all can unmount nested mounts correctly: *)
1699 InitEmpty, Always, TestOutputList (
1700 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1701 ["mkfs"; "ext2"; "/dev/sda1"];
1702 ["mkfs"; "ext2"; "/dev/sda2"];
1703 ["mkfs"; "ext2"; "/dev/sda3"];
1704 ["mount_options"; ""; "/dev/sda1"; "/"];
1706 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1707 ["mkdir"; "/mp1/mp2"];
1708 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1709 ["mkdir"; "/mp1/mp2/mp3"];
1712 "unmount all filesystems",
1714 This unmounts all mounted filesystems.
1716 Some internal mounts are not unmounted by this call.");
1718 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1720 "remove all LVM LVs, VGs and PVs",
1722 This command removes all LVM logical volumes, volume groups
1723 and physical volumes.");
1725 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
1726 [InitISOFS, Always, TestOutput (
1727 [["file"; "/empty"]], "empty");
1728 InitISOFS, Always, TestOutput (
1729 [["file"; "/known-1"]], "ASCII text");
1730 InitISOFS, Always, TestLastFail (
1731 [["file"; "/notexists"]]);
1732 InitISOFS, Always, TestOutput (
1733 [["file"; "/abssymlink"]], "symbolic link");
1734 InitISOFS, Always, TestOutput (
1735 [["file"; "/directory"]], "directory")],
1736 "determine file type",
1738 This call uses the standard L<file(1)> command to determine
1739 the type or contents of the file.
1741 This call will also transparently look inside various types
1744 The exact command which runs is C<file -zb path>. Note in
1745 particular that the filename is not prepended to the output
1748 This command can also be used on C</dev/> devices
1749 (and partitions, LV names). You can for example use this
1750 to determine if a device contains a filesystem, although
1751 it's usually better to use C<guestfs_vfs_type>.
1753 If the C<path> does not begin with C</dev/> then
1754 this command only works for the content of regular files.
1755 For other file types (directory, symbolic link etc) it
1756 will just return the string C<directory> etc.");
1758 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
1759 [InitBasicFS, Always, TestOutput (
1760 [["upload"; "test-command"; "/test-command"];
1761 ["chmod"; "0o755"; "/test-command"];
1762 ["command"; "/test-command 1"]], "Result1");
1763 InitBasicFS, Always, TestOutput (
1764 [["upload"; "test-command"; "/test-command"];
1765 ["chmod"; "0o755"; "/test-command"];
1766 ["command"; "/test-command 2"]], "Result2\n");
1767 InitBasicFS, Always, TestOutput (
1768 [["upload"; "test-command"; "/test-command"];
1769 ["chmod"; "0o755"; "/test-command"];
1770 ["command"; "/test-command 3"]], "\nResult3");
1771 InitBasicFS, Always, TestOutput (
1772 [["upload"; "test-command"; "/test-command"];
1773 ["chmod"; "0o755"; "/test-command"];
1774 ["command"; "/test-command 4"]], "\nResult4\n");
1775 InitBasicFS, Always, TestOutput (
1776 [["upload"; "test-command"; "/test-command"];
1777 ["chmod"; "0o755"; "/test-command"];
1778 ["command"; "/test-command 5"]], "\nResult5\n\n");
1779 InitBasicFS, Always, TestOutput (
1780 [["upload"; "test-command"; "/test-command"];
1781 ["chmod"; "0o755"; "/test-command"];
1782 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1783 InitBasicFS, Always, TestOutput (
1784 [["upload"; "test-command"; "/test-command"];
1785 ["chmod"; "0o755"; "/test-command"];
1786 ["command"; "/test-command 7"]], "");
1787 InitBasicFS, Always, TestOutput (
1788 [["upload"; "test-command"; "/test-command"];
1789 ["chmod"; "0o755"; "/test-command"];
1790 ["command"; "/test-command 8"]], "\n");
1791 InitBasicFS, Always, TestOutput (
1792 [["upload"; "test-command"; "/test-command"];
1793 ["chmod"; "0o755"; "/test-command"];
1794 ["command"; "/test-command 9"]], "\n\n");
1795 InitBasicFS, Always, TestOutput (
1796 [["upload"; "test-command"; "/test-command"];
1797 ["chmod"; "0o755"; "/test-command"];
1798 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1799 InitBasicFS, Always, TestOutput (
1800 [["upload"; "test-command"; "/test-command"];
1801 ["chmod"; "0o755"; "/test-command"];
1802 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1803 InitBasicFS, Always, TestLastFail (
1804 [["upload"; "test-command"; "/test-command"];
1805 ["chmod"; "0o755"; "/test-command"];
1806 ["command"; "/test-command"]])],
1807 "run a command from the guest filesystem",
1809 This call runs a command from the guest filesystem. The
1810 filesystem must be mounted, and must contain a compatible
1811 operating system (ie. something Linux, with the same
1812 or compatible processor architecture).
1814 The single parameter is an argv-style list of arguments.
1815 The first element is the name of the program to run.
1816 Subsequent elements are parameters. The list must be
1817 non-empty (ie. must contain a program name). Note that
1818 the command runs directly, and is I<not> invoked via
1819 the shell (see C<guestfs_sh>).
1821 The return value is anything printed to I<stdout> by
1824 If the command returns a non-zero exit status, then
1825 this function returns an error message. The error message
1826 string is the content of I<stderr> from the command.
1828 The C<$PATH> environment variable will contain at least
1829 C</usr/bin> and C</bin>. If you require a program from
1830 another location, you should provide the full path in the
1833 Shared libraries and data files required by the program
1834 must be available on filesystems which are mounted in the
1835 correct places. It is the caller's responsibility to ensure
1836 all filesystems that are needed are mounted at the right
1839 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
1840 [InitBasicFS, Always, TestOutputList (
1841 [["upload"; "test-command"; "/test-command"];
1842 ["chmod"; "0o755"; "/test-command"];
1843 ["command_lines"; "/test-command 1"]], ["Result1"]);
1844 InitBasicFS, Always, TestOutputList (
1845 [["upload"; "test-command"; "/test-command"];
1846 ["chmod"; "0o755"; "/test-command"];
1847 ["command_lines"; "/test-command 2"]], ["Result2"]);
1848 InitBasicFS, Always, TestOutputList (
1849 [["upload"; "test-command"; "/test-command"];
1850 ["chmod"; "0o755"; "/test-command"];
1851 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1852 InitBasicFS, Always, TestOutputList (
1853 [["upload"; "test-command"; "/test-command"];
1854 ["chmod"; "0o755"; "/test-command"];
1855 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1856 InitBasicFS, Always, TestOutputList (
1857 [["upload"; "test-command"; "/test-command"];
1858 ["chmod"; "0o755"; "/test-command"];
1859 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1860 InitBasicFS, Always, TestOutputList (
1861 [["upload"; "test-command"; "/test-command"];
1862 ["chmod"; "0o755"; "/test-command"];
1863 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1864 InitBasicFS, Always, TestOutputList (
1865 [["upload"; "test-command"; "/test-command"];
1866 ["chmod"; "0o755"; "/test-command"];
1867 ["command_lines"; "/test-command 7"]], []);
1868 InitBasicFS, Always, TestOutputList (
1869 [["upload"; "test-command"; "/test-command"];
1870 ["chmod"; "0o755"; "/test-command"];
1871 ["command_lines"; "/test-command 8"]], [""]);
1872 InitBasicFS, Always, TestOutputList (
1873 [["upload"; "test-command"; "/test-command"];
1874 ["chmod"; "0o755"; "/test-command"];
1875 ["command_lines"; "/test-command 9"]], ["";""]);
1876 InitBasicFS, Always, TestOutputList (
1877 [["upload"; "test-command"; "/test-command"];
1878 ["chmod"; "0o755"; "/test-command"];
1879 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1880 InitBasicFS, Always, TestOutputList (
1881 [["upload"; "test-command"; "/test-command"];
1882 ["chmod"; "0o755"; "/test-command"];
1883 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1884 "run a command, returning lines",
1886 This is the same as C<guestfs_command>, but splits the
1887 result into a list of lines.
1889 See also: C<guestfs_sh_lines>");
1891 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
1892 [InitISOFS, Always, TestOutputStruct (
1893 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1894 "get file information",
1896 Returns file information for the given C<path>.
1898 This is the same as the C<stat(2)> system call.");
1900 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
1901 [InitISOFS, Always, TestOutputStruct (
1902 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1903 "get file information for a symbolic link",
1905 Returns file information for the given C<path>.
1907 This is the same as C<guestfs_stat> except that if C<path>
1908 is a symbolic link, then the link is stat-ed, not the file it
1911 This is the same as the C<lstat(2)> system call.");
1913 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
1914 [InitISOFS, Always, TestOutputStruct (
1915 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1916 "get file system statistics",
1918 Returns file system statistics for any mounted file system.
1919 C<path> should be a file or directory in the mounted file system
1920 (typically it is the mount point itself, but it doesn't need to be).
1922 This is the same as the C<statvfs(2)> system call.");
1924 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
1926 "get ext2/ext3/ext4 superblock details",
1928 This returns the contents of the ext2, ext3 or ext4 filesystem
1929 superblock on C<device>.
1931 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1932 manpage for more details. The list of fields returned isn't
1933 clearly defined, and depends on both the version of C<tune2fs>
1934 that libguestfs was built against, and the filesystem itself.");
1936 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
1937 [InitEmpty, Always, TestOutputTrue (
1938 [["blockdev_setro"; "/dev/sda"];
1939 ["blockdev_getro"; "/dev/sda"]])],
1940 "set block device to read-only",
1942 Sets the block device named C<device> to read-only.
1944 This uses the L<blockdev(8)> command.");
1946 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
1947 [InitEmpty, Always, TestOutputFalse (
1948 [["blockdev_setrw"; "/dev/sda"];
1949 ["blockdev_getro"; "/dev/sda"]])],
1950 "set block device to read-write",
1952 Sets the block device named C<device> to read-write.
1954 This uses the L<blockdev(8)> command.");
1956 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
1957 [InitEmpty, Always, TestOutputTrue (
1958 [["blockdev_setro"; "/dev/sda"];
1959 ["blockdev_getro"; "/dev/sda"]])],
1960 "is block device set to read-only",
1962 Returns a boolean indicating if the block device is read-only
1963 (true if read-only, false if not).
1965 This uses the L<blockdev(8)> command.");
1967 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
1968 [InitEmpty, Always, TestOutputInt (
1969 [["blockdev_getss"; "/dev/sda"]], 512)],
1970 "get sectorsize of block device",
1972 This returns the size of sectors on a block device.
1973 Usually 512, but can be larger for modern devices.
1975 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1978 This uses the L<blockdev(8)> command.");
1980 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
1981 [InitEmpty, Always, TestOutputInt (
1982 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1983 "get blocksize of block device",
1985 This returns the block size of a device.
1987 (Note this is different from both I<size in blocks> and
1988 I<filesystem block size>).
1990 This uses the L<blockdev(8)> command.");
1992 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
1994 "set blocksize of block device",
1996 This sets the block size of a device.
1998 (Note this is different from both I<size in blocks> and
1999 I<filesystem block size>).
2001 This uses the L<blockdev(8)> command.");
2003 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2004 [InitEmpty, Always, TestOutputInt (
2005 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2006 "get total size of device in 512-byte sectors",
2008 This returns the size of the device in units of 512-byte sectors
2009 (even if the sectorsize isn't 512 bytes ... weird).
2011 See also C<guestfs_blockdev_getss> for the real sector size of
2012 the device, and C<guestfs_blockdev_getsize64> for the more
2013 useful I<size in bytes>.
2015 This uses the L<blockdev(8)> command.");
2017 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2018 [InitEmpty, Always, TestOutputInt (
2019 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2020 "get total size of device in bytes",
2022 This returns the size of the device in bytes.
2024 See also C<guestfs_blockdev_getsz>.
2026 This uses the L<blockdev(8)> command.");
2028 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2029 [InitEmpty, Always, TestRun
2030 [["blockdev_flushbufs"; "/dev/sda"]]],
2031 "flush device buffers",
2033 This tells the kernel to flush internal buffers associated
2036 This uses the L<blockdev(8)> command.");
2038 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2039 [InitEmpty, Always, TestRun
2040 [["blockdev_rereadpt"; "/dev/sda"]]],
2041 "reread partition table",
2043 Reread the partition table on C<device>.
2045 This uses the L<blockdev(8)> command.");
2047 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2048 [InitBasicFS, Always, TestOutput (
2049 (* Pick a file from cwd which isn't likely to change. *)
2050 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2051 ["checksum"; "md5"; "/COPYING.LIB"]],
2052 Digest.to_hex (Digest.file "COPYING.LIB"))],
2053 "upload a file from the local machine",
2055 Upload local file C<filename> to C<remotefilename> on the
2058 C<filename> can also be a named pipe.
2060 See also C<guestfs_download>.");
2062 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2063 [InitBasicFS, Always, TestOutput (
2064 (* Pick a file from cwd which isn't likely to change. *)
2065 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2066 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2067 ["upload"; "testdownload.tmp"; "/upload"];
2068 ["checksum"; "md5"; "/upload"]],
2069 Digest.to_hex (Digest.file "COPYING.LIB"))],
2070 "download a file to the local machine",
2072 Download file C<remotefilename> and save it as C<filename>
2073 on the local machine.
2075 C<filename> can also be a named pipe.
2077 See also C<guestfs_upload>, C<guestfs_cat>.");
2079 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2080 [InitISOFS, Always, TestOutput (
2081 [["checksum"; "crc"; "/known-3"]], "2891671662");
2082 InitISOFS, Always, TestLastFail (
2083 [["checksum"; "crc"; "/notexists"]]);
2084 InitISOFS, Always, TestOutput (
2085 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2086 InitISOFS, Always, TestOutput (
2087 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2088 InitISOFS, Always, TestOutput (
2089 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2090 InitISOFS, Always, TestOutput (
2091 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2092 InitISOFS, Always, TestOutput (
2093 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2094 InitISOFS, Always, TestOutput (
2095 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2096 (* Test for RHBZ#579608, absolute symbolic links. *)
2097 InitISOFS, Always, TestOutput (
2098 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2099 "compute MD5, SHAx or CRC checksum of file",
2101 This call computes the MD5, SHAx or CRC checksum of the
2104 The type of checksum to compute is given by the C<csumtype>
2105 parameter which must have one of the following values:
2111 Compute the cyclic redundancy check (CRC) specified by POSIX
2112 for the C<cksum> command.
2116 Compute the MD5 hash (using the C<md5sum> program).
2120 Compute the SHA1 hash (using the C<sha1sum> program).
2124 Compute the SHA224 hash (using the C<sha224sum> program).
2128 Compute the SHA256 hash (using the C<sha256sum> program).
2132 Compute the SHA384 hash (using the C<sha384sum> program).
2136 Compute the SHA512 hash (using the C<sha512sum> program).
2140 The checksum is returned as a printable string.
2142 To get the checksum for a device, use C<guestfs_checksum_device>.
2144 To get the checksums for many files, use C<guestfs_checksums_out>.");
2146 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2147 [InitBasicFS, Always, TestOutput (
2148 [["tar_in"; "../images/helloworld.tar"; "/"];
2149 ["cat"; "/hello"]], "hello\n")],
2150 "unpack tarfile to directory",
2152 This command uploads and unpacks local file C<tarfile> (an
2153 I<uncompressed> tar file) into C<directory>.
2155 To upload a compressed tarball, use C<guestfs_tgz_in>
2156 or C<guestfs_txz_in>.");
2158 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2160 "pack directory into tarfile",
2162 This command packs the contents of C<directory> and downloads
2163 it to local file C<tarfile>.
2165 To download a compressed tarball, use C<guestfs_tgz_out>
2166 or C<guestfs_txz_out>.");
2168 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2169 [InitBasicFS, Always, TestOutput (
2170 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2171 ["cat"; "/hello"]], "hello\n")],
2172 "unpack compressed tarball to directory",
2174 This command uploads and unpacks local file C<tarball> (a
2175 I<gzip compressed> tar file) into C<directory>.
2177 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2179 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2181 "pack directory into compressed tarball",
2183 This command packs the contents of C<directory> and downloads
2184 it to local file C<tarball>.
2186 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2188 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2189 [InitBasicFS, Always, TestLastFail (
2191 ["mount_ro"; "/dev/sda1"; "/"];
2192 ["touch"; "/new"]]);
2193 InitBasicFS, Always, TestOutput (
2194 [["write"; "/new"; "data"];
2196 ["mount_ro"; "/dev/sda1"; "/"];
2197 ["cat"; "/new"]], "data")],
2198 "mount a guest disk, read-only",
2200 This is the same as the C<guestfs_mount> command, but it
2201 mounts the filesystem with the read-only (I<-o ro>) flag.");
2203 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2205 "mount a guest disk with mount options",
2207 This is the same as the C<guestfs_mount> command, but it
2208 allows you to set the mount options as for the
2209 L<mount(8)> I<-o> flag.
2211 If the C<options> parameter is an empty string, then
2212 no options are passed (all options default to whatever
2213 the filesystem uses).");
2215 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2217 "mount a guest disk with mount options and vfstype",
2219 This is the same as the C<guestfs_mount> command, but it
2220 allows you to set both the mount options and the vfstype
2221 as for the L<mount(8)> I<-o> and I<-t> flags.");
2223 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [],
2225 "debugging and internals",
2227 The C<guestfs_debug> command exposes some internals of
2228 C<guestfsd> (the guestfs daemon) that runs inside the
2231 There is no comprehensive help for this command. You have
2232 to look at the file C<daemon/debug.c> in the libguestfs source
2233 to find out what you can do.");
2235 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2236 [InitEmpty, Always, TestOutputList (
2237 [["part_disk"; "/dev/sda"; "mbr"];
2238 ["pvcreate"; "/dev/sda1"];
2239 ["vgcreate"; "VG"; "/dev/sda1"];
2240 ["lvcreate"; "LV1"; "VG"; "50"];
2241 ["lvcreate"; "LV2"; "VG"; "50"];
2242 ["lvremove"; "/dev/VG/LV1"];
2243 ["lvs"]], ["/dev/VG/LV2"]);
2244 InitEmpty, Always, TestOutputList (
2245 [["part_disk"; "/dev/sda"; "mbr"];
2246 ["pvcreate"; "/dev/sda1"];
2247 ["vgcreate"; "VG"; "/dev/sda1"];
2248 ["lvcreate"; "LV1"; "VG"; "50"];
2249 ["lvcreate"; "LV2"; "VG"; "50"];
2250 ["lvremove"; "/dev/VG"];
2252 InitEmpty, Always, TestOutputList (
2253 [["part_disk"; "/dev/sda"; "mbr"];
2254 ["pvcreate"; "/dev/sda1"];
2255 ["vgcreate"; "VG"; "/dev/sda1"];
2256 ["lvcreate"; "LV1"; "VG"; "50"];
2257 ["lvcreate"; "LV2"; "VG"; "50"];
2258 ["lvremove"; "/dev/VG"];
2260 "remove an LVM logical volume",
2262 Remove an LVM logical volume C<device>, where C<device> is
2263 the path to the LV, such as C</dev/VG/LV>.
2265 You can also remove all LVs in a volume group by specifying
2266 the VG name, C</dev/VG>.");
2268 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2269 [InitEmpty, Always, TestOutputList (
2270 [["part_disk"; "/dev/sda"; "mbr"];
2271 ["pvcreate"; "/dev/sda1"];
2272 ["vgcreate"; "VG"; "/dev/sda1"];
2273 ["lvcreate"; "LV1"; "VG"; "50"];
2274 ["lvcreate"; "LV2"; "VG"; "50"];
2277 InitEmpty, Always, TestOutputList (
2278 [["part_disk"; "/dev/sda"; "mbr"];
2279 ["pvcreate"; "/dev/sda1"];
2280 ["vgcreate"; "VG"; "/dev/sda1"];
2281 ["lvcreate"; "LV1"; "VG"; "50"];
2282 ["lvcreate"; "LV2"; "VG"; "50"];
2285 "remove an LVM volume group",
2287 Remove an LVM volume group C<vgname>, (for example C<VG>).
2289 This also forcibly removes all logical volumes in the volume
2292 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2293 [InitEmpty, Always, TestOutputListOfDevices (
2294 [["part_disk"; "/dev/sda"; "mbr"];
2295 ["pvcreate"; "/dev/sda1"];
2296 ["vgcreate"; "VG"; "/dev/sda1"];
2297 ["lvcreate"; "LV1"; "VG"; "50"];
2298 ["lvcreate"; "LV2"; "VG"; "50"];
2300 ["pvremove"; "/dev/sda1"];
2302 InitEmpty, Always, TestOutputListOfDevices (
2303 [["part_disk"; "/dev/sda"; "mbr"];
2304 ["pvcreate"; "/dev/sda1"];
2305 ["vgcreate"; "VG"; "/dev/sda1"];
2306 ["lvcreate"; "LV1"; "VG"; "50"];
2307 ["lvcreate"; "LV2"; "VG"; "50"];
2309 ["pvremove"; "/dev/sda1"];
2311 InitEmpty, Always, TestOutputListOfDevices (
2312 [["part_disk"; "/dev/sda"; "mbr"];
2313 ["pvcreate"; "/dev/sda1"];
2314 ["vgcreate"; "VG"; "/dev/sda1"];
2315 ["lvcreate"; "LV1"; "VG"; "50"];
2316 ["lvcreate"; "LV2"; "VG"; "50"];
2318 ["pvremove"; "/dev/sda1"];
2320 "remove an LVM physical volume",
2322 This wipes a physical volume C<device> so that LVM will no longer
2325 The implementation uses the C<pvremove> command which refuses to
2326 wipe physical volumes that contain any volume groups, so you have
2327 to remove those first.");
2329 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2330 [InitBasicFS, Always, TestOutput (
2331 [["set_e2label"; "/dev/sda1"; "testlabel"];
2332 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2333 "set the ext2/3/4 filesystem label",
2335 This sets the ext2/3/4 filesystem label of the filesystem on
2336 C<device> to C<label>. Filesystem labels are limited to
2339 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2340 to return the existing label on a filesystem.");
2342 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2344 "get the ext2/3/4 filesystem label",
2346 This returns the ext2/3/4 filesystem label of the filesystem on
2349 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2350 (let uuid = uuidgen () in
2351 [InitBasicFS, Always, TestOutput (
2352 [["set_e2uuid"; "/dev/sda1"; uuid];
2353 ["get_e2uuid"; "/dev/sda1"]], uuid);
2354 InitBasicFS, Always, TestOutput (
2355 [["set_e2uuid"; "/dev/sda1"; "clear"];
2356 ["get_e2uuid"; "/dev/sda1"]], "");
2357 (* We can't predict what UUIDs will be, so just check the commands run. *)
2358 InitBasicFS, Always, TestRun (
2359 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2360 InitBasicFS, Always, TestRun (
2361 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2362 "set the ext2/3/4 filesystem UUID",
2364 This sets the ext2/3/4 filesystem UUID of the filesystem on
2365 C<device> to C<uuid>. The format of the UUID and alternatives
2366 such as C<clear>, C<random> and C<time> are described in the
2367 L<tune2fs(8)> manpage.
2369 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2370 to return the existing UUID of a filesystem.");
2372 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2373 (* Regression test for RHBZ#597112. *)
2374 (let uuid = uuidgen () in
2375 [InitBasicFS, Always, TestOutput (
2376 [["mke2journal"; "1024"; "/dev/sdb"];
2377 ["set_e2uuid"; "/dev/sdb"; uuid];
2378 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2379 "get the ext2/3/4 filesystem UUID",
2381 This returns the ext2/3/4 filesystem UUID of the filesystem on
2384 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2385 [InitBasicFS, Always, TestOutputInt (
2386 [["umount"; "/dev/sda1"];
2387 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2388 InitBasicFS, Always, TestOutputInt (
2389 [["umount"; "/dev/sda1"];
2390 ["zero"; "/dev/sda1"];
2391 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2392 "run the filesystem checker",
2394 This runs the filesystem checker (fsck) on C<device> which
2395 should have filesystem type C<fstype>.
2397 The returned integer is the status. See L<fsck(8)> for the
2398 list of status codes from C<fsck>.
2406 Multiple status codes can be summed together.
2410 A non-zero return code can mean \"success\", for example if
2411 errors have been corrected on the filesystem.
2415 Checking or repairing NTFS volumes is not supported
2420 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2422 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2423 [InitBasicFS, Always, TestOutput (
2424 [["umount"; "/dev/sda1"];
2425 ["zero"; "/dev/sda1"];
2426 ["file"; "/dev/sda1"]], "data")],
2427 "write zeroes to the device",
2429 This command writes zeroes over the first few blocks of C<device>.
2431 How many blocks are zeroed isn't specified (but it's I<not> enough
2432 to securely wipe the device). It should be sufficient to remove
2433 any partition tables, filesystem superblocks and so on.
2435 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2437 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2439 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2440 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2442 [InitBasicFS, Always, TestOutputTrue (
2443 [["mkdir_p"; "/boot/grub"];
2444 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2445 ["grub_install"; "/"; "/dev/vda"];
2446 ["is_dir"; "/boot"]])],
2449 This command installs GRUB (the Grand Unified Bootloader) on
2450 C<device>, with the root directory being C<root>.
2452 Note: If grub-install reports the error
2453 \"No suitable drive was found in the generated device map.\"
2454 it may be that you need to create a C</boot/grub/device.map>
2455 file first that contains the mapping between grub device names
2456 and Linux device names. It is usually sufficient to create
2461 replacing C</dev/vda> with the name of the installation device.");
2463 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2464 [InitBasicFS, Always, TestOutput (
2465 [["write"; "/old"; "file content"];
2466 ["cp"; "/old"; "/new"];
2467 ["cat"; "/new"]], "file content");
2468 InitBasicFS, Always, TestOutputTrue (
2469 [["write"; "/old"; "file content"];
2470 ["cp"; "/old"; "/new"];
2471 ["is_file"; "/old"]]);
2472 InitBasicFS, Always, TestOutput (
2473 [["write"; "/old"; "file content"];
2475 ["cp"; "/old"; "/dir/new"];
2476 ["cat"; "/dir/new"]], "file content")],
2479 This copies a file from C<src> to C<dest> where C<dest> is
2480 either a destination filename or destination directory.");
2482 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2483 [InitBasicFS, Always, TestOutput (
2484 [["mkdir"; "/olddir"];
2485 ["mkdir"; "/newdir"];
2486 ["write"; "/olddir/file"; "file content"];
2487 ["cp_a"; "/olddir"; "/newdir"];
2488 ["cat"; "/newdir/olddir/file"]], "file content")],
2489 "copy a file or directory recursively",
2491 This copies a file or directory from C<src> to C<dest>
2492 recursively using the C<cp -a> command.");
2494 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2495 [InitBasicFS, Always, TestOutput (
2496 [["write"; "/old"; "file content"];
2497 ["mv"; "/old"; "/new"];
2498 ["cat"; "/new"]], "file content");
2499 InitBasicFS, Always, TestOutputFalse (
2500 [["write"; "/old"; "file content"];
2501 ["mv"; "/old"; "/new"];
2502 ["is_file"; "/old"]])],
2505 This moves a file from C<src> to C<dest> where C<dest> is
2506 either a destination filename or destination directory.");
2508 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2509 [InitEmpty, Always, TestRun (
2510 [["drop_caches"; "3"]])],
2511 "drop kernel page cache, dentries and inodes",
2513 This instructs the guest kernel to drop its page cache,
2514 and/or dentries and inode caches. The parameter C<whattodrop>
2515 tells the kernel what precisely to drop, see
2516 L<http://linux-mm.org/Drop_Caches>
2518 Setting C<whattodrop> to 3 should drop everything.
2520 This automatically calls L<sync(2)> before the operation,
2521 so that the maximum guest memory is freed.");
2523 ("dmesg", (RString "kmsgs", [], []), 91, [],
2524 [InitEmpty, Always, TestRun (
2526 "return kernel messages",
2528 This returns the kernel messages (C<dmesg> output) from
2529 the guest kernel. This is sometimes useful for extended
2530 debugging of problems.
2532 Another way to get the same information is to enable
2533 verbose messages with C<guestfs_set_verbose> or by setting
2534 the environment variable C<LIBGUESTFS_DEBUG=1> before
2535 running the program.");
2537 ("ping_daemon", (RErr, [], []), 92, [],
2538 [InitEmpty, Always, TestRun (
2539 [["ping_daemon"]])],
2540 "ping the guest daemon",
2542 This is a test probe into the guestfs daemon running inside
2543 the qemu subprocess. Calling this function checks that the
2544 daemon responds to the ping message, without affecting the daemon
2545 or attached block device(s) in any other way.");
2547 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2548 [InitBasicFS, Always, TestOutputTrue (
2549 [["write"; "/file1"; "contents of a file"];
2550 ["cp"; "/file1"; "/file2"];
2551 ["equal"; "/file1"; "/file2"]]);
2552 InitBasicFS, Always, TestOutputFalse (
2553 [["write"; "/file1"; "contents of a file"];
2554 ["write"; "/file2"; "contents of another file"];
2555 ["equal"; "/file1"; "/file2"]]);
2556 InitBasicFS, Always, TestLastFail (
2557 [["equal"; "/file1"; "/file2"]])],
2558 "test if two files have equal contents",
2560 This compares the two files C<file1> and C<file2> and returns
2561 true if their content is exactly equal, or false otherwise.
2563 The external L<cmp(1)> program is used for the comparison.");
2565 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2566 [InitISOFS, Always, TestOutputList (
2567 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2568 InitISOFS, Always, TestOutputList (
2569 [["strings"; "/empty"]], []);
2570 (* Test for RHBZ#579608, absolute symbolic links. *)
2571 InitISOFS, Always, TestRun (
2572 [["strings"; "/abssymlink"]])],
2573 "print the printable strings in a file",
2575 This runs the L<strings(1)> command on a file and returns
2576 the list of printable strings found.");
2578 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2579 [InitISOFS, Always, TestOutputList (
2580 [["strings_e"; "b"; "/known-5"]], []);
2581 InitBasicFS, Always, TestOutputList (
2582 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2583 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2584 "print the printable strings in a file",
2586 This is like the C<guestfs_strings> command, but allows you to
2587 specify the encoding of strings that are looked for in
2588 the source file C<path>.
2590 Allowed encodings are:
2596 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2597 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2601 Single 8-bit-byte characters.
2605 16-bit big endian strings such as those encoded in
2606 UTF-16BE or UCS-2BE.
2608 =item l (lower case letter L)
2610 16-bit little endian such as UTF-16LE and UCS-2LE.
2611 This is useful for examining binaries in Windows guests.
2615 32-bit big endian such as UCS-4BE.
2619 32-bit little endian such as UCS-4LE.
2623 The returned strings are transcoded to UTF-8.");
2625 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2626 [InitISOFS, Always, TestOutput (
2627 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2628 (* Test for RHBZ#501888c2 regression which caused large hexdump
2629 * commands to segfault.
2631 InitISOFS, Always, TestRun (
2632 [["hexdump"; "/100krandom"]]);
2633 (* Test for RHBZ#579608, absolute symbolic links. *)
2634 InitISOFS, Always, TestRun (
2635 [["hexdump"; "/abssymlink"]])],
2636 "dump a file in hexadecimal",
2638 This runs C<hexdump -C> on the given C<path>. The result is
2639 the human-readable, canonical hex dump of the file.");
2641 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2642 [InitNone, Always, TestOutput (
2643 [["part_disk"; "/dev/sda"; "mbr"];
2644 ["mkfs"; "ext3"; "/dev/sda1"];
2645 ["mount_options"; ""; "/dev/sda1"; "/"];
2646 ["write"; "/new"; "test file"];
2647 ["umount"; "/dev/sda1"];
2648 ["zerofree"; "/dev/sda1"];
2649 ["mount_options"; ""; "/dev/sda1"; "/"];
2650 ["cat"; "/new"]], "test file")],
2651 "zero unused inodes and disk blocks on ext2/3 filesystem",
2653 This runs the I<zerofree> program on C<device>. This program
2654 claims to zero unused inodes and disk blocks on an ext2/3
2655 filesystem, thus making it possible to compress the filesystem
2658 You should B<not> run this program if the filesystem is
2661 It is possible that using this program can damage the filesystem
2662 or data on the filesystem.");
2664 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2666 "resize an LVM physical volume",
2668 This resizes (expands or shrinks) an existing LVM physical
2669 volume to match the new size of the underlying device.");
2671 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2672 Int "cyls"; Int "heads"; Int "sectors";
2673 String "line"], []), 99, [DangerWillRobinson],
2675 "modify a single partition on a block device",
2677 This runs L<sfdisk(8)> option to modify just the single
2678 partition C<n> (note: C<n> counts from 1).
2680 For other parameters, see C<guestfs_sfdisk>. You should usually
2681 pass C<0> for the cyls/heads/sectors parameters.
2683 See also: C<guestfs_part_add>");
2685 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2687 "display the partition table",
2689 This displays the partition table on C<device>, in the
2690 human-readable output of the L<sfdisk(8)> command. It is
2691 not intended to be parsed.
2693 See also: C<guestfs_part_list>");
2695 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2697 "display the kernel geometry",
2699 This displays the kernel's idea of the geometry of C<device>.
2701 The result is in human-readable format, and not designed to
2704 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2706 "display the disk geometry from the partition table",
2708 This displays the disk geometry of C<device> read from the
2709 partition table. Especially in the case where the underlying
2710 block device has been resized, this can be different from the
2711 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2713 The result is in human-readable format, and not designed to
2716 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2718 "activate or deactivate all volume groups",
2720 This command activates or (if C<activate> is false) deactivates
2721 all logical volumes in all volume groups.
2722 If activated, then they are made known to the
2723 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2724 then those devices disappear.
2726 This command is the same as running C<vgchange -a y|n>");
2728 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
2730 "activate or deactivate some volume groups",
2732 This command activates or (if C<activate> is false) deactivates
2733 all logical volumes in the listed volume groups C<volgroups>.
2734 If activated, then they are made known to the
2735 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2736 then those devices disappear.
2738 This command is the same as running C<vgchange -a y|n volgroups...>
2740 Note that if C<volgroups> is an empty list then B<all> volume groups
2741 are activated or deactivated.");
2743 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
2744 [InitNone, Always, TestOutput (
2745 [["part_disk"; "/dev/sda"; "mbr"];
2746 ["pvcreate"; "/dev/sda1"];
2747 ["vgcreate"; "VG"; "/dev/sda1"];
2748 ["lvcreate"; "LV"; "VG"; "10"];
2749 ["mkfs"; "ext2"; "/dev/VG/LV"];
2750 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2751 ["write"; "/new"; "test content"];
2753 ["lvresize"; "/dev/VG/LV"; "20"];
2754 ["e2fsck_f"; "/dev/VG/LV"];
2755 ["resize2fs"; "/dev/VG/LV"];
2756 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2757 ["cat"; "/new"]], "test content");
2758 InitNone, Always, TestRun (
2759 (* Make an LV smaller to test RHBZ#587484. *)
2760 [["part_disk"; "/dev/sda"; "mbr"];
2761 ["pvcreate"; "/dev/sda1"];
2762 ["vgcreate"; "VG"; "/dev/sda1"];
2763 ["lvcreate"; "LV"; "VG"; "20"];
2764 ["lvresize"; "/dev/VG/LV"; "10"]])],
2765 "resize an LVM logical volume",
2767 This resizes (expands or shrinks) an existing LVM logical
2768 volume to C<mbytes>. When reducing, data in the reduced part
2771 ("resize2fs", (RErr, [Device "device"], []), 106, [],
2772 [], (* lvresize tests this *)
2773 "resize an ext2, ext3 or ext4 filesystem",
2775 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2776 the underlying device.
2778 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2779 on the C<device> before calling this command. For unknown reasons
2780 C<resize2fs> sometimes gives an error about this and sometimes not.
2781 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2782 calling this function.");
2784 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
2785 [InitBasicFS, Always, TestOutputList (
2786 [["find"; "/"]], ["lost+found"]);
2787 InitBasicFS, Always, TestOutputList (
2791 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2792 InitBasicFS, Always, TestOutputList (
2793 [["mkdir_p"; "/a/b/c"];
2794 ["touch"; "/a/b/c/d"];
2795 ["find"; "/a/b/"]], ["c"; "c/d"])],
2796 "find all files and directories",
2798 This command lists out all files and directories, recursively,
2799 starting at C<directory>. It is essentially equivalent to
2800 running the shell command C<find directory -print> but some
2801 post-processing happens on the output, described below.
2803 This returns a list of strings I<without any prefix>. Thus
2804 if the directory structure was:
2810 then the returned list from C<guestfs_find> C</tmp> would be
2818 If C<directory> is not a directory, then this command returns
2821 The returned list is sorted.
2823 See also C<guestfs_find0>.");
2825 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
2826 [], (* lvresize tests this *)
2827 "check an ext2/ext3 filesystem",
2829 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2830 filesystem checker on C<device>, noninteractively (C<-p>),
2831 even if the filesystem appears to be clean (C<-f>).
2833 This command is only needed because of C<guestfs_resize2fs>
2834 (q.v.). Normally you should use C<guestfs_fsck>.");
2836 ("sleep", (RErr, [Int "secs"], []), 109, [],
2837 [InitNone, Always, TestRun (
2839 "sleep for some seconds",
2841 Sleep for C<secs> seconds.");
2843 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
2844 [InitNone, Always, TestOutputInt (
2845 [["part_disk"; "/dev/sda"; "mbr"];
2846 ["mkfs"; "ntfs"; "/dev/sda1"];
2847 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2848 InitNone, Always, TestOutputInt (
2849 [["part_disk"; "/dev/sda"; "mbr"];
2850 ["mkfs"; "ext2"; "/dev/sda1"];
2851 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2852 "probe NTFS volume",
2854 This command runs the L<ntfs-3g.probe(8)> command which probes
2855 an NTFS C<device> for mountability. (Not all NTFS volumes can
2856 be mounted read-write, and some cannot be mounted at all).
2858 C<rw> is a boolean flag. Set it to true if you want to test
2859 if the volume can be mounted read-write. Set it to false if
2860 you want to test if the volume can be mounted read-only.
2862 The return value is an integer which C<0> if the operation
2863 would succeed, or some non-zero value documented in the
2864 L<ntfs-3g.probe(8)> manual page.");
2866 ("sh", (RString "output", [String "command"], []), 111, [],
2867 [], (* XXX needs tests *)
2868 "run a command via the shell",
2870 This call runs a command from the guest filesystem via the
2873 This is like C<guestfs_command>, but passes the command to:
2875 /bin/sh -c \"command\"
2877 Depending on the guest's shell, this usually results in
2878 wildcards being expanded, shell expressions being interpolated
2881 All the provisos about C<guestfs_command> apply to this call.");
2883 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
2884 [], (* XXX needs tests *)
2885 "run a command via the shell returning lines",
2887 This is the same as C<guestfs_sh>, but splits the result
2888 into a list of lines.
2890 See also: C<guestfs_command_lines>");
2892 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
2893 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2894 * code in stubs.c, since all valid glob patterns must start with "/".
2895 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2897 [InitBasicFS, Always, TestOutputList (
2898 [["mkdir_p"; "/a/b/c"];
2899 ["touch"; "/a/b/c/d"];
2900 ["touch"; "/a/b/c/e"];
2901 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2902 InitBasicFS, Always, TestOutputList (
2903 [["mkdir_p"; "/a/b/c"];
2904 ["touch"; "/a/b/c/d"];
2905 ["touch"; "/a/b/c/e"];
2906 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2907 InitBasicFS, Always, TestOutputList (
2908 [["mkdir_p"; "/a/b/c"];
2909 ["touch"; "/a/b/c/d"];
2910 ["touch"; "/a/b/c/e"];
2911 ["glob_expand"; "/a/*/x/*"]], [])],
2912 "expand a wildcard path",
2914 This command searches for all the pathnames matching
2915 C<pattern> according to the wildcard expansion rules
2918 If no paths match, then this returns an empty list
2919 (note: not an error).
2921 It is just a wrapper around the C L<glob(3)> function
2922 with flags C<GLOB_MARK|GLOB_BRACE>.
2923 See that manual page for more details.");
2925 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
2926 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2927 [["scrub_device"; "/dev/sdc"]])],
2928 "scrub (securely wipe) a device",
2930 This command writes patterns over C<device> to make data retrieval
2933 It is an interface to the L<scrub(1)> program. See that
2934 manual page for more details.");
2936 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
2937 [InitBasicFS, Always, TestRun (
2938 [["write"; "/file"; "content"];
2939 ["scrub_file"; "/file"]])],
2940 "scrub (securely wipe) a file",
2942 This command writes patterns over a file to make data retrieval
2945 The file is I<removed> after scrubbing.
2947 It is an interface to the L<scrub(1)> program. See that
2948 manual page for more details.");
2950 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
2951 [], (* XXX needs testing *)
2952 "scrub (securely wipe) free space",
2954 This command creates the directory C<dir> and then fills it
2955 with files until the filesystem is full, and scrubs the files
2956 as for C<guestfs_scrub_file>, and deletes them.
2957 The intention is to scrub any free space on the partition
2960 It is an interface to the L<scrub(1)> program. See that
2961 manual page for more details.");
2963 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
2964 [InitBasicFS, Always, TestRun (
2966 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2967 "create a temporary directory",
2969 This command creates a temporary directory. The
2970 C<template> parameter should be a full pathname for the
2971 temporary directory name with the final six characters being
2974 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2975 the second one being suitable for Windows filesystems.
2977 The name of the temporary directory that was created
2980 The temporary directory is created with mode 0700
2981 and is owned by root.
2983 The caller is responsible for deleting the temporary
2984 directory and its contents after use.
2986 See also: L<mkdtemp(3)>");
2988 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
2989 [InitISOFS, Always, TestOutputInt (
2990 [["wc_l"; "/10klines"]], 10000);
2991 (* Test for RHBZ#579608, absolute symbolic links. *)
2992 InitISOFS, Always, TestOutputInt (
2993 [["wc_l"; "/abssymlink"]], 10000)],
2994 "count lines in a file",
2996 This command counts the lines in a file, using the
2997 C<wc -l> external command.");
2999 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3000 [InitISOFS, Always, TestOutputInt (
3001 [["wc_w"; "/10klines"]], 10000)],
3002 "count words in a file",
3004 This command counts the words in a file, using the
3005 C<wc -w> external command.");
3007 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3008 [InitISOFS, Always, TestOutputInt (
3009 [["wc_c"; "/100kallspaces"]], 102400)],
3010 "count characters in a file",
3012 This command counts the characters in a file, using the
3013 C<wc -c> external command.");
3015 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3016 [InitISOFS, Always, TestOutputList (
3017 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3018 (* Test for RHBZ#579608, absolute symbolic links. *)
3019 InitISOFS, Always, TestOutputList (
3020 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3021 "return first 10 lines of a file",
3023 This command returns up to the first 10 lines of a file as
3024 a list of strings.");
3026 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3027 [InitISOFS, Always, TestOutputList (
3028 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3029 InitISOFS, Always, TestOutputList (
3030 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3031 InitISOFS, Always, TestOutputList (
3032 [["head_n"; "0"; "/10klines"]], [])],
3033 "return first N lines of a file",
3035 If the parameter C<nrlines> is a positive number, this returns the first
3036 C<nrlines> lines of the file C<path>.
3038 If the parameter C<nrlines> is a negative number, this returns lines
3039 from the file C<path>, excluding the last C<nrlines> lines.
3041 If the parameter C<nrlines> is zero, this returns an empty list.");
3043 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3044 [InitISOFS, Always, TestOutputList (
3045 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3046 "return last 10 lines of a file",
3048 This command returns up to the last 10 lines of a file as
3049 a list of strings.");
3051 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3052 [InitISOFS, Always, TestOutputList (
3053 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3054 InitISOFS, Always, TestOutputList (
3055 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3056 InitISOFS, Always, TestOutputList (
3057 [["tail_n"; "0"; "/10klines"]], [])],
3058 "return last N lines of a file",
3060 If the parameter C<nrlines> is a positive number, this returns the last
3061 C<nrlines> lines of the file C<path>.
3063 If the parameter C<nrlines> is a negative number, this returns lines
3064 from the file C<path>, starting with the C<-nrlines>th line.
3066 If the parameter C<nrlines> is zero, this returns an empty list.");
3068 ("df", (RString "output", [], []), 125, [],
3069 [], (* XXX Tricky to test because it depends on the exact format
3070 * of the 'df' command and other imponderables.
3072 "report file system disk space usage",
3074 This command runs the C<df> command to report disk space used.
3076 This command is mostly useful for interactive sessions. It
3077 is I<not> intended that you try to parse the output string.
3078 Use C<statvfs> from programs.");
3080 ("df_h", (RString "output", [], []), 126, [],
3081 [], (* XXX Tricky to test because it depends on the exact format
3082 * of the 'df' command and other imponderables.
3084 "report file system disk space usage (human readable)",
3086 This command runs the C<df -h> command to report disk space used
3087 in human-readable format.
3089 This command is mostly useful for interactive sessions. It
3090 is I<not> intended that you try to parse the output string.
3091 Use C<statvfs> from programs.");
3093 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3094 [InitISOFS, Always, TestOutputInt (
3095 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3096 "estimate file space usage",
3098 This command runs the C<du -s> command to estimate file space
3101 C<path> can be a file or a directory. If C<path> is a directory
3102 then the estimate includes the contents of the directory and all
3103 subdirectories (recursively).
3105 The result is the estimated size in I<kilobytes>
3106 (ie. units of 1024 bytes).");
3108 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3109 [InitISOFS, Always, TestOutputList (
3110 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3111 "list files in an initrd",
3113 This command lists out files contained in an initrd.
3115 The files are listed without any initial C</> character. The
3116 files are listed in the order they appear (not necessarily
3117 alphabetical). Directory names are listed as separate items.
3119 Old Linux kernels (2.4 and earlier) used a compressed ext2
3120 filesystem as initrd. We I<only> support the newer initramfs
3121 format (compressed cpio files).");
3123 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3125 "mount a file using the loop device",
3127 This command lets you mount C<file> (a filesystem image
3128 in a file) on a mount point. It is entirely equivalent to
3129 the command C<mount -o loop file mountpoint>.");
3131 ("mkswap", (RErr, [Device "device"], []), 130, [],
3132 [InitEmpty, Always, TestRun (
3133 [["part_disk"; "/dev/sda"; "mbr"];
3134 ["mkswap"; "/dev/sda1"]])],
3135 "create a swap partition",
3137 Create a swap partition on C<device>.");
3139 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3140 [InitEmpty, Always, TestRun (
3141 [["part_disk"; "/dev/sda"; "mbr"];
3142 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3143 "create a swap partition with a label",
3145 Create a swap partition on C<device> with label C<label>.
3147 Note that you cannot attach a swap label to a block device
3148 (eg. C</dev/sda>), just to a partition. This appears to be
3149 a limitation of the kernel or swap tools.");
3151 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3152 (let uuid = uuidgen () in
3153 [InitEmpty, Always, TestRun (
3154 [["part_disk"; "/dev/sda"; "mbr"];
3155 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3156 "create a swap partition with an explicit UUID",
3158 Create a swap partition on C<device> with UUID C<uuid>.");
3160 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3161 [InitBasicFS, Always, TestOutputStruct (
3162 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3163 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3164 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3165 InitBasicFS, Always, TestOutputStruct (
3166 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3167 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3168 "make block, character or FIFO devices",
3170 This call creates block or character special devices, or
3171 named pipes (FIFOs).
3173 The C<mode> parameter should be the mode, using the standard
3174 constants. C<devmajor> and C<devminor> are the
3175 device major and minor numbers, only used when creating block
3176 and character special devices.
3178 Note that, just like L<mknod(2)>, the mode must be bitwise
3179 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3180 just creates a regular file). These constants are
3181 available in the standard Linux header files, or you can use
3182 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3183 which are wrappers around this command which bitwise OR
3184 in the appropriate constant for you.
3186 The mode actually set is affected by the umask.");
3188 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3189 [InitBasicFS, Always, TestOutputStruct (
3190 [["mkfifo"; "0o777"; "/node"];
3191 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3192 "make FIFO (named pipe)",
3194 This call creates a FIFO (named pipe) called C<path> with
3195 mode C<mode>. It is just a convenient wrapper around
3198 The mode actually set is affected by the umask.");
3200 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3201 [InitBasicFS, Always, TestOutputStruct (
3202 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3203 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3204 "make block device node",
3206 This call creates a block device node called C<path> with
3207 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3208 It is just a convenient wrapper around C<guestfs_mknod>.
3210 The mode actually set is affected by the umask.");
3212 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3213 [InitBasicFS, Always, TestOutputStruct (
3214 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3215 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3216 "make char device node",
3218 This call creates a char device node called C<path> with
3219 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3220 It is just a convenient wrapper around C<guestfs_mknod>.
3222 The mode actually set is affected by the umask.");
3224 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3225 [InitEmpty, Always, TestOutputInt (
3226 [["umask"; "0o22"]], 0o22)],
3227 "set file mode creation mask (umask)",
3229 This function sets the mask used for creating new files and
3230 device nodes to C<mask & 0777>.
3232 Typical umask values would be C<022> which creates new files
3233 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3234 C<002> which creates new files with permissions like
3235 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3237 The default umask is C<022>. This is important because it
3238 means that directories and device nodes will be created with
3239 C<0644> or C<0755> mode even if you specify C<0777>.
3241 See also C<guestfs_get_umask>,
3242 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3244 This call returns the previous umask.");
3246 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3248 "read directories entries",
3250 This returns the list of directory entries in directory C<dir>.
3252 All entries in the directory are returned, including C<.> and
3253 C<..>. The entries are I<not> sorted, but returned in the same
3254 order as the underlying filesystem.
3256 Also this call returns basic file type information about each
3257 file. The C<ftyp> field will contain one of the following characters:
3295 The L<readdir(3)> call returned a C<d_type> field with an
3300 This function is primarily intended for use by programs. To
3301 get a simple list of names, use C<guestfs_ls>. To get a printable
3302 directory for human consumption, use C<guestfs_ll>.");
3304 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3306 "create partitions on a block device",
3308 This is a simplified interface to the C<guestfs_sfdisk>
3309 command, where partition sizes are specified in megabytes
3310 only (rounded to the nearest cylinder) and you don't need
3311 to specify the cyls, heads and sectors parameters which
3312 were rarely if ever used anyway.
3314 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3315 and C<guestfs_part_disk>");
3317 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3319 "determine file type inside a compressed file",
3321 This command runs C<file> after first decompressing C<path>
3324 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3326 Since 1.0.63, use C<guestfs_file> instead which can now
3327 process compressed files.");
3329 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3331 "list extended attributes of a file or directory",
3333 This call lists the extended attributes of the file or directory
3336 At the system call level, this is a combination of the
3337 L<listxattr(2)> and L<getxattr(2)> calls.
3339 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3341 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3343 "list extended attributes of a file or directory",
3345 This is the same as C<guestfs_getxattrs>, but if C<path>
3346 is a symbolic link, then it returns the extended attributes
3347 of the link itself.");
3349 ("setxattr", (RErr, [String "xattr";
3350 String "val"; Int "vallen"; (* will be BufferIn *)
3351 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3353 "set extended attribute of a file or directory",
3355 This call sets the extended attribute named C<xattr>
3356 of the file C<path> to the value C<val> (of length C<vallen>).
3357 The value is arbitrary 8 bit data.
3359 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3361 ("lsetxattr", (RErr, [String "xattr";
3362 String "val"; Int "vallen"; (* will be BufferIn *)
3363 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3365 "set extended attribute of a file or directory",
3367 This is the same as C<guestfs_setxattr>, but if C<path>
3368 is a symbolic link, then it sets an extended attribute
3369 of the link itself.");
3371 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3373 "remove extended attribute of a file or directory",
3375 This call removes the extended attribute named C<xattr>
3376 of the file C<path>.
3378 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3380 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3382 "remove extended attribute of a file or directory",
3384 This is the same as C<guestfs_removexattr>, but if C<path>
3385 is a symbolic link, then it removes an extended attribute
3386 of the link itself.");
3388 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3392 This call is similar to C<guestfs_mounts>. That call returns
3393 a list of devices. This one returns a hash table (map) of
3394 device name to directory where the device is mounted.");
3396 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3397 (* This is a special case: while you would expect a parameter
3398 * of type "Pathname", that doesn't work, because it implies
3399 * NEED_ROOT in the generated calling code in stubs.c, and
3400 * this function cannot use NEED_ROOT.
3403 "create a mountpoint",
3405 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3406 specialized calls that can be used to create extra mountpoints
3407 before mounting the first filesystem.
3409 These calls are I<only> necessary in some very limited circumstances,
3410 mainly the case where you want to mount a mix of unrelated and/or
3411 read-only filesystems together.
3413 For example, live CDs often contain a \"Russian doll\" nest of
3414 filesystems, an ISO outer layer, with a squashfs image inside, with
3415 an ext2/3 image inside that. You can unpack this as follows
3418 add-ro Fedora-11-i686-Live.iso
3422 mkmountpoint /ext3fs
3424 mount-loop /cd/LiveOS/squashfs.img /sqsh
3425 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3427 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3429 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3430 You may get unexpected errors if you try to mix these calls. It is
3431 safest to manually unmount filesystems and remove mountpoints after use.
3433 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3434 longest first, so for this to work for manual mountpoints, you
3435 must ensure that the innermost mountpoints have the longest
3436 pathnames, as in the example code above.
3438 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3440 Autosync [see C<guestfs_set_autosync>, this is set by default on
3441 handles] means that C<guestfs_umount_all> is called when the handle
3442 is closed which can also trigger these issues.");
3444 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3446 "remove a mountpoint",
3448 This calls removes a mountpoint that was previously created
3449 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3450 for full details.");
3452 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3453 [InitISOFS, Always, TestOutputBuffer (
3454 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3455 (* Test various near large, large and too large files (RHBZ#589039). *)
3456 InitBasicFS, Always, TestLastFail (
3458 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3459 ["read_file"; "/a"]]);
3460 InitBasicFS, Always, TestLastFail (
3462 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3463 ["read_file"; "/a"]]);
3464 InitBasicFS, Always, TestLastFail (
3466 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3467 ["read_file"; "/a"]])],
3470 This calls returns the contents of the file C<path> as a
3473 Unlike C<guestfs_cat>, this function can correctly
3474 handle files that contain embedded ASCII NUL characters.
3475 However unlike C<guestfs_download>, this function is limited
3476 in the total size of file that can be handled.");
3478 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3479 [InitISOFS, Always, TestOutputList (
3480 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3481 InitISOFS, Always, TestOutputList (
3482 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3483 (* Test for RHBZ#579608, absolute symbolic links. *)
3484 InitISOFS, Always, TestOutputList (
3485 [["grep"; "nomatch"; "/abssymlink"]], [])],
3486 "return lines matching a pattern",
3488 This calls the external C<grep> program and returns the
3491 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3492 [InitISOFS, Always, TestOutputList (
3493 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3494 "return lines matching a pattern",
3496 This calls the external C<egrep> program and returns the
3499 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3500 [InitISOFS, Always, TestOutputList (
3501 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3502 "return lines matching a pattern",
3504 This calls the external C<fgrep> program and returns the
3507 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3508 [InitISOFS, Always, TestOutputList (
3509 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3510 "return lines matching a pattern",
3512 This calls the external C<grep -i> program and returns the
3515 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3516 [InitISOFS, Always, TestOutputList (
3517 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3518 "return lines matching a pattern",
3520 This calls the external C<egrep -i> program and returns the
3523 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3524 [InitISOFS, Always, TestOutputList (
3525 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3526 "return lines matching a pattern",
3528 This calls the external C<fgrep -i> program and returns the
3531 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3532 [InitISOFS, Always, TestOutputList (
3533 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3534 "return lines matching a pattern",
3536 This calls the external C<zgrep> program and returns the
3539 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3540 [InitISOFS, Always, TestOutputList (
3541 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3542 "return lines matching a pattern",
3544 This calls the external C<zegrep> program and returns the
3547 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3548 [InitISOFS, Always, TestOutputList (
3549 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3550 "return lines matching a pattern",
3552 This calls the external C<zfgrep> program and returns the
3555 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3556 [InitISOFS, Always, TestOutputList (
3557 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3558 "return lines matching a pattern",
3560 This calls the external C<zgrep -i> program and returns the
3563 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3564 [InitISOFS, Always, TestOutputList (
3565 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3566 "return lines matching a pattern",
3568 This calls the external C<zegrep -i> program and returns the
3571 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3572 [InitISOFS, Always, TestOutputList (
3573 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3574 "return lines matching a pattern",
3576 This calls the external C<zfgrep -i> program and returns the
3579 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3580 [InitISOFS, Always, TestOutput (
3581 [["realpath"; "/../directory"]], "/directory")],
3582 "canonicalized absolute pathname",
3584 Return the canonicalized absolute pathname of C<path>. The
3585 returned path has no C<.>, C<..> or symbolic link path elements.");
3587 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3588 [InitBasicFS, Always, TestOutputStruct (
3591 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3592 "create a hard link",
3594 This command creates a hard link using the C<ln> command.");
3596 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3597 [InitBasicFS, Always, TestOutputStruct (
3600 ["ln_f"; "/a"; "/b"];
3601 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3602 "create a hard link",
3604 This command creates a hard link using the C<ln -f> command.
3605 The C<-f> option removes the link (C<linkname>) if it exists already.");
3607 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3608 [InitBasicFS, Always, TestOutputStruct (
3610 ["ln_s"; "a"; "/b"];
3611 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3612 "create a symbolic link",
3614 This command creates a symbolic link using the C<ln -s> command.");
3616 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3617 [InitBasicFS, Always, TestOutput (
3618 [["mkdir_p"; "/a/b"];
3619 ["touch"; "/a/b/c"];
3620 ["ln_sf"; "../d"; "/a/b/c"];
3621 ["readlink"; "/a/b/c"]], "../d")],
3622 "create a symbolic link",
3624 This command creates a symbolic link using the C<ln -sf> command,
3625 The C<-f> option removes the link (C<linkname>) if it exists already.");
3627 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3628 [] (* XXX tested above *),
3629 "read the target of a symbolic link",
3631 This command reads the target of a symbolic link.");
3633 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3634 [InitBasicFS, Always, TestOutputStruct (
3635 [["fallocate"; "/a"; "1000000"];
3636 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3637 "preallocate a file in the guest filesystem",
3639 This command preallocates a file (containing zero bytes) named
3640 C<path> of size C<len> bytes. If the file exists already, it
3643 Do not confuse this with the guestfish-specific
3644 C<alloc> command which allocates a file in the host and
3645 attaches it as a device.");
3647 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3648 [InitPartition, Always, TestRun (
3649 [["mkswap"; "/dev/sda1"];
3650 ["swapon_device"; "/dev/sda1"];
3651 ["swapoff_device"; "/dev/sda1"]])],
3652 "enable swap on device",
3654 This command enables the libguestfs appliance to use the
3655 swap device or partition named C<device>. The increased
3656 memory is made available for all commands, for example
3657 those run using C<guestfs_command> or C<guestfs_sh>.
3659 Note that you should not swap to existing guest swap
3660 partitions unless you know what you are doing. They may
3661 contain hibernation information, or other information that
3662 the guest doesn't want you to trash. You also risk leaking
3663 information about the host to the guest this way. Instead,
3664 attach a new host device to the guest and swap on that.");
3666 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3667 [], (* XXX tested by swapon_device *)
3668 "disable swap on device",
3670 This command disables the libguestfs appliance swap
3671 device or partition named C<device>.
3672 See C<guestfs_swapon_device>.");
3674 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3675 [InitBasicFS, Always, TestRun (
3676 [["fallocate"; "/swap"; "8388608"];
3677 ["mkswap_file"; "/swap"];
3678 ["swapon_file"; "/swap"];
3679 ["swapoff_file"; "/swap"]])],
3680 "enable swap on file",
3682 This command enables swap to a file.
3683 See C<guestfs_swapon_device> for other notes.");
3685 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3686 [], (* XXX tested by swapon_file *)
3687 "disable swap on file",
3689 This command disables the libguestfs appliance swap on file.");
3691 ("swapon_label", (RErr, [String "label"], []), 174, [],
3692 [InitEmpty, Always, TestRun (
3693 [["part_disk"; "/dev/sdb"; "mbr"];
3694 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3695 ["swapon_label"; "swapit"];
3696 ["swapoff_label"; "swapit"];
3697 ["zero"; "/dev/sdb"];
3698 ["blockdev_rereadpt"; "/dev/sdb"]])],
3699 "enable swap on labeled swap partition",
3701 This command enables swap to a labeled swap partition.
3702 See C<guestfs_swapon_device> for other notes.");
3704 ("swapoff_label", (RErr, [String "label"], []), 175, [],
3705 [], (* XXX tested by swapon_label *)
3706 "disable swap on labeled swap partition",
3708 This command disables the libguestfs appliance swap on
3709 labeled swap partition.");
3711 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3712 (let uuid = uuidgen () in
3713 [InitEmpty, Always, TestRun (
3714 [["mkswap_U"; uuid; "/dev/sdb"];
3715 ["swapon_uuid"; uuid];
3716 ["swapoff_uuid"; uuid]])]),
3717 "enable swap on swap partition by UUID",
3719 This command enables swap to a swap partition with the given UUID.
3720 See C<guestfs_swapon_device> for other notes.");
3722 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3723 [], (* XXX tested by swapon_uuid *)
3724 "disable swap on swap partition by UUID",
3726 This command disables the libguestfs appliance swap partition
3727 with the given UUID.");
3729 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
3730 [InitBasicFS, Always, TestRun (
3731 [["fallocate"; "/swap"; "8388608"];
3732 ["mkswap_file"; "/swap"]])],
3733 "create a swap file",
3737 This command just writes a swap file signature to an existing
3738 file. To create the file itself, use something like C<guestfs_fallocate>.");
3740 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
3741 [InitISOFS, Always, TestRun (
3742 [["inotify_init"; "0"]])],
3743 "create an inotify handle",
3745 This command creates a new inotify handle.
3746 The inotify subsystem can be used to notify events which happen to
3747 objects in the guest filesystem.
3749 C<maxevents> is the maximum number of events which will be
3750 queued up between calls to C<guestfs_inotify_read> or
3751 C<guestfs_inotify_files>.
3752 If this is passed as C<0>, then the kernel (or previously set)
3753 default is used. For Linux 2.6.29 the default was 16384 events.
3754 Beyond this limit, the kernel throws away events, but records
3755 the fact that it threw them away by setting a flag
3756 C<IN_Q_OVERFLOW> in the returned structure list (see
3757 C<guestfs_inotify_read>).
3759 Before any events are generated, you have to add some
3760 watches to the internal watch list. See:
3761 C<guestfs_inotify_add_watch>,
3762 C<guestfs_inotify_rm_watch> and
3763 C<guestfs_inotify_watch_all>.
3765 Queued up events should be read periodically by calling
3766 C<guestfs_inotify_read>
3767 (or C<guestfs_inotify_files> which is just a helpful
3768 wrapper around C<guestfs_inotify_read>). If you don't
3769 read the events out often enough then you risk the internal
3772 The handle should be closed after use by calling
3773 C<guestfs_inotify_close>. This also removes any
3774 watches automatically.
3776 See also L<inotify(7)> for an overview of the inotify interface
3777 as exposed by the Linux kernel, which is roughly what we expose
3778 via libguestfs. Note that there is one global inotify handle
3779 per libguestfs instance.");
3781 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
3782 [InitBasicFS, Always, TestOutputList (
3783 [["inotify_init"; "0"];
3784 ["inotify_add_watch"; "/"; "1073741823"];
3787 ["inotify_files"]], ["a"; "b"])],
3788 "add an inotify watch",
3790 Watch C<path> for the events listed in C<mask>.
3792 Note that if C<path> is a directory then events within that
3793 directory are watched, but this does I<not> happen recursively
3794 (in subdirectories).
3796 Note for non-C or non-Linux callers: the inotify events are
3797 defined by the Linux kernel ABI and are listed in
3798 C</usr/include/sys/inotify.h>.");
3800 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
3802 "remove an inotify watch",
3804 Remove a previously defined inotify watch.
3805 See C<guestfs_inotify_add_watch>.");
3807 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
3809 "return list of inotify events",
3811 Return the complete queue of events that have happened
3812 since the previous read call.
3814 If no events have happened, this returns an empty list.
3816 I<Note>: In order to make sure that all events have been
3817 read, you must call this function repeatedly until it
3818 returns an empty list. The reason is that the call will
3819 read events up to the maximum appliance-to-host message
3820 size and leave remaining events in the queue.");
3822 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
3824 "return list of watched files that had events",
3826 This function is a helpful wrapper around C<guestfs_inotify_read>
3827 which just returns a list of pathnames of objects that were
3828 touched. The returned pathnames are sorted and deduplicated.");
3830 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
3832 "close the inotify handle",
3834 This closes the inotify handle which was previously
3835 opened by inotify_init. It removes all watches, throws
3836 away any pending events, and deallocates all resources.");
3838 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
3840 "set SELinux security context",
3842 This sets the SELinux security context of the daemon
3843 to the string C<context>.
3845 See the documentation about SELINUX in L<guestfs(3)>.");
3847 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
3849 "get SELinux security context",
3851 This gets the SELinux security context of the daemon.
3853 See the documentation about SELINUX in L<guestfs(3)>,
3854 and C<guestfs_setcon>");
3856 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
3857 [InitEmpty, Always, TestOutput (
3858 [["part_disk"; "/dev/sda"; "mbr"];
3859 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3860 ["mount_options"; ""; "/dev/sda1"; "/"];
3861 ["write"; "/new"; "new file contents"];
3862 ["cat"; "/new"]], "new file contents");
3863 InitEmpty, Always, TestRun (
3864 [["part_disk"; "/dev/sda"; "mbr"];
3865 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3866 InitEmpty, Always, TestLastFail (
3867 [["part_disk"; "/dev/sda"; "mbr"];
3868 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3869 InitEmpty, Always, TestLastFail (
3870 [["part_disk"; "/dev/sda"; "mbr"];
3871 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3872 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3873 [["part_disk"; "/dev/sda"; "mbr"];
3874 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3875 "make a filesystem with block size",
3877 This call is similar to C<guestfs_mkfs>, but it allows you to
3878 control the block size of the resulting filesystem. Supported
3879 block sizes depend on the filesystem type, but typically they
3880 are C<1024>, C<2048> or C<4096> only.
3882 For VFAT and NTFS the C<blocksize> parameter is treated as
3883 the requested cluster size.");
3885 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
3886 [InitEmpty, Always, TestOutput (
3887 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3888 ["mke2journal"; "4096"; "/dev/sda1"];
3889 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3890 ["mount_options"; ""; "/dev/sda2"; "/"];
3891 ["write"; "/new"; "new file contents"];
3892 ["cat"; "/new"]], "new file contents")],
3893 "make ext2/3/4 external journal",
3895 This creates an ext2 external journal on C<device>. It is equivalent
3898 mke2fs -O journal_dev -b blocksize device");
3900 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
3901 [InitEmpty, Always, TestOutput (
3902 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3903 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3904 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3905 ["mount_options"; ""; "/dev/sda2"; "/"];
3906 ["write"; "/new"; "new file contents"];
3907 ["cat"; "/new"]], "new file contents")],
3908 "make ext2/3/4 external journal with label",
3910 This creates an ext2 external journal on C<device> with label C<label>.");
3912 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
3913 (let uuid = uuidgen () in
3914 [InitEmpty, Always, TestOutput (
3915 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3916 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3917 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3918 ["mount_options"; ""; "/dev/sda2"; "/"];
3919 ["write"; "/new"; "new file contents"];
3920 ["cat"; "/new"]], "new file contents")]),
3921 "make ext2/3/4 external journal with UUID",
3923 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3925 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
3927 "make ext2/3/4 filesystem with external journal",
3929 This creates an ext2/3/4 filesystem on C<device> with
3930 an external journal on C<journal>. It is equivalent
3933 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3935 See also C<guestfs_mke2journal>.");
3937 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
3939 "make ext2/3/4 filesystem with external journal",
3941 This creates an ext2/3/4 filesystem on C<device> with
3942 an external journal on the journal labeled C<label>.
3944 See also C<guestfs_mke2journal_L>.");
3946 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
3948 "make ext2/3/4 filesystem with external journal",
3950 This creates an ext2/3/4 filesystem on C<device> with
3951 an external journal on the journal with UUID C<uuid>.
3953 See also C<guestfs_mke2journal_U>.");
3955 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
3956 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3957 "load a kernel module",
3959 This loads a kernel module in the appliance.
3961 The kernel module must have been whitelisted when libguestfs
3962 was built (see C<appliance/kmod.whitelist.in> in the source).");
3964 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
3965 [InitNone, Always, TestOutput (
3966 [["echo_daemon"; "This is a test"]], "This is a test"
3968 "echo arguments back to the client",
3970 This command concatenates the list of C<words> passed with single spaces
3971 between them and returns the resulting string.
3973 You can use this command to test the connection through to the daemon.
3975 See also C<guestfs_ping_daemon>.");
3977 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
3978 [], (* There is a regression test for this. *)
3979 "find all files and directories, returning NUL-separated list",
3981 This command lists out all files and directories, recursively,
3982 starting at C<directory>, placing the resulting list in the
3983 external file called C<files>.
3985 This command works the same way as C<guestfs_find> with the
3986 following exceptions:
3992 The resulting list is written to an external file.
3996 Items (filenames) in the result are separated
3997 by C<\\0> characters. See L<find(1)> option I<-print0>.
4001 This command is not limited in the number of names that it
4006 The result list is not sorted.
4010 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4011 [InitISOFS, Always, TestOutput (
4012 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4013 InitISOFS, Always, TestOutput (
4014 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4015 InitISOFS, Always, TestOutput (
4016 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4017 InitISOFS, Always, TestLastFail (
4018 [["case_sensitive_path"; "/Known-1/"]]);
4019 InitBasicFS, Always, TestOutput (
4021 ["mkdir"; "/a/bbb"];
4022 ["touch"; "/a/bbb/c"];
4023 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4024 InitBasicFS, Always, TestOutput (
4026 ["mkdir"; "/a/bbb"];
4027 ["touch"; "/a/bbb/c"];
4028 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4029 InitBasicFS, Always, TestLastFail (
4031 ["mkdir"; "/a/bbb"];
4032 ["touch"; "/a/bbb/c"];
4033 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4034 "return true path on case-insensitive filesystem",
4036 This can be used to resolve case insensitive paths on
4037 a filesystem which is case sensitive. The use case is
4038 to resolve paths which you have read from Windows configuration
4039 files or the Windows Registry, to the true path.
4041 The command handles a peculiarity of the Linux ntfs-3g
4042 filesystem driver (and probably others), which is that although
4043 the underlying filesystem is case-insensitive, the driver
4044 exports the filesystem to Linux as case-sensitive.
4046 One consequence of this is that special directories such
4047 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4048 (or other things) depending on the precise details of how
4049 they were created. In Windows itself this would not be
4052 Bug or feature? You decide:
4053 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4055 This function resolves the true case of each element in the
4056 path and returns the case-sensitive path.
4058 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4059 might return C<\"/WINDOWS/system32\"> (the exact return value
4060 would depend on details of how the directories were originally
4061 created under Windows).
4064 This function does not handle drive names, backslashes etc.
4066 See also C<guestfs_realpath>.");
4068 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4069 [InitBasicFS, Always, TestOutput (
4070 [["vfs_type"; "/dev/sda1"]], "ext2")],
4071 "get the Linux VFS type corresponding to a mounted device",
4073 This command gets the filesystem type corresponding to
4074 the filesystem on C<device>.
4076 For most filesystems, the result is the name of the Linux
4077 VFS module which would be used to mount this filesystem
4078 if you mounted it without specifying the filesystem type.
4079 For example a string such as C<ext3> or C<ntfs>.");
4081 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4082 [InitBasicFS, Always, TestOutputStruct (
4083 [["write"; "/test"; "some stuff so size is not zero"];
4084 ["truncate"; "/test"];
4085 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4086 "truncate a file to zero size",
4088 This command truncates C<path> to a zero-length file. The
4089 file must exist already.");
4091 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4092 [InitBasicFS, Always, TestOutputStruct (
4093 [["touch"; "/test"];
4094 ["truncate_size"; "/test"; "1000"];
4095 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4096 "truncate a file to a particular size",
4098 This command truncates C<path> to size C<size> bytes. The file
4101 If the current file size is less than C<size> then
4102 the file is extended to the required size with zero bytes.
4103 This creates a sparse file (ie. disk blocks are not allocated
4104 for the file until you write to it). To create a non-sparse
4105 file of zeroes, use C<guestfs_fallocate64> instead.");
4107 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4108 [InitBasicFS, Always, TestOutputStruct (
4109 [["touch"; "/test"];
4110 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4111 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4112 "set timestamp of a file with nanosecond precision",
4114 This command sets the timestamps of a file with nanosecond
4117 C<atsecs, atnsecs> are the last access time (atime) in secs and
4118 nanoseconds from the epoch.
4120 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4121 secs and nanoseconds from the epoch.
4123 If the C<*nsecs> field contains the special value C<-1> then
4124 the corresponding timestamp is set to the current time. (The
4125 C<*secs> field is ignored in this case).
4127 If the C<*nsecs> field contains the special value C<-2> then
4128 the corresponding timestamp is left unchanged. (The
4129 C<*secs> field is ignored in this case).");
4131 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4132 [InitBasicFS, Always, TestOutputStruct (
4133 [["mkdir_mode"; "/test"; "0o111"];
4134 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4135 "create a directory with a particular mode",
4137 This command creates a directory, setting the initial permissions
4138 of the directory to C<mode>.
4140 For common Linux filesystems, the actual mode which is set will
4141 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4142 interpret the mode in other ways.
4144 See also C<guestfs_mkdir>, C<guestfs_umask>");
4146 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4148 "change file owner and group",
4150 Change the file owner to C<owner> and group to C<group>.
4151 This is like C<guestfs_chown> but if C<path> is a symlink then
4152 the link itself is changed, not the target.
4154 Only numeric uid and gid are supported. If you want to use
4155 names, you will need to locate and parse the password file
4156 yourself (Augeas support makes this relatively easy).");
4158 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4160 "lstat on multiple files",
4162 This call allows you to perform the C<guestfs_lstat> operation
4163 on multiple files, where all files are in the directory C<path>.
4164 C<names> is the list of files from this directory.
4166 On return you get a list of stat structs, with a one-to-one
4167 correspondence to the C<names> list. If any name did not exist
4168 or could not be lstat'd, then the C<ino> field of that structure
4171 This call is intended for programs that want to efficiently
4172 list a directory contents without making many round-trips.
4173 See also C<guestfs_lxattrlist> for a similarly efficient call
4174 for getting extended attributes. Very long directory listings
4175 might cause the protocol message size to be exceeded, causing
4176 this call to fail. The caller must split up such requests
4177 into smaller groups of names.");
4179 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4181 "lgetxattr on multiple files",
4183 This call allows you to get the extended attributes
4184 of multiple files, where all files are in the directory C<path>.
4185 C<names> is the list of files from this directory.
4187 On return you get a flat list of xattr structs which must be
4188 interpreted sequentially. The first xattr struct always has a zero-length
4189 C<attrname>. C<attrval> in this struct is zero-length
4190 to indicate there was an error doing C<lgetxattr> for this
4191 file, I<or> is a C string which is a decimal number
4192 (the number of following attributes for this file, which could
4193 be C<\"0\">). Then after the first xattr struct are the
4194 zero or more attributes for the first named file.
4195 This repeats for the second and subsequent files.
4197 This call is intended for programs that want to efficiently
4198 list a directory contents without making many round-trips.
4199 See also C<guestfs_lstatlist> for a similarly efficient call
4200 for getting standard stats. Very long directory listings
4201 might cause the protocol message size to be exceeded, causing
4202 this call to fail. The caller must split up such requests
4203 into smaller groups of names.");
4205 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4207 "readlink on multiple files",
4209 This call allows you to do a C<readlink> operation
4210 on multiple files, where all files are in the directory C<path>.
4211 C<names> is the list of files from this directory.
4213 On return you get a list of strings, with a one-to-one
4214 correspondence to the C<names> list. Each string is the
4215 value of the symbolic link.
4217 If the C<readlink(2)> operation fails on any name, then
4218 the corresponding result string is the empty string C<\"\">.
4219 However the whole operation is completed even if there
4220 were C<readlink(2)> errors, and so you can call this
4221 function with names where you don't know if they are
4222 symbolic links already (albeit slightly less efficient).
4224 This call is intended for programs that want to efficiently
4225 list a directory contents without making many round-trips.
4226 Very long directory listings might cause the protocol
4227 message size to be exceeded, causing
4228 this call to fail. The caller must split up such requests
4229 into smaller groups of names.");
4231 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4232 [InitISOFS, Always, TestOutputBuffer (
4233 [["pread"; "/known-4"; "1"; "3"]], "\n");
4234 InitISOFS, Always, TestOutputBuffer (
4235 [["pread"; "/empty"; "0"; "100"]], "")],
4236 "read part of a file",
4238 This command lets you read part of a file. It reads C<count>
4239 bytes of the file, starting at C<offset>, from file C<path>.
4241 This may read fewer bytes than requested. For further details
4242 see the L<pread(2)> system call.
4244 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4246 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4247 [InitEmpty, Always, TestRun (
4248 [["part_init"; "/dev/sda"; "gpt"]])],
4249 "create an empty partition table",
4251 This creates an empty partition table on C<device> of one of the
4252 partition types listed below. Usually C<parttype> should be
4253 either C<msdos> or C<gpt> (for large disks).
4255 Initially there are no partitions. Following this, you should
4256 call C<guestfs_part_add> for each partition required.
4258 Possible values for C<parttype> are:
4262 =item B<efi> | B<gpt>
4264 Intel EFI / GPT partition table.
4266 This is recommended for >= 2 TB partitions that will be accessed
4267 from Linux and Intel-based Mac OS X. It also has limited backwards
4268 compatibility with the C<mbr> format.
4270 =item B<mbr> | B<msdos>
4272 The standard PC \"Master Boot Record\" (MBR) format used
4273 by MS-DOS and Windows. This partition type will B<only> work
4274 for device sizes up to 2 TB. For large disks we recommend
4279 Other partition table types that may work but are not
4288 =item B<amiga> | B<rdb>
4290 Amiga \"Rigid Disk Block\" format.
4298 DASD, used on IBM mainframes.
4306 Old Mac partition format. Modern Macs use C<gpt>.
4310 NEC PC-98 format, common in Japan apparently.
4318 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4319 [InitEmpty, Always, TestRun (
4320 [["part_init"; "/dev/sda"; "mbr"];
4321 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4322 InitEmpty, Always, TestRun (
4323 [["part_init"; "/dev/sda"; "gpt"];
4324 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4325 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4326 InitEmpty, Always, TestRun (
4327 [["part_init"; "/dev/sda"; "mbr"];
4328 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4329 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4330 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4331 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4332 "add a partition to the device",
4334 This command adds a partition to C<device>. If there is no partition
4335 table on the device, call C<guestfs_part_init> first.
4337 The C<prlogex> parameter is the type of partition. Normally you
4338 should pass C<p> or C<primary> here, but MBR partition tables also
4339 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4342 C<startsect> and C<endsect> are the start and end of the partition
4343 in I<sectors>. C<endsect> may be negative, which means it counts
4344 backwards from the end of the disk (C<-1> is the last sector).
4346 Creating a partition which covers the whole disk is not so easy.
4347 Use C<guestfs_part_disk> to do that.");
4349 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4350 [InitEmpty, Always, TestRun (
4351 [["part_disk"; "/dev/sda"; "mbr"]]);
4352 InitEmpty, Always, TestRun (
4353 [["part_disk"; "/dev/sda"; "gpt"]])],
4354 "partition whole disk with a single primary partition",
4356 This command is simply a combination of C<guestfs_part_init>
4357 followed by C<guestfs_part_add> to create a single primary partition
4358 covering the whole disk.
4360 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4361 but other possible values are described in C<guestfs_part_init>.");
4363 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4364 [InitEmpty, Always, TestRun (
4365 [["part_disk"; "/dev/sda"; "mbr"];
4366 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4367 "make a partition bootable",
4369 This sets the bootable flag on partition numbered C<partnum> on
4370 device C<device>. Note that partitions are numbered from 1.
4372 The bootable flag is used by some operating systems (notably
4373 Windows) to determine which partition to boot from. It is by
4374 no means universally recognized.");
4376 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4377 [InitEmpty, Always, TestRun (
4378 [["part_disk"; "/dev/sda"; "gpt"];
4379 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4380 "set partition name",
4382 This sets the partition name on partition numbered C<partnum> on
4383 device C<device>. Note that partitions are numbered from 1.
4385 The partition name can only be set on certain types of partition
4386 table. This works on C<gpt> but not on C<mbr> partitions.");
4388 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4389 [], (* XXX Add a regression test for this. *)
4390 "list partitions on a device",
4392 This command parses the partition table on C<device> and
4393 returns the list of partitions found.
4395 The fields in the returned structure are:
4401 Partition number, counting from 1.
4405 Start of the partition I<in bytes>. To get sectors you have to
4406 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4410 End of the partition in bytes.
4414 Size of the partition in bytes.
4418 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4419 [InitEmpty, Always, TestOutput (
4420 [["part_disk"; "/dev/sda"; "gpt"];
4421 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4422 "get the partition table type",
4424 This command examines the partition table on C<device> and
4425 returns the partition table type (format) being used.
4427 Common return values include: C<msdos> (a DOS/Windows style MBR
4428 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4429 values are possible, although unusual. See C<guestfs_part_init>
4432 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4433 [InitBasicFS, Always, TestOutputBuffer (
4434 [["fill"; "0x63"; "10"; "/test"];
4435 ["read_file"; "/test"]], "cccccccccc")],
4436 "fill a file with octets",
4438 This command creates a new file called C<path>. The initial
4439 content of the file is C<len> octets of C<c>, where C<c>
4440 must be a number in the range C<[0..255]>.
4442 To fill a file with zero bytes (sparsely), it is
4443 much more efficient to use C<guestfs_truncate_size>.
4444 To create a file with a pattern of repeating bytes
4445 use C<guestfs_fill_pattern>.");
4447 ("available", (RErr, [StringList "groups"], []), 216, [],
4448 [InitNone, Always, TestRun [["available"; ""]]],
4449 "test availability of some parts of the API",
4451 This command is used to check the availability of some
4452 groups of functionality in the appliance, which not all builds of
4453 the libguestfs appliance will be able to provide.
4455 The libguestfs groups, and the functions that those
4456 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4457 You can also fetch this list at runtime by calling
4458 C<guestfs_available_all_groups>.
4460 The argument C<groups> is a list of group names, eg:
4461 C<[\"inotify\", \"augeas\"]> would check for the availability of
4462 the Linux inotify functions and Augeas (configuration file
4465 The command returns no error if I<all> requested groups are available.
4467 It fails with an error if one or more of the requested
4468 groups is unavailable in the appliance.
4470 If an unknown group name is included in the
4471 list of groups then an error is always returned.
4479 You must call C<guestfs_launch> before calling this function.
4481 The reason is because we don't know what groups are
4482 supported by the appliance/daemon until it is running and can
4487 If a group of functions is available, this does not necessarily
4488 mean that they will work. You still have to check for errors
4489 when calling individual API functions even if they are
4494 It is usually the job of distro packagers to build
4495 complete functionality into the libguestfs appliance.
4496 Upstream libguestfs, if built from source with all
4497 requirements satisfied, will support everything.
4501 This call was added in version C<1.0.80>. In previous
4502 versions of libguestfs all you could do would be to speculatively
4503 execute a command to find out if the daemon implemented it.
4504 See also C<guestfs_version>.
4508 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4509 [InitBasicFS, Always, TestOutputBuffer (
4510 [["write"; "/src"; "hello, world"];
4511 ["dd"; "/src"; "/dest"];
4512 ["read_file"; "/dest"]], "hello, world")],
4513 "copy from source to destination using dd",
4515 This command copies from one source device or file C<src>
4516 to another destination device or file C<dest>. Normally you
4517 would use this to copy to or from a device or partition, for
4518 example to duplicate a filesystem.
4520 If the destination is a device, it must be as large or larger
4521 than the source file or device, otherwise the copy will fail.
4522 This command cannot do partial copies (see C<guestfs_copy_size>).");
4524 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4525 [InitBasicFS, Always, TestOutputInt (
4526 [["write"; "/file"; "hello, world"];
4527 ["filesize"; "/file"]], 12)],
4528 "return the size of the file in bytes",
4530 This command returns the size of C<file> in bytes.
4532 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4533 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4534 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4536 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4537 [InitBasicFSonLVM, Always, TestOutputList (
4538 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4539 ["lvs"]], ["/dev/VG/LV2"])],
4540 "rename an LVM logical volume",
4542 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4544 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4545 [InitBasicFSonLVM, Always, TestOutputList (
4547 ["vg_activate"; "false"; "VG"];
4548 ["vgrename"; "VG"; "VG2"];
4549 ["vg_activate"; "true"; "VG2"];
4550 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4551 ["vgs"]], ["VG2"])],
4552 "rename an LVM volume group",
4554 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4556 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4557 [InitISOFS, Always, TestOutputBuffer (
4558 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4559 "list the contents of a single file in an initrd",
4561 This command unpacks the file C<filename> from the initrd file
4562 called C<initrdpath>. The filename must be given I<without> the
4563 initial C</> character.
4565 For example, in guestfish you could use the following command
4566 to examine the boot script (usually called C</init>)
4567 contained in a Linux initrd or initramfs image:
4569 initrd-cat /boot/initrd-<version>.img init
4571 See also C<guestfs_initrd_list>.");
4573 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4575 "get the UUID of a physical volume",
4577 This command returns the UUID of the LVM PV C<device>.");
4579 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4581 "get the UUID of a volume group",
4583 This command returns the UUID of the LVM VG named C<vgname>.");
4585 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4587 "get the UUID of a logical volume",
4589 This command returns the UUID of the LVM LV C<device>.");
4591 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4593 "get the PV UUIDs containing the volume group",
4595 Given a VG called C<vgname>, this returns the UUIDs of all
4596 the physical volumes that this volume group resides on.
4598 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4599 calls to associate physical volumes and volume groups.
4601 See also C<guestfs_vglvuuids>.");
4603 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4605 "get the LV UUIDs of all LVs in the volume group",
4607 Given a VG called C<vgname>, this returns the UUIDs of all
4608 the logical volumes created in this volume group.
4610 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4611 calls to associate logical volumes and volume groups.
4613 See also C<guestfs_vgpvuuids>.");
4615 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4616 [InitBasicFS, Always, TestOutputBuffer (
4617 [["write"; "/src"; "hello, world"];
4618 ["copy_size"; "/src"; "/dest"; "5"];
4619 ["read_file"; "/dest"]], "hello")],
4620 "copy size bytes from source to destination using dd",
4622 This command copies exactly C<size> bytes from one source device
4623 or file C<src> to another destination device or file C<dest>.
4625 Note this will fail if the source is too short or if the destination
4626 is not large enough.");
4628 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4629 [InitBasicFSonLVM, Always, TestRun (
4630 [["zero_device"; "/dev/VG/LV"]])],
4631 "write zeroes to an entire device",
4633 This command writes zeroes over the entire C<device>. Compare
4634 with C<guestfs_zero> which just zeroes the first few blocks of
4637 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4638 [InitBasicFS, Always, TestOutput (
4639 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4640 ["cat"; "/hello"]], "hello\n")],
4641 "unpack compressed tarball to directory",
4643 This command uploads and unpacks local file C<tarball> (an
4644 I<xz compressed> tar file) into C<directory>.");
4646 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4648 "pack directory into compressed tarball",
4650 This command packs the contents of C<directory> and downloads
4651 it to local file C<tarball> (as an xz compressed tar archive).");
4653 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4655 "resize an NTFS filesystem",
4657 This command resizes an NTFS filesystem, expanding or
4658 shrinking it to the size of the underlying device.
4659 See also L<ntfsresize(8)>.");
4661 ("vgscan", (RErr, [], []), 232, [],
4662 [InitEmpty, Always, TestRun (
4664 "rescan for LVM physical volumes, volume groups and logical volumes",
4666 This rescans all block devices and rebuilds the list of LVM
4667 physical volumes, volume groups and logical volumes.");
4669 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
4670 [InitEmpty, Always, TestRun (
4671 [["part_init"; "/dev/sda"; "mbr"];
4672 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4673 ["part_del"; "/dev/sda"; "1"]])],
4674 "delete a partition",
4676 This command deletes the partition numbered C<partnum> on C<device>.
4678 Note that in the case of MBR partitioning, deleting an
4679 extended partition also deletes any logical partitions
4682 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
4683 [InitEmpty, Always, TestOutputTrue (
4684 [["part_init"; "/dev/sda"; "mbr"];
4685 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4686 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4687 ["part_get_bootable"; "/dev/sda"; "1"]])],
4688 "return true if a partition is bootable",
4690 This command returns true if the partition C<partnum> on
4691 C<device> has the bootable flag set.
4693 See also C<guestfs_part_set_bootable>.");
4695 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
4696 [InitEmpty, Always, TestOutputInt (
4697 [["part_init"; "/dev/sda"; "mbr"];
4698 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4699 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4700 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4701 "get the MBR type byte (ID byte) from a partition",
4703 Returns the MBR type byte (also known as the ID byte) from
4704 the numbered partition C<partnum>.
4706 Note that only MBR (old DOS-style) partitions have type bytes.
4707 You will get undefined results for other partition table
4708 types (see C<guestfs_part_get_parttype>).");
4710 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
4711 [], (* tested by part_get_mbr_id *)
4712 "set the MBR type byte (ID byte) of a partition",
4714 Sets the MBR type byte (also known as the ID byte) of
4715 the numbered partition C<partnum> to C<idbyte>. Note
4716 that the type bytes quoted in most documentation are
4717 in fact hexadecimal numbers, but usually documented
4718 without any leading \"0x\" which might be confusing.
4720 Note that only MBR (old DOS-style) partitions have type bytes.
4721 You will get undefined results for other partition table
4722 types (see C<guestfs_part_get_parttype>).");
4724 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
4725 [InitISOFS, Always, TestOutputFileMD5 (
4726 [["checksum_device"; "md5"; "/dev/sdd"]],
4727 "../images/test.iso")],
4728 "compute MD5, SHAx or CRC checksum of the contents of a device",
4730 This call computes the MD5, SHAx or CRC checksum of the
4731 contents of the device named C<device>. For the types of
4732 checksums supported see the C<guestfs_checksum> command.");
4734 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
4735 [InitNone, Always, TestRun (
4736 [["part_disk"; "/dev/sda"; "mbr"];
4737 ["pvcreate"; "/dev/sda1"];
4738 ["vgcreate"; "VG"; "/dev/sda1"];
4739 ["lvcreate"; "LV"; "VG"; "10"];
4740 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4741 "expand an LV to fill free space",
4743 This expands an existing logical volume C<lv> so that it fills
4744 C<pc>% of the remaining free space in the volume group. Commonly
4745 you would call this with pc = 100 which expands the logical volume
4746 as much as possible, using all remaining free space in the volume
4749 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
4750 [], (* XXX Augeas code needs tests. *)
4751 "clear Augeas path",
4753 Set the value associated with C<path> to C<NULL>. This
4754 is the same as the L<augtool(1)> C<clear> command.");
4756 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
4757 [InitEmpty, Always, TestOutputInt (
4758 [["get_umask"]], 0o22)],
4759 "get the current umask",
4761 Return the current umask. By default the umask is C<022>
4762 unless it has been set by calling C<guestfs_umask>.");
4764 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [],
4766 "upload a file to the appliance (internal use only)",
4768 The C<guestfs_debug_upload> command uploads a file to
4769 the libguestfs appliance.
4771 There is no comprehensive help for this command. You have
4772 to look at the file C<daemon/debug.c> in the libguestfs source
4773 to find out what it is for.");
4775 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
4776 [InitBasicFS, Always, TestOutput (
4777 [["base64_in"; "../images/hello.b64"; "/hello"];
4778 ["cat"; "/hello"]], "hello\n")],
4779 "upload base64-encoded data to file",
4781 This command uploads base64-encoded data from C<base64file>
4784 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
4786 "download file and encode as base64",
4788 This command downloads the contents of C<filename>, writing
4789 it out to local file C<base64file> encoded as base64.");
4791 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
4793 "compute MD5, SHAx or CRC checksum of files in a directory",
4795 This command computes the checksums of all regular files in
4796 C<directory> and then emits a list of those checksums to
4797 the local output file C<sumsfile>.
4799 This can be used for verifying the integrity of a virtual
4800 machine. However to be properly secure you should pay
4801 attention to the output of the checksum command (it uses
4802 the ones from GNU coreutils). In particular when the
4803 filename is not printable, coreutils uses a special
4804 backslash syntax. For more information, see the GNU
4805 coreutils info file.");
4807 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
4808 [InitBasicFS, Always, TestOutputBuffer (
4809 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4810 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4811 "fill a file with a repeating pattern of bytes",
4813 This function is like C<guestfs_fill> except that it creates
4814 a new file of length C<len> containing the repeating pattern
4815 of bytes in C<pattern>. The pattern is truncated if necessary
4816 to ensure the length of the file is exactly C<len> bytes.");
4818 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
4819 [InitBasicFS, Always, TestOutput (
4820 [["write"; "/new"; "new file contents"];
4821 ["cat"; "/new"]], "new file contents");
4822 InitBasicFS, Always, TestOutput (
4823 [["write"; "/new"; "\nnew file contents\n"];
4824 ["cat"; "/new"]], "\nnew file contents\n");
4825 InitBasicFS, Always, TestOutput (
4826 [["write"; "/new"; "\n\n"];
4827 ["cat"; "/new"]], "\n\n");
4828 InitBasicFS, Always, TestOutput (
4829 [["write"; "/new"; ""];
4830 ["cat"; "/new"]], "");
4831 InitBasicFS, Always, TestOutput (
4832 [["write"; "/new"; "\n\n\n"];
4833 ["cat"; "/new"]], "\n\n\n");
4834 InitBasicFS, Always, TestOutput (
4835 [["write"; "/new"; "\n"];
4836 ["cat"; "/new"]], "\n")],
4837 "create a new file",
4839 This call creates a file called C<path>. The content of the
4840 file is the string C<content> (which can contain any 8 bit data).");
4842 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
4843 [InitBasicFS, Always, TestOutput (
4844 [["write"; "/new"; "new file contents"];
4845 ["pwrite"; "/new"; "data"; "4"];
4846 ["cat"; "/new"]], "new data contents");
4847 InitBasicFS, Always, TestOutput (
4848 [["write"; "/new"; "new file contents"];
4849 ["pwrite"; "/new"; "is extended"; "9"];
4850 ["cat"; "/new"]], "new file is extended");
4851 InitBasicFS, Always, TestOutput (
4852 [["write"; "/new"; "new file contents"];
4853 ["pwrite"; "/new"; ""; "4"];
4854 ["cat"; "/new"]], "new file contents")],
4855 "write to part of a file",
4857 This command writes to part of a file. It writes the data
4858 buffer C<content> to the file C<path> starting at offset C<offset>.
4860 This command implements the L<pwrite(2)> system call, and like
4861 that system call it may not write the full data requested. The
4862 return value is the number of bytes that were actually written
4863 to the file. This could even be 0, although short writes are
4864 unlikely for regular files in ordinary circumstances.
4866 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
4868 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
4870 "resize an ext2, ext3 or ext4 filesystem (with size)",
4872 This command is the same as C<guestfs_resize2fs> except that it
4873 allows you to specify the new size (in bytes) explicitly.");
4875 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
4877 "resize an LVM physical volume (with size)",
4879 This command is the same as C<guestfs_pvresize> except that it
4880 allows you to specify the new size (in bytes) explicitly.");
4882 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
4884 "resize an NTFS filesystem (with size)",
4886 This command is the same as C<guestfs_ntfsresize> except that it
4887 allows you to specify the new size (in bytes) explicitly.");
4889 ("available_all_groups", (RStringList "groups", [], []), 251, [],
4890 [InitNone, Always, TestRun [["available_all_groups"]]],
4891 "return a list of all optional groups",
4893 This command returns a list of all optional groups that this
4894 daemon knows about. Note this returns both supported and unsupported
4895 groups. To find out which ones the daemon can actually support
4896 you have to call C<guestfs_available> on each member of the
4899 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4901 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
4902 [InitBasicFS, Always, TestOutputStruct (
4903 [["fallocate64"; "/a"; "1000000"];
4904 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4905 "preallocate a file in the guest filesystem",
4907 This command preallocates a file (containing zero bytes) named
4908 C<path> of size C<len> bytes. If the file exists already, it
4911 Note that this call allocates disk blocks for the file.
4912 To create a sparse file use C<guestfs_truncate_size> instead.
4914 The deprecated call C<guestfs_fallocate> does the same,
4915 but owing to an oversight it only allowed 30 bit lengths
4916 to be specified, effectively limiting the maximum size
4917 of files created through that call to 1GB.
4919 Do not confuse this with the guestfish-specific
4920 C<alloc> and C<sparse> commands which create
4921 a file in the host and attach it as a device.");
4923 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
4924 [InitBasicFS, Always, TestOutput (
4925 [["set_e2label"; "/dev/sda1"; "LTEST"];
4926 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4927 "get the filesystem label",
4929 This returns the filesystem label of the filesystem on
4932 If the filesystem is unlabeled, this returns the empty string.
4934 To find a filesystem from the label, use C<guestfs_findfs_label>.");
4936 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
4937 (let uuid = uuidgen () in
4938 [InitBasicFS, Always, TestOutput (
4939 [["set_e2uuid"; "/dev/sda1"; uuid];
4940 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4941 "get the filesystem UUID",
4943 This returns the filesystem UUID of the filesystem on
4946 If the filesystem does not have a UUID, this returns the empty string.
4948 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
4950 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
4951 (* Can't be tested with the current framework because
4952 * the VG is being used by the mounted filesystem, so
4953 * the vgchange -an command we do first will fail.
4956 "set LVM device filter",
4958 This sets the LVM device filter so that LVM will only be
4959 able to \"see\" the block devices in the list C<devices>,
4960 and will ignore all other attached block devices.
4962 Where disk image(s) contain duplicate PVs or VGs, this
4963 command is useful to get LVM to ignore the duplicates, otherwise
4964 LVM can get confused. Note also there are two types
4965 of duplication possible: either cloned PVs/VGs which have
4966 identical UUIDs; or VGs that are not cloned but just happen
4967 to have the same name. In normal operation you cannot
4968 create this situation, but you can do it outside LVM, eg.
4969 by cloning disk images or by bit twiddling inside the LVM
4972 This command also clears the LVM cache and performs a volume
4975 You can filter whole block devices or individual partitions.
4977 You cannot use this if any VG is currently in use (eg.
4978 contains a mounted filesystem), even if you are not
4979 filtering out that VG.");
4981 ("lvm_clear_filter", (RErr, [], []), 256, [],
4982 [], (* see note on lvm_set_filter *)
4983 "clear LVM device filter",
4985 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
4986 will be able to see every block device.
4988 This command also clears the LVM cache and performs a volume
4991 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
4993 "open a LUKS-encrypted block device",
4995 This command opens a block device which has been encrypted
4996 according to the Linux Unified Key Setup (LUKS) standard.
4998 C<device> is the encrypted block device or partition.
5000 The caller must supply one of the keys associated with the
5001 LUKS block device, in the C<key> parameter.
5003 This creates a new block device called C</dev/mapper/mapname>.
5004 Reads and writes to this block device are decrypted from and
5005 encrypted to the underlying C<device> respectively.
5007 If this block device contains LVM volume groups, then
5008 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5009 will make them visible.");
5011 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5013 "open a LUKS-encrypted block device read-only",
5015 This is the same as C<guestfs_luks_open> except that a read-only
5016 mapping is created.");
5018 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5020 "close a LUKS device",
5022 This closes a LUKS device that was created earlier by
5023 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5024 C<device> parameter must be the name of the LUKS mapping
5025 device (ie. C</dev/mapper/mapname>) and I<not> the name
5026 of the underlying block device.");
5028 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5030 "format a block device as a LUKS encrypted device",
5032 This command erases existing data on C<device> and formats
5033 the device as a LUKS encrypted device. C<key> is the
5034 initial key, which is added to key slot C<slot>. (LUKS
5035 supports 8 key slots, numbered 0-7).");
5037 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5039 "format a block device as a LUKS encrypted device",
5041 This command is the same as C<guestfs_luks_format> but
5042 it also allows you to set the C<cipher> used.");
5044 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5046 "add a key on a LUKS encrypted device",
5048 This command adds a new key on LUKS device C<device>.
5049 C<key> is any existing key, and is used to access the device.
5050 C<newkey> is the new key to add. C<keyslot> is the key slot
5051 that will be replaced.
5053 Note that if C<keyslot> already contains a key, then this
5054 command will fail. You have to use C<guestfs_luks_kill_slot>
5055 first to remove that key.");
5057 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5059 "remove a key from a LUKS encrypted device",
5061 This command deletes the key in key slot C<keyslot> from the
5062 encrypted LUKS device C<device>. C<key> must be one of the
5065 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5066 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5067 [["is_lv"; "/dev/VG/LV"]]);
5068 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5069 [["is_lv"; "/dev/sda1"]])],
5070 "test if device is a logical volume",
5072 This command tests whether C<device> is a logical volume, and
5073 returns true iff this is the case.");
5075 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5077 "find a filesystem by UUID",
5079 This command searches the filesystems and returns the one
5080 which has the given UUID. An error is returned if no such
5081 filesystem can be found.
5083 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5085 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5087 "find a filesystem by label",
5089 This command searches the filesystems and returns the one
5090 which has the given label. An error is returned if no such
5091 filesystem can be found.
5093 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5095 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5096 [InitISOFS, Always, TestOutputFalse (
5097 [["is_chardev"; "/directory"]]);
5098 InitBasicFS, Always, TestOutputTrue (
5099 [["mknod_c"; "0o777"; "99"; "66"; "/test"];
5100 ["is_chardev"; "/test"]])],
5101 "test if character device",
5103 This returns C<true> if and only if there is a character device
5104 with the given C<path> name.
5106 See also C<guestfs_stat>.");
5108 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5109 [InitISOFS, Always, TestOutputFalse (
5110 [["is_blockdev"; "/directory"]]);
5111 InitBasicFS, Always, TestOutputTrue (
5112 [["mknod_b"; "0o777"; "99"; "66"; "/test"];
5113 ["is_blockdev"; "/test"]])],
5114 "test if block device",
5116 This returns C<true> if and only if there is a block device
5117 with the given C<path> name.
5119 See also C<guestfs_stat>.");
5121 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5122 [InitISOFS, Always, TestOutputFalse (
5123 [["is_fifo"; "/directory"]]);
5124 InitBasicFS, Always, TestOutputTrue (
5125 [["mkfifo"; "0o777"; "/test"];
5126 ["is_fifo"; "/test"]])],
5127 "test if FIFO (named pipe)",
5129 This returns C<true> if and only if there is a FIFO (named pipe)
5130 with the given C<path> name.
5132 See also C<guestfs_stat>.");
5134 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5135 [InitISOFS, Always, TestOutputFalse (
5136 [["is_symlink"; "/directory"]]);
5137 InitISOFS, Always, TestOutputTrue (
5138 [["is_symlink"; "/abssymlink"]])],
5139 "test if symbolic link",
5141 This returns C<true> if and only if there is a symbolic link
5142 with the given C<path> name.
5144 See also C<guestfs_stat>.");
5146 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5147 (* XXX Need a positive test for sockets. *)
5148 [InitISOFS, Always, TestOutputFalse (
5149 [["is_socket"; "/directory"]])],
5152 This returns C<true> if and only if there is a Unix domain socket
5153 with the given C<path> name.
5155 See also C<guestfs_stat>.");
5157 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5158 [InitPartition, Always, TestOutputDevice (
5159 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5160 InitEmpty, Always, TestLastFail (
5161 [["part_to_dev"; "/dev/sda"]])],
5162 "convert partition name to device name",
5164 This function takes a partition name (eg. \"/dev/sdb1\") and
5165 removes the partition number, returning the device name
5168 The named partition must exist, for example as a string returned
5169 from C<guestfs_list_partitions>.");
5171 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [],
5172 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5173 [InitBasicFS, Always, TestOutput (
5174 [["upload_offset"; "../COPYING.LIB"; "/COPYING.LIB"; "0"];
5175 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5176 "upload a file from the local machine with offset",
5178 Upload local file C<filename> to C<remotefilename> on the
5181 C<remotefilename> is overwritten starting at the byte C<offset>
5182 specified. The intention is to overwrite parts of existing
5183 files or devices, although if a non-existant file is specified
5184 then it is created with a \"hole\" before C<offset>. The
5185 size of the data written is implicit in the size of the
5188 Note that there is no limit on the amount of data that
5189 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5190 and this call always writes the full amount unless an
5193 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5195 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5196 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5197 let offset = string_of_int 100 in
5198 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5199 [InitBasicFS, Always, TestOutput (
5200 (* Pick a file from cwd which isn't likely to change. *)
5201 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
5202 ["download_offset"; "/COPYING.LIB"; "testdownload.tmp"; offset; size];
5203 ["upload_offset"; "testdownload.tmp"; "/COPYING.LIB"; offset];
5204 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5205 "download a file to the local machine with offset and size",
5207 Download file C<remotefilename> and save it as C<filename>
5208 on the local machine.
5210 C<remotefilename> is read for C<size> bytes starting at C<offset>
5211 (this region must be within the file or device).
5213 Note that there is no limit on the amount of data that
5214 can be downloaded with this call, unlike with C<guestfs_pread>,
5215 and this call always reads the full amount unless an
5218 See also C<guestfs_download>, C<guestfs_pread>.");
5220 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5221 [InitPartition, Always, TestOutputList (
5222 [["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"];
5223 ["blockdev_rereadpt"; "/dev/sda"];
5224 ["list_partitions"]], [])],
5225 "write to part of a device",
5227 This command writes to part of a device. It writes the data
5228 buffer C<content> to C<device> starting at offset C<offset>.
5230 This command implements the L<pwrite(2)> system call, and like
5231 that system call it may not write the full data requested
5232 (although short writes to disk devices and partitions are
5233 probably impossible with standard Linux kernels).
5235 See also C<guestfs_pwrite>.");
5237 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5238 [InitEmpty, Always, TestOutputBuffer (
5239 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5240 "read part of a device",
5242 This command lets you read part of a file. It reads C<count>
5243 bytes of C<device>, starting at C<offset>.
5245 This may read fewer bytes than requested. For further details
5246 see the L<pread(2)> system call.
5248 See also C<guestfs_pread>.");
5250 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5251 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5252 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5253 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5254 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5255 "get canonical name of an LV",
5257 This converts alternative naming schemes for LVs that you
5258 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5259 is converted to C</dev/VG/LV>.
5261 This command returns an error if the C<lvname> parameter does
5262 not refer to a logical volume.
5264 See also C<guestfs_is_lv>.");
5268 let all_functions = non_daemon_functions @ daemon_functions
5270 (* In some places we want the functions to be displayed sorted
5271 * alphabetically, so this is useful:
5273 let all_functions_sorted = List.sort action_compare all_functions
5275 (* This is used to generate the src/MAX_PROC_NR file which
5276 * contains the maximum procedure number, a surrogate for the
5277 * ABI version number. See src/Makefile.am for the details.
5280 let proc_nrs = List.map (
5281 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5282 ) daemon_functions in
5283 List.fold_left max 0 proc_nrs
5285 (* Non-API meta-commands available only in guestfish.
5287 * Note (1): style, proc_nr and tests fields are all meaningless.
5288 * The only fields which are actually used are the shortname,
5289 * FishAlias flags, shortdesc and longdesc.
5291 * Note (2): to refer to other commands, use L</shortname>.
5293 * Note (3): keep this list sorted by shortname.
5295 let fish_commands = [
5296 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5297 "allocate and add a disk file",
5298 " alloc filename size
5300 This creates an empty (zeroed) file of the given size, and then adds
5301 so it can be further examined.
5303 For more advanced image creation, see L<qemu-img(1)> utility.
5305 Size can be specified using standard suffixes, eg. C<1M>.
5307 To create a sparse file, use L</sparse> instead. To create a
5308 prepared disk image, see L</PREPARED DISK IMAGES>.");
5310 ("copy_in", (RErr,[], []), -1, [], [],
5311 "copy local files or directories into an image",
5312 " copy-in local [local ...] /remotedir
5314 C<copy-in> copies local files or directories recursively into the disk
5315 image, placing them in the directory called C</remotedir> (which must
5316 exist). This guestfish meta-command turns into a sequence of
5317 L</tar-in> and other commands as necessary.
5319 Multiple local files and directories can be specified, but the last
5320 parameter must always be a remote directory. Wildcards cannot be
5323 ("copy_out", (RErr,[], []), -1, [], [],
5324 "copy remote files or directories out of an image",
5325 " copy-out remote [remote ...] localdir
5327 C<copy-out> copies remote files or directories recursively out of the
5328 disk image, placing them on the host disk in a local directory called
5329 C<localdir> (which must exist). This guestfish meta-command turns
5330 into a sequence of L</download>, L</tar-out> and other commands as
5333 Multiple remote files and directories can be specified, but the last
5334 parameter must always be a local directory. To download to the
5335 current directory, use C<.> as in:
5339 Wildcards cannot be used in the ordinary command, but you can use
5340 them with the help of L</glob> like this:
5342 glob copy-out /home/* .");
5344 ("echo", (RErr,[], []), -1, [], [],
5345 "display a line of text",
5348 This echos the parameters to the terminal.");
5350 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5354 This is used to edit a file. It downloads the file, edits it
5355 locally using your editor, then uploads the result.
5357 The editor is C<$EDITOR>. However if you use the alternate
5358 commands C<vi> or C<emacs> you will get those corresponding
5361 ("glob", (RErr,[], []), -1, [], [],
5362 "expand wildcards in command",
5363 " glob command args...
5365 Expand wildcards in any paths in the args list, and run C<command>
5366 repeatedly on each matching path.
5368 See L</WILDCARDS AND GLOBBING>.");
5370 ("hexedit", (RErr,[], []), -1, [], [],
5371 "edit with a hex editor",
5372 " hexedit <filename|device>
5373 hexedit <filename|device> <max>
5374 hexedit <filename|device> <start> <max>
5376 Use hexedit (a hex editor) to edit all or part of a binary file
5379 This command works by downloading potentially the whole file or
5380 device, editing it locally, then uploading it. If the file or
5381 device is large, you have to specify which part you wish to edit
5382 by using C<max> and/or C<start> C<max> parameters.
5383 C<start> and C<max> are specified in bytes, with the usual
5384 modifiers allowed such as C<1M> (1 megabyte).
5386 For example to edit the first few sectors of a disk you
5391 which would allow you to edit anywhere within the first megabyte
5394 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5396 hexedit /dev/sda1 0x400 0x400
5398 (assuming the superblock is in the standard location).
5400 This command requires the external L<hexedit(1)> program. You
5401 can specify another program to use by setting the C<HEXEDITOR>
5402 environment variable.
5404 See also L</hexdump>.");
5406 ("lcd", (RErr,[], []), -1, [], [],
5407 "change working directory",
5410 Change the local directory, ie. the current directory of guestfish
5413 Note that C<!cd> won't do what you might expect.");
5415 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5419 Opens the manual page for guestfish.");
5421 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5427 This is used to view a file.
5429 The default viewer is C<$PAGER>. However if you use the alternate
5430 command C<less> you will get the C<less> command specifically.");
5432 ("reopen", (RErr,[], []), -1, [], [],
5433 "close and reopen libguestfs handle",
5436 Close and reopen the libguestfs handle. It is not necessary to use
5437 this normally, because the handle is closed properly when guestfish
5438 exits. However this is occasionally useful for testing.");
5440 ("sparse", (RErr,[], []), -1, [], [],
5441 "create a sparse disk image and add",
5442 " sparse filename size
5444 This creates an empty sparse file of the given size, and then adds
5445 so it can be further examined.
5447 In all respects it works the same as the L</alloc> command, except that
5448 the image file is allocated sparsely, which means that disk blocks are
5449 not assigned to the file until they are needed. Sparse disk files
5450 only use space when written to, but they are slower and there is a
5451 danger you could run out of real disk space during a write operation.
5453 For more advanced image creation, see L<qemu-img(1)> utility.
5455 Size can be specified using standard suffixes, eg. C<1M>.");
5457 ("supported", (RErr,[], []), -1, [], [],
5458 "list supported groups of commands",
5461 This command returns a list of the optional groups
5462 known to the daemon, and indicates which ones are
5463 supported by this build of the libguestfs appliance.
5465 See also L<guestfs(3)/AVAILABILITY>.");
5467 ("time", (RErr,[], []), -1, [], [],
5468 "print elapsed time taken to run a command",
5469 " time command args...
5471 Run the command as usual, but print the elapsed time afterwards. This
5472 can be useful for benchmarking operations.");