2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter C<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form C<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to run C<guestfs_umount_all> followed by
286 C<guestfs_sync> when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
308 ("get_verbose", (RBool "verbose", [], []), -1, [],
312 This returns the verbose messages flag.");
314 ("is_ready", (RBool "ready", [], []), -1, [],
315 [InitNone, Always, TestOutputTrue (
317 "is ready to accept commands",
319 This returns true iff this handle is ready to accept commands
320 (in the C<READY> state).
322 For more information on states, see L<guestfs(3)>.");
324 ("is_config", (RBool "config", [], []), -1, [],
325 [InitNone, Always, TestOutputFalse (
327 "is in configuration state",
329 This returns true iff this handle is being configured
330 (in the C<CONFIG> state).
332 For more information on states, see L<guestfs(3)>.");
334 ("is_launching", (RBool "launching", [], []), -1, [],
335 [InitNone, Always, TestOutputFalse (
336 [["is_launching"]])],
337 "is launching subprocess",
339 This returns true iff this handle is launching the subprocess
340 (in the C<LAUNCHING> state).
342 For more information on states, see L<guestfs(3)>.");
344 ("is_busy", (RBool "busy", [], []), -1, [],
345 [InitNone, Always, TestOutputFalse (
347 "is busy processing a command",
349 This returns true iff this handle is busy processing a command
350 (in the C<BUSY> state).
352 For more information on states, see L<guestfs(3)>.");
354 ("get_state", (RInt "state", [], []), -1, [],
356 "get the current state",
358 This returns the current state as an opaque integer. This is
359 only useful for printing debug and internal error messages.
361 For more information on states, see L<guestfs(3)>.");
363 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
364 [InitNone, Always, TestOutputInt (
365 [["set_memsize"; "500"];
366 ["get_memsize"]], 500)],
367 "set memory allocated to the qemu subprocess",
369 This sets the memory size in megabytes allocated to the
370 qemu subprocess. This only has any effect if called before
373 You can also change this by setting the environment
374 variable C<LIBGUESTFS_MEMSIZE> before the handle is
377 For more information on the architecture of libguestfs,
378 see L<guestfs(3)>.");
380 ("get_memsize", (RInt "memsize", [], []), -1, [],
381 [InitNone, Always, TestOutputIntOp (
382 [["get_memsize"]], ">=", 256)],
383 "get memory allocated to the qemu subprocess",
385 This gets the memory size in megabytes allocated to the
388 If C<guestfs_set_memsize> was not called
389 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
390 then this returns the compiled-in default value for memsize.
392 For more information on the architecture of libguestfs,
393 see L<guestfs(3)>.");
395 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
396 [InitNone, Always, TestOutputIntOp (
397 [["get_pid"]], ">=", 1)],
398 "get PID of qemu subprocess",
400 Return the process ID of the qemu subprocess. If there is no
401 qemu subprocess, then this will return an error.
403 This is an internal call used for debugging and testing.");
405 ("version", (RStruct ("version", "version"), [], []), -1, [],
406 [InitNone, Always, TestOutputStruct (
407 [["version"]], [CompareWithInt ("major", 1)])],
408 "get the library version number",
410 Return the libguestfs version number that the program is linked
413 Note that because of dynamic linking this is not necessarily
414 the version of libguestfs that you compiled against. You can
415 compile the program, and then at runtime dynamically link
416 against a completely different C<libguestfs.so> library.
418 This call was added in version C<1.0.58>. In previous
419 versions of libguestfs there was no way to get the version
420 number. From C code you can use dynamic linker functions
421 to find out if this symbol exists (if it doesn't, then
422 it's an earlier version).
424 The call returns a structure with four elements. The first
425 three (C<major>, C<minor> and C<release>) are numbers and
426 correspond to the usual version triplet. The fourth element
427 (C<extra>) is a string and is normally empty, but may be
428 used for distro-specific information.
430 To construct the original version string:
431 C<$major.$minor.$release$extra>
433 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
435 I<Note:> Don't use this call to test for availability
436 of features. In enterprise distributions we backport
437 features from later versions into earlier versions,
438 making this an unreliable way to test for features.
439 Use C<guestfs_available> instead.");
441 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
442 [InitNone, Always, TestOutputTrue (
443 [["set_selinux"; "true"];
445 "set SELinux enabled or disabled at appliance boot",
447 This sets the selinux flag that is passed to the appliance
448 at boot time. The default is C<selinux=0> (disabled).
450 Note that if SELinux is enabled, it is always in
451 Permissive mode (C<enforcing=0>).
453 For more information on the architecture of libguestfs,
454 see L<guestfs(3)>.");
456 ("get_selinux", (RBool "selinux", [], []), -1, [],
458 "get SELinux enabled flag",
460 This returns the current setting of the selinux flag which
461 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
463 For more information on the architecture of libguestfs,
464 see L<guestfs(3)>.");
466 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
467 [InitNone, Always, TestOutputFalse (
468 [["set_trace"; "false"];
470 "enable or disable command traces",
472 If the command trace flag is set to 1, then commands are
473 printed on stderr before they are executed in a format
474 which is very similar to the one used by guestfish. In
475 other words, you can run a program with this enabled, and
476 you will get out a script which you can feed to guestfish
477 to perform the same set of actions.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
486 ("get_trace", (RBool "trace", [], []), -1, [],
488 "get command trace enabled flag",
490 Return the command trace flag.");
492 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
493 [InitNone, Always, TestOutputFalse (
494 [["set_direct"; "false"];
496 "enable or disable direct appliance mode",
498 If the direct appliance mode flag is enabled, then stdin and
499 stdout are passed directly through to the appliance once it
502 One consequence of this is that log messages aren't caught
503 by the library and handled by C<guestfs_set_log_message_callback>,
504 but go straight to stdout.
506 You probably don't want to use this unless you know what you
509 The default is disabled.");
511 ("get_direct", (RBool "direct", [], []), -1, [],
513 "get direct appliance mode flag",
515 Return the direct appliance mode flag.");
517 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
518 [InitNone, Always, TestOutputTrue (
519 [["set_recovery_proc"; "true"];
520 ["get_recovery_proc"]])],
521 "enable or disable the recovery process",
523 If this is called with the parameter C<false> then
524 C<guestfs_launch> does not create a recovery process. The
525 purpose of the recovery process is to stop runaway qemu
526 processes in the case where the main program aborts abruptly.
528 This only has any effect if called before C<guestfs_launch>,
529 and the default is true.
531 About the only time when you would want to disable this is
532 if the main process will fork itself into the background
533 (\"daemonize\" itself). In this case the recovery process
534 thinks that the main program has disappeared and so kills
535 qemu, which is not very helpful.");
537 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
539 "get recovery process enabled flag",
541 Return the recovery process enabled flag.");
543 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
545 "add a drive specifying the QEMU block emulation to use",
547 This is the same as C<guestfs_add_drive> but it allows you
548 to specify the QEMU interface emulation to use at run time.");
550 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
552 "add a drive read-only specifying the QEMU block emulation to use",
554 This is the same as C<guestfs_add_drive_ro> but it allows you
555 to specify the QEMU interface emulation to use at run time.");
557 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
558 [InitISOFS, Always, TestOutput (
559 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
560 InitISOFS, Always, TestOutput (
561 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
562 InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-win32.exe"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/lib-i586.so"]], "i386");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/lib-sparc.so"]], "sparc");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-win32.dll"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
582 "detect the architecture of a binary file",
584 This detects the architecture of the binary C<filename>,
585 and returns it if known.
587 Currently defined architectures are:
593 This string is returned for all 32 bit i386, i486, i586, i686 binaries
594 irrespective of the precise processor requirements of the binary.
606 64 bit SPARC V9 and above.
622 Libguestfs may return other architecture strings in future.
624 The function works on at least the following types of files:
630 many types of Un*x and Linux binary
634 many types of Un*x and Linux shared library
638 Windows Win32 and Win64 binaries
642 Windows Win32 and Win64 DLLs
644 Win32 binaries and DLLs return C<i386>.
646 Win64 binaries and DLLs return C<x86_64>.
654 Linux new-style initrd images
658 some non-x86 Linux vmlinuz kernels
662 What it can't do currently:
668 static libraries (libfoo.a)
672 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
676 x86 Linux vmlinuz kernels
678 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
679 compressed code, and are horribly hard to unpack. If you want to find
680 the architecture of a kernel, use the architecture of the associated
681 initrd or kernel module(s) instead.
685 ("inspect_os", (RStringList "roots", [], []), -1, [],
687 "inspect disk and return list of operating systems found",
689 This function uses other libguestfs functions and certain
690 heuristics to inspect the disk(s) (usually disks belonging to
691 a virtual machine), looking for operating systems.
693 The list returned is empty if no operating systems were found.
695 If one operating system was found, then this returns a list with
696 a single element, which is the name of the root filesystem of
697 this operating system. It is also possible for this function
698 to return a list containing more than one element, indicating
699 a dual-boot or multi-boot virtual machine, with each element being
700 the root filesystem of one of the operating systems.
702 You can pass the root string(s) returned to other
703 C<guestfs_inspect_get_*> functions in order to query further
704 information about each operating system, such as the name
707 This function uses other libguestfs features such as
708 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
709 and unmount filesystems and look at the contents. This should
710 be called with no disks currently mounted. The function may also
711 use Augeas, so any existing Augeas handle will be closed.
713 This function cannot decrypt encrypted disks. The caller
714 must do that first (supplying the necessary keys) if the
717 Please read L<guestfs(3)/INSPECTION> for more details.
719 See also C<guestfs_list_filesystems>.");
721 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
723 "get type of inspected operating system",
725 This function should only be called with a root device string
726 as returned by C<guestfs_inspect_os>.
728 This returns the type of the inspected operating system.
729 Currently defined types are:
735 Any Linux-based operating system.
739 Any Microsoft Windows operating system.
743 The operating system type could not be determined.
747 Future versions of libguestfs may return other strings here.
748 The caller should be prepared to handle any string.
750 Please read L<guestfs(3)/INSPECTION> for more details.");
752 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
754 "get architecture of inspected operating system",
756 This function should only be called with a root device string
757 as returned by C<guestfs_inspect_os>.
759 This returns the architecture of the inspected operating system.
760 The possible return values are listed under
761 C<guestfs_file_architecture>.
763 If the architecture could not be determined, then the
764 string C<unknown> is returned.
766 Please read L<guestfs(3)/INSPECTION> for more details.");
768 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
770 "get distro of inspected operating system",
772 This function should only be called with a root device string
773 as returned by C<guestfs_inspect_os>.
775 This returns the distro (distribution) of the inspected operating
778 Currently defined distros are:
788 Debian or a Debian-derived distro such as Ubuntu.
806 =item \"redhat-based\"
808 Some Red Hat-derived distro.
812 Red Hat Enterprise Linux and some derivatives.
816 Windows does not have distributions. This string is
817 returned if the OS type is Windows.
825 The distro could not be determined.
829 Future versions of libguestfs may return other strings here.
830 The caller should be prepared to handle any string.
832 Please read L<guestfs(3)/INSPECTION> for more details.");
834 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
836 "get major version of inspected operating system",
838 This function should only be called with a root device string
839 as returned by C<guestfs_inspect_os>.
841 This returns the major version number of the inspected operating
844 Windows uses a consistent versioning scheme which is I<not>
845 reflected in the popular public names used by the operating system.
846 Notably the operating system known as \"Windows 7\" is really
847 version 6.1 (ie. major = 6, minor = 1). You can find out the
848 real versions corresponding to releases of Windows by consulting
851 If the version could not be determined, then C<0> is returned.
853 Please read L<guestfs(3)/INSPECTION> for more details.");
855 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
857 "get minor version of inspected operating system",
859 This function should only be called with a root device string
860 as returned by C<guestfs_inspect_os>.
862 This returns the minor version number of the inspected operating
865 If the version could not be determined, then C<0> is returned.
867 Please read L<guestfs(3)/INSPECTION> for more details.
868 See also C<guestfs_inspect_get_major_version>.");
870 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
872 "get product name of inspected operating system",
874 This function should only be called with a root device string
875 as returned by C<guestfs_inspect_os>.
877 This returns the product name of the inspected operating
878 system. The product name is generally some freeform string
879 which can be displayed to the user, but should not be
882 If the product name could not be determined, then the
883 string C<unknown> is returned.
885 Please read L<guestfs(3)/INSPECTION> for more details.");
887 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
889 "get mountpoints of inspected operating system",
891 This function should only be called with a root device string
892 as returned by C<guestfs_inspect_os>.
894 This returns a hash of where we think the filesystems
895 associated with this operating system should be mounted.
896 Callers should note that this is at best an educated guess
897 made by reading configuration files such as C</etc/fstab>.
899 Each element in the returned hashtable has a key which
900 is the path of the mountpoint (eg. C</boot>) and a value
901 which is the filesystem that would be mounted there
904 Non-mounted devices such as swap devices are I<not>
905 returned in this list.
907 Please read L<guestfs(3)/INSPECTION> for more details.
908 See also C<guestfs_inspect_get_filesystems>.");
910 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
912 "get filesystems associated with inspected operating system",
914 This function should only be called with a root device string
915 as returned by C<guestfs_inspect_os>.
917 This returns a list of all the filesystems that we think
918 are associated with this operating system. This includes
919 the root filesystem, other ordinary filesystems, and
920 non-mounted devices like swap partitions.
922 In the case of a multi-boot virtual machine, it is possible
923 for a filesystem to be shared between operating systems.
925 Please read L<guestfs(3)/INSPECTION> for more details.
926 See also C<guestfs_inspect_get_mountpoints>.");
928 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
930 "set enable network flag",
932 If C<network> is true, then the network is enabled in the
933 libguestfs appliance. The default is false.
935 This affects whether commands are able to access the network
936 (see L<guestfs(3)/RUNNING COMMANDS>).
938 You must call this before calling C<guestfs_launch>, otherwise
941 ("get_network", (RBool "network", [], []), -1, [],
943 "get enable network flag",
945 This returns the enable network flag.");
947 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
951 This inspection command looks for filesystems on partitions,
952 block devices and logical volumes, returning a list of devices
953 containing filesystems and their type.
955 The return value is a hash, where the keys are the devices
956 containing filesystems, and the values are the filesystem types.
959 \"/dev/sda1\" => \"ntfs\"
960 \"/dev/sda2\" => \"ext2\"
961 \"/dev/vg_guest/lv_root\" => \"ext4\"
962 \"/dev/vg_guest/lv_swap\" => \"swap\"
964 The value can have the special value \"unknown\", meaning the
965 content of the device is undetermined or empty.
966 \"swap\" means a Linux swap partition.
968 This command runs other libguestfs commands, which might include
969 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
970 use this soon after launch and only when nothing is mounted.
972 Not all of the filesystems returned will be mountable. In
973 particular, swap partitions are returned in the list. Also
974 this command does not check that each filesystem
975 found is valid and mountable, and some filesystems might
976 be mountable but require special options. Filesystems may
977 not all belong to a single logical operating system
978 (use C<guestfs_inspect_os> to look for OSes).");
980 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
982 "add an image to examine or modify",
984 This function adds a virtual machine disk image C<filename> to
985 libguestfs. The first time you call this function, the disk
986 appears as C</dev/sda>, the second time as C</dev/sdb>, and
989 You don't necessarily need to be root when using libguestfs. However
990 you obviously do need sufficient permissions to access the filename
991 for whatever operations you want to perform (ie. read access if you
992 just want to read the image or write access if you want to modify the
995 This call checks that C<filename> exists.
997 The optional arguments are:
1003 If true then the image is treated as read-only. Writes are still
1004 allowed, but they are stored in a temporary snapshot overlay which
1005 is discarded at the end. The disk that you add is not modified.
1009 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1010 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1011 Possible formats include C<raw> and C<qcow2>.
1013 Automatic detection of the format opens you up to a potential
1014 security hole when dealing with untrusted raw-format images.
1015 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1020 This rarely-used option lets you emulate the behaviour of the
1021 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1025 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1027 "get Windows systemroot of inspected operating system",
1029 This function should only be called with a root device string
1030 as returned by C<guestfs_inspect_os>.
1032 This returns the Windows systemroot of the inspected guest.
1033 The systemroot is a directory path such as C</WINDOWS>.
1035 This call assumes that the guest is Windows and that the
1036 systemroot could be determined by inspection. If this is not
1037 the case then an error is returned.
1039 Please read L<guestfs(3)/INSPECTION> for more details.");
1041 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1043 "return list of operating systems found by last inspection",
1045 This function is a convenient way to get the list of root
1046 devices, as returned from a previous call to C<guestfs_inspect_os>,
1047 but without redoing the whole inspection process.
1049 This returns an empty list if either no root devices were
1050 found or the caller has not called C<guestfs_inspect_os>.
1052 Please read L<guestfs(3)/INSPECTION> for more details.");
1056 (* daemon_functions are any functions which cause some action
1057 * to take place in the daemon.
1060 let daemon_functions = [
1061 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1062 [InitEmpty, Always, TestOutput (
1063 [["part_disk"; "/dev/sda"; "mbr"];
1064 ["mkfs"; "ext2"; "/dev/sda1"];
1065 ["mount"; "/dev/sda1"; "/"];
1066 ["write"; "/new"; "new file contents"];
1067 ["cat"; "/new"]], "new file contents")],
1068 "mount a guest disk at a position in the filesystem",
1070 Mount a guest disk at a position in the filesystem. Block devices
1071 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1072 the guest. If those block devices contain partitions, they will have
1073 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1076 The rules are the same as for L<mount(2)>: A filesystem must
1077 first be mounted on C</> before others can be mounted. Other
1078 filesystems can only be mounted on directories which already
1081 The mounted filesystem is writable, if we have sufficient permissions
1082 on the underlying device.
1085 When you use this call, the filesystem options C<sync> and C<noatime>
1086 are set implicitly. This was originally done because we thought it
1087 would improve reliability, but it turns out that I<-o sync> has a
1088 very large negative performance impact and negligible effect on
1089 reliability. Therefore we recommend that you avoid using
1090 C<guestfs_mount> in any code that needs performance, and instead
1091 use C<guestfs_mount_options> (use an empty string for the first
1092 parameter if you don't want any options).");
1094 ("sync", (RErr, [], []), 2, [],
1095 [ InitEmpty, Always, TestRun [["sync"]]],
1096 "sync disks, writes are flushed through to the disk image",
1098 This syncs the disk, so that any writes are flushed through to the
1099 underlying disk image.
1101 You should always call this if you have modified a disk image, before
1102 closing the handle.");
1104 ("touch", (RErr, [Pathname "path"], []), 3, [],
1105 [InitBasicFS, Always, TestOutputTrue (
1107 ["exists"; "/new"]])],
1108 "update file timestamps or create a new file",
1110 Touch acts like the L<touch(1)> command. It can be used to
1111 update the timestamps on a file, or, if the file does not exist,
1112 to create a new zero-length file.
1114 This command only works on regular files, and will fail on other
1115 file types such as directories, symbolic links, block special etc.");
1117 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1118 [InitISOFS, Always, TestOutput (
1119 [["cat"; "/known-2"]], "abcdef\n")],
1120 "list the contents of a file",
1122 Return the contents of the file named C<path>.
1124 Note that this function cannot correctly handle binary files
1125 (specifically, files containing C<\\0> character which is treated
1126 as end of string). For those you need to use the C<guestfs_read_file>
1127 or C<guestfs_download> functions which have a more complex interface.");
1129 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1130 [], (* XXX Tricky to test because it depends on the exact format
1131 * of the 'ls -l' command, which changes between F10 and F11.
1133 "list the files in a directory (long format)",
1135 List the files in C<directory> (relative to the root directory,
1136 there is no cwd) in the format of 'ls -la'.
1138 This command is mostly useful for interactive sessions. It
1139 is I<not> intended that you try to parse the output string.");
1141 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1142 [InitBasicFS, Always, TestOutputList (
1144 ["touch"; "/newer"];
1145 ["touch"; "/newest"];
1146 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1147 "list the files in a directory",
1149 List the files in C<directory> (relative to the root directory,
1150 there is no cwd). The '.' and '..' entries are not returned, but
1151 hidden files are shown.
1153 This command is mostly useful for interactive sessions. Programs
1154 should probably use C<guestfs_readdir> instead.");
1156 ("list_devices", (RStringList "devices", [], []), 7, [],
1157 [InitEmpty, Always, TestOutputListOfDevices (
1158 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1159 "list the block devices",
1161 List all the block devices.
1163 The full block device names are returned, eg. C</dev/sda>.
1165 See also C<guestfs_list_filesystems>.");
1167 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1168 [InitBasicFS, Always, TestOutputListOfDevices (
1169 [["list_partitions"]], ["/dev/sda1"]);
1170 InitEmpty, Always, TestOutputListOfDevices (
1171 [["part_init"; "/dev/sda"; "mbr"];
1172 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1173 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1174 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1175 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1176 "list the partitions",
1178 List all the partitions detected on all block devices.
1180 The full partition device names are returned, eg. C</dev/sda1>
1182 This does not return logical volumes. For that you will need to
1183 call C<guestfs_lvs>.
1185 See also C<guestfs_list_filesystems>.");
1187 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1188 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1189 [["pvs"]], ["/dev/sda1"]);
1190 InitEmpty, Always, TestOutputListOfDevices (
1191 [["part_init"; "/dev/sda"; "mbr"];
1192 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1193 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1194 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1195 ["pvcreate"; "/dev/sda1"];
1196 ["pvcreate"; "/dev/sda2"];
1197 ["pvcreate"; "/dev/sda3"];
1198 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1199 "list the LVM physical volumes (PVs)",
1201 List all the physical volumes detected. This is the equivalent
1202 of the L<pvs(8)> command.
1204 This returns a list of just the device names that contain
1205 PVs (eg. C</dev/sda2>).
1207 See also C<guestfs_pvs_full>.");
1209 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1210 [InitBasicFSonLVM, Always, TestOutputList (
1212 InitEmpty, Always, TestOutputList (
1213 [["part_init"; "/dev/sda"; "mbr"];
1214 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1215 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1216 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1217 ["pvcreate"; "/dev/sda1"];
1218 ["pvcreate"; "/dev/sda2"];
1219 ["pvcreate"; "/dev/sda3"];
1220 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1221 ["vgcreate"; "VG2"; "/dev/sda3"];
1222 ["vgs"]], ["VG1"; "VG2"])],
1223 "list the LVM volume groups (VGs)",
1225 List all the volumes groups detected. This is the equivalent
1226 of the L<vgs(8)> command.
1228 This returns a list of just the volume group names that were
1229 detected (eg. C<VolGroup00>).
1231 See also C<guestfs_vgs_full>.");
1233 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1234 [InitBasicFSonLVM, Always, TestOutputList (
1235 [["lvs"]], ["/dev/VG/LV"]);
1236 InitEmpty, Always, TestOutputList (
1237 [["part_init"; "/dev/sda"; "mbr"];
1238 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1239 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1240 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1241 ["pvcreate"; "/dev/sda1"];
1242 ["pvcreate"; "/dev/sda2"];
1243 ["pvcreate"; "/dev/sda3"];
1244 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1245 ["vgcreate"; "VG2"; "/dev/sda3"];
1246 ["lvcreate"; "LV1"; "VG1"; "50"];
1247 ["lvcreate"; "LV2"; "VG1"; "50"];
1248 ["lvcreate"; "LV3"; "VG2"; "50"];
1249 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1250 "list the LVM logical volumes (LVs)",
1252 List all the logical volumes detected. This is the equivalent
1253 of the L<lvs(8)> command.
1255 This returns a list of the logical volume device names
1256 (eg. C</dev/VolGroup00/LogVol00>).
1258 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1260 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1261 [], (* XXX how to test? *)
1262 "list the LVM physical volumes (PVs)",
1264 List all the physical volumes detected. This is the equivalent
1265 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1267 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1268 [], (* XXX how to test? *)
1269 "list the LVM volume groups (VGs)",
1271 List all the volumes groups detected. This is the equivalent
1272 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1274 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1275 [], (* XXX how to test? *)
1276 "list the LVM logical volumes (LVs)",
1278 List all the logical volumes detected. This is the equivalent
1279 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1281 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1282 [InitISOFS, Always, TestOutputList (
1283 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1284 InitISOFS, Always, TestOutputList (
1285 [["read_lines"; "/empty"]], [])],
1286 "read file as lines",
1288 Return the contents of the file named C<path>.
1290 The file contents are returned as a list of lines. Trailing
1291 C<LF> and C<CRLF> character sequences are I<not> returned.
1293 Note that this function cannot correctly handle binary files
1294 (specifically, files containing C<\\0> character which is treated
1295 as end of line). For those you need to use the C<guestfs_read_file>
1296 function which has a more complex interface.");
1298 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1299 [], (* XXX Augeas code needs tests. *)
1300 "create a new Augeas handle",
1302 Create a new Augeas handle for editing configuration files.
1303 If there was any previous Augeas handle associated with this
1304 guestfs session, then it is closed.
1306 You must call this before using any other C<guestfs_aug_*>
1309 C<root> is the filesystem root. C<root> must not be NULL,
1312 The flags are the same as the flags defined in
1313 E<lt>augeas.hE<gt>, the logical I<or> of the following
1318 =item C<AUG_SAVE_BACKUP> = 1
1320 Keep the original file with a C<.augsave> extension.
1322 =item C<AUG_SAVE_NEWFILE> = 2
1324 Save changes into a file with extension C<.augnew>, and
1325 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1327 =item C<AUG_TYPE_CHECK> = 4
1329 Typecheck lenses (can be expensive).
1331 =item C<AUG_NO_STDINC> = 8
1333 Do not use standard load path for modules.
1335 =item C<AUG_SAVE_NOOP> = 16
1337 Make save a no-op, just record what would have been changed.
1339 =item C<AUG_NO_LOAD> = 32
1341 Do not load the tree in C<guestfs_aug_init>.
1345 To close the handle, you can call C<guestfs_aug_close>.
1347 To find out more about Augeas, see L<http://augeas.net/>.");
1349 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1350 [], (* XXX Augeas code needs tests. *)
1351 "close the current Augeas handle",
1353 Close the current Augeas handle and free up any resources
1354 used by it. After calling this, you have to call
1355 C<guestfs_aug_init> again before you can use any other
1356 Augeas functions.");
1358 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1359 [], (* XXX Augeas code needs tests. *)
1360 "define an Augeas variable",
1362 Defines an Augeas variable C<name> whose value is the result
1363 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1366 On success this returns the number of nodes in C<expr>, or
1367 C<0> if C<expr> evaluates to something which is not a nodeset.");
1369 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1370 [], (* XXX Augeas code needs tests. *)
1371 "define an Augeas node",
1373 Defines a variable C<name> whose value is the result of
1376 If C<expr> evaluates to an empty nodeset, a node is created,
1377 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1378 C<name> will be the nodeset containing that single node.
1380 On success this returns a pair containing the
1381 number of nodes in the nodeset, and a boolean flag
1382 if a node was created.");
1384 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1385 [], (* XXX Augeas code needs tests. *)
1386 "look up the value of an Augeas path",
1388 Look up the value associated with C<path>. If C<path>
1389 matches exactly one node, the C<value> is returned.");
1391 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1392 [], (* XXX Augeas code needs tests. *)
1393 "set Augeas path to value",
1395 Set the value associated with C<path> to C<val>.
1397 In the Augeas API, it is possible to clear a node by setting
1398 the value to NULL. Due to an oversight in the libguestfs API
1399 you cannot do that with this call. Instead you must use the
1400 C<guestfs_aug_clear> call.");
1402 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1403 [], (* XXX Augeas code needs tests. *)
1404 "insert a sibling Augeas node",
1406 Create a new sibling C<label> for C<path>, inserting it into
1407 the tree before or after C<path> (depending on the boolean
1410 C<path> must match exactly one existing node in the tree, and
1411 C<label> must be a label, ie. not contain C</>, C<*> or end
1412 with a bracketed index C<[N]>.");
1414 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1415 [], (* XXX Augeas code needs tests. *)
1416 "remove an Augeas path",
1418 Remove C<path> and all of its children.
1420 On success this returns the number of entries which were removed.");
1422 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1423 [], (* XXX Augeas code needs tests. *)
1426 Move the node C<src> to C<dest>. C<src> must match exactly
1427 one node. C<dest> is overwritten if it exists.");
1429 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1430 [], (* XXX Augeas code needs tests. *)
1431 "return Augeas nodes which match augpath",
1433 Returns a list of paths which match the path expression C<path>.
1434 The returned paths are sufficiently qualified so that they match
1435 exactly one node in the current tree.");
1437 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1438 [], (* XXX Augeas code needs tests. *)
1439 "write all pending Augeas changes to disk",
1441 This writes all pending changes to disk.
1443 The flags which were passed to C<guestfs_aug_init> affect exactly
1444 how files are saved.");
1446 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1447 [], (* XXX Augeas code needs tests. *)
1448 "load files into the tree",
1450 Load files into the tree.
1452 See C<aug_load> in the Augeas documentation for the full gory
1455 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1456 [], (* XXX Augeas code needs tests. *)
1457 "list Augeas nodes under augpath",
1459 This is just a shortcut for listing C<guestfs_aug_match>
1460 C<path/*> and sorting the resulting nodes into alphabetical order.");
1462 ("rm", (RErr, [Pathname "path"], []), 29, [],
1463 [InitBasicFS, Always, TestRun
1466 InitBasicFS, Always, TestLastFail
1468 InitBasicFS, Always, TestLastFail
1473 Remove the single file C<path>.");
1475 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1476 [InitBasicFS, Always, TestRun
1479 InitBasicFS, Always, TestLastFail
1480 [["rmdir"; "/new"]];
1481 InitBasicFS, Always, TestLastFail
1483 ["rmdir"; "/new"]]],
1484 "remove a directory",
1486 Remove the single directory C<path>.");
1488 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1489 [InitBasicFS, Always, TestOutputFalse
1491 ["mkdir"; "/new/foo"];
1492 ["touch"; "/new/foo/bar"];
1494 ["exists"; "/new"]]],
1495 "remove a file or directory recursively",
1497 Remove the file or directory C<path>, recursively removing the
1498 contents if its a directory. This is like the C<rm -rf> shell
1501 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1502 [InitBasicFS, Always, TestOutputTrue
1504 ["is_dir"; "/new"]];
1505 InitBasicFS, Always, TestLastFail
1506 [["mkdir"; "/new/foo/bar"]]],
1507 "create a directory",
1509 Create a directory named C<path>.");
1511 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1512 [InitBasicFS, Always, TestOutputTrue
1513 [["mkdir_p"; "/new/foo/bar"];
1514 ["is_dir"; "/new/foo/bar"]];
1515 InitBasicFS, Always, TestOutputTrue
1516 [["mkdir_p"; "/new/foo/bar"];
1517 ["is_dir"; "/new/foo"]];
1518 InitBasicFS, Always, TestOutputTrue
1519 [["mkdir_p"; "/new/foo/bar"];
1520 ["is_dir"; "/new"]];
1521 (* Regression tests for RHBZ#503133: *)
1522 InitBasicFS, Always, TestRun
1524 ["mkdir_p"; "/new"]];
1525 InitBasicFS, Always, TestLastFail
1527 ["mkdir_p"; "/new"]]],
1528 "create a directory and parents",
1530 Create a directory named C<path>, creating any parent directories
1531 as necessary. This is like the C<mkdir -p> shell command.");
1533 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1534 [], (* XXX Need stat command to test *)
1537 Change the mode (permissions) of C<path> to C<mode>. Only
1538 numeric modes are supported.
1540 I<Note>: When using this command from guestfish, C<mode>
1541 by default would be decimal, unless you prefix it with
1542 C<0> to get octal, ie. use C<0700> not C<700>.
1544 The mode actually set is affected by the umask.");
1546 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1547 [], (* XXX Need stat command to test *)
1548 "change file owner and group",
1550 Change the file owner to C<owner> and group to C<group>.
1552 Only numeric uid and gid are supported. If you want to use
1553 names, you will need to locate and parse the password file
1554 yourself (Augeas support makes this relatively easy).");
1556 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1557 [InitISOFS, Always, TestOutputTrue (
1558 [["exists"; "/empty"]]);
1559 InitISOFS, Always, TestOutputTrue (
1560 [["exists"; "/directory"]])],
1561 "test if file or directory exists",
1563 This returns C<true> if and only if there is a file, directory
1564 (or anything) with the given C<path> name.
1566 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1568 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1569 [InitISOFS, Always, TestOutputTrue (
1570 [["is_file"; "/known-1"]]);
1571 InitISOFS, Always, TestOutputFalse (
1572 [["is_file"; "/directory"]])],
1573 "test if a regular file",
1575 This returns C<true> if and only if there is a regular file
1576 with the given C<path> name. Note that it returns false for
1577 other objects like directories.
1579 See also C<guestfs_stat>.");
1581 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1582 [InitISOFS, Always, TestOutputFalse (
1583 [["is_dir"; "/known-3"]]);
1584 InitISOFS, Always, TestOutputTrue (
1585 [["is_dir"; "/directory"]])],
1586 "test if a directory",
1588 This returns C<true> if and only if there is a directory
1589 with the given C<path> name. Note that it returns false for
1590 other objects like files.
1592 See also C<guestfs_stat>.");
1594 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1595 [InitEmpty, Always, TestOutputListOfDevices (
1596 [["part_init"; "/dev/sda"; "mbr"];
1597 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1598 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1599 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1600 ["pvcreate"; "/dev/sda1"];
1601 ["pvcreate"; "/dev/sda2"];
1602 ["pvcreate"; "/dev/sda3"];
1603 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1604 "create an LVM physical volume",
1606 This creates an LVM physical volume on the named C<device>,
1607 where C<device> should usually be a partition name such
1610 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1611 [InitEmpty, Always, TestOutputList (
1612 [["part_init"; "/dev/sda"; "mbr"];
1613 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1614 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1615 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1616 ["pvcreate"; "/dev/sda1"];
1617 ["pvcreate"; "/dev/sda2"];
1618 ["pvcreate"; "/dev/sda3"];
1619 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1620 ["vgcreate"; "VG2"; "/dev/sda3"];
1621 ["vgs"]], ["VG1"; "VG2"])],
1622 "create an LVM volume group",
1624 This creates an LVM volume group called C<volgroup>
1625 from the non-empty list of physical volumes C<physvols>.");
1627 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1628 [InitEmpty, Always, TestOutputList (
1629 [["part_init"; "/dev/sda"; "mbr"];
1630 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1631 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1632 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1633 ["pvcreate"; "/dev/sda1"];
1634 ["pvcreate"; "/dev/sda2"];
1635 ["pvcreate"; "/dev/sda3"];
1636 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1637 ["vgcreate"; "VG2"; "/dev/sda3"];
1638 ["lvcreate"; "LV1"; "VG1"; "50"];
1639 ["lvcreate"; "LV2"; "VG1"; "50"];
1640 ["lvcreate"; "LV3"; "VG2"; "50"];
1641 ["lvcreate"; "LV4"; "VG2"; "50"];
1642 ["lvcreate"; "LV5"; "VG2"; "50"];
1644 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1645 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1646 "create an LVM logical volume",
1648 This creates an LVM logical volume called C<logvol>
1649 on the volume group C<volgroup>, with C<size> megabytes.");
1651 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1652 [InitEmpty, Always, TestOutput (
1653 [["part_disk"; "/dev/sda"; "mbr"];
1654 ["mkfs"; "ext2"; "/dev/sda1"];
1655 ["mount_options"; ""; "/dev/sda1"; "/"];
1656 ["write"; "/new"; "new file contents"];
1657 ["cat"; "/new"]], "new file contents")],
1658 "make a filesystem",
1660 This creates a filesystem on C<device> (usually a partition
1661 or LVM logical volume). The filesystem type is C<fstype>, for
1664 ("sfdisk", (RErr, [Device "device";
1665 Int "cyls"; Int "heads"; Int "sectors";
1666 StringList "lines"], []), 43, [DangerWillRobinson],
1668 "create partitions on a block device",
1670 This is a direct interface to the L<sfdisk(8)> program for creating
1671 partitions on block devices.
1673 C<device> should be a block device, for example C</dev/sda>.
1675 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1676 and sectors on the device, which are passed directly to sfdisk as
1677 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1678 of these, then the corresponding parameter is omitted. Usually for
1679 'large' disks, you can just pass C<0> for these, but for small
1680 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1681 out the right geometry and you will need to tell it.
1683 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1684 information refer to the L<sfdisk(8)> manpage.
1686 To create a single partition occupying the whole disk, you would
1687 pass C<lines> as a single element list, when the single element being
1688 the string C<,> (comma).
1690 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1691 C<guestfs_part_init>");
1693 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1694 (* Regression test for RHBZ#597135. *)
1695 [InitBasicFS, Always, TestLastFail
1696 [["write_file"; "/new"; "abc"; "10000"]]],
1699 This call creates a file called C<path>. The contents of the
1700 file is the string C<content> (which can contain any 8 bit data),
1701 with length C<size>.
1703 As a special case, if C<size> is C<0>
1704 then the length is calculated using C<strlen> (so in this case
1705 the content cannot contain embedded ASCII NULs).
1707 I<NB.> Owing to a bug, writing content containing ASCII NUL
1708 characters does I<not> work, even if the length is specified.");
1710 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1711 [InitEmpty, Always, TestOutputListOfDevices (
1712 [["part_disk"; "/dev/sda"; "mbr"];
1713 ["mkfs"; "ext2"; "/dev/sda1"];
1714 ["mount_options"; ""; "/dev/sda1"; "/"];
1715 ["mounts"]], ["/dev/sda1"]);
1716 InitEmpty, Always, TestOutputList (
1717 [["part_disk"; "/dev/sda"; "mbr"];
1718 ["mkfs"; "ext2"; "/dev/sda1"];
1719 ["mount_options"; ""; "/dev/sda1"; "/"];
1722 "unmount a filesystem",
1724 This unmounts the given filesystem. The filesystem may be
1725 specified either by its mountpoint (path) or the device which
1726 contains the filesystem.");
1728 ("mounts", (RStringList "devices", [], []), 46, [],
1729 [InitBasicFS, Always, TestOutputListOfDevices (
1730 [["mounts"]], ["/dev/sda1"])],
1731 "show mounted filesystems",
1733 This returns the list of currently mounted filesystems. It returns
1734 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1736 Some internal mounts are not shown.
1738 See also: C<guestfs_mountpoints>");
1740 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1741 [InitBasicFS, Always, TestOutputList (
1744 (* check that umount_all can unmount nested mounts correctly: *)
1745 InitEmpty, Always, TestOutputList (
1746 [["part_init"; "/dev/sda"; "mbr"];
1747 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1748 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1749 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1750 ["mkfs"; "ext2"; "/dev/sda1"];
1751 ["mkfs"; "ext2"; "/dev/sda2"];
1752 ["mkfs"; "ext2"; "/dev/sda3"];
1753 ["mount_options"; ""; "/dev/sda1"; "/"];
1755 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1756 ["mkdir"; "/mp1/mp2"];
1757 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1758 ["mkdir"; "/mp1/mp2/mp3"];
1761 "unmount all filesystems",
1763 This unmounts all mounted filesystems.
1765 Some internal mounts are not unmounted by this call.");
1767 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1769 "remove all LVM LVs, VGs and PVs",
1771 This command removes all LVM logical volumes, volume groups
1772 and physical volumes.");
1774 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
1775 [InitISOFS, Always, TestOutput (
1776 [["file"; "/empty"]], "empty");
1777 InitISOFS, Always, TestOutput (
1778 [["file"; "/known-1"]], "ASCII text");
1779 InitISOFS, Always, TestLastFail (
1780 [["file"; "/notexists"]]);
1781 InitISOFS, Always, TestOutput (
1782 [["file"; "/abssymlink"]], "symbolic link");
1783 InitISOFS, Always, TestOutput (
1784 [["file"; "/directory"]], "directory")],
1785 "determine file type",
1787 This call uses the standard L<file(1)> command to determine
1788 the type or contents of the file.
1790 This call will also transparently look inside various types
1793 The exact command which runs is C<file -zb path>. Note in
1794 particular that the filename is not prepended to the output
1797 This command can also be used on C</dev/> devices
1798 (and partitions, LV names). You can for example use this
1799 to determine if a device contains a filesystem, although
1800 it's usually better to use C<guestfs_vfs_type>.
1802 If the C<path> does not begin with C</dev/> then
1803 this command only works for the content of regular files.
1804 For other file types (directory, symbolic link etc) it
1805 will just return the string C<directory> etc.");
1807 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
1808 [InitBasicFS, Always, TestOutput (
1809 [["upload"; "test-command"; "/test-command"];
1810 ["chmod"; "0o755"; "/test-command"];
1811 ["command"; "/test-command 1"]], "Result1");
1812 InitBasicFS, Always, TestOutput (
1813 [["upload"; "test-command"; "/test-command"];
1814 ["chmod"; "0o755"; "/test-command"];
1815 ["command"; "/test-command 2"]], "Result2\n");
1816 InitBasicFS, Always, TestOutput (
1817 [["upload"; "test-command"; "/test-command"];
1818 ["chmod"; "0o755"; "/test-command"];
1819 ["command"; "/test-command 3"]], "\nResult3");
1820 InitBasicFS, Always, TestOutput (
1821 [["upload"; "test-command"; "/test-command"];
1822 ["chmod"; "0o755"; "/test-command"];
1823 ["command"; "/test-command 4"]], "\nResult4\n");
1824 InitBasicFS, Always, TestOutput (
1825 [["upload"; "test-command"; "/test-command"];
1826 ["chmod"; "0o755"; "/test-command"];
1827 ["command"; "/test-command 5"]], "\nResult5\n\n");
1828 InitBasicFS, Always, TestOutput (
1829 [["upload"; "test-command"; "/test-command"];
1830 ["chmod"; "0o755"; "/test-command"];
1831 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1832 InitBasicFS, Always, TestOutput (
1833 [["upload"; "test-command"; "/test-command"];
1834 ["chmod"; "0o755"; "/test-command"];
1835 ["command"; "/test-command 7"]], "");
1836 InitBasicFS, Always, TestOutput (
1837 [["upload"; "test-command"; "/test-command"];
1838 ["chmod"; "0o755"; "/test-command"];
1839 ["command"; "/test-command 8"]], "\n");
1840 InitBasicFS, Always, TestOutput (
1841 [["upload"; "test-command"; "/test-command"];
1842 ["chmod"; "0o755"; "/test-command"];
1843 ["command"; "/test-command 9"]], "\n\n");
1844 InitBasicFS, Always, TestOutput (
1845 [["upload"; "test-command"; "/test-command"];
1846 ["chmod"; "0o755"; "/test-command"];
1847 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1848 InitBasicFS, Always, TestOutput (
1849 [["upload"; "test-command"; "/test-command"];
1850 ["chmod"; "0o755"; "/test-command"];
1851 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1852 InitBasicFS, Always, TestLastFail (
1853 [["upload"; "test-command"; "/test-command"];
1854 ["chmod"; "0o755"; "/test-command"];
1855 ["command"; "/test-command"]])],
1856 "run a command from the guest filesystem",
1858 This call runs a command from the guest filesystem. The
1859 filesystem must be mounted, and must contain a compatible
1860 operating system (ie. something Linux, with the same
1861 or compatible processor architecture).
1863 The single parameter is an argv-style list of arguments.
1864 The first element is the name of the program to run.
1865 Subsequent elements are parameters. The list must be
1866 non-empty (ie. must contain a program name). Note that
1867 the command runs directly, and is I<not> invoked via
1868 the shell (see C<guestfs_sh>).
1870 The return value is anything printed to I<stdout> by
1873 If the command returns a non-zero exit status, then
1874 this function returns an error message. The error message
1875 string is the content of I<stderr> from the command.
1877 The C<$PATH> environment variable will contain at least
1878 C</usr/bin> and C</bin>. If you require a program from
1879 another location, you should provide the full path in the
1882 Shared libraries and data files required by the program
1883 must be available on filesystems which are mounted in the
1884 correct places. It is the caller's responsibility to ensure
1885 all filesystems that are needed are mounted at the right
1888 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
1889 [InitBasicFS, Always, TestOutputList (
1890 [["upload"; "test-command"; "/test-command"];
1891 ["chmod"; "0o755"; "/test-command"];
1892 ["command_lines"; "/test-command 1"]], ["Result1"]);
1893 InitBasicFS, Always, TestOutputList (
1894 [["upload"; "test-command"; "/test-command"];
1895 ["chmod"; "0o755"; "/test-command"];
1896 ["command_lines"; "/test-command 2"]], ["Result2"]);
1897 InitBasicFS, Always, TestOutputList (
1898 [["upload"; "test-command"; "/test-command"];
1899 ["chmod"; "0o755"; "/test-command"];
1900 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1901 InitBasicFS, Always, TestOutputList (
1902 [["upload"; "test-command"; "/test-command"];
1903 ["chmod"; "0o755"; "/test-command"];
1904 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1905 InitBasicFS, Always, TestOutputList (
1906 [["upload"; "test-command"; "/test-command"];
1907 ["chmod"; "0o755"; "/test-command"];
1908 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1909 InitBasicFS, Always, TestOutputList (
1910 [["upload"; "test-command"; "/test-command"];
1911 ["chmod"; "0o755"; "/test-command"];
1912 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1913 InitBasicFS, Always, TestOutputList (
1914 [["upload"; "test-command"; "/test-command"];
1915 ["chmod"; "0o755"; "/test-command"];
1916 ["command_lines"; "/test-command 7"]], []);
1917 InitBasicFS, Always, TestOutputList (
1918 [["upload"; "test-command"; "/test-command"];
1919 ["chmod"; "0o755"; "/test-command"];
1920 ["command_lines"; "/test-command 8"]], [""]);
1921 InitBasicFS, Always, TestOutputList (
1922 [["upload"; "test-command"; "/test-command"];
1923 ["chmod"; "0o755"; "/test-command"];
1924 ["command_lines"; "/test-command 9"]], ["";""]);
1925 InitBasicFS, Always, TestOutputList (
1926 [["upload"; "test-command"; "/test-command"];
1927 ["chmod"; "0o755"; "/test-command"];
1928 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1929 InitBasicFS, Always, TestOutputList (
1930 [["upload"; "test-command"; "/test-command"];
1931 ["chmod"; "0o755"; "/test-command"];
1932 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1933 "run a command, returning lines",
1935 This is the same as C<guestfs_command>, but splits the
1936 result into a list of lines.
1938 See also: C<guestfs_sh_lines>");
1940 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
1941 [InitISOFS, Always, TestOutputStruct (
1942 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1943 "get file information",
1945 Returns file information for the given C<path>.
1947 This is the same as the C<stat(2)> system call.");
1949 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
1950 [InitISOFS, Always, TestOutputStruct (
1951 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1952 "get file information for a symbolic link",
1954 Returns file information for the given C<path>.
1956 This is the same as C<guestfs_stat> except that if C<path>
1957 is a symbolic link, then the link is stat-ed, not the file it
1960 This is the same as the C<lstat(2)> system call.");
1962 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
1963 [InitISOFS, Always, TestOutputStruct (
1964 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1965 "get file system statistics",
1967 Returns file system statistics for any mounted file system.
1968 C<path> should be a file or directory in the mounted file system
1969 (typically it is the mount point itself, but it doesn't need to be).
1971 This is the same as the C<statvfs(2)> system call.");
1973 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
1975 "get ext2/ext3/ext4 superblock details",
1977 This returns the contents of the ext2, ext3 or ext4 filesystem
1978 superblock on C<device>.
1980 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1981 manpage for more details. The list of fields returned isn't
1982 clearly defined, and depends on both the version of C<tune2fs>
1983 that libguestfs was built against, and the filesystem itself.");
1985 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
1986 [InitEmpty, Always, TestOutputTrue (
1987 [["blockdev_setro"; "/dev/sda"];
1988 ["blockdev_getro"; "/dev/sda"]])],
1989 "set block device to read-only",
1991 Sets the block device named C<device> to read-only.
1993 This uses the L<blockdev(8)> command.");
1995 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
1996 [InitEmpty, Always, TestOutputFalse (
1997 [["blockdev_setrw"; "/dev/sda"];
1998 ["blockdev_getro"; "/dev/sda"]])],
1999 "set block device to read-write",
2001 Sets the block device named C<device> to read-write.
2003 This uses the L<blockdev(8)> command.");
2005 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2006 [InitEmpty, Always, TestOutputTrue (
2007 [["blockdev_setro"; "/dev/sda"];
2008 ["blockdev_getro"; "/dev/sda"]])],
2009 "is block device set to read-only",
2011 Returns a boolean indicating if the block device is read-only
2012 (true if read-only, false if not).
2014 This uses the L<blockdev(8)> command.");
2016 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2017 [InitEmpty, Always, TestOutputInt (
2018 [["blockdev_getss"; "/dev/sda"]], 512)],
2019 "get sectorsize of block device",
2021 This returns the size of sectors on a block device.
2022 Usually 512, but can be larger for modern devices.
2024 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2027 This uses the L<blockdev(8)> command.");
2029 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2030 [InitEmpty, Always, TestOutputInt (
2031 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2032 "get blocksize of block device",
2034 This returns the block size of a device.
2036 (Note this is different from both I<size in blocks> and
2037 I<filesystem block size>).
2039 This uses the L<blockdev(8)> command.");
2041 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2043 "set blocksize of block device",
2045 This sets the block size of a device.
2047 (Note this is different from both I<size in blocks> and
2048 I<filesystem block size>).
2050 This uses the L<blockdev(8)> command.");
2052 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2053 [InitEmpty, Always, TestOutputInt (
2054 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2055 "get total size of device in 512-byte sectors",
2057 This returns the size of the device in units of 512-byte sectors
2058 (even if the sectorsize isn't 512 bytes ... weird).
2060 See also C<guestfs_blockdev_getss> for the real sector size of
2061 the device, and C<guestfs_blockdev_getsize64> for the more
2062 useful I<size in bytes>.
2064 This uses the L<blockdev(8)> command.");
2066 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2067 [InitEmpty, Always, TestOutputInt (
2068 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2069 "get total size of device in bytes",
2071 This returns the size of the device in bytes.
2073 See also C<guestfs_blockdev_getsz>.
2075 This uses the L<blockdev(8)> command.");
2077 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2078 [InitEmpty, Always, TestRun
2079 [["blockdev_flushbufs"; "/dev/sda"]]],
2080 "flush device buffers",
2082 This tells the kernel to flush internal buffers associated
2085 This uses the L<blockdev(8)> command.");
2087 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2088 [InitEmpty, Always, TestRun
2089 [["blockdev_rereadpt"; "/dev/sda"]]],
2090 "reread partition table",
2092 Reread the partition table on C<device>.
2094 This uses the L<blockdev(8)> command.");
2096 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2097 [InitBasicFS, Always, TestOutput (
2098 (* Pick a file from cwd which isn't likely to change. *)
2099 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2100 ["checksum"; "md5"; "/COPYING.LIB"]],
2101 Digest.to_hex (Digest.file "COPYING.LIB"))],
2102 "upload a file from the local machine",
2104 Upload local file C<filename> to C<remotefilename> on the
2107 C<filename> can also be a named pipe.
2109 See also C<guestfs_download>.");
2111 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2112 [InitBasicFS, Always, TestOutput (
2113 (* Pick a file from cwd which isn't likely to change. *)
2114 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2115 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2116 ["upload"; "testdownload.tmp"; "/upload"];
2117 ["checksum"; "md5"; "/upload"]],
2118 Digest.to_hex (Digest.file "COPYING.LIB"))],
2119 "download a file to the local machine",
2121 Download file C<remotefilename> and save it as C<filename>
2122 on the local machine.
2124 C<filename> can also be a named pipe.
2126 See also C<guestfs_upload>, C<guestfs_cat>.");
2128 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2129 [InitISOFS, Always, TestOutput (
2130 [["checksum"; "crc"; "/known-3"]], "2891671662");
2131 InitISOFS, Always, TestLastFail (
2132 [["checksum"; "crc"; "/notexists"]]);
2133 InitISOFS, Always, TestOutput (
2134 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2135 InitISOFS, Always, TestOutput (
2136 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2137 InitISOFS, Always, TestOutput (
2138 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2139 InitISOFS, Always, TestOutput (
2140 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2141 InitISOFS, Always, TestOutput (
2142 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2143 InitISOFS, Always, TestOutput (
2144 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2145 (* Test for RHBZ#579608, absolute symbolic links. *)
2146 InitISOFS, Always, TestOutput (
2147 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2148 "compute MD5, SHAx or CRC checksum of file",
2150 This call computes the MD5, SHAx or CRC checksum of the
2153 The type of checksum to compute is given by the C<csumtype>
2154 parameter which must have one of the following values:
2160 Compute the cyclic redundancy check (CRC) specified by POSIX
2161 for the C<cksum> command.
2165 Compute the MD5 hash (using the C<md5sum> program).
2169 Compute the SHA1 hash (using the C<sha1sum> program).
2173 Compute the SHA224 hash (using the C<sha224sum> program).
2177 Compute the SHA256 hash (using the C<sha256sum> program).
2181 Compute the SHA384 hash (using the C<sha384sum> program).
2185 Compute the SHA512 hash (using the C<sha512sum> program).
2189 The checksum is returned as a printable string.
2191 To get the checksum for a device, use C<guestfs_checksum_device>.
2193 To get the checksums for many files, use C<guestfs_checksums_out>.");
2195 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2196 [InitBasicFS, Always, TestOutput (
2197 [["tar_in"; "../images/helloworld.tar"; "/"];
2198 ["cat"; "/hello"]], "hello\n")],
2199 "unpack tarfile to directory",
2201 This command uploads and unpacks local file C<tarfile> (an
2202 I<uncompressed> tar file) into C<directory>.
2204 To upload a compressed tarball, use C<guestfs_tgz_in>
2205 or C<guestfs_txz_in>.");
2207 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2209 "pack directory into tarfile",
2211 This command packs the contents of C<directory> and downloads
2212 it to local file C<tarfile>.
2214 To download a compressed tarball, use C<guestfs_tgz_out>
2215 or C<guestfs_txz_out>.");
2217 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2218 [InitBasicFS, Always, TestOutput (
2219 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2220 ["cat"; "/hello"]], "hello\n")],
2221 "unpack compressed tarball to directory",
2223 This command uploads and unpacks local file C<tarball> (a
2224 I<gzip compressed> tar file) into C<directory>.
2226 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2228 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2230 "pack directory into compressed tarball",
2232 This command packs the contents of C<directory> and downloads
2233 it to local file C<tarball>.
2235 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2237 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2238 [InitBasicFS, Always, TestLastFail (
2240 ["mount_ro"; "/dev/sda1"; "/"];
2241 ["touch"; "/new"]]);
2242 InitBasicFS, Always, TestOutput (
2243 [["write"; "/new"; "data"];
2245 ["mount_ro"; "/dev/sda1"; "/"];
2246 ["cat"; "/new"]], "data")],
2247 "mount a guest disk, read-only",
2249 This is the same as the C<guestfs_mount> command, but it
2250 mounts the filesystem with the read-only (I<-o ro>) flag.");
2252 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2254 "mount a guest disk with mount options",
2256 This is the same as the C<guestfs_mount> command, but it
2257 allows you to set the mount options as for the
2258 L<mount(8)> I<-o> flag.
2260 If the C<options> parameter is an empty string, then
2261 no options are passed (all options default to whatever
2262 the filesystem uses).");
2264 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2266 "mount a guest disk with mount options and vfstype",
2268 This is the same as the C<guestfs_mount> command, but it
2269 allows you to set both the mount options and the vfstype
2270 as for the L<mount(8)> I<-o> and I<-t> flags.");
2272 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [],
2274 "debugging and internals",
2276 The C<guestfs_debug> command exposes some internals of
2277 C<guestfsd> (the guestfs daemon) that runs inside the
2280 There is no comprehensive help for this command. You have
2281 to look at the file C<daemon/debug.c> in the libguestfs source
2282 to find out what you can do.");
2284 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2285 [InitEmpty, Always, TestOutputList (
2286 [["part_disk"; "/dev/sda"; "mbr"];
2287 ["pvcreate"; "/dev/sda1"];
2288 ["vgcreate"; "VG"; "/dev/sda1"];
2289 ["lvcreate"; "LV1"; "VG"; "50"];
2290 ["lvcreate"; "LV2"; "VG"; "50"];
2291 ["lvremove"; "/dev/VG/LV1"];
2292 ["lvs"]], ["/dev/VG/LV2"]);
2293 InitEmpty, Always, TestOutputList (
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"];
2299 ["lvremove"; "/dev/VG"];
2301 InitEmpty, Always, TestOutputList (
2302 [["part_disk"; "/dev/sda"; "mbr"];
2303 ["pvcreate"; "/dev/sda1"];
2304 ["vgcreate"; "VG"; "/dev/sda1"];
2305 ["lvcreate"; "LV1"; "VG"; "50"];
2306 ["lvcreate"; "LV2"; "VG"; "50"];
2307 ["lvremove"; "/dev/VG"];
2309 "remove an LVM logical volume",
2311 Remove an LVM logical volume C<device>, where C<device> is
2312 the path to the LV, such as C</dev/VG/LV>.
2314 You can also remove all LVs in a volume group by specifying
2315 the VG name, C</dev/VG>.");
2317 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2318 [InitEmpty, Always, TestOutputList (
2319 [["part_disk"; "/dev/sda"; "mbr"];
2320 ["pvcreate"; "/dev/sda1"];
2321 ["vgcreate"; "VG"; "/dev/sda1"];
2322 ["lvcreate"; "LV1"; "VG"; "50"];
2323 ["lvcreate"; "LV2"; "VG"; "50"];
2326 InitEmpty, Always, TestOutputList (
2327 [["part_disk"; "/dev/sda"; "mbr"];
2328 ["pvcreate"; "/dev/sda1"];
2329 ["vgcreate"; "VG"; "/dev/sda1"];
2330 ["lvcreate"; "LV1"; "VG"; "50"];
2331 ["lvcreate"; "LV2"; "VG"; "50"];
2334 "remove an LVM volume group",
2336 Remove an LVM volume group C<vgname>, (for example C<VG>).
2338 This also forcibly removes all logical volumes in the volume
2341 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2342 [InitEmpty, Always, TestOutputListOfDevices (
2343 [["part_disk"; "/dev/sda"; "mbr"];
2344 ["pvcreate"; "/dev/sda1"];
2345 ["vgcreate"; "VG"; "/dev/sda1"];
2346 ["lvcreate"; "LV1"; "VG"; "50"];
2347 ["lvcreate"; "LV2"; "VG"; "50"];
2349 ["pvremove"; "/dev/sda1"];
2351 InitEmpty, Always, TestOutputListOfDevices (
2352 [["part_disk"; "/dev/sda"; "mbr"];
2353 ["pvcreate"; "/dev/sda1"];
2354 ["vgcreate"; "VG"; "/dev/sda1"];
2355 ["lvcreate"; "LV1"; "VG"; "50"];
2356 ["lvcreate"; "LV2"; "VG"; "50"];
2358 ["pvremove"; "/dev/sda1"];
2360 InitEmpty, Always, TestOutputListOfDevices (
2361 [["part_disk"; "/dev/sda"; "mbr"];
2362 ["pvcreate"; "/dev/sda1"];
2363 ["vgcreate"; "VG"; "/dev/sda1"];
2364 ["lvcreate"; "LV1"; "VG"; "50"];
2365 ["lvcreate"; "LV2"; "VG"; "50"];
2367 ["pvremove"; "/dev/sda1"];
2369 "remove an LVM physical volume",
2371 This wipes a physical volume C<device> so that LVM will no longer
2374 The implementation uses the C<pvremove> command which refuses to
2375 wipe physical volumes that contain any volume groups, so you have
2376 to remove those first.");
2378 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2379 [InitBasicFS, Always, TestOutput (
2380 [["set_e2label"; "/dev/sda1"; "testlabel"];
2381 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2382 "set the ext2/3/4 filesystem label",
2384 This sets the ext2/3/4 filesystem label of the filesystem on
2385 C<device> to C<label>. Filesystem labels are limited to
2388 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2389 to return the existing label on a filesystem.");
2391 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2393 "get the ext2/3/4 filesystem label",
2395 This returns the ext2/3/4 filesystem label of the filesystem on
2398 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2399 (let uuid = uuidgen () in
2400 [InitBasicFS, Always, TestOutput (
2401 [["set_e2uuid"; "/dev/sda1"; uuid];
2402 ["get_e2uuid"; "/dev/sda1"]], uuid);
2403 InitBasicFS, Always, TestOutput (
2404 [["set_e2uuid"; "/dev/sda1"; "clear"];
2405 ["get_e2uuid"; "/dev/sda1"]], "");
2406 (* We can't predict what UUIDs will be, so just check the commands run. *)
2407 InitBasicFS, Always, TestRun (
2408 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2409 InitBasicFS, Always, TestRun (
2410 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2411 "set the ext2/3/4 filesystem UUID",
2413 This sets the ext2/3/4 filesystem UUID of the filesystem on
2414 C<device> to C<uuid>. The format of the UUID and alternatives
2415 such as C<clear>, C<random> and C<time> are described in the
2416 L<tune2fs(8)> manpage.
2418 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2419 to return the existing UUID of a filesystem.");
2421 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2422 (* Regression test for RHBZ#597112. *)
2423 (let uuid = uuidgen () in
2424 [InitBasicFS, Always, TestOutput (
2425 [["mke2journal"; "1024"; "/dev/sdb"];
2426 ["set_e2uuid"; "/dev/sdb"; uuid];
2427 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2428 "get the ext2/3/4 filesystem UUID",
2430 This returns the ext2/3/4 filesystem UUID of the filesystem on
2433 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2434 [InitBasicFS, Always, TestOutputInt (
2435 [["umount"; "/dev/sda1"];
2436 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2437 InitBasicFS, Always, TestOutputInt (
2438 [["umount"; "/dev/sda1"];
2439 ["zero"; "/dev/sda1"];
2440 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2441 "run the filesystem checker",
2443 This runs the filesystem checker (fsck) on C<device> which
2444 should have filesystem type C<fstype>.
2446 The returned integer is the status. See L<fsck(8)> for the
2447 list of status codes from C<fsck>.
2455 Multiple status codes can be summed together.
2459 A non-zero return code can mean \"success\", for example if
2460 errors have been corrected on the filesystem.
2464 Checking or repairing NTFS volumes is not supported
2469 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2471 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2472 [InitBasicFS, Always, TestOutput (
2473 [["umount"; "/dev/sda1"];
2474 ["zero"; "/dev/sda1"];
2475 ["file"; "/dev/sda1"]], "data")],
2476 "write zeroes to the device",
2478 This command writes zeroes over the first few blocks of C<device>.
2480 How many blocks are zeroed isn't specified (but it's I<not> enough
2481 to securely wipe the device). It should be sufficient to remove
2482 any partition tables, filesystem superblocks and so on.
2484 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2486 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2488 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2489 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2491 [InitBasicFS, Always, TestOutputTrue (
2492 [["mkdir_p"; "/boot/grub"];
2493 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2494 ["grub_install"; "/"; "/dev/vda"];
2495 ["is_dir"; "/boot"]])],
2498 This command installs GRUB (the Grand Unified Bootloader) on
2499 C<device>, with the root directory being C<root>.
2501 Note: If grub-install reports the error
2502 \"No suitable drive was found in the generated device map.\"
2503 it may be that you need to create a C</boot/grub/device.map>
2504 file first that contains the mapping between grub device names
2505 and Linux device names. It is usually sufficient to create
2510 replacing C</dev/vda> with the name of the installation device.");
2512 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2513 [InitBasicFS, Always, TestOutput (
2514 [["write"; "/old"; "file content"];
2515 ["cp"; "/old"; "/new"];
2516 ["cat"; "/new"]], "file content");
2517 InitBasicFS, Always, TestOutputTrue (
2518 [["write"; "/old"; "file content"];
2519 ["cp"; "/old"; "/new"];
2520 ["is_file"; "/old"]]);
2521 InitBasicFS, Always, TestOutput (
2522 [["write"; "/old"; "file content"];
2524 ["cp"; "/old"; "/dir/new"];
2525 ["cat"; "/dir/new"]], "file content")],
2528 This copies a file from C<src> to C<dest> where C<dest> is
2529 either a destination filename or destination directory.");
2531 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2532 [InitBasicFS, Always, TestOutput (
2533 [["mkdir"; "/olddir"];
2534 ["mkdir"; "/newdir"];
2535 ["write"; "/olddir/file"; "file content"];
2536 ["cp_a"; "/olddir"; "/newdir"];
2537 ["cat"; "/newdir/olddir/file"]], "file content")],
2538 "copy a file or directory recursively",
2540 This copies a file or directory from C<src> to C<dest>
2541 recursively using the C<cp -a> command.");
2543 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2544 [InitBasicFS, Always, TestOutput (
2545 [["write"; "/old"; "file content"];
2546 ["mv"; "/old"; "/new"];
2547 ["cat"; "/new"]], "file content");
2548 InitBasicFS, Always, TestOutputFalse (
2549 [["write"; "/old"; "file content"];
2550 ["mv"; "/old"; "/new"];
2551 ["is_file"; "/old"]])],
2554 This moves a file from C<src> to C<dest> where C<dest> is
2555 either a destination filename or destination directory.");
2557 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2558 [InitEmpty, Always, TestRun (
2559 [["drop_caches"; "3"]])],
2560 "drop kernel page cache, dentries and inodes",
2562 This instructs the guest kernel to drop its page cache,
2563 and/or dentries and inode caches. The parameter C<whattodrop>
2564 tells the kernel what precisely to drop, see
2565 L<http://linux-mm.org/Drop_Caches>
2567 Setting C<whattodrop> to 3 should drop everything.
2569 This automatically calls L<sync(2)> before the operation,
2570 so that the maximum guest memory is freed.");
2572 ("dmesg", (RString "kmsgs", [], []), 91, [],
2573 [InitEmpty, Always, TestRun (
2575 "return kernel messages",
2577 This returns the kernel messages (C<dmesg> output) from
2578 the guest kernel. This is sometimes useful for extended
2579 debugging of problems.
2581 Another way to get the same information is to enable
2582 verbose messages with C<guestfs_set_verbose> or by setting
2583 the environment variable C<LIBGUESTFS_DEBUG=1> before
2584 running the program.");
2586 ("ping_daemon", (RErr, [], []), 92, [],
2587 [InitEmpty, Always, TestRun (
2588 [["ping_daemon"]])],
2589 "ping the guest daemon",
2591 This is a test probe into the guestfs daemon running inside
2592 the qemu subprocess. Calling this function checks that the
2593 daemon responds to the ping message, without affecting the daemon
2594 or attached block device(s) in any other way.");
2596 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2597 [InitBasicFS, Always, TestOutputTrue (
2598 [["write"; "/file1"; "contents of a file"];
2599 ["cp"; "/file1"; "/file2"];
2600 ["equal"; "/file1"; "/file2"]]);
2601 InitBasicFS, Always, TestOutputFalse (
2602 [["write"; "/file1"; "contents of a file"];
2603 ["write"; "/file2"; "contents of another file"];
2604 ["equal"; "/file1"; "/file2"]]);
2605 InitBasicFS, Always, TestLastFail (
2606 [["equal"; "/file1"; "/file2"]])],
2607 "test if two files have equal contents",
2609 This compares the two files C<file1> and C<file2> and returns
2610 true if their content is exactly equal, or false otherwise.
2612 The external L<cmp(1)> program is used for the comparison.");
2614 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2615 [InitISOFS, Always, TestOutputList (
2616 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2617 InitISOFS, Always, TestOutputList (
2618 [["strings"; "/empty"]], []);
2619 (* Test for RHBZ#579608, absolute symbolic links. *)
2620 InitISOFS, Always, TestRun (
2621 [["strings"; "/abssymlink"]])],
2622 "print the printable strings in a file",
2624 This runs the L<strings(1)> command on a file and returns
2625 the list of printable strings found.");
2627 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2628 [InitISOFS, Always, TestOutputList (
2629 [["strings_e"; "b"; "/known-5"]], []);
2630 InitBasicFS, Always, TestOutputList (
2631 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2632 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2633 "print the printable strings in a file",
2635 This is like the C<guestfs_strings> command, but allows you to
2636 specify the encoding of strings that are looked for in
2637 the source file C<path>.
2639 Allowed encodings are:
2645 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2646 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2650 Single 8-bit-byte characters.
2654 16-bit big endian strings such as those encoded in
2655 UTF-16BE or UCS-2BE.
2657 =item l (lower case letter L)
2659 16-bit little endian such as UTF-16LE and UCS-2LE.
2660 This is useful for examining binaries in Windows guests.
2664 32-bit big endian such as UCS-4BE.
2668 32-bit little endian such as UCS-4LE.
2672 The returned strings are transcoded to UTF-8.");
2674 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2675 [InitISOFS, Always, TestOutput (
2676 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2677 (* Test for RHBZ#501888c2 regression which caused large hexdump
2678 * commands to segfault.
2680 InitISOFS, Always, TestRun (
2681 [["hexdump"; "/100krandom"]]);
2682 (* Test for RHBZ#579608, absolute symbolic links. *)
2683 InitISOFS, Always, TestRun (
2684 [["hexdump"; "/abssymlink"]])],
2685 "dump a file in hexadecimal",
2687 This runs C<hexdump -C> on the given C<path>. The result is
2688 the human-readable, canonical hex dump of the file.");
2690 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2691 [InitNone, Always, TestOutput (
2692 [["part_disk"; "/dev/sda"; "mbr"];
2693 ["mkfs"; "ext3"; "/dev/sda1"];
2694 ["mount_options"; ""; "/dev/sda1"; "/"];
2695 ["write"; "/new"; "test file"];
2696 ["umount"; "/dev/sda1"];
2697 ["zerofree"; "/dev/sda1"];
2698 ["mount_options"; ""; "/dev/sda1"; "/"];
2699 ["cat"; "/new"]], "test file")],
2700 "zero unused inodes and disk blocks on ext2/3 filesystem",
2702 This runs the I<zerofree> program on C<device>. This program
2703 claims to zero unused inodes and disk blocks on an ext2/3
2704 filesystem, thus making it possible to compress the filesystem
2707 You should B<not> run this program if the filesystem is
2710 It is possible that using this program can damage the filesystem
2711 or data on the filesystem.");
2713 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2715 "resize an LVM physical volume",
2717 This resizes (expands or shrinks) an existing LVM physical
2718 volume to match the new size of the underlying device.");
2720 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2721 Int "cyls"; Int "heads"; Int "sectors";
2722 String "line"], []), 99, [DangerWillRobinson],
2724 "modify a single partition on a block device",
2726 This runs L<sfdisk(8)> option to modify just the single
2727 partition C<n> (note: C<n> counts from 1).
2729 For other parameters, see C<guestfs_sfdisk>. You should usually
2730 pass C<0> for the cyls/heads/sectors parameters.
2732 See also: C<guestfs_part_add>");
2734 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2736 "display the partition table",
2738 This displays the partition table on C<device>, in the
2739 human-readable output of the L<sfdisk(8)> command. It is
2740 not intended to be parsed.
2742 See also: C<guestfs_part_list>");
2744 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2746 "display the kernel geometry",
2748 This displays the kernel's idea of the geometry of C<device>.
2750 The result is in human-readable format, and not designed to
2753 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2755 "display the disk geometry from the partition table",
2757 This displays the disk geometry of C<device> read from the
2758 partition table. Especially in the case where the underlying
2759 block device has been resized, this can be different from the
2760 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2762 The result is in human-readable format, and not designed to
2765 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2767 "activate or deactivate all volume groups",
2769 This command activates or (if C<activate> is false) deactivates
2770 all logical volumes in all volume groups.
2771 If activated, then they are made known to the
2772 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2773 then those devices disappear.
2775 This command is the same as running C<vgchange -a y|n>");
2777 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
2779 "activate or deactivate some volume groups",
2781 This command activates or (if C<activate> is false) deactivates
2782 all logical volumes in the listed volume groups C<volgroups>.
2783 If activated, then they are made known to the
2784 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2785 then those devices disappear.
2787 This command is the same as running C<vgchange -a y|n volgroups...>
2789 Note that if C<volgroups> is an empty list then B<all> volume groups
2790 are activated or deactivated.");
2792 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
2793 [InitNone, Always, TestOutput (
2794 [["part_disk"; "/dev/sda"; "mbr"];
2795 ["pvcreate"; "/dev/sda1"];
2796 ["vgcreate"; "VG"; "/dev/sda1"];
2797 ["lvcreate"; "LV"; "VG"; "10"];
2798 ["mkfs"; "ext2"; "/dev/VG/LV"];
2799 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2800 ["write"; "/new"; "test content"];
2802 ["lvresize"; "/dev/VG/LV"; "20"];
2803 ["e2fsck_f"; "/dev/VG/LV"];
2804 ["resize2fs"; "/dev/VG/LV"];
2805 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2806 ["cat"; "/new"]], "test content");
2807 InitNone, Always, TestRun (
2808 (* Make an LV smaller to test RHBZ#587484. *)
2809 [["part_disk"; "/dev/sda"; "mbr"];
2810 ["pvcreate"; "/dev/sda1"];
2811 ["vgcreate"; "VG"; "/dev/sda1"];
2812 ["lvcreate"; "LV"; "VG"; "20"];
2813 ["lvresize"; "/dev/VG/LV"; "10"]])],
2814 "resize an LVM logical volume",
2816 This resizes (expands or shrinks) an existing LVM logical
2817 volume to C<mbytes>. When reducing, data in the reduced part
2820 ("resize2fs", (RErr, [Device "device"], []), 106, [],
2821 [], (* lvresize tests this *)
2822 "resize an ext2, ext3 or ext4 filesystem",
2824 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2825 the underlying device.
2827 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2828 on the C<device> before calling this command. For unknown reasons
2829 C<resize2fs> sometimes gives an error about this and sometimes not.
2830 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2831 calling this function.");
2833 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
2834 [InitBasicFS, Always, TestOutputList (
2835 [["find"; "/"]], ["lost+found"]);
2836 InitBasicFS, Always, TestOutputList (
2840 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2841 InitBasicFS, Always, TestOutputList (
2842 [["mkdir_p"; "/a/b/c"];
2843 ["touch"; "/a/b/c/d"];
2844 ["find"; "/a/b/"]], ["c"; "c/d"])],
2845 "find all files and directories",
2847 This command lists out all files and directories, recursively,
2848 starting at C<directory>. It is essentially equivalent to
2849 running the shell command C<find directory -print> but some
2850 post-processing happens on the output, described below.
2852 This returns a list of strings I<without any prefix>. Thus
2853 if the directory structure was:
2859 then the returned list from C<guestfs_find> C</tmp> would be
2867 If C<directory> is not a directory, then this command returns
2870 The returned list is sorted.
2872 See also C<guestfs_find0>.");
2874 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
2875 [], (* lvresize tests this *)
2876 "check an ext2/ext3 filesystem",
2878 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2879 filesystem checker on C<device>, noninteractively (C<-p>),
2880 even if the filesystem appears to be clean (C<-f>).
2882 This command is only needed because of C<guestfs_resize2fs>
2883 (q.v.). Normally you should use C<guestfs_fsck>.");
2885 ("sleep", (RErr, [Int "secs"], []), 109, [],
2886 [InitNone, Always, TestRun (
2888 "sleep for some seconds",
2890 Sleep for C<secs> seconds.");
2892 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
2893 [InitNone, Always, TestOutputInt (
2894 [["part_disk"; "/dev/sda"; "mbr"];
2895 ["mkfs"; "ntfs"; "/dev/sda1"];
2896 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2897 InitNone, Always, TestOutputInt (
2898 [["part_disk"; "/dev/sda"; "mbr"];
2899 ["mkfs"; "ext2"; "/dev/sda1"];
2900 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2901 "probe NTFS volume",
2903 This command runs the L<ntfs-3g.probe(8)> command which probes
2904 an NTFS C<device> for mountability. (Not all NTFS volumes can
2905 be mounted read-write, and some cannot be mounted at all).
2907 C<rw> is a boolean flag. Set it to true if you want to test
2908 if the volume can be mounted read-write. Set it to false if
2909 you want to test if the volume can be mounted read-only.
2911 The return value is an integer which C<0> if the operation
2912 would succeed, or some non-zero value documented in the
2913 L<ntfs-3g.probe(8)> manual page.");
2915 ("sh", (RString "output", [String "command"], []), 111, [],
2916 [], (* XXX needs tests *)
2917 "run a command via the shell",
2919 This call runs a command from the guest filesystem via the
2922 This is like C<guestfs_command>, but passes the command to:
2924 /bin/sh -c \"command\"
2926 Depending on the guest's shell, this usually results in
2927 wildcards being expanded, shell expressions being interpolated
2930 All the provisos about C<guestfs_command> apply to this call.");
2932 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
2933 [], (* XXX needs tests *)
2934 "run a command via the shell returning lines",
2936 This is the same as C<guestfs_sh>, but splits the result
2937 into a list of lines.
2939 See also: C<guestfs_command_lines>");
2941 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
2942 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2943 * code in stubs.c, since all valid glob patterns must start with "/".
2944 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2946 [InitBasicFS, Always, TestOutputList (
2947 [["mkdir_p"; "/a/b/c"];
2948 ["touch"; "/a/b/c/d"];
2949 ["touch"; "/a/b/c/e"];
2950 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2951 InitBasicFS, Always, TestOutputList (
2952 [["mkdir_p"; "/a/b/c"];
2953 ["touch"; "/a/b/c/d"];
2954 ["touch"; "/a/b/c/e"];
2955 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2956 InitBasicFS, Always, TestOutputList (
2957 [["mkdir_p"; "/a/b/c"];
2958 ["touch"; "/a/b/c/d"];
2959 ["touch"; "/a/b/c/e"];
2960 ["glob_expand"; "/a/*/x/*"]], [])],
2961 "expand a wildcard path",
2963 This command searches for all the pathnames matching
2964 C<pattern> according to the wildcard expansion rules
2967 If no paths match, then this returns an empty list
2968 (note: not an error).
2970 It is just a wrapper around the C L<glob(3)> function
2971 with flags C<GLOB_MARK|GLOB_BRACE>.
2972 See that manual page for more details.");
2974 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
2975 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2976 [["scrub_device"; "/dev/sdc"]])],
2977 "scrub (securely wipe) a device",
2979 This command writes patterns over C<device> to make data retrieval
2982 It is an interface to the L<scrub(1)> program. See that
2983 manual page for more details.");
2985 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
2986 [InitBasicFS, Always, TestRun (
2987 [["write"; "/file"; "content"];
2988 ["scrub_file"; "/file"]])],
2989 "scrub (securely wipe) a file",
2991 This command writes patterns over a file to make data retrieval
2994 The file is I<removed> after scrubbing.
2996 It is an interface to the L<scrub(1)> program. See that
2997 manual page for more details.");
2999 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3000 [], (* XXX needs testing *)
3001 "scrub (securely wipe) free space",
3003 This command creates the directory C<dir> and then fills it
3004 with files until the filesystem is full, and scrubs the files
3005 as for C<guestfs_scrub_file>, and deletes them.
3006 The intention is to scrub any free space on the partition
3009 It is an interface to the L<scrub(1)> program. See that
3010 manual page for more details.");
3012 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3013 [InitBasicFS, Always, TestRun (
3015 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
3016 "create a temporary directory",
3018 This command creates a temporary directory. The
3019 C<template> parameter should be a full pathname for the
3020 temporary directory name with the final six characters being
3023 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3024 the second one being suitable for Windows filesystems.
3026 The name of the temporary directory that was created
3029 The temporary directory is created with mode 0700
3030 and is owned by root.
3032 The caller is responsible for deleting the temporary
3033 directory and its contents after use.
3035 See also: L<mkdtemp(3)>");
3037 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3038 [InitISOFS, Always, TestOutputInt (
3039 [["wc_l"; "/10klines"]], 10000);
3040 (* Test for RHBZ#579608, absolute symbolic links. *)
3041 InitISOFS, Always, TestOutputInt (
3042 [["wc_l"; "/abssymlink"]], 10000)],
3043 "count lines in a file",
3045 This command counts the lines in a file, using the
3046 C<wc -l> external command.");
3048 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3049 [InitISOFS, Always, TestOutputInt (
3050 [["wc_w"; "/10klines"]], 10000)],
3051 "count words in a file",
3053 This command counts the words in a file, using the
3054 C<wc -w> external command.");
3056 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3057 [InitISOFS, Always, TestOutputInt (
3058 [["wc_c"; "/100kallspaces"]], 102400)],
3059 "count characters in a file",
3061 This command counts the characters in a file, using the
3062 C<wc -c> external command.");
3064 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3065 [InitISOFS, Always, TestOutputList (
3066 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3067 (* Test for RHBZ#579608, absolute symbolic links. *)
3068 InitISOFS, Always, TestOutputList (
3069 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3070 "return first 10 lines of a file",
3072 This command returns up to the first 10 lines of a file as
3073 a list of strings.");
3075 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3076 [InitISOFS, Always, TestOutputList (
3077 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3078 InitISOFS, Always, TestOutputList (
3079 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3080 InitISOFS, Always, TestOutputList (
3081 [["head_n"; "0"; "/10klines"]], [])],
3082 "return first N lines of a file",
3084 If the parameter C<nrlines> is a positive number, this returns the first
3085 C<nrlines> lines of the file C<path>.
3087 If the parameter C<nrlines> is a negative number, this returns lines
3088 from the file C<path>, excluding the last C<nrlines> lines.
3090 If the parameter C<nrlines> is zero, this returns an empty list.");
3092 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3093 [InitISOFS, Always, TestOutputList (
3094 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3095 "return last 10 lines of a file",
3097 This command returns up to the last 10 lines of a file as
3098 a list of strings.");
3100 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3101 [InitISOFS, Always, TestOutputList (
3102 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3103 InitISOFS, Always, TestOutputList (
3104 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3105 InitISOFS, Always, TestOutputList (
3106 [["tail_n"; "0"; "/10klines"]], [])],
3107 "return last N lines of a file",
3109 If the parameter C<nrlines> is a positive number, this returns the last
3110 C<nrlines> lines of the file C<path>.
3112 If the parameter C<nrlines> is a negative number, this returns lines
3113 from the file C<path>, starting with the C<-nrlines>th line.
3115 If the parameter C<nrlines> is zero, this returns an empty list.");
3117 ("df", (RString "output", [], []), 125, [],
3118 [], (* XXX Tricky to test because it depends on the exact format
3119 * of the 'df' command and other imponderables.
3121 "report file system disk space usage",
3123 This command runs the C<df> command to report disk space used.
3125 This command is mostly useful for interactive sessions. It
3126 is I<not> intended that you try to parse the output string.
3127 Use C<statvfs> from programs.");
3129 ("df_h", (RString "output", [], []), 126, [],
3130 [], (* XXX Tricky to test because it depends on the exact format
3131 * of the 'df' command and other imponderables.
3133 "report file system disk space usage (human readable)",
3135 This command runs the C<df -h> command to report disk space used
3136 in human-readable format.
3138 This command is mostly useful for interactive sessions. It
3139 is I<not> intended that you try to parse the output string.
3140 Use C<statvfs> from programs.");
3142 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3143 [InitISOFS, Always, TestOutputInt (
3144 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3145 "estimate file space usage",
3147 This command runs the C<du -s> command to estimate file space
3150 C<path> can be a file or a directory. If C<path> is a directory
3151 then the estimate includes the contents of the directory and all
3152 subdirectories (recursively).
3154 The result is the estimated size in I<kilobytes>
3155 (ie. units of 1024 bytes).");
3157 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3158 [InitISOFS, Always, TestOutputList (
3159 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3160 "list files in an initrd",
3162 This command lists out files contained in an initrd.
3164 The files are listed without any initial C</> character. The
3165 files are listed in the order they appear (not necessarily
3166 alphabetical). Directory names are listed as separate items.
3168 Old Linux kernels (2.4 and earlier) used a compressed ext2
3169 filesystem as initrd. We I<only> support the newer initramfs
3170 format (compressed cpio files).");
3172 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3174 "mount a file using the loop device",
3176 This command lets you mount C<file> (a filesystem image
3177 in a file) on a mount point. It is entirely equivalent to
3178 the command C<mount -o loop file mountpoint>.");
3180 ("mkswap", (RErr, [Device "device"], []), 130, [],
3181 [InitEmpty, Always, TestRun (
3182 [["part_disk"; "/dev/sda"; "mbr"];
3183 ["mkswap"; "/dev/sda1"]])],
3184 "create a swap partition",
3186 Create a swap partition on C<device>.");
3188 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3189 [InitEmpty, Always, TestRun (
3190 [["part_disk"; "/dev/sda"; "mbr"];
3191 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3192 "create a swap partition with a label",
3194 Create a swap partition on C<device> with label C<label>.
3196 Note that you cannot attach a swap label to a block device
3197 (eg. C</dev/sda>), just to a partition. This appears to be
3198 a limitation of the kernel or swap tools.");
3200 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3201 (let uuid = uuidgen () in
3202 [InitEmpty, Always, TestRun (
3203 [["part_disk"; "/dev/sda"; "mbr"];
3204 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3205 "create a swap partition with an explicit UUID",
3207 Create a swap partition on C<device> with UUID C<uuid>.");
3209 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3210 [InitBasicFS, Always, TestOutputStruct (
3211 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3212 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3213 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3214 InitBasicFS, Always, TestOutputStruct (
3215 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3216 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3217 "make block, character or FIFO devices",
3219 This call creates block or character special devices, or
3220 named pipes (FIFOs).
3222 The C<mode> parameter should be the mode, using the standard
3223 constants. C<devmajor> and C<devminor> are the
3224 device major and minor numbers, only used when creating block
3225 and character special devices.
3227 Note that, just like L<mknod(2)>, the mode must be bitwise
3228 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3229 just creates a regular file). These constants are
3230 available in the standard Linux header files, or you can use
3231 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3232 which are wrappers around this command which bitwise OR
3233 in the appropriate constant for you.
3235 The mode actually set is affected by the umask.");
3237 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3238 [InitBasicFS, Always, TestOutputStruct (
3239 [["mkfifo"; "0o777"; "/node"];
3240 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3241 "make FIFO (named pipe)",
3243 This call creates a FIFO (named pipe) called C<path> with
3244 mode C<mode>. It is just a convenient wrapper around
3247 The mode actually set is affected by the umask.");
3249 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3250 [InitBasicFS, Always, TestOutputStruct (
3251 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3252 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3253 "make block device node",
3255 This call creates a block device node called C<path> with
3256 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3257 It is just a convenient wrapper around C<guestfs_mknod>.
3259 The mode actually set is affected by the umask.");
3261 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3262 [InitBasicFS, Always, TestOutputStruct (
3263 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3264 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3265 "make char device node",
3267 This call creates a char device node called C<path> with
3268 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3269 It is just a convenient wrapper around C<guestfs_mknod>.
3271 The mode actually set is affected by the umask.");
3273 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3274 [InitEmpty, Always, TestOutputInt (
3275 [["umask"; "0o22"]], 0o22)],
3276 "set file mode creation mask (umask)",
3278 This function sets the mask used for creating new files and
3279 device nodes to C<mask & 0777>.
3281 Typical umask values would be C<022> which creates new files
3282 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3283 C<002> which creates new files with permissions like
3284 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3286 The default umask is C<022>. This is important because it
3287 means that directories and device nodes will be created with
3288 C<0644> or C<0755> mode even if you specify C<0777>.
3290 See also C<guestfs_get_umask>,
3291 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3293 This call returns the previous umask.");
3295 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3297 "read directories entries",
3299 This returns the list of directory entries in directory C<dir>.
3301 All entries in the directory are returned, including C<.> and
3302 C<..>. The entries are I<not> sorted, but returned in the same
3303 order as the underlying filesystem.
3305 Also this call returns basic file type information about each
3306 file. The C<ftyp> field will contain one of the following characters:
3344 The L<readdir(3)> call returned a C<d_type> field with an
3349 This function is primarily intended for use by programs. To
3350 get a simple list of names, use C<guestfs_ls>. To get a printable
3351 directory for human consumption, use C<guestfs_ll>.");
3353 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3355 "create partitions on a block device",
3357 This is a simplified interface to the C<guestfs_sfdisk>
3358 command, where partition sizes are specified in megabytes
3359 only (rounded to the nearest cylinder) and you don't need
3360 to specify the cyls, heads and sectors parameters which
3361 were rarely if ever used anyway.
3363 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3364 and C<guestfs_part_disk>");
3366 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3368 "determine file type inside a compressed file",
3370 This command runs C<file> after first decompressing C<path>
3373 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3375 Since 1.0.63, use C<guestfs_file> instead which can now
3376 process compressed files.");
3378 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3380 "list extended attributes of a file or directory",
3382 This call lists the extended attributes of the file or directory
3385 At the system call level, this is a combination of the
3386 L<listxattr(2)> and L<getxattr(2)> calls.
3388 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3390 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3392 "list extended attributes of a file or directory",
3394 This is the same as C<guestfs_getxattrs>, but if C<path>
3395 is a symbolic link, then it returns the extended attributes
3396 of the link itself.");
3398 ("setxattr", (RErr, [String "xattr";
3399 String "val"; Int "vallen"; (* will be BufferIn *)
3400 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3402 "set extended attribute of a file or directory",
3404 This call sets the extended attribute named C<xattr>
3405 of the file C<path> to the value C<val> (of length C<vallen>).
3406 The value is arbitrary 8 bit data.
3408 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3410 ("lsetxattr", (RErr, [String "xattr";
3411 String "val"; Int "vallen"; (* will be BufferIn *)
3412 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3414 "set extended attribute of a file or directory",
3416 This is the same as C<guestfs_setxattr>, but if C<path>
3417 is a symbolic link, then it sets an extended attribute
3418 of the link itself.");
3420 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3422 "remove extended attribute of a file or directory",
3424 This call removes the extended attribute named C<xattr>
3425 of the file C<path>.
3427 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3429 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3431 "remove extended attribute of a file or directory",
3433 This is the same as C<guestfs_removexattr>, but if C<path>
3434 is a symbolic link, then it removes an extended attribute
3435 of the link itself.");
3437 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3441 This call is similar to C<guestfs_mounts>. That call returns
3442 a list of devices. This one returns a hash table (map) of
3443 device name to directory where the device is mounted.");
3445 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3446 (* This is a special case: while you would expect a parameter
3447 * of type "Pathname", that doesn't work, because it implies
3448 * NEED_ROOT in the generated calling code in stubs.c, and
3449 * this function cannot use NEED_ROOT.
3452 "create a mountpoint",
3454 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3455 specialized calls that can be used to create extra mountpoints
3456 before mounting the first filesystem.
3458 These calls are I<only> necessary in some very limited circumstances,
3459 mainly the case where you want to mount a mix of unrelated and/or
3460 read-only filesystems together.
3462 For example, live CDs often contain a \"Russian doll\" nest of
3463 filesystems, an ISO outer layer, with a squashfs image inside, with
3464 an ext2/3 image inside that. You can unpack this as follows
3467 add-ro Fedora-11-i686-Live.iso
3471 mkmountpoint /ext3fs
3473 mount-loop /cd/LiveOS/squashfs.img /sqsh
3474 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3476 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3478 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3479 You may get unexpected errors if you try to mix these calls. It is
3480 safest to manually unmount filesystems and remove mountpoints after use.
3482 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3483 longest first, so for this to work for manual mountpoints, you
3484 must ensure that the innermost mountpoints have the longest
3485 pathnames, as in the example code above.
3487 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3489 Autosync [see C<guestfs_set_autosync>, this is set by default on
3490 handles] means that C<guestfs_umount_all> is called when the handle
3491 is closed which can also trigger these issues.");
3493 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3495 "remove a mountpoint",
3497 This calls removes a mountpoint that was previously created
3498 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3499 for full details.");
3501 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3502 [InitISOFS, Always, TestOutputBuffer (
3503 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3504 (* Test various near large, large and too large files (RHBZ#589039). *)
3505 InitBasicFS, Always, TestLastFail (
3507 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3508 ["read_file"; "/a"]]);
3509 InitBasicFS, Always, TestLastFail (
3511 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3512 ["read_file"; "/a"]]);
3513 InitBasicFS, Always, TestLastFail (
3515 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3516 ["read_file"; "/a"]])],
3519 This calls returns the contents of the file C<path> as a
3522 Unlike C<guestfs_cat>, this function can correctly
3523 handle files that contain embedded ASCII NUL characters.
3524 However unlike C<guestfs_download>, this function is limited
3525 in the total size of file that can be handled.");
3527 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3528 [InitISOFS, Always, TestOutputList (
3529 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3530 InitISOFS, Always, TestOutputList (
3531 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3532 (* Test for RHBZ#579608, absolute symbolic links. *)
3533 InitISOFS, Always, TestOutputList (
3534 [["grep"; "nomatch"; "/abssymlink"]], [])],
3535 "return lines matching a pattern",
3537 This calls the external C<grep> program and returns the
3540 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3541 [InitISOFS, Always, TestOutputList (
3542 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3543 "return lines matching a pattern",
3545 This calls the external C<egrep> program and returns the
3548 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3549 [InitISOFS, Always, TestOutputList (
3550 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3551 "return lines matching a pattern",
3553 This calls the external C<fgrep> program and returns the
3556 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3557 [InitISOFS, Always, TestOutputList (
3558 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3559 "return lines matching a pattern",
3561 This calls the external C<grep -i> program and returns the
3564 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3565 [InitISOFS, Always, TestOutputList (
3566 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3567 "return lines matching a pattern",
3569 This calls the external C<egrep -i> program and returns the
3572 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3573 [InitISOFS, Always, TestOutputList (
3574 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3575 "return lines matching a pattern",
3577 This calls the external C<fgrep -i> program and returns the
3580 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3581 [InitISOFS, Always, TestOutputList (
3582 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3583 "return lines matching a pattern",
3585 This calls the external C<zgrep> program and returns the
3588 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3589 [InitISOFS, Always, TestOutputList (
3590 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3591 "return lines matching a pattern",
3593 This calls the external C<zegrep> program and returns the
3596 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3597 [InitISOFS, Always, TestOutputList (
3598 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3599 "return lines matching a pattern",
3601 This calls the external C<zfgrep> program and returns the
3604 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3605 [InitISOFS, Always, TestOutputList (
3606 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3607 "return lines matching a pattern",
3609 This calls the external C<zgrep -i> program and returns the
3612 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3613 [InitISOFS, Always, TestOutputList (
3614 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3615 "return lines matching a pattern",
3617 This calls the external C<zegrep -i> program and returns the
3620 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3621 [InitISOFS, Always, TestOutputList (
3622 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3623 "return lines matching a pattern",
3625 This calls the external C<zfgrep -i> program and returns the
3628 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3629 [InitISOFS, Always, TestOutput (
3630 [["realpath"; "/../directory"]], "/directory")],
3631 "canonicalized absolute pathname",
3633 Return the canonicalized absolute pathname of C<path>. The
3634 returned path has no C<.>, C<..> or symbolic link path elements.");
3636 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3637 [InitBasicFS, Always, TestOutputStruct (
3640 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3641 "create a hard link",
3643 This command creates a hard link using the C<ln> command.");
3645 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3646 [InitBasicFS, Always, TestOutputStruct (
3649 ["ln_f"; "/a"; "/b"];
3650 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3651 "create a hard link",
3653 This command creates a hard link using the C<ln -f> command.
3654 The C<-f> option removes the link (C<linkname>) if it exists already.");
3656 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3657 [InitBasicFS, Always, TestOutputStruct (
3659 ["ln_s"; "a"; "/b"];
3660 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3661 "create a symbolic link",
3663 This command creates a symbolic link using the C<ln -s> command.");
3665 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3666 [InitBasicFS, Always, TestOutput (
3667 [["mkdir_p"; "/a/b"];
3668 ["touch"; "/a/b/c"];
3669 ["ln_sf"; "../d"; "/a/b/c"];
3670 ["readlink"; "/a/b/c"]], "../d")],
3671 "create a symbolic link",
3673 This command creates a symbolic link using the C<ln -sf> command,
3674 The C<-f> option removes the link (C<linkname>) if it exists already.");
3676 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3677 [] (* XXX tested above *),
3678 "read the target of a symbolic link",
3680 This command reads the target of a symbolic link.");
3682 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3683 [InitBasicFS, Always, TestOutputStruct (
3684 [["fallocate"; "/a"; "1000000"];
3685 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3686 "preallocate a file in the guest filesystem",
3688 This command preallocates a file (containing zero bytes) named
3689 C<path> of size C<len> bytes. If the file exists already, it
3692 Do not confuse this with the guestfish-specific
3693 C<alloc> command which allocates a file in the host and
3694 attaches it as a device.");
3696 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3697 [InitPartition, Always, TestRun (
3698 [["mkswap"; "/dev/sda1"];
3699 ["swapon_device"; "/dev/sda1"];
3700 ["swapoff_device"; "/dev/sda1"]])],
3701 "enable swap on device",
3703 This command enables the libguestfs appliance to use the
3704 swap device or partition named C<device>. The increased
3705 memory is made available for all commands, for example
3706 those run using C<guestfs_command> or C<guestfs_sh>.
3708 Note that you should not swap to existing guest swap
3709 partitions unless you know what you are doing. They may
3710 contain hibernation information, or other information that
3711 the guest doesn't want you to trash. You also risk leaking
3712 information about the host to the guest this way. Instead,
3713 attach a new host device to the guest and swap on that.");
3715 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3716 [], (* XXX tested by swapon_device *)
3717 "disable swap on device",
3719 This command disables the libguestfs appliance swap
3720 device or partition named C<device>.
3721 See C<guestfs_swapon_device>.");
3723 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3724 [InitBasicFS, Always, TestRun (
3725 [["fallocate"; "/swap"; "8388608"];
3726 ["mkswap_file"; "/swap"];
3727 ["swapon_file"; "/swap"];
3728 ["swapoff_file"; "/swap"]])],
3729 "enable swap on file",
3731 This command enables swap to a file.
3732 See C<guestfs_swapon_device> for other notes.");
3734 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3735 [], (* XXX tested by swapon_file *)
3736 "disable swap on file",
3738 This command disables the libguestfs appliance swap on file.");
3740 ("swapon_label", (RErr, [String "label"], []), 174, [],
3741 [InitEmpty, Always, TestRun (
3742 [["part_disk"; "/dev/sdb"; "mbr"];
3743 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3744 ["swapon_label"; "swapit"];
3745 ["swapoff_label"; "swapit"];
3746 ["zero"; "/dev/sdb"];
3747 ["blockdev_rereadpt"; "/dev/sdb"]])],
3748 "enable swap on labeled swap partition",
3750 This command enables swap to a labeled swap partition.
3751 See C<guestfs_swapon_device> for other notes.");
3753 ("swapoff_label", (RErr, [String "label"], []), 175, [],
3754 [], (* XXX tested by swapon_label *)
3755 "disable swap on labeled swap partition",
3757 This command disables the libguestfs appliance swap on
3758 labeled swap partition.");
3760 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3761 (let uuid = uuidgen () in
3762 [InitEmpty, Always, TestRun (
3763 [["mkswap_U"; uuid; "/dev/sdb"];
3764 ["swapon_uuid"; uuid];
3765 ["swapoff_uuid"; uuid]])]),
3766 "enable swap on swap partition by UUID",
3768 This command enables swap to a swap partition with the given UUID.
3769 See C<guestfs_swapon_device> for other notes.");
3771 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3772 [], (* XXX tested by swapon_uuid *)
3773 "disable swap on swap partition by UUID",
3775 This command disables the libguestfs appliance swap partition
3776 with the given UUID.");
3778 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
3779 [InitBasicFS, Always, TestRun (
3780 [["fallocate"; "/swap"; "8388608"];
3781 ["mkswap_file"; "/swap"]])],
3782 "create a swap file",
3786 This command just writes a swap file signature to an existing
3787 file. To create the file itself, use something like C<guestfs_fallocate>.");
3789 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
3790 [InitISOFS, Always, TestRun (
3791 [["inotify_init"; "0"]])],
3792 "create an inotify handle",
3794 This command creates a new inotify handle.
3795 The inotify subsystem can be used to notify events which happen to
3796 objects in the guest filesystem.
3798 C<maxevents> is the maximum number of events which will be
3799 queued up between calls to C<guestfs_inotify_read> or
3800 C<guestfs_inotify_files>.
3801 If this is passed as C<0>, then the kernel (or previously set)
3802 default is used. For Linux 2.6.29 the default was 16384 events.
3803 Beyond this limit, the kernel throws away events, but records
3804 the fact that it threw them away by setting a flag
3805 C<IN_Q_OVERFLOW> in the returned structure list (see
3806 C<guestfs_inotify_read>).
3808 Before any events are generated, you have to add some
3809 watches to the internal watch list. See:
3810 C<guestfs_inotify_add_watch>,
3811 C<guestfs_inotify_rm_watch> and
3812 C<guestfs_inotify_watch_all>.
3814 Queued up events should be read periodically by calling
3815 C<guestfs_inotify_read>
3816 (or C<guestfs_inotify_files> which is just a helpful
3817 wrapper around C<guestfs_inotify_read>). If you don't
3818 read the events out often enough then you risk the internal
3821 The handle should be closed after use by calling
3822 C<guestfs_inotify_close>. This also removes any
3823 watches automatically.
3825 See also L<inotify(7)> for an overview of the inotify interface
3826 as exposed by the Linux kernel, which is roughly what we expose
3827 via libguestfs. Note that there is one global inotify handle
3828 per libguestfs instance.");
3830 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
3831 [InitBasicFS, Always, TestOutputList (
3832 [["inotify_init"; "0"];
3833 ["inotify_add_watch"; "/"; "1073741823"];
3836 ["inotify_files"]], ["a"; "b"])],
3837 "add an inotify watch",
3839 Watch C<path> for the events listed in C<mask>.
3841 Note that if C<path> is a directory then events within that
3842 directory are watched, but this does I<not> happen recursively
3843 (in subdirectories).
3845 Note for non-C or non-Linux callers: the inotify events are
3846 defined by the Linux kernel ABI and are listed in
3847 C</usr/include/sys/inotify.h>.");
3849 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
3851 "remove an inotify watch",
3853 Remove a previously defined inotify watch.
3854 See C<guestfs_inotify_add_watch>.");
3856 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
3858 "return list of inotify events",
3860 Return the complete queue of events that have happened
3861 since the previous read call.
3863 If no events have happened, this returns an empty list.
3865 I<Note>: In order to make sure that all events have been
3866 read, you must call this function repeatedly until it
3867 returns an empty list. The reason is that the call will
3868 read events up to the maximum appliance-to-host message
3869 size and leave remaining events in the queue.");
3871 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
3873 "return list of watched files that had events",
3875 This function is a helpful wrapper around C<guestfs_inotify_read>
3876 which just returns a list of pathnames of objects that were
3877 touched. The returned pathnames are sorted and deduplicated.");
3879 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
3881 "close the inotify handle",
3883 This closes the inotify handle which was previously
3884 opened by inotify_init. It removes all watches, throws
3885 away any pending events, and deallocates all resources.");
3887 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
3889 "set SELinux security context",
3891 This sets the SELinux security context of the daemon
3892 to the string C<context>.
3894 See the documentation about SELINUX in L<guestfs(3)>.");
3896 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
3898 "get SELinux security context",
3900 This gets the SELinux security context of the daemon.
3902 See the documentation about SELINUX in L<guestfs(3)>,
3903 and C<guestfs_setcon>");
3905 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
3906 [InitEmpty, Always, TestOutput (
3907 [["part_disk"; "/dev/sda"; "mbr"];
3908 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3909 ["mount_options"; ""; "/dev/sda1"; "/"];
3910 ["write"; "/new"; "new file contents"];
3911 ["cat"; "/new"]], "new file contents");
3912 InitEmpty, Always, TestRun (
3913 [["part_disk"; "/dev/sda"; "mbr"];
3914 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3915 InitEmpty, Always, TestLastFail (
3916 [["part_disk"; "/dev/sda"; "mbr"];
3917 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3918 InitEmpty, Always, TestLastFail (
3919 [["part_disk"; "/dev/sda"; "mbr"];
3920 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3921 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3922 [["part_disk"; "/dev/sda"; "mbr"];
3923 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3924 "make a filesystem with block size",
3926 This call is similar to C<guestfs_mkfs>, but it allows you to
3927 control the block size of the resulting filesystem. Supported
3928 block sizes depend on the filesystem type, but typically they
3929 are C<1024>, C<2048> or C<4096> only.
3931 For VFAT and NTFS the C<blocksize> parameter is treated as
3932 the requested cluster size.");
3934 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
3935 [InitEmpty, Always, TestOutput (
3936 [["part_init"; "/dev/sda"; "mbr"];
3937 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
3938 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
3939 ["mke2journal"; "4096"; "/dev/sda1"];
3940 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3941 ["mount_options"; ""; "/dev/sda2"; "/"];
3942 ["write"; "/new"; "new file contents"];
3943 ["cat"; "/new"]], "new file contents")],
3944 "make ext2/3/4 external journal",
3946 This creates an ext2 external journal on C<device>. It is equivalent
3949 mke2fs -O journal_dev -b blocksize device");
3951 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
3952 [InitEmpty, Always, TestOutput (
3953 [["part_init"; "/dev/sda"; "mbr"];
3954 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
3955 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
3956 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3957 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3958 ["mount_options"; ""; "/dev/sda2"; "/"];
3959 ["write"; "/new"; "new file contents"];
3960 ["cat"; "/new"]], "new file contents")],
3961 "make ext2/3/4 external journal with label",
3963 This creates an ext2 external journal on C<device> with label C<label>.");
3965 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
3966 (let uuid = uuidgen () in
3967 [InitEmpty, Always, TestOutput (
3968 [["part_init"; "/dev/sda"; "mbr"];
3969 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
3970 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
3971 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3972 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3973 ["mount_options"; ""; "/dev/sda2"; "/"];
3974 ["write"; "/new"; "new file contents"];
3975 ["cat"; "/new"]], "new file contents")]),
3976 "make ext2/3/4 external journal with UUID",
3978 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3980 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
3982 "make ext2/3/4 filesystem with external journal",
3984 This creates an ext2/3/4 filesystem on C<device> with
3985 an external journal on C<journal>. It is equivalent
3988 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3990 See also C<guestfs_mke2journal>.");
3992 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
3994 "make ext2/3/4 filesystem with external journal",
3996 This creates an ext2/3/4 filesystem on C<device> with
3997 an external journal on the journal labeled C<label>.
3999 See also C<guestfs_mke2journal_L>.");
4001 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4003 "make ext2/3/4 filesystem with external journal",
4005 This creates an ext2/3/4 filesystem on C<device> with
4006 an external journal on the journal with UUID C<uuid>.
4008 See also C<guestfs_mke2journal_U>.");
4010 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4011 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4012 "load a kernel module",
4014 This loads a kernel module in the appliance.
4016 The kernel module must have been whitelisted when libguestfs
4017 was built (see C<appliance/kmod.whitelist.in> in the source).");
4019 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4020 [InitNone, Always, TestOutput (
4021 [["echo_daemon"; "This is a test"]], "This is a test"
4023 "echo arguments back to the client",
4025 This command concatenates the list of C<words> passed with single spaces
4026 between them and returns the resulting string.
4028 You can use this command to test the connection through to the daemon.
4030 See also C<guestfs_ping_daemon>.");
4032 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4033 [], (* There is a regression test for this. *)
4034 "find all files and directories, returning NUL-separated list",
4036 This command lists out all files and directories, recursively,
4037 starting at C<directory>, placing the resulting list in the
4038 external file called C<files>.
4040 This command works the same way as C<guestfs_find> with the
4041 following exceptions:
4047 The resulting list is written to an external file.
4051 Items (filenames) in the result are separated
4052 by C<\\0> characters. See L<find(1)> option I<-print0>.
4056 This command is not limited in the number of names that it
4061 The result list is not sorted.
4065 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4066 [InitISOFS, Always, TestOutput (
4067 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4068 InitISOFS, Always, TestOutput (
4069 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4070 InitISOFS, Always, TestOutput (
4071 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4072 InitISOFS, Always, TestLastFail (
4073 [["case_sensitive_path"; "/Known-1/"]]);
4074 InitBasicFS, Always, TestOutput (
4076 ["mkdir"; "/a/bbb"];
4077 ["touch"; "/a/bbb/c"];
4078 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4079 InitBasicFS, Always, TestOutput (
4081 ["mkdir"; "/a/bbb"];
4082 ["touch"; "/a/bbb/c"];
4083 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4084 InitBasicFS, Always, TestLastFail (
4086 ["mkdir"; "/a/bbb"];
4087 ["touch"; "/a/bbb/c"];
4088 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4089 "return true path on case-insensitive filesystem",
4091 This can be used to resolve case insensitive paths on
4092 a filesystem which is case sensitive. The use case is
4093 to resolve paths which you have read from Windows configuration
4094 files or the Windows Registry, to the true path.
4096 The command handles a peculiarity of the Linux ntfs-3g
4097 filesystem driver (and probably others), which is that although
4098 the underlying filesystem is case-insensitive, the driver
4099 exports the filesystem to Linux as case-sensitive.
4101 One consequence of this is that special directories such
4102 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4103 (or other things) depending on the precise details of how
4104 they were created. In Windows itself this would not be
4107 Bug or feature? You decide:
4108 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4110 This function resolves the true case of each element in the
4111 path and returns the case-sensitive path.
4113 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4114 might return C<\"/WINDOWS/system32\"> (the exact return value
4115 would depend on details of how the directories were originally
4116 created under Windows).
4119 This function does not handle drive names, backslashes etc.
4121 See also C<guestfs_realpath>.");
4123 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4124 [InitBasicFS, Always, TestOutput (
4125 [["vfs_type"; "/dev/sda1"]], "ext2")],
4126 "get the Linux VFS type corresponding to a mounted device",
4128 This command gets the filesystem type corresponding to
4129 the filesystem on C<device>.
4131 For most filesystems, the result is the name of the Linux
4132 VFS module which would be used to mount this filesystem
4133 if you mounted it without specifying the filesystem type.
4134 For example a string such as C<ext3> or C<ntfs>.");
4136 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4137 [InitBasicFS, Always, TestOutputStruct (
4138 [["write"; "/test"; "some stuff so size is not zero"];
4139 ["truncate"; "/test"];
4140 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4141 "truncate a file to zero size",
4143 This command truncates C<path> to a zero-length file. The
4144 file must exist already.");
4146 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4147 [InitBasicFS, Always, TestOutputStruct (
4148 [["touch"; "/test"];
4149 ["truncate_size"; "/test"; "1000"];
4150 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4151 "truncate a file to a particular size",
4153 This command truncates C<path> to size C<size> bytes. The file
4156 If the current file size is less than C<size> then
4157 the file is extended to the required size with zero bytes.
4158 This creates a sparse file (ie. disk blocks are not allocated
4159 for the file until you write to it). To create a non-sparse
4160 file of zeroes, use C<guestfs_fallocate64> instead.");
4162 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4163 [InitBasicFS, Always, TestOutputStruct (
4164 [["touch"; "/test"];
4165 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4166 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4167 "set timestamp of a file with nanosecond precision",
4169 This command sets the timestamps of a file with nanosecond
4172 C<atsecs, atnsecs> are the last access time (atime) in secs and
4173 nanoseconds from the epoch.
4175 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4176 secs and nanoseconds from the epoch.
4178 If the C<*nsecs> field contains the special value C<-1> then
4179 the corresponding timestamp is set to the current time. (The
4180 C<*secs> field is ignored in this case).
4182 If the C<*nsecs> field contains the special value C<-2> then
4183 the corresponding timestamp is left unchanged. (The
4184 C<*secs> field is ignored in this case).");
4186 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4187 [InitBasicFS, Always, TestOutputStruct (
4188 [["mkdir_mode"; "/test"; "0o111"];
4189 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4190 "create a directory with a particular mode",
4192 This command creates a directory, setting the initial permissions
4193 of the directory to C<mode>.
4195 For common Linux filesystems, the actual mode which is set will
4196 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4197 interpret the mode in other ways.
4199 See also C<guestfs_mkdir>, C<guestfs_umask>");
4201 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4203 "change file owner and group",
4205 Change the file owner to C<owner> and group to C<group>.
4206 This is like C<guestfs_chown> but if C<path> is a symlink then
4207 the link itself is changed, not the target.
4209 Only numeric uid and gid are supported. If you want to use
4210 names, you will need to locate and parse the password file
4211 yourself (Augeas support makes this relatively easy).");
4213 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4215 "lstat on multiple files",
4217 This call allows you to perform the C<guestfs_lstat> operation
4218 on multiple files, where all files are in the directory C<path>.
4219 C<names> is the list of files from this directory.
4221 On return you get a list of stat structs, with a one-to-one
4222 correspondence to the C<names> list. If any name did not exist
4223 or could not be lstat'd, then the C<ino> field of that structure
4226 This call is intended for programs that want to efficiently
4227 list a directory contents without making many round-trips.
4228 See also C<guestfs_lxattrlist> for a similarly efficient call
4229 for getting extended attributes. Very long directory listings
4230 might cause the protocol message size to be exceeded, causing
4231 this call to fail. The caller must split up such requests
4232 into smaller groups of names.");
4234 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4236 "lgetxattr on multiple files",
4238 This call allows you to get the extended attributes
4239 of multiple files, where all files are in the directory C<path>.
4240 C<names> is the list of files from this directory.
4242 On return you get a flat list of xattr structs which must be
4243 interpreted sequentially. The first xattr struct always has a zero-length
4244 C<attrname>. C<attrval> in this struct is zero-length
4245 to indicate there was an error doing C<lgetxattr> for this
4246 file, I<or> is a C string which is a decimal number
4247 (the number of following attributes for this file, which could
4248 be C<\"0\">). Then after the first xattr struct are the
4249 zero or more attributes for the first named file.
4250 This repeats for the second and subsequent files.
4252 This call is intended for programs that want to efficiently
4253 list a directory contents without making many round-trips.
4254 See also C<guestfs_lstatlist> for a similarly efficient call
4255 for getting standard stats. Very long directory listings
4256 might cause the protocol message size to be exceeded, causing
4257 this call to fail. The caller must split up such requests
4258 into smaller groups of names.");
4260 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4262 "readlink on multiple files",
4264 This call allows you to do a C<readlink> operation
4265 on multiple files, where all files are in the directory C<path>.
4266 C<names> is the list of files from this directory.
4268 On return you get a list of strings, with a one-to-one
4269 correspondence to the C<names> list. Each string is the
4270 value of the symbolic link.
4272 If the C<readlink(2)> operation fails on any name, then
4273 the corresponding result string is the empty string C<\"\">.
4274 However the whole operation is completed even if there
4275 were C<readlink(2)> errors, and so you can call this
4276 function with names where you don't know if they are
4277 symbolic links already (albeit slightly less efficient).
4279 This call is intended for programs that want to efficiently
4280 list a directory contents without making many round-trips.
4281 Very long directory listings might cause the protocol
4282 message size to be exceeded, causing
4283 this call to fail. The caller must split up such requests
4284 into smaller groups of names.");
4286 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4287 [InitISOFS, Always, TestOutputBuffer (
4288 [["pread"; "/known-4"; "1"; "3"]], "\n");
4289 InitISOFS, Always, TestOutputBuffer (
4290 [["pread"; "/empty"; "0"; "100"]], "")],
4291 "read part of a file",
4293 This command lets you read part of a file. It reads C<count>
4294 bytes of the file, starting at C<offset>, from file C<path>.
4296 This may read fewer bytes than requested. For further details
4297 see the L<pread(2)> system call.
4299 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4301 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4302 [InitEmpty, Always, TestRun (
4303 [["part_init"; "/dev/sda"; "gpt"]])],
4304 "create an empty partition table",
4306 This creates an empty partition table on C<device> of one of the
4307 partition types listed below. Usually C<parttype> should be
4308 either C<msdos> or C<gpt> (for large disks).
4310 Initially there are no partitions. Following this, you should
4311 call C<guestfs_part_add> for each partition required.
4313 Possible values for C<parttype> are:
4317 =item B<efi> | B<gpt>
4319 Intel EFI / GPT partition table.
4321 This is recommended for >= 2 TB partitions that will be accessed
4322 from Linux and Intel-based Mac OS X. It also has limited backwards
4323 compatibility with the C<mbr> format.
4325 =item B<mbr> | B<msdos>
4327 The standard PC \"Master Boot Record\" (MBR) format used
4328 by MS-DOS and Windows. This partition type will B<only> work
4329 for device sizes up to 2 TB. For large disks we recommend
4334 Other partition table types that may work but are not
4343 =item B<amiga> | B<rdb>
4345 Amiga \"Rigid Disk Block\" format.
4353 DASD, used on IBM mainframes.
4361 Old Mac partition format. Modern Macs use C<gpt>.
4365 NEC PC-98 format, common in Japan apparently.
4373 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4374 [InitEmpty, Always, TestRun (
4375 [["part_init"; "/dev/sda"; "mbr"];
4376 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4377 InitEmpty, Always, TestRun (
4378 [["part_init"; "/dev/sda"; "gpt"];
4379 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4380 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4381 InitEmpty, Always, TestRun (
4382 [["part_init"; "/dev/sda"; "mbr"];
4383 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4384 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4385 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4386 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4387 "add a partition to the device",
4389 This command adds a partition to C<device>. If there is no partition
4390 table on the device, call C<guestfs_part_init> first.
4392 The C<prlogex> parameter is the type of partition. Normally you
4393 should pass C<p> or C<primary> here, but MBR partition tables also
4394 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4397 C<startsect> and C<endsect> are the start and end of the partition
4398 in I<sectors>. C<endsect> may be negative, which means it counts
4399 backwards from the end of the disk (C<-1> is the last sector).
4401 Creating a partition which covers the whole disk is not so easy.
4402 Use C<guestfs_part_disk> to do that.");
4404 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4405 [InitEmpty, Always, TestRun (
4406 [["part_disk"; "/dev/sda"; "mbr"]]);
4407 InitEmpty, Always, TestRun (
4408 [["part_disk"; "/dev/sda"; "gpt"]])],
4409 "partition whole disk with a single primary partition",
4411 This command is simply a combination of C<guestfs_part_init>
4412 followed by C<guestfs_part_add> to create a single primary partition
4413 covering the whole disk.
4415 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4416 but other possible values are described in C<guestfs_part_init>.");
4418 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4419 [InitEmpty, Always, TestRun (
4420 [["part_disk"; "/dev/sda"; "mbr"];
4421 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4422 "make a partition bootable",
4424 This sets the bootable flag on partition numbered C<partnum> on
4425 device C<device>. Note that partitions are numbered from 1.
4427 The bootable flag is used by some operating systems (notably
4428 Windows) to determine which partition to boot from. It is by
4429 no means universally recognized.");
4431 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4432 [InitEmpty, Always, TestRun (
4433 [["part_disk"; "/dev/sda"; "gpt"];
4434 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4435 "set partition name",
4437 This sets the partition name on partition numbered C<partnum> on
4438 device C<device>. Note that partitions are numbered from 1.
4440 The partition name can only be set on certain types of partition
4441 table. This works on C<gpt> but not on C<mbr> partitions.");
4443 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4444 [], (* XXX Add a regression test for this. *)
4445 "list partitions on a device",
4447 This command parses the partition table on C<device> and
4448 returns the list of partitions found.
4450 The fields in the returned structure are:
4456 Partition number, counting from 1.
4460 Start of the partition I<in bytes>. To get sectors you have to
4461 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4465 End of the partition in bytes.
4469 Size of the partition in bytes.
4473 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4474 [InitEmpty, Always, TestOutput (
4475 [["part_disk"; "/dev/sda"; "gpt"];
4476 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4477 "get the partition table type",
4479 This command examines the partition table on C<device> and
4480 returns the partition table type (format) being used.
4482 Common return values include: C<msdos> (a DOS/Windows style MBR
4483 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4484 values are possible, although unusual. See C<guestfs_part_init>
4487 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4488 [InitBasicFS, Always, TestOutputBuffer (
4489 [["fill"; "0x63"; "10"; "/test"];
4490 ["read_file"; "/test"]], "cccccccccc")],
4491 "fill a file with octets",
4493 This command creates a new file called C<path>. The initial
4494 content of the file is C<len> octets of C<c>, where C<c>
4495 must be a number in the range C<[0..255]>.
4497 To fill a file with zero bytes (sparsely), it is
4498 much more efficient to use C<guestfs_truncate_size>.
4499 To create a file with a pattern of repeating bytes
4500 use C<guestfs_fill_pattern>.");
4502 ("available", (RErr, [StringList "groups"], []), 216, [],
4503 [InitNone, Always, TestRun [["available"; ""]]],
4504 "test availability of some parts of the API",
4506 This command is used to check the availability of some
4507 groups of functionality in the appliance, which not all builds of
4508 the libguestfs appliance will be able to provide.
4510 The libguestfs groups, and the functions that those
4511 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4512 You can also fetch this list at runtime by calling
4513 C<guestfs_available_all_groups>.
4515 The argument C<groups> is a list of group names, eg:
4516 C<[\"inotify\", \"augeas\"]> would check for the availability of
4517 the Linux inotify functions and Augeas (configuration file
4520 The command returns no error if I<all> requested groups are available.
4522 It fails with an error if one or more of the requested
4523 groups is unavailable in the appliance.
4525 If an unknown group name is included in the
4526 list of groups then an error is always returned.
4534 You must call C<guestfs_launch> before calling this function.
4536 The reason is because we don't know what groups are
4537 supported by the appliance/daemon until it is running and can
4542 If a group of functions is available, this does not necessarily
4543 mean that they will work. You still have to check for errors
4544 when calling individual API functions even if they are
4549 It is usually the job of distro packagers to build
4550 complete functionality into the libguestfs appliance.
4551 Upstream libguestfs, if built from source with all
4552 requirements satisfied, will support everything.
4556 This call was added in version C<1.0.80>. In previous
4557 versions of libguestfs all you could do would be to speculatively
4558 execute a command to find out if the daemon implemented it.
4559 See also C<guestfs_version>.
4563 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4564 [InitBasicFS, Always, TestOutputBuffer (
4565 [["write"; "/src"; "hello, world"];
4566 ["dd"; "/src"; "/dest"];
4567 ["read_file"; "/dest"]], "hello, world")],
4568 "copy from source to destination using dd",
4570 This command copies from one source device or file C<src>
4571 to another destination device or file C<dest>. Normally you
4572 would use this to copy to or from a device or partition, for
4573 example to duplicate a filesystem.
4575 If the destination is a device, it must be as large or larger
4576 than the source file or device, otherwise the copy will fail.
4577 This command cannot do partial copies (see C<guestfs_copy_size>).");
4579 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4580 [InitBasicFS, Always, TestOutputInt (
4581 [["write"; "/file"; "hello, world"];
4582 ["filesize"; "/file"]], 12)],
4583 "return the size of the file in bytes",
4585 This command returns the size of C<file> in bytes.
4587 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4588 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4589 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4591 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4592 [InitBasicFSonLVM, Always, TestOutputList (
4593 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4594 ["lvs"]], ["/dev/VG/LV2"])],
4595 "rename an LVM logical volume",
4597 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4599 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4600 [InitBasicFSonLVM, Always, TestOutputList (
4602 ["vg_activate"; "false"; "VG"];
4603 ["vgrename"; "VG"; "VG2"];
4604 ["vg_activate"; "true"; "VG2"];
4605 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4606 ["vgs"]], ["VG2"])],
4607 "rename an LVM volume group",
4609 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4611 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4612 [InitISOFS, Always, TestOutputBuffer (
4613 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4614 "list the contents of a single file in an initrd",
4616 This command unpacks the file C<filename> from the initrd file
4617 called C<initrdpath>. The filename must be given I<without> the
4618 initial C</> character.
4620 For example, in guestfish you could use the following command
4621 to examine the boot script (usually called C</init>)
4622 contained in a Linux initrd or initramfs image:
4624 initrd-cat /boot/initrd-<version>.img init
4626 See also C<guestfs_initrd_list>.");
4628 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4630 "get the UUID of a physical volume",
4632 This command returns the UUID of the LVM PV C<device>.");
4634 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4636 "get the UUID of a volume group",
4638 This command returns the UUID of the LVM VG named C<vgname>.");
4640 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4642 "get the UUID of a logical volume",
4644 This command returns the UUID of the LVM LV C<device>.");
4646 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4648 "get the PV UUIDs containing the volume group",
4650 Given a VG called C<vgname>, this returns the UUIDs of all
4651 the physical volumes that this volume group resides on.
4653 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4654 calls to associate physical volumes and volume groups.
4656 See also C<guestfs_vglvuuids>.");
4658 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4660 "get the LV UUIDs of all LVs in the volume group",
4662 Given a VG called C<vgname>, this returns the UUIDs of all
4663 the logical volumes created in this volume group.
4665 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4666 calls to associate logical volumes and volume groups.
4668 See also C<guestfs_vgpvuuids>.");
4670 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4671 [InitBasicFS, Always, TestOutputBuffer (
4672 [["write"; "/src"; "hello, world"];
4673 ["copy_size"; "/src"; "/dest"; "5"];
4674 ["read_file"; "/dest"]], "hello")],
4675 "copy size bytes from source to destination using dd",
4677 This command copies exactly C<size> bytes from one source device
4678 or file C<src> to another destination device or file C<dest>.
4680 Note this will fail if the source is too short or if the destination
4681 is not large enough.");
4683 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4684 [InitBasicFSonLVM, Always, TestRun (
4685 [["zero_device"; "/dev/VG/LV"]])],
4686 "write zeroes to an entire device",
4688 This command writes zeroes over the entire C<device>. Compare
4689 with C<guestfs_zero> which just zeroes the first few blocks of
4692 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4693 [InitBasicFS, Always, TestOutput (
4694 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4695 ["cat"; "/hello"]], "hello\n")],
4696 "unpack compressed tarball to directory",
4698 This command uploads and unpacks local file C<tarball> (an
4699 I<xz compressed> tar file) into C<directory>.");
4701 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4703 "pack directory into compressed tarball",
4705 This command packs the contents of C<directory> and downloads
4706 it to local file C<tarball> (as an xz compressed tar archive).");
4708 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4710 "resize an NTFS filesystem",
4712 This command resizes an NTFS filesystem, expanding or
4713 shrinking it to the size of the underlying device.
4714 See also L<ntfsresize(8)>.");
4716 ("vgscan", (RErr, [], []), 232, [],
4717 [InitEmpty, Always, TestRun (
4719 "rescan for LVM physical volumes, volume groups and logical volumes",
4721 This rescans all block devices and rebuilds the list of LVM
4722 physical volumes, volume groups and logical volumes.");
4724 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
4725 [InitEmpty, Always, TestRun (
4726 [["part_init"; "/dev/sda"; "mbr"];
4727 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4728 ["part_del"; "/dev/sda"; "1"]])],
4729 "delete a partition",
4731 This command deletes the partition numbered C<partnum> on C<device>.
4733 Note that in the case of MBR partitioning, deleting an
4734 extended partition also deletes any logical partitions
4737 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
4738 [InitEmpty, Always, TestOutputTrue (
4739 [["part_init"; "/dev/sda"; "mbr"];
4740 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4741 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4742 ["part_get_bootable"; "/dev/sda"; "1"]])],
4743 "return true if a partition is bootable",
4745 This command returns true if the partition C<partnum> on
4746 C<device> has the bootable flag set.
4748 See also C<guestfs_part_set_bootable>.");
4750 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
4751 [InitEmpty, Always, TestOutputInt (
4752 [["part_init"; "/dev/sda"; "mbr"];
4753 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4754 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4755 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4756 "get the MBR type byte (ID byte) from a partition",
4758 Returns the MBR type byte (also known as the ID byte) from
4759 the numbered partition C<partnum>.
4761 Note that only MBR (old DOS-style) partitions have type bytes.
4762 You will get undefined results for other partition table
4763 types (see C<guestfs_part_get_parttype>).");
4765 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
4766 [], (* tested by part_get_mbr_id *)
4767 "set the MBR type byte (ID byte) of a partition",
4769 Sets the MBR type byte (also known as the ID byte) of
4770 the numbered partition C<partnum> to C<idbyte>. Note
4771 that the type bytes quoted in most documentation are
4772 in fact hexadecimal numbers, but usually documented
4773 without any leading \"0x\" which might be confusing.
4775 Note that only MBR (old DOS-style) partitions have type bytes.
4776 You will get undefined results for other partition table
4777 types (see C<guestfs_part_get_parttype>).");
4779 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
4780 [InitISOFS, Always, TestOutputFileMD5 (
4781 [["checksum_device"; "md5"; "/dev/sdd"]],
4782 "../images/test.iso")],
4783 "compute MD5, SHAx or CRC checksum of the contents of a device",
4785 This call computes the MD5, SHAx or CRC checksum of the
4786 contents of the device named C<device>. For the types of
4787 checksums supported see the C<guestfs_checksum> command.");
4789 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
4790 [InitNone, Always, TestRun (
4791 [["part_disk"; "/dev/sda"; "mbr"];
4792 ["pvcreate"; "/dev/sda1"];
4793 ["vgcreate"; "VG"; "/dev/sda1"];
4794 ["lvcreate"; "LV"; "VG"; "10"];
4795 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4796 "expand an LV to fill free space",
4798 This expands an existing logical volume C<lv> so that it fills
4799 C<pc>% of the remaining free space in the volume group. Commonly
4800 you would call this with pc = 100 which expands the logical volume
4801 as much as possible, using all remaining free space in the volume
4804 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
4805 [], (* XXX Augeas code needs tests. *)
4806 "clear Augeas path",
4808 Set the value associated with C<path> to C<NULL>. This
4809 is the same as the L<augtool(1)> C<clear> command.");
4811 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
4812 [InitEmpty, Always, TestOutputInt (
4813 [["get_umask"]], 0o22)],
4814 "get the current umask",
4816 Return the current umask. By default the umask is C<022>
4817 unless it has been set by calling C<guestfs_umask>.");
4819 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [],
4821 "upload a file to the appliance (internal use only)",
4823 The C<guestfs_debug_upload> command uploads a file to
4824 the libguestfs appliance.
4826 There is no comprehensive help for this command. You have
4827 to look at the file C<daemon/debug.c> in the libguestfs source
4828 to find out what it is for.");
4830 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
4831 [InitBasicFS, Always, TestOutput (
4832 [["base64_in"; "../images/hello.b64"; "/hello"];
4833 ["cat"; "/hello"]], "hello\n")],
4834 "upload base64-encoded data to file",
4836 This command uploads base64-encoded data from C<base64file>
4839 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
4841 "download file and encode as base64",
4843 This command downloads the contents of C<filename>, writing
4844 it out to local file C<base64file> encoded as base64.");
4846 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
4848 "compute MD5, SHAx or CRC checksum of files in a directory",
4850 This command computes the checksums of all regular files in
4851 C<directory> and then emits a list of those checksums to
4852 the local output file C<sumsfile>.
4854 This can be used for verifying the integrity of a virtual
4855 machine. However to be properly secure you should pay
4856 attention to the output of the checksum command (it uses
4857 the ones from GNU coreutils). In particular when the
4858 filename is not printable, coreutils uses a special
4859 backslash syntax. For more information, see the GNU
4860 coreutils info file.");
4862 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
4863 [InitBasicFS, Always, TestOutputBuffer (
4864 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4865 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4866 "fill a file with a repeating pattern of bytes",
4868 This function is like C<guestfs_fill> except that it creates
4869 a new file of length C<len> containing the repeating pattern
4870 of bytes in C<pattern>. The pattern is truncated if necessary
4871 to ensure the length of the file is exactly C<len> bytes.");
4873 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
4874 [InitBasicFS, Always, TestOutput (
4875 [["write"; "/new"; "new file contents"];
4876 ["cat"; "/new"]], "new file contents");
4877 InitBasicFS, Always, TestOutput (
4878 [["write"; "/new"; "\nnew file contents\n"];
4879 ["cat"; "/new"]], "\nnew file contents\n");
4880 InitBasicFS, Always, TestOutput (
4881 [["write"; "/new"; "\n\n"];
4882 ["cat"; "/new"]], "\n\n");
4883 InitBasicFS, Always, TestOutput (
4884 [["write"; "/new"; ""];
4885 ["cat"; "/new"]], "");
4886 InitBasicFS, Always, TestOutput (
4887 [["write"; "/new"; "\n\n\n"];
4888 ["cat"; "/new"]], "\n\n\n");
4889 InitBasicFS, Always, TestOutput (
4890 [["write"; "/new"; "\n"];
4891 ["cat"; "/new"]], "\n")],
4892 "create a new file",
4894 This call creates a file called C<path>. The content of the
4895 file is the string C<content> (which can contain any 8 bit data).");
4897 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
4898 [InitBasicFS, Always, TestOutput (
4899 [["write"; "/new"; "new file contents"];
4900 ["pwrite"; "/new"; "data"; "4"];
4901 ["cat"; "/new"]], "new data contents");
4902 InitBasicFS, Always, TestOutput (
4903 [["write"; "/new"; "new file contents"];
4904 ["pwrite"; "/new"; "is extended"; "9"];
4905 ["cat"; "/new"]], "new file is extended");
4906 InitBasicFS, Always, TestOutput (
4907 [["write"; "/new"; "new file contents"];
4908 ["pwrite"; "/new"; ""; "4"];
4909 ["cat"; "/new"]], "new file contents")],
4910 "write to part of a file",
4912 This command writes to part of a file. It writes the data
4913 buffer C<content> to the file C<path> starting at offset C<offset>.
4915 This command implements the L<pwrite(2)> system call, and like
4916 that system call it may not write the full data requested. The
4917 return value is the number of bytes that were actually written
4918 to the file. This could even be 0, although short writes are
4919 unlikely for regular files in ordinary circumstances.
4921 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
4923 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
4925 "resize an ext2, ext3 or ext4 filesystem (with size)",
4927 This command is the same as C<guestfs_resize2fs> except that it
4928 allows you to specify the new size (in bytes) explicitly.");
4930 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
4932 "resize an LVM physical volume (with size)",
4934 This command is the same as C<guestfs_pvresize> except that it
4935 allows you to specify the new size (in bytes) explicitly.");
4937 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
4939 "resize an NTFS filesystem (with size)",
4941 This command is the same as C<guestfs_ntfsresize> except that it
4942 allows you to specify the new size (in bytes) explicitly.");
4944 ("available_all_groups", (RStringList "groups", [], []), 251, [],
4945 [InitNone, Always, TestRun [["available_all_groups"]]],
4946 "return a list of all optional groups",
4948 This command returns a list of all optional groups that this
4949 daemon knows about. Note this returns both supported and unsupported
4950 groups. To find out which ones the daemon can actually support
4951 you have to call C<guestfs_available> on each member of the
4954 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4956 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
4957 [InitBasicFS, Always, TestOutputStruct (
4958 [["fallocate64"; "/a"; "1000000"];
4959 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4960 "preallocate a file in the guest filesystem",
4962 This command preallocates a file (containing zero bytes) named
4963 C<path> of size C<len> bytes. If the file exists already, it
4966 Note that this call allocates disk blocks for the file.
4967 To create a sparse file use C<guestfs_truncate_size> instead.
4969 The deprecated call C<guestfs_fallocate> does the same,
4970 but owing to an oversight it only allowed 30 bit lengths
4971 to be specified, effectively limiting the maximum size
4972 of files created through that call to 1GB.
4974 Do not confuse this with the guestfish-specific
4975 C<alloc> and C<sparse> commands which create
4976 a file in the host and attach it as a device.");
4978 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
4979 [InitBasicFS, Always, TestOutput (
4980 [["set_e2label"; "/dev/sda1"; "LTEST"];
4981 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4982 "get the filesystem label",
4984 This returns the filesystem label of the filesystem on
4987 If the filesystem is unlabeled, this returns the empty string.
4989 To find a filesystem from the label, use C<guestfs_findfs_label>.");
4991 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
4992 (let uuid = uuidgen () in
4993 [InitBasicFS, Always, TestOutput (
4994 [["set_e2uuid"; "/dev/sda1"; uuid];
4995 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4996 "get the filesystem UUID",
4998 This returns the filesystem UUID of the filesystem on
5001 If the filesystem does not have a UUID, this returns the empty string.
5003 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5005 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5006 (* Can't be tested with the current framework because
5007 * the VG is being used by the mounted filesystem, so
5008 * the vgchange -an command we do first will fail.
5011 "set LVM device filter",
5013 This sets the LVM device filter so that LVM will only be
5014 able to \"see\" the block devices in the list C<devices>,
5015 and will ignore all other attached block devices.
5017 Where disk image(s) contain duplicate PVs or VGs, this
5018 command is useful to get LVM to ignore the duplicates, otherwise
5019 LVM can get confused. Note also there are two types
5020 of duplication possible: either cloned PVs/VGs which have
5021 identical UUIDs; or VGs that are not cloned but just happen
5022 to have the same name. In normal operation you cannot
5023 create this situation, but you can do it outside LVM, eg.
5024 by cloning disk images or by bit twiddling inside the LVM
5027 This command also clears the LVM cache and performs a volume
5030 You can filter whole block devices or individual partitions.
5032 You cannot use this if any VG is currently in use (eg.
5033 contains a mounted filesystem), even if you are not
5034 filtering out that VG.");
5036 ("lvm_clear_filter", (RErr, [], []), 256, [],
5037 [], (* see note on lvm_set_filter *)
5038 "clear LVM device filter",
5040 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5041 will be able to see every block device.
5043 This command also clears the LVM cache and performs a volume
5046 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5048 "open a LUKS-encrypted block device",
5050 This command opens a block device which has been encrypted
5051 according to the Linux Unified Key Setup (LUKS) standard.
5053 C<device> is the encrypted block device or partition.
5055 The caller must supply one of the keys associated with the
5056 LUKS block device, in the C<key> parameter.
5058 This creates a new block device called C</dev/mapper/mapname>.
5059 Reads and writes to this block device are decrypted from and
5060 encrypted to the underlying C<device> respectively.
5062 If this block device contains LVM volume groups, then
5063 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5064 will make them visible.");
5066 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5068 "open a LUKS-encrypted block device read-only",
5070 This is the same as C<guestfs_luks_open> except that a read-only
5071 mapping is created.");
5073 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5075 "close a LUKS device",
5077 This closes a LUKS device that was created earlier by
5078 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5079 C<device> parameter must be the name of the LUKS mapping
5080 device (ie. C</dev/mapper/mapname>) and I<not> the name
5081 of the underlying block device.");
5083 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5085 "format a block device as a LUKS encrypted device",
5087 This command erases existing data on C<device> and formats
5088 the device as a LUKS encrypted device. C<key> is the
5089 initial key, which is added to key slot C<slot>. (LUKS
5090 supports 8 key slots, numbered 0-7).");
5092 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5094 "format a block device as a LUKS encrypted device",
5096 This command is the same as C<guestfs_luks_format> but
5097 it also allows you to set the C<cipher> used.");
5099 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5101 "add a key on a LUKS encrypted device",
5103 This command adds a new key on LUKS device C<device>.
5104 C<key> is any existing key, and is used to access the device.
5105 C<newkey> is the new key to add. C<keyslot> is the key slot
5106 that will be replaced.
5108 Note that if C<keyslot> already contains a key, then this
5109 command will fail. You have to use C<guestfs_luks_kill_slot>
5110 first to remove that key.");
5112 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5114 "remove a key from a LUKS encrypted device",
5116 This command deletes the key in key slot C<keyslot> from the
5117 encrypted LUKS device C<device>. C<key> must be one of the
5120 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5121 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5122 [["is_lv"; "/dev/VG/LV"]]);
5123 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5124 [["is_lv"; "/dev/sda1"]])],
5125 "test if device is a logical volume",
5127 This command tests whether C<device> is a logical volume, and
5128 returns true iff this is the case.");
5130 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5132 "find a filesystem by UUID",
5134 This command searches the filesystems and returns the one
5135 which has the given UUID. An error is returned if no such
5136 filesystem can be found.
5138 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5140 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5142 "find a filesystem by label",
5144 This command searches the filesystems and returns the one
5145 which has the given label. An error is returned if no such
5146 filesystem can be found.
5148 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5150 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5151 [InitISOFS, Always, TestOutputFalse (
5152 [["is_chardev"; "/directory"]]);
5153 InitBasicFS, Always, TestOutputTrue (
5154 [["mknod_c"; "0o777"; "99"; "66"; "/test"];
5155 ["is_chardev"; "/test"]])],
5156 "test if character device",
5158 This returns C<true> if and only if there is a character device
5159 with the given C<path> name.
5161 See also C<guestfs_stat>.");
5163 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5164 [InitISOFS, Always, TestOutputFalse (
5165 [["is_blockdev"; "/directory"]]);
5166 InitBasicFS, Always, TestOutputTrue (
5167 [["mknod_b"; "0o777"; "99"; "66"; "/test"];
5168 ["is_blockdev"; "/test"]])],
5169 "test if block device",
5171 This returns C<true> if and only if there is a block device
5172 with the given C<path> name.
5174 See also C<guestfs_stat>.");
5176 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5177 [InitISOFS, Always, TestOutputFalse (
5178 [["is_fifo"; "/directory"]]);
5179 InitBasicFS, Always, TestOutputTrue (
5180 [["mkfifo"; "0o777"; "/test"];
5181 ["is_fifo"; "/test"]])],
5182 "test if FIFO (named pipe)",
5184 This returns C<true> if and only if there is a FIFO (named pipe)
5185 with the given C<path> name.
5187 See also C<guestfs_stat>.");
5189 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5190 [InitISOFS, Always, TestOutputFalse (
5191 [["is_symlink"; "/directory"]]);
5192 InitISOFS, Always, TestOutputTrue (
5193 [["is_symlink"; "/abssymlink"]])],
5194 "test if symbolic link",
5196 This returns C<true> if and only if there is a symbolic link
5197 with the given C<path> name.
5199 See also C<guestfs_stat>.");
5201 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5202 (* XXX Need a positive test for sockets. *)
5203 [InitISOFS, Always, TestOutputFalse (
5204 [["is_socket"; "/directory"]])],
5207 This returns C<true> if and only if there is a Unix domain socket
5208 with the given C<path> name.
5210 See also C<guestfs_stat>.");
5212 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5213 [InitPartition, Always, TestOutputDevice (
5214 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5215 InitEmpty, Always, TestLastFail (
5216 [["part_to_dev"; "/dev/sda"]])],
5217 "convert partition name to device name",
5219 This function takes a partition name (eg. \"/dev/sdb1\") and
5220 removes the partition number, returning the device name
5223 The named partition must exist, for example as a string returned
5224 from C<guestfs_list_partitions>.");
5226 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [],
5227 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5228 [InitBasicFS, Always, TestOutput (
5229 [["upload_offset"; "../COPYING.LIB"; "/COPYING.LIB"; "0"];
5230 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5231 "upload a file from the local machine with offset",
5233 Upload local file C<filename> to C<remotefilename> on the
5236 C<remotefilename> is overwritten starting at the byte C<offset>
5237 specified. The intention is to overwrite parts of existing
5238 files or devices, although if a non-existant file is specified
5239 then it is created with a \"hole\" before C<offset>. The
5240 size of the data written is implicit in the size of the
5243 Note that there is no limit on the amount of data that
5244 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5245 and this call always writes the full amount unless an
5248 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5250 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5251 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5252 let offset = string_of_int 100 in
5253 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5254 [InitBasicFS, Always, TestOutput (
5255 (* Pick a file from cwd which isn't likely to change. *)
5256 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
5257 ["download_offset"; "/COPYING.LIB"; "testdownload.tmp"; offset; size];
5258 ["upload_offset"; "testdownload.tmp"; "/COPYING.LIB"; offset];
5259 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5260 "download a file to the local machine with offset and size",
5262 Download file C<remotefilename> and save it as C<filename>
5263 on the local machine.
5265 C<remotefilename> is read for C<size> bytes starting at C<offset>
5266 (this region must be within the file or device).
5268 Note that there is no limit on the amount of data that
5269 can be downloaded with this call, unlike with C<guestfs_pread>,
5270 and this call always reads the full amount unless an
5273 See also C<guestfs_download>, C<guestfs_pread>.");
5275 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5276 [InitPartition, Always, TestOutputList (
5277 [["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"];
5278 ["blockdev_rereadpt"; "/dev/sda"];
5279 ["list_partitions"]], [])],
5280 "write to part of a device",
5282 This command writes to part of a device. It writes the data
5283 buffer C<content> to C<device> starting at offset C<offset>.
5285 This command implements the L<pwrite(2)> system call, and like
5286 that system call it may not write the full data requested
5287 (although short writes to disk devices and partitions are
5288 probably impossible with standard Linux kernels).
5290 See also C<guestfs_pwrite>.");
5292 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5293 [InitEmpty, Always, TestOutputBuffer (
5294 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5295 "read part of a device",
5297 This command lets you read part of a file. It reads C<count>
5298 bytes of C<device>, starting at C<offset>.
5300 This may read fewer bytes than requested. For further details
5301 see the L<pread(2)> system call.
5303 See also C<guestfs_pread>.");
5305 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5306 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5307 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5308 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5309 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5310 "get canonical name of an LV",
5312 This converts alternative naming schemes for LVs that you
5313 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5314 is converted to C</dev/VG/LV>.
5316 This command returns an error if the C<lvname> parameter does
5317 not refer to a logical volume.
5319 See also C<guestfs_is_lv>.");
5323 let all_functions = non_daemon_functions @ daemon_functions
5325 (* In some places we want the functions to be displayed sorted
5326 * alphabetically, so this is useful:
5328 let all_functions_sorted = List.sort action_compare all_functions
5330 (* This is used to generate the src/MAX_PROC_NR file which
5331 * contains the maximum procedure number, a surrogate for the
5332 * ABI version number. See src/Makefile.am for the details.
5335 let proc_nrs = List.map (
5336 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5337 ) daemon_functions in
5338 List.fold_left max 0 proc_nrs
5340 (* Non-API meta-commands available only in guestfish.
5342 * Note (1): style, proc_nr and tests fields are all meaningless.
5343 * The only fields which are actually used are the shortname,
5344 * FishAlias flags, shortdesc and longdesc.
5346 * Note (2): to refer to other commands, use L</shortname>.
5348 * Note (3): keep this list sorted by shortname.
5350 let fish_commands = [
5351 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5352 "allocate and add a disk file",
5353 " alloc filename size
5355 This creates an empty (zeroed) file of the given size, and then adds
5356 so it can be further examined.
5358 For more advanced image creation, see L<qemu-img(1)> utility.
5360 Size can be specified using standard suffixes, eg. C<1M>.
5362 To create a sparse file, use L</sparse> instead. To create a
5363 prepared disk image, see L</PREPARED DISK IMAGES>.");
5365 ("copy_in", (RErr,[], []), -1, [], [],
5366 "copy local files or directories into an image",
5367 " copy-in local [local ...] /remotedir
5369 C<copy-in> copies local files or directories recursively into the disk
5370 image, placing them in the directory called C</remotedir> (which must
5371 exist). This guestfish meta-command turns into a sequence of
5372 L</tar-in> and other commands as necessary.
5374 Multiple local files and directories can be specified, but the last
5375 parameter must always be a remote directory. Wildcards cannot be
5378 ("copy_out", (RErr,[], []), -1, [], [],
5379 "copy remote files or directories out of an image",
5380 " copy-out remote [remote ...] localdir
5382 C<copy-out> copies remote files or directories recursively out of the
5383 disk image, placing them on the host disk in a local directory called
5384 C<localdir> (which must exist). This guestfish meta-command turns
5385 into a sequence of L</download>, L</tar-out> and other commands as
5388 Multiple remote files and directories can be specified, but the last
5389 parameter must always be a local directory. To download to the
5390 current directory, use C<.> as in:
5394 Wildcards cannot be used in the ordinary command, but you can use
5395 them with the help of L</glob> like this:
5397 glob copy-out /home/* .");
5399 ("echo", (RErr,[], []), -1, [], [],
5400 "display a line of text",
5403 This echos the parameters to the terminal.");
5405 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5409 This is used to edit a file. It downloads the file, edits it
5410 locally using your editor, then uploads the result.
5412 The editor is C<$EDITOR>. However if you use the alternate
5413 commands C<vi> or C<emacs> you will get those corresponding
5416 ("glob", (RErr,[], []), -1, [], [],
5417 "expand wildcards in command",
5418 " glob command args...
5420 Expand wildcards in any paths in the args list, and run C<command>
5421 repeatedly on each matching path.
5423 See L</WILDCARDS AND GLOBBING>.");
5425 ("hexedit", (RErr,[], []), -1, [], [],
5426 "edit with a hex editor",
5427 " hexedit <filename|device>
5428 hexedit <filename|device> <max>
5429 hexedit <filename|device> <start> <max>
5431 Use hexedit (a hex editor) to edit all or part of a binary file
5434 This command works by downloading potentially the whole file or
5435 device, editing it locally, then uploading it. If the file or
5436 device is large, you have to specify which part you wish to edit
5437 by using C<max> and/or C<start> C<max> parameters.
5438 C<start> and C<max> are specified in bytes, with the usual
5439 modifiers allowed such as C<1M> (1 megabyte).
5441 For example to edit the first few sectors of a disk you
5446 which would allow you to edit anywhere within the first megabyte
5449 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5451 hexedit /dev/sda1 0x400 0x400
5453 (assuming the superblock is in the standard location).
5455 This command requires the external L<hexedit(1)> program. You
5456 can specify another program to use by setting the C<HEXEDITOR>
5457 environment variable.
5459 See also L</hexdump>.");
5461 ("lcd", (RErr,[], []), -1, [], [],
5462 "change working directory",
5465 Change the local directory, ie. the current directory of guestfish
5468 Note that C<!cd> won't do what you might expect.");
5470 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5474 Opens the manual page for guestfish.");
5476 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5482 This is used to view a file.
5484 The default viewer is C<$PAGER>. However if you use the alternate
5485 command C<less> you will get the C<less> command specifically.");
5487 ("reopen", (RErr,[], []), -1, [], [],
5488 "close and reopen libguestfs handle",
5491 Close and reopen the libguestfs handle. It is not necessary to use
5492 this normally, because the handle is closed properly when guestfish
5493 exits. However this is occasionally useful for testing.");
5495 ("sparse", (RErr,[], []), -1, [], [],
5496 "create a sparse disk image and add",
5497 " sparse filename size
5499 This creates an empty sparse file of the given size, and then adds
5500 so it can be further examined.
5502 In all respects it works the same as the L</alloc> command, except that
5503 the image file is allocated sparsely, which means that disk blocks are
5504 not assigned to the file until they are needed. Sparse disk files
5505 only use space when written to, but they are slower and there is a
5506 danger you could run out of real disk space during a write operation.
5508 For more advanced image creation, see L<qemu-img(1)> utility.
5510 Size can be specified using standard suffixes, eg. C<1M>.");
5512 ("supported", (RErr,[], []), -1, [], [],
5513 "list supported groups of commands",
5516 This command returns a list of the optional groups
5517 known to the daemon, and indicates which ones are
5518 supported by this build of the libguestfs appliance.
5520 See also L<guestfs(3)/AVAILABILITY>.");
5522 ("time", (RErr,[], []), -1, [], [],
5523 "print elapsed time taken to run a command",
5524 " time command args...
5526 Run the command as usual, but print the elapsed time afterwards. This
5527 can be useful for benchmarking operations.");