2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter C<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form C<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to make filesystems consistent and synchronized
286 when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
308 ("get_verbose", (RBool "verbose", [], []), -1, [],
312 This returns the verbose messages flag.");
314 ("is_ready", (RBool "ready", [], []), -1, [],
315 [InitNone, Always, TestOutputTrue (
317 "is ready to accept commands",
319 This returns true iff this handle is ready to accept commands
320 (in the C<READY> state).
322 For more information on states, see L<guestfs(3)>.");
324 ("is_config", (RBool "config", [], []), -1, [],
325 [InitNone, Always, TestOutputFalse (
327 "is in configuration state",
329 This returns true iff this handle is being configured
330 (in the C<CONFIG> state).
332 For more information on states, see L<guestfs(3)>.");
334 ("is_launching", (RBool "launching", [], []), -1, [],
335 [InitNone, Always, TestOutputFalse (
336 [["is_launching"]])],
337 "is launching subprocess",
339 This returns true iff this handle is launching the subprocess
340 (in the C<LAUNCHING> state).
342 For more information on states, see L<guestfs(3)>.");
344 ("is_busy", (RBool "busy", [], []), -1, [],
345 [InitNone, Always, TestOutputFalse (
347 "is busy processing a command",
349 This returns true iff this handle is busy processing a command
350 (in the C<BUSY> state).
352 For more information on states, see L<guestfs(3)>.");
354 ("get_state", (RInt "state", [], []), -1, [],
356 "get the current state",
358 This returns the current state as an opaque integer. This is
359 only useful for printing debug and internal error messages.
361 For more information on states, see L<guestfs(3)>.");
363 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
364 [InitNone, Always, TestOutputInt (
365 [["set_memsize"; "500"];
366 ["get_memsize"]], 500)],
367 "set memory allocated to the qemu subprocess",
369 This sets the memory size in megabytes allocated to the
370 qemu subprocess. This only has any effect if called before
373 You can also change this by setting the environment
374 variable C<LIBGUESTFS_MEMSIZE> before the handle is
377 For more information on the architecture of libguestfs,
378 see L<guestfs(3)>.");
380 ("get_memsize", (RInt "memsize", [], []), -1, [],
381 [InitNone, Always, TestOutputIntOp (
382 [["get_memsize"]], ">=", 256)],
383 "get memory allocated to the qemu subprocess",
385 This gets the memory size in megabytes allocated to the
388 If C<guestfs_set_memsize> was not called
389 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
390 then this returns the compiled-in default value for memsize.
392 For more information on the architecture of libguestfs,
393 see L<guestfs(3)>.");
395 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
396 [InitNone, Always, TestOutputIntOp (
397 [["get_pid"]], ">=", 1)],
398 "get PID of qemu subprocess",
400 Return the process ID of the qemu subprocess. If there is no
401 qemu subprocess, then this will return an error.
403 This is an internal call used for debugging and testing.");
405 ("version", (RStruct ("version", "version"), [], []), -1, [],
406 [InitNone, Always, TestOutputStruct (
407 [["version"]], [CompareWithInt ("major", 1)])],
408 "get the library version number",
410 Return the libguestfs version number that the program is linked
413 Note that because of dynamic linking this is not necessarily
414 the version of libguestfs that you compiled against. You can
415 compile the program, and then at runtime dynamically link
416 against a completely different C<libguestfs.so> library.
418 This call was added in version C<1.0.58>. In previous
419 versions of libguestfs there was no way to get the version
420 number. From C code you can use dynamic linker functions
421 to find out if this symbol exists (if it doesn't, then
422 it's an earlier version).
424 The call returns a structure with four elements. The first
425 three (C<major>, C<minor> and C<release>) are numbers and
426 correspond to the usual version triplet. The fourth element
427 (C<extra>) is a string and is normally empty, but may be
428 used for distro-specific information.
430 To construct the original version string:
431 C<$major.$minor.$release$extra>
433 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
435 I<Note:> Don't use this call to test for availability
436 of features. In enterprise distributions we backport
437 features from later versions into earlier versions,
438 making this an unreliable way to test for features.
439 Use C<guestfs_available> instead.");
441 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
442 [InitNone, Always, TestOutputTrue (
443 [["set_selinux"; "true"];
445 "set SELinux enabled or disabled at appliance boot",
447 This sets the selinux flag that is passed to the appliance
448 at boot time. The default is C<selinux=0> (disabled).
450 Note that if SELinux is enabled, it is always in
451 Permissive mode (C<enforcing=0>).
453 For more information on the architecture of libguestfs,
454 see L<guestfs(3)>.");
456 ("get_selinux", (RBool "selinux", [], []), -1, [],
458 "get SELinux enabled flag",
460 This returns the current setting of the selinux flag which
461 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
463 For more information on the architecture of libguestfs,
464 see L<guestfs(3)>.");
466 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
467 [InitNone, Always, TestOutputFalse (
468 [["set_trace"; "false"];
470 "enable or disable command traces",
472 If the command trace flag is set to 1, then commands are
473 printed on stderr before they are executed in a format
474 which is very similar to the one used by guestfish. In
475 other words, you can run a program with this enabled, and
476 you will get out a script which you can feed to guestfish
477 to perform the same set of actions.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
486 ("get_trace", (RBool "trace", [], []), -1, [],
488 "get command trace enabled flag",
490 Return the command trace flag.");
492 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
493 [InitNone, Always, TestOutputFalse (
494 [["set_direct"; "false"];
496 "enable or disable direct appliance mode",
498 If the direct appliance mode flag is enabled, then stdin and
499 stdout are passed directly through to the appliance once it
502 One consequence of this is that log messages aren't caught
503 by the library and handled by C<guestfs_set_log_message_callback>,
504 but go straight to stdout.
506 You probably don't want to use this unless you know what you
509 The default is disabled.");
511 ("get_direct", (RBool "direct", [], []), -1, [],
513 "get direct appliance mode flag",
515 Return the direct appliance mode flag.");
517 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
518 [InitNone, Always, TestOutputTrue (
519 [["set_recovery_proc"; "true"];
520 ["get_recovery_proc"]])],
521 "enable or disable the recovery process",
523 If this is called with the parameter C<false> then
524 C<guestfs_launch> does not create a recovery process. The
525 purpose of the recovery process is to stop runaway qemu
526 processes in the case where the main program aborts abruptly.
528 This only has any effect if called before C<guestfs_launch>,
529 and the default is true.
531 About the only time when you would want to disable this is
532 if the main process will fork itself into the background
533 (\"daemonize\" itself). In this case the recovery process
534 thinks that the main program has disappeared and so kills
535 qemu, which is not very helpful.");
537 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
539 "get recovery process enabled flag",
541 Return the recovery process enabled flag.");
543 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
545 "add a drive specifying the QEMU block emulation to use",
547 This is the same as C<guestfs_add_drive> but it allows you
548 to specify the QEMU interface emulation to use at run time.");
550 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
552 "add a drive read-only specifying the QEMU block emulation to use",
554 This is the same as C<guestfs_add_drive_ro> but it allows you
555 to specify the QEMU interface emulation to use at run time.");
557 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
558 [InitISOFS, Always, TestOutput (
559 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
560 InitISOFS, Always, TestOutput (
561 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
562 InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-win32.exe"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/lib-i586.so"]], "i386");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/lib-sparc.so"]], "sparc");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-win32.dll"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
582 "detect the architecture of a binary file",
584 This detects the architecture of the binary C<filename>,
585 and returns it if known.
587 Currently defined architectures are:
593 This string is returned for all 32 bit i386, i486, i586, i686 binaries
594 irrespective of the precise processor requirements of the binary.
606 64 bit SPARC V9 and above.
622 Libguestfs may return other architecture strings in future.
624 The function works on at least the following types of files:
630 many types of Un*x and Linux binary
634 many types of Un*x and Linux shared library
638 Windows Win32 and Win64 binaries
642 Windows Win32 and Win64 DLLs
644 Win32 binaries and DLLs return C<i386>.
646 Win64 binaries and DLLs return C<x86_64>.
654 Linux new-style initrd images
658 some non-x86 Linux vmlinuz kernels
662 What it can't do currently:
668 static libraries (libfoo.a)
672 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
676 x86 Linux vmlinuz kernels
678 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
679 compressed code, and are horribly hard to unpack. If you want to find
680 the architecture of a kernel, use the architecture of the associated
681 initrd or kernel module(s) instead.
685 ("inspect_os", (RStringList "roots", [], []), -1, [],
687 "inspect disk and return list of operating systems found",
689 This function uses other libguestfs functions and certain
690 heuristics to inspect the disk(s) (usually disks belonging to
691 a virtual machine), looking for operating systems.
693 The list returned is empty if no operating systems were found.
695 If one operating system was found, then this returns a list with
696 a single element, which is the name of the root filesystem of
697 this operating system. It is also possible for this function
698 to return a list containing more than one element, indicating
699 a dual-boot or multi-boot virtual machine, with each element being
700 the root filesystem of one of the operating systems.
702 You can pass the root string(s) returned to other
703 C<guestfs_inspect_get_*> functions in order to query further
704 information about each operating system, such as the name
707 This function uses other libguestfs features such as
708 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
709 and unmount filesystems and look at the contents. This should
710 be called with no disks currently mounted. The function may also
711 use Augeas, so any existing Augeas handle will be closed.
713 This function cannot decrypt encrypted disks. The caller
714 must do that first (supplying the necessary keys) if the
717 Please read L<guestfs(3)/INSPECTION> for more details.
719 See also C<guestfs_list_filesystems>.");
721 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
723 "get type of inspected operating system",
725 This function should only be called with a root device string
726 as returned by C<guestfs_inspect_os>.
728 This returns the type of the inspected operating system.
729 Currently defined types are:
735 Any Linux-based operating system.
739 Any Microsoft Windows operating system.
747 The operating system type could not be determined.
751 Future versions of libguestfs may return other strings here.
752 The caller should be prepared to handle any string.
754 Please read L<guestfs(3)/INSPECTION> for more details.");
756 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
758 "get architecture of inspected operating system",
760 This function should only be called with a root device string
761 as returned by C<guestfs_inspect_os>.
763 This returns the architecture of the inspected operating system.
764 The possible return values are listed under
765 C<guestfs_file_architecture>.
767 If the architecture could not be determined, then the
768 string C<unknown> is returned.
770 Please read L<guestfs(3)/INSPECTION> for more details.");
772 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
774 "get distro of inspected operating system",
776 This function should only be called with a root device string
777 as returned by C<guestfs_inspect_os>.
779 This returns the distro (distribution) of the inspected operating
782 Currently defined distros are:
818 =item \"redhat-based\"
820 Some Red Hat-derived distro.
824 Red Hat Enterprise Linux and some derivatives.
832 The distro could not be determined.
836 Windows does not have distributions. This string is
837 returned if the OS type is Windows.
841 Future versions of libguestfs may return other strings here.
842 The caller should be prepared to handle any string.
844 Please read L<guestfs(3)/INSPECTION> for more details.");
846 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
848 "get major version of inspected operating system",
850 This function should only be called with a root device string
851 as returned by C<guestfs_inspect_os>.
853 This returns the major version number of the inspected operating
856 Windows uses a consistent versioning scheme which is I<not>
857 reflected in the popular public names used by the operating system.
858 Notably the operating system known as \"Windows 7\" is really
859 version 6.1 (ie. major = 6, minor = 1). You can find out the
860 real versions corresponding to releases of Windows by consulting
863 If the version could not be determined, then C<0> is returned.
865 Please read L<guestfs(3)/INSPECTION> for more details.");
867 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
869 "get minor version of inspected operating system",
871 This function should only be called with a root device string
872 as returned by C<guestfs_inspect_os>.
874 This returns the minor version number of the inspected operating
877 If the version could not be determined, then C<0> is returned.
879 Please read L<guestfs(3)/INSPECTION> for more details.
880 See also C<guestfs_inspect_get_major_version>.");
882 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
884 "get product name of inspected operating system",
886 This function should only be called with a root device string
887 as returned by C<guestfs_inspect_os>.
889 This returns the product name of the inspected operating
890 system. The product name is generally some freeform string
891 which can be displayed to the user, but should not be
894 If the product name could not be determined, then the
895 string C<unknown> is returned.
897 Please read L<guestfs(3)/INSPECTION> for more details.");
899 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
901 "get mountpoints of inspected operating system",
903 This function should only be called with a root device string
904 as returned by C<guestfs_inspect_os>.
906 This returns a hash of where we think the filesystems
907 associated with this operating system should be mounted.
908 Callers should note that this is at best an educated guess
909 made by reading configuration files such as C</etc/fstab>.
910 I<In particular note> that this may return filesystems
911 which are non-existent or not mountable and callers should
912 be prepared to handle or ignore failures if they try to
915 Each element in the returned hashtable has a key which
916 is the path of the mountpoint (eg. C</boot>) and a value
917 which is the filesystem that would be mounted there
920 Non-mounted devices such as swap devices are I<not>
921 returned in this list.
923 Please read L<guestfs(3)/INSPECTION> for more details.
924 See also C<guestfs_inspect_get_filesystems>.");
926 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
928 "get filesystems associated with inspected operating system",
930 This function should only be called with a root device string
931 as returned by C<guestfs_inspect_os>.
933 This returns a list of all the filesystems that we think
934 are associated with this operating system. This includes
935 the root filesystem, other ordinary filesystems, and
936 non-mounted devices like swap partitions.
938 In the case of a multi-boot virtual machine, it is possible
939 for a filesystem to be shared between operating systems.
941 Please read L<guestfs(3)/INSPECTION> for more details.
942 See also C<guestfs_inspect_get_mountpoints>.");
944 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
946 "set enable network flag",
948 If C<network> is true, then the network is enabled in the
949 libguestfs appliance. The default is false.
951 This affects whether commands are able to access the network
952 (see L<guestfs(3)/RUNNING COMMANDS>).
954 You must call this before calling C<guestfs_launch>, otherwise
957 ("get_network", (RBool "network", [], []), -1, [],
959 "get enable network flag",
961 This returns the enable network flag.");
963 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
967 This inspection command looks for filesystems on partitions,
968 block devices and logical volumes, returning a list of devices
969 containing filesystems and their type.
971 The return value is a hash, where the keys are the devices
972 containing filesystems, and the values are the filesystem types.
975 \"/dev/sda1\" => \"ntfs\"
976 \"/dev/sda2\" => \"ext2\"
977 \"/dev/vg_guest/lv_root\" => \"ext4\"
978 \"/dev/vg_guest/lv_swap\" => \"swap\"
980 The value can have the special value \"unknown\", meaning the
981 content of the device is undetermined or empty.
982 \"swap\" means a Linux swap partition.
984 This command runs other libguestfs commands, which might include
985 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
986 use this soon after launch and only when nothing is mounted.
988 Not all of the filesystems returned will be mountable. In
989 particular, swap partitions are returned in the list. Also
990 this command does not check that each filesystem
991 found is valid and mountable, and some filesystems might
992 be mountable but require special options. Filesystems may
993 not all belong to a single logical operating system
994 (use C<guestfs_inspect_os> to look for OSes).");
996 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
998 "add an image to examine or modify",
1000 This function adds a virtual machine disk image C<filename> to
1001 libguestfs. The first time you call this function, the disk
1002 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1005 You don't necessarily need to be root when using libguestfs. However
1006 you obviously do need sufficient permissions to access the filename
1007 for whatever operations you want to perform (ie. read access if you
1008 just want to read the image or write access if you want to modify the
1011 This call checks that C<filename> exists.
1013 The optional arguments are:
1019 If true then the image is treated as read-only. Writes are still
1020 allowed, but they are stored in a temporary snapshot overlay which
1021 is discarded at the end. The disk that you add is not modified.
1025 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1026 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1027 Possible formats include C<raw> and C<qcow2>.
1029 Automatic detection of the format opens you up to a potential
1030 security hole when dealing with untrusted raw-format images.
1031 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1036 This rarely-used option lets you emulate the behaviour of the
1037 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1041 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1043 "get Windows systemroot of inspected operating system",
1045 This function should only be called with a root device string
1046 as returned by C<guestfs_inspect_os>.
1048 This returns the Windows systemroot of the inspected guest.
1049 The systemroot is a directory path such as C</WINDOWS>.
1051 This call assumes that the guest is Windows and that the
1052 systemroot could be determined by inspection. If this is not
1053 the case then an error is returned.
1055 Please read L<guestfs(3)/INSPECTION> for more details.");
1057 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1059 "return list of operating systems found by last inspection",
1061 This function is a convenient way to get the list of root
1062 devices, as returned from a previous call to C<guestfs_inspect_os>,
1063 but without redoing the whole inspection process.
1065 This returns an empty list if either no root devices were
1066 found or the caller has not called C<guestfs_inspect_os>.
1068 Please read L<guestfs(3)/INSPECTION> for more details.");
1070 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1072 "debug the QEMU command line (internal use only)",
1074 This returns the internal QEMU command line. 'debug' commands are
1075 not part of the formal API and can be removed or changed at any time.");
1077 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"]), -1, [FishAlias "domain"],
1079 "add the disk(s) from a named libvirt domain",
1081 This function adds the disk(s) attached to the named libvirt
1082 domain C<dom>. It works by connecting to libvirt, requesting
1083 the domain and domain XML from libvirt, parsing it for disks,
1084 and calling C<guestfs_add_drive_opts> on each one.
1086 The number of disks added is returned. This operation is atomic:
1087 if an error is returned, then no disks are added.
1089 This function does some minimal checks to make sure the libvirt
1090 domain is not running (unless C<readonly> is true). In a future
1091 version we will try to acquire the libvirt lock on each disk.
1093 Disks must be accessible locally. This often means that adding disks
1094 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1095 will fail unless those disks are accessible via the same device path
1098 The optional C<libvirturi> parameter sets the libvirt URI
1099 (see L<http://libvirt.org/uri.html>). If this is not set then
1100 we connect to the default libvirt URI (or one set through an
1101 environment variable, see the libvirt documentation for full
1104 The optional C<live> flag controls whether this call will try
1105 to connect to a running virtual machine C<guestfsd> process if
1106 it sees a suitable E<lt>channelE<gt> element in the libvirt
1107 XML definition. The default (if the flag is omitted) is never
1110 The other optional parameters are passed directly through to
1111 C<guestfs_add_drive_opts>.");
1114 This interface is not quite baked yet. -- RWMJ 2010-11-11
1115 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1117 "add the disk(s) from a libvirt domain",
1119 This function adds the disk(s) attached to the libvirt domain C<dom>.
1120 It works by requesting the domain XML from libvirt, parsing it for
1121 disks, and calling C<guestfs_add_drive_opts> on each one.
1123 In the C API we declare C<void *dom>, but really it has type
1124 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1126 The number of disks added is returned. This operation is atomic:
1127 if an error is returned, then no disks are added.
1129 This function does some minimal checks to make sure the libvirt
1130 domain is not running (unless C<readonly> is true). In a future
1131 version we will try to acquire the libvirt lock on each disk.
1133 Disks must be accessible locally. This often means that adding disks
1134 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1135 will fail unless those disks are accessible via the same device path
1138 The optional C<live> flag controls whether this call will try
1139 to connect to a running virtual machine C<guestfsd> process if
1140 it sees a suitable E<lt>channelE<gt> element in the libvirt
1141 XML definition. The default (if the flag is omitted) is never
1144 The other optional parameters are passed directly through to
1145 C<guestfs_add_drive_opts>.");
1148 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1150 "get package format used by the operating system",
1152 This function should only be called with a root device string
1153 as returned by C<guestfs_inspect_os>.
1155 This function and C<guestfs_inspect_get_package_management> return
1156 the package format and package management tool used by the
1157 inspected operating system. For example for Fedora these
1158 functions would return C<rpm> (package format) and
1159 C<yum> (package management).
1161 This returns the string C<unknown> if we could not determine the
1162 package format I<or> if the operating system does not have
1163 a real packaging system (eg. Windows).
1165 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1166 Future versions of libguestfs may return other strings.
1168 Please read L<guestfs(3)/INSPECTION> for more details.");
1170 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1172 "get package management tool used by the operating system",
1174 This function should only be called with a root device string
1175 as returned by C<guestfs_inspect_os>.
1177 C<guestfs_inspect_get_package_format> and this function return
1178 the package format and package management tool used by the
1179 inspected operating system. For example for Fedora these
1180 functions would return C<rpm> (package format) and
1181 C<yum> (package management).
1183 This returns the string C<unknown> if we could not determine the
1184 package management tool I<or> if the operating system does not have
1185 a real packaging system (eg. Windows).
1187 Possible strings include: C<yum>, C<up2date>,
1188 C<apt> (for all Debian derivatives),
1189 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1190 Future versions of libguestfs may return other strings.
1192 Please read L<guestfs(3)/INSPECTION> for more details.");
1194 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1196 "get list of applications installed in the operating system",
1198 This function should only be called with a root device string
1199 as returned by C<guestfs_inspect_os>.
1201 Return the list of applications installed in the operating system.
1203 I<Note:> This call works differently from other parts of the
1204 inspection API. You have to call C<guestfs_inspect_os>, then
1205 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1206 before calling this. Listing applications is a significantly
1207 more difficult operation which requires access to the full
1208 filesystem. Also note that unlike the other
1209 C<guestfs_inspect_get_*> calls which are just returning
1210 data cached in the libguestfs handle, this call actually reads
1211 parts of the mounted filesystems during the call.
1213 This returns an empty list if the inspection code was not able
1214 to determine the list of applications.
1216 The application structure contains the following fields:
1222 The name of the application. For Red Hat-derived and Debian-derived
1223 Linux guests, this is the package name.
1225 =item C<app_display_name>
1227 The display name of the application, sometimes localized to the
1228 install language of the guest operating system.
1230 If unavailable this is returned as an empty string C<\"\">.
1231 Callers needing to display something can use C<app_name> instead.
1235 For package managers which use epochs, this contains the epoch of
1236 the package (an integer). If unavailable, this is returned as C<0>.
1238 =item C<app_version>
1240 The version string of the application or package. If unavailable
1241 this is returned as an empty string C<\"\">.
1243 =item C<app_release>
1245 The release string of the application or package, for package
1246 managers that use this. If unavailable this is returned as an
1247 empty string C<\"\">.
1249 =item C<app_install_path>
1251 The installation path of the application (on operating systems
1252 such as Windows which use installation paths). This path is
1253 in the format used by the guest operating system, it is not
1256 If unavailable this is returned as an empty string C<\"\">.
1258 =item C<app_trans_path>
1260 The install path translated into a libguestfs path.
1261 If unavailable this is returned as an empty string C<\"\">.
1263 =item C<app_publisher>
1265 The name of the publisher of the application, for package
1266 managers that use this. If unavailable this is returned
1267 as an empty string C<\"\">.
1271 The URL (eg. upstream URL) of the application.
1272 If unavailable this is returned as an empty string C<\"\">.
1274 =item C<app_source_package>
1276 For packaging systems which support this, the name of the source
1277 package. If unavailable this is returned as an empty string C<\"\">.
1279 =item C<app_summary>
1281 A short (usually one line) description of the application or package.
1282 If unavailable this is returned as an empty string C<\"\">.
1284 =item C<app_description>
1286 A longer description of the application or package.
1287 If unavailable this is returned as an empty string C<\"\">.
1291 Please read L<guestfs(3)/INSPECTION> for more details.");
1293 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1295 "get hostname of the operating system",
1297 This function should only be called with a root device string
1298 as returned by C<guestfs_inspect_os>.
1300 This function returns the hostname of the operating system
1301 as found by inspection of the guest's configuration files.
1303 If the hostname could not be determined, then the
1304 string C<unknown> is returned.
1306 Please read L<guestfs(3)/INSPECTION> for more details.");
1308 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1310 "get format of inspected operating system",
1312 This function should only be called with a root device string
1313 as returned by C<guestfs_inspect_os>.
1315 This returns the format of the inspected operating system. You
1316 can use it to detect install images, live CDs and similar.
1318 Currently defined formats are:
1324 This is an installed operating system.
1328 The disk image being inspected is not an installed operating system,
1329 but a I<bootable> install disk, live CD, or similar.
1333 The format of this disk image is not known.
1337 Future versions of libguestfs may return other strings here.
1338 The caller should be prepared to handle any string.
1340 Please read L<guestfs(3)/INSPECTION> for more details.");
1342 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1344 "get live flag for install disk",
1346 This function should only be called with a root device string
1347 as returned by C<guestfs_inspect_os>.
1349 If C<guestfs_inspect_get_format> returns C<installer> (this
1350 is an install disk), then this returns true if a live image
1351 was detected on the disk.
1353 Please read L<guestfs(3)/INSPECTION> for more details.");
1355 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1357 "get netinst (network installer) flag for install disk",
1359 This function should only be called with a root device string
1360 as returned by C<guestfs_inspect_os>.
1362 If C<guestfs_inspect_get_format> returns C<installer> (this
1363 is an install disk), then this returns true if the disk is
1364 a network installer, ie. not a self-contained install CD but
1365 one which is likely to require network access to complete
1368 Please read L<guestfs(3)/INSPECTION> for more details.");
1370 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1372 "get multipart flag for install disk",
1374 This function should only be called with a root device string
1375 as returned by C<guestfs_inspect_os>.
1377 If C<guestfs_inspect_get_format> returns C<installer> (this
1378 is an install disk), then this returns true if the disk is
1381 Please read L<guestfs(3)/INSPECTION> for more details.");
1383 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1385 "set the attach method",
1387 Set the method that libguestfs uses to connect to the back end
1388 guestfsd daemon. Possible methods are:
1394 Launch an appliance and connect to it. This is the ordinary method
1397 =item C<unix:I<path>>
1399 Connect to the Unix domain socket I<path>.
1401 This method lets you connect to an existing daemon or (using
1402 virtio-serial) to a live guest.
1406 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1407 [InitNone, Always, TestOutput (
1408 [["get_attach_method"]], "appliance")],
1409 "get the attach method",
1411 Return the current attach method. See C<guestfs_set_attach_method>.");
1415 (* daemon_functions are any functions which cause some action
1416 * to take place in the daemon.
1419 let daemon_functions = [
1420 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1421 [InitEmpty, Always, TestOutput (
1422 [["part_disk"; "/dev/sda"; "mbr"];
1423 ["mkfs"; "ext2"; "/dev/sda1"];
1424 ["mount"; "/dev/sda1"; "/"];
1425 ["write"; "/new"; "new file contents"];
1426 ["cat"; "/new"]], "new file contents")],
1427 "mount a guest disk at a position in the filesystem",
1429 Mount a guest disk at a position in the filesystem. Block devices
1430 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1431 the guest. If those block devices contain partitions, they will have
1432 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1435 The rules are the same as for L<mount(2)>: A filesystem must
1436 first be mounted on C</> before others can be mounted. Other
1437 filesystems can only be mounted on directories which already
1440 The mounted filesystem is writable, if we have sufficient permissions
1441 on the underlying device.
1444 When you use this call, the filesystem options C<sync> and C<noatime>
1445 are set implicitly. This was originally done because we thought it
1446 would improve reliability, but it turns out that I<-o sync> has a
1447 very large negative performance impact and negligible effect on
1448 reliability. Therefore we recommend that you avoid using
1449 C<guestfs_mount> in any code that needs performance, and instead
1450 use C<guestfs_mount_options> (use an empty string for the first
1451 parameter if you don't want any options).");
1453 ("sync", (RErr, [], []), 2, [],
1454 [ InitEmpty, Always, TestRun [["sync"]]],
1455 "sync disks, writes are flushed through to the disk image",
1457 This syncs the disk, so that any writes are flushed through to the
1458 underlying disk image.
1460 You should always call this if you have modified a disk image, before
1461 closing the handle.");
1463 ("touch", (RErr, [Pathname "path"], []), 3, [],
1464 [InitScratchFS, Always, TestOutputTrue (
1465 [["touch"; "/touch"];
1466 ["exists"; "/touch"]])],
1467 "update file timestamps or create a new file",
1469 Touch acts like the L<touch(1)> command. It can be used to
1470 update the timestamps on a file, or, if the file does not exist,
1471 to create a new zero-length file.
1473 This command only works on regular files, and will fail on other
1474 file types such as directories, symbolic links, block special etc.");
1476 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1477 [InitISOFS, Always, TestOutput (
1478 [["cat"; "/known-2"]], "abcdef\n")],
1479 "list the contents of a file",
1481 Return the contents of the file named C<path>.
1483 Note that this function cannot correctly handle binary files
1484 (specifically, files containing C<\\0> character which is treated
1485 as end of string). For those you need to use the C<guestfs_read_file>
1486 or C<guestfs_download> functions which have a more complex interface.");
1488 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1489 [], (* XXX Tricky to test because it depends on the exact format
1490 * of the 'ls -l' command, which changes between F10 and F11.
1492 "list the files in a directory (long format)",
1494 List the files in C<directory> (relative to the root directory,
1495 there is no cwd) in the format of 'ls -la'.
1497 This command is mostly useful for interactive sessions. It
1498 is I<not> intended that you try to parse the output string.");
1500 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1501 [InitScratchFS, Always, TestOutputList (
1503 ["touch"; "/ls/new"];
1504 ["touch"; "/ls/newer"];
1505 ["touch"; "/ls/newest"];
1506 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1507 "list the files in a directory",
1509 List the files in C<directory> (relative to the root directory,
1510 there is no cwd). The '.' and '..' entries are not returned, but
1511 hidden files are shown.
1513 This command is mostly useful for interactive sessions. Programs
1514 should probably use C<guestfs_readdir> instead.");
1516 ("list_devices", (RStringList "devices", [], []), 7, [],
1517 [InitEmpty, Always, TestOutputListOfDevices (
1518 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1519 "list the block devices",
1521 List all the block devices.
1523 The full block device names are returned, eg. C</dev/sda>.
1525 See also C<guestfs_list_filesystems>.");
1527 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1528 [InitBasicFS, Always, TestOutputListOfDevices (
1529 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1530 InitEmpty, Always, TestOutputListOfDevices (
1531 [["part_init"; "/dev/sda"; "mbr"];
1532 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1533 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1534 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1535 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1536 "list the partitions",
1538 List all the partitions detected on all block devices.
1540 The full partition device names are returned, eg. C</dev/sda1>
1542 This does not return logical volumes. For that you will need to
1543 call C<guestfs_lvs>.
1545 See also C<guestfs_list_filesystems>.");
1547 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1548 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1549 [["pvs"]], ["/dev/sda1"]);
1550 InitEmpty, Always, TestOutputListOfDevices (
1551 [["part_init"; "/dev/sda"; "mbr"];
1552 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1553 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1554 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1555 ["pvcreate"; "/dev/sda1"];
1556 ["pvcreate"; "/dev/sda2"];
1557 ["pvcreate"; "/dev/sda3"];
1558 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1559 "list the LVM physical volumes (PVs)",
1561 List all the physical volumes detected. This is the equivalent
1562 of the L<pvs(8)> command.
1564 This returns a list of just the device names that contain
1565 PVs (eg. C</dev/sda2>).
1567 See also C<guestfs_pvs_full>.");
1569 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1570 [InitBasicFSonLVM, Always, TestOutputList (
1572 InitEmpty, Always, TestOutputList (
1573 [["part_init"; "/dev/sda"; "mbr"];
1574 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1575 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1576 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1577 ["pvcreate"; "/dev/sda1"];
1578 ["pvcreate"; "/dev/sda2"];
1579 ["pvcreate"; "/dev/sda3"];
1580 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1581 ["vgcreate"; "VG2"; "/dev/sda3"];
1582 ["vgs"]], ["VG1"; "VG2"])],
1583 "list the LVM volume groups (VGs)",
1585 List all the volumes groups detected. This is the equivalent
1586 of the L<vgs(8)> command.
1588 This returns a list of just the volume group names that were
1589 detected (eg. C<VolGroup00>).
1591 See also C<guestfs_vgs_full>.");
1593 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1594 [InitBasicFSonLVM, Always, TestOutputList (
1595 [["lvs"]], ["/dev/VG/LV"]);
1596 InitEmpty, Always, TestOutputList (
1597 [["part_init"; "/dev/sda"; "mbr"];
1598 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1599 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1600 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1601 ["pvcreate"; "/dev/sda1"];
1602 ["pvcreate"; "/dev/sda2"];
1603 ["pvcreate"; "/dev/sda3"];
1604 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1605 ["vgcreate"; "VG2"; "/dev/sda3"];
1606 ["lvcreate"; "LV1"; "VG1"; "50"];
1607 ["lvcreate"; "LV2"; "VG1"; "50"];
1608 ["lvcreate"; "LV3"; "VG2"; "50"];
1609 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1610 "list the LVM logical volumes (LVs)",
1612 List all the logical volumes detected. This is the equivalent
1613 of the L<lvs(8)> command.
1615 This returns a list of the logical volume device names
1616 (eg. C</dev/VolGroup00/LogVol00>).
1618 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1620 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1621 [], (* XXX how to test? *)
1622 "list the LVM physical volumes (PVs)",
1624 List all the physical volumes detected. This is the equivalent
1625 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1627 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1628 [], (* XXX how to test? *)
1629 "list the LVM volume groups (VGs)",
1631 List all the volumes groups detected. This is the equivalent
1632 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1634 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1635 [], (* XXX how to test? *)
1636 "list the LVM logical volumes (LVs)",
1638 List all the logical volumes detected. This is the equivalent
1639 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1641 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1642 [InitISOFS, Always, TestOutputList (
1643 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1644 InitISOFS, Always, TestOutputList (
1645 [["read_lines"; "/empty"]], [])],
1646 "read file as lines",
1648 Return the contents of the file named C<path>.
1650 The file contents are returned as a list of lines. Trailing
1651 C<LF> and C<CRLF> character sequences are I<not> returned.
1653 Note that this function cannot correctly handle binary files
1654 (specifically, files containing C<\\0> character which is treated
1655 as end of line). For those you need to use the C<guestfs_read_file>
1656 function which has a more complex interface.");
1658 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1659 [], (* XXX Augeas code needs tests. *)
1660 "create a new Augeas handle",
1662 Create a new Augeas handle for editing configuration files.
1663 If there was any previous Augeas handle associated with this
1664 guestfs session, then it is closed.
1666 You must call this before using any other C<guestfs_aug_*>
1669 C<root> is the filesystem root. C<root> must not be NULL,
1672 The flags are the same as the flags defined in
1673 E<lt>augeas.hE<gt>, the logical I<or> of the following
1678 =item C<AUG_SAVE_BACKUP> = 1
1680 Keep the original file with a C<.augsave> extension.
1682 =item C<AUG_SAVE_NEWFILE> = 2
1684 Save changes into a file with extension C<.augnew>, and
1685 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1687 =item C<AUG_TYPE_CHECK> = 4
1689 Typecheck lenses (can be expensive).
1691 =item C<AUG_NO_STDINC> = 8
1693 Do not use standard load path for modules.
1695 =item C<AUG_SAVE_NOOP> = 16
1697 Make save a no-op, just record what would have been changed.
1699 =item C<AUG_NO_LOAD> = 32
1701 Do not load the tree in C<guestfs_aug_init>.
1705 To close the handle, you can call C<guestfs_aug_close>.
1707 To find out more about Augeas, see L<http://augeas.net/>.");
1709 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1710 [], (* XXX Augeas code needs tests. *)
1711 "close the current Augeas handle",
1713 Close the current Augeas handle and free up any resources
1714 used by it. After calling this, you have to call
1715 C<guestfs_aug_init> again before you can use any other
1716 Augeas functions.");
1718 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1719 [], (* XXX Augeas code needs tests. *)
1720 "define an Augeas variable",
1722 Defines an Augeas variable C<name> whose value is the result
1723 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1726 On success this returns the number of nodes in C<expr>, or
1727 C<0> if C<expr> evaluates to something which is not a nodeset.");
1729 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1730 [], (* XXX Augeas code needs tests. *)
1731 "define an Augeas node",
1733 Defines a variable C<name> whose value is the result of
1736 If C<expr> evaluates to an empty nodeset, a node is created,
1737 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1738 C<name> will be the nodeset containing that single node.
1740 On success this returns a pair containing the
1741 number of nodes in the nodeset, and a boolean flag
1742 if a node was created.");
1744 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1745 [], (* XXX Augeas code needs tests. *)
1746 "look up the value of an Augeas path",
1748 Look up the value associated with C<path>. If C<path>
1749 matches exactly one node, the C<value> is returned.");
1751 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1752 [], (* XXX Augeas code needs tests. *)
1753 "set Augeas path to value",
1755 Set the value associated with C<path> to C<val>.
1757 In the Augeas API, it is possible to clear a node by setting
1758 the value to NULL. Due to an oversight in the libguestfs API
1759 you cannot do that with this call. Instead you must use the
1760 C<guestfs_aug_clear> call.");
1762 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1763 [], (* XXX Augeas code needs tests. *)
1764 "insert a sibling Augeas node",
1766 Create a new sibling C<label> for C<path>, inserting it into
1767 the tree before or after C<path> (depending on the boolean
1770 C<path> must match exactly one existing node in the tree, and
1771 C<label> must be a label, ie. not contain C</>, C<*> or end
1772 with a bracketed index C<[N]>.");
1774 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1775 [], (* XXX Augeas code needs tests. *)
1776 "remove an Augeas path",
1778 Remove C<path> and all of its children.
1780 On success this returns the number of entries which were removed.");
1782 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1783 [], (* XXX Augeas code needs tests. *)
1786 Move the node C<src> to C<dest>. C<src> must match exactly
1787 one node. C<dest> is overwritten if it exists.");
1789 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1790 [], (* XXX Augeas code needs tests. *)
1791 "return Augeas nodes which match augpath",
1793 Returns a list of paths which match the path expression C<path>.
1794 The returned paths are sufficiently qualified so that they match
1795 exactly one node in the current tree.");
1797 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1798 [], (* XXX Augeas code needs tests. *)
1799 "write all pending Augeas changes to disk",
1801 This writes all pending changes to disk.
1803 The flags which were passed to C<guestfs_aug_init> affect exactly
1804 how files are saved.");
1806 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1807 [], (* XXX Augeas code needs tests. *)
1808 "load files into the tree",
1810 Load files into the tree.
1812 See C<aug_load> in the Augeas documentation for the full gory
1815 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1816 [], (* XXX Augeas code needs tests. *)
1817 "list Augeas nodes under augpath",
1819 This is just a shortcut for listing C<guestfs_aug_match>
1820 C<path/*> and sorting the resulting nodes into alphabetical order.");
1822 ("rm", (RErr, [Pathname "path"], []), 29, [],
1823 [InitScratchFS, Always, TestRun
1825 ["touch"; "/rm/new"];
1827 InitScratchFS, Always, TestLastFail
1828 [["rm"; "/nosuchfile"]];
1829 InitScratchFS, Always, TestLastFail
1834 Remove the single file C<path>.");
1836 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1837 [InitScratchFS, Always, TestRun
1838 [["mkdir"; "/rmdir"];
1839 ["rmdir"; "/rmdir"]];
1840 InitScratchFS, Always, TestLastFail
1841 [["rmdir"; "/rmdir2"]];
1842 InitScratchFS, Always, TestLastFail
1843 [["mkdir"; "/rmdir3"];
1844 ["touch"; "/rmdir3/new"];
1845 ["rmdir"; "/rmdir3/new"]]],
1846 "remove a directory",
1848 Remove the single directory C<path>.");
1850 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1851 [InitScratchFS, Always, TestOutputFalse
1852 [["mkdir"; "/rm_rf"];
1853 ["mkdir"; "/rm_rf/foo"];
1854 ["touch"; "/rm_rf/foo/bar"];
1855 ["rm_rf"; "/rm_rf"];
1856 ["exists"; "/rm_rf"]]],
1857 "remove a file or directory recursively",
1859 Remove the file or directory C<path>, recursively removing the
1860 contents if its a directory. This is like the C<rm -rf> shell
1863 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1864 [InitScratchFS, Always, TestOutputTrue
1865 [["mkdir"; "/mkdir"];
1866 ["is_dir"; "/mkdir"]];
1867 InitScratchFS, Always, TestLastFail
1868 [["mkdir"; "/mkdir2/foo/bar"]]],
1869 "create a directory",
1871 Create a directory named C<path>.");
1873 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1874 [InitScratchFS, Always, TestOutputTrue
1875 [["mkdir_p"; "/mkdir_p/foo/bar"];
1876 ["is_dir"; "/mkdir_p/foo/bar"]];
1877 InitScratchFS, Always, TestOutputTrue
1878 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1879 ["is_dir"; "/mkdir_p2/foo"]];
1880 InitScratchFS, Always, TestOutputTrue
1881 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1882 ["is_dir"; "/mkdir_p3"]];
1883 (* Regression tests for RHBZ#503133: *)
1884 InitScratchFS, Always, TestRun
1885 [["mkdir"; "/mkdir_p4"];
1886 ["mkdir_p"; "/mkdir_p4"]];
1887 InitScratchFS, Always, TestLastFail
1888 [["touch"; "/mkdir_p5"];
1889 ["mkdir_p"; "/mkdir_p5"]]],
1890 "create a directory and parents",
1892 Create a directory named C<path>, creating any parent directories
1893 as necessary. This is like the C<mkdir -p> shell command.");
1895 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1896 [], (* XXX Need stat command to test *)
1899 Change the mode (permissions) of C<path> to C<mode>. Only
1900 numeric modes are supported.
1902 I<Note>: When using this command from guestfish, C<mode>
1903 by default would be decimal, unless you prefix it with
1904 C<0> to get octal, ie. use C<0700> not C<700>.
1906 The mode actually set is affected by the umask.");
1908 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1909 [], (* XXX Need stat command to test *)
1910 "change file owner and group",
1912 Change the file owner to C<owner> and group to C<group>.
1914 Only numeric uid and gid are supported. If you want to use
1915 names, you will need to locate and parse the password file
1916 yourself (Augeas support makes this relatively easy).");
1918 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1919 [InitISOFS, Always, TestOutputTrue (
1920 [["exists"; "/empty"]]);
1921 InitISOFS, Always, TestOutputTrue (
1922 [["exists"; "/directory"]])],
1923 "test if file or directory exists",
1925 This returns C<true> if and only if there is a file, directory
1926 (or anything) with the given C<path> name.
1928 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1930 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1931 [InitISOFS, Always, TestOutputTrue (
1932 [["is_file"; "/known-1"]]);
1933 InitISOFS, Always, TestOutputFalse (
1934 [["is_file"; "/directory"]])],
1935 "test if a regular file",
1937 This returns C<true> if and only if there is a regular file
1938 with the given C<path> name. Note that it returns false for
1939 other objects like directories.
1941 See also C<guestfs_stat>.");
1943 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1944 [InitISOFS, Always, TestOutputFalse (
1945 [["is_dir"; "/known-3"]]);
1946 InitISOFS, Always, TestOutputTrue (
1947 [["is_dir"; "/directory"]])],
1948 "test if a directory",
1950 This returns C<true> if and only if there is a directory
1951 with the given C<path> name. Note that it returns false for
1952 other objects like files.
1954 See also C<guestfs_stat>.");
1956 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1957 [InitEmpty, Always, TestOutputListOfDevices (
1958 [["part_init"; "/dev/sda"; "mbr"];
1959 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1960 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1961 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1962 ["pvcreate"; "/dev/sda1"];
1963 ["pvcreate"; "/dev/sda2"];
1964 ["pvcreate"; "/dev/sda3"];
1965 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1966 "create an LVM physical volume",
1968 This creates an LVM physical volume on the named C<device>,
1969 where C<device> should usually be a partition name such
1972 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1973 [InitEmpty, Always, TestOutputList (
1974 [["part_init"; "/dev/sda"; "mbr"];
1975 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1976 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1977 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1978 ["pvcreate"; "/dev/sda1"];
1979 ["pvcreate"; "/dev/sda2"];
1980 ["pvcreate"; "/dev/sda3"];
1981 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1982 ["vgcreate"; "VG2"; "/dev/sda3"];
1983 ["vgs"]], ["VG1"; "VG2"])],
1984 "create an LVM volume group",
1986 This creates an LVM volume group called C<volgroup>
1987 from the non-empty list of physical volumes C<physvols>.");
1989 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
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 ["pvcreate"; "/dev/sda1"];
1996 ["pvcreate"; "/dev/sda2"];
1997 ["pvcreate"; "/dev/sda3"];
1998 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1999 ["vgcreate"; "VG2"; "/dev/sda3"];
2000 ["lvcreate"; "LV1"; "VG1"; "50"];
2001 ["lvcreate"; "LV2"; "VG1"; "50"];
2002 ["lvcreate"; "LV3"; "VG2"; "50"];
2003 ["lvcreate"; "LV4"; "VG2"; "50"];
2004 ["lvcreate"; "LV5"; "VG2"; "50"];
2006 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2007 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2008 "create an LVM logical volume",
2010 This creates an LVM logical volume called C<logvol>
2011 on the volume group C<volgroup>, with C<size> megabytes.");
2013 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2014 [InitEmpty, Always, TestOutput (
2015 [["part_disk"; "/dev/sda"; "mbr"];
2016 ["mkfs"; "ext2"; "/dev/sda1"];
2017 ["mount_options"; ""; "/dev/sda1"; "/"];
2018 ["write"; "/new"; "new file contents"];
2019 ["cat"; "/new"]], "new file contents")],
2020 "make a filesystem",
2022 This creates a filesystem on C<device> (usually a partition
2023 or LVM logical volume). The filesystem type is C<fstype>, for
2026 ("sfdisk", (RErr, [Device "device";
2027 Int "cyls"; Int "heads"; Int "sectors";
2028 StringList "lines"], []), 43, [DangerWillRobinson],
2030 "create partitions on a block device",
2032 This is a direct interface to the L<sfdisk(8)> program for creating
2033 partitions on block devices.
2035 C<device> should be a block device, for example C</dev/sda>.
2037 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2038 and sectors on the device, which are passed directly to sfdisk as
2039 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2040 of these, then the corresponding parameter is omitted. Usually for
2041 'large' disks, you can just pass C<0> for these, but for small
2042 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2043 out the right geometry and you will need to tell it.
2045 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2046 information refer to the L<sfdisk(8)> manpage.
2048 To create a single partition occupying the whole disk, you would
2049 pass C<lines> as a single element list, when the single element being
2050 the string C<,> (comma).
2052 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2053 C<guestfs_part_init>");
2055 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2056 (* Regression test for RHBZ#597135. *)
2057 [InitScratchFS, Always, TestLastFail
2058 [["write_file"; "/write_file"; "abc"; "10000"]]],
2061 This call creates a file called C<path>. The contents of the
2062 file is the string C<content> (which can contain any 8 bit data),
2063 with length C<size>.
2065 As a special case, if C<size> is C<0>
2066 then the length is calculated using C<strlen> (so in this case
2067 the content cannot contain embedded ASCII NULs).
2069 I<NB.> Owing to a bug, writing content containing ASCII NUL
2070 characters does I<not> work, even if the length is specified.");
2072 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2073 [InitEmpty, Always, TestOutputListOfDevices (
2074 [["part_disk"; "/dev/sda"; "mbr"];
2075 ["mkfs"; "ext2"; "/dev/sda1"];
2076 ["mount_options"; ""; "/dev/sda1"; "/"];
2077 ["mounts"]], ["/dev/sda1"]);
2078 InitEmpty, Always, TestOutputList (
2079 [["part_disk"; "/dev/sda"; "mbr"];
2080 ["mkfs"; "ext2"; "/dev/sda1"];
2081 ["mount_options"; ""; "/dev/sda1"; "/"];
2084 "unmount a filesystem",
2086 This unmounts the given filesystem. The filesystem may be
2087 specified either by its mountpoint (path) or the device which
2088 contains the filesystem.");
2090 ("mounts", (RStringList "devices", [], []), 46, [],
2091 [InitScratchFS, Always, TestOutputListOfDevices (
2092 [["mounts"]], ["/dev/sdb1"])],
2093 "show mounted filesystems",
2095 This returns the list of currently mounted filesystems. It returns
2096 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2098 Some internal mounts are not shown.
2100 See also: C<guestfs_mountpoints>");
2102 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2103 [InitScratchFS, Always, TestOutputList (
2106 (* check that umount_all can unmount nested mounts correctly: *)
2107 InitEmpty, Always, TestOutputList (
2108 [["part_init"; "/dev/sda"; "mbr"];
2109 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2110 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2111 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2112 ["mkfs"; "ext2"; "/dev/sda1"];
2113 ["mkfs"; "ext2"; "/dev/sda2"];
2114 ["mkfs"; "ext2"; "/dev/sda3"];
2115 ["mount_options"; ""; "/dev/sda1"; "/"];
2117 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2118 ["mkdir"; "/mp1/mp2"];
2119 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2120 ["mkdir"; "/mp1/mp2/mp3"];
2123 "unmount all filesystems",
2125 This unmounts all mounted filesystems.
2127 Some internal mounts are not unmounted by this call.");
2129 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2131 "remove all LVM LVs, VGs and PVs",
2133 This command removes all LVM logical volumes, volume groups
2134 and physical volumes.");
2136 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2137 [InitISOFS, Always, TestOutput (
2138 [["file"; "/empty"]], "empty");
2139 InitISOFS, Always, TestOutput (
2140 [["file"; "/known-1"]], "ASCII text");
2141 InitISOFS, Always, TestLastFail (
2142 [["file"; "/notexists"]]);
2143 InitISOFS, Always, TestOutput (
2144 [["file"; "/abssymlink"]], "symbolic link");
2145 InitISOFS, Always, TestOutput (
2146 [["file"; "/directory"]], "directory")],
2147 "determine file type",
2149 This call uses the standard L<file(1)> command to determine
2150 the type or contents of the file.
2152 This call will also transparently look inside various types
2155 The exact command which runs is C<file -zb path>. Note in
2156 particular that the filename is not prepended to the output
2159 This command can also be used on C</dev/> devices
2160 (and partitions, LV names). You can for example use this
2161 to determine if a device contains a filesystem, although
2162 it's usually better to use C<guestfs_vfs_type>.
2164 If the C<path> does not begin with C</dev/> then
2165 this command only works for the content of regular files.
2166 For other file types (directory, symbolic link etc) it
2167 will just return the string C<directory> etc.");
2169 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2170 [InitScratchFS, Always, TestOutput (
2171 [["mkdir"; "/command"];
2172 ["upload"; "test-command"; "/command/test-command"];
2173 ["chmod"; "0o755"; "/command/test-command"];
2174 ["command"; "/command/test-command 1"]], "Result1");
2175 InitScratchFS, Always, TestOutput (
2176 [["mkdir"; "/command2"];
2177 ["upload"; "test-command"; "/command2/test-command"];
2178 ["chmod"; "0o755"; "/command2/test-command"];
2179 ["command"; "/command2/test-command 2"]], "Result2\n");
2180 InitScratchFS, Always, TestOutput (
2181 [["mkdir"; "/command3"];
2182 ["upload"; "test-command"; "/command3/test-command"];
2183 ["chmod"; "0o755"; "/command3/test-command"];
2184 ["command"; "/command3/test-command 3"]], "\nResult3");
2185 InitScratchFS, Always, TestOutput (
2186 [["mkdir"; "/command4"];
2187 ["upload"; "test-command"; "/command4/test-command"];
2188 ["chmod"; "0o755"; "/command4/test-command"];
2189 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2190 InitScratchFS, Always, TestOutput (
2191 [["mkdir"; "/command5"];
2192 ["upload"; "test-command"; "/command5/test-command"];
2193 ["chmod"; "0o755"; "/command5/test-command"];
2194 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2195 InitScratchFS, Always, TestOutput (
2196 [["mkdir"; "/command6"];
2197 ["upload"; "test-command"; "/command6/test-command"];
2198 ["chmod"; "0o755"; "/command6/test-command"];
2199 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2200 InitScratchFS, Always, TestOutput (
2201 [["mkdir"; "/command7"];
2202 ["upload"; "test-command"; "/command7/test-command"];
2203 ["chmod"; "0o755"; "/command7/test-command"];
2204 ["command"; "/command7/test-command 7"]], "");
2205 InitScratchFS, Always, TestOutput (
2206 [["mkdir"; "/command8"];
2207 ["upload"; "test-command"; "/command8/test-command"];
2208 ["chmod"; "0o755"; "/command8/test-command"];
2209 ["command"; "/command8/test-command 8"]], "\n");
2210 InitScratchFS, Always, TestOutput (
2211 [["mkdir"; "/command9"];
2212 ["upload"; "test-command"; "/command9/test-command"];
2213 ["chmod"; "0o755"; "/command9/test-command"];
2214 ["command"; "/command9/test-command 9"]], "\n\n");
2215 InitScratchFS, Always, TestOutput (
2216 [["mkdir"; "/command10"];
2217 ["upload"; "test-command"; "/command10/test-command"];
2218 ["chmod"; "0o755"; "/command10/test-command"];
2219 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2220 InitScratchFS, Always, TestOutput (
2221 [["mkdir"; "/command11"];
2222 ["upload"; "test-command"; "/command11/test-command"];
2223 ["chmod"; "0o755"; "/command11/test-command"];
2224 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2225 InitScratchFS, Always, TestLastFail (
2226 [["mkdir"; "/command12"];
2227 ["upload"; "test-command"; "/command12/test-command"];
2228 ["chmod"; "0o755"; "/command12/test-command"];
2229 ["command"; "/command12/test-command"]])],
2230 "run a command from the guest filesystem",
2232 This call runs a command from the guest filesystem. The
2233 filesystem must be mounted, and must contain a compatible
2234 operating system (ie. something Linux, with the same
2235 or compatible processor architecture).
2237 The single parameter is an argv-style list of arguments.
2238 The first element is the name of the program to run.
2239 Subsequent elements are parameters. The list must be
2240 non-empty (ie. must contain a program name). Note that
2241 the command runs directly, and is I<not> invoked via
2242 the shell (see C<guestfs_sh>).
2244 The return value is anything printed to I<stdout> by
2247 If the command returns a non-zero exit status, then
2248 this function returns an error message. The error message
2249 string is the content of I<stderr> from the command.
2251 The C<$PATH> environment variable will contain at least
2252 C</usr/bin> and C</bin>. If you require a program from
2253 another location, you should provide the full path in the
2256 Shared libraries and data files required by the program
2257 must be available on filesystems which are mounted in the
2258 correct places. It is the caller's responsibility to ensure
2259 all filesystems that are needed are mounted at the right
2262 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2263 [InitScratchFS, Always, TestOutputList (
2264 [["mkdir"; "/command_lines"];
2265 ["upload"; "test-command"; "/command_lines/test-command"];
2266 ["chmod"; "0o755"; "/command_lines/test-command"];
2267 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2268 InitScratchFS, Always, TestOutputList (
2269 [["mkdir"; "/command_lines2"];
2270 ["upload"; "test-command"; "/command_lines2/test-command"];
2271 ["chmod"; "0o755"; "/command_lines2/test-command"];
2272 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2273 InitScratchFS, Always, TestOutputList (
2274 [["mkdir"; "/command_lines3"];
2275 ["upload"; "test-command"; "/command_lines3/test-command"];
2276 ["chmod"; "0o755"; "/command_lines3/test-command"];
2277 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2278 InitScratchFS, Always, TestOutputList (
2279 [["mkdir"; "/command_lines4"];
2280 ["upload"; "test-command"; "/command_lines4/test-command"];
2281 ["chmod"; "0o755"; "/command_lines4/test-command"];
2282 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2283 InitScratchFS, Always, TestOutputList (
2284 [["mkdir"; "/command_lines5"];
2285 ["upload"; "test-command"; "/command_lines5/test-command"];
2286 ["chmod"; "0o755"; "/command_lines5/test-command"];
2287 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2288 InitScratchFS, Always, TestOutputList (
2289 [["mkdir"; "/command_lines6"];
2290 ["upload"; "test-command"; "/command_lines6/test-command"];
2291 ["chmod"; "0o755"; "/command_lines6/test-command"];
2292 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2293 InitScratchFS, Always, TestOutputList (
2294 [["mkdir"; "/command_lines7"];
2295 ["upload"; "test-command"; "/command_lines7/test-command"];
2296 ["chmod"; "0o755"; "/command_lines7/test-command"];
2297 ["command_lines"; "/command_lines7/test-command 7"]], []);
2298 InitScratchFS, Always, TestOutputList (
2299 [["mkdir"; "/command_lines8"];
2300 ["upload"; "test-command"; "/command_lines8/test-command"];
2301 ["chmod"; "0o755"; "/command_lines8/test-command"];
2302 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2303 InitScratchFS, Always, TestOutputList (
2304 [["mkdir"; "/command_lines9"];
2305 ["upload"; "test-command"; "/command_lines9/test-command"];
2306 ["chmod"; "0o755"; "/command_lines9/test-command"];
2307 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2308 InitScratchFS, Always, TestOutputList (
2309 [["mkdir"; "/command_lines10"];
2310 ["upload"; "test-command"; "/command_lines10/test-command"];
2311 ["chmod"; "0o755"; "/command_lines10/test-command"];
2312 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2313 InitScratchFS, Always, TestOutputList (
2314 [["mkdir"; "/command_lines11"];
2315 ["upload"; "test-command"; "/command_lines11/test-command"];
2316 ["chmod"; "0o755"; "/command_lines11/test-command"];
2317 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2318 "run a command, returning lines",
2320 This is the same as C<guestfs_command>, but splits the
2321 result into a list of lines.
2323 See also: C<guestfs_sh_lines>");
2325 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2326 [InitISOFS, Always, TestOutputStruct (
2327 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2328 "get file information",
2330 Returns file information for the given C<path>.
2332 This is the same as the C<stat(2)> system call.");
2334 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2335 [InitISOFS, Always, TestOutputStruct (
2336 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2337 "get file information for a symbolic link",
2339 Returns file information for the given C<path>.
2341 This is the same as C<guestfs_stat> except that if C<path>
2342 is a symbolic link, then the link is stat-ed, not the file it
2345 This is the same as the C<lstat(2)> system call.");
2347 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2348 [InitISOFS, Always, TestOutputStruct (
2349 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2350 "get file system statistics",
2352 Returns file system statistics for any mounted file system.
2353 C<path> should be a file or directory in the mounted file system
2354 (typically it is the mount point itself, but it doesn't need to be).
2356 This is the same as the C<statvfs(2)> system call.");
2358 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2360 "get ext2/ext3/ext4 superblock details",
2362 This returns the contents of the ext2, ext3 or ext4 filesystem
2363 superblock on C<device>.
2365 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2366 manpage for more details. The list of fields returned isn't
2367 clearly defined, and depends on both the version of C<tune2fs>
2368 that libguestfs was built against, and the filesystem itself.");
2370 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2371 [InitEmpty, Always, TestOutputTrue (
2372 [["blockdev_setro"; "/dev/sda"];
2373 ["blockdev_getro"; "/dev/sda"]])],
2374 "set block device to read-only",
2376 Sets the block device named C<device> to read-only.
2378 This uses the L<blockdev(8)> command.");
2380 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2381 [InitEmpty, Always, TestOutputFalse (
2382 [["blockdev_setrw"; "/dev/sda"];
2383 ["blockdev_getro"; "/dev/sda"]])],
2384 "set block device to read-write",
2386 Sets the block device named C<device> to read-write.
2388 This uses the L<blockdev(8)> command.");
2390 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2391 [InitEmpty, Always, TestOutputTrue (
2392 [["blockdev_setro"; "/dev/sda"];
2393 ["blockdev_getro"; "/dev/sda"]])],
2394 "is block device set to read-only",
2396 Returns a boolean indicating if the block device is read-only
2397 (true if read-only, false if not).
2399 This uses the L<blockdev(8)> command.");
2401 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2402 [InitEmpty, Always, TestOutputInt (
2403 [["blockdev_getss"; "/dev/sda"]], 512)],
2404 "get sectorsize of block device",
2406 This returns the size of sectors on a block device.
2407 Usually 512, but can be larger for modern devices.
2409 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2412 This uses the L<blockdev(8)> command.");
2414 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2415 [InitEmpty, Always, TestOutputInt (
2416 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2417 "get blocksize of block device",
2419 This returns the block size of a device.
2421 (Note this is different from both I<size in blocks> and
2422 I<filesystem block size>).
2424 This uses the L<blockdev(8)> command.");
2426 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2428 "set blocksize of block device",
2430 This sets the block size of a device.
2432 (Note this is different from both I<size in blocks> and
2433 I<filesystem block size>).
2435 This uses the L<blockdev(8)> command.");
2437 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2438 [InitEmpty, Always, TestOutputInt (
2439 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2440 "get total size of device in 512-byte sectors",
2442 This returns the size of the device in units of 512-byte sectors
2443 (even if the sectorsize isn't 512 bytes ... weird).
2445 See also C<guestfs_blockdev_getss> for the real sector size of
2446 the device, and C<guestfs_blockdev_getsize64> for the more
2447 useful I<size in bytes>.
2449 This uses the L<blockdev(8)> command.");
2451 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2452 [InitEmpty, Always, TestOutputInt (
2453 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2454 "get total size of device in bytes",
2456 This returns the size of the device in bytes.
2458 See also C<guestfs_blockdev_getsz>.
2460 This uses the L<blockdev(8)> command.");
2462 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2463 [InitEmpty, Always, TestRun
2464 [["blockdev_flushbufs"; "/dev/sda"]]],
2465 "flush device buffers",
2467 This tells the kernel to flush internal buffers associated
2470 This uses the L<blockdev(8)> command.");
2472 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2473 [InitEmpty, Always, TestRun
2474 [["blockdev_rereadpt"; "/dev/sda"]]],
2475 "reread partition table",
2477 Reread the partition table on C<device>.
2479 This uses the L<blockdev(8)> command.");
2481 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2482 [InitScratchFS, Always, TestOutput (
2483 (* Pick a file from cwd which isn't likely to change. *)
2484 [["mkdir"; "/upload"];
2485 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2486 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2487 Digest.to_hex (Digest.file "COPYING.LIB"))],
2488 "upload a file from the local machine",
2490 Upload local file C<filename> to C<remotefilename> on the
2493 C<filename> can also be a named pipe.
2495 See also C<guestfs_download>.");
2497 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2498 [InitScratchFS, Always, TestOutput (
2499 (* Pick a file from cwd which isn't likely to change. *)
2500 [["mkdir"; "/download"];
2501 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2502 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2503 ["upload"; "testdownload.tmp"; "/download/upload"];
2504 ["checksum"; "md5"; "/download/upload"]],
2505 Digest.to_hex (Digest.file "COPYING.LIB"))],
2506 "download a file to the local machine",
2508 Download file C<remotefilename> and save it as C<filename>
2509 on the local machine.
2511 C<filename> can also be a named pipe.
2513 See also C<guestfs_upload>, C<guestfs_cat>.");
2515 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2516 [InitISOFS, Always, TestOutput (
2517 [["checksum"; "crc"; "/known-3"]], "2891671662");
2518 InitISOFS, Always, TestLastFail (
2519 [["checksum"; "crc"; "/notexists"]]);
2520 InitISOFS, Always, TestOutput (
2521 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2522 InitISOFS, Always, TestOutput (
2523 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2524 InitISOFS, Always, TestOutput (
2525 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2526 InitISOFS, Always, TestOutput (
2527 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2528 InitISOFS, Always, TestOutput (
2529 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2530 InitISOFS, Always, TestOutput (
2531 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2532 (* Test for RHBZ#579608, absolute symbolic links. *)
2533 InitISOFS, Always, TestOutput (
2534 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2535 "compute MD5, SHAx or CRC checksum of file",
2537 This call computes the MD5, SHAx or CRC checksum of the
2540 The type of checksum to compute is given by the C<csumtype>
2541 parameter which must have one of the following values:
2547 Compute the cyclic redundancy check (CRC) specified by POSIX
2548 for the C<cksum> command.
2552 Compute the MD5 hash (using the C<md5sum> program).
2556 Compute the SHA1 hash (using the C<sha1sum> program).
2560 Compute the SHA224 hash (using the C<sha224sum> program).
2564 Compute the SHA256 hash (using the C<sha256sum> program).
2568 Compute the SHA384 hash (using the C<sha384sum> program).
2572 Compute the SHA512 hash (using the C<sha512sum> program).
2576 The checksum is returned as a printable string.
2578 To get the checksum for a device, use C<guestfs_checksum_device>.
2580 To get the checksums for many files, use C<guestfs_checksums_out>.");
2582 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2583 [InitScratchFS, Always, TestOutput (
2584 [["mkdir"; "/tar_in"];
2585 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2586 ["cat"; "/tar_in/hello"]], "hello\n")],
2587 "unpack tarfile to directory",
2589 This command uploads and unpacks local file C<tarfile> (an
2590 I<uncompressed> tar file) into C<directory>.
2592 To upload a compressed tarball, use C<guestfs_tgz_in>
2593 or C<guestfs_txz_in>.");
2595 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2597 "pack directory into tarfile",
2599 This command packs the contents of C<directory> and downloads
2600 it to local file C<tarfile>.
2602 To download a compressed tarball, use C<guestfs_tgz_out>
2603 or C<guestfs_txz_out>.");
2605 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2606 [InitScratchFS, Always, TestOutput (
2607 [["mkdir"; "/tgz_in"];
2608 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2609 ["cat"; "/tgz_in/hello"]], "hello\n")],
2610 "unpack compressed tarball to directory",
2612 This command uploads and unpacks local file C<tarball> (a
2613 I<gzip compressed> tar file) into C<directory>.
2615 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2617 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2619 "pack directory into compressed tarball",
2621 This command packs the contents of C<directory> and downloads
2622 it to local file C<tarball>.
2624 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2626 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2627 [InitBasicFS, Always, TestLastFail (
2629 ["mount_ro"; "/dev/sda1"; "/"];
2630 ["touch"; "/new"]]);
2631 InitBasicFS, Always, TestOutput (
2632 [["write"; "/new"; "data"];
2634 ["mount_ro"; "/dev/sda1"; "/"];
2635 ["cat"; "/new"]], "data")],
2636 "mount a guest disk, read-only",
2638 This is the same as the C<guestfs_mount> command, but it
2639 mounts the filesystem with the read-only (I<-o ro>) flag.");
2641 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2643 "mount a guest disk with mount options",
2645 This is the same as the C<guestfs_mount> command, but it
2646 allows you to set the mount options as for the
2647 L<mount(8)> I<-o> flag.
2649 If the C<options> parameter is an empty string, then
2650 no options are passed (all options default to whatever
2651 the filesystem uses).");
2653 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2655 "mount a guest disk with mount options and vfstype",
2657 This is the same as the C<guestfs_mount> command, but it
2658 allows you to set both the mount options and the vfstype
2659 as for the L<mount(8)> I<-o> and I<-t> flags.");
2661 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2663 "debugging and internals",
2665 The C<guestfs_debug> command exposes some internals of
2666 C<guestfsd> (the guestfs daemon) that runs inside the
2669 There is no comprehensive help for this command. You have
2670 to look at the file C<daemon/debug.c> in the libguestfs source
2671 to find out what you can do.");
2673 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2674 [InitEmpty, Always, TestOutputList (
2675 [["part_disk"; "/dev/sda"; "mbr"];
2676 ["pvcreate"; "/dev/sda1"];
2677 ["vgcreate"; "VG"; "/dev/sda1"];
2678 ["lvcreate"; "LV1"; "VG"; "50"];
2679 ["lvcreate"; "LV2"; "VG"; "50"];
2680 ["lvremove"; "/dev/VG/LV1"];
2681 ["lvs"]], ["/dev/VG/LV2"]);
2682 InitEmpty, Always, TestOutputList (
2683 [["part_disk"; "/dev/sda"; "mbr"];
2684 ["pvcreate"; "/dev/sda1"];
2685 ["vgcreate"; "VG"; "/dev/sda1"];
2686 ["lvcreate"; "LV1"; "VG"; "50"];
2687 ["lvcreate"; "LV2"; "VG"; "50"];
2688 ["lvremove"; "/dev/VG"];
2690 InitEmpty, Always, TestOutputList (
2691 [["part_disk"; "/dev/sda"; "mbr"];
2692 ["pvcreate"; "/dev/sda1"];
2693 ["vgcreate"; "VG"; "/dev/sda1"];
2694 ["lvcreate"; "LV1"; "VG"; "50"];
2695 ["lvcreate"; "LV2"; "VG"; "50"];
2696 ["lvremove"; "/dev/VG"];
2698 "remove an LVM logical volume",
2700 Remove an LVM logical volume C<device>, where C<device> is
2701 the path to the LV, such as C</dev/VG/LV>.
2703 You can also remove all LVs in a volume group by specifying
2704 the VG name, C</dev/VG>.");
2706 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2707 [InitEmpty, Always, TestOutputList (
2708 [["part_disk"; "/dev/sda"; "mbr"];
2709 ["pvcreate"; "/dev/sda1"];
2710 ["vgcreate"; "VG"; "/dev/sda1"];
2711 ["lvcreate"; "LV1"; "VG"; "50"];
2712 ["lvcreate"; "LV2"; "VG"; "50"];
2715 InitEmpty, Always, TestOutputList (
2716 [["part_disk"; "/dev/sda"; "mbr"];
2717 ["pvcreate"; "/dev/sda1"];
2718 ["vgcreate"; "VG"; "/dev/sda1"];
2719 ["lvcreate"; "LV1"; "VG"; "50"];
2720 ["lvcreate"; "LV2"; "VG"; "50"];
2723 "remove an LVM volume group",
2725 Remove an LVM volume group C<vgname>, (for example C<VG>).
2727 This also forcibly removes all logical volumes in the volume
2730 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2731 [InitEmpty, Always, TestOutputListOfDevices (
2732 [["part_disk"; "/dev/sda"; "mbr"];
2733 ["pvcreate"; "/dev/sda1"];
2734 ["vgcreate"; "VG"; "/dev/sda1"];
2735 ["lvcreate"; "LV1"; "VG"; "50"];
2736 ["lvcreate"; "LV2"; "VG"; "50"];
2738 ["pvremove"; "/dev/sda1"];
2740 InitEmpty, Always, TestOutputListOfDevices (
2741 [["part_disk"; "/dev/sda"; "mbr"];
2742 ["pvcreate"; "/dev/sda1"];
2743 ["vgcreate"; "VG"; "/dev/sda1"];
2744 ["lvcreate"; "LV1"; "VG"; "50"];
2745 ["lvcreate"; "LV2"; "VG"; "50"];
2747 ["pvremove"; "/dev/sda1"];
2749 InitEmpty, Always, TestOutputListOfDevices (
2750 [["part_disk"; "/dev/sda"; "mbr"];
2751 ["pvcreate"; "/dev/sda1"];
2752 ["vgcreate"; "VG"; "/dev/sda1"];
2753 ["lvcreate"; "LV1"; "VG"; "50"];
2754 ["lvcreate"; "LV2"; "VG"; "50"];
2756 ["pvremove"; "/dev/sda1"];
2758 "remove an LVM physical volume",
2760 This wipes a physical volume C<device> so that LVM will no longer
2763 The implementation uses the C<pvremove> command which refuses to
2764 wipe physical volumes that contain any volume groups, so you have
2765 to remove those first.");
2767 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2768 [InitBasicFS, Always, TestOutput (
2769 [["set_e2label"; "/dev/sda1"; "testlabel"];
2770 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2771 "set the ext2/3/4 filesystem label",
2773 This sets the ext2/3/4 filesystem label of the filesystem on
2774 C<device> to C<label>. Filesystem labels are limited to
2777 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2778 to return the existing label on a filesystem.");
2780 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2782 "get the ext2/3/4 filesystem label",
2784 This returns the ext2/3/4 filesystem label of the filesystem on
2787 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2788 (let uuid = uuidgen () in
2789 [InitBasicFS, Always, TestOutput (
2790 [["set_e2uuid"; "/dev/sda1"; uuid];
2791 ["get_e2uuid"; "/dev/sda1"]], uuid);
2792 InitBasicFS, Always, TestOutput (
2793 [["set_e2uuid"; "/dev/sda1"; "clear"];
2794 ["get_e2uuid"; "/dev/sda1"]], "");
2795 (* We can't predict what UUIDs will be, so just check the commands run. *)
2796 InitBasicFS, Always, TestRun (
2797 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2798 InitBasicFS, Always, TestRun (
2799 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2800 "set the ext2/3/4 filesystem UUID",
2802 This sets the ext2/3/4 filesystem UUID of the filesystem on
2803 C<device> to C<uuid>. The format of the UUID and alternatives
2804 such as C<clear>, C<random> and C<time> are described in the
2805 L<tune2fs(8)> manpage.
2807 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2808 to return the existing UUID of a filesystem.");
2810 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2811 (* Regression test for RHBZ#597112. *)
2812 (let uuid = uuidgen () in
2813 [InitNone, Always, TestOutput (
2814 [["mke2journal"; "1024"; "/dev/sdc"];
2815 ["set_e2uuid"; "/dev/sdc"; uuid];
2816 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2817 "get the ext2/3/4 filesystem UUID",
2819 This returns the ext2/3/4 filesystem UUID of the filesystem on
2822 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2823 [InitBasicFS, Always, TestOutputInt (
2824 [["umount"; "/dev/sda1"];
2825 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2826 InitBasicFS, Always, TestOutputInt (
2827 [["umount"; "/dev/sda1"];
2828 ["zero"; "/dev/sda1"];
2829 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2830 "run the filesystem checker",
2832 This runs the filesystem checker (fsck) on C<device> which
2833 should have filesystem type C<fstype>.
2835 The returned integer is the status. See L<fsck(8)> for the
2836 list of status codes from C<fsck>.
2844 Multiple status codes can be summed together.
2848 A non-zero return code can mean \"success\", for example if
2849 errors have been corrected on the filesystem.
2853 Checking or repairing NTFS volumes is not supported
2858 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2860 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2861 [InitBasicFS, Always, TestOutput (
2862 [["umount"; "/dev/sda1"];
2863 ["zero"; "/dev/sda1"];
2864 ["file"; "/dev/sda1"]], "data")],
2865 "write zeroes to the device",
2867 This command writes zeroes over the first few blocks of C<device>.
2869 How many blocks are zeroed isn't specified (but it's I<not> enough
2870 to securely wipe the device). It should be sufficient to remove
2871 any partition tables, filesystem superblocks and so on.
2873 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2875 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2877 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2878 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2880 [InitBasicFS, Always, TestOutputTrue (
2881 [["mkdir_p"; "/boot/grub"];
2882 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2883 ["grub_install"; "/"; "/dev/vda"];
2884 ["is_dir"; "/boot"]])],
2887 This command installs GRUB (the Grand Unified Bootloader) on
2888 C<device>, with the root directory being C<root>.
2890 Note: If grub-install reports the error
2891 \"No suitable drive was found in the generated device map.\"
2892 it may be that you need to create a C</boot/grub/device.map>
2893 file first that contains the mapping between grub device names
2894 and Linux device names. It is usually sufficient to create
2899 replacing C</dev/vda> with the name of the installation device.");
2901 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2902 [InitScratchFS, Always, TestOutput (
2904 ["write"; "/cp/old"; "file content"];
2905 ["cp"; "/cp/old"; "/cp/new"];
2906 ["cat"; "/cp/new"]], "file content");
2907 InitScratchFS, Always, TestOutputTrue (
2909 ["write"; "/cp2/old"; "file content"];
2910 ["cp"; "/cp2/old"; "/cp2/new"];
2911 ["is_file"; "/cp2/old"]]);
2912 InitScratchFS, Always, TestOutput (
2914 ["write"; "/cp3/old"; "file content"];
2915 ["mkdir"; "/cp3/dir"];
2916 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2917 ["cat"; "/cp3/dir/new"]], "file content")],
2920 This copies a file from C<src> to C<dest> where C<dest> is
2921 either a destination filename or destination directory.");
2923 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2924 [InitScratchFS, Always, TestOutput (
2925 [["mkdir"; "/cp_a1"];
2926 ["mkdir"; "/cp_a2"];
2927 ["write"; "/cp_a1/file"; "file content"];
2928 ["cp_a"; "/cp_a1"; "/cp_a2"];
2929 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2930 "copy a file or directory recursively",
2932 This copies a file or directory from C<src> to C<dest>
2933 recursively using the C<cp -a> command.");
2935 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2936 [InitScratchFS, Always, TestOutput (
2938 ["write"; "/mv/old"; "file content"];
2939 ["mv"; "/mv/old"; "/mv/new"];
2940 ["cat"; "/mv/new"]], "file content");
2941 InitScratchFS, Always, TestOutputFalse (
2943 ["write"; "/mv2/old"; "file content"];
2944 ["mv"; "/mv2/old"; "/mv2/new"];
2945 ["is_file"; "/mv2/old"]])],
2948 This moves a file from C<src> to C<dest> where C<dest> is
2949 either a destination filename or destination directory.");
2951 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2952 [InitEmpty, Always, TestRun (
2953 [["drop_caches"; "3"]])],
2954 "drop kernel page cache, dentries and inodes",
2956 This instructs the guest kernel to drop its page cache,
2957 and/or dentries and inode caches. The parameter C<whattodrop>
2958 tells the kernel what precisely to drop, see
2959 L<http://linux-mm.org/Drop_Caches>
2961 Setting C<whattodrop> to 3 should drop everything.
2963 This automatically calls L<sync(2)> before the operation,
2964 so that the maximum guest memory is freed.");
2966 ("dmesg", (RString "kmsgs", [], []), 91, [],
2967 [InitEmpty, Always, TestRun (
2969 "return kernel messages",
2971 This returns the kernel messages (C<dmesg> output) from
2972 the guest kernel. This is sometimes useful for extended
2973 debugging of problems.
2975 Another way to get the same information is to enable
2976 verbose messages with C<guestfs_set_verbose> or by setting
2977 the environment variable C<LIBGUESTFS_DEBUG=1> before
2978 running the program.");
2980 ("ping_daemon", (RErr, [], []), 92, [],
2981 [InitEmpty, Always, TestRun (
2982 [["ping_daemon"]])],
2983 "ping the guest daemon",
2985 This is a test probe into the guestfs daemon running inside
2986 the qemu subprocess. Calling this function checks that the
2987 daemon responds to the ping message, without affecting the daemon
2988 or attached block device(s) in any other way.");
2990 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2991 [InitScratchFS, Always, TestOutputTrue (
2992 [["mkdir"; "/equal"];
2993 ["write"; "/equal/file1"; "contents of a file"];
2994 ["cp"; "/equal/file1"; "/equal/file2"];
2995 ["equal"; "/equal/file1"; "/equal/file2"]]);
2996 InitScratchFS, Always, TestOutputFalse (
2997 [["mkdir"; "/equal2"];
2998 ["write"; "/equal2/file1"; "contents of a file"];
2999 ["write"; "/equal2/file2"; "contents of another file"];
3000 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3001 InitScratchFS, Always, TestLastFail (
3002 [["mkdir"; "/equal3"];
3003 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3004 "test if two files have equal contents",
3006 This compares the two files C<file1> and C<file2> and returns
3007 true if their content is exactly equal, or false otherwise.
3009 The external L<cmp(1)> program is used for the comparison.");
3011 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3012 [InitISOFS, Always, TestOutputList (
3013 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3014 InitISOFS, Always, TestOutputList (
3015 [["strings"; "/empty"]], []);
3016 (* Test for RHBZ#579608, absolute symbolic links. *)
3017 InitISOFS, Always, TestRun (
3018 [["strings"; "/abssymlink"]])],
3019 "print the printable strings in a file",
3021 This runs the L<strings(1)> command on a file and returns
3022 the list of printable strings found.");
3024 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3025 [InitISOFS, Always, TestOutputList (
3026 [["strings_e"; "b"; "/known-5"]], []);
3027 InitScratchFS, Always, TestOutputList (
3028 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3029 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3030 "print the printable strings in a file",
3032 This is like the C<guestfs_strings> command, but allows you to
3033 specify the encoding of strings that are looked for in
3034 the source file C<path>.
3036 Allowed encodings are:
3042 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3043 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3047 Single 8-bit-byte characters.
3051 16-bit big endian strings such as those encoded in
3052 UTF-16BE or UCS-2BE.
3054 =item l (lower case letter L)
3056 16-bit little endian such as UTF-16LE and UCS-2LE.
3057 This is useful for examining binaries in Windows guests.
3061 32-bit big endian such as UCS-4BE.
3065 32-bit little endian such as UCS-4LE.
3069 The returned strings are transcoded to UTF-8.");
3071 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3072 [InitISOFS, Always, TestOutput (
3073 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3074 (* Test for RHBZ#501888c2 regression which caused large hexdump
3075 * commands to segfault.
3077 InitISOFS, Always, TestRun (
3078 [["hexdump"; "/100krandom"]]);
3079 (* Test for RHBZ#579608, absolute symbolic links. *)
3080 InitISOFS, Always, TestRun (
3081 [["hexdump"; "/abssymlink"]])],
3082 "dump a file in hexadecimal",
3084 This runs C<hexdump -C> on the given C<path>. The result is
3085 the human-readable, canonical hex dump of the file.");
3087 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3088 [InitNone, Always, TestOutput (
3089 [["part_disk"; "/dev/sda"; "mbr"];
3090 ["mkfs"; "ext3"; "/dev/sda1"];
3091 ["mount_options"; ""; "/dev/sda1"; "/"];
3092 ["write"; "/new"; "test file"];
3093 ["umount"; "/dev/sda1"];
3094 ["zerofree"; "/dev/sda1"];
3095 ["mount_options"; ""; "/dev/sda1"; "/"];
3096 ["cat"; "/new"]], "test file")],
3097 "zero unused inodes and disk blocks on ext2/3 filesystem",
3099 This runs the I<zerofree> program on C<device>. This program
3100 claims to zero unused inodes and disk blocks on an ext2/3
3101 filesystem, thus making it possible to compress the filesystem
3104 You should B<not> run this program if the filesystem is
3107 It is possible that using this program can damage the filesystem
3108 or data on the filesystem.");
3110 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3112 "resize an LVM physical volume",
3114 This resizes (expands or shrinks) an existing LVM physical
3115 volume to match the new size of the underlying device.");
3117 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3118 Int "cyls"; Int "heads"; Int "sectors";
3119 String "line"], []), 99, [DangerWillRobinson],
3121 "modify a single partition on a block device",
3123 This runs L<sfdisk(8)> option to modify just the single
3124 partition C<n> (note: C<n> counts from 1).
3126 For other parameters, see C<guestfs_sfdisk>. You should usually
3127 pass C<0> for the cyls/heads/sectors parameters.
3129 See also: C<guestfs_part_add>");
3131 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3133 "display the partition table",
3135 This displays the partition table on C<device>, in the
3136 human-readable output of the L<sfdisk(8)> command. It is
3137 not intended to be parsed.
3139 See also: C<guestfs_part_list>");
3141 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3143 "display the kernel geometry",
3145 This displays the kernel's idea of the geometry of C<device>.
3147 The result is in human-readable format, and not designed to
3150 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3152 "display the disk geometry from the partition table",
3154 This displays the disk geometry of C<device> read from the
3155 partition table. Especially in the case where the underlying
3156 block device has been resized, this can be different from the
3157 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3159 The result is in human-readable format, and not designed to
3162 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3164 "activate or deactivate all volume groups",
3166 This command activates or (if C<activate> is false) deactivates
3167 all logical volumes in all volume groups.
3168 If activated, then they are made known to the
3169 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3170 then those devices disappear.
3172 This command is the same as running C<vgchange -a y|n>");
3174 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3176 "activate or deactivate some volume groups",
3178 This command activates or (if C<activate> is false) deactivates
3179 all logical volumes in the listed volume groups C<volgroups>.
3180 If activated, then they are made known to the
3181 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3182 then those devices disappear.
3184 This command is the same as running C<vgchange -a y|n volgroups...>
3186 Note that if C<volgroups> is an empty list then B<all> volume groups
3187 are activated or deactivated.");
3189 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3190 [InitNone, Always, TestOutput (
3191 [["part_disk"; "/dev/sda"; "mbr"];
3192 ["pvcreate"; "/dev/sda1"];
3193 ["vgcreate"; "VG"; "/dev/sda1"];
3194 ["lvcreate"; "LV"; "VG"; "10"];
3195 ["mkfs"; "ext2"; "/dev/VG/LV"];
3196 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3197 ["write"; "/new"; "test content"];
3199 ["lvresize"; "/dev/VG/LV"; "20"];
3200 ["e2fsck_f"; "/dev/VG/LV"];
3201 ["resize2fs"; "/dev/VG/LV"];
3202 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3203 ["cat"; "/new"]], "test content");
3204 InitNone, Always, TestRun (
3205 (* Make an LV smaller to test RHBZ#587484. *)
3206 [["part_disk"; "/dev/sda"; "mbr"];
3207 ["pvcreate"; "/dev/sda1"];
3208 ["vgcreate"; "VG"; "/dev/sda1"];
3209 ["lvcreate"; "LV"; "VG"; "20"];
3210 ["lvresize"; "/dev/VG/LV"; "10"]])],
3211 "resize an LVM logical volume",
3213 This resizes (expands or shrinks) an existing LVM logical
3214 volume to C<mbytes>. When reducing, data in the reduced part
3217 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3218 [], (* lvresize tests this *)
3219 "resize an ext2, ext3 or ext4 filesystem",
3221 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3222 the underlying device.
3224 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3225 on the C<device> before calling this command. For unknown reasons
3226 C<resize2fs> sometimes gives an error about this and sometimes not.
3227 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3228 calling this function.");
3230 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3231 [InitBasicFS, Always, TestOutputList (
3232 [["find"; "/"]], ["lost+found"]);
3233 InitBasicFS, Always, TestOutputList (
3237 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3238 InitScratchFS, Always, TestOutputList (
3239 [["mkdir_p"; "/find/b/c"];
3240 ["touch"; "/find/b/c/d"];
3241 ["find"; "/find/b/"]], ["c"; "c/d"])],
3242 "find all files and directories",
3244 This command lists out all files and directories, recursively,
3245 starting at C<directory>. It is essentially equivalent to
3246 running the shell command C<find directory -print> but some
3247 post-processing happens on the output, described below.
3249 This returns a list of strings I<without any prefix>. Thus
3250 if the directory structure was:
3256 then the returned list from C<guestfs_find> C</tmp> would be
3264 If C<directory> is not a directory, then this command returns
3267 The returned list is sorted.
3269 See also C<guestfs_find0>.");
3271 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3272 [], (* lvresize tests this *)
3273 "check an ext2/ext3 filesystem",
3275 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3276 filesystem checker on C<device>, noninteractively (C<-p>),
3277 even if the filesystem appears to be clean (C<-f>).
3279 This command is only needed because of C<guestfs_resize2fs>
3280 (q.v.). Normally you should use C<guestfs_fsck>.");
3282 ("sleep", (RErr, [Int "secs"], []), 109, [],
3283 [InitNone, Always, TestRun (
3285 "sleep for some seconds",
3287 Sleep for C<secs> seconds.");
3289 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3290 [InitNone, Always, TestOutputInt (
3291 [["part_disk"; "/dev/sda"; "mbr"];
3292 ["mkfs"; "ntfs"; "/dev/sda1"];
3293 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3294 InitNone, Always, TestOutputInt (
3295 [["part_disk"; "/dev/sda"; "mbr"];
3296 ["mkfs"; "ext2"; "/dev/sda1"];
3297 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3298 "probe NTFS volume",
3300 This command runs the L<ntfs-3g.probe(8)> command which probes
3301 an NTFS C<device> for mountability. (Not all NTFS volumes can
3302 be mounted read-write, and some cannot be mounted at all).
3304 C<rw> is a boolean flag. Set it to true if you want to test
3305 if the volume can be mounted read-write. Set it to false if
3306 you want to test if the volume can be mounted read-only.
3308 The return value is an integer which C<0> if the operation
3309 would succeed, or some non-zero value documented in the
3310 L<ntfs-3g.probe(8)> manual page.");
3312 ("sh", (RString "output", [String "command"], []), 111, [],
3313 [], (* XXX needs tests *)
3314 "run a command via the shell",
3316 This call runs a command from the guest filesystem via the
3319 This is like C<guestfs_command>, but passes the command to:
3321 /bin/sh -c \"command\"
3323 Depending on the guest's shell, this usually results in
3324 wildcards being expanded, shell expressions being interpolated
3327 All the provisos about C<guestfs_command> apply to this call.");
3329 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3330 [], (* XXX needs tests *)
3331 "run a command via the shell returning lines",
3333 This is the same as C<guestfs_sh>, but splits the result
3334 into a list of lines.
3336 See also: C<guestfs_command_lines>");
3338 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3339 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3340 * code in stubs.c, since all valid glob patterns must start with "/".
3341 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3343 [InitScratchFS, Always, TestOutputList (
3344 [["mkdir_p"; "/glob_expand/b/c"];
3345 ["touch"; "/glob_expand/b/c/d"];
3346 ["touch"; "/glob_expand/b/c/e"];
3347 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3348 InitScratchFS, Always, TestOutputList (
3349 [["mkdir_p"; "/glob_expand2/b/c"];
3350 ["touch"; "/glob_expand2/b/c/d"];
3351 ["touch"; "/glob_expand2/b/c/e"];
3352 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3353 InitScratchFS, Always, TestOutputList (
3354 [["mkdir_p"; "/glob_expand3/b/c"];
3355 ["touch"; "/glob_expand3/b/c/d"];
3356 ["touch"; "/glob_expand3/b/c/e"];
3357 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3358 "expand a wildcard path",
3360 This command searches for all the pathnames matching
3361 C<pattern> according to the wildcard expansion rules
3364 If no paths match, then this returns an empty list
3365 (note: not an error).
3367 It is just a wrapper around the C L<glob(3)> function
3368 with flags C<GLOB_MARK|GLOB_BRACE>.
3369 See that manual page for more details.");
3371 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3372 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3373 [["scrub_device"; "/dev/sdc"]])],
3374 "scrub (securely wipe) a device",
3376 This command writes patterns over C<device> to make data retrieval
3379 It is an interface to the L<scrub(1)> program. See that
3380 manual page for more details.");
3382 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3383 [InitScratchFS, Always, TestRun (
3384 [["write"; "/scrub_file"; "content"];
3385 ["scrub_file"; "/scrub_file"]])],
3386 "scrub (securely wipe) a file",
3388 This command writes patterns over a file to make data retrieval
3391 The file is I<removed> after scrubbing.
3393 It is an interface to the L<scrub(1)> program. See that
3394 manual page for more details.");
3396 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3397 [], (* XXX needs testing *)
3398 "scrub (securely wipe) free space",
3400 This command creates the directory C<dir> and then fills it
3401 with files until the filesystem is full, and scrubs the files
3402 as for C<guestfs_scrub_file>, and deletes them.
3403 The intention is to scrub any free space on the partition
3406 It is an interface to the L<scrub(1)> program. See that
3407 manual page for more details.");
3409 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3410 [InitScratchFS, Always, TestRun (
3411 [["mkdir"; "/mkdtemp"];
3412 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3413 "create a temporary directory",
3415 This command creates a temporary directory. The
3416 C<template> parameter should be a full pathname for the
3417 temporary directory name with the final six characters being
3420 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3421 the second one being suitable for Windows filesystems.
3423 The name of the temporary directory that was created
3426 The temporary directory is created with mode 0700
3427 and is owned by root.
3429 The caller is responsible for deleting the temporary
3430 directory and its contents after use.
3432 See also: L<mkdtemp(3)>");
3434 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3435 [InitISOFS, Always, TestOutputInt (
3436 [["wc_l"; "/10klines"]], 10000);
3437 (* Test for RHBZ#579608, absolute symbolic links. *)
3438 InitISOFS, Always, TestOutputInt (
3439 [["wc_l"; "/abssymlink"]], 10000)],
3440 "count lines in a file",
3442 This command counts the lines in a file, using the
3443 C<wc -l> external command.");
3445 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3446 [InitISOFS, Always, TestOutputInt (
3447 [["wc_w"; "/10klines"]], 10000)],
3448 "count words in a file",
3450 This command counts the words in a file, using the
3451 C<wc -w> external command.");
3453 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3454 [InitISOFS, Always, TestOutputInt (
3455 [["wc_c"; "/100kallspaces"]], 102400)],
3456 "count characters in a file",
3458 This command counts the characters in a file, using the
3459 C<wc -c> external command.");
3461 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3462 [InitISOFS, Always, TestOutputList (
3463 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3464 (* Test for RHBZ#579608, absolute symbolic links. *)
3465 InitISOFS, Always, TestOutputList (
3466 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3467 "return first 10 lines of a file",
3469 This command returns up to the first 10 lines of a file as
3470 a list of strings.");
3472 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3473 [InitISOFS, Always, TestOutputList (
3474 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3475 InitISOFS, Always, TestOutputList (
3476 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3477 InitISOFS, Always, TestOutputList (
3478 [["head_n"; "0"; "/10klines"]], [])],
3479 "return first N lines of a file",
3481 If the parameter C<nrlines> is a positive number, this returns the first
3482 C<nrlines> lines of the file C<path>.
3484 If the parameter C<nrlines> is a negative number, this returns lines
3485 from the file C<path>, excluding the last C<nrlines> lines.
3487 If the parameter C<nrlines> is zero, this returns an empty list.");
3489 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3490 [InitISOFS, Always, TestOutputList (
3491 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3492 "return last 10 lines of a file",
3494 This command returns up to the last 10 lines of a file as
3495 a list of strings.");
3497 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3498 [InitISOFS, Always, TestOutputList (
3499 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3500 InitISOFS, Always, TestOutputList (
3501 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3502 InitISOFS, Always, TestOutputList (
3503 [["tail_n"; "0"; "/10klines"]], [])],
3504 "return last N lines of a file",
3506 If the parameter C<nrlines> is a positive number, this returns the last
3507 C<nrlines> lines of the file C<path>.
3509 If the parameter C<nrlines> is a negative number, this returns lines
3510 from the file C<path>, starting with the C<-nrlines>th line.
3512 If the parameter C<nrlines> is zero, this returns an empty list.");
3514 ("df", (RString "output", [], []), 125, [],
3515 [], (* XXX Tricky to test because it depends on the exact format
3516 * of the 'df' command and other imponderables.
3518 "report file system disk space usage",
3520 This command runs the C<df> command to report disk space used.
3522 This command is mostly useful for interactive sessions. It
3523 is I<not> intended that you try to parse the output string.
3524 Use C<guestfs_statvfs> from programs.");
3526 ("df_h", (RString "output", [], []), 126, [],
3527 [], (* XXX Tricky to test because it depends on the exact format
3528 * of the 'df' command and other imponderables.
3530 "report file system disk space usage (human readable)",
3532 This command runs the C<df -h> command to report disk space used
3533 in human-readable format.
3535 This command is mostly useful for interactive sessions. It
3536 is I<not> intended that you try to parse the output string.
3537 Use C<guestfs_statvfs> from programs.");
3539 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3540 [InitISOFS, Always, TestOutputInt (
3541 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3542 "estimate file space usage",
3544 This command runs the C<du -s> command to estimate file space
3547 C<path> can be a file or a directory. If C<path> is a directory
3548 then the estimate includes the contents of the directory and all
3549 subdirectories (recursively).
3551 The result is the estimated size in I<kilobytes>
3552 (ie. units of 1024 bytes).");
3554 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3555 [InitISOFS, Always, TestOutputList (
3556 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3557 "list files in an initrd",
3559 This command lists out files contained in an initrd.
3561 The files are listed without any initial C</> character. The
3562 files are listed in the order they appear (not necessarily
3563 alphabetical). Directory names are listed as separate items.
3565 Old Linux kernels (2.4 and earlier) used a compressed ext2
3566 filesystem as initrd. We I<only> support the newer initramfs
3567 format (compressed cpio files).");
3569 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3571 "mount a file using the loop device",
3573 This command lets you mount C<file> (a filesystem image
3574 in a file) on a mount point. It is entirely equivalent to
3575 the command C<mount -o loop file mountpoint>.");
3577 ("mkswap", (RErr, [Device "device"], []), 130, [],
3578 [InitEmpty, Always, TestRun (
3579 [["part_disk"; "/dev/sda"; "mbr"];
3580 ["mkswap"; "/dev/sda1"]])],
3581 "create a swap partition",
3583 Create a swap partition on C<device>.");
3585 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3586 [InitEmpty, Always, TestRun (
3587 [["part_disk"; "/dev/sda"; "mbr"];
3588 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3589 "create a swap partition with a label",
3591 Create a swap partition on C<device> with label C<label>.
3593 Note that you cannot attach a swap label to a block device
3594 (eg. C</dev/sda>), just to a partition. This appears to be
3595 a limitation of the kernel or swap tools.");
3597 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3598 (let uuid = uuidgen () in
3599 [InitEmpty, Always, TestRun (
3600 [["part_disk"; "/dev/sda"; "mbr"];
3601 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3602 "create a swap partition with an explicit UUID",
3604 Create a swap partition on C<device> with UUID C<uuid>.");
3606 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3607 [InitScratchFS, Always, TestOutputStruct (
3608 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3609 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3610 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3611 InitScratchFS, Always, TestOutputStruct (
3612 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3613 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3614 "make block, character or FIFO devices",
3616 This call creates block or character special devices, or
3617 named pipes (FIFOs).
3619 The C<mode> parameter should be the mode, using the standard
3620 constants. C<devmajor> and C<devminor> are the
3621 device major and minor numbers, only used when creating block
3622 and character special devices.
3624 Note that, just like L<mknod(2)>, the mode must be bitwise
3625 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3626 just creates a regular file). These constants are
3627 available in the standard Linux header files, or you can use
3628 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3629 which are wrappers around this command which bitwise OR
3630 in the appropriate constant for you.
3632 The mode actually set is affected by the umask.");
3634 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3635 [InitScratchFS, Always, TestOutputStruct (
3636 [["mkfifo"; "0o777"; "/mkfifo"];
3637 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3638 "make FIFO (named pipe)",
3640 This call creates a FIFO (named pipe) called C<path> with
3641 mode C<mode>. It is just a convenient wrapper around
3644 The mode actually set is affected by the umask.");
3646 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3647 [InitScratchFS, Always, TestOutputStruct (
3648 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3649 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3650 "make block device node",
3652 This call creates a block device node called C<path> with
3653 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3654 It is just a convenient wrapper around C<guestfs_mknod>.
3656 The mode actually set is affected by the umask.");
3658 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3659 [InitScratchFS, Always, TestOutputStruct (
3660 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3661 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3662 "make char device node",
3664 This call creates a char device node called C<path> with
3665 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3666 It is just a convenient wrapper around C<guestfs_mknod>.
3668 The mode actually set is affected by the umask.");
3670 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3671 [InitEmpty, Always, TestOutputInt (
3672 [["umask"; "0o22"]], 0o22)],
3673 "set file mode creation mask (umask)",
3675 This function sets the mask used for creating new files and
3676 device nodes to C<mask & 0777>.
3678 Typical umask values would be C<022> which creates new files
3679 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3680 C<002> which creates new files with permissions like
3681 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3683 The default umask is C<022>. This is important because it
3684 means that directories and device nodes will be created with
3685 C<0644> or C<0755> mode even if you specify C<0777>.
3687 See also C<guestfs_get_umask>,
3688 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3690 This call returns the previous umask.");
3692 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3694 "read directories entries",
3696 This returns the list of directory entries in directory C<dir>.
3698 All entries in the directory are returned, including C<.> and
3699 C<..>. The entries are I<not> sorted, but returned in the same
3700 order as the underlying filesystem.
3702 Also this call returns basic file type information about each
3703 file. The C<ftyp> field will contain one of the following characters:
3741 The L<readdir(3)> call returned a C<d_type> field with an
3746 This function is primarily intended for use by programs. To
3747 get a simple list of names, use C<guestfs_ls>. To get a printable
3748 directory for human consumption, use C<guestfs_ll>.");
3750 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3752 "create partitions on a block device",
3754 This is a simplified interface to the C<guestfs_sfdisk>
3755 command, where partition sizes are specified in megabytes
3756 only (rounded to the nearest cylinder) and you don't need
3757 to specify the cyls, heads and sectors parameters which
3758 were rarely if ever used anyway.
3760 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3761 and C<guestfs_part_disk>");
3763 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3765 "determine file type inside a compressed file",
3767 This command runs C<file> after first decompressing C<path>
3770 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3772 Since 1.0.63, use C<guestfs_file> instead which can now
3773 process compressed files.");
3775 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3777 "list extended attributes of a file or directory",
3779 This call lists the extended attributes of the file or directory
3782 At the system call level, this is a combination of the
3783 L<listxattr(2)> and L<getxattr(2)> calls.
3785 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3787 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3789 "list extended attributes of a file or directory",
3791 This is the same as C<guestfs_getxattrs>, but if C<path>
3792 is a symbolic link, then it returns the extended attributes
3793 of the link itself.");
3795 ("setxattr", (RErr, [String "xattr";
3796 String "val"; Int "vallen"; (* will be BufferIn *)
3797 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3799 "set extended attribute of a file or directory",
3801 This call sets the extended attribute named C<xattr>
3802 of the file C<path> to the value C<val> (of length C<vallen>).
3803 The value is arbitrary 8 bit data.
3805 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3807 ("lsetxattr", (RErr, [String "xattr";
3808 String "val"; Int "vallen"; (* will be BufferIn *)
3809 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3811 "set extended attribute of a file or directory",
3813 This is the same as C<guestfs_setxattr>, but if C<path>
3814 is a symbolic link, then it sets an extended attribute
3815 of the link itself.");
3817 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3819 "remove extended attribute of a file or directory",
3821 This call removes the extended attribute named C<xattr>
3822 of the file C<path>.
3824 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3826 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3828 "remove extended attribute of a file or directory",
3830 This is the same as C<guestfs_removexattr>, but if C<path>
3831 is a symbolic link, then it removes an extended attribute
3832 of the link itself.");
3834 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3838 This call is similar to C<guestfs_mounts>. That call returns
3839 a list of devices. This one returns a hash table (map) of
3840 device name to directory where the device is mounted.");
3842 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3843 (* This is a special case: while you would expect a parameter
3844 * of type "Pathname", that doesn't work, because it implies
3845 * NEED_ROOT in the generated calling code in stubs.c, and
3846 * this function cannot use NEED_ROOT.
3849 "create a mountpoint",
3851 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3852 specialized calls that can be used to create extra mountpoints
3853 before mounting the first filesystem.
3855 These calls are I<only> necessary in some very limited circumstances,
3856 mainly the case where you want to mount a mix of unrelated and/or
3857 read-only filesystems together.
3859 For example, live CDs often contain a \"Russian doll\" nest of
3860 filesystems, an ISO outer layer, with a squashfs image inside, with
3861 an ext2/3 image inside that. You can unpack this as follows
3864 add-ro Fedora-11-i686-Live.iso
3868 mkmountpoint /ext3fs
3870 mount-loop /cd/LiveOS/squashfs.img /sqsh
3871 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3873 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3875 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3876 You may get unexpected errors if you try to mix these calls. It is
3877 safest to manually unmount filesystems and remove mountpoints after use.
3879 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3880 longest first, so for this to work for manual mountpoints, you
3881 must ensure that the innermost mountpoints have the longest
3882 pathnames, as in the example code above.
3884 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3886 Autosync [see C<guestfs_set_autosync>, this is set by default on
3887 handles] can cause C<guestfs_umount_all> to be called when the handle
3888 is closed which can also trigger these issues.");
3890 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3892 "remove a mountpoint",
3894 This calls removes a mountpoint that was previously created
3895 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3896 for full details.");
3898 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3899 [InitISOFS, Always, TestOutputBuffer (
3900 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3901 (* Test various near large, large and too large files (RHBZ#589039). *)
3902 InitScratchFS, Always, TestLastFail (
3903 [["touch"; "/read_file"];
3904 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3905 ["read_file"; "/read_file"]]);
3906 InitScratchFS, Always, TestLastFail (
3907 [["touch"; "/read_file2"];
3908 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3909 ["read_file"; "/read_file2"]]);
3910 InitScratchFS, Always, TestLastFail (
3911 [["touch"; "/read_file3"];
3912 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3913 ["read_file"; "/read_file3"]])],
3916 This calls returns the contents of the file C<path> as a
3919 Unlike C<guestfs_cat>, this function can correctly
3920 handle files that contain embedded ASCII NUL characters.
3921 However unlike C<guestfs_download>, this function is limited
3922 in the total size of file that can be handled.");
3924 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3925 [InitISOFS, Always, TestOutputList (
3926 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3927 InitISOFS, Always, TestOutputList (
3928 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3929 (* Test for RHBZ#579608, absolute symbolic links. *)
3930 InitISOFS, Always, TestOutputList (
3931 [["grep"; "nomatch"; "/abssymlink"]], [])],
3932 "return lines matching a pattern",
3934 This calls the external C<grep> program and returns the
3937 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3938 [InitISOFS, Always, TestOutputList (
3939 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3940 "return lines matching a pattern",
3942 This calls the external C<egrep> program and returns the
3945 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3946 [InitISOFS, Always, TestOutputList (
3947 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3948 "return lines matching a pattern",
3950 This calls the external C<fgrep> program and returns the
3953 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3954 [InitISOFS, Always, TestOutputList (
3955 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3956 "return lines matching a pattern",
3958 This calls the external C<grep -i> program and returns the
3961 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3962 [InitISOFS, Always, TestOutputList (
3963 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3964 "return lines matching a pattern",
3966 This calls the external C<egrep -i> program and returns the
3969 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3970 [InitISOFS, Always, TestOutputList (
3971 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3972 "return lines matching a pattern",
3974 This calls the external C<fgrep -i> program and returns the
3977 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3978 [InitISOFS, Always, TestOutputList (
3979 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3980 "return lines matching a pattern",
3982 This calls the external C<zgrep> program and returns the
3985 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3986 [InitISOFS, Always, TestOutputList (
3987 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3988 "return lines matching a pattern",
3990 This calls the external C<zegrep> program and returns the
3993 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3994 [InitISOFS, Always, TestOutputList (
3995 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3996 "return lines matching a pattern",
3998 This calls the external C<zfgrep> program and returns the
4001 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4002 [InitISOFS, Always, TestOutputList (
4003 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4004 "return lines matching a pattern",
4006 This calls the external C<zgrep -i> program and returns the
4009 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4010 [InitISOFS, Always, TestOutputList (
4011 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4012 "return lines matching a pattern",
4014 This calls the external C<zegrep -i> program and returns the
4017 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4018 [InitISOFS, Always, TestOutputList (
4019 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4020 "return lines matching a pattern",
4022 This calls the external C<zfgrep -i> program and returns the
4025 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4026 [InitISOFS, Always, TestOutput (
4027 [["realpath"; "/../directory"]], "/directory")],
4028 "canonicalized absolute pathname",
4030 Return the canonicalized absolute pathname of C<path>. The
4031 returned path has no C<.>, C<..> or symbolic link path elements.");
4033 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4034 [InitScratchFS, Always, TestOutputStruct (
4037 ["ln"; "/ln/a"; "/ln/b"];
4038 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4039 "create a hard link",
4041 This command creates a hard link using the C<ln> command.");
4043 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4044 [InitScratchFS, Always, TestOutputStruct (
4045 [["mkdir"; "/ln_f"];
4046 ["touch"; "/ln_f/a"];
4047 ["touch"; "/ln_f/b"];
4048 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4049 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4050 "create a hard link",
4052 This command creates a hard link using the C<ln -f> command.
4053 The C<-f> option removes the link (C<linkname>) if it exists already.");
4055 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4056 [InitScratchFS, Always, TestOutputStruct (
4057 [["mkdir"; "/ln_s"];
4058 ["touch"; "/ln_s/a"];
4059 ["ln_s"; "a"; "/ln_s/b"];
4060 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4061 "create a symbolic link",
4063 This command creates a symbolic link using the C<ln -s> command.");
4065 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4066 [InitScratchFS, Always, TestOutput (
4067 [["mkdir_p"; "/ln_sf/b"];
4068 ["touch"; "/ln_sf/b/c"];
4069 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4070 ["readlink"; "/ln_sf/b/c"]], "../d")],
4071 "create a symbolic link",
4073 This command creates a symbolic link using the C<ln -sf> command,
4074 The C<-f> option removes the link (C<linkname>) if it exists already.");
4076 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4077 [] (* XXX tested above *),
4078 "read the target of a symbolic link",
4080 This command reads the target of a symbolic link.");
4082 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4083 [InitScratchFS, Always, TestOutputStruct (
4084 [["fallocate"; "/fallocate"; "1000000"];
4085 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4086 "preallocate a file in the guest filesystem",
4088 This command preallocates a file (containing zero bytes) named
4089 C<path> of size C<len> bytes. If the file exists already, it
4092 Do not confuse this with the guestfish-specific
4093 C<alloc> command which allocates a file in the host and
4094 attaches it as a device.");
4096 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4097 [InitPartition, Always, TestRun (
4098 [["mkswap"; "/dev/sda1"];
4099 ["swapon_device"; "/dev/sda1"];
4100 ["swapoff_device"; "/dev/sda1"]])],
4101 "enable swap on device",
4103 This command enables the libguestfs appliance to use the
4104 swap device or partition named C<device>. The increased
4105 memory is made available for all commands, for example
4106 those run using C<guestfs_command> or C<guestfs_sh>.
4108 Note that you should not swap to existing guest swap
4109 partitions unless you know what you are doing. They may
4110 contain hibernation information, or other information that
4111 the guest doesn't want you to trash. You also risk leaking
4112 information about the host to the guest this way. Instead,
4113 attach a new host device to the guest and swap on that.");
4115 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4116 [], (* XXX tested by swapon_device *)
4117 "disable swap on device",
4119 This command disables the libguestfs appliance swap
4120 device or partition named C<device>.
4121 See C<guestfs_swapon_device>.");
4123 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4124 [InitScratchFS, Always, TestRun (
4125 [["fallocate"; "/swapon_file"; "8388608"];
4126 ["mkswap_file"; "/swapon_file"];
4127 ["swapon_file"; "/swapon_file"];
4128 ["swapoff_file"; "/swapon_file"];
4129 ["rm"; "/swapon_file"]])],
4130 "enable swap on file",
4132 This command enables swap to a file.
4133 See C<guestfs_swapon_device> for other notes.");
4135 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4136 [], (* XXX tested by swapon_file *)
4137 "disable swap on file",
4139 This command disables the libguestfs appliance swap on file.");
4141 ("swapon_label", (RErr, [String "label"], []), 174, [],
4142 [InitEmpty, Always, TestRun (
4143 [["part_disk"; "/dev/sda"; "mbr"];
4144 ["mkswap_L"; "swapit"; "/dev/sda1"];
4145 ["swapon_label"; "swapit"];
4146 ["swapoff_label"; "swapit"];
4147 ["zero"; "/dev/sda"];
4148 ["blockdev_rereadpt"; "/dev/sda"]])],
4149 "enable swap on labeled swap partition",
4151 This command enables swap to a labeled swap partition.
4152 See C<guestfs_swapon_device> for other notes.");
4154 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4155 [], (* XXX tested by swapon_label *)
4156 "disable swap on labeled swap partition",
4158 This command disables the libguestfs appliance swap on
4159 labeled swap partition.");
4161 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4162 (let uuid = uuidgen () in
4163 [InitEmpty, Always, TestRun (
4164 [["mkswap_U"; uuid; "/dev/sdc"];
4165 ["swapon_uuid"; uuid];
4166 ["swapoff_uuid"; uuid]])]),
4167 "enable swap on swap partition by UUID",
4169 This command enables swap to a swap partition with the given UUID.
4170 See C<guestfs_swapon_device> for other notes.");
4172 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4173 [], (* XXX tested by swapon_uuid *)
4174 "disable swap on swap partition by UUID",
4176 This command disables the libguestfs appliance swap partition
4177 with the given UUID.");
4179 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4180 [InitScratchFS, Always, TestRun (
4181 [["fallocate"; "/mkswap_file"; "8388608"];
4182 ["mkswap_file"; "/mkswap_file"];
4183 ["rm"; "/mkswap_file"]])],
4184 "create a swap file",
4188 This command just writes a swap file signature to an existing
4189 file. To create the file itself, use something like C<guestfs_fallocate>.");
4191 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4192 [InitISOFS, Always, TestRun (
4193 [["inotify_init"; "0"]])],
4194 "create an inotify handle",
4196 This command creates a new inotify handle.
4197 The inotify subsystem can be used to notify events which happen to
4198 objects in the guest filesystem.
4200 C<maxevents> is the maximum number of events which will be
4201 queued up between calls to C<guestfs_inotify_read> or
4202 C<guestfs_inotify_files>.
4203 If this is passed as C<0>, then the kernel (or previously set)
4204 default is used. For Linux 2.6.29 the default was 16384 events.
4205 Beyond this limit, the kernel throws away events, but records
4206 the fact that it threw them away by setting a flag
4207 C<IN_Q_OVERFLOW> in the returned structure list (see
4208 C<guestfs_inotify_read>).
4210 Before any events are generated, you have to add some
4211 watches to the internal watch list. See:
4212 C<guestfs_inotify_add_watch>,
4213 C<guestfs_inotify_rm_watch> and
4214 C<guestfs_inotify_watch_all>.
4216 Queued up events should be read periodically by calling
4217 C<guestfs_inotify_read>
4218 (or C<guestfs_inotify_files> which is just a helpful
4219 wrapper around C<guestfs_inotify_read>). If you don't
4220 read the events out often enough then you risk the internal
4223 The handle should be closed after use by calling
4224 C<guestfs_inotify_close>. This also removes any
4225 watches automatically.
4227 See also L<inotify(7)> for an overview of the inotify interface
4228 as exposed by the Linux kernel, which is roughly what we expose
4229 via libguestfs. Note that there is one global inotify handle
4230 per libguestfs instance.");
4232 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4233 [InitScratchFS, Always, TestOutputList (
4234 [["mkdir"; "/inotify_add_watch"];
4235 ["inotify_init"; "0"];
4236 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4237 ["touch"; "/inotify_add_watch/a"];
4238 ["touch"; "/inotify_add_watch/b"];
4239 ["inotify_files"]], ["a"; "b"])],
4240 "add an inotify watch",
4242 Watch C<path> for the events listed in C<mask>.
4244 Note that if C<path> is a directory then events within that
4245 directory are watched, but this does I<not> happen recursively
4246 (in subdirectories).
4248 Note for non-C or non-Linux callers: the inotify events are
4249 defined by the Linux kernel ABI and are listed in
4250 C</usr/include/sys/inotify.h>.");
4252 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4254 "remove an inotify watch",
4256 Remove a previously defined inotify watch.
4257 See C<guestfs_inotify_add_watch>.");
4259 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4261 "return list of inotify events",
4263 Return the complete queue of events that have happened
4264 since the previous read call.
4266 If no events have happened, this returns an empty list.
4268 I<Note>: In order to make sure that all events have been
4269 read, you must call this function repeatedly until it
4270 returns an empty list. The reason is that the call will
4271 read events up to the maximum appliance-to-host message
4272 size and leave remaining events in the queue.");
4274 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4276 "return list of watched files that had events",
4278 This function is a helpful wrapper around C<guestfs_inotify_read>
4279 which just returns a list of pathnames of objects that were
4280 touched. The returned pathnames are sorted and deduplicated.");
4282 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4284 "close the inotify handle",
4286 This closes the inotify handle which was previously
4287 opened by inotify_init. It removes all watches, throws
4288 away any pending events, and deallocates all resources.");
4290 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4292 "set SELinux security context",
4294 This sets the SELinux security context of the daemon
4295 to the string C<context>.
4297 See the documentation about SELINUX in L<guestfs(3)>.");
4299 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4301 "get SELinux security context",
4303 This gets the SELinux security context of the daemon.
4305 See the documentation about SELINUX in L<guestfs(3)>,
4306 and C<guestfs_setcon>");
4308 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4309 [InitEmpty, Always, TestOutput (
4310 [["part_disk"; "/dev/sda"; "mbr"];
4311 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4312 ["mount_options"; ""; "/dev/sda1"; "/"];
4313 ["write"; "/new"; "new file contents"];
4314 ["cat"; "/new"]], "new file contents");
4315 InitEmpty, Always, TestRun (
4316 [["part_disk"; "/dev/sda"; "mbr"];
4317 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4318 InitEmpty, Always, TestLastFail (
4319 [["part_disk"; "/dev/sda"; "mbr"];
4320 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4321 InitEmpty, Always, TestLastFail (
4322 [["part_disk"; "/dev/sda"; "mbr"];
4323 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4324 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4325 [["part_disk"; "/dev/sda"; "mbr"];
4326 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4327 "make a filesystem with block size",
4329 This call is similar to C<guestfs_mkfs>, but it allows you to
4330 control the block size of the resulting filesystem. Supported
4331 block sizes depend on the filesystem type, but typically they
4332 are C<1024>, C<2048> or C<4096> only.
4334 For VFAT and NTFS the C<blocksize> parameter is treated as
4335 the requested cluster size.");
4337 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4338 [InitEmpty, Always, TestOutput (
4339 [["part_init"; "/dev/sda"; "mbr"];
4340 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4341 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4342 ["mke2journal"; "4096"; "/dev/sda1"];
4343 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4344 ["mount_options"; ""; "/dev/sda2"; "/"];
4345 ["write"; "/new"; "new file contents"];
4346 ["cat"; "/new"]], "new file contents")],
4347 "make ext2/3/4 external journal",
4349 This creates an ext2 external journal on C<device>. It is equivalent
4352 mke2fs -O journal_dev -b blocksize device");
4354 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4355 [InitEmpty, Always, TestOutput (
4356 [["part_init"; "/dev/sda"; "mbr"];
4357 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4358 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4359 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4360 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4361 ["mount_options"; ""; "/dev/sda2"; "/"];
4362 ["write"; "/new"; "new file contents"];
4363 ["cat"; "/new"]], "new file contents")],
4364 "make ext2/3/4 external journal with label",
4366 This creates an ext2 external journal on C<device> with label C<label>.");
4368 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4369 (let uuid = uuidgen () in
4370 [InitEmpty, Always, TestOutput (
4371 [["part_init"; "/dev/sda"; "mbr"];
4372 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4373 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4374 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4375 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4376 ["mount_options"; ""; "/dev/sda2"; "/"];
4377 ["write"; "/new"; "new file contents"];
4378 ["cat"; "/new"]], "new file contents")]),
4379 "make ext2/3/4 external journal with UUID",
4381 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4383 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4385 "make ext2/3/4 filesystem with external journal",
4387 This creates an ext2/3/4 filesystem on C<device> with
4388 an external journal on C<journal>. It is equivalent
4391 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4393 See also C<guestfs_mke2journal>.");
4395 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4397 "make ext2/3/4 filesystem with external journal",
4399 This creates an ext2/3/4 filesystem on C<device> with
4400 an external journal on the journal labeled C<label>.
4402 See also C<guestfs_mke2journal_L>.");
4404 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4406 "make ext2/3/4 filesystem with external journal",
4408 This creates an ext2/3/4 filesystem on C<device> with
4409 an external journal on the journal with UUID C<uuid>.
4411 See also C<guestfs_mke2journal_U>.");
4413 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4414 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4415 "load a kernel module",
4417 This loads a kernel module in the appliance.
4419 The kernel module must have been whitelisted when libguestfs
4420 was built (see C<appliance/kmod.whitelist.in> in the source).");
4422 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4423 [InitNone, Always, TestOutput (
4424 [["echo_daemon"; "This is a test"]], "This is a test"
4426 "echo arguments back to the client",
4428 This command concatenates the list of C<words> passed with single spaces
4429 between them and returns the resulting string.
4431 You can use this command to test the connection through to the daemon.
4433 See also C<guestfs_ping_daemon>.");
4435 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4436 [], (* There is a regression test for this. *)
4437 "find all files and directories, returning NUL-separated list",
4439 This command lists out all files and directories, recursively,
4440 starting at C<directory>, placing the resulting list in the
4441 external file called C<files>.
4443 This command works the same way as C<guestfs_find> with the
4444 following exceptions:
4450 The resulting list is written to an external file.
4454 Items (filenames) in the result are separated
4455 by C<\\0> characters. See L<find(1)> option I<-print0>.
4459 This command is not limited in the number of names that it
4464 The result list is not sorted.
4468 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4469 [InitISOFS, Always, TestOutput (
4470 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4471 InitISOFS, Always, TestOutput (
4472 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4473 InitISOFS, Always, TestOutput (
4474 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4475 InitISOFS, Always, TestLastFail (
4476 [["case_sensitive_path"; "/Known-1/"]]);
4477 InitScratchFS, Always, TestOutput (
4478 [["mkdir"; "/case_sensitive_path"];
4479 ["mkdir"; "/case_sensitive_path/bbb"];
4480 ["touch"; "/case_sensitive_path/bbb/c"];
4481 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4482 InitScratchFS, Always, TestOutput (
4483 [["mkdir"; "/case_sensitive_path2"];
4484 ["mkdir"; "/case_sensitive_path2/bbb"];
4485 ["touch"; "/case_sensitive_path2/bbb/c"];
4486 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4487 InitScratchFS, Always, TestLastFail (
4488 [["mkdir"; "/case_sensitive_path3"];
4489 ["mkdir"; "/case_sensitive_path3/bbb"];
4490 ["touch"; "/case_sensitive_path3/bbb/c"];
4491 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4492 "return true path on case-insensitive filesystem",
4494 This can be used to resolve case insensitive paths on
4495 a filesystem which is case sensitive. The use case is
4496 to resolve paths which you have read from Windows configuration
4497 files or the Windows Registry, to the true path.
4499 The command handles a peculiarity of the Linux ntfs-3g
4500 filesystem driver (and probably others), which is that although
4501 the underlying filesystem is case-insensitive, the driver
4502 exports the filesystem to Linux as case-sensitive.
4504 One consequence of this is that special directories such
4505 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4506 (or other things) depending on the precise details of how
4507 they were created. In Windows itself this would not be
4510 Bug or feature? You decide:
4511 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4513 This function resolves the true case of each element in the
4514 path and returns the case-sensitive path.
4516 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4517 might return C<\"/WINDOWS/system32\"> (the exact return value
4518 would depend on details of how the directories were originally
4519 created under Windows).
4522 This function does not handle drive names, backslashes etc.
4524 See also C<guestfs_realpath>.");
4526 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4527 [InitScratchFS, Always, TestOutput (
4528 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4529 "get the Linux VFS type corresponding to a mounted device",
4531 This command gets the filesystem type corresponding to
4532 the filesystem on C<device>.
4534 For most filesystems, the result is the name of the Linux
4535 VFS module which would be used to mount this filesystem
4536 if you mounted it without specifying the filesystem type.
4537 For example a string such as C<ext3> or C<ntfs>.");
4539 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4540 [InitScratchFS, Always, TestOutputStruct (
4541 [["write"; "/truncate"; "some stuff so size is not zero"];
4542 ["truncate"; "/truncate"];
4543 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4544 "truncate a file to zero size",
4546 This command truncates C<path> to a zero-length file. The
4547 file must exist already.");
4549 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4550 [InitScratchFS, Always, TestOutputStruct (
4551 [["touch"; "/truncate_size"];
4552 ["truncate_size"; "/truncate_size"; "1000"];
4553 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4554 "truncate a file to a particular size",
4556 This command truncates C<path> to size C<size> bytes. The file
4559 If the current file size is less than C<size> then
4560 the file is extended to the required size with zero bytes.
4561 This creates a sparse file (ie. disk blocks are not allocated
4562 for the file until you write to it). To create a non-sparse
4563 file of zeroes, use C<guestfs_fallocate64> instead.");
4565 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4566 [InitScratchFS, Always, TestOutputStruct (
4567 [["touch"; "/utimens"];
4568 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4569 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4570 "set timestamp of a file with nanosecond precision",
4572 This command sets the timestamps of a file with nanosecond
4575 C<atsecs, atnsecs> are the last access time (atime) in secs and
4576 nanoseconds from the epoch.
4578 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4579 secs and nanoseconds from the epoch.
4581 If the C<*nsecs> field contains the special value C<-1> then
4582 the corresponding timestamp is set to the current time. (The
4583 C<*secs> field is ignored in this case).
4585 If the C<*nsecs> field contains the special value C<-2> then
4586 the corresponding timestamp is left unchanged. (The
4587 C<*secs> field is ignored in this case).");
4589 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4590 [InitScratchFS, Always, TestOutputStruct (
4591 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4592 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4593 "create a directory with a particular mode",
4595 This command creates a directory, setting the initial permissions
4596 of the directory to C<mode>.
4598 For common Linux filesystems, the actual mode which is set will
4599 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4600 interpret the mode in other ways.
4602 See also C<guestfs_mkdir>, C<guestfs_umask>");
4604 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4606 "change file owner and group",
4608 Change the file owner to C<owner> and group to C<group>.
4609 This is like C<guestfs_chown> but if C<path> is a symlink then
4610 the link itself is changed, not the target.
4612 Only numeric uid and gid are supported. If you want to use
4613 names, you will need to locate and parse the password file
4614 yourself (Augeas support makes this relatively easy).");
4616 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4618 "lstat on multiple files",
4620 This call allows you to perform the C<guestfs_lstat> operation
4621 on multiple files, where all files are in the directory C<path>.
4622 C<names> is the list of files from this directory.
4624 On return you get a list of stat structs, with a one-to-one
4625 correspondence to the C<names> list. If any name did not exist
4626 or could not be lstat'd, then the C<ino> field of that structure
4629 This call is intended for programs that want to efficiently
4630 list a directory contents without making many round-trips.
4631 See also C<guestfs_lxattrlist> for a similarly efficient call
4632 for getting extended attributes. Very long directory listings
4633 might cause the protocol message size to be exceeded, causing
4634 this call to fail. The caller must split up such requests
4635 into smaller groups of names.");
4637 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4639 "lgetxattr on multiple files",
4641 This call allows you to get the extended attributes
4642 of multiple files, where all files are in the directory C<path>.
4643 C<names> is the list of files from this directory.
4645 On return you get a flat list of xattr structs which must be
4646 interpreted sequentially. The first xattr struct always has a zero-length
4647 C<attrname>. C<attrval> in this struct is zero-length
4648 to indicate there was an error doing C<lgetxattr> for this
4649 file, I<or> is a C string which is a decimal number
4650 (the number of following attributes for this file, which could
4651 be C<\"0\">). Then after the first xattr struct are the
4652 zero or more attributes for the first named file.
4653 This repeats for the second and subsequent files.
4655 This call is intended for programs that want to efficiently
4656 list a directory contents without making many round-trips.
4657 See also C<guestfs_lstatlist> for a similarly efficient call
4658 for getting standard stats. Very long directory listings
4659 might cause the protocol message size to be exceeded, causing
4660 this call to fail. The caller must split up such requests
4661 into smaller groups of names.");
4663 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4665 "readlink on multiple files",
4667 This call allows you to do a C<readlink> operation
4668 on multiple files, where all files are in the directory C<path>.
4669 C<names> is the list of files from this directory.
4671 On return you get a list of strings, with a one-to-one
4672 correspondence to the C<names> list. Each string is the
4673 value of the symbolic link.
4675 If the C<readlink(2)> operation fails on any name, then
4676 the corresponding result string is the empty string C<\"\">.
4677 However the whole operation is completed even if there
4678 were C<readlink(2)> errors, and so you can call this
4679 function with names where you don't know if they are
4680 symbolic links already (albeit slightly less efficient).
4682 This call is intended for programs that want to efficiently
4683 list a directory contents without making many round-trips.
4684 Very long directory listings might cause the protocol
4685 message size to be exceeded, causing
4686 this call to fail. The caller must split up such requests
4687 into smaller groups of names.");
4689 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4690 [InitISOFS, Always, TestOutputBuffer (
4691 [["pread"; "/known-4"; "1"; "3"]], "\n");
4692 InitISOFS, Always, TestOutputBuffer (
4693 [["pread"; "/empty"; "0"; "100"]], "")],
4694 "read part of a file",
4696 This command lets you read part of a file. It reads C<count>
4697 bytes of the file, starting at C<offset>, from file C<path>.
4699 This may read fewer bytes than requested. For further details
4700 see the L<pread(2)> system call.
4702 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4704 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4705 [InitEmpty, Always, TestRun (
4706 [["part_init"; "/dev/sda"; "gpt"]])],
4707 "create an empty partition table",
4709 This creates an empty partition table on C<device> of one of the
4710 partition types listed below. Usually C<parttype> should be
4711 either C<msdos> or C<gpt> (for large disks).
4713 Initially there are no partitions. Following this, you should
4714 call C<guestfs_part_add> for each partition required.
4716 Possible values for C<parttype> are:
4720 =item B<efi> | B<gpt>
4722 Intel EFI / GPT partition table.
4724 This is recommended for >= 2 TB partitions that will be accessed
4725 from Linux and Intel-based Mac OS X. It also has limited backwards
4726 compatibility with the C<mbr> format.
4728 =item B<mbr> | B<msdos>
4730 The standard PC \"Master Boot Record\" (MBR) format used
4731 by MS-DOS and Windows. This partition type will B<only> work
4732 for device sizes up to 2 TB. For large disks we recommend
4737 Other partition table types that may work but are not
4746 =item B<amiga> | B<rdb>
4748 Amiga \"Rigid Disk Block\" format.
4756 DASD, used on IBM mainframes.
4764 Old Mac partition format. Modern Macs use C<gpt>.
4768 NEC PC-98 format, common in Japan apparently.
4776 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4777 [InitEmpty, Always, TestRun (
4778 [["part_init"; "/dev/sda"; "mbr"];
4779 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4780 InitEmpty, Always, TestRun (
4781 [["part_init"; "/dev/sda"; "gpt"];
4782 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4783 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4784 InitEmpty, Always, TestRun (
4785 [["part_init"; "/dev/sda"; "mbr"];
4786 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4787 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4788 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4789 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4790 "add a partition to the device",
4792 This command adds a partition to C<device>. If there is no partition
4793 table on the device, call C<guestfs_part_init> first.
4795 The C<prlogex> parameter is the type of partition. Normally you
4796 should pass C<p> or C<primary> here, but MBR partition tables also
4797 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4800 C<startsect> and C<endsect> are the start and end of the partition
4801 in I<sectors>. C<endsect> may be negative, which means it counts
4802 backwards from the end of the disk (C<-1> is the last sector).
4804 Creating a partition which covers the whole disk is not so easy.
4805 Use C<guestfs_part_disk> to do that.");
4807 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4808 [InitEmpty, Always, TestRun (
4809 [["part_disk"; "/dev/sda"; "mbr"]]);
4810 InitEmpty, Always, TestRun (
4811 [["part_disk"; "/dev/sda"; "gpt"]])],
4812 "partition whole disk with a single primary partition",
4814 This command is simply a combination of C<guestfs_part_init>
4815 followed by C<guestfs_part_add> to create a single primary partition
4816 covering the whole disk.
4818 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4819 but other possible values are described in C<guestfs_part_init>.");
4821 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4822 [InitEmpty, Always, TestRun (
4823 [["part_disk"; "/dev/sda"; "mbr"];
4824 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4825 "make a partition bootable",
4827 This sets the bootable flag on partition numbered C<partnum> on
4828 device C<device>. Note that partitions are numbered from 1.
4830 The bootable flag is used by some operating systems (notably
4831 Windows) to determine which partition to boot from. It is by
4832 no means universally recognized.");
4834 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4835 [InitEmpty, Always, TestRun (
4836 [["part_disk"; "/dev/sda"; "gpt"];
4837 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4838 "set partition name",
4840 This sets the partition name on partition numbered C<partnum> on
4841 device C<device>. Note that partitions are numbered from 1.
4843 The partition name can only be set on certain types of partition
4844 table. This works on C<gpt> but not on C<mbr> partitions.");
4846 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4847 [], (* XXX Add a regression test for this. *)
4848 "list partitions on a device",
4850 This command parses the partition table on C<device> and
4851 returns the list of partitions found.
4853 The fields in the returned structure are:
4859 Partition number, counting from 1.
4863 Start of the partition I<in bytes>. To get sectors you have to
4864 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4868 End of the partition in bytes.
4872 Size of the partition in bytes.
4876 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4877 [InitEmpty, Always, TestOutput (
4878 [["part_disk"; "/dev/sda"; "gpt"];
4879 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4880 "get the partition table type",
4882 This command examines the partition table on C<device> and
4883 returns the partition table type (format) being used.
4885 Common return values include: C<msdos> (a DOS/Windows style MBR
4886 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4887 values are possible, although unusual. See C<guestfs_part_init>
4890 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4891 [InitScratchFS, Always, TestOutputBuffer (
4892 [["fill"; "0x63"; "10"; "/fill"];
4893 ["read_file"; "/fill"]], "cccccccccc")],
4894 "fill a file with octets",
4896 This command creates a new file called C<path>. The initial
4897 content of the file is C<len> octets of C<c>, where C<c>
4898 must be a number in the range C<[0..255]>.
4900 To fill a file with zero bytes (sparsely), it is
4901 much more efficient to use C<guestfs_truncate_size>.
4902 To create a file with a pattern of repeating bytes
4903 use C<guestfs_fill_pattern>.");
4905 ("available", (RErr, [StringList "groups"], []), 216, [],
4906 [InitNone, Always, TestRun [["available"; ""]]],
4907 "test availability of some parts of the API",
4909 This command is used to check the availability of some
4910 groups of functionality in the appliance, which not all builds of
4911 the libguestfs appliance will be able to provide.
4913 The libguestfs groups, and the functions that those
4914 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4915 You can also fetch this list at runtime by calling
4916 C<guestfs_available_all_groups>.
4918 The argument C<groups> is a list of group names, eg:
4919 C<[\"inotify\", \"augeas\"]> would check for the availability of
4920 the Linux inotify functions and Augeas (configuration file
4923 The command returns no error if I<all> requested groups are available.
4925 It fails with an error if one or more of the requested
4926 groups is unavailable in the appliance.
4928 If an unknown group name is included in the
4929 list of groups then an error is always returned.
4937 You must call C<guestfs_launch> before calling this function.
4939 The reason is because we don't know what groups are
4940 supported by the appliance/daemon until it is running and can
4945 If a group of functions is available, this does not necessarily
4946 mean that they will work. You still have to check for errors
4947 when calling individual API functions even if they are
4952 It is usually the job of distro packagers to build
4953 complete functionality into the libguestfs appliance.
4954 Upstream libguestfs, if built from source with all
4955 requirements satisfied, will support everything.
4959 This call was added in version C<1.0.80>. In previous
4960 versions of libguestfs all you could do would be to speculatively
4961 execute a command to find out if the daemon implemented it.
4962 See also C<guestfs_version>.
4966 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4967 [InitScratchFS, Always, TestOutputBuffer (
4969 ["write"; "/dd/src"; "hello, world"];
4970 ["dd"; "/dd/src"; "/dd/dest"];
4971 ["read_file"; "/dd/dest"]], "hello, world")],
4972 "copy from source to destination using dd",
4974 This command copies from one source device or file C<src>
4975 to another destination device or file C<dest>. Normally you
4976 would use this to copy to or from a device or partition, for
4977 example to duplicate a filesystem.
4979 If the destination is a device, it must be as large or larger
4980 than the source file or device, otherwise the copy will fail.
4981 This command cannot do partial copies (see C<guestfs_copy_size>).");
4983 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4984 [InitScratchFS, Always, TestOutputInt (
4985 [["write"; "/filesize"; "hello, world"];
4986 ["filesize"; "/filesize"]], 12)],
4987 "return the size of the file in bytes",
4989 This command returns the size of C<file> in bytes.
4991 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4992 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4993 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4995 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4996 [InitBasicFSonLVM, Always, TestOutputList (
4997 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4998 ["lvs"]], ["/dev/VG/LV2"])],
4999 "rename an LVM logical volume",
5001 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5003 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5004 [InitBasicFSonLVM, Always, TestOutputList (
5006 ["vg_activate"; "false"; "VG"];
5007 ["vgrename"; "VG"; "VG2"];
5008 ["vg_activate"; "true"; "VG2"];
5009 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5010 ["vgs"]], ["VG2"])],
5011 "rename an LVM volume group",
5013 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5015 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5016 [InitISOFS, Always, TestOutputBuffer (
5017 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5018 "list the contents of a single file in an initrd",
5020 This command unpacks the file C<filename> from the initrd file
5021 called C<initrdpath>. The filename must be given I<without> the
5022 initial C</> character.
5024 For example, in guestfish you could use the following command
5025 to examine the boot script (usually called C</init>)
5026 contained in a Linux initrd or initramfs image:
5028 initrd-cat /boot/initrd-<version>.img init
5030 See also C<guestfs_initrd_list>.");
5032 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5034 "get the UUID of a physical volume",
5036 This command returns the UUID of the LVM PV C<device>.");
5038 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5040 "get the UUID of a volume group",
5042 This command returns the UUID of the LVM VG named C<vgname>.");
5044 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5046 "get the UUID of a logical volume",
5048 This command returns the UUID of the LVM LV C<device>.");
5050 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5052 "get the PV UUIDs containing the volume group",
5054 Given a VG called C<vgname>, this returns the UUIDs of all
5055 the physical volumes that this volume group resides on.
5057 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5058 calls to associate physical volumes and volume groups.
5060 See also C<guestfs_vglvuuids>.");
5062 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5064 "get the LV UUIDs of all LVs in the volume group",
5066 Given a VG called C<vgname>, this returns the UUIDs of all
5067 the logical volumes created in this volume group.
5069 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5070 calls to associate logical volumes and volume groups.
5072 See also C<guestfs_vgpvuuids>.");
5074 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5075 [InitScratchFS, Always, TestOutputBuffer (
5076 [["mkdir"; "/copy_size"];
5077 ["write"; "/copy_size/src"; "hello, world"];
5078 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5079 ["read_file"; "/copy_size/dest"]], "hello")],
5080 "copy size bytes from source to destination using dd",
5082 This command copies exactly C<size> bytes from one source device
5083 or file C<src> to another destination device or file C<dest>.
5085 Note this will fail if the source is too short or if the destination
5086 is not large enough.");
5088 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5089 [InitBasicFSonLVM, Always, TestRun (
5090 [["zero_device"; "/dev/VG/LV"]])],
5091 "write zeroes to an entire device",
5093 This command writes zeroes over the entire C<device>. Compare
5094 with C<guestfs_zero> which just zeroes the first few blocks of
5097 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5098 [InitScratchFS, Always, TestOutput (
5099 [["mkdir"; "/txz_in"];
5100 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5101 ["cat"; "/txz_in/hello"]], "hello\n")],
5102 "unpack compressed tarball to directory",
5104 This command uploads and unpacks local file C<tarball> (an
5105 I<xz compressed> tar file) into C<directory>.");
5107 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5109 "pack directory into compressed tarball",
5111 This command packs the contents of C<directory> and downloads
5112 it to local file C<tarball> (as an xz compressed tar archive).");
5114 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5116 "resize an NTFS filesystem",
5118 This command resizes an NTFS filesystem, expanding or
5119 shrinking it to the size of the underlying device.
5120 See also L<ntfsresize(8)>.");
5122 ("vgscan", (RErr, [], []), 232, [],
5123 [InitEmpty, Always, TestRun (
5125 "rescan for LVM physical volumes, volume groups and logical volumes",
5127 This rescans all block devices and rebuilds the list of LVM
5128 physical volumes, volume groups and logical volumes.");
5130 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5131 [InitEmpty, Always, TestRun (
5132 [["part_init"; "/dev/sda"; "mbr"];
5133 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5134 ["part_del"; "/dev/sda"; "1"]])],
5135 "delete a partition",
5137 This command deletes the partition numbered C<partnum> on C<device>.
5139 Note that in the case of MBR partitioning, deleting an
5140 extended partition also deletes any logical partitions
5143 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5144 [InitEmpty, Always, TestOutputTrue (
5145 [["part_init"; "/dev/sda"; "mbr"];
5146 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5147 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5148 ["part_get_bootable"; "/dev/sda"; "1"]])],
5149 "return true if a partition is bootable",
5151 This command returns true if the partition C<partnum> on
5152 C<device> has the bootable flag set.
5154 See also C<guestfs_part_set_bootable>.");
5156 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5157 [InitEmpty, Always, TestOutputInt (
5158 [["part_init"; "/dev/sda"; "mbr"];
5159 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5160 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5161 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5162 "get the MBR type byte (ID byte) from a partition",
5164 Returns the MBR type byte (also known as the ID byte) from
5165 the numbered partition C<partnum>.
5167 Note that only MBR (old DOS-style) partitions have type bytes.
5168 You will get undefined results for other partition table
5169 types (see C<guestfs_part_get_parttype>).");
5171 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5172 [], (* tested by part_get_mbr_id *)
5173 "set the MBR type byte (ID byte) of a partition",
5175 Sets the MBR type byte (also known as the ID byte) of
5176 the numbered partition C<partnum> to C<idbyte>. Note
5177 that the type bytes quoted in most documentation are
5178 in fact hexadecimal numbers, but usually documented
5179 without any leading \"0x\" which might be confusing.
5181 Note that only MBR (old DOS-style) partitions have type bytes.
5182 You will get undefined results for other partition table
5183 types (see C<guestfs_part_get_parttype>).");
5185 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5186 [InitISOFS, Always, TestOutputFileMD5 (
5187 [["checksum_device"; "md5"; "/dev/sdd"]],
5188 "../images/test.iso")],
5189 "compute MD5, SHAx or CRC checksum of the contents of a device",
5191 This call computes the MD5, SHAx or CRC checksum of the
5192 contents of the device named C<device>. For the types of
5193 checksums supported see the C<guestfs_checksum> command.");
5195 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5196 [InitNone, Always, TestRun (
5197 [["part_disk"; "/dev/sda"; "mbr"];
5198 ["pvcreate"; "/dev/sda1"];
5199 ["vgcreate"; "VG"; "/dev/sda1"];
5200 ["lvcreate"; "LV"; "VG"; "10"];
5201 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5202 "expand an LV to fill free space",
5204 This expands an existing logical volume C<lv> so that it fills
5205 C<pc>% of the remaining free space in the volume group. Commonly
5206 you would call this with pc = 100 which expands the logical volume
5207 as much as possible, using all remaining free space in the volume
5210 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5211 [], (* XXX Augeas code needs tests. *)
5212 "clear Augeas path",
5214 Set the value associated with C<path> to C<NULL>. This
5215 is the same as the L<augtool(1)> C<clear> command.");
5217 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5218 [InitEmpty, Always, TestOutputInt (
5219 [["get_umask"]], 0o22)],
5220 "get the current umask",
5222 Return the current umask. By default the umask is C<022>
5223 unless it has been set by calling C<guestfs_umask>.");
5225 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5227 "upload a file to the appliance (internal use only)",
5229 The C<guestfs_debug_upload> command uploads a file to
5230 the libguestfs appliance.
5232 There is no comprehensive help for this command. You have
5233 to look at the file C<daemon/debug.c> in the libguestfs source
5234 to find out what it is for.");
5236 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5237 [InitScratchFS, Always, TestOutput (
5238 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5239 ["cat"; "/base64_in"]], "hello\n")],
5240 "upload base64-encoded data to file",
5242 This command uploads base64-encoded data from C<base64file>
5245 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5247 "download file and encode as base64",
5249 This command downloads the contents of C<filename>, writing
5250 it out to local file C<base64file> encoded as base64.");
5252 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5254 "compute MD5, SHAx or CRC checksum of files in a directory",
5256 This command computes the checksums of all regular files in
5257 C<directory> and then emits a list of those checksums to
5258 the local output file C<sumsfile>.
5260 This can be used for verifying the integrity of a virtual
5261 machine. However to be properly secure you should pay
5262 attention to the output of the checksum command (it uses
5263 the ones from GNU coreutils). In particular when the
5264 filename is not printable, coreutils uses a special
5265 backslash syntax. For more information, see the GNU
5266 coreutils info file.");
5268 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5269 [InitScratchFS, Always, TestOutputBuffer (
5270 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5271 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5272 "fill a file with a repeating pattern of bytes",
5274 This function is like C<guestfs_fill> except that it creates
5275 a new file of length C<len> containing the repeating pattern
5276 of bytes in C<pattern>. The pattern is truncated if necessary
5277 to ensure the length of the file is exactly C<len> bytes.");
5279 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5280 [InitScratchFS, Always, TestOutput (
5281 [["write"; "/write"; "new file contents"];
5282 ["cat"; "/write"]], "new file contents");
5283 InitScratchFS, Always, TestOutput (
5284 [["write"; "/write2"; "\nnew file contents\n"];
5285 ["cat"; "/write2"]], "\nnew file contents\n");
5286 InitScratchFS, Always, TestOutput (
5287 [["write"; "/write3"; "\n\n"];
5288 ["cat"; "/write3"]], "\n\n");
5289 InitScratchFS, Always, TestOutput (
5290 [["write"; "/write4"; ""];
5291 ["cat"; "/write4"]], "");
5292 InitScratchFS, Always, TestOutput (
5293 [["write"; "/write5"; "\n\n\n"];
5294 ["cat"; "/write5"]], "\n\n\n");
5295 InitScratchFS, Always, TestOutput (
5296 [["write"; "/write6"; "\n"];
5297 ["cat"; "/write6"]], "\n")],
5298 "create a new file",
5300 This call creates a file called C<path>. The content of the
5301 file is the string C<content> (which can contain any 8 bit data).");
5303 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5304 [InitScratchFS, Always, TestOutput (
5305 [["write"; "/pwrite"; "new file contents"];
5306 ["pwrite"; "/pwrite"; "data"; "4"];
5307 ["cat"; "/pwrite"]], "new data contents");
5308 InitScratchFS, Always, TestOutput (
5309 [["write"; "/pwrite2"; "new file contents"];
5310 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5311 ["cat"; "/pwrite2"]], "new file is extended");
5312 InitScratchFS, Always, TestOutput (
5313 [["write"; "/pwrite3"; "new file contents"];
5314 ["pwrite"; "/pwrite3"; ""; "4"];
5315 ["cat"; "/pwrite3"]], "new file contents")],
5316 "write to part of a file",
5318 This command writes to part of a file. It writes the data
5319 buffer C<content> to the file C<path> starting at offset C<offset>.
5321 This command implements the L<pwrite(2)> system call, and like
5322 that system call it may not write the full data requested. The
5323 return value is the number of bytes that were actually written
5324 to the file. This could even be 0, although short writes are
5325 unlikely for regular files in ordinary circumstances.
5327 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5329 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5331 "resize an ext2, ext3 or ext4 filesystem (with size)",
5333 This command is the same as C<guestfs_resize2fs> except that it
5334 allows you to specify the new size (in bytes) explicitly.");
5336 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5338 "resize an LVM physical volume (with size)",
5340 This command is the same as C<guestfs_pvresize> except that it
5341 allows you to specify the new size (in bytes) explicitly.");
5343 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5345 "resize an NTFS filesystem (with size)",
5347 This command is the same as C<guestfs_ntfsresize> except that it
5348 allows you to specify the new size (in bytes) explicitly.");
5350 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5351 [InitNone, Always, TestRun [["available_all_groups"]]],
5352 "return a list of all optional groups",
5354 This command returns a list of all optional groups that this
5355 daemon knows about. Note this returns both supported and unsupported
5356 groups. To find out which ones the daemon can actually support
5357 you have to call C<guestfs_available> on each member of the
5360 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5362 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5363 [InitScratchFS, Always, TestOutputStruct (
5364 [["fallocate64"; "/fallocate64"; "1000000"];
5365 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5366 "preallocate a file in the guest filesystem",
5368 This command preallocates a file (containing zero bytes) named
5369 C<path> of size C<len> bytes. If the file exists already, it
5372 Note that this call allocates disk blocks for the file.
5373 To create a sparse file use C<guestfs_truncate_size> instead.
5375 The deprecated call C<guestfs_fallocate> does the same,
5376 but owing to an oversight it only allowed 30 bit lengths
5377 to be specified, effectively limiting the maximum size
5378 of files created through that call to 1GB.
5380 Do not confuse this with the guestfish-specific
5381 C<alloc> and C<sparse> commands which create
5382 a file in the host and attach it as a device.");
5384 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5385 [InitBasicFS, Always, TestOutput (
5386 [["set_e2label"; "/dev/sda1"; "LTEST"];
5387 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5388 "get the filesystem label",
5390 This returns the filesystem label of the filesystem on
5393 If the filesystem is unlabeled, this returns the empty string.
5395 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5397 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5398 (let uuid = uuidgen () in
5399 [InitBasicFS, Always, TestOutput (
5400 [["set_e2uuid"; "/dev/sda1"; uuid];
5401 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5402 "get the filesystem UUID",
5404 This returns the filesystem UUID of the filesystem on
5407 If the filesystem does not have a UUID, this returns the empty string.
5409 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5411 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5412 (* Can't be tested with the current framework because
5413 * the VG is being used by the mounted filesystem, so
5414 * the vgchange -an command we do first will fail.
5417 "set LVM device filter",
5419 This sets the LVM device filter so that LVM will only be
5420 able to \"see\" the block devices in the list C<devices>,
5421 and will ignore all other attached block devices.
5423 Where disk image(s) contain duplicate PVs or VGs, this
5424 command is useful to get LVM to ignore the duplicates, otherwise
5425 LVM can get confused. Note also there are two types
5426 of duplication possible: either cloned PVs/VGs which have
5427 identical UUIDs; or VGs that are not cloned but just happen
5428 to have the same name. In normal operation you cannot
5429 create this situation, but you can do it outside LVM, eg.
5430 by cloning disk images or by bit twiddling inside the LVM
5433 This command also clears the LVM cache and performs a volume
5436 You can filter whole block devices or individual partitions.
5438 You cannot use this if any VG is currently in use (eg.
5439 contains a mounted filesystem), even if you are not
5440 filtering out that VG.");
5442 ("lvm_clear_filter", (RErr, [], []), 256, [],
5443 [], (* see note on lvm_set_filter *)
5444 "clear LVM device filter",
5446 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5447 will be able to see every block device.
5449 This command also clears the LVM cache and performs a volume
5452 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5454 "open a LUKS-encrypted block device",
5456 This command opens a block device which has been encrypted
5457 according to the Linux Unified Key Setup (LUKS) standard.
5459 C<device> is the encrypted block device or partition.
5461 The caller must supply one of the keys associated with the
5462 LUKS block device, in the C<key> parameter.
5464 This creates a new block device called C</dev/mapper/mapname>.
5465 Reads and writes to this block device are decrypted from and
5466 encrypted to the underlying C<device> respectively.
5468 If this block device contains LVM volume groups, then
5469 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5470 will make them visible.");
5472 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5474 "open a LUKS-encrypted block device read-only",
5476 This is the same as C<guestfs_luks_open> except that a read-only
5477 mapping is created.");
5479 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5481 "close a LUKS device",
5483 This closes a LUKS device that was created earlier by
5484 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5485 C<device> parameter must be the name of the LUKS mapping
5486 device (ie. C</dev/mapper/mapname>) and I<not> the name
5487 of the underlying block device.");
5489 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5491 "format a block device as a LUKS encrypted device",
5493 This command erases existing data on C<device> and formats
5494 the device as a LUKS encrypted device. C<key> is the
5495 initial key, which is added to key slot C<slot>. (LUKS
5496 supports 8 key slots, numbered 0-7).");
5498 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5500 "format a block device as a LUKS encrypted device",
5502 This command is the same as C<guestfs_luks_format> but
5503 it also allows you to set the C<cipher> used.");
5505 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5507 "add a key on a LUKS encrypted device",
5509 This command adds a new key on LUKS device C<device>.
5510 C<key> is any existing key, and is used to access the device.
5511 C<newkey> is the new key to add. C<keyslot> is the key slot
5512 that will be replaced.
5514 Note that if C<keyslot> already contains a key, then this
5515 command will fail. You have to use C<guestfs_luks_kill_slot>
5516 first to remove that key.");
5518 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5520 "remove a key from a LUKS encrypted device",
5522 This command deletes the key in key slot C<keyslot> from the
5523 encrypted LUKS device C<device>. C<key> must be one of the
5526 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5527 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5528 [["is_lv"; "/dev/VG/LV"]]);
5529 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5530 [["is_lv"; "/dev/sda1"]])],
5531 "test if device is a logical volume",
5533 This command tests whether C<device> is a logical volume, and
5534 returns true iff this is the case.");
5536 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5538 "find a filesystem by UUID",
5540 This command searches the filesystems and returns the one
5541 which has the given UUID. An error is returned if no such
5542 filesystem can be found.
5544 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5546 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5548 "find a filesystem by label",
5550 This command searches the filesystems and returns the one
5551 which has the given label. An error is returned if no such
5552 filesystem can be found.
5554 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5556 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5557 [InitISOFS, Always, TestOutputFalse (
5558 [["is_chardev"; "/directory"]]);
5559 InitScratchFS, Always, TestOutputTrue (
5560 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5561 ["is_chardev"; "/is_chardev"]])],
5562 "test if character device",
5564 This returns C<true> if and only if there is a character device
5565 with the given C<path> name.
5567 See also C<guestfs_stat>.");
5569 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5570 [InitISOFS, Always, TestOutputFalse (
5571 [["is_blockdev"; "/directory"]]);
5572 InitScratchFS, Always, TestOutputTrue (
5573 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5574 ["is_blockdev"; "/is_blockdev"]])],
5575 "test if block device",
5577 This returns C<true> if and only if there is a block device
5578 with the given C<path> name.
5580 See also C<guestfs_stat>.");
5582 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5583 [InitISOFS, Always, TestOutputFalse (
5584 [["is_fifo"; "/directory"]]);
5585 InitScratchFS, Always, TestOutputTrue (
5586 [["mkfifo"; "0o777"; "/is_fifo"];
5587 ["is_fifo"; "/is_fifo"]])],
5588 "test if FIFO (named pipe)",
5590 This returns C<true> if and only if there is a FIFO (named pipe)
5591 with the given C<path> name.
5593 See also C<guestfs_stat>.");
5595 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5596 [InitISOFS, Always, TestOutputFalse (
5597 [["is_symlink"; "/directory"]]);
5598 InitISOFS, Always, TestOutputTrue (
5599 [["is_symlink"; "/abssymlink"]])],
5600 "test if symbolic link",
5602 This returns C<true> if and only if there is a symbolic link
5603 with the given C<path> name.
5605 See also C<guestfs_stat>.");
5607 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5608 (* XXX Need a positive test for sockets. *)
5609 [InitISOFS, Always, TestOutputFalse (
5610 [["is_socket"; "/directory"]])],
5613 This returns C<true> if and only if there is a Unix domain socket
5614 with the given C<path> name.
5616 See also C<guestfs_stat>.");
5618 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5619 [InitPartition, Always, TestOutputDevice (
5620 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5621 InitEmpty, Always, TestLastFail (
5622 [["part_to_dev"; "/dev/sda"]])],
5623 "convert partition name to device name",
5625 This function takes a partition name (eg. \"/dev/sdb1\") and
5626 removes the partition number, returning the device name
5629 The named partition must exist, for example as a string returned
5630 from C<guestfs_list_partitions>.");
5632 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5633 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5634 [InitScratchFS, Always, TestOutput (
5635 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5636 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5637 "upload a file from the local machine with offset",
5639 Upload local file C<filename> to C<remotefilename> on the
5642 C<remotefilename> is overwritten starting at the byte C<offset>
5643 specified. The intention is to overwrite parts of existing
5644 files or devices, although if a non-existant file is specified
5645 then it is created with a \"hole\" before C<offset>. The
5646 size of the data written is implicit in the size of the
5649 Note that there is no limit on the amount of data that
5650 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5651 and this call always writes the full amount unless an
5654 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5656 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5657 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5658 let offset = string_of_int 100 in
5659 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5660 [InitScratchFS, Always, TestOutput (
5661 (* Pick a file from cwd which isn't likely to change. *)
5662 [["mkdir"; "/download_offset"];
5663 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5664 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5665 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5666 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5667 "download a file to the local machine with offset and size",
5669 Download file C<remotefilename> and save it as C<filename>
5670 on the local machine.
5672 C<remotefilename> is read for C<size> bytes starting at C<offset>
5673 (this region must be within the file or device).
5675 Note that there is no limit on the amount of data that
5676 can be downloaded with this call, unlike with C<guestfs_pread>,
5677 and this call always reads the full amount unless an
5680 See also C<guestfs_download>, C<guestfs_pread>.");
5682 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5683 [InitPartition, Always, TestOutputListOfDevices (
5684 [["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"];
5685 ["blockdev_rereadpt"; "/dev/sda"];
5686 ["list_partitions"]], ["/dev/sdb1"])],
5687 "write to part of a device",
5689 This command writes to part of a device. It writes the data
5690 buffer C<content> to C<device> starting at offset C<offset>.
5692 This command implements the L<pwrite(2)> system call, and like
5693 that system call it may not write the full data requested
5694 (although short writes to disk devices and partitions are
5695 probably impossible with standard Linux kernels).
5697 See also C<guestfs_pwrite>.");
5699 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5700 [InitEmpty, Always, TestOutputBuffer (
5701 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5702 "read part of a device",
5704 This command lets you read part of a file. It reads C<count>
5705 bytes of C<device>, starting at C<offset>.
5707 This may read fewer bytes than requested. For further details
5708 see the L<pread(2)> system call.
5710 See also C<guestfs_pread>.");
5712 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5713 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5714 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5715 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5716 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5717 "get canonical name of an LV",
5719 This converts alternative naming schemes for LVs that you
5720 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5721 is converted to C</dev/VG/LV>.
5723 This command returns an error if the C<lvname> parameter does
5724 not refer to a logical volume.
5726 See also C<guestfs_is_lv>.");
5728 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5729 [InitEmpty, Always, TestOutput (
5730 [["part_disk"; "/dev/sda"; "mbr"];
5731 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5732 ["mount_options"; ""; "/dev/sda1"; "/"];
5733 ["write"; "/new"; "new file contents"];
5734 ["cat"; "/new"]], "new file contents")],
5735 "make a filesystem",
5737 This function creates a filesystem on C<device>. The filesystem
5738 type is C<fstype>, for example C<ext3>.
5740 The optional arguments are:
5746 The filesystem block size. Supported block sizes depend on the
5747 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5748 for Linux ext2/3 filesystems.
5750 For VFAT and NTFS the C<blocksize> parameter is treated as
5751 the requested cluster size.
5753 For UFS block sizes, please see L<mkfs.ufs(8)>.
5757 This passes the C<-O> parameter to the external mkfs program.
5759 For certain filesystem types, this allows extra filesystem
5760 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5763 You cannot use this optional parameter with the C<gfs> or
5764 C<gfs2> filesystem type.
5768 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5770 "get a single extended attribute",
5772 Get a single extended attribute from file C<path> named C<name>.
5773 This call follows symlinks. If you want to lookup an extended
5774 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5776 Normally it is better to get all extended attributes from a file
5777 in one go by calling C<guestfs_getxattrs>. However some Linux
5778 filesystem implementations are buggy and do not provide a way to
5779 list out attributes. For these filesystems (notably ntfs-3g)
5780 you have to know the names of the extended attributes you want
5781 in advance and call this function.
5783 Extended attribute values are blobs of binary data. If there
5784 is no extended attribute named C<name>, this returns an error.
5786 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5788 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5790 "get a single extended attribute",
5792 Get a single extended attribute from file C<path> named C<name>.
5793 If C<path> is a symlink, then this call returns an extended
5794 attribute from the symlink.
5796 Normally it is better to get all extended attributes from a file
5797 in one go by calling C<guestfs_getxattrs>. However some Linux
5798 filesystem implementations are buggy and do not provide a way to
5799 list out attributes. For these filesystems (notably ntfs-3g)
5800 you have to know the names of the extended attributes you want
5801 in advance and call this function.
5803 Extended attribute values are blobs of binary data. If there
5804 is no extended attribute named C<name>, this returns an error.
5806 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5808 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5810 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5812 This command is the same as C<guestfs_resize2fs>, but the filesystem
5813 is resized to its minimum size. This works like the C<-M> option
5814 to the C<resize2fs> command.
5816 To get the resulting size of the filesystem you should call
5817 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5818 values. These two numbers, multiplied together, give the
5819 resulting size of the minimal filesystem in bytes.");
5821 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5823 "internal autosync operation",
5825 This command performs the autosync operation just before the
5826 handle is closed. You should not call this command directly.
5827 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5828 control whether or not this operation is performed when the
5829 handle is closed.");
5833 let all_functions = non_daemon_functions @ daemon_functions
5835 (* In some places we want the functions to be displayed sorted
5836 * alphabetically, so this is useful:
5838 let all_functions_sorted = List.sort action_compare all_functions
5840 (* This is used to generate the src/MAX_PROC_NR file which
5841 * contains the maximum procedure number, a surrogate for the
5842 * ABI version number. See src/Makefile.am for the details.
5845 let proc_nrs = List.map (
5846 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5847 ) daemon_functions in
5848 List.fold_left max 0 proc_nrs
5850 (* Non-API meta-commands available only in guestfish.
5852 * Note (1): style, proc_nr and tests fields are all meaningless.
5853 * The only fields which are actually used are the shortname,
5854 * FishAlias flags, shortdesc and longdesc.
5856 * Note (2): to refer to other commands, use L</shortname>.
5858 * Note (3): keep this list sorted by shortname.
5860 let fish_commands = [
5861 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5862 "allocate and add a disk file",
5863 " alloc filename size
5865 This creates an empty (zeroed) file of the given size, and then adds
5866 so it can be further examined.
5868 For more advanced image creation, see L<qemu-img(1)> utility.
5870 Size can be specified using standard suffixes, eg. C<1M>.
5872 To create a sparse file, use L</sparse> instead. To create a
5873 prepared disk image, see L</PREPARED DISK IMAGES>.");
5875 ("copy_in", (RErr,[], []), -1, [], [],
5876 "copy local files or directories into an image",
5877 " copy-in local [local ...] /remotedir
5879 C<copy-in> copies local files or directories recursively into the disk
5880 image, placing them in the directory called C</remotedir> (which must
5881 exist). This guestfish meta-command turns into a sequence of
5882 L</tar-in> and other commands as necessary.
5884 Multiple local files and directories can be specified, but the last
5885 parameter must always be a remote directory. Wildcards cannot be
5888 ("copy_out", (RErr,[], []), -1, [], [],
5889 "copy remote files or directories out of an image",
5890 " copy-out remote [remote ...] localdir
5892 C<copy-out> copies remote files or directories recursively out of the
5893 disk image, placing them on the host disk in a local directory called
5894 C<localdir> (which must exist). This guestfish meta-command turns
5895 into a sequence of L</download>, L</tar-out> and other commands as
5898 Multiple remote files and directories can be specified, but the last
5899 parameter must always be a local directory. To download to the
5900 current directory, use C<.> as in:
5904 Wildcards cannot be used in the ordinary command, but you can use
5905 them with the help of L</glob> like this:
5907 glob copy-out /home/* .");
5909 ("echo", (RErr,[], []), -1, [], [],
5910 "display a line of text",
5913 This echos the parameters to the terminal.");
5915 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5919 This is used to edit a file. It downloads the file, edits it
5920 locally using your editor, then uploads the result.
5922 The editor is C<$EDITOR>. However if you use the alternate
5923 commands C<vi> or C<emacs> you will get those corresponding
5926 ("glob", (RErr,[], []), -1, [], [],
5927 "expand wildcards in command",
5928 " glob command args...
5930 Expand wildcards in any paths in the args list, and run C<command>
5931 repeatedly on each matching path.
5933 See L</WILDCARDS AND GLOBBING>.");
5935 ("hexedit", (RErr,[], []), -1, [], [],
5936 "edit with a hex editor",
5937 " hexedit <filename|device>
5938 hexedit <filename|device> <max>
5939 hexedit <filename|device> <start> <max>
5941 Use hexedit (a hex editor) to edit all or part of a binary file
5944 This command works by downloading potentially the whole file or
5945 device, editing it locally, then uploading it. If the file or
5946 device is large, you have to specify which part you wish to edit
5947 by using C<max> and/or C<start> C<max> parameters.
5948 C<start> and C<max> are specified in bytes, with the usual
5949 modifiers allowed such as C<1M> (1 megabyte).
5951 For example to edit the first few sectors of a disk you
5956 which would allow you to edit anywhere within the first megabyte
5959 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5961 hexedit /dev/sda1 0x400 0x400
5963 (assuming the superblock is in the standard location).
5965 This command requires the external L<hexedit(1)> program. You
5966 can specify another program to use by setting the C<HEXEDITOR>
5967 environment variable.
5969 See also L</hexdump>.");
5971 ("lcd", (RErr,[], []), -1, [], [],
5972 "change working directory",
5975 Change the local directory, ie. the current directory of guestfish
5978 Note that C<!cd> won't do what you might expect.");
5980 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5984 Opens the manual page for guestfish.");
5986 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5992 This is used to view a file.
5994 The default viewer is C<$PAGER>. However if you use the alternate
5995 command C<less> you will get the C<less> command specifically.");
5997 ("reopen", (RErr,[], []), -1, [], [],
5998 "close and reopen libguestfs handle",
6001 Close and reopen the libguestfs handle. It is not necessary to use
6002 this normally, because the handle is closed properly when guestfish
6003 exits. However this is occasionally useful for testing.");
6005 ("sparse", (RErr,[], []), -1, [], [],
6006 "create a sparse disk image and add",
6007 " sparse filename size
6009 This creates an empty sparse file of the given size, and then adds
6010 so it can be further examined.
6012 In all respects it works the same as the L</alloc> command, except that
6013 the image file is allocated sparsely, which means that disk blocks are
6014 not assigned to the file until they are needed. Sparse disk files
6015 only use space when written to, but they are slower and there is a
6016 danger you could run out of real disk space during a write operation.
6018 For more advanced image creation, see L<qemu-img(1)> utility.
6020 Size can be specified using standard suffixes, eg. C<1M>.");
6022 ("supported", (RErr,[], []), -1, [], [],
6023 "list supported groups of commands",
6026 This command returns a list of the optional groups
6027 known to the daemon, and indicates which ones are
6028 supported by this build of the libguestfs appliance.
6030 See also L<guestfs(3)/AVAILABILITY>.");
6032 ("time", (RErr,[], []), -1, [], [],
6033 "print elapsed time taken to run a command",
6034 " time command args...
6036 Run the command as usual, but print the elapsed time afterwards. This
6037 can be useful for benchmarking operations.");