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 make filesystems consistent and synchronized
286 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>.
910 I<In particular note> that this may return filesystems
911 which are non-existent or not mountable and callers should
912 be prepared to handle or ignore failures if they try to
915 Each element in the returned hashtable has a key which
916 is the path of the mountpoint (eg. C</boot>) and a value
917 which is the filesystem that would be mounted there
920 Non-mounted devices such as swap devices are I<not>
921 returned in this list.
923 Please read L<guestfs(3)/INSPECTION> for more details.
924 See also C<guestfs_inspect_get_filesystems>.");
926 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
928 "get filesystems associated with inspected operating system",
930 This function should only be called with a root device string
931 as returned by C<guestfs_inspect_os>.
933 This returns a list of all the filesystems that we think
934 are associated with this operating system. This includes
935 the root filesystem, other ordinary filesystems, and
936 non-mounted devices like swap partitions.
938 In the case of a multi-boot virtual machine, it is possible
939 for a filesystem to be shared between operating systems.
941 Please read L<guestfs(3)/INSPECTION> for more details.
942 See also C<guestfs_inspect_get_mountpoints>.");
944 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
946 "set enable network flag",
948 If C<network> is true, then the network is enabled in the
949 libguestfs appliance. The default is false.
951 This affects whether commands are able to access the network
952 (see L<guestfs(3)/RUNNING COMMANDS>).
954 You must call this before calling C<guestfs_launch>, otherwise
957 ("get_network", (RBool "network", [], []), -1, [],
959 "get enable network flag",
961 This returns the enable network flag.");
963 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
967 This inspection command looks for filesystems on partitions,
968 block devices and logical volumes, returning a list of devices
969 containing filesystems and their type.
971 The return value is a hash, where the keys are the devices
972 containing filesystems, and the values are the filesystem types.
975 \"/dev/sda1\" => \"ntfs\"
976 \"/dev/sda2\" => \"ext2\"
977 \"/dev/vg_guest/lv_root\" => \"ext4\"
978 \"/dev/vg_guest/lv_swap\" => \"swap\"
980 The value can have the special value \"unknown\", meaning the
981 content of the device is undetermined or empty.
982 \"swap\" means a Linux swap partition.
984 This command runs other libguestfs commands, which might include
985 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
986 use this soon after launch and only when nothing is mounted.
988 Not all of the filesystems returned will be mountable. In
989 particular, swap partitions are returned in the list. Also
990 this command does not check that each filesystem
991 found is valid and mountable, and some filesystems might
992 be mountable but require special options. Filesystems may
993 not all belong to a single logical operating system
994 (use C<guestfs_inspect_os> to look for OSes).");
996 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
998 "add an image to examine or modify",
1000 This function adds a virtual machine disk image C<filename> to
1001 libguestfs. The first time you call this function, the disk
1002 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1005 You don't necessarily need to be root when using libguestfs. However
1006 you obviously do need sufficient permissions to access the filename
1007 for whatever operations you want to perform (ie. read access if you
1008 just want to read the image or write access if you want to modify the
1011 This call checks that C<filename> exists.
1013 The optional arguments are:
1019 If true then the image is treated as read-only. Writes are still
1020 allowed, but they are stored in a temporary snapshot overlay which
1021 is discarded at the end. The disk that you add is not modified.
1025 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1026 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1027 Possible formats include C<raw> and C<qcow2>.
1029 Automatic detection of the format opens you up to a potential
1030 security hole when dealing with untrusted raw-format images.
1031 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1036 This rarely-used option lets you emulate the behaviour of the
1037 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1041 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1043 "get Windows systemroot of inspected operating system",
1045 This function should only be called with a root device string
1046 as returned by C<guestfs_inspect_os>.
1048 This returns the Windows systemroot of the inspected guest.
1049 The systemroot is a directory path such as C</WINDOWS>.
1051 This call assumes that the guest is Windows and that the
1052 systemroot could be determined by inspection. If this is not
1053 the case then an error is returned.
1055 Please read L<guestfs(3)/INSPECTION> for more details.");
1057 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1059 "return list of operating systems found by last inspection",
1061 This function is a convenient way to get the list of root
1062 devices, as returned from a previous call to C<guestfs_inspect_os>,
1063 but without redoing the whole inspection process.
1065 This returns an empty list if either no root devices were
1066 found or the caller has not called C<guestfs_inspect_os>.
1068 Please read L<guestfs(3)/INSPECTION> for more details.");
1070 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1072 "debug the QEMU command line (internal use only)",
1074 This returns the internal QEMU command line. 'debug' commands are
1075 not part of the formal API and can be removed or changed at any time.");
1077 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"]), -1, [FishAlias "domain"],
1079 "add the disk(s) from a named libvirt domain",
1081 This function adds the disk(s) attached to the named libvirt
1082 domain C<dom>. It works by connecting to libvirt, requesting
1083 the domain and domain XML from libvirt, parsing it for disks,
1084 and calling C<guestfs_add_drive_opts> on each one.
1086 The number of disks added is returned. This operation is atomic:
1087 if an error is returned, then no disks are added.
1089 This function does some minimal checks to make sure the libvirt
1090 domain is not running (unless C<readonly> is true). In a future
1091 version we will try to acquire the libvirt lock on each disk.
1093 Disks must be accessible locally. This often means that adding disks
1094 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1095 will fail unless those disks are accessible via the same device path
1098 The optional C<libvirturi> parameter sets the libvirt URI
1099 (see L<http://libvirt.org/uri.html>). If this is not set then
1100 we connect to the default libvirt URI (or one set through an
1101 environment variable, see the libvirt documentation for full
1104 The optional C<live> flag controls whether this call will try
1105 to connect to a running virtual machine C<guestfsd> process if
1106 it sees a suitable E<lt>channelE<gt> element in the libvirt
1107 XML definition. The default (if the flag is omitted) is never
1108 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1111 The other optional parameters are passed directly through to
1112 C<guestfs_add_drive_opts>.");
1115 This interface is not quite baked yet. -- RWMJ 2010-11-11
1116 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1118 "add the disk(s) from a libvirt domain",
1120 This function adds the disk(s) attached to the libvirt domain C<dom>.
1121 It works by requesting the domain XML from libvirt, parsing it for
1122 disks, and calling C<guestfs_add_drive_opts> on each one.
1124 In the C API we declare C<void *dom>, but really it has type
1125 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1127 The number of disks added is returned. This operation is atomic:
1128 if an error is returned, then no disks are added.
1130 This function does some minimal checks to make sure the libvirt
1131 domain is not running (unless C<readonly> is true). In a future
1132 version we will try to acquire the libvirt lock on each disk.
1134 Disks must be accessible locally. This often means that adding disks
1135 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1136 will fail unless those disks are accessible via the same device path
1139 The optional C<live> flag controls whether this call will try
1140 to connect to a running virtual machine C<guestfsd> process if
1141 it sees a suitable E<lt>channelE<gt> element in the libvirt
1142 XML definition. The default (if the flag is omitted) is never
1143 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1146 The other optional parameters are passed directly through to
1147 C<guestfs_add_drive_opts>.");
1150 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1152 "get package format used by the operating system",
1154 This function should only be called with a root device string
1155 as returned by C<guestfs_inspect_os>.
1157 This function and C<guestfs_inspect_get_package_management> return
1158 the package format and package management tool used by the
1159 inspected operating system. For example for Fedora these
1160 functions would return C<rpm> (package format) and
1161 C<yum> (package management).
1163 This returns the string C<unknown> if we could not determine the
1164 package format I<or> if the operating system does not have
1165 a real packaging system (eg. Windows).
1167 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1168 Future versions of libguestfs may return other strings.
1170 Please read L<guestfs(3)/INSPECTION> for more details.");
1172 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1174 "get package management tool used by the operating system",
1176 This function should only be called with a root device string
1177 as returned by C<guestfs_inspect_os>.
1179 C<guestfs_inspect_get_package_format> and this function return
1180 the package format and package management tool used by the
1181 inspected operating system. For example for Fedora these
1182 functions would return C<rpm> (package format) and
1183 C<yum> (package management).
1185 This returns the string C<unknown> if we could not determine the
1186 package management tool I<or> if the operating system does not have
1187 a real packaging system (eg. Windows).
1189 Possible strings include: C<yum>, C<up2date>,
1190 C<apt> (for all Debian derivatives),
1191 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1192 Future versions of libguestfs may return other strings.
1194 Please read L<guestfs(3)/INSPECTION> for more details.");
1196 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1198 "get list of applications installed in the operating system",
1200 This function should only be called with a root device string
1201 as returned by C<guestfs_inspect_os>.
1203 Return the list of applications installed in the operating system.
1205 I<Note:> This call works differently from other parts of the
1206 inspection API. You have to call C<guestfs_inspect_os>, then
1207 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1208 before calling this. Listing applications is a significantly
1209 more difficult operation which requires access to the full
1210 filesystem. Also note that unlike the other
1211 C<guestfs_inspect_get_*> calls which are just returning
1212 data cached in the libguestfs handle, this call actually reads
1213 parts of the mounted filesystems during the call.
1215 This returns an empty list if the inspection code was not able
1216 to determine the list of applications.
1218 The application structure contains the following fields:
1224 The name of the application. For Red Hat-derived and Debian-derived
1225 Linux guests, this is the package name.
1227 =item C<app_display_name>
1229 The display name of the application, sometimes localized to the
1230 install language of the guest operating system.
1232 If unavailable this is returned as an empty string C<\"\">.
1233 Callers needing to display something can use C<app_name> instead.
1237 For package managers which use epochs, this contains the epoch of
1238 the package (an integer). If unavailable, this is returned as C<0>.
1240 =item C<app_version>
1242 The version string of the application or package. If unavailable
1243 this is returned as an empty string C<\"\">.
1245 =item C<app_release>
1247 The release string of the application or package, for package
1248 managers that use this. If unavailable this is returned as an
1249 empty string C<\"\">.
1251 =item C<app_install_path>
1253 The installation path of the application (on operating systems
1254 such as Windows which use installation paths). This path is
1255 in the format used by the guest operating system, it is not
1258 If unavailable this is returned as an empty string C<\"\">.
1260 =item C<app_trans_path>
1262 The install path translated into a libguestfs path.
1263 If unavailable this is returned as an empty string C<\"\">.
1265 =item C<app_publisher>
1267 The name of the publisher of the application, for package
1268 managers that use this. If unavailable this is returned
1269 as an empty string C<\"\">.
1273 The URL (eg. upstream URL) of the application.
1274 If unavailable this is returned as an empty string C<\"\">.
1276 =item C<app_source_package>
1278 For packaging systems which support this, the name of the source
1279 package. If unavailable this is returned as an empty string C<\"\">.
1281 =item C<app_summary>
1283 A short (usually one line) description of the application or package.
1284 If unavailable this is returned as an empty string C<\"\">.
1286 =item C<app_description>
1288 A longer description of the application or package.
1289 If unavailable this is returned as an empty string C<\"\">.
1293 Please read L<guestfs(3)/INSPECTION> for more details.");
1295 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1297 "get hostname of the operating system",
1299 This function should only be called with a root device string
1300 as returned by C<guestfs_inspect_os>.
1302 This function returns the hostname of the operating system
1303 as found by inspection of the guest's configuration files.
1305 If the hostname could not be determined, then the
1306 string C<unknown> is returned.
1308 Please read L<guestfs(3)/INSPECTION> for more details.");
1310 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1312 "get format of inspected operating system",
1314 This function should only be called with a root device string
1315 as returned by C<guestfs_inspect_os>.
1317 This returns the format of the inspected operating system. You
1318 can use it to detect install images, live CDs and similar.
1320 Currently defined formats are:
1326 This is an installed operating system.
1330 The disk image being inspected is not an installed operating system,
1331 but a I<bootable> install disk, live CD, or similar.
1335 The format of this disk image is not known.
1339 Future versions of libguestfs may return other strings here.
1340 The caller should be prepared to handle any string.
1342 Please read L<guestfs(3)/INSPECTION> for more details.");
1344 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1346 "get live flag for install disk",
1348 This function should only be called with a root device string
1349 as returned by C<guestfs_inspect_os>.
1351 If C<guestfs_inspect_get_format> returns C<installer> (this
1352 is an install disk), then this returns true if a live image
1353 was detected on the disk.
1355 Please read L<guestfs(3)/INSPECTION> for more details.");
1357 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1359 "get netinst (network installer) flag for install disk",
1361 This function should only be called with a root device string
1362 as returned by C<guestfs_inspect_os>.
1364 If C<guestfs_inspect_get_format> returns C<installer> (this
1365 is an install disk), then this returns true if the disk is
1366 a network installer, ie. not a self-contained install CD but
1367 one which is likely to require network access to complete
1370 Please read L<guestfs(3)/INSPECTION> for more details.");
1372 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1374 "get multipart flag for install disk",
1376 This function should only be called with a root device string
1377 as returned by C<guestfs_inspect_os>.
1379 If C<guestfs_inspect_get_format> returns C<installer> (this
1380 is an install disk), then this returns true if the disk is
1383 Please read L<guestfs(3)/INSPECTION> for more details.");
1385 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1387 "set the attach method",
1389 Set the method that libguestfs uses to connect to the back end
1390 guestfsd daemon. Possible methods are:
1396 Launch an appliance and connect to it. This is the ordinary method
1399 =item C<unix:I<path>>
1401 Connect to the Unix domain socket I<path>.
1403 This method lets you connect to an existing daemon or (using
1404 virtio-serial) to a live guest. For more information, see
1405 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1409 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1410 [InitNone, Always, TestOutput (
1411 [["get_attach_method"]], "appliance")],
1412 "get the attach method",
1414 Return the current attach method. See C<guestfs_set_attach_method>.");
1418 (* daemon_functions are any functions which cause some action
1419 * to take place in the daemon.
1422 let daemon_functions = [
1423 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1424 [InitEmpty, Always, TestOutput (
1425 [["part_disk"; "/dev/sda"; "mbr"];
1426 ["mkfs"; "ext2"; "/dev/sda1"];
1427 ["mount"; "/dev/sda1"; "/"];
1428 ["write"; "/new"; "new file contents"];
1429 ["cat"; "/new"]], "new file contents")],
1430 "mount a guest disk at a position in the filesystem",
1432 Mount a guest disk at a position in the filesystem. Block devices
1433 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1434 the guest. If those block devices contain partitions, they will have
1435 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1438 The rules are the same as for L<mount(2)>: A filesystem must
1439 first be mounted on C</> before others can be mounted. Other
1440 filesystems can only be mounted on directories which already
1443 The mounted filesystem is writable, if we have sufficient permissions
1444 on the underlying device.
1447 When you use this call, the filesystem options C<sync> and C<noatime>
1448 are set implicitly. This was originally done because we thought it
1449 would improve reliability, but it turns out that I<-o sync> has a
1450 very large negative performance impact and negligible effect on
1451 reliability. Therefore we recommend that you avoid using
1452 C<guestfs_mount> in any code that needs performance, and instead
1453 use C<guestfs_mount_options> (use an empty string for the first
1454 parameter if you don't want any options).");
1456 ("sync", (RErr, [], []), 2, [],
1457 [ InitEmpty, Always, TestRun [["sync"]]],
1458 "sync disks, writes are flushed through to the disk image",
1460 This syncs the disk, so that any writes are flushed through to the
1461 underlying disk image.
1463 You should always call this if you have modified a disk image, before
1464 closing the handle.");
1466 ("touch", (RErr, [Pathname "path"], []), 3, [],
1467 [InitScratchFS, Always, TestOutputTrue (
1468 [["touch"; "/touch"];
1469 ["exists"; "/touch"]])],
1470 "update file timestamps or create a new file",
1472 Touch acts like the L<touch(1)> command. It can be used to
1473 update the timestamps on a file, or, if the file does not exist,
1474 to create a new zero-length file.
1476 This command only works on regular files, and will fail on other
1477 file types such as directories, symbolic links, block special etc.");
1479 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1480 [InitISOFS, Always, TestOutput (
1481 [["cat"; "/known-2"]], "abcdef\n")],
1482 "list the contents of a file",
1484 Return the contents of the file named C<path>.
1486 Note that this function cannot correctly handle binary files
1487 (specifically, files containing C<\\0> character which is treated
1488 as end of string). For those you need to use the C<guestfs_read_file>
1489 or C<guestfs_download> functions which have a more complex interface.");
1491 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1492 [], (* XXX Tricky to test because it depends on the exact format
1493 * of the 'ls -l' command, which changes between F10 and F11.
1495 "list the files in a directory (long format)",
1497 List the files in C<directory> (relative to the root directory,
1498 there is no cwd) in the format of 'ls -la'.
1500 This command is mostly useful for interactive sessions. It
1501 is I<not> intended that you try to parse the output string.");
1503 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1504 [InitScratchFS, Always, TestOutputList (
1506 ["touch"; "/ls/new"];
1507 ["touch"; "/ls/newer"];
1508 ["touch"; "/ls/newest"];
1509 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1510 "list the files in a directory",
1512 List the files in C<directory> (relative to the root directory,
1513 there is no cwd). The '.' and '..' entries are not returned, but
1514 hidden files are shown.
1516 This command is mostly useful for interactive sessions. Programs
1517 should probably use C<guestfs_readdir> instead.");
1519 ("list_devices", (RStringList "devices", [], []), 7, [],
1520 [InitEmpty, Always, TestOutputListOfDevices (
1521 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1522 "list the block devices",
1524 List all the block devices.
1526 The full block device names are returned, eg. C</dev/sda>.
1528 See also C<guestfs_list_filesystems>.");
1530 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1531 [InitBasicFS, Always, TestOutputListOfDevices (
1532 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1533 InitEmpty, Always, TestOutputListOfDevices (
1534 [["part_init"; "/dev/sda"; "mbr"];
1535 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1536 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1537 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1538 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1539 "list the partitions",
1541 List all the partitions detected on all block devices.
1543 The full partition device names are returned, eg. C</dev/sda1>
1545 This does not return logical volumes. For that you will need to
1546 call C<guestfs_lvs>.
1548 See also C<guestfs_list_filesystems>.");
1550 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1551 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1552 [["pvs"]], ["/dev/sda1"]);
1553 InitEmpty, Always, TestOutputListOfDevices (
1554 [["part_init"; "/dev/sda"; "mbr"];
1555 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1556 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1557 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1558 ["pvcreate"; "/dev/sda1"];
1559 ["pvcreate"; "/dev/sda2"];
1560 ["pvcreate"; "/dev/sda3"];
1561 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1562 "list the LVM physical volumes (PVs)",
1564 List all the physical volumes detected. This is the equivalent
1565 of the L<pvs(8)> command.
1567 This returns a list of just the device names that contain
1568 PVs (eg. C</dev/sda2>).
1570 See also C<guestfs_pvs_full>.");
1572 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1573 [InitBasicFSonLVM, Always, TestOutputList (
1575 InitEmpty, Always, TestOutputList (
1576 [["part_init"; "/dev/sda"; "mbr"];
1577 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1578 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1579 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1580 ["pvcreate"; "/dev/sda1"];
1581 ["pvcreate"; "/dev/sda2"];
1582 ["pvcreate"; "/dev/sda3"];
1583 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1584 ["vgcreate"; "VG2"; "/dev/sda3"];
1585 ["vgs"]], ["VG1"; "VG2"])],
1586 "list the LVM volume groups (VGs)",
1588 List all the volumes groups detected. This is the equivalent
1589 of the L<vgs(8)> command.
1591 This returns a list of just the volume group names that were
1592 detected (eg. C<VolGroup00>).
1594 See also C<guestfs_vgs_full>.");
1596 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1597 [InitBasicFSonLVM, Always, TestOutputList (
1598 [["lvs"]], ["/dev/VG/LV"]);
1599 InitEmpty, Always, TestOutputList (
1600 [["part_init"; "/dev/sda"; "mbr"];
1601 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1602 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1603 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1604 ["pvcreate"; "/dev/sda1"];
1605 ["pvcreate"; "/dev/sda2"];
1606 ["pvcreate"; "/dev/sda3"];
1607 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1608 ["vgcreate"; "VG2"; "/dev/sda3"];
1609 ["lvcreate"; "LV1"; "VG1"; "50"];
1610 ["lvcreate"; "LV2"; "VG1"; "50"];
1611 ["lvcreate"; "LV3"; "VG2"; "50"];
1612 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1613 "list the LVM logical volumes (LVs)",
1615 List all the logical volumes detected. This is the equivalent
1616 of the L<lvs(8)> command.
1618 This returns a list of the logical volume device names
1619 (eg. C</dev/VolGroup00/LogVol00>).
1621 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1623 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1624 [], (* XXX how to test? *)
1625 "list the LVM physical volumes (PVs)",
1627 List all the physical volumes detected. This is the equivalent
1628 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1630 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1631 [], (* XXX how to test? *)
1632 "list the LVM volume groups (VGs)",
1634 List all the volumes groups detected. This is the equivalent
1635 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1637 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1638 [], (* XXX how to test? *)
1639 "list the LVM logical volumes (LVs)",
1641 List all the logical volumes detected. This is the equivalent
1642 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1644 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1645 [InitISOFS, Always, TestOutputList (
1646 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1647 InitISOFS, Always, TestOutputList (
1648 [["read_lines"; "/empty"]], [])],
1649 "read file as lines",
1651 Return the contents of the file named C<path>.
1653 The file contents are returned as a list of lines. Trailing
1654 C<LF> and C<CRLF> character sequences are I<not> returned.
1656 Note that this function cannot correctly handle binary files
1657 (specifically, files containing C<\\0> character which is treated
1658 as end of line). For those you need to use the C<guestfs_read_file>
1659 function which has a more complex interface.");
1661 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1662 [], (* XXX Augeas code needs tests. *)
1663 "create a new Augeas handle",
1665 Create a new Augeas handle for editing configuration files.
1666 If there was any previous Augeas handle associated with this
1667 guestfs session, then it is closed.
1669 You must call this before using any other C<guestfs_aug_*>
1672 C<root> is the filesystem root. C<root> must not be NULL,
1675 The flags are the same as the flags defined in
1676 E<lt>augeas.hE<gt>, the logical I<or> of the following
1681 =item C<AUG_SAVE_BACKUP> = 1
1683 Keep the original file with a C<.augsave> extension.
1685 =item C<AUG_SAVE_NEWFILE> = 2
1687 Save changes into a file with extension C<.augnew>, and
1688 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1690 =item C<AUG_TYPE_CHECK> = 4
1692 Typecheck lenses (can be expensive).
1694 =item C<AUG_NO_STDINC> = 8
1696 Do not use standard load path for modules.
1698 =item C<AUG_SAVE_NOOP> = 16
1700 Make save a no-op, just record what would have been changed.
1702 =item C<AUG_NO_LOAD> = 32
1704 Do not load the tree in C<guestfs_aug_init>.
1708 To close the handle, you can call C<guestfs_aug_close>.
1710 To find out more about Augeas, see L<http://augeas.net/>.");
1712 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1713 [], (* XXX Augeas code needs tests. *)
1714 "close the current Augeas handle",
1716 Close the current Augeas handle and free up any resources
1717 used by it. After calling this, you have to call
1718 C<guestfs_aug_init> again before you can use any other
1719 Augeas functions.");
1721 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1722 [], (* XXX Augeas code needs tests. *)
1723 "define an Augeas variable",
1725 Defines an Augeas variable C<name> whose value is the result
1726 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1729 On success this returns the number of nodes in C<expr>, or
1730 C<0> if C<expr> evaluates to something which is not a nodeset.");
1732 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1733 [], (* XXX Augeas code needs tests. *)
1734 "define an Augeas node",
1736 Defines a variable C<name> whose value is the result of
1739 If C<expr> evaluates to an empty nodeset, a node is created,
1740 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1741 C<name> will be the nodeset containing that single node.
1743 On success this returns a pair containing the
1744 number of nodes in the nodeset, and a boolean flag
1745 if a node was created.");
1747 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1748 [], (* XXX Augeas code needs tests. *)
1749 "look up the value of an Augeas path",
1751 Look up the value associated with C<path>. If C<path>
1752 matches exactly one node, the C<value> is returned.");
1754 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1755 [], (* XXX Augeas code needs tests. *)
1756 "set Augeas path to value",
1758 Set the value associated with C<path> to C<val>.
1760 In the Augeas API, it is possible to clear a node by setting
1761 the value to NULL. Due to an oversight in the libguestfs API
1762 you cannot do that with this call. Instead you must use the
1763 C<guestfs_aug_clear> call.");
1765 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1766 [], (* XXX Augeas code needs tests. *)
1767 "insert a sibling Augeas node",
1769 Create a new sibling C<label> for C<path>, inserting it into
1770 the tree before or after C<path> (depending on the boolean
1773 C<path> must match exactly one existing node in the tree, and
1774 C<label> must be a label, ie. not contain C</>, C<*> or end
1775 with a bracketed index C<[N]>.");
1777 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1778 [], (* XXX Augeas code needs tests. *)
1779 "remove an Augeas path",
1781 Remove C<path> and all of its children.
1783 On success this returns the number of entries which were removed.");
1785 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1786 [], (* XXX Augeas code needs tests. *)
1789 Move the node C<src> to C<dest>. C<src> must match exactly
1790 one node. C<dest> is overwritten if it exists.");
1792 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1793 [], (* XXX Augeas code needs tests. *)
1794 "return Augeas nodes which match augpath",
1796 Returns a list of paths which match the path expression C<path>.
1797 The returned paths are sufficiently qualified so that they match
1798 exactly one node in the current tree.");
1800 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1801 [], (* XXX Augeas code needs tests. *)
1802 "write all pending Augeas changes to disk",
1804 This writes all pending changes to disk.
1806 The flags which were passed to C<guestfs_aug_init> affect exactly
1807 how files are saved.");
1809 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1810 [], (* XXX Augeas code needs tests. *)
1811 "load files into the tree",
1813 Load files into the tree.
1815 See C<aug_load> in the Augeas documentation for the full gory
1818 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1819 [], (* XXX Augeas code needs tests. *)
1820 "list Augeas nodes under augpath",
1822 This is just a shortcut for listing C<guestfs_aug_match>
1823 C<path/*> and sorting the resulting nodes into alphabetical order.");
1825 ("rm", (RErr, [Pathname "path"], []), 29, [],
1826 [InitScratchFS, Always, TestRun
1828 ["touch"; "/rm/new"];
1830 InitScratchFS, Always, TestLastFail
1831 [["rm"; "/nosuchfile"]];
1832 InitScratchFS, Always, TestLastFail
1837 Remove the single file C<path>.");
1839 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1840 [InitScratchFS, Always, TestRun
1841 [["mkdir"; "/rmdir"];
1842 ["rmdir"; "/rmdir"]];
1843 InitScratchFS, Always, TestLastFail
1844 [["rmdir"; "/rmdir2"]];
1845 InitScratchFS, Always, TestLastFail
1846 [["mkdir"; "/rmdir3"];
1847 ["touch"; "/rmdir3/new"];
1848 ["rmdir"; "/rmdir3/new"]]],
1849 "remove a directory",
1851 Remove the single directory C<path>.");
1853 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1854 [InitScratchFS, Always, TestOutputFalse
1855 [["mkdir"; "/rm_rf"];
1856 ["mkdir"; "/rm_rf/foo"];
1857 ["touch"; "/rm_rf/foo/bar"];
1858 ["rm_rf"; "/rm_rf"];
1859 ["exists"; "/rm_rf"]]],
1860 "remove a file or directory recursively",
1862 Remove the file or directory C<path>, recursively removing the
1863 contents if its a directory. This is like the C<rm -rf> shell
1866 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1867 [InitScratchFS, Always, TestOutputTrue
1868 [["mkdir"; "/mkdir"];
1869 ["is_dir"; "/mkdir"]];
1870 InitScratchFS, Always, TestLastFail
1871 [["mkdir"; "/mkdir2/foo/bar"]]],
1872 "create a directory",
1874 Create a directory named C<path>.");
1876 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1877 [InitScratchFS, Always, TestOutputTrue
1878 [["mkdir_p"; "/mkdir_p/foo/bar"];
1879 ["is_dir"; "/mkdir_p/foo/bar"]];
1880 InitScratchFS, Always, TestOutputTrue
1881 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1882 ["is_dir"; "/mkdir_p2/foo"]];
1883 InitScratchFS, Always, TestOutputTrue
1884 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1885 ["is_dir"; "/mkdir_p3"]];
1886 (* Regression tests for RHBZ#503133: *)
1887 InitScratchFS, Always, TestRun
1888 [["mkdir"; "/mkdir_p4"];
1889 ["mkdir_p"; "/mkdir_p4"]];
1890 InitScratchFS, Always, TestLastFail
1891 [["touch"; "/mkdir_p5"];
1892 ["mkdir_p"; "/mkdir_p5"]]],
1893 "create a directory and parents",
1895 Create a directory named C<path>, creating any parent directories
1896 as necessary. This is like the C<mkdir -p> shell command.");
1898 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1899 [], (* XXX Need stat command to test *)
1902 Change the mode (permissions) of C<path> to C<mode>. Only
1903 numeric modes are supported.
1905 I<Note>: When using this command from guestfish, C<mode>
1906 by default would be decimal, unless you prefix it with
1907 C<0> to get octal, ie. use C<0700> not C<700>.
1909 The mode actually set is affected by the umask.");
1911 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1912 [], (* XXX Need stat command to test *)
1913 "change file owner and group",
1915 Change the file owner to C<owner> and group to C<group>.
1917 Only numeric uid and gid are supported. If you want to use
1918 names, you will need to locate and parse the password file
1919 yourself (Augeas support makes this relatively easy).");
1921 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1922 [InitISOFS, Always, TestOutputTrue (
1923 [["exists"; "/empty"]]);
1924 InitISOFS, Always, TestOutputTrue (
1925 [["exists"; "/directory"]])],
1926 "test if file or directory exists",
1928 This returns C<true> if and only if there is a file, directory
1929 (or anything) with the given C<path> name.
1931 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1933 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1934 [InitISOFS, Always, TestOutputTrue (
1935 [["is_file"; "/known-1"]]);
1936 InitISOFS, Always, TestOutputFalse (
1937 [["is_file"; "/directory"]])],
1938 "test if a regular file",
1940 This returns C<true> if and only if there is a regular file
1941 with the given C<path> name. Note that it returns false for
1942 other objects like directories.
1944 See also C<guestfs_stat>.");
1946 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1947 [InitISOFS, Always, TestOutputFalse (
1948 [["is_dir"; "/known-3"]]);
1949 InitISOFS, Always, TestOutputTrue (
1950 [["is_dir"; "/directory"]])],
1951 "test if a directory",
1953 This returns C<true> if and only if there is a directory
1954 with the given C<path> name. Note that it returns false for
1955 other objects like files.
1957 See also C<guestfs_stat>.");
1959 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1960 [InitEmpty, Always, TestOutputListOfDevices (
1961 [["part_init"; "/dev/sda"; "mbr"];
1962 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1963 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1964 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1965 ["pvcreate"; "/dev/sda1"];
1966 ["pvcreate"; "/dev/sda2"];
1967 ["pvcreate"; "/dev/sda3"];
1968 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1969 "create an LVM physical volume",
1971 This creates an LVM physical volume on the named C<device>,
1972 where C<device> should usually be a partition name such
1975 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1976 [InitEmpty, Always, TestOutputList (
1977 [["part_init"; "/dev/sda"; "mbr"];
1978 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1979 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1980 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1981 ["pvcreate"; "/dev/sda1"];
1982 ["pvcreate"; "/dev/sda2"];
1983 ["pvcreate"; "/dev/sda3"];
1984 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1985 ["vgcreate"; "VG2"; "/dev/sda3"];
1986 ["vgs"]], ["VG1"; "VG2"])],
1987 "create an LVM volume group",
1989 This creates an LVM volume group called C<volgroup>
1990 from the non-empty list of physical volumes C<physvols>.");
1992 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1993 [InitEmpty, Always, TestOutputList (
1994 [["part_init"; "/dev/sda"; "mbr"];
1995 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1996 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1997 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1998 ["pvcreate"; "/dev/sda1"];
1999 ["pvcreate"; "/dev/sda2"];
2000 ["pvcreate"; "/dev/sda3"];
2001 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2002 ["vgcreate"; "VG2"; "/dev/sda3"];
2003 ["lvcreate"; "LV1"; "VG1"; "50"];
2004 ["lvcreate"; "LV2"; "VG1"; "50"];
2005 ["lvcreate"; "LV3"; "VG2"; "50"];
2006 ["lvcreate"; "LV4"; "VG2"; "50"];
2007 ["lvcreate"; "LV5"; "VG2"; "50"];
2009 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2010 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2011 "create an LVM logical volume",
2013 This creates an LVM logical volume called C<logvol>
2014 on the volume group C<volgroup>, with C<size> megabytes.");
2016 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2017 [InitEmpty, Always, TestOutput (
2018 [["part_disk"; "/dev/sda"; "mbr"];
2019 ["mkfs"; "ext2"; "/dev/sda1"];
2020 ["mount_options"; ""; "/dev/sda1"; "/"];
2021 ["write"; "/new"; "new file contents"];
2022 ["cat"; "/new"]], "new file contents")],
2023 "make a filesystem",
2025 This creates a filesystem on C<device> (usually a partition
2026 or LVM logical volume). The filesystem type is C<fstype>, for
2029 ("sfdisk", (RErr, [Device "device";
2030 Int "cyls"; Int "heads"; Int "sectors";
2031 StringList "lines"], []), 43, [DangerWillRobinson],
2033 "create partitions on a block device",
2035 This is a direct interface to the L<sfdisk(8)> program for creating
2036 partitions on block devices.
2038 C<device> should be a block device, for example C</dev/sda>.
2040 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2041 and sectors on the device, which are passed directly to sfdisk as
2042 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2043 of these, then the corresponding parameter is omitted. Usually for
2044 'large' disks, you can just pass C<0> for these, but for small
2045 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2046 out the right geometry and you will need to tell it.
2048 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2049 information refer to the L<sfdisk(8)> manpage.
2051 To create a single partition occupying the whole disk, you would
2052 pass C<lines> as a single element list, when the single element being
2053 the string C<,> (comma).
2055 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2056 C<guestfs_part_init>");
2058 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2059 (* Regression test for RHBZ#597135. *)
2060 [InitScratchFS, Always, TestLastFail
2061 [["write_file"; "/write_file"; "abc"; "10000"]]],
2064 This call creates a file called C<path>. The contents of the
2065 file is the string C<content> (which can contain any 8 bit data),
2066 with length C<size>.
2068 As a special case, if C<size> is C<0>
2069 then the length is calculated using C<strlen> (so in this case
2070 the content cannot contain embedded ASCII NULs).
2072 I<NB.> Owing to a bug, writing content containing ASCII NUL
2073 characters does I<not> work, even if the length is specified.");
2075 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2076 [InitEmpty, Always, TestOutputListOfDevices (
2077 [["part_disk"; "/dev/sda"; "mbr"];
2078 ["mkfs"; "ext2"; "/dev/sda1"];
2079 ["mount_options"; ""; "/dev/sda1"; "/"];
2080 ["mounts"]], ["/dev/sda1"]);
2081 InitEmpty, Always, TestOutputList (
2082 [["part_disk"; "/dev/sda"; "mbr"];
2083 ["mkfs"; "ext2"; "/dev/sda1"];
2084 ["mount_options"; ""; "/dev/sda1"; "/"];
2087 "unmount a filesystem",
2089 This unmounts the given filesystem. The filesystem may be
2090 specified either by its mountpoint (path) or the device which
2091 contains the filesystem.");
2093 ("mounts", (RStringList "devices", [], []), 46, [],
2094 [InitScratchFS, Always, TestOutputListOfDevices (
2095 [["mounts"]], ["/dev/sdb1"])],
2096 "show mounted filesystems",
2098 This returns the list of currently mounted filesystems. It returns
2099 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2101 Some internal mounts are not shown.
2103 See also: C<guestfs_mountpoints>");
2105 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2106 [InitScratchFS, Always, TestOutputList (
2109 (* check that umount_all can unmount nested mounts correctly: *)
2110 InitEmpty, Always, TestOutputList (
2111 [["part_init"; "/dev/sda"; "mbr"];
2112 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2113 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2114 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2115 ["mkfs"; "ext2"; "/dev/sda1"];
2116 ["mkfs"; "ext2"; "/dev/sda2"];
2117 ["mkfs"; "ext2"; "/dev/sda3"];
2118 ["mount_options"; ""; "/dev/sda1"; "/"];
2120 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2121 ["mkdir"; "/mp1/mp2"];
2122 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2123 ["mkdir"; "/mp1/mp2/mp3"];
2126 "unmount all filesystems",
2128 This unmounts all mounted filesystems.
2130 Some internal mounts are not unmounted by this call.");
2132 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2134 "remove all LVM LVs, VGs and PVs",
2136 This command removes all LVM logical volumes, volume groups
2137 and physical volumes.");
2139 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2140 [InitISOFS, Always, TestOutput (
2141 [["file"; "/empty"]], "empty");
2142 InitISOFS, Always, TestOutput (
2143 [["file"; "/known-1"]], "ASCII text");
2144 InitISOFS, Always, TestLastFail (
2145 [["file"; "/notexists"]]);
2146 InitISOFS, Always, TestOutput (
2147 [["file"; "/abssymlink"]], "symbolic link");
2148 InitISOFS, Always, TestOutput (
2149 [["file"; "/directory"]], "directory")],
2150 "determine file type",
2152 This call uses the standard L<file(1)> command to determine
2153 the type or contents of the file.
2155 This call will also transparently look inside various types
2158 The exact command which runs is C<file -zb path>. Note in
2159 particular that the filename is not prepended to the output
2162 This command can also be used on C</dev/> devices
2163 (and partitions, LV names). You can for example use this
2164 to determine if a device contains a filesystem, although
2165 it's usually better to use C<guestfs_vfs_type>.
2167 If the C<path> does not begin with C</dev/> then
2168 this command only works for the content of regular files.
2169 For other file types (directory, symbolic link etc) it
2170 will just return the string C<directory> etc.");
2172 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2173 [InitScratchFS, Always, TestOutput (
2174 [["mkdir"; "/command"];
2175 ["upload"; "test-command"; "/command/test-command"];
2176 ["chmod"; "0o755"; "/command/test-command"];
2177 ["command"; "/command/test-command 1"]], "Result1");
2178 InitScratchFS, Always, TestOutput (
2179 [["mkdir"; "/command2"];
2180 ["upload"; "test-command"; "/command2/test-command"];
2181 ["chmod"; "0o755"; "/command2/test-command"];
2182 ["command"; "/command2/test-command 2"]], "Result2\n");
2183 InitScratchFS, Always, TestOutput (
2184 [["mkdir"; "/command3"];
2185 ["upload"; "test-command"; "/command3/test-command"];
2186 ["chmod"; "0o755"; "/command3/test-command"];
2187 ["command"; "/command3/test-command 3"]], "\nResult3");
2188 InitScratchFS, Always, TestOutput (
2189 [["mkdir"; "/command4"];
2190 ["upload"; "test-command"; "/command4/test-command"];
2191 ["chmod"; "0o755"; "/command4/test-command"];
2192 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2193 InitScratchFS, Always, TestOutput (
2194 [["mkdir"; "/command5"];
2195 ["upload"; "test-command"; "/command5/test-command"];
2196 ["chmod"; "0o755"; "/command5/test-command"];
2197 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2198 InitScratchFS, Always, TestOutput (
2199 [["mkdir"; "/command6"];
2200 ["upload"; "test-command"; "/command6/test-command"];
2201 ["chmod"; "0o755"; "/command6/test-command"];
2202 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2203 InitScratchFS, Always, TestOutput (
2204 [["mkdir"; "/command7"];
2205 ["upload"; "test-command"; "/command7/test-command"];
2206 ["chmod"; "0o755"; "/command7/test-command"];
2207 ["command"; "/command7/test-command 7"]], "");
2208 InitScratchFS, Always, TestOutput (
2209 [["mkdir"; "/command8"];
2210 ["upload"; "test-command"; "/command8/test-command"];
2211 ["chmod"; "0o755"; "/command8/test-command"];
2212 ["command"; "/command8/test-command 8"]], "\n");
2213 InitScratchFS, Always, TestOutput (
2214 [["mkdir"; "/command9"];
2215 ["upload"; "test-command"; "/command9/test-command"];
2216 ["chmod"; "0o755"; "/command9/test-command"];
2217 ["command"; "/command9/test-command 9"]], "\n\n");
2218 InitScratchFS, Always, TestOutput (
2219 [["mkdir"; "/command10"];
2220 ["upload"; "test-command"; "/command10/test-command"];
2221 ["chmod"; "0o755"; "/command10/test-command"];
2222 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2223 InitScratchFS, Always, TestOutput (
2224 [["mkdir"; "/command11"];
2225 ["upload"; "test-command"; "/command11/test-command"];
2226 ["chmod"; "0o755"; "/command11/test-command"];
2227 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2228 InitScratchFS, Always, TestLastFail (
2229 [["mkdir"; "/command12"];
2230 ["upload"; "test-command"; "/command12/test-command"];
2231 ["chmod"; "0o755"; "/command12/test-command"];
2232 ["command"; "/command12/test-command"]])],
2233 "run a command from the guest filesystem",
2235 This call runs a command from the guest filesystem. The
2236 filesystem must be mounted, and must contain a compatible
2237 operating system (ie. something Linux, with the same
2238 or compatible processor architecture).
2240 The single parameter is an argv-style list of arguments.
2241 The first element is the name of the program to run.
2242 Subsequent elements are parameters. The list must be
2243 non-empty (ie. must contain a program name). Note that
2244 the command runs directly, and is I<not> invoked via
2245 the shell (see C<guestfs_sh>).
2247 The return value is anything printed to I<stdout> by
2250 If the command returns a non-zero exit status, then
2251 this function returns an error message. The error message
2252 string is the content of I<stderr> from the command.
2254 The C<$PATH> environment variable will contain at least
2255 C</usr/bin> and C</bin>. If you require a program from
2256 another location, you should provide the full path in the
2259 Shared libraries and data files required by the program
2260 must be available on filesystems which are mounted in the
2261 correct places. It is the caller's responsibility to ensure
2262 all filesystems that are needed are mounted at the right
2265 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2266 [InitScratchFS, Always, TestOutputList (
2267 [["mkdir"; "/command_lines"];
2268 ["upload"; "test-command"; "/command_lines/test-command"];
2269 ["chmod"; "0o755"; "/command_lines/test-command"];
2270 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2271 InitScratchFS, Always, TestOutputList (
2272 [["mkdir"; "/command_lines2"];
2273 ["upload"; "test-command"; "/command_lines2/test-command"];
2274 ["chmod"; "0o755"; "/command_lines2/test-command"];
2275 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2276 InitScratchFS, Always, TestOutputList (
2277 [["mkdir"; "/command_lines3"];
2278 ["upload"; "test-command"; "/command_lines3/test-command"];
2279 ["chmod"; "0o755"; "/command_lines3/test-command"];
2280 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2281 InitScratchFS, Always, TestOutputList (
2282 [["mkdir"; "/command_lines4"];
2283 ["upload"; "test-command"; "/command_lines4/test-command"];
2284 ["chmod"; "0o755"; "/command_lines4/test-command"];
2285 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2286 InitScratchFS, Always, TestOutputList (
2287 [["mkdir"; "/command_lines5"];
2288 ["upload"; "test-command"; "/command_lines5/test-command"];
2289 ["chmod"; "0o755"; "/command_lines5/test-command"];
2290 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2291 InitScratchFS, Always, TestOutputList (
2292 [["mkdir"; "/command_lines6"];
2293 ["upload"; "test-command"; "/command_lines6/test-command"];
2294 ["chmod"; "0o755"; "/command_lines6/test-command"];
2295 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2296 InitScratchFS, Always, TestOutputList (
2297 [["mkdir"; "/command_lines7"];
2298 ["upload"; "test-command"; "/command_lines7/test-command"];
2299 ["chmod"; "0o755"; "/command_lines7/test-command"];
2300 ["command_lines"; "/command_lines7/test-command 7"]], []);
2301 InitScratchFS, Always, TestOutputList (
2302 [["mkdir"; "/command_lines8"];
2303 ["upload"; "test-command"; "/command_lines8/test-command"];
2304 ["chmod"; "0o755"; "/command_lines8/test-command"];
2305 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2306 InitScratchFS, Always, TestOutputList (
2307 [["mkdir"; "/command_lines9"];
2308 ["upload"; "test-command"; "/command_lines9/test-command"];
2309 ["chmod"; "0o755"; "/command_lines9/test-command"];
2310 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2311 InitScratchFS, Always, TestOutputList (
2312 [["mkdir"; "/command_lines10"];
2313 ["upload"; "test-command"; "/command_lines10/test-command"];
2314 ["chmod"; "0o755"; "/command_lines10/test-command"];
2315 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2316 InitScratchFS, Always, TestOutputList (
2317 [["mkdir"; "/command_lines11"];
2318 ["upload"; "test-command"; "/command_lines11/test-command"];
2319 ["chmod"; "0o755"; "/command_lines11/test-command"];
2320 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2321 "run a command, returning lines",
2323 This is the same as C<guestfs_command>, but splits the
2324 result into a list of lines.
2326 See also: C<guestfs_sh_lines>");
2328 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2329 [InitISOFS, Always, TestOutputStruct (
2330 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2331 "get file information",
2333 Returns file information for the given C<path>.
2335 This is the same as the C<stat(2)> system call.");
2337 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2338 [InitISOFS, Always, TestOutputStruct (
2339 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2340 "get file information for a symbolic link",
2342 Returns file information for the given C<path>.
2344 This is the same as C<guestfs_stat> except that if C<path>
2345 is a symbolic link, then the link is stat-ed, not the file it
2348 This is the same as the C<lstat(2)> system call.");
2350 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2351 [InitISOFS, Always, TestOutputStruct (
2352 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2353 "get file system statistics",
2355 Returns file system statistics for any mounted file system.
2356 C<path> should be a file or directory in the mounted file system
2357 (typically it is the mount point itself, but it doesn't need to be).
2359 This is the same as the C<statvfs(2)> system call.");
2361 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2363 "get ext2/ext3/ext4 superblock details",
2365 This returns the contents of the ext2, ext3 or ext4 filesystem
2366 superblock on C<device>.
2368 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2369 manpage for more details. The list of fields returned isn't
2370 clearly defined, and depends on both the version of C<tune2fs>
2371 that libguestfs was built against, and the filesystem itself.");
2373 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2374 [InitEmpty, Always, TestOutputTrue (
2375 [["blockdev_setro"; "/dev/sda"];
2376 ["blockdev_getro"; "/dev/sda"]])],
2377 "set block device to read-only",
2379 Sets the block device named C<device> to read-only.
2381 This uses the L<blockdev(8)> command.");
2383 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2384 [InitEmpty, Always, TestOutputFalse (
2385 [["blockdev_setrw"; "/dev/sda"];
2386 ["blockdev_getro"; "/dev/sda"]])],
2387 "set block device to read-write",
2389 Sets the block device named C<device> to read-write.
2391 This uses the L<blockdev(8)> command.");
2393 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2394 [InitEmpty, Always, TestOutputTrue (
2395 [["blockdev_setro"; "/dev/sda"];
2396 ["blockdev_getro"; "/dev/sda"]])],
2397 "is block device set to read-only",
2399 Returns a boolean indicating if the block device is read-only
2400 (true if read-only, false if not).
2402 This uses the L<blockdev(8)> command.");
2404 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2405 [InitEmpty, Always, TestOutputInt (
2406 [["blockdev_getss"; "/dev/sda"]], 512)],
2407 "get sectorsize of block device",
2409 This returns the size of sectors on a block device.
2410 Usually 512, but can be larger for modern devices.
2412 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2415 This uses the L<blockdev(8)> command.");
2417 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2418 [InitEmpty, Always, TestOutputInt (
2419 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2420 "get blocksize of block device",
2422 This returns the block size of a device.
2424 (Note this is different from both I<size in blocks> and
2425 I<filesystem block size>).
2427 This uses the L<blockdev(8)> command.");
2429 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2431 "set blocksize of block device",
2433 This sets the block size of a device.
2435 (Note this is different from both I<size in blocks> and
2436 I<filesystem block size>).
2438 This uses the L<blockdev(8)> command.");
2440 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2441 [InitEmpty, Always, TestOutputInt (
2442 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2443 "get total size of device in 512-byte sectors",
2445 This returns the size of the device in units of 512-byte sectors
2446 (even if the sectorsize isn't 512 bytes ... weird).
2448 See also C<guestfs_blockdev_getss> for the real sector size of
2449 the device, and C<guestfs_blockdev_getsize64> for the more
2450 useful I<size in bytes>.
2452 This uses the L<blockdev(8)> command.");
2454 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2455 [InitEmpty, Always, TestOutputInt (
2456 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2457 "get total size of device in bytes",
2459 This returns the size of the device in bytes.
2461 See also C<guestfs_blockdev_getsz>.
2463 This uses the L<blockdev(8)> command.");
2465 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2466 [InitEmpty, Always, TestRun
2467 [["blockdev_flushbufs"; "/dev/sda"]]],
2468 "flush device buffers",
2470 This tells the kernel to flush internal buffers associated
2473 This uses the L<blockdev(8)> command.");
2475 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2476 [InitEmpty, Always, TestRun
2477 [["blockdev_rereadpt"; "/dev/sda"]]],
2478 "reread partition table",
2480 Reread the partition table on C<device>.
2482 This uses the L<blockdev(8)> command.");
2484 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2485 [InitScratchFS, Always, TestOutput (
2486 (* Pick a file from cwd which isn't likely to change. *)
2487 [["mkdir"; "/upload"];
2488 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2489 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2490 Digest.to_hex (Digest.file "COPYING.LIB"))],
2491 "upload a file from the local machine",
2493 Upload local file C<filename> to C<remotefilename> on the
2496 C<filename> can also be a named pipe.
2498 See also C<guestfs_download>.");
2500 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2501 [InitScratchFS, Always, TestOutput (
2502 (* Pick a file from cwd which isn't likely to change. *)
2503 [["mkdir"; "/download"];
2504 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2505 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2506 ["upload"; "testdownload.tmp"; "/download/upload"];
2507 ["checksum"; "md5"; "/download/upload"]],
2508 Digest.to_hex (Digest.file "COPYING.LIB"))],
2509 "download a file to the local machine",
2511 Download file C<remotefilename> and save it as C<filename>
2512 on the local machine.
2514 C<filename> can also be a named pipe.
2516 See also C<guestfs_upload>, C<guestfs_cat>.");
2518 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2519 [InitISOFS, Always, TestOutput (
2520 [["checksum"; "crc"; "/known-3"]], "2891671662");
2521 InitISOFS, Always, TestLastFail (
2522 [["checksum"; "crc"; "/notexists"]]);
2523 InitISOFS, Always, TestOutput (
2524 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2525 InitISOFS, Always, TestOutput (
2526 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2527 InitISOFS, Always, TestOutput (
2528 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2529 InitISOFS, Always, TestOutput (
2530 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2531 InitISOFS, Always, TestOutput (
2532 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2533 InitISOFS, Always, TestOutput (
2534 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2535 (* Test for RHBZ#579608, absolute symbolic links. *)
2536 InitISOFS, Always, TestOutput (
2537 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2538 "compute MD5, SHAx or CRC checksum of file",
2540 This call computes the MD5, SHAx or CRC checksum of the
2543 The type of checksum to compute is given by the C<csumtype>
2544 parameter which must have one of the following values:
2550 Compute the cyclic redundancy check (CRC) specified by POSIX
2551 for the C<cksum> command.
2555 Compute the MD5 hash (using the C<md5sum> program).
2559 Compute the SHA1 hash (using the C<sha1sum> program).
2563 Compute the SHA224 hash (using the C<sha224sum> program).
2567 Compute the SHA256 hash (using the C<sha256sum> program).
2571 Compute the SHA384 hash (using the C<sha384sum> program).
2575 Compute the SHA512 hash (using the C<sha512sum> program).
2579 The checksum is returned as a printable string.
2581 To get the checksum for a device, use C<guestfs_checksum_device>.
2583 To get the checksums for many files, use C<guestfs_checksums_out>.");
2585 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2586 [InitScratchFS, Always, TestOutput (
2587 [["mkdir"; "/tar_in"];
2588 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2589 ["cat"; "/tar_in/hello"]], "hello\n")],
2590 "unpack tarfile to directory",
2592 This command uploads and unpacks local file C<tarfile> (an
2593 I<uncompressed> tar file) into C<directory>.
2595 To upload a compressed tarball, use C<guestfs_tgz_in>
2596 or C<guestfs_txz_in>.");
2598 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2600 "pack directory into tarfile",
2602 This command packs the contents of C<directory> and downloads
2603 it to local file C<tarfile>.
2605 To download a compressed tarball, use C<guestfs_tgz_out>
2606 or C<guestfs_txz_out>.");
2608 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2609 [InitScratchFS, Always, TestOutput (
2610 [["mkdir"; "/tgz_in"];
2611 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2612 ["cat"; "/tgz_in/hello"]], "hello\n")],
2613 "unpack compressed tarball to directory",
2615 This command uploads and unpacks local file C<tarball> (a
2616 I<gzip compressed> tar file) into C<directory>.
2618 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2620 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2622 "pack directory into compressed tarball",
2624 This command packs the contents of C<directory> and downloads
2625 it to local file C<tarball>.
2627 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2629 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2630 [InitBasicFS, Always, TestLastFail (
2632 ["mount_ro"; "/dev/sda1"; "/"];
2633 ["touch"; "/new"]]);
2634 InitBasicFS, Always, TestOutput (
2635 [["write"; "/new"; "data"];
2637 ["mount_ro"; "/dev/sda1"; "/"];
2638 ["cat"; "/new"]], "data")],
2639 "mount a guest disk, read-only",
2641 This is the same as the C<guestfs_mount> command, but it
2642 mounts the filesystem with the read-only (I<-o ro>) flag.");
2644 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2646 "mount a guest disk with mount options",
2648 This is the same as the C<guestfs_mount> command, but it
2649 allows you to set the mount options as for the
2650 L<mount(8)> I<-o> flag.
2652 If the C<options> parameter is an empty string, then
2653 no options are passed (all options default to whatever
2654 the filesystem uses).");
2656 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2658 "mount a guest disk with mount options and vfstype",
2660 This is the same as the C<guestfs_mount> command, but it
2661 allows you to set both the mount options and the vfstype
2662 as for the L<mount(8)> I<-o> and I<-t> flags.");
2664 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2666 "debugging and internals",
2668 The C<guestfs_debug> command exposes some internals of
2669 C<guestfsd> (the guestfs daemon) that runs inside the
2672 There is no comprehensive help for this command. You have
2673 to look at the file C<daemon/debug.c> in the libguestfs source
2674 to find out what you can do.");
2676 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2677 [InitEmpty, Always, TestOutputList (
2678 [["part_disk"; "/dev/sda"; "mbr"];
2679 ["pvcreate"; "/dev/sda1"];
2680 ["vgcreate"; "VG"; "/dev/sda1"];
2681 ["lvcreate"; "LV1"; "VG"; "50"];
2682 ["lvcreate"; "LV2"; "VG"; "50"];
2683 ["lvremove"; "/dev/VG/LV1"];
2684 ["lvs"]], ["/dev/VG/LV2"]);
2685 InitEmpty, Always, TestOutputList (
2686 [["part_disk"; "/dev/sda"; "mbr"];
2687 ["pvcreate"; "/dev/sda1"];
2688 ["vgcreate"; "VG"; "/dev/sda1"];
2689 ["lvcreate"; "LV1"; "VG"; "50"];
2690 ["lvcreate"; "LV2"; "VG"; "50"];
2691 ["lvremove"; "/dev/VG"];
2693 InitEmpty, Always, TestOutputList (
2694 [["part_disk"; "/dev/sda"; "mbr"];
2695 ["pvcreate"; "/dev/sda1"];
2696 ["vgcreate"; "VG"; "/dev/sda1"];
2697 ["lvcreate"; "LV1"; "VG"; "50"];
2698 ["lvcreate"; "LV2"; "VG"; "50"];
2699 ["lvremove"; "/dev/VG"];
2701 "remove an LVM logical volume",
2703 Remove an LVM logical volume C<device>, where C<device> is
2704 the path to the LV, such as C</dev/VG/LV>.
2706 You can also remove all LVs in a volume group by specifying
2707 the VG name, C</dev/VG>.");
2709 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2710 [InitEmpty, Always, TestOutputList (
2711 [["part_disk"; "/dev/sda"; "mbr"];
2712 ["pvcreate"; "/dev/sda1"];
2713 ["vgcreate"; "VG"; "/dev/sda1"];
2714 ["lvcreate"; "LV1"; "VG"; "50"];
2715 ["lvcreate"; "LV2"; "VG"; "50"];
2718 InitEmpty, Always, TestOutputList (
2719 [["part_disk"; "/dev/sda"; "mbr"];
2720 ["pvcreate"; "/dev/sda1"];
2721 ["vgcreate"; "VG"; "/dev/sda1"];
2722 ["lvcreate"; "LV1"; "VG"; "50"];
2723 ["lvcreate"; "LV2"; "VG"; "50"];
2726 "remove an LVM volume group",
2728 Remove an LVM volume group C<vgname>, (for example C<VG>).
2730 This also forcibly removes all logical volumes in the volume
2733 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2734 [InitEmpty, Always, TestOutputListOfDevices (
2735 [["part_disk"; "/dev/sda"; "mbr"];
2736 ["pvcreate"; "/dev/sda1"];
2737 ["vgcreate"; "VG"; "/dev/sda1"];
2738 ["lvcreate"; "LV1"; "VG"; "50"];
2739 ["lvcreate"; "LV2"; "VG"; "50"];
2741 ["pvremove"; "/dev/sda1"];
2743 InitEmpty, Always, TestOutputListOfDevices (
2744 [["part_disk"; "/dev/sda"; "mbr"];
2745 ["pvcreate"; "/dev/sda1"];
2746 ["vgcreate"; "VG"; "/dev/sda1"];
2747 ["lvcreate"; "LV1"; "VG"; "50"];
2748 ["lvcreate"; "LV2"; "VG"; "50"];
2750 ["pvremove"; "/dev/sda1"];
2752 InitEmpty, Always, TestOutputListOfDevices (
2753 [["part_disk"; "/dev/sda"; "mbr"];
2754 ["pvcreate"; "/dev/sda1"];
2755 ["vgcreate"; "VG"; "/dev/sda1"];
2756 ["lvcreate"; "LV1"; "VG"; "50"];
2757 ["lvcreate"; "LV2"; "VG"; "50"];
2759 ["pvremove"; "/dev/sda1"];
2761 "remove an LVM physical volume",
2763 This wipes a physical volume C<device> so that LVM will no longer
2766 The implementation uses the C<pvremove> command which refuses to
2767 wipe physical volumes that contain any volume groups, so you have
2768 to remove those first.");
2770 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2771 [InitBasicFS, Always, TestOutput (
2772 [["set_e2label"; "/dev/sda1"; "testlabel"];
2773 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2774 "set the ext2/3/4 filesystem label",
2776 This sets the ext2/3/4 filesystem label of the filesystem on
2777 C<device> to C<label>. Filesystem labels are limited to
2780 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2781 to return the existing label on a filesystem.");
2783 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2785 "get the ext2/3/4 filesystem label",
2787 This returns the ext2/3/4 filesystem label of the filesystem on
2790 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2791 (let uuid = uuidgen () in
2792 [InitBasicFS, Always, TestOutput (
2793 [["set_e2uuid"; "/dev/sda1"; uuid];
2794 ["get_e2uuid"; "/dev/sda1"]], uuid);
2795 InitBasicFS, Always, TestOutput (
2796 [["set_e2uuid"; "/dev/sda1"; "clear"];
2797 ["get_e2uuid"; "/dev/sda1"]], "");
2798 (* We can't predict what UUIDs will be, so just check the commands run. *)
2799 InitBasicFS, Always, TestRun (
2800 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2801 InitBasicFS, Always, TestRun (
2802 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2803 "set the ext2/3/4 filesystem UUID",
2805 This sets the ext2/3/4 filesystem UUID of the filesystem on
2806 C<device> to C<uuid>. The format of the UUID and alternatives
2807 such as C<clear>, C<random> and C<time> are described in the
2808 L<tune2fs(8)> manpage.
2810 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2811 to return the existing UUID of a filesystem.");
2813 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2814 (* Regression test for RHBZ#597112. *)
2815 (let uuid = uuidgen () in
2816 [InitNone, Always, TestOutput (
2817 [["mke2journal"; "1024"; "/dev/sdc"];
2818 ["set_e2uuid"; "/dev/sdc"; uuid];
2819 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2820 "get the ext2/3/4 filesystem UUID",
2822 This returns the ext2/3/4 filesystem UUID of the filesystem on
2825 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2826 [InitBasicFS, Always, TestOutputInt (
2827 [["umount"; "/dev/sda1"];
2828 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2829 InitBasicFS, Always, TestOutputInt (
2830 [["umount"; "/dev/sda1"];
2831 ["zero"; "/dev/sda1"];
2832 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2833 "run the filesystem checker",
2835 This runs the filesystem checker (fsck) on C<device> which
2836 should have filesystem type C<fstype>.
2838 The returned integer is the status. See L<fsck(8)> for the
2839 list of status codes from C<fsck>.
2847 Multiple status codes can be summed together.
2851 A non-zero return code can mean \"success\", for example if
2852 errors have been corrected on the filesystem.
2856 Checking or repairing NTFS volumes is not supported
2861 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2863 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2864 [InitBasicFS, Always, TestOutput (
2865 [["umount"; "/dev/sda1"];
2866 ["zero"; "/dev/sda1"];
2867 ["file"; "/dev/sda1"]], "data")],
2868 "write zeroes to the device",
2870 This command writes zeroes over the first few blocks of C<device>.
2872 How many blocks are zeroed isn't specified (but it's I<not> enough
2873 to securely wipe the device). It should be sufficient to remove
2874 any partition tables, filesystem superblocks and so on.
2876 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2878 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2880 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2881 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2883 [InitBasicFS, Always, TestOutputTrue (
2884 [["mkdir_p"; "/boot/grub"];
2885 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2886 ["grub_install"; "/"; "/dev/vda"];
2887 ["is_dir"; "/boot"]])],
2890 This command installs GRUB (the Grand Unified Bootloader) on
2891 C<device>, with the root directory being C<root>.
2893 Note: If grub-install reports the error
2894 \"No suitable drive was found in the generated device map.\"
2895 it may be that you need to create a C</boot/grub/device.map>
2896 file first that contains the mapping between grub device names
2897 and Linux device names. It is usually sufficient to create
2902 replacing C</dev/vda> with the name of the installation device.");
2904 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2905 [InitScratchFS, Always, TestOutput (
2907 ["write"; "/cp/old"; "file content"];
2908 ["cp"; "/cp/old"; "/cp/new"];
2909 ["cat"; "/cp/new"]], "file content");
2910 InitScratchFS, Always, TestOutputTrue (
2912 ["write"; "/cp2/old"; "file content"];
2913 ["cp"; "/cp2/old"; "/cp2/new"];
2914 ["is_file"; "/cp2/old"]]);
2915 InitScratchFS, Always, TestOutput (
2917 ["write"; "/cp3/old"; "file content"];
2918 ["mkdir"; "/cp3/dir"];
2919 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2920 ["cat"; "/cp3/dir/new"]], "file content")],
2923 This copies a file from C<src> to C<dest> where C<dest> is
2924 either a destination filename or destination directory.");
2926 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2927 [InitScratchFS, Always, TestOutput (
2928 [["mkdir"; "/cp_a1"];
2929 ["mkdir"; "/cp_a2"];
2930 ["write"; "/cp_a1/file"; "file content"];
2931 ["cp_a"; "/cp_a1"; "/cp_a2"];
2932 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2933 "copy a file or directory recursively",
2935 This copies a file or directory from C<src> to C<dest>
2936 recursively using the C<cp -a> command.");
2938 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2939 [InitScratchFS, Always, TestOutput (
2941 ["write"; "/mv/old"; "file content"];
2942 ["mv"; "/mv/old"; "/mv/new"];
2943 ["cat"; "/mv/new"]], "file content");
2944 InitScratchFS, Always, TestOutputFalse (
2946 ["write"; "/mv2/old"; "file content"];
2947 ["mv"; "/mv2/old"; "/mv2/new"];
2948 ["is_file"; "/mv2/old"]])],
2951 This moves a file from C<src> to C<dest> where C<dest> is
2952 either a destination filename or destination directory.");
2954 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2955 [InitEmpty, Always, TestRun (
2956 [["drop_caches"; "3"]])],
2957 "drop kernel page cache, dentries and inodes",
2959 This instructs the guest kernel to drop its page cache,
2960 and/or dentries and inode caches. The parameter C<whattodrop>
2961 tells the kernel what precisely to drop, see
2962 L<http://linux-mm.org/Drop_Caches>
2964 Setting C<whattodrop> to 3 should drop everything.
2966 This automatically calls L<sync(2)> before the operation,
2967 so that the maximum guest memory is freed.");
2969 ("dmesg", (RString "kmsgs", [], []), 91, [],
2970 [InitEmpty, Always, TestRun (
2972 "return kernel messages",
2974 This returns the kernel messages (C<dmesg> output) from
2975 the guest kernel. This is sometimes useful for extended
2976 debugging of problems.
2978 Another way to get the same information is to enable
2979 verbose messages with C<guestfs_set_verbose> or by setting
2980 the environment variable C<LIBGUESTFS_DEBUG=1> before
2981 running the program.");
2983 ("ping_daemon", (RErr, [], []), 92, [],
2984 [InitEmpty, Always, TestRun (
2985 [["ping_daemon"]])],
2986 "ping the guest daemon",
2988 This is a test probe into the guestfs daemon running inside
2989 the qemu subprocess. Calling this function checks that the
2990 daemon responds to the ping message, without affecting the daemon
2991 or attached block device(s) in any other way.");
2993 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2994 [InitScratchFS, Always, TestOutputTrue (
2995 [["mkdir"; "/equal"];
2996 ["write"; "/equal/file1"; "contents of a file"];
2997 ["cp"; "/equal/file1"; "/equal/file2"];
2998 ["equal"; "/equal/file1"; "/equal/file2"]]);
2999 InitScratchFS, Always, TestOutputFalse (
3000 [["mkdir"; "/equal2"];
3001 ["write"; "/equal2/file1"; "contents of a file"];
3002 ["write"; "/equal2/file2"; "contents of another file"];
3003 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3004 InitScratchFS, Always, TestLastFail (
3005 [["mkdir"; "/equal3"];
3006 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3007 "test if two files have equal contents",
3009 This compares the two files C<file1> and C<file2> and returns
3010 true if their content is exactly equal, or false otherwise.
3012 The external L<cmp(1)> program is used for the comparison.");
3014 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3015 [InitISOFS, Always, TestOutputList (
3016 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3017 InitISOFS, Always, TestOutputList (
3018 [["strings"; "/empty"]], []);
3019 (* Test for RHBZ#579608, absolute symbolic links. *)
3020 InitISOFS, Always, TestRun (
3021 [["strings"; "/abssymlink"]])],
3022 "print the printable strings in a file",
3024 This runs the L<strings(1)> command on a file and returns
3025 the list of printable strings found.");
3027 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3028 [InitISOFS, Always, TestOutputList (
3029 [["strings_e"; "b"; "/known-5"]], []);
3030 InitScratchFS, Always, TestOutputList (
3031 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3032 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3033 "print the printable strings in a file",
3035 This is like the C<guestfs_strings> command, but allows you to
3036 specify the encoding of strings that are looked for in
3037 the source file C<path>.
3039 Allowed encodings are:
3045 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3046 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3050 Single 8-bit-byte characters.
3054 16-bit big endian strings such as those encoded in
3055 UTF-16BE or UCS-2BE.
3057 =item l (lower case letter L)
3059 16-bit little endian such as UTF-16LE and UCS-2LE.
3060 This is useful for examining binaries in Windows guests.
3064 32-bit big endian such as UCS-4BE.
3068 32-bit little endian such as UCS-4LE.
3072 The returned strings are transcoded to UTF-8.");
3074 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3075 [InitISOFS, Always, TestOutput (
3076 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3077 (* Test for RHBZ#501888c2 regression which caused large hexdump
3078 * commands to segfault.
3080 InitISOFS, Always, TestRun (
3081 [["hexdump"; "/100krandom"]]);
3082 (* Test for RHBZ#579608, absolute symbolic links. *)
3083 InitISOFS, Always, TestRun (
3084 [["hexdump"; "/abssymlink"]])],
3085 "dump a file in hexadecimal",
3087 This runs C<hexdump -C> on the given C<path>. The result is
3088 the human-readable, canonical hex dump of the file.");
3090 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3091 [InitNone, Always, TestOutput (
3092 [["part_disk"; "/dev/sda"; "mbr"];
3093 ["mkfs"; "ext3"; "/dev/sda1"];
3094 ["mount_options"; ""; "/dev/sda1"; "/"];
3095 ["write"; "/new"; "test file"];
3096 ["umount"; "/dev/sda1"];
3097 ["zerofree"; "/dev/sda1"];
3098 ["mount_options"; ""; "/dev/sda1"; "/"];
3099 ["cat"; "/new"]], "test file")],
3100 "zero unused inodes and disk blocks on ext2/3 filesystem",
3102 This runs the I<zerofree> program on C<device>. This program
3103 claims to zero unused inodes and disk blocks on an ext2/3
3104 filesystem, thus making it possible to compress the filesystem
3107 You should B<not> run this program if the filesystem is
3110 It is possible that using this program can damage the filesystem
3111 or data on the filesystem.");
3113 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3115 "resize an LVM physical volume",
3117 This resizes (expands or shrinks) an existing LVM physical
3118 volume to match the new size of the underlying device.");
3120 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3121 Int "cyls"; Int "heads"; Int "sectors";
3122 String "line"], []), 99, [DangerWillRobinson],
3124 "modify a single partition on a block device",
3126 This runs L<sfdisk(8)> option to modify just the single
3127 partition C<n> (note: C<n> counts from 1).
3129 For other parameters, see C<guestfs_sfdisk>. You should usually
3130 pass C<0> for the cyls/heads/sectors parameters.
3132 See also: C<guestfs_part_add>");
3134 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3136 "display the partition table",
3138 This displays the partition table on C<device>, in the
3139 human-readable output of the L<sfdisk(8)> command. It is
3140 not intended to be parsed.
3142 See also: C<guestfs_part_list>");
3144 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3146 "display the kernel geometry",
3148 This displays the kernel's idea of the geometry of C<device>.
3150 The result is in human-readable format, and not designed to
3153 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3155 "display the disk geometry from the partition table",
3157 This displays the disk geometry of C<device> read from the
3158 partition table. Especially in the case where the underlying
3159 block device has been resized, this can be different from the
3160 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3162 The result is in human-readable format, and not designed to
3165 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3167 "activate or deactivate all volume groups",
3169 This command activates or (if C<activate> is false) deactivates
3170 all logical volumes in all volume groups.
3171 If activated, then they are made known to the
3172 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3173 then those devices disappear.
3175 This command is the same as running C<vgchange -a y|n>");
3177 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3179 "activate or deactivate some volume groups",
3181 This command activates or (if C<activate> is false) deactivates
3182 all logical volumes in the listed volume groups C<volgroups>.
3183 If activated, then they are made known to the
3184 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3185 then those devices disappear.
3187 This command is the same as running C<vgchange -a y|n volgroups...>
3189 Note that if C<volgroups> is an empty list then B<all> volume groups
3190 are activated or deactivated.");
3192 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3193 [InitNone, Always, TestOutput (
3194 [["part_disk"; "/dev/sda"; "mbr"];
3195 ["pvcreate"; "/dev/sda1"];
3196 ["vgcreate"; "VG"; "/dev/sda1"];
3197 ["lvcreate"; "LV"; "VG"; "10"];
3198 ["mkfs"; "ext2"; "/dev/VG/LV"];
3199 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3200 ["write"; "/new"; "test content"];
3202 ["lvresize"; "/dev/VG/LV"; "20"];
3203 ["e2fsck_f"; "/dev/VG/LV"];
3204 ["resize2fs"; "/dev/VG/LV"];
3205 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3206 ["cat"; "/new"]], "test content");
3207 InitNone, Always, TestRun (
3208 (* Make an LV smaller to test RHBZ#587484. *)
3209 [["part_disk"; "/dev/sda"; "mbr"];
3210 ["pvcreate"; "/dev/sda1"];
3211 ["vgcreate"; "VG"; "/dev/sda1"];
3212 ["lvcreate"; "LV"; "VG"; "20"];
3213 ["lvresize"; "/dev/VG/LV"; "10"]])],
3214 "resize an LVM logical volume",
3216 This resizes (expands or shrinks) an existing LVM logical
3217 volume to C<mbytes>. When reducing, data in the reduced part
3220 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3221 [], (* lvresize tests this *)
3222 "resize an ext2, ext3 or ext4 filesystem",
3224 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3225 the underlying device.
3227 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3228 on the C<device> before calling this command. For unknown reasons
3229 C<resize2fs> sometimes gives an error about this and sometimes not.
3230 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3231 calling this function.");
3233 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3234 [InitBasicFS, Always, TestOutputList (
3235 [["find"; "/"]], ["lost+found"]);
3236 InitBasicFS, Always, TestOutputList (
3240 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3241 InitScratchFS, Always, TestOutputList (
3242 [["mkdir_p"; "/find/b/c"];
3243 ["touch"; "/find/b/c/d"];
3244 ["find"; "/find/b/"]], ["c"; "c/d"])],
3245 "find all files and directories",
3247 This command lists out all files and directories, recursively,
3248 starting at C<directory>. It is essentially equivalent to
3249 running the shell command C<find directory -print> but some
3250 post-processing happens on the output, described below.
3252 This returns a list of strings I<without any prefix>. Thus
3253 if the directory structure was:
3259 then the returned list from C<guestfs_find> C</tmp> would be
3267 If C<directory> is not a directory, then this command returns
3270 The returned list is sorted.
3272 See also C<guestfs_find0>.");
3274 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3275 [], (* lvresize tests this *)
3276 "check an ext2/ext3 filesystem",
3278 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3279 filesystem checker on C<device>, noninteractively (C<-p>),
3280 even if the filesystem appears to be clean (C<-f>).
3282 This command is only needed because of C<guestfs_resize2fs>
3283 (q.v.). Normally you should use C<guestfs_fsck>.");
3285 ("sleep", (RErr, [Int "secs"], []), 109, [],
3286 [InitNone, Always, TestRun (
3288 "sleep for some seconds",
3290 Sleep for C<secs> seconds.");
3292 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3293 [InitNone, Always, TestOutputInt (
3294 [["part_disk"; "/dev/sda"; "mbr"];
3295 ["mkfs"; "ntfs"; "/dev/sda1"];
3296 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3297 InitNone, Always, TestOutputInt (
3298 [["part_disk"; "/dev/sda"; "mbr"];
3299 ["mkfs"; "ext2"; "/dev/sda1"];
3300 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3301 "probe NTFS volume",
3303 This command runs the L<ntfs-3g.probe(8)> command which probes
3304 an NTFS C<device> for mountability. (Not all NTFS volumes can
3305 be mounted read-write, and some cannot be mounted at all).
3307 C<rw> is a boolean flag. Set it to true if you want to test
3308 if the volume can be mounted read-write. Set it to false if
3309 you want to test if the volume can be mounted read-only.
3311 The return value is an integer which C<0> if the operation
3312 would succeed, or some non-zero value documented in the
3313 L<ntfs-3g.probe(8)> manual page.");
3315 ("sh", (RString "output", [String "command"], []), 111, [],
3316 [], (* XXX needs tests *)
3317 "run a command via the shell",
3319 This call runs a command from the guest filesystem via the
3322 This is like C<guestfs_command>, but passes the command to:
3324 /bin/sh -c \"command\"
3326 Depending on the guest's shell, this usually results in
3327 wildcards being expanded, shell expressions being interpolated
3330 All the provisos about C<guestfs_command> apply to this call.");
3332 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3333 [], (* XXX needs tests *)
3334 "run a command via the shell returning lines",
3336 This is the same as C<guestfs_sh>, but splits the result
3337 into a list of lines.
3339 See also: C<guestfs_command_lines>");
3341 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3342 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3343 * code in stubs.c, since all valid glob patterns must start with "/".
3344 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3346 [InitScratchFS, Always, TestOutputList (
3347 [["mkdir_p"; "/glob_expand/b/c"];
3348 ["touch"; "/glob_expand/b/c/d"];
3349 ["touch"; "/glob_expand/b/c/e"];
3350 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3351 InitScratchFS, Always, TestOutputList (
3352 [["mkdir_p"; "/glob_expand2/b/c"];
3353 ["touch"; "/glob_expand2/b/c/d"];
3354 ["touch"; "/glob_expand2/b/c/e"];
3355 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3356 InitScratchFS, Always, TestOutputList (
3357 [["mkdir_p"; "/glob_expand3/b/c"];
3358 ["touch"; "/glob_expand3/b/c/d"];
3359 ["touch"; "/glob_expand3/b/c/e"];
3360 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3361 "expand a wildcard path",
3363 This command searches for all the pathnames matching
3364 C<pattern> according to the wildcard expansion rules
3367 If no paths match, then this returns an empty list
3368 (note: not an error).
3370 It is just a wrapper around the C L<glob(3)> function
3371 with flags C<GLOB_MARK|GLOB_BRACE>.
3372 See that manual page for more details.");
3374 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3375 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3376 [["scrub_device"; "/dev/sdc"]])],
3377 "scrub (securely wipe) a device",
3379 This command writes patterns over C<device> to make data retrieval
3382 It is an interface to the L<scrub(1)> program. See that
3383 manual page for more details.");
3385 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3386 [InitScratchFS, Always, TestRun (
3387 [["write"; "/scrub_file"; "content"];
3388 ["scrub_file"; "/scrub_file"]])],
3389 "scrub (securely wipe) a file",
3391 This command writes patterns over a file to make data retrieval
3394 The file is I<removed> after scrubbing.
3396 It is an interface to the L<scrub(1)> program. See that
3397 manual page for more details.");
3399 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3400 [], (* XXX needs testing *)
3401 "scrub (securely wipe) free space",
3403 This command creates the directory C<dir> and then fills it
3404 with files until the filesystem is full, and scrubs the files
3405 as for C<guestfs_scrub_file>, and deletes them.
3406 The intention is to scrub any free space on the partition
3409 It is an interface to the L<scrub(1)> program. See that
3410 manual page for more details.");
3412 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3413 [InitScratchFS, Always, TestRun (
3414 [["mkdir"; "/mkdtemp"];
3415 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3416 "create a temporary directory",
3418 This command creates a temporary directory. The
3419 C<template> parameter should be a full pathname for the
3420 temporary directory name with the final six characters being
3423 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3424 the second one being suitable for Windows filesystems.
3426 The name of the temporary directory that was created
3429 The temporary directory is created with mode 0700
3430 and is owned by root.
3432 The caller is responsible for deleting the temporary
3433 directory and its contents after use.
3435 See also: L<mkdtemp(3)>");
3437 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3438 [InitISOFS, Always, TestOutputInt (
3439 [["wc_l"; "/10klines"]], 10000);
3440 (* Test for RHBZ#579608, absolute symbolic links. *)
3441 InitISOFS, Always, TestOutputInt (
3442 [["wc_l"; "/abssymlink"]], 10000)],
3443 "count lines in a file",
3445 This command counts the lines in a file, using the
3446 C<wc -l> external command.");
3448 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3449 [InitISOFS, Always, TestOutputInt (
3450 [["wc_w"; "/10klines"]], 10000)],
3451 "count words in a file",
3453 This command counts the words in a file, using the
3454 C<wc -w> external command.");
3456 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3457 [InitISOFS, Always, TestOutputInt (
3458 [["wc_c"; "/100kallspaces"]], 102400)],
3459 "count characters in a file",
3461 This command counts the characters in a file, using the
3462 C<wc -c> external command.");
3464 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3465 [InitISOFS, Always, TestOutputList (
3466 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3467 (* Test for RHBZ#579608, absolute symbolic links. *)
3468 InitISOFS, Always, TestOutputList (
3469 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3470 "return first 10 lines of a file",
3472 This command returns up to the first 10 lines of a file as
3473 a list of strings.");
3475 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3476 [InitISOFS, Always, TestOutputList (
3477 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3478 InitISOFS, Always, TestOutputList (
3479 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3480 InitISOFS, Always, TestOutputList (
3481 [["head_n"; "0"; "/10klines"]], [])],
3482 "return first N lines of a file",
3484 If the parameter C<nrlines> is a positive number, this returns the first
3485 C<nrlines> lines of the file C<path>.
3487 If the parameter C<nrlines> is a negative number, this returns lines
3488 from the file C<path>, excluding the last C<nrlines> lines.
3490 If the parameter C<nrlines> is zero, this returns an empty list.");
3492 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3493 [InitISOFS, Always, TestOutputList (
3494 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3495 "return last 10 lines of a file",
3497 This command returns up to the last 10 lines of a file as
3498 a list of strings.");
3500 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3501 [InitISOFS, Always, TestOutputList (
3502 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3503 InitISOFS, Always, TestOutputList (
3504 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3505 InitISOFS, Always, TestOutputList (
3506 [["tail_n"; "0"; "/10klines"]], [])],
3507 "return last N lines of a file",
3509 If the parameter C<nrlines> is a positive number, this returns the last
3510 C<nrlines> lines of the file C<path>.
3512 If the parameter C<nrlines> is a negative number, this returns lines
3513 from the file C<path>, starting with the C<-nrlines>th line.
3515 If the parameter C<nrlines> is zero, this returns an empty list.");
3517 ("df", (RString "output", [], []), 125, [],
3518 [], (* XXX Tricky to test because it depends on the exact format
3519 * of the 'df' command and other imponderables.
3521 "report file system disk space usage",
3523 This command runs the C<df> command to report disk space used.
3525 This command is mostly useful for interactive sessions. It
3526 is I<not> intended that you try to parse the output string.
3527 Use C<guestfs_statvfs> from programs.");
3529 ("df_h", (RString "output", [], []), 126, [],
3530 [], (* XXX Tricky to test because it depends on the exact format
3531 * of the 'df' command and other imponderables.
3533 "report file system disk space usage (human readable)",
3535 This command runs the C<df -h> command to report disk space used
3536 in human-readable format.
3538 This command is mostly useful for interactive sessions. It
3539 is I<not> intended that you try to parse the output string.
3540 Use C<guestfs_statvfs> from programs.");
3542 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3543 [InitISOFS, Always, TestOutputInt (
3544 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3545 "estimate file space usage",
3547 This command runs the C<du -s> command to estimate file space
3550 C<path> can be a file or a directory. If C<path> is a directory
3551 then the estimate includes the contents of the directory and all
3552 subdirectories (recursively).
3554 The result is the estimated size in I<kilobytes>
3555 (ie. units of 1024 bytes).");
3557 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3558 [InitISOFS, Always, TestOutputList (
3559 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3560 "list files in an initrd",
3562 This command lists out files contained in an initrd.
3564 The files are listed without any initial C</> character. The
3565 files are listed in the order they appear (not necessarily
3566 alphabetical). Directory names are listed as separate items.
3568 Old Linux kernels (2.4 and earlier) used a compressed ext2
3569 filesystem as initrd. We I<only> support the newer initramfs
3570 format (compressed cpio files).");
3572 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3574 "mount a file using the loop device",
3576 This command lets you mount C<file> (a filesystem image
3577 in a file) on a mount point. It is entirely equivalent to
3578 the command C<mount -o loop file mountpoint>.");
3580 ("mkswap", (RErr, [Device "device"], []), 130, [],
3581 [InitEmpty, Always, TestRun (
3582 [["part_disk"; "/dev/sda"; "mbr"];
3583 ["mkswap"; "/dev/sda1"]])],
3584 "create a swap partition",
3586 Create a swap partition on C<device>.");
3588 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3589 [InitEmpty, Always, TestRun (
3590 [["part_disk"; "/dev/sda"; "mbr"];
3591 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3592 "create a swap partition with a label",
3594 Create a swap partition on C<device> with label C<label>.
3596 Note that you cannot attach a swap label to a block device
3597 (eg. C</dev/sda>), just to a partition. This appears to be
3598 a limitation of the kernel or swap tools.");
3600 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3601 (let uuid = uuidgen () in
3602 [InitEmpty, Always, TestRun (
3603 [["part_disk"; "/dev/sda"; "mbr"];
3604 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3605 "create a swap partition with an explicit UUID",
3607 Create a swap partition on C<device> with UUID C<uuid>.");
3609 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3610 [InitScratchFS, Always, TestOutputStruct (
3611 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3612 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3613 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3614 InitScratchFS, Always, TestOutputStruct (
3615 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3616 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3617 "make block, character or FIFO devices",
3619 This call creates block or character special devices, or
3620 named pipes (FIFOs).
3622 The C<mode> parameter should be the mode, using the standard
3623 constants. C<devmajor> and C<devminor> are the
3624 device major and minor numbers, only used when creating block
3625 and character special devices.
3627 Note that, just like L<mknod(2)>, the mode must be bitwise
3628 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3629 just creates a regular file). These constants are
3630 available in the standard Linux header files, or you can use
3631 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3632 which are wrappers around this command which bitwise OR
3633 in the appropriate constant for you.
3635 The mode actually set is affected by the umask.");
3637 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3638 [InitScratchFS, Always, TestOutputStruct (
3639 [["mkfifo"; "0o777"; "/mkfifo"];
3640 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3641 "make FIFO (named pipe)",
3643 This call creates a FIFO (named pipe) called C<path> with
3644 mode C<mode>. It is just a convenient wrapper around
3647 The mode actually set is affected by the umask.");
3649 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3650 [InitScratchFS, Always, TestOutputStruct (
3651 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3652 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3653 "make block device node",
3655 This call creates a block device node called C<path> with
3656 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3657 It is just a convenient wrapper around C<guestfs_mknod>.
3659 The mode actually set is affected by the umask.");
3661 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3662 [InitScratchFS, Always, TestOutputStruct (
3663 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3664 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3665 "make char device node",
3667 This call creates a char device node called C<path> with
3668 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3669 It is just a convenient wrapper around C<guestfs_mknod>.
3671 The mode actually set is affected by the umask.");
3673 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3674 [InitEmpty, Always, TestOutputInt (
3675 [["umask"; "0o22"]], 0o22)],
3676 "set file mode creation mask (umask)",
3678 This function sets the mask used for creating new files and
3679 device nodes to C<mask & 0777>.
3681 Typical umask values would be C<022> which creates new files
3682 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3683 C<002> which creates new files with permissions like
3684 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3686 The default umask is C<022>. This is important because it
3687 means that directories and device nodes will be created with
3688 C<0644> or C<0755> mode even if you specify C<0777>.
3690 See also C<guestfs_get_umask>,
3691 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3693 This call returns the previous umask.");
3695 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3697 "read directories entries",
3699 This returns the list of directory entries in directory C<dir>.
3701 All entries in the directory are returned, including C<.> and
3702 C<..>. The entries are I<not> sorted, but returned in the same
3703 order as the underlying filesystem.
3705 Also this call returns basic file type information about each
3706 file. The C<ftyp> field will contain one of the following characters:
3744 The L<readdir(3)> call returned a C<d_type> field with an
3749 This function is primarily intended for use by programs. To
3750 get a simple list of names, use C<guestfs_ls>. To get a printable
3751 directory for human consumption, use C<guestfs_ll>.");
3753 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3755 "create partitions on a block device",
3757 This is a simplified interface to the C<guestfs_sfdisk>
3758 command, where partition sizes are specified in megabytes
3759 only (rounded to the nearest cylinder) and you don't need
3760 to specify the cyls, heads and sectors parameters which
3761 were rarely if ever used anyway.
3763 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3764 and C<guestfs_part_disk>");
3766 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3768 "determine file type inside a compressed file",
3770 This command runs C<file> after first decompressing C<path>
3773 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3775 Since 1.0.63, use C<guestfs_file> instead which can now
3776 process compressed files.");
3778 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3780 "list extended attributes of a file or directory",
3782 This call lists the extended attributes of the file or directory
3785 At the system call level, this is a combination of the
3786 L<listxattr(2)> and L<getxattr(2)> calls.
3788 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3790 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3792 "list extended attributes of a file or directory",
3794 This is the same as C<guestfs_getxattrs>, but if C<path>
3795 is a symbolic link, then it returns the extended attributes
3796 of the link itself.");
3798 ("setxattr", (RErr, [String "xattr";
3799 String "val"; Int "vallen"; (* will be BufferIn *)
3800 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3802 "set extended attribute of a file or directory",
3804 This call sets the extended attribute named C<xattr>
3805 of the file C<path> to the value C<val> (of length C<vallen>).
3806 The value is arbitrary 8 bit data.
3808 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3810 ("lsetxattr", (RErr, [String "xattr";
3811 String "val"; Int "vallen"; (* will be BufferIn *)
3812 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3814 "set extended attribute of a file or directory",
3816 This is the same as C<guestfs_setxattr>, but if C<path>
3817 is a symbolic link, then it sets an extended attribute
3818 of the link itself.");
3820 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3822 "remove extended attribute of a file or directory",
3824 This call removes the extended attribute named C<xattr>
3825 of the file C<path>.
3827 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3829 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3831 "remove extended attribute of a file or directory",
3833 This is the same as C<guestfs_removexattr>, but if C<path>
3834 is a symbolic link, then it removes an extended attribute
3835 of the link itself.");
3837 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3841 This call is similar to C<guestfs_mounts>. That call returns
3842 a list of devices. This one returns a hash table (map) of
3843 device name to directory where the device is mounted.");
3845 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3846 (* This is a special case: while you would expect a parameter
3847 * of type "Pathname", that doesn't work, because it implies
3848 * NEED_ROOT in the generated calling code in stubs.c, and
3849 * this function cannot use NEED_ROOT.
3852 "create a mountpoint",
3854 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3855 specialized calls that can be used to create extra mountpoints
3856 before mounting the first filesystem.
3858 These calls are I<only> necessary in some very limited circumstances,
3859 mainly the case where you want to mount a mix of unrelated and/or
3860 read-only filesystems together.
3862 For example, live CDs often contain a \"Russian doll\" nest of
3863 filesystems, an ISO outer layer, with a squashfs image inside, with
3864 an ext2/3 image inside that. You can unpack this as follows
3867 add-ro Fedora-11-i686-Live.iso
3871 mkmountpoint /ext3fs
3873 mount-loop /cd/LiveOS/squashfs.img /sqsh
3874 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3876 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3878 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3879 You may get unexpected errors if you try to mix these calls. It is
3880 safest to manually unmount filesystems and remove mountpoints after use.
3882 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3883 longest first, so for this to work for manual mountpoints, you
3884 must ensure that the innermost mountpoints have the longest
3885 pathnames, as in the example code above.
3887 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3889 Autosync [see C<guestfs_set_autosync>, this is set by default on
3890 handles] can cause C<guestfs_umount_all> to be called when the handle
3891 is closed which can also trigger these issues.");
3893 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3895 "remove a mountpoint",
3897 This calls removes a mountpoint that was previously created
3898 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3899 for full details.");
3901 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3902 [InitISOFS, Always, TestOutputBuffer (
3903 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3904 (* Test various near large, large and too large files (RHBZ#589039). *)
3905 InitScratchFS, Always, TestLastFail (
3906 [["touch"; "/read_file"];
3907 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3908 ["read_file"; "/read_file"]]);
3909 InitScratchFS, Always, TestLastFail (
3910 [["touch"; "/read_file2"];
3911 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3912 ["read_file"; "/read_file2"]]);
3913 InitScratchFS, Always, TestLastFail (
3914 [["touch"; "/read_file3"];
3915 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3916 ["read_file"; "/read_file3"]])],
3919 This calls returns the contents of the file C<path> as a
3922 Unlike C<guestfs_cat>, this function can correctly
3923 handle files that contain embedded ASCII NUL characters.
3924 However unlike C<guestfs_download>, this function is limited
3925 in the total size of file that can be handled.");
3927 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3928 [InitISOFS, Always, TestOutputList (
3929 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3930 InitISOFS, Always, TestOutputList (
3931 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3932 (* Test for RHBZ#579608, absolute symbolic links. *)
3933 InitISOFS, Always, TestOutputList (
3934 [["grep"; "nomatch"; "/abssymlink"]], [])],
3935 "return lines matching a pattern",
3937 This calls the external C<grep> program and returns the
3940 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3941 [InitISOFS, Always, TestOutputList (
3942 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3943 "return lines matching a pattern",
3945 This calls the external C<egrep> program and returns the
3948 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3949 [InitISOFS, Always, TestOutputList (
3950 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3951 "return lines matching a pattern",
3953 This calls the external C<fgrep> program and returns the
3956 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3957 [InitISOFS, Always, TestOutputList (
3958 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3959 "return lines matching a pattern",
3961 This calls the external C<grep -i> program and returns the
3964 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3965 [InitISOFS, Always, TestOutputList (
3966 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3967 "return lines matching a pattern",
3969 This calls the external C<egrep -i> program and returns the
3972 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3973 [InitISOFS, Always, TestOutputList (
3974 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3975 "return lines matching a pattern",
3977 This calls the external C<fgrep -i> program and returns the
3980 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3981 [InitISOFS, Always, TestOutputList (
3982 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3983 "return lines matching a pattern",
3985 This calls the external C<zgrep> program and returns the
3988 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3989 [InitISOFS, Always, TestOutputList (
3990 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3991 "return lines matching a pattern",
3993 This calls the external C<zegrep> program and returns the
3996 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3997 [InitISOFS, Always, TestOutputList (
3998 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3999 "return lines matching a pattern",
4001 This calls the external C<zfgrep> program and returns the
4004 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4005 [InitISOFS, Always, TestOutputList (
4006 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4007 "return lines matching a pattern",
4009 This calls the external C<zgrep -i> program and returns the
4012 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4013 [InitISOFS, Always, TestOutputList (
4014 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4015 "return lines matching a pattern",
4017 This calls the external C<zegrep -i> program and returns the
4020 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4021 [InitISOFS, Always, TestOutputList (
4022 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4023 "return lines matching a pattern",
4025 This calls the external C<zfgrep -i> program and returns the
4028 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4029 [InitISOFS, Always, TestOutput (
4030 [["realpath"; "/../directory"]], "/directory")],
4031 "canonicalized absolute pathname",
4033 Return the canonicalized absolute pathname of C<path>. The
4034 returned path has no C<.>, C<..> or symbolic link path elements.");
4036 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4037 [InitScratchFS, Always, TestOutputStruct (
4040 ["ln"; "/ln/a"; "/ln/b"];
4041 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4042 "create a hard link",
4044 This command creates a hard link using the C<ln> command.");
4046 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4047 [InitScratchFS, Always, TestOutputStruct (
4048 [["mkdir"; "/ln_f"];
4049 ["touch"; "/ln_f/a"];
4050 ["touch"; "/ln_f/b"];
4051 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4052 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4053 "create a hard link",
4055 This command creates a hard link using the C<ln -f> command.
4056 The C<-f> option removes the link (C<linkname>) if it exists already.");
4058 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4059 [InitScratchFS, Always, TestOutputStruct (
4060 [["mkdir"; "/ln_s"];
4061 ["touch"; "/ln_s/a"];
4062 ["ln_s"; "a"; "/ln_s/b"];
4063 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4064 "create a symbolic link",
4066 This command creates a symbolic link using the C<ln -s> command.");
4068 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4069 [InitScratchFS, Always, TestOutput (
4070 [["mkdir_p"; "/ln_sf/b"];
4071 ["touch"; "/ln_sf/b/c"];
4072 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4073 ["readlink"; "/ln_sf/b/c"]], "../d")],
4074 "create a symbolic link",
4076 This command creates a symbolic link using the C<ln -sf> command,
4077 The C<-f> option removes the link (C<linkname>) if it exists already.");
4079 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4080 [] (* XXX tested above *),
4081 "read the target of a symbolic link",
4083 This command reads the target of a symbolic link.");
4085 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4086 [InitScratchFS, Always, TestOutputStruct (
4087 [["fallocate"; "/fallocate"; "1000000"];
4088 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4089 "preallocate a file in the guest filesystem",
4091 This command preallocates a file (containing zero bytes) named
4092 C<path> of size C<len> bytes. If the file exists already, it
4095 Do not confuse this with the guestfish-specific
4096 C<alloc> command which allocates a file in the host and
4097 attaches it as a device.");
4099 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4100 [InitPartition, Always, TestRun (
4101 [["mkswap"; "/dev/sda1"];
4102 ["swapon_device"; "/dev/sda1"];
4103 ["swapoff_device"; "/dev/sda1"]])],
4104 "enable swap on device",
4106 This command enables the libguestfs appliance to use the
4107 swap device or partition named C<device>. The increased
4108 memory is made available for all commands, for example
4109 those run using C<guestfs_command> or C<guestfs_sh>.
4111 Note that you should not swap to existing guest swap
4112 partitions unless you know what you are doing. They may
4113 contain hibernation information, or other information that
4114 the guest doesn't want you to trash. You also risk leaking
4115 information about the host to the guest this way. Instead,
4116 attach a new host device to the guest and swap on that.");
4118 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4119 [], (* XXX tested by swapon_device *)
4120 "disable swap on device",
4122 This command disables the libguestfs appliance swap
4123 device or partition named C<device>.
4124 See C<guestfs_swapon_device>.");
4126 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4127 [InitScratchFS, Always, TestRun (
4128 [["fallocate"; "/swapon_file"; "8388608"];
4129 ["mkswap_file"; "/swapon_file"];
4130 ["swapon_file"; "/swapon_file"];
4131 ["swapoff_file"; "/swapon_file"];
4132 ["rm"; "/swapon_file"]])],
4133 "enable swap on file",
4135 This command enables swap to a file.
4136 See C<guestfs_swapon_device> for other notes.");
4138 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4139 [], (* XXX tested by swapon_file *)
4140 "disable swap on file",
4142 This command disables the libguestfs appliance swap on file.");
4144 ("swapon_label", (RErr, [String "label"], []), 174, [],
4145 [InitEmpty, Always, TestRun (
4146 [["part_disk"; "/dev/sda"; "mbr"];
4147 ["mkswap_L"; "swapit"; "/dev/sda1"];
4148 ["swapon_label"; "swapit"];
4149 ["swapoff_label"; "swapit"];
4150 ["zero"; "/dev/sda"];
4151 ["blockdev_rereadpt"; "/dev/sda"]])],
4152 "enable swap on labeled swap partition",
4154 This command enables swap to a labeled swap partition.
4155 See C<guestfs_swapon_device> for other notes.");
4157 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4158 [], (* XXX tested by swapon_label *)
4159 "disable swap on labeled swap partition",
4161 This command disables the libguestfs appliance swap on
4162 labeled swap partition.");
4164 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4165 (let uuid = uuidgen () in
4166 [InitEmpty, Always, TestRun (
4167 [["mkswap_U"; uuid; "/dev/sdc"];
4168 ["swapon_uuid"; uuid];
4169 ["swapoff_uuid"; uuid]])]),
4170 "enable swap on swap partition by UUID",
4172 This command enables swap to a swap partition with the given UUID.
4173 See C<guestfs_swapon_device> for other notes.");
4175 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4176 [], (* XXX tested by swapon_uuid *)
4177 "disable swap on swap partition by UUID",
4179 This command disables the libguestfs appliance swap partition
4180 with the given UUID.");
4182 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4183 [InitScratchFS, Always, TestRun (
4184 [["fallocate"; "/mkswap_file"; "8388608"];
4185 ["mkswap_file"; "/mkswap_file"];
4186 ["rm"; "/mkswap_file"]])],
4187 "create a swap file",
4191 This command just writes a swap file signature to an existing
4192 file. To create the file itself, use something like C<guestfs_fallocate>.");
4194 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4195 [InitISOFS, Always, TestRun (
4196 [["inotify_init"; "0"]])],
4197 "create an inotify handle",
4199 This command creates a new inotify handle.
4200 The inotify subsystem can be used to notify events which happen to
4201 objects in the guest filesystem.
4203 C<maxevents> is the maximum number of events which will be
4204 queued up between calls to C<guestfs_inotify_read> or
4205 C<guestfs_inotify_files>.
4206 If this is passed as C<0>, then the kernel (or previously set)
4207 default is used. For Linux 2.6.29 the default was 16384 events.
4208 Beyond this limit, the kernel throws away events, but records
4209 the fact that it threw them away by setting a flag
4210 C<IN_Q_OVERFLOW> in the returned structure list (see
4211 C<guestfs_inotify_read>).
4213 Before any events are generated, you have to add some
4214 watches to the internal watch list. See:
4215 C<guestfs_inotify_add_watch>,
4216 C<guestfs_inotify_rm_watch> and
4217 C<guestfs_inotify_watch_all>.
4219 Queued up events should be read periodically by calling
4220 C<guestfs_inotify_read>
4221 (or C<guestfs_inotify_files> which is just a helpful
4222 wrapper around C<guestfs_inotify_read>). If you don't
4223 read the events out often enough then you risk the internal
4226 The handle should be closed after use by calling
4227 C<guestfs_inotify_close>. This also removes any
4228 watches automatically.
4230 See also L<inotify(7)> for an overview of the inotify interface
4231 as exposed by the Linux kernel, which is roughly what we expose
4232 via libguestfs. Note that there is one global inotify handle
4233 per libguestfs instance.");
4235 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4236 [InitScratchFS, Always, TestOutputList (
4237 [["mkdir"; "/inotify_add_watch"];
4238 ["inotify_init"; "0"];
4239 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4240 ["touch"; "/inotify_add_watch/a"];
4241 ["touch"; "/inotify_add_watch/b"];
4242 ["inotify_files"]], ["a"; "b"])],
4243 "add an inotify watch",
4245 Watch C<path> for the events listed in C<mask>.
4247 Note that if C<path> is a directory then events within that
4248 directory are watched, but this does I<not> happen recursively
4249 (in subdirectories).
4251 Note for non-C or non-Linux callers: the inotify events are
4252 defined by the Linux kernel ABI and are listed in
4253 C</usr/include/sys/inotify.h>.");
4255 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4257 "remove an inotify watch",
4259 Remove a previously defined inotify watch.
4260 See C<guestfs_inotify_add_watch>.");
4262 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4264 "return list of inotify events",
4266 Return the complete queue of events that have happened
4267 since the previous read call.
4269 If no events have happened, this returns an empty list.
4271 I<Note>: In order to make sure that all events have been
4272 read, you must call this function repeatedly until it
4273 returns an empty list. The reason is that the call will
4274 read events up to the maximum appliance-to-host message
4275 size and leave remaining events in the queue.");
4277 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4279 "return list of watched files that had events",
4281 This function is a helpful wrapper around C<guestfs_inotify_read>
4282 which just returns a list of pathnames of objects that were
4283 touched. The returned pathnames are sorted and deduplicated.");
4285 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4287 "close the inotify handle",
4289 This closes the inotify handle which was previously
4290 opened by inotify_init. It removes all watches, throws
4291 away any pending events, and deallocates all resources.");
4293 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4295 "set SELinux security context",
4297 This sets the SELinux security context of the daemon
4298 to the string C<context>.
4300 See the documentation about SELINUX in L<guestfs(3)>.");
4302 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4304 "get SELinux security context",
4306 This gets the SELinux security context of the daemon.
4308 See the documentation about SELINUX in L<guestfs(3)>,
4309 and C<guestfs_setcon>");
4311 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4312 [InitEmpty, Always, TestOutput (
4313 [["part_disk"; "/dev/sda"; "mbr"];
4314 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4315 ["mount_options"; ""; "/dev/sda1"; "/"];
4316 ["write"; "/new"; "new file contents"];
4317 ["cat"; "/new"]], "new file contents");
4318 InitEmpty, Always, TestRun (
4319 [["part_disk"; "/dev/sda"; "mbr"];
4320 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4321 InitEmpty, Always, TestLastFail (
4322 [["part_disk"; "/dev/sda"; "mbr"];
4323 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4324 InitEmpty, Always, TestLastFail (
4325 [["part_disk"; "/dev/sda"; "mbr"];
4326 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4327 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4328 [["part_disk"; "/dev/sda"; "mbr"];
4329 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4330 "make a filesystem with block size",
4332 This call is similar to C<guestfs_mkfs>, but it allows you to
4333 control the block size of the resulting filesystem. Supported
4334 block sizes depend on the filesystem type, but typically they
4335 are C<1024>, C<2048> or C<4096> only.
4337 For VFAT and NTFS the C<blocksize> parameter is treated as
4338 the requested cluster size.");
4340 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4341 [InitEmpty, Always, TestOutput (
4342 [["part_init"; "/dev/sda"; "mbr"];
4343 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4344 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4345 ["mke2journal"; "4096"; "/dev/sda1"];
4346 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4347 ["mount_options"; ""; "/dev/sda2"; "/"];
4348 ["write"; "/new"; "new file contents"];
4349 ["cat"; "/new"]], "new file contents")],
4350 "make ext2/3/4 external journal",
4352 This creates an ext2 external journal on C<device>. It is equivalent
4355 mke2fs -O journal_dev -b blocksize device");
4357 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4358 [InitEmpty, Always, TestOutput (
4359 [["part_init"; "/dev/sda"; "mbr"];
4360 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4361 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4362 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4363 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4364 ["mount_options"; ""; "/dev/sda2"; "/"];
4365 ["write"; "/new"; "new file contents"];
4366 ["cat"; "/new"]], "new file contents")],
4367 "make ext2/3/4 external journal with label",
4369 This creates an ext2 external journal on C<device> with label C<label>.");
4371 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4372 (let uuid = uuidgen () in
4373 [InitEmpty, Always, TestOutput (
4374 [["part_init"; "/dev/sda"; "mbr"];
4375 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4376 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4377 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4378 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4379 ["mount_options"; ""; "/dev/sda2"; "/"];
4380 ["write"; "/new"; "new file contents"];
4381 ["cat"; "/new"]], "new file contents")]),
4382 "make ext2/3/4 external journal with UUID",
4384 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4386 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4388 "make ext2/3/4 filesystem with external journal",
4390 This creates an ext2/3/4 filesystem on C<device> with
4391 an external journal on C<journal>. It is equivalent
4394 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4396 See also C<guestfs_mke2journal>.");
4398 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4400 "make ext2/3/4 filesystem with external journal",
4402 This creates an ext2/3/4 filesystem on C<device> with
4403 an external journal on the journal labeled C<label>.
4405 See also C<guestfs_mke2journal_L>.");
4407 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4409 "make ext2/3/4 filesystem with external journal",
4411 This creates an ext2/3/4 filesystem on C<device> with
4412 an external journal on the journal with UUID C<uuid>.
4414 See also C<guestfs_mke2journal_U>.");
4416 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4417 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4418 "load a kernel module",
4420 This loads a kernel module in the appliance.
4422 The kernel module must have been whitelisted when libguestfs
4423 was built (see C<appliance/kmod.whitelist.in> in the source).");
4425 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4426 [InitNone, Always, TestOutput (
4427 [["echo_daemon"; "This is a test"]], "This is a test"
4429 "echo arguments back to the client",
4431 This command concatenates the list of C<words> passed with single spaces
4432 between them and returns the resulting string.
4434 You can use this command to test the connection through to the daemon.
4436 See also C<guestfs_ping_daemon>.");
4438 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4439 [], (* There is a regression test for this. *)
4440 "find all files and directories, returning NUL-separated list",
4442 This command lists out all files and directories, recursively,
4443 starting at C<directory>, placing the resulting list in the
4444 external file called C<files>.
4446 This command works the same way as C<guestfs_find> with the
4447 following exceptions:
4453 The resulting list is written to an external file.
4457 Items (filenames) in the result are separated
4458 by C<\\0> characters. See L<find(1)> option I<-print0>.
4462 This command is not limited in the number of names that it
4467 The result list is not sorted.
4471 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4472 [InitISOFS, Always, TestOutput (
4473 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4474 InitISOFS, Always, TestOutput (
4475 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4476 InitISOFS, Always, TestOutput (
4477 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4478 InitISOFS, Always, TestLastFail (
4479 [["case_sensitive_path"; "/Known-1/"]]);
4480 InitScratchFS, Always, TestOutput (
4481 [["mkdir"; "/case_sensitive_path"];
4482 ["mkdir"; "/case_sensitive_path/bbb"];
4483 ["touch"; "/case_sensitive_path/bbb/c"];
4484 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4485 InitScratchFS, Always, TestOutput (
4486 [["mkdir"; "/case_sensitive_path2"];
4487 ["mkdir"; "/case_sensitive_path2/bbb"];
4488 ["touch"; "/case_sensitive_path2/bbb/c"];
4489 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4490 InitScratchFS, Always, TestLastFail (
4491 [["mkdir"; "/case_sensitive_path3"];
4492 ["mkdir"; "/case_sensitive_path3/bbb"];
4493 ["touch"; "/case_sensitive_path3/bbb/c"];
4494 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4495 "return true path on case-insensitive filesystem",
4497 This can be used to resolve case insensitive paths on
4498 a filesystem which is case sensitive. The use case is
4499 to resolve paths which you have read from Windows configuration
4500 files or the Windows Registry, to the true path.
4502 The command handles a peculiarity of the Linux ntfs-3g
4503 filesystem driver (and probably others), which is that although
4504 the underlying filesystem is case-insensitive, the driver
4505 exports the filesystem to Linux as case-sensitive.
4507 One consequence of this is that special directories such
4508 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4509 (or other things) depending on the precise details of how
4510 they were created. In Windows itself this would not be
4513 Bug or feature? You decide:
4514 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4516 This function resolves the true case of each element in the
4517 path and returns the case-sensitive path.
4519 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4520 might return C<\"/WINDOWS/system32\"> (the exact return value
4521 would depend on details of how the directories were originally
4522 created under Windows).
4525 This function does not handle drive names, backslashes etc.
4527 See also C<guestfs_realpath>.");
4529 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4530 [InitScratchFS, Always, TestOutput (
4531 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4532 "get the Linux VFS type corresponding to a mounted device",
4534 This command gets the filesystem type corresponding to
4535 the filesystem on C<device>.
4537 For most filesystems, the result is the name of the Linux
4538 VFS module which would be used to mount this filesystem
4539 if you mounted it without specifying the filesystem type.
4540 For example a string such as C<ext3> or C<ntfs>.");
4542 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4543 [InitScratchFS, Always, TestOutputStruct (
4544 [["write"; "/truncate"; "some stuff so size is not zero"];
4545 ["truncate"; "/truncate"];
4546 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4547 "truncate a file to zero size",
4549 This command truncates C<path> to a zero-length file. The
4550 file must exist already.");
4552 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4553 [InitScratchFS, Always, TestOutputStruct (
4554 [["touch"; "/truncate_size"];
4555 ["truncate_size"; "/truncate_size"; "1000"];
4556 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4557 "truncate a file to a particular size",
4559 This command truncates C<path> to size C<size> bytes. The file
4562 If the current file size is less than C<size> then
4563 the file is extended to the required size with zero bytes.
4564 This creates a sparse file (ie. disk blocks are not allocated
4565 for the file until you write to it). To create a non-sparse
4566 file of zeroes, use C<guestfs_fallocate64> instead.");
4568 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4569 [InitScratchFS, Always, TestOutputStruct (
4570 [["touch"; "/utimens"];
4571 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4572 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4573 "set timestamp of a file with nanosecond precision",
4575 This command sets the timestamps of a file with nanosecond
4578 C<atsecs, atnsecs> are the last access time (atime) in secs and
4579 nanoseconds from the epoch.
4581 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4582 secs and nanoseconds from the epoch.
4584 If the C<*nsecs> field contains the special value C<-1> then
4585 the corresponding timestamp is set to the current time. (The
4586 C<*secs> field is ignored in this case).
4588 If the C<*nsecs> field contains the special value C<-2> then
4589 the corresponding timestamp is left unchanged. (The
4590 C<*secs> field is ignored in this case).");
4592 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4593 [InitScratchFS, Always, TestOutputStruct (
4594 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4595 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4596 "create a directory with a particular mode",
4598 This command creates a directory, setting the initial permissions
4599 of the directory to C<mode>.
4601 For common Linux filesystems, the actual mode which is set will
4602 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4603 interpret the mode in other ways.
4605 See also C<guestfs_mkdir>, C<guestfs_umask>");
4607 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4609 "change file owner and group",
4611 Change the file owner to C<owner> and group to C<group>.
4612 This is like C<guestfs_chown> but if C<path> is a symlink then
4613 the link itself is changed, not the target.
4615 Only numeric uid and gid are supported. If you want to use
4616 names, you will need to locate and parse the password file
4617 yourself (Augeas support makes this relatively easy).");
4619 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4621 "lstat on multiple files",
4623 This call allows you to perform the C<guestfs_lstat> operation
4624 on multiple files, where all files are in the directory C<path>.
4625 C<names> is the list of files from this directory.
4627 On return you get a list of stat structs, with a one-to-one
4628 correspondence to the C<names> list. If any name did not exist
4629 or could not be lstat'd, then the C<ino> field of that structure
4632 This call is intended for programs that want to efficiently
4633 list a directory contents without making many round-trips.
4634 See also C<guestfs_lxattrlist> for a similarly efficient call
4635 for getting extended attributes. Very long directory listings
4636 might cause the protocol message size to be exceeded, causing
4637 this call to fail. The caller must split up such requests
4638 into smaller groups of names.");
4640 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4642 "lgetxattr on multiple files",
4644 This call allows you to get the extended attributes
4645 of multiple files, where all files are in the directory C<path>.
4646 C<names> is the list of files from this directory.
4648 On return you get a flat list of xattr structs which must be
4649 interpreted sequentially. The first xattr struct always has a zero-length
4650 C<attrname>. C<attrval> in this struct is zero-length
4651 to indicate there was an error doing C<lgetxattr> for this
4652 file, I<or> is a C string which is a decimal number
4653 (the number of following attributes for this file, which could
4654 be C<\"0\">). Then after the first xattr struct are the
4655 zero or more attributes for the first named file.
4656 This repeats for the second and subsequent files.
4658 This call is intended for programs that want to efficiently
4659 list a directory contents without making many round-trips.
4660 See also C<guestfs_lstatlist> for a similarly efficient call
4661 for getting standard stats. Very long directory listings
4662 might cause the protocol message size to be exceeded, causing
4663 this call to fail. The caller must split up such requests
4664 into smaller groups of names.");
4666 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4668 "readlink on multiple files",
4670 This call allows you to do a C<readlink> operation
4671 on multiple files, where all files are in the directory C<path>.
4672 C<names> is the list of files from this directory.
4674 On return you get a list of strings, with a one-to-one
4675 correspondence to the C<names> list. Each string is the
4676 value of the symbolic link.
4678 If the C<readlink(2)> operation fails on any name, then
4679 the corresponding result string is the empty string C<\"\">.
4680 However the whole operation is completed even if there
4681 were C<readlink(2)> errors, and so you can call this
4682 function with names where you don't know if they are
4683 symbolic links already (albeit slightly less efficient).
4685 This call is intended for programs that want to efficiently
4686 list a directory contents without making many round-trips.
4687 Very long directory listings might cause the protocol
4688 message size to be exceeded, causing
4689 this call to fail. The caller must split up such requests
4690 into smaller groups of names.");
4692 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4693 [InitISOFS, Always, TestOutputBuffer (
4694 [["pread"; "/known-4"; "1"; "3"]], "\n");
4695 InitISOFS, Always, TestOutputBuffer (
4696 [["pread"; "/empty"; "0"; "100"]], "")],
4697 "read part of a file",
4699 This command lets you read part of a file. It reads C<count>
4700 bytes of the file, starting at C<offset>, from file C<path>.
4702 This may read fewer bytes than requested. For further details
4703 see the L<pread(2)> system call.
4705 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4707 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4708 [InitEmpty, Always, TestRun (
4709 [["part_init"; "/dev/sda"; "gpt"]])],
4710 "create an empty partition table",
4712 This creates an empty partition table on C<device> of one of the
4713 partition types listed below. Usually C<parttype> should be
4714 either C<msdos> or C<gpt> (for large disks).
4716 Initially there are no partitions. Following this, you should
4717 call C<guestfs_part_add> for each partition required.
4719 Possible values for C<parttype> are:
4723 =item B<efi> | B<gpt>
4725 Intel EFI / GPT partition table.
4727 This is recommended for >= 2 TB partitions that will be accessed
4728 from Linux and Intel-based Mac OS X. It also has limited backwards
4729 compatibility with the C<mbr> format.
4731 =item B<mbr> | B<msdos>
4733 The standard PC \"Master Boot Record\" (MBR) format used
4734 by MS-DOS and Windows. This partition type will B<only> work
4735 for device sizes up to 2 TB. For large disks we recommend
4740 Other partition table types that may work but are not
4749 =item B<amiga> | B<rdb>
4751 Amiga \"Rigid Disk Block\" format.
4759 DASD, used on IBM mainframes.
4767 Old Mac partition format. Modern Macs use C<gpt>.
4771 NEC PC-98 format, common in Japan apparently.
4779 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4780 [InitEmpty, Always, TestRun (
4781 [["part_init"; "/dev/sda"; "mbr"];
4782 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4783 InitEmpty, Always, TestRun (
4784 [["part_init"; "/dev/sda"; "gpt"];
4785 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4786 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4787 InitEmpty, Always, TestRun (
4788 [["part_init"; "/dev/sda"; "mbr"];
4789 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4790 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4791 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4792 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4793 "add a partition to the device",
4795 This command adds a partition to C<device>. If there is no partition
4796 table on the device, call C<guestfs_part_init> first.
4798 The C<prlogex> parameter is the type of partition. Normally you
4799 should pass C<p> or C<primary> here, but MBR partition tables also
4800 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4803 C<startsect> and C<endsect> are the start and end of the partition
4804 in I<sectors>. C<endsect> may be negative, which means it counts
4805 backwards from the end of the disk (C<-1> is the last sector).
4807 Creating a partition which covers the whole disk is not so easy.
4808 Use C<guestfs_part_disk> to do that.");
4810 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4811 [InitEmpty, Always, TestRun (
4812 [["part_disk"; "/dev/sda"; "mbr"]]);
4813 InitEmpty, Always, TestRun (
4814 [["part_disk"; "/dev/sda"; "gpt"]])],
4815 "partition whole disk with a single primary partition",
4817 This command is simply a combination of C<guestfs_part_init>
4818 followed by C<guestfs_part_add> to create a single primary partition
4819 covering the whole disk.
4821 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4822 but other possible values are described in C<guestfs_part_init>.");
4824 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4825 [InitEmpty, Always, TestRun (
4826 [["part_disk"; "/dev/sda"; "mbr"];
4827 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4828 "make a partition bootable",
4830 This sets the bootable flag on partition numbered C<partnum> on
4831 device C<device>. Note that partitions are numbered from 1.
4833 The bootable flag is used by some operating systems (notably
4834 Windows) to determine which partition to boot from. It is by
4835 no means universally recognized.");
4837 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4838 [InitEmpty, Always, TestRun (
4839 [["part_disk"; "/dev/sda"; "gpt"];
4840 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4841 "set partition name",
4843 This sets the partition name on partition numbered C<partnum> on
4844 device C<device>. Note that partitions are numbered from 1.
4846 The partition name can only be set on certain types of partition
4847 table. This works on C<gpt> but not on C<mbr> partitions.");
4849 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4850 [], (* XXX Add a regression test for this. *)
4851 "list partitions on a device",
4853 This command parses the partition table on C<device> and
4854 returns the list of partitions found.
4856 The fields in the returned structure are:
4862 Partition number, counting from 1.
4866 Start of the partition I<in bytes>. To get sectors you have to
4867 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4871 End of the partition in bytes.
4875 Size of the partition in bytes.
4879 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4880 [InitEmpty, Always, TestOutput (
4881 [["part_disk"; "/dev/sda"; "gpt"];
4882 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4883 "get the partition table type",
4885 This command examines the partition table on C<device> and
4886 returns the partition table type (format) being used.
4888 Common return values include: C<msdos> (a DOS/Windows style MBR
4889 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4890 values are possible, although unusual. See C<guestfs_part_init>
4893 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4894 [InitScratchFS, Always, TestOutputBuffer (
4895 [["fill"; "0x63"; "10"; "/fill"];
4896 ["read_file"; "/fill"]], "cccccccccc")],
4897 "fill a file with octets",
4899 This command creates a new file called C<path>. The initial
4900 content of the file is C<len> octets of C<c>, where C<c>
4901 must be a number in the range C<[0..255]>.
4903 To fill a file with zero bytes (sparsely), it is
4904 much more efficient to use C<guestfs_truncate_size>.
4905 To create a file with a pattern of repeating bytes
4906 use C<guestfs_fill_pattern>.");
4908 ("available", (RErr, [StringList "groups"], []), 216, [],
4909 [InitNone, Always, TestRun [["available"; ""]]],
4910 "test availability of some parts of the API",
4912 This command is used to check the availability of some
4913 groups of functionality in the appliance, which not all builds of
4914 the libguestfs appliance will be able to provide.
4916 The libguestfs groups, and the functions that those
4917 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4918 You can also fetch this list at runtime by calling
4919 C<guestfs_available_all_groups>.
4921 The argument C<groups> is a list of group names, eg:
4922 C<[\"inotify\", \"augeas\"]> would check for the availability of
4923 the Linux inotify functions and Augeas (configuration file
4926 The command returns no error if I<all> requested groups are available.
4928 It fails with an error if one or more of the requested
4929 groups is unavailable in the appliance.
4931 If an unknown group name is included in the
4932 list of groups then an error is always returned.
4940 You must call C<guestfs_launch> before calling this function.
4942 The reason is because we don't know what groups are
4943 supported by the appliance/daemon until it is running and can
4948 If a group of functions is available, this does not necessarily
4949 mean that they will work. You still have to check for errors
4950 when calling individual API functions even if they are
4955 It is usually the job of distro packagers to build
4956 complete functionality into the libguestfs appliance.
4957 Upstream libguestfs, if built from source with all
4958 requirements satisfied, will support everything.
4962 This call was added in version C<1.0.80>. In previous
4963 versions of libguestfs all you could do would be to speculatively
4964 execute a command to find out if the daemon implemented it.
4965 See also C<guestfs_version>.
4969 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4970 [InitScratchFS, Always, TestOutputBuffer (
4972 ["write"; "/dd/src"; "hello, world"];
4973 ["dd"; "/dd/src"; "/dd/dest"];
4974 ["read_file"; "/dd/dest"]], "hello, world")],
4975 "copy from source to destination using dd",
4977 This command copies from one source device or file C<src>
4978 to another destination device or file C<dest>. Normally you
4979 would use this to copy to or from a device or partition, for
4980 example to duplicate a filesystem.
4982 If the destination is a device, it must be as large or larger
4983 than the source file or device, otherwise the copy will fail.
4984 This command cannot do partial copies (see C<guestfs_copy_size>).");
4986 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4987 [InitScratchFS, Always, TestOutputInt (
4988 [["write"; "/filesize"; "hello, world"];
4989 ["filesize"; "/filesize"]], 12)],
4990 "return the size of the file in bytes",
4992 This command returns the size of C<file> in bytes.
4994 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4995 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4996 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4998 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4999 [InitBasicFSonLVM, Always, TestOutputList (
5000 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5001 ["lvs"]], ["/dev/VG/LV2"])],
5002 "rename an LVM logical volume",
5004 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5006 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5007 [InitBasicFSonLVM, Always, TestOutputList (
5009 ["vg_activate"; "false"; "VG"];
5010 ["vgrename"; "VG"; "VG2"];
5011 ["vg_activate"; "true"; "VG2"];
5012 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5013 ["vgs"]], ["VG2"])],
5014 "rename an LVM volume group",
5016 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5018 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5019 [InitISOFS, Always, TestOutputBuffer (
5020 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5021 "list the contents of a single file in an initrd",
5023 This command unpacks the file C<filename> from the initrd file
5024 called C<initrdpath>. The filename must be given I<without> the
5025 initial C</> character.
5027 For example, in guestfish you could use the following command
5028 to examine the boot script (usually called C</init>)
5029 contained in a Linux initrd or initramfs image:
5031 initrd-cat /boot/initrd-<version>.img init
5033 See also C<guestfs_initrd_list>.");
5035 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5037 "get the UUID of a physical volume",
5039 This command returns the UUID of the LVM PV C<device>.");
5041 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5043 "get the UUID of a volume group",
5045 This command returns the UUID of the LVM VG named C<vgname>.");
5047 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5049 "get the UUID of a logical volume",
5051 This command returns the UUID of the LVM LV C<device>.");
5053 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5055 "get the PV UUIDs containing the volume group",
5057 Given a VG called C<vgname>, this returns the UUIDs of all
5058 the physical volumes that this volume group resides on.
5060 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5061 calls to associate physical volumes and volume groups.
5063 See also C<guestfs_vglvuuids>.");
5065 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5067 "get the LV UUIDs of all LVs in the volume group",
5069 Given a VG called C<vgname>, this returns the UUIDs of all
5070 the logical volumes created in this volume group.
5072 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5073 calls to associate logical volumes and volume groups.
5075 See also C<guestfs_vgpvuuids>.");
5077 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5078 [InitScratchFS, Always, TestOutputBuffer (
5079 [["mkdir"; "/copy_size"];
5080 ["write"; "/copy_size/src"; "hello, world"];
5081 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5082 ["read_file"; "/copy_size/dest"]], "hello")],
5083 "copy size bytes from source to destination using dd",
5085 This command copies exactly C<size> bytes from one source device
5086 or file C<src> to another destination device or file C<dest>.
5088 Note this will fail if the source is too short or if the destination
5089 is not large enough.");
5091 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5092 [InitBasicFSonLVM, Always, TestRun (
5093 [["zero_device"; "/dev/VG/LV"]])],
5094 "write zeroes to an entire device",
5096 This command writes zeroes over the entire C<device>. Compare
5097 with C<guestfs_zero> which just zeroes the first few blocks of
5100 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5101 [InitScratchFS, Always, TestOutput (
5102 [["mkdir"; "/txz_in"];
5103 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5104 ["cat"; "/txz_in/hello"]], "hello\n")],
5105 "unpack compressed tarball to directory",
5107 This command uploads and unpacks local file C<tarball> (an
5108 I<xz compressed> tar file) into C<directory>.");
5110 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5112 "pack directory into compressed tarball",
5114 This command packs the contents of C<directory> and downloads
5115 it to local file C<tarball> (as an xz compressed tar archive).");
5117 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5119 "resize an NTFS filesystem",
5121 This command resizes an NTFS filesystem, expanding or
5122 shrinking it to the size of the underlying device.
5123 See also L<ntfsresize(8)>.");
5125 ("vgscan", (RErr, [], []), 232, [],
5126 [InitEmpty, Always, TestRun (
5128 "rescan for LVM physical volumes, volume groups and logical volumes",
5130 This rescans all block devices and rebuilds the list of LVM
5131 physical volumes, volume groups and logical volumes.");
5133 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5134 [InitEmpty, Always, TestRun (
5135 [["part_init"; "/dev/sda"; "mbr"];
5136 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5137 ["part_del"; "/dev/sda"; "1"]])],
5138 "delete a partition",
5140 This command deletes the partition numbered C<partnum> on C<device>.
5142 Note that in the case of MBR partitioning, deleting an
5143 extended partition also deletes any logical partitions
5146 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5147 [InitEmpty, Always, TestOutputTrue (
5148 [["part_init"; "/dev/sda"; "mbr"];
5149 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5150 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5151 ["part_get_bootable"; "/dev/sda"; "1"]])],
5152 "return true if a partition is bootable",
5154 This command returns true if the partition C<partnum> on
5155 C<device> has the bootable flag set.
5157 See also C<guestfs_part_set_bootable>.");
5159 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5160 [InitEmpty, Always, TestOutputInt (
5161 [["part_init"; "/dev/sda"; "mbr"];
5162 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5163 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5164 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5165 "get the MBR type byte (ID byte) from a partition",
5167 Returns the MBR type byte (also known as the ID byte) from
5168 the numbered partition C<partnum>.
5170 Note that only MBR (old DOS-style) partitions have type bytes.
5171 You will get undefined results for other partition table
5172 types (see C<guestfs_part_get_parttype>).");
5174 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5175 [], (* tested by part_get_mbr_id *)
5176 "set the MBR type byte (ID byte) of a partition",
5178 Sets the MBR type byte (also known as the ID byte) of
5179 the numbered partition C<partnum> to C<idbyte>. Note
5180 that the type bytes quoted in most documentation are
5181 in fact hexadecimal numbers, but usually documented
5182 without any leading \"0x\" which might be confusing.
5184 Note that only MBR (old DOS-style) partitions have type bytes.
5185 You will get undefined results for other partition table
5186 types (see C<guestfs_part_get_parttype>).");
5188 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5189 [InitISOFS, Always, TestOutputFileMD5 (
5190 [["checksum_device"; "md5"; "/dev/sdd"]],
5191 "../images/test.iso")],
5192 "compute MD5, SHAx or CRC checksum of the contents of a device",
5194 This call computes the MD5, SHAx or CRC checksum of the
5195 contents of the device named C<device>. For the types of
5196 checksums supported see the C<guestfs_checksum> command.");
5198 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5199 [InitNone, Always, TestRun (
5200 [["part_disk"; "/dev/sda"; "mbr"];
5201 ["pvcreate"; "/dev/sda1"];
5202 ["vgcreate"; "VG"; "/dev/sda1"];
5203 ["lvcreate"; "LV"; "VG"; "10"];
5204 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5205 "expand an LV to fill free space",
5207 This expands an existing logical volume C<lv> so that it fills
5208 C<pc>% of the remaining free space in the volume group. Commonly
5209 you would call this with pc = 100 which expands the logical volume
5210 as much as possible, using all remaining free space in the volume
5213 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5214 [], (* XXX Augeas code needs tests. *)
5215 "clear Augeas path",
5217 Set the value associated with C<path> to C<NULL>. This
5218 is the same as the L<augtool(1)> C<clear> command.");
5220 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5221 [InitEmpty, Always, TestOutputInt (
5222 [["get_umask"]], 0o22)],
5223 "get the current umask",
5225 Return the current umask. By default the umask is C<022>
5226 unless it has been set by calling C<guestfs_umask>.");
5228 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5230 "upload a file to the appliance (internal use only)",
5232 The C<guestfs_debug_upload> command uploads a file to
5233 the libguestfs appliance.
5235 There is no comprehensive help for this command. You have
5236 to look at the file C<daemon/debug.c> in the libguestfs source
5237 to find out what it is for.");
5239 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5240 [InitScratchFS, Always, TestOutput (
5241 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5242 ["cat"; "/base64_in"]], "hello\n")],
5243 "upload base64-encoded data to file",
5245 This command uploads base64-encoded data from C<base64file>
5248 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5250 "download file and encode as base64",
5252 This command downloads the contents of C<filename>, writing
5253 it out to local file C<base64file> encoded as base64.");
5255 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5257 "compute MD5, SHAx or CRC checksum of files in a directory",
5259 This command computes the checksums of all regular files in
5260 C<directory> and then emits a list of those checksums to
5261 the local output file C<sumsfile>.
5263 This can be used for verifying the integrity of a virtual
5264 machine. However to be properly secure you should pay
5265 attention to the output of the checksum command (it uses
5266 the ones from GNU coreutils). In particular when the
5267 filename is not printable, coreutils uses a special
5268 backslash syntax. For more information, see the GNU
5269 coreutils info file.");
5271 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5272 [InitScratchFS, Always, TestOutputBuffer (
5273 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5274 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5275 "fill a file with a repeating pattern of bytes",
5277 This function is like C<guestfs_fill> except that it creates
5278 a new file of length C<len> containing the repeating pattern
5279 of bytes in C<pattern>. The pattern is truncated if necessary
5280 to ensure the length of the file is exactly C<len> bytes.");
5282 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5283 [InitScratchFS, Always, TestOutput (
5284 [["write"; "/write"; "new file contents"];
5285 ["cat"; "/write"]], "new file contents");
5286 InitScratchFS, Always, TestOutput (
5287 [["write"; "/write2"; "\nnew file contents\n"];
5288 ["cat"; "/write2"]], "\nnew file contents\n");
5289 InitScratchFS, Always, TestOutput (
5290 [["write"; "/write3"; "\n\n"];
5291 ["cat"; "/write3"]], "\n\n");
5292 InitScratchFS, Always, TestOutput (
5293 [["write"; "/write4"; ""];
5294 ["cat"; "/write4"]], "");
5295 InitScratchFS, Always, TestOutput (
5296 [["write"; "/write5"; "\n\n\n"];
5297 ["cat"; "/write5"]], "\n\n\n");
5298 InitScratchFS, Always, TestOutput (
5299 [["write"; "/write6"; "\n"];
5300 ["cat"; "/write6"]], "\n")],
5301 "create a new file",
5303 This call creates a file called C<path>. The content of the
5304 file is the string C<content> (which can contain any 8 bit data).");
5306 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5307 [InitScratchFS, Always, TestOutput (
5308 [["write"; "/pwrite"; "new file contents"];
5309 ["pwrite"; "/pwrite"; "data"; "4"];
5310 ["cat"; "/pwrite"]], "new data contents");
5311 InitScratchFS, Always, TestOutput (
5312 [["write"; "/pwrite2"; "new file contents"];
5313 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5314 ["cat"; "/pwrite2"]], "new file is extended");
5315 InitScratchFS, Always, TestOutput (
5316 [["write"; "/pwrite3"; "new file contents"];
5317 ["pwrite"; "/pwrite3"; ""; "4"];
5318 ["cat"; "/pwrite3"]], "new file contents")],
5319 "write to part of a file",
5321 This command writes to part of a file. It writes the data
5322 buffer C<content> to the file C<path> starting at offset C<offset>.
5324 This command implements the L<pwrite(2)> system call, and like
5325 that system call it may not write the full data requested. The
5326 return value is the number of bytes that were actually written
5327 to the file. This could even be 0, although short writes are
5328 unlikely for regular files in ordinary circumstances.
5330 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5332 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5334 "resize an ext2, ext3 or ext4 filesystem (with size)",
5336 This command is the same as C<guestfs_resize2fs> except that it
5337 allows you to specify the new size (in bytes) explicitly.");
5339 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5341 "resize an LVM physical volume (with size)",
5343 This command is the same as C<guestfs_pvresize> except that it
5344 allows you to specify the new size (in bytes) explicitly.");
5346 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5348 "resize an NTFS filesystem (with size)",
5350 This command is the same as C<guestfs_ntfsresize> except that it
5351 allows you to specify the new size (in bytes) explicitly.");
5353 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5354 [InitNone, Always, TestRun [["available_all_groups"]]],
5355 "return a list of all optional groups",
5357 This command returns a list of all optional groups that this
5358 daemon knows about. Note this returns both supported and unsupported
5359 groups. To find out which ones the daemon can actually support
5360 you have to call C<guestfs_available> on each member of the
5363 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5365 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5366 [InitScratchFS, Always, TestOutputStruct (
5367 [["fallocate64"; "/fallocate64"; "1000000"];
5368 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5369 "preallocate a file in the guest filesystem",
5371 This command preallocates a file (containing zero bytes) named
5372 C<path> of size C<len> bytes. If the file exists already, it
5375 Note that this call allocates disk blocks for the file.
5376 To create a sparse file use C<guestfs_truncate_size> instead.
5378 The deprecated call C<guestfs_fallocate> does the same,
5379 but owing to an oversight it only allowed 30 bit lengths
5380 to be specified, effectively limiting the maximum size
5381 of files created through that call to 1GB.
5383 Do not confuse this with the guestfish-specific
5384 C<alloc> and C<sparse> commands which create
5385 a file in the host and attach it as a device.");
5387 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5388 [InitBasicFS, Always, TestOutput (
5389 [["set_e2label"; "/dev/sda1"; "LTEST"];
5390 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5391 "get the filesystem label",
5393 This returns the filesystem label of the filesystem on
5396 If the filesystem is unlabeled, this returns the empty string.
5398 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5400 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5401 (let uuid = uuidgen () in
5402 [InitBasicFS, Always, TestOutput (
5403 [["set_e2uuid"; "/dev/sda1"; uuid];
5404 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5405 "get the filesystem UUID",
5407 This returns the filesystem UUID of the filesystem on
5410 If the filesystem does not have a UUID, this returns the empty string.
5412 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5414 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5415 (* Can't be tested with the current framework because
5416 * the VG is being used by the mounted filesystem, so
5417 * the vgchange -an command we do first will fail.
5420 "set LVM device filter",
5422 This sets the LVM device filter so that LVM will only be
5423 able to \"see\" the block devices in the list C<devices>,
5424 and will ignore all other attached block devices.
5426 Where disk image(s) contain duplicate PVs or VGs, this
5427 command is useful to get LVM to ignore the duplicates, otherwise
5428 LVM can get confused. Note also there are two types
5429 of duplication possible: either cloned PVs/VGs which have
5430 identical UUIDs; or VGs that are not cloned but just happen
5431 to have the same name. In normal operation you cannot
5432 create this situation, but you can do it outside LVM, eg.
5433 by cloning disk images or by bit twiddling inside the LVM
5436 This command also clears the LVM cache and performs a volume
5439 You can filter whole block devices or individual partitions.
5441 You cannot use this if any VG is currently in use (eg.
5442 contains a mounted filesystem), even if you are not
5443 filtering out that VG.");
5445 ("lvm_clear_filter", (RErr, [], []), 256, [],
5446 [], (* see note on lvm_set_filter *)
5447 "clear LVM device filter",
5449 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5450 will be able to see every block device.
5452 This command also clears the LVM cache and performs a volume
5455 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5457 "open a LUKS-encrypted block device",
5459 This command opens a block device which has been encrypted
5460 according to the Linux Unified Key Setup (LUKS) standard.
5462 C<device> is the encrypted block device or partition.
5464 The caller must supply one of the keys associated with the
5465 LUKS block device, in the C<key> parameter.
5467 This creates a new block device called C</dev/mapper/mapname>.
5468 Reads and writes to this block device are decrypted from and
5469 encrypted to the underlying C<device> respectively.
5471 If this block device contains LVM volume groups, then
5472 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5473 will make them visible.");
5475 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5477 "open a LUKS-encrypted block device read-only",
5479 This is the same as C<guestfs_luks_open> except that a read-only
5480 mapping is created.");
5482 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5484 "close a LUKS device",
5486 This closes a LUKS device that was created earlier by
5487 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5488 C<device> parameter must be the name of the LUKS mapping
5489 device (ie. C</dev/mapper/mapname>) and I<not> the name
5490 of the underlying block device.");
5492 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5494 "format a block device as a LUKS encrypted device",
5496 This command erases existing data on C<device> and formats
5497 the device as a LUKS encrypted device. C<key> is the
5498 initial key, which is added to key slot C<slot>. (LUKS
5499 supports 8 key slots, numbered 0-7).");
5501 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5503 "format a block device as a LUKS encrypted device",
5505 This command is the same as C<guestfs_luks_format> but
5506 it also allows you to set the C<cipher> used.");
5508 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5510 "add a key on a LUKS encrypted device",
5512 This command adds a new key on LUKS device C<device>.
5513 C<key> is any existing key, and is used to access the device.
5514 C<newkey> is the new key to add. C<keyslot> is the key slot
5515 that will be replaced.
5517 Note that if C<keyslot> already contains a key, then this
5518 command will fail. You have to use C<guestfs_luks_kill_slot>
5519 first to remove that key.");
5521 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5523 "remove a key from a LUKS encrypted device",
5525 This command deletes the key in key slot C<keyslot> from the
5526 encrypted LUKS device C<device>. C<key> must be one of the
5529 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5530 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5531 [["is_lv"; "/dev/VG/LV"]]);
5532 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5533 [["is_lv"; "/dev/sda1"]])],
5534 "test if device is a logical volume",
5536 This command tests whether C<device> is a logical volume, and
5537 returns true iff this is the case.");
5539 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5541 "find a filesystem by UUID",
5543 This command searches the filesystems and returns the one
5544 which has the given UUID. An error is returned if no such
5545 filesystem can be found.
5547 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5549 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5551 "find a filesystem by label",
5553 This command searches the filesystems and returns the one
5554 which has the given label. An error is returned if no such
5555 filesystem can be found.
5557 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5559 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5560 [InitISOFS, Always, TestOutputFalse (
5561 [["is_chardev"; "/directory"]]);
5562 InitScratchFS, Always, TestOutputTrue (
5563 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5564 ["is_chardev"; "/is_chardev"]])],
5565 "test if character device",
5567 This returns C<true> if and only if there is a character device
5568 with the given C<path> name.
5570 See also C<guestfs_stat>.");
5572 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5573 [InitISOFS, Always, TestOutputFalse (
5574 [["is_blockdev"; "/directory"]]);
5575 InitScratchFS, Always, TestOutputTrue (
5576 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5577 ["is_blockdev"; "/is_blockdev"]])],
5578 "test if block device",
5580 This returns C<true> if and only if there is a block device
5581 with the given C<path> name.
5583 See also C<guestfs_stat>.");
5585 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5586 [InitISOFS, Always, TestOutputFalse (
5587 [["is_fifo"; "/directory"]]);
5588 InitScratchFS, Always, TestOutputTrue (
5589 [["mkfifo"; "0o777"; "/is_fifo"];
5590 ["is_fifo"; "/is_fifo"]])],
5591 "test if FIFO (named pipe)",
5593 This returns C<true> if and only if there is a FIFO (named pipe)
5594 with the given C<path> name.
5596 See also C<guestfs_stat>.");
5598 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5599 [InitISOFS, Always, TestOutputFalse (
5600 [["is_symlink"; "/directory"]]);
5601 InitISOFS, Always, TestOutputTrue (
5602 [["is_symlink"; "/abssymlink"]])],
5603 "test if symbolic link",
5605 This returns C<true> if and only if there is a symbolic link
5606 with the given C<path> name.
5608 See also C<guestfs_stat>.");
5610 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5611 (* XXX Need a positive test for sockets. *)
5612 [InitISOFS, Always, TestOutputFalse (
5613 [["is_socket"; "/directory"]])],
5616 This returns C<true> if and only if there is a Unix domain socket
5617 with the given C<path> name.
5619 See also C<guestfs_stat>.");
5621 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5622 [InitPartition, Always, TestOutputDevice (
5623 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5624 InitEmpty, Always, TestLastFail (
5625 [["part_to_dev"; "/dev/sda"]])],
5626 "convert partition name to device name",
5628 This function takes a partition name (eg. \"/dev/sdb1\") and
5629 removes the partition number, returning the device name
5632 The named partition must exist, for example as a string returned
5633 from C<guestfs_list_partitions>.");
5635 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5636 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5637 [InitScratchFS, Always, TestOutput (
5638 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5639 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5640 "upload a file from the local machine with offset",
5642 Upload local file C<filename> to C<remotefilename> on the
5645 C<remotefilename> is overwritten starting at the byte C<offset>
5646 specified. The intention is to overwrite parts of existing
5647 files or devices, although if a non-existant file is specified
5648 then it is created with a \"hole\" before C<offset>. The
5649 size of the data written is implicit in the size of the
5652 Note that there is no limit on the amount of data that
5653 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5654 and this call always writes the full amount unless an
5657 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5659 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5660 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5661 let offset = string_of_int 100 in
5662 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5663 [InitScratchFS, Always, TestOutput (
5664 (* Pick a file from cwd which isn't likely to change. *)
5665 [["mkdir"; "/download_offset"];
5666 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5667 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5668 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5669 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5670 "download a file to the local machine with offset and size",
5672 Download file C<remotefilename> and save it as C<filename>
5673 on the local machine.
5675 C<remotefilename> is read for C<size> bytes starting at C<offset>
5676 (this region must be within the file or device).
5678 Note that there is no limit on the amount of data that
5679 can be downloaded with this call, unlike with C<guestfs_pread>,
5680 and this call always reads the full amount unless an
5683 See also C<guestfs_download>, C<guestfs_pread>.");
5685 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5686 [InitPartition, Always, TestOutputListOfDevices (
5687 [["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"];
5688 ["blockdev_rereadpt"; "/dev/sda"];
5689 ["list_partitions"]], ["/dev/sdb1"])],
5690 "write to part of a device",
5692 This command writes to part of a device. It writes the data
5693 buffer C<content> to C<device> starting at offset C<offset>.
5695 This command implements the L<pwrite(2)> system call, and like
5696 that system call it may not write the full data requested
5697 (although short writes to disk devices and partitions are
5698 probably impossible with standard Linux kernels).
5700 See also C<guestfs_pwrite>.");
5702 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5703 [InitEmpty, Always, TestOutputBuffer (
5704 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5705 "read part of a device",
5707 This command lets you read part of a file. It reads C<count>
5708 bytes of C<device>, starting at C<offset>.
5710 This may read fewer bytes than requested. For further details
5711 see the L<pread(2)> system call.
5713 See also C<guestfs_pread>.");
5715 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5716 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5717 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5718 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5719 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5720 "get canonical name of an LV",
5722 This converts alternative naming schemes for LVs that you
5723 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5724 is converted to C</dev/VG/LV>.
5726 This command returns an error if the C<lvname> parameter does
5727 not refer to a logical volume.
5729 See also C<guestfs_is_lv>.");
5731 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5732 [InitEmpty, Always, TestOutput (
5733 [["part_disk"; "/dev/sda"; "mbr"];
5734 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5735 ["mount_options"; ""; "/dev/sda1"; "/"];
5736 ["write"; "/new"; "new file contents"];
5737 ["cat"; "/new"]], "new file contents")],
5738 "make a filesystem",
5740 This function creates a filesystem on C<device>. The filesystem
5741 type is C<fstype>, for example C<ext3>.
5743 The optional arguments are:
5749 The filesystem block size. Supported block sizes depend on the
5750 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5751 for Linux ext2/3 filesystems.
5753 For VFAT and NTFS the C<blocksize> parameter is treated as
5754 the requested cluster size.
5756 For UFS block sizes, please see L<mkfs.ufs(8)>.
5760 This passes the C<-O> parameter to the external mkfs program.
5762 For certain filesystem types, this allows extra filesystem
5763 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5766 You cannot use this optional parameter with the C<gfs> or
5767 C<gfs2> filesystem type.
5771 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5773 "get a single extended attribute",
5775 Get a single extended attribute from file C<path> named C<name>.
5776 This call follows symlinks. If you want to lookup an extended
5777 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5779 Normally it is better to get all extended attributes from a file
5780 in one go by calling C<guestfs_getxattrs>. However some Linux
5781 filesystem implementations are buggy and do not provide a way to
5782 list out attributes. For these filesystems (notably ntfs-3g)
5783 you have to know the names of the extended attributes you want
5784 in advance and call this function.
5786 Extended attribute values are blobs of binary data. If there
5787 is no extended attribute named C<name>, this returns an error.
5789 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5791 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5793 "get a single extended attribute",
5795 Get a single extended attribute from file C<path> named C<name>.
5796 If C<path> is a symlink, then this call returns an extended
5797 attribute from the symlink.
5799 Normally it is better to get all extended attributes from a file
5800 in one go by calling C<guestfs_getxattrs>. However some Linux
5801 filesystem implementations are buggy and do not provide a way to
5802 list out attributes. For these filesystems (notably ntfs-3g)
5803 you have to know the names of the extended attributes you want
5804 in advance and call this function.
5806 Extended attribute values are blobs of binary data. If there
5807 is no extended attribute named C<name>, this returns an error.
5809 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5811 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5813 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5815 This command is the same as C<guestfs_resize2fs>, but the filesystem
5816 is resized to its minimum size. This works like the C<-M> option
5817 to the C<resize2fs> command.
5819 To get the resulting size of the filesystem you should call
5820 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5821 values. These two numbers, multiplied together, give the
5822 resulting size of the minimal filesystem in bytes.");
5824 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5826 "internal autosync operation",
5828 This command performs the autosync operation just before the
5829 handle is closed. You should not call this command directly.
5830 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5831 control whether or not this operation is performed when the
5832 handle is closed.");
5836 let all_functions = non_daemon_functions @ daemon_functions
5838 (* In some places we want the functions to be displayed sorted
5839 * alphabetically, so this is useful:
5841 let all_functions_sorted = List.sort action_compare all_functions
5843 (* This is used to generate the src/MAX_PROC_NR file which
5844 * contains the maximum procedure number, a surrogate for the
5845 * ABI version number. See src/Makefile.am for the details.
5848 let proc_nrs = List.map (
5849 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5850 ) daemon_functions in
5851 List.fold_left max 0 proc_nrs
5853 (* Non-API meta-commands available only in guestfish.
5855 * Note (1): style, proc_nr and tests fields are all meaningless.
5856 * The only fields which are actually used are the shortname,
5857 * FishAlias flags, shortdesc and longdesc.
5859 * Note (2): to refer to other commands, use L</shortname>.
5861 * Note (3): keep this list sorted by shortname.
5863 let fish_commands = [
5864 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5865 "allocate and add a disk file",
5866 " alloc filename size
5868 This creates an empty (zeroed) file of the given size, and then adds
5869 so it can be further examined.
5871 For more advanced image creation, see L<qemu-img(1)> utility.
5873 Size can be specified using standard suffixes, eg. C<1M>.
5875 To create a sparse file, use L</sparse> instead. To create a
5876 prepared disk image, see L</PREPARED DISK IMAGES>.");
5878 ("copy_in", (RErr,[], []), -1, [], [],
5879 "copy local files or directories into an image",
5880 " copy-in local [local ...] /remotedir
5882 C<copy-in> copies local files or directories recursively into the disk
5883 image, placing them in the directory called C</remotedir> (which must
5884 exist). This guestfish meta-command turns into a sequence of
5885 L</tar-in> and other commands as necessary.
5887 Multiple local files and directories can be specified, but the last
5888 parameter must always be a remote directory. Wildcards cannot be
5891 ("copy_out", (RErr,[], []), -1, [], [],
5892 "copy remote files or directories out of an image",
5893 " copy-out remote [remote ...] localdir
5895 C<copy-out> copies remote files or directories recursively out of the
5896 disk image, placing them on the host disk in a local directory called
5897 C<localdir> (which must exist). This guestfish meta-command turns
5898 into a sequence of L</download>, L</tar-out> and other commands as
5901 Multiple remote files and directories can be specified, but the last
5902 parameter must always be a local directory. To download to the
5903 current directory, use C<.> as in:
5907 Wildcards cannot be used in the ordinary command, but you can use
5908 them with the help of L</glob> like this:
5910 glob copy-out /home/* .");
5912 ("echo", (RErr,[], []), -1, [], [],
5913 "display a line of text",
5916 This echos the parameters to the terminal.");
5918 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5922 This is used to edit a file. It downloads the file, edits it
5923 locally using your editor, then uploads the result.
5925 The editor is C<$EDITOR>. However if you use the alternate
5926 commands C<vi> or C<emacs> you will get those corresponding
5929 ("glob", (RErr,[], []), -1, [], [],
5930 "expand wildcards in command",
5931 " glob command args...
5933 Expand wildcards in any paths in the args list, and run C<command>
5934 repeatedly on each matching path.
5936 See L</WILDCARDS AND GLOBBING>.");
5938 ("hexedit", (RErr,[], []), -1, [], [],
5939 "edit with a hex editor",
5940 " hexedit <filename|device>
5941 hexedit <filename|device> <max>
5942 hexedit <filename|device> <start> <max>
5944 Use hexedit (a hex editor) to edit all or part of a binary file
5947 This command works by downloading potentially the whole file or
5948 device, editing it locally, then uploading it. If the file or
5949 device is large, you have to specify which part you wish to edit
5950 by using C<max> and/or C<start> C<max> parameters.
5951 C<start> and C<max> are specified in bytes, with the usual
5952 modifiers allowed such as C<1M> (1 megabyte).
5954 For example to edit the first few sectors of a disk you
5959 which would allow you to edit anywhere within the first megabyte
5962 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5964 hexedit /dev/sda1 0x400 0x400
5966 (assuming the superblock is in the standard location).
5968 This command requires the external L<hexedit(1)> program. You
5969 can specify another program to use by setting the C<HEXEDITOR>
5970 environment variable.
5972 See also L</hexdump>.");
5974 ("lcd", (RErr,[], []), -1, [], [],
5975 "change working directory",
5978 Change the local directory, ie. the current directory of guestfish
5981 Note that C<!cd> won't do what you might expect.");
5983 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5987 Opens the manual page for guestfish.");
5989 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5995 This is used to view a file.
5997 The default viewer is C<$PAGER>. However if you use the alternate
5998 command C<less> you will get the C<less> command specifically.");
6000 ("reopen", (RErr,[], []), -1, [], [],
6001 "close and reopen libguestfs handle",
6004 Close and reopen the libguestfs handle. It is not necessary to use
6005 this normally, because the handle is closed properly when guestfish
6006 exits. However this is occasionally useful for testing.");
6008 ("sparse", (RErr,[], []), -1, [], [],
6009 "create a sparse disk image and add",
6010 " sparse filename size
6012 This creates an empty sparse file of the given size, and then adds
6013 so it can be further examined.
6015 In all respects it works the same as the L</alloc> command, except that
6016 the image file is allocated sparsely, which means that disk blocks are
6017 not assigned to the file until they are needed. Sparse disk files
6018 only use space when written to, but they are slower and there is a
6019 danger you could run out of real disk space during a write operation.
6021 For more advanced image creation, see L<qemu-img(1)> utility.
6023 Size can be specified using standard suffixes, eg. C<1M>.");
6025 ("supported", (RErr,[], []), -1, [], [],
6026 "list supported groups of commands",
6029 This command returns a list of the optional groups
6030 known to the daemon, and indicates which ones are
6031 supported by this build of the libguestfs appliance.
6033 See also L<guestfs(3)/AVAILABILITY>.");
6035 ("time", (RErr,[], []), -1, [], [],
6036 "print elapsed time taken to run a command",
6037 " time command args...
6039 Run the command as usual, but print the elapsed time afterwards. This
6040 can be useful for benchmarking operations.");