2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter C<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form C<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to run C<guestfs_umount_all> followed by
286 C<guestfs_sync> when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
308 ("get_verbose", (RBool "verbose", [], []), -1, [],
312 This returns the verbose messages flag.");
314 ("is_ready", (RBool "ready", [], []), -1, [],
315 [InitNone, Always, TestOutputTrue (
317 "is ready to accept commands",
319 This returns true iff this handle is ready to accept commands
320 (in the C<READY> state).
322 For more information on states, see L<guestfs(3)>.");
324 ("is_config", (RBool "config", [], []), -1, [],
325 [InitNone, Always, TestOutputFalse (
327 "is in configuration state",
329 This returns true iff this handle is being configured
330 (in the C<CONFIG> state).
332 For more information on states, see L<guestfs(3)>.");
334 ("is_launching", (RBool "launching", [], []), -1, [],
335 [InitNone, Always, TestOutputFalse (
336 [["is_launching"]])],
337 "is launching subprocess",
339 This returns true iff this handle is launching the subprocess
340 (in the C<LAUNCHING> state).
342 For more information on states, see L<guestfs(3)>.");
344 ("is_busy", (RBool "busy", [], []), -1, [],
345 [InitNone, Always, TestOutputFalse (
347 "is busy processing a command",
349 This returns true iff this handle is busy processing a command
350 (in the C<BUSY> state).
352 For more information on states, see L<guestfs(3)>.");
354 ("get_state", (RInt "state", [], []), -1, [],
356 "get the current state",
358 This returns the current state as an opaque integer. This is
359 only useful for printing debug and internal error messages.
361 For more information on states, see L<guestfs(3)>.");
363 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
364 [InitNone, Always, TestOutputInt (
365 [["set_memsize"; "500"];
366 ["get_memsize"]], 500)],
367 "set memory allocated to the qemu subprocess",
369 This sets the memory size in megabytes allocated to the
370 qemu subprocess. This only has any effect if called before
373 You can also change this by setting the environment
374 variable C<LIBGUESTFS_MEMSIZE> before the handle is
377 For more information on the architecture of libguestfs,
378 see L<guestfs(3)>.");
380 ("get_memsize", (RInt "memsize", [], []), -1, [],
381 [InitNone, Always, TestOutputIntOp (
382 [["get_memsize"]], ">=", 256)],
383 "get memory allocated to the qemu subprocess",
385 This gets the memory size in megabytes allocated to the
388 If C<guestfs_set_memsize> was not called
389 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
390 then this returns the compiled-in default value for memsize.
392 For more information on the architecture of libguestfs,
393 see L<guestfs(3)>.");
395 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
396 [InitNone, Always, TestOutputIntOp (
397 [["get_pid"]], ">=", 1)],
398 "get PID of qemu subprocess",
400 Return the process ID of the qemu subprocess. If there is no
401 qemu subprocess, then this will return an error.
403 This is an internal call used for debugging and testing.");
405 ("version", (RStruct ("version", "version"), [], []), -1, [],
406 [InitNone, Always, TestOutputStruct (
407 [["version"]], [CompareWithInt ("major", 1)])],
408 "get the library version number",
410 Return the libguestfs version number that the program is linked
413 Note that because of dynamic linking this is not necessarily
414 the version of libguestfs that you compiled against. You can
415 compile the program, and then at runtime dynamically link
416 against a completely different C<libguestfs.so> library.
418 This call was added in version C<1.0.58>. In previous
419 versions of libguestfs there was no way to get the version
420 number. From C code you can use dynamic linker functions
421 to find out if this symbol exists (if it doesn't, then
422 it's an earlier version).
424 The call returns a structure with four elements. The first
425 three (C<major>, C<minor> and C<release>) are numbers and
426 correspond to the usual version triplet. The fourth element
427 (C<extra>) is a string and is normally empty, but may be
428 used for distro-specific information.
430 To construct the original version string:
431 C<$major.$minor.$release$extra>
433 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
435 I<Note:> Don't use this call to test for availability
436 of features. In enterprise distributions we backport
437 features from later versions into earlier versions,
438 making this an unreliable way to test for features.
439 Use C<guestfs_available> instead.");
441 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
442 [InitNone, Always, TestOutputTrue (
443 [["set_selinux"; "true"];
445 "set SELinux enabled or disabled at appliance boot",
447 This sets the selinux flag that is passed to the appliance
448 at boot time. The default is C<selinux=0> (disabled).
450 Note that if SELinux is enabled, it is always in
451 Permissive mode (C<enforcing=0>).
453 For more information on the architecture of libguestfs,
454 see L<guestfs(3)>.");
456 ("get_selinux", (RBool "selinux", [], []), -1, [],
458 "get SELinux enabled flag",
460 This returns the current setting of the selinux flag which
461 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
463 For more information on the architecture of libguestfs,
464 see L<guestfs(3)>.");
466 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
467 [InitNone, Always, TestOutputFalse (
468 [["set_trace"; "false"];
470 "enable or disable command traces",
472 If the command trace flag is set to 1, then commands are
473 printed on stderr before they are executed in a format
474 which is very similar to the one used by guestfish. In
475 other words, you can run a program with this enabled, and
476 you will get out a script which you can feed to guestfish
477 to perform the same set of actions.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
486 ("get_trace", (RBool "trace", [], []), -1, [],
488 "get command trace enabled flag",
490 Return the command trace flag.");
492 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
493 [InitNone, Always, TestOutputFalse (
494 [["set_direct"; "false"];
496 "enable or disable direct appliance mode",
498 If the direct appliance mode flag is enabled, then stdin and
499 stdout are passed directly through to the appliance once it
502 One consequence of this is that log messages aren't caught
503 by the library and handled by C<guestfs_set_log_message_callback>,
504 but go straight to stdout.
506 You probably don't want to use this unless you know what you
509 The default is disabled.");
511 ("get_direct", (RBool "direct", [], []), -1, [],
513 "get direct appliance mode flag",
515 Return the direct appliance mode flag.");
517 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
518 [InitNone, Always, TestOutputTrue (
519 [["set_recovery_proc"; "true"];
520 ["get_recovery_proc"]])],
521 "enable or disable the recovery process",
523 If this is called with the parameter C<false> then
524 C<guestfs_launch> does not create a recovery process. The
525 purpose of the recovery process is to stop runaway qemu
526 processes in the case where the main program aborts abruptly.
528 This only has any effect if called before C<guestfs_launch>,
529 and the default is true.
531 About the only time when you would want to disable this is
532 if the main process will fork itself into the background
533 (\"daemonize\" itself). In this case the recovery process
534 thinks that the main program has disappeared and so kills
535 qemu, which is not very helpful.");
537 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
539 "get recovery process enabled flag",
541 Return the recovery process enabled flag.");
543 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
545 "add a drive specifying the QEMU block emulation to use",
547 This is the same as C<guestfs_add_drive> but it allows you
548 to specify the QEMU interface emulation to use at run time.");
550 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
552 "add a drive read-only specifying the QEMU block emulation to use",
554 This is the same as C<guestfs_add_drive_ro> but it allows you
555 to specify the QEMU interface emulation to use at run time.");
557 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
558 [InitISOFS, Always, TestOutput (
559 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
560 InitISOFS, Always, TestOutput (
561 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
562 InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-win32.exe"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/lib-i586.so"]], "i386");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/lib-sparc.so"]], "sparc");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-win32.dll"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
582 "detect the architecture of a binary file",
584 This detects the architecture of the binary C<filename>,
585 and returns it if known.
587 Currently defined architectures are:
593 This string is returned for all 32 bit i386, i486, i586, i686 binaries
594 irrespective of the precise processor requirements of the binary.
606 64 bit SPARC V9 and above.
622 Libguestfs may return other architecture strings in future.
624 The function works on at least the following types of files:
630 many types of Un*x and Linux binary
634 many types of Un*x and Linux shared library
638 Windows Win32 and Win64 binaries
642 Windows Win32 and Win64 DLLs
644 Win32 binaries and DLLs return C<i386>.
646 Win64 binaries and DLLs return C<x86_64>.
654 Linux new-style initrd images
658 some non-x86 Linux vmlinuz kernels
662 What it can't do currently:
668 static libraries (libfoo.a)
672 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
676 x86 Linux vmlinuz kernels
678 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
679 compressed code, and are horribly hard to unpack. If you want to find
680 the architecture of a kernel, use the architecture of the associated
681 initrd or kernel module(s) instead.
685 ("inspect_os", (RStringList "roots", [], []), -1, [],
687 "inspect disk and return list of operating systems found",
689 This function uses other libguestfs functions and certain
690 heuristics to inspect the disk(s) (usually disks belonging to
691 a virtual machine), looking for operating systems.
693 The list returned is empty if no operating systems were found.
695 If one operating system was found, then this returns a list with
696 a single element, which is the name of the root filesystem of
697 this operating system. It is also possible for this function
698 to return a list containing more than one element, indicating
699 a dual-boot or multi-boot virtual machine, with each element being
700 the root filesystem of one of the operating systems.
702 You can pass the root string(s) returned to other
703 C<guestfs_inspect_get_*> functions in order to query further
704 information about each operating system, such as the name
707 This function uses other libguestfs features such as
708 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
709 and unmount filesystems and look at the contents. This should
710 be called with no disks currently mounted. The function may also
711 use Augeas, so any existing Augeas handle will be closed.
713 This function cannot decrypt encrypted disks. The caller
714 must do that first (supplying the necessary keys) if the
717 Please read L<guestfs(3)/INSPECTION> for more details.
719 See also C<guestfs_list_filesystems>.");
721 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
723 "get type of inspected operating system",
725 This function should only be called with a root device string
726 as returned by C<guestfs_inspect_os>.
728 This returns the type of the inspected operating system.
729 Currently defined types are:
735 Any Linux-based operating system.
739 Any Microsoft Windows operating system.
747 The operating system type could not be determined.
751 Future versions of libguestfs may return other strings here.
752 The caller should be prepared to handle any string.
754 Please read L<guestfs(3)/INSPECTION> for more details.");
756 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
758 "get architecture of inspected operating system",
760 This function should only be called with a root device string
761 as returned by C<guestfs_inspect_os>.
763 This returns the architecture of the inspected operating system.
764 The possible return values are listed under
765 C<guestfs_file_architecture>.
767 If the architecture could not be determined, then the
768 string C<unknown> is returned.
770 Please read L<guestfs(3)/INSPECTION> for more details.");
772 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
774 "get distro of inspected operating system",
776 This function should only be called with a root device string
777 as returned by C<guestfs_inspect_os>.
779 This returns the distro (distribution) of the inspected operating
782 Currently defined distros are:
818 =item \"redhat-based\"
820 Some Red Hat-derived distro.
824 Red Hat Enterprise Linux and some derivatives.
832 The distro could not be determined.
836 Windows does not have distributions. This string is
837 returned if the OS type is Windows.
841 Future versions of libguestfs may return other strings here.
842 The caller should be prepared to handle any string.
844 Please read L<guestfs(3)/INSPECTION> for more details.");
846 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
848 "get major version of inspected operating system",
850 This function should only be called with a root device string
851 as returned by C<guestfs_inspect_os>.
853 This returns the major version number of the inspected operating
856 Windows uses a consistent versioning scheme which is I<not>
857 reflected in the popular public names used by the operating system.
858 Notably the operating system known as \"Windows 7\" is really
859 version 6.1 (ie. major = 6, minor = 1). You can find out the
860 real versions corresponding to releases of Windows by consulting
863 If the version could not be determined, then C<0> is returned.
865 Please read L<guestfs(3)/INSPECTION> for more details.");
867 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
869 "get minor version of inspected operating system",
871 This function should only be called with a root device string
872 as returned by C<guestfs_inspect_os>.
874 This returns the minor version number of the inspected operating
877 If the version could not be determined, then C<0> is returned.
879 Please read L<guestfs(3)/INSPECTION> for more details.
880 See also C<guestfs_inspect_get_major_version>.");
882 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
884 "get product name of inspected operating system",
886 This function should only be called with a root device string
887 as returned by C<guestfs_inspect_os>.
889 This returns the product name of the inspected operating
890 system. The product name is generally some freeform string
891 which can be displayed to the user, but should not be
894 If the product name could not be determined, then the
895 string C<unknown> is returned.
897 Please read L<guestfs(3)/INSPECTION> for more details.");
899 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
901 "get mountpoints of inspected operating system",
903 This function should only be called with a root device string
904 as returned by C<guestfs_inspect_os>.
906 This returns a hash of where we think the filesystems
907 associated with this operating system should be mounted.
908 Callers should note that this is at best an educated guess
909 made by reading configuration files such as C</etc/fstab>.
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.");
1298 (* daemon_functions are any functions which cause some action
1299 * to take place in the daemon.
1302 let daemon_functions = [
1303 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1304 [InitEmpty, Always, TestOutput (
1305 [["part_disk"; "/dev/sda"; "mbr"];
1306 ["mkfs"; "ext2"; "/dev/sda1"];
1307 ["mount"; "/dev/sda1"; "/"];
1308 ["write"; "/new"; "new file contents"];
1309 ["cat"; "/new"]], "new file contents")],
1310 "mount a guest disk at a position in the filesystem",
1312 Mount a guest disk at a position in the filesystem. Block devices
1313 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1314 the guest. If those block devices contain partitions, they will have
1315 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1318 The rules are the same as for L<mount(2)>: A filesystem must
1319 first be mounted on C</> before others can be mounted. Other
1320 filesystems can only be mounted on directories which already
1323 The mounted filesystem is writable, if we have sufficient permissions
1324 on the underlying device.
1327 When you use this call, the filesystem options C<sync> and C<noatime>
1328 are set implicitly. This was originally done because we thought it
1329 would improve reliability, but it turns out that I<-o sync> has a
1330 very large negative performance impact and negligible effect on
1331 reliability. Therefore we recommend that you avoid using
1332 C<guestfs_mount> in any code that needs performance, and instead
1333 use C<guestfs_mount_options> (use an empty string for the first
1334 parameter if you don't want any options).");
1336 ("sync", (RErr, [], []), 2, [],
1337 [ InitEmpty, Always, TestRun [["sync"]]],
1338 "sync disks, writes are flushed through to the disk image",
1340 This syncs the disk, so that any writes are flushed through to the
1341 underlying disk image.
1343 You should always call this if you have modified a disk image, before
1344 closing the handle.");
1346 ("touch", (RErr, [Pathname "path"], []), 3, [],
1347 [InitScratchFS, Always, TestOutputTrue (
1348 [["touch"; "/touch"];
1349 ["exists"; "/touch"]])],
1350 "update file timestamps or create a new file",
1352 Touch acts like the L<touch(1)> command. It can be used to
1353 update the timestamps on a file, or, if the file does not exist,
1354 to create a new zero-length file.
1356 This command only works on regular files, and will fail on other
1357 file types such as directories, symbolic links, block special etc.");
1359 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1360 [InitISOFS, Always, TestOutput (
1361 [["cat"; "/known-2"]], "abcdef\n")],
1362 "list the contents of a file",
1364 Return the contents of the file named C<path>.
1366 Note that this function cannot correctly handle binary files
1367 (specifically, files containing C<\\0> character which is treated
1368 as end of string). For those you need to use the C<guestfs_read_file>
1369 or C<guestfs_download> functions which have a more complex interface.");
1371 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1372 [], (* XXX Tricky to test because it depends on the exact format
1373 * of the 'ls -l' command, which changes between F10 and F11.
1375 "list the files in a directory (long format)",
1377 List the files in C<directory> (relative to the root directory,
1378 there is no cwd) in the format of 'ls -la'.
1380 This command is mostly useful for interactive sessions. It
1381 is I<not> intended that you try to parse the output string.");
1383 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1384 [InitScratchFS, Always, TestOutputList (
1386 ["touch"; "/ls/new"];
1387 ["touch"; "/ls/newer"];
1388 ["touch"; "/ls/newest"];
1389 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1390 "list the files in a directory",
1392 List the files in C<directory> (relative to the root directory,
1393 there is no cwd). The '.' and '..' entries are not returned, but
1394 hidden files are shown.
1396 This command is mostly useful for interactive sessions. Programs
1397 should probably use C<guestfs_readdir> instead.");
1399 ("list_devices", (RStringList "devices", [], []), 7, [],
1400 [InitEmpty, Always, TestOutputListOfDevices (
1401 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1402 "list the block devices",
1404 List all the block devices.
1406 The full block device names are returned, eg. C</dev/sda>.
1408 See also C<guestfs_list_filesystems>.");
1410 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1411 [InitBasicFS, Always, TestOutputListOfDevices (
1412 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1413 InitEmpty, Always, TestOutputListOfDevices (
1414 [["part_init"; "/dev/sda"; "mbr"];
1415 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1416 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1417 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1418 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1419 "list the partitions",
1421 List all the partitions detected on all block devices.
1423 The full partition device names are returned, eg. C</dev/sda1>
1425 This does not return logical volumes. For that you will need to
1426 call C<guestfs_lvs>.
1428 See also C<guestfs_list_filesystems>.");
1430 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1431 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1432 [["pvs"]], ["/dev/sda1"]);
1433 InitEmpty, Always, TestOutputListOfDevices (
1434 [["part_init"; "/dev/sda"; "mbr"];
1435 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1436 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1437 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1438 ["pvcreate"; "/dev/sda1"];
1439 ["pvcreate"; "/dev/sda2"];
1440 ["pvcreate"; "/dev/sda3"];
1441 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1442 "list the LVM physical volumes (PVs)",
1444 List all the physical volumes detected. This is the equivalent
1445 of the L<pvs(8)> command.
1447 This returns a list of just the device names that contain
1448 PVs (eg. C</dev/sda2>).
1450 See also C<guestfs_pvs_full>.");
1452 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1453 [InitBasicFSonLVM, Always, TestOutputList (
1455 InitEmpty, Always, TestOutputList (
1456 [["part_init"; "/dev/sda"; "mbr"];
1457 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1458 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1459 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1460 ["pvcreate"; "/dev/sda1"];
1461 ["pvcreate"; "/dev/sda2"];
1462 ["pvcreate"; "/dev/sda3"];
1463 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1464 ["vgcreate"; "VG2"; "/dev/sda3"];
1465 ["vgs"]], ["VG1"; "VG2"])],
1466 "list the LVM volume groups (VGs)",
1468 List all the volumes groups detected. This is the equivalent
1469 of the L<vgs(8)> command.
1471 This returns a list of just the volume group names that were
1472 detected (eg. C<VolGroup00>).
1474 See also C<guestfs_vgs_full>.");
1476 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1477 [InitBasicFSonLVM, Always, TestOutputList (
1478 [["lvs"]], ["/dev/VG/LV"]);
1479 InitEmpty, Always, TestOutputList (
1480 [["part_init"; "/dev/sda"; "mbr"];
1481 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1482 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1483 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1484 ["pvcreate"; "/dev/sda1"];
1485 ["pvcreate"; "/dev/sda2"];
1486 ["pvcreate"; "/dev/sda3"];
1487 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1488 ["vgcreate"; "VG2"; "/dev/sda3"];
1489 ["lvcreate"; "LV1"; "VG1"; "50"];
1490 ["lvcreate"; "LV2"; "VG1"; "50"];
1491 ["lvcreate"; "LV3"; "VG2"; "50"];
1492 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1493 "list the LVM logical volumes (LVs)",
1495 List all the logical volumes detected. This is the equivalent
1496 of the L<lvs(8)> command.
1498 This returns a list of the logical volume device names
1499 (eg. C</dev/VolGroup00/LogVol00>).
1501 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1503 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1504 [], (* XXX how to test? *)
1505 "list the LVM physical volumes (PVs)",
1507 List all the physical volumes detected. This is the equivalent
1508 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1510 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1511 [], (* XXX how to test? *)
1512 "list the LVM volume groups (VGs)",
1514 List all the volumes groups detected. This is the equivalent
1515 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1517 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1518 [], (* XXX how to test? *)
1519 "list the LVM logical volumes (LVs)",
1521 List all the logical volumes detected. This is the equivalent
1522 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1524 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1525 [InitISOFS, Always, TestOutputList (
1526 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1527 InitISOFS, Always, TestOutputList (
1528 [["read_lines"; "/empty"]], [])],
1529 "read file as lines",
1531 Return the contents of the file named C<path>.
1533 The file contents are returned as a list of lines. Trailing
1534 C<LF> and C<CRLF> character sequences are I<not> returned.
1536 Note that this function cannot correctly handle binary files
1537 (specifically, files containing C<\\0> character which is treated
1538 as end of line). For those you need to use the C<guestfs_read_file>
1539 function which has a more complex interface.");
1541 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1542 [], (* XXX Augeas code needs tests. *)
1543 "create a new Augeas handle",
1545 Create a new Augeas handle for editing configuration files.
1546 If there was any previous Augeas handle associated with this
1547 guestfs session, then it is closed.
1549 You must call this before using any other C<guestfs_aug_*>
1552 C<root> is the filesystem root. C<root> must not be NULL,
1555 The flags are the same as the flags defined in
1556 E<lt>augeas.hE<gt>, the logical I<or> of the following
1561 =item C<AUG_SAVE_BACKUP> = 1
1563 Keep the original file with a C<.augsave> extension.
1565 =item C<AUG_SAVE_NEWFILE> = 2
1567 Save changes into a file with extension C<.augnew>, and
1568 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1570 =item C<AUG_TYPE_CHECK> = 4
1574 This option is only useful when debugging Augeas lenses. Use
1575 of this option may require additional memory for the libguestfs
1576 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1577 environment variable or call C<guestfs_set_memsize>.
1579 =item C<AUG_NO_STDINC> = 8
1581 Do not use standard load path for modules.
1583 =item C<AUG_SAVE_NOOP> = 16
1585 Make save a no-op, just record what would have been changed.
1587 =item C<AUG_NO_LOAD> = 32
1589 Do not load the tree in C<guestfs_aug_init>.
1593 To close the handle, you can call C<guestfs_aug_close>.
1595 To find out more about Augeas, see L<http://augeas.net/>.");
1597 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1598 [], (* XXX Augeas code needs tests. *)
1599 "close the current Augeas handle",
1601 Close the current Augeas handle and free up any resources
1602 used by it. After calling this, you have to call
1603 C<guestfs_aug_init> again before you can use any other
1604 Augeas functions.");
1606 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1607 [], (* XXX Augeas code needs tests. *)
1608 "define an Augeas variable",
1610 Defines an Augeas variable C<name> whose value is the result
1611 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1614 On success this returns the number of nodes in C<expr>, or
1615 C<0> if C<expr> evaluates to something which is not a nodeset.");
1617 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1618 [], (* XXX Augeas code needs tests. *)
1619 "define an Augeas node",
1621 Defines a variable C<name> whose value is the result of
1624 If C<expr> evaluates to an empty nodeset, a node is created,
1625 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1626 C<name> will be the nodeset containing that single node.
1628 On success this returns a pair containing the
1629 number of nodes in the nodeset, and a boolean flag
1630 if a node was created.");
1632 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1633 [], (* XXX Augeas code needs tests. *)
1634 "look up the value of an Augeas path",
1636 Look up the value associated with C<path>. If C<path>
1637 matches exactly one node, the C<value> is returned.");
1639 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1640 [], (* XXX Augeas code needs tests. *)
1641 "set Augeas path to value",
1643 Set the value associated with C<path> to C<val>.
1645 In the Augeas API, it is possible to clear a node by setting
1646 the value to NULL. Due to an oversight in the libguestfs API
1647 you cannot do that with this call. Instead you must use the
1648 C<guestfs_aug_clear> call.");
1650 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1651 [], (* XXX Augeas code needs tests. *)
1652 "insert a sibling Augeas node",
1654 Create a new sibling C<label> for C<path>, inserting it into
1655 the tree before or after C<path> (depending on the boolean
1658 C<path> must match exactly one existing node in the tree, and
1659 C<label> must be a label, ie. not contain C</>, C<*> or end
1660 with a bracketed index C<[N]>.");
1662 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1663 [], (* XXX Augeas code needs tests. *)
1664 "remove an Augeas path",
1666 Remove C<path> and all of its children.
1668 On success this returns the number of entries which were removed.");
1670 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1671 [], (* XXX Augeas code needs tests. *)
1674 Move the node C<src> to C<dest>. C<src> must match exactly
1675 one node. C<dest> is overwritten if it exists.");
1677 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1678 [], (* XXX Augeas code needs tests. *)
1679 "return Augeas nodes which match augpath",
1681 Returns a list of paths which match the path expression C<path>.
1682 The returned paths are sufficiently qualified so that they match
1683 exactly one node in the current tree.");
1685 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1686 [], (* XXX Augeas code needs tests. *)
1687 "write all pending Augeas changes to disk",
1689 This writes all pending changes to disk.
1691 The flags which were passed to C<guestfs_aug_init> affect exactly
1692 how files are saved.");
1694 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1695 [], (* XXX Augeas code needs tests. *)
1696 "load files into the tree",
1698 Load files into the tree.
1700 See C<aug_load> in the Augeas documentation for the full gory
1703 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1704 [], (* XXX Augeas code needs tests. *)
1705 "list Augeas nodes under augpath",
1707 This is just a shortcut for listing C<guestfs_aug_match>
1708 C<path/*> and sorting the resulting nodes into alphabetical order.");
1710 ("rm", (RErr, [Pathname "path"], []), 29, [],
1711 [InitScratchFS, Always, TestRun
1713 ["touch"; "/rm/new"];
1715 InitScratchFS, Always, TestLastFail
1716 [["rm"; "/nosuchfile"]];
1717 InitScratchFS, Always, TestLastFail
1722 Remove the single file C<path>.");
1724 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1725 [InitScratchFS, Always, TestRun
1726 [["mkdir"; "/rmdir"];
1727 ["rmdir"; "/rmdir"]];
1728 InitScratchFS, Always, TestLastFail
1729 [["rmdir"; "/rmdir2"]];
1730 InitScratchFS, Always, TestLastFail
1731 [["mkdir"; "/rmdir3"];
1732 ["touch"; "/rmdir3/new"];
1733 ["rmdir"; "/rmdir3/new"]]],
1734 "remove a directory",
1736 Remove the single directory C<path>.");
1738 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1739 [InitScratchFS, Always, TestOutputFalse
1740 [["mkdir"; "/rm_rf"];
1741 ["mkdir"; "/rm_rf/foo"];
1742 ["touch"; "/rm_rf/foo/bar"];
1743 ["rm_rf"; "/rm_rf"];
1744 ["exists"; "/rm_rf"]]],
1745 "remove a file or directory recursively",
1747 Remove the file or directory C<path>, recursively removing the
1748 contents if its a directory. This is like the C<rm -rf> shell
1751 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1752 [InitScratchFS, Always, TestOutputTrue
1753 [["mkdir"; "/mkdir"];
1754 ["is_dir"; "/mkdir"]];
1755 InitScratchFS, Always, TestLastFail
1756 [["mkdir"; "/mkdir2/foo/bar"]]],
1757 "create a directory",
1759 Create a directory named C<path>.");
1761 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1762 [InitScratchFS, Always, TestOutputTrue
1763 [["mkdir_p"; "/mkdir_p/foo/bar"];
1764 ["is_dir"; "/mkdir_p/foo/bar"]];
1765 InitScratchFS, Always, TestOutputTrue
1766 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1767 ["is_dir"; "/mkdir_p2/foo"]];
1768 InitScratchFS, Always, TestOutputTrue
1769 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1770 ["is_dir"; "/mkdir_p3"]];
1771 (* Regression tests for RHBZ#503133: *)
1772 InitScratchFS, Always, TestRun
1773 [["mkdir"; "/mkdir_p4"];
1774 ["mkdir_p"; "/mkdir_p4"]];
1775 InitScratchFS, Always, TestLastFail
1776 [["touch"; "/mkdir_p5"];
1777 ["mkdir_p"; "/mkdir_p5"]]],
1778 "create a directory and parents",
1780 Create a directory named C<path>, creating any parent directories
1781 as necessary. This is like the C<mkdir -p> shell command.");
1783 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1784 [], (* XXX Need stat command to test *)
1787 Change the mode (permissions) of C<path> to C<mode>. Only
1788 numeric modes are supported.
1790 I<Note>: When using this command from guestfish, C<mode>
1791 by default would be decimal, unless you prefix it with
1792 C<0> to get octal, ie. use C<0700> not C<700>.
1794 The mode actually set is affected by the umask.");
1796 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1797 [], (* XXX Need stat command to test *)
1798 "change file owner and group",
1800 Change the file owner to C<owner> and group to C<group>.
1802 Only numeric uid and gid are supported. If you want to use
1803 names, you will need to locate and parse the password file
1804 yourself (Augeas support makes this relatively easy).");
1806 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1807 [InitISOFS, Always, TestOutputTrue (
1808 [["exists"; "/empty"]]);
1809 InitISOFS, Always, TestOutputTrue (
1810 [["exists"; "/directory"]])],
1811 "test if file or directory exists",
1813 This returns C<true> if and only if there is a file, directory
1814 (or anything) with the given C<path> name.
1816 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1818 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1819 [InitISOFS, Always, TestOutputTrue (
1820 [["is_file"; "/known-1"]]);
1821 InitISOFS, Always, TestOutputFalse (
1822 [["is_file"; "/directory"]])],
1823 "test if a regular file",
1825 This returns C<true> if and only if there is a regular file
1826 with the given C<path> name. Note that it returns false for
1827 other objects like directories.
1829 See also C<guestfs_stat>.");
1831 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1832 [InitISOFS, Always, TestOutputFalse (
1833 [["is_dir"; "/known-3"]]);
1834 InitISOFS, Always, TestOutputTrue (
1835 [["is_dir"; "/directory"]])],
1836 "test if a directory",
1838 This returns C<true> if and only if there is a directory
1839 with the given C<path> name. Note that it returns false for
1840 other objects like files.
1842 See also C<guestfs_stat>.");
1844 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1845 [InitEmpty, Always, TestOutputListOfDevices (
1846 [["part_init"; "/dev/sda"; "mbr"];
1847 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1848 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1849 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1850 ["pvcreate"; "/dev/sda1"];
1851 ["pvcreate"; "/dev/sda2"];
1852 ["pvcreate"; "/dev/sda3"];
1853 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1854 "create an LVM physical volume",
1856 This creates an LVM physical volume on the named C<device>,
1857 where C<device> should usually be a partition name such
1860 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1861 [InitEmpty, Always, TestOutputList (
1862 [["part_init"; "/dev/sda"; "mbr"];
1863 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1864 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1865 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1866 ["pvcreate"; "/dev/sda1"];
1867 ["pvcreate"; "/dev/sda2"];
1868 ["pvcreate"; "/dev/sda3"];
1869 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1870 ["vgcreate"; "VG2"; "/dev/sda3"];
1871 ["vgs"]], ["VG1"; "VG2"])],
1872 "create an LVM volume group",
1874 This creates an LVM volume group called C<volgroup>
1875 from the non-empty list of physical volumes C<physvols>.");
1877 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1878 [InitEmpty, Always, TestOutputList (
1879 [["part_init"; "/dev/sda"; "mbr"];
1880 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1881 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1882 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1883 ["pvcreate"; "/dev/sda1"];
1884 ["pvcreate"; "/dev/sda2"];
1885 ["pvcreate"; "/dev/sda3"];
1886 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1887 ["vgcreate"; "VG2"; "/dev/sda3"];
1888 ["lvcreate"; "LV1"; "VG1"; "50"];
1889 ["lvcreate"; "LV2"; "VG1"; "50"];
1890 ["lvcreate"; "LV3"; "VG2"; "50"];
1891 ["lvcreate"; "LV4"; "VG2"; "50"];
1892 ["lvcreate"; "LV5"; "VG2"; "50"];
1894 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1895 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1896 "create an LVM logical volume",
1898 This creates an LVM logical volume called C<logvol>
1899 on the volume group C<volgroup>, with C<size> megabytes.");
1901 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1902 [InitEmpty, Always, TestOutput (
1903 [["part_disk"; "/dev/sda"; "mbr"];
1904 ["mkfs"; "ext2"; "/dev/sda1"];
1905 ["mount_options"; ""; "/dev/sda1"; "/"];
1906 ["write"; "/new"; "new file contents"];
1907 ["cat"; "/new"]], "new file contents")],
1908 "make a filesystem",
1910 This creates a filesystem on C<device> (usually a partition
1911 or LVM logical volume). The filesystem type is C<fstype>, for
1914 ("sfdisk", (RErr, [Device "device";
1915 Int "cyls"; Int "heads"; Int "sectors";
1916 StringList "lines"], []), 43, [DangerWillRobinson],
1918 "create partitions on a block device",
1920 This is a direct interface to the L<sfdisk(8)> program for creating
1921 partitions on block devices.
1923 C<device> should be a block device, for example C</dev/sda>.
1925 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1926 and sectors on the device, which are passed directly to sfdisk as
1927 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1928 of these, then the corresponding parameter is omitted. Usually for
1929 'large' disks, you can just pass C<0> for these, but for small
1930 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1931 out the right geometry and you will need to tell it.
1933 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1934 information refer to the L<sfdisk(8)> manpage.
1936 To create a single partition occupying the whole disk, you would
1937 pass C<lines> as a single element list, when the single element being
1938 the string C<,> (comma).
1940 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1941 C<guestfs_part_init>");
1943 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1944 (* Regression test for RHBZ#597135. *)
1945 [InitScratchFS, Always, TestLastFail
1946 [["write_file"; "/write_file"; "abc"; "10000"]]],
1949 This call creates a file called C<path>. The contents of the
1950 file is the string C<content> (which can contain any 8 bit data),
1951 with length C<size>.
1953 As a special case, if C<size> is C<0>
1954 then the length is calculated using C<strlen> (so in this case
1955 the content cannot contain embedded ASCII NULs).
1957 I<NB.> Owing to a bug, writing content containing ASCII NUL
1958 characters does I<not> work, even if the length is specified.");
1960 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1961 [InitEmpty, Always, TestOutputListOfDevices (
1962 [["part_disk"; "/dev/sda"; "mbr"];
1963 ["mkfs"; "ext2"; "/dev/sda1"];
1964 ["mount_options"; ""; "/dev/sda1"; "/"];
1965 ["mounts"]], ["/dev/sda1"]);
1966 InitEmpty, Always, TestOutputList (
1967 [["part_disk"; "/dev/sda"; "mbr"];
1968 ["mkfs"; "ext2"; "/dev/sda1"];
1969 ["mount_options"; ""; "/dev/sda1"; "/"];
1972 "unmount a filesystem",
1974 This unmounts the given filesystem. The filesystem may be
1975 specified either by its mountpoint (path) or the device which
1976 contains the filesystem.");
1978 ("mounts", (RStringList "devices", [], []), 46, [],
1979 [InitScratchFS, Always, TestOutputListOfDevices (
1980 [["mounts"]], ["/dev/sdb1"])],
1981 "show mounted filesystems",
1983 This returns the list of currently mounted filesystems. It returns
1984 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1986 Some internal mounts are not shown.
1988 See also: C<guestfs_mountpoints>");
1990 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1991 [InitScratchFS, Always, TestOutputList (
1994 (* check that umount_all can unmount nested mounts correctly: *)
1995 InitEmpty, Always, TestOutputList (
1996 [["part_init"; "/dev/sda"; "mbr"];
1997 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1998 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1999 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2000 ["mkfs"; "ext2"; "/dev/sda1"];
2001 ["mkfs"; "ext2"; "/dev/sda2"];
2002 ["mkfs"; "ext2"; "/dev/sda3"];
2003 ["mount_options"; ""; "/dev/sda1"; "/"];
2005 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2006 ["mkdir"; "/mp1/mp2"];
2007 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2008 ["mkdir"; "/mp1/mp2/mp3"];
2011 "unmount all filesystems",
2013 This unmounts all mounted filesystems.
2015 Some internal mounts are not unmounted by this call.");
2017 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2019 "remove all LVM LVs, VGs and PVs",
2021 This command removes all LVM logical volumes, volume groups
2022 and physical volumes.");
2024 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2025 [InitISOFS, Always, TestOutput (
2026 [["file"; "/empty"]], "empty");
2027 InitISOFS, Always, TestOutput (
2028 [["file"; "/known-1"]], "ASCII text");
2029 InitISOFS, Always, TestLastFail (
2030 [["file"; "/notexists"]]);
2031 InitISOFS, Always, TestOutput (
2032 [["file"; "/abssymlink"]], "symbolic link");
2033 InitISOFS, Always, TestOutput (
2034 [["file"; "/directory"]], "directory")],
2035 "determine file type",
2037 This call uses the standard L<file(1)> command to determine
2038 the type or contents of the file.
2040 This call will also transparently look inside various types
2043 The exact command which runs is C<file -zb path>. Note in
2044 particular that the filename is not prepended to the output
2047 The output depends on the output of the underlying L<file(1)>
2048 command and it can change in future in ways beyond our control.
2049 In other words, the output is not guaranteed by the ABI.
2051 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2052 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc).");
2054 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2055 [InitScratchFS, Always, TestOutput (
2056 [["mkdir"; "/command"];
2057 ["upload"; "test-command"; "/command/test-command"];
2058 ["chmod"; "0o755"; "/command/test-command"];
2059 ["command"; "/command/test-command 1"]], "Result1");
2060 InitScratchFS, Always, TestOutput (
2061 [["mkdir"; "/command2"];
2062 ["upload"; "test-command"; "/command2/test-command"];
2063 ["chmod"; "0o755"; "/command2/test-command"];
2064 ["command"; "/command2/test-command 2"]], "Result2\n");
2065 InitScratchFS, Always, TestOutput (
2066 [["mkdir"; "/command3"];
2067 ["upload"; "test-command"; "/command3/test-command"];
2068 ["chmod"; "0o755"; "/command3/test-command"];
2069 ["command"; "/command3/test-command 3"]], "\nResult3");
2070 InitScratchFS, Always, TestOutput (
2071 [["mkdir"; "/command4"];
2072 ["upload"; "test-command"; "/command4/test-command"];
2073 ["chmod"; "0o755"; "/command4/test-command"];
2074 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2075 InitScratchFS, Always, TestOutput (
2076 [["mkdir"; "/command5"];
2077 ["upload"; "test-command"; "/command5/test-command"];
2078 ["chmod"; "0o755"; "/command5/test-command"];
2079 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2080 InitScratchFS, Always, TestOutput (
2081 [["mkdir"; "/command6"];
2082 ["upload"; "test-command"; "/command6/test-command"];
2083 ["chmod"; "0o755"; "/command6/test-command"];
2084 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2085 InitScratchFS, Always, TestOutput (
2086 [["mkdir"; "/command7"];
2087 ["upload"; "test-command"; "/command7/test-command"];
2088 ["chmod"; "0o755"; "/command7/test-command"];
2089 ["command"; "/command7/test-command 7"]], "");
2090 InitScratchFS, Always, TestOutput (
2091 [["mkdir"; "/command8"];
2092 ["upload"; "test-command"; "/command8/test-command"];
2093 ["chmod"; "0o755"; "/command8/test-command"];
2094 ["command"; "/command8/test-command 8"]], "\n");
2095 InitScratchFS, Always, TestOutput (
2096 [["mkdir"; "/command9"];
2097 ["upload"; "test-command"; "/command9/test-command"];
2098 ["chmod"; "0o755"; "/command9/test-command"];
2099 ["command"; "/command9/test-command 9"]], "\n\n");
2100 InitScratchFS, Always, TestOutput (
2101 [["mkdir"; "/command10"];
2102 ["upload"; "test-command"; "/command10/test-command"];
2103 ["chmod"; "0o755"; "/command10/test-command"];
2104 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2105 InitScratchFS, Always, TestOutput (
2106 [["mkdir"; "/command11"];
2107 ["upload"; "test-command"; "/command11/test-command"];
2108 ["chmod"; "0o755"; "/command11/test-command"];
2109 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2110 InitScratchFS, Always, TestLastFail (
2111 [["mkdir"; "/command12"];
2112 ["upload"; "test-command"; "/command12/test-command"];
2113 ["chmod"; "0o755"; "/command12/test-command"];
2114 ["command"; "/command12/test-command"]])],
2115 "run a command from the guest filesystem",
2117 This call runs a command from the guest filesystem. The
2118 filesystem must be mounted, and must contain a compatible
2119 operating system (ie. something Linux, with the same
2120 or compatible processor architecture).
2122 The single parameter is an argv-style list of arguments.
2123 The first element is the name of the program to run.
2124 Subsequent elements are parameters. The list must be
2125 non-empty (ie. must contain a program name). Note that
2126 the command runs directly, and is I<not> invoked via
2127 the shell (see C<guestfs_sh>).
2129 The return value is anything printed to I<stdout> by
2132 If the command returns a non-zero exit status, then
2133 this function returns an error message. The error message
2134 string is the content of I<stderr> from the command.
2136 The C<$PATH> environment variable will contain at least
2137 C</usr/bin> and C</bin>. If you require a program from
2138 another location, you should provide the full path in the
2141 Shared libraries and data files required by the program
2142 must be available on filesystems which are mounted in the
2143 correct places. It is the caller's responsibility to ensure
2144 all filesystems that are needed are mounted at the right
2147 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2148 [InitScratchFS, Always, TestOutputList (
2149 [["mkdir"; "/command_lines"];
2150 ["upload"; "test-command"; "/command_lines/test-command"];
2151 ["chmod"; "0o755"; "/command_lines/test-command"];
2152 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2153 InitScratchFS, Always, TestOutputList (
2154 [["mkdir"; "/command_lines2"];
2155 ["upload"; "test-command"; "/command_lines2/test-command"];
2156 ["chmod"; "0o755"; "/command_lines2/test-command"];
2157 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2158 InitScratchFS, Always, TestOutputList (
2159 [["mkdir"; "/command_lines3"];
2160 ["upload"; "test-command"; "/command_lines3/test-command"];
2161 ["chmod"; "0o755"; "/command_lines3/test-command"];
2162 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2163 InitScratchFS, Always, TestOutputList (
2164 [["mkdir"; "/command_lines4"];
2165 ["upload"; "test-command"; "/command_lines4/test-command"];
2166 ["chmod"; "0o755"; "/command_lines4/test-command"];
2167 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2168 InitScratchFS, Always, TestOutputList (
2169 [["mkdir"; "/command_lines5"];
2170 ["upload"; "test-command"; "/command_lines5/test-command"];
2171 ["chmod"; "0o755"; "/command_lines5/test-command"];
2172 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2173 InitScratchFS, Always, TestOutputList (
2174 [["mkdir"; "/command_lines6"];
2175 ["upload"; "test-command"; "/command_lines6/test-command"];
2176 ["chmod"; "0o755"; "/command_lines6/test-command"];
2177 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2178 InitScratchFS, Always, TestOutputList (
2179 [["mkdir"; "/command_lines7"];
2180 ["upload"; "test-command"; "/command_lines7/test-command"];
2181 ["chmod"; "0o755"; "/command_lines7/test-command"];
2182 ["command_lines"; "/command_lines7/test-command 7"]], []);
2183 InitScratchFS, Always, TestOutputList (
2184 [["mkdir"; "/command_lines8"];
2185 ["upload"; "test-command"; "/command_lines8/test-command"];
2186 ["chmod"; "0o755"; "/command_lines8/test-command"];
2187 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2188 InitScratchFS, Always, TestOutputList (
2189 [["mkdir"; "/command_lines9"];
2190 ["upload"; "test-command"; "/command_lines9/test-command"];
2191 ["chmod"; "0o755"; "/command_lines9/test-command"];
2192 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2193 InitScratchFS, Always, TestOutputList (
2194 [["mkdir"; "/command_lines10"];
2195 ["upload"; "test-command"; "/command_lines10/test-command"];
2196 ["chmod"; "0o755"; "/command_lines10/test-command"];
2197 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2198 InitScratchFS, Always, TestOutputList (
2199 [["mkdir"; "/command_lines11"];
2200 ["upload"; "test-command"; "/command_lines11/test-command"];
2201 ["chmod"; "0o755"; "/command_lines11/test-command"];
2202 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2203 "run a command, returning lines",
2205 This is the same as C<guestfs_command>, but splits the
2206 result into a list of lines.
2208 See also: C<guestfs_sh_lines>");
2210 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2211 [InitISOFS, Always, TestOutputStruct (
2212 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2213 "get file information",
2215 Returns file information for the given C<path>.
2217 This is the same as the C<stat(2)> system call.");
2219 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2220 [InitISOFS, Always, TestOutputStruct (
2221 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2222 "get file information for a symbolic link",
2224 Returns file information for the given C<path>.
2226 This is the same as C<guestfs_stat> except that if C<path>
2227 is a symbolic link, then the link is stat-ed, not the file it
2230 This is the same as the C<lstat(2)> system call.");
2232 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2233 [InitISOFS, Always, TestOutputStruct (
2234 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2235 "get file system statistics",
2237 Returns file system statistics for any mounted file system.
2238 C<path> should be a file or directory in the mounted file system
2239 (typically it is the mount point itself, but it doesn't need to be).
2241 This is the same as the C<statvfs(2)> system call.");
2243 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2245 "get ext2/ext3/ext4 superblock details",
2247 This returns the contents of the ext2, ext3 or ext4 filesystem
2248 superblock on C<device>.
2250 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2251 manpage for more details. The list of fields returned isn't
2252 clearly defined, and depends on both the version of C<tune2fs>
2253 that libguestfs was built against, and the filesystem itself.");
2255 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2256 [InitEmpty, Always, TestOutputTrue (
2257 [["blockdev_setro"; "/dev/sda"];
2258 ["blockdev_getro"; "/dev/sda"]])],
2259 "set block device to read-only",
2261 Sets the block device named C<device> to read-only.
2263 This uses the L<blockdev(8)> command.");
2265 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2266 [InitEmpty, Always, TestOutputFalse (
2267 [["blockdev_setrw"; "/dev/sda"];
2268 ["blockdev_getro"; "/dev/sda"]])],
2269 "set block device to read-write",
2271 Sets the block device named C<device> to read-write.
2273 This uses the L<blockdev(8)> command.");
2275 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2276 [InitEmpty, Always, TestOutputTrue (
2277 [["blockdev_setro"; "/dev/sda"];
2278 ["blockdev_getro"; "/dev/sda"]])],
2279 "is block device set to read-only",
2281 Returns a boolean indicating if the block device is read-only
2282 (true if read-only, false if not).
2284 This uses the L<blockdev(8)> command.");
2286 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2287 [InitEmpty, Always, TestOutputInt (
2288 [["blockdev_getss"; "/dev/sda"]], 512)],
2289 "get sectorsize of block device",
2291 This returns the size of sectors on a block device.
2292 Usually 512, but can be larger for modern devices.
2294 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2297 This uses the L<blockdev(8)> command.");
2299 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2300 [InitEmpty, Always, TestOutputInt (
2301 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2302 "get blocksize of block device",
2304 This returns the block size of a device.
2306 (Note this is different from both I<size in blocks> and
2307 I<filesystem block size>).
2309 This uses the L<blockdev(8)> command.");
2311 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2313 "set blocksize of block device",
2315 This sets the block size of a device.
2317 (Note this is different from both I<size in blocks> and
2318 I<filesystem block size>).
2320 This uses the L<blockdev(8)> command.");
2322 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2323 [InitEmpty, Always, TestOutputInt (
2324 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2325 "get total size of device in 512-byte sectors",
2327 This returns the size of the device in units of 512-byte sectors
2328 (even if the sectorsize isn't 512 bytes ... weird).
2330 See also C<guestfs_blockdev_getss> for the real sector size of
2331 the device, and C<guestfs_blockdev_getsize64> for the more
2332 useful I<size in bytes>.
2334 This uses the L<blockdev(8)> command.");
2336 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2337 [InitEmpty, Always, TestOutputInt (
2338 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2339 "get total size of device in bytes",
2341 This returns the size of the device in bytes.
2343 See also C<guestfs_blockdev_getsz>.
2345 This uses the L<blockdev(8)> command.");
2347 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2348 [InitEmpty, Always, TestRun
2349 [["blockdev_flushbufs"; "/dev/sda"]]],
2350 "flush device buffers",
2352 This tells the kernel to flush internal buffers associated
2355 This uses the L<blockdev(8)> command.");
2357 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2358 [InitEmpty, Always, TestRun
2359 [["blockdev_rereadpt"; "/dev/sda"]]],
2360 "reread partition table",
2362 Reread the partition table on C<device>.
2364 This uses the L<blockdev(8)> command.");
2366 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2367 [InitScratchFS, Always, TestOutput (
2368 (* Pick a file from cwd which isn't likely to change. *)
2369 [["mkdir"; "/upload"];
2370 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2371 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2372 Digest.to_hex (Digest.file "COPYING.LIB"))],
2373 "upload a file from the local machine",
2375 Upload local file C<filename> to C<remotefilename> on the
2378 C<filename> can also be a named pipe.
2380 See also C<guestfs_download>.");
2382 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2383 [InitScratchFS, Always, TestOutput (
2384 (* Pick a file from cwd which isn't likely to change. *)
2385 [["mkdir"; "/download"];
2386 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2387 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2388 ["upload"; "testdownload.tmp"; "/download/upload"];
2389 ["checksum"; "md5"; "/download/upload"]],
2390 Digest.to_hex (Digest.file "COPYING.LIB"))],
2391 "download a file to the local machine",
2393 Download file C<remotefilename> and save it as C<filename>
2394 on the local machine.
2396 C<filename> can also be a named pipe.
2398 See also C<guestfs_upload>, C<guestfs_cat>.");
2400 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2401 [InitISOFS, Always, TestOutput (
2402 [["checksum"; "crc"; "/known-3"]], "2891671662");
2403 InitISOFS, Always, TestLastFail (
2404 [["checksum"; "crc"; "/notexists"]]);
2405 InitISOFS, Always, TestOutput (
2406 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2407 InitISOFS, Always, TestOutput (
2408 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2409 InitISOFS, Always, TestOutput (
2410 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2411 InitISOFS, Always, TestOutput (
2412 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2413 InitISOFS, Always, TestOutput (
2414 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2415 InitISOFS, Always, TestOutput (
2416 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2417 (* Test for RHBZ#579608, absolute symbolic links. *)
2418 InitISOFS, Always, TestOutput (
2419 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2420 "compute MD5, SHAx or CRC checksum of file",
2422 This call computes the MD5, SHAx or CRC checksum of the
2425 The type of checksum to compute is given by the C<csumtype>
2426 parameter which must have one of the following values:
2432 Compute the cyclic redundancy check (CRC) specified by POSIX
2433 for the C<cksum> command.
2437 Compute the MD5 hash (using the C<md5sum> program).
2441 Compute the SHA1 hash (using the C<sha1sum> program).
2445 Compute the SHA224 hash (using the C<sha224sum> program).
2449 Compute the SHA256 hash (using the C<sha256sum> program).
2453 Compute the SHA384 hash (using the C<sha384sum> program).
2457 Compute the SHA512 hash (using the C<sha512sum> program).
2461 The checksum is returned as a printable string.
2463 To get the checksum for a device, use C<guestfs_checksum_device>.
2465 To get the checksums for many files, use C<guestfs_checksums_out>.");
2467 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2468 [InitScratchFS, Always, TestOutput (
2469 [["mkdir"; "/tar_in"];
2470 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2471 ["cat"; "/tar_in/hello"]], "hello\n")],
2472 "unpack tarfile to directory",
2474 This command uploads and unpacks local file C<tarfile> (an
2475 I<uncompressed> tar file) into C<directory>.
2477 To upload a compressed tarball, use C<guestfs_tgz_in>
2478 or C<guestfs_txz_in>.");
2480 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2482 "pack directory into tarfile",
2484 This command packs the contents of C<directory> and downloads
2485 it to local file C<tarfile>.
2487 To download a compressed tarball, use C<guestfs_tgz_out>
2488 or C<guestfs_txz_out>.");
2490 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2491 [InitScratchFS, Always, TestOutput (
2492 [["mkdir"; "/tgz_in"];
2493 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2494 ["cat"; "/tgz_in/hello"]], "hello\n")],
2495 "unpack compressed tarball to directory",
2497 This command uploads and unpacks local file C<tarball> (a
2498 I<gzip compressed> tar file) into C<directory>.
2500 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2502 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2504 "pack directory into compressed tarball",
2506 This command packs the contents of C<directory> and downloads
2507 it to local file C<tarball>.
2509 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2511 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2512 [InitBasicFS, Always, TestLastFail (
2514 ["mount_ro"; "/dev/sda1"; "/"];
2515 ["touch"; "/new"]]);
2516 InitBasicFS, Always, TestOutput (
2517 [["write"; "/new"; "data"];
2519 ["mount_ro"; "/dev/sda1"; "/"];
2520 ["cat"; "/new"]], "data")],
2521 "mount a guest disk, read-only",
2523 This is the same as the C<guestfs_mount> command, but it
2524 mounts the filesystem with the read-only (I<-o ro>) flag.");
2526 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2528 "mount a guest disk with mount options",
2530 This is the same as the C<guestfs_mount> command, but it
2531 allows you to set the mount options as for the
2532 L<mount(8)> I<-o> flag.
2534 If the C<options> parameter is an empty string, then
2535 no options are passed (all options default to whatever
2536 the filesystem uses).");
2538 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2540 "mount a guest disk with mount options and vfstype",
2542 This is the same as the C<guestfs_mount> command, but it
2543 allows you to set both the mount options and the vfstype
2544 as for the L<mount(8)> I<-o> and I<-t> flags.");
2546 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2548 "debugging and internals",
2550 The C<guestfs_debug> command exposes some internals of
2551 C<guestfsd> (the guestfs daemon) that runs inside the
2554 There is no comprehensive help for this command. You have
2555 to look at the file C<daemon/debug.c> in the libguestfs source
2556 to find out what you can do.");
2558 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2559 [InitEmpty, Always, TestOutputList (
2560 [["part_disk"; "/dev/sda"; "mbr"];
2561 ["pvcreate"; "/dev/sda1"];
2562 ["vgcreate"; "VG"; "/dev/sda1"];
2563 ["lvcreate"; "LV1"; "VG"; "50"];
2564 ["lvcreate"; "LV2"; "VG"; "50"];
2565 ["lvremove"; "/dev/VG/LV1"];
2566 ["lvs"]], ["/dev/VG/LV2"]);
2567 InitEmpty, Always, TestOutputList (
2568 [["part_disk"; "/dev/sda"; "mbr"];
2569 ["pvcreate"; "/dev/sda1"];
2570 ["vgcreate"; "VG"; "/dev/sda1"];
2571 ["lvcreate"; "LV1"; "VG"; "50"];
2572 ["lvcreate"; "LV2"; "VG"; "50"];
2573 ["lvremove"; "/dev/VG"];
2575 InitEmpty, Always, TestOutputList (
2576 [["part_disk"; "/dev/sda"; "mbr"];
2577 ["pvcreate"; "/dev/sda1"];
2578 ["vgcreate"; "VG"; "/dev/sda1"];
2579 ["lvcreate"; "LV1"; "VG"; "50"];
2580 ["lvcreate"; "LV2"; "VG"; "50"];
2581 ["lvremove"; "/dev/VG"];
2583 "remove an LVM logical volume",
2585 Remove an LVM logical volume C<device>, where C<device> is
2586 the path to the LV, such as C</dev/VG/LV>.
2588 You can also remove all LVs in a volume group by specifying
2589 the VG name, C</dev/VG>.");
2591 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2592 [InitEmpty, Always, TestOutputList (
2593 [["part_disk"; "/dev/sda"; "mbr"];
2594 ["pvcreate"; "/dev/sda1"];
2595 ["vgcreate"; "VG"; "/dev/sda1"];
2596 ["lvcreate"; "LV1"; "VG"; "50"];
2597 ["lvcreate"; "LV2"; "VG"; "50"];
2600 InitEmpty, Always, TestOutputList (
2601 [["part_disk"; "/dev/sda"; "mbr"];
2602 ["pvcreate"; "/dev/sda1"];
2603 ["vgcreate"; "VG"; "/dev/sda1"];
2604 ["lvcreate"; "LV1"; "VG"; "50"];
2605 ["lvcreate"; "LV2"; "VG"; "50"];
2608 "remove an LVM volume group",
2610 Remove an LVM volume group C<vgname>, (for example C<VG>).
2612 This also forcibly removes all logical volumes in the volume
2615 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2616 [InitEmpty, Always, TestOutputListOfDevices (
2617 [["part_disk"; "/dev/sda"; "mbr"];
2618 ["pvcreate"; "/dev/sda1"];
2619 ["vgcreate"; "VG"; "/dev/sda1"];
2620 ["lvcreate"; "LV1"; "VG"; "50"];
2621 ["lvcreate"; "LV2"; "VG"; "50"];
2623 ["pvremove"; "/dev/sda1"];
2625 InitEmpty, Always, TestOutputListOfDevices (
2626 [["part_disk"; "/dev/sda"; "mbr"];
2627 ["pvcreate"; "/dev/sda1"];
2628 ["vgcreate"; "VG"; "/dev/sda1"];
2629 ["lvcreate"; "LV1"; "VG"; "50"];
2630 ["lvcreate"; "LV2"; "VG"; "50"];
2632 ["pvremove"; "/dev/sda1"];
2634 InitEmpty, Always, TestOutputListOfDevices (
2635 [["part_disk"; "/dev/sda"; "mbr"];
2636 ["pvcreate"; "/dev/sda1"];
2637 ["vgcreate"; "VG"; "/dev/sda1"];
2638 ["lvcreate"; "LV1"; "VG"; "50"];
2639 ["lvcreate"; "LV2"; "VG"; "50"];
2641 ["pvremove"; "/dev/sda1"];
2643 "remove an LVM physical volume",
2645 This wipes a physical volume C<device> so that LVM will no longer
2648 The implementation uses the C<pvremove> command which refuses to
2649 wipe physical volumes that contain any volume groups, so you have
2650 to remove those first.");
2652 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2653 [InitBasicFS, Always, TestOutput (
2654 [["set_e2label"; "/dev/sda1"; "testlabel"];
2655 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2656 "set the ext2/3/4 filesystem label",
2658 This sets the ext2/3/4 filesystem label of the filesystem on
2659 C<device> to C<label>. Filesystem labels are limited to
2662 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2663 to return the existing label on a filesystem.");
2665 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2667 "get the ext2/3/4 filesystem label",
2669 This returns the ext2/3/4 filesystem label of the filesystem on
2672 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2673 (let uuid = uuidgen () in
2674 [InitBasicFS, Always, TestOutput (
2675 [["set_e2uuid"; "/dev/sda1"; uuid];
2676 ["get_e2uuid"; "/dev/sda1"]], uuid);
2677 InitBasicFS, Always, TestOutput (
2678 [["set_e2uuid"; "/dev/sda1"; "clear"];
2679 ["get_e2uuid"; "/dev/sda1"]], "");
2680 (* We can't predict what UUIDs will be, so just check the commands run. *)
2681 InitBasicFS, Always, TestRun (
2682 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2683 InitBasicFS, Always, TestRun (
2684 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2685 "set the ext2/3/4 filesystem UUID",
2687 This sets the ext2/3/4 filesystem UUID of the filesystem on
2688 C<device> to C<uuid>. The format of the UUID and alternatives
2689 such as C<clear>, C<random> and C<time> are described in the
2690 L<tune2fs(8)> manpage.
2692 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2693 to return the existing UUID of a filesystem.");
2695 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2696 (* Regression test for RHBZ#597112. *)
2697 (let uuid = uuidgen () in
2698 [InitNone, Always, TestOutput (
2699 [["mke2journal"; "1024"; "/dev/sdc"];
2700 ["set_e2uuid"; "/dev/sdc"; uuid];
2701 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2702 "get the ext2/3/4 filesystem UUID",
2704 This returns the ext2/3/4 filesystem UUID of the filesystem on
2707 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2708 [InitBasicFS, Always, TestOutputInt (
2709 [["umount"; "/dev/sda1"];
2710 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2711 InitBasicFS, Always, TestOutputInt (
2712 [["umount"; "/dev/sda1"];
2713 ["zero"; "/dev/sda1"];
2714 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2715 "run the filesystem checker",
2717 This runs the filesystem checker (fsck) on C<device> which
2718 should have filesystem type C<fstype>.
2720 The returned integer is the status. See L<fsck(8)> for the
2721 list of status codes from C<fsck>.
2729 Multiple status codes can be summed together.
2733 A non-zero return code can mean \"success\", for example if
2734 errors have been corrected on the filesystem.
2738 Checking or repairing NTFS volumes is not supported
2743 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2745 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2746 [InitBasicFS, Always, TestRun (
2747 [["umount"; "/dev/sda1"];
2748 ["zero"; "/dev/sda1"]])],
2749 "write zeroes to the device",
2751 This command writes zeroes over the first few blocks of C<device>.
2753 How many blocks are zeroed isn't specified (but it's I<not> enough
2754 to securely wipe the device). It should be sufficient to remove
2755 any partition tables, filesystem superblocks and so on.
2757 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2759 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2761 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2762 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2764 [InitBasicFS, Always, TestOutputTrue (
2765 [["mkdir_p"; "/boot/grub"];
2766 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2767 ["grub_install"; "/"; "/dev/vda"];
2768 ["is_dir"; "/boot"]])],
2771 This command installs GRUB (the Grand Unified Bootloader) on
2772 C<device>, with the root directory being C<root>.
2774 Note: If grub-install reports the error
2775 \"No suitable drive was found in the generated device map.\"
2776 it may be that you need to create a C</boot/grub/device.map>
2777 file first that contains the mapping between grub device names
2778 and Linux device names. It is usually sufficient to create
2783 replacing C</dev/vda> with the name of the installation device.");
2785 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2786 [InitScratchFS, Always, TestOutput (
2788 ["write"; "/cp/old"; "file content"];
2789 ["cp"; "/cp/old"; "/cp/new"];
2790 ["cat"; "/cp/new"]], "file content");
2791 InitScratchFS, Always, TestOutputTrue (
2793 ["write"; "/cp2/old"; "file content"];
2794 ["cp"; "/cp2/old"; "/cp2/new"];
2795 ["is_file"; "/cp2/old"]]);
2796 InitScratchFS, Always, TestOutput (
2798 ["write"; "/cp3/old"; "file content"];
2799 ["mkdir"; "/cp3/dir"];
2800 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2801 ["cat"; "/cp3/dir/new"]], "file content")],
2804 This copies a file from C<src> to C<dest> where C<dest> is
2805 either a destination filename or destination directory.");
2807 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2808 [InitScratchFS, Always, TestOutput (
2809 [["mkdir"; "/cp_a1"];
2810 ["mkdir"; "/cp_a2"];
2811 ["write"; "/cp_a1/file"; "file content"];
2812 ["cp_a"; "/cp_a1"; "/cp_a2"];
2813 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2814 "copy a file or directory recursively",
2816 This copies a file or directory from C<src> to C<dest>
2817 recursively using the C<cp -a> command.");
2819 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2820 [InitScratchFS, Always, TestOutput (
2822 ["write"; "/mv/old"; "file content"];
2823 ["mv"; "/mv/old"; "/mv/new"];
2824 ["cat"; "/mv/new"]], "file content");
2825 InitScratchFS, Always, TestOutputFalse (
2827 ["write"; "/mv2/old"; "file content"];
2828 ["mv"; "/mv2/old"; "/mv2/new"];
2829 ["is_file"; "/mv2/old"]])],
2832 This moves a file from C<src> to C<dest> where C<dest> is
2833 either a destination filename or destination directory.");
2835 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2836 [InitEmpty, Always, TestRun (
2837 [["drop_caches"; "3"]])],
2838 "drop kernel page cache, dentries and inodes",
2840 This instructs the guest kernel to drop its page cache,
2841 and/or dentries and inode caches. The parameter C<whattodrop>
2842 tells the kernel what precisely to drop, see
2843 L<http://linux-mm.org/Drop_Caches>
2845 Setting C<whattodrop> to 3 should drop everything.
2847 This automatically calls L<sync(2)> before the operation,
2848 so that the maximum guest memory is freed.");
2850 ("dmesg", (RString "kmsgs", [], []), 91, [],
2851 [InitEmpty, Always, TestRun (
2853 "return kernel messages",
2855 This returns the kernel messages (C<dmesg> output) from
2856 the guest kernel. This is sometimes useful for extended
2857 debugging of problems.
2859 Another way to get the same information is to enable
2860 verbose messages with C<guestfs_set_verbose> or by setting
2861 the environment variable C<LIBGUESTFS_DEBUG=1> before
2862 running the program.");
2864 ("ping_daemon", (RErr, [], []), 92, [],
2865 [InitEmpty, Always, TestRun (
2866 [["ping_daemon"]])],
2867 "ping the guest daemon",
2869 This is a test probe into the guestfs daemon running inside
2870 the qemu subprocess. Calling this function checks that the
2871 daemon responds to the ping message, without affecting the daemon
2872 or attached block device(s) in any other way.");
2874 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2875 [InitScratchFS, Always, TestOutputTrue (
2876 [["mkdir"; "/equal"];
2877 ["write"; "/equal/file1"; "contents of a file"];
2878 ["cp"; "/equal/file1"; "/equal/file2"];
2879 ["equal"; "/equal/file1"; "/equal/file2"]]);
2880 InitScratchFS, Always, TestOutputFalse (
2881 [["mkdir"; "/equal2"];
2882 ["write"; "/equal2/file1"; "contents of a file"];
2883 ["write"; "/equal2/file2"; "contents of another file"];
2884 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
2885 InitScratchFS, Always, TestLastFail (
2886 [["mkdir"; "/equal3"];
2887 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
2888 "test if two files have equal contents",
2890 This compares the two files C<file1> and C<file2> and returns
2891 true if their content is exactly equal, or false otherwise.
2893 The external L<cmp(1)> program is used for the comparison.");
2895 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2896 [InitISOFS, Always, TestOutputList (
2897 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2898 InitISOFS, Always, TestOutputList (
2899 [["strings"; "/empty"]], []);
2900 (* Test for RHBZ#579608, absolute symbolic links. *)
2901 InitISOFS, Always, TestRun (
2902 [["strings"; "/abssymlink"]])],
2903 "print the printable strings in a file",
2905 This runs the L<strings(1)> command on a file and returns
2906 the list of printable strings found.");
2908 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2909 [InitISOFS, Always, TestOutputList (
2910 [["strings_e"; "b"; "/known-5"]], []);
2911 InitScratchFS, Always, TestOutputList (
2912 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2913 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
2914 "print the printable strings in a file",
2916 This is like the C<guestfs_strings> command, but allows you to
2917 specify the encoding of strings that are looked for in
2918 the source file C<path>.
2920 Allowed encodings are:
2926 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2927 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2931 Single 8-bit-byte characters.
2935 16-bit big endian strings such as those encoded in
2936 UTF-16BE or UCS-2BE.
2938 =item l (lower case letter L)
2940 16-bit little endian such as UTF-16LE and UCS-2LE.
2941 This is useful for examining binaries in Windows guests.
2945 32-bit big endian such as UCS-4BE.
2949 32-bit little endian such as UCS-4LE.
2953 The returned strings are transcoded to UTF-8.");
2955 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2956 [InitISOFS, Always, TestOutput (
2957 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2958 (* Test for RHBZ#501888c2 regression which caused large hexdump
2959 * commands to segfault.
2961 InitISOFS, Always, TestRun (
2962 [["hexdump"; "/100krandom"]]);
2963 (* Test for RHBZ#579608, absolute symbolic links. *)
2964 InitISOFS, Always, TestRun (
2965 [["hexdump"; "/abssymlink"]])],
2966 "dump a file in hexadecimal",
2968 This runs C<hexdump -C> on the given C<path>. The result is
2969 the human-readable, canonical hex dump of the file.");
2971 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2972 [InitNone, Always, TestOutput (
2973 [["part_disk"; "/dev/sda"; "mbr"];
2974 ["mkfs"; "ext3"; "/dev/sda1"];
2975 ["mount_options"; ""; "/dev/sda1"; "/"];
2976 ["write"; "/new"; "test file"];
2977 ["umount"; "/dev/sda1"];
2978 ["zerofree"; "/dev/sda1"];
2979 ["mount_options"; ""; "/dev/sda1"; "/"];
2980 ["cat"; "/new"]], "test file")],
2981 "zero unused inodes and disk blocks on ext2/3 filesystem",
2983 This runs the I<zerofree> program on C<device>. This program
2984 claims to zero unused inodes and disk blocks on an ext2/3
2985 filesystem, thus making it possible to compress the filesystem
2988 You should B<not> run this program if the filesystem is
2991 It is possible that using this program can damage the filesystem
2992 or data on the filesystem.");
2994 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2996 "resize an LVM physical volume",
2998 This resizes (expands or shrinks) an existing LVM physical
2999 volume to match the new size of the underlying device.");
3001 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3002 Int "cyls"; Int "heads"; Int "sectors";
3003 String "line"], []), 99, [DangerWillRobinson],
3005 "modify a single partition on a block device",
3007 This runs L<sfdisk(8)> option to modify just the single
3008 partition C<n> (note: C<n> counts from 1).
3010 For other parameters, see C<guestfs_sfdisk>. You should usually
3011 pass C<0> for the cyls/heads/sectors parameters.
3013 See also: C<guestfs_part_add>");
3015 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3017 "display the partition table",
3019 This displays the partition table on C<device>, in the
3020 human-readable output of the L<sfdisk(8)> command. It is
3021 not intended to be parsed.
3023 See also: C<guestfs_part_list>");
3025 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3027 "display the kernel geometry",
3029 This displays the kernel's idea of the geometry of C<device>.
3031 The result is in human-readable format, and not designed to
3034 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3036 "display the disk geometry from the partition table",
3038 This displays the disk geometry of C<device> read from the
3039 partition table. Especially in the case where the underlying
3040 block device has been resized, this can be different from the
3041 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3043 The result is in human-readable format, and not designed to
3046 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3048 "activate or deactivate all volume groups",
3050 This command activates or (if C<activate> is false) deactivates
3051 all logical volumes in all volume groups.
3052 If activated, then they are made known to the
3053 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3054 then those devices disappear.
3056 This command is the same as running C<vgchange -a y|n>");
3058 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3060 "activate or deactivate some volume groups",
3062 This command activates or (if C<activate> is false) deactivates
3063 all logical volumes in the listed volume groups C<volgroups>.
3064 If activated, then they are made known to the
3065 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3066 then those devices disappear.
3068 This command is the same as running C<vgchange -a y|n volgroups...>
3070 Note that if C<volgroups> is an empty list then B<all> volume groups
3071 are activated or deactivated.");
3073 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3074 [InitNone, Always, TestOutput (
3075 [["part_disk"; "/dev/sda"; "mbr"];
3076 ["pvcreate"; "/dev/sda1"];
3077 ["vgcreate"; "VG"; "/dev/sda1"];
3078 ["lvcreate"; "LV"; "VG"; "10"];
3079 ["mkfs"; "ext2"; "/dev/VG/LV"];
3080 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3081 ["write"; "/new"; "test content"];
3083 ["lvresize"; "/dev/VG/LV"; "20"];
3084 ["e2fsck_f"; "/dev/VG/LV"];
3085 ["resize2fs"; "/dev/VG/LV"];
3086 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3087 ["cat"; "/new"]], "test content");
3088 InitNone, Always, TestRun (
3089 (* Make an LV smaller to test RHBZ#587484. *)
3090 [["part_disk"; "/dev/sda"; "mbr"];
3091 ["pvcreate"; "/dev/sda1"];
3092 ["vgcreate"; "VG"; "/dev/sda1"];
3093 ["lvcreate"; "LV"; "VG"; "20"];
3094 ["lvresize"; "/dev/VG/LV"; "10"]])],
3095 "resize an LVM logical volume",
3097 This resizes (expands or shrinks) an existing LVM logical
3098 volume to C<mbytes>. When reducing, data in the reduced part
3101 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3102 [], (* lvresize tests this *)
3103 "resize an ext2, ext3 or ext4 filesystem",
3105 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3106 the underlying device.
3108 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3109 on the C<device> before calling this command. For unknown reasons
3110 C<resize2fs> sometimes gives an error about this and sometimes not.
3111 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3112 calling this function.");
3114 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3115 [InitBasicFS, Always, TestOutputList (
3116 [["find"; "/"]], ["lost+found"]);
3117 InitBasicFS, Always, TestOutputList (
3121 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3122 InitScratchFS, Always, TestOutputList (
3123 [["mkdir_p"; "/find/b/c"];
3124 ["touch"; "/find/b/c/d"];
3125 ["find"; "/find/b/"]], ["c"; "c/d"])],
3126 "find all files and directories",
3128 This command lists out all files and directories, recursively,
3129 starting at C<directory>. It is essentially equivalent to
3130 running the shell command C<find directory -print> but some
3131 post-processing happens on the output, described below.
3133 This returns a list of strings I<without any prefix>. Thus
3134 if the directory structure was:
3140 then the returned list from C<guestfs_find> C</tmp> would be
3148 If C<directory> is not a directory, then this command returns
3151 The returned list is sorted.
3153 See also C<guestfs_find0>.");
3155 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3156 [], (* lvresize tests this *)
3157 "check an ext2/ext3 filesystem",
3159 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3160 filesystem checker on C<device>, noninteractively (C<-p>),
3161 even if the filesystem appears to be clean (C<-f>).
3163 This command is only needed because of C<guestfs_resize2fs>
3164 (q.v.). Normally you should use C<guestfs_fsck>.");
3166 ("sleep", (RErr, [Int "secs"], []), 109, [],
3167 [InitNone, Always, TestRun (
3169 "sleep for some seconds",
3171 Sleep for C<secs> seconds.");
3173 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3174 [InitNone, Always, TestOutputInt (
3175 [["part_disk"; "/dev/sda"; "mbr"];
3176 ["mkfs"; "ntfs"; "/dev/sda1"];
3177 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3178 InitNone, Always, TestOutputInt (
3179 [["part_disk"; "/dev/sda"; "mbr"];
3180 ["mkfs"; "ext2"; "/dev/sda1"];
3181 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3182 "probe NTFS volume",
3184 This command runs the L<ntfs-3g.probe(8)> command which probes
3185 an NTFS C<device> for mountability. (Not all NTFS volumes can
3186 be mounted read-write, and some cannot be mounted at all).
3188 C<rw> is a boolean flag. Set it to true if you want to test
3189 if the volume can be mounted read-write. Set it to false if
3190 you want to test if the volume can be mounted read-only.
3192 The return value is an integer which C<0> if the operation
3193 would succeed, or some non-zero value documented in the
3194 L<ntfs-3g.probe(8)> manual page.");
3196 ("sh", (RString "output", [String "command"], []), 111, [],
3197 [], (* XXX needs tests *)
3198 "run a command via the shell",
3200 This call runs a command from the guest filesystem via the
3203 This is like C<guestfs_command>, but passes the command to:
3205 /bin/sh -c \"command\"
3207 Depending on the guest's shell, this usually results in
3208 wildcards being expanded, shell expressions being interpolated
3211 All the provisos about C<guestfs_command> apply to this call.");
3213 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3214 [], (* XXX needs tests *)
3215 "run a command via the shell returning lines",
3217 This is the same as C<guestfs_sh>, but splits the result
3218 into a list of lines.
3220 See also: C<guestfs_command_lines>");
3222 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3223 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3224 * code in stubs.c, since all valid glob patterns must start with "/".
3225 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3227 [InitScratchFS, Always, TestOutputList (
3228 [["mkdir_p"; "/glob_expand/b/c"];
3229 ["touch"; "/glob_expand/b/c/d"];
3230 ["touch"; "/glob_expand/b/c/e"];
3231 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3232 InitScratchFS, Always, TestOutputList (
3233 [["mkdir_p"; "/glob_expand2/b/c"];
3234 ["touch"; "/glob_expand2/b/c/d"];
3235 ["touch"; "/glob_expand2/b/c/e"];
3236 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3237 InitScratchFS, Always, TestOutputList (
3238 [["mkdir_p"; "/glob_expand3/b/c"];
3239 ["touch"; "/glob_expand3/b/c/d"];
3240 ["touch"; "/glob_expand3/b/c/e"];
3241 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3242 "expand a wildcard path",
3244 This command searches for all the pathnames matching
3245 C<pattern> according to the wildcard expansion rules
3248 If no paths match, then this returns an empty list
3249 (note: not an error).
3251 It is just a wrapper around the C L<glob(3)> function
3252 with flags C<GLOB_MARK|GLOB_BRACE>.
3253 See that manual page for more details.");
3255 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3256 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3257 [["scrub_device"; "/dev/sdc"]])],
3258 "scrub (securely wipe) a device",
3260 This command writes patterns over C<device> to make data retrieval
3263 It is an interface to the L<scrub(1)> program. See that
3264 manual page for more details.");
3266 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3267 [InitScratchFS, Always, TestRun (
3268 [["write"; "/scrub_file"; "content"];
3269 ["scrub_file"; "/scrub_file"]])],
3270 "scrub (securely wipe) a file",
3272 This command writes patterns over a file to make data retrieval
3275 The file is I<removed> after scrubbing.
3277 It is an interface to the L<scrub(1)> program. See that
3278 manual page for more details.");
3280 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3281 [], (* XXX needs testing *)
3282 "scrub (securely wipe) free space",
3284 This command creates the directory C<dir> and then fills it
3285 with files until the filesystem is full, and scrubs the files
3286 as for C<guestfs_scrub_file>, and deletes them.
3287 The intention is to scrub any free space on the partition
3290 It is an interface to the L<scrub(1)> program. See that
3291 manual page for more details.");
3293 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3294 [InitScratchFS, Always, TestRun (
3295 [["mkdir"; "/mkdtemp"];
3296 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3297 "create a temporary directory",
3299 This command creates a temporary directory. The
3300 C<template> parameter should be a full pathname for the
3301 temporary directory name with the final six characters being
3304 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3305 the second one being suitable for Windows filesystems.
3307 The name of the temporary directory that was created
3310 The temporary directory is created with mode 0700
3311 and is owned by root.
3313 The caller is responsible for deleting the temporary
3314 directory and its contents after use.
3316 See also: L<mkdtemp(3)>");
3318 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3319 [InitISOFS, Always, TestOutputInt (
3320 [["wc_l"; "/10klines"]], 10000);
3321 (* Test for RHBZ#579608, absolute symbolic links. *)
3322 InitISOFS, Always, TestOutputInt (
3323 [["wc_l"; "/abssymlink"]], 10000)],
3324 "count lines in a file",
3326 This command counts the lines in a file, using the
3327 C<wc -l> external command.");
3329 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3330 [InitISOFS, Always, TestOutputInt (
3331 [["wc_w"; "/10klines"]], 10000)],
3332 "count words in a file",
3334 This command counts the words in a file, using the
3335 C<wc -w> external command.");
3337 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3338 [InitISOFS, Always, TestOutputInt (
3339 [["wc_c"; "/100kallspaces"]], 102400)],
3340 "count characters in a file",
3342 This command counts the characters in a file, using the
3343 C<wc -c> external command.");
3345 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3346 [InitISOFS, Always, TestOutputList (
3347 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3348 (* Test for RHBZ#579608, absolute symbolic links. *)
3349 InitISOFS, Always, TestOutputList (
3350 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3351 "return first 10 lines of a file",
3353 This command returns up to the first 10 lines of a file as
3354 a list of strings.");
3356 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3357 [InitISOFS, Always, TestOutputList (
3358 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3359 InitISOFS, Always, TestOutputList (
3360 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3361 InitISOFS, Always, TestOutputList (
3362 [["head_n"; "0"; "/10klines"]], [])],
3363 "return first N lines of a file",
3365 If the parameter C<nrlines> is a positive number, this returns the first
3366 C<nrlines> lines of the file C<path>.
3368 If the parameter C<nrlines> is a negative number, this returns lines
3369 from the file C<path>, excluding the last C<nrlines> lines.
3371 If the parameter C<nrlines> is zero, this returns an empty list.");
3373 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3374 [InitISOFS, Always, TestOutputList (
3375 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3376 "return last 10 lines of a file",
3378 This command returns up to the last 10 lines of a file as
3379 a list of strings.");
3381 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3382 [InitISOFS, Always, TestOutputList (
3383 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3384 InitISOFS, Always, TestOutputList (
3385 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3386 InitISOFS, Always, TestOutputList (
3387 [["tail_n"; "0"; "/10klines"]], [])],
3388 "return last N lines of a file",
3390 If the parameter C<nrlines> is a positive number, this returns the last
3391 C<nrlines> lines of the file C<path>.
3393 If the parameter C<nrlines> is a negative number, this returns lines
3394 from the file C<path>, starting with the C<-nrlines>th line.
3396 If the parameter C<nrlines> is zero, this returns an empty list.");
3398 ("df", (RString "output", [], []), 125, [],
3399 [], (* XXX Tricky to test because it depends on the exact format
3400 * of the 'df' command and other imponderables.
3402 "report file system disk space usage",
3404 This command runs the C<df> command to report disk space used.
3406 This command is mostly useful for interactive sessions. It
3407 is I<not> intended that you try to parse the output string.
3408 Use C<guestfs_statvfs> from programs.");
3410 ("df_h", (RString "output", [], []), 126, [],
3411 [], (* XXX Tricky to test because it depends on the exact format
3412 * of the 'df' command and other imponderables.
3414 "report file system disk space usage (human readable)",
3416 This command runs the C<df -h> command to report disk space used
3417 in human-readable format.
3419 This command is mostly useful for interactive sessions. It
3420 is I<not> intended that you try to parse the output string.
3421 Use C<guestfs_statvfs> from programs.");
3423 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3424 [InitISOFS, Always, TestOutputInt (
3425 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3426 "estimate file space usage",
3428 This command runs the C<du -s> command to estimate file space
3431 C<path> can be a file or a directory. If C<path> is a directory
3432 then the estimate includes the contents of the directory and all
3433 subdirectories (recursively).
3435 The result is the estimated size in I<kilobytes>
3436 (ie. units of 1024 bytes).");
3438 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3439 [InitISOFS, Always, TestOutputList (
3440 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3441 "list files in an initrd",
3443 This command lists out files contained in an initrd.
3445 The files are listed without any initial C</> character. The
3446 files are listed in the order they appear (not necessarily
3447 alphabetical). Directory names are listed as separate items.
3449 Old Linux kernels (2.4 and earlier) used a compressed ext2
3450 filesystem as initrd. We I<only> support the newer initramfs
3451 format (compressed cpio files).");
3453 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3455 "mount a file using the loop device",
3457 This command lets you mount C<file> (a filesystem image
3458 in a file) on a mount point. It is entirely equivalent to
3459 the command C<mount -o loop file mountpoint>.");
3461 ("mkswap", (RErr, [Device "device"], []), 130, [],
3462 [InitEmpty, Always, TestRun (
3463 [["part_disk"; "/dev/sda"; "mbr"];
3464 ["mkswap"; "/dev/sda1"]])],
3465 "create a swap partition",
3467 Create a swap partition on C<device>.");
3469 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3470 [InitEmpty, Always, TestRun (
3471 [["part_disk"; "/dev/sda"; "mbr"];
3472 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3473 "create a swap partition with a label",
3475 Create a swap partition on C<device> with label C<label>.
3477 Note that you cannot attach a swap label to a block device
3478 (eg. C</dev/sda>), just to a partition. This appears to be
3479 a limitation of the kernel or swap tools.");
3481 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3482 (let uuid = uuidgen () in
3483 [InitEmpty, Always, TestRun (
3484 [["part_disk"; "/dev/sda"; "mbr"];
3485 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3486 "create a swap partition with an explicit UUID",
3488 Create a swap partition on C<device> with UUID C<uuid>.");
3490 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3491 [InitScratchFS, Always, TestOutputStruct (
3492 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3493 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3494 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3495 InitScratchFS, Always, TestOutputStruct (
3496 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3497 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3498 "make block, character or FIFO devices",
3500 This call creates block or character special devices, or
3501 named pipes (FIFOs).
3503 The C<mode> parameter should be the mode, using the standard
3504 constants. C<devmajor> and C<devminor> are the
3505 device major and minor numbers, only used when creating block
3506 and character special devices.
3508 Note that, just like L<mknod(2)>, the mode must be bitwise
3509 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3510 just creates a regular file). These constants are
3511 available in the standard Linux header files, or you can use
3512 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3513 which are wrappers around this command which bitwise OR
3514 in the appropriate constant for you.
3516 The mode actually set is affected by the umask.");
3518 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3519 [InitScratchFS, Always, TestOutputStruct (
3520 [["mkfifo"; "0o777"; "/mkfifo"];
3521 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3522 "make FIFO (named pipe)",
3524 This call creates a FIFO (named pipe) called C<path> with
3525 mode C<mode>. It is just a convenient wrapper around
3528 The mode actually set is affected by the umask.");
3530 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3531 [InitScratchFS, Always, TestOutputStruct (
3532 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3533 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3534 "make block device node",
3536 This call creates a block device node called C<path> with
3537 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3538 It is just a convenient wrapper around C<guestfs_mknod>.
3540 The mode actually set is affected by the umask.");
3542 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3543 [InitScratchFS, Always, TestOutputStruct (
3544 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3545 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3546 "make char device node",
3548 This call creates a char device node called C<path> with
3549 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3550 It is just a convenient wrapper around C<guestfs_mknod>.
3552 The mode actually set is affected by the umask.");
3554 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3555 [InitEmpty, Always, TestOutputInt (
3556 [["umask"; "0o22"]], 0o22)],
3557 "set file mode creation mask (umask)",
3559 This function sets the mask used for creating new files and
3560 device nodes to C<mask & 0777>.
3562 Typical umask values would be C<022> which creates new files
3563 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3564 C<002> which creates new files with permissions like
3565 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3567 The default umask is C<022>. This is important because it
3568 means that directories and device nodes will be created with
3569 C<0644> or C<0755> mode even if you specify C<0777>.
3571 See also C<guestfs_get_umask>,
3572 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3574 This call returns the previous umask.");
3576 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3578 "read directories entries",
3580 This returns the list of directory entries in directory C<dir>.
3582 All entries in the directory are returned, including C<.> and
3583 C<..>. The entries are I<not> sorted, but returned in the same
3584 order as the underlying filesystem.
3586 Also this call returns basic file type information about each
3587 file. The C<ftyp> field will contain one of the following characters:
3625 The L<readdir(3)> call returned a C<d_type> field with an
3630 This function is primarily intended for use by programs. To
3631 get a simple list of names, use C<guestfs_ls>. To get a printable
3632 directory for human consumption, use C<guestfs_ll>.");
3634 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3636 "create partitions on a block device",
3638 This is a simplified interface to the C<guestfs_sfdisk>
3639 command, where partition sizes are specified in megabytes
3640 only (rounded to the nearest cylinder) and you don't need
3641 to specify the cyls, heads and sectors parameters which
3642 were rarely if ever used anyway.
3644 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3645 and C<guestfs_part_disk>");
3647 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3649 "determine file type inside a compressed file",
3651 This command runs C<file> after first decompressing C<path>
3654 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3656 Since 1.0.63, use C<guestfs_file> instead which can now
3657 process compressed files.");
3659 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3661 "list extended attributes of a file or directory",
3663 This call lists the extended attributes of the file or directory
3666 At the system call level, this is a combination of the
3667 L<listxattr(2)> and L<getxattr(2)> calls.
3669 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3671 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3673 "list extended attributes of a file or directory",
3675 This is the same as C<guestfs_getxattrs>, but if C<path>
3676 is a symbolic link, then it returns the extended attributes
3677 of the link itself.");
3679 ("setxattr", (RErr, [String "xattr";
3680 String "val"; Int "vallen"; (* will be BufferIn *)
3681 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3683 "set extended attribute of a file or directory",
3685 This call sets the extended attribute named C<xattr>
3686 of the file C<path> to the value C<val> (of length C<vallen>).
3687 The value is arbitrary 8 bit data.
3689 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3691 ("lsetxattr", (RErr, [String "xattr";
3692 String "val"; Int "vallen"; (* will be BufferIn *)
3693 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3695 "set extended attribute of a file or directory",
3697 This is the same as C<guestfs_setxattr>, but if C<path>
3698 is a symbolic link, then it sets an extended attribute
3699 of the link itself.");
3701 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3703 "remove extended attribute of a file or directory",
3705 This call removes the extended attribute named C<xattr>
3706 of the file C<path>.
3708 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3710 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3712 "remove extended attribute of a file or directory",
3714 This is the same as C<guestfs_removexattr>, but if C<path>
3715 is a symbolic link, then it removes an extended attribute
3716 of the link itself.");
3718 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3722 This call is similar to C<guestfs_mounts>. That call returns
3723 a list of devices. This one returns a hash table (map) of
3724 device name to directory where the device is mounted.");
3726 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3727 (* This is a special case: while you would expect a parameter
3728 * of type "Pathname", that doesn't work, because it implies
3729 * NEED_ROOT in the generated calling code in stubs.c, and
3730 * this function cannot use NEED_ROOT.
3733 "create a mountpoint",
3735 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3736 specialized calls that can be used to create extra mountpoints
3737 before mounting the first filesystem.
3739 These calls are I<only> necessary in some very limited circumstances,
3740 mainly the case where you want to mount a mix of unrelated and/or
3741 read-only filesystems together.
3743 For example, live CDs often contain a \"Russian doll\" nest of
3744 filesystems, an ISO outer layer, with a squashfs image inside, with
3745 an ext2/3 image inside that. You can unpack this as follows
3748 add-ro Fedora-11-i686-Live.iso
3752 mkmountpoint /ext3fs
3754 mount-loop /cd/LiveOS/squashfs.img /sqsh
3755 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3757 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3759 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3760 You may get unexpected errors if you try to mix these calls. It is
3761 safest to manually unmount filesystems and remove mountpoints after use.
3763 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3764 longest first, so for this to work for manual mountpoints, you
3765 must ensure that the innermost mountpoints have the longest
3766 pathnames, as in the example code above.
3768 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3770 Autosync [see C<guestfs_set_autosync>, this is set by default on
3771 handles] means that C<guestfs_umount_all> is called when the handle
3772 is closed which can also trigger these issues.");
3774 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3776 "remove a mountpoint",
3778 This calls removes a mountpoint that was previously created
3779 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3780 for full details.");
3782 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3783 [InitISOFS, Always, TestOutputBuffer (
3784 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3785 (* Test various near large, large and too large files (RHBZ#589039). *)
3786 InitScratchFS, Always, TestLastFail (
3787 [["touch"; "/read_file"];
3788 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3789 ["read_file"; "/read_file"]]);
3790 InitScratchFS, Always, TestLastFail (
3791 [["touch"; "/read_file2"];
3792 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3793 ["read_file"; "/read_file2"]]);
3794 InitScratchFS, Always, TestLastFail (
3795 [["touch"; "/read_file3"];
3796 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3797 ["read_file"; "/read_file3"]])],
3800 This calls returns the contents of the file C<path> as a
3803 Unlike C<guestfs_cat>, this function can correctly
3804 handle files that contain embedded ASCII NUL characters.
3805 However unlike C<guestfs_download>, this function is limited
3806 in the total size of file that can be handled.");
3808 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3809 [InitISOFS, Always, TestOutputList (
3810 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3811 InitISOFS, Always, TestOutputList (
3812 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3813 (* Test for RHBZ#579608, absolute symbolic links. *)
3814 InitISOFS, Always, TestOutputList (
3815 [["grep"; "nomatch"; "/abssymlink"]], [])],
3816 "return lines matching a pattern",
3818 This calls the external C<grep> program and returns the
3821 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3822 [InitISOFS, Always, TestOutputList (
3823 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3824 "return lines matching a pattern",
3826 This calls the external C<egrep> program and returns the
3829 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3830 [InitISOFS, Always, TestOutputList (
3831 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3832 "return lines matching a pattern",
3834 This calls the external C<fgrep> program and returns the
3837 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3838 [InitISOFS, Always, TestOutputList (
3839 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3840 "return lines matching a pattern",
3842 This calls the external C<grep -i> program and returns the
3845 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3846 [InitISOFS, Always, TestOutputList (
3847 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3848 "return lines matching a pattern",
3850 This calls the external C<egrep -i> program and returns the
3853 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3854 [InitISOFS, Always, TestOutputList (
3855 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3856 "return lines matching a pattern",
3858 This calls the external C<fgrep -i> program and returns the
3861 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3862 [InitISOFS, Always, TestOutputList (
3863 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3864 "return lines matching a pattern",
3866 This calls the external C<zgrep> program and returns the
3869 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3870 [InitISOFS, Always, TestOutputList (
3871 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3872 "return lines matching a pattern",
3874 This calls the external C<zegrep> program and returns the
3877 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3878 [InitISOFS, Always, TestOutputList (
3879 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3880 "return lines matching a pattern",
3882 This calls the external C<zfgrep> program and returns the
3885 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3886 [InitISOFS, Always, TestOutputList (
3887 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3888 "return lines matching a pattern",
3890 This calls the external C<zgrep -i> program and returns the
3893 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3894 [InitISOFS, Always, TestOutputList (
3895 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3896 "return lines matching a pattern",
3898 This calls the external C<zegrep -i> program and returns the
3901 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3902 [InitISOFS, Always, TestOutputList (
3903 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3904 "return lines matching a pattern",
3906 This calls the external C<zfgrep -i> program and returns the
3909 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3910 [InitISOFS, Always, TestOutput (
3911 [["realpath"; "/../directory"]], "/directory")],
3912 "canonicalized absolute pathname",
3914 Return the canonicalized absolute pathname of C<path>. The
3915 returned path has no C<.>, C<..> or symbolic link path elements.");
3917 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3918 [InitScratchFS, Always, TestOutputStruct (
3921 ["ln"; "/ln/a"; "/ln/b"];
3922 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
3923 "create a hard link",
3925 This command creates a hard link using the C<ln> command.");
3927 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3928 [InitScratchFS, Always, TestOutputStruct (
3929 [["mkdir"; "/ln_f"];
3930 ["touch"; "/ln_f/a"];
3931 ["touch"; "/ln_f/b"];
3932 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
3933 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
3934 "create a hard link",
3936 This command creates a hard link using the C<ln -f> command.
3937 The C<-f> option removes the link (C<linkname>) if it exists already.");
3939 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3940 [InitScratchFS, Always, TestOutputStruct (
3941 [["mkdir"; "/ln_s"];
3942 ["touch"; "/ln_s/a"];
3943 ["ln_s"; "a"; "/ln_s/b"];
3944 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
3945 "create a symbolic link",
3947 This command creates a symbolic link using the C<ln -s> command.");
3949 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3950 [InitScratchFS, Always, TestOutput (
3951 [["mkdir_p"; "/ln_sf/b"];
3952 ["touch"; "/ln_sf/b/c"];
3953 ["ln_sf"; "../d"; "/ln_sf/b/c"];
3954 ["readlink"; "/ln_sf/b/c"]], "../d")],
3955 "create a symbolic link",
3957 This command creates a symbolic link using the C<ln -sf> command,
3958 The C<-f> option removes the link (C<linkname>) if it exists already.");
3960 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3961 [] (* XXX tested above *),
3962 "read the target of a symbolic link",
3964 This command reads the target of a symbolic link.");
3966 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3967 [InitScratchFS, Always, TestOutputStruct (
3968 [["fallocate"; "/fallocate"; "1000000"];
3969 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
3970 "preallocate a file in the guest filesystem",
3972 This command preallocates a file (containing zero bytes) named
3973 C<path> of size C<len> bytes. If the file exists already, it
3976 Do not confuse this with the guestfish-specific
3977 C<alloc> command which allocates a file in the host and
3978 attaches it as a device.");
3980 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3981 [InitPartition, Always, TestRun (
3982 [["mkswap"; "/dev/sda1"];
3983 ["swapon_device"; "/dev/sda1"];
3984 ["swapoff_device"; "/dev/sda1"]])],
3985 "enable swap on device",
3987 This command enables the libguestfs appliance to use the
3988 swap device or partition named C<device>. The increased
3989 memory is made available for all commands, for example
3990 those run using C<guestfs_command> or C<guestfs_sh>.
3992 Note that you should not swap to existing guest swap
3993 partitions unless you know what you are doing. They may
3994 contain hibernation information, or other information that
3995 the guest doesn't want you to trash. You also risk leaking
3996 information about the host to the guest this way. Instead,
3997 attach a new host device to the guest and swap on that.");
3999 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4000 [], (* XXX tested by swapon_device *)
4001 "disable swap on device",
4003 This command disables the libguestfs appliance swap
4004 device or partition named C<device>.
4005 See C<guestfs_swapon_device>.");
4007 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4008 [InitScratchFS, Always, TestRun (
4009 [["fallocate"; "/swapon_file"; "8388608"];
4010 ["mkswap_file"; "/swapon_file"];
4011 ["swapon_file"; "/swapon_file"];
4012 ["swapoff_file"; "/swapon_file"];
4013 ["rm"; "/swapon_file"]])],
4014 "enable swap on file",
4016 This command enables swap to a file.
4017 See C<guestfs_swapon_device> for other notes.");
4019 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4020 [], (* XXX tested by swapon_file *)
4021 "disable swap on file",
4023 This command disables the libguestfs appliance swap on file.");
4025 ("swapon_label", (RErr, [String "label"], []), 174, [],
4026 [InitEmpty, Always, TestRun (
4027 [["part_disk"; "/dev/sda"; "mbr"];
4028 ["mkswap_L"; "swapit"; "/dev/sda1"];
4029 ["swapon_label"; "swapit"];
4030 ["swapoff_label"; "swapit"];
4031 ["zero"; "/dev/sda"];
4032 ["blockdev_rereadpt"; "/dev/sda"]])],
4033 "enable swap on labeled swap partition",
4035 This command enables swap to a labeled swap partition.
4036 See C<guestfs_swapon_device> for other notes.");
4038 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4039 [], (* XXX tested by swapon_label *)
4040 "disable swap on labeled swap partition",
4042 This command disables the libguestfs appliance swap on
4043 labeled swap partition.");
4045 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4046 (let uuid = uuidgen () in
4047 [InitEmpty, Always, TestRun (
4048 [["mkswap_U"; uuid; "/dev/sdc"];
4049 ["swapon_uuid"; uuid];
4050 ["swapoff_uuid"; uuid]])]),
4051 "enable swap on swap partition by UUID",
4053 This command enables swap to a swap partition with the given UUID.
4054 See C<guestfs_swapon_device> for other notes.");
4056 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4057 [], (* XXX tested by swapon_uuid *)
4058 "disable swap on swap partition by UUID",
4060 This command disables the libguestfs appliance swap partition
4061 with the given UUID.");
4063 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4064 [InitScratchFS, Always, TestRun (
4065 [["fallocate"; "/mkswap_file"; "8388608"];
4066 ["mkswap_file"; "/mkswap_file"];
4067 ["rm"; "/mkswap_file"]])],
4068 "create a swap file",
4072 This command just writes a swap file signature to an existing
4073 file. To create the file itself, use something like C<guestfs_fallocate>.");
4075 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4076 [InitISOFS, Always, TestRun (
4077 [["inotify_init"; "0"]])],
4078 "create an inotify handle",
4080 This command creates a new inotify handle.
4081 The inotify subsystem can be used to notify events which happen to
4082 objects in the guest filesystem.
4084 C<maxevents> is the maximum number of events which will be
4085 queued up between calls to C<guestfs_inotify_read> or
4086 C<guestfs_inotify_files>.
4087 If this is passed as C<0>, then the kernel (or previously set)
4088 default is used. For Linux 2.6.29 the default was 16384 events.
4089 Beyond this limit, the kernel throws away events, but records
4090 the fact that it threw them away by setting a flag
4091 C<IN_Q_OVERFLOW> in the returned structure list (see
4092 C<guestfs_inotify_read>).
4094 Before any events are generated, you have to add some
4095 watches to the internal watch list. See:
4096 C<guestfs_inotify_add_watch>,
4097 C<guestfs_inotify_rm_watch> and
4098 C<guestfs_inotify_watch_all>.
4100 Queued up events should be read periodically by calling
4101 C<guestfs_inotify_read>
4102 (or C<guestfs_inotify_files> which is just a helpful
4103 wrapper around C<guestfs_inotify_read>). If you don't
4104 read the events out often enough then you risk the internal
4107 The handle should be closed after use by calling
4108 C<guestfs_inotify_close>. This also removes any
4109 watches automatically.
4111 See also L<inotify(7)> for an overview of the inotify interface
4112 as exposed by the Linux kernel, which is roughly what we expose
4113 via libguestfs. Note that there is one global inotify handle
4114 per libguestfs instance.");
4116 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4117 [InitScratchFS, Always, TestOutputList (
4118 [["mkdir"; "/inotify_add_watch"];
4119 ["inotify_init"; "0"];
4120 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4121 ["touch"; "/inotify_add_watch/a"];
4122 ["touch"; "/inotify_add_watch/b"];
4123 ["inotify_files"]], ["a"; "b"])],
4124 "add an inotify watch",
4126 Watch C<path> for the events listed in C<mask>.
4128 Note that if C<path> is a directory then events within that
4129 directory are watched, but this does I<not> happen recursively
4130 (in subdirectories).
4132 Note for non-C or non-Linux callers: the inotify events are
4133 defined by the Linux kernel ABI and are listed in
4134 C</usr/include/sys/inotify.h>.");
4136 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4138 "remove an inotify watch",
4140 Remove a previously defined inotify watch.
4141 See C<guestfs_inotify_add_watch>.");
4143 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4145 "return list of inotify events",
4147 Return the complete queue of events that have happened
4148 since the previous read call.
4150 If no events have happened, this returns an empty list.
4152 I<Note>: In order to make sure that all events have been
4153 read, you must call this function repeatedly until it
4154 returns an empty list. The reason is that the call will
4155 read events up to the maximum appliance-to-host message
4156 size and leave remaining events in the queue.");
4158 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4160 "return list of watched files that had events",
4162 This function is a helpful wrapper around C<guestfs_inotify_read>
4163 which just returns a list of pathnames of objects that were
4164 touched. The returned pathnames are sorted and deduplicated.");
4166 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4168 "close the inotify handle",
4170 This closes the inotify handle which was previously
4171 opened by inotify_init. It removes all watches, throws
4172 away any pending events, and deallocates all resources.");
4174 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4176 "set SELinux security context",
4178 This sets the SELinux security context of the daemon
4179 to the string C<context>.
4181 See the documentation about SELINUX in L<guestfs(3)>.");
4183 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4185 "get SELinux security context",
4187 This gets the SELinux security context of the daemon.
4189 See the documentation about SELINUX in L<guestfs(3)>,
4190 and C<guestfs_setcon>");
4192 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4193 [InitEmpty, Always, TestOutput (
4194 [["part_disk"; "/dev/sda"; "mbr"];
4195 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4196 ["mount_options"; ""; "/dev/sda1"; "/"];
4197 ["write"; "/new"; "new file contents"];
4198 ["cat"; "/new"]], "new file contents");
4199 InitEmpty, Always, TestRun (
4200 [["part_disk"; "/dev/sda"; "mbr"];
4201 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4202 InitEmpty, Always, TestLastFail (
4203 [["part_disk"; "/dev/sda"; "mbr"];
4204 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4205 InitEmpty, Always, TestLastFail (
4206 [["part_disk"; "/dev/sda"; "mbr"];
4207 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4208 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4209 [["part_disk"; "/dev/sda"; "mbr"];
4210 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4211 "make a filesystem with block size",
4213 This call is similar to C<guestfs_mkfs>, but it allows you to
4214 control the block size of the resulting filesystem. Supported
4215 block sizes depend on the filesystem type, but typically they
4216 are C<1024>, C<2048> or C<4096> only.
4218 For VFAT and NTFS the C<blocksize> parameter is treated as
4219 the requested cluster size.");
4221 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4222 [InitEmpty, Always, TestOutput (
4223 [["part_init"; "/dev/sda"; "mbr"];
4224 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4225 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4226 ["mke2journal"; "4096"; "/dev/sda1"];
4227 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4228 ["mount_options"; ""; "/dev/sda2"; "/"];
4229 ["write"; "/new"; "new file contents"];
4230 ["cat"; "/new"]], "new file contents")],
4231 "make ext2/3/4 external journal",
4233 This creates an ext2 external journal on C<device>. It is equivalent
4236 mke2fs -O journal_dev -b blocksize device");
4238 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4239 [InitEmpty, Always, TestOutput (
4240 [["part_init"; "/dev/sda"; "mbr"];
4241 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4242 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4243 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4244 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4245 ["mount_options"; ""; "/dev/sda2"; "/"];
4246 ["write"; "/new"; "new file contents"];
4247 ["cat"; "/new"]], "new file contents")],
4248 "make ext2/3/4 external journal with label",
4250 This creates an ext2 external journal on C<device> with label C<label>.");
4252 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4253 (let uuid = uuidgen () in
4254 [InitEmpty, Always, TestOutput (
4255 [["part_init"; "/dev/sda"; "mbr"];
4256 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4257 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4258 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4259 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4260 ["mount_options"; ""; "/dev/sda2"; "/"];
4261 ["write"; "/new"; "new file contents"];
4262 ["cat"; "/new"]], "new file contents")]),
4263 "make ext2/3/4 external journal with UUID",
4265 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4267 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4269 "make ext2/3/4 filesystem with external journal",
4271 This creates an ext2/3/4 filesystem on C<device> with
4272 an external journal on C<journal>. It is equivalent
4275 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4277 See also C<guestfs_mke2journal>.");
4279 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4281 "make ext2/3/4 filesystem with external journal",
4283 This creates an ext2/3/4 filesystem on C<device> with
4284 an external journal on the journal labeled C<label>.
4286 See also C<guestfs_mke2journal_L>.");
4288 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4290 "make ext2/3/4 filesystem with external journal",
4292 This creates an ext2/3/4 filesystem on C<device> with
4293 an external journal on the journal with UUID C<uuid>.
4295 See also C<guestfs_mke2journal_U>.");
4297 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4298 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4299 "load a kernel module",
4301 This loads a kernel module in the appliance.
4303 The kernel module must have been whitelisted when libguestfs
4304 was built (see C<appliance/kmod.whitelist.in> in the source).");
4306 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4307 [InitNone, Always, TestOutput (
4308 [["echo_daemon"; "This is a test"]], "This is a test"
4310 "echo arguments back to the client",
4312 This command concatenates the list of C<words> passed with single spaces
4313 between them and returns the resulting string.
4315 You can use this command to test the connection through to the daemon.
4317 See also C<guestfs_ping_daemon>.");
4319 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4320 [], (* There is a regression test for this. *)
4321 "find all files and directories, returning NUL-separated list",
4323 This command lists out all files and directories, recursively,
4324 starting at C<directory>, placing the resulting list in the
4325 external file called C<files>.
4327 This command works the same way as C<guestfs_find> with the
4328 following exceptions:
4334 The resulting list is written to an external file.
4338 Items (filenames) in the result are separated
4339 by C<\\0> characters. See L<find(1)> option I<-print0>.
4343 This command is not limited in the number of names that it
4348 The result list is not sorted.
4352 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4353 [InitISOFS, Always, TestOutput (
4354 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4355 InitISOFS, Always, TestOutput (
4356 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4357 InitISOFS, Always, TestOutput (
4358 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4359 InitISOFS, Always, TestLastFail (
4360 [["case_sensitive_path"; "/Known-1/"]]);
4361 InitScratchFS, Always, TestOutput (
4362 [["mkdir"; "/case_sensitive_path"];
4363 ["mkdir"; "/case_sensitive_path/bbb"];
4364 ["touch"; "/case_sensitive_path/bbb/c"];
4365 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4366 InitScratchFS, Always, TestOutput (
4367 [["mkdir"; "/case_sensitive_path2"];
4368 ["mkdir"; "/case_sensitive_path2/bbb"];
4369 ["touch"; "/case_sensitive_path2/bbb/c"];
4370 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4371 InitScratchFS, Always, TestLastFail (
4372 [["mkdir"; "/case_sensitive_path3"];
4373 ["mkdir"; "/case_sensitive_path3/bbb"];
4374 ["touch"; "/case_sensitive_path3/bbb/c"];
4375 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4376 "return true path on case-insensitive filesystem",
4378 This can be used to resolve case insensitive paths on
4379 a filesystem which is case sensitive. The use case is
4380 to resolve paths which you have read from Windows configuration
4381 files or the Windows Registry, to the true path.
4383 The command handles a peculiarity of the Linux ntfs-3g
4384 filesystem driver (and probably others), which is that although
4385 the underlying filesystem is case-insensitive, the driver
4386 exports the filesystem to Linux as case-sensitive.
4388 One consequence of this is that special directories such
4389 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4390 (or other things) depending on the precise details of how
4391 they were created. In Windows itself this would not be
4394 Bug or feature? You decide:
4395 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4397 This function resolves the true case of each element in the
4398 path and returns the case-sensitive path.
4400 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4401 might return C<\"/WINDOWS/system32\"> (the exact return value
4402 would depend on details of how the directories were originally
4403 created under Windows).
4406 This function does not handle drive names, backslashes etc.
4408 See also C<guestfs_realpath>.");
4410 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4411 [InitScratchFS, Always, TestOutput (
4412 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4413 "get the Linux VFS type corresponding to a mounted device",
4415 This command gets the filesystem type corresponding to
4416 the filesystem on C<device>.
4418 For most filesystems, the result is the name of the Linux
4419 VFS module which would be used to mount this filesystem
4420 if you mounted it without specifying the filesystem type.
4421 For example a string such as C<ext3> or C<ntfs>.");
4423 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4424 [InitScratchFS, Always, TestOutputStruct (
4425 [["write"; "/truncate"; "some stuff so size is not zero"];
4426 ["truncate"; "/truncate"];
4427 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4428 "truncate a file to zero size",
4430 This command truncates C<path> to a zero-length file. The
4431 file must exist already.");
4433 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4434 [InitScratchFS, Always, TestOutputStruct (
4435 [["touch"; "/truncate_size"];
4436 ["truncate_size"; "/truncate_size"; "1000"];
4437 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4438 "truncate a file to a particular size",
4440 This command truncates C<path> to size C<size> bytes. The file
4443 If the current file size is less than C<size> then
4444 the file is extended to the required size with zero bytes.
4445 This creates a sparse file (ie. disk blocks are not allocated
4446 for the file until you write to it). To create a non-sparse
4447 file of zeroes, use C<guestfs_fallocate64> instead.");
4449 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4450 [InitScratchFS, Always, TestOutputStruct (
4451 [["touch"; "/utimens"];
4452 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4453 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4454 "set timestamp of a file with nanosecond precision",
4456 This command sets the timestamps of a file with nanosecond
4459 C<atsecs, atnsecs> are the last access time (atime) in secs and
4460 nanoseconds from the epoch.
4462 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4463 secs and nanoseconds from the epoch.
4465 If the C<*nsecs> field contains the special value C<-1> then
4466 the corresponding timestamp is set to the current time. (The
4467 C<*secs> field is ignored in this case).
4469 If the C<*nsecs> field contains the special value C<-2> then
4470 the corresponding timestamp is left unchanged. (The
4471 C<*secs> field is ignored in this case).");
4473 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4474 [InitScratchFS, Always, TestOutputStruct (
4475 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4476 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4477 "create a directory with a particular mode",
4479 This command creates a directory, setting the initial permissions
4480 of the directory to C<mode>.
4482 For common Linux filesystems, the actual mode which is set will
4483 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4484 interpret the mode in other ways.
4486 See also C<guestfs_mkdir>, C<guestfs_umask>");
4488 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4490 "change file owner and group",
4492 Change the file owner to C<owner> and group to C<group>.
4493 This is like C<guestfs_chown> but if C<path> is a symlink then
4494 the link itself is changed, not the target.
4496 Only numeric uid and gid are supported. If you want to use
4497 names, you will need to locate and parse the password file
4498 yourself (Augeas support makes this relatively easy).");
4500 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4502 "lstat on multiple files",
4504 This call allows you to perform the C<guestfs_lstat> operation
4505 on multiple files, where all files are in the directory C<path>.
4506 C<names> is the list of files from this directory.
4508 On return you get a list of stat structs, with a one-to-one
4509 correspondence to the C<names> list. If any name did not exist
4510 or could not be lstat'd, then the C<ino> field of that structure
4513 This call is intended for programs that want to efficiently
4514 list a directory contents without making many round-trips.
4515 See also C<guestfs_lxattrlist> for a similarly efficient call
4516 for getting extended attributes. Very long directory listings
4517 might cause the protocol message size to be exceeded, causing
4518 this call to fail. The caller must split up such requests
4519 into smaller groups of names.");
4521 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4523 "lgetxattr on multiple files",
4525 This call allows you to get the extended attributes
4526 of multiple files, where all files are in the directory C<path>.
4527 C<names> is the list of files from this directory.
4529 On return you get a flat list of xattr structs which must be
4530 interpreted sequentially. The first xattr struct always has a zero-length
4531 C<attrname>. C<attrval> in this struct is zero-length
4532 to indicate there was an error doing C<lgetxattr> for this
4533 file, I<or> is a C string which is a decimal number
4534 (the number of following attributes for this file, which could
4535 be C<\"0\">). Then after the first xattr struct are the
4536 zero or more attributes for the first named file.
4537 This repeats for the second and subsequent files.
4539 This call is intended for programs that want to efficiently
4540 list a directory contents without making many round-trips.
4541 See also C<guestfs_lstatlist> for a similarly efficient call
4542 for getting standard stats. Very long directory listings
4543 might cause the protocol message size to be exceeded, causing
4544 this call to fail. The caller must split up such requests
4545 into smaller groups of names.");
4547 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4549 "readlink on multiple files",
4551 This call allows you to do a C<readlink> operation
4552 on multiple files, where all files are in the directory C<path>.
4553 C<names> is the list of files from this directory.
4555 On return you get a list of strings, with a one-to-one
4556 correspondence to the C<names> list. Each string is the
4557 value of the symbolic link.
4559 If the C<readlink(2)> operation fails on any name, then
4560 the corresponding result string is the empty string C<\"\">.
4561 However the whole operation is completed even if there
4562 were C<readlink(2)> errors, and so you can call this
4563 function with names where you don't know if they are
4564 symbolic links already (albeit slightly less efficient).
4566 This call is intended for programs that want to efficiently
4567 list a directory contents without making many round-trips.
4568 Very long directory listings might cause the protocol
4569 message size to be exceeded, causing
4570 this call to fail. The caller must split up such requests
4571 into smaller groups of names.");
4573 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4574 [InitISOFS, Always, TestOutputBuffer (
4575 [["pread"; "/known-4"; "1"; "3"]], "\n");
4576 InitISOFS, Always, TestOutputBuffer (
4577 [["pread"; "/empty"; "0"; "100"]], "")],
4578 "read part of a file",
4580 This command lets you read part of a file. It reads C<count>
4581 bytes of the file, starting at C<offset>, from file C<path>.
4583 This may read fewer bytes than requested. For further details
4584 see the L<pread(2)> system call.
4586 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4588 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4589 [InitEmpty, Always, TestRun (
4590 [["part_init"; "/dev/sda"; "gpt"]])],
4591 "create an empty partition table",
4593 This creates an empty partition table on C<device> of one of the
4594 partition types listed below. Usually C<parttype> should be
4595 either C<msdos> or C<gpt> (for large disks).
4597 Initially there are no partitions. Following this, you should
4598 call C<guestfs_part_add> for each partition required.
4600 Possible values for C<parttype> are:
4604 =item B<efi> | B<gpt>
4606 Intel EFI / GPT partition table.
4608 This is recommended for >= 2 TB partitions that will be accessed
4609 from Linux and Intel-based Mac OS X. It also has limited backwards
4610 compatibility with the C<mbr> format.
4612 =item B<mbr> | B<msdos>
4614 The standard PC \"Master Boot Record\" (MBR) format used
4615 by MS-DOS and Windows. This partition type will B<only> work
4616 for device sizes up to 2 TB. For large disks we recommend
4621 Other partition table types that may work but are not
4630 =item B<amiga> | B<rdb>
4632 Amiga \"Rigid Disk Block\" format.
4640 DASD, used on IBM mainframes.
4648 Old Mac partition format. Modern Macs use C<gpt>.
4652 NEC PC-98 format, common in Japan apparently.
4660 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4661 [InitEmpty, Always, TestRun (
4662 [["part_init"; "/dev/sda"; "mbr"];
4663 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4664 InitEmpty, Always, TestRun (
4665 [["part_init"; "/dev/sda"; "gpt"];
4666 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4667 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4668 InitEmpty, Always, TestRun (
4669 [["part_init"; "/dev/sda"; "mbr"];
4670 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4671 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4672 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4673 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4674 "add a partition to the device",
4676 This command adds a partition to C<device>. If there is no partition
4677 table on the device, call C<guestfs_part_init> first.
4679 The C<prlogex> parameter is the type of partition. Normally you
4680 should pass C<p> or C<primary> here, but MBR partition tables also
4681 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4684 C<startsect> and C<endsect> are the start and end of the partition
4685 in I<sectors>. C<endsect> may be negative, which means it counts
4686 backwards from the end of the disk (C<-1> is the last sector).
4688 Creating a partition which covers the whole disk is not so easy.
4689 Use C<guestfs_part_disk> to do that.");
4691 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4692 [InitEmpty, Always, TestRun (
4693 [["part_disk"; "/dev/sda"; "mbr"]]);
4694 InitEmpty, Always, TestRun (
4695 [["part_disk"; "/dev/sda"; "gpt"]])],
4696 "partition whole disk with a single primary partition",
4698 This command is simply a combination of C<guestfs_part_init>
4699 followed by C<guestfs_part_add> to create a single primary partition
4700 covering the whole disk.
4702 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4703 but other possible values are described in C<guestfs_part_init>.");
4705 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4706 [InitEmpty, Always, TestRun (
4707 [["part_disk"; "/dev/sda"; "mbr"];
4708 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4709 "make a partition bootable",
4711 This sets the bootable flag on partition numbered C<partnum> on
4712 device C<device>. Note that partitions are numbered from 1.
4714 The bootable flag is used by some operating systems (notably
4715 Windows) to determine which partition to boot from. It is by
4716 no means universally recognized.");
4718 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4719 [InitEmpty, Always, TestRun (
4720 [["part_disk"; "/dev/sda"; "gpt"];
4721 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4722 "set partition name",
4724 This sets the partition name on partition numbered C<partnum> on
4725 device C<device>. Note that partitions are numbered from 1.
4727 The partition name can only be set on certain types of partition
4728 table. This works on C<gpt> but not on C<mbr> partitions.");
4730 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4731 [], (* XXX Add a regression test for this. *)
4732 "list partitions on a device",
4734 This command parses the partition table on C<device> and
4735 returns the list of partitions found.
4737 The fields in the returned structure are:
4743 Partition number, counting from 1.
4747 Start of the partition I<in bytes>. To get sectors you have to
4748 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4752 End of the partition in bytes.
4756 Size of the partition in bytes.
4760 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4761 [InitEmpty, Always, TestOutput (
4762 [["part_disk"; "/dev/sda"; "gpt"];
4763 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4764 "get the partition table type",
4766 This command examines the partition table on C<device> and
4767 returns the partition table type (format) being used.
4769 Common return values include: C<msdos> (a DOS/Windows style MBR
4770 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4771 values are possible, although unusual. See C<guestfs_part_init>
4774 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4775 [InitScratchFS, Always, TestOutputBuffer (
4776 [["fill"; "0x63"; "10"; "/fill"];
4777 ["read_file"; "/fill"]], "cccccccccc")],
4778 "fill a file with octets",
4780 This command creates a new file called C<path>. The initial
4781 content of the file is C<len> octets of C<c>, where C<c>
4782 must be a number in the range C<[0..255]>.
4784 To fill a file with zero bytes (sparsely), it is
4785 much more efficient to use C<guestfs_truncate_size>.
4786 To create a file with a pattern of repeating bytes
4787 use C<guestfs_fill_pattern>.");
4789 ("available", (RErr, [StringList "groups"], []), 216, [],
4790 [InitNone, Always, TestRun [["available"; ""]]],
4791 "test availability of some parts of the API",
4793 This command is used to check the availability of some
4794 groups of functionality in the appliance, which not all builds of
4795 the libguestfs appliance will be able to provide.
4797 The libguestfs groups, and the functions that those
4798 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4799 You can also fetch this list at runtime by calling
4800 C<guestfs_available_all_groups>.
4802 The argument C<groups> is a list of group names, eg:
4803 C<[\"inotify\", \"augeas\"]> would check for the availability of
4804 the Linux inotify functions and Augeas (configuration file
4807 The command returns no error if I<all> requested groups are available.
4809 It fails with an error if one or more of the requested
4810 groups is unavailable in the appliance.
4812 If an unknown group name is included in the
4813 list of groups then an error is always returned.
4821 You must call C<guestfs_launch> before calling this function.
4823 The reason is because we don't know what groups are
4824 supported by the appliance/daemon until it is running and can
4829 If a group of functions is available, this does not necessarily
4830 mean that they will work. You still have to check for errors
4831 when calling individual API functions even if they are
4836 It is usually the job of distro packagers to build
4837 complete functionality into the libguestfs appliance.
4838 Upstream libguestfs, if built from source with all
4839 requirements satisfied, will support everything.
4843 This call was added in version C<1.0.80>. In previous
4844 versions of libguestfs all you could do would be to speculatively
4845 execute a command to find out if the daemon implemented it.
4846 See also C<guestfs_version>.
4850 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4851 [InitScratchFS, Always, TestOutputBuffer (
4853 ["write"; "/dd/src"; "hello, world"];
4854 ["dd"; "/dd/src"; "/dd/dest"];
4855 ["read_file"; "/dd/dest"]], "hello, world")],
4856 "copy from source to destination using dd",
4858 This command copies from one source device or file C<src>
4859 to another destination device or file C<dest>. Normally you
4860 would use this to copy to or from a device or partition, for
4861 example to duplicate a filesystem.
4863 If the destination is a device, it must be as large or larger
4864 than the source file or device, otherwise the copy will fail.
4865 This command cannot do partial copies (see C<guestfs_copy_size>).");
4867 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4868 [InitScratchFS, Always, TestOutputInt (
4869 [["write"; "/filesize"; "hello, world"];
4870 ["filesize"; "/filesize"]], 12)],
4871 "return the size of the file in bytes",
4873 This command returns the size of C<file> in bytes.
4875 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4876 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4877 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4879 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4880 [InitBasicFSonLVM, Always, TestOutputList (
4881 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4882 ["lvs"]], ["/dev/VG/LV2"])],
4883 "rename an LVM logical volume",
4885 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4887 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4888 [InitBasicFSonLVM, Always, TestOutputList (
4890 ["vg_activate"; "false"; "VG"];
4891 ["vgrename"; "VG"; "VG2"];
4892 ["vg_activate"; "true"; "VG2"];
4893 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4894 ["vgs"]], ["VG2"])],
4895 "rename an LVM volume group",
4897 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4899 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4900 [InitISOFS, Always, TestOutputBuffer (
4901 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4902 "list the contents of a single file in an initrd",
4904 This command unpacks the file C<filename> from the initrd file
4905 called C<initrdpath>. The filename must be given I<without> the
4906 initial C</> character.
4908 For example, in guestfish you could use the following command
4909 to examine the boot script (usually called C</init>)
4910 contained in a Linux initrd or initramfs image:
4912 initrd-cat /boot/initrd-<version>.img init
4914 See also C<guestfs_initrd_list>.");
4916 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4918 "get the UUID of a physical volume",
4920 This command returns the UUID of the LVM PV C<device>.");
4922 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4924 "get the UUID of a volume group",
4926 This command returns the UUID of the LVM VG named C<vgname>.");
4928 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4930 "get the UUID of a logical volume",
4932 This command returns the UUID of the LVM LV C<device>.");
4934 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4936 "get the PV UUIDs containing the volume group",
4938 Given a VG called C<vgname>, this returns the UUIDs of all
4939 the physical volumes that this volume group resides on.
4941 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4942 calls to associate physical volumes and volume groups.
4944 See also C<guestfs_vglvuuids>.");
4946 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4948 "get the LV UUIDs of all LVs in the volume group",
4950 Given a VG called C<vgname>, this returns the UUIDs of all
4951 the logical volumes created in this volume group.
4953 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4954 calls to associate logical volumes and volume groups.
4956 See also C<guestfs_vgpvuuids>.");
4958 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4959 [InitScratchFS, Always, TestOutputBuffer (
4960 [["mkdir"; "/copy_size"];
4961 ["write"; "/copy_size/src"; "hello, world"];
4962 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
4963 ["read_file"; "/copy_size/dest"]], "hello")],
4964 "copy size bytes from source to destination using dd",
4966 This command copies exactly C<size> bytes from one source device
4967 or file C<src> to another destination device or file C<dest>.
4969 Note this will fail if the source is too short or if the destination
4970 is not large enough.");
4972 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4973 [InitBasicFSonLVM, Always, TestRun (
4974 [["zero_device"; "/dev/VG/LV"]])],
4975 "write zeroes to an entire device",
4977 This command writes zeroes over the entire C<device>. Compare
4978 with C<guestfs_zero> which just zeroes the first few blocks of
4981 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4982 [InitScratchFS, Always, TestOutput (
4983 [["mkdir"; "/txz_in"];
4984 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
4985 ["cat"; "/txz_in/hello"]], "hello\n")],
4986 "unpack compressed tarball to directory",
4988 This command uploads and unpacks local file C<tarball> (an
4989 I<xz compressed> tar file) into C<directory>.");
4991 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4993 "pack directory into compressed tarball",
4995 This command packs the contents of C<directory> and downloads
4996 it to local file C<tarball> (as an xz compressed tar archive).");
4998 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5000 "resize an NTFS filesystem",
5002 This command resizes an NTFS filesystem, expanding or
5003 shrinking it to the size of the underlying device.
5005 I<Note:> After the resize operation, the filesystem is marked
5006 as requiring a consistency check (for safety). You have to boot
5007 into Windows to perform this check and clear this condition.
5008 Furthermore, ntfsresize refuses to resize filesystems
5009 which have been marked in this way. So in effect it is
5010 not possible to call ntfsresize multiple times on a single
5011 filesystem without booting into Windows between each resize.
5013 See also L<ntfsresize(8)>.");
5015 ("vgscan", (RErr, [], []), 232, [],
5016 [InitEmpty, Always, TestRun (
5018 "rescan for LVM physical volumes, volume groups and logical volumes",
5020 This rescans all block devices and rebuilds the list of LVM
5021 physical volumes, volume groups and logical volumes.");
5023 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5024 [InitEmpty, Always, TestRun (
5025 [["part_init"; "/dev/sda"; "mbr"];
5026 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5027 ["part_del"; "/dev/sda"; "1"]])],
5028 "delete a partition",
5030 This command deletes the partition numbered C<partnum> on C<device>.
5032 Note that in the case of MBR partitioning, deleting an
5033 extended partition also deletes any logical partitions
5036 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5037 [InitEmpty, Always, TestOutputTrue (
5038 [["part_init"; "/dev/sda"; "mbr"];
5039 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5040 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5041 ["part_get_bootable"; "/dev/sda"; "1"]])],
5042 "return true if a partition is bootable",
5044 This command returns true if the partition C<partnum> on
5045 C<device> has the bootable flag set.
5047 See also C<guestfs_part_set_bootable>.");
5049 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5050 [InitEmpty, Always, TestOutputInt (
5051 [["part_init"; "/dev/sda"; "mbr"];
5052 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5053 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5054 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5055 "get the MBR type byte (ID byte) from a partition",
5057 Returns the MBR type byte (also known as the ID byte) from
5058 the numbered partition C<partnum>.
5060 Note that only MBR (old DOS-style) partitions have type bytes.
5061 You will get undefined results for other partition table
5062 types (see C<guestfs_part_get_parttype>).");
5064 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5065 [], (* tested by part_get_mbr_id *)
5066 "set the MBR type byte (ID byte) of a partition",
5068 Sets the MBR type byte (also known as the ID byte) of
5069 the numbered partition C<partnum> to C<idbyte>. Note
5070 that the type bytes quoted in most documentation are
5071 in fact hexadecimal numbers, but usually documented
5072 without any leading \"0x\" which might be confusing.
5074 Note that only MBR (old DOS-style) partitions have type bytes.
5075 You will get undefined results for other partition table
5076 types (see C<guestfs_part_get_parttype>).");
5078 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5079 [InitISOFS, Always, TestOutputFileMD5 (
5080 [["checksum_device"; "md5"; "/dev/sdd"]],
5081 "../images/test.iso")],
5082 "compute MD5, SHAx or CRC checksum of the contents of a device",
5084 This call computes the MD5, SHAx or CRC checksum of the
5085 contents of the device named C<device>. For the types of
5086 checksums supported see the C<guestfs_checksum> command.");
5088 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5089 [InitNone, Always, TestRun (
5090 [["part_disk"; "/dev/sda"; "mbr"];
5091 ["pvcreate"; "/dev/sda1"];
5092 ["vgcreate"; "VG"; "/dev/sda1"];
5093 ["lvcreate"; "LV"; "VG"; "10"];
5094 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5095 "expand an LV to fill free space",
5097 This expands an existing logical volume C<lv> so that it fills
5098 C<pc>% of the remaining free space in the volume group. Commonly
5099 you would call this with pc = 100 which expands the logical volume
5100 as much as possible, using all remaining free space in the volume
5103 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5104 [], (* XXX Augeas code needs tests. *)
5105 "clear Augeas path",
5107 Set the value associated with C<path> to C<NULL>. This
5108 is the same as the L<augtool(1)> C<clear> command.");
5110 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5111 [InitEmpty, Always, TestOutputInt (
5112 [["get_umask"]], 0o22)],
5113 "get the current umask",
5115 Return the current umask. By default the umask is C<022>
5116 unless it has been set by calling C<guestfs_umask>.");
5118 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5120 "upload a file to the appliance (internal use only)",
5122 The C<guestfs_debug_upload> command uploads a file to
5123 the libguestfs appliance.
5125 There is no comprehensive help for this command. You have
5126 to look at the file C<daemon/debug.c> in the libguestfs source
5127 to find out what it is for.");
5129 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5130 [InitScratchFS, Always, TestOutput (
5131 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5132 ["cat"; "/base64_in"]], "hello\n")],
5133 "upload base64-encoded data to file",
5135 This command uploads base64-encoded data from C<base64file>
5138 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5140 "download file and encode as base64",
5142 This command downloads the contents of C<filename>, writing
5143 it out to local file C<base64file> encoded as base64.");
5145 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5147 "compute MD5, SHAx or CRC checksum of files in a directory",
5149 This command computes the checksums of all regular files in
5150 C<directory> and then emits a list of those checksums to
5151 the local output file C<sumsfile>.
5153 This can be used for verifying the integrity of a virtual
5154 machine. However to be properly secure you should pay
5155 attention to the output of the checksum command (it uses
5156 the ones from GNU coreutils). In particular when the
5157 filename is not printable, coreutils uses a special
5158 backslash syntax. For more information, see the GNU
5159 coreutils info file.");
5161 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5162 [InitScratchFS, Always, TestOutputBuffer (
5163 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5164 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5165 "fill a file with a repeating pattern of bytes",
5167 This function is like C<guestfs_fill> except that it creates
5168 a new file of length C<len> containing the repeating pattern
5169 of bytes in C<pattern>. The pattern is truncated if necessary
5170 to ensure the length of the file is exactly C<len> bytes.");
5172 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5173 [InitScratchFS, Always, TestOutput (
5174 [["write"; "/write"; "new file contents"];
5175 ["cat"; "/write"]], "new file contents");
5176 InitScratchFS, Always, TestOutput (
5177 [["write"; "/write2"; "\nnew file contents\n"];
5178 ["cat"; "/write2"]], "\nnew file contents\n");
5179 InitScratchFS, Always, TestOutput (
5180 [["write"; "/write3"; "\n\n"];
5181 ["cat"; "/write3"]], "\n\n");
5182 InitScratchFS, Always, TestOutput (
5183 [["write"; "/write4"; ""];
5184 ["cat"; "/write4"]], "");
5185 InitScratchFS, Always, TestOutput (
5186 [["write"; "/write5"; "\n\n\n"];
5187 ["cat"; "/write5"]], "\n\n\n");
5188 InitScratchFS, Always, TestOutput (
5189 [["write"; "/write6"; "\n"];
5190 ["cat"; "/write6"]], "\n")],
5191 "create a new file",
5193 This call creates a file called C<path>. The content of the
5194 file is the string C<content> (which can contain any 8 bit data).");
5196 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5197 [InitScratchFS, Always, TestOutput (
5198 [["write"; "/pwrite"; "new file contents"];
5199 ["pwrite"; "/pwrite"; "data"; "4"];
5200 ["cat"; "/pwrite"]], "new data contents");
5201 InitScratchFS, Always, TestOutput (
5202 [["write"; "/pwrite2"; "new file contents"];
5203 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5204 ["cat"; "/pwrite2"]], "new file is extended");
5205 InitScratchFS, Always, TestOutput (
5206 [["write"; "/pwrite3"; "new file contents"];
5207 ["pwrite"; "/pwrite3"; ""; "4"];
5208 ["cat"; "/pwrite3"]], "new file contents")],
5209 "write to part of a file",
5211 This command writes to part of a file. It writes the data
5212 buffer C<content> to the file C<path> starting at offset C<offset>.
5214 This command implements the L<pwrite(2)> system call, and like
5215 that system call it may not write the full data requested. The
5216 return value is the number of bytes that were actually written
5217 to the file. This could even be 0, although short writes are
5218 unlikely for regular files in ordinary circumstances.
5220 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5222 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5224 "resize an ext2, ext3 or ext4 filesystem (with size)",
5226 This command is the same as C<guestfs_resize2fs> except that it
5227 allows you to specify the new size (in bytes) explicitly.");
5229 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5231 "resize an LVM physical volume (with size)",
5233 This command is the same as C<guestfs_pvresize> except that it
5234 allows you to specify the new size (in bytes) explicitly.");
5236 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5238 "resize an NTFS filesystem (with size)",
5240 This command is the same as C<guestfs_ntfsresize> except that it
5241 allows you to specify the new size (in bytes) explicitly.");
5243 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5244 [InitNone, Always, TestRun [["available_all_groups"]]],
5245 "return a list of all optional groups",
5247 This command returns a list of all optional groups that this
5248 daemon knows about. Note this returns both supported and unsupported
5249 groups. To find out which ones the daemon can actually support
5250 you have to call C<guestfs_available> on each member of the
5253 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5255 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5256 [InitScratchFS, Always, TestOutputStruct (
5257 [["fallocate64"; "/fallocate64"; "1000000"];
5258 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5259 "preallocate a file in the guest filesystem",
5261 This command preallocates a file (containing zero bytes) named
5262 C<path> of size C<len> bytes. If the file exists already, it
5265 Note that this call allocates disk blocks for the file.
5266 To create a sparse file use C<guestfs_truncate_size> instead.
5268 The deprecated call C<guestfs_fallocate> does the same,
5269 but owing to an oversight it only allowed 30 bit lengths
5270 to be specified, effectively limiting the maximum size
5271 of files created through that call to 1GB.
5273 Do not confuse this with the guestfish-specific
5274 C<alloc> and C<sparse> commands which create
5275 a file in the host and attach it as a device.");
5277 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5278 [InitBasicFS, Always, TestOutput (
5279 [["set_e2label"; "/dev/sda1"; "LTEST"];
5280 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5281 "get the filesystem label",
5283 This returns the filesystem label of the filesystem on
5286 If the filesystem is unlabeled, this returns the empty string.
5288 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5290 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5291 (let uuid = uuidgen () in
5292 [InitBasicFS, Always, TestOutput (
5293 [["set_e2uuid"; "/dev/sda1"; uuid];
5294 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5295 "get the filesystem UUID",
5297 This returns the filesystem UUID of the filesystem on
5300 If the filesystem does not have a UUID, this returns the empty string.
5302 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5304 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5305 (* Can't be tested with the current framework because
5306 * the VG is being used by the mounted filesystem, so
5307 * the vgchange -an command we do first will fail.
5310 "set LVM device filter",
5312 This sets the LVM device filter so that LVM will only be
5313 able to \"see\" the block devices in the list C<devices>,
5314 and will ignore all other attached block devices.
5316 Where disk image(s) contain duplicate PVs or VGs, this
5317 command is useful to get LVM to ignore the duplicates, otherwise
5318 LVM can get confused. Note also there are two types
5319 of duplication possible: either cloned PVs/VGs which have
5320 identical UUIDs; or VGs that are not cloned but just happen
5321 to have the same name. In normal operation you cannot
5322 create this situation, but you can do it outside LVM, eg.
5323 by cloning disk images or by bit twiddling inside the LVM
5326 This command also clears the LVM cache and performs a volume
5329 You can filter whole block devices or individual partitions.
5331 You cannot use this if any VG is currently in use (eg.
5332 contains a mounted filesystem), even if you are not
5333 filtering out that VG.");
5335 ("lvm_clear_filter", (RErr, [], []), 256, [],
5336 [], (* see note on lvm_set_filter *)
5337 "clear LVM device filter",
5339 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5340 will be able to see every block device.
5342 This command also clears the LVM cache and performs a volume
5345 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5347 "open a LUKS-encrypted block device",
5349 This command opens a block device which has been encrypted
5350 according to the Linux Unified Key Setup (LUKS) standard.
5352 C<device> is the encrypted block device or partition.
5354 The caller must supply one of the keys associated with the
5355 LUKS block device, in the C<key> parameter.
5357 This creates a new block device called C</dev/mapper/mapname>.
5358 Reads and writes to this block device are decrypted from and
5359 encrypted to the underlying C<device> respectively.
5361 If this block device contains LVM volume groups, then
5362 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5363 will make them visible.");
5365 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5367 "open a LUKS-encrypted block device read-only",
5369 This is the same as C<guestfs_luks_open> except that a read-only
5370 mapping is created.");
5372 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5374 "close a LUKS device",
5376 This closes a LUKS device that was created earlier by
5377 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5378 C<device> parameter must be the name of the LUKS mapping
5379 device (ie. C</dev/mapper/mapname>) and I<not> the name
5380 of the underlying block device.");
5382 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5384 "format a block device as a LUKS encrypted device",
5386 This command erases existing data on C<device> and formats
5387 the device as a LUKS encrypted device. C<key> is the
5388 initial key, which is added to key slot C<slot>. (LUKS
5389 supports 8 key slots, numbered 0-7).");
5391 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5393 "format a block device as a LUKS encrypted device",
5395 This command is the same as C<guestfs_luks_format> but
5396 it also allows you to set the C<cipher> used.");
5398 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5400 "add a key on a LUKS encrypted device",
5402 This command adds a new key on LUKS device C<device>.
5403 C<key> is any existing key, and is used to access the device.
5404 C<newkey> is the new key to add. C<keyslot> is the key slot
5405 that will be replaced.
5407 Note that if C<keyslot> already contains a key, then this
5408 command will fail. You have to use C<guestfs_luks_kill_slot>
5409 first to remove that key.");
5411 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5413 "remove a key from a LUKS encrypted device",
5415 This command deletes the key in key slot C<keyslot> from the
5416 encrypted LUKS device C<device>. C<key> must be one of the
5419 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5420 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5421 [["is_lv"; "/dev/VG/LV"]]);
5422 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5423 [["is_lv"; "/dev/sda1"]])],
5424 "test if device is a logical volume",
5426 This command tests whether C<device> is a logical volume, and
5427 returns true iff this is the case.");
5429 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5431 "find a filesystem by UUID",
5433 This command searches the filesystems and returns the one
5434 which has the given UUID. An error is returned if no such
5435 filesystem can be found.
5437 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5439 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5441 "find a filesystem by label",
5443 This command searches the filesystems and returns the one
5444 which has the given label. An error is returned if no such
5445 filesystem can be found.
5447 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5449 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5450 [InitISOFS, Always, TestOutputFalse (
5451 [["is_chardev"; "/directory"]]);
5452 InitScratchFS, Always, TestOutputTrue (
5453 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5454 ["is_chardev"; "/is_chardev"]])],
5455 "test if character device",
5457 This returns C<true> if and only if there is a character device
5458 with the given C<path> name.
5460 See also C<guestfs_stat>.");
5462 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5463 [InitISOFS, Always, TestOutputFalse (
5464 [["is_blockdev"; "/directory"]]);
5465 InitScratchFS, Always, TestOutputTrue (
5466 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5467 ["is_blockdev"; "/is_blockdev"]])],
5468 "test if block device",
5470 This returns C<true> if and only if there is a block device
5471 with the given C<path> name.
5473 See also C<guestfs_stat>.");
5475 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5476 [InitISOFS, Always, TestOutputFalse (
5477 [["is_fifo"; "/directory"]]);
5478 InitScratchFS, Always, TestOutputTrue (
5479 [["mkfifo"; "0o777"; "/is_fifo"];
5480 ["is_fifo"; "/is_fifo"]])],
5481 "test if FIFO (named pipe)",
5483 This returns C<true> if and only if there is a FIFO (named pipe)
5484 with the given C<path> name.
5486 See also C<guestfs_stat>.");
5488 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5489 [InitISOFS, Always, TestOutputFalse (
5490 [["is_symlink"; "/directory"]]);
5491 InitISOFS, Always, TestOutputTrue (
5492 [["is_symlink"; "/abssymlink"]])],
5493 "test if symbolic link",
5495 This returns C<true> if and only if there is a symbolic link
5496 with the given C<path> name.
5498 See also C<guestfs_stat>.");
5500 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5501 (* XXX Need a positive test for sockets. *)
5502 [InitISOFS, Always, TestOutputFalse (
5503 [["is_socket"; "/directory"]])],
5506 This returns C<true> if and only if there is a Unix domain socket
5507 with the given C<path> name.
5509 See also C<guestfs_stat>.");
5511 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5512 [InitPartition, Always, TestOutputDevice (
5513 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5514 InitEmpty, Always, TestLastFail (
5515 [["part_to_dev"; "/dev/sda"]])],
5516 "convert partition name to device name",
5518 This function takes a partition name (eg. \"/dev/sdb1\") and
5519 removes the partition number, returning the device name
5522 The named partition must exist, for example as a string returned
5523 from C<guestfs_list_partitions>.");
5525 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5526 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5527 [InitScratchFS, Always, TestOutput (
5528 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5529 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5530 "upload a file from the local machine with offset",
5532 Upload local file C<filename> to C<remotefilename> on the
5535 C<remotefilename> is overwritten starting at the byte C<offset>
5536 specified. The intention is to overwrite parts of existing
5537 files or devices, although if a non-existant file is specified
5538 then it is created with a \"hole\" before C<offset>. The
5539 size of the data written is implicit in the size of the
5542 Note that there is no limit on the amount of data that
5543 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5544 and this call always writes the full amount unless an
5547 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5549 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5550 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5551 let offset = string_of_int 100 in
5552 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5553 [InitScratchFS, Always, TestOutput (
5554 (* Pick a file from cwd which isn't likely to change. *)
5555 [["mkdir"; "/download_offset"];
5556 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5557 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5558 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5559 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5560 "download a file to the local machine with offset and size",
5562 Download file C<remotefilename> and save it as C<filename>
5563 on the local machine.
5565 C<remotefilename> is read for C<size> bytes starting at C<offset>
5566 (this region must be within the file or device).
5568 Note that there is no limit on the amount of data that
5569 can be downloaded with this call, unlike with C<guestfs_pread>,
5570 and this call always reads the full amount unless an
5573 See also C<guestfs_download>, C<guestfs_pread>.");
5575 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5576 [InitPartition, Always, TestOutputListOfDevices (
5577 [["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"];
5578 ["blockdev_rereadpt"; "/dev/sda"];
5579 ["list_partitions"]], ["/dev/sdb1"])],
5580 "write to part of a device",
5582 This command writes to part of a device. It writes the data
5583 buffer C<content> to C<device> starting at offset C<offset>.
5585 This command implements the L<pwrite(2)> system call, and like
5586 that system call it may not write the full data requested
5587 (although short writes to disk devices and partitions are
5588 probably impossible with standard Linux kernels).
5590 See also C<guestfs_pwrite>.");
5592 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5593 [InitEmpty, Always, TestOutputBuffer (
5594 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5595 "read part of a device",
5597 This command lets you read part of a file. It reads C<count>
5598 bytes of C<device>, starting at C<offset>.
5600 This may read fewer bytes than requested. For further details
5601 see the L<pread(2)> system call.
5603 See also C<guestfs_pread>.");
5605 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5606 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5607 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5608 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5609 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5610 "get canonical name of an LV",
5612 This converts alternative naming schemes for LVs that you
5613 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5614 is converted to C</dev/VG/LV>.
5616 This command returns an error if the C<lvname> parameter does
5617 not refer to a logical volume.
5619 See also C<guestfs_is_lv>.");
5621 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"]), 278, [],
5622 [InitEmpty, Always, TestOutput (
5623 [["part_disk"; "/dev/sda"; "mbr"];
5624 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"];
5625 ["mount_options"; ""; "/dev/sda1"; "/"];
5626 ["write"; "/new"; "new file contents"];
5627 ["cat"; "/new"]], "new file contents")],
5628 "make a filesystem",
5630 This function creates a filesystem on C<device>. The filesystem
5631 type is C<fstype>, for example C<ext3>.
5633 The optional arguments are:
5639 The filesystem block size. Supported block sizes depend on the
5640 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5641 for Linux ext2/3 filesystems.
5643 For VFAT and NTFS the C<blocksize> parameter is treated as
5644 the requested cluster size.
5646 For UFS block sizes, please see L<mkfs.ufs(8)>.
5650 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5652 "get a single extended attribute",
5654 Get a single extended attribute from file C<path> named C<name>.
5655 This call follows symlinks. If you want to lookup an extended
5656 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5658 Normally it is better to get all extended attributes from a file
5659 in one go by calling C<guestfs_getxattrs>. However some Linux
5660 filesystem implementations are buggy and do not provide a way to
5661 list out attributes. For these filesystems (notably ntfs-3g)
5662 you have to know the names of the extended attributes you want
5663 in advance and call this function.
5665 Extended attribute values are blobs of binary data. If there
5666 is no extended attribute named C<name>, this returns an error.
5668 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5670 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5672 "get a single extended attribute",
5674 Get a single extended attribute from file C<path> named C<name>.
5675 If C<path> is a symlink, then this call returns an extended
5676 attribute from the symlink.
5678 Normally it is better to get all extended attributes from a file
5679 in one go by calling C<guestfs_getxattrs>. However some Linux
5680 filesystem implementations are buggy and do not provide a way to
5681 list out attributes. For these filesystems (notably ntfs-3g)
5682 you have to know the names of the extended attributes you want
5683 in advance and call this function.
5685 Extended attribute values are blobs of binary data. If there
5686 is no extended attribute named C<name>, this returns an error.
5688 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5692 let all_functions = non_daemon_functions @ daemon_functions
5694 (* In some places we want the functions to be displayed sorted
5695 * alphabetically, so this is useful:
5697 let all_functions_sorted = List.sort action_compare all_functions
5699 (* This is used to generate the src/MAX_PROC_NR file which
5700 * contains the maximum procedure number, a surrogate for the
5701 * ABI version number. See src/Makefile.am for the details.
5704 let proc_nrs = List.map (
5705 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5706 ) daemon_functions in
5707 List.fold_left max 0 proc_nrs
5709 (* Non-API meta-commands available only in guestfish.
5711 * Note (1): style, proc_nr and tests fields are all meaningless.
5712 * The only fields which are actually used are the shortname,
5713 * FishAlias flags, shortdesc and longdesc.
5715 * Note (2): to refer to other commands, use L</shortname>.
5717 * Note (3): keep this list sorted by shortname.
5719 let fish_commands = [
5720 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5721 "allocate and add a disk file",
5722 " alloc filename size
5724 This creates an empty (zeroed) file of the given size, and then adds
5725 so it can be further examined.
5727 For more advanced image creation, see L<qemu-img(1)> utility.
5729 Size can be specified using standard suffixes, eg. C<1M>.
5731 To create a sparse file, use L</sparse> instead. To create a
5732 prepared disk image, see L</PREPARED DISK IMAGES>.");
5734 ("copy_in", (RErr,[], []), -1, [], [],
5735 "copy local files or directories into an image",
5736 " copy-in local [local ...] /remotedir
5738 C<copy-in> copies local files or directories recursively into the disk
5739 image, placing them in the directory called C</remotedir> (which must
5740 exist). This guestfish meta-command turns into a sequence of
5741 L</tar-in> and other commands as necessary.
5743 Multiple local files and directories can be specified, but the last
5744 parameter must always be a remote directory. Wildcards cannot be
5747 ("copy_out", (RErr,[], []), -1, [], [],
5748 "copy remote files or directories out of an image",
5749 " copy-out remote [remote ...] localdir
5751 C<copy-out> copies remote files or directories recursively out of the
5752 disk image, placing them on the host disk in a local directory called
5753 C<localdir> (which must exist). This guestfish meta-command turns
5754 into a sequence of L</download>, L</tar-out> and other commands as
5757 Multiple remote files and directories can be specified, but the last
5758 parameter must always be a local directory. To download to the
5759 current directory, use C<.> as in:
5763 Wildcards cannot be used in the ordinary command, but you can use
5764 them with the help of L</glob> like this:
5766 glob copy-out /home/* .");
5768 ("echo", (RErr,[], []), -1, [], [],
5769 "display a line of text",
5772 This echos the parameters to the terminal.");
5774 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5778 This is used to edit a file. It downloads the file, edits it
5779 locally using your editor, then uploads the result.
5781 The editor is C<$EDITOR>. However if you use the alternate
5782 commands C<vi> or C<emacs> you will get those corresponding
5785 ("glob", (RErr,[], []), -1, [], [],
5786 "expand wildcards in command",
5787 " glob command args...
5789 Expand wildcards in any paths in the args list, and run C<command>
5790 repeatedly on each matching path.
5792 See L</WILDCARDS AND GLOBBING>.");
5794 ("hexedit", (RErr,[], []), -1, [], [],
5795 "edit with a hex editor",
5796 " hexedit <filename|device>
5797 hexedit <filename|device> <max>
5798 hexedit <filename|device> <start> <max>
5800 Use hexedit (a hex editor) to edit all or part of a binary file
5803 This command works by downloading potentially the whole file or
5804 device, editing it locally, then uploading it. If the file or
5805 device is large, you have to specify which part you wish to edit
5806 by using C<max> and/or C<start> C<max> parameters.
5807 C<start> and C<max> are specified in bytes, with the usual
5808 modifiers allowed such as C<1M> (1 megabyte).
5810 For example to edit the first few sectors of a disk you
5815 which would allow you to edit anywhere within the first megabyte
5818 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5820 hexedit /dev/sda1 0x400 0x400
5822 (assuming the superblock is in the standard location).
5824 This command requires the external L<hexedit(1)> program. You
5825 can specify another program to use by setting the C<HEXEDITOR>
5826 environment variable.
5828 See also L</hexdump>.");
5830 ("lcd", (RErr,[], []), -1, [], [],
5831 "change working directory",
5834 Change the local directory, ie. the current directory of guestfish
5837 Note that C<!cd> won't do what you might expect.");
5839 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5843 Opens the manual page for guestfish.");
5845 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5851 This is used to view a file.
5853 The default viewer is C<$PAGER>. However if you use the alternate
5854 command C<less> you will get the C<less> command specifically.");
5856 ("reopen", (RErr,[], []), -1, [], [],
5857 "close and reopen libguestfs handle",
5860 Close and reopen the libguestfs handle. It is not necessary to use
5861 this normally, because the handle is closed properly when guestfish
5862 exits. However this is occasionally useful for testing.");
5864 ("sparse", (RErr,[], []), -1, [], [],
5865 "create a sparse disk image and add",
5866 " sparse filename size
5868 This creates an empty sparse file of the given size, and then adds
5869 so it can be further examined.
5871 In all respects it works the same as the L</alloc> command, except that
5872 the image file is allocated sparsely, which means that disk blocks are
5873 not assigned to the file until they are needed. Sparse disk files
5874 only use space when written to, but they are slower and there is a
5875 danger you could run out of real disk space during a write operation.
5877 For more advanced image creation, see L<qemu-img(1)> utility.
5879 Size can be specified using standard suffixes, eg. C<1M>.");
5881 ("supported", (RErr,[], []), -1, [], [],
5882 "list supported groups of commands",
5885 This command returns a list of the optional groups
5886 known to the daemon, and indicates which ones are
5887 supported by this build of the libguestfs appliance.
5889 See also L<guestfs(3)/AVAILABILITY>.");
5891 ("time", (RErr,[], []), -1, [], [],
5892 "print elapsed time taken to run a command",
5893 " time command args...
5895 Run the command as usual, but print the elapsed time afterwards. This
5896 can be useful for benchmarking operations.");