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.
747 The operating system type could not be determined.
751 Future versions of libguestfs may return other strings here.
752 The caller should be prepared to handle any string.
754 Please read L<guestfs(3)/INSPECTION> for more details.");
756 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
758 "get architecture of inspected operating system",
760 This function should only be called with a root device string
761 as returned by C<guestfs_inspect_os>.
763 This returns the architecture of the inspected operating system.
764 The possible return values are listed under
765 C<guestfs_file_architecture>.
767 If the architecture could not be determined, then the
768 string C<unknown> is returned.
770 Please read L<guestfs(3)/INSPECTION> for more details.");
772 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
774 "get distro of inspected operating system",
776 This function should only be called with a root device string
777 as returned by C<guestfs_inspect_os>.
779 This returns the distro (distribution) of the inspected operating
782 Currently defined distros are:
818 =item \"redhat-based\"
820 Some Red Hat-derived distro.
824 Red Hat Enterprise Linux and some derivatives.
832 The distro could not be determined.
836 Windows does not have distributions. This string is
837 returned if the OS type is Windows.
841 Future versions of libguestfs may return other strings here.
842 The caller should be prepared to handle any string.
844 Please read L<guestfs(3)/INSPECTION> for more details.");
846 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
848 "get major version of inspected operating system",
850 This function should only be called with a root device string
851 as returned by C<guestfs_inspect_os>.
853 This returns the major version number of the inspected operating
856 Windows uses a consistent versioning scheme which is I<not>
857 reflected in the popular public names used by the operating system.
858 Notably the operating system known as \"Windows 7\" is really
859 version 6.1 (ie. major = 6, minor = 1). You can find out the
860 real versions corresponding to releases of Windows by consulting
863 If the version could not be determined, then C<0> is returned.
865 Please read L<guestfs(3)/INSPECTION> for more details.");
867 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
869 "get minor version of inspected operating system",
871 This function should only be called with a root device string
872 as returned by C<guestfs_inspect_os>.
874 This returns the minor version number of the inspected operating
877 If the version could not be determined, then C<0> is returned.
879 Please read L<guestfs(3)/INSPECTION> for more details.
880 See also C<guestfs_inspect_get_major_version>.");
882 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
884 "get product name of inspected operating system",
886 This function should only be called with a root device string
887 as returned by C<guestfs_inspect_os>.
889 This returns the product name of the inspected operating
890 system. The product name is generally some freeform string
891 which can be displayed to the user, but should not be
894 If the product name could not be determined, then the
895 string C<unknown> is returned.
897 Please read L<guestfs(3)/INSPECTION> for more details.");
899 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
901 "get mountpoints of inspected operating system",
903 This function should only be called with a root device string
904 as returned by C<guestfs_inspect_os>.
906 This returns a hash of where we think the filesystems
907 associated with this operating system should be mounted.
908 Callers should note that this is at best an educated guess
909 made by reading configuration files such as C</etc/fstab>.
911 Each element in the returned hashtable has a key which
912 is the path of the mountpoint (eg. C</boot>) and a value
913 which is the filesystem that would be mounted there
916 Non-mounted devices such as swap devices are I<not>
917 returned in this list.
919 Please read L<guestfs(3)/INSPECTION> for more details.
920 See also C<guestfs_inspect_get_filesystems>.");
922 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
924 "get filesystems associated with inspected operating system",
926 This function should only be called with a root device string
927 as returned by C<guestfs_inspect_os>.
929 This returns a list of all the filesystems that we think
930 are associated with this operating system. This includes
931 the root filesystem, other ordinary filesystems, and
932 non-mounted devices like swap partitions.
934 In the case of a multi-boot virtual machine, it is possible
935 for a filesystem to be shared between operating systems.
937 Please read L<guestfs(3)/INSPECTION> for more details.
938 See also C<guestfs_inspect_get_mountpoints>.");
940 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
942 "set enable network flag",
944 If C<network> is true, then the network is enabled in the
945 libguestfs appliance. The default is false.
947 This affects whether commands are able to access the network
948 (see L<guestfs(3)/RUNNING COMMANDS>).
950 You must call this before calling C<guestfs_launch>, otherwise
953 ("get_network", (RBool "network", [], []), -1, [],
955 "get enable network flag",
957 This returns the enable network flag.");
959 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
963 This inspection command looks for filesystems on partitions,
964 block devices and logical volumes, returning a list of devices
965 containing filesystems and their type.
967 The return value is a hash, where the keys are the devices
968 containing filesystems, and the values are the filesystem types.
971 \"/dev/sda1\" => \"ntfs\"
972 \"/dev/sda2\" => \"ext2\"
973 \"/dev/vg_guest/lv_root\" => \"ext4\"
974 \"/dev/vg_guest/lv_swap\" => \"swap\"
976 The value can have the special value \"unknown\", meaning the
977 content of the device is undetermined or empty.
978 \"swap\" means a Linux swap partition.
980 This command runs other libguestfs commands, which might include
981 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
982 use this soon after launch and only when nothing is mounted.
984 Not all of the filesystems returned will be mountable. In
985 particular, swap partitions are returned in the list. Also
986 this command does not check that each filesystem
987 found is valid and mountable, and some filesystems might
988 be mountable but require special options. Filesystems may
989 not all belong to a single logical operating system
990 (use C<guestfs_inspect_os> to look for OSes).");
992 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
994 "add an image to examine or modify",
996 This function adds a virtual machine disk image C<filename> to
997 libguestfs. The first time you call this function, the disk
998 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1001 You don't necessarily need to be root when using libguestfs. However
1002 you obviously do need sufficient permissions to access the filename
1003 for whatever operations you want to perform (ie. read access if you
1004 just want to read the image or write access if you want to modify the
1007 This call checks that C<filename> exists.
1009 The optional arguments are:
1015 If true then the image is treated as read-only. Writes are still
1016 allowed, but they are stored in a temporary snapshot overlay which
1017 is discarded at the end. The disk that you add is not modified.
1021 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1022 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1023 Possible formats include C<raw> and C<qcow2>.
1025 Automatic detection of the format opens you up to a potential
1026 security hole when dealing with untrusted raw-format images.
1027 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1032 This rarely-used option lets you emulate the behaviour of the
1033 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1037 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1039 "get Windows systemroot of inspected operating system",
1041 This function should only be called with a root device string
1042 as returned by C<guestfs_inspect_os>.
1044 This returns the Windows systemroot of the inspected guest.
1045 The systemroot is a directory path such as C</WINDOWS>.
1047 This call assumes that the guest is Windows and that the
1048 systemroot could be determined by inspection. If this is not
1049 the case then an error is returned.
1051 Please read L<guestfs(3)/INSPECTION> for more details.");
1053 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1055 "return list of operating systems found by last inspection",
1057 This function is a convenient way to get the list of root
1058 devices, as returned from a previous call to C<guestfs_inspect_os>,
1059 but without redoing the whole inspection process.
1061 This returns an empty list if either no root devices were
1062 found or the caller has not called C<guestfs_inspect_os>.
1064 Please read L<guestfs(3)/INSPECTION> for more details.");
1066 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1068 "debug the QEMU command line (internal use only)",
1070 This returns the internal QEMU command line. 'debug' commands are
1071 not part of the formal API and can be removed or changed at any time.");
1073 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"]), -1, [FishAlias "domain"],
1075 "add the disk(s) from a named libvirt domain",
1077 This function adds the disk(s) attached to the named libvirt
1078 domain C<dom>. It works by connecting to libvirt, requesting
1079 the domain and domain XML from libvirt, parsing it for disks,
1080 and calling C<guestfs_add_drive_opts> on each one.
1082 The number of disks added is returned. This operation is atomic:
1083 if an error is returned, then no disks are added.
1085 This function does some minimal checks to make sure the libvirt
1086 domain is not running (unless C<readonly> is true). In a future
1087 version we will try to acquire the libvirt lock on each disk.
1089 Disks must be accessible locally. This often means that adding disks
1090 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1091 will fail unless those disks are accessible via the same device path
1094 The optional C<libvirturi> parameter sets the libvirt URI
1095 (see L<http://libvirt.org/uri.html>). If this is not set then
1096 we connect to the default libvirt URI (or one set through an
1097 environment variable, see the libvirt documentation for full
1100 The other optional parameters are passed directly through to
1101 C<guestfs_add_drive_opts>.");
1104 This interface is not quite baked yet. -- RWMJ 2010-11-11
1105 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"]), -1, [NotInFish],
1107 "add the disk(s) from a libvirt domain",
1109 This function adds the disk(s) attached to the libvirt domain C<dom>.
1110 It works by requesting the domain XML from libvirt, parsing it for
1111 disks, and calling C<guestfs_add_drive_opts> on each one.
1113 In the C API we declare C<void *dom>, but really it has type
1114 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1116 The number of disks added is returned. This operation is atomic:
1117 if an error is returned, then no disks are added.
1119 This function does some minimal checks to make sure the libvirt
1120 domain is not running (unless C<readonly> is true). In a future
1121 version we will try to acquire the libvirt lock on each disk.
1123 Disks must be accessible locally. This often means that adding disks
1124 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1125 will fail unless those disks are accessible via the same device path
1128 The optional parameters are passed directly through to
1129 C<guestfs_add_drive_opts>.");
1132 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1134 "get package format used by the operating system",
1136 This function should only be called with a root device string
1137 as returned by C<guestfs_inspect_os>.
1139 This function and C<guestfs_inspect_get_package_management> return
1140 the package format and package management tool used by the
1141 inspected operating system. For example for Fedora these
1142 functions would return C<rpm> (package format) and
1143 C<yum> (package management).
1145 This returns the string C<unknown> if we could not determine the
1146 package format I<or> if the operating system does not have
1147 a real packaging system (eg. Windows).
1149 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1150 Future versions of libguestfs may return other strings.
1152 Please read L<guestfs(3)/INSPECTION> for more details.");
1154 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1156 "get package management tool used by the operating system",
1158 This function should only be called with a root device string
1159 as returned by C<guestfs_inspect_os>.
1161 C<guestfs_inspect_get_package_format> and this function return
1162 the package format and package management tool used by the
1163 inspected operating system. For example for Fedora these
1164 functions would return C<rpm> (package format) and
1165 C<yum> (package management).
1167 This returns the string C<unknown> if we could not determine the
1168 package management tool I<or> if the operating system does not have
1169 a real packaging system (eg. Windows).
1171 Possible strings include: C<yum>, C<up2date>,
1172 C<apt> (for all Debian derivatives),
1173 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1174 Future versions of libguestfs may return other strings.
1176 Please read L<guestfs(3)/INSPECTION> for more details.");
1178 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1180 "get list of applications installed in the operating system",
1182 This function should only be called with a root device string
1183 as returned by C<guestfs_inspect_os>.
1185 Return the list of applications installed in the operating system.
1187 I<Note:> This call works differently from other parts of the
1188 inspection API. You have to call C<guestfs_inspect_os>, then
1189 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1190 before calling this. Listing applications is a significantly
1191 more difficult operation which requires access to the full
1192 filesystem. Also note that unlike the other
1193 C<guestfs_inspect_get_*> calls which are just returning
1194 data cached in the libguestfs handle, this call actually reads
1195 parts of the mounted filesystems during the call.
1197 This returns an empty list if the inspection code was not able
1198 to determine the list of applications.
1200 The application structure contains the following fields:
1206 The name of the application. For Red Hat-derived and Debian-derived
1207 Linux guests, this is the package name.
1209 =item C<app_display_name>
1211 The display name of the application, sometimes localized to the
1212 install language of the guest operating system.
1214 If unavailable this is returned as an empty string C<\"\">.
1215 Callers needing to display something can use C<app_name> instead.
1219 For package managers which use epochs, this contains the epoch of
1220 the package (an integer). If unavailable, this is returned as C<0>.
1222 =item C<app_version>
1224 The version string of the application or package. If unavailable
1225 this is returned as an empty string C<\"\">.
1227 =item C<app_release>
1229 The release string of the application or package, for package
1230 managers that use this. If unavailable this is returned as an
1231 empty string C<\"\">.
1233 =item C<app_install_path>
1235 The installation path of the application (on operating systems
1236 such as Windows which use installation paths). This path is
1237 in the format used by the guest operating system, it is not
1240 If unavailable this is returned as an empty string C<\"\">.
1242 =item C<app_trans_path>
1244 The install path translated into a libguestfs path.
1245 If unavailable this is returned as an empty string C<\"\">.
1247 =item C<app_publisher>
1249 The name of the publisher of the application, for package
1250 managers that use this. If unavailable this is returned
1251 as an empty string C<\"\">.
1255 The URL (eg. upstream URL) of the application.
1256 If unavailable this is returned as an empty string C<\"\">.
1258 =item C<app_source_package>
1260 For packaging systems which support this, the name of the source
1261 package. If unavailable this is returned as an empty string C<\"\">.
1263 =item C<app_summary>
1265 A short (usually one line) description of the application or package.
1266 If unavailable this is returned as an empty string C<\"\">.
1268 =item C<app_description>
1270 A longer description of the application or package.
1271 If unavailable this is returned as an empty string C<\"\">.
1275 Please read L<guestfs(3)/INSPECTION> for more details.");
1277 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1279 "get hostname of the operating system",
1281 This function should only be called with a root device string
1282 as returned by C<guestfs_inspect_os>.
1284 This function returns the hostname of the operating system
1285 as found by inspection of the guest's configuration files.
1287 If the hostname could not be determined, then the
1288 string C<unknown> is returned.
1290 Please read L<guestfs(3)/INSPECTION> for more details.");
1294 (* daemon_functions are any functions which cause some action
1295 * to take place in the daemon.
1298 let daemon_functions = [
1299 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1300 [InitEmpty, Always, TestOutput (
1301 [["part_disk"; "/dev/sda"; "mbr"];
1302 ["mkfs"; "ext2"; "/dev/sda1"];
1303 ["mount"; "/dev/sda1"; "/"];
1304 ["write"; "/new"; "new file contents"];
1305 ["cat"; "/new"]], "new file contents")],
1306 "mount a guest disk at a position in the filesystem",
1308 Mount a guest disk at a position in the filesystem. Block devices
1309 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1310 the guest. If those block devices contain partitions, they will have
1311 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1314 The rules are the same as for L<mount(2)>: A filesystem must
1315 first be mounted on C</> before others can be mounted. Other
1316 filesystems can only be mounted on directories which already
1319 The mounted filesystem is writable, if we have sufficient permissions
1320 on the underlying device.
1323 When you use this call, the filesystem options C<sync> and C<noatime>
1324 are set implicitly. This was originally done because we thought it
1325 would improve reliability, but it turns out that I<-o sync> has a
1326 very large negative performance impact and negligible effect on
1327 reliability. Therefore we recommend that you avoid using
1328 C<guestfs_mount> in any code that needs performance, and instead
1329 use C<guestfs_mount_options> (use an empty string for the first
1330 parameter if you don't want any options).");
1332 ("sync", (RErr, [], []), 2, [],
1333 [ InitEmpty, Always, TestRun [["sync"]]],
1334 "sync disks, writes are flushed through to the disk image",
1336 This syncs the disk, so that any writes are flushed through to the
1337 underlying disk image.
1339 You should always call this if you have modified a disk image, before
1340 closing the handle.");
1342 ("touch", (RErr, [Pathname "path"], []), 3, [],
1343 [InitScratchFS, Always, TestOutputTrue (
1344 [["touch"; "/touch"];
1345 ["exists"; "/touch"]])],
1346 "update file timestamps or create a new file",
1348 Touch acts like the L<touch(1)> command. It can be used to
1349 update the timestamps on a file, or, if the file does not exist,
1350 to create a new zero-length file.
1352 This command only works on regular files, and will fail on other
1353 file types such as directories, symbolic links, block special etc.");
1355 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1356 [InitISOFS, Always, TestOutput (
1357 [["cat"; "/known-2"]], "abcdef\n")],
1358 "list the contents of a file",
1360 Return the contents of the file named C<path>.
1362 Note that this function cannot correctly handle binary files
1363 (specifically, files containing C<\\0> character which is treated
1364 as end of string). For those you need to use the C<guestfs_read_file>
1365 or C<guestfs_download> functions which have a more complex interface.");
1367 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1368 [], (* XXX Tricky to test because it depends on the exact format
1369 * of the 'ls -l' command, which changes between F10 and F11.
1371 "list the files in a directory (long format)",
1373 List the files in C<directory> (relative to the root directory,
1374 there is no cwd) in the format of 'ls -la'.
1376 This command is mostly useful for interactive sessions. It
1377 is I<not> intended that you try to parse the output string.");
1379 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1380 [InitScratchFS, Always, TestOutputList (
1382 ["touch"; "/ls/new"];
1383 ["touch"; "/ls/newer"];
1384 ["touch"; "/ls/newest"];
1385 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1386 "list the files in a directory",
1388 List the files in C<directory> (relative to the root directory,
1389 there is no cwd). The '.' and '..' entries are not returned, but
1390 hidden files are shown.
1392 This command is mostly useful for interactive sessions. Programs
1393 should probably use C<guestfs_readdir> instead.");
1395 ("list_devices", (RStringList "devices", [], []), 7, [],
1396 [InitEmpty, Always, TestOutputListOfDevices (
1397 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1398 "list the block devices",
1400 List all the block devices.
1402 The full block device names are returned, eg. C</dev/sda>.
1404 See also C<guestfs_list_filesystems>.");
1406 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1407 [InitBasicFS, Always, TestOutputListOfDevices (
1408 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1409 InitEmpty, Always, TestOutputListOfDevices (
1410 [["part_init"; "/dev/sda"; "mbr"];
1411 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1412 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1413 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1414 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1415 "list the partitions",
1417 List all the partitions detected on all block devices.
1419 The full partition device names are returned, eg. C</dev/sda1>
1421 This does not return logical volumes. For that you will need to
1422 call C<guestfs_lvs>.
1424 See also C<guestfs_list_filesystems>.");
1426 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1427 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1428 [["pvs"]], ["/dev/sda1"]);
1429 InitEmpty, Always, TestOutputListOfDevices (
1430 [["part_init"; "/dev/sda"; "mbr"];
1431 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1432 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1433 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1434 ["pvcreate"; "/dev/sda1"];
1435 ["pvcreate"; "/dev/sda2"];
1436 ["pvcreate"; "/dev/sda3"];
1437 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1438 "list the LVM physical volumes (PVs)",
1440 List all the physical volumes detected. This is the equivalent
1441 of the L<pvs(8)> command.
1443 This returns a list of just the device names that contain
1444 PVs (eg. C</dev/sda2>).
1446 See also C<guestfs_pvs_full>.");
1448 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1449 [InitBasicFSonLVM, Always, TestOutputList (
1451 InitEmpty, Always, TestOutputList (
1452 [["part_init"; "/dev/sda"; "mbr"];
1453 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1454 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1455 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1456 ["pvcreate"; "/dev/sda1"];
1457 ["pvcreate"; "/dev/sda2"];
1458 ["pvcreate"; "/dev/sda3"];
1459 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1460 ["vgcreate"; "VG2"; "/dev/sda3"];
1461 ["vgs"]], ["VG1"; "VG2"])],
1462 "list the LVM volume groups (VGs)",
1464 List all the volumes groups detected. This is the equivalent
1465 of the L<vgs(8)> command.
1467 This returns a list of just the volume group names that were
1468 detected (eg. C<VolGroup00>).
1470 See also C<guestfs_vgs_full>.");
1472 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1473 [InitBasicFSonLVM, Always, TestOutputList (
1474 [["lvs"]], ["/dev/VG/LV"]);
1475 InitEmpty, Always, TestOutputList (
1476 [["part_init"; "/dev/sda"; "mbr"];
1477 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1478 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1479 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1480 ["pvcreate"; "/dev/sda1"];
1481 ["pvcreate"; "/dev/sda2"];
1482 ["pvcreate"; "/dev/sda3"];
1483 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1484 ["vgcreate"; "VG2"; "/dev/sda3"];
1485 ["lvcreate"; "LV1"; "VG1"; "50"];
1486 ["lvcreate"; "LV2"; "VG1"; "50"];
1487 ["lvcreate"; "LV3"; "VG2"; "50"];
1488 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1489 "list the LVM logical volumes (LVs)",
1491 List all the logical volumes detected. This is the equivalent
1492 of the L<lvs(8)> command.
1494 This returns a list of the logical volume device names
1495 (eg. C</dev/VolGroup00/LogVol00>).
1497 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1499 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1500 [], (* XXX how to test? *)
1501 "list the LVM physical volumes (PVs)",
1503 List all the physical volumes detected. This is the equivalent
1504 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1506 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1507 [], (* XXX how to test? *)
1508 "list the LVM volume groups (VGs)",
1510 List all the volumes groups detected. This is the equivalent
1511 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1513 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1514 [], (* XXX how to test? *)
1515 "list the LVM logical volumes (LVs)",
1517 List all the logical volumes detected. This is the equivalent
1518 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1520 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1521 [InitISOFS, Always, TestOutputList (
1522 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1523 InitISOFS, Always, TestOutputList (
1524 [["read_lines"; "/empty"]], [])],
1525 "read file as lines",
1527 Return the contents of the file named C<path>.
1529 The file contents are returned as a list of lines. Trailing
1530 C<LF> and C<CRLF> character sequences are I<not> returned.
1532 Note that this function cannot correctly handle binary files
1533 (specifically, files containing C<\\0> character which is treated
1534 as end of line). For those you need to use the C<guestfs_read_file>
1535 function which has a more complex interface.");
1537 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1538 [], (* XXX Augeas code needs tests. *)
1539 "create a new Augeas handle",
1541 Create a new Augeas handle for editing configuration files.
1542 If there was any previous Augeas handle associated with this
1543 guestfs session, then it is closed.
1545 You must call this before using any other C<guestfs_aug_*>
1548 C<root> is the filesystem root. C<root> must not be NULL,
1551 The flags are the same as the flags defined in
1552 E<lt>augeas.hE<gt>, the logical I<or> of the following
1557 =item C<AUG_SAVE_BACKUP> = 1
1559 Keep the original file with a C<.augsave> extension.
1561 =item C<AUG_SAVE_NEWFILE> = 2
1563 Save changes into a file with extension C<.augnew>, and
1564 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1566 =item C<AUG_TYPE_CHECK> = 4
1568 Typecheck lenses (can be expensive).
1570 =item C<AUG_NO_STDINC> = 8
1572 Do not use standard load path for modules.
1574 =item C<AUG_SAVE_NOOP> = 16
1576 Make save a no-op, just record what would have been changed.
1578 =item C<AUG_NO_LOAD> = 32
1580 Do not load the tree in C<guestfs_aug_init>.
1584 To close the handle, you can call C<guestfs_aug_close>.
1586 To find out more about Augeas, see L<http://augeas.net/>.");
1588 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1589 [], (* XXX Augeas code needs tests. *)
1590 "close the current Augeas handle",
1592 Close the current Augeas handle and free up any resources
1593 used by it. After calling this, you have to call
1594 C<guestfs_aug_init> again before you can use any other
1595 Augeas functions.");
1597 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1598 [], (* XXX Augeas code needs tests. *)
1599 "define an Augeas variable",
1601 Defines an Augeas variable C<name> whose value is the result
1602 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1605 On success this returns the number of nodes in C<expr>, or
1606 C<0> if C<expr> evaluates to something which is not a nodeset.");
1608 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1609 [], (* XXX Augeas code needs tests. *)
1610 "define an Augeas node",
1612 Defines a variable C<name> whose value is the result of
1615 If C<expr> evaluates to an empty nodeset, a node is created,
1616 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1617 C<name> will be the nodeset containing that single node.
1619 On success this returns a pair containing the
1620 number of nodes in the nodeset, and a boolean flag
1621 if a node was created.");
1623 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1624 [], (* XXX Augeas code needs tests. *)
1625 "look up the value of an Augeas path",
1627 Look up the value associated with C<path>. If C<path>
1628 matches exactly one node, the C<value> is returned.");
1630 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1631 [], (* XXX Augeas code needs tests. *)
1632 "set Augeas path to value",
1634 Set the value associated with C<path> to C<val>.
1636 In the Augeas API, it is possible to clear a node by setting
1637 the value to NULL. Due to an oversight in the libguestfs API
1638 you cannot do that with this call. Instead you must use the
1639 C<guestfs_aug_clear> call.");
1641 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1642 [], (* XXX Augeas code needs tests. *)
1643 "insert a sibling Augeas node",
1645 Create a new sibling C<label> for C<path>, inserting it into
1646 the tree before or after C<path> (depending on the boolean
1649 C<path> must match exactly one existing node in the tree, and
1650 C<label> must be a label, ie. not contain C</>, C<*> or end
1651 with a bracketed index C<[N]>.");
1653 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1654 [], (* XXX Augeas code needs tests. *)
1655 "remove an Augeas path",
1657 Remove C<path> and all of its children.
1659 On success this returns the number of entries which were removed.");
1661 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1662 [], (* XXX Augeas code needs tests. *)
1665 Move the node C<src> to C<dest>. C<src> must match exactly
1666 one node. C<dest> is overwritten if it exists.");
1668 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1669 [], (* XXX Augeas code needs tests. *)
1670 "return Augeas nodes which match augpath",
1672 Returns a list of paths which match the path expression C<path>.
1673 The returned paths are sufficiently qualified so that they match
1674 exactly one node in the current tree.");
1676 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1677 [], (* XXX Augeas code needs tests. *)
1678 "write all pending Augeas changes to disk",
1680 This writes all pending changes to disk.
1682 The flags which were passed to C<guestfs_aug_init> affect exactly
1683 how files are saved.");
1685 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1686 [], (* XXX Augeas code needs tests. *)
1687 "load files into the tree",
1689 Load files into the tree.
1691 See C<aug_load> in the Augeas documentation for the full gory
1694 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1695 [], (* XXX Augeas code needs tests. *)
1696 "list Augeas nodes under augpath",
1698 This is just a shortcut for listing C<guestfs_aug_match>
1699 C<path/*> and sorting the resulting nodes into alphabetical order.");
1701 ("rm", (RErr, [Pathname "path"], []), 29, [],
1702 [InitScratchFS, Always, TestRun
1704 ["touch"; "/rm/new"];
1706 InitScratchFS, Always, TestLastFail
1707 [["rm"; "/nosuchfile"]];
1708 InitScratchFS, Always, TestLastFail
1713 Remove the single file C<path>.");
1715 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1716 [InitScratchFS, Always, TestRun
1717 [["mkdir"; "/rmdir"];
1718 ["rmdir"; "/rmdir"]];
1719 InitScratchFS, Always, TestLastFail
1720 [["rmdir"; "/rmdir2"]];
1721 InitScratchFS, Always, TestLastFail
1722 [["mkdir"; "/rmdir3"];
1723 ["touch"; "/rmdir3/new"];
1724 ["rmdir"; "/rmdir3/new"]]],
1725 "remove a directory",
1727 Remove the single directory C<path>.");
1729 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1730 [InitScratchFS, Always, TestOutputFalse
1731 [["mkdir"; "/rm_rf"];
1732 ["mkdir"; "/rm_rf/foo"];
1733 ["touch"; "/rm_rf/foo/bar"];
1734 ["rm_rf"; "/rm_rf"];
1735 ["exists"; "/rm_rf"]]],
1736 "remove a file or directory recursively",
1738 Remove the file or directory C<path>, recursively removing the
1739 contents if its a directory. This is like the C<rm -rf> shell
1742 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1743 [InitScratchFS, Always, TestOutputTrue
1744 [["mkdir"; "/mkdir"];
1745 ["is_dir"; "/mkdir"]];
1746 InitScratchFS, Always, TestLastFail
1747 [["mkdir"; "/mkdir2/foo/bar"]]],
1748 "create a directory",
1750 Create a directory named C<path>.");
1752 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1753 [InitScratchFS, Always, TestOutputTrue
1754 [["mkdir_p"; "/mkdir_p/foo/bar"];
1755 ["is_dir"; "/mkdir_p/foo/bar"]];
1756 InitScratchFS, Always, TestOutputTrue
1757 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1758 ["is_dir"; "/mkdir_p2/foo"]];
1759 InitScratchFS, Always, TestOutputTrue
1760 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1761 ["is_dir"; "/mkdir_p3"]];
1762 (* Regression tests for RHBZ#503133: *)
1763 InitScratchFS, Always, TestRun
1764 [["mkdir"; "/mkdir_p4"];
1765 ["mkdir_p"; "/mkdir_p4"]];
1766 InitScratchFS, Always, TestLastFail
1767 [["touch"; "/mkdir_p5"];
1768 ["mkdir_p"; "/mkdir_p5"]]],
1769 "create a directory and parents",
1771 Create a directory named C<path>, creating any parent directories
1772 as necessary. This is like the C<mkdir -p> shell command.");
1774 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1775 [], (* XXX Need stat command to test *)
1778 Change the mode (permissions) of C<path> to C<mode>. Only
1779 numeric modes are supported.
1781 I<Note>: When using this command from guestfish, C<mode>
1782 by default would be decimal, unless you prefix it with
1783 C<0> to get octal, ie. use C<0700> not C<700>.
1785 The mode actually set is affected by the umask.");
1787 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1788 [], (* XXX Need stat command to test *)
1789 "change file owner and group",
1791 Change the file owner to C<owner> and group to C<group>.
1793 Only numeric uid and gid are supported. If you want to use
1794 names, you will need to locate and parse the password file
1795 yourself (Augeas support makes this relatively easy).");
1797 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1798 [InitISOFS, Always, TestOutputTrue (
1799 [["exists"; "/empty"]]);
1800 InitISOFS, Always, TestOutputTrue (
1801 [["exists"; "/directory"]])],
1802 "test if file or directory exists",
1804 This returns C<true> if and only if there is a file, directory
1805 (or anything) with the given C<path> name.
1807 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1809 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1810 [InitISOFS, Always, TestOutputTrue (
1811 [["is_file"; "/known-1"]]);
1812 InitISOFS, Always, TestOutputFalse (
1813 [["is_file"; "/directory"]])],
1814 "test if a regular file",
1816 This returns C<true> if and only if there is a regular file
1817 with the given C<path> name. Note that it returns false for
1818 other objects like directories.
1820 See also C<guestfs_stat>.");
1822 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1823 [InitISOFS, Always, TestOutputFalse (
1824 [["is_dir"; "/known-3"]]);
1825 InitISOFS, Always, TestOutputTrue (
1826 [["is_dir"; "/directory"]])],
1827 "test if a directory",
1829 This returns C<true> if and only if there is a directory
1830 with the given C<path> name. Note that it returns false for
1831 other objects like files.
1833 See also C<guestfs_stat>.");
1835 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1836 [InitEmpty, Always, TestOutputListOfDevices (
1837 [["part_init"; "/dev/sda"; "mbr"];
1838 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1839 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1840 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1841 ["pvcreate"; "/dev/sda1"];
1842 ["pvcreate"; "/dev/sda2"];
1843 ["pvcreate"; "/dev/sda3"];
1844 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1845 "create an LVM physical volume",
1847 This creates an LVM physical volume on the named C<device>,
1848 where C<device> should usually be a partition name such
1851 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1852 [InitEmpty, Always, TestOutputList (
1853 [["part_init"; "/dev/sda"; "mbr"];
1854 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1855 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1856 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1857 ["pvcreate"; "/dev/sda1"];
1858 ["pvcreate"; "/dev/sda2"];
1859 ["pvcreate"; "/dev/sda3"];
1860 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1861 ["vgcreate"; "VG2"; "/dev/sda3"];
1862 ["vgs"]], ["VG1"; "VG2"])],
1863 "create an LVM volume group",
1865 This creates an LVM volume group called C<volgroup>
1866 from the non-empty list of physical volumes C<physvols>.");
1868 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1869 [InitEmpty, Always, TestOutputList (
1870 [["part_init"; "/dev/sda"; "mbr"];
1871 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1872 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1873 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1874 ["pvcreate"; "/dev/sda1"];
1875 ["pvcreate"; "/dev/sda2"];
1876 ["pvcreate"; "/dev/sda3"];
1877 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1878 ["vgcreate"; "VG2"; "/dev/sda3"];
1879 ["lvcreate"; "LV1"; "VG1"; "50"];
1880 ["lvcreate"; "LV2"; "VG1"; "50"];
1881 ["lvcreate"; "LV3"; "VG2"; "50"];
1882 ["lvcreate"; "LV4"; "VG2"; "50"];
1883 ["lvcreate"; "LV5"; "VG2"; "50"];
1885 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1886 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1887 "create an LVM logical volume",
1889 This creates an LVM logical volume called C<logvol>
1890 on the volume group C<volgroup>, with C<size> megabytes.");
1892 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1893 [InitEmpty, Always, TestOutput (
1894 [["part_disk"; "/dev/sda"; "mbr"];
1895 ["mkfs"; "ext2"; "/dev/sda1"];
1896 ["mount_options"; ""; "/dev/sda1"; "/"];
1897 ["write"; "/new"; "new file contents"];
1898 ["cat"; "/new"]], "new file contents")],
1899 "make a filesystem",
1901 This creates a filesystem on C<device> (usually a partition
1902 or LVM logical volume). The filesystem type is C<fstype>, for
1905 ("sfdisk", (RErr, [Device "device";
1906 Int "cyls"; Int "heads"; Int "sectors";
1907 StringList "lines"], []), 43, [DangerWillRobinson],
1909 "create partitions on a block device",
1911 This is a direct interface to the L<sfdisk(8)> program for creating
1912 partitions on block devices.
1914 C<device> should be a block device, for example C</dev/sda>.
1916 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1917 and sectors on the device, which are passed directly to sfdisk as
1918 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1919 of these, then the corresponding parameter is omitted. Usually for
1920 'large' disks, you can just pass C<0> for these, but for small
1921 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1922 out the right geometry and you will need to tell it.
1924 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1925 information refer to the L<sfdisk(8)> manpage.
1927 To create a single partition occupying the whole disk, you would
1928 pass C<lines> as a single element list, when the single element being
1929 the string C<,> (comma).
1931 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1932 C<guestfs_part_init>");
1934 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1935 (* Regression test for RHBZ#597135. *)
1936 [InitScratchFS, Always, TestLastFail
1937 [["write_file"; "/write_file"; "abc"; "10000"]]],
1940 This call creates a file called C<path>. The contents of the
1941 file is the string C<content> (which can contain any 8 bit data),
1942 with length C<size>.
1944 As a special case, if C<size> is C<0>
1945 then the length is calculated using C<strlen> (so in this case
1946 the content cannot contain embedded ASCII NULs).
1948 I<NB.> Owing to a bug, writing content containing ASCII NUL
1949 characters does I<not> work, even if the length is specified.");
1951 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1952 [InitEmpty, Always, TestOutputListOfDevices (
1953 [["part_disk"; "/dev/sda"; "mbr"];
1954 ["mkfs"; "ext2"; "/dev/sda1"];
1955 ["mount_options"; ""; "/dev/sda1"; "/"];
1956 ["mounts"]], ["/dev/sda1"]);
1957 InitEmpty, Always, TestOutputList (
1958 [["part_disk"; "/dev/sda"; "mbr"];
1959 ["mkfs"; "ext2"; "/dev/sda1"];
1960 ["mount_options"; ""; "/dev/sda1"; "/"];
1963 "unmount a filesystem",
1965 This unmounts the given filesystem. The filesystem may be
1966 specified either by its mountpoint (path) or the device which
1967 contains the filesystem.");
1969 ("mounts", (RStringList "devices", [], []), 46, [],
1970 [InitScratchFS, Always, TestOutputListOfDevices (
1971 [["mounts"]], ["/dev/sdb1"])],
1972 "show mounted filesystems",
1974 This returns the list of currently mounted filesystems. It returns
1975 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1977 Some internal mounts are not shown.
1979 See also: C<guestfs_mountpoints>");
1981 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1982 [InitScratchFS, Always, TestOutputList (
1985 (* check that umount_all can unmount nested mounts correctly: *)
1986 InitEmpty, Always, TestOutputList (
1987 [["part_init"; "/dev/sda"; "mbr"];
1988 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1989 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1990 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1991 ["mkfs"; "ext2"; "/dev/sda1"];
1992 ["mkfs"; "ext2"; "/dev/sda2"];
1993 ["mkfs"; "ext2"; "/dev/sda3"];
1994 ["mount_options"; ""; "/dev/sda1"; "/"];
1996 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1997 ["mkdir"; "/mp1/mp2"];
1998 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1999 ["mkdir"; "/mp1/mp2/mp3"];
2002 "unmount all filesystems",
2004 This unmounts all mounted filesystems.
2006 Some internal mounts are not unmounted by this call.");
2008 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2010 "remove all LVM LVs, VGs and PVs",
2012 This command removes all LVM logical volumes, volume groups
2013 and physical volumes.");
2015 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2016 [InitISOFS, Always, TestOutput (
2017 [["file"; "/empty"]], "empty");
2018 InitISOFS, Always, TestOutput (
2019 [["file"; "/known-1"]], "ASCII text");
2020 InitISOFS, Always, TestLastFail (
2021 [["file"; "/notexists"]]);
2022 InitISOFS, Always, TestOutput (
2023 [["file"; "/abssymlink"]], "symbolic link");
2024 InitISOFS, Always, TestOutput (
2025 [["file"; "/directory"]], "directory")],
2026 "determine file type",
2028 This call uses the standard L<file(1)> command to determine
2029 the type or contents of the file.
2031 This call will also transparently look inside various types
2034 The exact command which runs is C<file -zb path>. Note in
2035 particular that the filename is not prepended to the output
2038 This command can also be used on C</dev/> devices
2039 (and partitions, LV names). You can for example use this
2040 to determine if a device contains a filesystem, although
2041 it's usually better to use C<guestfs_vfs_type>.
2043 If the C<path> does not begin with C</dev/> then
2044 this command only works for the content of regular files.
2045 For other file types (directory, symbolic link etc) it
2046 will just return the string C<directory> etc.");
2048 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2049 [InitScratchFS, Always, TestOutput (
2050 [["mkdir"; "/command"];
2051 ["upload"; "test-command"; "/command/test-command"];
2052 ["chmod"; "0o755"; "/command/test-command"];
2053 ["command"; "/command/test-command 1"]], "Result1");
2054 InitScratchFS, Always, TestOutput (
2055 [["mkdir"; "/command2"];
2056 ["upload"; "test-command"; "/command2/test-command"];
2057 ["chmod"; "0o755"; "/command2/test-command"];
2058 ["command"; "/command2/test-command 2"]], "Result2\n");
2059 InitScratchFS, Always, TestOutput (
2060 [["mkdir"; "/command3"];
2061 ["upload"; "test-command"; "/command3/test-command"];
2062 ["chmod"; "0o755"; "/command3/test-command"];
2063 ["command"; "/command3/test-command 3"]], "\nResult3");
2064 InitScratchFS, Always, TestOutput (
2065 [["mkdir"; "/command4"];
2066 ["upload"; "test-command"; "/command4/test-command"];
2067 ["chmod"; "0o755"; "/command4/test-command"];
2068 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2069 InitScratchFS, Always, TestOutput (
2070 [["mkdir"; "/command5"];
2071 ["upload"; "test-command"; "/command5/test-command"];
2072 ["chmod"; "0o755"; "/command5/test-command"];
2073 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2074 InitScratchFS, Always, TestOutput (
2075 [["mkdir"; "/command6"];
2076 ["upload"; "test-command"; "/command6/test-command"];
2077 ["chmod"; "0o755"; "/command6/test-command"];
2078 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2079 InitScratchFS, Always, TestOutput (
2080 [["mkdir"; "/command7"];
2081 ["upload"; "test-command"; "/command7/test-command"];
2082 ["chmod"; "0o755"; "/command7/test-command"];
2083 ["command"; "/command7/test-command 7"]], "");
2084 InitScratchFS, Always, TestOutput (
2085 [["mkdir"; "/command8"];
2086 ["upload"; "test-command"; "/command8/test-command"];
2087 ["chmod"; "0o755"; "/command8/test-command"];
2088 ["command"; "/command8/test-command 8"]], "\n");
2089 InitScratchFS, Always, TestOutput (
2090 [["mkdir"; "/command9"];
2091 ["upload"; "test-command"; "/command9/test-command"];
2092 ["chmod"; "0o755"; "/command9/test-command"];
2093 ["command"; "/command9/test-command 9"]], "\n\n");
2094 InitScratchFS, Always, TestOutput (
2095 [["mkdir"; "/command10"];
2096 ["upload"; "test-command"; "/command10/test-command"];
2097 ["chmod"; "0o755"; "/command10/test-command"];
2098 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2099 InitScratchFS, Always, TestOutput (
2100 [["mkdir"; "/command11"];
2101 ["upload"; "test-command"; "/command11/test-command"];
2102 ["chmod"; "0o755"; "/command11/test-command"];
2103 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2104 InitScratchFS, Always, TestLastFail (
2105 [["mkdir"; "/command12"];
2106 ["upload"; "test-command"; "/command12/test-command"];
2107 ["chmod"; "0o755"; "/command12/test-command"];
2108 ["command"; "/command12/test-command"]])],
2109 "run a command from the guest filesystem",
2111 This call runs a command from the guest filesystem. The
2112 filesystem must be mounted, and must contain a compatible
2113 operating system (ie. something Linux, with the same
2114 or compatible processor architecture).
2116 The single parameter is an argv-style list of arguments.
2117 The first element is the name of the program to run.
2118 Subsequent elements are parameters. The list must be
2119 non-empty (ie. must contain a program name). Note that
2120 the command runs directly, and is I<not> invoked via
2121 the shell (see C<guestfs_sh>).
2123 The return value is anything printed to I<stdout> by
2126 If the command returns a non-zero exit status, then
2127 this function returns an error message. The error message
2128 string is the content of I<stderr> from the command.
2130 The C<$PATH> environment variable will contain at least
2131 C</usr/bin> and C</bin>. If you require a program from
2132 another location, you should provide the full path in the
2135 Shared libraries and data files required by the program
2136 must be available on filesystems which are mounted in the
2137 correct places. It is the caller's responsibility to ensure
2138 all filesystems that are needed are mounted at the right
2141 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2142 [InitScratchFS, Always, TestOutputList (
2143 [["mkdir"; "/command_lines"];
2144 ["upload"; "test-command"; "/command_lines/test-command"];
2145 ["chmod"; "0o755"; "/command_lines/test-command"];
2146 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2147 InitScratchFS, Always, TestOutputList (
2148 [["mkdir"; "/command_lines2"];
2149 ["upload"; "test-command"; "/command_lines2/test-command"];
2150 ["chmod"; "0o755"; "/command_lines2/test-command"];
2151 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2152 InitScratchFS, Always, TestOutputList (
2153 [["mkdir"; "/command_lines3"];
2154 ["upload"; "test-command"; "/command_lines3/test-command"];
2155 ["chmod"; "0o755"; "/command_lines3/test-command"];
2156 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2157 InitScratchFS, Always, TestOutputList (
2158 [["mkdir"; "/command_lines4"];
2159 ["upload"; "test-command"; "/command_lines4/test-command"];
2160 ["chmod"; "0o755"; "/command_lines4/test-command"];
2161 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2162 InitScratchFS, Always, TestOutputList (
2163 [["mkdir"; "/command_lines5"];
2164 ["upload"; "test-command"; "/command_lines5/test-command"];
2165 ["chmod"; "0o755"; "/command_lines5/test-command"];
2166 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2167 InitScratchFS, Always, TestOutputList (
2168 [["mkdir"; "/command_lines6"];
2169 ["upload"; "test-command"; "/command_lines6/test-command"];
2170 ["chmod"; "0o755"; "/command_lines6/test-command"];
2171 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2172 InitScratchFS, Always, TestOutputList (
2173 [["mkdir"; "/command_lines7"];
2174 ["upload"; "test-command"; "/command_lines7/test-command"];
2175 ["chmod"; "0o755"; "/command_lines7/test-command"];
2176 ["command_lines"; "/command_lines7/test-command 7"]], []);
2177 InitScratchFS, Always, TestOutputList (
2178 [["mkdir"; "/command_lines8"];
2179 ["upload"; "test-command"; "/command_lines8/test-command"];
2180 ["chmod"; "0o755"; "/command_lines8/test-command"];
2181 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2182 InitScratchFS, Always, TestOutputList (
2183 [["mkdir"; "/command_lines9"];
2184 ["upload"; "test-command"; "/command_lines9/test-command"];
2185 ["chmod"; "0o755"; "/command_lines9/test-command"];
2186 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2187 InitScratchFS, Always, TestOutputList (
2188 [["mkdir"; "/command_lines10"];
2189 ["upload"; "test-command"; "/command_lines10/test-command"];
2190 ["chmod"; "0o755"; "/command_lines10/test-command"];
2191 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2192 InitScratchFS, Always, TestOutputList (
2193 [["mkdir"; "/command_lines11"];
2194 ["upload"; "test-command"; "/command_lines11/test-command"];
2195 ["chmod"; "0o755"; "/command_lines11/test-command"];
2196 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2197 "run a command, returning lines",
2199 This is the same as C<guestfs_command>, but splits the
2200 result into a list of lines.
2202 See also: C<guestfs_sh_lines>");
2204 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2205 [InitISOFS, Always, TestOutputStruct (
2206 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2207 "get file information",
2209 Returns file information for the given C<path>.
2211 This is the same as the C<stat(2)> system call.");
2213 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2214 [InitISOFS, Always, TestOutputStruct (
2215 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2216 "get file information for a symbolic link",
2218 Returns file information for the given C<path>.
2220 This is the same as C<guestfs_stat> except that if C<path>
2221 is a symbolic link, then the link is stat-ed, not the file it
2224 This is the same as the C<lstat(2)> system call.");
2226 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2227 [InitISOFS, Always, TestOutputStruct (
2228 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2229 "get file system statistics",
2231 Returns file system statistics for any mounted file system.
2232 C<path> should be a file or directory in the mounted file system
2233 (typically it is the mount point itself, but it doesn't need to be).
2235 This is the same as the C<statvfs(2)> system call.");
2237 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2239 "get ext2/ext3/ext4 superblock details",
2241 This returns the contents of the ext2, ext3 or ext4 filesystem
2242 superblock on C<device>.
2244 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2245 manpage for more details. The list of fields returned isn't
2246 clearly defined, and depends on both the version of C<tune2fs>
2247 that libguestfs was built against, and the filesystem itself.");
2249 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2250 [InitEmpty, Always, TestOutputTrue (
2251 [["blockdev_setro"; "/dev/sda"];
2252 ["blockdev_getro"; "/dev/sda"]])],
2253 "set block device to read-only",
2255 Sets the block device named C<device> to read-only.
2257 This uses the L<blockdev(8)> command.");
2259 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2260 [InitEmpty, Always, TestOutputFalse (
2261 [["blockdev_setrw"; "/dev/sda"];
2262 ["blockdev_getro"; "/dev/sda"]])],
2263 "set block device to read-write",
2265 Sets the block device named C<device> to read-write.
2267 This uses the L<blockdev(8)> command.");
2269 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2270 [InitEmpty, Always, TestOutputTrue (
2271 [["blockdev_setro"; "/dev/sda"];
2272 ["blockdev_getro"; "/dev/sda"]])],
2273 "is block device set to read-only",
2275 Returns a boolean indicating if the block device is read-only
2276 (true if read-only, false if not).
2278 This uses the L<blockdev(8)> command.");
2280 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2281 [InitEmpty, Always, TestOutputInt (
2282 [["blockdev_getss"; "/dev/sda"]], 512)],
2283 "get sectorsize of block device",
2285 This returns the size of sectors on a block device.
2286 Usually 512, but can be larger for modern devices.
2288 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2291 This uses the L<blockdev(8)> command.");
2293 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2294 [InitEmpty, Always, TestOutputInt (
2295 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2296 "get blocksize of block device",
2298 This returns the block size of a device.
2300 (Note this is different from both I<size in blocks> and
2301 I<filesystem block size>).
2303 This uses the L<blockdev(8)> command.");
2305 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2307 "set blocksize of block device",
2309 This sets the block size of a device.
2311 (Note this is different from both I<size in blocks> and
2312 I<filesystem block size>).
2314 This uses the L<blockdev(8)> command.");
2316 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2317 [InitEmpty, Always, TestOutputInt (
2318 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2319 "get total size of device in 512-byte sectors",
2321 This returns the size of the device in units of 512-byte sectors
2322 (even if the sectorsize isn't 512 bytes ... weird).
2324 See also C<guestfs_blockdev_getss> for the real sector size of
2325 the device, and C<guestfs_blockdev_getsize64> for the more
2326 useful I<size in bytes>.
2328 This uses the L<blockdev(8)> command.");
2330 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2331 [InitEmpty, Always, TestOutputInt (
2332 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2333 "get total size of device in bytes",
2335 This returns the size of the device in bytes.
2337 See also C<guestfs_blockdev_getsz>.
2339 This uses the L<blockdev(8)> command.");
2341 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2342 [InitEmpty, Always, TestRun
2343 [["blockdev_flushbufs"; "/dev/sda"]]],
2344 "flush device buffers",
2346 This tells the kernel to flush internal buffers associated
2349 This uses the L<blockdev(8)> command.");
2351 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2352 [InitEmpty, Always, TestRun
2353 [["blockdev_rereadpt"; "/dev/sda"]]],
2354 "reread partition table",
2356 Reread the partition table on C<device>.
2358 This uses the L<blockdev(8)> command.");
2360 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2361 [InitScratchFS, Always, TestOutput (
2362 (* Pick a file from cwd which isn't likely to change. *)
2363 [["mkdir"; "/upload"];
2364 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2365 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2366 Digest.to_hex (Digest.file "COPYING.LIB"))],
2367 "upload a file from the local machine",
2369 Upload local file C<filename> to C<remotefilename> on the
2372 C<filename> can also be a named pipe.
2374 See also C<guestfs_download>.");
2376 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2377 [InitScratchFS, Always, TestOutput (
2378 (* Pick a file from cwd which isn't likely to change. *)
2379 [["mkdir"; "/download"];
2380 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2381 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2382 ["upload"; "testdownload.tmp"; "/download/upload"];
2383 ["checksum"; "md5"; "/download/upload"]],
2384 Digest.to_hex (Digest.file "COPYING.LIB"))],
2385 "download a file to the local machine",
2387 Download file C<remotefilename> and save it as C<filename>
2388 on the local machine.
2390 C<filename> can also be a named pipe.
2392 See also C<guestfs_upload>, C<guestfs_cat>.");
2394 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2395 [InitISOFS, Always, TestOutput (
2396 [["checksum"; "crc"; "/known-3"]], "2891671662");
2397 InitISOFS, Always, TestLastFail (
2398 [["checksum"; "crc"; "/notexists"]]);
2399 InitISOFS, Always, TestOutput (
2400 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2401 InitISOFS, Always, TestOutput (
2402 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2403 InitISOFS, Always, TestOutput (
2404 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2405 InitISOFS, Always, TestOutput (
2406 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2407 InitISOFS, Always, TestOutput (
2408 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2409 InitISOFS, Always, TestOutput (
2410 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2411 (* Test for RHBZ#579608, absolute symbolic links. *)
2412 InitISOFS, Always, TestOutput (
2413 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2414 "compute MD5, SHAx or CRC checksum of file",
2416 This call computes the MD5, SHAx or CRC checksum of the
2419 The type of checksum to compute is given by the C<csumtype>
2420 parameter which must have one of the following values:
2426 Compute the cyclic redundancy check (CRC) specified by POSIX
2427 for the C<cksum> command.
2431 Compute the MD5 hash (using the C<md5sum> program).
2435 Compute the SHA1 hash (using the C<sha1sum> program).
2439 Compute the SHA224 hash (using the C<sha224sum> program).
2443 Compute the SHA256 hash (using the C<sha256sum> program).
2447 Compute the SHA384 hash (using the C<sha384sum> program).
2451 Compute the SHA512 hash (using the C<sha512sum> program).
2455 The checksum is returned as a printable string.
2457 To get the checksum for a device, use C<guestfs_checksum_device>.
2459 To get the checksums for many files, use C<guestfs_checksums_out>.");
2461 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2462 [InitScratchFS, Always, TestOutput (
2463 [["mkdir"; "/tar_in"];
2464 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2465 ["cat"; "/tar_in/hello"]], "hello\n")],
2466 "unpack tarfile to directory",
2468 This command uploads and unpacks local file C<tarfile> (an
2469 I<uncompressed> tar file) into C<directory>.
2471 To upload a compressed tarball, use C<guestfs_tgz_in>
2472 or C<guestfs_txz_in>.");
2474 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2476 "pack directory into tarfile",
2478 This command packs the contents of C<directory> and downloads
2479 it to local file C<tarfile>.
2481 To download a compressed tarball, use C<guestfs_tgz_out>
2482 or C<guestfs_txz_out>.");
2484 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2485 [InitScratchFS, Always, TestOutput (
2486 [["mkdir"; "/tgz_in"];
2487 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2488 ["cat"; "/tgz_in/hello"]], "hello\n")],
2489 "unpack compressed tarball to directory",
2491 This command uploads and unpacks local file C<tarball> (a
2492 I<gzip compressed> tar file) into C<directory>.
2494 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2496 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2498 "pack directory into compressed tarball",
2500 This command packs the contents of C<directory> and downloads
2501 it to local file C<tarball>.
2503 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2505 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2506 [InitBasicFS, Always, TestLastFail (
2508 ["mount_ro"; "/dev/sda1"; "/"];
2509 ["touch"; "/new"]]);
2510 InitBasicFS, Always, TestOutput (
2511 [["write"; "/new"; "data"];
2513 ["mount_ro"; "/dev/sda1"; "/"];
2514 ["cat"; "/new"]], "data")],
2515 "mount a guest disk, read-only",
2517 This is the same as the C<guestfs_mount> command, but it
2518 mounts the filesystem with the read-only (I<-o ro>) flag.");
2520 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2522 "mount a guest disk with mount options",
2524 This is the same as the C<guestfs_mount> command, but it
2525 allows you to set the mount options as for the
2526 L<mount(8)> I<-o> flag.
2528 If the C<options> parameter is an empty string, then
2529 no options are passed (all options default to whatever
2530 the filesystem uses).");
2532 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2534 "mount a guest disk with mount options and vfstype",
2536 This is the same as the C<guestfs_mount> command, but it
2537 allows you to set both the mount options and the vfstype
2538 as for the L<mount(8)> I<-o> and I<-t> flags.");
2540 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2542 "debugging and internals",
2544 The C<guestfs_debug> command exposes some internals of
2545 C<guestfsd> (the guestfs daemon) that runs inside the
2548 There is no comprehensive help for this command. You have
2549 to look at the file C<daemon/debug.c> in the libguestfs source
2550 to find out what you can do.");
2552 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2553 [InitEmpty, Always, TestOutputList (
2554 [["part_disk"; "/dev/sda"; "mbr"];
2555 ["pvcreate"; "/dev/sda1"];
2556 ["vgcreate"; "VG"; "/dev/sda1"];
2557 ["lvcreate"; "LV1"; "VG"; "50"];
2558 ["lvcreate"; "LV2"; "VG"; "50"];
2559 ["lvremove"; "/dev/VG/LV1"];
2560 ["lvs"]], ["/dev/VG/LV2"]);
2561 InitEmpty, Always, TestOutputList (
2562 [["part_disk"; "/dev/sda"; "mbr"];
2563 ["pvcreate"; "/dev/sda1"];
2564 ["vgcreate"; "VG"; "/dev/sda1"];
2565 ["lvcreate"; "LV1"; "VG"; "50"];
2566 ["lvcreate"; "LV2"; "VG"; "50"];
2567 ["lvremove"; "/dev/VG"];
2569 InitEmpty, Always, TestOutputList (
2570 [["part_disk"; "/dev/sda"; "mbr"];
2571 ["pvcreate"; "/dev/sda1"];
2572 ["vgcreate"; "VG"; "/dev/sda1"];
2573 ["lvcreate"; "LV1"; "VG"; "50"];
2574 ["lvcreate"; "LV2"; "VG"; "50"];
2575 ["lvremove"; "/dev/VG"];
2577 "remove an LVM logical volume",
2579 Remove an LVM logical volume C<device>, where C<device> is
2580 the path to the LV, such as C</dev/VG/LV>.
2582 You can also remove all LVs in a volume group by specifying
2583 the VG name, C</dev/VG>.");
2585 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2586 [InitEmpty, Always, TestOutputList (
2587 [["part_disk"; "/dev/sda"; "mbr"];
2588 ["pvcreate"; "/dev/sda1"];
2589 ["vgcreate"; "VG"; "/dev/sda1"];
2590 ["lvcreate"; "LV1"; "VG"; "50"];
2591 ["lvcreate"; "LV2"; "VG"; "50"];
2594 InitEmpty, Always, TestOutputList (
2595 [["part_disk"; "/dev/sda"; "mbr"];
2596 ["pvcreate"; "/dev/sda1"];
2597 ["vgcreate"; "VG"; "/dev/sda1"];
2598 ["lvcreate"; "LV1"; "VG"; "50"];
2599 ["lvcreate"; "LV2"; "VG"; "50"];
2602 "remove an LVM volume group",
2604 Remove an LVM volume group C<vgname>, (for example C<VG>).
2606 This also forcibly removes all logical volumes in the volume
2609 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2610 [InitEmpty, Always, TestOutputListOfDevices (
2611 [["part_disk"; "/dev/sda"; "mbr"];
2612 ["pvcreate"; "/dev/sda1"];
2613 ["vgcreate"; "VG"; "/dev/sda1"];
2614 ["lvcreate"; "LV1"; "VG"; "50"];
2615 ["lvcreate"; "LV2"; "VG"; "50"];
2617 ["pvremove"; "/dev/sda1"];
2619 InitEmpty, Always, TestOutputListOfDevices (
2620 [["part_disk"; "/dev/sda"; "mbr"];
2621 ["pvcreate"; "/dev/sda1"];
2622 ["vgcreate"; "VG"; "/dev/sda1"];
2623 ["lvcreate"; "LV1"; "VG"; "50"];
2624 ["lvcreate"; "LV2"; "VG"; "50"];
2626 ["pvremove"; "/dev/sda1"];
2628 InitEmpty, Always, TestOutputListOfDevices (
2629 [["part_disk"; "/dev/sda"; "mbr"];
2630 ["pvcreate"; "/dev/sda1"];
2631 ["vgcreate"; "VG"; "/dev/sda1"];
2632 ["lvcreate"; "LV1"; "VG"; "50"];
2633 ["lvcreate"; "LV2"; "VG"; "50"];
2635 ["pvremove"; "/dev/sda1"];
2637 "remove an LVM physical volume",
2639 This wipes a physical volume C<device> so that LVM will no longer
2642 The implementation uses the C<pvremove> command which refuses to
2643 wipe physical volumes that contain any volume groups, so you have
2644 to remove those first.");
2646 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2647 [InitBasicFS, Always, TestOutput (
2648 [["set_e2label"; "/dev/sda1"; "testlabel"];
2649 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2650 "set the ext2/3/4 filesystem label",
2652 This sets the ext2/3/4 filesystem label of the filesystem on
2653 C<device> to C<label>. Filesystem labels are limited to
2656 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2657 to return the existing label on a filesystem.");
2659 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2661 "get the ext2/3/4 filesystem label",
2663 This returns the ext2/3/4 filesystem label of the filesystem on
2666 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2667 (let uuid = uuidgen () in
2668 [InitBasicFS, Always, TestOutput (
2669 [["set_e2uuid"; "/dev/sda1"; uuid];
2670 ["get_e2uuid"; "/dev/sda1"]], uuid);
2671 InitBasicFS, Always, TestOutput (
2672 [["set_e2uuid"; "/dev/sda1"; "clear"];
2673 ["get_e2uuid"; "/dev/sda1"]], "");
2674 (* We can't predict what UUIDs will be, so just check the commands run. *)
2675 InitBasicFS, Always, TestRun (
2676 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2677 InitBasicFS, Always, TestRun (
2678 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2679 "set the ext2/3/4 filesystem UUID",
2681 This sets the ext2/3/4 filesystem UUID of the filesystem on
2682 C<device> to C<uuid>. The format of the UUID and alternatives
2683 such as C<clear>, C<random> and C<time> are described in the
2684 L<tune2fs(8)> manpage.
2686 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2687 to return the existing UUID of a filesystem.");
2689 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2690 (* Regression test for RHBZ#597112. *)
2691 (let uuid = uuidgen () in
2692 [InitNone, Always, TestOutput (
2693 [["mke2journal"; "1024"; "/dev/sdc"];
2694 ["set_e2uuid"; "/dev/sdc"; uuid];
2695 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2696 "get the ext2/3/4 filesystem UUID",
2698 This returns the ext2/3/4 filesystem UUID of the filesystem on
2701 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2702 [InitBasicFS, Always, TestOutputInt (
2703 [["umount"; "/dev/sda1"];
2704 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2705 InitBasicFS, Always, TestOutputInt (
2706 [["umount"; "/dev/sda1"];
2707 ["zero"; "/dev/sda1"];
2708 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2709 "run the filesystem checker",
2711 This runs the filesystem checker (fsck) on C<device> which
2712 should have filesystem type C<fstype>.
2714 The returned integer is the status. See L<fsck(8)> for the
2715 list of status codes from C<fsck>.
2723 Multiple status codes can be summed together.
2727 A non-zero return code can mean \"success\", for example if
2728 errors have been corrected on the filesystem.
2732 Checking or repairing NTFS volumes is not supported
2737 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2739 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2740 [InitBasicFS, Always, TestOutput (
2741 [["umount"; "/dev/sda1"];
2742 ["zero"; "/dev/sda1"];
2743 ["file"; "/dev/sda1"]], "data")],
2744 "write zeroes to the device",
2746 This command writes zeroes over the first few blocks of C<device>.
2748 How many blocks are zeroed isn't specified (but it's I<not> enough
2749 to securely wipe the device). It should be sufficient to remove
2750 any partition tables, filesystem superblocks and so on.
2752 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2754 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2756 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2757 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2759 [InitBasicFS, Always, TestOutputTrue (
2760 [["mkdir_p"; "/boot/grub"];
2761 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2762 ["grub_install"; "/"; "/dev/vda"];
2763 ["is_dir"; "/boot"]])],
2766 This command installs GRUB (the Grand Unified Bootloader) on
2767 C<device>, with the root directory being C<root>.
2769 Note: If grub-install reports the error
2770 \"No suitable drive was found in the generated device map.\"
2771 it may be that you need to create a C</boot/grub/device.map>
2772 file first that contains the mapping between grub device names
2773 and Linux device names. It is usually sufficient to create
2778 replacing C</dev/vda> with the name of the installation device.");
2780 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2781 [InitScratchFS, Always, TestOutput (
2783 ["write"; "/cp/old"; "file content"];
2784 ["cp"; "/cp/old"; "/cp/new"];
2785 ["cat"; "/cp/new"]], "file content");
2786 InitScratchFS, Always, TestOutputTrue (
2788 ["write"; "/cp2/old"; "file content"];
2789 ["cp"; "/cp2/old"; "/cp2/new"];
2790 ["is_file"; "/cp2/old"]]);
2791 InitScratchFS, Always, TestOutput (
2793 ["write"; "/cp3/old"; "file content"];
2794 ["mkdir"; "/cp3/dir"];
2795 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2796 ["cat"; "/cp3/dir/new"]], "file content")],
2799 This copies a file from C<src> to C<dest> where C<dest> is
2800 either a destination filename or destination directory.");
2802 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2803 [InitScratchFS, Always, TestOutput (
2804 [["mkdir"; "/cp_a1"];
2805 ["mkdir"; "/cp_a2"];
2806 ["write"; "/cp_a1/file"; "file content"];
2807 ["cp_a"; "/cp_a1"; "/cp_a2"];
2808 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2809 "copy a file or directory recursively",
2811 This copies a file or directory from C<src> to C<dest>
2812 recursively using the C<cp -a> command.");
2814 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2815 [InitScratchFS, Always, TestOutput (
2817 ["write"; "/mv/old"; "file content"];
2818 ["mv"; "/mv/old"; "/mv/new"];
2819 ["cat"; "/mv/new"]], "file content");
2820 InitScratchFS, Always, TestOutputFalse (
2822 ["write"; "/mv2/old"; "file content"];
2823 ["mv"; "/mv2/old"; "/mv2/new"];
2824 ["is_file"; "/mv2/old"]])],
2827 This moves a file from C<src> to C<dest> where C<dest> is
2828 either a destination filename or destination directory.");
2830 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2831 [InitEmpty, Always, TestRun (
2832 [["drop_caches"; "3"]])],
2833 "drop kernel page cache, dentries and inodes",
2835 This instructs the guest kernel to drop its page cache,
2836 and/or dentries and inode caches. The parameter C<whattodrop>
2837 tells the kernel what precisely to drop, see
2838 L<http://linux-mm.org/Drop_Caches>
2840 Setting C<whattodrop> to 3 should drop everything.
2842 This automatically calls L<sync(2)> before the operation,
2843 so that the maximum guest memory is freed.");
2845 ("dmesg", (RString "kmsgs", [], []), 91, [],
2846 [InitEmpty, Always, TestRun (
2848 "return kernel messages",
2850 This returns the kernel messages (C<dmesg> output) from
2851 the guest kernel. This is sometimes useful for extended
2852 debugging of problems.
2854 Another way to get the same information is to enable
2855 verbose messages with C<guestfs_set_verbose> or by setting
2856 the environment variable C<LIBGUESTFS_DEBUG=1> before
2857 running the program.");
2859 ("ping_daemon", (RErr, [], []), 92, [],
2860 [InitEmpty, Always, TestRun (
2861 [["ping_daemon"]])],
2862 "ping the guest daemon",
2864 This is a test probe into the guestfs daemon running inside
2865 the qemu subprocess. Calling this function checks that the
2866 daemon responds to the ping message, without affecting the daemon
2867 or attached block device(s) in any other way.");
2869 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2870 [InitScratchFS, Always, TestOutputTrue (
2871 [["mkdir"; "/equal"];
2872 ["write"; "/equal/file1"; "contents of a file"];
2873 ["cp"; "/equal/file1"; "/equal/file2"];
2874 ["equal"; "/equal/file1"; "/equal/file2"]]);
2875 InitScratchFS, Always, TestOutputFalse (
2876 [["mkdir"; "/equal2"];
2877 ["write"; "/equal2/file1"; "contents of a file"];
2878 ["write"; "/equal2/file2"; "contents of another file"];
2879 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
2880 InitScratchFS, Always, TestLastFail (
2881 [["mkdir"; "/equal3"];
2882 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
2883 "test if two files have equal contents",
2885 This compares the two files C<file1> and C<file2> and returns
2886 true if their content is exactly equal, or false otherwise.
2888 The external L<cmp(1)> program is used for the comparison.");
2890 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2891 [InitISOFS, Always, TestOutputList (
2892 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2893 InitISOFS, Always, TestOutputList (
2894 [["strings"; "/empty"]], []);
2895 (* Test for RHBZ#579608, absolute symbolic links. *)
2896 InitISOFS, Always, TestRun (
2897 [["strings"; "/abssymlink"]])],
2898 "print the printable strings in a file",
2900 This runs the L<strings(1)> command on a file and returns
2901 the list of printable strings found.");
2903 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2904 [InitISOFS, Always, TestOutputList (
2905 [["strings_e"; "b"; "/known-5"]], []);
2906 InitScratchFS, Always, TestOutputList (
2907 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2908 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
2909 "print the printable strings in a file",
2911 This is like the C<guestfs_strings> command, but allows you to
2912 specify the encoding of strings that are looked for in
2913 the source file C<path>.
2915 Allowed encodings are:
2921 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2922 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2926 Single 8-bit-byte characters.
2930 16-bit big endian strings such as those encoded in
2931 UTF-16BE or UCS-2BE.
2933 =item l (lower case letter L)
2935 16-bit little endian such as UTF-16LE and UCS-2LE.
2936 This is useful for examining binaries in Windows guests.
2940 32-bit big endian such as UCS-4BE.
2944 32-bit little endian such as UCS-4LE.
2948 The returned strings are transcoded to UTF-8.");
2950 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2951 [InitISOFS, Always, TestOutput (
2952 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2953 (* Test for RHBZ#501888c2 regression which caused large hexdump
2954 * commands to segfault.
2956 InitISOFS, Always, TestRun (
2957 [["hexdump"; "/100krandom"]]);
2958 (* Test for RHBZ#579608, absolute symbolic links. *)
2959 InitISOFS, Always, TestRun (
2960 [["hexdump"; "/abssymlink"]])],
2961 "dump a file in hexadecimal",
2963 This runs C<hexdump -C> on the given C<path>. The result is
2964 the human-readable, canonical hex dump of the file.");
2966 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2967 [InitNone, Always, TestOutput (
2968 [["part_disk"; "/dev/sda"; "mbr"];
2969 ["mkfs"; "ext3"; "/dev/sda1"];
2970 ["mount_options"; ""; "/dev/sda1"; "/"];
2971 ["write"; "/new"; "test file"];
2972 ["umount"; "/dev/sda1"];
2973 ["zerofree"; "/dev/sda1"];
2974 ["mount_options"; ""; "/dev/sda1"; "/"];
2975 ["cat"; "/new"]], "test file")],
2976 "zero unused inodes and disk blocks on ext2/3 filesystem",
2978 This runs the I<zerofree> program on C<device>. This program
2979 claims to zero unused inodes and disk blocks on an ext2/3
2980 filesystem, thus making it possible to compress the filesystem
2983 You should B<not> run this program if the filesystem is
2986 It is possible that using this program can damage the filesystem
2987 or data on the filesystem.");
2989 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2991 "resize an LVM physical volume",
2993 This resizes (expands or shrinks) an existing LVM physical
2994 volume to match the new size of the underlying device.");
2996 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2997 Int "cyls"; Int "heads"; Int "sectors";
2998 String "line"], []), 99, [DangerWillRobinson],
3000 "modify a single partition on a block device",
3002 This runs L<sfdisk(8)> option to modify just the single
3003 partition C<n> (note: C<n> counts from 1).
3005 For other parameters, see C<guestfs_sfdisk>. You should usually
3006 pass C<0> for the cyls/heads/sectors parameters.
3008 See also: C<guestfs_part_add>");
3010 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3012 "display the partition table",
3014 This displays the partition table on C<device>, in the
3015 human-readable output of the L<sfdisk(8)> command. It is
3016 not intended to be parsed.
3018 See also: C<guestfs_part_list>");
3020 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3022 "display the kernel geometry",
3024 This displays the kernel's idea of the geometry of C<device>.
3026 The result is in human-readable format, and not designed to
3029 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3031 "display the disk geometry from the partition table",
3033 This displays the disk geometry of C<device> read from the
3034 partition table. Especially in the case where the underlying
3035 block device has been resized, this can be different from the
3036 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3038 The result is in human-readable format, and not designed to
3041 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3043 "activate or deactivate all volume groups",
3045 This command activates or (if C<activate> is false) deactivates
3046 all logical volumes in all volume groups.
3047 If activated, then they are made known to the
3048 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3049 then those devices disappear.
3051 This command is the same as running C<vgchange -a y|n>");
3053 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3055 "activate or deactivate some volume groups",
3057 This command activates or (if C<activate> is false) deactivates
3058 all logical volumes in the listed volume groups C<volgroups>.
3059 If activated, then they are made known to the
3060 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3061 then those devices disappear.
3063 This command is the same as running C<vgchange -a y|n volgroups...>
3065 Note that if C<volgroups> is an empty list then B<all> volume groups
3066 are activated or deactivated.");
3068 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3069 [InitNone, Always, TestOutput (
3070 [["part_disk"; "/dev/sda"; "mbr"];
3071 ["pvcreate"; "/dev/sda1"];
3072 ["vgcreate"; "VG"; "/dev/sda1"];
3073 ["lvcreate"; "LV"; "VG"; "10"];
3074 ["mkfs"; "ext2"; "/dev/VG/LV"];
3075 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3076 ["write"; "/new"; "test content"];
3078 ["lvresize"; "/dev/VG/LV"; "20"];
3079 ["e2fsck_f"; "/dev/VG/LV"];
3080 ["resize2fs"; "/dev/VG/LV"];
3081 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3082 ["cat"; "/new"]], "test content");
3083 InitNone, Always, TestRun (
3084 (* Make an LV smaller to test RHBZ#587484. *)
3085 [["part_disk"; "/dev/sda"; "mbr"];
3086 ["pvcreate"; "/dev/sda1"];
3087 ["vgcreate"; "VG"; "/dev/sda1"];
3088 ["lvcreate"; "LV"; "VG"; "20"];
3089 ["lvresize"; "/dev/VG/LV"; "10"]])],
3090 "resize an LVM logical volume",
3092 This resizes (expands or shrinks) an existing LVM logical
3093 volume to C<mbytes>. When reducing, data in the reduced part
3096 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3097 [], (* lvresize tests this *)
3098 "resize an ext2, ext3 or ext4 filesystem",
3100 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3101 the underlying device.
3103 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3104 on the C<device> before calling this command. For unknown reasons
3105 C<resize2fs> sometimes gives an error about this and sometimes not.
3106 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3107 calling this function.");
3109 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3110 [InitBasicFS, Always, TestOutputList (
3111 [["find"; "/"]], ["lost+found"]);
3112 InitBasicFS, Always, TestOutputList (
3116 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3117 InitScratchFS, Always, TestOutputList (
3118 [["mkdir_p"; "/find/b/c"];
3119 ["touch"; "/find/b/c/d"];
3120 ["find"; "/find/b/"]], ["c"; "c/d"])],
3121 "find all files and directories",
3123 This command lists out all files and directories, recursively,
3124 starting at C<directory>. It is essentially equivalent to
3125 running the shell command C<find directory -print> but some
3126 post-processing happens on the output, described below.
3128 This returns a list of strings I<without any prefix>. Thus
3129 if the directory structure was:
3135 then the returned list from C<guestfs_find> C</tmp> would be
3143 If C<directory> is not a directory, then this command returns
3146 The returned list is sorted.
3148 See also C<guestfs_find0>.");
3150 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3151 [], (* lvresize tests this *)
3152 "check an ext2/ext3 filesystem",
3154 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3155 filesystem checker on C<device>, noninteractively (C<-p>),
3156 even if the filesystem appears to be clean (C<-f>).
3158 This command is only needed because of C<guestfs_resize2fs>
3159 (q.v.). Normally you should use C<guestfs_fsck>.");
3161 ("sleep", (RErr, [Int "secs"], []), 109, [],
3162 [InitNone, Always, TestRun (
3164 "sleep for some seconds",
3166 Sleep for C<secs> seconds.");
3168 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3169 [InitNone, Always, TestOutputInt (
3170 [["part_disk"; "/dev/sda"; "mbr"];
3171 ["mkfs"; "ntfs"; "/dev/sda1"];
3172 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3173 InitNone, Always, TestOutputInt (
3174 [["part_disk"; "/dev/sda"; "mbr"];
3175 ["mkfs"; "ext2"; "/dev/sda1"];
3176 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3177 "probe NTFS volume",
3179 This command runs the L<ntfs-3g.probe(8)> command which probes
3180 an NTFS C<device> for mountability. (Not all NTFS volumes can
3181 be mounted read-write, and some cannot be mounted at all).
3183 C<rw> is a boolean flag. Set it to true if you want to test
3184 if the volume can be mounted read-write. Set it to false if
3185 you want to test if the volume can be mounted read-only.
3187 The return value is an integer which C<0> if the operation
3188 would succeed, or some non-zero value documented in the
3189 L<ntfs-3g.probe(8)> manual page.");
3191 ("sh", (RString "output", [String "command"], []), 111, [],
3192 [], (* XXX needs tests *)
3193 "run a command via the shell",
3195 This call runs a command from the guest filesystem via the
3198 This is like C<guestfs_command>, but passes the command to:
3200 /bin/sh -c \"command\"
3202 Depending on the guest's shell, this usually results in
3203 wildcards being expanded, shell expressions being interpolated
3206 All the provisos about C<guestfs_command> apply to this call.");
3208 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3209 [], (* XXX needs tests *)
3210 "run a command via the shell returning lines",
3212 This is the same as C<guestfs_sh>, but splits the result
3213 into a list of lines.
3215 See also: C<guestfs_command_lines>");
3217 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3218 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3219 * code in stubs.c, since all valid glob patterns must start with "/".
3220 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3222 [InitScratchFS, Always, TestOutputList (
3223 [["mkdir_p"; "/glob_expand/b/c"];
3224 ["touch"; "/glob_expand/b/c/d"];
3225 ["touch"; "/glob_expand/b/c/e"];
3226 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3227 InitScratchFS, Always, TestOutputList (
3228 [["mkdir_p"; "/glob_expand2/b/c"];
3229 ["touch"; "/glob_expand2/b/c/d"];
3230 ["touch"; "/glob_expand2/b/c/e"];
3231 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3232 InitScratchFS, Always, TestOutputList (
3233 [["mkdir_p"; "/glob_expand3/b/c"];
3234 ["touch"; "/glob_expand3/b/c/d"];
3235 ["touch"; "/glob_expand3/b/c/e"];
3236 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3237 "expand a wildcard path",
3239 This command searches for all the pathnames matching
3240 C<pattern> according to the wildcard expansion rules
3243 If no paths match, then this returns an empty list
3244 (note: not an error).
3246 It is just a wrapper around the C L<glob(3)> function
3247 with flags C<GLOB_MARK|GLOB_BRACE>.
3248 See that manual page for more details.");
3250 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3251 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3252 [["scrub_device"; "/dev/sdc"]])],
3253 "scrub (securely wipe) a device",
3255 This command writes patterns over C<device> to make data retrieval
3258 It is an interface to the L<scrub(1)> program. See that
3259 manual page for more details.");
3261 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3262 [InitScratchFS, Always, TestRun (
3263 [["write"; "/scrub_file"; "content"];
3264 ["scrub_file"; "/scrub_file"]])],
3265 "scrub (securely wipe) a file",
3267 This command writes patterns over a file to make data retrieval
3270 The file is I<removed> after scrubbing.
3272 It is an interface to the L<scrub(1)> program. See that
3273 manual page for more details.");
3275 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3276 [], (* XXX needs testing *)
3277 "scrub (securely wipe) free space",
3279 This command creates the directory C<dir> and then fills it
3280 with files until the filesystem is full, and scrubs the files
3281 as for C<guestfs_scrub_file>, and deletes them.
3282 The intention is to scrub any free space on the partition
3285 It is an interface to the L<scrub(1)> program. See that
3286 manual page for more details.");
3288 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3289 [InitScratchFS, Always, TestRun (
3290 [["mkdir"; "/mkdtemp"];
3291 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3292 "create a temporary directory",
3294 This command creates a temporary directory. The
3295 C<template> parameter should be a full pathname for the
3296 temporary directory name with the final six characters being
3299 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3300 the second one being suitable for Windows filesystems.
3302 The name of the temporary directory that was created
3305 The temporary directory is created with mode 0700
3306 and is owned by root.
3308 The caller is responsible for deleting the temporary
3309 directory and its contents after use.
3311 See also: L<mkdtemp(3)>");
3313 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3314 [InitISOFS, Always, TestOutputInt (
3315 [["wc_l"; "/10klines"]], 10000);
3316 (* Test for RHBZ#579608, absolute symbolic links. *)
3317 InitISOFS, Always, TestOutputInt (
3318 [["wc_l"; "/abssymlink"]], 10000)],
3319 "count lines in a file",
3321 This command counts the lines in a file, using the
3322 C<wc -l> external command.");
3324 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3325 [InitISOFS, Always, TestOutputInt (
3326 [["wc_w"; "/10klines"]], 10000)],
3327 "count words in a file",
3329 This command counts the words in a file, using the
3330 C<wc -w> external command.");
3332 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3333 [InitISOFS, Always, TestOutputInt (
3334 [["wc_c"; "/100kallspaces"]], 102400)],
3335 "count characters in a file",
3337 This command counts the characters in a file, using the
3338 C<wc -c> external command.");
3340 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3341 [InitISOFS, Always, TestOutputList (
3342 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3343 (* Test for RHBZ#579608, absolute symbolic links. *)
3344 InitISOFS, Always, TestOutputList (
3345 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3346 "return first 10 lines of a file",
3348 This command returns up to the first 10 lines of a file as
3349 a list of strings.");
3351 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3352 [InitISOFS, Always, TestOutputList (
3353 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3354 InitISOFS, Always, TestOutputList (
3355 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3356 InitISOFS, Always, TestOutputList (
3357 [["head_n"; "0"; "/10klines"]], [])],
3358 "return first N lines of a file",
3360 If the parameter C<nrlines> is a positive number, this returns the first
3361 C<nrlines> lines of the file C<path>.
3363 If the parameter C<nrlines> is a negative number, this returns lines
3364 from the file C<path>, excluding the last C<nrlines> lines.
3366 If the parameter C<nrlines> is zero, this returns an empty list.");
3368 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3369 [InitISOFS, Always, TestOutputList (
3370 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3371 "return last 10 lines of a file",
3373 This command returns up to the last 10 lines of a file as
3374 a list of strings.");
3376 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3377 [InitISOFS, Always, TestOutputList (
3378 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3379 InitISOFS, Always, TestOutputList (
3380 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3381 InitISOFS, Always, TestOutputList (
3382 [["tail_n"; "0"; "/10klines"]], [])],
3383 "return last N lines of a file",
3385 If the parameter C<nrlines> is a positive number, this returns the last
3386 C<nrlines> lines of the file C<path>.
3388 If the parameter C<nrlines> is a negative number, this returns lines
3389 from the file C<path>, starting with the C<-nrlines>th line.
3391 If the parameter C<nrlines> is zero, this returns an empty list.");
3393 ("df", (RString "output", [], []), 125, [],
3394 [], (* XXX Tricky to test because it depends on the exact format
3395 * of the 'df' command and other imponderables.
3397 "report file system disk space usage",
3399 This command runs the C<df> command to report disk space used.
3401 This command is mostly useful for interactive sessions. It
3402 is I<not> intended that you try to parse the output string.
3403 Use C<guestfs_statvfs> from programs.");
3405 ("df_h", (RString "output", [], []), 126, [],
3406 [], (* XXX Tricky to test because it depends on the exact format
3407 * of the 'df' command and other imponderables.
3409 "report file system disk space usage (human readable)",
3411 This command runs the C<df -h> command to report disk space used
3412 in human-readable format.
3414 This command is mostly useful for interactive sessions. It
3415 is I<not> intended that you try to parse the output string.
3416 Use C<guestfs_statvfs> from programs.");
3418 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3419 [InitISOFS, Always, TestOutputInt (
3420 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3421 "estimate file space usage",
3423 This command runs the C<du -s> command to estimate file space
3426 C<path> can be a file or a directory. If C<path> is a directory
3427 then the estimate includes the contents of the directory and all
3428 subdirectories (recursively).
3430 The result is the estimated size in I<kilobytes>
3431 (ie. units of 1024 bytes).");
3433 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3434 [InitISOFS, Always, TestOutputList (
3435 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3436 "list files in an initrd",
3438 This command lists out files contained in an initrd.
3440 The files are listed without any initial C</> character. The
3441 files are listed in the order they appear (not necessarily
3442 alphabetical). Directory names are listed as separate items.
3444 Old Linux kernels (2.4 and earlier) used a compressed ext2
3445 filesystem as initrd. We I<only> support the newer initramfs
3446 format (compressed cpio files).");
3448 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3450 "mount a file using the loop device",
3452 This command lets you mount C<file> (a filesystem image
3453 in a file) on a mount point. It is entirely equivalent to
3454 the command C<mount -o loop file mountpoint>.");
3456 ("mkswap", (RErr, [Device "device"], []), 130, [],
3457 [InitEmpty, Always, TestRun (
3458 [["part_disk"; "/dev/sda"; "mbr"];
3459 ["mkswap"; "/dev/sda1"]])],
3460 "create a swap partition",
3462 Create a swap partition on C<device>.");
3464 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3465 [InitEmpty, Always, TestRun (
3466 [["part_disk"; "/dev/sda"; "mbr"];
3467 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3468 "create a swap partition with a label",
3470 Create a swap partition on C<device> with label C<label>.
3472 Note that you cannot attach a swap label to a block device
3473 (eg. C</dev/sda>), just to a partition. This appears to be
3474 a limitation of the kernel or swap tools.");
3476 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3477 (let uuid = uuidgen () in
3478 [InitEmpty, Always, TestRun (
3479 [["part_disk"; "/dev/sda"; "mbr"];
3480 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3481 "create a swap partition with an explicit UUID",
3483 Create a swap partition on C<device> with UUID C<uuid>.");
3485 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3486 [InitScratchFS, Always, TestOutputStruct (
3487 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3488 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3489 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3490 InitScratchFS, Always, TestOutputStruct (
3491 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3492 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3493 "make block, character or FIFO devices",
3495 This call creates block or character special devices, or
3496 named pipes (FIFOs).
3498 The C<mode> parameter should be the mode, using the standard
3499 constants. C<devmajor> and C<devminor> are the
3500 device major and minor numbers, only used when creating block
3501 and character special devices.
3503 Note that, just like L<mknod(2)>, the mode must be bitwise
3504 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3505 just creates a regular file). These constants are
3506 available in the standard Linux header files, or you can use
3507 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3508 which are wrappers around this command which bitwise OR
3509 in the appropriate constant for you.
3511 The mode actually set is affected by the umask.");
3513 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3514 [InitScratchFS, Always, TestOutputStruct (
3515 [["mkfifo"; "0o777"; "/mkfifo"];
3516 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3517 "make FIFO (named pipe)",
3519 This call creates a FIFO (named pipe) called C<path> with
3520 mode C<mode>. It is just a convenient wrapper around
3523 The mode actually set is affected by the umask.");
3525 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3526 [InitScratchFS, Always, TestOutputStruct (
3527 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3528 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3529 "make block device node",
3531 This call creates a block device node called C<path> with
3532 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3533 It is just a convenient wrapper around C<guestfs_mknod>.
3535 The mode actually set is affected by the umask.");
3537 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3538 [InitScratchFS, Always, TestOutputStruct (
3539 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3540 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3541 "make char device node",
3543 This call creates a char device node called C<path> with
3544 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3545 It is just a convenient wrapper around C<guestfs_mknod>.
3547 The mode actually set is affected by the umask.");
3549 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3550 [InitEmpty, Always, TestOutputInt (
3551 [["umask"; "0o22"]], 0o22)],
3552 "set file mode creation mask (umask)",
3554 This function sets the mask used for creating new files and
3555 device nodes to C<mask & 0777>.
3557 Typical umask values would be C<022> which creates new files
3558 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3559 C<002> which creates new files with permissions like
3560 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3562 The default umask is C<022>. This is important because it
3563 means that directories and device nodes will be created with
3564 C<0644> or C<0755> mode even if you specify C<0777>.
3566 See also C<guestfs_get_umask>,
3567 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3569 This call returns the previous umask.");
3571 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3573 "read directories entries",
3575 This returns the list of directory entries in directory C<dir>.
3577 All entries in the directory are returned, including C<.> and
3578 C<..>. The entries are I<not> sorted, but returned in the same
3579 order as the underlying filesystem.
3581 Also this call returns basic file type information about each
3582 file. The C<ftyp> field will contain one of the following characters:
3620 The L<readdir(3)> call returned a C<d_type> field with an
3625 This function is primarily intended for use by programs. To
3626 get a simple list of names, use C<guestfs_ls>. To get a printable
3627 directory for human consumption, use C<guestfs_ll>.");
3629 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3631 "create partitions on a block device",
3633 This is a simplified interface to the C<guestfs_sfdisk>
3634 command, where partition sizes are specified in megabytes
3635 only (rounded to the nearest cylinder) and you don't need
3636 to specify the cyls, heads and sectors parameters which
3637 were rarely if ever used anyway.
3639 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3640 and C<guestfs_part_disk>");
3642 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3644 "determine file type inside a compressed file",
3646 This command runs C<file> after first decompressing C<path>
3649 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3651 Since 1.0.63, use C<guestfs_file> instead which can now
3652 process compressed files.");
3654 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3656 "list extended attributes of a file or directory",
3658 This call lists the extended attributes of the file or directory
3661 At the system call level, this is a combination of the
3662 L<listxattr(2)> and L<getxattr(2)> calls.
3664 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3666 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3668 "list extended attributes of a file or directory",
3670 This is the same as C<guestfs_getxattrs>, but if C<path>
3671 is a symbolic link, then it returns the extended attributes
3672 of the link itself.");
3674 ("setxattr", (RErr, [String "xattr";
3675 String "val"; Int "vallen"; (* will be BufferIn *)
3676 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3678 "set extended attribute of a file or directory",
3680 This call sets the extended attribute named C<xattr>
3681 of the file C<path> to the value C<val> (of length C<vallen>).
3682 The value is arbitrary 8 bit data.
3684 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3686 ("lsetxattr", (RErr, [String "xattr";
3687 String "val"; Int "vallen"; (* will be BufferIn *)
3688 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3690 "set extended attribute of a file or directory",
3692 This is the same as C<guestfs_setxattr>, but if C<path>
3693 is a symbolic link, then it sets an extended attribute
3694 of the link itself.");
3696 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3698 "remove extended attribute of a file or directory",
3700 This call removes the extended attribute named C<xattr>
3701 of the file C<path>.
3703 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3705 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3707 "remove extended attribute of a file or directory",
3709 This is the same as C<guestfs_removexattr>, but if C<path>
3710 is a symbolic link, then it removes an extended attribute
3711 of the link itself.");
3713 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3717 This call is similar to C<guestfs_mounts>. That call returns
3718 a list of devices. This one returns a hash table (map) of
3719 device name to directory where the device is mounted.");
3721 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3722 (* This is a special case: while you would expect a parameter
3723 * of type "Pathname", that doesn't work, because it implies
3724 * NEED_ROOT in the generated calling code in stubs.c, and
3725 * this function cannot use NEED_ROOT.
3728 "create a mountpoint",
3730 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3731 specialized calls that can be used to create extra mountpoints
3732 before mounting the first filesystem.
3734 These calls are I<only> necessary in some very limited circumstances,
3735 mainly the case where you want to mount a mix of unrelated and/or
3736 read-only filesystems together.
3738 For example, live CDs often contain a \"Russian doll\" nest of
3739 filesystems, an ISO outer layer, with a squashfs image inside, with
3740 an ext2/3 image inside that. You can unpack this as follows
3743 add-ro Fedora-11-i686-Live.iso
3747 mkmountpoint /ext3fs
3749 mount-loop /cd/LiveOS/squashfs.img /sqsh
3750 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3752 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3754 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3755 You may get unexpected errors if you try to mix these calls. It is
3756 safest to manually unmount filesystems and remove mountpoints after use.
3758 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3759 longest first, so for this to work for manual mountpoints, you
3760 must ensure that the innermost mountpoints have the longest
3761 pathnames, as in the example code above.
3763 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3765 Autosync [see C<guestfs_set_autosync>, this is set by default on
3766 handles] means that C<guestfs_umount_all> is called when the handle
3767 is closed which can also trigger these issues.");
3769 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3771 "remove a mountpoint",
3773 This calls removes a mountpoint that was previously created
3774 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3775 for full details.");
3777 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3778 [InitISOFS, Always, TestOutputBuffer (
3779 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3780 (* Test various near large, large and too large files (RHBZ#589039). *)
3781 InitScratchFS, Always, TestLastFail (
3782 [["touch"; "/read_file"];
3783 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3784 ["read_file"; "/read_file"]]);
3785 InitScratchFS, Always, TestLastFail (
3786 [["touch"; "/read_file2"];
3787 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3788 ["read_file"; "/read_file2"]]);
3789 InitScratchFS, Always, TestLastFail (
3790 [["touch"; "/read_file3"];
3791 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3792 ["read_file"; "/read_file3"]])],
3795 This calls returns the contents of the file C<path> as a
3798 Unlike C<guestfs_cat>, this function can correctly
3799 handle files that contain embedded ASCII NUL characters.
3800 However unlike C<guestfs_download>, this function is limited
3801 in the total size of file that can be handled.");
3803 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3804 [InitISOFS, Always, TestOutputList (
3805 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3806 InitISOFS, Always, TestOutputList (
3807 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3808 (* Test for RHBZ#579608, absolute symbolic links. *)
3809 InitISOFS, Always, TestOutputList (
3810 [["grep"; "nomatch"; "/abssymlink"]], [])],
3811 "return lines matching a pattern",
3813 This calls the external C<grep> program and returns the
3816 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3817 [InitISOFS, Always, TestOutputList (
3818 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3819 "return lines matching a pattern",
3821 This calls the external C<egrep> program and returns the
3824 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3825 [InitISOFS, Always, TestOutputList (
3826 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3827 "return lines matching a pattern",
3829 This calls the external C<fgrep> program and returns the
3832 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3833 [InitISOFS, Always, TestOutputList (
3834 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3835 "return lines matching a pattern",
3837 This calls the external C<grep -i> program and returns the
3840 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3841 [InitISOFS, Always, TestOutputList (
3842 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3843 "return lines matching a pattern",
3845 This calls the external C<egrep -i> program and returns the
3848 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3849 [InitISOFS, Always, TestOutputList (
3850 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3851 "return lines matching a pattern",
3853 This calls the external C<fgrep -i> program and returns the
3856 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3857 [InitISOFS, Always, TestOutputList (
3858 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3859 "return lines matching a pattern",
3861 This calls the external C<zgrep> program and returns the
3864 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3865 [InitISOFS, Always, TestOutputList (
3866 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3867 "return lines matching a pattern",
3869 This calls the external C<zegrep> program and returns the
3872 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3873 [InitISOFS, Always, TestOutputList (
3874 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3875 "return lines matching a pattern",
3877 This calls the external C<zfgrep> program and returns the
3880 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3881 [InitISOFS, Always, TestOutputList (
3882 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3883 "return lines matching a pattern",
3885 This calls the external C<zgrep -i> program and returns the
3888 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3889 [InitISOFS, Always, TestOutputList (
3890 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3891 "return lines matching a pattern",
3893 This calls the external C<zegrep -i> program and returns the
3896 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3897 [InitISOFS, Always, TestOutputList (
3898 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3899 "return lines matching a pattern",
3901 This calls the external C<zfgrep -i> program and returns the
3904 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3905 [InitISOFS, Always, TestOutput (
3906 [["realpath"; "/../directory"]], "/directory")],
3907 "canonicalized absolute pathname",
3909 Return the canonicalized absolute pathname of C<path>. The
3910 returned path has no C<.>, C<..> or symbolic link path elements.");
3912 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3913 [InitScratchFS, Always, TestOutputStruct (
3916 ["ln"; "/ln/a"; "/ln/b"];
3917 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
3918 "create a hard link",
3920 This command creates a hard link using the C<ln> command.");
3922 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3923 [InitScratchFS, Always, TestOutputStruct (
3924 [["mkdir"; "/ln_f"];
3925 ["touch"; "/ln_f/a"];
3926 ["touch"; "/ln_f/b"];
3927 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
3928 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
3929 "create a hard link",
3931 This command creates a hard link using the C<ln -f> command.
3932 The C<-f> option removes the link (C<linkname>) if it exists already.");
3934 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3935 [InitScratchFS, Always, TestOutputStruct (
3936 [["mkdir"; "/ln_s"];
3937 ["touch"; "/ln_s/a"];
3938 ["ln_s"; "a"; "/ln_s/b"];
3939 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
3940 "create a symbolic link",
3942 This command creates a symbolic link using the C<ln -s> command.");
3944 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3945 [InitScratchFS, Always, TestOutput (
3946 [["mkdir_p"; "/ln_sf/b"];
3947 ["touch"; "/ln_sf/b/c"];
3948 ["ln_sf"; "../d"; "/ln_sf/b/c"];
3949 ["readlink"; "/ln_sf/b/c"]], "../d")],
3950 "create a symbolic link",
3952 This command creates a symbolic link using the C<ln -sf> command,
3953 The C<-f> option removes the link (C<linkname>) if it exists already.");
3955 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3956 [] (* XXX tested above *),
3957 "read the target of a symbolic link",
3959 This command reads the target of a symbolic link.");
3961 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3962 [InitScratchFS, Always, TestOutputStruct (
3963 [["fallocate"; "/fallocate"; "1000000"];
3964 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
3965 "preallocate a file in the guest filesystem",
3967 This command preallocates a file (containing zero bytes) named
3968 C<path> of size C<len> bytes. If the file exists already, it
3971 Do not confuse this with the guestfish-specific
3972 C<alloc> command which allocates a file in the host and
3973 attaches it as a device.");
3975 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3976 [InitPartition, Always, TestRun (
3977 [["mkswap"; "/dev/sda1"];
3978 ["swapon_device"; "/dev/sda1"];
3979 ["swapoff_device"; "/dev/sda1"]])],
3980 "enable swap on device",
3982 This command enables the libguestfs appliance to use the
3983 swap device or partition named C<device>. The increased
3984 memory is made available for all commands, for example
3985 those run using C<guestfs_command> or C<guestfs_sh>.
3987 Note that you should not swap to existing guest swap
3988 partitions unless you know what you are doing. They may
3989 contain hibernation information, or other information that
3990 the guest doesn't want you to trash. You also risk leaking
3991 information about the host to the guest this way. Instead,
3992 attach a new host device to the guest and swap on that.");
3994 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3995 [], (* XXX tested by swapon_device *)
3996 "disable swap on device",
3998 This command disables the libguestfs appliance swap
3999 device or partition named C<device>.
4000 See C<guestfs_swapon_device>.");
4002 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4003 [InitScratchFS, Always, TestRun (
4004 [["fallocate"; "/swapon_file"; "8388608"];
4005 ["mkswap_file"; "/swapon_file"];
4006 ["swapon_file"; "/swapon_file"];
4007 ["swapoff_file"; "/swapon_file"];
4008 ["rm"; "/swapon_file"]])],
4009 "enable swap on file",
4011 This command enables swap to a file.
4012 See C<guestfs_swapon_device> for other notes.");
4014 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4015 [], (* XXX tested by swapon_file *)
4016 "disable swap on file",
4018 This command disables the libguestfs appliance swap on file.");
4020 ("swapon_label", (RErr, [String "label"], []), 174, [],
4021 [InitEmpty, Always, TestRun (
4022 [["part_disk"; "/dev/sda"; "mbr"];
4023 ["mkswap_L"; "swapit"; "/dev/sda1"];
4024 ["swapon_label"; "swapit"];
4025 ["swapoff_label"; "swapit"];
4026 ["zero"; "/dev/sda"];
4027 ["blockdev_rereadpt"; "/dev/sda"]])],
4028 "enable swap on labeled swap partition",
4030 This command enables swap to a labeled swap partition.
4031 See C<guestfs_swapon_device> for other notes.");
4033 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4034 [], (* XXX tested by swapon_label *)
4035 "disable swap on labeled swap partition",
4037 This command disables the libguestfs appliance swap on
4038 labeled swap partition.");
4040 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4041 (let uuid = uuidgen () in
4042 [InitEmpty, Always, TestRun (
4043 [["mkswap_U"; uuid; "/dev/sdc"];
4044 ["swapon_uuid"; uuid];
4045 ["swapoff_uuid"; uuid]])]),
4046 "enable swap on swap partition by UUID",
4048 This command enables swap to a swap partition with the given UUID.
4049 See C<guestfs_swapon_device> for other notes.");
4051 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4052 [], (* XXX tested by swapon_uuid *)
4053 "disable swap on swap partition by UUID",
4055 This command disables the libguestfs appliance swap partition
4056 with the given UUID.");
4058 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4059 [InitScratchFS, Always, TestRun (
4060 [["fallocate"; "/mkswap_file"; "8388608"];
4061 ["mkswap_file"; "/mkswap_file"];
4062 ["rm"; "/mkswap_file"]])],
4063 "create a swap file",
4067 This command just writes a swap file signature to an existing
4068 file. To create the file itself, use something like C<guestfs_fallocate>.");
4070 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4071 [InitISOFS, Always, TestRun (
4072 [["inotify_init"; "0"]])],
4073 "create an inotify handle",
4075 This command creates a new inotify handle.
4076 The inotify subsystem can be used to notify events which happen to
4077 objects in the guest filesystem.
4079 C<maxevents> is the maximum number of events which will be
4080 queued up between calls to C<guestfs_inotify_read> or
4081 C<guestfs_inotify_files>.
4082 If this is passed as C<0>, then the kernel (or previously set)
4083 default is used. For Linux 2.6.29 the default was 16384 events.
4084 Beyond this limit, the kernel throws away events, but records
4085 the fact that it threw them away by setting a flag
4086 C<IN_Q_OVERFLOW> in the returned structure list (see
4087 C<guestfs_inotify_read>).
4089 Before any events are generated, you have to add some
4090 watches to the internal watch list. See:
4091 C<guestfs_inotify_add_watch>,
4092 C<guestfs_inotify_rm_watch> and
4093 C<guestfs_inotify_watch_all>.
4095 Queued up events should be read periodically by calling
4096 C<guestfs_inotify_read>
4097 (or C<guestfs_inotify_files> which is just a helpful
4098 wrapper around C<guestfs_inotify_read>). If you don't
4099 read the events out often enough then you risk the internal
4102 The handle should be closed after use by calling
4103 C<guestfs_inotify_close>. This also removes any
4104 watches automatically.
4106 See also L<inotify(7)> for an overview of the inotify interface
4107 as exposed by the Linux kernel, which is roughly what we expose
4108 via libguestfs. Note that there is one global inotify handle
4109 per libguestfs instance.");
4111 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4112 [InitScratchFS, Always, TestOutputList (
4113 [["mkdir"; "/inotify_add_watch"];
4114 ["inotify_init"; "0"];
4115 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4116 ["touch"; "/inotify_add_watch/a"];
4117 ["touch"; "/inotify_add_watch/b"];
4118 ["inotify_files"]], ["a"; "b"])],
4119 "add an inotify watch",
4121 Watch C<path> for the events listed in C<mask>.
4123 Note that if C<path> is a directory then events within that
4124 directory are watched, but this does I<not> happen recursively
4125 (in subdirectories).
4127 Note for non-C or non-Linux callers: the inotify events are
4128 defined by the Linux kernel ABI and are listed in
4129 C</usr/include/sys/inotify.h>.");
4131 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4133 "remove an inotify watch",
4135 Remove a previously defined inotify watch.
4136 See C<guestfs_inotify_add_watch>.");
4138 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4140 "return list of inotify events",
4142 Return the complete queue of events that have happened
4143 since the previous read call.
4145 If no events have happened, this returns an empty list.
4147 I<Note>: In order to make sure that all events have been
4148 read, you must call this function repeatedly until it
4149 returns an empty list. The reason is that the call will
4150 read events up to the maximum appliance-to-host message
4151 size and leave remaining events in the queue.");
4153 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4155 "return list of watched files that had events",
4157 This function is a helpful wrapper around C<guestfs_inotify_read>
4158 which just returns a list of pathnames of objects that were
4159 touched. The returned pathnames are sorted and deduplicated.");
4161 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4163 "close the inotify handle",
4165 This closes the inotify handle which was previously
4166 opened by inotify_init. It removes all watches, throws
4167 away any pending events, and deallocates all resources.");
4169 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4171 "set SELinux security context",
4173 This sets the SELinux security context of the daemon
4174 to the string C<context>.
4176 See the documentation about SELINUX in L<guestfs(3)>.");
4178 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4180 "get SELinux security context",
4182 This gets the SELinux security context of the daemon.
4184 See the documentation about SELINUX in L<guestfs(3)>,
4185 and C<guestfs_setcon>");
4187 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4188 [InitEmpty, Always, TestOutput (
4189 [["part_disk"; "/dev/sda"; "mbr"];
4190 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4191 ["mount_options"; ""; "/dev/sda1"; "/"];
4192 ["write"; "/new"; "new file contents"];
4193 ["cat"; "/new"]], "new file contents");
4194 InitEmpty, Always, TestRun (
4195 [["part_disk"; "/dev/sda"; "mbr"];
4196 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4197 InitEmpty, Always, TestLastFail (
4198 [["part_disk"; "/dev/sda"; "mbr"];
4199 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4200 InitEmpty, Always, TestLastFail (
4201 [["part_disk"; "/dev/sda"; "mbr"];
4202 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4203 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4204 [["part_disk"; "/dev/sda"; "mbr"];
4205 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4206 "make a filesystem with block size",
4208 This call is similar to C<guestfs_mkfs>, but it allows you to
4209 control the block size of the resulting filesystem. Supported
4210 block sizes depend on the filesystem type, but typically they
4211 are C<1024>, C<2048> or C<4096> only.
4213 For VFAT and NTFS the C<blocksize> parameter is treated as
4214 the requested cluster size.");
4216 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4217 [InitEmpty, Always, TestOutput (
4218 [["part_init"; "/dev/sda"; "mbr"];
4219 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4220 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4221 ["mke2journal"; "4096"; "/dev/sda1"];
4222 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4223 ["mount_options"; ""; "/dev/sda2"; "/"];
4224 ["write"; "/new"; "new file contents"];
4225 ["cat"; "/new"]], "new file contents")],
4226 "make ext2/3/4 external journal",
4228 This creates an ext2 external journal on C<device>. It is equivalent
4231 mke2fs -O journal_dev -b blocksize device");
4233 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4234 [InitEmpty, Always, TestOutput (
4235 [["part_init"; "/dev/sda"; "mbr"];
4236 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4237 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4238 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4239 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4240 ["mount_options"; ""; "/dev/sda2"; "/"];
4241 ["write"; "/new"; "new file contents"];
4242 ["cat"; "/new"]], "new file contents")],
4243 "make ext2/3/4 external journal with label",
4245 This creates an ext2 external journal on C<device> with label C<label>.");
4247 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4248 (let uuid = uuidgen () in
4249 [InitEmpty, Always, TestOutput (
4250 [["part_init"; "/dev/sda"; "mbr"];
4251 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4252 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4253 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4254 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4255 ["mount_options"; ""; "/dev/sda2"; "/"];
4256 ["write"; "/new"; "new file contents"];
4257 ["cat"; "/new"]], "new file contents")]),
4258 "make ext2/3/4 external journal with UUID",
4260 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4262 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4264 "make ext2/3/4 filesystem with external journal",
4266 This creates an ext2/3/4 filesystem on C<device> with
4267 an external journal on C<journal>. It is equivalent
4270 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4272 See also C<guestfs_mke2journal>.");
4274 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4276 "make ext2/3/4 filesystem with external journal",
4278 This creates an ext2/3/4 filesystem on C<device> with
4279 an external journal on the journal labeled C<label>.
4281 See also C<guestfs_mke2journal_L>.");
4283 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4285 "make ext2/3/4 filesystem with external journal",
4287 This creates an ext2/3/4 filesystem on C<device> with
4288 an external journal on the journal with UUID C<uuid>.
4290 See also C<guestfs_mke2journal_U>.");
4292 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4293 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4294 "load a kernel module",
4296 This loads a kernel module in the appliance.
4298 The kernel module must have been whitelisted when libguestfs
4299 was built (see C<appliance/kmod.whitelist.in> in the source).");
4301 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4302 [InitNone, Always, TestOutput (
4303 [["echo_daemon"; "This is a test"]], "This is a test"
4305 "echo arguments back to the client",
4307 This command concatenates the list of C<words> passed with single spaces
4308 between them and returns the resulting string.
4310 You can use this command to test the connection through to the daemon.
4312 See also C<guestfs_ping_daemon>.");
4314 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4315 [], (* There is a regression test for this. *)
4316 "find all files and directories, returning NUL-separated list",
4318 This command lists out all files and directories, recursively,
4319 starting at C<directory>, placing the resulting list in the
4320 external file called C<files>.
4322 This command works the same way as C<guestfs_find> with the
4323 following exceptions:
4329 The resulting list is written to an external file.
4333 Items (filenames) in the result are separated
4334 by C<\\0> characters. See L<find(1)> option I<-print0>.
4338 This command is not limited in the number of names that it
4343 The result list is not sorted.
4347 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4348 [InitISOFS, Always, TestOutput (
4349 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4350 InitISOFS, Always, TestOutput (
4351 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4352 InitISOFS, Always, TestOutput (
4353 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4354 InitISOFS, Always, TestLastFail (
4355 [["case_sensitive_path"; "/Known-1/"]]);
4356 InitScratchFS, Always, TestOutput (
4357 [["mkdir"; "/case_sensitive_path"];
4358 ["mkdir"; "/case_sensitive_path/bbb"];
4359 ["touch"; "/case_sensitive_path/bbb/c"];
4360 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4361 InitScratchFS, Always, TestOutput (
4362 [["mkdir"; "/case_sensitive_path2"];
4363 ["mkdir"; "/case_sensitive_path2/bbb"];
4364 ["touch"; "/case_sensitive_path2/bbb/c"];
4365 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4366 InitScratchFS, Always, TestLastFail (
4367 [["mkdir"; "/case_sensitive_path3"];
4368 ["mkdir"; "/case_sensitive_path3/bbb"];
4369 ["touch"; "/case_sensitive_path3/bbb/c"];
4370 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4371 "return true path on case-insensitive filesystem",
4373 This can be used to resolve case insensitive paths on
4374 a filesystem which is case sensitive. The use case is
4375 to resolve paths which you have read from Windows configuration
4376 files or the Windows Registry, to the true path.
4378 The command handles a peculiarity of the Linux ntfs-3g
4379 filesystem driver (and probably others), which is that although
4380 the underlying filesystem is case-insensitive, the driver
4381 exports the filesystem to Linux as case-sensitive.
4383 One consequence of this is that special directories such
4384 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4385 (or other things) depending on the precise details of how
4386 they were created. In Windows itself this would not be
4389 Bug or feature? You decide:
4390 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4392 This function resolves the true case of each element in the
4393 path and returns the case-sensitive path.
4395 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4396 might return C<\"/WINDOWS/system32\"> (the exact return value
4397 would depend on details of how the directories were originally
4398 created under Windows).
4401 This function does not handle drive names, backslashes etc.
4403 See also C<guestfs_realpath>.");
4405 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4406 [InitScratchFS, Always, TestOutput (
4407 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4408 "get the Linux VFS type corresponding to a mounted device",
4410 This command gets the filesystem type corresponding to
4411 the filesystem on C<device>.
4413 For most filesystems, the result is the name of the Linux
4414 VFS module which would be used to mount this filesystem
4415 if you mounted it without specifying the filesystem type.
4416 For example a string such as C<ext3> or C<ntfs>.");
4418 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4419 [InitScratchFS, Always, TestOutputStruct (
4420 [["write"; "/truncate"; "some stuff so size is not zero"];
4421 ["truncate"; "/truncate"];
4422 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4423 "truncate a file to zero size",
4425 This command truncates C<path> to a zero-length file. The
4426 file must exist already.");
4428 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4429 [InitScratchFS, Always, TestOutputStruct (
4430 [["touch"; "/truncate_size"];
4431 ["truncate_size"; "/truncate_size"; "1000"];
4432 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4433 "truncate a file to a particular size",
4435 This command truncates C<path> to size C<size> bytes. The file
4438 If the current file size is less than C<size> then
4439 the file is extended to the required size with zero bytes.
4440 This creates a sparse file (ie. disk blocks are not allocated
4441 for the file until you write to it). To create a non-sparse
4442 file of zeroes, use C<guestfs_fallocate64> instead.");
4444 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4445 [InitScratchFS, Always, TestOutputStruct (
4446 [["touch"; "/utimens"];
4447 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4448 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4449 "set timestamp of a file with nanosecond precision",
4451 This command sets the timestamps of a file with nanosecond
4454 C<atsecs, atnsecs> are the last access time (atime) in secs and
4455 nanoseconds from the epoch.
4457 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4458 secs and nanoseconds from the epoch.
4460 If the C<*nsecs> field contains the special value C<-1> then
4461 the corresponding timestamp is set to the current time. (The
4462 C<*secs> field is ignored in this case).
4464 If the C<*nsecs> field contains the special value C<-2> then
4465 the corresponding timestamp is left unchanged. (The
4466 C<*secs> field is ignored in this case).");
4468 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4469 [InitScratchFS, Always, TestOutputStruct (
4470 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4471 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4472 "create a directory with a particular mode",
4474 This command creates a directory, setting the initial permissions
4475 of the directory to C<mode>.
4477 For common Linux filesystems, the actual mode which is set will
4478 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4479 interpret the mode in other ways.
4481 See also C<guestfs_mkdir>, C<guestfs_umask>");
4483 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4485 "change file owner and group",
4487 Change the file owner to C<owner> and group to C<group>.
4488 This is like C<guestfs_chown> but if C<path> is a symlink then
4489 the link itself is changed, not the target.
4491 Only numeric uid and gid are supported. If you want to use
4492 names, you will need to locate and parse the password file
4493 yourself (Augeas support makes this relatively easy).");
4495 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4497 "lstat on multiple files",
4499 This call allows you to perform the C<guestfs_lstat> operation
4500 on multiple files, where all files are in the directory C<path>.
4501 C<names> is the list of files from this directory.
4503 On return you get a list of stat structs, with a one-to-one
4504 correspondence to the C<names> list. If any name did not exist
4505 or could not be lstat'd, then the C<ino> field of that structure
4508 This call is intended for programs that want to efficiently
4509 list a directory contents without making many round-trips.
4510 See also C<guestfs_lxattrlist> for a similarly efficient call
4511 for getting extended attributes. Very long directory listings
4512 might cause the protocol message size to be exceeded, causing
4513 this call to fail. The caller must split up such requests
4514 into smaller groups of names.");
4516 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4518 "lgetxattr on multiple files",
4520 This call allows you to get the extended attributes
4521 of multiple files, where all files are in the directory C<path>.
4522 C<names> is the list of files from this directory.
4524 On return you get a flat list of xattr structs which must be
4525 interpreted sequentially. The first xattr struct always has a zero-length
4526 C<attrname>. C<attrval> in this struct is zero-length
4527 to indicate there was an error doing C<lgetxattr> for this
4528 file, I<or> is a C string which is a decimal number
4529 (the number of following attributes for this file, which could
4530 be C<\"0\">). Then after the first xattr struct are the
4531 zero or more attributes for the first named file.
4532 This repeats for the second and subsequent files.
4534 This call is intended for programs that want to efficiently
4535 list a directory contents without making many round-trips.
4536 See also C<guestfs_lstatlist> for a similarly efficient call
4537 for getting standard stats. Very long directory listings
4538 might cause the protocol message size to be exceeded, causing
4539 this call to fail. The caller must split up such requests
4540 into smaller groups of names.");
4542 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4544 "readlink on multiple files",
4546 This call allows you to do a C<readlink> operation
4547 on multiple files, where all files are in the directory C<path>.
4548 C<names> is the list of files from this directory.
4550 On return you get a list of strings, with a one-to-one
4551 correspondence to the C<names> list. Each string is the
4552 value of the symbolic link.
4554 If the C<readlink(2)> operation fails on any name, then
4555 the corresponding result string is the empty string C<\"\">.
4556 However the whole operation is completed even if there
4557 were C<readlink(2)> errors, and so you can call this
4558 function with names where you don't know if they are
4559 symbolic links already (albeit slightly less efficient).
4561 This call is intended for programs that want to efficiently
4562 list a directory contents without making many round-trips.
4563 Very long directory listings might cause the protocol
4564 message size to be exceeded, causing
4565 this call to fail. The caller must split up such requests
4566 into smaller groups of names.");
4568 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4569 [InitISOFS, Always, TestOutputBuffer (
4570 [["pread"; "/known-4"; "1"; "3"]], "\n");
4571 InitISOFS, Always, TestOutputBuffer (
4572 [["pread"; "/empty"; "0"; "100"]], "")],
4573 "read part of a file",
4575 This command lets you read part of a file. It reads C<count>
4576 bytes of the file, starting at C<offset>, from file C<path>.
4578 This may read fewer bytes than requested. For further details
4579 see the L<pread(2)> system call.
4581 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4583 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4584 [InitEmpty, Always, TestRun (
4585 [["part_init"; "/dev/sda"; "gpt"]])],
4586 "create an empty partition table",
4588 This creates an empty partition table on C<device> of one of the
4589 partition types listed below. Usually C<parttype> should be
4590 either C<msdos> or C<gpt> (for large disks).
4592 Initially there are no partitions. Following this, you should
4593 call C<guestfs_part_add> for each partition required.
4595 Possible values for C<parttype> are:
4599 =item B<efi> | B<gpt>
4601 Intel EFI / GPT partition table.
4603 This is recommended for >= 2 TB partitions that will be accessed
4604 from Linux and Intel-based Mac OS X. It also has limited backwards
4605 compatibility with the C<mbr> format.
4607 =item B<mbr> | B<msdos>
4609 The standard PC \"Master Boot Record\" (MBR) format used
4610 by MS-DOS and Windows. This partition type will B<only> work
4611 for device sizes up to 2 TB. For large disks we recommend
4616 Other partition table types that may work but are not
4625 =item B<amiga> | B<rdb>
4627 Amiga \"Rigid Disk Block\" format.
4635 DASD, used on IBM mainframes.
4643 Old Mac partition format. Modern Macs use C<gpt>.
4647 NEC PC-98 format, common in Japan apparently.
4655 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4656 [InitEmpty, Always, TestRun (
4657 [["part_init"; "/dev/sda"; "mbr"];
4658 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4659 InitEmpty, Always, TestRun (
4660 [["part_init"; "/dev/sda"; "gpt"];
4661 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4662 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4663 InitEmpty, Always, TestRun (
4664 [["part_init"; "/dev/sda"; "mbr"];
4665 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4666 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4667 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4668 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4669 "add a partition to the device",
4671 This command adds a partition to C<device>. If there is no partition
4672 table on the device, call C<guestfs_part_init> first.
4674 The C<prlogex> parameter is the type of partition. Normally you
4675 should pass C<p> or C<primary> here, but MBR partition tables also
4676 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4679 C<startsect> and C<endsect> are the start and end of the partition
4680 in I<sectors>. C<endsect> may be negative, which means it counts
4681 backwards from the end of the disk (C<-1> is the last sector).
4683 Creating a partition which covers the whole disk is not so easy.
4684 Use C<guestfs_part_disk> to do that.");
4686 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4687 [InitEmpty, Always, TestRun (
4688 [["part_disk"; "/dev/sda"; "mbr"]]);
4689 InitEmpty, Always, TestRun (
4690 [["part_disk"; "/dev/sda"; "gpt"]])],
4691 "partition whole disk with a single primary partition",
4693 This command is simply a combination of C<guestfs_part_init>
4694 followed by C<guestfs_part_add> to create a single primary partition
4695 covering the whole disk.
4697 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4698 but other possible values are described in C<guestfs_part_init>.");
4700 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4701 [InitEmpty, Always, TestRun (
4702 [["part_disk"; "/dev/sda"; "mbr"];
4703 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4704 "make a partition bootable",
4706 This sets the bootable flag on partition numbered C<partnum> on
4707 device C<device>. Note that partitions are numbered from 1.
4709 The bootable flag is used by some operating systems (notably
4710 Windows) to determine which partition to boot from. It is by
4711 no means universally recognized.");
4713 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4714 [InitEmpty, Always, TestRun (
4715 [["part_disk"; "/dev/sda"; "gpt"];
4716 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4717 "set partition name",
4719 This sets the partition name on partition numbered C<partnum> on
4720 device C<device>. Note that partitions are numbered from 1.
4722 The partition name can only be set on certain types of partition
4723 table. This works on C<gpt> but not on C<mbr> partitions.");
4725 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4726 [], (* XXX Add a regression test for this. *)
4727 "list partitions on a device",
4729 This command parses the partition table on C<device> and
4730 returns the list of partitions found.
4732 The fields in the returned structure are:
4738 Partition number, counting from 1.
4742 Start of the partition I<in bytes>. To get sectors you have to
4743 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4747 End of the partition in bytes.
4751 Size of the partition in bytes.
4755 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4756 [InitEmpty, Always, TestOutput (
4757 [["part_disk"; "/dev/sda"; "gpt"];
4758 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4759 "get the partition table type",
4761 This command examines the partition table on C<device> and
4762 returns the partition table type (format) being used.
4764 Common return values include: C<msdos> (a DOS/Windows style MBR
4765 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4766 values are possible, although unusual. See C<guestfs_part_init>
4769 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4770 [InitScratchFS, Always, TestOutputBuffer (
4771 [["fill"; "0x63"; "10"; "/fill"];
4772 ["read_file"; "/fill"]], "cccccccccc")],
4773 "fill a file with octets",
4775 This command creates a new file called C<path>. The initial
4776 content of the file is C<len> octets of C<c>, where C<c>
4777 must be a number in the range C<[0..255]>.
4779 To fill a file with zero bytes (sparsely), it is
4780 much more efficient to use C<guestfs_truncate_size>.
4781 To create a file with a pattern of repeating bytes
4782 use C<guestfs_fill_pattern>.");
4784 ("available", (RErr, [StringList "groups"], []), 216, [],
4785 [InitNone, Always, TestRun [["available"; ""]]],
4786 "test availability of some parts of the API",
4788 This command is used to check the availability of some
4789 groups of functionality in the appliance, which not all builds of
4790 the libguestfs appliance will be able to provide.
4792 The libguestfs groups, and the functions that those
4793 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4794 You can also fetch this list at runtime by calling
4795 C<guestfs_available_all_groups>.
4797 The argument C<groups> is a list of group names, eg:
4798 C<[\"inotify\", \"augeas\"]> would check for the availability of
4799 the Linux inotify functions and Augeas (configuration file
4802 The command returns no error if I<all> requested groups are available.
4804 It fails with an error if one or more of the requested
4805 groups is unavailable in the appliance.
4807 If an unknown group name is included in the
4808 list of groups then an error is always returned.
4816 You must call C<guestfs_launch> before calling this function.
4818 The reason is because we don't know what groups are
4819 supported by the appliance/daemon until it is running and can
4824 If a group of functions is available, this does not necessarily
4825 mean that they will work. You still have to check for errors
4826 when calling individual API functions even if they are
4831 It is usually the job of distro packagers to build
4832 complete functionality into the libguestfs appliance.
4833 Upstream libguestfs, if built from source with all
4834 requirements satisfied, will support everything.
4838 This call was added in version C<1.0.80>. In previous
4839 versions of libguestfs all you could do would be to speculatively
4840 execute a command to find out if the daemon implemented it.
4841 See also C<guestfs_version>.
4845 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4846 [InitScratchFS, Always, TestOutputBuffer (
4848 ["write"; "/dd/src"; "hello, world"];
4849 ["dd"; "/dd/src"; "/dd/dest"];
4850 ["read_file"; "/dd/dest"]], "hello, world")],
4851 "copy from source to destination using dd",
4853 This command copies from one source device or file C<src>
4854 to another destination device or file C<dest>. Normally you
4855 would use this to copy to or from a device or partition, for
4856 example to duplicate a filesystem.
4858 If the destination is a device, it must be as large or larger
4859 than the source file or device, otherwise the copy will fail.
4860 This command cannot do partial copies (see C<guestfs_copy_size>).");
4862 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4863 [InitScratchFS, Always, TestOutputInt (
4864 [["write"; "/filesize"; "hello, world"];
4865 ["filesize"; "/filesize"]], 12)],
4866 "return the size of the file in bytes",
4868 This command returns the size of C<file> in bytes.
4870 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4871 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4872 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4874 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4875 [InitBasicFSonLVM, Always, TestOutputList (
4876 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4877 ["lvs"]], ["/dev/VG/LV2"])],
4878 "rename an LVM logical volume",
4880 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4882 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4883 [InitBasicFSonLVM, Always, TestOutputList (
4885 ["vg_activate"; "false"; "VG"];
4886 ["vgrename"; "VG"; "VG2"];
4887 ["vg_activate"; "true"; "VG2"];
4888 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4889 ["vgs"]], ["VG2"])],
4890 "rename an LVM volume group",
4892 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4894 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4895 [InitISOFS, Always, TestOutputBuffer (
4896 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4897 "list the contents of a single file in an initrd",
4899 This command unpacks the file C<filename> from the initrd file
4900 called C<initrdpath>. The filename must be given I<without> the
4901 initial C</> character.
4903 For example, in guestfish you could use the following command
4904 to examine the boot script (usually called C</init>)
4905 contained in a Linux initrd or initramfs image:
4907 initrd-cat /boot/initrd-<version>.img init
4909 See also C<guestfs_initrd_list>.");
4911 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4913 "get the UUID of a physical volume",
4915 This command returns the UUID of the LVM PV C<device>.");
4917 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4919 "get the UUID of a volume group",
4921 This command returns the UUID of the LVM VG named C<vgname>.");
4923 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4925 "get the UUID of a logical volume",
4927 This command returns the UUID of the LVM LV C<device>.");
4929 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4931 "get the PV UUIDs containing the volume group",
4933 Given a VG called C<vgname>, this returns the UUIDs of all
4934 the physical volumes that this volume group resides on.
4936 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4937 calls to associate physical volumes and volume groups.
4939 See also C<guestfs_vglvuuids>.");
4941 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4943 "get the LV UUIDs of all LVs in the volume group",
4945 Given a VG called C<vgname>, this returns the UUIDs of all
4946 the logical volumes created in this volume group.
4948 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4949 calls to associate logical volumes and volume groups.
4951 See also C<guestfs_vgpvuuids>.");
4953 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4954 [InitScratchFS, Always, TestOutputBuffer (
4955 [["mkdir"; "/copy_size"];
4956 ["write"; "/copy_size/src"; "hello, world"];
4957 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
4958 ["read_file"; "/copy_size/dest"]], "hello")],
4959 "copy size bytes from source to destination using dd",
4961 This command copies exactly C<size> bytes from one source device
4962 or file C<src> to another destination device or file C<dest>.
4964 Note this will fail if the source is too short or if the destination
4965 is not large enough.");
4967 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4968 [InitBasicFSonLVM, Always, TestRun (
4969 [["zero_device"; "/dev/VG/LV"]])],
4970 "write zeroes to an entire device",
4972 This command writes zeroes over the entire C<device>. Compare
4973 with C<guestfs_zero> which just zeroes the first few blocks of
4976 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4977 [InitScratchFS, Always, TestOutput (
4978 [["mkdir"; "/txz_in"];
4979 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
4980 ["cat"; "/txz_in/hello"]], "hello\n")],
4981 "unpack compressed tarball to directory",
4983 This command uploads and unpacks local file C<tarball> (an
4984 I<xz compressed> tar file) into C<directory>.");
4986 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4988 "pack directory into compressed tarball",
4990 This command packs the contents of C<directory> and downloads
4991 it to local file C<tarball> (as an xz compressed tar archive).");
4993 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4995 "resize an NTFS filesystem",
4997 This command resizes an NTFS filesystem, expanding or
4998 shrinking it to the size of the underlying device.
4999 See also L<ntfsresize(8)>.");
5001 ("vgscan", (RErr, [], []), 232, [],
5002 [InitEmpty, Always, TestRun (
5004 "rescan for LVM physical volumes, volume groups and logical volumes",
5006 This rescans all block devices and rebuilds the list of LVM
5007 physical volumes, volume groups and logical volumes.");
5009 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5010 [InitEmpty, Always, TestRun (
5011 [["part_init"; "/dev/sda"; "mbr"];
5012 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5013 ["part_del"; "/dev/sda"; "1"]])],
5014 "delete a partition",
5016 This command deletes the partition numbered C<partnum> on C<device>.
5018 Note that in the case of MBR partitioning, deleting an
5019 extended partition also deletes any logical partitions
5022 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5023 [InitEmpty, Always, TestOutputTrue (
5024 [["part_init"; "/dev/sda"; "mbr"];
5025 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5026 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5027 ["part_get_bootable"; "/dev/sda"; "1"]])],
5028 "return true if a partition is bootable",
5030 This command returns true if the partition C<partnum> on
5031 C<device> has the bootable flag set.
5033 See also C<guestfs_part_set_bootable>.");
5035 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5036 [InitEmpty, Always, TestOutputInt (
5037 [["part_init"; "/dev/sda"; "mbr"];
5038 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5039 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5040 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5041 "get the MBR type byte (ID byte) from a partition",
5043 Returns the MBR type byte (also known as the ID byte) from
5044 the numbered partition C<partnum>.
5046 Note that only MBR (old DOS-style) partitions have type bytes.
5047 You will get undefined results for other partition table
5048 types (see C<guestfs_part_get_parttype>).");
5050 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5051 [], (* tested by part_get_mbr_id *)
5052 "set the MBR type byte (ID byte) of a partition",
5054 Sets the MBR type byte (also known as the ID byte) of
5055 the numbered partition C<partnum> to C<idbyte>. Note
5056 that the type bytes quoted in most documentation are
5057 in fact hexadecimal numbers, but usually documented
5058 without any leading \"0x\" which might be confusing.
5060 Note that only MBR (old DOS-style) partitions have type bytes.
5061 You will get undefined results for other partition table
5062 types (see C<guestfs_part_get_parttype>).");
5064 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5065 [InitISOFS, Always, TestOutputFileMD5 (
5066 [["checksum_device"; "md5"; "/dev/sdd"]],
5067 "../images/test.iso")],
5068 "compute MD5, SHAx or CRC checksum of the contents of a device",
5070 This call computes the MD5, SHAx or CRC checksum of the
5071 contents of the device named C<device>. For the types of
5072 checksums supported see the C<guestfs_checksum> command.");
5074 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5075 [InitNone, Always, TestRun (
5076 [["part_disk"; "/dev/sda"; "mbr"];
5077 ["pvcreate"; "/dev/sda1"];
5078 ["vgcreate"; "VG"; "/dev/sda1"];
5079 ["lvcreate"; "LV"; "VG"; "10"];
5080 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5081 "expand an LV to fill free space",
5083 This expands an existing logical volume C<lv> so that it fills
5084 C<pc>% of the remaining free space in the volume group. Commonly
5085 you would call this with pc = 100 which expands the logical volume
5086 as much as possible, using all remaining free space in the volume
5089 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5090 [], (* XXX Augeas code needs tests. *)
5091 "clear Augeas path",
5093 Set the value associated with C<path> to C<NULL>. This
5094 is the same as the L<augtool(1)> C<clear> command.");
5096 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5097 [InitEmpty, Always, TestOutputInt (
5098 [["get_umask"]], 0o22)],
5099 "get the current umask",
5101 Return the current umask. By default the umask is C<022>
5102 unless it has been set by calling C<guestfs_umask>.");
5104 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5106 "upload a file to the appliance (internal use only)",
5108 The C<guestfs_debug_upload> command uploads a file to
5109 the libguestfs appliance.
5111 There is no comprehensive help for this command. You have
5112 to look at the file C<daemon/debug.c> in the libguestfs source
5113 to find out what it is for.");
5115 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5116 [InitScratchFS, Always, TestOutput (
5117 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5118 ["cat"; "/base64_in"]], "hello\n")],
5119 "upload base64-encoded data to file",
5121 This command uploads base64-encoded data from C<base64file>
5124 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5126 "download file and encode as base64",
5128 This command downloads the contents of C<filename>, writing
5129 it out to local file C<base64file> encoded as base64.");
5131 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5133 "compute MD5, SHAx or CRC checksum of files in a directory",
5135 This command computes the checksums of all regular files in
5136 C<directory> and then emits a list of those checksums to
5137 the local output file C<sumsfile>.
5139 This can be used for verifying the integrity of a virtual
5140 machine. However to be properly secure you should pay
5141 attention to the output of the checksum command (it uses
5142 the ones from GNU coreutils). In particular when the
5143 filename is not printable, coreutils uses a special
5144 backslash syntax. For more information, see the GNU
5145 coreutils info file.");
5147 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5148 [InitScratchFS, Always, TestOutputBuffer (
5149 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5150 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5151 "fill a file with a repeating pattern of bytes",
5153 This function is like C<guestfs_fill> except that it creates
5154 a new file of length C<len> containing the repeating pattern
5155 of bytes in C<pattern>. The pattern is truncated if necessary
5156 to ensure the length of the file is exactly C<len> bytes.");
5158 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5159 [InitScratchFS, Always, TestOutput (
5160 [["write"; "/write"; "new file contents"];
5161 ["cat"; "/write"]], "new file contents");
5162 InitScratchFS, Always, TestOutput (
5163 [["write"; "/write2"; "\nnew file contents\n"];
5164 ["cat"; "/write2"]], "\nnew file contents\n");
5165 InitScratchFS, Always, TestOutput (
5166 [["write"; "/write3"; "\n\n"];
5167 ["cat"; "/write3"]], "\n\n");
5168 InitScratchFS, Always, TestOutput (
5169 [["write"; "/write4"; ""];
5170 ["cat"; "/write4"]], "");
5171 InitScratchFS, Always, TestOutput (
5172 [["write"; "/write5"; "\n\n\n"];
5173 ["cat"; "/write5"]], "\n\n\n");
5174 InitScratchFS, Always, TestOutput (
5175 [["write"; "/write6"; "\n"];
5176 ["cat"; "/write6"]], "\n")],
5177 "create a new file",
5179 This call creates a file called C<path>. The content of the
5180 file is the string C<content> (which can contain any 8 bit data).");
5182 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5183 [InitScratchFS, Always, TestOutput (
5184 [["write"; "/pwrite"; "new file contents"];
5185 ["pwrite"; "/pwrite"; "data"; "4"];
5186 ["cat"; "/pwrite"]], "new data contents");
5187 InitScratchFS, Always, TestOutput (
5188 [["write"; "/pwrite2"; "new file contents"];
5189 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5190 ["cat"; "/pwrite2"]], "new file is extended");
5191 InitScratchFS, Always, TestOutput (
5192 [["write"; "/pwrite3"; "new file contents"];
5193 ["pwrite"; "/pwrite3"; ""; "4"];
5194 ["cat"; "/pwrite3"]], "new file contents")],
5195 "write to part of a file",
5197 This command writes to part of a file. It writes the data
5198 buffer C<content> to the file C<path> starting at offset C<offset>.
5200 This command implements the L<pwrite(2)> system call, and like
5201 that system call it may not write the full data requested. The
5202 return value is the number of bytes that were actually written
5203 to the file. This could even be 0, although short writes are
5204 unlikely for regular files in ordinary circumstances.
5206 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5208 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5210 "resize an ext2, ext3 or ext4 filesystem (with size)",
5212 This command is the same as C<guestfs_resize2fs> except that it
5213 allows you to specify the new size (in bytes) explicitly.");
5215 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5217 "resize an LVM physical volume (with size)",
5219 This command is the same as C<guestfs_pvresize> except that it
5220 allows you to specify the new size (in bytes) explicitly.");
5222 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5224 "resize an NTFS filesystem (with size)",
5226 This command is the same as C<guestfs_ntfsresize> except that it
5227 allows you to specify the new size (in bytes) explicitly.");
5229 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5230 [InitNone, Always, TestRun [["available_all_groups"]]],
5231 "return a list of all optional groups",
5233 This command returns a list of all optional groups that this
5234 daemon knows about. Note this returns both supported and unsupported
5235 groups. To find out which ones the daemon can actually support
5236 you have to call C<guestfs_available> on each member of the
5239 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5241 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5242 [InitScratchFS, Always, TestOutputStruct (
5243 [["fallocate64"; "/fallocate64"; "1000000"];
5244 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5245 "preallocate a file in the guest filesystem",
5247 This command preallocates a file (containing zero bytes) named
5248 C<path> of size C<len> bytes. If the file exists already, it
5251 Note that this call allocates disk blocks for the file.
5252 To create a sparse file use C<guestfs_truncate_size> instead.
5254 The deprecated call C<guestfs_fallocate> does the same,
5255 but owing to an oversight it only allowed 30 bit lengths
5256 to be specified, effectively limiting the maximum size
5257 of files created through that call to 1GB.
5259 Do not confuse this with the guestfish-specific
5260 C<alloc> and C<sparse> commands which create
5261 a file in the host and attach it as a device.");
5263 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5264 [InitBasicFS, Always, TestOutput (
5265 [["set_e2label"; "/dev/sda1"; "LTEST"];
5266 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5267 "get the filesystem label",
5269 This returns the filesystem label of the filesystem on
5272 If the filesystem is unlabeled, this returns the empty string.
5274 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5276 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5277 (let uuid = uuidgen () in
5278 [InitBasicFS, Always, TestOutput (
5279 [["set_e2uuid"; "/dev/sda1"; uuid];
5280 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5281 "get the filesystem UUID",
5283 This returns the filesystem UUID of the filesystem on
5286 If the filesystem does not have a UUID, this returns the empty string.
5288 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5290 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5291 (* Can't be tested with the current framework because
5292 * the VG is being used by the mounted filesystem, so
5293 * the vgchange -an command we do first will fail.
5296 "set LVM device filter",
5298 This sets the LVM device filter so that LVM will only be
5299 able to \"see\" the block devices in the list C<devices>,
5300 and will ignore all other attached block devices.
5302 Where disk image(s) contain duplicate PVs or VGs, this
5303 command is useful to get LVM to ignore the duplicates, otherwise
5304 LVM can get confused. Note also there are two types
5305 of duplication possible: either cloned PVs/VGs which have
5306 identical UUIDs; or VGs that are not cloned but just happen
5307 to have the same name. In normal operation you cannot
5308 create this situation, but you can do it outside LVM, eg.
5309 by cloning disk images or by bit twiddling inside the LVM
5312 This command also clears the LVM cache and performs a volume
5315 You can filter whole block devices or individual partitions.
5317 You cannot use this if any VG is currently in use (eg.
5318 contains a mounted filesystem), even if you are not
5319 filtering out that VG.");
5321 ("lvm_clear_filter", (RErr, [], []), 256, [],
5322 [], (* see note on lvm_set_filter *)
5323 "clear LVM device filter",
5325 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5326 will be able to see every block device.
5328 This command also clears the LVM cache and performs a volume
5331 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5333 "open a LUKS-encrypted block device",
5335 This command opens a block device which has been encrypted
5336 according to the Linux Unified Key Setup (LUKS) standard.
5338 C<device> is the encrypted block device or partition.
5340 The caller must supply one of the keys associated with the
5341 LUKS block device, in the C<key> parameter.
5343 This creates a new block device called C</dev/mapper/mapname>.
5344 Reads and writes to this block device are decrypted from and
5345 encrypted to the underlying C<device> respectively.
5347 If this block device contains LVM volume groups, then
5348 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5349 will make them visible.");
5351 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5353 "open a LUKS-encrypted block device read-only",
5355 This is the same as C<guestfs_luks_open> except that a read-only
5356 mapping is created.");
5358 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5360 "close a LUKS device",
5362 This closes a LUKS device that was created earlier by
5363 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5364 C<device> parameter must be the name of the LUKS mapping
5365 device (ie. C</dev/mapper/mapname>) and I<not> the name
5366 of the underlying block device.");
5368 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5370 "format a block device as a LUKS encrypted device",
5372 This command erases existing data on C<device> and formats
5373 the device as a LUKS encrypted device. C<key> is the
5374 initial key, which is added to key slot C<slot>. (LUKS
5375 supports 8 key slots, numbered 0-7).");
5377 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5379 "format a block device as a LUKS encrypted device",
5381 This command is the same as C<guestfs_luks_format> but
5382 it also allows you to set the C<cipher> used.");
5384 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5386 "add a key on a LUKS encrypted device",
5388 This command adds a new key on LUKS device C<device>.
5389 C<key> is any existing key, and is used to access the device.
5390 C<newkey> is the new key to add. C<keyslot> is the key slot
5391 that will be replaced.
5393 Note that if C<keyslot> already contains a key, then this
5394 command will fail. You have to use C<guestfs_luks_kill_slot>
5395 first to remove that key.");
5397 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5399 "remove a key from a LUKS encrypted device",
5401 This command deletes the key in key slot C<keyslot> from the
5402 encrypted LUKS device C<device>. C<key> must be one of the
5405 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5406 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5407 [["is_lv"; "/dev/VG/LV"]]);
5408 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5409 [["is_lv"; "/dev/sda1"]])],
5410 "test if device is a logical volume",
5412 This command tests whether C<device> is a logical volume, and
5413 returns true iff this is the case.");
5415 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5417 "find a filesystem by UUID",
5419 This command searches the filesystems and returns the one
5420 which has the given UUID. An error is returned if no such
5421 filesystem can be found.
5423 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5425 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5427 "find a filesystem by label",
5429 This command searches the filesystems and returns the one
5430 which has the given label. An error is returned if no such
5431 filesystem can be found.
5433 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5435 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5436 [InitISOFS, Always, TestOutputFalse (
5437 [["is_chardev"; "/directory"]]);
5438 InitScratchFS, Always, TestOutputTrue (
5439 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5440 ["is_chardev"; "/is_chardev"]])],
5441 "test if character device",
5443 This returns C<true> if and only if there is a character device
5444 with the given C<path> name.
5446 See also C<guestfs_stat>.");
5448 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5449 [InitISOFS, Always, TestOutputFalse (
5450 [["is_blockdev"; "/directory"]]);
5451 InitScratchFS, Always, TestOutputTrue (
5452 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5453 ["is_blockdev"; "/is_blockdev"]])],
5454 "test if block device",
5456 This returns C<true> if and only if there is a block device
5457 with the given C<path> name.
5459 See also C<guestfs_stat>.");
5461 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5462 [InitISOFS, Always, TestOutputFalse (
5463 [["is_fifo"; "/directory"]]);
5464 InitScratchFS, Always, TestOutputTrue (
5465 [["mkfifo"; "0o777"; "/is_fifo"];
5466 ["is_fifo"; "/is_fifo"]])],
5467 "test if FIFO (named pipe)",
5469 This returns C<true> if and only if there is a FIFO (named pipe)
5470 with the given C<path> name.
5472 See also C<guestfs_stat>.");
5474 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5475 [InitISOFS, Always, TestOutputFalse (
5476 [["is_symlink"; "/directory"]]);
5477 InitISOFS, Always, TestOutputTrue (
5478 [["is_symlink"; "/abssymlink"]])],
5479 "test if symbolic link",
5481 This returns C<true> if and only if there is a symbolic link
5482 with the given C<path> name.
5484 See also C<guestfs_stat>.");
5486 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5487 (* XXX Need a positive test for sockets. *)
5488 [InitISOFS, Always, TestOutputFalse (
5489 [["is_socket"; "/directory"]])],
5492 This returns C<true> if and only if there is a Unix domain socket
5493 with the given C<path> name.
5495 See also C<guestfs_stat>.");
5497 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5498 [InitPartition, Always, TestOutputDevice (
5499 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5500 InitEmpty, Always, TestLastFail (
5501 [["part_to_dev"; "/dev/sda"]])],
5502 "convert partition name to device name",
5504 This function takes a partition name (eg. \"/dev/sdb1\") and
5505 removes the partition number, returning the device name
5508 The named partition must exist, for example as a string returned
5509 from C<guestfs_list_partitions>.");
5511 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5512 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5513 [InitScratchFS, Always, TestOutput (
5514 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5515 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5516 "upload a file from the local machine with offset",
5518 Upload local file C<filename> to C<remotefilename> on the
5521 C<remotefilename> is overwritten starting at the byte C<offset>
5522 specified. The intention is to overwrite parts of existing
5523 files or devices, although if a non-existant file is specified
5524 then it is created with a \"hole\" before C<offset>. The
5525 size of the data written is implicit in the size of the
5528 Note that there is no limit on the amount of data that
5529 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5530 and this call always writes the full amount unless an
5533 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5535 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5536 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5537 let offset = string_of_int 100 in
5538 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5539 [InitScratchFS, Always, TestOutput (
5540 (* Pick a file from cwd which isn't likely to change. *)
5541 [["mkdir"; "/download_offset"];
5542 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5543 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5544 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5545 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5546 "download a file to the local machine with offset and size",
5548 Download file C<remotefilename> and save it as C<filename>
5549 on the local machine.
5551 C<remotefilename> is read for C<size> bytes starting at C<offset>
5552 (this region must be within the file or device).
5554 Note that there is no limit on the amount of data that
5555 can be downloaded with this call, unlike with C<guestfs_pread>,
5556 and this call always reads the full amount unless an
5559 See also C<guestfs_download>, C<guestfs_pread>.");
5561 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5562 [InitPartition, Always, TestOutputListOfDevices (
5563 [["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"];
5564 ["blockdev_rereadpt"; "/dev/sda"];
5565 ["list_partitions"]], ["/dev/sdb1"])],
5566 "write to part of a device",
5568 This command writes to part of a device. It writes the data
5569 buffer C<content> to C<device> starting at offset C<offset>.
5571 This command implements the L<pwrite(2)> system call, and like
5572 that system call it may not write the full data requested
5573 (although short writes to disk devices and partitions are
5574 probably impossible with standard Linux kernels).
5576 See also C<guestfs_pwrite>.");
5578 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5579 [InitEmpty, Always, TestOutputBuffer (
5580 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5581 "read part of a device",
5583 This command lets you read part of a file. It reads C<count>
5584 bytes of C<device>, starting at C<offset>.
5586 This may read fewer bytes than requested. For further details
5587 see the L<pread(2)> system call.
5589 See also C<guestfs_pread>.");
5591 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5592 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5593 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5594 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5595 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5596 "get canonical name of an LV",
5598 This converts alternative naming schemes for LVs that you
5599 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5600 is converted to C</dev/VG/LV>.
5602 This command returns an error if the C<lvname> parameter does
5603 not refer to a logical volume.
5605 See also C<guestfs_is_lv>.");
5607 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"]), 278, [],
5608 [InitEmpty, Always, TestOutput (
5609 [["part_disk"; "/dev/sda"; "mbr"];
5610 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"];
5611 ["mount_options"; ""; "/dev/sda1"; "/"];
5612 ["write"; "/new"; "new file contents"];
5613 ["cat"; "/new"]], "new file contents")],
5614 "make a filesystem",
5616 This function creates a filesystem on C<device>. The filesystem
5617 type is C<fstype>, for example C<ext3>.
5619 The optional arguments are:
5625 The filesystem block size. Supported block sizes depend on the
5626 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5627 for Linux ext2/3 filesystems.
5629 For VFAT and NTFS the C<blocksize> parameter is treated as
5630 the requested cluster size.
5634 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5636 "get a single extended attribute",
5638 Get a single extended attribute from file C<path> named C<name>.
5639 This call follows symlinks. If you want to lookup an extended
5640 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5642 Normally it is better to get all extended attributes from a file
5643 in one go by calling C<guestfs_getxattrs>. However some Linux
5644 filesystem implementations are buggy and do not provide a way to
5645 list out attributes. For these filesystems (notably ntfs-3g)
5646 you have to know the names of the extended attributes you want
5647 in advance and call this function.
5649 Extended attribute values are blobs of binary data. If there
5650 is no extended attribute named C<name>, this returns an error.
5652 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5654 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5656 "get a single extended attribute",
5658 Get a single extended attribute from file C<path> named C<name>.
5659 If C<path> is a symlink, then this call returns an extended
5660 attribute from the symlink.
5662 Normally it is better to get all extended attributes from a file
5663 in one go by calling C<guestfs_getxattrs>. However some Linux
5664 filesystem implementations are buggy and do not provide a way to
5665 list out attributes. For these filesystems (notably ntfs-3g)
5666 you have to know the names of the extended attributes you want
5667 in advance and call this function.
5669 Extended attribute values are blobs of binary data. If there
5670 is no extended attribute named C<name>, this returns an error.
5672 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5676 let all_functions = non_daemon_functions @ daemon_functions
5678 (* In some places we want the functions to be displayed sorted
5679 * alphabetically, so this is useful:
5681 let all_functions_sorted = List.sort action_compare all_functions
5683 (* This is used to generate the src/MAX_PROC_NR file which
5684 * contains the maximum procedure number, a surrogate for the
5685 * ABI version number. See src/Makefile.am for the details.
5688 let proc_nrs = List.map (
5689 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5690 ) daemon_functions in
5691 List.fold_left max 0 proc_nrs
5693 (* Non-API meta-commands available only in guestfish.
5695 * Note (1): style, proc_nr and tests fields are all meaningless.
5696 * The only fields which are actually used are the shortname,
5697 * FishAlias flags, shortdesc and longdesc.
5699 * Note (2): to refer to other commands, use L</shortname>.
5701 * Note (3): keep this list sorted by shortname.
5703 let fish_commands = [
5704 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5705 "allocate and add a disk file",
5706 " alloc filename size
5708 This creates an empty (zeroed) file of the given size, and then adds
5709 so it can be further examined.
5711 For more advanced image creation, see L<qemu-img(1)> utility.
5713 Size can be specified using standard suffixes, eg. C<1M>.
5715 To create a sparse file, use L</sparse> instead. To create a
5716 prepared disk image, see L</PREPARED DISK IMAGES>.");
5718 ("copy_in", (RErr,[], []), -1, [], [],
5719 "copy local files or directories into an image",
5720 " copy-in local [local ...] /remotedir
5722 C<copy-in> copies local files or directories recursively into the disk
5723 image, placing them in the directory called C</remotedir> (which must
5724 exist). This guestfish meta-command turns into a sequence of
5725 L</tar-in> and other commands as necessary.
5727 Multiple local files and directories can be specified, but the last
5728 parameter must always be a remote directory. Wildcards cannot be
5731 ("copy_out", (RErr,[], []), -1, [], [],
5732 "copy remote files or directories out of an image",
5733 " copy-out remote [remote ...] localdir
5735 C<copy-out> copies remote files or directories recursively out of the
5736 disk image, placing them on the host disk in a local directory called
5737 C<localdir> (which must exist). This guestfish meta-command turns
5738 into a sequence of L</download>, L</tar-out> and other commands as
5741 Multiple remote files and directories can be specified, but the last
5742 parameter must always be a local directory. To download to the
5743 current directory, use C<.> as in:
5747 Wildcards cannot be used in the ordinary command, but you can use
5748 them with the help of L</glob> like this:
5750 glob copy-out /home/* .");
5752 ("echo", (RErr,[], []), -1, [], [],
5753 "display a line of text",
5756 This echos the parameters to the terminal.");
5758 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5762 This is used to edit a file. It downloads the file, edits it
5763 locally using your editor, then uploads the result.
5765 The editor is C<$EDITOR>. However if you use the alternate
5766 commands C<vi> or C<emacs> you will get those corresponding
5769 ("glob", (RErr,[], []), -1, [], [],
5770 "expand wildcards in command",
5771 " glob command args...
5773 Expand wildcards in any paths in the args list, and run C<command>
5774 repeatedly on each matching path.
5776 See L</WILDCARDS AND GLOBBING>.");
5778 ("hexedit", (RErr,[], []), -1, [], [],
5779 "edit with a hex editor",
5780 " hexedit <filename|device>
5781 hexedit <filename|device> <max>
5782 hexedit <filename|device> <start> <max>
5784 Use hexedit (a hex editor) to edit all or part of a binary file
5787 This command works by downloading potentially the whole file or
5788 device, editing it locally, then uploading it. If the file or
5789 device is large, you have to specify which part you wish to edit
5790 by using C<max> and/or C<start> C<max> parameters.
5791 C<start> and C<max> are specified in bytes, with the usual
5792 modifiers allowed such as C<1M> (1 megabyte).
5794 For example to edit the first few sectors of a disk you
5799 which would allow you to edit anywhere within the first megabyte
5802 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5804 hexedit /dev/sda1 0x400 0x400
5806 (assuming the superblock is in the standard location).
5808 This command requires the external L<hexedit(1)> program. You
5809 can specify another program to use by setting the C<HEXEDITOR>
5810 environment variable.
5812 See also L</hexdump>.");
5814 ("lcd", (RErr,[], []), -1, [], [],
5815 "change working directory",
5818 Change the local directory, ie. the current directory of guestfish
5821 Note that C<!cd> won't do what you might expect.");
5823 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5827 Opens the manual page for guestfish.");
5829 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5835 This is used to view a file.
5837 The default viewer is C<$PAGER>. However if you use the alternate
5838 command C<less> you will get the C<less> command specifically.");
5840 ("reopen", (RErr,[], []), -1, [], [],
5841 "close and reopen libguestfs handle",
5844 Close and reopen the libguestfs handle. It is not necessary to use
5845 this normally, because the handle is closed properly when guestfish
5846 exits. However this is occasionally useful for testing.");
5848 ("sparse", (RErr,[], []), -1, [], [],
5849 "create a sparse disk image and add",
5850 " sparse filename size
5852 This creates an empty sparse file of the given size, and then adds
5853 so it can be further examined.
5855 In all respects it works the same as the L</alloc> command, except that
5856 the image file is allocated sparsely, which means that disk blocks are
5857 not assigned to the file until they are needed. Sparse disk files
5858 only use space when written to, but they are slower and there is a
5859 danger you could run out of real disk space during a write operation.
5861 For more advanced image creation, see L<qemu-img(1)> utility.
5863 Size can be specified using standard suffixes, eg. C<1M>.");
5865 ("supported", (RErr,[], []), -1, [], [],
5866 "list supported groups of commands",
5869 This command returns a list of the optional groups
5870 known to the daemon, and indicates which ones are
5871 supported by this build of the libguestfs appliance.
5873 See also L<guestfs(3)/AVAILABILITY>.");
5875 ("time", (RErr,[], []), -1, [], [],
5876 "print elapsed time taken to run a command",
5877 " time command args...
5879 Run the command as usual, but print the elapsed time afterwards. This
5880 can be useful for benchmarking operations.");