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.
802 =item \"redhat-based\"
804 Some Red Hat-derived distro.
808 Red Hat Enterprise Linux and some derivatives.
812 Windows does not have distributions. This string is
813 returned if the OS type is Windows.
821 The distro could not be determined.
825 Future versions of libguestfs may return other strings here.
826 The caller should be prepared to handle any string.
828 Please read L<guestfs(3)/INSPECTION> for more details.");
830 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
832 "get major version of inspected operating system",
834 This function should only be called with a root device string
835 as returned by C<guestfs_inspect_os>.
837 This returns the major version number of the inspected operating
840 Windows uses a consistent versioning scheme which is I<not>
841 reflected in the popular public names used by the operating system.
842 Notably the operating system known as \"Windows 7\" is really
843 version 6.1 (ie. major = 6, minor = 1). You can find out the
844 real versions corresponding to releases of Windows by consulting
847 If the version could not be determined, then C<0> is returned.
849 Please read L<guestfs(3)/INSPECTION> for more details.");
851 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
853 "get minor version of inspected operating system",
855 This function should only be called with a root device string
856 as returned by C<guestfs_inspect_os>.
858 This returns the minor version number of the inspected operating
861 If the version could not be determined, then C<0> is returned.
863 Please read L<guestfs(3)/INSPECTION> for more details.
864 See also C<guestfs_inspect_get_major_version>.");
866 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
868 "get product name of inspected operating system",
870 This function should only be called with a root device string
871 as returned by C<guestfs_inspect_os>.
873 This returns the product name of the inspected operating
874 system. The product name is generally some freeform string
875 which can be displayed to the user, but should not be
878 If the product name could not be determined, then the
879 string C<unknown> is returned.
881 Please read L<guestfs(3)/INSPECTION> for more details.");
883 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
885 "get mountpoints of inspected operating system",
887 This function should only be called with a root device string
888 as returned by C<guestfs_inspect_os>.
890 This returns a hash of where we think the filesystems
891 associated with this operating system should be mounted.
892 Callers should note that this is at best an educated guess
893 made by reading configuration files such as C</etc/fstab>.
895 Each element in the returned hashtable has a key which
896 is the path of the mountpoint (eg. C</boot>) and a value
897 which is the filesystem that would be mounted there
900 Non-mounted devices such as swap devices are I<not>
901 returned in this list.
903 Please read L<guestfs(3)/INSPECTION> for more details.
904 See also C<guestfs_inspect_get_filesystems>.");
906 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
908 "get filesystems associated with inspected operating system",
910 This function should only be called with a root device string
911 as returned by C<guestfs_inspect_os>.
913 This returns a list of all the filesystems that we think
914 are associated with this operating system. This includes
915 the root filesystem, other ordinary filesystems, and
916 non-mounted devices like swap partitions.
918 In the case of a multi-boot virtual machine, it is possible
919 for a filesystem to be shared between operating systems.
921 Please read L<guestfs(3)/INSPECTION> for more details.
922 See also C<guestfs_inspect_get_mountpoints>.");
924 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
926 "set enable network flag",
928 If C<network> is true, then the network is enabled in the
929 libguestfs appliance. The default is false.
931 This affects whether commands are able to access the network
932 (see L<guestfs(3)/RUNNING COMMANDS>).
934 You must call this before calling C<guestfs_launch>, otherwise
937 ("get_network", (RBool "network", [], []), -1, [],
939 "get enable network flag",
941 This returns the enable network flag.");
943 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
947 This inspection command looks for filesystems on partitions,
948 block devices and logical volumes, returning a list of devices
949 containing filesystems and their type.
951 The return value is a hash, where the keys are the devices
952 containing filesystems, and the values are the filesystem types.
955 \"/dev/sda1\" => \"ntfs\"
956 \"/dev/sda2\" => \"ext2\"
957 \"/dev/vg_guest/lv_root\" => \"ext4\"
958 \"/dev/vg_guest/lv_swap\" => \"swap\"
960 The value can have the special value \"unknown\", meaning the
961 content of the device is undetermined or empty.
962 \"swap\" means a Linux swap partition.
964 This command runs other libguestfs commands, which might include
965 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
966 use this soon after launch and only when nothing is mounted.
968 Not all of the filesystems returned will be mountable. In
969 particular, swap partitions are returned in the list. Also
970 this command does not check that each filesystem
971 found is valid and mountable, and some filesystems might
972 be mountable but require special options. Filesystems may
973 not all belong to a single logical operating system
974 (use C<guestfs_inspect_os> to look for OSes).");
976 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
978 "add an image to examine or modify",
980 This function adds a virtual machine disk image C<filename> to
981 libguestfs. The first time you call this function, the disk
982 appears as C</dev/sda>, the second time as C</dev/sdb>, and
985 You don't necessarily need to be root when using libguestfs. However
986 you obviously do need sufficient permissions to access the filename
987 for whatever operations you want to perform (ie. read access if you
988 just want to read the image or write access if you want to modify the
991 This call checks that C<filename> exists.
993 The optional arguments are:
999 If true then the image is treated as read-only. Writes are still
1000 allowed, but they are stored in a temporary snapshot overlay which
1001 is discarded at the end. The disk that you add is not modified.
1005 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1006 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1007 Possible formats include C<raw> and C<qcow2>.
1009 Automatic detection of the format opens you up to a potential
1010 security hole when dealing with untrusted raw-format images.
1011 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1016 This rarely-used option lets you emulate the behaviour of the
1017 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1021 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1023 "get Windows systemroot of inspected operating system",
1025 This function should only be called with a root device string
1026 as returned by C<guestfs_inspect_os>.
1028 This returns the Windows systemroot of the inspected guest.
1029 The systemroot is a directory path such as C</WINDOWS>.
1031 This call assumes that the guest is Windows and that the
1032 systemroot could be determined by inspection. If this is not
1033 the case then an error is returned.
1035 Please read L<guestfs(3)/INSPECTION> for more details.");
1039 (* daemon_functions are any functions which cause some action
1040 * to take place in the daemon.
1043 let daemon_functions = [
1044 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1045 [InitEmpty, Always, TestOutput (
1046 [["part_disk"; "/dev/sda"; "mbr"];
1047 ["mkfs"; "ext2"; "/dev/sda1"];
1048 ["mount"; "/dev/sda1"; "/"];
1049 ["write"; "/new"; "new file contents"];
1050 ["cat"; "/new"]], "new file contents")],
1051 "mount a guest disk at a position in the filesystem",
1053 Mount a guest disk at a position in the filesystem. Block devices
1054 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1055 the guest. If those block devices contain partitions, they will have
1056 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1059 The rules are the same as for L<mount(2)>: A filesystem must
1060 first be mounted on C</> before others can be mounted. Other
1061 filesystems can only be mounted on directories which already
1064 The mounted filesystem is writable, if we have sufficient permissions
1065 on the underlying device.
1068 When you use this call, the filesystem options C<sync> and C<noatime>
1069 are set implicitly. This was originally done because we thought it
1070 would improve reliability, but it turns out that I<-o sync> has a
1071 very large negative performance impact and negligible effect on
1072 reliability. Therefore we recommend that you avoid using
1073 C<guestfs_mount> in any code that needs performance, and instead
1074 use C<guestfs_mount_options> (use an empty string for the first
1075 parameter if you don't want any options).");
1077 ("sync", (RErr, [], []), 2, [],
1078 [ InitEmpty, Always, TestRun [["sync"]]],
1079 "sync disks, writes are flushed through to the disk image",
1081 This syncs the disk, so that any writes are flushed through to the
1082 underlying disk image.
1084 You should always call this if you have modified a disk image, before
1085 closing the handle.");
1087 ("touch", (RErr, [Pathname "path"], []), 3, [],
1088 [InitBasicFS, Always, TestOutputTrue (
1090 ["exists"; "/new"]])],
1091 "update file timestamps or create a new file",
1093 Touch acts like the L<touch(1)> command. It can be used to
1094 update the timestamps on a file, or, if the file does not exist,
1095 to create a new zero-length file.
1097 This command only works on regular files, and will fail on other
1098 file types such as directories, symbolic links, block special etc.");
1100 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1101 [InitISOFS, Always, TestOutput (
1102 [["cat"; "/known-2"]], "abcdef\n")],
1103 "list the contents of a file",
1105 Return the contents of the file named C<path>.
1107 Note that this function cannot correctly handle binary files
1108 (specifically, files containing C<\\0> character which is treated
1109 as end of string). For those you need to use the C<guestfs_read_file>
1110 or C<guestfs_download> functions which have a more complex interface.");
1112 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1113 [], (* XXX Tricky to test because it depends on the exact format
1114 * of the 'ls -l' command, which changes between F10 and F11.
1116 "list the files in a directory (long format)",
1118 List the files in C<directory> (relative to the root directory,
1119 there is no cwd) in the format of 'ls -la'.
1121 This command is mostly useful for interactive sessions. It
1122 is I<not> intended that you try to parse the output string.");
1124 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1125 [InitBasicFS, Always, TestOutputList (
1127 ["touch"; "/newer"];
1128 ["touch"; "/newest"];
1129 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1130 "list the files in a directory",
1132 List the files in C<directory> (relative to the root directory,
1133 there is no cwd). The '.' and '..' entries are not returned, but
1134 hidden files are shown.
1136 This command is mostly useful for interactive sessions. Programs
1137 should probably use C<guestfs_readdir> instead.");
1139 ("list_devices", (RStringList "devices", [], []), 7, [],
1140 [InitEmpty, Always, TestOutputListOfDevices (
1141 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1142 "list the block devices",
1144 List all the block devices.
1146 The full block device names are returned, eg. C</dev/sda>.
1148 See also C<guestfs_list_filesystems>.");
1150 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1151 [InitBasicFS, Always, TestOutputListOfDevices (
1152 [["list_partitions"]], ["/dev/sda1"]);
1153 InitEmpty, Always, TestOutputListOfDevices (
1154 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1155 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1156 "list the partitions",
1158 List all the partitions detected on all block devices.
1160 The full partition device names are returned, eg. C</dev/sda1>
1162 This does not return logical volumes. For that you will need to
1163 call C<guestfs_lvs>.
1165 See also C<guestfs_list_filesystems>.");
1167 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1168 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1169 [["pvs"]], ["/dev/sda1"]);
1170 InitEmpty, Always, TestOutputListOfDevices (
1171 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1172 ["pvcreate"; "/dev/sda1"];
1173 ["pvcreate"; "/dev/sda2"];
1174 ["pvcreate"; "/dev/sda3"];
1175 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1176 "list the LVM physical volumes (PVs)",
1178 List all the physical volumes detected. This is the equivalent
1179 of the L<pvs(8)> command.
1181 This returns a list of just the device names that contain
1182 PVs (eg. C</dev/sda2>).
1184 See also C<guestfs_pvs_full>.");
1186 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1187 [InitBasicFSonLVM, Always, TestOutputList (
1189 InitEmpty, Always, TestOutputList (
1190 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1191 ["pvcreate"; "/dev/sda1"];
1192 ["pvcreate"; "/dev/sda2"];
1193 ["pvcreate"; "/dev/sda3"];
1194 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1195 ["vgcreate"; "VG2"; "/dev/sda3"];
1196 ["vgs"]], ["VG1"; "VG2"])],
1197 "list the LVM volume groups (VGs)",
1199 List all the volumes groups detected. This is the equivalent
1200 of the L<vgs(8)> command.
1202 This returns a list of just the volume group names that were
1203 detected (eg. C<VolGroup00>).
1205 See also C<guestfs_vgs_full>.");
1207 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1208 [InitBasicFSonLVM, Always, TestOutputList (
1209 [["lvs"]], ["/dev/VG/LV"]);
1210 InitEmpty, Always, TestOutputList (
1211 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1212 ["pvcreate"; "/dev/sda1"];
1213 ["pvcreate"; "/dev/sda2"];
1214 ["pvcreate"; "/dev/sda3"];
1215 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1216 ["vgcreate"; "VG2"; "/dev/sda3"];
1217 ["lvcreate"; "LV1"; "VG1"; "50"];
1218 ["lvcreate"; "LV2"; "VG1"; "50"];
1219 ["lvcreate"; "LV3"; "VG2"; "50"];
1220 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1221 "list the LVM logical volumes (LVs)",
1223 List all the logical volumes detected. This is the equivalent
1224 of the L<lvs(8)> command.
1226 This returns a list of the logical volume device names
1227 (eg. C</dev/VolGroup00/LogVol00>).
1229 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1231 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1232 [], (* XXX how to test? *)
1233 "list the LVM physical volumes (PVs)",
1235 List all the physical volumes detected. This is the equivalent
1236 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1238 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1239 [], (* XXX how to test? *)
1240 "list the LVM volume groups (VGs)",
1242 List all the volumes groups detected. This is the equivalent
1243 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1245 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1246 [], (* XXX how to test? *)
1247 "list the LVM logical volumes (LVs)",
1249 List all the logical volumes detected. This is the equivalent
1250 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1252 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1253 [InitISOFS, Always, TestOutputList (
1254 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1255 InitISOFS, Always, TestOutputList (
1256 [["read_lines"; "/empty"]], [])],
1257 "read file as lines",
1259 Return the contents of the file named C<path>.
1261 The file contents are returned as a list of lines. Trailing
1262 C<LF> and C<CRLF> character sequences are I<not> returned.
1264 Note that this function cannot correctly handle binary files
1265 (specifically, files containing C<\\0> character which is treated
1266 as end of line). For those you need to use the C<guestfs_read_file>
1267 function which has a more complex interface.");
1269 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1270 [], (* XXX Augeas code needs tests. *)
1271 "create a new Augeas handle",
1273 Create a new Augeas handle for editing configuration files.
1274 If there was any previous Augeas handle associated with this
1275 guestfs session, then it is closed.
1277 You must call this before using any other C<guestfs_aug_*>
1280 C<root> is the filesystem root. C<root> must not be NULL,
1283 The flags are the same as the flags defined in
1284 E<lt>augeas.hE<gt>, the logical I<or> of the following
1289 =item C<AUG_SAVE_BACKUP> = 1
1291 Keep the original file with a C<.augsave> extension.
1293 =item C<AUG_SAVE_NEWFILE> = 2
1295 Save changes into a file with extension C<.augnew>, and
1296 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1298 =item C<AUG_TYPE_CHECK> = 4
1300 Typecheck lenses (can be expensive).
1302 =item C<AUG_NO_STDINC> = 8
1304 Do not use standard load path for modules.
1306 =item C<AUG_SAVE_NOOP> = 16
1308 Make save a no-op, just record what would have been changed.
1310 =item C<AUG_NO_LOAD> = 32
1312 Do not load the tree in C<guestfs_aug_init>.
1316 To close the handle, you can call C<guestfs_aug_close>.
1318 To find out more about Augeas, see L<http://augeas.net/>.");
1320 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1321 [], (* XXX Augeas code needs tests. *)
1322 "close the current Augeas handle",
1324 Close the current Augeas handle and free up any resources
1325 used by it. After calling this, you have to call
1326 C<guestfs_aug_init> again before you can use any other
1327 Augeas functions.");
1329 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1330 [], (* XXX Augeas code needs tests. *)
1331 "define an Augeas variable",
1333 Defines an Augeas variable C<name> whose value is the result
1334 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1337 On success this returns the number of nodes in C<expr>, or
1338 C<0> if C<expr> evaluates to something which is not a nodeset.");
1340 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1341 [], (* XXX Augeas code needs tests. *)
1342 "define an Augeas node",
1344 Defines a variable C<name> whose value is the result of
1347 If C<expr> evaluates to an empty nodeset, a node is created,
1348 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1349 C<name> will be the nodeset containing that single node.
1351 On success this returns a pair containing the
1352 number of nodes in the nodeset, and a boolean flag
1353 if a node was created.");
1355 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1356 [], (* XXX Augeas code needs tests. *)
1357 "look up the value of an Augeas path",
1359 Look up the value associated with C<path>. If C<path>
1360 matches exactly one node, the C<value> is returned.");
1362 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1363 [], (* XXX Augeas code needs tests. *)
1364 "set Augeas path to value",
1366 Set the value associated with C<path> to C<val>.
1368 In the Augeas API, it is possible to clear a node by setting
1369 the value to NULL. Due to an oversight in the libguestfs API
1370 you cannot do that with this call. Instead you must use the
1371 C<guestfs_aug_clear> call.");
1373 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1374 [], (* XXX Augeas code needs tests. *)
1375 "insert a sibling Augeas node",
1377 Create a new sibling C<label> for C<path>, inserting it into
1378 the tree before or after C<path> (depending on the boolean
1381 C<path> must match exactly one existing node in the tree, and
1382 C<label> must be a label, ie. not contain C</>, C<*> or end
1383 with a bracketed index C<[N]>.");
1385 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1386 [], (* XXX Augeas code needs tests. *)
1387 "remove an Augeas path",
1389 Remove C<path> and all of its children.
1391 On success this returns the number of entries which were removed.");
1393 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1394 [], (* XXX Augeas code needs tests. *)
1397 Move the node C<src> to C<dest>. C<src> must match exactly
1398 one node. C<dest> is overwritten if it exists.");
1400 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1401 [], (* XXX Augeas code needs tests. *)
1402 "return Augeas nodes which match augpath",
1404 Returns a list of paths which match the path expression C<path>.
1405 The returned paths are sufficiently qualified so that they match
1406 exactly one node in the current tree.");
1408 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1409 [], (* XXX Augeas code needs tests. *)
1410 "write all pending Augeas changes to disk",
1412 This writes all pending changes to disk.
1414 The flags which were passed to C<guestfs_aug_init> affect exactly
1415 how files are saved.");
1417 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1418 [], (* XXX Augeas code needs tests. *)
1419 "load files into the tree",
1421 Load files into the tree.
1423 See C<aug_load> in the Augeas documentation for the full gory
1426 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1427 [], (* XXX Augeas code needs tests. *)
1428 "list Augeas nodes under augpath",
1430 This is just a shortcut for listing C<guestfs_aug_match>
1431 C<path/*> and sorting the resulting nodes into alphabetical order.");
1433 ("rm", (RErr, [Pathname "path"], []), 29, [],
1434 [InitBasicFS, Always, TestRun
1437 InitBasicFS, Always, TestLastFail
1439 InitBasicFS, Always, TestLastFail
1444 Remove the single file C<path>.");
1446 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1447 [InitBasicFS, Always, TestRun
1450 InitBasicFS, Always, TestLastFail
1451 [["rmdir"; "/new"]];
1452 InitBasicFS, Always, TestLastFail
1454 ["rmdir"; "/new"]]],
1455 "remove a directory",
1457 Remove the single directory C<path>.");
1459 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1460 [InitBasicFS, Always, TestOutputFalse
1462 ["mkdir"; "/new/foo"];
1463 ["touch"; "/new/foo/bar"];
1465 ["exists"; "/new"]]],
1466 "remove a file or directory recursively",
1468 Remove the file or directory C<path>, recursively removing the
1469 contents if its a directory. This is like the C<rm -rf> shell
1472 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1473 [InitBasicFS, Always, TestOutputTrue
1475 ["is_dir"; "/new"]];
1476 InitBasicFS, Always, TestLastFail
1477 [["mkdir"; "/new/foo/bar"]]],
1478 "create a directory",
1480 Create a directory named C<path>.");
1482 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1483 [InitBasicFS, Always, TestOutputTrue
1484 [["mkdir_p"; "/new/foo/bar"];
1485 ["is_dir"; "/new/foo/bar"]];
1486 InitBasicFS, Always, TestOutputTrue
1487 [["mkdir_p"; "/new/foo/bar"];
1488 ["is_dir"; "/new/foo"]];
1489 InitBasicFS, Always, TestOutputTrue
1490 [["mkdir_p"; "/new/foo/bar"];
1491 ["is_dir"; "/new"]];
1492 (* Regression tests for RHBZ#503133: *)
1493 InitBasicFS, Always, TestRun
1495 ["mkdir_p"; "/new"]];
1496 InitBasicFS, Always, TestLastFail
1498 ["mkdir_p"; "/new"]]],
1499 "create a directory and parents",
1501 Create a directory named C<path>, creating any parent directories
1502 as necessary. This is like the C<mkdir -p> shell command.");
1504 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1505 [], (* XXX Need stat command to test *)
1508 Change the mode (permissions) of C<path> to C<mode>. Only
1509 numeric modes are supported.
1511 I<Note>: When using this command from guestfish, C<mode>
1512 by default would be decimal, unless you prefix it with
1513 C<0> to get octal, ie. use C<0700> not C<700>.
1515 The mode actually set is affected by the umask.");
1517 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1518 [], (* XXX Need stat command to test *)
1519 "change file owner and group",
1521 Change the file owner to C<owner> and group to C<group>.
1523 Only numeric uid and gid are supported. If you want to use
1524 names, you will need to locate and parse the password file
1525 yourself (Augeas support makes this relatively easy).");
1527 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1528 [InitISOFS, Always, TestOutputTrue (
1529 [["exists"; "/empty"]]);
1530 InitISOFS, Always, TestOutputTrue (
1531 [["exists"; "/directory"]])],
1532 "test if file or directory exists",
1534 This returns C<true> if and only if there is a file, directory
1535 (or anything) with the given C<path> name.
1537 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1539 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1540 [InitISOFS, Always, TestOutputTrue (
1541 [["is_file"; "/known-1"]]);
1542 InitISOFS, Always, TestOutputFalse (
1543 [["is_file"; "/directory"]])],
1544 "test if a regular file",
1546 This returns C<true> if and only if there is a regular file
1547 with the given C<path> name. Note that it returns false for
1548 other objects like directories.
1550 See also C<guestfs_stat>.");
1552 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1553 [InitISOFS, Always, TestOutputFalse (
1554 [["is_dir"; "/known-3"]]);
1555 InitISOFS, Always, TestOutputTrue (
1556 [["is_dir"; "/directory"]])],
1557 "test if a directory",
1559 This returns C<true> if and only if there is a directory
1560 with the given C<path> name. Note that it returns false for
1561 other objects like files.
1563 See also C<guestfs_stat>.");
1565 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1566 [InitEmpty, Always, TestOutputListOfDevices (
1567 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1568 ["pvcreate"; "/dev/sda1"];
1569 ["pvcreate"; "/dev/sda2"];
1570 ["pvcreate"; "/dev/sda3"];
1571 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1572 "create an LVM physical volume",
1574 This creates an LVM physical volume on the named C<device>,
1575 where C<device> should usually be a partition name such
1578 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1579 [InitEmpty, Always, TestOutputList (
1580 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1581 ["pvcreate"; "/dev/sda1"];
1582 ["pvcreate"; "/dev/sda2"];
1583 ["pvcreate"; "/dev/sda3"];
1584 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1585 ["vgcreate"; "VG2"; "/dev/sda3"];
1586 ["vgs"]], ["VG1"; "VG2"])],
1587 "create an LVM volume group",
1589 This creates an LVM volume group called C<volgroup>
1590 from the non-empty list of physical volumes C<physvols>.");
1592 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1593 [InitEmpty, Always, TestOutputList (
1594 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1595 ["pvcreate"; "/dev/sda1"];
1596 ["pvcreate"; "/dev/sda2"];
1597 ["pvcreate"; "/dev/sda3"];
1598 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1599 ["vgcreate"; "VG2"; "/dev/sda3"];
1600 ["lvcreate"; "LV1"; "VG1"; "50"];
1601 ["lvcreate"; "LV2"; "VG1"; "50"];
1602 ["lvcreate"; "LV3"; "VG2"; "50"];
1603 ["lvcreate"; "LV4"; "VG2"; "50"];
1604 ["lvcreate"; "LV5"; "VG2"; "50"];
1606 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1607 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1608 "create an LVM logical volume",
1610 This creates an LVM logical volume called C<logvol>
1611 on the volume group C<volgroup>, with C<size> megabytes.");
1613 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1614 [InitEmpty, Always, TestOutput (
1615 [["part_disk"; "/dev/sda"; "mbr"];
1616 ["mkfs"; "ext2"; "/dev/sda1"];
1617 ["mount_options"; ""; "/dev/sda1"; "/"];
1618 ["write"; "/new"; "new file contents"];
1619 ["cat"; "/new"]], "new file contents")],
1620 "make a filesystem",
1622 This creates a filesystem on C<device> (usually a partition
1623 or LVM logical volume). The filesystem type is C<fstype>, for
1626 ("sfdisk", (RErr, [Device "device";
1627 Int "cyls"; Int "heads"; Int "sectors";
1628 StringList "lines"], []), 43, [DangerWillRobinson],
1630 "create partitions on a block device",
1632 This is a direct interface to the L<sfdisk(8)> program for creating
1633 partitions on block devices.
1635 C<device> should be a block device, for example C</dev/sda>.
1637 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1638 and sectors on the device, which are passed directly to sfdisk as
1639 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1640 of these, then the corresponding parameter is omitted. Usually for
1641 'large' disks, you can just pass C<0> for these, but for small
1642 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1643 out the right geometry and you will need to tell it.
1645 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1646 information refer to the L<sfdisk(8)> manpage.
1648 To create a single partition occupying the whole disk, you would
1649 pass C<lines> as a single element list, when the single element being
1650 the string C<,> (comma).
1652 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1653 C<guestfs_part_init>");
1655 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1656 (* Regression test for RHBZ#597135. *)
1657 [InitBasicFS, Always, TestLastFail
1658 [["write_file"; "/new"; "abc"; "10000"]]],
1661 This call creates a file called C<path>. The contents of the
1662 file is the string C<content> (which can contain any 8 bit data),
1663 with length C<size>.
1665 As a special case, if C<size> is C<0>
1666 then the length is calculated using C<strlen> (so in this case
1667 the content cannot contain embedded ASCII NULs).
1669 I<NB.> Owing to a bug, writing content containing ASCII NUL
1670 characters does I<not> work, even if the length is specified.");
1672 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1673 [InitEmpty, Always, TestOutputListOfDevices (
1674 [["part_disk"; "/dev/sda"; "mbr"];
1675 ["mkfs"; "ext2"; "/dev/sda1"];
1676 ["mount_options"; ""; "/dev/sda1"; "/"];
1677 ["mounts"]], ["/dev/sda1"]);
1678 InitEmpty, Always, TestOutputList (
1679 [["part_disk"; "/dev/sda"; "mbr"];
1680 ["mkfs"; "ext2"; "/dev/sda1"];
1681 ["mount_options"; ""; "/dev/sda1"; "/"];
1684 "unmount a filesystem",
1686 This unmounts the given filesystem. The filesystem may be
1687 specified either by its mountpoint (path) or the device which
1688 contains the filesystem.");
1690 ("mounts", (RStringList "devices", [], []), 46, [],
1691 [InitBasicFS, Always, TestOutputListOfDevices (
1692 [["mounts"]], ["/dev/sda1"])],
1693 "show mounted filesystems",
1695 This returns the list of currently mounted filesystems. It returns
1696 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1698 Some internal mounts are not shown.
1700 See also: C<guestfs_mountpoints>");
1702 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1703 [InitBasicFS, Always, TestOutputList (
1706 (* check that umount_all can unmount nested mounts correctly: *)
1707 InitEmpty, Always, TestOutputList (
1708 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1709 ["mkfs"; "ext2"; "/dev/sda1"];
1710 ["mkfs"; "ext2"; "/dev/sda2"];
1711 ["mkfs"; "ext2"; "/dev/sda3"];
1712 ["mount_options"; ""; "/dev/sda1"; "/"];
1714 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1715 ["mkdir"; "/mp1/mp2"];
1716 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1717 ["mkdir"; "/mp1/mp2/mp3"];
1720 "unmount all filesystems",
1722 This unmounts all mounted filesystems.
1724 Some internal mounts are not unmounted by this call.");
1726 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
1728 "remove all LVM LVs, VGs and PVs",
1730 This command removes all LVM logical volumes, volume groups
1731 and physical volumes.");
1733 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
1734 [InitISOFS, Always, TestOutput (
1735 [["file"; "/empty"]], "empty");
1736 InitISOFS, Always, TestOutput (
1737 [["file"; "/known-1"]], "ASCII text");
1738 InitISOFS, Always, TestLastFail (
1739 [["file"; "/notexists"]]);
1740 InitISOFS, Always, TestOutput (
1741 [["file"; "/abssymlink"]], "symbolic link");
1742 InitISOFS, Always, TestOutput (
1743 [["file"; "/directory"]], "directory")],
1744 "determine file type",
1746 This call uses the standard L<file(1)> command to determine
1747 the type or contents of the file.
1749 This call will also transparently look inside various types
1752 The exact command which runs is C<file -zb path>. Note in
1753 particular that the filename is not prepended to the output
1756 This command can also be used on C</dev/> devices
1757 (and partitions, LV names). You can for example use this
1758 to determine if a device contains a filesystem, although
1759 it's usually better to use C<guestfs_vfs_type>.
1761 If the C<path> does not begin with C</dev/> then
1762 this command only works for the content of regular files.
1763 For other file types (directory, symbolic link etc) it
1764 will just return the string C<directory> etc.");
1766 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
1767 [InitBasicFS, Always, TestOutput (
1768 [["upload"; "test-command"; "/test-command"];
1769 ["chmod"; "0o755"; "/test-command"];
1770 ["command"; "/test-command 1"]], "Result1");
1771 InitBasicFS, Always, TestOutput (
1772 [["upload"; "test-command"; "/test-command"];
1773 ["chmod"; "0o755"; "/test-command"];
1774 ["command"; "/test-command 2"]], "Result2\n");
1775 InitBasicFS, Always, TestOutput (
1776 [["upload"; "test-command"; "/test-command"];
1777 ["chmod"; "0o755"; "/test-command"];
1778 ["command"; "/test-command 3"]], "\nResult3");
1779 InitBasicFS, Always, TestOutput (
1780 [["upload"; "test-command"; "/test-command"];
1781 ["chmod"; "0o755"; "/test-command"];
1782 ["command"; "/test-command 4"]], "\nResult4\n");
1783 InitBasicFS, Always, TestOutput (
1784 [["upload"; "test-command"; "/test-command"];
1785 ["chmod"; "0o755"; "/test-command"];
1786 ["command"; "/test-command 5"]], "\nResult5\n\n");
1787 InitBasicFS, Always, TestOutput (
1788 [["upload"; "test-command"; "/test-command"];
1789 ["chmod"; "0o755"; "/test-command"];
1790 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1791 InitBasicFS, Always, TestOutput (
1792 [["upload"; "test-command"; "/test-command"];
1793 ["chmod"; "0o755"; "/test-command"];
1794 ["command"; "/test-command 7"]], "");
1795 InitBasicFS, Always, TestOutput (
1796 [["upload"; "test-command"; "/test-command"];
1797 ["chmod"; "0o755"; "/test-command"];
1798 ["command"; "/test-command 8"]], "\n");
1799 InitBasicFS, Always, TestOutput (
1800 [["upload"; "test-command"; "/test-command"];
1801 ["chmod"; "0o755"; "/test-command"];
1802 ["command"; "/test-command 9"]], "\n\n");
1803 InitBasicFS, Always, TestOutput (
1804 [["upload"; "test-command"; "/test-command"];
1805 ["chmod"; "0o755"; "/test-command"];
1806 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1807 InitBasicFS, Always, TestOutput (
1808 [["upload"; "test-command"; "/test-command"];
1809 ["chmod"; "0o755"; "/test-command"];
1810 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1811 InitBasicFS, Always, TestLastFail (
1812 [["upload"; "test-command"; "/test-command"];
1813 ["chmod"; "0o755"; "/test-command"];
1814 ["command"; "/test-command"]])],
1815 "run a command from the guest filesystem",
1817 This call runs a command from the guest filesystem. The
1818 filesystem must be mounted, and must contain a compatible
1819 operating system (ie. something Linux, with the same
1820 or compatible processor architecture).
1822 The single parameter is an argv-style list of arguments.
1823 The first element is the name of the program to run.
1824 Subsequent elements are parameters. The list must be
1825 non-empty (ie. must contain a program name). Note that
1826 the command runs directly, and is I<not> invoked via
1827 the shell (see C<guestfs_sh>).
1829 The return value is anything printed to I<stdout> by
1832 If the command returns a non-zero exit status, then
1833 this function returns an error message. The error message
1834 string is the content of I<stderr> from the command.
1836 The C<$PATH> environment variable will contain at least
1837 C</usr/bin> and C</bin>. If you require a program from
1838 another location, you should provide the full path in the
1841 Shared libraries and data files required by the program
1842 must be available on filesystems which are mounted in the
1843 correct places. It is the caller's responsibility to ensure
1844 all filesystems that are needed are mounted at the right
1847 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
1848 [InitBasicFS, Always, TestOutputList (
1849 [["upload"; "test-command"; "/test-command"];
1850 ["chmod"; "0o755"; "/test-command"];
1851 ["command_lines"; "/test-command 1"]], ["Result1"]);
1852 InitBasicFS, Always, TestOutputList (
1853 [["upload"; "test-command"; "/test-command"];
1854 ["chmod"; "0o755"; "/test-command"];
1855 ["command_lines"; "/test-command 2"]], ["Result2"]);
1856 InitBasicFS, Always, TestOutputList (
1857 [["upload"; "test-command"; "/test-command"];
1858 ["chmod"; "0o755"; "/test-command"];
1859 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1860 InitBasicFS, Always, TestOutputList (
1861 [["upload"; "test-command"; "/test-command"];
1862 ["chmod"; "0o755"; "/test-command"];
1863 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1864 InitBasicFS, Always, TestOutputList (
1865 [["upload"; "test-command"; "/test-command"];
1866 ["chmod"; "0o755"; "/test-command"];
1867 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1868 InitBasicFS, Always, TestOutputList (
1869 [["upload"; "test-command"; "/test-command"];
1870 ["chmod"; "0o755"; "/test-command"];
1871 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1872 InitBasicFS, Always, TestOutputList (
1873 [["upload"; "test-command"; "/test-command"];
1874 ["chmod"; "0o755"; "/test-command"];
1875 ["command_lines"; "/test-command 7"]], []);
1876 InitBasicFS, Always, TestOutputList (
1877 [["upload"; "test-command"; "/test-command"];
1878 ["chmod"; "0o755"; "/test-command"];
1879 ["command_lines"; "/test-command 8"]], [""]);
1880 InitBasicFS, Always, TestOutputList (
1881 [["upload"; "test-command"; "/test-command"];
1882 ["chmod"; "0o755"; "/test-command"];
1883 ["command_lines"; "/test-command 9"]], ["";""]);
1884 InitBasicFS, Always, TestOutputList (
1885 [["upload"; "test-command"; "/test-command"];
1886 ["chmod"; "0o755"; "/test-command"];
1887 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1888 InitBasicFS, Always, TestOutputList (
1889 [["upload"; "test-command"; "/test-command"];
1890 ["chmod"; "0o755"; "/test-command"];
1891 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1892 "run a command, returning lines",
1894 This is the same as C<guestfs_command>, but splits the
1895 result into a list of lines.
1897 See also: C<guestfs_sh_lines>");
1899 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
1900 [InitISOFS, Always, TestOutputStruct (
1901 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1902 "get file information",
1904 Returns file information for the given C<path>.
1906 This is the same as the C<stat(2)> system call.");
1908 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
1909 [InitISOFS, Always, TestOutputStruct (
1910 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1911 "get file information for a symbolic link",
1913 Returns file information for the given C<path>.
1915 This is the same as C<guestfs_stat> except that if C<path>
1916 is a symbolic link, then the link is stat-ed, not the file it
1919 This is the same as the C<lstat(2)> system call.");
1921 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
1922 [InitISOFS, Always, TestOutputStruct (
1923 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1924 "get file system statistics",
1926 Returns file system statistics for any mounted file system.
1927 C<path> should be a file or directory in the mounted file system
1928 (typically it is the mount point itself, but it doesn't need to be).
1930 This is the same as the C<statvfs(2)> system call.");
1932 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
1934 "get ext2/ext3/ext4 superblock details",
1936 This returns the contents of the ext2, ext3 or ext4 filesystem
1937 superblock on C<device>.
1939 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1940 manpage for more details. The list of fields returned isn't
1941 clearly defined, and depends on both the version of C<tune2fs>
1942 that libguestfs was built against, and the filesystem itself.");
1944 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
1945 [InitEmpty, Always, TestOutputTrue (
1946 [["blockdev_setro"; "/dev/sda"];
1947 ["blockdev_getro"; "/dev/sda"]])],
1948 "set block device to read-only",
1950 Sets the block device named C<device> to read-only.
1952 This uses the L<blockdev(8)> command.");
1954 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
1955 [InitEmpty, Always, TestOutputFalse (
1956 [["blockdev_setrw"; "/dev/sda"];
1957 ["blockdev_getro"; "/dev/sda"]])],
1958 "set block device to read-write",
1960 Sets the block device named C<device> to read-write.
1962 This uses the L<blockdev(8)> command.");
1964 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
1965 [InitEmpty, Always, TestOutputTrue (
1966 [["blockdev_setro"; "/dev/sda"];
1967 ["blockdev_getro"; "/dev/sda"]])],
1968 "is block device set to read-only",
1970 Returns a boolean indicating if the block device is read-only
1971 (true if read-only, false if not).
1973 This uses the L<blockdev(8)> command.");
1975 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
1976 [InitEmpty, Always, TestOutputInt (
1977 [["blockdev_getss"; "/dev/sda"]], 512)],
1978 "get sectorsize of block device",
1980 This returns the size of sectors on a block device.
1981 Usually 512, but can be larger for modern devices.
1983 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1986 This uses the L<blockdev(8)> command.");
1988 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
1989 [InitEmpty, Always, TestOutputInt (
1990 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1991 "get blocksize of block device",
1993 This returns the block size of a device.
1995 (Note this is different from both I<size in blocks> and
1996 I<filesystem block size>).
1998 This uses the L<blockdev(8)> command.");
2000 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2002 "set blocksize of block device",
2004 This sets the block size of a device.
2006 (Note this is different from both I<size in blocks> and
2007 I<filesystem block size>).
2009 This uses the L<blockdev(8)> command.");
2011 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2012 [InitEmpty, Always, TestOutputInt (
2013 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2014 "get total size of device in 512-byte sectors",
2016 This returns the size of the device in units of 512-byte sectors
2017 (even if the sectorsize isn't 512 bytes ... weird).
2019 See also C<guestfs_blockdev_getss> for the real sector size of
2020 the device, and C<guestfs_blockdev_getsize64> for the more
2021 useful I<size in bytes>.
2023 This uses the L<blockdev(8)> command.");
2025 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2026 [InitEmpty, Always, TestOutputInt (
2027 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2028 "get total size of device in bytes",
2030 This returns the size of the device in bytes.
2032 See also C<guestfs_blockdev_getsz>.
2034 This uses the L<blockdev(8)> command.");
2036 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2037 [InitEmpty, Always, TestRun
2038 [["blockdev_flushbufs"; "/dev/sda"]]],
2039 "flush device buffers",
2041 This tells the kernel to flush internal buffers associated
2044 This uses the L<blockdev(8)> command.");
2046 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2047 [InitEmpty, Always, TestRun
2048 [["blockdev_rereadpt"; "/dev/sda"]]],
2049 "reread partition table",
2051 Reread the partition table on C<device>.
2053 This uses the L<blockdev(8)> command.");
2055 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [],
2056 [InitBasicFS, Always, TestOutput (
2057 (* Pick a file from cwd which isn't likely to change. *)
2058 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2059 ["checksum"; "md5"; "/COPYING.LIB"]],
2060 Digest.to_hex (Digest.file "COPYING.LIB"))],
2061 "upload a file from the local machine",
2063 Upload local file C<filename> to C<remotefilename> on the
2066 C<filename> can also be a named pipe.
2068 See also C<guestfs_download>.");
2070 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2071 [InitBasicFS, Always, TestOutput (
2072 (* Pick a file from cwd which isn't likely to change. *)
2073 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2074 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2075 ["upload"; "testdownload.tmp"; "/upload"];
2076 ["checksum"; "md5"; "/upload"]],
2077 Digest.to_hex (Digest.file "COPYING.LIB"))],
2078 "download a file to the local machine",
2080 Download file C<remotefilename> and save it as C<filename>
2081 on the local machine.
2083 C<filename> can also be a named pipe.
2085 See also C<guestfs_upload>, C<guestfs_cat>.");
2087 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2088 [InitISOFS, Always, TestOutput (
2089 [["checksum"; "crc"; "/known-3"]], "2891671662");
2090 InitISOFS, Always, TestLastFail (
2091 [["checksum"; "crc"; "/notexists"]]);
2092 InitISOFS, Always, TestOutput (
2093 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2094 InitISOFS, Always, TestOutput (
2095 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2096 InitISOFS, Always, TestOutput (
2097 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2098 InitISOFS, Always, TestOutput (
2099 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2100 InitISOFS, Always, TestOutput (
2101 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2102 InitISOFS, Always, TestOutput (
2103 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2104 (* Test for RHBZ#579608, absolute symbolic links. *)
2105 InitISOFS, Always, TestOutput (
2106 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2107 "compute MD5, SHAx or CRC checksum of file",
2109 This call computes the MD5, SHAx or CRC checksum of the
2112 The type of checksum to compute is given by the C<csumtype>
2113 parameter which must have one of the following values:
2119 Compute the cyclic redundancy check (CRC) specified by POSIX
2120 for the C<cksum> command.
2124 Compute the MD5 hash (using the C<md5sum> program).
2128 Compute the SHA1 hash (using the C<sha1sum> program).
2132 Compute the SHA224 hash (using the C<sha224sum> program).
2136 Compute the SHA256 hash (using the C<sha256sum> program).
2140 Compute the SHA384 hash (using the C<sha384sum> program).
2144 Compute the SHA512 hash (using the C<sha512sum> program).
2148 The checksum is returned as a printable string.
2150 To get the checksum for a device, use C<guestfs_checksum_device>.
2152 To get the checksums for many files, use C<guestfs_checksums_out>.");
2154 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2155 [InitBasicFS, Always, TestOutput (
2156 [["tar_in"; "../images/helloworld.tar"; "/"];
2157 ["cat"; "/hello"]], "hello\n")],
2158 "unpack tarfile to directory",
2160 This command uploads and unpacks local file C<tarfile> (an
2161 I<uncompressed> tar file) into C<directory>.
2163 To upload a compressed tarball, use C<guestfs_tgz_in>
2164 or C<guestfs_txz_in>.");
2166 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2168 "pack directory into tarfile",
2170 This command packs the contents of C<directory> and downloads
2171 it to local file C<tarfile>.
2173 To download a compressed tarball, use C<guestfs_tgz_out>
2174 or C<guestfs_txz_out>.");
2176 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2177 [InitBasicFS, Always, TestOutput (
2178 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2179 ["cat"; "/hello"]], "hello\n")],
2180 "unpack compressed tarball to directory",
2182 This command uploads and unpacks local file C<tarball> (a
2183 I<gzip compressed> tar file) into C<directory>.
2185 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2187 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2189 "pack directory into compressed tarball",
2191 This command packs the contents of C<directory> and downloads
2192 it to local file C<tarball>.
2194 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2196 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2197 [InitBasicFS, Always, TestLastFail (
2199 ["mount_ro"; "/dev/sda1"; "/"];
2200 ["touch"; "/new"]]);
2201 InitBasicFS, Always, TestOutput (
2202 [["write"; "/new"; "data"];
2204 ["mount_ro"; "/dev/sda1"; "/"];
2205 ["cat"; "/new"]], "data")],
2206 "mount a guest disk, read-only",
2208 This is the same as the C<guestfs_mount> command, but it
2209 mounts the filesystem with the read-only (I<-o ro>) flag.");
2211 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2213 "mount a guest disk with mount options",
2215 This is the same as the C<guestfs_mount> command, but it
2216 allows you to set the mount options as for the
2217 L<mount(8)> I<-o> flag.
2219 If the C<options> parameter is an empty string, then
2220 no options are passed (all options default to whatever
2221 the filesystem uses).");
2223 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2225 "mount a guest disk with mount options and vfstype",
2227 This is the same as the C<guestfs_mount> command, but it
2228 allows you to set both the mount options and the vfstype
2229 as for the L<mount(8)> I<-o> and I<-t> flags.");
2231 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [],
2233 "debugging and internals",
2235 The C<guestfs_debug> command exposes some internals of
2236 C<guestfsd> (the guestfs daemon) that runs inside the
2239 There is no comprehensive help for this command. You have
2240 to look at the file C<daemon/debug.c> in the libguestfs source
2241 to find out what you can do.");
2243 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2244 [InitEmpty, Always, TestOutputList (
2245 [["part_disk"; "/dev/sda"; "mbr"];
2246 ["pvcreate"; "/dev/sda1"];
2247 ["vgcreate"; "VG"; "/dev/sda1"];
2248 ["lvcreate"; "LV1"; "VG"; "50"];
2249 ["lvcreate"; "LV2"; "VG"; "50"];
2250 ["lvremove"; "/dev/VG/LV1"];
2251 ["lvs"]], ["/dev/VG/LV2"]);
2252 InitEmpty, Always, TestOutputList (
2253 [["part_disk"; "/dev/sda"; "mbr"];
2254 ["pvcreate"; "/dev/sda1"];
2255 ["vgcreate"; "VG"; "/dev/sda1"];
2256 ["lvcreate"; "LV1"; "VG"; "50"];
2257 ["lvcreate"; "LV2"; "VG"; "50"];
2258 ["lvremove"; "/dev/VG"];
2260 InitEmpty, Always, TestOutputList (
2261 [["part_disk"; "/dev/sda"; "mbr"];
2262 ["pvcreate"; "/dev/sda1"];
2263 ["vgcreate"; "VG"; "/dev/sda1"];
2264 ["lvcreate"; "LV1"; "VG"; "50"];
2265 ["lvcreate"; "LV2"; "VG"; "50"];
2266 ["lvremove"; "/dev/VG"];
2268 "remove an LVM logical volume",
2270 Remove an LVM logical volume C<device>, where C<device> is
2271 the path to the LV, such as C</dev/VG/LV>.
2273 You can also remove all LVs in a volume group by specifying
2274 the VG name, C</dev/VG>.");
2276 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2277 [InitEmpty, Always, TestOutputList (
2278 [["part_disk"; "/dev/sda"; "mbr"];
2279 ["pvcreate"; "/dev/sda1"];
2280 ["vgcreate"; "VG"; "/dev/sda1"];
2281 ["lvcreate"; "LV1"; "VG"; "50"];
2282 ["lvcreate"; "LV2"; "VG"; "50"];
2285 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"];
2293 "remove an LVM volume group",
2295 Remove an LVM volume group C<vgname>, (for example C<VG>).
2297 This also forcibly removes all logical volumes in the volume
2300 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2301 [InitEmpty, Always, TestOutputListOfDevices (
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"];
2308 ["pvremove"; "/dev/sda1"];
2310 InitEmpty, Always, TestOutputListOfDevices (
2311 [["part_disk"; "/dev/sda"; "mbr"];
2312 ["pvcreate"; "/dev/sda1"];
2313 ["vgcreate"; "VG"; "/dev/sda1"];
2314 ["lvcreate"; "LV1"; "VG"; "50"];
2315 ["lvcreate"; "LV2"; "VG"; "50"];
2317 ["pvremove"; "/dev/sda1"];
2319 InitEmpty, Always, TestOutputListOfDevices (
2320 [["part_disk"; "/dev/sda"; "mbr"];
2321 ["pvcreate"; "/dev/sda1"];
2322 ["vgcreate"; "VG"; "/dev/sda1"];
2323 ["lvcreate"; "LV1"; "VG"; "50"];
2324 ["lvcreate"; "LV2"; "VG"; "50"];
2326 ["pvremove"; "/dev/sda1"];
2328 "remove an LVM physical volume",
2330 This wipes a physical volume C<device> so that LVM will no longer
2333 The implementation uses the C<pvremove> command which refuses to
2334 wipe physical volumes that contain any volume groups, so you have
2335 to remove those first.");
2337 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2338 [InitBasicFS, Always, TestOutput (
2339 [["set_e2label"; "/dev/sda1"; "testlabel"];
2340 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2341 "set the ext2/3/4 filesystem label",
2343 This sets the ext2/3/4 filesystem label of the filesystem on
2344 C<device> to C<label>. Filesystem labels are limited to
2347 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2348 to return the existing label on a filesystem.");
2350 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2352 "get the ext2/3/4 filesystem label",
2354 This returns the ext2/3/4 filesystem label of the filesystem on
2357 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2358 (let uuid = uuidgen () in
2359 [InitBasicFS, Always, TestOutput (
2360 [["set_e2uuid"; "/dev/sda1"; uuid];
2361 ["get_e2uuid"; "/dev/sda1"]], uuid);
2362 InitBasicFS, Always, TestOutput (
2363 [["set_e2uuid"; "/dev/sda1"; "clear"];
2364 ["get_e2uuid"; "/dev/sda1"]], "");
2365 (* We can't predict what UUIDs will be, so just check the commands run. *)
2366 InitBasicFS, Always, TestRun (
2367 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2368 InitBasicFS, Always, TestRun (
2369 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2370 "set the ext2/3/4 filesystem UUID",
2372 This sets the ext2/3/4 filesystem UUID of the filesystem on
2373 C<device> to C<uuid>. The format of the UUID and alternatives
2374 such as C<clear>, C<random> and C<time> are described in the
2375 L<tune2fs(8)> manpage.
2377 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2378 to return the existing UUID of a filesystem.");
2380 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2381 (* Regression test for RHBZ#597112. *)
2382 (let uuid = uuidgen () in
2383 [InitBasicFS, Always, TestOutput (
2384 [["mke2journal"; "1024"; "/dev/sdb"];
2385 ["set_e2uuid"; "/dev/sdb"; uuid];
2386 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2387 "get the ext2/3/4 filesystem UUID",
2389 This returns the ext2/3/4 filesystem UUID of the filesystem on
2392 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2393 [InitBasicFS, Always, TestOutputInt (
2394 [["umount"; "/dev/sda1"];
2395 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2396 InitBasicFS, Always, TestOutputInt (
2397 [["umount"; "/dev/sda1"];
2398 ["zero"; "/dev/sda1"];
2399 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2400 "run the filesystem checker",
2402 This runs the filesystem checker (fsck) on C<device> which
2403 should have filesystem type C<fstype>.
2405 The returned integer is the status. See L<fsck(8)> for the
2406 list of status codes from C<fsck>.
2414 Multiple status codes can be summed together.
2418 A non-zero return code can mean \"success\", for example if
2419 errors have been corrected on the filesystem.
2423 Checking or repairing NTFS volumes is not supported
2428 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2430 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2431 [InitBasicFS, Always, TestOutput (
2432 [["umount"; "/dev/sda1"];
2433 ["zero"; "/dev/sda1"];
2434 ["file"; "/dev/sda1"]], "data")],
2435 "write zeroes to the device",
2437 This command writes zeroes over the first few blocks of C<device>.
2439 How many blocks are zeroed isn't specified (but it's I<not> enough
2440 to securely wipe the device). It should be sufficient to remove
2441 any partition tables, filesystem superblocks and so on.
2443 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2445 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2447 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2448 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2450 [InitBasicFS, Always, TestOutputTrue (
2451 [["mkdir_p"; "/boot/grub"];
2452 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2453 ["grub_install"; "/"; "/dev/vda"];
2454 ["is_dir"; "/boot"]])],
2457 This command installs GRUB (the Grand Unified Bootloader) on
2458 C<device>, with the root directory being C<root>.
2460 Note: If grub-install reports the error
2461 \"No suitable drive was found in the generated device map.\"
2462 it may be that you need to create a C</boot/grub/device.map>
2463 file first that contains the mapping between grub device names
2464 and Linux device names. It is usually sufficient to create
2469 replacing C</dev/vda> with the name of the installation device.");
2471 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2472 [InitBasicFS, Always, TestOutput (
2473 [["write"; "/old"; "file content"];
2474 ["cp"; "/old"; "/new"];
2475 ["cat"; "/new"]], "file content");
2476 InitBasicFS, Always, TestOutputTrue (
2477 [["write"; "/old"; "file content"];
2478 ["cp"; "/old"; "/new"];
2479 ["is_file"; "/old"]]);
2480 InitBasicFS, Always, TestOutput (
2481 [["write"; "/old"; "file content"];
2483 ["cp"; "/old"; "/dir/new"];
2484 ["cat"; "/dir/new"]], "file content")],
2487 This copies a file from C<src> to C<dest> where C<dest> is
2488 either a destination filename or destination directory.");
2490 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2491 [InitBasicFS, Always, TestOutput (
2492 [["mkdir"; "/olddir"];
2493 ["mkdir"; "/newdir"];
2494 ["write"; "/olddir/file"; "file content"];
2495 ["cp_a"; "/olddir"; "/newdir"];
2496 ["cat"; "/newdir/olddir/file"]], "file content")],
2497 "copy a file or directory recursively",
2499 This copies a file or directory from C<src> to C<dest>
2500 recursively using the C<cp -a> command.");
2502 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2503 [InitBasicFS, Always, TestOutput (
2504 [["write"; "/old"; "file content"];
2505 ["mv"; "/old"; "/new"];
2506 ["cat"; "/new"]], "file content");
2507 InitBasicFS, Always, TestOutputFalse (
2508 [["write"; "/old"; "file content"];
2509 ["mv"; "/old"; "/new"];
2510 ["is_file"; "/old"]])],
2513 This moves a file from C<src> to C<dest> where C<dest> is
2514 either a destination filename or destination directory.");
2516 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2517 [InitEmpty, Always, TestRun (
2518 [["drop_caches"; "3"]])],
2519 "drop kernel page cache, dentries and inodes",
2521 This instructs the guest kernel to drop its page cache,
2522 and/or dentries and inode caches. The parameter C<whattodrop>
2523 tells the kernel what precisely to drop, see
2524 L<http://linux-mm.org/Drop_Caches>
2526 Setting C<whattodrop> to 3 should drop everything.
2528 This automatically calls L<sync(2)> before the operation,
2529 so that the maximum guest memory is freed.");
2531 ("dmesg", (RString "kmsgs", [], []), 91, [],
2532 [InitEmpty, Always, TestRun (
2534 "return kernel messages",
2536 This returns the kernel messages (C<dmesg> output) from
2537 the guest kernel. This is sometimes useful for extended
2538 debugging of problems.
2540 Another way to get the same information is to enable
2541 verbose messages with C<guestfs_set_verbose> or by setting
2542 the environment variable C<LIBGUESTFS_DEBUG=1> before
2543 running the program.");
2545 ("ping_daemon", (RErr, [], []), 92, [],
2546 [InitEmpty, Always, TestRun (
2547 [["ping_daemon"]])],
2548 "ping the guest daemon",
2550 This is a test probe into the guestfs daemon running inside
2551 the qemu subprocess. Calling this function checks that the
2552 daemon responds to the ping message, without affecting the daemon
2553 or attached block device(s) in any other way.");
2555 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2556 [InitBasicFS, Always, TestOutputTrue (
2557 [["write"; "/file1"; "contents of a file"];
2558 ["cp"; "/file1"; "/file2"];
2559 ["equal"; "/file1"; "/file2"]]);
2560 InitBasicFS, Always, TestOutputFalse (
2561 [["write"; "/file1"; "contents of a file"];
2562 ["write"; "/file2"; "contents of another file"];
2563 ["equal"; "/file1"; "/file2"]]);
2564 InitBasicFS, Always, TestLastFail (
2565 [["equal"; "/file1"; "/file2"]])],
2566 "test if two files have equal contents",
2568 This compares the two files C<file1> and C<file2> and returns
2569 true if their content is exactly equal, or false otherwise.
2571 The external L<cmp(1)> program is used for the comparison.");
2573 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2574 [InitISOFS, Always, TestOutputList (
2575 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2576 InitISOFS, Always, TestOutputList (
2577 [["strings"; "/empty"]], []);
2578 (* Test for RHBZ#579608, absolute symbolic links. *)
2579 InitISOFS, Always, TestRun (
2580 [["strings"; "/abssymlink"]])],
2581 "print the printable strings in a file",
2583 This runs the L<strings(1)> command on a file and returns
2584 the list of printable strings found.");
2586 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2587 [InitISOFS, Always, TestOutputList (
2588 [["strings_e"; "b"; "/known-5"]], []);
2589 InitBasicFS, Always, TestOutputList (
2590 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2591 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2592 "print the printable strings in a file",
2594 This is like the C<guestfs_strings> command, but allows you to
2595 specify the encoding of strings that are looked for in
2596 the source file C<path>.
2598 Allowed encodings are:
2604 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2605 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2609 Single 8-bit-byte characters.
2613 16-bit big endian strings such as those encoded in
2614 UTF-16BE or UCS-2BE.
2616 =item l (lower case letter L)
2618 16-bit little endian such as UTF-16LE and UCS-2LE.
2619 This is useful for examining binaries in Windows guests.
2623 32-bit big endian such as UCS-4BE.
2627 32-bit little endian such as UCS-4LE.
2631 The returned strings are transcoded to UTF-8.");
2633 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2634 [InitISOFS, Always, TestOutput (
2635 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2636 (* Test for RHBZ#501888c2 regression which caused large hexdump
2637 * commands to segfault.
2639 InitISOFS, Always, TestRun (
2640 [["hexdump"; "/100krandom"]]);
2641 (* Test for RHBZ#579608, absolute symbolic links. *)
2642 InitISOFS, Always, TestRun (
2643 [["hexdump"; "/abssymlink"]])],
2644 "dump a file in hexadecimal",
2646 This runs C<hexdump -C> on the given C<path>. The result is
2647 the human-readable, canonical hex dump of the file.");
2649 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2650 [InitNone, Always, TestOutput (
2651 [["part_disk"; "/dev/sda"; "mbr"];
2652 ["mkfs"; "ext3"; "/dev/sda1"];
2653 ["mount_options"; ""; "/dev/sda1"; "/"];
2654 ["write"; "/new"; "test file"];
2655 ["umount"; "/dev/sda1"];
2656 ["zerofree"; "/dev/sda1"];
2657 ["mount_options"; ""; "/dev/sda1"; "/"];
2658 ["cat"; "/new"]], "test file")],
2659 "zero unused inodes and disk blocks on ext2/3 filesystem",
2661 This runs the I<zerofree> program on C<device>. This program
2662 claims to zero unused inodes and disk blocks on an ext2/3
2663 filesystem, thus making it possible to compress the filesystem
2666 You should B<not> run this program if the filesystem is
2669 It is possible that using this program can damage the filesystem
2670 or data on the filesystem.");
2672 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2674 "resize an LVM physical volume",
2676 This resizes (expands or shrinks) an existing LVM physical
2677 volume to match the new size of the underlying device.");
2679 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2680 Int "cyls"; Int "heads"; Int "sectors";
2681 String "line"], []), 99, [DangerWillRobinson],
2683 "modify a single partition on a block device",
2685 This runs L<sfdisk(8)> option to modify just the single
2686 partition C<n> (note: C<n> counts from 1).
2688 For other parameters, see C<guestfs_sfdisk>. You should usually
2689 pass C<0> for the cyls/heads/sectors parameters.
2691 See also: C<guestfs_part_add>");
2693 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
2695 "display the partition table",
2697 This displays the partition table on C<device>, in the
2698 human-readable output of the L<sfdisk(8)> command. It is
2699 not intended to be parsed.
2701 See also: C<guestfs_part_list>");
2703 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
2705 "display the kernel geometry",
2707 This displays the kernel's idea of the geometry of C<device>.
2709 The result is in human-readable format, and not designed to
2712 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
2714 "display the disk geometry from the partition table",
2716 This displays the disk geometry of C<device> read from the
2717 partition table. Especially in the case where the underlying
2718 block device has been resized, this can be different from the
2719 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2721 The result is in human-readable format, and not designed to
2724 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
2726 "activate or deactivate all volume groups",
2728 This command activates or (if C<activate> is false) deactivates
2729 all logical volumes in all volume groups.
2730 If activated, then they are made known to the
2731 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2732 then those devices disappear.
2734 This command is the same as running C<vgchange -a y|n>");
2736 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
2738 "activate or deactivate some volume groups",
2740 This command activates or (if C<activate> is false) deactivates
2741 all logical volumes in the listed volume groups C<volgroups>.
2742 If activated, then they are made known to the
2743 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2744 then those devices disappear.
2746 This command is the same as running C<vgchange -a y|n volgroups...>
2748 Note that if C<volgroups> is an empty list then B<all> volume groups
2749 are activated or deactivated.");
2751 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
2752 [InitNone, Always, TestOutput (
2753 [["part_disk"; "/dev/sda"; "mbr"];
2754 ["pvcreate"; "/dev/sda1"];
2755 ["vgcreate"; "VG"; "/dev/sda1"];
2756 ["lvcreate"; "LV"; "VG"; "10"];
2757 ["mkfs"; "ext2"; "/dev/VG/LV"];
2758 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2759 ["write"; "/new"; "test content"];
2761 ["lvresize"; "/dev/VG/LV"; "20"];
2762 ["e2fsck_f"; "/dev/VG/LV"];
2763 ["resize2fs"; "/dev/VG/LV"];
2764 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2765 ["cat"; "/new"]], "test content");
2766 InitNone, Always, TestRun (
2767 (* Make an LV smaller to test RHBZ#587484. *)
2768 [["part_disk"; "/dev/sda"; "mbr"];
2769 ["pvcreate"; "/dev/sda1"];
2770 ["vgcreate"; "VG"; "/dev/sda1"];
2771 ["lvcreate"; "LV"; "VG"; "20"];
2772 ["lvresize"; "/dev/VG/LV"; "10"]])],
2773 "resize an LVM logical volume",
2775 This resizes (expands or shrinks) an existing LVM logical
2776 volume to C<mbytes>. When reducing, data in the reduced part
2779 ("resize2fs", (RErr, [Device "device"], []), 106, [],
2780 [], (* lvresize tests this *)
2781 "resize an ext2, ext3 or ext4 filesystem",
2783 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2784 the underlying device.
2786 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2787 on the C<device> before calling this command. For unknown reasons
2788 C<resize2fs> sometimes gives an error about this and sometimes not.
2789 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2790 calling this function.");
2792 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
2793 [InitBasicFS, Always, TestOutputList (
2794 [["find"; "/"]], ["lost+found"]);
2795 InitBasicFS, Always, TestOutputList (
2799 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2800 InitBasicFS, Always, TestOutputList (
2801 [["mkdir_p"; "/a/b/c"];
2802 ["touch"; "/a/b/c/d"];
2803 ["find"; "/a/b/"]], ["c"; "c/d"])],
2804 "find all files and directories",
2806 This command lists out all files and directories, recursively,
2807 starting at C<directory>. It is essentially equivalent to
2808 running the shell command C<find directory -print> but some
2809 post-processing happens on the output, described below.
2811 This returns a list of strings I<without any prefix>. Thus
2812 if the directory structure was:
2818 then the returned list from C<guestfs_find> C</tmp> would be
2826 If C<directory> is not a directory, then this command returns
2829 The returned list is sorted.
2831 See also C<guestfs_find0>.");
2833 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
2834 [], (* lvresize tests this *)
2835 "check an ext2/ext3 filesystem",
2837 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2838 filesystem checker on C<device>, noninteractively (C<-p>),
2839 even if the filesystem appears to be clean (C<-f>).
2841 This command is only needed because of C<guestfs_resize2fs>
2842 (q.v.). Normally you should use C<guestfs_fsck>.");
2844 ("sleep", (RErr, [Int "secs"], []), 109, [],
2845 [InitNone, Always, TestRun (
2847 "sleep for some seconds",
2849 Sleep for C<secs> seconds.");
2851 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
2852 [InitNone, Always, TestOutputInt (
2853 [["part_disk"; "/dev/sda"; "mbr"];
2854 ["mkfs"; "ntfs"; "/dev/sda1"];
2855 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2856 InitNone, Always, TestOutputInt (
2857 [["part_disk"; "/dev/sda"; "mbr"];
2858 ["mkfs"; "ext2"; "/dev/sda1"];
2859 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2860 "probe NTFS volume",
2862 This command runs the L<ntfs-3g.probe(8)> command which probes
2863 an NTFS C<device> for mountability. (Not all NTFS volumes can
2864 be mounted read-write, and some cannot be mounted at all).
2866 C<rw> is a boolean flag. Set it to true if you want to test
2867 if the volume can be mounted read-write. Set it to false if
2868 you want to test if the volume can be mounted read-only.
2870 The return value is an integer which C<0> if the operation
2871 would succeed, or some non-zero value documented in the
2872 L<ntfs-3g.probe(8)> manual page.");
2874 ("sh", (RString "output", [String "command"], []), 111, [],
2875 [], (* XXX needs tests *)
2876 "run a command via the shell",
2878 This call runs a command from the guest filesystem via the
2881 This is like C<guestfs_command>, but passes the command to:
2883 /bin/sh -c \"command\"
2885 Depending on the guest's shell, this usually results in
2886 wildcards being expanded, shell expressions being interpolated
2889 All the provisos about C<guestfs_command> apply to this call.");
2891 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
2892 [], (* XXX needs tests *)
2893 "run a command via the shell returning lines",
2895 This is the same as C<guestfs_sh>, but splits the result
2896 into a list of lines.
2898 See also: C<guestfs_command_lines>");
2900 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
2901 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2902 * code in stubs.c, since all valid glob patterns must start with "/".
2903 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2905 [InitBasicFS, Always, TestOutputList (
2906 [["mkdir_p"; "/a/b/c"];
2907 ["touch"; "/a/b/c/d"];
2908 ["touch"; "/a/b/c/e"];
2909 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2910 InitBasicFS, Always, TestOutputList (
2911 [["mkdir_p"; "/a/b/c"];
2912 ["touch"; "/a/b/c/d"];
2913 ["touch"; "/a/b/c/e"];
2914 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2915 InitBasicFS, Always, TestOutputList (
2916 [["mkdir_p"; "/a/b/c"];
2917 ["touch"; "/a/b/c/d"];
2918 ["touch"; "/a/b/c/e"];
2919 ["glob_expand"; "/a/*/x/*"]], [])],
2920 "expand a wildcard path",
2922 This command searches for all the pathnames matching
2923 C<pattern> according to the wildcard expansion rules
2926 If no paths match, then this returns an empty list
2927 (note: not an error).
2929 It is just a wrapper around the C L<glob(3)> function
2930 with flags C<GLOB_MARK|GLOB_BRACE>.
2931 See that manual page for more details.");
2933 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
2934 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2935 [["scrub_device"; "/dev/sdc"]])],
2936 "scrub (securely wipe) a device",
2938 This command writes patterns over C<device> to make data retrieval
2941 It is an interface to the L<scrub(1)> program. See that
2942 manual page for more details.");
2944 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
2945 [InitBasicFS, Always, TestRun (
2946 [["write"; "/file"; "content"];
2947 ["scrub_file"; "/file"]])],
2948 "scrub (securely wipe) a file",
2950 This command writes patterns over a file to make data retrieval
2953 The file is I<removed> after scrubbing.
2955 It is an interface to the L<scrub(1)> program. See that
2956 manual page for more details.");
2958 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
2959 [], (* XXX needs testing *)
2960 "scrub (securely wipe) free space",
2962 This command creates the directory C<dir> and then fills it
2963 with files until the filesystem is full, and scrubs the files
2964 as for C<guestfs_scrub_file>, and deletes them.
2965 The intention is to scrub any free space on the partition
2968 It is an interface to the L<scrub(1)> program. See that
2969 manual page for more details.");
2971 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
2972 [InitBasicFS, Always, TestRun (
2974 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2975 "create a temporary directory",
2977 This command creates a temporary directory. The
2978 C<template> parameter should be a full pathname for the
2979 temporary directory name with the final six characters being
2982 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2983 the second one being suitable for Windows filesystems.
2985 The name of the temporary directory that was created
2988 The temporary directory is created with mode 0700
2989 and is owned by root.
2991 The caller is responsible for deleting the temporary
2992 directory and its contents after use.
2994 See also: L<mkdtemp(3)>");
2996 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
2997 [InitISOFS, Always, TestOutputInt (
2998 [["wc_l"; "/10klines"]], 10000);
2999 (* Test for RHBZ#579608, absolute symbolic links. *)
3000 InitISOFS, Always, TestOutputInt (
3001 [["wc_l"; "/abssymlink"]], 10000)],
3002 "count lines in a file",
3004 This command counts the lines in a file, using the
3005 C<wc -l> external command.");
3007 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3008 [InitISOFS, Always, TestOutputInt (
3009 [["wc_w"; "/10klines"]], 10000)],
3010 "count words in a file",
3012 This command counts the words in a file, using the
3013 C<wc -w> external command.");
3015 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3016 [InitISOFS, Always, TestOutputInt (
3017 [["wc_c"; "/100kallspaces"]], 102400)],
3018 "count characters in a file",
3020 This command counts the characters in a file, using the
3021 C<wc -c> external command.");
3023 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3024 [InitISOFS, Always, TestOutputList (
3025 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3026 (* Test for RHBZ#579608, absolute symbolic links. *)
3027 InitISOFS, Always, TestOutputList (
3028 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3029 "return first 10 lines of a file",
3031 This command returns up to the first 10 lines of a file as
3032 a list of strings.");
3034 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3035 [InitISOFS, Always, TestOutputList (
3036 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3037 InitISOFS, Always, TestOutputList (
3038 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3039 InitISOFS, Always, TestOutputList (
3040 [["head_n"; "0"; "/10klines"]], [])],
3041 "return first N lines of a file",
3043 If the parameter C<nrlines> is a positive number, this returns the first
3044 C<nrlines> lines of the file C<path>.
3046 If the parameter C<nrlines> is a negative number, this returns lines
3047 from the file C<path>, excluding the last C<nrlines> lines.
3049 If the parameter C<nrlines> is zero, this returns an empty list.");
3051 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3052 [InitISOFS, Always, TestOutputList (
3053 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3054 "return last 10 lines of a file",
3056 This command returns up to the last 10 lines of a file as
3057 a list of strings.");
3059 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3060 [InitISOFS, Always, TestOutputList (
3061 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3062 InitISOFS, Always, TestOutputList (
3063 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3064 InitISOFS, Always, TestOutputList (
3065 [["tail_n"; "0"; "/10klines"]], [])],
3066 "return last N lines of a file",
3068 If the parameter C<nrlines> is a positive number, this returns the last
3069 C<nrlines> lines of the file C<path>.
3071 If the parameter C<nrlines> is a negative number, this returns lines
3072 from the file C<path>, starting with the C<-nrlines>th line.
3074 If the parameter C<nrlines> is zero, this returns an empty list.");
3076 ("df", (RString "output", [], []), 125, [],
3077 [], (* XXX Tricky to test because it depends on the exact format
3078 * of the 'df' command and other imponderables.
3080 "report file system disk space usage",
3082 This command runs the C<df> command to report disk space used.
3084 This command is mostly useful for interactive sessions. It
3085 is I<not> intended that you try to parse the output string.
3086 Use C<statvfs> from programs.");
3088 ("df_h", (RString "output", [], []), 126, [],
3089 [], (* XXX Tricky to test because it depends on the exact format
3090 * of the 'df' command and other imponderables.
3092 "report file system disk space usage (human readable)",
3094 This command runs the C<df -h> command to report disk space used
3095 in human-readable format.
3097 This command is mostly useful for interactive sessions. It
3098 is I<not> intended that you try to parse the output string.
3099 Use C<statvfs> from programs.");
3101 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3102 [InitISOFS, Always, TestOutputInt (
3103 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3104 "estimate file space usage",
3106 This command runs the C<du -s> command to estimate file space
3109 C<path> can be a file or a directory. If C<path> is a directory
3110 then the estimate includes the contents of the directory and all
3111 subdirectories (recursively).
3113 The result is the estimated size in I<kilobytes>
3114 (ie. units of 1024 bytes).");
3116 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3117 [InitISOFS, Always, TestOutputList (
3118 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3119 "list files in an initrd",
3121 This command lists out files contained in an initrd.
3123 The files are listed without any initial C</> character. The
3124 files are listed in the order they appear (not necessarily
3125 alphabetical). Directory names are listed as separate items.
3127 Old Linux kernels (2.4 and earlier) used a compressed ext2
3128 filesystem as initrd. We I<only> support the newer initramfs
3129 format (compressed cpio files).");
3131 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3133 "mount a file using the loop device",
3135 This command lets you mount C<file> (a filesystem image
3136 in a file) on a mount point. It is entirely equivalent to
3137 the command C<mount -o loop file mountpoint>.");
3139 ("mkswap", (RErr, [Device "device"], []), 130, [],
3140 [InitEmpty, Always, TestRun (
3141 [["part_disk"; "/dev/sda"; "mbr"];
3142 ["mkswap"; "/dev/sda1"]])],
3143 "create a swap partition",
3145 Create a swap partition on C<device>.");
3147 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3148 [InitEmpty, Always, TestRun (
3149 [["part_disk"; "/dev/sda"; "mbr"];
3150 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3151 "create a swap partition with a label",
3153 Create a swap partition on C<device> with label C<label>.
3155 Note that you cannot attach a swap label to a block device
3156 (eg. C</dev/sda>), just to a partition. This appears to be
3157 a limitation of the kernel or swap tools.");
3159 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3160 (let uuid = uuidgen () in
3161 [InitEmpty, Always, TestRun (
3162 [["part_disk"; "/dev/sda"; "mbr"];
3163 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3164 "create a swap partition with an explicit UUID",
3166 Create a swap partition on C<device> with UUID C<uuid>.");
3168 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3169 [InitBasicFS, Always, TestOutputStruct (
3170 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3171 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3172 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3173 InitBasicFS, Always, TestOutputStruct (
3174 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3175 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3176 "make block, character or FIFO devices",
3178 This call creates block or character special devices, or
3179 named pipes (FIFOs).
3181 The C<mode> parameter should be the mode, using the standard
3182 constants. C<devmajor> and C<devminor> are the
3183 device major and minor numbers, only used when creating block
3184 and character special devices.
3186 Note that, just like L<mknod(2)>, the mode must be bitwise
3187 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3188 just creates a regular file). These constants are
3189 available in the standard Linux header files, or you can use
3190 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3191 which are wrappers around this command which bitwise OR
3192 in the appropriate constant for you.
3194 The mode actually set is affected by the umask.");
3196 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3197 [InitBasicFS, Always, TestOutputStruct (
3198 [["mkfifo"; "0o777"; "/node"];
3199 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3200 "make FIFO (named pipe)",
3202 This call creates a FIFO (named pipe) called C<path> with
3203 mode C<mode>. It is just a convenient wrapper around
3206 The mode actually set is affected by the umask.");
3208 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3209 [InitBasicFS, Always, TestOutputStruct (
3210 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3211 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3212 "make block device node",
3214 This call creates a block device node called C<path> with
3215 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3216 It is just a convenient wrapper around C<guestfs_mknod>.
3218 The mode actually set is affected by the umask.");
3220 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3221 [InitBasicFS, Always, TestOutputStruct (
3222 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3223 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3224 "make char device node",
3226 This call creates a char device node called C<path> with
3227 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3228 It is just a convenient wrapper around C<guestfs_mknod>.
3230 The mode actually set is affected by the umask.");
3232 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3233 [InitEmpty, Always, TestOutputInt (
3234 [["umask"; "0o22"]], 0o22)],
3235 "set file mode creation mask (umask)",
3237 This function sets the mask used for creating new files and
3238 device nodes to C<mask & 0777>.
3240 Typical umask values would be C<022> which creates new files
3241 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3242 C<002> which creates new files with permissions like
3243 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3245 The default umask is C<022>. This is important because it
3246 means that directories and device nodes will be created with
3247 C<0644> or C<0755> mode even if you specify C<0777>.
3249 See also C<guestfs_get_umask>,
3250 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3252 This call returns the previous umask.");
3254 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3256 "read directories entries",
3258 This returns the list of directory entries in directory C<dir>.
3260 All entries in the directory are returned, including C<.> and
3261 C<..>. The entries are I<not> sorted, but returned in the same
3262 order as the underlying filesystem.
3264 Also this call returns basic file type information about each
3265 file. The C<ftyp> field will contain one of the following characters:
3303 The L<readdir(3)> call returned a C<d_type> field with an
3308 This function is primarily intended for use by programs. To
3309 get a simple list of names, use C<guestfs_ls>. To get a printable
3310 directory for human consumption, use C<guestfs_ll>.");
3312 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3314 "create partitions on a block device",
3316 This is a simplified interface to the C<guestfs_sfdisk>
3317 command, where partition sizes are specified in megabytes
3318 only (rounded to the nearest cylinder) and you don't need
3319 to specify the cyls, heads and sectors parameters which
3320 were rarely if ever used anyway.
3322 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3323 and C<guestfs_part_disk>");
3325 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3327 "determine file type inside a compressed file",
3329 This command runs C<file> after first decompressing C<path>
3332 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3334 Since 1.0.63, use C<guestfs_file> instead which can now
3335 process compressed files.");
3337 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3339 "list extended attributes of a file or directory",
3341 This call lists the extended attributes of the file or directory
3344 At the system call level, this is a combination of the
3345 L<listxattr(2)> and L<getxattr(2)> calls.
3347 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3349 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3351 "list extended attributes of a file or directory",
3353 This is the same as C<guestfs_getxattrs>, but if C<path>
3354 is a symbolic link, then it returns the extended attributes
3355 of the link itself.");
3357 ("setxattr", (RErr, [String "xattr";
3358 String "val"; Int "vallen"; (* will be BufferIn *)
3359 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3361 "set extended attribute of a file or directory",
3363 This call sets the extended attribute named C<xattr>
3364 of the file C<path> to the value C<val> (of length C<vallen>).
3365 The value is arbitrary 8 bit data.
3367 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3369 ("lsetxattr", (RErr, [String "xattr";
3370 String "val"; Int "vallen"; (* will be BufferIn *)
3371 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3373 "set extended attribute of a file or directory",
3375 This is the same as C<guestfs_setxattr>, but if C<path>
3376 is a symbolic link, then it sets an extended attribute
3377 of the link itself.");
3379 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3381 "remove extended attribute of a file or directory",
3383 This call removes the extended attribute named C<xattr>
3384 of the file C<path>.
3386 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3388 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3390 "remove extended attribute of a file or directory",
3392 This is the same as C<guestfs_removexattr>, but if C<path>
3393 is a symbolic link, then it removes an extended attribute
3394 of the link itself.");
3396 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3400 This call is similar to C<guestfs_mounts>. That call returns
3401 a list of devices. This one returns a hash table (map) of
3402 device name to directory where the device is mounted.");
3404 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3405 (* This is a special case: while you would expect a parameter
3406 * of type "Pathname", that doesn't work, because it implies
3407 * NEED_ROOT in the generated calling code in stubs.c, and
3408 * this function cannot use NEED_ROOT.
3411 "create a mountpoint",
3413 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3414 specialized calls that can be used to create extra mountpoints
3415 before mounting the first filesystem.
3417 These calls are I<only> necessary in some very limited circumstances,
3418 mainly the case where you want to mount a mix of unrelated and/or
3419 read-only filesystems together.
3421 For example, live CDs often contain a \"Russian doll\" nest of
3422 filesystems, an ISO outer layer, with a squashfs image inside, with
3423 an ext2/3 image inside that. You can unpack this as follows
3426 add-ro Fedora-11-i686-Live.iso
3430 mkmountpoint /ext3fs
3432 mount-loop /cd/LiveOS/squashfs.img /sqsh
3433 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3435 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3437 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3438 You may get unexpected errors if you try to mix these calls. It is
3439 safest to manually unmount filesystems and remove mountpoints after use.
3441 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3442 longest first, so for this to work for manual mountpoints, you
3443 must ensure that the innermost mountpoints have the longest
3444 pathnames, as in the example code above.
3446 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3448 Autosync [see C<guestfs_set_autosync>, this is set by default on
3449 handles] means that C<guestfs_umount_all> is called when the handle
3450 is closed which can also trigger these issues.");
3452 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3454 "remove a mountpoint",
3456 This calls removes a mountpoint that was previously created
3457 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3458 for full details.");
3460 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3461 [InitISOFS, Always, TestOutputBuffer (
3462 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3463 (* Test various near large, large and too large files (RHBZ#589039). *)
3464 InitBasicFS, Always, TestLastFail (
3466 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3467 ["read_file"; "/a"]]);
3468 InitBasicFS, Always, TestLastFail (
3470 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3471 ["read_file"; "/a"]]);
3472 InitBasicFS, Always, TestLastFail (
3474 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3475 ["read_file"; "/a"]])],
3478 This calls returns the contents of the file C<path> as a
3481 Unlike C<guestfs_cat>, this function can correctly
3482 handle files that contain embedded ASCII NUL characters.
3483 However unlike C<guestfs_download>, this function is limited
3484 in the total size of file that can be handled.");
3486 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3487 [InitISOFS, Always, TestOutputList (
3488 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3489 InitISOFS, Always, TestOutputList (
3490 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3491 (* Test for RHBZ#579608, absolute symbolic links. *)
3492 InitISOFS, Always, TestOutputList (
3493 [["grep"; "nomatch"; "/abssymlink"]], [])],
3494 "return lines matching a pattern",
3496 This calls the external C<grep> program and returns the
3499 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3500 [InitISOFS, Always, TestOutputList (
3501 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3502 "return lines matching a pattern",
3504 This calls the external C<egrep> program and returns the
3507 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3508 [InitISOFS, Always, TestOutputList (
3509 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3510 "return lines matching a pattern",
3512 This calls the external C<fgrep> program and returns the
3515 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3516 [InitISOFS, Always, TestOutputList (
3517 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3518 "return lines matching a pattern",
3520 This calls the external C<grep -i> program and returns the
3523 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3524 [InitISOFS, Always, TestOutputList (
3525 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3526 "return lines matching a pattern",
3528 This calls the external C<egrep -i> program and returns the
3531 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3532 [InitISOFS, Always, TestOutputList (
3533 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3534 "return lines matching a pattern",
3536 This calls the external C<fgrep -i> program and returns the
3539 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3540 [InitISOFS, Always, TestOutputList (
3541 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3542 "return lines matching a pattern",
3544 This calls the external C<zgrep> program and returns the
3547 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3548 [InitISOFS, Always, TestOutputList (
3549 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3550 "return lines matching a pattern",
3552 This calls the external C<zegrep> program and returns the
3555 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3556 [InitISOFS, Always, TestOutputList (
3557 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3558 "return lines matching a pattern",
3560 This calls the external C<zfgrep> program and returns the
3563 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3564 [InitISOFS, Always, TestOutputList (
3565 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3566 "return lines matching a pattern",
3568 This calls the external C<zgrep -i> program and returns the
3571 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3572 [InitISOFS, Always, TestOutputList (
3573 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3574 "return lines matching a pattern",
3576 This calls the external C<zegrep -i> program and returns the
3579 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3580 [InitISOFS, Always, TestOutputList (
3581 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3582 "return lines matching a pattern",
3584 This calls the external C<zfgrep -i> program and returns the
3587 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3588 [InitISOFS, Always, TestOutput (
3589 [["realpath"; "/../directory"]], "/directory")],
3590 "canonicalized absolute pathname",
3592 Return the canonicalized absolute pathname of C<path>. The
3593 returned path has no C<.>, C<..> or symbolic link path elements.");
3595 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3596 [InitBasicFS, Always, TestOutputStruct (
3599 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3600 "create a hard link",
3602 This command creates a hard link using the C<ln> command.");
3604 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3605 [InitBasicFS, Always, TestOutputStruct (
3608 ["ln_f"; "/a"; "/b"];
3609 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3610 "create a hard link",
3612 This command creates a hard link using the C<ln -f> command.
3613 The C<-f> option removes the link (C<linkname>) if it exists already.");
3615 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3616 [InitBasicFS, Always, TestOutputStruct (
3618 ["ln_s"; "a"; "/b"];
3619 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3620 "create a symbolic link",
3622 This command creates a symbolic link using the C<ln -s> command.");
3624 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3625 [InitBasicFS, Always, TestOutput (
3626 [["mkdir_p"; "/a/b"];
3627 ["touch"; "/a/b/c"];
3628 ["ln_sf"; "../d"; "/a/b/c"];
3629 ["readlink"; "/a/b/c"]], "../d")],
3630 "create a symbolic link",
3632 This command creates a symbolic link using the C<ln -sf> command,
3633 The C<-f> option removes the link (C<linkname>) if it exists already.");
3635 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3636 [] (* XXX tested above *),
3637 "read the target of a symbolic link",
3639 This command reads the target of a symbolic link.");
3641 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3642 [InitBasicFS, Always, TestOutputStruct (
3643 [["fallocate"; "/a"; "1000000"];
3644 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3645 "preallocate a file in the guest filesystem",
3647 This command preallocates a file (containing zero bytes) named
3648 C<path> of size C<len> bytes. If the file exists already, it
3651 Do not confuse this with the guestfish-specific
3652 C<alloc> command which allocates a file in the host and
3653 attaches it as a device.");
3655 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3656 [InitPartition, Always, TestRun (
3657 [["mkswap"; "/dev/sda1"];
3658 ["swapon_device"; "/dev/sda1"];
3659 ["swapoff_device"; "/dev/sda1"]])],
3660 "enable swap on device",
3662 This command enables the libguestfs appliance to use the
3663 swap device or partition named C<device>. The increased
3664 memory is made available for all commands, for example
3665 those run using C<guestfs_command> or C<guestfs_sh>.
3667 Note that you should not swap to existing guest swap
3668 partitions unless you know what you are doing. They may
3669 contain hibernation information, or other information that
3670 the guest doesn't want you to trash. You also risk leaking
3671 information about the host to the guest this way. Instead,
3672 attach a new host device to the guest and swap on that.");
3674 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3675 [], (* XXX tested by swapon_device *)
3676 "disable swap on device",
3678 This command disables the libguestfs appliance swap
3679 device or partition named C<device>.
3680 See C<guestfs_swapon_device>.");
3682 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
3683 [InitBasicFS, Always, TestRun (
3684 [["fallocate"; "/swap"; "8388608"];
3685 ["mkswap_file"; "/swap"];
3686 ["swapon_file"; "/swap"];
3687 ["swapoff_file"; "/swap"]])],
3688 "enable swap on file",
3690 This command enables swap to a file.
3691 See C<guestfs_swapon_device> for other notes.");
3693 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
3694 [], (* XXX tested by swapon_file *)
3695 "disable swap on file",
3697 This command disables the libguestfs appliance swap on file.");
3699 ("swapon_label", (RErr, [String "label"], []), 174, [],
3700 [InitEmpty, Always, TestRun (
3701 [["part_disk"; "/dev/sdb"; "mbr"];
3702 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3703 ["swapon_label"; "swapit"];
3704 ["swapoff_label"; "swapit"];
3705 ["zero"; "/dev/sdb"];
3706 ["blockdev_rereadpt"; "/dev/sdb"]])],
3707 "enable swap on labeled swap partition",
3709 This command enables swap to a labeled swap partition.
3710 See C<guestfs_swapon_device> for other notes.");
3712 ("swapoff_label", (RErr, [String "label"], []), 175, [],
3713 [], (* XXX tested by swapon_label *)
3714 "disable swap on labeled swap partition",
3716 This command disables the libguestfs appliance swap on
3717 labeled swap partition.");
3719 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
3720 (let uuid = uuidgen () in
3721 [InitEmpty, Always, TestRun (
3722 [["mkswap_U"; uuid; "/dev/sdb"];
3723 ["swapon_uuid"; uuid];
3724 ["swapoff_uuid"; uuid]])]),
3725 "enable swap on swap partition by UUID",
3727 This command enables swap to a swap partition with the given UUID.
3728 See C<guestfs_swapon_device> for other notes.");
3730 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
3731 [], (* XXX tested by swapon_uuid *)
3732 "disable swap on swap partition by UUID",
3734 This command disables the libguestfs appliance swap partition
3735 with the given UUID.");
3737 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
3738 [InitBasicFS, Always, TestRun (
3739 [["fallocate"; "/swap"; "8388608"];
3740 ["mkswap_file"; "/swap"]])],
3741 "create a swap file",
3745 This command just writes a swap file signature to an existing
3746 file. To create the file itself, use something like C<guestfs_fallocate>.");
3748 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
3749 [InitISOFS, Always, TestRun (
3750 [["inotify_init"; "0"]])],
3751 "create an inotify handle",
3753 This command creates a new inotify handle.
3754 The inotify subsystem can be used to notify events which happen to
3755 objects in the guest filesystem.
3757 C<maxevents> is the maximum number of events which will be
3758 queued up between calls to C<guestfs_inotify_read> or
3759 C<guestfs_inotify_files>.
3760 If this is passed as C<0>, then the kernel (or previously set)
3761 default is used. For Linux 2.6.29 the default was 16384 events.
3762 Beyond this limit, the kernel throws away events, but records
3763 the fact that it threw them away by setting a flag
3764 C<IN_Q_OVERFLOW> in the returned structure list (see
3765 C<guestfs_inotify_read>).
3767 Before any events are generated, you have to add some
3768 watches to the internal watch list. See:
3769 C<guestfs_inotify_add_watch>,
3770 C<guestfs_inotify_rm_watch> and
3771 C<guestfs_inotify_watch_all>.
3773 Queued up events should be read periodically by calling
3774 C<guestfs_inotify_read>
3775 (or C<guestfs_inotify_files> which is just a helpful
3776 wrapper around C<guestfs_inotify_read>). If you don't
3777 read the events out often enough then you risk the internal
3780 The handle should be closed after use by calling
3781 C<guestfs_inotify_close>. This also removes any
3782 watches automatically.
3784 See also L<inotify(7)> for an overview of the inotify interface
3785 as exposed by the Linux kernel, which is roughly what we expose
3786 via libguestfs. Note that there is one global inotify handle
3787 per libguestfs instance.");
3789 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
3790 [InitBasicFS, Always, TestOutputList (
3791 [["inotify_init"; "0"];
3792 ["inotify_add_watch"; "/"; "1073741823"];
3795 ["inotify_files"]], ["a"; "b"])],
3796 "add an inotify watch",
3798 Watch C<path> for the events listed in C<mask>.
3800 Note that if C<path> is a directory then events within that
3801 directory are watched, but this does I<not> happen recursively
3802 (in subdirectories).
3804 Note for non-C or non-Linux callers: the inotify events are
3805 defined by the Linux kernel ABI and are listed in
3806 C</usr/include/sys/inotify.h>.");
3808 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
3810 "remove an inotify watch",
3812 Remove a previously defined inotify watch.
3813 See C<guestfs_inotify_add_watch>.");
3815 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
3817 "return list of inotify events",
3819 Return the complete queue of events that have happened
3820 since the previous read call.
3822 If no events have happened, this returns an empty list.
3824 I<Note>: In order to make sure that all events have been
3825 read, you must call this function repeatedly until it
3826 returns an empty list. The reason is that the call will
3827 read events up to the maximum appliance-to-host message
3828 size and leave remaining events in the queue.");
3830 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
3832 "return list of watched files that had events",
3834 This function is a helpful wrapper around C<guestfs_inotify_read>
3835 which just returns a list of pathnames of objects that were
3836 touched. The returned pathnames are sorted and deduplicated.");
3838 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
3840 "close the inotify handle",
3842 This closes the inotify handle which was previously
3843 opened by inotify_init. It removes all watches, throws
3844 away any pending events, and deallocates all resources.");
3846 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
3848 "set SELinux security context",
3850 This sets the SELinux security context of the daemon
3851 to the string C<context>.
3853 See the documentation about SELINUX in L<guestfs(3)>.");
3855 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
3857 "get SELinux security context",
3859 This gets the SELinux security context of the daemon.
3861 See the documentation about SELINUX in L<guestfs(3)>,
3862 and C<guestfs_setcon>");
3864 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [],
3865 [InitEmpty, Always, TestOutput (
3866 [["part_disk"; "/dev/sda"; "mbr"];
3867 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3868 ["mount_options"; ""; "/dev/sda1"; "/"];
3869 ["write"; "/new"; "new file contents"];
3870 ["cat"; "/new"]], "new file contents");
3871 InitEmpty, Always, TestRun (
3872 [["part_disk"; "/dev/sda"; "mbr"];
3873 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3874 InitEmpty, Always, TestLastFail (
3875 [["part_disk"; "/dev/sda"; "mbr"];
3876 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3877 InitEmpty, Always, TestLastFail (
3878 [["part_disk"; "/dev/sda"; "mbr"];
3879 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3880 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3881 [["part_disk"; "/dev/sda"; "mbr"];
3882 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3883 "make a filesystem with block size",
3885 This call is similar to C<guestfs_mkfs>, but it allows you to
3886 control the block size of the resulting filesystem. Supported
3887 block sizes depend on the filesystem type, but typically they
3888 are C<1024>, C<2048> or C<4096> only.
3890 For VFAT and NTFS the C<blocksize> parameter is treated as
3891 the requested cluster size.");
3893 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
3894 [InitEmpty, Always, TestOutput (
3895 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3896 ["mke2journal"; "4096"; "/dev/sda1"];
3897 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3898 ["mount_options"; ""; "/dev/sda2"; "/"];
3899 ["write"; "/new"; "new file contents"];
3900 ["cat"; "/new"]], "new file contents")],
3901 "make ext2/3/4 external journal",
3903 This creates an ext2 external journal on C<device>. It is equivalent
3906 mke2fs -O journal_dev -b blocksize device");
3908 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
3909 [InitEmpty, Always, TestOutput (
3910 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3911 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3912 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3913 ["mount_options"; ""; "/dev/sda2"; "/"];
3914 ["write"; "/new"; "new file contents"];
3915 ["cat"; "/new"]], "new file contents")],
3916 "make ext2/3/4 external journal with label",
3918 This creates an ext2 external journal on C<device> with label C<label>.");
3920 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
3921 (let uuid = uuidgen () in
3922 [InitEmpty, Always, TestOutput (
3923 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3924 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3925 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3926 ["mount_options"; ""; "/dev/sda2"; "/"];
3927 ["write"; "/new"; "new file contents"];
3928 ["cat"; "/new"]], "new file contents")]),
3929 "make ext2/3/4 external journal with UUID",
3931 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3933 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
3935 "make ext2/3/4 filesystem with external journal",
3937 This creates an ext2/3/4 filesystem on C<device> with
3938 an external journal on C<journal>. It is equivalent
3941 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3943 See also C<guestfs_mke2journal>.");
3945 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
3947 "make ext2/3/4 filesystem with external journal",
3949 This creates an ext2/3/4 filesystem on C<device> with
3950 an external journal on the journal labeled C<label>.
3952 See also C<guestfs_mke2journal_L>.");
3954 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
3956 "make ext2/3/4 filesystem with external journal",
3958 This creates an ext2/3/4 filesystem on C<device> with
3959 an external journal on the journal with UUID C<uuid>.
3961 See also C<guestfs_mke2journal_U>.");
3963 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
3964 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3965 "load a kernel module",
3967 This loads a kernel module in the appliance.
3969 The kernel module must have been whitelisted when libguestfs
3970 was built (see C<appliance/kmod.whitelist.in> in the source).");
3972 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
3973 [InitNone, Always, TestOutput (
3974 [["echo_daemon"; "This is a test"]], "This is a test"
3976 "echo arguments back to the client",
3978 This command concatenates the list of C<words> passed with single spaces
3979 between them and returns the resulting string.
3981 You can use this command to test the connection through to the daemon.
3983 See also C<guestfs_ping_daemon>.");
3985 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
3986 [], (* There is a regression test for this. *)
3987 "find all files and directories, returning NUL-separated list",
3989 This command lists out all files and directories, recursively,
3990 starting at C<directory>, placing the resulting list in the
3991 external file called C<files>.
3993 This command works the same way as C<guestfs_find> with the
3994 following exceptions:
4000 The resulting list is written to an external file.
4004 Items (filenames) in the result are separated
4005 by C<\\0> characters. See L<find(1)> option I<-print0>.
4009 This command is not limited in the number of names that it
4014 The result list is not sorted.
4018 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4019 [InitISOFS, Always, TestOutput (
4020 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4021 InitISOFS, Always, TestOutput (
4022 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4023 InitISOFS, Always, TestOutput (
4024 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4025 InitISOFS, Always, TestLastFail (
4026 [["case_sensitive_path"; "/Known-1/"]]);
4027 InitBasicFS, Always, TestOutput (
4029 ["mkdir"; "/a/bbb"];
4030 ["touch"; "/a/bbb/c"];
4031 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4032 InitBasicFS, Always, TestOutput (
4034 ["mkdir"; "/a/bbb"];
4035 ["touch"; "/a/bbb/c"];
4036 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4037 InitBasicFS, Always, TestLastFail (
4039 ["mkdir"; "/a/bbb"];
4040 ["touch"; "/a/bbb/c"];
4041 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4042 "return true path on case-insensitive filesystem",
4044 This can be used to resolve case insensitive paths on
4045 a filesystem which is case sensitive. The use case is
4046 to resolve paths which you have read from Windows configuration
4047 files or the Windows Registry, to the true path.
4049 The command handles a peculiarity of the Linux ntfs-3g
4050 filesystem driver (and probably others), which is that although
4051 the underlying filesystem is case-insensitive, the driver
4052 exports the filesystem to Linux as case-sensitive.
4054 One consequence of this is that special directories such
4055 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4056 (or other things) depending on the precise details of how
4057 they were created. In Windows itself this would not be
4060 Bug or feature? You decide:
4061 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4063 This function resolves the true case of each element in the
4064 path and returns the case-sensitive path.
4066 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4067 might return C<\"/WINDOWS/system32\"> (the exact return value
4068 would depend on details of how the directories were originally
4069 created under Windows).
4072 This function does not handle drive names, backslashes etc.
4074 See also C<guestfs_realpath>.");
4076 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4077 [InitBasicFS, Always, TestOutput (
4078 [["vfs_type"; "/dev/sda1"]], "ext2")],
4079 "get the Linux VFS type corresponding to a mounted device",
4081 This command gets the filesystem type corresponding to
4082 the filesystem on C<device>.
4084 For most filesystems, the result is the name of the Linux
4085 VFS module which would be used to mount this filesystem
4086 if you mounted it without specifying the filesystem type.
4087 For example a string such as C<ext3> or C<ntfs>.");
4089 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4090 [InitBasicFS, Always, TestOutputStruct (
4091 [["write"; "/test"; "some stuff so size is not zero"];
4092 ["truncate"; "/test"];
4093 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4094 "truncate a file to zero size",
4096 This command truncates C<path> to a zero-length file. The
4097 file must exist already.");
4099 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4100 [InitBasicFS, Always, TestOutputStruct (
4101 [["touch"; "/test"];
4102 ["truncate_size"; "/test"; "1000"];
4103 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4104 "truncate a file to a particular size",
4106 This command truncates C<path> to size C<size> bytes. The file
4109 If the current file size is less than C<size> then
4110 the file is extended to the required size with zero bytes.
4111 This creates a sparse file (ie. disk blocks are not allocated
4112 for the file until you write to it). To create a non-sparse
4113 file of zeroes, use C<guestfs_fallocate64> instead.");
4115 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4116 [InitBasicFS, Always, TestOutputStruct (
4117 [["touch"; "/test"];
4118 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4119 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4120 "set timestamp of a file with nanosecond precision",
4122 This command sets the timestamps of a file with nanosecond
4125 C<atsecs, atnsecs> are the last access time (atime) in secs and
4126 nanoseconds from the epoch.
4128 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4129 secs and nanoseconds from the epoch.
4131 If the C<*nsecs> field contains the special value C<-1> then
4132 the corresponding timestamp is set to the current time. (The
4133 C<*secs> field is ignored in this case).
4135 If the C<*nsecs> field contains the special value C<-2> then
4136 the corresponding timestamp is left unchanged. (The
4137 C<*secs> field is ignored in this case).");
4139 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4140 [InitBasicFS, Always, TestOutputStruct (
4141 [["mkdir_mode"; "/test"; "0o111"];
4142 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4143 "create a directory with a particular mode",
4145 This command creates a directory, setting the initial permissions
4146 of the directory to C<mode>.
4148 For common Linux filesystems, the actual mode which is set will
4149 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4150 interpret the mode in other ways.
4152 See also C<guestfs_mkdir>, C<guestfs_umask>");
4154 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4156 "change file owner and group",
4158 Change the file owner to C<owner> and group to C<group>.
4159 This is like C<guestfs_chown> but if C<path> is a symlink then
4160 the link itself is changed, not the target.
4162 Only numeric uid and gid are supported. If you want to use
4163 names, you will need to locate and parse the password file
4164 yourself (Augeas support makes this relatively easy).");
4166 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4168 "lstat on multiple files",
4170 This call allows you to perform the C<guestfs_lstat> operation
4171 on multiple files, where all files are in the directory C<path>.
4172 C<names> is the list of files from this directory.
4174 On return you get a list of stat structs, with a one-to-one
4175 correspondence to the C<names> list. If any name did not exist
4176 or could not be lstat'd, then the C<ino> field of that structure
4179 This call is intended for programs that want to efficiently
4180 list a directory contents without making many round-trips.
4181 See also C<guestfs_lxattrlist> for a similarly efficient call
4182 for getting extended attributes. Very long directory listings
4183 might cause the protocol message size to be exceeded, causing
4184 this call to fail. The caller must split up such requests
4185 into smaller groups of names.");
4187 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4189 "lgetxattr on multiple files",
4191 This call allows you to get the extended attributes
4192 of multiple files, where all files are in the directory C<path>.
4193 C<names> is the list of files from this directory.
4195 On return you get a flat list of xattr structs which must be
4196 interpreted sequentially. The first xattr struct always has a zero-length
4197 C<attrname>. C<attrval> in this struct is zero-length
4198 to indicate there was an error doing C<lgetxattr> for this
4199 file, I<or> is a C string which is a decimal number
4200 (the number of following attributes for this file, which could
4201 be C<\"0\">). Then after the first xattr struct are the
4202 zero or more attributes for the first named file.
4203 This repeats for the second and subsequent files.
4205 This call is intended for programs that want to efficiently
4206 list a directory contents without making many round-trips.
4207 See also C<guestfs_lstatlist> for a similarly efficient call
4208 for getting standard stats. Very long directory listings
4209 might cause the protocol message size to be exceeded, causing
4210 this call to fail. The caller must split up such requests
4211 into smaller groups of names.");
4213 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4215 "readlink on multiple files",
4217 This call allows you to do a C<readlink> 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 strings, with a one-to-one
4222 correspondence to the C<names> list. Each string is the
4223 value of the symbolic link.
4225 If the C<readlink(2)> operation fails on any name, then
4226 the corresponding result string is the empty string C<\"\">.
4227 However the whole operation is completed even if there
4228 were C<readlink(2)> errors, and so you can call this
4229 function with names where you don't know if they are
4230 symbolic links already (albeit slightly less efficient).
4232 This call is intended for programs that want to efficiently
4233 list a directory contents without making many round-trips.
4234 Very long directory listings might cause the protocol
4235 message size to be exceeded, causing
4236 this call to fail. The caller must split up such requests
4237 into smaller groups of names.");
4239 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4240 [InitISOFS, Always, TestOutputBuffer (
4241 [["pread"; "/known-4"; "1"; "3"]], "\n");
4242 InitISOFS, Always, TestOutputBuffer (
4243 [["pread"; "/empty"; "0"; "100"]], "")],
4244 "read part of a file",
4246 This command lets you read part of a file. It reads C<count>
4247 bytes of the file, starting at C<offset>, from file C<path>.
4249 This may read fewer bytes than requested. For further details
4250 see the L<pread(2)> system call.
4252 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4254 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4255 [InitEmpty, Always, TestRun (
4256 [["part_init"; "/dev/sda"; "gpt"]])],
4257 "create an empty partition table",
4259 This creates an empty partition table on C<device> of one of the
4260 partition types listed below. Usually C<parttype> should be
4261 either C<msdos> or C<gpt> (for large disks).
4263 Initially there are no partitions. Following this, you should
4264 call C<guestfs_part_add> for each partition required.
4266 Possible values for C<parttype> are:
4270 =item B<efi> | B<gpt>
4272 Intel EFI / GPT partition table.
4274 This is recommended for >= 2 TB partitions that will be accessed
4275 from Linux and Intel-based Mac OS X. It also has limited backwards
4276 compatibility with the C<mbr> format.
4278 =item B<mbr> | B<msdos>
4280 The standard PC \"Master Boot Record\" (MBR) format used
4281 by MS-DOS and Windows. This partition type will B<only> work
4282 for device sizes up to 2 TB. For large disks we recommend
4287 Other partition table types that may work but are not
4296 =item B<amiga> | B<rdb>
4298 Amiga \"Rigid Disk Block\" format.
4306 DASD, used on IBM mainframes.
4314 Old Mac partition format. Modern Macs use C<gpt>.
4318 NEC PC-98 format, common in Japan apparently.
4326 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4327 [InitEmpty, Always, TestRun (
4328 [["part_init"; "/dev/sda"; "mbr"];
4329 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4330 InitEmpty, Always, TestRun (
4331 [["part_init"; "/dev/sda"; "gpt"];
4332 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4333 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4334 InitEmpty, Always, TestRun (
4335 [["part_init"; "/dev/sda"; "mbr"];
4336 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4337 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4338 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4339 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4340 "add a partition to the device",
4342 This command adds a partition to C<device>. If there is no partition
4343 table on the device, call C<guestfs_part_init> first.
4345 The C<prlogex> parameter is the type of partition. Normally you
4346 should pass C<p> or C<primary> here, but MBR partition tables also
4347 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4350 C<startsect> and C<endsect> are the start and end of the partition
4351 in I<sectors>. C<endsect> may be negative, which means it counts
4352 backwards from the end of the disk (C<-1> is the last sector).
4354 Creating a partition which covers the whole disk is not so easy.
4355 Use C<guestfs_part_disk> to do that.");
4357 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4358 [InitEmpty, Always, TestRun (
4359 [["part_disk"; "/dev/sda"; "mbr"]]);
4360 InitEmpty, Always, TestRun (
4361 [["part_disk"; "/dev/sda"; "gpt"]])],
4362 "partition whole disk with a single primary partition",
4364 This command is simply a combination of C<guestfs_part_init>
4365 followed by C<guestfs_part_add> to create a single primary partition
4366 covering the whole disk.
4368 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4369 but other possible values are described in C<guestfs_part_init>.");
4371 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4372 [InitEmpty, Always, TestRun (
4373 [["part_disk"; "/dev/sda"; "mbr"];
4374 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4375 "make a partition bootable",
4377 This sets the bootable flag on partition numbered C<partnum> on
4378 device C<device>. Note that partitions are numbered from 1.
4380 The bootable flag is used by some operating systems (notably
4381 Windows) to determine which partition to boot from. It is by
4382 no means universally recognized.");
4384 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4385 [InitEmpty, Always, TestRun (
4386 [["part_disk"; "/dev/sda"; "gpt"];
4387 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4388 "set partition name",
4390 This sets the partition name on partition numbered C<partnum> on
4391 device C<device>. Note that partitions are numbered from 1.
4393 The partition name can only be set on certain types of partition
4394 table. This works on C<gpt> but not on C<mbr> partitions.");
4396 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4397 [], (* XXX Add a regression test for this. *)
4398 "list partitions on a device",
4400 This command parses the partition table on C<device> and
4401 returns the list of partitions found.
4403 The fields in the returned structure are:
4409 Partition number, counting from 1.
4413 Start of the partition I<in bytes>. To get sectors you have to
4414 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4418 End of the partition in bytes.
4422 Size of the partition in bytes.
4426 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4427 [InitEmpty, Always, TestOutput (
4428 [["part_disk"; "/dev/sda"; "gpt"];
4429 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4430 "get the partition table type",
4432 This command examines the partition table on C<device> and
4433 returns the partition table type (format) being used.
4435 Common return values include: C<msdos> (a DOS/Windows style MBR
4436 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4437 values are possible, although unusual. See C<guestfs_part_init>
4440 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4441 [InitBasicFS, Always, TestOutputBuffer (
4442 [["fill"; "0x63"; "10"; "/test"];
4443 ["read_file"; "/test"]], "cccccccccc")],
4444 "fill a file with octets",
4446 This command creates a new file called C<path>. The initial
4447 content of the file is C<len> octets of C<c>, where C<c>
4448 must be a number in the range C<[0..255]>.
4450 To fill a file with zero bytes (sparsely), it is
4451 much more efficient to use C<guestfs_truncate_size>.
4452 To create a file with a pattern of repeating bytes
4453 use C<guestfs_fill_pattern>.");
4455 ("available", (RErr, [StringList "groups"], []), 216, [],
4456 [InitNone, Always, TestRun [["available"; ""]]],
4457 "test availability of some parts of the API",
4459 This command is used to check the availability of some
4460 groups of functionality in the appliance, which not all builds of
4461 the libguestfs appliance will be able to provide.
4463 The libguestfs groups, and the functions that those
4464 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4465 You can also fetch this list at runtime by calling
4466 C<guestfs_available_all_groups>.
4468 The argument C<groups> is a list of group names, eg:
4469 C<[\"inotify\", \"augeas\"]> would check for the availability of
4470 the Linux inotify functions and Augeas (configuration file
4473 The command returns no error if I<all> requested groups are available.
4475 It fails with an error if one or more of the requested
4476 groups is unavailable in the appliance.
4478 If an unknown group name is included in the
4479 list of groups then an error is always returned.
4487 You must call C<guestfs_launch> before calling this function.
4489 The reason is because we don't know what groups are
4490 supported by the appliance/daemon until it is running and can
4495 If a group of functions is available, this does not necessarily
4496 mean that they will work. You still have to check for errors
4497 when calling individual API functions even if they are
4502 It is usually the job of distro packagers to build
4503 complete functionality into the libguestfs appliance.
4504 Upstream libguestfs, if built from source with all
4505 requirements satisfied, will support everything.
4509 This call was added in version C<1.0.80>. In previous
4510 versions of libguestfs all you could do would be to speculatively
4511 execute a command to find out if the daemon implemented it.
4512 See also C<guestfs_version>.
4516 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4517 [InitBasicFS, Always, TestOutputBuffer (
4518 [["write"; "/src"; "hello, world"];
4519 ["dd"; "/src"; "/dest"];
4520 ["read_file"; "/dest"]], "hello, world")],
4521 "copy from source to destination using dd",
4523 This command copies from one source device or file C<src>
4524 to another destination device or file C<dest>. Normally you
4525 would use this to copy to or from a device or partition, for
4526 example to duplicate a filesystem.
4528 If the destination is a device, it must be as large or larger
4529 than the source file or device, otherwise the copy will fail.
4530 This command cannot do partial copies (see C<guestfs_copy_size>).");
4532 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4533 [InitBasicFS, Always, TestOutputInt (
4534 [["write"; "/file"; "hello, world"];
4535 ["filesize"; "/file"]], 12)],
4536 "return the size of the file in bytes",
4538 This command returns the size of C<file> in bytes.
4540 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4541 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4542 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4544 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4545 [InitBasicFSonLVM, Always, TestOutputList (
4546 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4547 ["lvs"]], ["/dev/VG/LV2"])],
4548 "rename an LVM logical volume",
4550 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4552 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4553 [InitBasicFSonLVM, Always, TestOutputList (
4555 ["vg_activate"; "false"; "VG"];
4556 ["vgrename"; "VG"; "VG2"];
4557 ["vg_activate"; "true"; "VG2"];
4558 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4559 ["vgs"]], ["VG2"])],
4560 "rename an LVM volume group",
4562 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4564 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4565 [InitISOFS, Always, TestOutputBuffer (
4566 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4567 "list the contents of a single file in an initrd",
4569 This command unpacks the file C<filename> from the initrd file
4570 called C<initrdpath>. The filename must be given I<without> the
4571 initial C</> character.
4573 For example, in guestfish you could use the following command
4574 to examine the boot script (usually called C</init>)
4575 contained in a Linux initrd or initramfs image:
4577 initrd-cat /boot/initrd-<version>.img init
4579 See also C<guestfs_initrd_list>.");
4581 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4583 "get the UUID of a physical volume",
4585 This command returns the UUID of the LVM PV C<device>.");
4587 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4589 "get the UUID of a volume group",
4591 This command returns the UUID of the LVM VG named C<vgname>.");
4593 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4595 "get the UUID of a logical volume",
4597 This command returns the UUID of the LVM LV C<device>.");
4599 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4601 "get the PV UUIDs containing the volume group",
4603 Given a VG called C<vgname>, this returns the UUIDs of all
4604 the physical volumes that this volume group resides on.
4606 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4607 calls to associate physical volumes and volume groups.
4609 See also C<guestfs_vglvuuids>.");
4611 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4613 "get the LV UUIDs of all LVs in the volume group",
4615 Given a VG called C<vgname>, this returns the UUIDs of all
4616 the logical volumes created in this volume group.
4618 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4619 calls to associate logical volumes and volume groups.
4621 See also C<guestfs_vgpvuuids>.");
4623 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4624 [InitBasicFS, Always, TestOutputBuffer (
4625 [["write"; "/src"; "hello, world"];
4626 ["copy_size"; "/src"; "/dest"; "5"];
4627 ["read_file"; "/dest"]], "hello")],
4628 "copy size bytes from source to destination using dd",
4630 This command copies exactly C<size> bytes from one source device
4631 or file C<src> to another destination device or file C<dest>.
4633 Note this will fail if the source is too short or if the destination
4634 is not large enough.");
4636 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4637 [InitBasicFSonLVM, Always, TestRun (
4638 [["zero_device"; "/dev/VG/LV"]])],
4639 "write zeroes to an entire device",
4641 This command writes zeroes over the entire C<device>. Compare
4642 with C<guestfs_zero> which just zeroes the first few blocks of
4645 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4646 [InitBasicFS, Always, TestOutput (
4647 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4648 ["cat"; "/hello"]], "hello\n")],
4649 "unpack compressed tarball to directory",
4651 This command uploads and unpacks local file C<tarball> (an
4652 I<xz compressed> tar file) into C<directory>.");
4654 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4656 "pack directory into compressed tarball",
4658 This command packs the contents of C<directory> and downloads
4659 it to local file C<tarball> (as an xz compressed tar archive).");
4661 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4663 "resize an NTFS filesystem",
4665 This command resizes an NTFS filesystem, expanding or
4666 shrinking it to the size of the underlying device.
4667 See also L<ntfsresize(8)>.");
4669 ("vgscan", (RErr, [], []), 232, [],
4670 [InitEmpty, Always, TestRun (
4672 "rescan for LVM physical volumes, volume groups and logical volumes",
4674 This rescans all block devices and rebuilds the list of LVM
4675 physical volumes, volume groups and logical volumes.");
4677 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
4678 [InitEmpty, Always, TestRun (
4679 [["part_init"; "/dev/sda"; "mbr"];
4680 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4681 ["part_del"; "/dev/sda"; "1"]])],
4682 "delete a partition",
4684 This command deletes the partition numbered C<partnum> on C<device>.
4686 Note that in the case of MBR partitioning, deleting an
4687 extended partition also deletes any logical partitions
4690 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
4691 [InitEmpty, Always, TestOutputTrue (
4692 [["part_init"; "/dev/sda"; "mbr"];
4693 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4694 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4695 ["part_get_bootable"; "/dev/sda"; "1"]])],
4696 "return true if a partition is bootable",
4698 This command returns true if the partition C<partnum> on
4699 C<device> has the bootable flag set.
4701 See also C<guestfs_part_set_bootable>.");
4703 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
4704 [InitEmpty, Always, TestOutputInt (
4705 [["part_init"; "/dev/sda"; "mbr"];
4706 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4707 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4708 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4709 "get the MBR type byte (ID byte) from a partition",
4711 Returns the MBR type byte (also known as the ID byte) from
4712 the numbered partition C<partnum>.
4714 Note that only MBR (old DOS-style) partitions have type bytes.
4715 You will get undefined results for other partition table
4716 types (see C<guestfs_part_get_parttype>).");
4718 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
4719 [], (* tested by part_get_mbr_id *)
4720 "set the MBR type byte (ID byte) of a partition",
4722 Sets the MBR type byte (also known as the ID byte) of
4723 the numbered partition C<partnum> to C<idbyte>. Note
4724 that the type bytes quoted in most documentation are
4725 in fact hexadecimal numbers, but usually documented
4726 without any leading \"0x\" which might be confusing.
4728 Note that only MBR (old DOS-style) partitions have type bytes.
4729 You will get undefined results for other partition table
4730 types (see C<guestfs_part_get_parttype>).");
4732 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
4733 [InitISOFS, Always, TestOutputFileMD5 (
4734 [["checksum_device"; "md5"; "/dev/sdd"]],
4735 "../images/test.iso")],
4736 "compute MD5, SHAx or CRC checksum of the contents of a device",
4738 This call computes the MD5, SHAx or CRC checksum of the
4739 contents of the device named C<device>. For the types of
4740 checksums supported see the C<guestfs_checksum> command.");
4742 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
4743 [InitNone, Always, TestRun (
4744 [["part_disk"; "/dev/sda"; "mbr"];
4745 ["pvcreate"; "/dev/sda1"];
4746 ["vgcreate"; "VG"; "/dev/sda1"];
4747 ["lvcreate"; "LV"; "VG"; "10"];
4748 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4749 "expand an LV to fill free space",
4751 This expands an existing logical volume C<lv> so that it fills
4752 C<pc>% of the remaining free space in the volume group. Commonly
4753 you would call this with pc = 100 which expands the logical volume
4754 as much as possible, using all remaining free space in the volume
4757 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
4758 [], (* XXX Augeas code needs tests. *)
4759 "clear Augeas path",
4761 Set the value associated with C<path> to C<NULL>. This
4762 is the same as the L<augtool(1)> C<clear> command.");
4764 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
4765 [InitEmpty, Always, TestOutputInt (
4766 [["get_umask"]], 0o22)],
4767 "get the current umask",
4769 Return the current umask. By default the umask is C<022>
4770 unless it has been set by calling C<guestfs_umask>.");
4772 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [],
4774 "upload a file to the appliance (internal use only)",
4776 The C<guestfs_debug_upload> command uploads a file to
4777 the libguestfs appliance.
4779 There is no comprehensive help for this command. You have
4780 to look at the file C<daemon/debug.c> in the libguestfs source
4781 to find out what it is for.");
4783 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
4784 [InitBasicFS, Always, TestOutput (
4785 [["base64_in"; "../images/hello.b64"; "/hello"];
4786 ["cat"; "/hello"]], "hello\n")],
4787 "upload base64-encoded data to file",
4789 This command uploads base64-encoded data from C<base64file>
4792 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
4794 "download file and encode as base64",
4796 This command downloads the contents of C<filename>, writing
4797 it out to local file C<base64file> encoded as base64.");
4799 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
4801 "compute MD5, SHAx or CRC checksum of files in a directory",
4803 This command computes the checksums of all regular files in
4804 C<directory> and then emits a list of those checksums to
4805 the local output file C<sumsfile>.
4807 This can be used for verifying the integrity of a virtual
4808 machine. However to be properly secure you should pay
4809 attention to the output of the checksum command (it uses
4810 the ones from GNU coreutils). In particular when the
4811 filename is not printable, coreutils uses a special
4812 backslash syntax. For more information, see the GNU
4813 coreutils info file.");
4815 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
4816 [InitBasicFS, Always, TestOutputBuffer (
4817 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4818 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4819 "fill a file with a repeating pattern of bytes",
4821 This function is like C<guestfs_fill> except that it creates
4822 a new file of length C<len> containing the repeating pattern
4823 of bytes in C<pattern>. The pattern is truncated if necessary
4824 to ensure the length of the file is exactly C<len> bytes.");
4826 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
4827 [InitBasicFS, Always, TestOutput (
4828 [["write"; "/new"; "new file contents"];
4829 ["cat"; "/new"]], "new file contents");
4830 InitBasicFS, Always, TestOutput (
4831 [["write"; "/new"; "\nnew file contents\n"];
4832 ["cat"; "/new"]], "\nnew file contents\n");
4833 InitBasicFS, Always, TestOutput (
4834 [["write"; "/new"; "\n\n"];
4835 ["cat"; "/new"]], "\n\n");
4836 InitBasicFS, Always, TestOutput (
4837 [["write"; "/new"; ""];
4838 ["cat"; "/new"]], "");
4839 InitBasicFS, Always, TestOutput (
4840 [["write"; "/new"; "\n\n\n"];
4841 ["cat"; "/new"]], "\n\n\n");
4842 InitBasicFS, Always, TestOutput (
4843 [["write"; "/new"; "\n"];
4844 ["cat"; "/new"]], "\n")],
4845 "create a new file",
4847 This call creates a file called C<path>. The content of the
4848 file is the string C<content> (which can contain any 8 bit data).");
4850 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
4851 [InitBasicFS, Always, TestOutput (
4852 [["write"; "/new"; "new file contents"];
4853 ["pwrite"; "/new"; "data"; "4"];
4854 ["cat"; "/new"]], "new data contents");
4855 InitBasicFS, Always, TestOutput (
4856 [["write"; "/new"; "new file contents"];
4857 ["pwrite"; "/new"; "is extended"; "9"];
4858 ["cat"; "/new"]], "new file is extended");
4859 InitBasicFS, Always, TestOutput (
4860 [["write"; "/new"; "new file contents"];
4861 ["pwrite"; "/new"; ""; "4"];
4862 ["cat"; "/new"]], "new file contents")],
4863 "write to part of a file",
4865 This command writes to part of a file. It writes the data
4866 buffer C<content> to the file C<path> starting at offset C<offset>.
4868 This command implements the L<pwrite(2)> system call, and like
4869 that system call it may not write the full data requested. The
4870 return value is the number of bytes that were actually written
4871 to the file. This could even be 0, although short writes are
4872 unlikely for regular files in ordinary circumstances.
4874 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
4876 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
4878 "resize an ext2, ext3 or ext4 filesystem (with size)",
4880 This command is the same as C<guestfs_resize2fs> except that it
4881 allows you to specify the new size (in bytes) explicitly.");
4883 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
4885 "resize an LVM physical volume (with size)",
4887 This command is the same as C<guestfs_pvresize> except that it
4888 allows you to specify the new size (in bytes) explicitly.");
4890 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
4892 "resize an NTFS filesystem (with size)",
4894 This command is the same as C<guestfs_ntfsresize> except that it
4895 allows you to specify the new size (in bytes) explicitly.");
4897 ("available_all_groups", (RStringList "groups", [], []), 251, [],
4898 [InitNone, Always, TestRun [["available_all_groups"]]],
4899 "return a list of all optional groups",
4901 This command returns a list of all optional groups that this
4902 daemon knows about. Note this returns both supported and unsupported
4903 groups. To find out which ones the daemon can actually support
4904 you have to call C<guestfs_available> on each member of the
4907 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4909 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
4910 [InitBasicFS, Always, TestOutputStruct (
4911 [["fallocate64"; "/a"; "1000000"];
4912 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4913 "preallocate a file in the guest filesystem",
4915 This command preallocates a file (containing zero bytes) named
4916 C<path> of size C<len> bytes. If the file exists already, it
4919 Note that this call allocates disk blocks for the file.
4920 To create a sparse file use C<guestfs_truncate_size> instead.
4922 The deprecated call C<guestfs_fallocate> does the same,
4923 but owing to an oversight it only allowed 30 bit lengths
4924 to be specified, effectively limiting the maximum size
4925 of files created through that call to 1GB.
4927 Do not confuse this with the guestfish-specific
4928 C<alloc> and C<sparse> commands which create
4929 a file in the host and attach it as a device.");
4931 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
4932 [InitBasicFS, Always, TestOutput (
4933 [["set_e2label"; "/dev/sda1"; "LTEST"];
4934 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4935 "get the filesystem label",
4937 This returns the filesystem label of the filesystem on
4940 If the filesystem is unlabeled, this returns the empty string.
4942 To find a filesystem from the label, use C<guestfs_findfs_label>.");
4944 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
4945 (let uuid = uuidgen () in
4946 [InitBasicFS, Always, TestOutput (
4947 [["set_e2uuid"; "/dev/sda1"; uuid];
4948 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4949 "get the filesystem UUID",
4951 This returns the filesystem UUID of the filesystem on
4954 If the filesystem does not have a UUID, this returns the empty string.
4956 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
4958 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
4959 (* Can't be tested with the current framework because
4960 * the VG is being used by the mounted filesystem, so
4961 * the vgchange -an command we do first will fail.
4964 "set LVM device filter",
4966 This sets the LVM device filter so that LVM will only be
4967 able to \"see\" the block devices in the list C<devices>,
4968 and will ignore all other attached block devices.
4970 Where disk image(s) contain duplicate PVs or VGs, this
4971 command is useful to get LVM to ignore the duplicates, otherwise
4972 LVM can get confused. Note also there are two types
4973 of duplication possible: either cloned PVs/VGs which have
4974 identical UUIDs; or VGs that are not cloned but just happen
4975 to have the same name. In normal operation you cannot
4976 create this situation, but you can do it outside LVM, eg.
4977 by cloning disk images or by bit twiddling inside the LVM
4980 This command also clears the LVM cache and performs a volume
4983 You can filter whole block devices or individual partitions.
4985 You cannot use this if any VG is currently in use (eg.
4986 contains a mounted filesystem), even if you are not
4987 filtering out that VG.");
4989 ("lvm_clear_filter", (RErr, [], []), 256, [],
4990 [], (* see note on lvm_set_filter *)
4991 "clear LVM device filter",
4993 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
4994 will be able to see every block device.
4996 This command also clears the LVM cache and performs a volume
4999 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5001 "open a LUKS-encrypted block device",
5003 This command opens a block device which has been encrypted
5004 according to the Linux Unified Key Setup (LUKS) standard.
5006 C<device> is the encrypted block device or partition.
5008 The caller must supply one of the keys associated with the
5009 LUKS block device, in the C<key> parameter.
5011 This creates a new block device called C</dev/mapper/mapname>.
5012 Reads and writes to this block device are decrypted from and
5013 encrypted to the underlying C<device> respectively.
5015 If this block device contains LVM volume groups, then
5016 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5017 will make them visible.");
5019 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5021 "open a LUKS-encrypted block device read-only",
5023 This is the same as C<guestfs_luks_open> except that a read-only
5024 mapping is created.");
5026 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5028 "close a LUKS device",
5030 This closes a LUKS device that was created earlier by
5031 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5032 C<device> parameter must be the name of the LUKS mapping
5033 device (ie. C</dev/mapper/mapname>) and I<not> the name
5034 of the underlying block device.");
5036 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5038 "format a block device as a LUKS encrypted device",
5040 This command erases existing data on C<device> and formats
5041 the device as a LUKS encrypted device. C<key> is the
5042 initial key, which is added to key slot C<slot>. (LUKS
5043 supports 8 key slots, numbered 0-7).");
5045 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5047 "format a block device as a LUKS encrypted device",
5049 This command is the same as C<guestfs_luks_format> but
5050 it also allows you to set the C<cipher> used.");
5052 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5054 "add a key on a LUKS encrypted device",
5056 This command adds a new key on LUKS device C<device>.
5057 C<key> is any existing key, and is used to access the device.
5058 C<newkey> is the new key to add. C<keyslot> is the key slot
5059 that will be replaced.
5061 Note that if C<keyslot> already contains a key, then this
5062 command will fail. You have to use C<guestfs_luks_kill_slot>
5063 first to remove that key.");
5065 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5067 "remove a key from a LUKS encrypted device",
5069 This command deletes the key in key slot C<keyslot> from the
5070 encrypted LUKS device C<device>. C<key> must be one of the
5073 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5074 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5075 [["is_lv"; "/dev/VG/LV"]]);
5076 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5077 [["is_lv"; "/dev/sda1"]])],
5078 "test if device is a logical volume",
5080 This command tests whether C<device> is a logical volume, and
5081 returns true iff this is the case.");
5083 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5085 "find a filesystem by UUID",
5087 This command searches the filesystems and returns the one
5088 which has the given UUID. An error is returned if no such
5089 filesystem can be found.
5091 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5093 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5095 "find a filesystem by label",
5097 This command searches the filesystems and returns the one
5098 which has the given label. An error is returned if no such
5099 filesystem can be found.
5101 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5103 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5104 [InitISOFS, Always, TestOutputFalse (
5105 [["is_chardev"; "/directory"]]);
5106 InitBasicFS, Always, TestOutputTrue (
5107 [["mknod_c"; "0o777"; "99"; "66"; "/test"];
5108 ["is_chardev"; "/test"]])],
5109 "test if character device",
5111 This returns C<true> if and only if there is a character device
5112 with the given C<path> name.
5114 See also C<guestfs_stat>.");
5116 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5117 [InitISOFS, Always, TestOutputFalse (
5118 [["is_blockdev"; "/directory"]]);
5119 InitBasicFS, Always, TestOutputTrue (
5120 [["mknod_b"; "0o777"; "99"; "66"; "/test"];
5121 ["is_blockdev"; "/test"]])],
5122 "test if block device",
5124 This returns C<true> if and only if there is a block device
5125 with the given C<path> name.
5127 See also C<guestfs_stat>.");
5129 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5130 [InitISOFS, Always, TestOutputFalse (
5131 [["is_fifo"; "/directory"]]);
5132 InitBasicFS, Always, TestOutputTrue (
5133 [["mkfifo"; "0o777"; "/test"];
5134 ["is_fifo"; "/test"]])],
5135 "test if FIFO (named pipe)",
5137 This returns C<true> if and only if there is a FIFO (named pipe)
5138 with the given C<path> name.
5140 See also C<guestfs_stat>.");
5142 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5143 [InitISOFS, Always, TestOutputFalse (
5144 [["is_symlink"; "/directory"]]);
5145 InitISOFS, Always, TestOutputTrue (
5146 [["is_symlink"; "/abssymlink"]])],
5147 "test if symbolic link",
5149 This returns C<true> if and only if there is a symbolic link
5150 with the given C<path> name.
5152 See also C<guestfs_stat>.");
5154 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5155 (* XXX Need a positive test for sockets. *)
5156 [InitISOFS, Always, TestOutputFalse (
5157 [["is_socket"; "/directory"]])],
5160 This returns C<true> if and only if there is a Unix domain socket
5161 with the given C<path> name.
5163 See also C<guestfs_stat>.");
5165 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5166 [InitPartition, Always, TestOutputDevice (
5167 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5168 InitEmpty, Always, TestLastFail (
5169 [["part_to_dev"; "/dev/sda"]])],
5170 "convert partition name to device name",
5172 This function takes a partition name (eg. \"/dev/sdb1\") and
5173 removes the partition number, returning the device name
5176 The named partition must exist, for example as a string returned
5177 from C<guestfs_list_partitions>.");
5179 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [],
5180 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5181 [InitBasicFS, Always, TestOutput (
5182 [["upload_offset"; "../COPYING.LIB"; "/COPYING.LIB"; "0"];
5183 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5184 "upload a file from the local machine with offset",
5186 Upload local file C<filename> to C<remotefilename> on the
5189 C<remotefilename> is overwritten starting at the byte C<offset>
5190 specified. The intention is to overwrite parts of existing
5191 files or devices, although if a non-existant file is specified
5192 then it is created with a \"hole\" before C<offset>. The
5193 size of the data written is implicit in the size of the
5196 Note that there is no limit on the amount of data that
5197 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5198 and this call always writes the full amount unless an
5201 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5203 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5204 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5205 let offset = string_of_int 100 in
5206 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5207 [InitBasicFS, Always, TestOutput (
5208 (* Pick a file from cwd which isn't likely to change. *)
5209 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
5210 ["download_offset"; "/COPYING.LIB"; "testdownload.tmp"; offset; size];
5211 ["upload_offset"; "testdownload.tmp"; "/COPYING.LIB"; offset];
5212 ["checksum"; "md5"; "/COPYING.LIB"]], md5)]),
5213 "download a file to the local machine with offset and size",
5215 Download file C<remotefilename> and save it as C<filename>
5216 on the local machine.
5218 C<remotefilename> is read for C<size> bytes starting at C<offset>
5219 (this region must be within the file or device).
5221 Note that there is no limit on the amount of data that
5222 can be downloaded with this call, unlike with C<guestfs_pread>,
5223 and this call always reads the full amount unless an
5226 See also C<guestfs_download>, C<guestfs_pread>.");
5228 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5229 [InitPartition, Always, TestOutputList (
5230 [["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"];
5231 ["blockdev_rereadpt"; "/dev/sda"];
5232 ["list_partitions"]], [])],
5233 "write to part of a device",
5235 This command writes to part of a device. It writes the data
5236 buffer C<content> to C<device> starting at offset C<offset>.
5238 This command implements the L<pwrite(2)> system call, and like
5239 that system call it may not write the full data requested
5240 (although short writes to disk devices and partitions are
5241 probably impossible with standard Linux kernels).
5243 See also C<guestfs_pwrite>.");
5245 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5246 [InitEmpty, Always, TestOutputBuffer (
5247 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5248 "read part of a device",
5250 This command lets you read part of a file. It reads C<count>
5251 bytes of C<device>, starting at C<offset>.
5253 This may read fewer bytes than requested. For further details
5254 see the L<pread(2)> system call.
5256 See also C<guestfs_pread>.");
5258 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5259 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5260 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5261 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5262 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5263 "get canonical name of an LV",
5265 This converts alternative naming schemes for LVs that you
5266 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5267 is converted to C</dev/VG/LV>.
5269 This command returns an error if the C<lvname> parameter does
5270 not refer to a logical volume.
5272 See also C<guestfs_is_lv>.");
5276 let all_functions = non_daemon_functions @ daemon_functions
5278 (* In some places we want the functions to be displayed sorted
5279 * alphabetically, so this is useful:
5281 let all_functions_sorted = List.sort action_compare all_functions
5283 (* This is used to generate the src/MAX_PROC_NR file which
5284 * contains the maximum procedure number, a surrogate for the
5285 * ABI version number. See src/Makefile.am for the details.
5288 let proc_nrs = List.map (
5289 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5290 ) daemon_functions in
5291 List.fold_left max 0 proc_nrs
5293 (* Non-API meta-commands available only in guestfish.
5295 * Note (1): style, proc_nr and tests fields are all meaningless.
5296 * The only fields which are actually used are the shortname,
5297 * FishAlias flags, shortdesc and longdesc.
5299 * Note (2): to refer to other commands, use L</shortname>.
5301 * Note (3): keep this list sorted by shortname.
5303 let fish_commands = [
5304 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5305 "allocate and add a disk file",
5306 " alloc filename size
5308 This creates an empty (zeroed) file of the given size, and then adds
5309 so it can be further examined.
5311 For more advanced image creation, see L<qemu-img(1)> utility.
5313 Size can be specified using standard suffixes, eg. C<1M>.
5315 To create a sparse file, use L</sparse> instead. To create a
5316 prepared disk image, see L</PREPARED DISK IMAGES>.");
5318 ("copy_in", (RErr,[], []), -1, [], [],
5319 "copy local files or directories into an image",
5320 " copy-in local [local ...] /remotedir
5322 C<copy-in> copies local files or directories recursively into the disk
5323 image, placing them in the directory called C</remotedir> (which must
5324 exist). This guestfish meta-command turns into a sequence of
5325 L</tar-in> and other commands as necessary.
5327 Multiple local files and directories can be specified, but the last
5328 parameter must always be a remote directory. Wildcards cannot be
5331 ("copy_out", (RErr,[], []), -1, [], [],
5332 "copy remote files or directories out of an image",
5333 " copy-out remote [remote ...] localdir
5335 C<copy-out> copies remote files or directories recursively out of the
5336 disk image, placing them on the host disk in a local directory called
5337 C<localdir> (which must exist). This guestfish meta-command turns
5338 into a sequence of L</download>, L</tar-out> and other commands as
5341 Multiple remote files and directories can be specified, but the last
5342 parameter must always be a local directory. To download to the
5343 current directory, use C<.> as in:
5347 Wildcards cannot be used in the ordinary command, but you can use
5348 them with the help of L</glob> like this:
5350 glob copy-out /home/* .");
5352 ("echo", (RErr,[], []), -1, [], [],
5353 "display a line of text",
5356 This echos the parameters to the terminal.");
5358 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5362 This is used to edit a file. It downloads the file, edits it
5363 locally using your editor, then uploads the result.
5365 The editor is C<$EDITOR>. However if you use the alternate
5366 commands C<vi> or C<emacs> you will get those corresponding
5369 ("glob", (RErr,[], []), -1, [], [],
5370 "expand wildcards in command",
5371 " glob command args...
5373 Expand wildcards in any paths in the args list, and run C<command>
5374 repeatedly on each matching path.
5376 See L</WILDCARDS AND GLOBBING>.");
5378 ("hexedit", (RErr,[], []), -1, [], [],
5379 "edit with a hex editor",
5380 " hexedit <filename|device>
5381 hexedit <filename|device> <max>
5382 hexedit <filename|device> <start> <max>
5384 Use hexedit (a hex editor) to edit all or part of a binary file
5387 This command works by downloading potentially the whole file or
5388 device, editing it locally, then uploading it. If the file or
5389 device is large, you have to specify which part you wish to edit
5390 by using C<max> and/or C<start> C<max> parameters.
5391 C<start> and C<max> are specified in bytes, with the usual
5392 modifiers allowed such as C<1M> (1 megabyte).
5394 For example to edit the first few sectors of a disk you
5399 which would allow you to edit anywhere within the first megabyte
5402 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5404 hexedit /dev/sda1 0x400 0x400
5406 (assuming the superblock is in the standard location).
5408 This command requires the external L<hexedit(1)> program. You
5409 can specify another program to use by setting the C<HEXEDITOR>
5410 environment variable.
5412 See also L</hexdump>.");
5414 ("lcd", (RErr,[], []), -1, [], [],
5415 "change working directory",
5418 Change the local directory, ie. the current directory of guestfish
5421 Note that C<!cd> won't do what you might expect.");
5423 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5427 Opens the manual page for guestfish.");
5429 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5435 This is used to view a file.
5437 The default viewer is C<$PAGER>. However if you use the alternate
5438 command C<less> you will get the C<less> command specifically.");
5440 ("reopen", (RErr,[], []), -1, [], [],
5441 "close and reopen libguestfs handle",
5444 Close and reopen the libguestfs handle. It is not necessary to use
5445 this normally, because the handle is closed properly when guestfish
5446 exits. However this is occasionally useful for testing.");
5448 ("sparse", (RErr,[], []), -1, [], [],
5449 "create a sparse disk image and add",
5450 " sparse filename size
5452 This creates an empty sparse file of the given size, and then adds
5453 so it can be further examined.
5455 In all respects it works the same as the L</alloc> command, except that
5456 the image file is allocated sparsely, which means that disk blocks are
5457 not assigned to the file until they are needed. Sparse disk files
5458 only use space when written to, but they are slower and there is a
5459 danger you could run out of real disk space during a write operation.
5461 For more advanced image creation, see L<qemu-img(1)> utility.
5463 Size can be specified using standard suffixes, eg. C<1M>.");
5465 ("supported", (RErr,[], []), -1, [], [],
5466 "list supported groups of commands",
5469 This command returns a list of the optional groups
5470 known to the daemon, and indicates which ones are
5471 supported by this build of the libguestfs appliance.
5473 See also L<guestfs(3)/AVAILABILITY>.");
5475 ("time", (RErr,[], []), -1, [], [],
5476 "print elapsed time taken to run a command",
5477 " time command args...
5479 Run the command as usual, but print the elapsed time afterwards. This
5480 can be useful for benchmarking operations.");