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
1572 Typecheck lenses (can be expensive).
1574 =item C<AUG_NO_STDINC> = 8
1576 Do not use standard load path for modules.
1578 =item C<AUG_SAVE_NOOP> = 16
1580 Make save a no-op, just record what would have been changed.
1582 =item C<AUG_NO_LOAD> = 32
1584 Do not load the tree in C<guestfs_aug_init>.
1588 To close the handle, you can call C<guestfs_aug_close>.
1590 To find out more about Augeas, see L<http://augeas.net/>.");
1592 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1593 [], (* XXX Augeas code needs tests. *)
1594 "close the current Augeas handle",
1596 Close the current Augeas handle and free up any resources
1597 used by it. After calling this, you have to call
1598 C<guestfs_aug_init> again before you can use any other
1599 Augeas functions.");
1601 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1602 [], (* XXX Augeas code needs tests. *)
1603 "define an Augeas variable",
1605 Defines an Augeas variable C<name> whose value is the result
1606 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1609 On success this returns the number of nodes in C<expr>, or
1610 C<0> if C<expr> evaluates to something which is not a nodeset.");
1612 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1613 [], (* XXX Augeas code needs tests. *)
1614 "define an Augeas node",
1616 Defines a variable C<name> whose value is the result of
1619 If C<expr> evaluates to an empty nodeset, a node is created,
1620 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1621 C<name> will be the nodeset containing that single node.
1623 On success this returns a pair containing the
1624 number of nodes in the nodeset, and a boolean flag
1625 if a node was created.");
1627 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1628 [], (* XXX Augeas code needs tests. *)
1629 "look up the value of an Augeas path",
1631 Look up the value associated with C<path>. If C<path>
1632 matches exactly one node, the C<value> is returned.");
1634 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1635 [], (* XXX Augeas code needs tests. *)
1636 "set Augeas path to value",
1638 Set the value associated with C<path> to C<val>.
1640 In the Augeas API, it is possible to clear a node by setting
1641 the value to NULL. Due to an oversight in the libguestfs API
1642 you cannot do that with this call. Instead you must use the
1643 C<guestfs_aug_clear> call.");
1645 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1646 [], (* XXX Augeas code needs tests. *)
1647 "insert a sibling Augeas node",
1649 Create a new sibling C<label> for C<path>, inserting it into
1650 the tree before or after C<path> (depending on the boolean
1653 C<path> must match exactly one existing node in the tree, and
1654 C<label> must be a label, ie. not contain C</>, C<*> or end
1655 with a bracketed index C<[N]>.");
1657 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1658 [], (* XXX Augeas code needs tests. *)
1659 "remove an Augeas path",
1661 Remove C<path> and all of its children.
1663 On success this returns the number of entries which were removed.");
1665 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1666 [], (* XXX Augeas code needs tests. *)
1669 Move the node C<src> to C<dest>. C<src> must match exactly
1670 one node. C<dest> is overwritten if it exists.");
1672 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1673 [], (* XXX Augeas code needs tests. *)
1674 "return Augeas nodes which match augpath",
1676 Returns a list of paths which match the path expression C<path>.
1677 The returned paths are sufficiently qualified so that they match
1678 exactly one node in the current tree.");
1680 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1681 [], (* XXX Augeas code needs tests. *)
1682 "write all pending Augeas changes to disk",
1684 This writes all pending changes to disk.
1686 The flags which were passed to C<guestfs_aug_init> affect exactly
1687 how files are saved.");
1689 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1690 [], (* XXX Augeas code needs tests. *)
1691 "load files into the tree",
1693 Load files into the tree.
1695 See C<aug_load> in the Augeas documentation for the full gory
1698 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1699 [], (* XXX Augeas code needs tests. *)
1700 "list Augeas nodes under augpath",
1702 This is just a shortcut for listing C<guestfs_aug_match>
1703 C<path/*> and sorting the resulting nodes into alphabetical order.");
1705 ("rm", (RErr, [Pathname "path"], []), 29, [],
1706 [InitScratchFS, Always, TestRun
1708 ["touch"; "/rm/new"];
1710 InitScratchFS, Always, TestLastFail
1711 [["rm"; "/nosuchfile"]];
1712 InitScratchFS, Always, TestLastFail
1717 Remove the single file C<path>.");
1719 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1720 [InitScratchFS, Always, TestRun
1721 [["mkdir"; "/rmdir"];
1722 ["rmdir"; "/rmdir"]];
1723 InitScratchFS, Always, TestLastFail
1724 [["rmdir"; "/rmdir2"]];
1725 InitScratchFS, Always, TestLastFail
1726 [["mkdir"; "/rmdir3"];
1727 ["touch"; "/rmdir3/new"];
1728 ["rmdir"; "/rmdir3/new"]]],
1729 "remove a directory",
1731 Remove the single directory C<path>.");
1733 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1734 [InitScratchFS, Always, TestOutputFalse
1735 [["mkdir"; "/rm_rf"];
1736 ["mkdir"; "/rm_rf/foo"];
1737 ["touch"; "/rm_rf/foo/bar"];
1738 ["rm_rf"; "/rm_rf"];
1739 ["exists"; "/rm_rf"]]],
1740 "remove a file or directory recursively",
1742 Remove the file or directory C<path>, recursively removing the
1743 contents if its a directory. This is like the C<rm -rf> shell
1746 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1747 [InitScratchFS, Always, TestOutputTrue
1748 [["mkdir"; "/mkdir"];
1749 ["is_dir"; "/mkdir"]];
1750 InitScratchFS, Always, TestLastFail
1751 [["mkdir"; "/mkdir2/foo/bar"]]],
1752 "create a directory",
1754 Create a directory named C<path>.");
1756 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1757 [InitScratchFS, Always, TestOutputTrue
1758 [["mkdir_p"; "/mkdir_p/foo/bar"];
1759 ["is_dir"; "/mkdir_p/foo/bar"]];
1760 InitScratchFS, Always, TestOutputTrue
1761 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1762 ["is_dir"; "/mkdir_p2/foo"]];
1763 InitScratchFS, Always, TestOutputTrue
1764 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1765 ["is_dir"; "/mkdir_p3"]];
1766 (* Regression tests for RHBZ#503133: *)
1767 InitScratchFS, Always, TestRun
1768 [["mkdir"; "/mkdir_p4"];
1769 ["mkdir_p"; "/mkdir_p4"]];
1770 InitScratchFS, Always, TestLastFail
1771 [["touch"; "/mkdir_p5"];
1772 ["mkdir_p"; "/mkdir_p5"]]],
1773 "create a directory and parents",
1775 Create a directory named C<path>, creating any parent directories
1776 as necessary. This is like the C<mkdir -p> shell command.");
1778 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1779 [], (* XXX Need stat command to test *)
1782 Change the mode (permissions) of C<path> to C<mode>. Only
1783 numeric modes are supported.
1785 I<Note>: When using this command from guestfish, C<mode>
1786 by default would be decimal, unless you prefix it with
1787 C<0> to get octal, ie. use C<0700> not C<700>.
1789 The mode actually set is affected by the umask.");
1791 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1792 [], (* XXX Need stat command to test *)
1793 "change file owner and group",
1795 Change the file owner to C<owner> and group to C<group>.
1797 Only numeric uid and gid are supported. If you want to use
1798 names, you will need to locate and parse the password file
1799 yourself (Augeas support makes this relatively easy).");
1801 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1802 [InitISOFS, Always, TestOutputTrue (
1803 [["exists"; "/empty"]]);
1804 InitISOFS, Always, TestOutputTrue (
1805 [["exists"; "/directory"]])],
1806 "test if file or directory exists",
1808 This returns C<true> if and only if there is a file, directory
1809 (or anything) with the given C<path> name.
1811 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1813 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1814 [InitISOFS, Always, TestOutputTrue (
1815 [["is_file"; "/known-1"]]);
1816 InitISOFS, Always, TestOutputFalse (
1817 [["is_file"; "/directory"]])],
1818 "test if a regular file",
1820 This returns C<true> if and only if there is a regular file
1821 with the given C<path> name. Note that it returns false for
1822 other objects like directories.
1824 See also C<guestfs_stat>.");
1826 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1827 [InitISOFS, Always, TestOutputFalse (
1828 [["is_dir"; "/known-3"]]);
1829 InitISOFS, Always, TestOutputTrue (
1830 [["is_dir"; "/directory"]])],
1831 "test if a directory",
1833 This returns C<true> if and only if there is a directory
1834 with the given C<path> name. Note that it returns false for
1835 other objects like files.
1837 See also C<guestfs_stat>.");
1839 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1840 [InitEmpty, Always, TestOutputListOfDevices (
1841 [["part_init"; "/dev/sda"; "mbr"];
1842 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1843 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1844 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1845 ["pvcreate"; "/dev/sda1"];
1846 ["pvcreate"; "/dev/sda2"];
1847 ["pvcreate"; "/dev/sda3"];
1848 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1849 "create an LVM physical volume",
1851 This creates an LVM physical volume on the named C<device>,
1852 where C<device> should usually be a partition name such
1855 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1856 [InitEmpty, Always, TestOutputList (
1857 [["part_init"; "/dev/sda"; "mbr"];
1858 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1859 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1860 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1861 ["pvcreate"; "/dev/sda1"];
1862 ["pvcreate"; "/dev/sda2"];
1863 ["pvcreate"; "/dev/sda3"];
1864 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1865 ["vgcreate"; "VG2"; "/dev/sda3"];
1866 ["vgs"]], ["VG1"; "VG2"])],
1867 "create an LVM volume group",
1869 This creates an LVM volume group called C<volgroup>
1870 from the non-empty list of physical volumes C<physvols>.");
1872 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1873 [InitEmpty, Always, TestOutputList (
1874 [["part_init"; "/dev/sda"; "mbr"];
1875 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1876 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1877 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1878 ["pvcreate"; "/dev/sda1"];
1879 ["pvcreate"; "/dev/sda2"];
1880 ["pvcreate"; "/dev/sda3"];
1881 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1882 ["vgcreate"; "VG2"; "/dev/sda3"];
1883 ["lvcreate"; "LV1"; "VG1"; "50"];
1884 ["lvcreate"; "LV2"; "VG1"; "50"];
1885 ["lvcreate"; "LV3"; "VG2"; "50"];
1886 ["lvcreate"; "LV4"; "VG2"; "50"];
1887 ["lvcreate"; "LV5"; "VG2"; "50"];
1889 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1890 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1891 "create an LVM logical volume",
1893 This creates an LVM logical volume called C<logvol>
1894 on the volume group C<volgroup>, with C<size> megabytes.");
1896 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1897 [InitEmpty, Always, TestOutput (
1898 [["part_disk"; "/dev/sda"; "mbr"];
1899 ["mkfs"; "ext2"; "/dev/sda1"];
1900 ["mount_options"; ""; "/dev/sda1"; "/"];
1901 ["write"; "/new"; "new file contents"];
1902 ["cat"; "/new"]], "new file contents")],
1903 "make a filesystem",
1905 This creates a filesystem on C<device> (usually a partition
1906 or LVM logical volume). The filesystem type is C<fstype>, for
1909 ("sfdisk", (RErr, [Device "device";
1910 Int "cyls"; Int "heads"; Int "sectors";
1911 StringList "lines"], []), 43, [DangerWillRobinson],
1913 "create partitions on a block device",
1915 This is a direct interface to the L<sfdisk(8)> program for creating
1916 partitions on block devices.
1918 C<device> should be a block device, for example C</dev/sda>.
1920 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1921 and sectors on the device, which are passed directly to sfdisk as
1922 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1923 of these, then the corresponding parameter is omitted. Usually for
1924 'large' disks, you can just pass C<0> for these, but for small
1925 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1926 out the right geometry and you will need to tell it.
1928 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1929 information refer to the L<sfdisk(8)> manpage.
1931 To create a single partition occupying the whole disk, you would
1932 pass C<lines> as a single element list, when the single element being
1933 the string C<,> (comma).
1935 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1936 C<guestfs_part_init>");
1938 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1939 (* Regression test for RHBZ#597135. *)
1940 [InitScratchFS, Always, TestLastFail
1941 [["write_file"; "/write_file"; "abc"; "10000"]]],
1944 This call creates a file called C<path>. The contents of the
1945 file is the string C<content> (which can contain any 8 bit data),
1946 with length C<size>.
1948 As a special case, if C<size> is C<0>
1949 then the length is calculated using C<strlen> (so in this case
1950 the content cannot contain embedded ASCII NULs).
1952 I<NB.> Owing to a bug, writing content containing ASCII NUL
1953 characters does I<not> work, even if the length is specified.");
1955 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
1956 [InitEmpty, Always, TestOutputListOfDevices (
1957 [["part_disk"; "/dev/sda"; "mbr"];
1958 ["mkfs"; "ext2"; "/dev/sda1"];
1959 ["mount_options"; ""; "/dev/sda1"; "/"];
1960 ["mounts"]], ["/dev/sda1"]);
1961 InitEmpty, Always, TestOutputList (
1962 [["part_disk"; "/dev/sda"; "mbr"];
1963 ["mkfs"; "ext2"; "/dev/sda1"];
1964 ["mount_options"; ""; "/dev/sda1"; "/"];
1967 "unmount a filesystem",
1969 This unmounts the given filesystem. The filesystem may be
1970 specified either by its mountpoint (path) or the device which
1971 contains the filesystem.");
1973 ("mounts", (RStringList "devices", [], []), 46, [],
1974 [InitScratchFS, Always, TestOutputListOfDevices (
1975 [["mounts"]], ["/dev/sdb1"])],
1976 "show mounted filesystems",
1978 This returns the list of currently mounted filesystems. It returns
1979 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1981 Some internal mounts are not shown.
1983 See also: C<guestfs_mountpoints>");
1985 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
1986 [InitScratchFS, Always, TestOutputList (
1989 (* check that umount_all can unmount nested mounts correctly: *)
1990 InitEmpty, Always, TestOutputList (
1991 [["part_init"; "/dev/sda"; "mbr"];
1992 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1993 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1994 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1995 ["mkfs"; "ext2"; "/dev/sda1"];
1996 ["mkfs"; "ext2"; "/dev/sda2"];
1997 ["mkfs"; "ext2"; "/dev/sda3"];
1998 ["mount_options"; ""; "/dev/sda1"; "/"];
2000 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2001 ["mkdir"; "/mp1/mp2"];
2002 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2003 ["mkdir"; "/mp1/mp2/mp3"];
2006 "unmount all filesystems",
2008 This unmounts all mounted filesystems.
2010 Some internal mounts are not unmounted by this call.");
2012 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2014 "remove all LVM LVs, VGs and PVs",
2016 This command removes all LVM logical volumes, volume groups
2017 and physical volumes.");
2019 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2020 [InitISOFS, Always, TestOutput (
2021 [["file"; "/empty"]], "empty");
2022 InitISOFS, Always, TestOutput (
2023 [["file"; "/known-1"]], "ASCII text");
2024 InitISOFS, Always, TestLastFail (
2025 [["file"; "/notexists"]]);
2026 InitISOFS, Always, TestOutput (
2027 [["file"; "/abssymlink"]], "symbolic link");
2028 InitISOFS, Always, TestOutput (
2029 [["file"; "/directory"]], "directory")],
2030 "determine file type",
2032 This call uses the standard L<file(1)> command to determine
2033 the type or contents of the file.
2035 This call will also transparently look inside various types
2038 The exact command which runs is C<file -zb path>. Note in
2039 particular that the filename is not prepended to the output
2042 This command can also be used on C</dev/> devices
2043 (and partitions, LV names). You can for example use this
2044 to determine if a device contains a filesystem, although
2045 it's usually better to use C<guestfs_vfs_type>.
2047 If the C<path> does not begin with C</dev/> then
2048 this command only works for the content of regular files.
2049 For other file types (directory, symbolic link etc) it
2050 will just return the string C<directory> etc.");
2052 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2053 [InitScratchFS, Always, TestOutput (
2054 [["mkdir"; "/command"];
2055 ["upload"; "test-command"; "/command/test-command"];
2056 ["chmod"; "0o755"; "/command/test-command"];
2057 ["command"; "/command/test-command 1"]], "Result1");
2058 InitScratchFS, Always, TestOutput (
2059 [["mkdir"; "/command2"];
2060 ["upload"; "test-command"; "/command2/test-command"];
2061 ["chmod"; "0o755"; "/command2/test-command"];
2062 ["command"; "/command2/test-command 2"]], "Result2\n");
2063 InitScratchFS, Always, TestOutput (
2064 [["mkdir"; "/command3"];
2065 ["upload"; "test-command"; "/command3/test-command"];
2066 ["chmod"; "0o755"; "/command3/test-command"];
2067 ["command"; "/command3/test-command 3"]], "\nResult3");
2068 InitScratchFS, Always, TestOutput (
2069 [["mkdir"; "/command4"];
2070 ["upload"; "test-command"; "/command4/test-command"];
2071 ["chmod"; "0o755"; "/command4/test-command"];
2072 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2073 InitScratchFS, Always, TestOutput (
2074 [["mkdir"; "/command5"];
2075 ["upload"; "test-command"; "/command5/test-command"];
2076 ["chmod"; "0o755"; "/command5/test-command"];
2077 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2078 InitScratchFS, Always, TestOutput (
2079 [["mkdir"; "/command6"];
2080 ["upload"; "test-command"; "/command6/test-command"];
2081 ["chmod"; "0o755"; "/command6/test-command"];
2082 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2083 InitScratchFS, Always, TestOutput (
2084 [["mkdir"; "/command7"];
2085 ["upload"; "test-command"; "/command7/test-command"];
2086 ["chmod"; "0o755"; "/command7/test-command"];
2087 ["command"; "/command7/test-command 7"]], "");
2088 InitScratchFS, Always, TestOutput (
2089 [["mkdir"; "/command8"];
2090 ["upload"; "test-command"; "/command8/test-command"];
2091 ["chmod"; "0o755"; "/command8/test-command"];
2092 ["command"; "/command8/test-command 8"]], "\n");
2093 InitScratchFS, Always, TestOutput (
2094 [["mkdir"; "/command9"];
2095 ["upload"; "test-command"; "/command9/test-command"];
2096 ["chmod"; "0o755"; "/command9/test-command"];
2097 ["command"; "/command9/test-command 9"]], "\n\n");
2098 InitScratchFS, Always, TestOutput (
2099 [["mkdir"; "/command10"];
2100 ["upload"; "test-command"; "/command10/test-command"];
2101 ["chmod"; "0o755"; "/command10/test-command"];
2102 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2103 InitScratchFS, Always, TestOutput (
2104 [["mkdir"; "/command11"];
2105 ["upload"; "test-command"; "/command11/test-command"];
2106 ["chmod"; "0o755"; "/command11/test-command"];
2107 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2108 InitScratchFS, Always, TestLastFail (
2109 [["mkdir"; "/command12"];
2110 ["upload"; "test-command"; "/command12/test-command"];
2111 ["chmod"; "0o755"; "/command12/test-command"];
2112 ["command"; "/command12/test-command"]])],
2113 "run a command from the guest filesystem",
2115 This call runs a command from the guest filesystem. The
2116 filesystem must be mounted, and must contain a compatible
2117 operating system (ie. something Linux, with the same
2118 or compatible processor architecture).
2120 The single parameter is an argv-style list of arguments.
2121 The first element is the name of the program to run.
2122 Subsequent elements are parameters. The list must be
2123 non-empty (ie. must contain a program name). Note that
2124 the command runs directly, and is I<not> invoked via
2125 the shell (see C<guestfs_sh>).
2127 The return value is anything printed to I<stdout> by
2130 If the command returns a non-zero exit status, then
2131 this function returns an error message. The error message
2132 string is the content of I<stderr> from the command.
2134 The C<$PATH> environment variable will contain at least
2135 C</usr/bin> and C</bin>. If you require a program from
2136 another location, you should provide the full path in the
2139 Shared libraries and data files required by the program
2140 must be available on filesystems which are mounted in the
2141 correct places. It is the caller's responsibility to ensure
2142 all filesystems that are needed are mounted at the right
2145 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2146 [InitScratchFS, Always, TestOutputList (
2147 [["mkdir"; "/command_lines"];
2148 ["upload"; "test-command"; "/command_lines/test-command"];
2149 ["chmod"; "0o755"; "/command_lines/test-command"];
2150 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2151 InitScratchFS, Always, TestOutputList (
2152 [["mkdir"; "/command_lines2"];
2153 ["upload"; "test-command"; "/command_lines2/test-command"];
2154 ["chmod"; "0o755"; "/command_lines2/test-command"];
2155 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2156 InitScratchFS, Always, TestOutputList (
2157 [["mkdir"; "/command_lines3"];
2158 ["upload"; "test-command"; "/command_lines3/test-command"];
2159 ["chmod"; "0o755"; "/command_lines3/test-command"];
2160 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2161 InitScratchFS, Always, TestOutputList (
2162 [["mkdir"; "/command_lines4"];
2163 ["upload"; "test-command"; "/command_lines4/test-command"];
2164 ["chmod"; "0o755"; "/command_lines4/test-command"];
2165 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2166 InitScratchFS, Always, TestOutputList (
2167 [["mkdir"; "/command_lines5"];
2168 ["upload"; "test-command"; "/command_lines5/test-command"];
2169 ["chmod"; "0o755"; "/command_lines5/test-command"];
2170 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2171 InitScratchFS, Always, TestOutputList (
2172 [["mkdir"; "/command_lines6"];
2173 ["upload"; "test-command"; "/command_lines6/test-command"];
2174 ["chmod"; "0o755"; "/command_lines6/test-command"];
2175 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2176 InitScratchFS, Always, TestOutputList (
2177 [["mkdir"; "/command_lines7"];
2178 ["upload"; "test-command"; "/command_lines7/test-command"];
2179 ["chmod"; "0o755"; "/command_lines7/test-command"];
2180 ["command_lines"; "/command_lines7/test-command 7"]], []);
2181 InitScratchFS, Always, TestOutputList (
2182 [["mkdir"; "/command_lines8"];
2183 ["upload"; "test-command"; "/command_lines8/test-command"];
2184 ["chmod"; "0o755"; "/command_lines8/test-command"];
2185 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2186 InitScratchFS, Always, TestOutputList (
2187 [["mkdir"; "/command_lines9"];
2188 ["upload"; "test-command"; "/command_lines9/test-command"];
2189 ["chmod"; "0o755"; "/command_lines9/test-command"];
2190 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2191 InitScratchFS, Always, TestOutputList (
2192 [["mkdir"; "/command_lines10"];
2193 ["upload"; "test-command"; "/command_lines10/test-command"];
2194 ["chmod"; "0o755"; "/command_lines10/test-command"];
2195 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2196 InitScratchFS, Always, TestOutputList (
2197 [["mkdir"; "/command_lines11"];
2198 ["upload"; "test-command"; "/command_lines11/test-command"];
2199 ["chmod"; "0o755"; "/command_lines11/test-command"];
2200 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2201 "run a command, returning lines",
2203 This is the same as C<guestfs_command>, but splits the
2204 result into a list of lines.
2206 See also: C<guestfs_sh_lines>");
2208 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2209 [InitISOFS, Always, TestOutputStruct (
2210 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2211 "get file information",
2213 Returns file information for the given C<path>.
2215 This is the same as the C<stat(2)> system call.");
2217 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2218 [InitISOFS, Always, TestOutputStruct (
2219 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2220 "get file information for a symbolic link",
2222 Returns file information for the given C<path>.
2224 This is the same as C<guestfs_stat> except that if C<path>
2225 is a symbolic link, then the link is stat-ed, not the file it
2228 This is the same as the C<lstat(2)> system call.");
2230 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2231 [InitISOFS, Always, TestOutputStruct (
2232 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2233 "get file system statistics",
2235 Returns file system statistics for any mounted file system.
2236 C<path> should be a file or directory in the mounted file system
2237 (typically it is the mount point itself, but it doesn't need to be).
2239 This is the same as the C<statvfs(2)> system call.");
2241 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2243 "get ext2/ext3/ext4 superblock details",
2245 This returns the contents of the ext2, ext3 or ext4 filesystem
2246 superblock on C<device>.
2248 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2249 manpage for more details. The list of fields returned isn't
2250 clearly defined, and depends on both the version of C<tune2fs>
2251 that libguestfs was built against, and the filesystem itself.");
2253 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2254 [InitEmpty, Always, TestOutputTrue (
2255 [["blockdev_setro"; "/dev/sda"];
2256 ["blockdev_getro"; "/dev/sda"]])],
2257 "set block device to read-only",
2259 Sets the block device named C<device> to read-only.
2261 This uses the L<blockdev(8)> command.");
2263 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2264 [InitEmpty, Always, TestOutputFalse (
2265 [["blockdev_setrw"; "/dev/sda"];
2266 ["blockdev_getro"; "/dev/sda"]])],
2267 "set block device to read-write",
2269 Sets the block device named C<device> to read-write.
2271 This uses the L<blockdev(8)> command.");
2273 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2274 [InitEmpty, Always, TestOutputTrue (
2275 [["blockdev_setro"; "/dev/sda"];
2276 ["blockdev_getro"; "/dev/sda"]])],
2277 "is block device set to read-only",
2279 Returns a boolean indicating if the block device is read-only
2280 (true if read-only, false if not).
2282 This uses the L<blockdev(8)> command.");
2284 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2285 [InitEmpty, Always, TestOutputInt (
2286 [["blockdev_getss"; "/dev/sda"]], 512)],
2287 "get sectorsize of block device",
2289 This returns the size of sectors on a block device.
2290 Usually 512, but can be larger for modern devices.
2292 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2295 This uses the L<blockdev(8)> command.");
2297 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2298 [InitEmpty, Always, TestOutputInt (
2299 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2300 "get blocksize of block device",
2302 This returns the block size of a device.
2304 (Note this is different from both I<size in blocks> and
2305 I<filesystem block size>).
2307 This uses the L<blockdev(8)> command.");
2309 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2311 "set blocksize of block device",
2313 This sets the block size of a device.
2315 (Note this is different from both I<size in blocks> and
2316 I<filesystem block size>).
2318 This uses the L<blockdev(8)> command.");
2320 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2321 [InitEmpty, Always, TestOutputInt (
2322 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2323 "get total size of device in 512-byte sectors",
2325 This returns the size of the device in units of 512-byte sectors
2326 (even if the sectorsize isn't 512 bytes ... weird).
2328 See also C<guestfs_blockdev_getss> for the real sector size of
2329 the device, and C<guestfs_blockdev_getsize64> for the more
2330 useful I<size in bytes>.
2332 This uses the L<blockdev(8)> command.");
2334 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2335 [InitEmpty, Always, TestOutputInt (
2336 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2337 "get total size of device in bytes",
2339 This returns the size of the device in bytes.
2341 See also C<guestfs_blockdev_getsz>.
2343 This uses the L<blockdev(8)> command.");
2345 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2346 [InitEmpty, Always, TestRun
2347 [["blockdev_flushbufs"; "/dev/sda"]]],
2348 "flush device buffers",
2350 This tells the kernel to flush internal buffers associated
2353 This uses the L<blockdev(8)> command.");
2355 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2356 [InitEmpty, Always, TestRun
2357 [["blockdev_rereadpt"; "/dev/sda"]]],
2358 "reread partition table",
2360 Reread the partition table on C<device>.
2362 This uses the L<blockdev(8)> command.");
2364 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2365 [InitScratchFS, Always, TestOutput (
2366 (* Pick a file from cwd which isn't likely to change. *)
2367 [["mkdir"; "/upload"];
2368 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2369 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2370 Digest.to_hex (Digest.file "COPYING.LIB"))],
2371 "upload a file from the local machine",
2373 Upload local file C<filename> to C<remotefilename> on the
2376 C<filename> can also be a named pipe.
2378 See also C<guestfs_download>.");
2380 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2381 [InitScratchFS, Always, TestOutput (
2382 (* Pick a file from cwd which isn't likely to change. *)
2383 [["mkdir"; "/download"];
2384 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2385 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2386 ["upload"; "testdownload.tmp"; "/download/upload"];
2387 ["checksum"; "md5"; "/download/upload"]],
2388 Digest.to_hex (Digest.file "COPYING.LIB"))],
2389 "download a file to the local machine",
2391 Download file C<remotefilename> and save it as C<filename>
2392 on the local machine.
2394 C<filename> can also be a named pipe.
2396 See also C<guestfs_upload>, C<guestfs_cat>.");
2398 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2399 [InitISOFS, Always, TestOutput (
2400 [["checksum"; "crc"; "/known-3"]], "2891671662");
2401 InitISOFS, Always, TestLastFail (
2402 [["checksum"; "crc"; "/notexists"]]);
2403 InitISOFS, Always, TestOutput (
2404 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2405 InitISOFS, Always, TestOutput (
2406 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2407 InitISOFS, Always, TestOutput (
2408 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2409 InitISOFS, Always, TestOutput (
2410 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2411 InitISOFS, Always, TestOutput (
2412 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2413 InitISOFS, Always, TestOutput (
2414 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2415 (* Test for RHBZ#579608, absolute symbolic links. *)
2416 InitISOFS, Always, TestOutput (
2417 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2418 "compute MD5, SHAx or CRC checksum of file",
2420 This call computes the MD5, SHAx or CRC checksum of the
2423 The type of checksum to compute is given by the C<csumtype>
2424 parameter which must have one of the following values:
2430 Compute the cyclic redundancy check (CRC) specified by POSIX
2431 for the C<cksum> command.
2435 Compute the MD5 hash (using the C<md5sum> program).
2439 Compute the SHA1 hash (using the C<sha1sum> program).
2443 Compute the SHA224 hash (using the C<sha224sum> program).
2447 Compute the SHA256 hash (using the C<sha256sum> program).
2451 Compute the SHA384 hash (using the C<sha384sum> program).
2455 Compute the SHA512 hash (using the C<sha512sum> program).
2459 The checksum is returned as a printable string.
2461 To get the checksum for a device, use C<guestfs_checksum_device>.
2463 To get the checksums for many files, use C<guestfs_checksums_out>.");
2465 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2466 [InitScratchFS, Always, TestOutput (
2467 [["mkdir"; "/tar_in"];
2468 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2469 ["cat"; "/tar_in/hello"]], "hello\n")],
2470 "unpack tarfile to directory",
2472 This command uploads and unpacks local file C<tarfile> (an
2473 I<uncompressed> tar file) into C<directory>.
2475 To upload a compressed tarball, use C<guestfs_tgz_in>
2476 or C<guestfs_txz_in>.");
2478 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2480 "pack directory into tarfile",
2482 This command packs the contents of C<directory> and downloads
2483 it to local file C<tarfile>.
2485 To download a compressed tarball, use C<guestfs_tgz_out>
2486 or C<guestfs_txz_out>.");
2488 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2489 [InitScratchFS, Always, TestOutput (
2490 [["mkdir"; "/tgz_in"];
2491 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2492 ["cat"; "/tgz_in/hello"]], "hello\n")],
2493 "unpack compressed tarball to directory",
2495 This command uploads and unpacks local file C<tarball> (a
2496 I<gzip compressed> tar file) into C<directory>.
2498 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2500 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2502 "pack directory into compressed tarball",
2504 This command packs the contents of C<directory> and downloads
2505 it to local file C<tarball>.
2507 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2509 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2510 [InitBasicFS, Always, TestLastFail (
2512 ["mount_ro"; "/dev/sda1"; "/"];
2513 ["touch"; "/new"]]);
2514 InitBasicFS, Always, TestOutput (
2515 [["write"; "/new"; "data"];
2517 ["mount_ro"; "/dev/sda1"; "/"];
2518 ["cat"; "/new"]], "data")],
2519 "mount a guest disk, read-only",
2521 This is the same as the C<guestfs_mount> command, but it
2522 mounts the filesystem with the read-only (I<-o ro>) flag.");
2524 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2526 "mount a guest disk with mount options",
2528 This is the same as the C<guestfs_mount> command, but it
2529 allows you to set the mount options as for the
2530 L<mount(8)> I<-o> flag.
2532 If the C<options> parameter is an empty string, then
2533 no options are passed (all options default to whatever
2534 the filesystem uses).");
2536 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2538 "mount a guest disk with mount options and vfstype",
2540 This is the same as the C<guestfs_mount> command, but it
2541 allows you to set both the mount options and the vfstype
2542 as for the L<mount(8)> I<-o> and I<-t> flags.");
2544 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2546 "debugging and internals",
2548 The C<guestfs_debug> command exposes some internals of
2549 C<guestfsd> (the guestfs daemon) that runs inside the
2552 There is no comprehensive help for this command. You have
2553 to look at the file C<daemon/debug.c> in the libguestfs source
2554 to find out what you can do.");
2556 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2557 [InitEmpty, Always, TestOutputList (
2558 [["part_disk"; "/dev/sda"; "mbr"];
2559 ["pvcreate"; "/dev/sda1"];
2560 ["vgcreate"; "VG"; "/dev/sda1"];
2561 ["lvcreate"; "LV1"; "VG"; "50"];
2562 ["lvcreate"; "LV2"; "VG"; "50"];
2563 ["lvremove"; "/dev/VG/LV1"];
2564 ["lvs"]], ["/dev/VG/LV2"]);
2565 InitEmpty, Always, TestOutputList (
2566 [["part_disk"; "/dev/sda"; "mbr"];
2567 ["pvcreate"; "/dev/sda1"];
2568 ["vgcreate"; "VG"; "/dev/sda1"];
2569 ["lvcreate"; "LV1"; "VG"; "50"];
2570 ["lvcreate"; "LV2"; "VG"; "50"];
2571 ["lvremove"; "/dev/VG"];
2573 InitEmpty, Always, TestOutputList (
2574 [["part_disk"; "/dev/sda"; "mbr"];
2575 ["pvcreate"; "/dev/sda1"];
2576 ["vgcreate"; "VG"; "/dev/sda1"];
2577 ["lvcreate"; "LV1"; "VG"; "50"];
2578 ["lvcreate"; "LV2"; "VG"; "50"];
2579 ["lvremove"; "/dev/VG"];
2581 "remove an LVM logical volume",
2583 Remove an LVM logical volume C<device>, where C<device> is
2584 the path to the LV, such as C</dev/VG/LV>.
2586 You can also remove all LVs in a volume group by specifying
2587 the VG name, C</dev/VG>.");
2589 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2590 [InitEmpty, Always, TestOutputList (
2591 [["part_disk"; "/dev/sda"; "mbr"];
2592 ["pvcreate"; "/dev/sda1"];
2593 ["vgcreate"; "VG"; "/dev/sda1"];
2594 ["lvcreate"; "LV1"; "VG"; "50"];
2595 ["lvcreate"; "LV2"; "VG"; "50"];
2598 InitEmpty, Always, TestOutputList (
2599 [["part_disk"; "/dev/sda"; "mbr"];
2600 ["pvcreate"; "/dev/sda1"];
2601 ["vgcreate"; "VG"; "/dev/sda1"];
2602 ["lvcreate"; "LV1"; "VG"; "50"];
2603 ["lvcreate"; "LV2"; "VG"; "50"];
2606 "remove an LVM volume group",
2608 Remove an LVM volume group C<vgname>, (for example C<VG>).
2610 This also forcibly removes all logical volumes in the volume
2613 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2614 [InitEmpty, Always, TestOutputListOfDevices (
2615 [["part_disk"; "/dev/sda"; "mbr"];
2616 ["pvcreate"; "/dev/sda1"];
2617 ["vgcreate"; "VG"; "/dev/sda1"];
2618 ["lvcreate"; "LV1"; "VG"; "50"];
2619 ["lvcreate"; "LV2"; "VG"; "50"];
2621 ["pvremove"; "/dev/sda1"];
2623 InitEmpty, Always, TestOutputListOfDevices (
2624 [["part_disk"; "/dev/sda"; "mbr"];
2625 ["pvcreate"; "/dev/sda1"];
2626 ["vgcreate"; "VG"; "/dev/sda1"];
2627 ["lvcreate"; "LV1"; "VG"; "50"];
2628 ["lvcreate"; "LV2"; "VG"; "50"];
2630 ["pvremove"; "/dev/sda1"];
2632 InitEmpty, Always, TestOutputListOfDevices (
2633 [["part_disk"; "/dev/sda"; "mbr"];
2634 ["pvcreate"; "/dev/sda1"];
2635 ["vgcreate"; "VG"; "/dev/sda1"];
2636 ["lvcreate"; "LV1"; "VG"; "50"];
2637 ["lvcreate"; "LV2"; "VG"; "50"];
2639 ["pvremove"; "/dev/sda1"];
2641 "remove an LVM physical volume",
2643 This wipes a physical volume C<device> so that LVM will no longer
2646 The implementation uses the C<pvremove> command which refuses to
2647 wipe physical volumes that contain any volume groups, so you have
2648 to remove those first.");
2650 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2651 [InitBasicFS, Always, TestOutput (
2652 [["set_e2label"; "/dev/sda1"; "testlabel"];
2653 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2654 "set the ext2/3/4 filesystem label",
2656 This sets the ext2/3/4 filesystem label of the filesystem on
2657 C<device> to C<label>. Filesystem labels are limited to
2660 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2661 to return the existing label on a filesystem.");
2663 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2665 "get the ext2/3/4 filesystem label",
2667 This returns the ext2/3/4 filesystem label of the filesystem on
2670 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2671 (let uuid = uuidgen () in
2672 [InitBasicFS, Always, TestOutput (
2673 [["set_e2uuid"; "/dev/sda1"; uuid];
2674 ["get_e2uuid"; "/dev/sda1"]], uuid);
2675 InitBasicFS, Always, TestOutput (
2676 [["set_e2uuid"; "/dev/sda1"; "clear"];
2677 ["get_e2uuid"; "/dev/sda1"]], "");
2678 (* We can't predict what UUIDs will be, so just check the commands run. *)
2679 InitBasicFS, Always, TestRun (
2680 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2681 InitBasicFS, Always, TestRun (
2682 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2683 "set the ext2/3/4 filesystem UUID",
2685 This sets the ext2/3/4 filesystem UUID of the filesystem on
2686 C<device> to C<uuid>. The format of the UUID and alternatives
2687 such as C<clear>, C<random> and C<time> are described in the
2688 L<tune2fs(8)> manpage.
2690 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2691 to return the existing UUID of a filesystem.");
2693 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2694 (* Regression test for RHBZ#597112. *)
2695 (let uuid = uuidgen () in
2696 [InitNone, Always, TestOutput (
2697 [["mke2journal"; "1024"; "/dev/sdc"];
2698 ["set_e2uuid"; "/dev/sdc"; uuid];
2699 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2700 "get the ext2/3/4 filesystem UUID",
2702 This returns the ext2/3/4 filesystem UUID of the filesystem on
2705 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2706 [InitBasicFS, Always, TestOutputInt (
2707 [["umount"; "/dev/sda1"];
2708 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2709 InitBasicFS, Always, TestOutputInt (
2710 [["umount"; "/dev/sda1"];
2711 ["zero"; "/dev/sda1"];
2712 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2713 "run the filesystem checker",
2715 This runs the filesystem checker (fsck) on C<device> which
2716 should have filesystem type C<fstype>.
2718 The returned integer is the status. See L<fsck(8)> for the
2719 list of status codes from C<fsck>.
2727 Multiple status codes can be summed together.
2731 A non-zero return code can mean \"success\", for example if
2732 errors have been corrected on the filesystem.
2736 Checking or repairing NTFS volumes is not supported
2741 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2743 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2744 [InitBasicFS, Always, TestRun (
2745 [["umount"; "/dev/sda1"];
2746 ["zero"; "/dev/sda1"]])],
2747 "write zeroes to the device",
2749 This command writes zeroes over the first few blocks of C<device>.
2751 How many blocks are zeroed isn't specified (but it's I<not> enough
2752 to securely wipe the device). It should be sufficient to remove
2753 any partition tables, filesystem superblocks and so on.
2755 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2757 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2759 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2760 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2762 [InitBasicFS, Always, TestOutputTrue (
2763 [["mkdir_p"; "/boot/grub"];
2764 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2765 ["grub_install"; "/"; "/dev/vda"];
2766 ["is_dir"; "/boot"]])],
2769 This command installs GRUB (the Grand Unified Bootloader) on
2770 C<device>, with the root directory being C<root>.
2772 Note: If grub-install reports the error
2773 \"No suitable drive was found in the generated device map.\"
2774 it may be that you need to create a C</boot/grub/device.map>
2775 file first that contains the mapping between grub device names
2776 and Linux device names. It is usually sufficient to create
2781 replacing C</dev/vda> with the name of the installation device.");
2783 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2784 [InitScratchFS, Always, TestOutput (
2786 ["write"; "/cp/old"; "file content"];
2787 ["cp"; "/cp/old"; "/cp/new"];
2788 ["cat"; "/cp/new"]], "file content");
2789 InitScratchFS, Always, TestOutputTrue (
2791 ["write"; "/cp2/old"; "file content"];
2792 ["cp"; "/cp2/old"; "/cp2/new"];
2793 ["is_file"; "/cp2/old"]]);
2794 InitScratchFS, Always, TestOutput (
2796 ["write"; "/cp3/old"; "file content"];
2797 ["mkdir"; "/cp3/dir"];
2798 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2799 ["cat"; "/cp3/dir/new"]], "file content")],
2802 This copies a file from C<src> to C<dest> where C<dest> is
2803 either a destination filename or destination directory.");
2805 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2806 [InitScratchFS, Always, TestOutput (
2807 [["mkdir"; "/cp_a1"];
2808 ["mkdir"; "/cp_a2"];
2809 ["write"; "/cp_a1/file"; "file content"];
2810 ["cp_a"; "/cp_a1"; "/cp_a2"];
2811 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2812 "copy a file or directory recursively",
2814 This copies a file or directory from C<src> to C<dest>
2815 recursively using the C<cp -a> command.");
2817 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2818 [InitScratchFS, Always, TestOutput (
2820 ["write"; "/mv/old"; "file content"];
2821 ["mv"; "/mv/old"; "/mv/new"];
2822 ["cat"; "/mv/new"]], "file content");
2823 InitScratchFS, Always, TestOutputFalse (
2825 ["write"; "/mv2/old"; "file content"];
2826 ["mv"; "/mv2/old"; "/mv2/new"];
2827 ["is_file"; "/mv2/old"]])],
2830 This moves a file from C<src> to C<dest> where C<dest> is
2831 either a destination filename or destination directory.");
2833 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2834 [InitEmpty, Always, TestRun (
2835 [["drop_caches"; "3"]])],
2836 "drop kernel page cache, dentries and inodes",
2838 This instructs the guest kernel to drop its page cache,
2839 and/or dentries and inode caches. The parameter C<whattodrop>
2840 tells the kernel what precisely to drop, see
2841 L<http://linux-mm.org/Drop_Caches>
2843 Setting C<whattodrop> to 3 should drop everything.
2845 This automatically calls L<sync(2)> before the operation,
2846 so that the maximum guest memory is freed.");
2848 ("dmesg", (RString "kmsgs", [], []), 91, [],
2849 [InitEmpty, Always, TestRun (
2851 "return kernel messages",
2853 This returns the kernel messages (C<dmesg> output) from
2854 the guest kernel. This is sometimes useful for extended
2855 debugging of problems.
2857 Another way to get the same information is to enable
2858 verbose messages with C<guestfs_set_verbose> or by setting
2859 the environment variable C<LIBGUESTFS_DEBUG=1> before
2860 running the program.");
2862 ("ping_daemon", (RErr, [], []), 92, [],
2863 [InitEmpty, Always, TestRun (
2864 [["ping_daemon"]])],
2865 "ping the guest daemon",
2867 This is a test probe into the guestfs daemon running inside
2868 the qemu subprocess. Calling this function checks that the
2869 daemon responds to the ping message, without affecting the daemon
2870 or attached block device(s) in any other way.");
2872 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2873 [InitScratchFS, Always, TestOutputTrue (
2874 [["mkdir"; "/equal"];
2875 ["write"; "/equal/file1"; "contents of a file"];
2876 ["cp"; "/equal/file1"; "/equal/file2"];
2877 ["equal"; "/equal/file1"; "/equal/file2"]]);
2878 InitScratchFS, Always, TestOutputFalse (
2879 [["mkdir"; "/equal2"];
2880 ["write"; "/equal2/file1"; "contents of a file"];
2881 ["write"; "/equal2/file2"; "contents of another file"];
2882 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
2883 InitScratchFS, Always, TestLastFail (
2884 [["mkdir"; "/equal3"];
2885 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
2886 "test if two files have equal contents",
2888 This compares the two files C<file1> and C<file2> and returns
2889 true if their content is exactly equal, or false otherwise.
2891 The external L<cmp(1)> program is used for the comparison.");
2893 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2894 [InitISOFS, Always, TestOutputList (
2895 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2896 InitISOFS, Always, TestOutputList (
2897 [["strings"; "/empty"]], []);
2898 (* Test for RHBZ#579608, absolute symbolic links. *)
2899 InitISOFS, Always, TestRun (
2900 [["strings"; "/abssymlink"]])],
2901 "print the printable strings in a file",
2903 This runs the L<strings(1)> command on a file and returns
2904 the list of printable strings found.");
2906 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2907 [InitISOFS, Always, TestOutputList (
2908 [["strings_e"; "b"; "/known-5"]], []);
2909 InitScratchFS, Always, TestOutputList (
2910 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2911 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
2912 "print the printable strings in a file",
2914 This is like the C<guestfs_strings> command, but allows you to
2915 specify the encoding of strings that are looked for in
2916 the source file C<path>.
2918 Allowed encodings are:
2924 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2925 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2929 Single 8-bit-byte characters.
2933 16-bit big endian strings such as those encoded in
2934 UTF-16BE or UCS-2BE.
2936 =item l (lower case letter L)
2938 16-bit little endian such as UTF-16LE and UCS-2LE.
2939 This is useful for examining binaries in Windows guests.
2943 32-bit big endian such as UCS-4BE.
2947 32-bit little endian such as UCS-4LE.
2951 The returned strings are transcoded to UTF-8.");
2953 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
2954 [InitISOFS, Always, TestOutput (
2955 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2956 (* Test for RHBZ#501888c2 regression which caused large hexdump
2957 * commands to segfault.
2959 InitISOFS, Always, TestRun (
2960 [["hexdump"; "/100krandom"]]);
2961 (* Test for RHBZ#579608, absolute symbolic links. *)
2962 InitISOFS, Always, TestRun (
2963 [["hexdump"; "/abssymlink"]])],
2964 "dump a file in hexadecimal",
2966 This runs C<hexdump -C> on the given C<path>. The result is
2967 the human-readable, canonical hex dump of the file.");
2969 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
2970 [InitNone, Always, TestOutput (
2971 [["part_disk"; "/dev/sda"; "mbr"];
2972 ["mkfs"; "ext3"; "/dev/sda1"];
2973 ["mount_options"; ""; "/dev/sda1"; "/"];
2974 ["write"; "/new"; "test file"];
2975 ["umount"; "/dev/sda1"];
2976 ["zerofree"; "/dev/sda1"];
2977 ["mount_options"; ""; "/dev/sda1"; "/"];
2978 ["cat"; "/new"]], "test file")],
2979 "zero unused inodes and disk blocks on ext2/3 filesystem",
2981 This runs the I<zerofree> program on C<device>. This program
2982 claims to zero unused inodes and disk blocks on an ext2/3
2983 filesystem, thus making it possible to compress the filesystem
2986 You should B<not> run this program if the filesystem is
2989 It is possible that using this program can damage the filesystem
2990 or data on the filesystem.");
2992 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
2994 "resize an LVM physical volume",
2996 This resizes (expands or shrinks) an existing LVM physical
2997 volume to match the new size of the underlying device.");
2999 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3000 Int "cyls"; Int "heads"; Int "sectors";
3001 String "line"], []), 99, [DangerWillRobinson],
3003 "modify a single partition on a block device",
3005 This runs L<sfdisk(8)> option to modify just the single
3006 partition C<n> (note: C<n> counts from 1).
3008 For other parameters, see C<guestfs_sfdisk>. You should usually
3009 pass C<0> for the cyls/heads/sectors parameters.
3011 See also: C<guestfs_part_add>");
3013 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3015 "display the partition table",
3017 This displays the partition table on C<device>, in the
3018 human-readable output of the L<sfdisk(8)> command. It is
3019 not intended to be parsed.
3021 See also: C<guestfs_part_list>");
3023 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3025 "display the kernel geometry",
3027 This displays the kernel's idea of the geometry of C<device>.
3029 The result is in human-readable format, and not designed to
3032 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3034 "display the disk geometry from the partition table",
3036 This displays the disk geometry of C<device> read from the
3037 partition table. Especially in the case where the underlying
3038 block device has been resized, this can be different from the
3039 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3041 The result is in human-readable format, and not designed to
3044 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3046 "activate or deactivate all volume groups",
3048 This command activates or (if C<activate> is false) deactivates
3049 all logical volumes in all volume groups.
3050 If activated, then they are made known to the
3051 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3052 then those devices disappear.
3054 This command is the same as running C<vgchange -a y|n>");
3056 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3058 "activate or deactivate some volume groups",
3060 This command activates or (if C<activate> is false) deactivates
3061 all logical volumes in the listed volume groups C<volgroups>.
3062 If activated, then they are made known to the
3063 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3064 then those devices disappear.
3066 This command is the same as running C<vgchange -a y|n volgroups...>
3068 Note that if C<volgroups> is an empty list then B<all> volume groups
3069 are activated or deactivated.");
3071 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3072 [InitNone, Always, TestOutput (
3073 [["part_disk"; "/dev/sda"; "mbr"];
3074 ["pvcreate"; "/dev/sda1"];
3075 ["vgcreate"; "VG"; "/dev/sda1"];
3076 ["lvcreate"; "LV"; "VG"; "10"];
3077 ["mkfs"; "ext2"; "/dev/VG/LV"];
3078 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3079 ["write"; "/new"; "test content"];
3081 ["lvresize"; "/dev/VG/LV"; "20"];
3082 ["e2fsck_f"; "/dev/VG/LV"];
3083 ["resize2fs"; "/dev/VG/LV"];
3084 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3085 ["cat"; "/new"]], "test content");
3086 InitNone, Always, TestRun (
3087 (* Make an LV smaller to test RHBZ#587484. *)
3088 [["part_disk"; "/dev/sda"; "mbr"];
3089 ["pvcreate"; "/dev/sda1"];
3090 ["vgcreate"; "VG"; "/dev/sda1"];
3091 ["lvcreate"; "LV"; "VG"; "20"];
3092 ["lvresize"; "/dev/VG/LV"; "10"]])],
3093 "resize an LVM logical volume",
3095 This resizes (expands or shrinks) an existing LVM logical
3096 volume to C<mbytes>. When reducing, data in the reduced part
3099 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3100 [], (* lvresize tests this *)
3101 "resize an ext2, ext3 or ext4 filesystem",
3103 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3104 the underlying device.
3106 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3107 on the C<device> before calling this command. For unknown reasons
3108 C<resize2fs> sometimes gives an error about this and sometimes not.
3109 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3110 calling this function.");
3112 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3113 [InitBasicFS, Always, TestOutputList (
3114 [["find"; "/"]], ["lost+found"]);
3115 InitBasicFS, Always, TestOutputList (
3119 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3120 InitScratchFS, Always, TestOutputList (
3121 [["mkdir_p"; "/find/b/c"];
3122 ["touch"; "/find/b/c/d"];
3123 ["find"; "/find/b/"]], ["c"; "c/d"])],
3124 "find all files and directories",
3126 This command lists out all files and directories, recursively,
3127 starting at C<directory>. It is essentially equivalent to
3128 running the shell command C<find directory -print> but some
3129 post-processing happens on the output, described below.
3131 This returns a list of strings I<without any prefix>. Thus
3132 if the directory structure was:
3138 then the returned list from C<guestfs_find> C</tmp> would be
3146 If C<directory> is not a directory, then this command returns
3149 The returned list is sorted.
3151 See also C<guestfs_find0>.");
3153 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3154 [], (* lvresize tests this *)
3155 "check an ext2/ext3 filesystem",
3157 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3158 filesystem checker on C<device>, noninteractively (C<-p>),
3159 even if the filesystem appears to be clean (C<-f>).
3161 This command is only needed because of C<guestfs_resize2fs>
3162 (q.v.). Normally you should use C<guestfs_fsck>.");
3164 ("sleep", (RErr, [Int "secs"], []), 109, [],
3165 [InitNone, Always, TestRun (
3167 "sleep for some seconds",
3169 Sleep for C<secs> seconds.");
3171 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3172 [InitNone, Always, TestOutputInt (
3173 [["part_disk"; "/dev/sda"; "mbr"];
3174 ["mkfs"; "ntfs"; "/dev/sda1"];
3175 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3176 InitNone, Always, TestOutputInt (
3177 [["part_disk"; "/dev/sda"; "mbr"];
3178 ["mkfs"; "ext2"; "/dev/sda1"];
3179 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3180 "probe NTFS volume",
3182 This command runs the L<ntfs-3g.probe(8)> command which probes
3183 an NTFS C<device> for mountability. (Not all NTFS volumes can
3184 be mounted read-write, and some cannot be mounted at all).
3186 C<rw> is a boolean flag. Set it to true if you want to test
3187 if the volume can be mounted read-write. Set it to false if
3188 you want to test if the volume can be mounted read-only.
3190 The return value is an integer which C<0> if the operation
3191 would succeed, or some non-zero value documented in the
3192 L<ntfs-3g.probe(8)> manual page.");
3194 ("sh", (RString "output", [String "command"], []), 111, [],
3195 [], (* XXX needs tests *)
3196 "run a command via the shell",
3198 This call runs a command from the guest filesystem via the
3201 This is like C<guestfs_command>, but passes the command to:
3203 /bin/sh -c \"command\"
3205 Depending on the guest's shell, this usually results in
3206 wildcards being expanded, shell expressions being interpolated
3209 All the provisos about C<guestfs_command> apply to this call.");
3211 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3212 [], (* XXX needs tests *)
3213 "run a command via the shell returning lines",
3215 This is the same as C<guestfs_sh>, but splits the result
3216 into a list of lines.
3218 See also: C<guestfs_command_lines>");
3220 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3221 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3222 * code in stubs.c, since all valid glob patterns must start with "/".
3223 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3225 [InitScratchFS, Always, TestOutputList (
3226 [["mkdir_p"; "/glob_expand/b/c"];
3227 ["touch"; "/glob_expand/b/c/d"];
3228 ["touch"; "/glob_expand/b/c/e"];
3229 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3230 InitScratchFS, Always, TestOutputList (
3231 [["mkdir_p"; "/glob_expand2/b/c"];
3232 ["touch"; "/glob_expand2/b/c/d"];
3233 ["touch"; "/glob_expand2/b/c/e"];
3234 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3235 InitScratchFS, Always, TestOutputList (
3236 [["mkdir_p"; "/glob_expand3/b/c"];
3237 ["touch"; "/glob_expand3/b/c/d"];
3238 ["touch"; "/glob_expand3/b/c/e"];
3239 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3240 "expand a wildcard path",
3242 This command searches for all the pathnames matching
3243 C<pattern> according to the wildcard expansion rules
3246 If no paths match, then this returns an empty list
3247 (note: not an error).
3249 It is just a wrapper around the C L<glob(3)> function
3250 with flags C<GLOB_MARK|GLOB_BRACE>.
3251 See that manual page for more details.");
3253 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3254 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3255 [["scrub_device"; "/dev/sdc"]])],
3256 "scrub (securely wipe) a device",
3258 This command writes patterns over C<device> to make data retrieval
3261 It is an interface to the L<scrub(1)> program. See that
3262 manual page for more details.");
3264 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3265 [InitScratchFS, Always, TestRun (
3266 [["write"; "/scrub_file"; "content"];
3267 ["scrub_file"; "/scrub_file"]])],
3268 "scrub (securely wipe) a file",
3270 This command writes patterns over a file to make data retrieval
3273 The file is I<removed> after scrubbing.
3275 It is an interface to the L<scrub(1)> program. See that
3276 manual page for more details.");
3278 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3279 [], (* XXX needs testing *)
3280 "scrub (securely wipe) free space",
3282 This command creates the directory C<dir> and then fills it
3283 with files until the filesystem is full, and scrubs the files
3284 as for C<guestfs_scrub_file>, and deletes them.
3285 The intention is to scrub any free space on the partition
3288 It is an interface to the L<scrub(1)> program. See that
3289 manual page for more details.");
3291 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3292 [InitScratchFS, Always, TestRun (
3293 [["mkdir"; "/mkdtemp"];
3294 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3295 "create a temporary directory",
3297 This command creates a temporary directory. The
3298 C<template> parameter should be a full pathname for the
3299 temporary directory name with the final six characters being
3302 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3303 the second one being suitable for Windows filesystems.
3305 The name of the temporary directory that was created
3308 The temporary directory is created with mode 0700
3309 and is owned by root.
3311 The caller is responsible for deleting the temporary
3312 directory and its contents after use.
3314 See also: L<mkdtemp(3)>");
3316 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3317 [InitISOFS, Always, TestOutputInt (
3318 [["wc_l"; "/10klines"]], 10000);
3319 (* Test for RHBZ#579608, absolute symbolic links. *)
3320 InitISOFS, Always, TestOutputInt (
3321 [["wc_l"; "/abssymlink"]], 10000)],
3322 "count lines in a file",
3324 This command counts the lines in a file, using the
3325 C<wc -l> external command.");
3327 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3328 [InitISOFS, Always, TestOutputInt (
3329 [["wc_w"; "/10klines"]], 10000)],
3330 "count words in a file",
3332 This command counts the words in a file, using the
3333 C<wc -w> external command.");
3335 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3336 [InitISOFS, Always, TestOutputInt (
3337 [["wc_c"; "/100kallspaces"]], 102400)],
3338 "count characters in a file",
3340 This command counts the characters in a file, using the
3341 C<wc -c> external command.");
3343 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3344 [InitISOFS, Always, TestOutputList (
3345 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3346 (* Test for RHBZ#579608, absolute symbolic links. *)
3347 InitISOFS, Always, TestOutputList (
3348 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3349 "return first 10 lines of a file",
3351 This command returns up to the first 10 lines of a file as
3352 a list of strings.");
3354 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3355 [InitISOFS, Always, TestOutputList (
3356 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3357 InitISOFS, Always, TestOutputList (
3358 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3359 InitISOFS, Always, TestOutputList (
3360 [["head_n"; "0"; "/10klines"]], [])],
3361 "return first N lines of a file",
3363 If the parameter C<nrlines> is a positive number, this returns the first
3364 C<nrlines> lines of the file C<path>.
3366 If the parameter C<nrlines> is a negative number, this returns lines
3367 from the file C<path>, excluding the last C<nrlines> lines.
3369 If the parameter C<nrlines> is zero, this returns an empty list.");
3371 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3372 [InitISOFS, Always, TestOutputList (
3373 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3374 "return last 10 lines of a file",
3376 This command returns up to the last 10 lines of a file as
3377 a list of strings.");
3379 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3380 [InitISOFS, Always, TestOutputList (
3381 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3382 InitISOFS, Always, TestOutputList (
3383 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3384 InitISOFS, Always, TestOutputList (
3385 [["tail_n"; "0"; "/10klines"]], [])],
3386 "return last N lines of a file",
3388 If the parameter C<nrlines> is a positive number, this returns the last
3389 C<nrlines> lines of the file C<path>.
3391 If the parameter C<nrlines> is a negative number, this returns lines
3392 from the file C<path>, starting with the C<-nrlines>th line.
3394 If the parameter C<nrlines> is zero, this returns an empty list.");
3396 ("df", (RString "output", [], []), 125, [],
3397 [], (* XXX Tricky to test because it depends on the exact format
3398 * of the 'df' command and other imponderables.
3400 "report file system disk space usage",
3402 This command runs the C<df> command to report disk space used.
3404 This command is mostly useful for interactive sessions. It
3405 is I<not> intended that you try to parse the output string.
3406 Use C<guestfs_statvfs> from programs.");
3408 ("df_h", (RString "output", [], []), 126, [],
3409 [], (* XXX Tricky to test because it depends on the exact format
3410 * of the 'df' command and other imponderables.
3412 "report file system disk space usage (human readable)",
3414 This command runs the C<df -h> command to report disk space used
3415 in human-readable format.
3417 This command is mostly useful for interactive sessions. It
3418 is I<not> intended that you try to parse the output string.
3419 Use C<guestfs_statvfs> from programs.");
3421 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3422 [InitISOFS, Always, TestOutputInt (
3423 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3424 "estimate file space usage",
3426 This command runs the C<du -s> command to estimate file space
3429 C<path> can be a file or a directory. If C<path> is a directory
3430 then the estimate includes the contents of the directory and all
3431 subdirectories (recursively).
3433 The result is the estimated size in I<kilobytes>
3434 (ie. units of 1024 bytes).");
3436 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3437 [InitISOFS, Always, TestOutputList (
3438 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3439 "list files in an initrd",
3441 This command lists out files contained in an initrd.
3443 The files are listed without any initial C</> character. The
3444 files are listed in the order they appear (not necessarily
3445 alphabetical). Directory names are listed as separate items.
3447 Old Linux kernels (2.4 and earlier) used a compressed ext2
3448 filesystem as initrd. We I<only> support the newer initramfs
3449 format (compressed cpio files).");
3451 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3453 "mount a file using the loop device",
3455 This command lets you mount C<file> (a filesystem image
3456 in a file) on a mount point. It is entirely equivalent to
3457 the command C<mount -o loop file mountpoint>.");
3459 ("mkswap", (RErr, [Device "device"], []), 130, [],
3460 [InitEmpty, Always, TestRun (
3461 [["part_disk"; "/dev/sda"; "mbr"];
3462 ["mkswap"; "/dev/sda1"]])],
3463 "create a swap partition",
3465 Create a swap partition on C<device>.");
3467 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3468 [InitEmpty, Always, TestRun (
3469 [["part_disk"; "/dev/sda"; "mbr"];
3470 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3471 "create a swap partition with a label",
3473 Create a swap partition on C<device> with label C<label>.
3475 Note that you cannot attach a swap label to a block device
3476 (eg. C</dev/sda>), just to a partition. This appears to be
3477 a limitation of the kernel or swap tools.");
3479 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3480 (let uuid = uuidgen () in
3481 [InitEmpty, Always, TestRun (
3482 [["part_disk"; "/dev/sda"; "mbr"];
3483 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3484 "create a swap partition with an explicit UUID",
3486 Create a swap partition on C<device> with UUID C<uuid>.");
3488 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3489 [InitScratchFS, Always, TestOutputStruct (
3490 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3491 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3492 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3493 InitScratchFS, Always, TestOutputStruct (
3494 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3495 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3496 "make block, character or FIFO devices",
3498 This call creates block or character special devices, or
3499 named pipes (FIFOs).
3501 The C<mode> parameter should be the mode, using the standard
3502 constants. C<devmajor> and C<devminor> are the
3503 device major and minor numbers, only used when creating block
3504 and character special devices.
3506 Note that, just like L<mknod(2)>, the mode must be bitwise
3507 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3508 just creates a regular file). These constants are
3509 available in the standard Linux header files, or you can use
3510 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3511 which are wrappers around this command which bitwise OR
3512 in the appropriate constant for you.
3514 The mode actually set is affected by the umask.");
3516 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3517 [InitScratchFS, Always, TestOutputStruct (
3518 [["mkfifo"; "0o777"; "/mkfifo"];
3519 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3520 "make FIFO (named pipe)",
3522 This call creates a FIFO (named pipe) called C<path> with
3523 mode C<mode>. It is just a convenient wrapper around
3526 The mode actually set is affected by the umask.");
3528 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3529 [InitScratchFS, Always, TestOutputStruct (
3530 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3531 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3532 "make block device node",
3534 This call creates a block device node called C<path> with
3535 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3536 It is just a convenient wrapper around C<guestfs_mknod>.
3538 The mode actually set is affected by the umask.");
3540 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3541 [InitScratchFS, Always, TestOutputStruct (
3542 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3543 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3544 "make char device node",
3546 This call creates a char device node called C<path> with
3547 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3548 It is just a convenient wrapper around C<guestfs_mknod>.
3550 The mode actually set is affected by the umask.");
3552 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3553 [InitEmpty, Always, TestOutputInt (
3554 [["umask"; "0o22"]], 0o22)],
3555 "set file mode creation mask (umask)",
3557 This function sets the mask used for creating new files and
3558 device nodes to C<mask & 0777>.
3560 Typical umask values would be C<022> which creates new files
3561 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3562 C<002> which creates new files with permissions like
3563 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3565 The default umask is C<022>. This is important because it
3566 means that directories and device nodes will be created with
3567 C<0644> or C<0755> mode even if you specify C<0777>.
3569 See also C<guestfs_get_umask>,
3570 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3572 This call returns the previous umask.");
3574 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3576 "read directories entries",
3578 This returns the list of directory entries in directory C<dir>.
3580 All entries in the directory are returned, including C<.> and
3581 C<..>. The entries are I<not> sorted, but returned in the same
3582 order as the underlying filesystem.
3584 Also this call returns basic file type information about each
3585 file. The C<ftyp> field will contain one of the following characters:
3623 The L<readdir(3)> call returned a C<d_type> field with an
3628 This function is primarily intended for use by programs. To
3629 get a simple list of names, use C<guestfs_ls>. To get a printable
3630 directory for human consumption, use C<guestfs_ll>.");
3632 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3634 "create partitions on a block device",
3636 This is a simplified interface to the C<guestfs_sfdisk>
3637 command, where partition sizes are specified in megabytes
3638 only (rounded to the nearest cylinder) and you don't need
3639 to specify the cyls, heads and sectors parameters which
3640 were rarely if ever used anyway.
3642 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3643 and C<guestfs_part_disk>");
3645 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3647 "determine file type inside a compressed file",
3649 This command runs C<file> after first decompressing C<path>
3652 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3654 Since 1.0.63, use C<guestfs_file> instead which can now
3655 process compressed files.");
3657 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3659 "list extended attributes of a file or directory",
3661 This call lists the extended attributes of the file or directory
3664 At the system call level, this is a combination of the
3665 L<listxattr(2)> and L<getxattr(2)> calls.
3667 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3669 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3671 "list extended attributes of a file or directory",
3673 This is the same as C<guestfs_getxattrs>, but if C<path>
3674 is a symbolic link, then it returns the extended attributes
3675 of the link itself.");
3677 ("setxattr", (RErr, [String "xattr";
3678 String "val"; Int "vallen"; (* will be BufferIn *)
3679 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3681 "set extended attribute of a file or directory",
3683 This call sets the extended attribute named C<xattr>
3684 of the file C<path> to the value C<val> (of length C<vallen>).
3685 The value is arbitrary 8 bit data.
3687 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3689 ("lsetxattr", (RErr, [String "xattr";
3690 String "val"; Int "vallen"; (* will be BufferIn *)
3691 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3693 "set extended attribute of a file or directory",
3695 This is the same as C<guestfs_setxattr>, but if C<path>
3696 is a symbolic link, then it sets an extended attribute
3697 of the link itself.");
3699 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3701 "remove extended attribute of a file or directory",
3703 This call removes the extended attribute named C<xattr>
3704 of the file C<path>.
3706 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3708 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3710 "remove extended attribute of a file or directory",
3712 This is the same as C<guestfs_removexattr>, but if C<path>
3713 is a symbolic link, then it removes an extended attribute
3714 of the link itself.");
3716 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3720 This call is similar to C<guestfs_mounts>. That call returns
3721 a list of devices. This one returns a hash table (map) of
3722 device name to directory where the device is mounted.");
3724 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3725 (* This is a special case: while you would expect a parameter
3726 * of type "Pathname", that doesn't work, because it implies
3727 * NEED_ROOT in the generated calling code in stubs.c, and
3728 * this function cannot use NEED_ROOT.
3731 "create a mountpoint",
3733 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3734 specialized calls that can be used to create extra mountpoints
3735 before mounting the first filesystem.
3737 These calls are I<only> necessary in some very limited circumstances,
3738 mainly the case where you want to mount a mix of unrelated and/or
3739 read-only filesystems together.
3741 For example, live CDs often contain a \"Russian doll\" nest of
3742 filesystems, an ISO outer layer, with a squashfs image inside, with
3743 an ext2/3 image inside that. You can unpack this as follows
3746 add-ro Fedora-11-i686-Live.iso
3750 mkmountpoint /ext3fs
3752 mount-loop /cd/LiveOS/squashfs.img /sqsh
3753 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3755 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3757 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3758 You may get unexpected errors if you try to mix these calls. It is
3759 safest to manually unmount filesystems and remove mountpoints after use.
3761 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3762 longest first, so for this to work for manual mountpoints, you
3763 must ensure that the innermost mountpoints have the longest
3764 pathnames, as in the example code above.
3766 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3768 Autosync [see C<guestfs_set_autosync>, this is set by default on
3769 handles] means that C<guestfs_umount_all> is called when the handle
3770 is closed which can also trigger these issues.");
3772 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3774 "remove a mountpoint",
3776 This calls removes a mountpoint that was previously created
3777 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3778 for full details.");
3780 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3781 [InitISOFS, Always, TestOutputBuffer (
3782 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3783 (* Test various near large, large and too large files (RHBZ#589039). *)
3784 InitScratchFS, Always, TestLastFail (
3785 [["touch"; "/read_file"];
3786 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3787 ["read_file"; "/read_file"]]);
3788 InitScratchFS, Always, TestLastFail (
3789 [["touch"; "/read_file2"];
3790 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3791 ["read_file"; "/read_file2"]]);
3792 InitScratchFS, Always, TestLastFail (
3793 [["touch"; "/read_file3"];
3794 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3795 ["read_file"; "/read_file3"]])],
3798 This calls returns the contents of the file C<path> as a
3801 Unlike C<guestfs_cat>, this function can correctly
3802 handle files that contain embedded ASCII NUL characters.
3803 However unlike C<guestfs_download>, this function is limited
3804 in the total size of file that can be handled.");
3806 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3807 [InitISOFS, Always, TestOutputList (
3808 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3809 InitISOFS, Always, TestOutputList (
3810 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3811 (* Test for RHBZ#579608, absolute symbolic links. *)
3812 InitISOFS, Always, TestOutputList (
3813 [["grep"; "nomatch"; "/abssymlink"]], [])],
3814 "return lines matching a pattern",
3816 This calls the external C<grep> program and returns the
3819 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3820 [InitISOFS, Always, TestOutputList (
3821 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3822 "return lines matching a pattern",
3824 This calls the external C<egrep> program and returns the
3827 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3828 [InitISOFS, Always, TestOutputList (
3829 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3830 "return lines matching a pattern",
3832 This calls the external C<fgrep> program and returns the
3835 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3836 [InitISOFS, Always, TestOutputList (
3837 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3838 "return lines matching a pattern",
3840 This calls the external C<grep -i> program and returns the
3843 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3844 [InitISOFS, Always, TestOutputList (
3845 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3846 "return lines matching a pattern",
3848 This calls the external C<egrep -i> program and returns the
3851 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3852 [InitISOFS, Always, TestOutputList (
3853 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3854 "return lines matching a pattern",
3856 This calls the external C<fgrep -i> program and returns the
3859 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3860 [InitISOFS, Always, TestOutputList (
3861 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3862 "return lines matching a pattern",
3864 This calls the external C<zgrep> program and returns the
3867 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3868 [InitISOFS, Always, TestOutputList (
3869 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3870 "return lines matching a pattern",
3872 This calls the external C<zegrep> program and returns the
3875 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3876 [InitISOFS, Always, TestOutputList (
3877 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3878 "return lines matching a pattern",
3880 This calls the external C<zfgrep> program and returns the
3883 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3884 [InitISOFS, Always, TestOutputList (
3885 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3886 "return lines matching a pattern",
3888 This calls the external C<zgrep -i> program and returns the
3891 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3892 [InitISOFS, Always, TestOutputList (
3893 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3894 "return lines matching a pattern",
3896 This calls the external C<zegrep -i> program and returns the
3899 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3900 [InitISOFS, Always, TestOutputList (
3901 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3902 "return lines matching a pattern",
3904 This calls the external C<zfgrep -i> program and returns the
3907 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3908 [InitISOFS, Always, TestOutput (
3909 [["realpath"; "/../directory"]], "/directory")],
3910 "canonicalized absolute pathname",
3912 Return the canonicalized absolute pathname of C<path>. The
3913 returned path has no C<.>, C<..> or symbolic link path elements.");
3915 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3916 [InitScratchFS, Always, TestOutputStruct (
3919 ["ln"; "/ln/a"; "/ln/b"];
3920 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
3921 "create a hard link",
3923 This command creates a hard link using the C<ln> command.");
3925 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
3926 [InitScratchFS, Always, TestOutputStruct (
3927 [["mkdir"; "/ln_f"];
3928 ["touch"; "/ln_f/a"];
3929 ["touch"; "/ln_f/b"];
3930 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
3931 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
3932 "create a hard link",
3934 This command creates a hard link using the C<ln -f> command.
3935 The C<-f> option removes the link (C<linkname>) if it exists already.");
3937 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
3938 [InitScratchFS, Always, TestOutputStruct (
3939 [["mkdir"; "/ln_s"];
3940 ["touch"; "/ln_s/a"];
3941 ["ln_s"; "a"; "/ln_s/b"];
3942 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
3943 "create a symbolic link",
3945 This command creates a symbolic link using the C<ln -s> command.");
3947 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
3948 [InitScratchFS, Always, TestOutput (
3949 [["mkdir_p"; "/ln_sf/b"];
3950 ["touch"; "/ln_sf/b/c"];
3951 ["ln_sf"; "../d"; "/ln_sf/b/c"];
3952 ["readlink"; "/ln_sf/b/c"]], "../d")],
3953 "create a symbolic link",
3955 This command creates a symbolic link using the C<ln -sf> command,
3956 The C<-f> option removes the link (C<linkname>) if it exists already.");
3958 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
3959 [] (* XXX tested above *),
3960 "read the target of a symbolic link",
3962 This command reads the target of a symbolic link.");
3964 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
3965 [InitScratchFS, Always, TestOutputStruct (
3966 [["fallocate"; "/fallocate"; "1000000"];
3967 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
3968 "preallocate a file in the guest filesystem",
3970 This command preallocates a file (containing zero bytes) named
3971 C<path> of size C<len> bytes. If the file exists already, it
3974 Do not confuse this with the guestfish-specific
3975 C<alloc> command which allocates a file in the host and
3976 attaches it as a device.");
3978 ("swapon_device", (RErr, [Device "device"], []), 170, [],
3979 [InitPartition, Always, TestRun (
3980 [["mkswap"; "/dev/sda1"];
3981 ["swapon_device"; "/dev/sda1"];
3982 ["swapoff_device"; "/dev/sda1"]])],
3983 "enable swap on device",
3985 This command enables the libguestfs appliance to use the
3986 swap device or partition named C<device>. The increased
3987 memory is made available for all commands, for example
3988 those run using C<guestfs_command> or C<guestfs_sh>.
3990 Note that you should not swap to existing guest swap
3991 partitions unless you know what you are doing. They may
3992 contain hibernation information, or other information that
3993 the guest doesn't want you to trash. You also risk leaking
3994 information about the host to the guest this way. Instead,
3995 attach a new host device to the guest and swap on that.");
3997 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
3998 [], (* XXX tested by swapon_device *)
3999 "disable swap on device",
4001 This command disables the libguestfs appliance swap
4002 device or partition named C<device>.
4003 See C<guestfs_swapon_device>.");
4005 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4006 [InitScratchFS, Always, TestRun (
4007 [["fallocate"; "/swapon_file"; "8388608"];
4008 ["mkswap_file"; "/swapon_file"];
4009 ["swapon_file"; "/swapon_file"];
4010 ["swapoff_file"; "/swapon_file"];
4011 ["rm"; "/swapon_file"]])],
4012 "enable swap on file",
4014 This command enables swap to a file.
4015 See C<guestfs_swapon_device> for other notes.");
4017 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4018 [], (* XXX tested by swapon_file *)
4019 "disable swap on file",
4021 This command disables the libguestfs appliance swap on file.");
4023 ("swapon_label", (RErr, [String "label"], []), 174, [],
4024 [InitEmpty, Always, TestRun (
4025 [["part_disk"; "/dev/sda"; "mbr"];
4026 ["mkswap_L"; "swapit"; "/dev/sda1"];
4027 ["swapon_label"; "swapit"];
4028 ["swapoff_label"; "swapit"];
4029 ["zero"; "/dev/sda"];
4030 ["blockdev_rereadpt"; "/dev/sda"]])],
4031 "enable swap on labeled swap partition",
4033 This command enables swap to a labeled swap partition.
4034 See C<guestfs_swapon_device> for other notes.");
4036 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4037 [], (* XXX tested by swapon_label *)
4038 "disable swap on labeled swap partition",
4040 This command disables the libguestfs appliance swap on
4041 labeled swap partition.");
4043 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4044 (let uuid = uuidgen () in
4045 [InitEmpty, Always, TestRun (
4046 [["mkswap_U"; uuid; "/dev/sdc"];
4047 ["swapon_uuid"; uuid];
4048 ["swapoff_uuid"; uuid]])]),
4049 "enable swap on swap partition by UUID",
4051 This command enables swap to a swap partition with the given UUID.
4052 See C<guestfs_swapon_device> for other notes.");
4054 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4055 [], (* XXX tested by swapon_uuid *)
4056 "disable swap on swap partition by UUID",
4058 This command disables the libguestfs appliance swap partition
4059 with the given UUID.");
4061 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4062 [InitScratchFS, Always, TestRun (
4063 [["fallocate"; "/mkswap_file"; "8388608"];
4064 ["mkswap_file"; "/mkswap_file"];
4065 ["rm"; "/mkswap_file"]])],
4066 "create a swap file",
4070 This command just writes a swap file signature to an existing
4071 file. To create the file itself, use something like C<guestfs_fallocate>.");
4073 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4074 [InitISOFS, Always, TestRun (
4075 [["inotify_init"; "0"]])],
4076 "create an inotify handle",
4078 This command creates a new inotify handle.
4079 The inotify subsystem can be used to notify events which happen to
4080 objects in the guest filesystem.
4082 C<maxevents> is the maximum number of events which will be
4083 queued up between calls to C<guestfs_inotify_read> or
4084 C<guestfs_inotify_files>.
4085 If this is passed as C<0>, then the kernel (or previously set)
4086 default is used. For Linux 2.6.29 the default was 16384 events.
4087 Beyond this limit, the kernel throws away events, but records
4088 the fact that it threw them away by setting a flag
4089 C<IN_Q_OVERFLOW> in the returned structure list (see
4090 C<guestfs_inotify_read>).
4092 Before any events are generated, you have to add some
4093 watches to the internal watch list. See:
4094 C<guestfs_inotify_add_watch>,
4095 C<guestfs_inotify_rm_watch> and
4096 C<guestfs_inotify_watch_all>.
4098 Queued up events should be read periodically by calling
4099 C<guestfs_inotify_read>
4100 (or C<guestfs_inotify_files> which is just a helpful
4101 wrapper around C<guestfs_inotify_read>). If you don't
4102 read the events out often enough then you risk the internal
4105 The handle should be closed after use by calling
4106 C<guestfs_inotify_close>. This also removes any
4107 watches automatically.
4109 See also L<inotify(7)> for an overview of the inotify interface
4110 as exposed by the Linux kernel, which is roughly what we expose
4111 via libguestfs. Note that there is one global inotify handle
4112 per libguestfs instance.");
4114 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4115 [InitScratchFS, Always, TestOutputList (
4116 [["mkdir"; "/inotify_add_watch"];
4117 ["inotify_init"; "0"];
4118 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4119 ["touch"; "/inotify_add_watch/a"];
4120 ["touch"; "/inotify_add_watch/b"];
4121 ["inotify_files"]], ["a"; "b"])],
4122 "add an inotify watch",
4124 Watch C<path> for the events listed in C<mask>.
4126 Note that if C<path> is a directory then events within that
4127 directory are watched, but this does I<not> happen recursively
4128 (in subdirectories).
4130 Note for non-C or non-Linux callers: the inotify events are
4131 defined by the Linux kernel ABI and are listed in
4132 C</usr/include/sys/inotify.h>.");
4134 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4136 "remove an inotify watch",
4138 Remove a previously defined inotify watch.
4139 See C<guestfs_inotify_add_watch>.");
4141 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4143 "return list of inotify events",
4145 Return the complete queue of events that have happened
4146 since the previous read call.
4148 If no events have happened, this returns an empty list.
4150 I<Note>: In order to make sure that all events have been
4151 read, you must call this function repeatedly until it
4152 returns an empty list. The reason is that the call will
4153 read events up to the maximum appliance-to-host message
4154 size and leave remaining events in the queue.");
4156 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4158 "return list of watched files that had events",
4160 This function is a helpful wrapper around C<guestfs_inotify_read>
4161 which just returns a list of pathnames of objects that were
4162 touched. The returned pathnames are sorted and deduplicated.");
4164 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4166 "close the inotify handle",
4168 This closes the inotify handle which was previously
4169 opened by inotify_init. It removes all watches, throws
4170 away any pending events, and deallocates all resources.");
4172 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4174 "set SELinux security context",
4176 This sets the SELinux security context of the daemon
4177 to the string C<context>.
4179 See the documentation about SELINUX in L<guestfs(3)>.");
4181 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4183 "get SELinux security context",
4185 This gets the SELinux security context of the daemon.
4187 See the documentation about SELINUX in L<guestfs(3)>,
4188 and C<guestfs_setcon>");
4190 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4191 [InitEmpty, Always, TestOutput (
4192 [["part_disk"; "/dev/sda"; "mbr"];
4193 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4194 ["mount_options"; ""; "/dev/sda1"; "/"];
4195 ["write"; "/new"; "new file contents"];
4196 ["cat"; "/new"]], "new file contents");
4197 InitEmpty, Always, TestRun (
4198 [["part_disk"; "/dev/sda"; "mbr"];
4199 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4200 InitEmpty, Always, TestLastFail (
4201 [["part_disk"; "/dev/sda"; "mbr"];
4202 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4203 InitEmpty, Always, TestLastFail (
4204 [["part_disk"; "/dev/sda"; "mbr"];
4205 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4206 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4207 [["part_disk"; "/dev/sda"; "mbr"];
4208 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4209 "make a filesystem with block size",
4211 This call is similar to C<guestfs_mkfs>, but it allows you to
4212 control the block size of the resulting filesystem. Supported
4213 block sizes depend on the filesystem type, but typically they
4214 are C<1024>, C<2048> or C<4096> only.
4216 For VFAT and NTFS the C<blocksize> parameter is treated as
4217 the requested cluster size.");
4219 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4220 [InitEmpty, Always, TestOutput (
4221 [["part_init"; "/dev/sda"; "mbr"];
4222 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4223 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4224 ["mke2journal"; "4096"; "/dev/sda1"];
4225 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4226 ["mount_options"; ""; "/dev/sda2"; "/"];
4227 ["write"; "/new"; "new file contents"];
4228 ["cat"; "/new"]], "new file contents")],
4229 "make ext2/3/4 external journal",
4231 This creates an ext2 external journal on C<device>. It is equivalent
4234 mke2fs -O journal_dev -b blocksize device");
4236 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4237 [InitEmpty, Always, TestOutput (
4238 [["part_init"; "/dev/sda"; "mbr"];
4239 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4240 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4241 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4242 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4243 ["mount_options"; ""; "/dev/sda2"; "/"];
4244 ["write"; "/new"; "new file contents"];
4245 ["cat"; "/new"]], "new file contents")],
4246 "make ext2/3/4 external journal with label",
4248 This creates an ext2 external journal on C<device> with label C<label>.");
4250 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4251 (let uuid = uuidgen () in
4252 [InitEmpty, Always, TestOutput (
4253 [["part_init"; "/dev/sda"; "mbr"];
4254 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4255 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4256 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4257 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4258 ["mount_options"; ""; "/dev/sda2"; "/"];
4259 ["write"; "/new"; "new file contents"];
4260 ["cat"; "/new"]], "new file contents")]),
4261 "make ext2/3/4 external journal with UUID",
4263 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4265 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4267 "make ext2/3/4 filesystem with external journal",
4269 This creates an ext2/3/4 filesystem on C<device> with
4270 an external journal on C<journal>. It is equivalent
4273 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4275 See also C<guestfs_mke2journal>.");
4277 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4279 "make ext2/3/4 filesystem with external journal",
4281 This creates an ext2/3/4 filesystem on C<device> with
4282 an external journal on the journal labeled C<label>.
4284 See also C<guestfs_mke2journal_L>.");
4286 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4288 "make ext2/3/4 filesystem with external journal",
4290 This creates an ext2/3/4 filesystem on C<device> with
4291 an external journal on the journal with UUID C<uuid>.
4293 See also C<guestfs_mke2journal_U>.");
4295 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4296 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4297 "load a kernel module",
4299 This loads a kernel module in the appliance.
4301 The kernel module must have been whitelisted when libguestfs
4302 was built (see C<appliance/kmod.whitelist.in> in the source).");
4304 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4305 [InitNone, Always, TestOutput (
4306 [["echo_daemon"; "This is a test"]], "This is a test"
4308 "echo arguments back to the client",
4310 This command concatenates the list of C<words> passed with single spaces
4311 between them and returns the resulting string.
4313 You can use this command to test the connection through to the daemon.
4315 See also C<guestfs_ping_daemon>.");
4317 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4318 [], (* There is a regression test for this. *)
4319 "find all files and directories, returning NUL-separated list",
4321 This command lists out all files and directories, recursively,
4322 starting at C<directory>, placing the resulting list in the
4323 external file called C<files>.
4325 This command works the same way as C<guestfs_find> with the
4326 following exceptions:
4332 The resulting list is written to an external file.
4336 Items (filenames) in the result are separated
4337 by C<\\0> characters. See L<find(1)> option I<-print0>.
4341 This command is not limited in the number of names that it
4346 The result list is not sorted.
4350 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4351 [InitISOFS, Always, TestOutput (
4352 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4353 InitISOFS, Always, TestOutput (
4354 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4355 InitISOFS, Always, TestOutput (
4356 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4357 InitISOFS, Always, TestLastFail (
4358 [["case_sensitive_path"; "/Known-1/"]]);
4359 InitScratchFS, Always, TestOutput (
4360 [["mkdir"; "/case_sensitive_path"];
4361 ["mkdir"; "/case_sensitive_path/bbb"];
4362 ["touch"; "/case_sensitive_path/bbb/c"];
4363 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4364 InitScratchFS, Always, TestOutput (
4365 [["mkdir"; "/case_sensitive_path2"];
4366 ["mkdir"; "/case_sensitive_path2/bbb"];
4367 ["touch"; "/case_sensitive_path2/bbb/c"];
4368 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4369 InitScratchFS, Always, TestLastFail (
4370 [["mkdir"; "/case_sensitive_path3"];
4371 ["mkdir"; "/case_sensitive_path3/bbb"];
4372 ["touch"; "/case_sensitive_path3/bbb/c"];
4373 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4374 "return true path on case-insensitive filesystem",
4376 This can be used to resolve case insensitive paths on
4377 a filesystem which is case sensitive. The use case is
4378 to resolve paths which you have read from Windows configuration
4379 files or the Windows Registry, to the true path.
4381 The command handles a peculiarity of the Linux ntfs-3g
4382 filesystem driver (and probably others), which is that although
4383 the underlying filesystem is case-insensitive, the driver
4384 exports the filesystem to Linux as case-sensitive.
4386 One consequence of this is that special directories such
4387 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4388 (or other things) depending on the precise details of how
4389 they were created. In Windows itself this would not be
4392 Bug or feature? You decide:
4393 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4395 This function resolves the true case of each element in the
4396 path and returns the case-sensitive path.
4398 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4399 might return C<\"/WINDOWS/system32\"> (the exact return value
4400 would depend on details of how the directories were originally
4401 created under Windows).
4404 This function does not handle drive names, backslashes etc.
4406 See also C<guestfs_realpath>.");
4408 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4409 [InitScratchFS, Always, TestOutput (
4410 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4411 "get the Linux VFS type corresponding to a mounted device",
4413 This command gets the filesystem type corresponding to
4414 the filesystem on C<device>.
4416 For most filesystems, the result is the name of the Linux
4417 VFS module which would be used to mount this filesystem
4418 if you mounted it without specifying the filesystem type.
4419 For example a string such as C<ext3> or C<ntfs>.");
4421 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4422 [InitScratchFS, Always, TestOutputStruct (
4423 [["write"; "/truncate"; "some stuff so size is not zero"];
4424 ["truncate"; "/truncate"];
4425 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4426 "truncate a file to zero size",
4428 This command truncates C<path> to a zero-length file. The
4429 file must exist already.");
4431 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4432 [InitScratchFS, Always, TestOutputStruct (
4433 [["touch"; "/truncate_size"];
4434 ["truncate_size"; "/truncate_size"; "1000"];
4435 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4436 "truncate a file to a particular size",
4438 This command truncates C<path> to size C<size> bytes. The file
4441 If the current file size is less than C<size> then
4442 the file is extended to the required size with zero bytes.
4443 This creates a sparse file (ie. disk blocks are not allocated
4444 for the file until you write to it). To create a non-sparse
4445 file of zeroes, use C<guestfs_fallocate64> instead.");
4447 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4448 [InitScratchFS, Always, TestOutputStruct (
4449 [["touch"; "/utimens"];
4450 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4451 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4452 "set timestamp of a file with nanosecond precision",
4454 This command sets the timestamps of a file with nanosecond
4457 C<atsecs, atnsecs> are the last access time (atime) in secs and
4458 nanoseconds from the epoch.
4460 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4461 secs and nanoseconds from the epoch.
4463 If the C<*nsecs> field contains the special value C<-1> then
4464 the corresponding timestamp is set to the current time. (The
4465 C<*secs> field is ignored in this case).
4467 If the C<*nsecs> field contains the special value C<-2> then
4468 the corresponding timestamp is left unchanged. (The
4469 C<*secs> field is ignored in this case).");
4471 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4472 [InitScratchFS, Always, TestOutputStruct (
4473 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4474 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4475 "create a directory with a particular mode",
4477 This command creates a directory, setting the initial permissions
4478 of the directory to C<mode>.
4480 For common Linux filesystems, the actual mode which is set will
4481 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4482 interpret the mode in other ways.
4484 See also C<guestfs_mkdir>, C<guestfs_umask>");
4486 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4488 "change file owner and group",
4490 Change the file owner to C<owner> and group to C<group>.
4491 This is like C<guestfs_chown> but if C<path> is a symlink then
4492 the link itself is changed, not the target.
4494 Only numeric uid and gid are supported. If you want to use
4495 names, you will need to locate and parse the password file
4496 yourself (Augeas support makes this relatively easy).");
4498 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4500 "lstat on multiple files",
4502 This call allows you to perform the C<guestfs_lstat> operation
4503 on multiple files, where all files are in the directory C<path>.
4504 C<names> is the list of files from this directory.
4506 On return you get a list of stat structs, with a one-to-one
4507 correspondence to the C<names> list. If any name did not exist
4508 or could not be lstat'd, then the C<ino> field of that structure
4511 This call is intended for programs that want to efficiently
4512 list a directory contents without making many round-trips.
4513 See also C<guestfs_lxattrlist> for a similarly efficient call
4514 for getting extended attributes. Very long directory listings
4515 might cause the protocol message size to be exceeded, causing
4516 this call to fail. The caller must split up such requests
4517 into smaller groups of names.");
4519 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4521 "lgetxattr on multiple files",
4523 This call allows you to get the extended attributes
4524 of multiple files, where all files are in the directory C<path>.
4525 C<names> is the list of files from this directory.
4527 On return you get a flat list of xattr structs which must be
4528 interpreted sequentially. The first xattr struct always has a zero-length
4529 C<attrname>. C<attrval> in this struct is zero-length
4530 to indicate there was an error doing C<lgetxattr> for this
4531 file, I<or> is a C string which is a decimal number
4532 (the number of following attributes for this file, which could
4533 be C<\"0\">). Then after the first xattr struct are the
4534 zero or more attributes for the first named file.
4535 This repeats for the second and subsequent files.
4537 This call is intended for programs that want to efficiently
4538 list a directory contents without making many round-trips.
4539 See also C<guestfs_lstatlist> for a similarly efficient call
4540 for getting standard stats. Very long directory listings
4541 might cause the protocol message size to be exceeded, causing
4542 this call to fail. The caller must split up such requests
4543 into smaller groups of names.");
4545 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4547 "readlink on multiple files",
4549 This call allows you to do a C<readlink> operation
4550 on multiple files, where all files are in the directory C<path>.
4551 C<names> is the list of files from this directory.
4553 On return you get a list of strings, with a one-to-one
4554 correspondence to the C<names> list. Each string is the
4555 value of the symbolic link.
4557 If the C<readlink(2)> operation fails on any name, then
4558 the corresponding result string is the empty string C<\"\">.
4559 However the whole operation is completed even if there
4560 were C<readlink(2)> errors, and so you can call this
4561 function with names where you don't know if they are
4562 symbolic links already (albeit slightly less efficient).
4564 This call is intended for programs that want to efficiently
4565 list a directory contents without making many round-trips.
4566 Very long directory listings might cause the protocol
4567 message size to be exceeded, causing
4568 this call to fail. The caller must split up such requests
4569 into smaller groups of names.");
4571 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4572 [InitISOFS, Always, TestOutputBuffer (
4573 [["pread"; "/known-4"; "1"; "3"]], "\n");
4574 InitISOFS, Always, TestOutputBuffer (
4575 [["pread"; "/empty"; "0"; "100"]], "")],
4576 "read part of a file",
4578 This command lets you read part of a file. It reads C<count>
4579 bytes of the file, starting at C<offset>, from file C<path>.
4581 This may read fewer bytes than requested. For further details
4582 see the L<pread(2)> system call.
4584 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4586 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4587 [InitEmpty, Always, TestRun (
4588 [["part_init"; "/dev/sda"; "gpt"]])],
4589 "create an empty partition table",
4591 This creates an empty partition table on C<device> of one of the
4592 partition types listed below. Usually C<parttype> should be
4593 either C<msdos> or C<gpt> (for large disks).
4595 Initially there are no partitions. Following this, you should
4596 call C<guestfs_part_add> for each partition required.
4598 Possible values for C<parttype> are:
4602 =item B<efi> | B<gpt>
4604 Intel EFI / GPT partition table.
4606 This is recommended for >= 2 TB partitions that will be accessed
4607 from Linux and Intel-based Mac OS X. It also has limited backwards
4608 compatibility with the C<mbr> format.
4610 =item B<mbr> | B<msdos>
4612 The standard PC \"Master Boot Record\" (MBR) format used
4613 by MS-DOS and Windows. This partition type will B<only> work
4614 for device sizes up to 2 TB. For large disks we recommend
4619 Other partition table types that may work but are not
4628 =item B<amiga> | B<rdb>
4630 Amiga \"Rigid Disk Block\" format.
4638 DASD, used on IBM mainframes.
4646 Old Mac partition format. Modern Macs use C<gpt>.
4650 NEC PC-98 format, common in Japan apparently.
4658 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4659 [InitEmpty, Always, TestRun (
4660 [["part_init"; "/dev/sda"; "mbr"];
4661 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4662 InitEmpty, Always, TestRun (
4663 [["part_init"; "/dev/sda"; "gpt"];
4664 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4665 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4666 InitEmpty, Always, TestRun (
4667 [["part_init"; "/dev/sda"; "mbr"];
4668 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4669 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4670 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4671 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4672 "add a partition to the device",
4674 This command adds a partition to C<device>. If there is no partition
4675 table on the device, call C<guestfs_part_init> first.
4677 The C<prlogex> parameter is the type of partition. Normally you
4678 should pass C<p> or C<primary> here, but MBR partition tables also
4679 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4682 C<startsect> and C<endsect> are the start and end of the partition
4683 in I<sectors>. C<endsect> may be negative, which means it counts
4684 backwards from the end of the disk (C<-1> is the last sector).
4686 Creating a partition which covers the whole disk is not so easy.
4687 Use C<guestfs_part_disk> to do that.");
4689 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4690 [InitEmpty, Always, TestRun (
4691 [["part_disk"; "/dev/sda"; "mbr"]]);
4692 InitEmpty, Always, TestRun (
4693 [["part_disk"; "/dev/sda"; "gpt"]])],
4694 "partition whole disk with a single primary partition",
4696 This command is simply a combination of C<guestfs_part_init>
4697 followed by C<guestfs_part_add> to create a single primary partition
4698 covering the whole disk.
4700 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4701 but other possible values are described in C<guestfs_part_init>.");
4703 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4704 [InitEmpty, Always, TestRun (
4705 [["part_disk"; "/dev/sda"; "mbr"];
4706 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4707 "make a partition bootable",
4709 This sets the bootable flag on partition numbered C<partnum> on
4710 device C<device>. Note that partitions are numbered from 1.
4712 The bootable flag is used by some operating systems (notably
4713 Windows) to determine which partition to boot from. It is by
4714 no means universally recognized.");
4716 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4717 [InitEmpty, Always, TestRun (
4718 [["part_disk"; "/dev/sda"; "gpt"];
4719 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4720 "set partition name",
4722 This sets the partition name on partition numbered C<partnum> on
4723 device C<device>. Note that partitions are numbered from 1.
4725 The partition name can only be set on certain types of partition
4726 table. This works on C<gpt> but not on C<mbr> partitions.");
4728 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4729 [], (* XXX Add a regression test for this. *)
4730 "list partitions on a device",
4732 This command parses the partition table on C<device> and
4733 returns the list of partitions found.
4735 The fields in the returned structure are:
4741 Partition number, counting from 1.
4745 Start of the partition I<in bytes>. To get sectors you have to
4746 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4750 End of the partition in bytes.
4754 Size of the partition in bytes.
4758 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4759 [InitEmpty, Always, TestOutput (
4760 [["part_disk"; "/dev/sda"; "gpt"];
4761 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4762 "get the partition table type",
4764 This command examines the partition table on C<device> and
4765 returns the partition table type (format) being used.
4767 Common return values include: C<msdos> (a DOS/Windows style MBR
4768 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4769 values are possible, although unusual. See C<guestfs_part_init>
4772 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4773 [InitScratchFS, Always, TestOutputBuffer (
4774 [["fill"; "0x63"; "10"; "/fill"];
4775 ["read_file"; "/fill"]], "cccccccccc")],
4776 "fill a file with octets",
4778 This command creates a new file called C<path>. The initial
4779 content of the file is C<len> octets of C<c>, where C<c>
4780 must be a number in the range C<[0..255]>.
4782 To fill a file with zero bytes (sparsely), it is
4783 much more efficient to use C<guestfs_truncate_size>.
4784 To create a file with a pattern of repeating bytes
4785 use C<guestfs_fill_pattern>.");
4787 ("available", (RErr, [StringList "groups"], []), 216, [],
4788 [InitNone, Always, TestRun [["available"; ""]]],
4789 "test availability of some parts of the API",
4791 This command is used to check the availability of some
4792 groups of functionality in the appliance, which not all builds of
4793 the libguestfs appliance will be able to provide.
4795 The libguestfs groups, and the functions that those
4796 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4797 You can also fetch this list at runtime by calling
4798 C<guestfs_available_all_groups>.
4800 The argument C<groups> is a list of group names, eg:
4801 C<[\"inotify\", \"augeas\"]> would check for the availability of
4802 the Linux inotify functions and Augeas (configuration file
4805 The command returns no error if I<all> requested groups are available.
4807 It fails with an error if one or more of the requested
4808 groups is unavailable in the appliance.
4810 If an unknown group name is included in the
4811 list of groups then an error is always returned.
4819 You must call C<guestfs_launch> before calling this function.
4821 The reason is because we don't know what groups are
4822 supported by the appliance/daemon until it is running and can
4827 If a group of functions is available, this does not necessarily
4828 mean that they will work. You still have to check for errors
4829 when calling individual API functions even if they are
4834 It is usually the job of distro packagers to build
4835 complete functionality into the libguestfs appliance.
4836 Upstream libguestfs, if built from source with all
4837 requirements satisfied, will support everything.
4841 This call was added in version C<1.0.80>. In previous
4842 versions of libguestfs all you could do would be to speculatively
4843 execute a command to find out if the daemon implemented it.
4844 See also C<guestfs_version>.
4848 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4849 [InitScratchFS, Always, TestOutputBuffer (
4851 ["write"; "/dd/src"; "hello, world"];
4852 ["dd"; "/dd/src"; "/dd/dest"];
4853 ["read_file"; "/dd/dest"]], "hello, world")],
4854 "copy from source to destination using dd",
4856 This command copies from one source device or file C<src>
4857 to another destination device or file C<dest>. Normally you
4858 would use this to copy to or from a device or partition, for
4859 example to duplicate a filesystem.
4861 If the destination is a device, it must be as large or larger
4862 than the source file or device, otherwise the copy will fail.
4863 This command cannot do partial copies (see C<guestfs_copy_size>).");
4865 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4866 [InitScratchFS, Always, TestOutputInt (
4867 [["write"; "/filesize"; "hello, world"];
4868 ["filesize"; "/filesize"]], 12)],
4869 "return the size of the file in bytes",
4871 This command returns the size of C<file> in bytes.
4873 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4874 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4875 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4877 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4878 [InitBasicFSonLVM, Always, TestOutputList (
4879 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4880 ["lvs"]], ["/dev/VG/LV2"])],
4881 "rename an LVM logical volume",
4883 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4885 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4886 [InitBasicFSonLVM, Always, TestOutputList (
4888 ["vg_activate"; "false"; "VG"];
4889 ["vgrename"; "VG"; "VG2"];
4890 ["vg_activate"; "true"; "VG2"];
4891 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4892 ["vgs"]], ["VG2"])],
4893 "rename an LVM volume group",
4895 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4897 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4898 [InitISOFS, Always, TestOutputBuffer (
4899 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4900 "list the contents of a single file in an initrd",
4902 This command unpacks the file C<filename> from the initrd file
4903 called C<initrdpath>. The filename must be given I<without> the
4904 initial C</> character.
4906 For example, in guestfish you could use the following command
4907 to examine the boot script (usually called C</init>)
4908 contained in a Linux initrd or initramfs image:
4910 initrd-cat /boot/initrd-<version>.img init
4912 See also C<guestfs_initrd_list>.");
4914 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4916 "get the UUID of a physical volume",
4918 This command returns the UUID of the LVM PV C<device>.");
4920 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4922 "get the UUID of a volume group",
4924 This command returns the UUID of the LVM VG named C<vgname>.");
4926 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
4928 "get the UUID of a logical volume",
4930 This command returns the UUID of the LVM LV C<device>.");
4932 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
4934 "get the PV UUIDs containing the volume group",
4936 Given a VG called C<vgname>, this returns the UUIDs of all
4937 the physical volumes that this volume group resides on.
4939 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4940 calls to associate physical volumes and volume groups.
4942 See also C<guestfs_vglvuuids>.");
4944 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
4946 "get the LV UUIDs of all LVs in the volume group",
4948 Given a VG called C<vgname>, this returns the UUIDs of all
4949 the logical volumes created in this volume group.
4951 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4952 calls to associate logical volumes and volume groups.
4954 See also C<guestfs_vgpvuuids>.");
4956 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
4957 [InitScratchFS, Always, TestOutputBuffer (
4958 [["mkdir"; "/copy_size"];
4959 ["write"; "/copy_size/src"; "hello, world"];
4960 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
4961 ["read_file"; "/copy_size/dest"]], "hello")],
4962 "copy size bytes from source to destination using dd",
4964 This command copies exactly C<size> bytes from one source device
4965 or file C<src> to another destination device or file C<dest>.
4967 Note this will fail if the source is too short or if the destination
4968 is not large enough.");
4970 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
4971 [InitBasicFSonLVM, Always, TestRun (
4972 [["zero_device"; "/dev/VG/LV"]])],
4973 "write zeroes to an entire device",
4975 This command writes zeroes over the entire C<device>. Compare
4976 with C<guestfs_zero> which just zeroes the first few blocks of
4979 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
4980 [InitScratchFS, Always, TestOutput (
4981 [["mkdir"; "/txz_in"];
4982 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
4983 ["cat"; "/txz_in/hello"]], "hello\n")],
4984 "unpack compressed tarball to directory",
4986 This command uploads and unpacks local file C<tarball> (an
4987 I<xz compressed> tar file) into C<directory>.");
4989 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
4991 "pack directory into compressed tarball",
4993 This command packs the contents of C<directory> and downloads
4994 it to local file C<tarball> (as an xz compressed tar archive).");
4996 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
4998 "resize an NTFS filesystem",
5000 This command resizes an NTFS filesystem, expanding or
5001 shrinking it to the size of the underlying device.
5002 See also L<ntfsresize(8)>.");
5004 ("vgscan", (RErr, [], []), 232, [],
5005 [InitEmpty, Always, TestRun (
5007 "rescan for LVM physical volumes, volume groups and logical volumes",
5009 This rescans all block devices and rebuilds the list of LVM
5010 physical volumes, volume groups and logical volumes.");
5012 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5013 [InitEmpty, Always, TestRun (
5014 [["part_init"; "/dev/sda"; "mbr"];
5015 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5016 ["part_del"; "/dev/sda"; "1"]])],
5017 "delete a partition",
5019 This command deletes the partition numbered C<partnum> on C<device>.
5021 Note that in the case of MBR partitioning, deleting an
5022 extended partition also deletes any logical partitions
5025 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5026 [InitEmpty, Always, TestOutputTrue (
5027 [["part_init"; "/dev/sda"; "mbr"];
5028 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5029 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5030 ["part_get_bootable"; "/dev/sda"; "1"]])],
5031 "return true if a partition is bootable",
5033 This command returns true if the partition C<partnum> on
5034 C<device> has the bootable flag set.
5036 See also C<guestfs_part_set_bootable>.");
5038 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5039 [InitEmpty, Always, TestOutputInt (
5040 [["part_init"; "/dev/sda"; "mbr"];
5041 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5042 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5043 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5044 "get the MBR type byte (ID byte) from a partition",
5046 Returns the MBR type byte (also known as the ID byte) from
5047 the numbered partition C<partnum>.
5049 Note that only MBR (old DOS-style) partitions have type bytes.
5050 You will get undefined results for other partition table
5051 types (see C<guestfs_part_get_parttype>).");
5053 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5054 [], (* tested by part_get_mbr_id *)
5055 "set the MBR type byte (ID byte) of a partition",
5057 Sets the MBR type byte (also known as the ID byte) of
5058 the numbered partition C<partnum> to C<idbyte>. Note
5059 that the type bytes quoted in most documentation are
5060 in fact hexadecimal numbers, but usually documented
5061 without any leading \"0x\" which might be confusing.
5063 Note that only MBR (old DOS-style) partitions have type bytes.
5064 You will get undefined results for other partition table
5065 types (see C<guestfs_part_get_parttype>).");
5067 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5068 [InitISOFS, Always, TestOutputFileMD5 (
5069 [["checksum_device"; "md5"; "/dev/sdd"]],
5070 "../images/test.iso")],
5071 "compute MD5, SHAx or CRC checksum of the contents of a device",
5073 This call computes the MD5, SHAx or CRC checksum of the
5074 contents of the device named C<device>. For the types of
5075 checksums supported see the C<guestfs_checksum> command.");
5077 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5078 [InitNone, Always, TestRun (
5079 [["part_disk"; "/dev/sda"; "mbr"];
5080 ["pvcreate"; "/dev/sda1"];
5081 ["vgcreate"; "VG"; "/dev/sda1"];
5082 ["lvcreate"; "LV"; "VG"; "10"];
5083 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5084 "expand an LV to fill free space",
5086 This expands an existing logical volume C<lv> so that it fills
5087 C<pc>% of the remaining free space in the volume group. Commonly
5088 you would call this with pc = 100 which expands the logical volume
5089 as much as possible, using all remaining free space in the volume
5092 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5093 [], (* XXX Augeas code needs tests. *)
5094 "clear Augeas path",
5096 Set the value associated with C<path> to C<NULL>. This
5097 is the same as the L<augtool(1)> C<clear> command.");
5099 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5100 [InitEmpty, Always, TestOutputInt (
5101 [["get_umask"]], 0o22)],
5102 "get the current umask",
5104 Return the current umask. By default the umask is C<022>
5105 unless it has been set by calling C<guestfs_umask>.");
5107 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5109 "upload a file to the appliance (internal use only)",
5111 The C<guestfs_debug_upload> command uploads a file to
5112 the libguestfs appliance.
5114 There is no comprehensive help for this command. You have
5115 to look at the file C<daemon/debug.c> in the libguestfs source
5116 to find out what it is for.");
5118 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5119 [InitScratchFS, Always, TestOutput (
5120 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5121 ["cat"; "/base64_in"]], "hello\n")],
5122 "upload base64-encoded data to file",
5124 This command uploads base64-encoded data from C<base64file>
5127 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5129 "download file and encode as base64",
5131 This command downloads the contents of C<filename>, writing
5132 it out to local file C<base64file> encoded as base64.");
5134 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5136 "compute MD5, SHAx or CRC checksum of files in a directory",
5138 This command computes the checksums of all regular files in
5139 C<directory> and then emits a list of those checksums to
5140 the local output file C<sumsfile>.
5142 This can be used for verifying the integrity of a virtual
5143 machine. However to be properly secure you should pay
5144 attention to the output of the checksum command (it uses
5145 the ones from GNU coreutils). In particular when the
5146 filename is not printable, coreutils uses a special
5147 backslash syntax. For more information, see the GNU
5148 coreutils info file.");
5150 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5151 [InitScratchFS, Always, TestOutputBuffer (
5152 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5153 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5154 "fill a file with a repeating pattern of bytes",
5156 This function is like C<guestfs_fill> except that it creates
5157 a new file of length C<len> containing the repeating pattern
5158 of bytes in C<pattern>. The pattern is truncated if necessary
5159 to ensure the length of the file is exactly C<len> bytes.");
5161 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5162 [InitScratchFS, Always, TestOutput (
5163 [["write"; "/write"; "new file contents"];
5164 ["cat"; "/write"]], "new file contents");
5165 InitScratchFS, Always, TestOutput (
5166 [["write"; "/write2"; "\nnew file contents\n"];
5167 ["cat"; "/write2"]], "\nnew file contents\n");
5168 InitScratchFS, Always, TestOutput (
5169 [["write"; "/write3"; "\n\n"];
5170 ["cat"; "/write3"]], "\n\n");
5171 InitScratchFS, Always, TestOutput (
5172 [["write"; "/write4"; ""];
5173 ["cat"; "/write4"]], "");
5174 InitScratchFS, Always, TestOutput (
5175 [["write"; "/write5"; "\n\n\n"];
5176 ["cat"; "/write5"]], "\n\n\n");
5177 InitScratchFS, Always, TestOutput (
5178 [["write"; "/write6"; "\n"];
5179 ["cat"; "/write6"]], "\n")],
5180 "create a new file",
5182 This call creates a file called C<path>. The content of the
5183 file is the string C<content> (which can contain any 8 bit data).");
5185 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5186 [InitScratchFS, Always, TestOutput (
5187 [["write"; "/pwrite"; "new file contents"];
5188 ["pwrite"; "/pwrite"; "data"; "4"];
5189 ["cat"; "/pwrite"]], "new data contents");
5190 InitScratchFS, Always, TestOutput (
5191 [["write"; "/pwrite2"; "new file contents"];
5192 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5193 ["cat"; "/pwrite2"]], "new file is extended");
5194 InitScratchFS, Always, TestOutput (
5195 [["write"; "/pwrite3"; "new file contents"];
5196 ["pwrite"; "/pwrite3"; ""; "4"];
5197 ["cat"; "/pwrite3"]], "new file contents")],
5198 "write to part of a file",
5200 This command writes to part of a file. It writes the data
5201 buffer C<content> to the file C<path> starting at offset C<offset>.
5203 This command implements the L<pwrite(2)> system call, and like
5204 that system call it may not write the full data requested. The
5205 return value is the number of bytes that were actually written
5206 to the file. This could even be 0, although short writes are
5207 unlikely for regular files in ordinary circumstances.
5209 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5211 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5213 "resize an ext2, ext3 or ext4 filesystem (with size)",
5215 This command is the same as C<guestfs_resize2fs> except that it
5216 allows you to specify the new size (in bytes) explicitly.");
5218 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5220 "resize an LVM physical volume (with size)",
5222 This command is the same as C<guestfs_pvresize> except that it
5223 allows you to specify the new size (in bytes) explicitly.");
5225 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5227 "resize an NTFS filesystem (with size)",
5229 This command is the same as C<guestfs_ntfsresize> except that it
5230 allows you to specify the new size (in bytes) explicitly.");
5232 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5233 [InitNone, Always, TestRun [["available_all_groups"]]],
5234 "return a list of all optional groups",
5236 This command returns a list of all optional groups that this
5237 daemon knows about. Note this returns both supported and unsupported
5238 groups. To find out which ones the daemon can actually support
5239 you have to call C<guestfs_available> on each member of the
5242 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5244 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5245 [InitScratchFS, Always, TestOutputStruct (
5246 [["fallocate64"; "/fallocate64"; "1000000"];
5247 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5248 "preallocate a file in the guest filesystem",
5250 This command preallocates a file (containing zero bytes) named
5251 C<path> of size C<len> bytes. If the file exists already, it
5254 Note that this call allocates disk blocks for the file.
5255 To create a sparse file use C<guestfs_truncate_size> instead.
5257 The deprecated call C<guestfs_fallocate> does the same,
5258 but owing to an oversight it only allowed 30 bit lengths
5259 to be specified, effectively limiting the maximum size
5260 of files created through that call to 1GB.
5262 Do not confuse this with the guestfish-specific
5263 C<alloc> and C<sparse> commands which create
5264 a file in the host and attach it as a device.");
5266 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5267 [InitBasicFS, Always, TestOutput (
5268 [["set_e2label"; "/dev/sda1"; "LTEST"];
5269 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5270 "get the filesystem label",
5272 This returns the filesystem label of the filesystem on
5275 If the filesystem is unlabeled, this returns the empty string.
5277 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5279 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5280 (let uuid = uuidgen () in
5281 [InitBasicFS, Always, TestOutput (
5282 [["set_e2uuid"; "/dev/sda1"; uuid];
5283 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5284 "get the filesystem UUID",
5286 This returns the filesystem UUID of the filesystem on
5289 If the filesystem does not have a UUID, this returns the empty string.
5291 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5293 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5294 (* Can't be tested with the current framework because
5295 * the VG is being used by the mounted filesystem, so
5296 * the vgchange -an command we do first will fail.
5299 "set LVM device filter",
5301 This sets the LVM device filter so that LVM will only be
5302 able to \"see\" the block devices in the list C<devices>,
5303 and will ignore all other attached block devices.
5305 Where disk image(s) contain duplicate PVs or VGs, this
5306 command is useful to get LVM to ignore the duplicates, otherwise
5307 LVM can get confused. Note also there are two types
5308 of duplication possible: either cloned PVs/VGs which have
5309 identical UUIDs; or VGs that are not cloned but just happen
5310 to have the same name. In normal operation you cannot
5311 create this situation, but you can do it outside LVM, eg.
5312 by cloning disk images or by bit twiddling inside the LVM
5315 This command also clears the LVM cache and performs a volume
5318 You can filter whole block devices or individual partitions.
5320 You cannot use this if any VG is currently in use (eg.
5321 contains a mounted filesystem), even if you are not
5322 filtering out that VG.");
5324 ("lvm_clear_filter", (RErr, [], []), 256, [],
5325 [], (* see note on lvm_set_filter *)
5326 "clear LVM device filter",
5328 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5329 will be able to see every block device.
5331 This command also clears the LVM cache and performs a volume
5334 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5336 "open a LUKS-encrypted block device",
5338 This command opens a block device which has been encrypted
5339 according to the Linux Unified Key Setup (LUKS) standard.
5341 C<device> is the encrypted block device or partition.
5343 The caller must supply one of the keys associated with the
5344 LUKS block device, in the C<key> parameter.
5346 This creates a new block device called C</dev/mapper/mapname>.
5347 Reads and writes to this block device are decrypted from and
5348 encrypted to the underlying C<device> respectively.
5350 If this block device contains LVM volume groups, then
5351 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5352 will make them visible.");
5354 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5356 "open a LUKS-encrypted block device read-only",
5358 This is the same as C<guestfs_luks_open> except that a read-only
5359 mapping is created.");
5361 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5363 "close a LUKS device",
5365 This closes a LUKS device that was created earlier by
5366 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5367 C<device> parameter must be the name of the LUKS mapping
5368 device (ie. C</dev/mapper/mapname>) and I<not> the name
5369 of the underlying block device.");
5371 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5373 "format a block device as a LUKS encrypted device",
5375 This command erases existing data on C<device> and formats
5376 the device as a LUKS encrypted device. C<key> is the
5377 initial key, which is added to key slot C<slot>. (LUKS
5378 supports 8 key slots, numbered 0-7).");
5380 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5382 "format a block device as a LUKS encrypted device",
5384 This command is the same as C<guestfs_luks_format> but
5385 it also allows you to set the C<cipher> used.");
5387 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5389 "add a key on a LUKS encrypted device",
5391 This command adds a new key on LUKS device C<device>.
5392 C<key> is any existing key, and is used to access the device.
5393 C<newkey> is the new key to add. C<keyslot> is the key slot
5394 that will be replaced.
5396 Note that if C<keyslot> already contains a key, then this
5397 command will fail. You have to use C<guestfs_luks_kill_slot>
5398 first to remove that key.");
5400 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5402 "remove a key from a LUKS encrypted device",
5404 This command deletes the key in key slot C<keyslot> from the
5405 encrypted LUKS device C<device>. C<key> must be one of the
5408 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5409 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5410 [["is_lv"; "/dev/VG/LV"]]);
5411 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5412 [["is_lv"; "/dev/sda1"]])],
5413 "test if device is a logical volume",
5415 This command tests whether C<device> is a logical volume, and
5416 returns true iff this is the case.");
5418 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5420 "find a filesystem by UUID",
5422 This command searches the filesystems and returns the one
5423 which has the given UUID. An error is returned if no such
5424 filesystem can be found.
5426 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5428 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5430 "find a filesystem by label",
5432 This command searches the filesystems and returns the one
5433 which has the given label. An error is returned if no such
5434 filesystem can be found.
5436 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5438 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5439 [InitISOFS, Always, TestOutputFalse (
5440 [["is_chardev"; "/directory"]]);
5441 InitScratchFS, Always, TestOutputTrue (
5442 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5443 ["is_chardev"; "/is_chardev"]])],
5444 "test if character device",
5446 This returns C<true> if and only if there is a character device
5447 with the given C<path> name.
5449 See also C<guestfs_stat>.");
5451 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5452 [InitISOFS, Always, TestOutputFalse (
5453 [["is_blockdev"; "/directory"]]);
5454 InitScratchFS, Always, TestOutputTrue (
5455 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5456 ["is_blockdev"; "/is_blockdev"]])],
5457 "test if block device",
5459 This returns C<true> if and only if there is a block device
5460 with the given C<path> name.
5462 See also C<guestfs_stat>.");
5464 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5465 [InitISOFS, Always, TestOutputFalse (
5466 [["is_fifo"; "/directory"]]);
5467 InitScratchFS, Always, TestOutputTrue (
5468 [["mkfifo"; "0o777"; "/is_fifo"];
5469 ["is_fifo"; "/is_fifo"]])],
5470 "test if FIFO (named pipe)",
5472 This returns C<true> if and only if there is a FIFO (named pipe)
5473 with the given C<path> name.
5475 See also C<guestfs_stat>.");
5477 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5478 [InitISOFS, Always, TestOutputFalse (
5479 [["is_symlink"; "/directory"]]);
5480 InitISOFS, Always, TestOutputTrue (
5481 [["is_symlink"; "/abssymlink"]])],
5482 "test if symbolic link",
5484 This returns C<true> if and only if there is a symbolic link
5485 with the given C<path> name.
5487 See also C<guestfs_stat>.");
5489 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5490 (* XXX Need a positive test for sockets. *)
5491 [InitISOFS, Always, TestOutputFalse (
5492 [["is_socket"; "/directory"]])],
5495 This returns C<true> if and only if there is a Unix domain socket
5496 with the given C<path> name.
5498 See also C<guestfs_stat>.");
5500 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5501 [InitPartition, Always, TestOutputDevice (
5502 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5503 InitEmpty, Always, TestLastFail (
5504 [["part_to_dev"; "/dev/sda"]])],
5505 "convert partition name to device name",
5507 This function takes a partition name (eg. \"/dev/sdb1\") and
5508 removes the partition number, returning the device name
5511 The named partition must exist, for example as a string returned
5512 from C<guestfs_list_partitions>.");
5514 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5515 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5516 [InitScratchFS, Always, TestOutput (
5517 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5518 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5519 "upload a file from the local machine with offset",
5521 Upload local file C<filename> to C<remotefilename> on the
5524 C<remotefilename> is overwritten starting at the byte C<offset>
5525 specified. The intention is to overwrite parts of existing
5526 files or devices, although if a non-existant file is specified
5527 then it is created with a \"hole\" before C<offset>. The
5528 size of the data written is implicit in the size of the
5531 Note that there is no limit on the amount of data that
5532 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5533 and this call always writes the full amount unless an
5536 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5538 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5539 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5540 let offset = string_of_int 100 in
5541 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5542 [InitScratchFS, Always, TestOutput (
5543 (* Pick a file from cwd which isn't likely to change. *)
5544 [["mkdir"; "/download_offset"];
5545 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5546 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5547 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5548 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5549 "download a file to the local machine with offset and size",
5551 Download file C<remotefilename> and save it as C<filename>
5552 on the local machine.
5554 C<remotefilename> is read for C<size> bytes starting at C<offset>
5555 (this region must be within the file or device).
5557 Note that there is no limit on the amount of data that
5558 can be downloaded with this call, unlike with C<guestfs_pread>,
5559 and this call always reads the full amount unless an
5562 See also C<guestfs_download>, C<guestfs_pread>.");
5564 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5565 [InitPartition, Always, TestOutputListOfDevices (
5566 [["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"];
5567 ["blockdev_rereadpt"; "/dev/sda"];
5568 ["list_partitions"]], ["/dev/sdb1"])],
5569 "write to part of a device",
5571 This command writes to part of a device. It writes the data
5572 buffer C<content> to C<device> starting at offset C<offset>.
5574 This command implements the L<pwrite(2)> system call, and like
5575 that system call it may not write the full data requested
5576 (although short writes to disk devices and partitions are
5577 probably impossible with standard Linux kernels).
5579 See also C<guestfs_pwrite>.");
5581 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5582 [InitEmpty, Always, TestOutputBuffer (
5583 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5584 "read part of a device",
5586 This command lets you read part of a file. It reads C<count>
5587 bytes of C<device>, starting at C<offset>.
5589 This may read fewer bytes than requested. For further details
5590 see the L<pread(2)> system call.
5592 See also C<guestfs_pread>.");
5594 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5595 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5596 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5597 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5598 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5599 "get canonical name of an LV",
5601 This converts alternative naming schemes for LVs that you
5602 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5603 is converted to C</dev/VG/LV>.
5605 This command returns an error if the C<lvname> parameter does
5606 not refer to a logical volume.
5608 See also C<guestfs_is_lv>.");
5610 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"]), 278, [],
5611 [InitEmpty, Always, TestOutput (
5612 [["part_disk"; "/dev/sda"; "mbr"];
5613 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"];
5614 ["mount_options"; ""; "/dev/sda1"; "/"];
5615 ["write"; "/new"; "new file contents"];
5616 ["cat"; "/new"]], "new file contents")],
5617 "make a filesystem",
5619 This function creates a filesystem on C<device>. The filesystem
5620 type is C<fstype>, for example C<ext3>.
5622 The optional arguments are:
5628 The filesystem block size. Supported block sizes depend on the
5629 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5630 for Linux ext2/3 filesystems.
5632 For VFAT and NTFS the C<blocksize> parameter is treated as
5633 the requested cluster size.
5635 For UFS block sizes, please see L<mkfs.ufs(8)>.
5639 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5641 "get a single extended attribute",
5643 Get a single extended attribute from file C<path> named C<name>.
5644 This call follows symlinks. If you want to lookup an extended
5645 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5647 Normally it is better to get all extended attributes from a file
5648 in one go by calling C<guestfs_getxattrs>. However some Linux
5649 filesystem implementations are buggy and do not provide a way to
5650 list out attributes. For these filesystems (notably ntfs-3g)
5651 you have to know the names of the extended attributes you want
5652 in advance and call this function.
5654 Extended attribute values are blobs of binary data. If there
5655 is no extended attribute named C<name>, this returns an error.
5657 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5659 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5661 "get a single extended attribute",
5663 Get a single extended attribute from file C<path> named C<name>.
5664 If C<path> is a symlink, then this call returns an extended
5665 attribute from the symlink.
5667 Normally it is better to get all extended attributes from a file
5668 in one go by calling C<guestfs_getxattrs>. However some Linux
5669 filesystem implementations are buggy and do not provide a way to
5670 list out attributes. For these filesystems (notably ntfs-3g)
5671 you have to know the names of the extended attributes you want
5672 in advance and call this function.
5674 Extended attribute values are blobs of binary data. If there
5675 is no extended attribute named C<name>, this returns an error.
5677 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5681 let all_functions = non_daemon_functions @ daemon_functions
5683 (* In some places we want the functions to be displayed sorted
5684 * alphabetically, so this is useful:
5686 let all_functions_sorted = List.sort action_compare all_functions
5688 (* This is used to generate the src/MAX_PROC_NR file which
5689 * contains the maximum procedure number, a surrogate for the
5690 * ABI version number. See src/Makefile.am for the details.
5693 let proc_nrs = List.map (
5694 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5695 ) daemon_functions in
5696 List.fold_left max 0 proc_nrs
5698 (* Non-API meta-commands available only in guestfish.
5700 * Note (1): style, proc_nr and tests fields are all meaningless.
5701 * The only fields which are actually used are the shortname,
5702 * FishAlias flags, shortdesc and longdesc.
5704 * Note (2): to refer to other commands, use L</shortname>.
5706 * Note (3): keep this list sorted by shortname.
5708 let fish_commands = [
5709 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5710 "allocate and add a disk file",
5711 " alloc filename size
5713 This creates an empty (zeroed) file of the given size, and then adds
5714 so it can be further examined.
5716 For more advanced image creation, see L<qemu-img(1)> utility.
5718 Size can be specified using standard suffixes, eg. C<1M>.
5720 To create a sparse file, use L</sparse> instead. To create a
5721 prepared disk image, see L</PREPARED DISK IMAGES>.");
5723 ("copy_in", (RErr,[], []), -1, [], [],
5724 "copy local files or directories into an image",
5725 " copy-in local [local ...] /remotedir
5727 C<copy-in> copies local files or directories recursively into the disk
5728 image, placing them in the directory called C</remotedir> (which must
5729 exist). This guestfish meta-command turns into a sequence of
5730 L</tar-in> and other commands as necessary.
5732 Multiple local files and directories can be specified, but the last
5733 parameter must always be a remote directory. Wildcards cannot be
5736 ("copy_out", (RErr,[], []), -1, [], [],
5737 "copy remote files or directories out of an image",
5738 " copy-out remote [remote ...] localdir
5740 C<copy-out> copies remote files or directories recursively out of the
5741 disk image, placing them on the host disk in a local directory called
5742 C<localdir> (which must exist). This guestfish meta-command turns
5743 into a sequence of L</download>, L</tar-out> and other commands as
5746 Multiple remote files and directories can be specified, but the last
5747 parameter must always be a local directory. To download to the
5748 current directory, use C<.> as in:
5752 Wildcards cannot be used in the ordinary command, but you can use
5753 them with the help of L</glob> like this:
5755 glob copy-out /home/* .");
5757 ("echo", (RErr,[], []), -1, [], [],
5758 "display a line of text",
5761 This echos the parameters to the terminal.");
5763 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5767 This is used to edit a file. It downloads the file, edits it
5768 locally using your editor, then uploads the result.
5770 The editor is C<$EDITOR>. However if you use the alternate
5771 commands C<vi> or C<emacs> you will get those corresponding
5774 ("glob", (RErr,[], []), -1, [], [],
5775 "expand wildcards in command",
5776 " glob command args...
5778 Expand wildcards in any paths in the args list, and run C<command>
5779 repeatedly on each matching path.
5781 See L</WILDCARDS AND GLOBBING>.");
5783 ("hexedit", (RErr,[], []), -1, [], [],
5784 "edit with a hex editor",
5785 " hexedit <filename|device>
5786 hexedit <filename|device> <max>
5787 hexedit <filename|device> <start> <max>
5789 Use hexedit (a hex editor) to edit all or part of a binary file
5792 This command works by downloading potentially the whole file or
5793 device, editing it locally, then uploading it. If the file or
5794 device is large, you have to specify which part you wish to edit
5795 by using C<max> and/or C<start> C<max> parameters.
5796 C<start> and C<max> are specified in bytes, with the usual
5797 modifiers allowed such as C<1M> (1 megabyte).
5799 For example to edit the first few sectors of a disk you
5804 which would allow you to edit anywhere within the first megabyte
5807 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5809 hexedit /dev/sda1 0x400 0x400
5811 (assuming the superblock is in the standard location).
5813 This command requires the external L<hexedit(1)> program. You
5814 can specify another program to use by setting the C<HEXEDITOR>
5815 environment variable.
5817 See also L</hexdump>.");
5819 ("lcd", (RErr,[], []), -1, [], [],
5820 "change working directory",
5823 Change the local directory, ie. the current directory of guestfish
5826 Note that C<!cd> won't do what you might expect.");
5828 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5832 Opens the manual page for guestfish.");
5834 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5840 This is used to view a file.
5842 The default viewer is C<$PAGER>. However if you use the alternate
5843 command C<less> you will get the C<less> command specifically.");
5845 ("reopen", (RErr,[], []), -1, [], [],
5846 "close and reopen libguestfs handle",
5849 Close and reopen the libguestfs handle. It is not necessary to use
5850 this normally, because the handle is closed properly when guestfish
5851 exits. However this is occasionally useful for testing.");
5853 ("sparse", (RErr,[], []), -1, [], [],
5854 "create a sparse disk image and add",
5855 " sparse filename size
5857 This creates an empty sparse file of the given size, and then adds
5858 so it can be further examined.
5860 In all respects it works the same as the L</alloc> command, except that
5861 the image file is allocated sparsely, which means that disk blocks are
5862 not assigned to the file until they are needed. Sparse disk files
5863 only use space when written to, but they are slower and there is a
5864 danger you could run out of real disk space during a write operation.
5866 For more advanced image creation, see L<qemu-img(1)> utility.
5868 Size can be specified using standard suffixes, eg. C<1M>.");
5870 ("supported", (RErr,[], []), -1, [], [],
5871 "list supported groups of commands",
5874 This command returns a list of the optional groups
5875 known to the daemon, and indicates which ones are
5876 supported by this build of the libguestfs appliance.
5878 See also L<guestfs(3)/AVAILABILITY>.");
5880 ("time", (RErr,[], []), -1, [], [],
5881 "print elapsed time taken to run a command",
5882 " time command args...
5884 Run the command as usual, but print the elapsed time afterwards. This
5885 can be useful for benchmarking operations.");