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"]), -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 other optional parameters are passed directly through to
1105 C<guestfs_add_drive_opts>.");
1108 This interface is not quite baked yet. -- RWMJ 2010-11-11
1109 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"]), -1, [NotInFish],
1111 "add the disk(s) from a libvirt domain",
1113 This function adds the disk(s) attached to the libvirt domain C<dom>.
1114 It works by requesting the domain XML from libvirt, parsing it for
1115 disks, and calling C<guestfs_add_drive_opts> on each one.
1117 In the C API we declare C<void *dom>, but really it has type
1118 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1120 The number of disks added is returned. This operation is atomic:
1121 if an error is returned, then no disks are added.
1123 This function does some minimal checks to make sure the libvirt
1124 domain is not running (unless C<readonly> is true). In a future
1125 version we will try to acquire the libvirt lock on each disk.
1127 Disks must be accessible locally. This often means that adding disks
1128 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1129 will fail unless those disks are accessible via the same device path
1132 The optional parameters are passed directly through to
1133 C<guestfs_add_drive_opts>.");
1136 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1138 "get package format used by the operating system",
1140 This function should only be called with a root device string
1141 as returned by C<guestfs_inspect_os>.
1143 This function and C<guestfs_inspect_get_package_management> return
1144 the package format and package management tool used by the
1145 inspected operating system. For example for Fedora these
1146 functions would return C<rpm> (package format) and
1147 C<yum> (package management).
1149 This returns the string C<unknown> if we could not determine the
1150 package format I<or> if the operating system does not have
1151 a real packaging system (eg. Windows).
1153 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1154 Future versions of libguestfs may return other strings.
1156 Please read L<guestfs(3)/INSPECTION> for more details.");
1158 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1160 "get package management tool used by the operating system",
1162 This function should only be called with a root device string
1163 as returned by C<guestfs_inspect_os>.
1165 C<guestfs_inspect_get_package_format> and this function return
1166 the package format and package management tool used by the
1167 inspected operating system. For example for Fedora these
1168 functions would return C<rpm> (package format) and
1169 C<yum> (package management).
1171 This returns the string C<unknown> if we could not determine the
1172 package management tool I<or> if the operating system does not have
1173 a real packaging system (eg. Windows).
1175 Possible strings include: C<yum>, C<up2date>,
1176 C<apt> (for all Debian derivatives),
1177 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1178 Future versions of libguestfs may return other strings.
1180 Please read L<guestfs(3)/INSPECTION> for more details.");
1182 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1184 "get list of applications installed in the operating system",
1186 This function should only be called with a root device string
1187 as returned by C<guestfs_inspect_os>.
1189 Return the list of applications installed in the operating system.
1191 I<Note:> This call works differently from other parts of the
1192 inspection API. You have to call C<guestfs_inspect_os>, then
1193 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1194 before calling this. Listing applications is a significantly
1195 more difficult operation which requires access to the full
1196 filesystem. Also note that unlike the other
1197 C<guestfs_inspect_get_*> calls which are just returning
1198 data cached in the libguestfs handle, this call actually reads
1199 parts of the mounted filesystems during the call.
1201 This returns an empty list if the inspection code was not able
1202 to determine the list of applications.
1204 The application structure contains the following fields:
1210 The name of the application. For Red Hat-derived and Debian-derived
1211 Linux guests, this is the package name.
1213 =item C<app_display_name>
1215 The display name of the application, sometimes localized to the
1216 install language of the guest operating system.
1218 If unavailable this is returned as an empty string C<\"\">.
1219 Callers needing to display something can use C<app_name> instead.
1223 For package managers which use epochs, this contains the epoch of
1224 the package (an integer). If unavailable, this is returned as C<0>.
1226 =item C<app_version>
1228 The version string of the application or package. If unavailable
1229 this is returned as an empty string C<\"\">.
1231 =item C<app_release>
1233 The release string of the application or package, for package
1234 managers that use this. If unavailable this is returned as an
1235 empty string C<\"\">.
1237 =item C<app_install_path>
1239 The installation path of the application (on operating systems
1240 such as Windows which use installation paths). This path is
1241 in the format used by the guest operating system, it is not
1244 If unavailable this is returned as an empty string C<\"\">.
1246 =item C<app_trans_path>
1248 The install path translated into a libguestfs path.
1249 If unavailable this is returned as an empty string C<\"\">.
1251 =item C<app_publisher>
1253 The name of the publisher of the application, for package
1254 managers that use this. If unavailable this is returned
1255 as an empty string C<\"\">.
1259 The URL (eg. upstream URL) of the application.
1260 If unavailable this is returned as an empty string C<\"\">.
1262 =item C<app_source_package>
1264 For packaging systems which support this, the name of the source
1265 package. If unavailable this is returned as an empty string C<\"\">.
1267 =item C<app_summary>
1269 A short (usually one line) description of the application or package.
1270 If unavailable this is returned as an empty string C<\"\">.
1272 =item C<app_description>
1274 A longer description of the application or package.
1275 If unavailable this is returned as an empty string C<\"\">.
1279 Please read L<guestfs(3)/INSPECTION> for more details.");
1281 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1283 "get hostname of the operating system",
1285 This function should only be called with a root device string
1286 as returned by C<guestfs_inspect_os>.
1288 This function returns the hostname of the operating system
1289 as found by inspection of the guest's configuration files.
1291 If the hostname could not be determined, then the
1292 string C<unknown> is returned.
1294 Please read L<guestfs(3)/INSPECTION> for more details.");
1296 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1298 "get format of inspected operating system",
1300 This function should only be called with a root device string
1301 as returned by C<guestfs_inspect_os>.
1303 This returns the format of the inspected operating system. You
1304 can use it to detect install images, live CDs and similar.
1306 Currently defined formats are:
1312 This is an installed operating system.
1316 The disk image being inspected is not an installed operating system,
1317 but a I<bootable> install disk, live CD, or similar.
1321 The format of this disk image is not known.
1325 Future versions of libguestfs may return other strings here.
1326 The caller should be prepared to handle any string.
1328 Please read L<guestfs(3)/INSPECTION> for more details.");
1330 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1332 "get live flag for install disk",
1334 This function should only be called with a root device string
1335 as returned by C<guestfs_inspect_os>.
1337 If C<guestfs_inspect_get_format> returns C<installer> (this
1338 is an install disk), then this returns true if a live image
1339 was detected on the disk.
1341 Please read L<guestfs(3)/INSPECTION> for more details.");
1343 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1345 "get netinst (network installer) flag for install disk",
1347 This function should only be called with a root device string
1348 as returned by C<guestfs_inspect_os>.
1350 If C<guestfs_inspect_get_format> returns C<installer> (this
1351 is an install disk), then this returns true if the disk is
1352 a network installer, ie. not a self-contained install CD but
1353 one which is likely to require network access to complete
1356 Please read L<guestfs(3)/INSPECTION> for more details.");
1358 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1360 "get multipart flag for install disk",
1362 This function should only be called with a root device string
1363 as returned by C<guestfs_inspect_os>.
1365 If C<guestfs_inspect_get_format> returns C<installer> (this
1366 is an install disk), then this returns true if the disk is
1369 Please read L<guestfs(3)/INSPECTION> for more details.");
1371 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1373 "set the attach method",
1375 Set the method that libguestfs uses to connect to the back end
1376 guestfsd daemon. Possible methods are:
1382 Launch an appliance and connect to it. This is the ordinary method
1385 =item C<unix:I<path>>
1387 Connect to the Unix domain socket I<path>.
1389 This method lets you connect to an existing daemon or (using
1390 virtio-serial) to a live guest.
1394 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1395 [InitNone, Always, TestOutput (
1396 [["get_attach_method"]], "appliance")],
1397 "get the attach method",
1399 Return the current attach method. See C<guestfs_set_attach_method>.");
1403 (* daemon_functions are any functions which cause some action
1404 * to take place in the daemon.
1407 let daemon_functions = [
1408 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1409 [InitEmpty, Always, TestOutput (
1410 [["part_disk"; "/dev/sda"; "mbr"];
1411 ["mkfs"; "ext2"; "/dev/sda1"];
1412 ["mount"; "/dev/sda1"; "/"];
1413 ["write"; "/new"; "new file contents"];
1414 ["cat"; "/new"]], "new file contents")],
1415 "mount a guest disk at a position in the filesystem",
1417 Mount a guest disk at a position in the filesystem. Block devices
1418 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1419 the guest. If those block devices contain partitions, they will have
1420 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1423 The rules are the same as for L<mount(2)>: A filesystem must
1424 first be mounted on C</> before others can be mounted. Other
1425 filesystems can only be mounted on directories which already
1428 The mounted filesystem is writable, if we have sufficient permissions
1429 on the underlying device.
1432 When you use this call, the filesystem options C<sync> and C<noatime>
1433 are set implicitly. This was originally done because we thought it
1434 would improve reliability, but it turns out that I<-o sync> has a
1435 very large negative performance impact and negligible effect on
1436 reliability. Therefore we recommend that you avoid using
1437 C<guestfs_mount> in any code that needs performance, and instead
1438 use C<guestfs_mount_options> (use an empty string for the first
1439 parameter if you don't want any options).");
1441 ("sync", (RErr, [], []), 2, [],
1442 [ InitEmpty, Always, TestRun [["sync"]]],
1443 "sync disks, writes are flushed through to the disk image",
1445 This syncs the disk, so that any writes are flushed through to the
1446 underlying disk image.
1448 You should always call this if you have modified a disk image, before
1449 closing the handle.");
1451 ("touch", (RErr, [Pathname "path"], []), 3, [],
1452 [InitScratchFS, Always, TestOutputTrue (
1453 [["touch"; "/touch"];
1454 ["exists"; "/touch"]])],
1455 "update file timestamps or create a new file",
1457 Touch acts like the L<touch(1)> command. It can be used to
1458 update the timestamps on a file, or, if the file does not exist,
1459 to create a new zero-length file.
1461 This command only works on regular files, and will fail on other
1462 file types such as directories, symbolic links, block special etc.");
1464 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1465 [InitISOFS, Always, TestOutput (
1466 [["cat"; "/known-2"]], "abcdef\n")],
1467 "list the contents of a file",
1469 Return the contents of the file named C<path>.
1471 Note that this function cannot correctly handle binary files
1472 (specifically, files containing C<\\0> character which is treated
1473 as end of string). For those you need to use the C<guestfs_read_file>
1474 or C<guestfs_download> functions which have a more complex interface.");
1476 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1477 [], (* XXX Tricky to test because it depends on the exact format
1478 * of the 'ls -l' command, which changes between F10 and F11.
1480 "list the files in a directory (long format)",
1482 List the files in C<directory> (relative to the root directory,
1483 there is no cwd) in the format of 'ls -la'.
1485 This command is mostly useful for interactive sessions. It
1486 is I<not> intended that you try to parse the output string.");
1488 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1489 [InitScratchFS, Always, TestOutputList (
1491 ["touch"; "/ls/new"];
1492 ["touch"; "/ls/newer"];
1493 ["touch"; "/ls/newest"];
1494 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1495 "list the files in a directory",
1497 List the files in C<directory> (relative to the root directory,
1498 there is no cwd). The '.' and '..' entries are not returned, but
1499 hidden files are shown.
1501 This command is mostly useful for interactive sessions. Programs
1502 should probably use C<guestfs_readdir> instead.");
1504 ("list_devices", (RStringList "devices", [], []), 7, [],
1505 [InitEmpty, Always, TestOutputListOfDevices (
1506 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1507 "list the block devices",
1509 List all the block devices.
1511 The full block device names are returned, eg. C</dev/sda>.
1513 See also C<guestfs_list_filesystems>.");
1515 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1516 [InitBasicFS, Always, TestOutputListOfDevices (
1517 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1518 InitEmpty, Always, TestOutputListOfDevices (
1519 [["part_init"; "/dev/sda"; "mbr"];
1520 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1521 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1522 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1523 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1524 "list the partitions",
1526 List all the partitions detected on all block devices.
1528 The full partition device names are returned, eg. C</dev/sda1>
1530 This does not return logical volumes. For that you will need to
1531 call C<guestfs_lvs>.
1533 See also C<guestfs_list_filesystems>.");
1535 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1536 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1537 [["pvs"]], ["/dev/sda1"]);
1538 InitEmpty, Always, TestOutputListOfDevices (
1539 [["part_init"; "/dev/sda"; "mbr"];
1540 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1541 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1542 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1543 ["pvcreate"; "/dev/sda1"];
1544 ["pvcreate"; "/dev/sda2"];
1545 ["pvcreate"; "/dev/sda3"];
1546 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1547 "list the LVM physical volumes (PVs)",
1549 List all the physical volumes detected. This is the equivalent
1550 of the L<pvs(8)> command.
1552 This returns a list of just the device names that contain
1553 PVs (eg. C</dev/sda2>).
1555 See also C<guestfs_pvs_full>.");
1557 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1558 [InitBasicFSonLVM, Always, TestOutputList (
1560 InitEmpty, Always, TestOutputList (
1561 [["part_init"; "/dev/sda"; "mbr"];
1562 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1563 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1564 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1565 ["pvcreate"; "/dev/sda1"];
1566 ["pvcreate"; "/dev/sda2"];
1567 ["pvcreate"; "/dev/sda3"];
1568 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1569 ["vgcreate"; "VG2"; "/dev/sda3"];
1570 ["vgs"]], ["VG1"; "VG2"])],
1571 "list the LVM volume groups (VGs)",
1573 List all the volumes groups detected. This is the equivalent
1574 of the L<vgs(8)> command.
1576 This returns a list of just the volume group names that were
1577 detected (eg. C<VolGroup00>).
1579 See also C<guestfs_vgs_full>.");
1581 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1582 [InitBasicFSonLVM, Always, TestOutputList (
1583 [["lvs"]], ["/dev/VG/LV"]);
1584 InitEmpty, Always, TestOutputList (
1585 [["part_init"; "/dev/sda"; "mbr"];
1586 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1587 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1588 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1589 ["pvcreate"; "/dev/sda1"];
1590 ["pvcreate"; "/dev/sda2"];
1591 ["pvcreate"; "/dev/sda3"];
1592 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1593 ["vgcreate"; "VG2"; "/dev/sda3"];
1594 ["lvcreate"; "LV1"; "VG1"; "50"];
1595 ["lvcreate"; "LV2"; "VG1"; "50"];
1596 ["lvcreate"; "LV3"; "VG2"; "50"];
1597 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1598 "list the LVM logical volumes (LVs)",
1600 List all the logical volumes detected. This is the equivalent
1601 of the L<lvs(8)> command.
1603 This returns a list of the logical volume device names
1604 (eg. C</dev/VolGroup00/LogVol00>).
1606 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1608 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1609 [], (* XXX how to test? *)
1610 "list the LVM physical volumes (PVs)",
1612 List all the physical volumes detected. This is the equivalent
1613 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1615 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1616 [], (* XXX how to test? *)
1617 "list the LVM volume groups (VGs)",
1619 List all the volumes groups detected. This is the equivalent
1620 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1622 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1623 [], (* XXX how to test? *)
1624 "list the LVM logical volumes (LVs)",
1626 List all the logical volumes detected. This is the equivalent
1627 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1629 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1630 [InitISOFS, Always, TestOutputList (
1631 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1632 InitISOFS, Always, TestOutputList (
1633 [["read_lines"; "/empty"]], [])],
1634 "read file as lines",
1636 Return the contents of the file named C<path>.
1638 The file contents are returned as a list of lines. Trailing
1639 C<LF> and C<CRLF> character sequences are I<not> returned.
1641 Note that this function cannot correctly handle binary files
1642 (specifically, files containing C<\\0> character which is treated
1643 as end of line). For those you need to use the C<guestfs_read_file>
1644 function which has a more complex interface.");
1646 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1647 [], (* XXX Augeas code needs tests. *)
1648 "create a new Augeas handle",
1650 Create a new Augeas handle for editing configuration files.
1651 If there was any previous Augeas handle associated with this
1652 guestfs session, then it is closed.
1654 You must call this before using any other C<guestfs_aug_*>
1657 C<root> is the filesystem root. C<root> must not be NULL,
1660 The flags are the same as the flags defined in
1661 E<lt>augeas.hE<gt>, the logical I<or> of the following
1666 =item C<AUG_SAVE_BACKUP> = 1
1668 Keep the original file with a C<.augsave> extension.
1670 =item C<AUG_SAVE_NEWFILE> = 2
1672 Save changes into a file with extension C<.augnew>, and
1673 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1675 =item C<AUG_TYPE_CHECK> = 4
1677 Typecheck lenses (can be expensive).
1679 =item C<AUG_NO_STDINC> = 8
1681 Do not use standard load path for modules.
1683 =item C<AUG_SAVE_NOOP> = 16
1685 Make save a no-op, just record what would have been changed.
1687 =item C<AUG_NO_LOAD> = 32
1689 Do not load the tree in C<guestfs_aug_init>.
1693 To close the handle, you can call C<guestfs_aug_close>.
1695 To find out more about Augeas, see L<http://augeas.net/>.");
1697 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1698 [], (* XXX Augeas code needs tests. *)
1699 "close the current Augeas handle",
1701 Close the current Augeas handle and free up any resources
1702 used by it. After calling this, you have to call
1703 C<guestfs_aug_init> again before you can use any other
1704 Augeas functions.");
1706 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1707 [], (* XXX Augeas code needs tests. *)
1708 "define an Augeas variable",
1710 Defines an Augeas variable C<name> whose value is the result
1711 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1714 On success this returns the number of nodes in C<expr>, or
1715 C<0> if C<expr> evaluates to something which is not a nodeset.");
1717 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1718 [], (* XXX Augeas code needs tests. *)
1719 "define an Augeas node",
1721 Defines a variable C<name> whose value is the result of
1724 If C<expr> evaluates to an empty nodeset, a node is created,
1725 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1726 C<name> will be the nodeset containing that single node.
1728 On success this returns a pair containing the
1729 number of nodes in the nodeset, and a boolean flag
1730 if a node was created.");
1732 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1733 [], (* XXX Augeas code needs tests. *)
1734 "look up the value of an Augeas path",
1736 Look up the value associated with C<path>. If C<path>
1737 matches exactly one node, the C<value> is returned.");
1739 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1740 [], (* XXX Augeas code needs tests. *)
1741 "set Augeas path to value",
1743 Set the value associated with C<path> to C<val>.
1745 In the Augeas API, it is possible to clear a node by setting
1746 the value to NULL. Due to an oversight in the libguestfs API
1747 you cannot do that with this call. Instead you must use the
1748 C<guestfs_aug_clear> call.");
1750 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1751 [], (* XXX Augeas code needs tests. *)
1752 "insert a sibling Augeas node",
1754 Create a new sibling C<label> for C<path>, inserting it into
1755 the tree before or after C<path> (depending on the boolean
1758 C<path> must match exactly one existing node in the tree, and
1759 C<label> must be a label, ie. not contain C</>, C<*> or end
1760 with a bracketed index C<[N]>.");
1762 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1763 [], (* XXX Augeas code needs tests. *)
1764 "remove an Augeas path",
1766 Remove C<path> and all of its children.
1768 On success this returns the number of entries which were removed.");
1770 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1771 [], (* XXX Augeas code needs tests. *)
1774 Move the node C<src> to C<dest>. C<src> must match exactly
1775 one node. C<dest> is overwritten if it exists.");
1777 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1778 [], (* XXX Augeas code needs tests. *)
1779 "return Augeas nodes which match augpath",
1781 Returns a list of paths which match the path expression C<path>.
1782 The returned paths are sufficiently qualified so that they match
1783 exactly one node in the current tree.");
1785 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1786 [], (* XXX Augeas code needs tests. *)
1787 "write all pending Augeas changes to disk",
1789 This writes all pending changes to disk.
1791 The flags which were passed to C<guestfs_aug_init> affect exactly
1792 how files are saved.");
1794 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1795 [], (* XXX Augeas code needs tests. *)
1796 "load files into the tree",
1798 Load files into the tree.
1800 See C<aug_load> in the Augeas documentation for the full gory
1803 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1804 [], (* XXX Augeas code needs tests. *)
1805 "list Augeas nodes under augpath",
1807 This is just a shortcut for listing C<guestfs_aug_match>
1808 C<path/*> and sorting the resulting nodes into alphabetical order.");
1810 ("rm", (RErr, [Pathname "path"], []), 29, [],
1811 [InitScratchFS, Always, TestRun
1813 ["touch"; "/rm/new"];
1815 InitScratchFS, Always, TestLastFail
1816 [["rm"; "/nosuchfile"]];
1817 InitScratchFS, Always, TestLastFail
1822 Remove the single file C<path>.");
1824 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1825 [InitScratchFS, Always, TestRun
1826 [["mkdir"; "/rmdir"];
1827 ["rmdir"; "/rmdir"]];
1828 InitScratchFS, Always, TestLastFail
1829 [["rmdir"; "/rmdir2"]];
1830 InitScratchFS, Always, TestLastFail
1831 [["mkdir"; "/rmdir3"];
1832 ["touch"; "/rmdir3/new"];
1833 ["rmdir"; "/rmdir3/new"]]],
1834 "remove a directory",
1836 Remove the single directory C<path>.");
1838 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1839 [InitScratchFS, Always, TestOutputFalse
1840 [["mkdir"; "/rm_rf"];
1841 ["mkdir"; "/rm_rf/foo"];
1842 ["touch"; "/rm_rf/foo/bar"];
1843 ["rm_rf"; "/rm_rf"];
1844 ["exists"; "/rm_rf"]]],
1845 "remove a file or directory recursively",
1847 Remove the file or directory C<path>, recursively removing the
1848 contents if its a directory. This is like the C<rm -rf> shell
1851 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1852 [InitScratchFS, Always, TestOutputTrue
1853 [["mkdir"; "/mkdir"];
1854 ["is_dir"; "/mkdir"]];
1855 InitScratchFS, Always, TestLastFail
1856 [["mkdir"; "/mkdir2/foo/bar"]]],
1857 "create a directory",
1859 Create a directory named C<path>.");
1861 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1862 [InitScratchFS, Always, TestOutputTrue
1863 [["mkdir_p"; "/mkdir_p/foo/bar"];
1864 ["is_dir"; "/mkdir_p/foo/bar"]];
1865 InitScratchFS, Always, TestOutputTrue
1866 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1867 ["is_dir"; "/mkdir_p2/foo"]];
1868 InitScratchFS, Always, TestOutputTrue
1869 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1870 ["is_dir"; "/mkdir_p3"]];
1871 (* Regression tests for RHBZ#503133: *)
1872 InitScratchFS, Always, TestRun
1873 [["mkdir"; "/mkdir_p4"];
1874 ["mkdir_p"; "/mkdir_p4"]];
1875 InitScratchFS, Always, TestLastFail
1876 [["touch"; "/mkdir_p5"];
1877 ["mkdir_p"; "/mkdir_p5"]]],
1878 "create a directory and parents",
1880 Create a directory named C<path>, creating any parent directories
1881 as necessary. This is like the C<mkdir -p> shell command.");
1883 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1884 [], (* XXX Need stat command to test *)
1887 Change the mode (permissions) of C<path> to C<mode>. Only
1888 numeric modes are supported.
1890 I<Note>: When using this command from guestfish, C<mode>
1891 by default would be decimal, unless you prefix it with
1892 C<0> to get octal, ie. use C<0700> not C<700>.
1894 The mode actually set is affected by the umask.");
1896 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1897 [], (* XXX Need stat command to test *)
1898 "change file owner and group",
1900 Change the file owner to C<owner> and group to C<group>.
1902 Only numeric uid and gid are supported. If you want to use
1903 names, you will need to locate and parse the password file
1904 yourself (Augeas support makes this relatively easy).");
1906 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1907 [InitISOFS, Always, TestOutputTrue (
1908 [["exists"; "/empty"]]);
1909 InitISOFS, Always, TestOutputTrue (
1910 [["exists"; "/directory"]])],
1911 "test if file or directory exists",
1913 This returns C<true> if and only if there is a file, directory
1914 (or anything) with the given C<path> name.
1916 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1918 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1919 [InitISOFS, Always, TestOutputTrue (
1920 [["is_file"; "/known-1"]]);
1921 InitISOFS, Always, TestOutputFalse (
1922 [["is_file"; "/directory"]])],
1923 "test if a regular file",
1925 This returns C<true> if and only if there is a regular file
1926 with the given C<path> name. Note that it returns false for
1927 other objects like directories.
1929 See also C<guestfs_stat>.");
1931 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1932 [InitISOFS, Always, TestOutputFalse (
1933 [["is_dir"; "/known-3"]]);
1934 InitISOFS, Always, TestOutputTrue (
1935 [["is_dir"; "/directory"]])],
1936 "test if a directory",
1938 This returns C<true> if and only if there is a directory
1939 with the given C<path> name. Note that it returns false for
1940 other objects like files.
1942 See also C<guestfs_stat>.");
1944 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1945 [InitEmpty, Always, TestOutputListOfDevices (
1946 [["part_init"; "/dev/sda"; "mbr"];
1947 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1948 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1949 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1950 ["pvcreate"; "/dev/sda1"];
1951 ["pvcreate"; "/dev/sda2"];
1952 ["pvcreate"; "/dev/sda3"];
1953 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1954 "create an LVM physical volume",
1956 This creates an LVM physical volume on the named C<device>,
1957 where C<device> should usually be a partition name such
1960 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1961 [InitEmpty, Always, TestOutputList (
1962 [["part_init"; "/dev/sda"; "mbr"];
1963 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1964 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1965 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1966 ["pvcreate"; "/dev/sda1"];
1967 ["pvcreate"; "/dev/sda2"];
1968 ["pvcreate"; "/dev/sda3"];
1969 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1970 ["vgcreate"; "VG2"; "/dev/sda3"];
1971 ["vgs"]], ["VG1"; "VG2"])],
1972 "create an LVM volume group",
1974 This creates an LVM volume group called C<volgroup>
1975 from the non-empty list of physical volumes C<physvols>.");
1977 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1978 [InitEmpty, Always, TestOutputList (
1979 [["part_init"; "/dev/sda"; "mbr"];
1980 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1981 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1982 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1983 ["pvcreate"; "/dev/sda1"];
1984 ["pvcreate"; "/dev/sda2"];
1985 ["pvcreate"; "/dev/sda3"];
1986 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1987 ["vgcreate"; "VG2"; "/dev/sda3"];
1988 ["lvcreate"; "LV1"; "VG1"; "50"];
1989 ["lvcreate"; "LV2"; "VG1"; "50"];
1990 ["lvcreate"; "LV3"; "VG2"; "50"];
1991 ["lvcreate"; "LV4"; "VG2"; "50"];
1992 ["lvcreate"; "LV5"; "VG2"; "50"];
1994 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1995 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1996 "create an LVM logical volume",
1998 This creates an LVM logical volume called C<logvol>
1999 on the volume group C<volgroup>, with C<size> megabytes.");
2001 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2002 [InitEmpty, Always, TestOutput (
2003 [["part_disk"; "/dev/sda"; "mbr"];
2004 ["mkfs"; "ext2"; "/dev/sda1"];
2005 ["mount_options"; ""; "/dev/sda1"; "/"];
2006 ["write"; "/new"; "new file contents"];
2007 ["cat"; "/new"]], "new file contents")],
2008 "make a filesystem",
2010 This creates a filesystem on C<device> (usually a partition
2011 or LVM logical volume). The filesystem type is C<fstype>, for
2014 ("sfdisk", (RErr, [Device "device";
2015 Int "cyls"; Int "heads"; Int "sectors";
2016 StringList "lines"], []), 43, [DangerWillRobinson],
2018 "create partitions on a block device",
2020 This is a direct interface to the L<sfdisk(8)> program for creating
2021 partitions on block devices.
2023 C<device> should be a block device, for example C</dev/sda>.
2025 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2026 and sectors on the device, which are passed directly to sfdisk as
2027 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2028 of these, then the corresponding parameter is omitted. Usually for
2029 'large' disks, you can just pass C<0> for these, but for small
2030 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2031 out the right geometry and you will need to tell it.
2033 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2034 information refer to the L<sfdisk(8)> manpage.
2036 To create a single partition occupying the whole disk, you would
2037 pass C<lines> as a single element list, when the single element being
2038 the string C<,> (comma).
2040 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2041 C<guestfs_part_init>");
2043 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2044 (* Regression test for RHBZ#597135. *)
2045 [InitScratchFS, Always, TestLastFail
2046 [["write_file"; "/write_file"; "abc"; "10000"]]],
2049 This call creates a file called C<path>. The contents of the
2050 file is the string C<content> (which can contain any 8 bit data),
2051 with length C<size>.
2053 As a special case, if C<size> is C<0>
2054 then the length is calculated using C<strlen> (so in this case
2055 the content cannot contain embedded ASCII NULs).
2057 I<NB.> Owing to a bug, writing content containing ASCII NUL
2058 characters does I<not> work, even if the length is specified.");
2060 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2061 [InitEmpty, Always, TestOutputListOfDevices (
2062 [["part_disk"; "/dev/sda"; "mbr"];
2063 ["mkfs"; "ext2"; "/dev/sda1"];
2064 ["mount_options"; ""; "/dev/sda1"; "/"];
2065 ["mounts"]], ["/dev/sda1"]);
2066 InitEmpty, Always, TestOutputList (
2067 [["part_disk"; "/dev/sda"; "mbr"];
2068 ["mkfs"; "ext2"; "/dev/sda1"];
2069 ["mount_options"; ""; "/dev/sda1"; "/"];
2072 "unmount a filesystem",
2074 This unmounts the given filesystem. The filesystem may be
2075 specified either by its mountpoint (path) or the device which
2076 contains the filesystem.");
2078 ("mounts", (RStringList "devices", [], []), 46, [],
2079 [InitScratchFS, Always, TestOutputListOfDevices (
2080 [["mounts"]], ["/dev/sdb1"])],
2081 "show mounted filesystems",
2083 This returns the list of currently mounted filesystems. It returns
2084 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2086 Some internal mounts are not shown.
2088 See also: C<guestfs_mountpoints>");
2090 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2091 [InitScratchFS, Always, TestOutputList (
2094 (* check that umount_all can unmount nested mounts correctly: *)
2095 InitEmpty, Always, TestOutputList (
2096 [["part_init"; "/dev/sda"; "mbr"];
2097 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2098 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2099 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2100 ["mkfs"; "ext2"; "/dev/sda1"];
2101 ["mkfs"; "ext2"; "/dev/sda2"];
2102 ["mkfs"; "ext2"; "/dev/sda3"];
2103 ["mount_options"; ""; "/dev/sda1"; "/"];
2105 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2106 ["mkdir"; "/mp1/mp2"];
2107 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2108 ["mkdir"; "/mp1/mp2/mp3"];
2111 "unmount all filesystems",
2113 This unmounts all mounted filesystems.
2115 Some internal mounts are not unmounted by this call.");
2117 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2119 "remove all LVM LVs, VGs and PVs",
2121 This command removes all LVM logical volumes, volume groups
2122 and physical volumes.");
2124 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2125 [InitISOFS, Always, TestOutput (
2126 [["file"; "/empty"]], "empty");
2127 InitISOFS, Always, TestOutput (
2128 [["file"; "/known-1"]], "ASCII text");
2129 InitISOFS, Always, TestLastFail (
2130 [["file"; "/notexists"]]);
2131 InitISOFS, Always, TestOutput (
2132 [["file"; "/abssymlink"]], "symbolic link");
2133 InitISOFS, Always, TestOutput (
2134 [["file"; "/directory"]], "directory")],
2135 "determine file type",
2137 This call uses the standard L<file(1)> command to determine
2138 the type or contents of the file.
2140 This call will also transparently look inside various types
2143 The exact command which runs is C<file -zb path>. Note in
2144 particular that the filename is not prepended to the output
2147 This command can also be used on C</dev/> devices
2148 (and partitions, LV names). You can for example use this
2149 to determine if a device contains a filesystem, although
2150 it's usually better to use C<guestfs_vfs_type>.
2152 If the C<path> does not begin with C</dev/> then
2153 this command only works for the content of regular files.
2154 For other file types (directory, symbolic link etc) it
2155 will just return the string C<directory> etc.");
2157 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2158 [InitScratchFS, Always, TestOutput (
2159 [["mkdir"; "/command"];
2160 ["upload"; "test-command"; "/command/test-command"];
2161 ["chmod"; "0o755"; "/command/test-command"];
2162 ["command"; "/command/test-command 1"]], "Result1");
2163 InitScratchFS, Always, TestOutput (
2164 [["mkdir"; "/command2"];
2165 ["upload"; "test-command"; "/command2/test-command"];
2166 ["chmod"; "0o755"; "/command2/test-command"];
2167 ["command"; "/command2/test-command 2"]], "Result2\n");
2168 InitScratchFS, Always, TestOutput (
2169 [["mkdir"; "/command3"];
2170 ["upload"; "test-command"; "/command3/test-command"];
2171 ["chmod"; "0o755"; "/command3/test-command"];
2172 ["command"; "/command3/test-command 3"]], "\nResult3");
2173 InitScratchFS, Always, TestOutput (
2174 [["mkdir"; "/command4"];
2175 ["upload"; "test-command"; "/command4/test-command"];
2176 ["chmod"; "0o755"; "/command4/test-command"];
2177 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2178 InitScratchFS, Always, TestOutput (
2179 [["mkdir"; "/command5"];
2180 ["upload"; "test-command"; "/command5/test-command"];
2181 ["chmod"; "0o755"; "/command5/test-command"];
2182 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2183 InitScratchFS, Always, TestOutput (
2184 [["mkdir"; "/command6"];
2185 ["upload"; "test-command"; "/command6/test-command"];
2186 ["chmod"; "0o755"; "/command6/test-command"];
2187 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2188 InitScratchFS, Always, TestOutput (
2189 [["mkdir"; "/command7"];
2190 ["upload"; "test-command"; "/command7/test-command"];
2191 ["chmod"; "0o755"; "/command7/test-command"];
2192 ["command"; "/command7/test-command 7"]], "");
2193 InitScratchFS, Always, TestOutput (
2194 [["mkdir"; "/command8"];
2195 ["upload"; "test-command"; "/command8/test-command"];
2196 ["chmod"; "0o755"; "/command8/test-command"];
2197 ["command"; "/command8/test-command 8"]], "\n");
2198 InitScratchFS, Always, TestOutput (
2199 [["mkdir"; "/command9"];
2200 ["upload"; "test-command"; "/command9/test-command"];
2201 ["chmod"; "0o755"; "/command9/test-command"];
2202 ["command"; "/command9/test-command 9"]], "\n\n");
2203 InitScratchFS, Always, TestOutput (
2204 [["mkdir"; "/command10"];
2205 ["upload"; "test-command"; "/command10/test-command"];
2206 ["chmod"; "0o755"; "/command10/test-command"];
2207 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2208 InitScratchFS, Always, TestOutput (
2209 [["mkdir"; "/command11"];
2210 ["upload"; "test-command"; "/command11/test-command"];
2211 ["chmod"; "0o755"; "/command11/test-command"];
2212 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2213 InitScratchFS, Always, TestLastFail (
2214 [["mkdir"; "/command12"];
2215 ["upload"; "test-command"; "/command12/test-command"];
2216 ["chmod"; "0o755"; "/command12/test-command"];
2217 ["command"; "/command12/test-command"]])],
2218 "run a command from the guest filesystem",
2220 This call runs a command from the guest filesystem. The
2221 filesystem must be mounted, and must contain a compatible
2222 operating system (ie. something Linux, with the same
2223 or compatible processor architecture).
2225 The single parameter is an argv-style list of arguments.
2226 The first element is the name of the program to run.
2227 Subsequent elements are parameters. The list must be
2228 non-empty (ie. must contain a program name). Note that
2229 the command runs directly, and is I<not> invoked via
2230 the shell (see C<guestfs_sh>).
2232 The return value is anything printed to I<stdout> by
2235 If the command returns a non-zero exit status, then
2236 this function returns an error message. The error message
2237 string is the content of I<stderr> from the command.
2239 The C<$PATH> environment variable will contain at least
2240 C</usr/bin> and C</bin>. If you require a program from
2241 another location, you should provide the full path in the
2244 Shared libraries and data files required by the program
2245 must be available on filesystems which are mounted in the
2246 correct places. It is the caller's responsibility to ensure
2247 all filesystems that are needed are mounted at the right
2250 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2251 [InitScratchFS, Always, TestOutputList (
2252 [["mkdir"; "/command_lines"];
2253 ["upload"; "test-command"; "/command_lines/test-command"];
2254 ["chmod"; "0o755"; "/command_lines/test-command"];
2255 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2256 InitScratchFS, Always, TestOutputList (
2257 [["mkdir"; "/command_lines2"];
2258 ["upload"; "test-command"; "/command_lines2/test-command"];
2259 ["chmod"; "0o755"; "/command_lines2/test-command"];
2260 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2261 InitScratchFS, Always, TestOutputList (
2262 [["mkdir"; "/command_lines3"];
2263 ["upload"; "test-command"; "/command_lines3/test-command"];
2264 ["chmod"; "0o755"; "/command_lines3/test-command"];
2265 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2266 InitScratchFS, Always, TestOutputList (
2267 [["mkdir"; "/command_lines4"];
2268 ["upload"; "test-command"; "/command_lines4/test-command"];
2269 ["chmod"; "0o755"; "/command_lines4/test-command"];
2270 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2271 InitScratchFS, Always, TestOutputList (
2272 [["mkdir"; "/command_lines5"];
2273 ["upload"; "test-command"; "/command_lines5/test-command"];
2274 ["chmod"; "0o755"; "/command_lines5/test-command"];
2275 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2276 InitScratchFS, Always, TestOutputList (
2277 [["mkdir"; "/command_lines6"];
2278 ["upload"; "test-command"; "/command_lines6/test-command"];
2279 ["chmod"; "0o755"; "/command_lines6/test-command"];
2280 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2281 InitScratchFS, Always, TestOutputList (
2282 [["mkdir"; "/command_lines7"];
2283 ["upload"; "test-command"; "/command_lines7/test-command"];
2284 ["chmod"; "0o755"; "/command_lines7/test-command"];
2285 ["command_lines"; "/command_lines7/test-command 7"]], []);
2286 InitScratchFS, Always, TestOutputList (
2287 [["mkdir"; "/command_lines8"];
2288 ["upload"; "test-command"; "/command_lines8/test-command"];
2289 ["chmod"; "0o755"; "/command_lines8/test-command"];
2290 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2291 InitScratchFS, Always, TestOutputList (
2292 [["mkdir"; "/command_lines9"];
2293 ["upload"; "test-command"; "/command_lines9/test-command"];
2294 ["chmod"; "0o755"; "/command_lines9/test-command"];
2295 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2296 InitScratchFS, Always, TestOutputList (
2297 [["mkdir"; "/command_lines10"];
2298 ["upload"; "test-command"; "/command_lines10/test-command"];
2299 ["chmod"; "0o755"; "/command_lines10/test-command"];
2300 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2301 InitScratchFS, Always, TestOutputList (
2302 [["mkdir"; "/command_lines11"];
2303 ["upload"; "test-command"; "/command_lines11/test-command"];
2304 ["chmod"; "0o755"; "/command_lines11/test-command"];
2305 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2306 "run a command, returning lines",
2308 This is the same as C<guestfs_command>, but splits the
2309 result into a list of lines.
2311 See also: C<guestfs_sh_lines>");
2313 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2314 [InitISOFS, Always, TestOutputStruct (
2315 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2316 "get file information",
2318 Returns file information for the given C<path>.
2320 This is the same as the C<stat(2)> system call.");
2322 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2323 [InitISOFS, Always, TestOutputStruct (
2324 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2325 "get file information for a symbolic link",
2327 Returns file information for the given C<path>.
2329 This is the same as C<guestfs_stat> except that if C<path>
2330 is a symbolic link, then the link is stat-ed, not the file it
2333 This is the same as the C<lstat(2)> system call.");
2335 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2336 [InitISOFS, Always, TestOutputStruct (
2337 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2338 "get file system statistics",
2340 Returns file system statistics for any mounted file system.
2341 C<path> should be a file or directory in the mounted file system
2342 (typically it is the mount point itself, but it doesn't need to be).
2344 This is the same as the C<statvfs(2)> system call.");
2346 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2348 "get ext2/ext3/ext4 superblock details",
2350 This returns the contents of the ext2, ext3 or ext4 filesystem
2351 superblock on C<device>.
2353 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2354 manpage for more details. The list of fields returned isn't
2355 clearly defined, and depends on both the version of C<tune2fs>
2356 that libguestfs was built against, and the filesystem itself.");
2358 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2359 [InitEmpty, Always, TestOutputTrue (
2360 [["blockdev_setro"; "/dev/sda"];
2361 ["blockdev_getro"; "/dev/sda"]])],
2362 "set block device to read-only",
2364 Sets the block device named C<device> to read-only.
2366 This uses the L<blockdev(8)> command.");
2368 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2369 [InitEmpty, Always, TestOutputFalse (
2370 [["blockdev_setrw"; "/dev/sda"];
2371 ["blockdev_getro"; "/dev/sda"]])],
2372 "set block device to read-write",
2374 Sets the block device named C<device> to read-write.
2376 This uses the L<blockdev(8)> command.");
2378 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2379 [InitEmpty, Always, TestOutputTrue (
2380 [["blockdev_setro"; "/dev/sda"];
2381 ["blockdev_getro"; "/dev/sda"]])],
2382 "is block device set to read-only",
2384 Returns a boolean indicating if the block device is read-only
2385 (true if read-only, false if not).
2387 This uses the L<blockdev(8)> command.");
2389 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2390 [InitEmpty, Always, TestOutputInt (
2391 [["blockdev_getss"; "/dev/sda"]], 512)],
2392 "get sectorsize of block device",
2394 This returns the size of sectors on a block device.
2395 Usually 512, but can be larger for modern devices.
2397 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2400 This uses the L<blockdev(8)> command.");
2402 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2403 [InitEmpty, Always, TestOutputInt (
2404 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2405 "get blocksize of block device",
2407 This returns the block size of a device.
2409 (Note this is different from both I<size in blocks> and
2410 I<filesystem block size>).
2412 This uses the L<blockdev(8)> command.");
2414 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2416 "set blocksize of block device",
2418 This sets the block size of a device.
2420 (Note this is different from both I<size in blocks> and
2421 I<filesystem block size>).
2423 This uses the L<blockdev(8)> command.");
2425 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2426 [InitEmpty, Always, TestOutputInt (
2427 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2428 "get total size of device in 512-byte sectors",
2430 This returns the size of the device in units of 512-byte sectors
2431 (even if the sectorsize isn't 512 bytes ... weird).
2433 See also C<guestfs_blockdev_getss> for the real sector size of
2434 the device, and C<guestfs_blockdev_getsize64> for the more
2435 useful I<size in bytes>.
2437 This uses the L<blockdev(8)> command.");
2439 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2440 [InitEmpty, Always, TestOutputInt (
2441 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2442 "get total size of device in bytes",
2444 This returns the size of the device in bytes.
2446 See also C<guestfs_blockdev_getsz>.
2448 This uses the L<blockdev(8)> command.");
2450 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2451 [InitEmpty, Always, TestRun
2452 [["blockdev_flushbufs"; "/dev/sda"]]],
2453 "flush device buffers",
2455 This tells the kernel to flush internal buffers associated
2458 This uses the L<blockdev(8)> command.");
2460 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2461 [InitEmpty, Always, TestRun
2462 [["blockdev_rereadpt"; "/dev/sda"]]],
2463 "reread partition table",
2465 Reread the partition table on C<device>.
2467 This uses the L<blockdev(8)> command.");
2469 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2470 [InitScratchFS, Always, TestOutput (
2471 (* Pick a file from cwd which isn't likely to change. *)
2472 [["mkdir"; "/upload"];
2473 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2474 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2475 Digest.to_hex (Digest.file "COPYING.LIB"))],
2476 "upload a file from the local machine",
2478 Upload local file C<filename> to C<remotefilename> on the
2481 C<filename> can also be a named pipe.
2483 See also C<guestfs_download>.");
2485 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2486 [InitScratchFS, Always, TestOutput (
2487 (* Pick a file from cwd which isn't likely to change. *)
2488 [["mkdir"; "/download"];
2489 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2490 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2491 ["upload"; "testdownload.tmp"; "/download/upload"];
2492 ["checksum"; "md5"; "/download/upload"]],
2493 Digest.to_hex (Digest.file "COPYING.LIB"))],
2494 "download a file to the local machine",
2496 Download file C<remotefilename> and save it as C<filename>
2497 on the local machine.
2499 C<filename> can also be a named pipe.
2501 See also C<guestfs_upload>, C<guestfs_cat>.");
2503 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2504 [InitISOFS, Always, TestOutput (
2505 [["checksum"; "crc"; "/known-3"]], "2891671662");
2506 InitISOFS, Always, TestLastFail (
2507 [["checksum"; "crc"; "/notexists"]]);
2508 InitISOFS, Always, TestOutput (
2509 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2510 InitISOFS, Always, TestOutput (
2511 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2512 InitISOFS, Always, TestOutput (
2513 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2514 InitISOFS, Always, TestOutput (
2515 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2516 InitISOFS, Always, TestOutput (
2517 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2518 InitISOFS, Always, TestOutput (
2519 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2520 (* Test for RHBZ#579608, absolute symbolic links. *)
2521 InitISOFS, Always, TestOutput (
2522 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2523 "compute MD5, SHAx or CRC checksum of file",
2525 This call computes the MD5, SHAx or CRC checksum of the
2528 The type of checksum to compute is given by the C<csumtype>
2529 parameter which must have one of the following values:
2535 Compute the cyclic redundancy check (CRC) specified by POSIX
2536 for the C<cksum> command.
2540 Compute the MD5 hash (using the C<md5sum> program).
2544 Compute the SHA1 hash (using the C<sha1sum> program).
2548 Compute the SHA224 hash (using the C<sha224sum> program).
2552 Compute the SHA256 hash (using the C<sha256sum> program).
2556 Compute the SHA384 hash (using the C<sha384sum> program).
2560 Compute the SHA512 hash (using the C<sha512sum> program).
2564 The checksum is returned as a printable string.
2566 To get the checksum for a device, use C<guestfs_checksum_device>.
2568 To get the checksums for many files, use C<guestfs_checksums_out>.");
2570 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2571 [InitScratchFS, Always, TestOutput (
2572 [["mkdir"; "/tar_in"];
2573 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2574 ["cat"; "/tar_in/hello"]], "hello\n")],
2575 "unpack tarfile to directory",
2577 This command uploads and unpacks local file C<tarfile> (an
2578 I<uncompressed> tar file) into C<directory>.
2580 To upload a compressed tarball, use C<guestfs_tgz_in>
2581 or C<guestfs_txz_in>.");
2583 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2585 "pack directory into tarfile",
2587 This command packs the contents of C<directory> and downloads
2588 it to local file C<tarfile>.
2590 To download a compressed tarball, use C<guestfs_tgz_out>
2591 or C<guestfs_txz_out>.");
2593 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2594 [InitScratchFS, Always, TestOutput (
2595 [["mkdir"; "/tgz_in"];
2596 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2597 ["cat"; "/tgz_in/hello"]], "hello\n")],
2598 "unpack compressed tarball to directory",
2600 This command uploads and unpacks local file C<tarball> (a
2601 I<gzip compressed> tar file) into C<directory>.
2603 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2605 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2607 "pack directory into compressed tarball",
2609 This command packs the contents of C<directory> and downloads
2610 it to local file C<tarball>.
2612 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2614 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2615 [InitBasicFS, Always, TestLastFail (
2617 ["mount_ro"; "/dev/sda1"; "/"];
2618 ["touch"; "/new"]]);
2619 InitBasicFS, Always, TestOutput (
2620 [["write"; "/new"; "data"];
2622 ["mount_ro"; "/dev/sda1"; "/"];
2623 ["cat"; "/new"]], "data")],
2624 "mount a guest disk, read-only",
2626 This is the same as the C<guestfs_mount> command, but it
2627 mounts the filesystem with the read-only (I<-o ro>) flag.");
2629 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2631 "mount a guest disk with mount options",
2633 This is the same as the C<guestfs_mount> command, but it
2634 allows you to set the mount options as for the
2635 L<mount(8)> I<-o> flag.
2637 If the C<options> parameter is an empty string, then
2638 no options are passed (all options default to whatever
2639 the filesystem uses).");
2641 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2643 "mount a guest disk with mount options and vfstype",
2645 This is the same as the C<guestfs_mount> command, but it
2646 allows you to set both the mount options and the vfstype
2647 as for the L<mount(8)> I<-o> and I<-t> flags.");
2649 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2651 "debugging and internals",
2653 The C<guestfs_debug> command exposes some internals of
2654 C<guestfsd> (the guestfs daemon) that runs inside the
2657 There is no comprehensive help for this command. You have
2658 to look at the file C<daemon/debug.c> in the libguestfs source
2659 to find out what you can do.");
2661 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2662 [InitEmpty, Always, TestOutputList (
2663 [["part_disk"; "/dev/sda"; "mbr"];
2664 ["pvcreate"; "/dev/sda1"];
2665 ["vgcreate"; "VG"; "/dev/sda1"];
2666 ["lvcreate"; "LV1"; "VG"; "50"];
2667 ["lvcreate"; "LV2"; "VG"; "50"];
2668 ["lvremove"; "/dev/VG/LV1"];
2669 ["lvs"]], ["/dev/VG/LV2"]);
2670 InitEmpty, Always, TestOutputList (
2671 [["part_disk"; "/dev/sda"; "mbr"];
2672 ["pvcreate"; "/dev/sda1"];
2673 ["vgcreate"; "VG"; "/dev/sda1"];
2674 ["lvcreate"; "LV1"; "VG"; "50"];
2675 ["lvcreate"; "LV2"; "VG"; "50"];
2676 ["lvremove"; "/dev/VG"];
2678 InitEmpty, Always, TestOutputList (
2679 [["part_disk"; "/dev/sda"; "mbr"];
2680 ["pvcreate"; "/dev/sda1"];
2681 ["vgcreate"; "VG"; "/dev/sda1"];
2682 ["lvcreate"; "LV1"; "VG"; "50"];
2683 ["lvcreate"; "LV2"; "VG"; "50"];
2684 ["lvremove"; "/dev/VG"];
2686 "remove an LVM logical volume",
2688 Remove an LVM logical volume C<device>, where C<device> is
2689 the path to the LV, such as C</dev/VG/LV>.
2691 You can also remove all LVs in a volume group by specifying
2692 the VG name, C</dev/VG>.");
2694 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2695 [InitEmpty, Always, TestOutputList (
2696 [["part_disk"; "/dev/sda"; "mbr"];
2697 ["pvcreate"; "/dev/sda1"];
2698 ["vgcreate"; "VG"; "/dev/sda1"];
2699 ["lvcreate"; "LV1"; "VG"; "50"];
2700 ["lvcreate"; "LV2"; "VG"; "50"];
2703 InitEmpty, Always, TestOutputList (
2704 [["part_disk"; "/dev/sda"; "mbr"];
2705 ["pvcreate"; "/dev/sda1"];
2706 ["vgcreate"; "VG"; "/dev/sda1"];
2707 ["lvcreate"; "LV1"; "VG"; "50"];
2708 ["lvcreate"; "LV2"; "VG"; "50"];
2711 "remove an LVM volume group",
2713 Remove an LVM volume group C<vgname>, (for example C<VG>).
2715 This also forcibly removes all logical volumes in the volume
2718 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2719 [InitEmpty, Always, TestOutputListOfDevices (
2720 [["part_disk"; "/dev/sda"; "mbr"];
2721 ["pvcreate"; "/dev/sda1"];
2722 ["vgcreate"; "VG"; "/dev/sda1"];
2723 ["lvcreate"; "LV1"; "VG"; "50"];
2724 ["lvcreate"; "LV2"; "VG"; "50"];
2726 ["pvremove"; "/dev/sda1"];
2728 InitEmpty, Always, TestOutputListOfDevices (
2729 [["part_disk"; "/dev/sda"; "mbr"];
2730 ["pvcreate"; "/dev/sda1"];
2731 ["vgcreate"; "VG"; "/dev/sda1"];
2732 ["lvcreate"; "LV1"; "VG"; "50"];
2733 ["lvcreate"; "LV2"; "VG"; "50"];
2735 ["pvremove"; "/dev/sda1"];
2737 InitEmpty, Always, TestOutputListOfDevices (
2738 [["part_disk"; "/dev/sda"; "mbr"];
2739 ["pvcreate"; "/dev/sda1"];
2740 ["vgcreate"; "VG"; "/dev/sda1"];
2741 ["lvcreate"; "LV1"; "VG"; "50"];
2742 ["lvcreate"; "LV2"; "VG"; "50"];
2744 ["pvremove"; "/dev/sda1"];
2746 "remove an LVM physical volume",
2748 This wipes a physical volume C<device> so that LVM will no longer
2751 The implementation uses the C<pvremove> command which refuses to
2752 wipe physical volumes that contain any volume groups, so you have
2753 to remove those first.");
2755 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2756 [InitBasicFS, Always, TestOutput (
2757 [["set_e2label"; "/dev/sda1"; "testlabel"];
2758 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2759 "set the ext2/3/4 filesystem label",
2761 This sets the ext2/3/4 filesystem label of the filesystem on
2762 C<device> to C<label>. Filesystem labels are limited to
2765 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2766 to return the existing label on a filesystem.");
2768 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2770 "get the ext2/3/4 filesystem label",
2772 This returns the ext2/3/4 filesystem label of the filesystem on
2775 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2776 (let uuid = uuidgen () in
2777 [InitBasicFS, Always, TestOutput (
2778 [["set_e2uuid"; "/dev/sda1"; uuid];
2779 ["get_e2uuid"; "/dev/sda1"]], uuid);
2780 InitBasicFS, Always, TestOutput (
2781 [["set_e2uuid"; "/dev/sda1"; "clear"];
2782 ["get_e2uuid"; "/dev/sda1"]], "");
2783 (* We can't predict what UUIDs will be, so just check the commands run. *)
2784 InitBasicFS, Always, TestRun (
2785 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2786 InitBasicFS, Always, TestRun (
2787 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2788 "set the ext2/3/4 filesystem UUID",
2790 This sets the ext2/3/4 filesystem UUID of the filesystem on
2791 C<device> to C<uuid>. The format of the UUID and alternatives
2792 such as C<clear>, C<random> and C<time> are described in the
2793 L<tune2fs(8)> manpage.
2795 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2796 to return the existing UUID of a filesystem.");
2798 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2799 (* Regression test for RHBZ#597112. *)
2800 (let uuid = uuidgen () in
2801 [InitNone, Always, TestOutput (
2802 [["mke2journal"; "1024"; "/dev/sdc"];
2803 ["set_e2uuid"; "/dev/sdc"; uuid];
2804 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2805 "get the ext2/3/4 filesystem UUID",
2807 This returns the ext2/3/4 filesystem UUID of the filesystem on
2810 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2811 [InitBasicFS, Always, TestOutputInt (
2812 [["umount"; "/dev/sda1"];
2813 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2814 InitBasicFS, Always, TestOutputInt (
2815 [["umount"; "/dev/sda1"];
2816 ["zero"; "/dev/sda1"];
2817 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2818 "run the filesystem checker",
2820 This runs the filesystem checker (fsck) on C<device> which
2821 should have filesystem type C<fstype>.
2823 The returned integer is the status. See L<fsck(8)> for the
2824 list of status codes from C<fsck>.
2832 Multiple status codes can be summed together.
2836 A non-zero return code can mean \"success\", for example if
2837 errors have been corrected on the filesystem.
2841 Checking or repairing NTFS volumes is not supported
2846 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2848 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2849 [InitBasicFS, Always, TestOutput (
2850 [["umount"; "/dev/sda1"];
2851 ["zero"; "/dev/sda1"];
2852 ["file"; "/dev/sda1"]], "data")],
2853 "write zeroes to the device",
2855 This command writes zeroes over the first few blocks of C<device>.
2857 How many blocks are zeroed isn't specified (but it's I<not> enough
2858 to securely wipe the device). It should be sufficient to remove
2859 any partition tables, filesystem superblocks and so on.
2861 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2863 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2865 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2866 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2868 [InitBasicFS, Always, TestOutputTrue (
2869 [["mkdir_p"; "/boot/grub"];
2870 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2871 ["grub_install"; "/"; "/dev/vda"];
2872 ["is_dir"; "/boot"]])],
2875 This command installs GRUB (the Grand Unified Bootloader) on
2876 C<device>, with the root directory being C<root>.
2878 Note: If grub-install reports the error
2879 \"No suitable drive was found in the generated device map.\"
2880 it may be that you need to create a C</boot/grub/device.map>
2881 file first that contains the mapping between grub device names
2882 and Linux device names. It is usually sufficient to create
2887 replacing C</dev/vda> with the name of the installation device.");
2889 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2890 [InitScratchFS, Always, TestOutput (
2892 ["write"; "/cp/old"; "file content"];
2893 ["cp"; "/cp/old"; "/cp/new"];
2894 ["cat"; "/cp/new"]], "file content");
2895 InitScratchFS, Always, TestOutputTrue (
2897 ["write"; "/cp2/old"; "file content"];
2898 ["cp"; "/cp2/old"; "/cp2/new"];
2899 ["is_file"; "/cp2/old"]]);
2900 InitScratchFS, Always, TestOutput (
2902 ["write"; "/cp3/old"; "file content"];
2903 ["mkdir"; "/cp3/dir"];
2904 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2905 ["cat"; "/cp3/dir/new"]], "file content")],
2908 This copies a file from C<src> to C<dest> where C<dest> is
2909 either a destination filename or destination directory.");
2911 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2912 [InitScratchFS, Always, TestOutput (
2913 [["mkdir"; "/cp_a1"];
2914 ["mkdir"; "/cp_a2"];
2915 ["write"; "/cp_a1/file"; "file content"];
2916 ["cp_a"; "/cp_a1"; "/cp_a2"];
2917 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2918 "copy a file or directory recursively",
2920 This copies a file or directory from C<src> to C<dest>
2921 recursively using the C<cp -a> command.");
2923 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2924 [InitScratchFS, Always, TestOutput (
2926 ["write"; "/mv/old"; "file content"];
2927 ["mv"; "/mv/old"; "/mv/new"];
2928 ["cat"; "/mv/new"]], "file content");
2929 InitScratchFS, Always, TestOutputFalse (
2931 ["write"; "/mv2/old"; "file content"];
2932 ["mv"; "/mv2/old"; "/mv2/new"];
2933 ["is_file"; "/mv2/old"]])],
2936 This moves a file from C<src> to C<dest> where C<dest> is
2937 either a destination filename or destination directory.");
2939 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2940 [InitEmpty, Always, TestRun (
2941 [["drop_caches"; "3"]])],
2942 "drop kernel page cache, dentries and inodes",
2944 This instructs the guest kernel to drop its page cache,
2945 and/or dentries and inode caches. The parameter C<whattodrop>
2946 tells the kernel what precisely to drop, see
2947 L<http://linux-mm.org/Drop_Caches>
2949 Setting C<whattodrop> to 3 should drop everything.
2951 This automatically calls L<sync(2)> before the operation,
2952 so that the maximum guest memory is freed.");
2954 ("dmesg", (RString "kmsgs", [], []), 91, [],
2955 [InitEmpty, Always, TestRun (
2957 "return kernel messages",
2959 This returns the kernel messages (C<dmesg> output) from
2960 the guest kernel. This is sometimes useful for extended
2961 debugging of problems.
2963 Another way to get the same information is to enable
2964 verbose messages with C<guestfs_set_verbose> or by setting
2965 the environment variable C<LIBGUESTFS_DEBUG=1> before
2966 running the program.");
2968 ("ping_daemon", (RErr, [], []), 92, [],
2969 [InitEmpty, Always, TestRun (
2970 [["ping_daemon"]])],
2971 "ping the guest daemon",
2973 This is a test probe into the guestfs daemon running inside
2974 the qemu subprocess. Calling this function checks that the
2975 daemon responds to the ping message, without affecting the daemon
2976 or attached block device(s) in any other way.");
2978 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2979 [InitScratchFS, Always, TestOutputTrue (
2980 [["mkdir"; "/equal"];
2981 ["write"; "/equal/file1"; "contents of a file"];
2982 ["cp"; "/equal/file1"; "/equal/file2"];
2983 ["equal"; "/equal/file1"; "/equal/file2"]]);
2984 InitScratchFS, Always, TestOutputFalse (
2985 [["mkdir"; "/equal2"];
2986 ["write"; "/equal2/file1"; "contents of a file"];
2987 ["write"; "/equal2/file2"; "contents of another file"];
2988 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
2989 InitScratchFS, Always, TestLastFail (
2990 [["mkdir"; "/equal3"];
2991 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
2992 "test if two files have equal contents",
2994 This compares the two files C<file1> and C<file2> and returns
2995 true if their content is exactly equal, or false otherwise.
2997 The external L<cmp(1)> program is used for the comparison.");
2999 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3000 [InitISOFS, Always, TestOutputList (
3001 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3002 InitISOFS, Always, TestOutputList (
3003 [["strings"; "/empty"]], []);
3004 (* Test for RHBZ#579608, absolute symbolic links. *)
3005 InitISOFS, Always, TestRun (
3006 [["strings"; "/abssymlink"]])],
3007 "print the printable strings in a file",
3009 This runs the L<strings(1)> command on a file and returns
3010 the list of printable strings found.");
3012 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3013 [InitISOFS, Always, TestOutputList (
3014 [["strings_e"; "b"; "/known-5"]], []);
3015 InitScratchFS, Always, TestOutputList (
3016 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3017 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3018 "print the printable strings in a file",
3020 This is like the C<guestfs_strings> command, but allows you to
3021 specify the encoding of strings that are looked for in
3022 the source file C<path>.
3024 Allowed encodings are:
3030 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3031 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3035 Single 8-bit-byte characters.
3039 16-bit big endian strings such as those encoded in
3040 UTF-16BE or UCS-2BE.
3042 =item l (lower case letter L)
3044 16-bit little endian such as UTF-16LE and UCS-2LE.
3045 This is useful for examining binaries in Windows guests.
3049 32-bit big endian such as UCS-4BE.
3053 32-bit little endian such as UCS-4LE.
3057 The returned strings are transcoded to UTF-8.");
3059 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3060 [InitISOFS, Always, TestOutput (
3061 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3062 (* Test for RHBZ#501888c2 regression which caused large hexdump
3063 * commands to segfault.
3065 InitISOFS, Always, TestRun (
3066 [["hexdump"; "/100krandom"]]);
3067 (* Test for RHBZ#579608, absolute symbolic links. *)
3068 InitISOFS, Always, TestRun (
3069 [["hexdump"; "/abssymlink"]])],
3070 "dump a file in hexadecimal",
3072 This runs C<hexdump -C> on the given C<path>. The result is
3073 the human-readable, canonical hex dump of the file.");
3075 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3076 [InitNone, Always, TestOutput (
3077 [["part_disk"; "/dev/sda"; "mbr"];
3078 ["mkfs"; "ext3"; "/dev/sda1"];
3079 ["mount_options"; ""; "/dev/sda1"; "/"];
3080 ["write"; "/new"; "test file"];
3081 ["umount"; "/dev/sda1"];
3082 ["zerofree"; "/dev/sda1"];
3083 ["mount_options"; ""; "/dev/sda1"; "/"];
3084 ["cat"; "/new"]], "test file")],
3085 "zero unused inodes and disk blocks on ext2/3 filesystem",
3087 This runs the I<zerofree> program on C<device>. This program
3088 claims to zero unused inodes and disk blocks on an ext2/3
3089 filesystem, thus making it possible to compress the filesystem
3092 You should B<not> run this program if the filesystem is
3095 It is possible that using this program can damage the filesystem
3096 or data on the filesystem.");
3098 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3100 "resize an LVM physical volume",
3102 This resizes (expands or shrinks) an existing LVM physical
3103 volume to match the new size of the underlying device.");
3105 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3106 Int "cyls"; Int "heads"; Int "sectors";
3107 String "line"], []), 99, [DangerWillRobinson],
3109 "modify a single partition on a block device",
3111 This runs L<sfdisk(8)> option to modify just the single
3112 partition C<n> (note: C<n> counts from 1).
3114 For other parameters, see C<guestfs_sfdisk>. You should usually
3115 pass C<0> for the cyls/heads/sectors parameters.
3117 See also: C<guestfs_part_add>");
3119 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3121 "display the partition table",
3123 This displays the partition table on C<device>, in the
3124 human-readable output of the L<sfdisk(8)> command. It is
3125 not intended to be parsed.
3127 See also: C<guestfs_part_list>");
3129 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3131 "display the kernel geometry",
3133 This displays the kernel's idea of the geometry of C<device>.
3135 The result is in human-readable format, and not designed to
3138 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3140 "display the disk geometry from the partition table",
3142 This displays the disk geometry of C<device> read from the
3143 partition table. Especially in the case where the underlying
3144 block device has been resized, this can be different from the
3145 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3147 The result is in human-readable format, and not designed to
3150 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3152 "activate or deactivate all volume groups",
3154 This command activates or (if C<activate> is false) deactivates
3155 all logical volumes in all volume groups.
3156 If activated, then they are made known to the
3157 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3158 then those devices disappear.
3160 This command is the same as running C<vgchange -a y|n>");
3162 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3164 "activate or deactivate some volume groups",
3166 This command activates or (if C<activate> is false) deactivates
3167 all logical volumes in the listed volume groups C<volgroups>.
3168 If activated, then they are made known to the
3169 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3170 then those devices disappear.
3172 This command is the same as running C<vgchange -a y|n volgroups...>
3174 Note that if C<volgroups> is an empty list then B<all> volume groups
3175 are activated or deactivated.");
3177 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3178 [InitNone, Always, TestOutput (
3179 [["part_disk"; "/dev/sda"; "mbr"];
3180 ["pvcreate"; "/dev/sda1"];
3181 ["vgcreate"; "VG"; "/dev/sda1"];
3182 ["lvcreate"; "LV"; "VG"; "10"];
3183 ["mkfs"; "ext2"; "/dev/VG/LV"];
3184 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3185 ["write"; "/new"; "test content"];
3187 ["lvresize"; "/dev/VG/LV"; "20"];
3188 ["e2fsck_f"; "/dev/VG/LV"];
3189 ["resize2fs"; "/dev/VG/LV"];
3190 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3191 ["cat"; "/new"]], "test content");
3192 InitNone, Always, TestRun (
3193 (* Make an LV smaller to test RHBZ#587484. *)
3194 [["part_disk"; "/dev/sda"; "mbr"];
3195 ["pvcreate"; "/dev/sda1"];
3196 ["vgcreate"; "VG"; "/dev/sda1"];
3197 ["lvcreate"; "LV"; "VG"; "20"];
3198 ["lvresize"; "/dev/VG/LV"; "10"]])],
3199 "resize an LVM logical volume",
3201 This resizes (expands or shrinks) an existing LVM logical
3202 volume to C<mbytes>. When reducing, data in the reduced part
3205 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3206 [], (* lvresize tests this *)
3207 "resize an ext2, ext3 or ext4 filesystem",
3209 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3210 the underlying device.
3212 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3213 on the C<device> before calling this command. For unknown reasons
3214 C<resize2fs> sometimes gives an error about this and sometimes not.
3215 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3216 calling this function.");
3218 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3219 [InitBasicFS, Always, TestOutputList (
3220 [["find"; "/"]], ["lost+found"]);
3221 InitBasicFS, Always, TestOutputList (
3225 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3226 InitScratchFS, Always, TestOutputList (
3227 [["mkdir_p"; "/find/b/c"];
3228 ["touch"; "/find/b/c/d"];
3229 ["find"; "/find/b/"]], ["c"; "c/d"])],
3230 "find all files and directories",
3232 This command lists out all files and directories, recursively,
3233 starting at C<directory>. It is essentially equivalent to
3234 running the shell command C<find directory -print> but some
3235 post-processing happens on the output, described below.
3237 This returns a list of strings I<without any prefix>. Thus
3238 if the directory structure was:
3244 then the returned list from C<guestfs_find> C</tmp> would be
3252 If C<directory> is not a directory, then this command returns
3255 The returned list is sorted.
3257 See also C<guestfs_find0>.");
3259 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3260 [], (* lvresize tests this *)
3261 "check an ext2/ext3 filesystem",
3263 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3264 filesystem checker on C<device>, noninteractively (C<-p>),
3265 even if the filesystem appears to be clean (C<-f>).
3267 This command is only needed because of C<guestfs_resize2fs>
3268 (q.v.). Normally you should use C<guestfs_fsck>.");
3270 ("sleep", (RErr, [Int "secs"], []), 109, [],
3271 [InitNone, Always, TestRun (
3273 "sleep for some seconds",
3275 Sleep for C<secs> seconds.");
3277 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3278 [InitNone, Always, TestOutputInt (
3279 [["part_disk"; "/dev/sda"; "mbr"];
3280 ["mkfs"; "ntfs"; "/dev/sda1"];
3281 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3282 InitNone, Always, TestOutputInt (
3283 [["part_disk"; "/dev/sda"; "mbr"];
3284 ["mkfs"; "ext2"; "/dev/sda1"];
3285 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3286 "probe NTFS volume",
3288 This command runs the L<ntfs-3g.probe(8)> command which probes
3289 an NTFS C<device> for mountability. (Not all NTFS volumes can
3290 be mounted read-write, and some cannot be mounted at all).
3292 C<rw> is a boolean flag. Set it to true if you want to test
3293 if the volume can be mounted read-write. Set it to false if
3294 you want to test if the volume can be mounted read-only.
3296 The return value is an integer which C<0> if the operation
3297 would succeed, or some non-zero value documented in the
3298 L<ntfs-3g.probe(8)> manual page.");
3300 ("sh", (RString "output", [String "command"], []), 111, [],
3301 [], (* XXX needs tests *)
3302 "run a command via the shell",
3304 This call runs a command from the guest filesystem via the
3307 This is like C<guestfs_command>, but passes the command to:
3309 /bin/sh -c \"command\"
3311 Depending on the guest's shell, this usually results in
3312 wildcards being expanded, shell expressions being interpolated
3315 All the provisos about C<guestfs_command> apply to this call.");
3317 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3318 [], (* XXX needs tests *)
3319 "run a command via the shell returning lines",
3321 This is the same as C<guestfs_sh>, but splits the result
3322 into a list of lines.
3324 See also: C<guestfs_command_lines>");
3326 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3327 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3328 * code in stubs.c, since all valid glob patterns must start with "/".
3329 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3331 [InitScratchFS, Always, TestOutputList (
3332 [["mkdir_p"; "/glob_expand/b/c"];
3333 ["touch"; "/glob_expand/b/c/d"];
3334 ["touch"; "/glob_expand/b/c/e"];
3335 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3336 InitScratchFS, Always, TestOutputList (
3337 [["mkdir_p"; "/glob_expand2/b/c"];
3338 ["touch"; "/glob_expand2/b/c/d"];
3339 ["touch"; "/glob_expand2/b/c/e"];
3340 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3341 InitScratchFS, Always, TestOutputList (
3342 [["mkdir_p"; "/glob_expand3/b/c"];
3343 ["touch"; "/glob_expand3/b/c/d"];
3344 ["touch"; "/glob_expand3/b/c/e"];
3345 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3346 "expand a wildcard path",
3348 This command searches for all the pathnames matching
3349 C<pattern> according to the wildcard expansion rules
3352 If no paths match, then this returns an empty list
3353 (note: not an error).
3355 It is just a wrapper around the C L<glob(3)> function
3356 with flags C<GLOB_MARK|GLOB_BRACE>.
3357 See that manual page for more details.");
3359 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3360 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3361 [["scrub_device"; "/dev/sdc"]])],
3362 "scrub (securely wipe) a device",
3364 This command writes patterns over C<device> to make data retrieval
3367 It is an interface to the L<scrub(1)> program. See that
3368 manual page for more details.");
3370 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3371 [InitScratchFS, Always, TestRun (
3372 [["write"; "/scrub_file"; "content"];
3373 ["scrub_file"; "/scrub_file"]])],
3374 "scrub (securely wipe) a file",
3376 This command writes patterns over a file to make data retrieval
3379 The file is I<removed> after scrubbing.
3381 It is an interface to the L<scrub(1)> program. See that
3382 manual page for more details.");
3384 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3385 [], (* XXX needs testing *)
3386 "scrub (securely wipe) free space",
3388 This command creates the directory C<dir> and then fills it
3389 with files until the filesystem is full, and scrubs the files
3390 as for C<guestfs_scrub_file>, and deletes them.
3391 The intention is to scrub any free space on the partition
3394 It is an interface to the L<scrub(1)> program. See that
3395 manual page for more details.");
3397 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3398 [InitScratchFS, Always, TestRun (
3399 [["mkdir"; "/mkdtemp"];
3400 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3401 "create a temporary directory",
3403 This command creates a temporary directory. The
3404 C<template> parameter should be a full pathname for the
3405 temporary directory name with the final six characters being
3408 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3409 the second one being suitable for Windows filesystems.
3411 The name of the temporary directory that was created
3414 The temporary directory is created with mode 0700
3415 and is owned by root.
3417 The caller is responsible for deleting the temporary
3418 directory and its contents after use.
3420 See also: L<mkdtemp(3)>");
3422 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3423 [InitISOFS, Always, TestOutputInt (
3424 [["wc_l"; "/10klines"]], 10000);
3425 (* Test for RHBZ#579608, absolute symbolic links. *)
3426 InitISOFS, Always, TestOutputInt (
3427 [["wc_l"; "/abssymlink"]], 10000)],
3428 "count lines in a file",
3430 This command counts the lines in a file, using the
3431 C<wc -l> external command.");
3433 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3434 [InitISOFS, Always, TestOutputInt (
3435 [["wc_w"; "/10klines"]], 10000)],
3436 "count words in a file",
3438 This command counts the words in a file, using the
3439 C<wc -w> external command.");
3441 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3442 [InitISOFS, Always, TestOutputInt (
3443 [["wc_c"; "/100kallspaces"]], 102400)],
3444 "count characters in a file",
3446 This command counts the characters in a file, using the
3447 C<wc -c> external command.");
3449 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3450 [InitISOFS, Always, TestOutputList (
3451 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3452 (* Test for RHBZ#579608, absolute symbolic links. *)
3453 InitISOFS, Always, TestOutputList (
3454 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3455 "return first 10 lines of a file",
3457 This command returns up to the first 10 lines of a file as
3458 a list of strings.");
3460 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3461 [InitISOFS, Always, TestOutputList (
3462 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3463 InitISOFS, Always, TestOutputList (
3464 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3465 InitISOFS, Always, TestOutputList (
3466 [["head_n"; "0"; "/10klines"]], [])],
3467 "return first N lines of a file",
3469 If the parameter C<nrlines> is a positive number, this returns the first
3470 C<nrlines> lines of the file C<path>.
3472 If the parameter C<nrlines> is a negative number, this returns lines
3473 from the file C<path>, excluding the last C<nrlines> lines.
3475 If the parameter C<nrlines> is zero, this returns an empty list.");
3477 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3478 [InitISOFS, Always, TestOutputList (
3479 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3480 "return last 10 lines of a file",
3482 This command returns up to the last 10 lines of a file as
3483 a list of strings.");
3485 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3486 [InitISOFS, Always, TestOutputList (
3487 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3488 InitISOFS, Always, TestOutputList (
3489 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3490 InitISOFS, Always, TestOutputList (
3491 [["tail_n"; "0"; "/10klines"]], [])],
3492 "return last N lines of a file",
3494 If the parameter C<nrlines> is a positive number, this returns the last
3495 C<nrlines> lines of the file C<path>.
3497 If the parameter C<nrlines> is a negative number, this returns lines
3498 from the file C<path>, starting with the C<-nrlines>th line.
3500 If the parameter C<nrlines> is zero, this returns an empty list.");
3502 ("df", (RString "output", [], []), 125, [],
3503 [], (* XXX Tricky to test because it depends on the exact format
3504 * of the 'df' command and other imponderables.
3506 "report file system disk space usage",
3508 This command runs the C<df> command to report disk space used.
3510 This command is mostly useful for interactive sessions. It
3511 is I<not> intended that you try to parse the output string.
3512 Use C<guestfs_statvfs> from programs.");
3514 ("df_h", (RString "output", [], []), 126, [],
3515 [], (* XXX Tricky to test because it depends on the exact format
3516 * of the 'df' command and other imponderables.
3518 "report file system disk space usage (human readable)",
3520 This command runs the C<df -h> command to report disk space used
3521 in human-readable format.
3523 This command is mostly useful for interactive sessions. It
3524 is I<not> intended that you try to parse the output string.
3525 Use C<guestfs_statvfs> from programs.");
3527 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3528 [InitISOFS, Always, TestOutputInt (
3529 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3530 "estimate file space usage",
3532 This command runs the C<du -s> command to estimate file space
3535 C<path> can be a file or a directory. If C<path> is a directory
3536 then the estimate includes the contents of the directory and all
3537 subdirectories (recursively).
3539 The result is the estimated size in I<kilobytes>
3540 (ie. units of 1024 bytes).");
3542 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3543 [InitISOFS, Always, TestOutputList (
3544 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3545 "list files in an initrd",
3547 This command lists out files contained in an initrd.
3549 The files are listed without any initial C</> character. The
3550 files are listed in the order they appear (not necessarily
3551 alphabetical). Directory names are listed as separate items.
3553 Old Linux kernels (2.4 and earlier) used a compressed ext2
3554 filesystem as initrd. We I<only> support the newer initramfs
3555 format (compressed cpio files).");
3557 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3559 "mount a file using the loop device",
3561 This command lets you mount C<file> (a filesystem image
3562 in a file) on a mount point. It is entirely equivalent to
3563 the command C<mount -o loop file mountpoint>.");
3565 ("mkswap", (RErr, [Device "device"], []), 130, [],
3566 [InitEmpty, Always, TestRun (
3567 [["part_disk"; "/dev/sda"; "mbr"];
3568 ["mkswap"; "/dev/sda1"]])],
3569 "create a swap partition",
3571 Create a swap partition on C<device>.");
3573 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3574 [InitEmpty, Always, TestRun (
3575 [["part_disk"; "/dev/sda"; "mbr"];
3576 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3577 "create a swap partition with a label",
3579 Create a swap partition on C<device> with label C<label>.
3581 Note that you cannot attach a swap label to a block device
3582 (eg. C</dev/sda>), just to a partition. This appears to be
3583 a limitation of the kernel or swap tools.");
3585 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3586 (let uuid = uuidgen () in
3587 [InitEmpty, Always, TestRun (
3588 [["part_disk"; "/dev/sda"; "mbr"];
3589 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3590 "create a swap partition with an explicit UUID",
3592 Create a swap partition on C<device> with UUID C<uuid>.");
3594 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3595 [InitScratchFS, Always, TestOutputStruct (
3596 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3597 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3598 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3599 InitScratchFS, Always, TestOutputStruct (
3600 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3601 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3602 "make block, character or FIFO devices",
3604 This call creates block or character special devices, or
3605 named pipes (FIFOs).
3607 The C<mode> parameter should be the mode, using the standard
3608 constants. C<devmajor> and C<devminor> are the
3609 device major and minor numbers, only used when creating block
3610 and character special devices.
3612 Note that, just like L<mknod(2)>, the mode must be bitwise
3613 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3614 just creates a regular file). These constants are
3615 available in the standard Linux header files, or you can use
3616 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3617 which are wrappers around this command which bitwise OR
3618 in the appropriate constant for you.
3620 The mode actually set is affected by the umask.");
3622 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3623 [InitScratchFS, Always, TestOutputStruct (
3624 [["mkfifo"; "0o777"; "/mkfifo"];
3625 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3626 "make FIFO (named pipe)",
3628 This call creates a FIFO (named pipe) called C<path> with
3629 mode C<mode>. It is just a convenient wrapper around
3632 The mode actually set is affected by the umask.");
3634 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3635 [InitScratchFS, Always, TestOutputStruct (
3636 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3637 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3638 "make block device node",
3640 This call creates a block device node called C<path> with
3641 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3642 It is just a convenient wrapper around C<guestfs_mknod>.
3644 The mode actually set is affected by the umask.");
3646 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3647 [InitScratchFS, Always, TestOutputStruct (
3648 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3649 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3650 "make char device node",
3652 This call creates a char device node called C<path> with
3653 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3654 It is just a convenient wrapper around C<guestfs_mknod>.
3656 The mode actually set is affected by the umask.");
3658 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3659 [InitEmpty, Always, TestOutputInt (
3660 [["umask"; "0o22"]], 0o22)],
3661 "set file mode creation mask (umask)",
3663 This function sets the mask used for creating new files and
3664 device nodes to C<mask & 0777>.
3666 Typical umask values would be C<022> which creates new files
3667 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3668 C<002> which creates new files with permissions like
3669 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3671 The default umask is C<022>. This is important because it
3672 means that directories and device nodes will be created with
3673 C<0644> or C<0755> mode even if you specify C<0777>.
3675 See also C<guestfs_get_umask>,
3676 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3678 This call returns the previous umask.");
3680 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3682 "read directories entries",
3684 This returns the list of directory entries in directory C<dir>.
3686 All entries in the directory are returned, including C<.> and
3687 C<..>. The entries are I<not> sorted, but returned in the same
3688 order as the underlying filesystem.
3690 Also this call returns basic file type information about each
3691 file. The C<ftyp> field will contain one of the following characters:
3729 The L<readdir(3)> call returned a C<d_type> field with an
3734 This function is primarily intended for use by programs. To
3735 get a simple list of names, use C<guestfs_ls>. To get a printable
3736 directory for human consumption, use C<guestfs_ll>.");
3738 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3740 "create partitions on a block device",
3742 This is a simplified interface to the C<guestfs_sfdisk>
3743 command, where partition sizes are specified in megabytes
3744 only (rounded to the nearest cylinder) and you don't need
3745 to specify the cyls, heads and sectors parameters which
3746 were rarely if ever used anyway.
3748 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3749 and C<guestfs_part_disk>");
3751 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3753 "determine file type inside a compressed file",
3755 This command runs C<file> after first decompressing C<path>
3758 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3760 Since 1.0.63, use C<guestfs_file> instead which can now
3761 process compressed files.");
3763 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3765 "list extended attributes of a file or directory",
3767 This call lists the extended attributes of the file or directory
3770 At the system call level, this is a combination of the
3771 L<listxattr(2)> and L<getxattr(2)> calls.
3773 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3775 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3777 "list extended attributes of a file or directory",
3779 This is the same as C<guestfs_getxattrs>, but if C<path>
3780 is a symbolic link, then it returns the extended attributes
3781 of the link itself.");
3783 ("setxattr", (RErr, [String "xattr";
3784 String "val"; Int "vallen"; (* will be BufferIn *)
3785 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3787 "set extended attribute of a file or directory",
3789 This call sets the extended attribute named C<xattr>
3790 of the file C<path> to the value C<val> (of length C<vallen>).
3791 The value is arbitrary 8 bit data.
3793 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3795 ("lsetxattr", (RErr, [String "xattr";
3796 String "val"; Int "vallen"; (* will be BufferIn *)
3797 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3799 "set extended attribute of a file or directory",
3801 This is the same as C<guestfs_setxattr>, but if C<path>
3802 is a symbolic link, then it sets an extended attribute
3803 of the link itself.");
3805 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3807 "remove extended attribute of a file or directory",
3809 This call removes the extended attribute named C<xattr>
3810 of the file C<path>.
3812 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3814 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3816 "remove extended attribute of a file or directory",
3818 This is the same as C<guestfs_removexattr>, but if C<path>
3819 is a symbolic link, then it removes an extended attribute
3820 of the link itself.");
3822 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3826 This call is similar to C<guestfs_mounts>. That call returns
3827 a list of devices. This one returns a hash table (map) of
3828 device name to directory where the device is mounted.");
3830 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3831 (* This is a special case: while you would expect a parameter
3832 * of type "Pathname", that doesn't work, because it implies
3833 * NEED_ROOT in the generated calling code in stubs.c, and
3834 * this function cannot use NEED_ROOT.
3837 "create a mountpoint",
3839 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3840 specialized calls that can be used to create extra mountpoints
3841 before mounting the first filesystem.
3843 These calls are I<only> necessary in some very limited circumstances,
3844 mainly the case where you want to mount a mix of unrelated and/or
3845 read-only filesystems together.
3847 For example, live CDs often contain a \"Russian doll\" nest of
3848 filesystems, an ISO outer layer, with a squashfs image inside, with
3849 an ext2/3 image inside that. You can unpack this as follows
3852 add-ro Fedora-11-i686-Live.iso
3856 mkmountpoint /ext3fs
3858 mount-loop /cd/LiveOS/squashfs.img /sqsh
3859 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3861 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3863 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3864 You may get unexpected errors if you try to mix these calls. It is
3865 safest to manually unmount filesystems and remove mountpoints after use.
3867 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3868 longest first, so for this to work for manual mountpoints, you
3869 must ensure that the innermost mountpoints have the longest
3870 pathnames, as in the example code above.
3872 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3874 Autosync [see C<guestfs_set_autosync>, this is set by default on
3875 handles] can cause C<guestfs_umount_all> to be called when the handle
3876 is closed which can also trigger these issues.");
3878 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3880 "remove a mountpoint",
3882 This calls removes a mountpoint that was previously created
3883 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3884 for full details.");
3886 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3887 [InitISOFS, Always, TestOutputBuffer (
3888 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3889 (* Test various near large, large and too large files (RHBZ#589039). *)
3890 InitScratchFS, Always, TestLastFail (
3891 [["touch"; "/read_file"];
3892 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3893 ["read_file"; "/read_file"]]);
3894 InitScratchFS, Always, TestLastFail (
3895 [["touch"; "/read_file2"];
3896 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3897 ["read_file"; "/read_file2"]]);
3898 InitScratchFS, Always, TestLastFail (
3899 [["touch"; "/read_file3"];
3900 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3901 ["read_file"; "/read_file3"]])],
3904 This calls returns the contents of the file C<path> as a
3907 Unlike C<guestfs_cat>, this function can correctly
3908 handle files that contain embedded ASCII NUL characters.
3909 However unlike C<guestfs_download>, this function is limited
3910 in the total size of file that can be handled.");
3912 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3913 [InitISOFS, Always, TestOutputList (
3914 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3915 InitISOFS, Always, TestOutputList (
3916 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3917 (* Test for RHBZ#579608, absolute symbolic links. *)
3918 InitISOFS, Always, TestOutputList (
3919 [["grep"; "nomatch"; "/abssymlink"]], [])],
3920 "return lines matching a pattern",
3922 This calls the external C<grep> program and returns the
3925 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3926 [InitISOFS, Always, TestOutputList (
3927 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3928 "return lines matching a pattern",
3930 This calls the external C<egrep> program and returns the
3933 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3934 [InitISOFS, Always, TestOutputList (
3935 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3936 "return lines matching a pattern",
3938 This calls the external C<fgrep> program and returns the
3941 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3942 [InitISOFS, Always, TestOutputList (
3943 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3944 "return lines matching a pattern",
3946 This calls the external C<grep -i> program and returns the
3949 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3950 [InitISOFS, Always, TestOutputList (
3951 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3952 "return lines matching a pattern",
3954 This calls the external C<egrep -i> program and returns the
3957 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3958 [InitISOFS, Always, TestOutputList (
3959 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3960 "return lines matching a pattern",
3962 This calls the external C<fgrep -i> program and returns the
3965 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3966 [InitISOFS, Always, TestOutputList (
3967 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3968 "return lines matching a pattern",
3970 This calls the external C<zgrep> program and returns the
3973 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3974 [InitISOFS, Always, TestOutputList (
3975 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3976 "return lines matching a pattern",
3978 This calls the external C<zegrep> program and returns the
3981 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3982 [InitISOFS, Always, TestOutputList (
3983 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3984 "return lines matching a pattern",
3986 This calls the external C<zfgrep> program and returns the
3989 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3990 [InitISOFS, Always, TestOutputList (
3991 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3992 "return lines matching a pattern",
3994 This calls the external C<zgrep -i> program and returns the
3997 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3998 [InitISOFS, Always, TestOutputList (
3999 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4000 "return lines matching a pattern",
4002 This calls the external C<zegrep -i> program and returns the
4005 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4006 [InitISOFS, Always, TestOutputList (
4007 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4008 "return lines matching a pattern",
4010 This calls the external C<zfgrep -i> program and returns the
4013 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4014 [InitISOFS, Always, TestOutput (
4015 [["realpath"; "/../directory"]], "/directory")],
4016 "canonicalized absolute pathname",
4018 Return the canonicalized absolute pathname of C<path>. The
4019 returned path has no C<.>, C<..> or symbolic link path elements.");
4021 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4022 [InitScratchFS, Always, TestOutputStruct (
4025 ["ln"; "/ln/a"; "/ln/b"];
4026 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4027 "create a hard link",
4029 This command creates a hard link using the C<ln> command.");
4031 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4032 [InitScratchFS, Always, TestOutputStruct (
4033 [["mkdir"; "/ln_f"];
4034 ["touch"; "/ln_f/a"];
4035 ["touch"; "/ln_f/b"];
4036 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4037 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4038 "create a hard link",
4040 This command creates a hard link using the C<ln -f> command.
4041 The C<-f> option removes the link (C<linkname>) if it exists already.");
4043 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4044 [InitScratchFS, Always, TestOutputStruct (
4045 [["mkdir"; "/ln_s"];
4046 ["touch"; "/ln_s/a"];
4047 ["ln_s"; "a"; "/ln_s/b"];
4048 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4049 "create a symbolic link",
4051 This command creates a symbolic link using the C<ln -s> command.");
4053 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4054 [InitScratchFS, Always, TestOutput (
4055 [["mkdir_p"; "/ln_sf/b"];
4056 ["touch"; "/ln_sf/b/c"];
4057 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4058 ["readlink"; "/ln_sf/b/c"]], "../d")],
4059 "create a symbolic link",
4061 This command creates a symbolic link using the C<ln -sf> command,
4062 The C<-f> option removes the link (C<linkname>) if it exists already.");
4064 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4065 [] (* XXX tested above *),
4066 "read the target of a symbolic link",
4068 This command reads the target of a symbolic link.");
4070 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4071 [InitScratchFS, Always, TestOutputStruct (
4072 [["fallocate"; "/fallocate"; "1000000"];
4073 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4074 "preallocate a file in the guest filesystem",
4076 This command preallocates a file (containing zero bytes) named
4077 C<path> of size C<len> bytes. If the file exists already, it
4080 Do not confuse this with the guestfish-specific
4081 C<alloc> command which allocates a file in the host and
4082 attaches it as a device.");
4084 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4085 [InitPartition, Always, TestRun (
4086 [["mkswap"; "/dev/sda1"];
4087 ["swapon_device"; "/dev/sda1"];
4088 ["swapoff_device"; "/dev/sda1"]])],
4089 "enable swap on device",
4091 This command enables the libguestfs appliance to use the
4092 swap device or partition named C<device>. The increased
4093 memory is made available for all commands, for example
4094 those run using C<guestfs_command> or C<guestfs_sh>.
4096 Note that you should not swap to existing guest swap
4097 partitions unless you know what you are doing. They may
4098 contain hibernation information, or other information that
4099 the guest doesn't want you to trash. You also risk leaking
4100 information about the host to the guest this way. Instead,
4101 attach a new host device to the guest and swap on that.");
4103 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4104 [], (* XXX tested by swapon_device *)
4105 "disable swap on device",
4107 This command disables the libguestfs appliance swap
4108 device or partition named C<device>.
4109 See C<guestfs_swapon_device>.");
4111 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4112 [InitScratchFS, Always, TestRun (
4113 [["fallocate"; "/swapon_file"; "8388608"];
4114 ["mkswap_file"; "/swapon_file"];
4115 ["swapon_file"; "/swapon_file"];
4116 ["swapoff_file"; "/swapon_file"];
4117 ["rm"; "/swapon_file"]])],
4118 "enable swap on file",
4120 This command enables swap to a file.
4121 See C<guestfs_swapon_device> for other notes.");
4123 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4124 [], (* XXX tested by swapon_file *)
4125 "disable swap on file",
4127 This command disables the libguestfs appliance swap on file.");
4129 ("swapon_label", (RErr, [String "label"], []), 174, [],
4130 [InitEmpty, Always, TestRun (
4131 [["part_disk"; "/dev/sda"; "mbr"];
4132 ["mkswap_L"; "swapit"; "/dev/sda1"];
4133 ["swapon_label"; "swapit"];
4134 ["swapoff_label"; "swapit"];
4135 ["zero"; "/dev/sda"];
4136 ["blockdev_rereadpt"; "/dev/sda"]])],
4137 "enable swap on labeled swap partition",
4139 This command enables swap to a labeled swap partition.
4140 See C<guestfs_swapon_device> for other notes.");
4142 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4143 [], (* XXX tested by swapon_label *)
4144 "disable swap on labeled swap partition",
4146 This command disables the libguestfs appliance swap on
4147 labeled swap partition.");
4149 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4150 (let uuid = uuidgen () in
4151 [InitEmpty, Always, TestRun (
4152 [["mkswap_U"; uuid; "/dev/sdc"];
4153 ["swapon_uuid"; uuid];
4154 ["swapoff_uuid"; uuid]])]),
4155 "enable swap on swap partition by UUID",
4157 This command enables swap to a swap partition with the given UUID.
4158 See C<guestfs_swapon_device> for other notes.");
4160 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4161 [], (* XXX tested by swapon_uuid *)
4162 "disable swap on swap partition by UUID",
4164 This command disables the libguestfs appliance swap partition
4165 with the given UUID.");
4167 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4168 [InitScratchFS, Always, TestRun (
4169 [["fallocate"; "/mkswap_file"; "8388608"];
4170 ["mkswap_file"; "/mkswap_file"];
4171 ["rm"; "/mkswap_file"]])],
4172 "create a swap file",
4176 This command just writes a swap file signature to an existing
4177 file. To create the file itself, use something like C<guestfs_fallocate>.");
4179 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4180 [InitISOFS, Always, TestRun (
4181 [["inotify_init"; "0"]])],
4182 "create an inotify handle",
4184 This command creates a new inotify handle.
4185 The inotify subsystem can be used to notify events which happen to
4186 objects in the guest filesystem.
4188 C<maxevents> is the maximum number of events which will be
4189 queued up between calls to C<guestfs_inotify_read> or
4190 C<guestfs_inotify_files>.
4191 If this is passed as C<0>, then the kernel (or previously set)
4192 default is used. For Linux 2.6.29 the default was 16384 events.
4193 Beyond this limit, the kernel throws away events, but records
4194 the fact that it threw them away by setting a flag
4195 C<IN_Q_OVERFLOW> in the returned structure list (see
4196 C<guestfs_inotify_read>).
4198 Before any events are generated, you have to add some
4199 watches to the internal watch list. See:
4200 C<guestfs_inotify_add_watch>,
4201 C<guestfs_inotify_rm_watch> and
4202 C<guestfs_inotify_watch_all>.
4204 Queued up events should be read periodically by calling
4205 C<guestfs_inotify_read>
4206 (or C<guestfs_inotify_files> which is just a helpful
4207 wrapper around C<guestfs_inotify_read>). If you don't
4208 read the events out often enough then you risk the internal
4211 The handle should be closed after use by calling
4212 C<guestfs_inotify_close>. This also removes any
4213 watches automatically.
4215 See also L<inotify(7)> for an overview of the inotify interface
4216 as exposed by the Linux kernel, which is roughly what we expose
4217 via libguestfs. Note that there is one global inotify handle
4218 per libguestfs instance.");
4220 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4221 [InitScratchFS, Always, TestOutputList (
4222 [["mkdir"; "/inotify_add_watch"];
4223 ["inotify_init"; "0"];
4224 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4225 ["touch"; "/inotify_add_watch/a"];
4226 ["touch"; "/inotify_add_watch/b"];
4227 ["inotify_files"]], ["a"; "b"])],
4228 "add an inotify watch",
4230 Watch C<path> for the events listed in C<mask>.
4232 Note that if C<path> is a directory then events within that
4233 directory are watched, but this does I<not> happen recursively
4234 (in subdirectories).
4236 Note for non-C or non-Linux callers: the inotify events are
4237 defined by the Linux kernel ABI and are listed in
4238 C</usr/include/sys/inotify.h>.");
4240 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4242 "remove an inotify watch",
4244 Remove a previously defined inotify watch.
4245 See C<guestfs_inotify_add_watch>.");
4247 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4249 "return list of inotify events",
4251 Return the complete queue of events that have happened
4252 since the previous read call.
4254 If no events have happened, this returns an empty list.
4256 I<Note>: In order to make sure that all events have been
4257 read, you must call this function repeatedly until it
4258 returns an empty list. The reason is that the call will
4259 read events up to the maximum appliance-to-host message
4260 size and leave remaining events in the queue.");
4262 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4264 "return list of watched files that had events",
4266 This function is a helpful wrapper around C<guestfs_inotify_read>
4267 which just returns a list of pathnames of objects that were
4268 touched. The returned pathnames are sorted and deduplicated.");
4270 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4272 "close the inotify handle",
4274 This closes the inotify handle which was previously
4275 opened by inotify_init. It removes all watches, throws
4276 away any pending events, and deallocates all resources.");
4278 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4280 "set SELinux security context",
4282 This sets the SELinux security context of the daemon
4283 to the string C<context>.
4285 See the documentation about SELINUX in L<guestfs(3)>.");
4287 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4289 "get SELinux security context",
4291 This gets the SELinux security context of the daemon.
4293 See the documentation about SELINUX in L<guestfs(3)>,
4294 and C<guestfs_setcon>");
4296 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4297 [InitEmpty, Always, TestOutput (
4298 [["part_disk"; "/dev/sda"; "mbr"];
4299 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4300 ["mount_options"; ""; "/dev/sda1"; "/"];
4301 ["write"; "/new"; "new file contents"];
4302 ["cat"; "/new"]], "new file contents");
4303 InitEmpty, Always, TestRun (
4304 [["part_disk"; "/dev/sda"; "mbr"];
4305 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4306 InitEmpty, Always, TestLastFail (
4307 [["part_disk"; "/dev/sda"; "mbr"];
4308 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4309 InitEmpty, Always, TestLastFail (
4310 [["part_disk"; "/dev/sda"; "mbr"];
4311 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4312 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4313 [["part_disk"; "/dev/sda"; "mbr"];
4314 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4315 "make a filesystem with block size",
4317 This call is similar to C<guestfs_mkfs>, but it allows you to
4318 control the block size of the resulting filesystem. Supported
4319 block sizes depend on the filesystem type, but typically they
4320 are C<1024>, C<2048> or C<4096> only.
4322 For VFAT and NTFS the C<blocksize> parameter is treated as
4323 the requested cluster size.");
4325 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4326 [InitEmpty, Always, TestOutput (
4327 [["part_init"; "/dev/sda"; "mbr"];
4328 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4329 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4330 ["mke2journal"; "4096"; "/dev/sda1"];
4331 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4332 ["mount_options"; ""; "/dev/sda2"; "/"];
4333 ["write"; "/new"; "new file contents"];
4334 ["cat"; "/new"]], "new file contents")],
4335 "make ext2/3/4 external journal",
4337 This creates an ext2 external journal on C<device>. It is equivalent
4340 mke2fs -O journal_dev -b blocksize device");
4342 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4343 [InitEmpty, Always, TestOutput (
4344 [["part_init"; "/dev/sda"; "mbr"];
4345 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4346 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4347 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4348 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4349 ["mount_options"; ""; "/dev/sda2"; "/"];
4350 ["write"; "/new"; "new file contents"];
4351 ["cat"; "/new"]], "new file contents")],
4352 "make ext2/3/4 external journal with label",
4354 This creates an ext2 external journal on C<device> with label C<label>.");
4356 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4357 (let uuid = uuidgen () in
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_U"; "4096"; uuid; "/dev/sda1"];
4363 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
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 UUID",
4369 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4371 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4373 "make ext2/3/4 filesystem with external journal",
4375 This creates an ext2/3/4 filesystem on C<device> with
4376 an external journal on C<journal>. It is equivalent
4379 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4381 See also C<guestfs_mke2journal>.");
4383 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4385 "make ext2/3/4 filesystem with external journal",
4387 This creates an ext2/3/4 filesystem on C<device> with
4388 an external journal on the journal labeled C<label>.
4390 See also C<guestfs_mke2journal_L>.");
4392 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4394 "make ext2/3/4 filesystem with external journal",
4396 This creates an ext2/3/4 filesystem on C<device> with
4397 an external journal on the journal with UUID C<uuid>.
4399 See also C<guestfs_mke2journal_U>.");
4401 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4402 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4403 "load a kernel module",
4405 This loads a kernel module in the appliance.
4407 The kernel module must have been whitelisted when libguestfs
4408 was built (see C<appliance/kmod.whitelist.in> in the source).");
4410 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4411 [InitNone, Always, TestOutput (
4412 [["echo_daemon"; "This is a test"]], "This is a test"
4414 "echo arguments back to the client",
4416 This command concatenates the list of C<words> passed with single spaces
4417 between them and returns the resulting string.
4419 You can use this command to test the connection through to the daemon.
4421 See also C<guestfs_ping_daemon>.");
4423 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4424 [], (* There is a regression test for this. *)
4425 "find all files and directories, returning NUL-separated list",
4427 This command lists out all files and directories, recursively,
4428 starting at C<directory>, placing the resulting list in the
4429 external file called C<files>.
4431 This command works the same way as C<guestfs_find> with the
4432 following exceptions:
4438 The resulting list is written to an external file.
4442 Items (filenames) in the result are separated
4443 by C<\\0> characters. See L<find(1)> option I<-print0>.
4447 This command is not limited in the number of names that it
4452 The result list is not sorted.
4456 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4457 [InitISOFS, Always, TestOutput (
4458 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4459 InitISOFS, Always, TestOutput (
4460 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4461 InitISOFS, Always, TestOutput (
4462 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4463 InitISOFS, Always, TestLastFail (
4464 [["case_sensitive_path"; "/Known-1/"]]);
4465 InitScratchFS, Always, TestOutput (
4466 [["mkdir"; "/case_sensitive_path"];
4467 ["mkdir"; "/case_sensitive_path/bbb"];
4468 ["touch"; "/case_sensitive_path/bbb/c"];
4469 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4470 InitScratchFS, Always, TestOutput (
4471 [["mkdir"; "/case_sensitive_path2"];
4472 ["mkdir"; "/case_sensitive_path2/bbb"];
4473 ["touch"; "/case_sensitive_path2/bbb/c"];
4474 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4475 InitScratchFS, Always, TestLastFail (
4476 [["mkdir"; "/case_sensitive_path3"];
4477 ["mkdir"; "/case_sensitive_path3/bbb"];
4478 ["touch"; "/case_sensitive_path3/bbb/c"];
4479 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4480 "return true path on case-insensitive filesystem",
4482 This can be used to resolve case insensitive paths on
4483 a filesystem which is case sensitive. The use case is
4484 to resolve paths which you have read from Windows configuration
4485 files or the Windows Registry, to the true path.
4487 The command handles a peculiarity of the Linux ntfs-3g
4488 filesystem driver (and probably others), which is that although
4489 the underlying filesystem is case-insensitive, the driver
4490 exports the filesystem to Linux as case-sensitive.
4492 One consequence of this is that special directories such
4493 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4494 (or other things) depending on the precise details of how
4495 they were created. In Windows itself this would not be
4498 Bug or feature? You decide:
4499 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4501 This function resolves the true case of each element in the
4502 path and returns the case-sensitive path.
4504 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4505 might return C<\"/WINDOWS/system32\"> (the exact return value
4506 would depend on details of how the directories were originally
4507 created under Windows).
4510 This function does not handle drive names, backslashes etc.
4512 See also C<guestfs_realpath>.");
4514 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4515 [InitScratchFS, Always, TestOutput (
4516 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4517 "get the Linux VFS type corresponding to a mounted device",
4519 This command gets the filesystem type corresponding to
4520 the filesystem on C<device>.
4522 For most filesystems, the result is the name of the Linux
4523 VFS module which would be used to mount this filesystem
4524 if you mounted it without specifying the filesystem type.
4525 For example a string such as C<ext3> or C<ntfs>.");
4527 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4528 [InitScratchFS, Always, TestOutputStruct (
4529 [["write"; "/truncate"; "some stuff so size is not zero"];
4530 ["truncate"; "/truncate"];
4531 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4532 "truncate a file to zero size",
4534 This command truncates C<path> to a zero-length file. The
4535 file must exist already.");
4537 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4538 [InitScratchFS, Always, TestOutputStruct (
4539 [["touch"; "/truncate_size"];
4540 ["truncate_size"; "/truncate_size"; "1000"];
4541 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4542 "truncate a file to a particular size",
4544 This command truncates C<path> to size C<size> bytes. The file
4547 If the current file size is less than C<size> then
4548 the file is extended to the required size with zero bytes.
4549 This creates a sparse file (ie. disk blocks are not allocated
4550 for the file until you write to it). To create a non-sparse
4551 file of zeroes, use C<guestfs_fallocate64> instead.");
4553 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4554 [InitScratchFS, Always, TestOutputStruct (
4555 [["touch"; "/utimens"];
4556 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4557 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4558 "set timestamp of a file with nanosecond precision",
4560 This command sets the timestamps of a file with nanosecond
4563 C<atsecs, atnsecs> are the last access time (atime) in secs and
4564 nanoseconds from the epoch.
4566 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4567 secs and nanoseconds from the epoch.
4569 If the C<*nsecs> field contains the special value C<-1> then
4570 the corresponding timestamp is set to the current time. (The
4571 C<*secs> field is ignored in this case).
4573 If the C<*nsecs> field contains the special value C<-2> then
4574 the corresponding timestamp is left unchanged. (The
4575 C<*secs> field is ignored in this case).");
4577 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4578 [InitScratchFS, Always, TestOutputStruct (
4579 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4580 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4581 "create a directory with a particular mode",
4583 This command creates a directory, setting the initial permissions
4584 of the directory to C<mode>.
4586 For common Linux filesystems, the actual mode which is set will
4587 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4588 interpret the mode in other ways.
4590 See also C<guestfs_mkdir>, C<guestfs_umask>");
4592 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4594 "change file owner and group",
4596 Change the file owner to C<owner> and group to C<group>.
4597 This is like C<guestfs_chown> but if C<path> is a symlink then
4598 the link itself is changed, not the target.
4600 Only numeric uid and gid are supported. If you want to use
4601 names, you will need to locate and parse the password file
4602 yourself (Augeas support makes this relatively easy).");
4604 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4606 "lstat on multiple files",
4608 This call allows you to perform the C<guestfs_lstat> operation
4609 on multiple files, where all files are in the directory C<path>.
4610 C<names> is the list of files from this directory.
4612 On return you get a list of stat structs, with a one-to-one
4613 correspondence to the C<names> list. If any name did not exist
4614 or could not be lstat'd, then the C<ino> field of that structure
4617 This call is intended for programs that want to efficiently
4618 list a directory contents without making many round-trips.
4619 See also C<guestfs_lxattrlist> for a similarly efficient call
4620 for getting extended attributes. Very long directory listings
4621 might cause the protocol message size to be exceeded, causing
4622 this call to fail. The caller must split up such requests
4623 into smaller groups of names.");
4625 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4627 "lgetxattr on multiple files",
4629 This call allows you to get the extended attributes
4630 of multiple files, where all files are in the directory C<path>.
4631 C<names> is the list of files from this directory.
4633 On return you get a flat list of xattr structs which must be
4634 interpreted sequentially. The first xattr struct always has a zero-length
4635 C<attrname>. C<attrval> in this struct is zero-length
4636 to indicate there was an error doing C<lgetxattr> for this
4637 file, I<or> is a C string which is a decimal number
4638 (the number of following attributes for this file, which could
4639 be C<\"0\">). Then after the first xattr struct are the
4640 zero or more attributes for the first named file.
4641 This repeats for the second and subsequent files.
4643 This call is intended for programs that want to efficiently
4644 list a directory contents without making many round-trips.
4645 See also C<guestfs_lstatlist> for a similarly efficient call
4646 for getting standard stats. Very long directory listings
4647 might cause the protocol message size to be exceeded, causing
4648 this call to fail. The caller must split up such requests
4649 into smaller groups of names.");
4651 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4653 "readlink on multiple files",
4655 This call allows you to do a C<readlink> operation
4656 on multiple files, where all files are in the directory C<path>.
4657 C<names> is the list of files from this directory.
4659 On return you get a list of strings, with a one-to-one
4660 correspondence to the C<names> list. Each string is the
4661 value of the symbolic link.
4663 If the C<readlink(2)> operation fails on any name, then
4664 the corresponding result string is the empty string C<\"\">.
4665 However the whole operation is completed even if there
4666 were C<readlink(2)> errors, and so you can call this
4667 function with names where you don't know if they are
4668 symbolic links already (albeit slightly less efficient).
4670 This call is intended for programs that want to efficiently
4671 list a directory contents without making many round-trips.
4672 Very long directory listings might cause the protocol
4673 message size to be exceeded, causing
4674 this call to fail. The caller must split up such requests
4675 into smaller groups of names.");
4677 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4678 [InitISOFS, Always, TestOutputBuffer (
4679 [["pread"; "/known-4"; "1"; "3"]], "\n");
4680 InitISOFS, Always, TestOutputBuffer (
4681 [["pread"; "/empty"; "0"; "100"]], "")],
4682 "read part of a file",
4684 This command lets you read part of a file. It reads C<count>
4685 bytes of the file, starting at C<offset>, from file C<path>.
4687 This may read fewer bytes than requested. For further details
4688 see the L<pread(2)> system call.
4690 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4692 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4693 [InitEmpty, Always, TestRun (
4694 [["part_init"; "/dev/sda"; "gpt"]])],
4695 "create an empty partition table",
4697 This creates an empty partition table on C<device> of one of the
4698 partition types listed below. Usually C<parttype> should be
4699 either C<msdos> or C<gpt> (for large disks).
4701 Initially there are no partitions. Following this, you should
4702 call C<guestfs_part_add> for each partition required.
4704 Possible values for C<parttype> are:
4708 =item B<efi> | B<gpt>
4710 Intel EFI / GPT partition table.
4712 This is recommended for >= 2 TB partitions that will be accessed
4713 from Linux and Intel-based Mac OS X. It also has limited backwards
4714 compatibility with the C<mbr> format.
4716 =item B<mbr> | B<msdos>
4718 The standard PC \"Master Boot Record\" (MBR) format used
4719 by MS-DOS and Windows. This partition type will B<only> work
4720 for device sizes up to 2 TB. For large disks we recommend
4725 Other partition table types that may work but are not
4734 =item B<amiga> | B<rdb>
4736 Amiga \"Rigid Disk Block\" format.
4744 DASD, used on IBM mainframes.
4752 Old Mac partition format. Modern Macs use C<gpt>.
4756 NEC PC-98 format, common in Japan apparently.
4764 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4765 [InitEmpty, Always, TestRun (
4766 [["part_init"; "/dev/sda"; "mbr"];
4767 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4768 InitEmpty, Always, TestRun (
4769 [["part_init"; "/dev/sda"; "gpt"];
4770 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4771 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4772 InitEmpty, Always, TestRun (
4773 [["part_init"; "/dev/sda"; "mbr"];
4774 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4775 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4776 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4777 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4778 "add a partition to the device",
4780 This command adds a partition to C<device>. If there is no partition
4781 table on the device, call C<guestfs_part_init> first.
4783 The C<prlogex> parameter is the type of partition. Normally you
4784 should pass C<p> or C<primary> here, but MBR partition tables also
4785 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4788 C<startsect> and C<endsect> are the start and end of the partition
4789 in I<sectors>. C<endsect> may be negative, which means it counts
4790 backwards from the end of the disk (C<-1> is the last sector).
4792 Creating a partition which covers the whole disk is not so easy.
4793 Use C<guestfs_part_disk> to do that.");
4795 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4796 [InitEmpty, Always, TestRun (
4797 [["part_disk"; "/dev/sda"; "mbr"]]);
4798 InitEmpty, Always, TestRun (
4799 [["part_disk"; "/dev/sda"; "gpt"]])],
4800 "partition whole disk with a single primary partition",
4802 This command is simply a combination of C<guestfs_part_init>
4803 followed by C<guestfs_part_add> to create a single primary partition
4804 covering the whole disk.
4806 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4807 but other possible values are described in C<guestfs_part_init>.");
4809 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4810 [InitEmpty, Always, TestRun (
4811 [["part_disk"; "/dev/sda"; "mbr"];
4812 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4813 "make a partition bootable",
4815 This sets the bootable flag on partition numbered C<partnum> on
4816 device C<device>. Note that partitions are numbered from 1.
4818 The bootable flag is used by some operating systems (notably
4819 Windows) to determine which partition to boot from. It is by
4820 no means universally recognized.");
4822 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4823 [InitEmpty, Always, TestRun (
4824 [["part_disk"; "/dev/sda"; "gpt"];
4825 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4826 "set partition name",
4828 This sets the partition name on partition numbered C<partnum> on
4829 device C<device>. Note that partitions are numbered from 1.
4831 The partition name can only be set on certain types of partition
4832 table. This works on C<gpt> but not on C<mbr> partitions.");
4834 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4835 [], (* XXX Add a regression test for this. *)
4836 "list partitions on a device",
4838 This command parses the partition table on C<device> and
4839 returns the list of partitions found.
4841 The fields in the returned structure are:
4847 Partition number, counting from 1.
4851 Start of the partition I<in bytes>. To get sectors you have to
4852 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4856 End of the partition in bytes.
4860 Size of the partition in bytes.
4864 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4865 [InitEmpty, Always, TestOutput (
4866 [["part_disk"; "/dev/sda"; "gpt"];
4867 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4868 "get the partition table type",
4870 This command examines the partition table on C<device> and
4871 returns the partition table type (format) being used.
4873 Common return values include: C<msdos> (a DOS/Windows style MBR
4874 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4875 values are possible, although unusual. See C<guestfs_part_init>
4878 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4879 [InitScratchFS, Always, TestOutputBuffer (
4880 [["fill"; "0x63"; "10"; "/fill"];
4881 ["read_file"; "/fill"]], "cccccccccc")],
4882 "fill a file with octets",
4884 This command creates a new file called C<path>. The initial
4885 content of the file is C<len> octets of C<c>, where C<c>
4886 must be a number in the range C<[0..255]>.
4888 To fill a file with zero bytes (sparsely), it is
4889 much more efficient to use C<guestfs_truncate_size>.
4890 To create a file with a pattern of repeating bytes
4891 use C<guestfs_fill_pattern>.");
4893 ("available", (RErr, [StringList "groups"], []), 216, [],
4894 [InitNone, Always, TestRun [["available"; ""]]],
4895 "test availability of some parts of the API",
4897 This command is used to check the availability of some
4898 groups of functionality in the appliance, which not all builds of
4899 the libguestfs appliance will be able to provide.
4901 The libguestfs groups, and the functions that those
4902 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4903 You can also fetch this list at runtime by calling
4904 C<guestfs_available_all_groups>.
4906 The argument C<groups> is a list of group names, eg:
4907 C<[\"inotify\", \"augeas\"]> would check for the availability of
4908 the Linux inotify functions and Augeas (configuration file
4911 The command returns no error if I<all> requested groups are available.
4913 It fails with an error if one or more of the requested
4914 groups is unavailable in the appliance.
4916 If an unknown group name is included in the
4917 list of groups then an error is always returned.
4925 You must call C<guestfs_launch> before calling this function.
4927 The reason is because we don't know what groups are
4928 supported by the appliance/daemon until it is running and can
4933 If a group of functions is available, this does not necessarily
4934 mean that they will work. You still have to check for errors
4935 when calling individual API functions even if they are
4940 It is usually the job of distro packagers to build
4941 complete functionality into the libguestfs appliance.
4942 Upstream libguestfs, if built from source with all
4943 requirements satisfied, will support everything.
4947 This call was added in version C<1.0.80>. In previous
4948 versions of libguestfs all you could do would be to speculatively
4949 execute a command to find out if the daemon implemented it.
4950 See also C<guestfs_version>.
4954 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4955 [InitScratchFS, Always, TestOutputBuffer (
4957 ["write"; "/dd/src"; "hello, world"];
4958 ["dd"; "/dd/src"; "/dd/dest"];
4959 ["read_file"; "/dd/dest"]], "hello, world")],
4960 "copy from source to destination using dd",
4962 This command copies from one source device or file C<src>
4963 to another destination device or file C<dest>. Normally you
4964 would use this to copy to or from a device or partition, for
4965 example to duplicate a filesystem.
4967 If the destination is a device, it must be as large or larger
4968 than the source file or device, otherwise the copy will fail.
4969 This command cannot do partial copies (see C<guestfs_copy_size>).");
4971 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4972 [InitScratchFS, Always, TestOutputInt (
4973 [["write"; "/filesize"; "hello, world"];
4974 ["filesize"; "/filesize"]], 12)],
4975 "return the size of the file in bytes",
4977 This command returns the size of C<file> in bytes.
4979 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4980 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4981 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4983 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4984 [InitBasicFSonLVM, Always, TestOutputList (
4985 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4986 ["lvs"]], ["/dev/VG/LV2"])],
4987 "rename an LVM logical volume",
4989 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4991 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4992 [InitBasicFSonLVM, Always, TestOutputList (
4994 ["vg_activate"; "false"; "VG"];
4995 ["vgrename"; "VG"; "VG2"];
4996 ["vg_activate"; "true"; "VG2"];
4997 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4998 ["vgs"]], ["VG2"])],
4999 "rename an LVM volume group",
5001 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5003 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5004 [InitISOFS, Always, TestOutputBuffer (
5005 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5006 "list the contents of a single file in an initrd",
5008 This command unpacks the file C<filename> from the initrd file
5009 called C<initrdpath>. The filename must be given I<without> the
5010 initial C</> character.
5012 For example, in guestfish you could use the following command
5013 to examine the boot script (usually called C</init>)
5014 contained in a Linux initrd or initramfs image:
5016 initrd-cat /boot/initrd-<version>.img init
5018 See also C<guestfs_initrd_list>.");
5020 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5022 "get the UUID of a physical volume",
5024 This command returns the UUID of the LVM PV C<device>.");
5026 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5028 "get the UUID of a volume group",
5030 This command returns the UUID of the LVM VG named C<vgname>.");
5032 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5034 "get the UUID of a logical volume",
5036 This command returns the UUID of the LVM LV C<device>.");
5038 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5040 "get the PV UUIDs containing the volume group",
5042 Given a VG called C<vgname>, this returns the UUIDs of all
5043 the physical volumes that this volume group resides on.
5045 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5046 calls to associate physical volumes and volume groups.
5048 See also C<guestfs_vglvuuids>.");
5050 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5052 "get the LV UUIDs of all LVs in the volume group",
5054 Given a VG called C<vgname>, this returns the UUIDs of all
5055 the logical volumes created in this volume group.
5057 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5058 calls to associate logical volumes and volume groups.
5060 See also C<guestfs_vgpvuuids>.");
5062 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5063 [InitScratchFS, Always, TestOutputBuffer (
5064 [["mkdir"; "/copy_size"];
5065 ["write"; "/copy_size/src"; "hello, world"];
5066 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5067 ["read_file"; "/copy_size/dest"]], "hello")],
5068 "copy size bytes from source to destination using dd",
5070 This command copies exactly C<size> bytes from one source device
5071 or file C<src> to another destination device or file C<dest>.
5073 Note this will fail if the source is too short or if the destination
5074 is not large enough.");
5076 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5077 [InitBasicFSonLVM, Always, TestRun (
5078 [["zero_device"; "/dev/VG/LV"]])],
5079 "write zeroes to an entire device",
5081 This command writes zeroes over the entire C<device>. Compare
5082 with C<guestfs_zero> which just zeroes the first few blocks of
5085 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5086 [InitScratchFS, Always, TestOutput (
5087 [["mkdir"; "/txz_in"];
5088 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5089 ["cat"; "/txz_in/hello"]], "hello\n")],
5090 "unpack compressed tarball to directory",
5092 This command uploads and unpacks local file C<tarball> (an
5093 I<xz compressed> tar file) into C<directory>.");
5095 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5097 "pack directory into compressed tarball",
5099 This command packs the contents of C<directory> and downloads
5100 it to local file C<tarball> (as an xz compressed tar archive).");
5102 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5104 "resize an NTFS filesystem",
5106 This command resizes an NTFS filesystem, expanding or
5107 shrinking it to the size of the underlying device.
5108 See also L<ntfsresize(8)>.");
5110 ("vgscan", (RErr, [], []), 232, [],
5111 [InitEmpty, Always, TestRun (
5113 "rescan for LVM physical volumes, volume groups and logical volumes",
5115 This rescans all block devices and rebuilds the list of LVM
5116 physical volumes, volume groups and logical volumes.");
5118 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5119 [InitEmpty, Always, TestRun (
5120 [["part_init"; "/dev/sda"; "mbr"];
5121 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5122 ["part_del"; "/dev/sda"; "1"]])],
5123 "delete a partition",
5125 This command deletes the partition numbered C<partnum> on C<device>.
5127 Note that in the case of MBR partitioning, deleting an
5128 extended partition also deletes any logical partitions
5131 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5132 [InitEmpty, Always, TestOutputTrue (
5133 [["part_init"; "/dev/sda"; "mbr"];
5134 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5135 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5136 ["part_get_bootable"; "/dev/sda"; "1"]])],
5137 "return true if a partition is bootable",
5139 This command returns true if the partition C<partnum> on
5140 C<device> has the bootable flag set.
5142 See also C<guestfs_part_set_bootable>.");
5144 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5145 [InitEmpty, Always, TestOutputInt (
5146 [["part_init"; "/dev/sda"; "mbr"];
5147 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5148 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5149 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5150 "get the MBR type byte (ID byte) from a partition",
5152 Returns the MBR type byte (also known as the ID byte) from
5153 the numbered partition C<partnum>.
5155 Note that only MBR (old DOS-style) partitions have type bytes.
5156 You will get undefined results for other partition table
5157 types (see C<guestfs_part_get_parttype>).");
5159 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5160 [], (* tested by part_get_mbr_id *)
5161 "set the MBR type byte (ID byte) of a partition",
5163 Sets the MBR type byte (also known as the ID byte) of
5164 the numbered partition C<partnum> to C<idbyte>. Note
5165 that the type bytes quoted in most documentation are
5166 in fact hexadecimal numbers, but usually documented
5167 without any leading \"0x\" which might be confusing.
5169 Note that only MBR (old DOS-style) partitions have type bytes.
5170 You will get undefined results for other partition table
5171 types (see C<guestfs_part_get_parttype>).");
5173 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5174 [InitISOFS, Always, TestOutputFileMD5 (
5175 [["checksum_device"; "md5"; "/dev/sdd"]],
5176 "../images/test.iso")],
5177 "compute MD5, SHAx or CRC checksum of the contents of a device",
5179 This call computes the MD5, SHAx or CRC checksum of the
5180 contents of the device named C<device>. For the types of
5181 checksums supported see the C<guestfs_checksum> command.");
5183 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5184 [InitNone, Always, TestRun (
5185 [["part_disk"; "/dev/sda"; "mbr"];
5186 ["pvcreate"; "/dev/sda1"];
5187 ["vgcreate"; "VG"; "/dev/sda1"];
5188 ["lvcreate"; "LV"; "VG"; "10"];
5189 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5190 "expand an LV to fill free space",
5192 This expands an existing logical volume C<lv> so that it fills
5193 C<pc>% of the remaining free space in the volume group. Commonly
5194 you would call this with pc = 100 which expands the logical volume
5195 as much as possible, using all remaining free space in the volume
5198 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5199 [], (* XXX Augeas code needs tests. *)
5200 "clear Augeas path",
5202 Set the value associated with C<path> to C<NULL>. This
5203 is the same as the L<augtool(1)> C<clear> command.");
5205 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5206 [InitEmpty, Always, TestOutputInt (
5207 [["get_umask"]], 0o22)],
5208 "get the current umask",
5210 Return the current umask. By default the umask is C<022>
5211 unless it has been set by calling C<guestfs_umask>.");
5213 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5215 "upload a file to the appliance (internal use only)",
5217 The C<guestfs_debug_upload> command uploads a file to
5218 the libguestfs appliance.
5220 There is no comprehensive help for this command. You have
5221 to look at the file C<daemon/debug.c> in the libguestfs source
5222 to find out what it is for.");
5224 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5225 [InitScratchFS, Always, TestOutput (
5226 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5227 ["cat"; "/base64_in"]], "hello\n")],
5228 "upload base64-encoded data to file",
5230 This command uploads base64-encoded data from C<base64file>
5233 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5235 "download file and encode as base64",
5237 This command downloads the contents of C<filename>, writing
5238 it out to local file C<base64file> encoded as base64.");
5240 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5242 "compute MD5, SHAx or CRC checksum of files in a directory",
5244 This command computes the checksums of all regular files in
5245 C<directory> and then emits a list of those checksums to
5246 the local output file C<sumsfile>.
5248 This can be used for verifying the integrity of a virtual
5249 machine. However to be properly secure you should pay
5250 attention to the output of the checksum command (it uses
5251 the ones from GNU coreutils). In particular when the
5252 filename is not printable, coreutils uses a special
5253 backslash syntax. For more information, see the GNU
5254 coreutils info file.");
5256 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5257 [InitScratchFS, Always, TestOutputBuffer (
5258 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5259 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5260 "fill a file with a repeating pattern of bytes",
5262 This function is like C<guestfs_fill> except that it creates
5263 a new file of length C<len> containing the repeating pattern
5264 of bytes in C<pattern>. The pattern is truncated if necessary
5265 to ensure the length of the file is exactly C<len> bytes.");
5267 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5268 [InitScratchFS, Always, TestOutput (
5269 [["write"; "/write"; "new file contents"];
5270 ["cat"; "/write"]], "new file contents");
5271 InitScratchFS, Always, TestOutput (
5272 [["write"; "/write2"; "\nnew file contents\n"];
5273 ["cat"; "/write2"]], "\nnew file contents\n");
5274 InitScratchFS, Always, TestOutput (
5275 [["write"; "/write3"; "\n\n"];
5276 ["cat"; "/write3"]], "\n\n");
5277 InitScratchFS, Always, TestOutput (
5278 [["write"; "/write4"; ""];
5279 ["cat"; "/write4"]], "");
5280 InitScratchFS, Always, TestOutput (
5281 [["write"; "/write5"; "\n\n\n"];
5282 ["cat"; "/write5"]], "\n\n\n");
5283 InitScratchFS, Always, TestOutput (
5284 [["write"; "/write6"; "\n"];
5285 ["cat"; "/write6"]], "\n")],
5286 "create a new file",
5288 This call creates a file called C<path>. The content of the
5289 file is the string C<content> (which can contain any 8 bit data).");
5291 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5292 [InitScratchFS, Always, TestOutput (
5293 [["write"; "/pwrite"; "new file contents"];
5294 ["pwrite"; "/pwrite"; "data"; "4"];
5295 ["cat"; "/pwrite"]], "new data contents");
5296 InitScratchFS, Always, TestOutput (
5297 [["write"; "/pwrite2"; "new file contents"];
5298 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5299 ["cat"; "/pwrite2"]], "new file is extended");
5300 InitScratchFS, Always, TestOutput (
5301 [["write"; "/pwrite3"; "new file contents"];
5302 ["pwrite"; "/pwrite3"; ""; "4"];
5303 ["cat"; "/pwrite3"]], "new file contents")],
5304 "write to part of a file",
5306 This command writes to part of a file. It writes the data
5307 buffer C<content> to the file C<path> starting at offset C<offset>.
5309 This command implements the L<pwrite(2)> system call, and like
5310 that system call it may not write the full data requested. The
5311 return value is the number of bytes that were actually written
5312 to the file. This could even be 0, although short writes are
5313 unlikely for regular files in ordinary circumstances.
5315 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5317 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5319 "resize an ext2, ext3 or ext4 filesystem (with size)",
5321 This command is the same as C<guestfs_resize2fs> except that it
5322 allows you to specify the new size (in bytes) explicitly.");
5324 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5326 "resize an LVM physical volume (with size)",
5328 This command is the same as C<guestfs_pvresize> except that it
5329 allows you to specify the new size (in bytes) explicitly.");
5331 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5333 "resize an NTFS filesystem (with size)",
5335 This command is the same as C<guestfs_ntfsresize> except that it
5336 allows you to specify the new size (in bytes) explicitly.");
5338 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5339 [InitNone, Always, TestRun [["available_all_groups"]]],
5340 "return a list of all optional groups",
5342 This command returns a list of all optional groups that this
5343 daemon knows about. Note this returns both supported and unsupported
5344 groups. To find out which ones the daemon can actually support
5345 you have to call C<guestfs_available> on each member of the
5348 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5350 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5351 [InitScratchFS, Always, TestOutputStruct (
5352 [["fallocate64"; "/fallocate64"; "1000000"];
5353 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5354 "preallocate a file in the guest filesystem",
5356 This command preallocates a file (containing zero bytes) named
5357 C<path> of size C<len> bytes. If the file exists already, it
5360 Note that this call allocates disk blocks for the file.
5361 To create a sparse file use C<guestfs_truncate_size> instead.
5363 The deprecated call C<guestfs_fallocate> does the same,
5364 but owing to an oversight it only allowed 30 bit lengths
5365 to be specified, effectively limiting the maximum size
5366 of files created through that call to 1GB.
5368 Do not confuse this with the guestfish-specific
5369 C<alloc> and C<sparse> commands which create
5370 a file in the host and attach it as a device.");
5372 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5373 [InitBasicFS, Always, TestOutput (
5374 [["set_e2label"; "/dev/sda1"; "LTEST"];
5375 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5376 "get the filesystem label",
5378 This returns the filesystem label of the filesystem on
5381 If the filesystem is unlabeled, this returns the empty string.
5383 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5385 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5386 (let uuid = uuidgen () in
5387 [InitBasicFS, Always, TestOutput (
5388 [["set_e2uuid"; "/dev/sda1"; uuid];
5389 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5390 "get the filesystem UUID",
5392 This returns the filesystem UUID of the filesystem on
5395 If the filesystem does not have a UUID, this returns the empty string.
5397 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5399 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5400 (* Can't be tested with the current framework because
5401 * the VG is being used by the mounted filesystem, so
5402 * the vgchange -an command we do first will fail.
5405 "set LVM device filter",
5407 This sets the LVM device filter so that LVM will only be
5408 able to \"see\" the block devices in the list C<devices>,
5409 and will ignore all other attached block devices.
5411 Where disk image(s) contain duplicate PVs or VGs, this
5412 command is useful to get LVM to ignore the duplicates, otherwise
5413 LVM can get confused. Note also there are two types
5414 of duplication possible: either cloned PVs/VGs which have
5415 identical UUIDs; or VGs that are not cloned but just happen
5416 to have the same name. In normal operation you cannot
5417 create this situation, but you can do it outside LVM, eg.
5418 by cloning disk images or by bit twiddling inside the LVM
5421 This command also clears the LVM cache and performs a volume
5424 You can filter whole block devices or individual partitions.
5426 You cannot use this if any VG is currently in use (eg.
5427 contains a mounted filesystem), even if you are not
5428 filtering out that VG.");
5430 ("lvm_clear_filter", (RErr, [], []), 256, [],
5431 [], (* see note on lvm_set_filter *)
5432 "clear LVM device filter",
5434 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5435 will be able to see every block device.
5437 This command also clears the LVM cache and performs a volume
5440 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5442 "open a LUKS-encrypted block device",
5444 This command opens a block device which has been encrypted
5445 according to the Linux Unified Key Setup (LUKS) standard.
5447 C<device> is the encrypted block device or partition.
5449 The caller must supply one of the keys associated with the
5450 LUKS block device, in the C<key> parameter.
5452 This creates a new block device called C</dev/mapper/mapname>.
5453 Reads and writes to this block device are decrypted from and
5454 encrypted to the underlying C<device> respectively.
5456 If this block device contains LVM volume groups, then
5457 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5458 will make them visible.");
5460 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5462 "open a LUKS-encrypted block device read-only",
5464 This is the same as C<guestfs_luks_open> except that a read-only
5465 mapping is created.");
5467 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5469 "close a LUKS device",
5471 This closes a LUKS device that was created earlier by
5472 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5473 C<device> parameter must be the name of the LUKS mapping
5474 device (ie. C</dev/mapper/mapname>) and I<not> the name
5475 of the underlying block device.");
5477 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5479 "format a block device as a LUKS encrypted device",
5481 This command erases existing data on C<device> and formats
5482 the device as a LUKS encrypted device. C<key> is the
5483 initial key, which is added to key slot C<slot>. (LUKS
5484 supports 8 key slots, numbered 0-7).");
5486 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5488 "format a block device as a LUKS encrypted device",
5490 This command is the same as C<guestfs_luks_format> but
5491 it also allows you to set the C<cipher> used.");
5493 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5495 "add a key on a LUKS encrypted device",
5497 This command adds a new key on LUKS device C<device>.
5498 C<key> is any existing key, and is used to access the device.
5499 C<newkey> is the new key to add. C<keyslot> is the key slot
5500 that will be replaced.
5502 Note that if C<keyslot> already contains a key, then this
5503 command will fail. You have to use C<guestfs_luks_kill_slot>
5504 first to remove that key.");
5506 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5508 "remove a key from a LUKS encrypted device",
5510 This command deletes the key in key slot C<keyslot> from the
5511 encrypted LUKS device C<device>. C<key> must be one of the
5514 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5515 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5516 [["is_lv"; "/dev/VG/LV"]]);
5517 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5518 [["is_lv"; "/dev/sda1"]])],
5519 "test if device is a logical volume",
5521 This command tests whether C<device> is a logical volume, and
5522 returns true iff this is the case.");
5524 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5526 "find a filesystem by UUID",
5528 This command searches the filesystems and returns the one
5529 which has the given UUID. An error is returned if no such
5530 filesystem can be found.
5532 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5534 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5536 "find a filesystem by label",
5538 This command searches the filesystems and returns the one
5539 which has the given label. An error is returned if no such
5540 filesystem can be found.
5542 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5544 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5545 [InitISOFS, Always, TestOutputFalse (
5546 [["is_chardev"; "/directory"]]);
5547 InitScratchFS, Always, TestOutputTrue (
5548 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5549 ["is_chardev"; "/is_chardev"]])],
5550 "test if character device",
5552 This returns C<true> if and only if there is a character device
5553 with the given C<path> name.
5555 See also C<guestfs_stat>.");
5557 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5558 [InitISOFS, Always, TestOutputFalse (
5559 [["is_blockdev"; "/directory"]]);
5560 InitScratchFS, Always, TestOutputTrue (
5561 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5562 ["is_blockdev"; "/is_blockdev"]])],
5563 "test if block device",
5565 This returns C<true> if and only if there is a block device
5566 with the given C<path> name.
5568 See also C<guestfs_stat>.");
5570 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5571 [InitISOFS, Always, TestOutputFalse (
5572 [["is_fifo"; "/directory"]]);
5573 InitScratchFS, Always, TestOutputTrue (
5574 [["mkfifo"; "0o777"; "/is_fifo"];
5575 ["is_fifo"; "/is_fifo"]])],
5576 "test if FIFO (named pipe)",
5578 This returns C<true> if and only if there is a FIFO (named pipe)
5579 with the given C<path> name.
5581 See also C<guestfs_stat>.");
5583 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5584 [InitISOFS, Always, TestOutputFalse (
5585 [["is_symlink"; "/directory"]]);
5586 InitISOFS, Always, TestOutputTrue (
5587 [["is_symlink"; "/abssymlink"]])],
5588 "test if symbolic link",
5590 This returns C<true> if and only if there is a symbolic link
5591 with the given C<path> name.
5593 See also C<guestfs_stat>.");
5595 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5596 (* XXX Need a positive test for sockets. *)
5597 [InitISOFS, Always, TestOutputFalse (
5598 [["is_socket"; "/directory"]])],
5601 This returns C<true> if and only if there is a Unix domain socket
5602 with the given C<path> name.
5604 See also C<guestfs_stat>.");
5606 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5607 [InitPartition, Always, TestOutputDevice (
5608 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5609 InitEmpty, Always, TestLastFail (
5610 [["part_to_dev"; "/dev/sda"]])],
5611 "convert partition name to device name",
5613 This function takes a partition name (eg. \"/dev/sdb1\") and
5614 removes the partition number, returning the device name
5617 The named partition must exist, for example as a string returned
5618 from C<guestfs_list_partitions>.");
5620 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5621 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5622 [InitScratchFS, Always, TestOutput (
5623 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5624 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5625 "upload a file from the local machine with offset",
5627 Upload local file C<filename> to C<remotefilename> on the
5630 C<remotefilename> is overwritten starting at the byte C<offset>
5631 specified. The intention is to overwrite parts of existing
5632 files or devices, although if a non-existant file is specified
5633 then it is created with a \"hole\" before C<offset>. The
5634 size of the data written is implicit in the size of the
5637 Note that there is no limit on the amount of data that
5638 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5639 and this call always writes the full amount unless an
5642 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5644 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5645 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5646 let offset = string_of_int 100 in
5647 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5648 [InitScratchFS, Always, TestOutput (
5649 (* Pick a file from cwd which isn't likely to change. *)
5650 [["mkdir"; "/download_offset"];
5651 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5652 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5653 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5654 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5655 "download a file to the local machine with offset and size",
5657 Download file C<remotefilename> and save it as C<filename>
5658 on the local machine.
5660 C<remotefilename> is read for C<size> bytes starting at C<offset>
5661 (this region must be within the file or device).
5663 Note that there is no limit on the amount of data that
5664 can be downloaded with this call, unlike with C<guestfs_pread>,
5665 and this call always reads the full amount unless an
5668 See also C<guestfs_download>, C<guestfs_pread>.");
5670 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5671 [InitPartition, Always, TestOutputListOfDevices (
5672 [["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"];
5673 ["blockdev_rereadpt"; "/dev/sda"];
5674 ["list_partitions"]], ["/dev/sdb1"])],
5675 "write to part of a device",
5677 This command writes to part of a device. It writes the data
5678 buffer C<content> to C<device> starting at offset C<offset>.
5680 This command implements the L<pwrite(2)> system call, and like
5681 that system call it may not write the full data requested
5682 (although short writes to disk devices and partitions are
5683 probably impossible with standard Linux kernels).
5685 See also C<guestfs_pwrite>.");
5687 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5688 [InitEmpty, Always, TestOutputBuffer (
5689 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5690 "read part of a device",
5692 This command lets you read part of a file. It reads C<count>
5693 bytes of C<device>, starting at C<offset>.
5695 This may read fewer bytes than requested. For further details
5696 see the L<pread(2)> system call.
5698 See also C<guestfs_pread>.");
5700 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5701 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5702 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5703 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5704 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5705 "get canonical name of an LV",
5707 This converts alternative naming schemes for LVs that you
5708 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5709 is converted to C</dev/VG/LV>.
5711 This command returns an error if the C<lvname> parameter does
5712 not refer to a logical volume.
5714 See also C<guestfs_is_lv>.");
5716 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5717 [InitEmpty, Always, TestOutput (
5718 [["part_disk"; "/dev/sda"; "mbr"];
5719 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5720 ["mount_options"; ""; "/dev/sda1"; "/"];
5721 ["write"; "/new"; "new file contents"];
5722 ["cat"; "/new"]], "new file contents")],
5723 "make a filesystem",
5725 This function creates a filesystem on C<device>. The filesystem
5726 type is C<fstype>, for example C<ext3>.
5728 The optional arguments are:
5734 The filesystem block size. Supported block sizes depend on the
5735 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5736 for Linux ext2/3 filesystems.
5738 For VFAT and NTFS the C<blocksize> parameter is treated as
5739 the requested cluster size.
5741 For UFS block sizes, please see L<mkfs.ufs(8)>.
5745 This passes the C<-O> parameter to the external mkfs program.
5747 For certain filesystem types, this allows extra filesystem
5748 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5751 You cannot use this optional parameter with the C<gfs> or
5752 C<gfs2> filesystem type.
5756 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5758 "get a single extended attribute",
5760 Get a single extended attribute from file C<path> named C<name>.
5761 This call follows symlinks. If you want to lookup an extended
5762 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5764 Normally it is better to get all extended attributes from a file
5765 in one go by calling C<guestfs_getxattrs>. However some Linux
5766 filesystem implementations are buggy and do not provide a way to
5767 list out attributes. For these filesystems (notably ntfs-3g)
5768 you have to know the names of the extended attributes you want
5769 in advance and call this function.
5771 Extended attribute values are blobs of binary data. If there
5772 is no extended attribute named C<name>, this returns an error.
5774 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5776 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5778 "get a single extended attribute",
5780 Get a single extended attribute from file C<path> named C<name>.
5781 If C<path> is a symlink, then this call returns an extended
5782 attribute from the symlink.
5784 Normally it is better to get all extended attributes from a file
5785 in one go by calling C<guestfs_getxattrs>. However some Linux
5786 filesystem implementations are buggy and do not provide a way to
5787 list out attributes. For these filesystems (notably ntfs-3g)
5788 you have to know the names of the extended attributes you want
5789 in advance and call this function.
5791 Extended attribute values are blobs of binary data. If there
5792 is no extended attribute named C<name>, this returns an error.
5794 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5796 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5798 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5800 This command is the same as C<guestfs_resize2fs>, but the filesystem
5801 is resized to its minimum size. This works like the C<-M> option
5802 to the C<resize2fs> command.
5804 To get the resulting size of the filesystem you should call
5805 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5806 values. These two numbers, multiplied together, give the
5807 resulting size of the minimal filesystem in bytes.");
5809 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5811 "internal autosync operation",
5813 This command performs the autosync operation just before the
5814 handle is closed. You should not call this command directly.
5815 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5816 control whether or not this operation is performed when the
5817 handle is closed.");
5821 let all_functions = non_daemon_functions @ daemon_functions
5823 (* In some places we want the functions to be displayed sorted
5824 * alphabetically, so this is useful:
5826 let all_functions_sorted = List.sort action_compare all_functions
5828 (* This is used to generate the src/MAX_PROC_NR file which
5829 * contains the maximum procedure number, a surrogate for the
5830 * ABI version number. See src/Makefile.am for the details.
5833 let proc_nrs = List.map (
5834 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5835 ) daemon_functions in
5836 List.fold_left max 0 proc_nrs
5838 (* Non-API meta-commands available only in guestfish.
5840 * Note (1): style, proc_nr and tests fields are all meaningless.
5841 * The only fields which are actually used are the shortname,
5842 * FishAlias flags, shortdesc and longdesc.
5844 * Note (2): to refer to other commands, use L</shortname>.
5846 * Note (3): keep this list sorted by shortname.
5848 let fish_commands = [
5849 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5850 "allocate and add a disk file",
5851 " alloc filename size
5853 This creates an empty (zeroed) file of the given size, and then adds
5854 so it can be further examined.
5856 For more advanced image creation, see L<qemu-img(1)> utility.
5858 Size can be specified using standard suffixes, eg. C<1M>.
5860 To create a sparse file, use L</sparse> instead. To create a
5861 prepared disk image, see L</PREPARED DISK IMAGES>.");
5863 ("copy_in", (RErr,[], []), -1, [], [],
5864 "copy local files or directories into an image",
5865 " copy-in local [local ...] /remotedir
5867 C<copy-in> copies local files or directories recursively into the disk
5868 image, placing them in the directory called C</remotedir> (which must
5869 exist). This guestfish meta-command turns into a sequence of
5870 L</tar-in> and other commands as necessary.
5872 Multiple local files and directories can be specified, but the last
5873 parameter must always be a remote directory. Wildcards cannot be
5876 ("copy_out", (RErr,[], []), -1, [], [],
5877 "copy remote files or directories out of an image",
5878 " copy-out remote [remote ...] localdir
5880 C<copy-out> copies remote files or directories recursively out of the
5881 disk image, placing them on the host disk in a local directory called
5882 C<localdir> (which must exist). This guestfish meta-command turns
5883 into a sequence of L</download>, L</tar-out> and other commands as
5886 Multiple remote files and directories can be specified, but the last
5887 parameter must always be a local directory. To download to the
5888 current directory, use C<.> as in:
5892 Wildcards cannot be used in the ordinary command, but you can use
5893 them with the help of L</glob> like this:
5895 glob copy-out /home/* .");
5897 ("echo", (RErr,[], []), -1, [], [],
5898 "display a line of text",
5901 This echos the parameters to the terminal.");
5903 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5907 This is used to edit a file. It downloads the file, edits it
5908 locally using your editor, then uploads the result.
5910 The editor is C<$EDITOR>. However if you use the alternate
5911 commands C<vi> or C<emacs> you will get those corresponding
5914 ("glob", (RErr,[], []), -1, [], [],
5915 "expand wildcards in command",
5916 " glob command args...
5918 Expand wildcards in any paths in the args list, and run C<command>
5919 repeatedly on each matching path.
5921 See L</WILDCARDS AND GLOBBING>.");
5923 ("hexedit", (RErr,[], []), -1, [], [],
5924 "edit with a hex editor",
5925 " hexedit <filename|device>
5926 hexedit <filename|device> <max>
5927 hexedit <filename|device> <start> <max>
5929 Use hexedit (a hex editor) to edit all or part of a binary file
5932 This command works by downloading potentially the whole file or
5933 device, editing it locally, then uploading it. If the file or
5934 device is large, you have to specify which part you wish to edit
5935 by using C<max> and/or C<start> C<max> parameters.
5936 C<start> and C<max> are specified in bytes, with the usual
5937 modifiers allowed such as C<1M> (1 megabyte).
5939 For example to edit the first few sectors of a disk you
5944 which would allow you to edit anywhere within the first megabyte
5947 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5949 hexedit /dev/sda1 0x400 0x400
5951 (assuming the superblock is in the standard location).
5953 This command requires the external L<hexedit(1)> program. You
5954 can specify another program to use by setting the C<HEXEDITOR>
5955 environment variable.
5957 See also L</hexdump>.");
5959 ("lcd", (RErr,[], []), -1, [], [],
5960 "change working directory",
5963 Change the local directory, ie. the current directory of guestfish
5966 Note that C<!cd> won't do what you might expect.");
5968 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5972 Opens the manual page for guestfish.");
5974 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5980 This is used to view a file.
5982 The default viewer is C<$PAGER>. However if you use the alternate
5983 command C<less> you will get the C<less> command specifically.");
5985 ("reopen", (RErr,[], []), -1, [], [],
5986 "close and reopen libguestfs handle",
5989 Close and reopen the libguestfs handle. It is not necessary to use
5990 this normally, because the handle is closed properly when guestfish
5991 exits. However this is occasionally useful for testing.");
5993 ("sparse", (RErr,[], []), -1, [], [],
5994 "create a sparse disk image and add",
5995 " sparse filename size
5997 This creates an empty sparse file of the given size, and then adds
5998 so it can be further examined.
6000 In all respects it works the same as the L</alloc> command, except that
6001 the image file is allocated sparsely, which means that disk blocks are
6002 not assigned to the file until they are needed. Sparse disk files
6003 only use space when written to, but they are slower and there is a
6004 danger you could run out of real disk space during a write operation.
6006 For more advanced image creation, see L<qemu-img(1)> utility.
6008 Size can be specified using standard suffixes, eg. C<1M>.");
6010 ("supported", (RErr,[], []), -1, [], [],
6011 "list supported groups of commands",
6014 This command returns a list of the optional groups
6015 known to the daemon, and indicates which ones are
6016 supported by this build of the libguestfs appliance.
6018 See also L<guestfs(3)/AVAILABILITY>.");
6020 ("time", (RErr,[], []), -1, [], [],
6021 "print elapsed time taken to run a command",
6022 " time command args...
6024 Run the command as usual, but print the elapsed time afterwards. This
6025 can be useful for benchmarking operations.");