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
1098 details). If you are using the C API directly then it is more
1099 flexible to create the libvirt connection object yourself, get
1100 the domain object, and call C<guestfs_add_libvirt_dom>.
1102 The other optional parameters are passed directly through to
1103 C<guestfs_add_drive_opts>.");
1106 This interface is not quite baked yet. -- RWMJ 2010-11-11
1107 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"]), -1, [NotInFish],
1109 "add the disk(s) from a libvirt domain",
1111 This function adds the disk(s) attached to the libvirt domain C<dom>.
1112 It works by requesting the domain XML from libvirt, parsing it for
1113 disks, and calling C<guestfs_add_drive_opts> on each one.
1115 In the C API we declare C<void *dom>, but really it has type
1116 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1118 The number of disks added is returned. This operation is atomic:
1119 if an error is returned, then no disks are added.
1121 This function does some minimal checks to make sure the libvirt
1122 domain is not running (unless C<readonly> is true). In a future
1123 version we will try to acquire the libvirt lock on each disk.
1125 Disks must be accessible locally. This often means that adding disks
1126 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1127 will fail unless those disks are accessible via the same device path
1130 The optional parameters are passed directly through to
1131 C<guestfs_add_drive_opts>.");
1134 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1136 "get package format used by the operating system",
1138 This function should only be called with a root device string
1139 as returned by C<guestfs_inspect_os>.
1141 This function and C<guestfs_inspect_get_package_management> return
1142 the package format and package management tool used by the
1143 inspected operating system. For example for Fedora these
1144 functions would return C<rpm> (package format) and
1145 C<yum> (package management).
1147 This returns the string C<unknown> if we could not determine the
1148 package format I<or> if the operating system does not have
1149 a real packaging system (eg. Windows).
1151 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1152 Future versions of libguestfs may return other strings.
1154 Please read L<guestfs(3)/INSPECTION> for more details.");
1156 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1158 "get package management tool used by the operating system",
1160 This function should only be called with a root device string
1161 as returned by C<guestfs_inspect_os>.
1163 C<guestfs_inspect_get_package_format> and this function return
1164 the package format and package management tool used by the
1165 inspected operating system. For example for Fedora these
1166 functions would return C<rpm> (package format) and
1167 C<yum> (package management).
1169 This returns the string C<unknown> if we could not determine the
1170 package management tool I<or> if the operating system does not have
1171 a real packaging system (eg. Windows).
1173 Possible strings include: C<yum>, C<up2date>,
1174 C<apt> (for all Debian derivatives),
1175 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1176 Future versions of libguestfs may return other strings.
1178 Please read L<guestfs(3)/INSPECTION> for more details.");
1180 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1182 "get list of applications installed in the operating system",
1184 This function should only be called with a root device string
1185 as returned by C<guestfs_inspect_os>.
1187 Return the list of applications installed in the operating system.
1189 I<Note:> This call works differently from other parts of the
1190 inspection API. You have to call C<guestfs_inspect_os>, then
1191 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1192 before calling this. Listing applications is a significantly
1193 more difficult operation which requires access to the full
1194 filesystem. Also note that unlike the other
1195 C<guestfs_inspect_get_*> calls which are just returning
1196 data cached in the libguestfs handle, this call actually reads
1197 parts of the mounted filesystems during the call.
1199 This returns an empty list if the inspection code was not able
1200 to determine the list of applications.
1202 The application structure contains the following fields:
1208 The name of the application. For Red Hat-derived and Debian-derived
1209 Linux guests, this is the package name.
1211 =item C<app_display_name>
1213 The display name of the application, sometimes localized to the
1214 install language of the guest operating system.
1216 If unavailable this is returned as an empty string C<\"\">.
1217 Callers needing to display something can use C<app_name> instead.
1221 For package managers which use epochs, this contains the epoch of
1222 the package (an integer). If unavailable, this is returned as C<0>.
1224 =item C<app_version>
1226 The version string of the application or package. If unavailable
1227 this is returned as an empty string C<\"\">.
1229 =item C<app_release>
1231 The release string of the application or package, for package
1232 managers that use this. If unavailable this is returned as an
1233 empty string C<\"\">.
1235 =item C<app_install_path>
1237 The installation path of the application (on operating systems
1238 such as Windows which use installation paths). This path is
1239 in the format used by the guest operating system, it is not
1242 If unavailable this is returned as an empty string C<\"\">.
1244 =item C<app_trans_path>
1246 The install path translated into a libguestfs path.
1247 If unavailable this is returned as an empty string C<\"\">.
1249 =item C<app_publisher>
1251 The name of the publisher of the application, for package
1252 managers that use this. If unavailable this is returned
1253 as an empty string C<\"\">.
1257 The URL (eg. upstream URL) of the application.
1258 If unavailable this is returned as an empty string C<\"\">.
1260 =item C<app_source_package>
1262 For packaging systems which support this, the name of the source
1263 package. If unavailable this is returned as an empty string C<\"\">.
1265 =item C<app_summary>
1267 A short (usually one line) description of the application or package.
1268 If unavailable this is returned as an empty string C<\"\">.
1270 =item C<app_description>
1272 A longer description of the application or package.
1273 If unavailable this is returned as an empty string C<\"\">.
1277 Please read L<guestfs(3)/INSPECTION> for more details.");
1279 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1281 "get hostname of the operating system",
1283 This function should only be called with a root device string
1284 as returned by C<guestfs_inspect_os>.
1286 This function returns the hostname of the operating system
1287 as found by inspection of the guest's configuration files.
1289 If the hostname could not be determined, then the
1290 string C<unknown> is returned.
1292 Please read L<guestfs(3)/INSPECTION> for more details.");
1296 (* daemon_functions are any functions which cause some action
1297 * to take place in the daemon.
1300 let daemon_functions = [
1301 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1302 [InitEmpty, Always, TestOutput (
1303 [["part_disk"; "/dev/sda"; "mbr"];
1304 ["mkfs"; "ext2"; "/dev/sda1"];
1305 ["mount"; "/dev/sda1"; "/"];
1306 ["write"; "/new"; "new file contents"];
1307 ["cat"; "/new"]], "new file contents")],
1308 "mount a guest disk at a position in the filesystem",
1310 Mount a guest disk at a position in the filesystem. Block devices
1311 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1312 the guest. If those block devices contain partitions, they will have
1313 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1316 The rules are the same as for L<mount(2)>: A filesystem must
1317 first be mounted on C</> before others can be mounted. Other
1318 filesystems can only be mounted on directories which already
1321 The mounted filesystem is writable, if we have sufficient permissions
1322 on the underlying device.
1325 When you use this call, the filesystem options C<sync> and C<noatime>
1326 are set implicitly. This was originally done because we thought it
1327 would improve reliability, but it turns out that I<-o sync> has a
1328 very large negative performance impact and negligible effect on
1329 reliability. Therefore we recommend that you avoid using
1330 C<guestfs_mount> in any code that needs performance, and instead
1331 use C<guestfs_mount_options> (use an empty string for the first
1332 parameter if you don't want any options).");
1334 ("sync", (RErr, [], []), 2, [],
1335 [ InitEmpty, Always, TestRun [["sync"]]],
1336 "sync disks, writes are flushed through to the disk image",
1338 This syncs the disk, so that any writes are flushed through to the
1339 underlying disk image.
1341 You should always call this if you have modified a disk image, before
1342 closing the handle.");
1344 ("touch", (RErr, [Pathname "path"], []), 3, [],
1345 [InitScratchFS, Always, TestOutputTrue (
1346 [["touch"; "/touch"];
1347 ["exists"; "/touch"]])],
1348 "update file timestamps or create a new file",
1350 Touch acts like the L<touch(1)> command. It can be used to
1351 update the timestamps on a file, or, if the file does not exist,
1352 to create a new zero-length file.
1354 This command only works on regular files, and will fail on other
1355 file types such as directories, symbolic links, block special etc.");
1357 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1358 [InitISOFS, Always, TestOutput (
1359 [["cat"; "/known-2"]], "abcdef\n")],
1360 "list the contents of a file",
1362 Return the contents of the file named C<path>.
1364 Note that this function cannot correctly handle binary files
1365 (specifically, files containing C<\\0> character which is treated
1366 as end of string). For those you need to use the C<guestfs_read_file>
1367 or C<guestfs_download> functions which have a more complex interface.");
1369 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1370 [], (* XXX Tricky to test because it depends on the exact format
1371 * of the 'ls -l' command, which changes between F10 and F11.
1373 "list the files in a directory (long format)",
1375 List the files in C<directory> (relative to the root directory,
1376 there is no cwd) in the format of 'ls -la'.
1378 This command is mostly useful for interactive sessions. It
1379 is I<not> intended that you try to parse the output string.");
1381 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1382 [InitScratchFS, Always, TestOutputList (
1384 ["touch"; "/ls/new"];
1385 ["touch"; "/ls/newer"];
1386 ["touch"; "/ls/newest"];
1387 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1388 "list the files in a directory",
1390 List the files in C<directory> (relative to the root directory,
1391 there is no cwd). The '.' and '..' entries are not returned, but
1392 hidden files are shown.
1394 This command is mostly useful for interactive sessions. Programs
1395 should probably use C<guestfs_readdir> instead.");
1397 ("list_devices", (RStringList "devices", [], []), 7, [],
1398 [InitEmpty, Always, TestOutputListOfDevices (
1399 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1400 "list the block devices",
1402 List all the block devices.
1404 The full block device names are returned, eg. C</dev/sda>.
1406 See also C<guestfs_list_filesystems>.");
1408 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1409 [InitBasicFS, Always, TestOutputListOfDevices (
1410 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1411 InitEmpty, Always, TestOutputListOfDevices (
1412 [["part_init"; "/dev/sda"; "mbr"];
1413 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1414 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1415 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1416 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1417 "list the partitions",
1419 List all the partitions detected on all block devices.
1421 The full partition device names are returned, eg. C</dev/sda1>
1423 This does not return logical volumes. For that you will need to
1424 call C<guestfs_lvs>.
1426 See also C<guestfs_list_filesystems>.");
1428 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1429 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1430 [["pvs"]], ["/dev/sda1"]);
1431 InitEmpty, Always, TestOutputListOfDevices (
1432 [["part_init"; "/dev/sda"; "mbr"];
1433 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1434 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1435 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1436 ["pvcreate"; "/dev/sda1"];
1437 ["pvcreate"; "/dev/sda2"];
1438 ["pvcreate"; "/dev/sda3"];
1439 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1440 "list the LVM physical volumes (PVs)",
1442 List all the physical volumes detected. This is the equivalent
1443 of the L<pvs(8)> command.
1445 This returns a list of just the device names that contain
1446 PVs (eg. C</dev/sda2>).
1448 See also C<guestfs_pvs_full>.");
1450 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1451 [InitBasicFSonLVM, Always, TestOutputList (
1453 InitEmpty, Always, TestOutputList (
1454 [["part_init"; "/dev/sda"; "mbr"];
1455 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1456 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1457 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1458 ["pvcreate"; "/dev/sda1"];
1459 ["pvcreate"; "/dev/sda2"];
1460 ["pvcreate"; "/dev/sda3"];
1461 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1462 ["vgcreate"; "VG2"; "/dev/sda3"];
1463 ["vgs"]], ["VG1"; "VG2"])],
1464 "list the LVM volume groups (VGs)",
1466 List all the volumes groups detected. This is the equivalent
1467 of the L<vgs(8)> command.
1469 This returns a list of just the volume group names that were
1470 detected (eg. C<VolGroup00>).
1472 See also C<guestfs_vgs_full>.");
1474 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1475 [InitBasicFSonLVM, Always, TestOutputList (
1476 [["lvs"]], ["/dev/VG/LV"]);
1477 InitEmpty, Always, TestOutputList (
1478 [["part_init"; "/dev/sda"; "mbr"];
1479 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1480 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1481 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1482 ["pvcreate"; "/dev/sda1"];
1483 ["pvcreate"; "/dev/sda2"];
1484 ["pvcreate"; "/dev/sda3"];
1485 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1486 ["vgcreate"; "VG2"; "/dev/sda3"];
1487 ["lvcreate"; "LV1"; "VG1"; "50"];
1488 ["lvcreate"; "LV2"; "VG1"; "50"];
1489 ["lvcreate"; "LV3"; "VG2"; "50"];
1490 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1491 "list the LVM logical volumes (LVs)",
1493 List all the logical volumes detected. This is the equivalent
1494 of the L<lvs(8)> command.
1496 This returns a list of the logical volume device names
1497 (eg. C</dev/VolGroup00/LogVol00>).
1499 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1501 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1502 [], (* XXX how to test? *)
1503 "list the LVM physical volumes (PVs)",
1505 List all the physical volumes detected. This is the equivalent
1506 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1508 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1509 [], (* XXX how to test? *)
1510 "list the LVM volume groups (VGs)",
1512 List all the volumes groups detected. This is the equivalent
1513 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1515 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1516 [], (* XXX how to test? *)
1517 "list the LVM logical volumes (LVs)",
1519 List all the logical volumes detected. This is the equivalent
1520 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1522 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1523 [InitISOFS, Always, TestOutputList (
1524 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1525 InitISOFS, Always, TestOutputList (
1526 [["read_lines"; "/empty"]], [])],
1527 "read file as lines",
1529 Return the contents of the file named C<path>.
1531 The file contents are returned as a list of lines. Trailing
1532 C<LF> and C<CRLF> character sequences are I<not> returned.
1534 Note that this function cannot correctly handle binary files
1535 (specifically, files containing C<\\0> character which is treated
1536 as end of line). For those you need to use the C<guestfs_read_file>
1537 function which has a more complex interface.");
1539 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1540 [], (* XXX Augeas code needs tests. *)
1541 "create a new Augeas handle",
1543 Create a new Augeas handle for editing configuration files.
1544 If there was any previous Augeas handle associated with this
1545 guestfs session, then it is closed.
1547 You must call this before using any other C<guestfs_aug_*>
1550 C<root> is the filesystem root. C<root> must not be NULL,
1553 The flags are the same as the flags defined in
1554 E<lt>augeas.hE<gt>, the logical I<or> of the following
1559 =item C<AUG_SAVE_BACKUP> = 1
1561 Keep the original file with a C<.augsave> extension.
1563 =item C<AUG_SAVE_NEWFILE> = 2
1565 Save changes into a file with extension C<.augnew>, and
1566 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1568 =item C<AUG_TYPE_CHECK> = 4
1570 Typecheck lenses (can be expensive).
1572 =item C<AUG_NO_STDINC> = 8
1574 Do not use standard load path for modules.
1576 =item C<AUG_SAVE_NOOP> = 16
1578 Make save a no-op, just record what would have been changed.
1580 =item C<AUG_NO_LOAD> = 32
1582 Do not load the tree in C<guestfs_aug_init>.
1586 To close the handle, you can call C<guestfs_aug_close>.
1588 To find out more about Augeas, see L<http://augeas.net/>.");
1590 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1591 [], (* XXX Augeas code needs tests. *)
1592 "close the current Augeas handle",
1594 Close the current Augeas handle and free up any resources
1595 used by it. After calling this, you have to call
1596 C<guestfs_aug_init> again before you can use any other
1597 Augeas functions.");
1599 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1600 [], (* XXX Augeas code needs tests. *)
1601 "define an Augeas variable",
1603 Defines an Augeas variable C<name> whose value is the result
1604 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1607 On success this returns the number of nodes in C<expr>, or
1608 C<0> if C<expr> evaluates to something which is not a nodeset.");
1610 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1611 [], (* XXX Augeas code needs tests. *)
1612 "define an Augeas node",
1614 Defines a variable C<name> whose value is the result of
1617 If C<expr> evaluates to an empty nodeset, a node is created,
1618 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1619 C<name> will be the nodeset containing that single node.
1621 On success this returns a pair containing the
1622 number of nodes in the nodeset, and a boolean flag
1623 if a node was created.");
1625 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1626 [], (* XXX Augeas code needs tests. *)
1627 "look up the value of an Augeas path",
1629 Look up the value associated with C<path>. If C<path>
1630 matches exactly one node, the C<value> is returned.");
1632 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1633 [], (* XXX Augeas code needs tests. *)
1634 "set Augeas path to value",
1636 Set the value associated with C<path> to C<val>.
1638 In the Augeas API, it is possible to clear a node by setting
1639 the value to NULL. Due to an oversight in the libguestfs API
1640 you cannot do that with this call. Instead you must use the
1641 C<guestfs_aug_clear> call.");
1643 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1644 [], (* XXX Augeas code needs tests. *)
1645 "insert a sibling Augeas node",
1647 Create a new sibling C<label> for C<path>, inserting it into
1648 the tree before or after C<path> (depending on the boolean
1651 C<path> must match exactly one existing node in the tree, and
1652 C<label> must be a label, ie. not contain C</>, C<*> or end
1653 with a bracketed index C<[N]>.");
1655 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1656 [], (* XXX Augeas code needs tests. *)
1657 "remove an Augeas path",
1659 Remove C<path> and all of its children.
1661 On success this returns the number of entries which were removed.");
1663 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1664 [], (* XXX Augeas code needs tests. *)
1667 Move the node C<src> to C<dest>. C<src> must match exactly
1668 one node. C<dest> is overwritten if it exists.");
1670 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1671 [], (* XXX Augeas code needs tests. *)
1672 "return Augeas nodes which match augpath",
1674 Returns a list of paths which match the path expression C<path>.
1675 The returned paths are sufficiently qualified so that they match
1676 exactly one node in the current tree.");
1678 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1679 [], (* XXX Augeas code needs tests. *)
1680 "write all pending Augeas changes to disk",
1682 This writes all pending changes to disk.
1684 The flags which were passed to C<guestfs_aug_init> affect exactly
1685 how files are saved.");
1687 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1688 [], (* XXX Augeas code needs tests. *)
1689 "load files into the tree",
1691 Load files into the tree.
1693 See C<aug_load> in the Augeas documentation for the full gory
1696 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1697 [], (* XXX Augeas code needs tests. *)
1698 "list Augeas nodes under augpath",
1700 This is just a shortcut for listing C<guestfs_aug_match>
1701 C<path/*> and sorting the resulting nodes into alphabetical order.");
1703 ("rm", (RErr, [Pathname "path"], []), 29, [],
1704 [InitScratchFS, Always, TestRun
1706 ["touch"; "/rm/new"];
1708 InitScratchFS, Always, TestLastFail
1709 [["rm"; "/nosuchfile"]];
1710 InitScratchFS, Always, TestLastFail
1715 Remove the single file C<path>.");
1717 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1718 [InitScratchFS, Always, TestRun
1719 [["mkdir"; "/rmdir"];
1720 ["rmdir"; "/rmdir"]];
1721 InitScratchFS, Always, TestLastFail
1722 [["rmdir"; "/rmdir2"]];
1723 InitScratchFS, Always, TestLastFail
1724 [["mkdir"; "/rmdir3"];
1725 ["touch"; "/rmdir3/new"];
1726 ["rmdir"; "/rmdir3/new"]]],
1727 "remove a directory",
1729 Remove the single directory C<path>.");
1731 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1732 [InitScratchFS, Always, TestOutputFalse
1733 [["mkdir"; "/rm_rf"];
1734 ["mkdir"; "/rm_rf/foo"];
1735 ["touch"; "/rm_rf/foo/bar"];
1736 ["rm_rf"; "/rm_rf"];
1737 ["exists"; "/rm_rf"]]],
1738 "remove a file or directory recursively",
1740 Remove the file or directory C<path>, recursively removing the
1741 contents if its a directory. This is like the C<rm -rf> shell
1744 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1745 [InitScratchFS, Always, TestOutputTrue
1746 [["mkdir"; "/mkdir"];
1747 ["is_dir"; "/mkdir"]];
1748 InitScratchFS, Always, TestLastFail
1749 [["mkdir"; "/mkdir2/foo/bar"]]],
1750 "create a directory",
1752 Create a directory named C<path>.");
1754 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1755 [InitScratchFS, Always, TestOutputTrue
1756 [["mkdir_p"; "/mkdir_p/foo/bar"];
1757 ["is_dir"; "/mkdir_p/foo/bar"]];
1758 InitScratchFS, Always, TestOutputTrue
1759 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1760 ["is_dir"; "/mkdir_p2/foo"]];
1761 InitScratchFS, Always, TestOutputTrue
1762 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1763 ["is_dir"; "/mkdir_p3"]];
1764 (* Regression tests for RHBZ#503133: *)
1765 InitScratchFS, Always, TestRun
1766 [["mkdir"; "/mkdir_p4"];
1767 ["mkdir_p"; "/mkdir_p4"]];
1768 InitScratchFS, Always, TestLastFail
1769 [["touch"; "/mkdir_p5"];
1770 ["mkdir_p"; "/mkdir_p5"]]],
1771 "create a directory and parents",
1773 Create a directory named C<path>, creating any parent directories
1774 as necessary. This is like the C<mkdir -p> shell command.");
1776 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1777 [], (* XXX Need stat command to test *)
1780 Change the mode (permissions) of C<path> to C<mode>. Only
1781 numeric modes are supported.
1783 I<Note>: When using this command from guestfish, C<mode>
1784 by default would be decimal, unless you prefix it with
1785 C<0> to get octal, ie. use C<0700> not C<700>.
1787 The mode actually set is affected by the umask.");
1789 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1790 [], (* XXX Need stat command to test *)
1791 "change file owner and group",
1793 Change the file owner to C<owner> and group to C<group>.
1795 Only numeric uid and gid are supported. If you want to use
1796 names, you will need to locate and parse the password file
1797 yourself (Augeas support makes this relatively easy).");
1799 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1800 [InitISOFS, Always, TestOutputTrue (
1801 [["exists"; "/empty"]]);
1802 InitISOFS, Always, TestOutputTrue (
1803 [["exists"; "/directory"]])],
1804 "test if file or directory exists",
1806 This returns C<true> if and only if there is a file, directory
1807 (or anything) with the given C<path> name.
1809 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1811 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1812 [InitISOFS, Always, TestOutputTrue (
1813 [["is_file"; "/known-1"]]);
1814 InitISOFS, Always, TestOutputFalse (
1815 [["is_file"; "/directory"]])],
1816 "test if a regular file",
1818 This returns C<true> if and only if there is a regular file
1819 with the given C<path> name. Note that it returns false for
1820 other objects like directories.
1822 See also C<guestfs_stat>.");
1824 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1825 [InitISOFS, Always, TestOutputFalse (
1826 [["is_dir"; "/known-3"]]);
1827 InitISOFS, Always, TestOutputTrue (
1828 [["is_dir"; "/directory"]])],
1829 "test if a directory",
1831 This returns C<true> if and only if there is a directory
1832 with the given C<path> name. Note that it returns false for
1833 other objects like files.
1835 See also C<guestfs_stat>.");
1837 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1838 [InitEmpty, Always, TestOutputListOfDevices (
1839 [["part_init"; "/dev/sda"; "mbr"];
1840 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1841 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1842 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1843 ["pvcreate"; "/dev/sda1"];
1844 ["pvcreate"; "/dev/sda2"];
1845 ["pvcreate"; "/dev/sda3"];
1846 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1847 "create an LVM physical volume",
1849 This creates an LVM physical volume on the named C<device>,
1850 where C<device> should usually be a partition name such
1853 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1854 [InitEmpty, Always, TestOutputList (
1855 [["part_init"; "/dev/sda"; "mbr"];
1856 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1857 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1858 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1859 ["pvcreate"; "/dev/sda1"];
1860 ["pvcreate"; "/dev/sda2"];
1861 ["pvcreate"; "/dev/sda3"];
1862 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1863 ["vgcreate"; "VG2"; "/dev/sda3"];
1864 ["vgs"]], ["VG1"; "VG2"])],
1865 "create an LVM volume group",
1867 This creates an LVM volume group called C<volgroup>
1868 from the non-empty list of physical volumes C<physvols>.");
1870 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1871 [InitEmpty, Always, TestOutputList (
1872 [["part_init"; "/dev/sda"; "mbr"];
1873 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1874 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1875 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1876 ["pvcreate"; "/dev/sda1"];
1877 ["pvcreate"; "/dev/sda2"];
1878 ["pvcreate"; "/dev/sda3"];
1879 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1880 ["vgcreate"; "VG2"; "/dev/sda3"];
1881 ["lvcreate"; "LV1"; "VG1"; "50"];
1882 ["lvcreate"; "LV2"; "VG1"; "50"];
1883 ["lvcreate"; "LV3"; "VG2"; "50"];
1884 ["lvcreate"; "LV4"; "VG2"; "50"];
1885 ["lvcreate"; "LV5"; "VG2"; "50"];
1887 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1888 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1889 "create an LVM logical volume",
1891 This creates an LVM logical volume called C<logvol>
1892 on the volume group C<volgroup>, with C<size> megabytes.");
1894 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1895 [InitEmpty, Always, TestOutput (
1896 [["part_disk"; "/dev/sda"; "mbr"];
1897 ["mkfs"; "ext2"; "/dev/sda1"];
1898 ["mount_options"; ""; "/dev/sda1"; "/"];
1899 ["write"; "/new"; "new file contents"];
1900 ["cat"; "/new"]], "new file contents")],
1901 "make a filesystem",
1903 This creates a filesystem on C<device> (usually a partition
1904 or LVM logical volume). The filesystem type is C<fstype>, for
1907 ("sfdisk", (RErr, [Device "device";
1908 Int "cyls"; Int "heads"; Int "sectors";
1909 StringList "lines"], []), 43, [DangerWillRobinson],
1911 "create partitions on a block device",
1913 This is a direct interface to the L<sfdisk(8)> program for creating
1914 partitions on block devices.
1916 C<device> should be a block device, for example C</dev/sda>.
1918 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1919 and sectors on the device, which are passed directly to sfdisk as
1920 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1921 of these, then the corresponding parameter is omitted. Usually for
1922 'large' disks, you can just pass C<0> for these, but for small
1923 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1924 out the right geometry and you will need to tell it.
1926 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1927 information refer to the L<sfdisk(8)> manpage.
1929 To create a single partition occupying the whole disk, you would
1930 pass C<lines> as a single element list, when the single element being
1931 the string C<,> (comma).
1933 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1934 C<guestfs_part_init>");
1936 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1937 (* Regression test for RHBZ#597135. *)
1938 [InitScratchFS, Always, TestLastFail
1939 [["write_file"; "/write_file"; "abc"; "10000"]]],
1942 This call creates a file called C<path>. The contents of the
1943 file is the string C<content> (which can contain any 8 bit data),
1944 with length C<size>.
1946 As a special case, if C<size> is C<0>
1947 then the length is calculated using C<strlen> (so in this case
1948 the content cannot contain embedded ASCII NULs).
1950 I<NB.> Owing to a bug, writing content containing ASCII NUL
1951 characters does I<not> work, even if the length is specified.");
1953 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1954 [InitEmpty, Always, TestOutputListOfDevices (
1955 [["part_disk"; "/dev/sda"; "mbr"];
1956 ["mkfs"; "ext2"; "/dev/sda1"];
1957 ["mount_options"; ""; "/dev/sda1"; "/"];
1958 ["mounts"]], ["/dev/sda1"]);
1959 InitEmpty, Always, TestOutputList (
1960 [["part_disk"; "/dev/sda"; "mbr"];
1961 ["mkfs"; "ext2"; "/dev/sda1"];
1962 ["mount_options"; ""; "/dev/sda1"; "/"];
1965 "unmount a filesystem",
1967 This unmounts the given filesystem. The filesystem may be
1968 specified either by its mountpoint (path) or the device which
1969 contains the filesystem.");
1971 ("mounts", (RStringList "devices", [], []), 46, [],
1972 [InitScratchFS, Always, TestOutputListOfDevices (
1973 [["mounts"]], ["/dev/sdb1"])],
1974 "show mounted filesystems",
1976 This returns the list of currently mounted filesystems. It returns
1977 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1979 Some internal mounts are not shown.
1981 See also: C<guestfs_mountpoints>");
1983 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1984 [InitScratchFS, Always, TestOutputList (
1987 (* check that umount_all can unmount nested mounts correctly: *)
1988 InitEmpty, Always, TestOutputList (
1989 [["part_init"; "/dev/sda"; "mbr"];
1990 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1991 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1992 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1993 ["mkfs"; "ext2"; "/dev/sda1"];
1994 ["mkfs"; "ext2"; "/dev/sda2"];
1995 ["mkfs"; "ext2"; "/dev/sda3"];
1996 ["mount_options"; ""; "/dev/sda1"; "/"];
1998 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1999 ["mkdir"; "/mp1/mp2"];
2000 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2001 ["mkdir"; "/mp1/mp2/mp3"];
2004 "unmount all filesystems",
2006 This unmounts all mounted filesystems.
2008 Some internal mounts are not unmounted by this call.");
2010 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2012 "remove all LVM LVs, VGs and PVs",
2014 This command removes all LVM logical volumes, volume groups
2015 and physical volumes.");
2017 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2018 [InitISOFS, Always, TestOutput (
2019 [["file"; "/empty"]], "empty");
2020 InitISOFS, Always, TestOutput (
2021 [["file"; "/known-1"]], "ASCII text");
2022 InitISOFS, Always, TestLastFail (
2023 [["file"; "/notexists"]]);
2024 InitISOFS, Always, TestOutput (
2025 [["file"; "/abssymlink"]], "symbolic link");
2026 InitISOFS, Always, TestOutput (
2027 [["file"; "/directory"]], "directory")],
2028 "determine file type",
2030 This call uses the standard L<file(1)> command to determine
2031 the type or contents of the file.
2033 This call will also transparently look inside various types
2036 The exact command which runs is C<file -zb path>. Note in
2037 particular that the filename is not prepended to the output
2040 This command can also be used on C</dev/> devices
2041 (and partitions, LV names). You can for example use this
2042 to determine if a device contains a filesystem, although
2043 it's usually better to use C<guestfs_vfs_type>.
2045 If the C<path> does not begin with C</dev/> then
2046 this command only works for the content of regular files.
2047 For other file types (directory, symbolic link etc) it
2048 will just return the string C<directory> etc.");
2050 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2051 [InitScratchFS, Always, TestOutput (
2052 [["mkdir"; "/command"];
2053 ["upload"; "test-command"; "/command/test-command"];
2054 ["chmod"; "0o755"; "/command/test-command"];
2055 ["command"; "/command/test-command 1"]], "Result1");
2056 InitScratchFS, Always, TestOutput (
2057 [["mkdir"; "/command2"];
2058 ["upload"; "test-command"; "/command2/test-command"];
2059 ["chmod"; "0o755"; "/command2/test-command"];
2060 ["command"; "/command2/test-command 2"]], "Result2\n");
2061 InitScratchFS, Always, TestOutput (
2062 [["mkdir"; "/command3"];
2063 ["upload"; "test-command"; "/command3/test-command"];
2064 ["chmod"; "0o755"; "/command3/test-command"];
2065 ["command"; "/command3/test-command 3"]], "\nResult3");
2066 InitScratchFS, Always, TestOutput (
2067 [["mkdir"; "/command4"];
2068 ["upload"; "test-command"; "/command4/test-command"];
2069 ["chmod"; "0o755"; "/command4/test-command"];
2070 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2071 InitScratchFS, Always, TestOutput (
2072 [["mkdir"; "/command5"];
2073 ["upload"; "test-command"; "/command5/test-command"];
2074 ["chmod"; "0o755"; "/command5/test-command"];
2075 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2076 InitScratchFS, Always, TestOutput (
2077 [["mkdir"; "/command6"];
2078 ["upload"; "test-command"; "/command6/test-command"];
2079 ["chmod"; "0o755"; "/command6/test-command"];
2080 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2081 InitScratchFS, Always, TestOutput (
2082 [["mkdir"; "/command7"];
2083 ["upload"; "test-command"; "/command7/test-command"];
2084 ["chmod"; "0o755"; "/command7/test-command"];
2085 ["command"; "/command7/test-command 7"]], "");
2086 InitScratchFS, Always, TestOutput (
2087 [["mkdir"; "/command8"];
2088 ["upload"; "test-command"; "/command8/test-command"];
2089 ["chmod"; "0o755"; "/command8/test-command"];
2090 ["command"; "/command8/test-command 8"]], "\n");
2091 InitScratchFS, Always, TestOutput (
2092 [["mkdir"; "/command9"];
2093 ["upload"; "test-command"; "/command9/test-command"];
2094 ["chmod"; "0o755"; "/command9/test-command"];
2095 ["command"; "/command9/test-command 9"]], "\n\n");
2096 InitScratchFS, Always, TestOutput (
2097 [["mkdir"; "/command10"];
2098 ["upload"; "test-command"; "/command10/test-command"];
2099 ["chmod"; "0o755"; "/command10/test-command"];
2100 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2101 InitScratchFS, Always, TestOutput (
2102 [["mkdir"; "/command11"];
2103 ["upload"; "test-command"; "/command11/test-command"];
2104 ["chmod"; "0o755"; "/command11/test-command"];
2105 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2106 InitScratchFS, Always, TestLastFail (
2107 [["mkdir"; "/command12"];
2108 ["upload"; "test-command"; "/command12/test-command"];
2109 ["chmod"; "0o755"; "/command12/test-command"];
2110 ["command"; "/command12/test-command"]])],
2111 "run a command from the guest filesystem",
2113 This call runs a command from the guest filesystem. The
2114 filesystem must be mounted, and must contain a compatible
2115 operating system (ie. something Linux, with the same
2116 or compatible processor architecture).
2118 The single parameter is an argv-style list of arguments.
2119 The first element is the name of the program to run.
2120 Subsequent elements are parameters. The list must be
2121 non-empty (ie. must contain a program name). Note that
2122 the command runs directly, and is I<not> invoked via
2123 the shell (see C<guestfs_sh>).
2125 The return value is anything printed to I<stdout> by
2128 If the command returns a non-zero exit status, then
2129 this function returns an error message. The error message
2130 string is the content of I<stderr> from the command.
2132 The C<$PATH> environment variable will contain at least
2133 C</usr/bin> and C</bin>. If you require a program from
2134 another location, you should provide the full path in the
2137 Shared libraries and data files required by the program
2138 must be available on filesystems which are mounted in the
2139 correct places. It is the caller's responsibility to ensure
2140 all filesystems that are needed are mounted at the right
2143 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2144 [InitScratchFS, Always, TestOutputList (
2145 [["mkdir"; "/command_lines"];
2146 ["upload"; "test-command"; "/command_lines/test-command"];
2147 ["chmod"; "0o755"; "/command_lines/test-command"];
2148 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2149 InitScratchFS, Always, TestOutputList (
2150 [["mkdir"; "/command_lines2"];
2151 ["upload"; "test-command"; "/command_lines2/test-command"];
2152 ["chmod"; "0o755"; "/command_lines2/test-command"];
2153 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2154 InitScratchFS, Always, TestOutputList (
2155 [["mkdir"; "/command_lines3"];
2156 ["upload"; "test-command"; "/command_lines3/test-command"];
2157 ["chmod"; "0o755"; "/command_lines3/test-command"];
2158 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2159 InitScratchFS, Always, TestOutputList (
2160 [["mkdir"; "/command_lines4"];
2161 ["upload"; "test-command"; "/command_lines4/test-command"];
2162 ["chmod"; "0o755"; "/command_lines4/test-command"];
2163 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2164 InitScratchFS, Always, TestOutputList (
2165 [["mkdir"; "/command_lines5"];
2166 ["upload"; "test-command"; "/command_lines5/test-command"];
2167 ["chmod"; "0o755"; "/command_lines5/test-command"];
2168 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2169 InitScratchFS, Always, TestOutputList (
2170 [["mkdir"; "/command_lines6"];
2171 ["upload"; "test-command"; "/command_lines6/test-command"];
2172 ["chmod"; "0o755"; "/command_lines6/test-command"];
2173 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2174 InitScratchFS, Always, TestOutputList (
2175 [["mkdir"; "/command_lines7"];
2176 ["upload"; "test-command"; "/command_lines7/test-command"];
2177 ["chmod"; "0o755"; "/command_lines7/test-command"];
2178 ["command_lines"; "/command_lines7/test-command 7"]], []);
2179 InitScratchFS, Always, TestOutputList (
2180 [["mkdir"; "/command_lines8"];
2181 ["upload"; "test-command"; "/command_lines8/test-command"];
2182 ["chmod"; "0o755"; "/command_lines8/test-command"];
2183 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2184 InitScratchFS, Always, TestOutputList (
2185 [["mkdir"; "/command_lines9"];
2186 ["upload"; "test-command"; "/command_lines9/test-command"];
2187 ["chmod"; "0o755"; "/command_lines9/test-command"];
2188 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2189 InitScratchFS, Always, TestOutputList (
2190 [["mkdir"; "/command_lines10"];
2191 ["upload"; "test-command"; "/command_lines10/test-command"];
2192 ["chmod"; "0o755"; "/command_lines10/test-command"];
2193 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2194 InitScratchFS, Always, TestOutputList (
2195 [["mkdir"; "/command_lines11"];
2196 ["upload"; "test-command"; "/command_lines11/test-command"];
2197 ["chmod"; "0o755"; "/command_lines11/test-command"];
2198 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2199 "run a command, returning lines",
2201 This is the same as C<guestfs_command>, but splits the
2202 result into a list of lines.
2204 See also: C<guestfs_sh_lines>");
2206 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2207 [InitISOFS, Always, TestOutputStruct (
2208 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2209 "get file information",
2211 Returns file information for the given C<path>.
2213 This is the same as the C<stat(2)> system call.");
2215 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2216 [InitISOFS, Always, TestOutputStruct (
2217 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2218 "get file information for a symbolic link",
2220 Returns file information for the given C<path>.
2222 This is the same as C<guestfs_stat> except that if C<path>
2223 is a symbolic link, then the link is stat-ed, not the file it
2226 This is the same as the C<lstat(2)> system call.");
2228 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2229 [InitISOFS, Always, TestOutputStruct (
2230 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2231 "get file system statistics",
2233 Returns file system statistics for any mounted file system.
2234 C<path> should be a file or directory in the mounted file system
2235 (typically it is the mount point itself, but it doesn't need to be).
2237 This is the same as the C<statvfs(2)> system call.");
2239 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2241 "get ext2/ext3/ext4 superblock details",
2243 This returns the contents of the ext2, ext3 or ext4 filesystem
2244 superblock on C<device>.
2246 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2247 manpage for more details. The list of fields returned isn't
2248 clearly defined, and depends on both the version of C<tune2fs>
2249 that libguestfs was built against, and the filesystem itself.");
2251 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2252 [InitEmpty, Always, TestOutputTrue (
2253 [["blockdev_setro"; "/dev/sda"];
2254 ["blockdev_getro"; "/dev/sda"]])],
2255 "set block device to read-only",
2257 Sets the block device named C<device> to read-only.
2259 This uses the L<blockdev(8)> command.");
2261 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2262 [InitEmpty, Always, TestOutputFalse (
2263 [["blockdev_setrw"; "/dev/sda"];
2264 ["blockdev_getro"; "/dev/sda"]])],
2265 "set block device to read-write",
2267 Sets the block device named C<device> to read-write.
2269 This uses the L<blockdev(8)> command.");
2271 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2272 [InitEmpty, Always, TestOutputTrue (
2273 [["blockdev_setro"; "/dev/sda"];
2274 ["blockdev_getro"; "/dev/sda"]])],
2275 "is block device set to read-only",
2277 Returns a boolean indicating if the block device is read-only
2278 (true if read-only, false if not).
2280 This uses the L<blockdev(8)> command.");
2282 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2283 [InitEmpty, Always, TestOutputInt (
2284 [["blockdev_getss"; "/dev/sda"]], 512)],
2285 "get sectorsize of block device",
2287 This returns the size of sectors on a block device.
2288 Usually 512, but can be larger for modern devices.
2290 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2293 This uses the L<blockdev(8)> command.");
2295 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2296 [InitEmpty, Always, TestOutputInt (
2297 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2298 "get blocksize of block device",
2300 This returns the block size of a device.
2302 (Note this is different from both I<size in blocks> and
2303 I<filesystem block size>).
2305 This uses the L<blockdev(8)> command.");
2307 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2309 "set blocksize of block device",
2311 This sets the block size of a device.
2313 (Note this is different from both I<size in blocks> and
2314 I<filesystem block size>).
2316 This uses the L<blockdev(8)> command.");
2318 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2319 [InitEmpty, Always, TestOutputInt (
2320 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2321 "get total size of device in 512-byte sectors",
2323 This returns the size of the device in units of 512-byte sectors
2324 (even if the sectorsize isn't 512 bytes ... weird).
2326 See also C<guestfs_blockdev_getss> for the real sector size of
2327 the device, and C<guestfs_blockdev_getsize64> for the more
2328 useful I<size in bytes>.
2330 This uses the L<blockdev(8)> command.");
2332 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2333 [InitEmpty, Always, TestOutputInt (
2334 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2335 "get total size of device in bytes",
2337 This returns the size of the device in bytes.
2339 See also C<guestfs_blockdev_getsz>.
2341 This uses the L<blockdev(8)> command.");
2343 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2344 [InitEmpty, Always, TestRun
2345 [["blockdev_flushbufs"; "/dev/sda"]]],
2346 "flush device buffers",
2348 This tells the kernel to flush internal buffers associated
2351 This uses the L<blockdev(8)> command.");
2353 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2354 [InitEmpty, Always, TestRun
2355 [["blockdev_rereadpt"; "/dev/sda"]]],
2356 "reread partition table",
2358 Reread the partition table on C<device>.
2360 This uses the L<blockdev(8)> command.");
2362 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2363 [InitScratchFS, Always, TestOutput (
2364 (* Pick a file from cwd which isn't likely to change. *)
2365 [["mkdir"; "/upload"];
2366 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2367 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2368 Digest.to_hex (Digest.file "COPYING.LIB"))],
2369 "upload a file from the local machine",
2371 Upload local file C<filename> to C<remotefilename> on the
2374 C<filename> can also be a named pipe.
2376 See also C<guestfs_download>.");
2378 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2379 [InitScratchFS, Always, TestOutput (
2380 (* Pick a file from cwd which isn't likely to change. *)
2381 [["mkdir"; "/download"];
2382 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2383 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2384 ["upload"; "testdownload.tmp"; "/download/upload"];
2385 ["checksum"; "md5"; "/download/upload"]],
2386 Digest.to_hex (Digest.file "COPYING.LIB"))],
2387 "download a file to the local machine",
2389 Download file C<remotefilename> and save it as C<filename>
2390 on the local machine.
2392 C<filename> can also be a named pipe.
2394 See also C<guestfs_upload>, C<guestfs_cat>.");
2396 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2397 [InitISOFS, Always, TestOutput (
2398 [["checksum"; "crc"; "/known-3"]], "2891671662");
2399 InitISOFS, Always, TestLastFail (
2400 [["checksum"; "crc"; "/notexists"]]);
2401 InitISOFS, Always, TestOutput (
2402 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2403 InitISOFS, Always, TestOutput (
2404 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2405 InitISOFS, Always, TestOutput (
2406 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2407 InitISOFS, Always, TestOutput (
2408 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2409 InitISOFS, Always, TestOutput (
2410 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2411 InitISOFS, Always, TestOutput (
2412 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2413 (* Test for RHBZ#579608, absolute symbolic links. *)
2414 InitISOFS, Always, TestOutput (
2415 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2416 "compute MD5, SHAx or CRC checksum of file",
2418 This call computes the MD5, SHAx or CRC checksum of the
2421 The type of checksum to compute is given by the C<csumtype>
2422 parameter which must have one of the following values:
2428 Compute the cyclic redundancy check (CRC) specified by POSIX
2429 for the C<cksum> command.
2433 Compute the MD5 hash (using the C<md5sum> program).
2437 Compute the SHA1 hash (using the C<sha1sum> program).
2441 Compute the SHA224 hash (using the C<sha224sum> program).
2445 Compute the SHA256 hash (using the C<sha256sum> program).
2449 Compute the SHA384 hash (using the C<sha384sum> program).
2453 Compute the SHA512 hash (using the C<sha512sum> program).
2457 The checksum is returned as a printable string.
2459 To get the checksum for a device, use C<guestfs_checksum_device>.
2461 To get the checksums for many files, use C<guestfs_checksums_out>.");
2463 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2464 [InitScratchFS, Always, TestOutput (
2465 [["mkdir"; "/tar_in"];
2466 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2467 ["cat"; "/tar_in/hello"]], "hello\n")],
2468 "unpack tarfile to directory",
2470 This command uploads and unpacks local file C<tarfile> (an
2471 I<uncompressed> tar file) into C<directory>.
2473 To upload a compressed tarball, use C<guestfs_tgz_in>
2474 or C<guestfs_txz_in>.");
2476 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2478 "pack directory into tarfile",
2480 This command packs the contents of C<directory> and downloads
2481 it to local file C<tarfile>.
2483 To download a compressed tarball, use C<guestfs_tgz_out>
2484 or C<guestfs_txz_out>.");
2486 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2487 [InitScratchFS, Always, TestOutput (
2488 [["mkdir"; "/tgz_in"];
2489 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2490 ["cat"; "/tgz_in/hello"]], "hello\n")],
2491 "unpack compressed tarball to directory",
2493 This command uploads and unpacks local file C<tarball> (a
2494 I<gzip compressed> tar file) into C<directory>.
2496 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2498 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2500 "pack directory into compressed tarball",
2502 This command packs the contents of C<directory> and downloads
2503 it to local file C<tarball>.
2505 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2507 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2508 [InitBasicFS, Always, TestLastFail (
2510 ["mount_ro"; "/dev/sda1"; "/"];
2511 ["touch"; "/new"]]);
2512 InitBasicFS, Always, TestOutput (
2513 [["write"; "/new"; "data"];
2515 ["mount_ro"; "/dev/sda1"; "/"];
2516 ["cat"; "/new"]], "data")],
2517 "mount a guest disk, read-only",
2519 This is the same as the C<guestfs_mount> command, but it
2520 mounts the filesystem with the read-only (I<-o ro>) flag.");
2522 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2524 "mount a guest disk with mount options",
2526 This is the same as the C<guestfs_mount> command, but it
2527 allows you to set the mount options as for the
2528 L<mount(8)> I<-o> flag.
2530 If the C<options> parameter is an empty string, then
2531 no options are passed (all options default to whatever
2532 the filesystem uses).");
2534 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2536 "mount a guest disk with mount options and vfstype",
2538 This is the same as the C<guestfs_mount> command, but it
2539 allows you to set both the mount options and the vfstype
2540 as for the L<mount(8)> I<-o> and I<-t> flags.");
2542 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2544 "debugging and internals",
2546 The C<guestfs_debug> command exposes some internals of
2547 C<guestfsd> (the guestfs daemon) that runs inside the
2550 There is no comprehensive help for this command. You have
2551 to look at the file C<daemon/debug.c> in the libguestfs source
2552 to find out what you can do.");
2554 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2555 [InitEmpty, Always, TestOutputList (
2556 [["part_disk"; "/dev/sda"; "mbr"];
2557 ["pvcreate"; "/dev/sda1"];
2558 ["vgcreate"; "VG"; "/dev/sda1"];
2559 ["lvcreate"; "LV1"; "VG"; "50"];
2560 ["lvcreate"; "LV2"; "VG"; "50"];
2561 ["lvremove"; "/dev/VG/LV1"];
2562 ["lvs"]], ["/dev/VG/LV2"]);
2563 InitEmpty, Always, TestOutputList (
2564 [["part_disk"; "/dev/sda"; "mbr"];
2565 ["pvcreate"; "/dev/sda1"];
2566 ["vgcreate"; "VG"; "/dev/sda1"];
2567 ["lvcreate"; "LV1"; "VG"; "50"];
2568 ["lvcreate"; "LV2"; "VG"; "50"];
2569 ["lvremove"; "/dev/VG"];
2571 InitEmpty, Always, TestOutputList (
2572 [["part_disk"; "/dev/sda"; "mbr"];
2573 ["pvcreate"; "/dev/sda1"];
2574 ["vgcreate"; "VG"; "/dev/sda1"];
2575 ["lvcreate"; "LV1"; "VG"; "50"];
2576 ["lvcreate"; "LV2"; "VG"; "50"];
2577 ["lvremove"; "/dev/VG"];
2579 "remove an LVM logical volume",
2581 Remove an LVM logical volume C<device>, where C<device> is
2582 the path to the LV, such as C</dev/VG/LV>.
2584 You can also remove all LVs in a volume group by specifying
2585 the VG name, C</dev/VG>.");
2587 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2588 [InitEmpty, Always, TestOutputList (
2589 [["part_disk"; "/dev/sda"; "mbr"];
2590 ["pvcreate"; "/dev/sda1"];
2591 ["vgcreate"; "VG"; "/dev/sda1"];
2592 ["lvcreate"; "LV1"; "VG"; "50"];
2593 ["lvcreate"; "LV2"; "VG"; "50"];
2596 InitEmpty, Always, TestOutputList (
2597 [["part_disk"; "/dev/sda"; "mbr"];
2598 ["pvcreate"; "/dev/sda1"];
2599 ["vgcreate"; "VG"; "/dev/sda1"];
2600 ["lvcreate"; "LV1"; "VG"; "50"];
2601 ["lvcreate"; "LV2"; "VG"; "50"];
2604 "remove an LVM volume group",
2606 Remove an LVM volume group C<vgname>, (for example C<VG>).
2608 This also forcibly removes all logical volumes in the volume
2611 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2612 [InitEmpty, Always, TestOutputListOfDevices (
2613 [["part_disk"; "/dev/sda"; "mbr"];
2614 ["pvcreate"; "/dev/sda1"];
2615 ["vgcreate"; "VG"; "/dev/sda1"];
2616 ["lvcreate"; "LV1"; "VG"; "50"];
2617 ["lvcreate"; "LV2"; "VG"; "50"];
2619 ["pvremove"; "/dev/sda1"];
2621 InitEmpty, Always, TestOutputListOfDevices (
2622 [["part_disk"; "/dev/sda"; "mbr"];
2623 ["pvcreate"; "/dev/sda1"];
2624 ["vgcreate"; "VG"; "/dev/sda1"];
2625 ["lvcreate"; "LV1"; "VG"; "50"];
2626 ["lvcreate"; "LV2"; "VG"; "50"];
2628 ["pvremove"; "/dev/sda1"];
2630 InitEmpty, Always, TestOutputListOfDevices (
2631 [["part_disk"; "/dev/sda"; "mbr"];
2632 ["pvcreate"; "/dev/sda1"];
2633 ["vgcreate"; "VG"; "/dev/sda1"];
2634 ["lvcreate"; "LV1"; "VG"; "50"];
2635 ["lvcreate"; "LV2"; "VG"; "50"];
2637 ["pvremove"; "/dev/sda1"];
2639 "remove an LVM physical volume",
2641 This wipes a physical volume C<device> so that LVM will no longer
2644 The implementation uses the C<pvremove> command which refuses to
2645 wipe physical volumes that contain any volume groups, so you have
2646 to remove those first.");
2648 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2649 [InitBasicFS, Always, TestOutput (
2650 [["set_e2label"; "/dev/sda1"; "testlabel"];
2651 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2652 "set the ext2/3/4 filesystem label",
2654 This sets the ext2/3/4 filesystem label of the filesystem on
2655 C<device> to C<label>. Filesystem labels are limited to
2658 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2659 to return the existing label on a filesystem.");
2661 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2663 "get the ext2/3/4 filesystem label",
2665 This returns the ext2/3/4 filesystem label of the filesystem on
2668 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2669 (let uuid = uuidgen () in
2670 [InitBasicFS, Always, TestOutput (
2671 [["set_e2uuid"; "/dev/sda1"; uuid];
2672 ["get_e2uuid"; "/dev/sda1"]], uuid);
2673 InitBasicFS, Always, TestOutput (
2674 [["set_e2uuid"; "/dev/sda1"; "clear"];
2675 ["get_e2uuid"; "/dev/sda1"]], "");
2676 (* We can't predict what UUIDs will be, so just check the commands run. *)
2677 InitBasicFS, Always, TestRun (
2678 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2679 InitBasicFS, Always, TestRun (
2680 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2681 "set the ext2/3/4 filesystem UUID",
2683 This sets the ext2/3/4 filesystem UUID of the filesystem on
2684 C<device> to C<uuid>. The format of the UUID and alternatives
2685 such as C<clear>, C<random> and C<time> are described in the
2686 L<tune2fs(8)> manpage.
2688 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2689 to return the existing UUID of a filesystem.");
2691 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2692 (* Regression test for RHBZ#597112. *)
2693 (let uuid = uuidgen () in
2694 [InitNone, Always, TestOutput (
2695 [["mke2journal"; "1024"; "/dev/sdc"];
2696 ["set_e2uuid"; "/dev/sdc"; uuid];
2697 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2698 "get the ext2/3/4 filesystem UUID",
2700 This returns the ext2/3/4 filesystem UUID of the filesystem on
2703 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2704 [InitBasicFS, Always, TestOutputInt (
2705 [["umount"; "/dev/sda1"];
2706 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2707 InitBasicFS, Always, TestOutputInt (
2708 [["umount"; "/dev/sda1"];
2709 ["zero"; "/dev/sda1"];
2710 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2711 "run the filesystem checker",
2713 This runs the filesystem checker (fsck) on C<device> which
2714 should have filesystem type C<fstype>.
2716 The returned integer is the status. See L<fsck(8)> for the
2717 list of status codes from C<fsck>.
2725 Multiple status codes can be summed together.
2729 A non-zero return code can mean \"success\", for example if
2730 errors have been corrected on the filesystem.
2734 Checking or repairing NTFS volumes is not supported
2739 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2741 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2742 [InitBasicFS, Always, TestOutput (
2743 [["umount"; "/dev/sda1"];
2744 ["zero"; "/dev/sda1"];
2745 ["file"; "/dev/sda1"]], "data")],
2746 "write zeroes to the device",
2748 This command writes zeroes over the first few blocks of C<device>.
2750 How many blocks are zeroed isn't specified (but it's I<not> enough
2751 to securely wipe the device). It should be sufficient to remove
2752 any partition tables, filesystem superblocks and so on.
2754 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2756 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2758 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2759 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2761 [InitBasicFS, Always, TestOutputTrue (
2762 [["mkdir_p"; "/boot/grub"];
2763 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2764 ["grub_install"; "/"; "/dev/vda"];
2765 ["is_dir"; "/boot"]])],
2768 This command installs GRUB (the Grand Unified Bootloader) on
2769 C<device>, with the root directory being C<root>.
2771 Note: If grub-install reports the error
2772 \"No suitable drive was found in the generated device map.\"
2773 it may be that you need to create a C</boot/grub/device.map>
2774 file first that contains the mapping between grub device names
2775 and Linux device names. It is usually sufficient to create
2780 replacing C</dev/vda> with the name of the installation device.");
2782 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2783 [InitScratchFS, Always, TestOutput (
2785 ["write"; "/cp/old"; "file content"];
2786 ["cp"; "/cp/old"; "/cp/new"];
2787 ["cat"; "/cp/new"]], "file content");
2788 InitScratchFS, Always, TestOutputTrue (
2790 ["write"; "/cp2/old"; "file content"];
2791 ["cp"; "/cp2/old"; "/cp2/new"];
2792 ["is_file"; "/cp2/old"]]);
2793 InitScratchFS, Always, TestOutput (
2795 ["write"; "/cp3/old"; "file content"];
2796 ["mkdir"; "/cp3/dir"];
2797 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2798 ["cat"; "/cp3/dir/new"]], "file content")],
2801 This copies a file from C<src> to C<dest> where C<dest> is
2802 either a destination filename or destination directory.");
2804 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2805 [InitScratchFS, Always, TestOutput (
2806 [["mkdir"; "/cp_a1"];
2807 ["mkdir"; "/cp_a2"];
2808 ["write"; "/cp_a1/file"; "file content"];
2809 ["cp_a"; "/cp_a1"; "/cp_a2"];
2810 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2811 "copy a file or directory recursively",
2813 This copies a file or directory from C<src> to C<dest>
2814 recursively using the C<cp -a> command.");
2816 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2817 [InitScratchFS, Always, TestOutput (
2819 ["write"; "/mv/old"; "file content"];
2820 ["mv"; "/mv/old"; "/mv/new"];
2821 ["cat"; "/mv/new"]], "file content");
2822 InitScratchFS, Always, TestOutputFalse (
2824 ["write"; "/mv2/old"; "file content"];
2825 ["mv"; "/mv2/old"; "/mv2/new"];
2826 ["is_file"; "/mv2/old"]])],
2829 This moves a file from C<src> to C<dest> where C<dest> is
2830 either a destination filename or destination directory.");
2832 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2833 [InitEmpty, Always, TestRun (
2834 [["drop_caches"; "3"]])],
2835 "drop kernel page cache, dentries and inodes",
2837 This instructs the guest kernel to drop its page cache,
2838 and/or dentries and inode caches. The parameter C<whattodrop>
2839 tells the kernel what precisely to drop, see
2840 L<http://linux-mm.org/Drop_Caches>
2842 Setting C<whattodrop> to 3 should drop everything.
2844 This automatically calls L<sync(2)> before the operation,
2845 so that the maximum guest memory is freed.");
2847 ("dmesg", (RString "kmsgs", [], []), 91, [],
2848 [InitEmpty, Always, TestRun (
2850 "return kernel messages",
2852 This returns the kernel messages (C<dmesg> output) from
2853 the guest kernel. This is sometimes useful for extended
2854 debugging of problems.
2856 Another way to get the same information is to enable
2857 verbose messages with C<guestfs_set_verbose> or by setting
2858 the environment variable C<LIBGUESTFS_DEBUG=1> before
2859 running the program.");
2861 ("ping_daemon", (RErr, [], []), 92, [],
2862 [InitEmpty, Always, TestRun (
2863 [["ping_daemon"]])],
2864 "ping the guest daemon",
2866 This is a test probe into the guestfs daemon running inside
2867 the qemu subprocess. Calling this function checks that the
2868 daemon responds to the ping message, without affecting the daemon
2869 or attached block device(s) in any other way.");
2871 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2872 [InitScratchFS, Always, TestOutputTrue (
2873 [["mkdir"; "/equal"];
2874 ["write"; "/equal/file1"; "contents of a file"];
2875 ["cp"; "/equal/file1"; "/equal/file2"];
2876 ["equal"; "/equal/file1"; "/equal/file2"]]);
2877 InitScratchFS, Always, TestOutputFalse (
2878 [["mkdir"; "/equal2"];
2879 ["write"; "/equal2/file1"; "contents of a file"];
2880 ["write"; "/equal2/file2"; "contents of another file"];
2881 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
2882 InitScratchFS, Always, TestLastFail (
2883 [["mkdir"; "/equal3"];
2884 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
2885 "test if two files have equal contents",
2887 This compares the two files C<file1> and C<file2> and returns
2888 true if their content is exactly equal, or false otherwise.
2890 The external L<cmp(1)> program is used for the comparison.");
2892 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2893 [InitISOFS, Always, TestOutputList (
2894 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2895 InitISOFS, Always, TestOutputList (
2896 [["strings"; "/empty"]], []);
2897 (* Test for RHBZ#579608, absolute symbolic links. *)
2898 InitISOFS, Always, TestRun (
2899 [["strings"; "/abssymlink"]])],
2900 "print the printable strings in a file",
2902 This runs the L<strings(1)> command on a file and returns
2903 the list of printable strings found.");
2905 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2906 [InitISOFS, Always, TestOutputList (
2907 [["strings_e"; "b"; "/known-5"]], []);
2908 InitScratchFS, Always, TestOutputList (
2909 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2910 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
2911 "print the printable strings in a file",
2913 This is like the C<guestfs_strings> command, but allows you to
2914 specify the encoding of strings that are looked for in
2915 the source file C<path>.
2917 Allowed encodings are:
2923 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2924 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2928 Single 8-bit-byte characters.
2932 16-bit big endian strings such as those encoded in
2933 UTF-16BE or UCS-2BE.
2935 =item l (lower case letter L)
2937 16-bit little endian such as UTF-16LE and UCS-2LE.
2938 This is useful for examining binaries in Windows guests.
2942 32-bit big endian such as UCS-4BE.
2946 32-bit little endian such as UCS-4LE.
2950 The returned strings are transcoded to UTF-8.");
2952 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2953 [InitISOFS, Always, TestOutput (
2954 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2955 (* Test for RHBZ#501888c2 regression which caused large hexdump
2956 * commands to segfault.
2958 InitISOFS, Always, TestRun (
2959 [["hexdump"; "/100krandom"]]);
2960 (* Test for RHBZ#579608, absolute symbolic links. *)
2961 InitISOFS, Always, TestRun (
2962 [["hexdump"; "/abssymlink"]])],
2963 "dump a file in hexadecimal",
2965 This runs C<hexdump -C> on the given C<path>. The result is
2966 the human-readable, canonical hex dump of the file.");
2968 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2969 [InitNone, Always, TestOutput (
2970 [["part_disk"; "/dev/sda"; "mbr"];
2971 ["mkfs"; "ext3"; "/dev/sda1"];
2972 ["mount_options"; ""; "/dev/sda1"; "/"];
2973 ["write"; "/new"; "test file"];
2974 ["umount"; "/dev/sda1"];
2975 ["zerofree"; "/dev/sda1"];
2976 ["mount_options"; ""; "/dev/sda1"; "/"];
2977 ["cat"; "/new"]], "test file")],
2978 "zero unused inodes and disk blocks on ext2/3 filesystem",
2980 This runs the I<zerofree> program on C<device>. This program
2981 claims to zero unused inodes and disk blocks on an ext2/3
2982 filesystem, thus making it possible to compress the filesystem
2985 You should B<not> run this program if the filesystem is
2988 It is possible that using this program can damage the filesystem
2989 or data on the filesystem.");
2991 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2993 "resize an LVM physical volume",
2995 This resizes (expands or shrinks) an existing LVM physical
2996 volume to match the new size of the underlying device.");
2998 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2999 Int "cyls"; Int "heads"; Int "sectors";
3000 String "line"], []), 99, [DangerWillRobinson],
3002 "modify a single partition on a block device",
3004 This runs L<sfdisk(8)> option to modify just the single
3005 partition C<n> (note: C<n> counts from 1).
3007 For other parameters, see C<guestfs_sfdisk>. You should usually
3008 pass C<0> for the cyls/heads/sectors parameters.
3010 See also: C<guestfs_part_add>");
3012 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3014 "display the partition table",
3016 This displays the partition table on C<device>, in the
3017 human-readable output of the L<sfdisk(8)> command. It is
3018 not intended to be parsed.
3020 See also: C<guestfs_part_list>");
3022 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3024 "display the kernel geometry",
3026 This displays the kernel's idea of the geometry of C<device>.
3028 The result is in human-readable format, and not designed to
3031 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3033 "display the disk geometry from the partition table",
3035 This displays the disk geometry of C<device> read from the
3036 partition table. Especially in the case where the underlying
3037 block device has been resized, this can be different from the
3038 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3040 The result is in human-readable format, and not designed to
3043 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3045 "activate or deactivate all volume groups",
3047 This command activates or (if C<activate> is false) deactivates
3048 all logical volumes in all volume groups.
3049 If activated, then they are made known to the
3050 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3051 then those devices disappear.
3053 This command is the same as running C<vgchange -a y|n>");
3055 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3057 "activate or deactivate some volume groups",
3059 This command activates or (if C<activate> is false) deactivates
3060 all logical volumes in the listed volume groups C<volgroups>.
3061 If activated, then they are made known to the
3062 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3063 then those devices disappear.
3065 This command is the same as running C<vgchange -a y|n volgroups...>
3067 Note that if C<volgroups> is an empty list then B<all> volume groups
3068 are activated or deactivated.");
3070 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3071 [InitNone, Always, TestOutput (
3072 [["part_disk"; "/dev/sda"; "mbr"];
3073 ["pvcreate"; "/dev/sda1"];
3074 ["vgcreate"; "VG"; "/dev/sda1"];
3075 ["lvcreate"; "LV"; "VG"; "10"];
3076 ["mkfs"; "ext2"; "/dev/VG/LV"];
3077 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3078 ["write"; "/new"; "test content"];
3080 ["lvresize"; "/dev/VG/LV"; "20"];
3081 ["e2fsck_f"; "/dev/VG/LV"];
3082 ["resize2fs"; "/dev/VG/LV"];
3083 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3084 ["cat"; "/new"]], "test content");
3085 InitNone, Always, TestRun (
3086 (* Make an LV smaller to test RHBZ#587484. *)
3087 [["part_disk"; "/dev/sda"; "mbr"];
3088 ["pvcreate"; "/dev/sda1"];
3089 ["vgcreate"; "VG"; "/dev/sda1"];
3090 ["lvcreate"; "LV"; "VG"; "20"];
3091 ["lvresize"; "/dev/VG/LV"; "10"]])],
3092 "resize an LVM logical volume",
3094 This resizes (expands or shrinks) an existing LVM logical
3095 volume to C<mbytes>. When reducing, data in the reduced part
3098 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3099 [], (* lvresize tests this *)
3100 "resize an ext2, ext3 or ext4 filesystem",
3102 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3103 the underlying device.
3105 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3106 on the C<device> before calling this command. For unknown reasons
3107 C<resize2fs> sometimes gives an error about this and sometimes not.
3108 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3109 calling this function.");
3111 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3112 [InitBasicFS, Always, TestOutputList (
3113 [["find"; "/"]], ["lost+found"]);
3114 InitBasicFS, Always, TestOutputList (
3118 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3119 InitScratchFS, Always, TestOutputList (
3120 [["mkdir_p"; "/find/b/c"];
3121 ["touch"; "/find/b/c/d"];
3122 ["find"; "/find/b/"]], ["c"; "c/d"])],
3123 "find all files and directories",
3125 This command lists out all files and directories, recursively,
3126 starting at C<directory>. It is essentially equivalent to
3127 running the shell command C<find directory -print> but some
3128 post-processing happens on the output, described below.
3130 This returns a list of strings I<without any prefix>. Thus
3131 if the directory structure was:
3137 then the returned list from C<guestfs_find> C</tmp> would be
3145 If C<directory> is not a directory, then this command returns
3148 The returned list is sorted.
3150 See also C<guestfs_find0>.");
3152 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3153 [], (* lvresize tests this *)
3154 "check an ext2/ext3 filesystem",
3156 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3157 filesystem checker on C<device>, noninteractively (C<-p>),
3158 even if the filesystem appears to be clean (C<-f>).
3160 This command is only needed because of C<guestfs_resize2fs>
3161 (q.v.). Normally you should use C<guestfs_fsck>.");
3163 ("sleep", (RErr, [Int "secs"], []), 109, [],
3164 [InitNone, Always, TestRun (
3166 "sleep for some seconds",
3168 Sleep for C<secs> seconds.");
3170 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3171 [InitNone, Always, TestOutputInt (
3172 [["part_disk"; "/dev/sda"; "mbr"];
3173 ["mkfs"; "ntfs"; "/dev/sda1"];
3174 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3175 InitNone, Always, TestOutputInt (
3176 [["part_disk"; "/dev/sda"; "mbr"];
3177 ["mkfs"; "ext2"; "/dev/sda1"];
3178 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3179 "probe NTFS volume",
3181 This command runs the L<ntfs-3g.probe(8)> command which probes
3182 an NTFS C<device> for mountability. (Not all NTFS volumes can
3183 be mounted read-write, and some cannot be mounted at all).
3185 C<rw> is a boolean flag. Set it to true if you want to test
3186 if the volume can be mounted read-write. Set it to false if
3187 you want to test if the volume can be mounted read-only.
3189 The return value is an integer which C<0> if the operation
3190 would succeed, or some non-zero value documented in the
3191 L<ntfs-3g.probe(8)> manual page.");
3193 ("sh", (RString "output", [String "command"], []), 111, [],
3194 [], (* XXX needs tests *)
3195 "run a command via the shell",
3197 This call runs a command from the guest filesystem via the
3200 This is like C<guestfs_command>, but passes the command to:
3202 /bin/sh -c \"command\"
3204 Depending on the guest's shell, this usually results in
3205 wildcards being expanded, shell expressions being interpolated
3208 All the provisos about C<guestfs_command> apply to this call.");
3210 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3211 [], (* XXX needs tests *)
3212 "run a command via the shell returning lines",
3214 This is the same as C<guestfs_sh>, but splits the result
3215 into a list of lines.
3217 See also: C<guestfs_command_lines>");
3219 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3220 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3221 * code in stubs.c, since all valid glob patterns must start with "/".
3222 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3224 [InitScratchFS, Always, TestOutputList (
3225 [["mkdir_p"; "/glob_expand/b/c"];
3226 ["touch"; "/glob_expand/b/c/d"];
3227 ["touch"; "/glob_expand/b/c/e"];
3228 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3229 InitScratchFS, Always, TestOutputList (
3230 [["mkdir_p"; "/glob_expand2/b/c"];
3231 ["touch"; "/glob_expand2/b/c/d"];
3232 ["touch"; "/glob_expand2/b/c/e"];
3233 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3234 InitScratchFS, Always, TestOutputList (
3235 [["mkdir_p"; "/glob_expand3/b/c"];
3236 ["touch"; "/glob_expand3/b/c/d"];
3237 ["touch"; "/glob_expand3/b/c/e"];
3238 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3239 "expand a wildcard path",
3241 This command searches for all the pathnames matching
3242 C<pattern> according to the wildcard expansion rules
3245 If no paths match, then this returns an empty list
3246 (note: not an error).
3248 It is just a wrapper around the C L<glob(3)> function
3249 with flags C<GLOB_MARK|GLOB_BRACE>.
3250 See that manual page for more details.");
3252 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3253 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3254 [["scrub_device"; "/dev/sdc"]])],
3255 "scrub (securely wipe) a device",
3257 This command writes patterns over C<device> to make data retrieval
3260 It is an interface to the L<scrub(1)> program. See that
3261 manual page for more details.");
3263 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3264 [InitScratchFS, Always, TestRun (
3265 [["write"; "/scrub_file"; "content"];
3266 ["scrub_file"; "/scrub_file"]])],
3267 "scrub (securely wipe) a file",
3269 This command writes patterns over a file to make data retrieval
3272 The file is I<removed> after scrubbing.
3274 It is an interface to the L<scrub(1)> program. See that
3275 manual page for more details.");
3277 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3278 [], (* XXX needs testing *)
3279 "scrub (securely wipe) free space",
3281 This command creates the directory C<dir> and then fills it
3282 with files until the filesystem is full, and scrubs the files
3283 as for C<guestfs_scrub_file>, and deletes them.
3284 The intention is to scrub any free space on the partition
3287 It is an interface to the L<scrub(1)> program. See that
3288 manual page for more details.");
3290 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3291 [InitScratchFS, Always, TestRun (
3292 [["mkdir"; "/mkdtemp"];
3293 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3294 "create a temporary directory",
3296 This command creates a temporary directory. The
3297 C<template> parameter should be a full pathname for the
3298 temporary directory name with the final six characters being
3301 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3302 the second one being suitable for Windows filesystems.
3304 The name of the temporary directory that was created
3307 The temporary directory is created with mode 0700
3308 and is owned by root.
3310 The caller is responsible for deleting the temporary
3311 directory and its contents after use.
3313 See also: L<mkdtemp(3)>");
3315 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3316 [InitISOFS, Always, TestOutputInt (
3317 [["wc_l"; "/10klines"]], 10000);
3318 (* Test for RHBZ#579608, absolute symbolic links. *)
3319 InitISOFS, Always, TestOutputInt (
3320 [["wc_l"; "/abssymlink"]], 10000)],
3321 "count lines in a file",
3323 This command counts the lines in a file, using the
3324 C<wc -l> external command.");
3326 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3327 [InitISOFS, Always, TestOutputInt (
3328 [["wc_w"; "/10klines"]], 10000)],
3329 "count words in a file",
3331 This command counts the words in a file, using the
3332 C<wc -w> external command.");
3334 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3335 [InitISOFS, Always, TestOutputInt (
3336 [["wc_c"; "/100kallspaces"]], 102400)],
3337 "count characters in a file",
3339 This command counts the characters in a file, using the
3340 C<wc -c> external command.");
3342 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3343 [InitISOFS, Always, TestOutputList (
3344 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3345 (* Test for RHBZ#579608, absolute symbolic links. *)
3346 InitISOFS, Always, TestOutputList (
3347 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3348 "return first 10 lines of a file",
3350 This command returns up to the first 10 lines of a file as
3351 a list of strings.");
3353 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3354 [InitISOFS, Always, TestOutputList (
3355 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3356 InitISOFS, Always, TestOutputList (
3357 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3358 InitISOFS, Always, TestOutputList (
3359 [["head_n"; "0"; "/10klines"]], [])],
3360 "return first N lines of a file",
3362 If the parameter C<nrlines> is a positive number, this returns the first
3363 C<nrlines> lines of the file C<path>.
3365 If the parameter C<nrlines> is a negative number, this returns lines
3366 from the file C<path>, excluding the last C<nrlines> lines.
3368 If the parameter C<nrlines> is zero, this returns an empty list.");
3370 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3371 [InitISOFS, Always, TestOutputList (
3372 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3373 "return last 10 lines of a file",
3375 This command returns up to the last 10 lines of a file as
3376 a list of strings.");
3378 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3379 [InitISOFS, Always, TestOutputList (
3380 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3381 InitISOFS, Always, TestOutputList (
3382 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3383 InitISOFS, Always, TestOutputList (
3384 [["tail_n"; "0"; "/10klines"]], [])],
3385 "return last N lines of a file",
3387 If the parameter C<nrlines> is a positive number, this returns the last
3388 C<nrlines> lines of the file C<path>.
3390 If the parameter C<nrlines> is a negative number, this returns lines
3391 from the file C<path>, starting with the C<-nrlines>th line.
3393 If the parameter C<nrlines> is zero, this returns an empty list.");
3395 ("df", (RString "output", [], []), 125, [],
3396 [], (* XXX Tricky to test because it depends on the exact format
3397 * of the 'df' command and other imponderables.
3399 "report file system disk space usage",
3401 This command runs the C<df> command to report disk space used.
3403 This command is mostly useful for interactive sessions. It
3404 is I<not> intended that you try to parse the output string.
3405 Use C<guestfs_statvfs> from programs.");
3407 ("df_h", (RString "output", [], []), 126, [],
3408 [], (* XXX Tricky to test because it depends on the exact format
3409 * of the 'df' command and other imponderables.
3411 "report file system disk space usage (human readable)",
3413 This command runs the C<df -h> command to report disk space used
3414 in human-readable format.
3416 This command is mostly useful for interactive sessions. It
3417 is I<not> intended that you try to parse the output string.
3418 Use C<guestfs_statvfs> from programs.");
3420 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3421 [InitISOFS, Always, TestOutputInt (
3422 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3423 "estimate file space usage",
3425 This command runs the C<du -s> command to estimate file space
3428 C<path> can be a file or a directory. If C<path> is a directory
3429 then the estimate includes the contents of the directory and all
3430 subdirectories (recursively).
3432 The result is the estimated size in I<kilobytes>
3433 (ie. units of 1024 bytes).");
3435 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3436 [InitISOFS, Always, TestOutputList (
3437 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3438 "list files in an initrd",
3440 This command lists out files contained in an initrd.
3442 The files are listed without any initial C</> character. The
3443 files are listed in the order they appear (not necessarily
3444 alphabetical). Directory names are listed as separate items.
3446 Old Linux kernels (2.4 and earlier) used a compressed ext2
3447 filesystem as initrd. We I<only> support the newer initramfs
3448 format (compressed cpio files).");
3450 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3452 "mount a file using the loop device",
3454 This command lets you mount C<file> (a filesystem image
3455 in a file) on a mount point. It is entirely equivalent to
3456 the command C<mount -o loop file mountpoint>.");
3458 ("mkswap", (RErr, [Device "device"], []), 130, [],
3459 [InitEmpty, Always, TestRun (
3460 [["part_disk"; "/dev/sda"; "mbr"];
3461 ["mkswap"; "/dev/sda1"]])],
3462 "create a swap partition",
3464 Create a swap partition on C<device>.");
3466 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3467 [InitEmpty, Always, TestRun (
3468 [["part_disk"; "/dev/sda"; "mbr"];
3469 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3470 "create a swap partition with a label",
3472 Create a swap partition on C<device> with label C<label>.
3474 Note that you cannot attach a swap label to a block device
3475 (eg. C</dev/sda>), just to a partition. This appears to be
3476 a limitation of the kernel or swap tools.");
3478 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3479 (let uuid = uuidgen () in
3480 [InitEmpty, Always, TestRun (
3481 [["part_disk"; "/dev/sda"; "mbr"];
3482 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3483 "create a swap partition with an explicit UUID",
3485 Create a swap partition on C<device> with UUID C<uuid>.");
3487 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3488 [InitScratchFS, Always, TestOutputStruct (
3489 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3490 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3491 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3492 InitScratchFS, Always, TestOutputStruct (
3493 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3494 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3495 "make block, character or FIFO devices",
3497 This call creates block or character special devices, or
3498 named pipes (FIFOs).
3500 The C<mode> parameter should be the mode, using the standard
3501 constants. C<devmajor> and C<devminor> are the
3502 device major and minor numbers, only used when creating block
3503 and character special devices.
3505 Note that, just like L<mknod(2)>, the mode must be bitwise
3506 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3507 just creates a regular file). These constants are
3508 available in the standard Linux header files, or you can use
3509 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3510 which are wrappers around this command which bitwise OR
3511 in the appropriate constant for you.
3513 The mode actually set is affected by the umask.");
3515 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3516 [InitScratchFS, Always, TestOutputStruct (
3517 [["mkfifo"; "0o777"; "/mkfifo"];
3518 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3519 "make FIFO (named pipe)",
3521 This call creates a FIFO (named pipe) called C<path> with
3522 mode C<mode>. It is just a convenient wrapper around
3525 The mode actually set is affected by the umask.");
3527 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3528 [InitScratchFS, Always, TestOutputStruct (
3529 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3530 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3531 "make block device node",
3533 This call creates a block device node called C<path> with
3534 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3535 It is just a convenient wrapper around C<guestfs_mknod>.
3537 The mode actually set is affected by the umask.");
3539 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3540 [InitScratchFS, Always, TestOutputStruct (
3541 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3542 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3543 "make char device node",
3545 This call creates a char device node called C<path> with
3546 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3547 It is just a convenient wrapper around C<guestfs_mknod>.
3549 The mode actually set is affected by the umask.");
3551 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3552 [InitEmpty, Always, TestOutputInt (
3553 [["umask"; "0o22"]], 0o22)],
3554 "set file mode creation mask (umask)",
3556 This function sets the mask used for creating new files and
3557 device nodes to C<mask & 0777>.
3559 Typical umask values would be C<022> which creates new files
3560 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3561 C<002> which creates new files with permissions like
3562 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3564 The default umask is C<022>. This is important because it
3565 means that directories and device nodes will be created with
3566 C<0644> or C<0755> mode even if you specify C<0777>.
3568 See also C<guestfs_get_umask>,
3569 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3571 This call returns the previous umask.");
3573 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3575 "read directories entries",
3577 This returns the list of directory entries in directory C<dir>.
3579 All entries in the directory are returned, including C<.> and
3580 C<..>. The entries are I<not> sorted, but returned in the same
3581 order as the underlying filesystem.
3583 Also this call returns basic file type information about each
3584 file. The C<ftyp> field will contain one of the following characters:
3622 The L<readdir(3)> call returned a C<d_type> field with an
3627 This function is primarily intended for use by programs. To
3628 get a simple list of names, use C<guestfs_ls>. To get a printable
3629 directory for human consumption, use C<guestfs_ll>.");
3631 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3633 "create partitions on a block device",
3635 This is a simplified interface to the C<guestfs_sfdisk>
3636 command, where partition sizes are specified in megabytes
3637 only (rounded to the nearest cylinder) and you don't need
3638 to specify the cyls, heads and sectors parameters which
3639 were rarely if ever used anyway.
3641 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3642 and C<guestfs_part_disk>");
3644 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3646 "determine file type inside a compressed file",
3648 This command runs C<file> after first decompressing C<path>
3651 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3653 Since 1.0.63, use C<guestfs_file> instead which can now
3654 process compressed files.");
3656 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3658 "list extended attributes of a file or directory",
3660 This call lists the extended attributes of the file or directory
3663 At the system call level, this is a combination of the
3664 L<listxattr(2)> and L<getxattr(2)> calls.
3666 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3668 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3670 "list extended attributes of a file or directory",
3672 This is the same as C<guestfs_getxattrs>, but if C<path>
3673 is a symbolic link, then it returns the extended attributes
3674 of the link itself.");
3676 ("setxattr", (RErr, [String "xattr";
3677 String "val"; Int "vallen"; (* will be BufferIn *)
3678 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3680 "set extended attribute of a file or directory",
3682 This call sets the extended attribute named C<xattr>
3683 of the file C<path> to the value C<val> (of length C<vallen>).
3684 The value is arbitrary 8 bit data.
3686 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3688 ("lsetxattr", (RErr, [String "xattr";
3689 String "val"; Int "vallen"; (* will be BufferIn *)
3690 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3692 "set extended attribute of a file or directory",
3694 This is the same as C<guestfs_setxattr>, but if C<path>
3695 is a symbolic link, then it sets an extended attribute
3696 of the link itself.");
3698 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3700 "remove extended attribute of a file or directory",
3702 This call removes the extended attribute named C<xattr>
3703 of the file C<path>.
3705 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3707 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3709 "remove extended attribute of a file or directory",
3711 This is the same as C<guestfs_removexattr>, but if C<path>
3712 is a symbolic link, then it removes an extended attribute
3713 of the link itself.");
3715 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3719 This call is similar to C<guestfs_mounts>. That call returns
3720 a list of devices. This one returns a hash table (map) of
3721 device name to directory where the device is mounted.");
3723 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3724 (* This is a special case: while you would expect a parameter
3725 * of type "Pathname", that doesn't work, because it implies
3726 * NEED_ROOT in the generated calling code in stubs.c, and
3727 * this function cannot use NEED_ROOT.
3730 "create a mountpoint",
3732 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3733 specialized calls that can be used to create extra mountpoints
3734 before mounting the first filesystem.
3736 These calls are I<only> necessary in some very limited circumstances,
3737 mainly the case where you want to mount a mix of unrelated and/or
3738 read-only filesystems together.
3740 For example, live CDs often contain a \"Russian doll\" nest of
3741 filesystems, an ISO outer layer, with a squashfs image inside, with
3742 an ext2/3 image inside that. You can unpack this as follows
3745 add-ro Fedora-11-i686-Live.iso
3749 mkmountpoint /ext3fs
3751 mount-loop /cd/LiveOS/squashfs.img /sqsh
3752 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3754 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3756 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3757 You may get unexpected errors if you try to mix these calls. It is
3758 safest to manually unmount filesystems and remove mountpoints after use.
3760 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3761 longest first, so for this to work for manual mountpoints, you
3762 must ensure that the innermost mountpoints have the longest
3763 pathnames, as in the example code above.
3765 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3767 Autosync [see C<guestfs_set_autosync>, this is set by default on
3768 handles] means that C<guestfs_umount_all> is called when the handle
3769 is closed which can also trigger these issues.");
3771 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3773 "remove a mountpoint",
3775 This calls removes a mountpoint that was previously created
3776 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3777 for full details.");
3779 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3780 [InitISOFS, Always, TestOutputBuffer (
3781 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3782 (* Test various near large, large and too large files (RHBZ#589039). *)
3783 InitScratchFS, Always, TestLastFail (
3784 [["touch"; "/read_file"];
3785 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3786 ["read_file"; "/read_file"]]);
3787 InitScratchFS, Always, TestLastFail (
3788 [["touch"; "/read_file2"];
3789 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3790 ["read_file"; "/read_file2"]]);
3791 InitScratchFS, Always, TestLastFail (
3792 [["touch"; "/read_file3"];
3793 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3794 ["read_file"; "/read_file3"]])],
3797 This calls returns the contents of the file C<path> as a
3800 Unlike C<guestfs_cat>, this function can correctly
3801 handle files that contain embedded ASCII NUL characters.
3802 However unlike C<guestfs_download>, this function is limited
3803 in the total size of file that can be handled.");
3805 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3806 [InitISOFS, Always, TestOutputList (
3807 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3808 InitISOFS, Always, TestOutputList (
3809 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3810 (* Test for RHBZ#579608, absolute symbolic links. *)
3811 InitISOFS, Always, TestOutputList (
3812 [["grep"; "nomatch"; "/abssymlink"]], [])],
3813 "return lines matching a pattern",
3815 This calls the external C<grep> program and returns the
3818 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3819 [InitISOFS, Always, TestOutputList (
3820 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3821 "return lines matching a pattern",
3823 This calls the external C<egrep> program and returns the
3826 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3827 [InitISOFS, Always, TestOutputList (
3828 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3829 "return lines matching a pattern",
3831 This calls the external C<fgrep> program and returns the
3834 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3835 [InitISOFS, Always, TestOutputList (
3836 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3837 "return lines matching a pattern",
3839 This calls the external C<grep -i> program and returns the
3842 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3843 [InitISOFS, Always, TestOutputList (
3844 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3845 "return lines matching a pattern",
3847 This calls the external C<egrep -i> program and returns the
3850 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3851 [InitISOFS, Always, TestOutputList (
3852 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3853 "return lines matching a pattern",
3855 This calls the external C<fgrep -i> program and returns the
3858 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3859 [InitISOFS, Always, TestOutputList (
3860 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3861 "return lines matching a pattern",
3863 This calls the external C<zgrep> program and returns the
3866 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3867 [InitISOFS, Always, TestOutputList (
3868 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3869 "return lines matching a pattern",
3871 This calls the external C<zegrep> program and returns the
3874 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3875 [InitISOFS, Always, TestOutputList (
3876 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3877 "return lines matching a pattern",
3879 This calls the external C<zfgrep> program and returns the
3882 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3883 [InitISOFS, Always, TestOutputList (
3884 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3885 "return lines matching a pattern",
3887 This calls the external C<zgrep -i> program and returns the
3890 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3891 [InitISOFS, Always, TestOutputList (
3892 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3893 "return lines matching a pattern",
3895 This calls the external C<zegrep -i> program and returns the
3898 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3899 [InitISOFS, Always, TestOutputList (
3900 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3901 "return lines matching a pattern",
3903 This calls the external C<zfgrep -i> program and returns the
3906 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3907 [InitISOFS, Always, TestOutput (
3908 [["realpath"; "/../directory"]], "/directory")],
3909 "canonicalized absolute pathname",
3911 Return the canonicalized absolute pathname of C<path>. The
3912 returned path has no C<.>, C<..> or symbolic link path elements.");
3914 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3915 [InitScratchFS, Always, TestOutputStruct (
3918 ["ln"; "/ln/a"; "/ln/b"];
3919 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
3920 "create a hard link",
3922 This command creates a hard link using the C<ln> command.");
3924 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3925 [InitScratchFS, Always, TestOutputStruct (
3926 [["mkdir"; "/ln_f"];
3927 ["touch"; "/ln_f/a"];
3928 ["touch"; "/ln_f/b"];
3929 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
3930 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
3931 "create a hard link",
3933 This command creates a hard link using the C<ln -f> command.
3934 The C<-f> option removes the link (C<linkname>) if it exists already.");
3936 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3937 [InitScratchFS, Always, TestOutputStruct (
3938 [["mkdir"; "/ln_s"];
3939 ["touch"; "/ln_s/a"];
3940 ["ln_s"; "a"; "/ln_s/b"];
3941 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
3942 "create a symbolic link",
3944 This command creates a symbolic link using the C<ln -s> command.");
3946 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3947 [InitScratchFS, Always, TestOutput (
3948 [["mkdir_p"; "/ln_sf/b"];
3949 ["touch"; "/ln_sf/b/c"];
3950 ["ln_sf"; "../d"; "/ln_sf/b/c"];
3951 ["readlink"; "/ln_sf/b/c"]], "../d")],
3952 "create a symbolic link",
3954 This command creates a symbolic link using the C<ln -sf> command,
3955 The C<-f> option removes the link (C<linkname>) if it exists already.");
3957 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3958 [] (* XXX tested above *),
3959 "read the target of a symbolic link",
3961 This command reads the target of a symbolic link.");
3963 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3964 [InitScratchFS, Always, TestOutputStruct (
3965 [["fallocate"; "/fallocate"; "1000000"];
3966 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
3967 "preallocate a file in the guest filesystem",
3969 This command preallocates a file (containing zero bytes) named
3970 C<path> of size C<len> bytes. If the file exists already, it
3973 Do not confuse this with the guestfish-specific
3974 C<alloc> command which allocates a file in the host and
3975 attaches it as a device.");
3977 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3978 [InitPartition, Always, TestRun (
3979 [["mkswap"; "/dev/sda1"];
3980 ["swapon_device"; "/dev/sda1"];
3981 ["swapoff_device"; "/dev/sda1"]])],
3982 "enable swap on device",
3984 This command enables the libguestfs appliance to use the
3985 swap device or partition named C<device>. The increased
3986 memory is made available for all commands, for example
3987 those run using C<guestfs_command> or C<guestfs_sh>.
3989 Note that you should not swap to existing guest swap
3990 partitions unless you know what you are doing. They may
3991 contain hibernation information, or other information that
3992 the guest doesn't want you to trash. You also risk leaking
3993 information about the host to the guest this way. Instead,
3994 attach a new host device to the guest and swap on that.");
3996 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3997 [], (* XXX tested by swapon_device *)
3998 "disable swap on device",
4000 This command disables the libguestfs appliance swap
4001 device or partition named C<device>.
4002 See C<guestfs_swapon_device>.");
4004 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4005 [InitScratchFS, Always, TestRun (
4006 [["fallocate"; "/swapon_file"; "8388608"];
4007 ["mkswap_file"; "/swapon_file"];
4008 ["swapon_file"; "/swapon_file"];
4009 ["swapoff_file"; "/swapon_file"];
4010 ["rm"; "/swapon_file"]])],
4011 "enable swap on file",
4013 This command enables swap to a file.
4014 See C<guestfs_swapon_device> for other notes.");
4016 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4017 [], (* XXX tested by swapon_file *)
4018 "disable swap on file",
4020 This command disables the libguestfs appliance swap on file.");
4022 ("swapon_label", (RErr, [String "label"], []), 174, [],
4023 [InitEmpty, Always, TestRun (
4024 [["part_disk"; "/dev/sda"; "mbr"];
4025 ["mkswap_L"; "swapit"; "/dev/sda1"];
4026 ["swapon_label"; "swapit"];
4027 ["swapoff_label"; "swapit"];
4028 ["zero"; "/dev/sda"];
4029 ["blockdev_rereadpt"; "/dev/sda"]])],
4030 "enable swap on labeled swap partition",
4032 This command enables swap to a labeled swap partition.
4033 See C<guestfs_swapon_device> for other notes.");
4035 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4036 [], (* XXX tested by swapon_label *)
4037 "disable swap on labeled swap partition",
4039 This command disables the libguestfs appliance swap on
4040 labeled swap partition.");
4042 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4043 (let uuid = uuidgen () in
4044 [InitEmpty, Always, TestRun (
4045 [["mkswap_U"; uuid; "/dev/sdc"];
4046 ["swapon_uuid"; uuid];
4047 ["swapoff_uuid"; uuid]])]),
4048 "enable swap on swap partition by UUID",
4050 This command enables swap to a swap partition with the given UUID.
4051 See C<guestfs_swapon_device> for other notes.");
4053 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4054 [], (* XXX tested by swapon_uuid *)
4055 "disable swap on swap partition by UUID",
4057 This command disables the libguestfs appliance swap partition
4058 with the given UUID.");
4060 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4061 [InitScratchFS, Always, TestRun (
4062 [["fallocate"; "/mkswap_file"; "8388608"];
4063 ["mkswap_file"; "/mkswap_file"];
4064 ["rm"; "/mkswap_file"]])],
4065 "create a swap file",
4069 This command just writes a swap file signature to an existing
4070 file. To create the file itself, use something like C<guestfs_fallocate>.");
4072 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4073 [InitISOFS, Always, TestRun (
4074 [["inotify_init"; "0"]])],
4075 "create an inotify handle",
4077 This command creates a new inotify handle.
4078 The inotify subsystem can be used to notify events which happen to
4079 objects in the guest filesystem.
4081 C<maxevents> is the maximum number of events which will be
4082 queued up between calls to C<guestfs_inotify_read> or
4083 C<guestfs_inotify_files>.
4084 If this is passed as C<0>, then the kernel (or previously set)
4085 default is used. For Linux 2.6.29 the default was 16384 events.
4086 Beyond this limit, the kernel throws away events, but records
4087 the fact that it threw them away by setting a flag
4088 C<IN_Q_OVERFLOW> in the returned structure list (see
4089 C<guestfs_inotify_read>).
4091 Before any events are generated, you have to add some
4092 watches to the internal watch list. See:
4093 C<guestfs_inotify_add_watch>,
4094 C<guestfs_inotify_rm_watch> and
4095 C<guestfs_inotify_watch_all>.
4097 Queued up events should be read periodically by calling
4098 C<guestfs_inotify_read>
4099 (or C<guestfs_inotify_files> which is just a helpful
4100 wrapper around C<guestfs_inotify_read>). If you don't
4101 read the events out often enough then you risk the internal
4104 The handle should be closed after use by calling
4105 C<guestfs_inotify_close>. This also removes any
4106 watches automatically.
4108 See also L<inotify(7)> for an overview of the inotify interface
4109 as exposed by the Linux kernel, which is roughly what we expose
4110 via libguestfs. Note that there is one global inotify handle
4111 per libguestfs instance.");
4113 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4114 [InitScratchFS, Always, TestOutputList (
4115 [["mkdir"; "/inotify_add_watch"];
4116 ["inotify_init"; "0"];
4117 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4118 ["touch"; "/inotify_add_watch/a"];
4119 ["touch"; "/inotify_add_watch/b"];
4120 ["inotify_files"]], ["a"; "b"])],
4121 "add an inotify watch",
4123 Watch C<path> for the events listed in C<mask>.
4125 Note that if C<path> is a directory then events within that
4126 directory are watched, but this does I<not> happen recursively
4127 (in subdirectories).
4129 Note for non-C or non-Linux callers: the inotify events are
4130 defined by the Linux kernel ABI and are listed in
4131 C</usr/include/sys/inotify.h>.");
4133 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4135 "remove an inotify watch",
4137 Remove a previously defined inotify watch.
4138 See C<guestfs_inotify_add_watch>.");
4140 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4142 "return list of inotify events",
4144 Return the complete queue of events that have happened
4145 since the previous read call.
4147 If no events have happened, this returns an empty list.
4149 I<Note>: In order to make sure that all events have been
4150 read, you must call this function repeatedly until it
4151 returns an empty list. The reason is that the call will
4152 read events up to the maximum appliance-to-host message
4153 size and leave remaining events in the queue.");
4155 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4157 "return list of watched files that had events",
4159 This function is a helpful wrapper around C<guestfs_inotify_read>
4160 which just returns a list of pathnames of objects that were
4161 touched. The returned pathnames are sorted and deduplicated.");
4163 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4165 "close the inotify handle",
4167 This closes the inotify handle which was previously
4168 opened by inotify_init. It removes all watches, throws
4169 away any pending events, and deallocates all resources.");
4171 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4173 "set SELinux security context",
4175 This sets the SELinux security context of the daemon
4176 to the string C<context>.
4178 See the documentation about SELINUX in L<guestfs(3)>.");
4180 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4182 "get SELinux security context",
4184 This gets the SELinux security context of the daemon.
4186 See the documentation about SELINUX in L<guestfs(3)>,
4187 and C<guestfs_setcon>");
4189 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4190 [InitEmpty, Always, TestOutput (
4191 [["part_disk"; "/dev/sda"; "mbr"];
4192 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4193 ["mount_options"; ""; "/dev/sda1"; "/"];
4194 ["write"; "/new"; "new file contents"];
4195 ["cat"; "/new"]], "new file contents");
4196 InitEmpty, Always, TestRun (
4197 [["part_disk"; "/dev/sda"; "mbr"];
4198 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4199 InitEmpty, Always, TestLastFail (
4200 [["part_disk"; "/dev/sda"; "mbr"];
4201 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4202 InitEmpty, Always, TestLastFail (
4203 [["part_disk"; "/dev/sda"; "mbr"];
4204 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4205 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4206 [["part_disk"; "/dev/sda"; "mbr"];
4207 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4208 "make a filesystem with block size",
4210 This call is similar to C<guestfs_mkfs>, but it allows you to
4211 control the block size of the resulting filesystem. Supported
4212 block sizes depend on the filesystem type, but typically they
4213 are C<1024>, C<2048> or C<4096> only.
4215 For VFAT and NTFS the C<blocksize> parameter is treated as
4216 the requested cluster size.");
4218 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4219 [InitEmpty, Always, TestOutput (
4220 [["part_init"; "/dev/sda"; "mbr"];
4221 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4222 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4223 ["mke2journal"; "4096"; "/dev/sda1"];
4224 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4225 ["mount_options"; ""; "/dev/sda2"; "/"];
4226 ["write"; "/new"; "new file contents"];
4227 ["cat"; "/new"]], "new file contents")],
4228 "make ext2/3/4 external journal",
4230 This creates an ext2 external journal on C<device>. It is equivalent
4233 mke2fs -O journal_dev -b blocksize device");
4235 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4236 [InitEmpty, Always, TestOutput (
4237 [["part_init"; "/dev/sda"; "mbr"];
4238 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4239 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4240 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4241 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4242 ["mount_options"; ""; "/dev/sda2"; "/"];
4243 ["write"; "/new"; "new file contents"];
4244 ["cat"; "/new"]], "new file contents")],
4245 "make ext2/3/4 external journal with label",
4247 This creates an ext2 external journal on C<device> with label C<label>.");
4249 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4250 (let uuid = uuidgen () in
4251 [InitEmpty, Always, TestOutput (
4252 [["part_init"; "/dev/sda"; "mbr"];
4253 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4254 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4255 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4256 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4257 ["mount_options"; ""; "/dev/sda2"; "/"];
4258 ["write"; "/new"; "new file contents"];
4259 ["cat"; "/new"]], "new file contents")]),
4260 "make ext2/3/4 external journal with UUID",
4262 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4264 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4266 "make ext2/3/4 filesystem with external journal",
4268 This creates an ext2/3/4 filesystem on C<device> with
4269 an external journal on C<journal>. It is equivalent
4272 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4274 See also C<guestfs_mke2journal>.");
4276 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4278 "make ext2/3/4 filesystem with external journal",
4280 This creates an ext2/3/4 filesystem on C<device> with
4281 an external journal on the journal labeled C<label>.
4283 See also C<guestfs_mke2journal_L>.");
4285 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4287 "make ext2/3/4 filesystem with external journal",
4289 This creates an ext2/3/4 filesystem on C<device> with
4290 an external journal on the journal with UUID C<uuid>.
4292 See also C<guestfs_mke2journal_U>.");
4294 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4295 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4296 "load a kernel module",
4298 This loads a kernel module in the appliance.
4300 The kernel module must have been whitelisted when libguestfs
4301 was built (see C<appliance/kmod.whitelist.in> in the source).");
4303 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4304 [InitNone, Always, TestOutput (
4305 [["echo_daemon"; "This is a test"]], "This is a test"
4307 "echo arguments back to the client",
4309 This command concatenates the list of C<words> passed with single spaces
4310 between them and returns the resulting string.
4312 You can use this command to test the connection through to the daemon.
4314 See also C<guestfs_ping_daemon>.");
4316 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4317 [], (* There is a regression test for this. *)
4318 "find all files and directories, returning NUL-separated list",
4320 This command lists out all files and directories, recursively,
4321 starting at C<directory>, placing the resulting list in the
4322 external file called C<files>.
4324 This command works the same way as C<guestfs_find> with the
4325 following exceptions:
4331 The resulting list is written to an external file.
4335 Items (filenames) in the result are separated
4336 by C<\\0> characters. See L<find(1)> option I<-print0>.
4340 This command is not limited in the number of names that it
4345 The result list is not sorted.
4349 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4350 [InitISOFS, Always, TestOutput (
4351 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4352 InitISOFS, Always, TestOutput (
4353 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4354 InitISOFS, Always, TestOutput (
4355 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4356 InitISOFS, Always, TestLastFail (
4357 [["case_sensitive_path"; "/Known-1/"]]);
4358 InitScratchFS, Always, TestOutput (
4359 [["mkdir"; "/case_sensitive_path"];
4360 ["mkdir"; "/case_sensitive_path/bbb"];
4361 ["touch"; "/case_sensitive_path/bbb/c"];
4362 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4363 InitScratchFS, Always, TestOutput (
4364 [["mkdir"; "/case_sensitive_path2"];
4365 ["mkdir"; "/case_sensitive_path2/bbb"];
4366 ["touch"; "/case_sensitive_path2/bbb/c"];
4367 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4368 InitScratchFS, Always, TestLastFail (
4369 [["mkdir"; "/case_sensitive_path3"];
4370 ["mkdir"; "/case_sensitive_path3/bbb"];
4371 ["touch"; "/case_sensitive_path3/bbb/c"];
4372 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4373 "return true path on case-insensitive filesystem",
4375 This can be used to resolve case insensitive paths on
4376 a filesystem which is case sensitive. The use case is
4377 to resolve paths which you have read from Windows configuration
4378 files or the Windows Registry, to the true path.
4380 The command handles a peculiarity of the Linux ntfs-3g
4381 filesystem driver (and probably others), which is that although
4382 the underlying filesystem is case-insensitive, the driver
4383 exports the filesystem to Linux as case-sensitive.
4385 One consequence of this is that special directories such
4386 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4387 (or other things) depending on the precise details of how
4388 they were created. In Windows itself this would not be
4391 Bug or feature? You decide:
4392 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4394 This function resolves the true case of each element in the
4395 path and returns the case-sensitive path.
4397 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4398 might return C<\"/WINDOWS/system32\"> (the exact return value
4399 would depend on details of how the directories were originally
4400 created under Windows).
4403 This function does not handle drive names, backslashes etc.
4405 See also C<guestfs_realpath>.");
4407 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4408 [InitScratchFS, Always, TestOutput (
4409 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4410 "get the Linux VFS type corresponding to a mounted device",
4412 This command gets the filesystem type corresponding to
4413 the filesystem on C<device>.
4415 For most filesystems, the result is the name of the Linux
4416 VFS module which would be used to mount this filesystem
4417 if you mounted it without specifying the filesystem type.
4418 For example a string such as C<ext3> or C<ntfs>.");
4420 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4421 [InitScratchFS, Always, TestOutputStruct (
4422 [["write"; "/truncate"; "some stuff so size is not zero"];
4423 ["truncate"; "/truncate"];
4424 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4425 "truncate a file to zero size",
4427 This command truncates C<path> to a zero-length file. The
4428 file must exist already.");
4430 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4431 [InitScratchFS, Always, TestOutputStruct (
4432 [["touch"; "/truncate_size"];
4433 ["truncate_size"; "/truncate_size"; "1000"];
4434 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4435 "truncate a file to a particular size",
4437 This command truncates C<path> to size C<size> bytes. The file
4440 If the current file size is less than C<size> then
4441 the file is extended to the required size with zero bytes.
4442 This creates a sparse file (ie. disk blocks are not allocated
4443 for the file until you write to it). To create a non-sparse
4444 file of zeroes, use C<guestfs_fallocate64> instead.");
4446 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4447 [InitScratchFS, Always, TestOutputStruct (
4448 [["touch"; "/utimens"];
4449 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4450 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4451 "set timestamp of a file with nanosecond precision",
4453 This command sets the timestamps of a file with nanosecond
4456 C<atsecs, atnsecs> are the last access time (atime) in secs and
4457 nanoseconds from the epoch.
4459 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4460 secs and nanoseconds from the epoch.
4462 If the C<*nsecs> field contains the special value C<-1> then
4463 the corresponding timestamp is set to the current time. (The
4464 C<*secs> field is ignored in this case).
4466 If the C<*nsecs> field contains the special value C<-2> then
4467 the corresponding timestamp is left unchanged. (The
4468 C<*secs> field is ignored in this case).");
4470 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4471 [InitScratchFS, Always, TestOutputStruct (
4472 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4473 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4474 "create a directory with a particular mode",
4476 This command creates a directory, setting the initial permissions
4477 of the directory to C<mode>.
4479 For common Linux filesystems, the actual mode which is set will
4480 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4481 interpret the mode in other ways.
4483 See also C<guestfs_mkdir>, C<guestfs_umask>");
4485 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4487 "change file owner and group",
4489 Change the file owner to C<owner> and group to C<group>.
4490 This is like C<guestfs_chown> but if C<path> is a symlink then
4491 the link itself is changed, not the target.
4493 Only numeric uid and gid are supported. If you want to use
4494 names, you will need to locate and parse the password file
4495 yourself (Augeas support makes this relatively easy).");
4497 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4499 "lstat on multiple files",
4501 This call allows you to perform the C<guestfs_lstat> operation
4502 on multiple files, where all files are in the directory C<path>.
4503 C<names> is the list of files from this directory.
4505 On return you get a list of stat structs, with a one-to-one
4506 correspondence to the C<names> list. If any name did not exist
4507 or could not be lstat'd, then the C<ino> field of that structure
4510 This call is intended for programs that want to efficiently
4511 list a directory contents without making many round-trips.
4512 See also C<guestfs_lxattrlist> for a similarly efficient call
4513 for getting extended attributes. Very long directory listings
4514 might cause the protocol message size to be exceeded, causing
4515 this call to fail. The caller must split up such requests
4516 into smaller groups of names.");
4518 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4520 "lgetxattr on multiple files",
4522 This call allows you to get the extended attributes
4523 of multiple files, where all files are in the directory C<path>.
4524 C<names> is the list of files from this directory.
4526 On return you get a flat list of xattr structs which must be
4527 interpreted sequentially. The first xattr struct always has a zero-length
4528 C<attrname>. C<attrval> in this struct is zero-length
4529 to indicate there was an error doing C<lgetxattr> for this
4530 file, I<or> is a C string which is a decimal number
4531 (the number of following attributes for this file, which could
4532 be C<\"0\">). Then after the first xattr struct are the
4533 zero or more attributes for the first named file.
4534 This repeats for the second and subsequent files.
4536 This call is intended for programs that want to efficiently
4537 list a directory contents without making many round-trips.
4538 See also C<guestfs_lstatlist> for a similarly efficient call
4539 for getting standard stats. Very long directory listings
4540 might cause the protocol message size to be exceeded, causing
4541 this call to fail. The caller must split up such requests
4542 into smaller groups of names.");
4544 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4546 "readlink on multiple files",
4548 This call allows you to do a C<readlink> operation
4549 on multiple files, where all files are in the directory C<path>.
4550 C<names> is the list of files from this directory.
4552 On return you get a list of strings, with a one-to-one
4553 correspondence to the C<names> list. Each string is the
4554 value of the symbolic link.
4556 If the C<readlink(2)> operation fails on any name, then
4557 the corresponding result string is the empty string C<\"\">.
4558 However the whole operation is completed even if there
4559 were C<readlink(2)> errors, and so you can call this
4560 function with names where you don't know if they are
4561 symbolic links already (albeit slightly less efficient).
4563 This call is intended for programs that want to efficiently
4564 list a directory contents without making many round-trips.
4565 Very long directory listings might cause the protocol
4566 message size to be exceeded, causing
4567 this call to fail. The caller must split up such requests
4568 into smaller groups of names.");
4570 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4571 [InitISOFS, Always, TestOutputBuffer (
4572 [["pread"; "/known-4"; "1"; "3"]], "\n");
4573 InitISOFS, Always, TestOutputBuffer (
4574 [["pread"; "/empty"; "0"; "100"]], "")],
4575 "read part of a file",
4577 This command lets you read part of a file. It reads C<count>
4578 bytes of the file, starting at C<offset>, from file C<path>.
4580 This may read fewer bytes than requested. For further details
4581 see the L<pread(2)> system call.
4583 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4585 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4586 [InitEmpty, Always, TestRun (
4587 [["part_init"; "/dev/sda"; "gpt"]])],
4588 "create an empty partition table",
4590 This creates an empty partition table on C<device> of one of the
4591 partition types listed below. Usually C<parttype> should be
4592 either C<msdos> or C<gpt> (for large disks).
4594 Initially there are no partitions. Following this, you should
4595 call C<guestfs_part_add> for each partition required.
4597 Possible values for C<parttype> are:
4601 =item B<efi> | B<gpt>
4603 Intel EFI / GPT partition table.
4605 This is recommended for >= 2 TB partitions that will be accessed
4606 from Linux and Intel-based Mac OS X. It also has limited backwards
4607 compatibility with the C<mbr> format.
4609 =item B<mbr> | B<msdos>
4611 The standard PC \"Master Boot Record\" (MBR) format used
4612 by MS-DOS and Windows. This partition type will B<only> work
4613 for device sizes up to 2 TB. For large disks we recommend
4618 Other partition table types that may work but are not
4627 =item B<amiga> | B<rdb>
4629 Amiga \"Rigid Disk Block\" format.
4637 DASD, used on IBM mainframes.
4645 Old Mac partition format. Modern Macs use C<gpt>.
4649 NEC PC-98 format, common in Japan apparently.
4657 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4658 [InitEmpty, Always, TestRun (
4659 [["part_init"; "/dev/sda"; "mbr"];
4660 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4661 InitEmpty, Always, TestRun (
4662 [["part_init"; "/dev/sda"; "gpt"];
4663 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4664 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4665 InitEmpty, Always, TestRun (
4666 [["part_init"; "/dev/sda"; "mbr"];
4667 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4668 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4669 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4670 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4671 "add a partition to the device",
4673 This command adds a partition to C<device>. If there is no partition
4674 table on the device, call C<guestfs_part_init> first.
4676 The C<prlogex> parameter is the type of partition. Normally you
4677 should pass C<p> or C<primary> here, but MBR partition tables also
4678 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4681 C<startsect> and C<endsect> are the start and end of the partition
4682 in I<sectors>. C<endsect> may be negative, which means it counts
4683 backwards from the end of the disk (C<-1> is the last sector).
4685 Creating a partition which covers the whole disk is not so easy.
4686 Use C<guestfs_part_disk> to do that.");
4688 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4689 [InitEmpty, Always, TestRun (
4690 [["part_disk"; "/dev/sda"; "mbr"]]);
4691 InitEmpty, Always, TestRun (
4692 [["part_disk"; "/dev/sda"; "gpt"]])],
4693 "partition whole disk with a single primary partition",
4695 This command is simply a combination of C<guestfs_part_init>
4696 followed by C<guestfs_part_add> to create a single primary partition
4697 covering the whole disk.
4699 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4700 but other possible values are described in C<guestfs_part_init>.");
4702 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4703 [InitEmpty, Always, TestRun (
4704 [["part_disk"; "/dev/sda"; "mbr"];
4705 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4706 "make a partition bootable",
4708 This sets the bootable flag on partition numbered C<partnum> on
4709 device C<device>. Note that partitions are numbered from 1.
4711 The bootable flag is used by some operating systems (notably
4712 Windows) to determine which partition to boot from. It is by
4713 no means universally recognized.");
4715 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4716 [InitEmpty, Always, TestRun (
4717 [["part_disk"; "/dev/sda"; "gpt"];
4718 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4719 "set partition name",
4721 This sets the partition name on partition numbered C<partnum> on
4722 device C<device>. Note that partitions are numbered from 1.
4724 The partition name can only be set on certain types of partition
4725 table. This works on C<gpt> but not on C<mbr> partitions.");
4727 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4728 [], (* XXX Add a regression test for this. *)
4729 "list partitions on a device",
4731 This command parses the partition table on C<device> and
4732 returns the list of partitions found.
4734 The fields in the returned structure are:
4740 Partition number, counting from 1.
4744 Start of the partition I<in bytes>. To get sectors you have to
4745 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4749 End of the partition in bytes.
4753 Size of the partition in bytes.
4757 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4758 [InitEmpty, Always, TestOutput (
4759 [["part_disk"; "/dev/sda"; "gpt"];
4760 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4761 "get the partition table type",
4763 This command examines the partition table on C<device> and
4764 returns the partition table type (format) being used.
4766 Common return values include: C<msdos> (a DOS/Windows style MBR
4767 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4768 values are possible, although unusual. See C<guestfs_part_init>
4771 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4772 [InitScratchFS, Always, TestOutputBuffer (
4773 [["fill"; "0x63"; "10"; "/fill"];
4774 ["read_file"; "/fill"]], "cccccccccc")],
4775 "fill a file with octets",
4777 This command creates a new file called C<path>. The initial
4778 content of the file is C<len> octets of C<c>, where C<c>
4779 must be a number in the range C<[0..255]>.
4781 To fill a file with zero bytes (sparsely), it is
4782 much more efficient to use C<guestfs_truncate_size>.
4783 To create a file with a pattern of repeating bytes
4784 use C<guestfs_fill_pattern>.");
4786 ("available", (RErr, [StringList "groups"], []), 216, [],
4787 [InitNone, Always, TestRun [["available"; ""]]],
4788 "test availability of some parts of the API",
4790 This command is used to check the availability of some
4791 groups of functionality in the appliance, which not all builds of
4792 the libguestfs appliance will be able to provide.
4794 The libguestfs groups, and the functions that those
4795 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4796 You can also fetch this list at runtime by calling
4797 C<guestfs_available_all_groups>.
4799 The argument C<groups> is a list of group names, eg:
4800 C<[\"inotify\", \"augeas\"]> would check for the availability of
4801 the Linux inotify functions and Augeas (configuration file
4804 The command returns no error if I<all> requested groups are available.
4806 It fails with an error if one or more of the requested
4807 groups is unavailable in the appliance.
4809 If an unknown group name is included in the
4810 list of groups then an error is always returned.
4818 You must call C<guestfs_launch> before calling this function.
4820 The reason is because we don't know what groups are
4821 supported by the appliance/daemon until it is running and can
4826 If a group of functions is available, this does not necessarily
4827 mean that they will work. You still have to check for errors
4828 when calling individual API functions even if they are
4833 It is usually the job of distro packagers to build
4834 complete functionality into the libguestfs appliance.
4835 Upstream libguestfs, if built from source with all
4836 requirements satisfied, will support everything.
4840 This call was added in version C<1.0.80>. In previous
4841 versions of libguestfs all you could do would be to speculatively
4842 execute a command to find out if the daemon implemented it.
4843 See also C<guestfs_version>.
4847 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4848 [InitScratchFS, Always, TestOutputBuffer (
4850 ["write"; "/dd/src"; "hello, world"];
4851 ["dd"; "/dd/src"; "/dd/dest"];
4852 ["read_file"; "/dd/dest"]], "hello, world")],
4853 "copy from source to destination using dd",
4855 This command copies from one source device or file C<src>
4856 to another destination device or file C<dest>. Normally you
4857 would use this to copy to or from a device or partition, for
4858 example to duplicate a filesystem.
4860 If the destination is a device, it must be as large or larger
4861 than the source file or device, otherwise the copy will fail.
4862 This command cannot do partial copies (see C<guestfs_copy_size>).");
4864 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4865 [InitScratchFS, Always, TestOutputInt (
4866 [["write"; "/filesize"; "hello, world"];
4867 ["filesize"; "/filesize"]], 12)],
4868 "return the size of the file in bytes",
4870 This command returns the size of C<file> in bytes.
4872 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4873 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4874 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4876 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4877 [InitBasicFSonLVM, Always, TestOutputList (
4878 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4879 ["lvs"]], ["/dev/VG/LV2"])],
4880 "rename an LVM logical volume",
4882 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4884 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4885 [InitBasicFSonLVM, Always, TestOutputList (
4887 ["vg_activate"; "false"; "VG"];
4888 ["vgrename"; "VG"; "VG2"];
4889 ["vg_activate"; "true"; "VG2"];
4890 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4891 ["vgs"]], ["VG2"])],
4892 "rename an LVM volume group",
4894 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4896 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4897 [InitISOFS, Always, TestOutputBuffer (
4898 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4899 "list the contents of a single file in an initrd",
4901 This command unpacks the file C<filename> from the initrd file
4902 called C<initrdpath>. The filename must be given I<without> the
4903 initial C</> character.
4905 For example, in guestfish you could use the following command
4906 to examine the boot script (usually called C</init>)
4907 contained in a Linux initrd or initramfs image:
4909 initrd-cat /boot/initrd-<version>.img init
4911 See also C<guestfs_initrd_list>.");
4913 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4915 "get the UUID of a physical volume",
4917 This command returns the UUID of the LVM PV C<device>.");
4919 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4921 "get the UUID of a volume group",
4923 This command returns the UUID of the LVM VG named C<vgname>.");
4925 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4927 "get the UUID of a logical volume",
4929 This command returns the UUID of the LVM LV C<device>.");
4931 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4933 "get the PV UUIDs containing the volume group",
4935 Given a VG called C<vgname>, this returns the UUIDs of all
4936 the physical volumes that this volume group resides on.
4938 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4939 calls to associate physical volumes and volume groups.
4941 See also C<guestfs_vglvuuids>.");
4943 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4945 "get the LV UUIDs of all LVs in the volume group",
4947 Given a VG called C<vgname>, this returns the UUIDs of all
4948 the logical volumes created in this volume group.
4950 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4951 calls to associate logical volumes and volume groups.
4953 See also C<guestfs_vgpvuuids>.");
4955 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4956 [InitScratchFS, Always, TestOutputBuffer (
4957 [["mkdir"; "/copy_size"];
4958 ["write"; "/copy_size/src"; "hello, world"];
4959 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
4960 ["read_file"; "/copy_size/dest"]], "hello")],
4961 "copy size bytes from source to destination using dd",
4963 This command copies exactly C<size> bytes from one source device
4964 or file C<src> to another destination device or file C<dest>.
4966 Note this will fail if the source is too short or if the destination
4967 is not large enough.");
4969 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4970 [InitBasicFSonLVM, Always, TestRun (
4971 [["zero_device"; "/dev/VG/LV"]])],
4972 "write zeroes to an entire device",
4974 This command writes zeroes over the entire C<device>. Compare
4975 with C<guestfs_zero> which just zeroes the first few blocks of
4978 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4979 [InitScratchFS, Always, TestOutput (
4980 [["mkdir"; "/txz_in"];
4981 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
4982 ["cat"; "/txz_in/hello"]], "hello\n")],
4983 "unpack compressed tarball to directory",
4985 This command uploads and unpacks local file C<tarball> (an
4986 I<xz compressed> tar file) into C<directory>.");
4988 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4990 "pack directory into compressed tarball",
4992 This command packs the contents of C<directory> and downloads
4993 it to local file C<tarball> (as an xz compressed tar archive).");
4995 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4997 "resize an NTFS filesystem",
4999 This command resizes an NTFS filesystem, expanding or
5000 shrinking it to the size of the underlying device.
5001 See also L<ntfsresize(8)>.");
5003 ("vgscan", (RErr, [], []), 232, [],
5004 [InitEmpty, Always, TestRun (
5006 "rescan for LVM physical volumes, volume groups and logical volumes",
5008 This rescans all block devices and rebuilds the list of LVM
5009 physical volumes, volume groups and logical volumes.");
5011 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5012 [InitEmpty, Always, TestRun (
5013 [["part_init"; "/dev/sda"; "mbr"];
5014 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5015 ["part_del"; "/dev/sda"; "1"]])],
5016 "delete a partition",
5018 This command deletes the partition numbered C<partnum> on C<device>.
5020 Note that in the case of MBR partitioning, deleting an
5021 extended partition also deletes any logical partitions
5024 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5025 [InitEmpty, Always, TestOutputTrue (
5026 [["part_init"; "/dev/sda"; "mbr"];
5027 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5028 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5029 ["part_get_bootable"; "/dev/sda"; "1"]])],
5030 "return true if a partition is bootable",
5032 This command returns true if the partition C<partnum> on
5033 C<device> has the bootable flag set.
5035 See also C<guestfs_part_set_bootable>.");
5037 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5038 [InitEmpty, Always, TestOutputInt (
5039 [["part_init"; "/dev/sda"; "mbr"];
5040 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5041 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5042 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5043 "get the MBR type byte (ID byte) from a partition",
5045 Returns the MBR type byte (also known as the ID byte) from
5046 the numbered partition C<partnum>.
5048 Note that only MBR (old DOS-style) partitions have type bytes.
5049 You will get undefined results for other partition table
5050 types (see C<guestfs_part_get_parttype>).");
5052 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5053 [], (* tested by part_get_mbr_id *)
5054 "set the MBR type byte (ID byte) of a partition",
5056 Sets the MBR type byte (also known as the ID byte) of
5057 the numbered partition C<partnum> to C<idbyte>. Note
5058 that the type bytes quoted in most documentation are
5059 in fact hexadecimal numbers, but usually documented
5060 without any leading \"0x\" which might be confusing.
5062 Note that only MBR (old DOS-style) partitions have type bytes.
5063 You will get undefined results for other partition table
5064 types (see C<guestfs_part_get_parttype>).");
5066 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5067 [InitISOFS, Always, TestOutputFileMD5 (
5068 [["checksum_device"; "md5"; "/dev/sdd"]],
5069 "../images/test.iso")],
5070 "compute MD5, SHAx or CRC checksum of the contents of a device",
5072 This call computes the MD5, SHAx or CRC checksum of the
5073 contents of the device named C<device>. For the types of
5074 checksums supported see the C<guestfs_checksum> command.");
5076 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5077 [InitNone, Always, TestRun (
5078 [["part_disk"; "/dev/sda"; "mbr"];
5079 ["pvcreate"; "/dev/sda1"];
5080 ["vgcreate"; "VG"; "/dev/sda1"];
5081 ["lvcreate"; "LV"; "VG"; "10"];
5082 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5083 "expand an LV to fill free space",
5085 This expands an existing logical volume C<lv> so that it fills
5086 C<pc>% of the remaining free space in the volume group. Commonly
5087 you would call this with pc = 100 which expands the logical volume
5088 as much as possible, using all remaining free space in the volume
5091 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5092 [], (* XXX Augeas code needs tests. *)
5093 "clear Augeas path",
5095 Set the value associated with C<path> to C<NULL>. This
5096 is the same as the L<augtool(1)> C<clear> command.");
5098 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5099 [InitEmpty, Always, TestOutputInt (
5100 [["get_umask"]], 0o22)],
5101 "get the current umask",
5103 Return the current umask. By default the umask is C<022>
5104 unless it has been set by calling C<guestfs_umask>.");
5106 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5108 "upload a file to the appliance (internal use only)",
5110 The C<guestfs_debug_upload> command uploads a file to
5111 the libguestfs appliance.
5113 There is no comprehensive help for this command. You have
5114 to look at the file C<daemon/debug.c> in the libguestfs source
5115 to find out what it is for.");
5117 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5118 [InitScratchFS, Always, TestOutput (
5119 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5120 ["cat"; "/base64_in"]], "hello\n")],
5121 "upload base64-encoded data to file",
5123 This command uploads base64-encoded data from C<base64file>
5126 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5128 "download file and encode as base64",
5130 This command downloads the contents of C<filename>, writing
5131 it out to local file C<base64file> encoded as base64.");
5133 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5135 "compute MD5, SHAx or CRC checksum of files in a directory",
5137 This command computes the checksums of all regular files in
5138 C<directory> and then emits a list of those checksums to
5139 the local output file C<sumsfile>.
5141 This can be used for verifying the integrity of a virtual
5142 machine. However to be properly secure you should pay
5143 attention to the output of the checksum command (it uses
5144 the ones from GNU coreutils). In particular when the
5145 filename is not printable, coreutils uses a special
5146 backslash syntax. For more information, see the GNU
5147 coreutils info file.");
5149 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5150 [InitScratchFS, Always, TestOutputBuffer (
5151 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5152 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5153 "fill a file with a repeating pattern of bytes",
5155 This function is like C<guestfs_fill> except that it creates
5156 a new file of length C<len> containing the repeating pattern
5157 of bytes in C<pattern>. The pattern is truncated if necessary
5158 to ensure the length of the file is exactly C<len> bytes.");
5160 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5161 [InitScratchFS, Always, TestOutput (
5162 [["write"; "/write"; "new file contents"];
5163 ["cat"; "/write"]], "new file contents");
5164 InitScratchFS, Always, TestOutput (
5165 [["write"; "/write2"; "\nnew file contents\n"];
5166 ["cat"; "/write2"]], "\nnew file contents\n");
5167 InitScratchFS, Always, TestOutput (
5168 [["write"; "/write3"; "\n\n"];
5169 ["cat"; "/write3"]], "\n\n");
5170 InitScratchFS, Always, TestOutput (
5171 [["write"; "/write4"; ""];
5172 ["cat"; "/write4"]], "");
5173 InitScratchFS, Always, TestOutput (
5174 [["write"; "/write5"; "\n\n\n"];
5175 ["cat"; "/write5"]], "\n\n\n");
5176 InitScratchFS, Always, TestOutput (
5177 [["write"; "/write6"; "\n"];
5178 ["cat"; "/write6"]], "\n")],
5179 "create a new file",
5181 This call creates a file called C<path>. The content of the
5182 file is the string C<content> (which can contain any 8 bit data).");
5184 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5185 [InitScratchFS, Always, TestOutput (
5186 [["write"; "/pwrite"; "new file contents"];
5187 ["pwrite"; "/pwrite"; "data"; "4"];
5188 ["cat"; "/pwrite"]], "new data contents");
5189 InitScratchFS, Always, TestOutput (
5190 [["write"; "/pwrite2"; "new file contents"];
5191 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5192 ["cat"; "/pwrite2"]], "new file is extended");
5193 InitScratchFS, Always, TestOutput (
5194 [["write"; "/pwrite3"; "new file contents"];
5195 ["pwrite"; "/pwrite3"; ""; "4"];
5196 ["cat"; "/pwrite3"]], "new file contents")],
5197 "write to part of a file",
5199 This command writes to part of a file. It writes the data
5200 buffer C<content> to the file C<path> starting at offset C<offset>.
5202 This command implements the L<pwrite(2)> system call, and like
5203 that system call it may not write the full data requested. The
5204 return value is the number of bytes that were actually written
5205 to the file. This could even be 0, although short writes are
5206 unlikely for regular files in ordinary circumstances.
5208 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5210 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5212 "resize an ext2, ext3 or ext4 filesystem (with size)",
5214 This command is the same as C<guestfs_resize2fs> except that it
5215 allows you to specify the new size (in bytes) explicitly.");
5217 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5219 "resize an LVM physical volume (with size)",
5221 This command is the same as C<guestfs_pvresize> except that it
5222 allows you to specify the new size (in bytes) explicitly.");
5224 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5226 "resize an NTFS filesystem (with size)",
5228 This command is the same as C<guestfs_ntfsresize> except that it
5229 allows you to specify the new size (in bytes) explicitly.");
5231 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5232 [InitNone, Always, TestRun [["available_all_groups"]]],
5233 "return a list of all optional groups",
5235 This command returns a list of all optional groups that this
5236 daemon knows about. Note this returns both supported and unsupported
5237 groups. To find out which ones the daemon can actually support
5238 you have to call C<guestfs_available> on each member of the
5241 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5243 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5244 [InitScratchFS, Always, TestOutputStruct (
5245 [["fallocate64"; "/fallocate64"; "1000000"];
5246 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5247 "preallocate a file in the guest filesystem",
5249 This command preallocates a file (containing zero bytes) named
5250 C<path> of size C<len> bytes. If the file exists already, it
5253 Note that this call allocates disk blocks for the file.
5254 To create a sparse file use C<guestfs_truncate_size> instead.
5256 The deprecated call C<guestfs_fallocate> does the same,
5257 but owing to an oversight it only allowed 30 bit lengths
5258 to be specified, effectively limiting the maximum size
5259 of files created through that call to 1GB.
5261 Do not confuse this with the guestfish-specific
5262 C<alloc> and C<sparse> commands which create
5263 a file in the host and attach it as a device.");
5265 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5266 [InitBasicFS, Always, TestOutput (
5267 [["set_e2label"; "/dev/sda1"; "LTEST"];
5268 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5269 "get the filesystem label",
5271 This returns the filesystem label of the filesystem on
5274 If the filesystem is unlabeled, this returns the empty string.
5276 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5278 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5279 (let uuid = uuidgen () in
5280 [InitBasicFS, Always, TestOutput (
5281 [["set_e2uuid"; "/dev/sda1"; uuid];
5282 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5283 "get the filesystem UUID",
5285 This returns the filesystem UUID of the filesystem on
5288 If the filesystem does not have a UUID, this returns the empty string.
5290 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5292 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5293 (* Can't be tested with the current framework because
5294 * the VG is being used by the mounted filesystem, so
5295 * the vgchange -an command we do first will fail.
5298 "set LVM device filter",
5300 This sets the LVM device filter so that LVM will only be
5301 able to \"see\" the block devices in the list C<devices>,
5302 and will ignore all other attached block devices.
5304 Where disk image(s) contain duplicate PVs or VGs, this
5305 command is useful to get LVM to ignore the duplicates, otherwise
5306 LVM can get confused. Note also there are two types
5307 of duplication possible: either cloned PVs/VGs which have
5308 identical UUIDs; or VGs that are not cloned but just happen
5309 to have the same name. In normal operation you cannot
5310 create this situation, but you can do it outside LVM, eg.
5311 by cloning disk images or by bit twiddling inside the LVM
5314 This command also clears the LVM cache and performs a volume
5317 You can filter whole block devices or individual partitions.
5319 You cannot use this if any VG is currently in use (eg.
5320 contains a mounted filesystem), even if you are not
5321 filtering out that VG.");
5323 ("lvm_clear_filter", (RErr, [], []), 256, [],
5324 [], (* see note on lvm_set_filter *)
5325 "clear LVM device filter",
5327 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5328 will be able to see every block device.
5330 This command also clears the LVM cache and performs a volume
5333 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5335 "open a LUKS-encrypted block device",
5337 This command opens a block device which has been encrypted
5338 according to the Linux Unified Key Setup (LUKS) standard.
5340 C<device> is the encrypted block device or partition.
5342 The caller must supply one of the keys associated with the
5343 LUKS block device, in the C<key> parameter.
5345 This creates a new block device called C</dev/mapper/mapname>.
5346 Reads and writes to this block device are decrypted from and
5347 encrypted to the underlying C<device> respectively.
5349 If this block device contains LVM volume groups, then
5350 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5351 will make them visible.");
5353 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5355 "open a LUKS-encrypted block device read-only",
5357 This is the same as C<guestfs_luks_open> except that a read-only
5358 mapping is created.");
5360 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5362 "close a LUKS device",
5364 This closes a LUKS device that was created earlier by
5365 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5366 C<device> parameter must be the name of the LUKS mapping
5367 device (ie. C</dev/mapper/mapname>) and I<not> the name
5368 of the underlying block device.");
5370 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5372 "format a block device as a LUKS encrypted device",
5374 This command erases existing data on C<device> and formats
5375 the device as a LUKS encrypted device. C<key> is the
5376 initial key, which is added to key slot C<slot>. (LUKS
5377 supports 8 key slots, numbered 0-7).");
5379 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5381 "format a block device as a LUKS encrypted device",
5383 This command is the same as C<guestfs_luks_format> but
5384 it also allows you to set the C<cipher> used.");
5386 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5388 "add a key on a LUKS encrypted device",
5390 This command adds a new key on LUKS device C<device>.
5391 C<key> is any existing key, and is used to access the device.
5392 C<newkey> is the new key to add. C<keyslot> is the key slot
5393 that will be replaced.
5395 Note that if C<keyslot> already contains a key, then this
5396 command will fail. You have to use C<guestfs_luks_kill_slot>
5397 first to remove that key.");
5399 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5401 "remove a key from a LUKS encrypted device",
5403 This command deletes the key in key slot C<keyslot> from the
5404 encrypted LUKS device C<device>. C<key> must be one of the
5407 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5408 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5409 [["is_lv"; "/dev/VG/LV"]]);
5410 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5411 [["is_lv"; "/dev/sda1"]])],
5412 "test if device is a logical volume",
5414 This command tests whether C<device> is a logical volume, and
5415 returns true iff this is the case.");
5417 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5419 "find a filesystem by UUID",
5421 This command searches the filesystems and returns the one
5422 which has the given UUID. An error is returned if no such
5423 filesystem can be found.
5425 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5427 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5429 "find a filesystem by label",
5431 This command searches the filesystems and returns the one
5432 which has the given label. An error is returned if no such
5433 filesystem can be found.
5435 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5437 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5438 [InitISOFS, Always, TestOutputFalse (
5439 [["is_chardev"; "/directory"]]);
5440 InitScratchFS, Always, TestOutputTrue (
5441 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5442 ["is_chardev"; "/is_chardev"]])],
5443 "test if character device",
5445 This returns C<true> if and only if there is a character device
5446 with the given C<path> name.
5448 See also C<guestfs_stat>.");
5450 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5451 [InitISOFS, Always, TestOutputFalse (
5452 [["is_blockdev"; "/directory"]]);
5453 InitScratchFS, Always, TestOutputTrue (
5454 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5455 ["is_blockdev"; "/is_blockdev"]])],
5456 "test if block device",
5458 This returns C<true> if and only if there is a block device
5459 with the given C<path> name.
5461 See also C<guestfs_stat>.");
5463 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5464 [InitISOFS, Always, TestOutputFalse (
5465 [["is_fifo"; "/directory"]]);
5466 InitScratchFS, Always, TestOutputTrue (
5467 [["mkfifo"; "0o777"; "/is_fifo"];
5468 ["is_fifo"; "/is_fifo"]])],
5469 "test if FIFO (named pipe)",
5471 This returns C<true> if and only if there is a FIFO (named pipe)
5472 with the given C<path> name.
5474 See also C<guestfs_stat>.");
5476 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5477 [InitISOFS, Always, TestOutputFalse (
5478 [["is_symlink"; "/directory"]]);
5479 InitISOFS, Always, TestOutputTrue (
5480 [["is_symlink"; "/abssymlink"]])],
5481 "test if symbolic link",
5483 This returns C<true> if and only if there is a symbolic link
5484 with the given C<path> name.
5486 See also C<guestfs_stat>.");
5488 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5489 (* XXX Need a positive test for sockets. *)
5490 [InitISOFS, Always, TestOutputFalse (
5491 [["is_socket"; "/directory"]])],
5494 This returns C<true> if and only if there is a Unix domain socket
5495 with the given C<path> name.
5497 See also C<guestfs_stat>.");
5499 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5500 [InitPartition, Always, TestOutputDevice (
5501 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5502 InitEmpty, Always, TestLastFail (
5503 [["part_to_dev"; "/dev/sda"]])],
5504 "convert partition name to device name",
5506 This function takes a partition name (eg. \"/dev/sdb1\") and
5507 removes the partition number, returning the device name
5510 The named partition must exist, for example as a string returned
5511 from C<guestfs_list_partitions>.");
5513 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5514 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5515 [InitScratchFS, Always, TestOutput (
5516 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5517 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5518 "upload a file from the local machine with offset",
5520 Upload local file C<filename> to C<remotefilename> on the
5523 C<remotefilename> is overwritten starting at the byte C<offset>
5524 specified. The intention is to overwrite parts of existing
5525 files or devices, although if a non-existant file is specified
5526 then it is created with a \"hole\" before C<offset>. The
5527 size of the data written is implicit in the size of the
5530 Note that there is no limit on the amount of data that
5531 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5532 and this call always writes the full amount unless an
5535 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5537 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5538 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5539 let offset = string_of_int 100 in
5540 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5541 [InitScratchFS, Always, TestOutput (
5542 (* Pick a file from cwd which isn't likely to change. *)
5543 [["mkdir"; "/download_offset"];
5544 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5545 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5546 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5547 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5548 "download a file to the local machine with offset and size",
5550 Download file C<remotefilename> and save it as C<filename>
5551 on the local machine.
5553 C<remotefilename> is read for C<size> bytes starting at C<offset>
5554 (this region must be within the file or device).
5556 Note that there is no limit on the amount of data that
5557 can be downloaded with this call, unlike with C<guestfs_pread>,
5558 and this call always reads the full amount unless an
5561 See also C<guestfs_download>, C<guestfs_pread>.");
5563 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5564 [InitPartition, Always, TestOutputListOfDevices (
5565 [["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"];
5566 ["blockdev_rereadpt"; "/dev/sda"];
5567 ["list_partitions"]], ["/dev/sdb1"])],
5568 "write to part of a device",
5570 This command writes to part of a device. It writes the data
5571 buffer C<content> to C<device> starting at offset C<offset>.
5573 This command implements the L<pwrite(2)> system call, and like
5574 that system call it may not write the full data requested
5575 (although short writes to disk devices and partitions are
5576 probably impossible with standard Linux kernels).
5578 See also C<guestfs_pwrite>.");
5580 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5581 [InitEmpty, Always, TestOutputBuffer (
5582 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5583 "read part of a device",
5585 This command lets you read part of a file. It reads C<count>
5586 bytes of C<device>, starting at C<offset>.
5588 This may read fewer bytes than requested. For further details
5589 see the L<pread(2)> system call.
5591 See also C<guestfs_pread>.");
5593 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5594 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5595 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5596 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5597 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5598 "get canonical name of an LV",
5600 This converts alternative naming schemes for LVs that you
5601 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5602 is converted to C</dev/VG/LV>.
5604 This command returns an error if the C<lvname> parameter does
5605 not refer to a logical volume.
5607 See also C<guestfs_is_lv>.");
5609 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"]), 278, [],
5610 [InitEmpty, Always, TestOutput (
5611 [["part_disk"; "/dev/sda"; "mbr"];
5612 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"];
5613 ["mount_options"; ""; "/dev/sda1"; "/"];
5614 ["write"; "/new"; "new file contents"];
5615 ["cat"; "/new"]], "new file contents")],
5616 "make a filesystem",
5618 This function creates a filesystem on C<device>. The filesystem
5619 type is C<fstype>, for example C<ext3>.
5621 The optional arguments are:
5627 The filesystem block size. Supported block sizes depend on the
5628 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5629 for Linux ext2/3 filesystems.
5631 For VFAT and NTFS the C<blocksize> parameter is treated as
5632 the requested cluster size.
5636 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5638 "get a single extended attribute",
5640 Get a single extended attribute from file C<path> named C<name>.
5641 This call follows symlinks. If you want to lookup an extended
5642 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5644 Normally it is better to get all extended attributes from a file
5645 in one go by calling C<guestfs_getxattrs>. However some Linux
5646 filesystem implementations are buggy and do not provide a way to
5647 list out attributes. For these filesystems (notably ntfs-3g)
5648 you have to know the names of the extended attributes you want
5649 in advance and call this function.
5651 Extended attribute values are blobs of binary data. If there
5652 is no extended attribute named C<name>, this returns an error.
5654 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5656 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5658 "get a single extended attribute",
5660 Get a single extended attribute from file C<path> named C<name>.
5661 If C<path> is a symlink, then this call returns an extended
5662 attribute from the symlink.
5664 Normally it is better to get all extended attributes from a file
5665 in one go by calling C<guestfs_getxattrs>. However some Linux
5666 filesystem implementations are buggy and do not provide a way to
5667 list out attributes. For these filesystems (notably ntfs-3g)
5668 you have to know the names of the extended attributes you want
5669 in advance and call this function.
5671 Extended attribute values are blobs of binary data. If there
5672 is no extended attribute named C<name>, this returns an error.
5674 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5678 let all_functions = non_daemon_functions @ daemon_functions
5680 (* In some places we want the functions to be displayed sorted
5681 * alphabetically, so this is useful:
5683 let all_functions_sorted = List.sort action_compare all_functions
5685 (* This is used to generate the src/MAX_PROC_NR file which
5686 * contains the maximum procedure number, a surrogate for the
5687 * ABI version number. See src/Makefile.am for the details.
5690 let proc_nrs = List.map (
5691 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5692 ) daemon_functions in
5693 List.fold_left max 0 proc_nrs
5695 (* Non-API meta-commands available only in guestfish.
5697 * Note (1): style, proc_nr and tests fields are all meaningless.
5698 * The only fields which are actually used are the shortname,
5699 * FishAlias flags, shortdesc and longdesc.
5701 * Note (2): to refer to other commands, use L</shortname>.
5703 * Note (3): keep this list sorted by shortname.
5705 let fish_commands = [
5706 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5707 "allocate and add a disk file",
5708 " alloc filename size
5710 This creates an empty (zeroed) file of the given size, and then adds
5711 so it can be further examined.
5713 For more advanced image creation, see L<qemu-img(1)> utility.
5715 Size can be specified using standard suffixes, eg. C<1M>.
5717 To create a sparse file, use L</sparse> instead. To create a
5718 prepared disk image, see L</PREPARED DISK IMAGES>.");
5720 ("copy_in", (RErr,[], []), -1, [], [],
5721 "copy local files or directories into an image",
5722 " copy-in local [local ...] /remotedir
5724 C<copy-in> copies local files or directories recursively into the disk
5725 image, placing them in the directory called C</remotedir> (which must
5726 exist). This guestfish meta-command turns into a sequence of
5727 L</tar-in> and other commands as necessary.
5729 Multiple local files and directories can be specified, but the last
5730 parameter must always be a remote directory. Wildcards cannot be
5733 ("copy_out", (RErr,[], []), -1, [], [],
5734 "copy remote files or directories out of an image",
5735 " copy-out remote [remote ...] localdir
5737 C<copy-out> copies remote files or directories recursively out of the
5738 disk image, placing them on the host disk in a local directory called
5739 C<localdir> (which must exist). This guestfish meta-command turns
5740 into a sequence of L</download>, L</tar-out> and other commands as
5743 Multiple remote files and directories can be specified, but the last
5744 parameter must always be a local directory. To download to the
5745 current directory, use C<.> as in:
5749 Wildcards cannot be used in the ordinary command, but you can use
5750 them with the help of L</glob> like this:
5752 glob copy-out /home/* .");
5754 ("echo", (RErr,[], []), -1, [], [],
5755 "display a line of text",
5758 This echos the parameters to the terminal.");
5760 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5764 This is used to edit a file. It downloads the file, edits it
5765 locally using your editor, then uploads the result.
5767 The editor is C<$EDITOR>. However if you use the alternate
5768 commands C<vi> or C<emacs> you will get those corresponding
5771 ("glob", (RErr,[], []), -1, [], [],
5772 "expand wildcards in command",
5773 " glob command args...
5775 Expand wildcards in any paths in the args list, and run C<command>
5776 repeatedly on each matching path.
5778 See L</WILDCARDS AND GLOBBING>.");
5780 ("hexedit", (RErr,[], []), -1, [], [],
5781 "edit with a hex editor",
5782 " hexedit <filename|device>
5783 hexedit <filename|device> <max>
5784 hexedit <filename|device> <start> <max>
5786 Use hexedit (a hex editor) to edit all or part of a binary file
5789 This command works by downloading potentially the whole file or
5790 device, editing it locally, then uploading it. If the file or
5791 device is large, you have to specify which part you wish to edit
5792 by using C<max> and/or C<start> C<max> parameters.
5793 C<start> and C<max> are specified in bytes, with the usual
5794 modifiers allowed such as C<1M> (1 megabyte).
5796 For example to edit the first few sectors of a disk you
5801 which would allow you to edit anywhere within the first megabyte
5804 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5806 hexedit /dev/sda1 0x400 0x400
5808 (assuming the superblock is in the standard location).
5810 This command requires the external L<hexedit(1)> program. You
5811 can specify another program to use by setting the C<HEXEDITOR>
5812 environment variable.
5814 See also L</hexdump>.");
5816 ("lcd", (RErr,[], []), -1, [], [],
5817 "change working directory",
5820 Change the local directory, ie. the current directory of guestfish
5823 Note that C<!cd> won't do what you might expect.");
5825 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5829 Opens the manual page for guestfish.");
5831 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5837 This is used to view a file.
5839 The default viewer is C<$PAGER>. However if you use the alternate
5840 command C<less> you will get the C<less> command specifically.");
5842 ("reopen", (RErr,[], []), -1, [], [],
5843 "close and reopen libguestfs handle",
5846 Close and reopen the libguestfs handle. It is not necessary to use
5847 this normally, because the handle is closed properly when guestfish
5848 exits. However this is occasionally useful for testing.");
5850 ("sparse", (RErr,[], []), -1, [], [],
5851 "create a sparse disk image and add",
5852 " sparse filename size
5854 This creates an empty sparse file of the given size, and then adds
5855 so it can be further examined.
5857 In all respects it works the same as the L</alloc> command, except that
5858 the image file is allocated sparsely, which means that disk blocks are
5859 not assigned to the file until they are needed. Sparse disk files
5860 only use space when written to, but they are slower and there is a
5861 danger you could run out of real disk space during a write operation.
5863 For more advanced image creation, see L<qemu-img(1)> utility.
5865 Size can be specified using standard suffixes, eg. C<1M>.");
5867 ("supported", (RErr,[], []), -1, [], [],
5868 "list supported groups of commands",
5871 This command returns a list of the optional groups
5872 known to the daemon, and indicates which ones are
5873 supported by this build of the libguestfs appliance.
5875 See also L<guestfs(3)/AVAILABILITY>.");
5877 ("time", (RErr,[], []), -1, [], [],
5878 "print elapsed time taken to run a command",
5879 " time command args...
5881 Run the command as usual, but print the elapsed time afterwards. This
5882 can be useful for benchmarking operations.");