2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter C<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form C<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to run C<guestfs_umount_all> followed by
286 C<guestfs_sync> when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
308 ("get_verbose", (RBool "verbose", [], []), -1, [],
312 This returns the verbose messages flag.");
314 ("is_ready", (RBool "ready", [], []), -1, [],
315 [InitNone, Always, TestOutputTrue (
317 "is ready to accept commands",
319 This returns true iff this handle is ready to accept commands
320 (in the C<READY> state).
322 For more information on states, see L<guestfs(3)>.");
324 ("is_config", (RBool "config", [], []), -1, [],
325 [InitNone, Always, TestOutputFalse (
327 "is in configuration state",
329 This returns true iff this handle is being configured
330 (in the C<CONFIG> state).
332 For more information on states, see L<guestfs(3)>.");
334 ("is_launching", (RBool "launching", [], []), -1, [],
335 [InitNone, Always, TestOutputFalse (
336 [["is_launching"]])],
337 "is launching subprocess",
339 This returns true iff this handle is launching the subprocess
340 (in the C<LAUNCHING> state).
342 For more information on states, see L<guestfs(3)>.");
344 ("is_busy", (RBool "busy", [], []), -1, [],
345 [InitNone, Always, TestOutputFalse (
347 "is busy processing a command",
349 This returns true iff this handle is busy processing a command
350 (in the C<BUSY> state).
352 For more information on states, see L<guestfs(3)>.");
354 ("get_state", (RInt "state", [], []), -1, [],
356 "get the current state",
358 This returns the current state as an opaque integer. This is
359 only useful for printing debug and internal error messages.
361 For more information on states, see L<guestfs(3)>.");
363 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
364 [InitNone, Always, TestOutputInt (
365 [["set_memsize"; "500"];
366 ["get_memsize"]], 500)],
367 "set memory allocated to the qemu subprocess",
369 This sets the memory size in megabytes allocated to the
370 qemu subprocess. This only has any effect if called before
373 You can also change this by setting the environment
374 variable C<LIBGUESTFS_MEMSIZE> before the handle is
377 For more information on the architecture of libguestfs,
378 see L<guestfs(3)>.");
380 ("get_memsize", (RInt "memsize", [], []), -1, [],
381 [InitNone, Always, TestOutputIntOp (
382 [["get_memsize"]], ">=", 256)],
383 "get memory allocated to the qemu subprocess",
385 This gets the memory size in megabytes allocated to the
388 If C<guestfs_set_memsize> was not called
389 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
390 then this returns the compiled-in default value for memsize.
392 For more information on the architecture of libguestfs,
393 see L<guestfs(3)>.");
395 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
396 [InitNone, Always, TestOutputIntOp (
397 [["get_pid"]], ">=", 1)],
398 "get PID of qemu subprocess",
400 Return the process ID of the qemu subprocess. If there is no
401 qemu subprocess, then this will return an error.
403 This is an internal call used for debugging and testing.");
405 ("version", (RStruct ("version", "version"), [], []), -1, [],
406 [InitNone, Always, TestOutputStruct (
407 [["version"]], [CompareWithInt ("major", 1)])],
408 "get the library version number",
410 Return the libguestfs version number that the program is linked
413 Note that because of dynamic linking this is not necessarily
414 the version of libguestfs that you compiled against. You can
415 compile the program, and then at runtime dynamically link
416 against a completely different C<libguestfs.so> library.
418 This call was added in version C<1.0.58>. In previous
419 versions of libguestfs there was no way to get the version
420 number. From C code you can use dynamic linker functions
421 to find out if this symbol exists (if it doesn't, then
422 it's an earlier version).
424 The call returns a structure with four elements. The first
425 three (C<major>, C<minor> and C<release>) are numbers and
426 correspond to the usual version triplet. The fourth element
427 (C<extra>) is a string and is normally empty, but may be
428 used for distro-specific information.
430 To construct the original version string:
431 C<$major.$minor.$release$extra>
433 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
435 I<Note:> Don't use this call to test for availability
436 of features. In enterprise distributions we backport
437 features from later versions into earlier versions,
438 making this an unreliable way to test for features.
439 Use C<guestfs_available> instead.");
441 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
442 [InitNone, Always, TestOutputTrue (
443 [["set_selinux"; "true"];
445 "set SELinux enabled or disabled at appliance boot",
447 This sets the selinux flag that is passed to the appliance
448 at boot time. The default is C<selinux=0> (disabled).
450 Note that if SELinux is enabled, it is always in
451 Permissive mode (C<enforcing=0>).
453 For more information on the architecture of libguestfs,
454 see L<guestfs(3)>.");
456 ("get_selinux", (RBool "selinux", [], []), -1, [],
458 "get SELinux enabled flag",
460 This returns the current setting of the selinux flag which
461 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
463 For more information on the architecture of libguestfs,
464 see L<guestfs(3)>.");
466 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
467 [InitNone, Always, TestOutputFalse (
468 [["set_trace"; "false"];
470 "enable or disable command traces",
472 If the command trace flag is set to 1, then commands are
473 printed on stderr before they are executed in a format
474 which is very similar to the one used by guestfish. In
475 other words, you can run a program with this enabled, and
476 you will get out a script which you can feed to guestfish
477 to perform the same set of actions.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
486 ("get_trace", (RBool "trace", [], []), -1, [],
488 "get command trace enabled flag",
490 Return the command trace flag.");
492 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
493 [InitNone, Always, TestOutputFalse (
494 [["set_direct"; "false"];
496 "enable or disable direct appliance mode",
498 If the direct appliance mode flag is enabled, then stdin and
499 stdout are passed directly through to the appliance once it
502 One consequence of this is that log messages aren't caught
503 by the library and handled by C<guestfs_set_log_message_callback>,
504 but go straight to stdout.
506 You probably don't want to use this unless you know what you
509 The default is disabled.");
511 ("get_direct", (RBool "direct", [], []), -1, [],
513 "get direct appliance mode flag",
515 Return the direct appliance mode flag.");
517 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
518 [InitNone, Always, TestOutputTrue (
519 [["set_recovery_proc"; "true"];
520 ["get_recovery_proc"]])],
521 "enable or disable the recovery process",
523 If this is called with the parameter C<false> then
524 C<guestfs_launch> does not create a recovery process. The
525 purpose of the recovery process is to stop runaway qemu
526 processes in the case where the main program aborts abruptly.
528 This only has any effect if called before C<guestfs_launch>,
529 and the default is true.
531 About the only time when you would want to disable this is
532 if the main process will fork itself into the background
533 (\"daemonize\" itself). In this case the recovery process
534 thinks that the main program has disappeared and so kills
535 qemu, which is not very helpful.");
537 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
539 "get recovery process enabled flag",
541 Return the recovery process enabled flag.");
543 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
545 "add a drive specifying the QEMU block emulation to use",
547 This is the same as C<guestfs_add_drive> but it allows you
548 to specify the QEMU interface emulation to use at run time.");
550 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
552 "add a drive read-only specifying the QEMU block emulation to use",
554 This is the same as C<guestfs_add_drive_ro> but it allows you
555 to specify the QEMU interface emulation to use at run time.");
557 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
558 [InitISOFS, Always, TestOutput (
559 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
560 InitISOFS, Always, TestOutput (
561 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
562 InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-win32.exe"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/lib-i586.so"]], "i386");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/lib-sparc.so"]], "sparc");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-win32.dll"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
582 "detect the architecture of a binary file",
584 This detects the architecture of the binary C<filename>,
585 and returns it if known.
587 Currently defined architectures are:
593 This string is returned for all 32 bit i386, i486, i586, i686 binaries
594 irrespective of the precise processor requirements of the binary.
606 64 bit SPARC V9 and above.
622 Libguestfs may return other architecture strings in future.
624 The function works on at least the following types of files:
630 many types of Un*x and Linux binary
634 many types of Un*x and Linux shared library
638 Windows Win32 and Win64 binaries
642 Windows Win32 and Win64 DLLs
644 Win32 binaries and DLLs return C<i386>.
646 Win64 binaries and DLLs return C<x86_64>.
654 Linux new-style initrd images
658 some non-x86 Linux vmlinuz kernels
662 What it can't do currently:
668 static libraries (libfoo.a)
672 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
676 x86 Linux vmlinuz kernels
678 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
679 compressed code, and are horribly hard to unpack. If you want to find
680 the architecture of a kernel, use the architecture of the associated
681 initrd or kernel module(s) instead.
685 ("inspect_os", (RStringList "roots", [], []), -1, [],
687 "inspect disk and return list of operating systems found",
689 This function uses other libguestfs functions and certain
690 heuristics to inspect the disk(s) (usually disks belonging to
691 a virtual machine), looking for operating systems.
693 The list returned is empty if no operating systems were found.
695 If one operating system was found, then this returns a list with
696 a single element, which is the name of the root filesystem of
697 this operating system. It is also possible for this function
698 to return a list containing more than one element, indicating
699 a dual-boot or multi-boot virtual machine, with each element being
700 the root filesystem of one of the operating systems.
702 You can pass the root string(s) returned to other
703 C<guestfs_inspect_get_*> functions in order to query further
704 information about each operating system, such as the name
707 This function uses other libguestfs features such as
708 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
709 and unmount filesystems and look at the contents. This should
710 be called with no disks currently mounted. The function may also
711 use Augeas, so any existing Augeas handle will be closed.
713 This function cannot decrypt encrypted disks. The caller
714 must do that first (supplying the necessary keys) if the
717 Please read L<guestfs(3)/INSPECTION> for more details.
719 See also C<guestfs_list_filesystems>.");
721 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
723 "get type of inspected operating system",
725 This function should only be called with a root device string
726 as returned by C<guestfs_inspect_os>.
728 This returns the type of the inspected operating system.
729 Currently defined types are:
735 Any Linux-based operating system.
739 Any Microsoft Windows operating system.
747 The operating system type could not be determined.
751 Future versions of libguestfs may return other strings here.
752 The caller should be prepared to handle any string.
754 Please read L<guestfs(3)/INSPECTION> for more details.");
756 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
758 "get architecture of inspected operating system",
760 This function should only be called with a root device string
761 as returned by C<guestfs_inspect_os>.
763 This returns the architecture of the inspected operating system.
764 The possible return values are listed under
765 C<guestfs_file_architecture>.
767 If the architecture could not be determined, then the
768 string C<unknown> is returned.
770 Please read L<guestfs(3)/INSPECTION> for more details.");
772 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
774 "get distro of inspected operating system",
776 This function should only be called with a root device string
777 as returned by C<guestfs_inspect_os>.
779 This returns the distro (distribution) of the inspected operating
782 Currently defined distros are:
818 =item \"redhat-based\"
820 Some Red Hat-derived distro.
824 Red Hat Enterprise Linux and some derivatives.
832 The distro could not be determined.
836 Windows does not have distributions. This string is
837 returned if the OS type is Windows.
841 Future versions of libguestfs may return other strings here.
842 The caller should be prepared to handle any string.
844 Please read L<guestfs(3)/INSPECTION> for more details.");
846 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
848 "get major version of inspected operating system",
850 This function should only be called with a root device string
851 as returned by C<guestfs_inspect_os>.
853 This returns the major version number of the inspected operating
856 Windows uses a consistent versioning scheme which is I<not>
857 reflected in the popular public names used by the operating system.
858 Notably the operating system known as \"Windows 7\" is really
859 version 6.1 (ie. major = 6, minor = 1). You can find out the
860 real versions corresponding to releases of Windows by consulting
863 If the version could not be determined, then C<0> is returned.
865 Please read L<guestfs(3)/INSPECTION> for more details.");
867 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
869 "get minor version of inspected operating system",
871 This function should only be called with a root device string
872 as returned by C<guestfs_inspect_os>.
874 This returns the minor version number of the inspected operating
877 If the version could not be determined, then C<0> is returned.
879 Please read L<guestfs(3)/INSPECTION> for more details.
880 See also C<guestfs_inspect_get_major_version>.");
882 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
884 "get product name of inspected operating system",
886 This function should only be called with a root device string
887 as returned by C<guestfs_inspect_os>.
889 This returns the product name of the inspected operating
890 system. The product name is generally some freeform string
891 which can be displayed to the user, but should not be
894 If the product name could not be determined, then the
895 string C<unknown> is returned.
897 Please read L<guestfs(3)/INSPECTION> for more details.");
899 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
901 "get mountpoints of inspected operating system",
903 This function should only be called with a root device string
904 as returned by C<guestfs_inspect_os>.
906 This returns a hash of where we think the filesystems
907 associated with this operating system should be mounted.
908 Callers should note that this is at best an educated guess
909 made by reading configuration files such as C</etc/fstab>.
910 I<In particular note> that this may return filesystems
911 which are non-existent or not mountable and callers should
912 be prepared to handle or ignore failures if they try to
915 Each element in the returned hashtable has a key which
916 is the path of the mountpoint (eg. C</boot>) and a value
917 which is the filesystem that would be mounted there
920 Non-mounted devices such as swap devices are I<not>
921 returned in this list.
923 Please read L<guestfs(3)/INSPECTION> for more details.
924 See also C<guestfs_inspect_get_filesystems>.");
926 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
928 "get filesystems associated with inspected operating system",
930 This function should only be called with a root device string
931 as returned by C<guestfs_inspect_os>.
933 This returns a list of all the filesystems that we think
934 are associated with this operating system. This includes
935 the root filesystem, other ordinary filesystems, and
936 non-mounted devices like swap partitions.
938 In the case of a multi-boot virtual machine, it is possible
939 for a filesystem to be shared between operating systems.
941 Please read L<guestfs(3)/INSPECTION> for more details.
942 See also C<guestfs_inspect_get_mountpoints>.");
944 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
946 "set enable network flag",
948 If C<network> is true, then the network is enabled in the
949 libguestfs appliance. The default is false.
951 This affects whether commands are able to access the network
952 (see L<guestfs(3)/RUNNING COMMANDS>).
954 You must call this before calling C<guestfs_launch>, otherwise
957 ("get_network", (RBool "network", [], []), -1, [],
959 "get enable network flag",
961 This returns the enable network flag.");
963 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
967 This inspection command looks for filesystems on partitions,
968 block devices and logical volumes, returning a list of devices
969 containing filesystems and their type.
971 The return value is a hash, where the keys are the devices
972 containing filesystems, and the values are the filesystem types.
975 \"/dev/sda1\" => \"ntfs\"
976 \"/dev/sda2\" => \"ext2\"
977 \"/dev/vg_guest/lv_root\" => \"ext4\"
978 \"/dev/vg_guest/lv_swap\" => \"swap\"
980 The value can have the special value \"unknown\", meaning the
981 content of the device is undetermined or empty.
982 \"swap\" means a Linux swap partition.
984 This command runs other libguestfs commands, which might include
985 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
986 use this soon after launch and only when nothing is mounted.
988 Not all of the filesystems returned will be mountable. In
989 particular, swap partitions are returned in the list. Also
990 this command does not check that each filesystem
991 found is valid and mountable, and some filesystems might
992 be mountable but require special options. Filesystems may
993 not all belong to a single logical operating system
994 (use C<guestfs_inspect_os> to look for OSes).");
996 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
998 "add an image to examine or modify",
1000 This function adds a virtual machine disk image C<filename> to
1001 libguestfs. The first time you call this function, the disk
1002 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1005 You don't necessarily need to be root when using libguestfs. However
1006 you obviously do need sufficient permissions to access the filename
1007 for whatever operations you want to perform (ie. read access if you
1008 just want to read the image or write access if you want to modify the
1011 This call checks that C<filename> exists.
1013 The optional arguments are:
1019 If true then the image is treated as read-only. Writes are still
1020 allowed, but they are stored in a temporary snapshot overlay which
1021 is discarded at the end. The disk that you add is not modified.
1025 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1026 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1027 Possible formats include C<raw> and C<qcow2>.
1029 Automatic detection of the format opens you up to a potential
1030 security hole when dealing with untrusted raw-format images.
1031 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1036 This rarely-used option lets you emulate the behaviour of the
1037 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1041 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1043 "get Windows systemroot of inspected operating system",
1045 This function should only be called with a root device string
1046 as returned by C<guestfs_inspect_os>.
1048 This returns the Windows systemroot of the inspected guest.
1049 The systemroot is a directory path such as C</WINDOWS>.
1051 This call assumes that the guest is Windows and that the
1052 systemroot could be determined by inspection. If this is not
1053 the case then an error is returned.
1055 Please read L<guestfs(3)/INSPECTION> for more details.");
1057 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1059 "return list of operating systems found by last inspection",
1061 This function is a convenient way to get the list of root
1062 devices, as returned from a previous call to C<guestfs_inspect_os>,
1063 but without redoing the whole inspection process.
1065 This returns an empty list if either no root devices were
1066 found or the caller has not called C<guestfs_inspect_os>.
1068 Please read L<guestfs(3)/INSPECTION> for more details.");
1070 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1072 "debug the QEMU command line (internal use only)",
1074 This returns the internal QEMU command line. 'debug' commands are
1075 not part of the formal API and can be removed or changed at any time.");
1077 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"]), -1, [FishAlias "domain"],
1079 "add the disk(s) from a named libvirt domain",
1081 This function adds the disk(s) attached to the named libvirt
1082 domain C<dom>. It works by connecting to libvirt, requesting
1083 the domain and domain XML from libvirt, parsing it for disks,
1084 and calling C<guestfs_add_drive_opts> on each one.
1086 The number of disks added is returned. This operation is atomic:
1087 if an error is returned, then no disks are added.
1089 This function does some minimal checks to make sure the libvirt
1090 domain is not running (unless C<readonly> is true). In a future
1091 version we will try to acquire the libvirt lock on each disk.
1093 Disks must be accessible locally. This often means that adding disks
1094 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1095 will fail unless those disks are accessible via the same device path
1098 The optional C<libvirturi> parameter sets the libvirt URI
1099 (see L<http://libvirt.org/uri.html>). If this is not set then
1100 we connect to the default libvirt URI (or one set through an
1101 environment variable, see the libvirt documentation for full
1104 The other optional parameters are passed directly through to
1105 C<guestfs_add_drive_opts>.");
1108 This interface is not quite baked yet. -- RWMJ 2010-11-11
1109 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"]), -1, [NotInFish],
1111 "add the disk(s) from a libvirt domain",
1113 This function adds the disk(s) attached to the libvirt domain C<dom>.
1114 It works by requesting the domain XML from libvirt, parsing it for
1115 disks, and calling C<guestfs_add_drive_opts> on each one.
1117 In the C API we declare C<void *dom>, but really it has type
1118 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1120 The number of disks added is returned. This operation is atomic:
1121 if an error is returned, then no disks are added.
1123 This function does some minimal checks to make sure the libvirt
1124 domain is not running (unless C<readonly> is true). In a future
1125 version we will try to acquire the libvirt lock on each disk.
1127 Disks must be accessible locally. This often means that adding disks
1128 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1129 will fail unless those disks are accessible via the same device path
1132 The optional parameters are passed directly through to
1133 C<guestfs_add_drive_opts>.");
1136 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1138 "get package format used by the operating system",
1140 This function should only be called with a root device string
1141 as returned by C<guestfs_inspect_os>.
1143 This function and C<guestfs_inspect_get_package_management> return
1144 the package format and package management tool used by the
1145 inspected operating system. For example for Fedora these
1146 functions would return C<rpm> (package format) and
1147 C<yum> (package management).
1149 This returns the string C<unknown> if we could not determine the
1150 package format I<or> if the operating system does not have
1151 a real packaging system (eg. Windows).
1153 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1154 Future versions of libguestfs may return other strings.
1156 Please read L<guestfs(3)/INSPECTION> for more details.");
1158 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1160 "get package management tool used by the operating system",
1162 This function should only be called with a root device string
1163 as returned by C<guestfs_inspect_os>.
1165 C<guestfs_inspect_get_package_format> and this function return
1166 the package format and package management tool used by the
1167 inspected operating system. For example for Fedora these
1168 functions would return C<rpm> (package format) and
1169 C<yum> (package management).
1171 This returns the string C<unknown> if we could not determine the
1172 package management tool I<or> if the operating system does not have
1173 a real packaging system (eg. Windows).
1175 Possible strings include: C<yum>, C<up2date>,
1176 C<apt> (for all Debian derivatives),
1177 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1178 Future versions of libguestfs may return other strings.
1180 Please read L<guestfs(3)/INSPECTION> for more details.");
1182 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1184 "get list of applications installed in the operating system",
1186 This function should only be called with a root device string
1187 as returned by C<guestfs_inspect_os>.
1189 Return the list of applications installed in the operating system.
1191 I<Note:> This call works differently from other parts of the
1192 inspection API. You have to call C<guestfs_inspect_os>, then
1193 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1194 before calling this. Listing applications is a significantly
1195 more difficult operation which requires access to the full
1196 filesystem. Also note that unlike the other
1197 C<guestfs_inspect_get_*> calls which are just returning
1198 data cached in the libguestfs handle, this call actually reads
1199 parts of the mounted filesystems during the call.
1201 This returns an empty list if the inspection code was not able
1202 to determine the list of applications.
1204 The application structure contains the following fields:
1210 The name of the application. For Red Hat-derived and Debian-derived
1211 Linux guests, this is the package name.
1213 =item C<app_display_name>
1215 The display name of the application, sometimes localized to the
1216 install language of the guest operating system.
1218 If unavailable this is returned as an empty string C<\"\">.
1219 Callers needing to display something can use C<app_name> instead.
1223 For package managers which use epochs, this contains the epoch of
1224 the package (an integer). If unavailable, this is returned as C<0>.
1226 =item C<app_version>
1228 The version string of the application or package. If unavailable
1229 this is returned as an empty string C<\"\">.
1231 =item C<app_release>
1233 The release string of the application or package, for package
1234 managers that use this. If unavailable this is returned as an
1235 empty string C<\"\">.
1237 =item C<app_install_path>
1239 The installation path of the application (on operating systems
1240 such as Windows which use installation paths). This path is
1241 in the format used by the guest operating system, it is not
1244 If unavailable this is returned as an empty string C<\"\">.
1246 =item C<app_trans_path>
1248 The install path translated into a libguestfs path.
1249 If unavailable this is returned as an empty string C<\"\">.
1251 =item C<app_publisher>
1253 The name of the publisher of the application, for package
1254 managers that use this. If unavailable this is returned
1255 as an empty string C<\"\">.
1259 The URL (eg. upstream URL) of the application.
1260 If unavailable this is returned as an empty string C<\"\">.
1262 =item C<app_source_package>
1264 For packaging systems which support this, the name of the source
1265 package. If unavailable this is returned as an empty string C<\"\">.
1267 =item C<app_summary>
1269 A short (usually one line) description of the application or package.
1270 If unavailable this is returned as an empty string C<\"\">.
1272 =item C<app_description>
1274 A longer description of the application or package.
1275 If unavailable this is returned as an empty string C<\"\">.
1279 Please read L<guestfs(3)/INSPECTION> for more details.");
1281 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1283 "get hostname of the operating system",
1285 This function should only be called with a root device string
1286 as returned by C<guestfs_inspect_os>.
1288 This function returns the hostname of the operating system
1289 as found by inspection of the guest's configuration files.
1291 If the hostname could not be determined, then the
1292 string C<unknown> is returned.
1294 Please read L<guestfs(3)/INSPECTION> for more details.");
1296 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1298 "get format of inspected operating system",
1300 This function should only be called with a root device string
1301 as returned by C<guestfs_inspect_os>.
1303 This returns the format of the inspected operating system. You
1304 can use it to detect install images, live CDs and similar.
1306 Currently defined formats are:
1312 This is an installed operating system.
1316 The disk image being inspected is not an installed operating system,
1317 but a I<bootable> install disk, live CD, or similar.
1321 The format of this disk image is not known.
1325 Future versions of libguestfs may return other strings here.
1326 The caller should be prepared to handle any string.
1328 Please read L<guestfs(3)/INSPECTION> for more details.");
1330 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1332 "get live flag for install disk",
1334 This function should only be called with a root device string
1335 as returned by C<guestfs_inspect_os>.
1337 If C<guestfs_inspect_get_format> returns C<installer> (this
1338 is an install disk), then this returns true if a live image
1339 was detected on the disk.
1341 Please read L<guestfs(3)/INSPECTION> for more details.");
1343 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1345 "get netinst (network installer) flag for install disk",
1347 This function should only be called with a root device string
1348 as returned by C<guestfs_inspect_os>.
1350 If C<guestfs_inspect_get_format> returns C<installer> (this
1351 is an install disk), then this returns true if the disk is
1352 a network installer, ie. not a self-contained install CD but
1353 one which is likely to require network access to complete
1356 Please read L<guestfs(3)/INSPECTION> for more details.");
1358 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1360 "get multipart flag for install disk",
1362 This function should only be called with a root device string
1363 as returned by C<guestfs_inspect_os>.
1365 If C<guestfs_inspect_get_format> returns C<installer> (this
1366 is an install disk), then this returns true if the disk is
1369 Please read L<guestfs(3)/INSPECTION> for more details.");
1373 (* daemon_functions are any functions which cause some action
1374 * to take place in the daemon.
1377 let daemon_functions = [
1378 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1379 [InitEmpty, Always, TestOutput (
1380 [["part_disk"; "/dev/sda"; "mbr"];
1381 ["mkfs"; "ext2"; "/dev/sda1"];
1382 ["mount"; "/dev/sda1"; "/"];
1383 ["write"; "/new"; "new file contents"];
1384 ["cat"; "/new"]], "new file contents")],
1385 "mount a guest disk at a position in the filesystem",
1387 Mount a guest disk at a position in the filesystem. Block devices
1388 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1389 the guest. If those block devices contain partitions, they will have
1390 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1393 The rules are the same as for L<mount(2)>: A filesystem must
1394 first be mounted on C</> before others can be mounted. Other
1395 filesystems can only be mounted on directories which already
1398 The mounted filesystem is writable, if we have sufficient permissions
1399 on the underlying device.
1402 When you use this call, the filesystem options C<sync> and C<noatime>
1403 are set implicitly. This was originally done because we thought it
1404 would improve reliability, but it turns out that I<-o sync> has a
1405 very large negative performance impact and negligible effect on
1406 reliability. Therefore we recommend that you avoid using
1407 C<guestfs_mount> in any code that needs performance, and instead
1408 use C<guestfs_mount_options> (use an empty string for the first
1409 parameter if you don't want any options).");
1411 ("sync", (RErr, [], []), 2, [],
1412 [ InitEmpty, Always, TestRun [["sync"]]],
1413 "sync disks, writes are flushed through to the disk image",
1415 This syncs the disk, so that any writes are flushed through to the
1416 underlying disk image.
1418 You should always call this if you have modified a disk image, before
1419 closing the handle.");
1421 ("touch", (RErr, [Pathname "path"], []), 3, [],
1422 [InitScratchFS, Always, TestOutputTrue (
1423 [["touch"; "/touch"];
1424 ["exists"; "/touch"]])],
1425 "update file timestamps or create a new file",
1427 Touch acts like the L<touch(1)> command. It can be used to
1428 update the timestamps on a file, or, if the file does not exist,
1429 to create a new zero-length file.
1431 This command only works on regular files, and will fail on other
1432 file types such as directories, symbolic links, block special etc.");
1434 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1435 [InitISOFS, Always, TestOutput (
1436 [["cat"; "/known-2"]], "abcdef\n")],
1437 "list the contents of a file",
1439 Return the contents of the file named C<path>.
1441 Note that this function cannot correctly handle binary files
1442 (specifically, files containing C<\\0> character which is treated
1443 as end of string). For those you need to use the C<guestfs_read_file>
1444 or C<guestfs_download> functions which have a more complex interface.");
1446 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1447 [], (* XXX Tricky to test because it depends on the exact format
1448 * of the 'ls -l' command, which changes between F10 and F11.
1450 "list the files in a directory (long format)",
1452 List the files in C<directory> (relative to the root directory,
1453 there is no cwd) in the format of 'ls -la'.
1455 This command is mostly useful for interactive sessions. It
1456 is I<not> intended that you try to parse the output string.");
1458 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1459 [InitScratchFS, Always, TestOutputList (
1461 ["touch"; "/ls/new"];
1462 ["touch"; "/ls/newer"];
1463 ["touch"; "/ls/newest"];
1464 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1465 "list the files in a directory",
1467 List the files in C<directory> (relative to the root directory,
1468 there is no cwd). The '.' and '..' entries are not returned, but
1469 hidden files are shown.
1471 This command is mostly useful for interactive sessions. Programs
1472 should probably use C<guestfs_readdir> instead.");
1474 ("list_devices", (RStringList "devices", [], []), 7, [],
1475 [InitEmpty, Always, TestOutputListOfDevices (
1476 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1477 "list the block devices",
1479 List all the block devices.
1481 The full block device names are returned, eg. C</dev/sda>.
1483 See also C<guestfs_list_filesystems>.");
1485 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1486 [InitBasicFS, Always, TestOutputListOfDevices (
1487 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1488 InitEmpty, Always, TestOutputListOfDevices (
1489 [["part_init"; "/dev/sda"; "mbr"];
1490 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1491 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1492 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1493 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1494 "list the partitions",
1496 List all the partitions detected on all block devices.
1498 The full partition device names are returned, eg. C</dev/sda1>
1500 This does not return logical volumes. For that you will need to
1501 call C<guestfs_lvs>.
1503 See also C<guestfs_list_filesystems>.");
1505 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1506 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1507 [["pvs"]], ["/dev/sda1"]);
1508 InitEmpty, Always, TestOutputListOfDevices (
1509 [["part_init"; "/dev/sda"; "mbr"];
1510 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1511 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1512 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1513 ["pvcreate"; "/dev/sda1"];
1514 ["pvcreate"; "/dev/sda2"];
1515 ["pvcreate"; "/dev/sda3"];
1516 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1517 "list the LVM physical volumes (PVs)",
1519 List all the physical volumes detected. This is the equivalent
1520 of the L<pvs(8)> command.
1522 This returns a list of just the device names that contain
1523 PVs (eg. C</dev/sda2>).
1525 See also C<guestfs_pvs_full>.");
1527 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1528 [InitBasicFSonLVM, Always, TestOutputList (
1530 InitEmpty, Always, TestOutputList (
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 ["pvcreate"; "/dev/sda1"];
1536 ["pvcreate"; "/dev/sda2"];
1537 ["pvcreate"; "/dev/sda3"];
1538 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1539 ["vgcreate"; "VG2"; "/dev/sda3"];
1540 ["vgs"]], ["VG1"; "VG2"])],
1541 "list the LVM volume groups (VGs)",
1543 List all the volumes groups detected. This is the equivalent
1544 of the L<vgs(8)> command.
1546 This returns a list of just the volume group names that were
1547 detected (eg. C<VolGroup00>).
1549 See also C<guestfs_vgs_full>.");
1551 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1552 [InitBasicFSonLVM, Always, TestOutputList (
1553 [["lvs"]], ["/dev/VG/LV"]);
1554 InitEmpty, Always, TestOutputList (
1555 [["part_init"; "/dev/sda"; "mbr"];
1556 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1557 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1558 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1559 ["pvcreate"; "/dev/sda1"];
1560 ["pvcreate"; "/dev/sda2"];
1561 ["pvcreate"; "/dev/sda3"];
1562 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1563 ["vgcreate"; "VG2"; "/dev/sda3"];
1564 ["lvcreate"; "LV1"; "VG1"; "50"];
1565 ["lvcreate"; "LV2"; "VG1"; "50"];
1566 ["lvcreate"; "LV3"; "VG2"; "50"];
1567 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1568 "list the LVM logical volumes (LVs)",
1570 List all the logical volumes detected. This is the equivalent
1571 of the L<lvs(8)> command.
1573 This returns a list of the logical volume device names
1574 (eg. C</dev/VolGroup00/LogVol00>).
1576 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1578 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1579 [], (* XXX how to test? *)
1580 "list the LVM physical volumes (PVs)",
1582 List all the physical volumes detected. This is the equivalent
1583 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1585 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1586 [], (* XXX how to test? *)
1587 "list the LVM volume groups (VGs)",
1589 List all the volumes groups detected. This is the equivalent
1590 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1592 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1593 [], (* XXX how to test? *)
1594 "list the LVM logical volumes (LVs)",
1596 List all the logical volumes detected. This is the equivalent
1597 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1599 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1600 [InitISOFS, Always, TestOutputList (
1601 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1602 InitISOFS, Always, TestOutputList (
1603 [["read_lines"; "/empty"]], [])],
1604 "read file as lines",
1606 Return the contents of the file named C<path>.
1608 The file contents are returned as a list of lines. Trailing
1609 C<LF> and C<CRLF> character sequences are I<not> returned.
1611 Note that this function cannot correctly handle binary files
1612 (specifically, files containing C<\\0> character which is treated
1613 as end of line). For those you need to use the C<guestfs_read_file>
1614 function which has a more complex interface.");
1616 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1617 [], (* XXX Augeas code needs tests. *)
1618 "create a new Augeas handle",
1620 Create a new Augeas handle for editing configuration files.
1621 If there was any previous Augeas handle associated with this
1622 guestfs session, then it is closed.
1624 You must call this before using any other C<guestfs_aug_*>
1627 C<root> is the filesystem root. C<root> must not be NULL,
1630 The flags are the same as the flags defined in
1631 E<lt>augeas.hE<gt>, the logical I<or> of the following
1636 =item C<AUG_SAVE_BACKUP> = 1
1638 Keep the original file with a C<.augsave> extension.
1640 =item C<AUG_SAVE_NEWFILE> = 2
1642 Save changes into a file with extension C<.augnew>, and
1643 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1645 =item C<AUG_TYPE_CHECK> = 4
1647 Typecheck lenses (can be expensive).
1649 =item C<AUG_NO_STDINC> = 8
1651 Do not use standard load path for modules.
1653 =item C<AUG_SAVE_NOOP> = 16
1655 Make save a no-op, just record what would have been changed.
1657 =item C<AUG_NO_LOAD> = 32
1659 Do not load the tree in C<guestfs_aug_init>.
1663 To close the handle, you can call C<guestfs_aug_close>.
1665 To find out more about Augeas, see L<http://augeas.net/>.");
1667 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1668 [], (* XXX Augeas code needs tests. *)
1669 "close the current Augeas handle",
1671 Close the current Augeas handle and free up any resources
1672 used by it. After calling this, you have to call
1673 C<guestfs_aug_init> again before you can use any other
1674 Augeas functions.");
1676 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1677 [], (* XXX Augeas code needs tests. *)
1678 "define an Augeas variable",
1680 Defines an Augeas variable C<name> whose value is the result
1681 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1684 On success this returns the number of nodes in C<expr>, or
1685 C<0> if C<expr> evaluates to something which is not a nodeset.");
1687 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1688 [], (* XXX Augeas code needs tests. *)
1689 "define an Augeas node",
1691 Defines a variable C<name> whose value is the result of
1694 If C<expr> evaluates to an empty nodeset, a node is created,
1695 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1696 C<name> will be the nodeset containing that single node.
1698 On success this returns a pair containing the
1699 number of nodes in the nodeset, and a boolean flag
1700 if a node was created.");
1702 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1703 [], (* XXX Augeas code needs tests. *)
1704 "look up the value of an Augeas path",
1706 Look up the value associated with C<path>. If C<path>
1707 matches exactly one node, the C<value> is returned.");
1709 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1710 [], (* XXX Augeas code needs tests. *)
1711 "set Augeas path to value",
1713 Set the value associated with C<path> to C<val>.
1715 In the Augeas API, it is possible to clear a node by setting
1716 the value to NULL. Due to an oversight in the libguestfs API
1717 you cannot do that with this call. Instead you must use the
1718 C<guestfs_aug_clear> call.");
1720 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1721 [], (* XXX Augeas code needs tests. *)
1722 "insert a sibling Augeas node",
1724 Create a new sibling C<label> for C<path>, inserting it into
1725 the tree before or after C<path> (depending on the boolean
1728 C<path> must match exactly one existing node in the tree, and
1729 C<label> must be a label, ie. not contain C</>, C<*> or end
1730 with a bracketed index C<[N]>.");
1732 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1733 [], (* XXX Augeas code needs tests. *)
1734 "remove an Augeas path",
1736 Remove C<path> and all of its children.
1738 On success this returns the number of entries which were removed.");
1740 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1741 [], (* XXX Augeas code needs tests. *)
1744 Move the node C<src> to C<dest>. C<src> must match exactly
1745 one node. C<dest> is overwritten if it exists.");
1747 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1748 [], (* XXX Augeas code needs tests. *)
1749 "return Augeas nodes which match augpath",
1751 Returns a list of paths which match the path expression C<path>.
1752 The returned paths are sufficiently qualified so that they match
1753 exactly one node in the current tree.");
1755 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1756 [], (* XXX Augeas code needs tests. *)
1757 "write all pending Augeas changes to disk",
1759 This writes all pending changes to disk.
1761 The flags which were passed to C<guestfs_aug_init> affect exactly
1762 how files are saved.");
1764 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1765 [], (* XXX Augeas code needs tests. *)
1766 "load files into the tree",
1768 Load files into the tree.
1770 See C<aug_load> in the Augeas documentation for the full gory
1773 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1774 [], (* XXX Augeas code needs tests. *)
1775 "list Augeas nodes under augpath",
1777 This is just a shortcut for listing C<guestfs_aug_match>
1778 C<path/*> and sorting the resulting nodes into alphabetical order.");
1780 ("rm", (RErr, [Pathname "path"], []), 29, [],
1781 [InitScratchFS, Always, TestRun
1783 ["touch"; "/rm/new"];
1785 InitScratchFS, Always, TestLastFail
1786 [["rm"; "/nosuchfile"]];
1787 InitScratchFS, Always, TestLastFail
1792 Remove the single file C<path>.");
1794 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1795 [InitScratchFS, Always, TestRun
1796 [["mkdir"; "/rmdir"];
1797 ["rmdir"; "/rmdir"]];
1798 InitScratchFS, Always, TestLastFail
1799 [["rmdir"; "/rmdir2"]];
1800 InitScratchFS, Always, TestLastFail
1801 [["mkdir"; "/rmdir3"];
1802 ["touch"; "/rmdir3/new"];
1803 ["rmdir"; "/rmdir3/new"]]],
1804 "remove a directory",
1806 Remove the single directory C<path>.");
1808 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1809 [InitScratchFS, Always, TestOutputFalse
1810 [["mkdir"; "/rm_rf"];
1811 ["mkdir"; "/rm_rf/foo"];
1812 ["touch"; "/rm_rf/foo/bar"];
1813 ["rm_rf"; "/rm_rf"];
1814 ["exists"; "/rm_rf"]]],
1815 "remove a file or directory recursively",
1817 Remove the file or directory C<path>, recursively removing the
1818 contents if its a directory. This is like the C<rm -rf> shell
1821 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1822 [InitScratchFS, Always, TestOutputTrue
1823 [["mkdir"; "/mkdir"];
1824 ["is_dir"; "/mkdir"]];
1825 InitScratchFS, Always, TestLastFail
1826 [["mkdir"; "/mkdir2/foo/bar"]]],
1827 "create a directory",
1829 Create a directory named C<path>.");
1831 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1832 [InitScratchFS, Always, TestOutputTrue
1833 [["mkdir_p"; "/mkdir_p/foo/bar"];
1834 ["is_dir"; "/mkdir_p/foo/bar"]];
1835 InitScratchFS, Always, TestOutputTrue
1836 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1837 ["is_dir"; "/mkdir_p2/foo"]];
1838 InitScratchFS, Always, TestOutputTrue
1839 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1840 ["is_dir"; "/mkdir_p3"]];
1841 (* Regression tests for RHBZ#503133: *)
1842 InitScratchFS, Always, TestRun
1843 [["mkdir"; "/mkdir_p4"];
1844 ["mkdir_p"; "/mkdir_p4"]];
1845 InitScratchFS, Always, TestLastFail
1846 [["touch"; "/mkdir_p5"];
1847 ["mkdir_p"; "/mkdir_p5"]]],
1848 "create a directory and parents",
1850 Create a directory named C<path>, creating any parent directories
1851 as necessary. This is like the C<mkdir -p> shell command.");
1853 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1854 [], (* XXX Need stat command to test *)
1857 Change the mode (permissions) of C<path> to C<mode>. Only
1858 numeric modes are supported.
1860 I<Note>: When using this command from guestfish, C<mode>
1861 by default would be decimal, unless you prefix it with
1862 C<0> to get octal, ie. use C<0700> not C<700>.
1864 The mode actually set is affected by the umask.");
1866 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1867 [], (* XXX Need stat command to test *)
1868 "change file owner and group",
1870 Change the file owner to C<owner> and group to C<group>.
1872 Only numeric uid and gid are supported. If you want to use
1873 names, you will need to locate and parse the password file
1874 yourself (Augeas support makes this relatively easy).");
1876 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1877 [InitISOFS, Always, TestOutputTrue (
1878 [["exists"; "/empty"]]);
1879 InitISOFS, Always, TestOutputTrue (
1880 [["exists"; "/directory"]])],
1881 "test if file or directory exists",
1883 This returns C<true> if and only if there is a file, directory
1884 (or anything) with the given C<path> name.
1886 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1888 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1889 [InitISOFS, Always, TestOutputTrue (
1890 [["is_file"; "/known-1"]]);
1891 InitISOFS, Always, TestOutputFalse (
1892 [["is_file"; "/directory"]])],
1893 "test if a regular file",
1895 This returns C<true> if and only if there is a regular file
1896 with the given C<path> name. Note that it returns false for
1897 other objects like directories.
1899 See also C<guestfs_stat>.");
1901 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1902 [InitISOFS, Always, TestOutputFalse (
1903 [["is_dir"; "/known-3"]]);
1904 InitISOFS, Always, TestOutputTrue (
1905 [["is_dir"; "/directory"]])],
1906 "test if a directory",
1908 This returns C<true> if and only if there is a directory
1909 with the given C<path> name. Note that it returns false for
1910 other objects like files.
1912 See also C<guestfs_stat>.");
1914 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1915 [InitEmpty, Always, TestOutputListOfDevices (
1916 [["part_init"; "/dev/sda"; "mbr"];
1917 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1918 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1919 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1920 ["pvcreate"; "/dev/sda1"];
1921 ["pvcreate"; "/dev/sda2"];
1922 ["pvcreate"; "/dev/sda3"];
1923 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1924 "create an LVM physical volume",
1926 This creates an LVM physical volume on the named C<device>,
1927 where C<device> should usually be a partition name such
1930 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1931 [InitEmpty, Always, TestOutputList (
1932 [["part_init"; "/dev/sda"; "mbr"];
1933 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1934 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1935 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1936 ["pvcreate"; "/dev/sda1"];
1937 ["pvcreate"; "/dev/sda2"];
1938 ["pvcreate"; "/dev/sda3"];
1939 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1940 ["vgcreate"; "VG2"; "/dev/sda3"];
1941 ["vgs"]], ["VG1"; "VG2"])],
1942 "create an LVM volume group",
1944 This creates an LVM volume group called C<volgroup>
1945 from the non-empty list of physical volumes C<physvols>.");
1947 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1948 [InitEmpty, Always, TestOutputList (
1949 [["part_init"; "/dev/sda"; "mbr"];
1950 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1951 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1952 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1953 ["pvcreate"; "/dev/sda1"];
1954 ["pvcreate"; "/dev/sda2"];
1955 ["pvcreate"; "/dev/sda3"];
1956 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1957 ["vgcreate"; "VG2"; "/dev/sda3"];
1958 ["lvcreate"; "LV1"; "VG1"; "50"];
1959 ["lvcreate"; "LV2"; "VG1"; "50"];
1960 ["lvcreate"; "LV3"; "VG2"; "50"];
1961 ["lvcreate"; "LV4"; "VG2"; "50"];
1962 ["lvcreate"; "LV5"; "VG2"; "50"];
1964 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1965 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1966 "create an LVM logical volume",
1968 This creates an LVM logical volume called C<logvol>
1969 on the volume group C<volgroup>, with C<size> megabytes.");
1971 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
1972 [InitEmpty, Always, TestOutput (
1973 [["part_disk"; "/dev/sda"; "mbr"];
1974 ["mkfs"; "ext2"; "/dev/sda1"];
1975 ["mount_options"; ""; "/dev/sda1"; "/"];
1976 ["write"; "/new"; "new file contents"];
1977 ["cat"; "/new"]], "new file contents")],
1978 "make a filesystem",
1980 This creates a filesystem on C<device> (usually a partition
1981 or LVM logical volume). The filesystem type is C<fstype>, for
1984 ("sfdisk", (RErr, [Device "device";
1985 Int "cyls"; Int "heads"; Int "sectors";
1986 StringList "lines"], []), 43, [DangerWillRobinson],
1988 "create partitions on a block device",
1990 This is a direct interface to the L<sfdisk(8)> program for creating
1991 partitions on block devices.
1993 C<device> should be a block device, for example C</dev/sda>.
1995 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1996 and sectors on the device, which are passed directly to sfdisk as
1997 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1998 of these, then the corresponding parameter is omitted. Usually for
1999 'large' disks, you can just pass C<0> for these, but for small
2000 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2001 out the right geometry and you will need to tell it.
2003 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2004 information refer to the L<sfdisk(8)> manpage.
2006 To create a single partition occupying the whole disk, you would
2007 pass C<lines> as a single element list, when the single element being
2008 the string C<,> (comma).
2010 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2011 C<guestfs_part_init>");
2013 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2014 (* Regression test for RHBZ#597135. *)
2015 [InitScratchFS, Always, TestLastFail
2016 [["write_file"; "/write_file"; "abc"; "10000"]]],
2019 This call creates a file called C<path>. The contents of the
2020 file is the string C<content> (which can contain any 8 bit data),
2021 with length C<size>.
2023 As a special case, if C<size> is C<0>
2024 then the length is calculated using C<strlen> (so in this case
2025 the content cannot contain embedded ASCII NULs).
2027 I<NB.> Owing to a bug, writing content containing ASCII NUL
2028 characters does I<not> work, even if the length is specified.");
2030 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2031 [InitEmpty, Always, TestOutputListOfDevices (
2032 [["part_disk"; "/dev/sda"; "mbr"];
2033 ["mkfs"; "ext2"; "/dev/sda1"];
2034 ["mount_options"; ""; "/dev/sda1"; "/"];
2035 ["mounts"]], ["/dev/sda1"]);
2036 InitEmpty, Always, TestOutputList (
2037 [["part_disk"; "/dev/sda"; "mbr"];
2038 ["mkfs"; "ext2"; "/dev/sda1"];
2039 ["mount_options"; ""; "/dev/sda1"; "/"];
2042 "unmount a filesystem",
2044 This unmounts the given filesystem. The filesystem may be
2045 specified either by its mountpoint (path) or the device which
2046 contains the filesystem.");
2048 ("mounts", (RStringList "devices", [], []), 46, [],
2049 [InitScratchFS, Always, TestOutputListOfDevices (
2050 [["mounts"]], ["/dev/sdb1"])],
2051 "show mounted filesystems",
2053 This returns the list of currently mounted filesystems. It returns
2054 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2056 Some internal mounts are not shown.
2058 See also: C<guestfs_mountpoints>");
2060 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2061 [InitScratchFS, Always, TestOutputList (
2064 (* check that umount_all can unmount nested mounts correctly: *)
2065 InitEmpty, Always, TestOutputList (
2066 [["part_init"; "/dev/sda"; "mbr"];
2067 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2068 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2069 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2070 ["mkfs"; "ext2"; "/dev/sda1"];
2071 ["mkfs"; "ext2"; "/dev/sda2"];
2072 ["mkfs"; "ext2"; "/dev/sda3"];
2073 ["mount_options"; ""; "/dev/sda1"; "/"];
2075 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2076 ["mkdir"; "/mp1/mp2"];
2077 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2078 ["mkdir"; "/mp1/mp2/mp3"];
2081 "unmount all filesystems",
2083 This unmounts all mounted filesystems.
2085 Some internal mounts are not unmounted by this call.");
2087 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2089 "remove all LVM LVs, VGs and PVs",
2091 This command removes all LVM logical volumes, volume groups
2092 and physical volumes.");
2094 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2095 [InitISOFS, Always, TestOutput (
2096 [["file"; "/empty"]], "empty");
2097 InitISOFS, Always, TestOutput (
2098 [["file"; "/known-1"]], "ASCII text");
2099 InitISOFS, Always, TestLastFail (
2100 [["file"; "/notexists"]]);
2101 InitISOFS, Always, TestOutput (
2102 [["file"; "/abssymlink"]], "symbolic link");
2103 InitISOFS, Always, TestOutput (
2104 [["file"; "/directory"]], "directory")],
2105 "determine file type",
2107 This call uses the standard L<file(1)> command to determine
2108 the type or contents of the file.
2110 This call will also transparently look inside various types
2113 The exact command which runs is C<file -zb path>. Note in
2114 particular that the filename is not prepended to the output
2117 This command can also be used on C</dev/> devices
2118 (and partitions, LV names). You can for example use this
2119 to determine if a device contains a filesystem, although
2120 it's usually better to use C<guestfs_vfs_type>.
2122 If the C<path> does not begin with C</dev/> then
2123 this command only works for the content of regular files.
2124 For other file types (directory, symbolic link etc) it
2125 will just return the string C<directory> etc.");
2127 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2128 [InitScratchFS, Always, TestOutput (
2129 [["mkdir"; "/command"];
2130 ["upload"; "test-command"; "/command/test-command"];
2131 ["chmod"; "0o755"; "/command/test-command"];
2132 ["command"; "/command/test-command 1"]], "Result1");
2133 InitScratchFS, Always, TestOutput (
2134 [["mkdir"; "/command2"];
2135 ["upload"; "test-command"; "/command2/test-command"];
2136 ["chmod"; "0o755"; "/command2/test-command"];
2137 ["command"; "/command2/test-command 2"]], "Result2\n");
2138 InitScratchFS, Always, TestOutput (
2139 [["mkdir"; "/command3"];
2140 ["upload"; "test-command"; "/command3/test-command"];
2141 ["chmod"; "0o755"; "/command3/test-command"];
2142 ["command"; "/command3/test-command 3"]], "\nResult3");
2143 InitScratchFS, Always, TestOutput (
2144 [["mkdir"; "/command4"];
2145 ["upload"; "test-command"; "/command4/test-command"];
2146 ["chmod"; "0o755"; "/command4/test-command"];
2147 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2148 InitScratchFS, Always, TestOutput (
2149 [["mkdir"; "/command5"];
2150 ["upload"; "test-command"; "/command5/test-command"];
2151 ["chmod"; "0o755"; "/command5/test-command"];
2152 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2153 InitScratchFS, Always, TestOutput (
2154 [["mkdir"; "/command6"];
2155 ["upload"; "test-command"; "/command6/test-command"];
2156 ["chmod"; "0o755"; "/command6/test-command"];
2157 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2158 InitScratchFS, Always, TestOutput (
2159 [["mkdir"; "/command7"];
2160 ["upload"; "test-command"; "/command7/test-command"];
2161 ["chmod"; "0o755"; "/command7/test-command"];
2162 ["command"; "/command7/test-command 7"]], "");
2163 InitScratchFS, Always, TestOutput (
2164 [["mkdir"; "/command8"];
2165 ["upload"; "test-command"; "/command8/test-command"];
2166 ["chmod"; "0o755"; "/command8/test-command"];
2167 ["command"; "/command8/test-command 8"]], "\n");
2168 InitScratchFS, Always, TestOutput (
2169 [["mkdir"; "/command9"];
2170 ["upload"; "test-command"; "/command9/test-command"];
2171 ["chmod"; "0o755"; "/command9/test-command"];
2172 ["command"; "/command9/test-command 9"]], "\n\n");
2173 InitScratchFS, Always, TestOutput (
2174 [["mkdir"; "/command10"];
2175 ["upload"; "test-command"; "/command10/test-command"];
2176 ["chmod"; "0o755"; "/command10/test-command"];
2177 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2178 InitScratchFS, Always, TestOutput (
2179 [["mkdir"; "/command11"];
2180 ["upload"; "test-command"; "/command11/test-command"];
2181 ["chmod"; "0o755"; "/command11/test-command"];
2182 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2183 InitScratchFS, Always, TestLastFail (
2184 [["mkdir"; "/command12"];
2185 ["upload"; "test-command"; "/command12/test-command"];
2186 ["chmod"; "0o755"; "/command12/test-command"];
2187 ["command"; "/command12/test-command"]])],
2188 "run a command from the guest filesystem",
2190 This call runs a command from the guest filesystem. The
2191 filesystem must be mounted, and must contain a compatible
2192 operating system (ie. something Linux, with the same
2193 or compatible processor architecture).
2195 The single parameter is an argv-style list of arguments.
2196 The first element is the name of the program to run.
2197 Subsequent elements are parameters. The list must be
2198 non-empty (ie. must contain a program name). Note that
2199 the command runs directly, and is I<not> invoked via
2200 the shell (see C<guestfs_sh>).
2202 The return value is anything printed to I<stdout> by
2205 If the command returns a non-zero exit status, then
2206 this function returns an error message. The error message
2207 string is the content of I<stderr> from the command.
2209 The C<$PATH> environment variable will contain at least
2210 C</usr/bin> and C</bin>. If you require a program from
2211 another location, you should provide the full path in the
2214 Shared libraries and data files required by the program
2215 must be available on filesystems which are mounted in the
2216 correct places. It is the caller's responsibility to ensure
2217 all filesystems that are needed are mounted at the right
2220 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2221 [InitScratchFS, Always, TestOutputList (
2222 [["mkdir"; "/command_lines"];
2223 ["upload"; "test-command"; "/command_lines/test-command"];
2224 ["chmod"; "0o755"; "/command_lines/test-command"];
2225 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2226 InitScratchFS, Always, TestOutputList (
2227 [["mkdir"; "/command_lines2"];
2228 ["upload"; "test-command"; "/command_lines2/test-command"];
2229 ["chmod"; "0o755"; "/command_lines2/test-command"];
2230 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2231 InitScratchFS, Always, TestOutputList (
2232 [["mkdir"; "/command_lines3"];
2233 ["upload"; "test-command"; "/command_lines3/test-command"];
2234 ["chmod"; "0o755"; "/command_lines3/test-command"];
2235 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2236 InitScratchFS, Always, TestOutputList (
2237 [["mkdir"; "/command_lines4"];
2238 ["upload"; "test-command"; "/command_lines4/test-command"];
2239 ["chmod"; "0o755"; "/command_lines4/test-command"];
2240 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2241 InitScratchFS, Always, TestOutputList (
2242 [["mkdir"; "/command_lines5"];
2243 ["upload"; "test-command"; "/command_lines5/test-command"];
2244 ["chmod"; "0o755"; "/command_lines5/test-command"];
2245 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2246 InitScratchFS, Always, TestOutputList (
2247 [["mkdir"; "/command_lines6"];
2248 ["upload"; "test-command"; "/command_lines6/test-command"];
2249 ["chmod"; "0o755"; "/command_lines6/test-command"];
2250 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2251 InitScratchFS, Always, TestOutputList (
2252 [["mkdir"; "/command_lines7"];
2253 ["upload"; "test-command"; "/command_lines7/test-command"];
2254 ["chmod"; "0o755"; "/command_lines7/test-command"];
2255 ["command_lines"; "/command_lines7/test-command 7"]], []);
2256 InitScratchFS, Always, TestOutputList (
2257 [["mkdir"; "/command_lines8"];
2258 ["upload"; "test-command"; "/command_lines8/test-command"];
2259 ["chmod"; "0o755"; "/command_lines8/test-command"];
2260 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2261 InitScratchFS, Always, TestOutputList (
2262 [["mkdir"; "/command_lines9"];
2263 ["upload"; "test-command"; "/command_lines9/test-command"];
2264 ["chmod"; "0o755"; "/command_lines9/test-command"];
2265 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2266 InitScratchFS, Always, TestOutputList (
2267 [["mkdir"; "/command_lines10"];
2268 ["upload"; "test-command"; "/command_lines10/test-command"];
2269 ["chmod"; "0o755"; "/command_lines10/test-command"];
2270 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2271 InitScratchFS, Always, TestOutputList (
2272 [["mkdir"; "/command_lines11"];
2273 ["upload"; "test-command"; "/command_lines11/test-command"];
2274 ["chmod"; "0o755"; "/command_lines11/test-command"];
2275 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2276 "run a command, returning lines",
2278 This is the same as C<guestfs_command>, but splits the
2279 result into a list of lines.
2281 See also: C<guestfs_sh_lines>");
2283 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2284 [InitISOFS, Always, TestOutputStruct (
2285 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2286 "get file information",
2288 Returns file information for the given C<path>.
2290 This is the same as the C<stat(2)> system call.");
2292 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2293 [InitISOFS, Always, TestOutputStruct (
2294 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2295 "get file information for a symbolic link",
2297 Returns file information for the given C<path>.
2299 This is the same as C<guestfs_stat> except that if C<path>
2300 is a symbolic link, then the link is stat-ed, not the file it
2303 This is the same as the C<lstat(2)> system call.");
2305 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2306 [InitISOFS, Always, TestOutputStruct (
2307 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2308 "get file system statistics",
2310 Returns file system statistics for any mounted file system.
2311 C<path> should be a file or directory in the mounted file system
2312 (typically it is the mount point itself, but it doesn't need to be).
2314 This is the same as the C<statvfs(2)> system call.");
2316 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2318 "get ext2/ext3/ext4 superblock details",
2320 This returns the contents of the ext2, ext3 or ext4 filesystem
2321 superblock on C<device>.
2323 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2324 manpage for more details. The list of fields returned isn't
2325 clearly defined, and depends on both the version of C<tune2fs>
2326 that libguestfs was built against, and the filesystem itself.");
2328 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2329 [InitEmpty, Always, TestOutputTrue (
2330 [["blockdev_setro"; "/dev/sda"];
2331 ["blockdev_getro"; "/dev/sda"]])],
2332 "set block device to read-only",
2334 Sets the block device named C<device> to read-only.
2336 This uses the L<blockdev(8)> command.");
2338 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2339 [InitEmpty, Always, TestOutputFalse (
2340 [["blockdev_setrw"; "/dev/sda"];
2341 ["blockdev_getro"; "/dev/sda"]])],
2342 "set block device to read-write",
2344 Sets the block device named C<device> to read-write.
2346 This uses the L<blockdev(8)> command.");
2348 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2349 [InitEmpty, Always, TestOutputTrue (
2350 [["blockdev_setro"; "/dev/sda"];
2351 ["blockdev_getro"; "/dev/sda"]])],
2352 "is block device set to read-only",
2354 Returns a boolean indicating if the block device is read-only
2355 (true if read-only, false if not).
2357 This uses the L<blockdev(8)> command.");
2359 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2360 [InitEmpty, Always, TestOutputInt (
2361 [["blockdev_getss"; "/dev/sda"]], 512)],
2362 "get sectorsize of block device",
2364 This returns the size of sectors on a block device.
2365 Usually 512, but can be larger for modern devices.
2367 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2370 This uses the L<blockdev(8)> command.");
2372 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2373 [InitEmpty, Always, TestOutputInt (
2374 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2375 "get blocksize of block device",
2377 This returns the block size of a device.
2379 (Note this is different from both I<size in blocks> and
2380 I<filesystem block size>).
2382 This uses the L<blockdev(8)> command.");
2384 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2386 "set blocksize of block device",
2388 This sets the block size of a device.
2390 (Note this is different from both I<size in blocks> and
2391 I<filesystem block size>).
2393 This uses the L<blockdev(8)> command.");
2395 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2396 [InitEmpty, Always, TestOutputInt (
2397 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2398 "get total size of device in 512-byte sectors",
2400 This returns the size of the device in units of 512-byte sectors
2401 (even if the sectorsize isn't 512 bytes ... weird).
2403 See also C<guestfs_blockdev_getss> for the real sector size of
2404 the device, and C<guestfs_blockdev_getsize64> for the more
2405 useful I<size in bytes>.
2407 This uses the L<blockdev(8)> command.");
2409 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2410 [InitEmpty, Always, TestOutputInt (
2411 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2412 "get total size of device in bytes",
2414 This returns the size of the device in bytes.
2416 See also C<guestfs_blockdev_getsz>.
2418 This uses the L<blockdev(8)> command.");
2420 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2421 [InitEmpty, Always, TestRun
2422 [["blockdev_flushbufs"; "/dev/sda"]]],
2423 "flush device buffers",
2425 This tells the kernel to flush internal buffers associated
2428 This uses the L<blockdev(8)> command.");
2430 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2431 [InitEmpty, Always, TestRun
2432 [["blockdev_rereadpt"; "/dev/sda"]]],
2433 "reread partition table",
2435 Reread the partition table on C<device>.
2437 This uses the L<blockdev(8)> command.");
2439 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2440 [InitScratchFS, Always, TestOutput (
2441 (* Pick a file from cwd which isn't likely to change. *)
2442 [["mkdir"; "/upload"];
2443 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2444 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2445 Digest.to_hex (Digest.file "COPYING.LIB"))],
2446 "upload a file from the local machine",
2448 Upload local file C<filename> to C<remotefilename> on the
2451 C<filename> can also be a named pipe.
2453 See also C<guestfs_download>.");
2455 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2456 [InitScratchFS, Always, TestOutput (
2457 (* Pick a file from cwd which isn't likely to change. *)
2458 [["mkdir"; "/download"];
2459 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2460 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2461 ["upload"; "testdownload.tmp"; "/download/upload"];
2462 ["checksum"; "md5"; "/download/upload"]],
2463 Digest.to_hex (Digest.file "COPYING.LIB"))],
2464 "download a file to the local machine",
2466 Download file C<remotefilename> and save it as C<filename>
2467 on the local machine.
2469 C<filename> can also be a named pipe.
2471 See also C<guestfs_upload>, C<guestfs_cat>.");
2473 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2474 [InitISOFS, Always, TestOutput (
2475 [["checksum"; "crc"; "/known-3"]], "2891671662");
2476 InitISOFS, Always, TestLastFail (
2477 [["checksum"; "crc"; "/notexists"]]);
2478 InitISOFS, Always, TestOutput (
2479 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2480 InitISOFS, Always, TestOutput (
2481 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2482 InitISOFS, Always, TestOutput (
2483 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2484 InitISOFS, Always, TestOutput (
2485 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2486 InitISOFS, Always, TestOutput (
2487 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2488 InitISOFS, Always, TestOutput (
2489 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2490 (* Test for RHBZ#579608, absolute symbolic links. *)
2491 InitISOFS, Always, TestOutput (
2492 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2493 "compute MD5, SHAx or CRC checksum of file",
2495 This call computes the MD5, SHAx or CRC checksum of the
2498 The type of checksum to compute is given by the C<csumtype>
2499 parameter which must have one of the following values:
2505 Compute the cyclic redundancy check (CRC) specified by POSIX
2506 for the C<cksum> command.
2510 Compute the MD5 hash (using the C<md5sum> program).
2514 Compute the SHA1 hash (using the C<sha1sum> program).
2518 Compute the SHA224 hash (using the C<sha224sum> program).
2522 Compute the SHA256 hash (using the C<sha256sum> program).
2526 Compute the SHA384 hash (using the C<sha384sum> program).
2530 Compute the SHA512 hash (using the C<sha512sum> program).
2534 The checksum is returned as a printable string.
2536 To get the checksum for a device, use C<guestfs_checksum_device>.
2538 To get the checksums for many files, use C<guestfs_checksums_out>.");
2540 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2541 [InitScratchFS, Always, TestOutput (
2542 [["mkdir"; "/tar_in"];
2543 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2544 ["cat"; "/tar_in/hello"]], "hello\n")],
2545 "unpack tarfile to directory",
2547 This command uploads and unpacks local file C<tarfile> (an
2548 I<uncompressed> tar file) into C<directory>.
2550 To upload a compressed tarball, use C<guestfs_tgz_in>
2551 or C<guestfs_txz_in>.");
2553 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2555 "pack directory into tarfile",
2557 This command packs the contents of C<directory> and downloads
2558 it to local file C<tarfile>.
2560 To download a compressed tarball, use C<guestfs_tgz_out>
2561 or C<guestfs_txz_out>.");
2563 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2564 [InitScratchFS, Always, TestOutput (
2565 [["mkdir"; "/tgz_in"];
2566 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2567 ["cat"; "/tgz_in/hello"]], "hello\n")],
2568 "unpack compressed tarball to directory",
2570 This command uploads and unpacks local file C<tarball> (a
2571 I<gzip compressed> tar file) into C<directory>.
2573 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2575 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2577 "pack directory into compressed tarball",
2579 This command packs the contents of C<directory> and downloads
2580 it to local file C<tarball>.
2582 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2584 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2585 [InitBasicFS, Always, TestLastFail (
2587 ["mount_ro"; "/dev/sda1"; "/"];
2588 ["touch"; "/new"]]);
2589 InitBasicFS, Always, TestOutput (
2590 [["write"; "/new"; "data"];
2592 ["mount_ro"; "/dev/sda1"; "/"];
2593 ["cat"; "/new"]], "data")],
2594 "mount a guest disk, read-only",
2596 This is the same as the C<guestfs_mount> command, but it
2597 mounts the filesystem with the read-only (I<-o ro>) flag.");
2599 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2601 "mount a guest disk with mount options",
2603 This is the same as the C<guestfs_mount> command, but it
2604 allows you to set the mount options as for the
2605 L<mount(8)> I<-o> flag.
2607 If the C<options> parameter is an empty string, then
2608 no options are passed (all options default to whatever
2609 the filesystem uses).");
2611 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2613 "mount a guest disk with mount options and vfstype",
2615 This is the same as the C<guestfs_mount> command, but it
2616 allows you to set both the mount options and the vfstype
2617 as for the L<mount(8)> I<-o> and I<-t> flags.");
2619 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2621 "debugging and internals",
2623 The C<guestfs_debug> command exposes some internals of
2624 C<guestfsd> (the guestfs daemon) that runs inside the
2627 There is no comprehensive help for this command. You have
2628 to look at the file C<daemon/debug.c> in the libguestfs source
2629 to find out what you can do.");
2631 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2632 [InitEmpty, Always, TestOutputList (
2633 [["part_disk"; "/dev/sda"; "mbr"];
2634 ["pvcreate"; "/dev/sda1"];
2635 ["vgcreate"; "VG"; "/dev/sda1"];
2636 ["lvcreate"; "LV1"; "VG"; "50"];
2637 ["lvcreate"; "LV2"; "VG"; "50"];
2638 ["lvremove"; "/dev/VG/LV1"];
2639 ["lvs"]], ["/dev/VG/LV2"]);
2640 InitEmpty, Always, TestOutputList (
2641 [["part_disk"; "/dev/sda"; "mbr"];
2642 ["pvcreate"; "/dev/sda1"];
2643 ["vgcreate"; "VG"; "/dev/sda1"];
2644 ["lvcreate"; "LV1"; "VG"; "50"];
2645 ["lvcreate"; "LV2"; "VG"; "50"];
2646 ["lvremove"; "/dev/VG"];
2648 InitEmpty, Always, TestOutputList (
2649 [["part_disk"; "/dev/sda"; "mbr"];
2650 ["pvcreate"; "/dev/sda1"];
2651 ["vgcreate"; "VG"; "/dev/sda1"];
2652 ["lvcreate"; "LV1"; "VG"; "50"];
2653 ["lvcreate"; "LV2"; "VG"; "50"];
2654 ["lvremove"; "/dev/VG"];
2656 "remove an LVM logical volume",
2658 Remove an LVM logical volume C<device>, where C<device> is
2659 the path to the LV, such as C</dev/VG/LV>.
2661 You can also remove all LVs in a volume group by specifying
2662 the VG name, C</dev/VG>.");
2664 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2665 [InitEmpty, Always, TestOutputList (
2666 [["part_disk"; "/dev/sda"; "mbr"];
2667 ["pvcreate"; "/dev/sda1"];
2668 ["vgcreate"; "VG"; "/dev/sda1"];
2669 ["lvcreate"; "LV1"; "VG"; "50"];
2670 ["lvcreate"; "LV2"; "VG"; "50"];
2673 InitEmpty, Always, TestOutputList (
2674 [["part_disk"; "/dev/sda"; "mbr"];
2675 ["pvcreate"; "/dev/sda1"];
2676 ["vgcreate"; "VG"; "/dev/sda1"];
2677 ["lvcreate"; "LV1"; "VG"; "50"];
2678 ["lvcreate"; "LV2"; "VG"; "50"];
2681 "remove an LVM volume group",
2683 Remove an LVM volume group C<vgname>, (for example C<VG>).
2685 This also forcibly removes all logical volumes in the volume
2688 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2689 [InitEmpty, Always, TestOutputListOfDevices (
2690 [["part_disk"; "/dev/sda"; "mbr"];
2691 ["pvcreate"; "/dev/sda1"];
2692 ["vgcreate"; "VG"; "/dev/sda1"];
2693 ["lvcreate"; "LV1"; "VG"; "50"];
2694 ["lvcreate"; "LV2"; "VG"; "50"];
2696 ["pvremove"; "/dev/sda1"];
2698 InitEmpty, Always, TestOutputListOfDevices (
2699 [["part_disk"; "/dev/sda"; "mbr"];
2700 ["pvcreate"; "/dev/sda1"];
2701 ["vgcreate"; "VG"; "/dev/sda1"];
2702 ["lvcreate"; "LV1"; "VG"; "50"];
2703 ["lvcreate"; "LV2"; "VG"; "50"];
2705 ["pvremove"; "/dev/sda1"];
2707 InitEmpty, Always, TestOutputListOfDevices (
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"];
2714 ["pvremove"; "/dev/sda1"];
2716 "remove an LVM physical volume",
2718 This wipes a physical volume C<device> so that LVM will no longer
2721 The implementation uses the C<pvremove> command which refuses to
2722 wipe physical volumes that contain any volume groups, so you have
2723 to remove those first.");
2725 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2726 [InitBasicFS, Always, TestOutput (
2727 [["set_e2label"; "/dev/sda1"; "testlabel"];
2728 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2729 "set the ext2/3/4 filesystem label",
2731 This sets the ext2/3/4 filesystem label of the filesystem on
2732 C<device> to C<label>. Filesystem labels are limited to
2735 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2736 to return the existing label on a filesystem.");
2738 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2740 "get the ext2/3/4 filesystem label",
2742 This returns the ext2/3/4 filesystem label of the filesystem on
2745 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2746 (let uuid = uuidgen () in
2747 [InitBasicFS, Always, TestOutput (
2748 [["set_e2uuid"; "/dev/sda1"; uuid];
2749 ["get_e2uuid"; "/dev/sda1"]], uuid);
2750 InitBasicFS, Always, TestOutput (
2751 [["set_e2uuid"; "/dev/sda1"; "clear"];
2752 ["get_e2uuid"; "/dev/sda1"]], "");
2753 (* We can't predict what UUIDs will be, so just check the commands run. *)
2754 InitBasicFS, Always, TestRun (
2755 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2756 InitBasicFS, Always, TestRun (
2757 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2758 "set the ext2/3/4 filesystem UUID",
2760 This sets the ext2/3/4 filesystem UUID of the filesystem on
2761 C<device> to C<uuid>. The format of the UUID and alternatives
2762 such as C<clear>, C<random> and C<time> are described in the
2763 L<tune2fs(8)> manpage.
2765 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2766 to return the existing UUID of a filesystem.");
2768 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2769 (* Regression test for RHBZ#597112. *)
2770 (let uuid = uuidgen () in
2771 [InitNone, Always, TestOutput (
2772 [["mke2journal"; "1024"; "/dev/sdc"];
2773 ["set_e2uuid"; "/dev/sdc"; uuid];
2774 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2775 "get the ext2/3/4 filesystem UUID",
2777 This returns the ext2/3/4 filesystem UUID of the filesystem on
2780 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2781 [InitBasicFS, Always, TestOutputInt (
2782 [["umount"; "/dev/sda1"];
2783 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2784 InitBasicFS, Always, TestOutputInt (
2785 [["umount"; "/dev/sda1"];
2786 ["zero"; "/dev/sda1"];
2787 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2788 "run the filesystem checker",
2790 This runs the filesystem checker (fsck) on C<device> which
2791 should have filesystem type C<fstype>.
2793 The returned integer is the status. See L<fsck(8)> for the
2794 list of status codes from C<fsck>.
2802 Multiple status codes can be summed together.
2806 A non-zero return code can mean \"success\", for example if
2807 errors have been corrected on the filesystem.
2811 Checking or repairing NTFS volumes is not supported
2816 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2818 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2819 [InitBasicFS, Always, TestOutput (
2820 [["umount"; "/dev/sda1"];
2821 ["zero"; "/dev/sda1"];
2822 ["file"; "/dev/sda1"]], "data")],
2823 "write zeroes to the device",
2825 This command writes zeroes over the first few blocks of C<device>.
2827 How many blocks are zeroed isn't specified (but it's I<not> enough
2828 to securely wipe the device). It should be sufficient to remove
2829 any partition tables, filesystem superblocks and so on.
2831 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2833 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2835 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2836 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2838 [InitBasicFS, Always, TestOutputTrue (
2839 [["mkdir_p"; "/boot/grub"];
2840 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2841 ["grub_install"; "/"; "/dev/vda"];
2842 ["is_dir"; "/boot"]])],
2845 This command installs GRUB (the Grand Unified Bootloader) on
2846 C<device>, with the root directory being C<root>.
2848 Note: If grub-install reports the error
2849 \"No suitable drive was found in the generated device map.\"
2850 it may be that you need to create a C</boot/grub/device.map>
2851 file first that contains the mapping between grub device names
2852 and Linux device names. It is usually sufficient to create
2857 replacing C</dev/vda> with the name of the installation device.");
2859 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2860 [InitScratchFS, Always, TestOutput (
2862 ["write"; "/cp/old"; "file content"];
2863 ["cp"; "/cp/old"; "/cp/new"];
2864 ["cat"; "/cp/new"]], "file content");
2865 InitScratchFS, Always, TestOutputTrue (
2867 ["write"; "/cp2/old"; "file content"];
2868 ["cp"; "/cp2/old"; "/cp2/new"];
2869 ["is_file"; "/cp2/old"]]);
2870 InitScratchFS, Always, TestOutput (
2872 ["write"; "/cp3/old"; "file content"];
2873 ["mkdir"; "/cp3/dir"];
2874 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2875 ["cat"; "/cp3/dir/new"]], "file content")],
2878 This copies a file from C<src> to C<dest> where C<dest> is
2879 either a destination filename or destination directory.");
2881 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2882 [InitScratchFS, Always, TestOutput (
2883 [["mkdir"; "/cp_a1"];
2884 ["mkdir"; "/cp_a2"];
2885 ["write"; "/cp_a1/file"; "file content"];
2886 ["cp_a"; "/cp_a1"; "/cp_a2"];
2887 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2888 "copy a file or directory recursively",
2890 This copies a file or directory from C<src> to C<dest>
2891 recursively using the C<cp -a> command.");
2893 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2894 [InitScratchFS, Always, TestOutput (
2896 ["write"; "/mv/old"; "file content"];
2897 ["mv"; "/mv/old"; "/mv/new"];
2898 ["cat"; "/mv/new"]], "file content");
2899 InitScratchFS, Always, TestOutputFalse (
2901 ["write"; "/mv2/old"; "file content"];
2902 ["mv"; "/mv2/old"; "/mv2/new"];
2903 ["is_file"; "/mv2/old"]])],
2906 This moves a file from C<src> to C<dest> where C<dest> is
2907 either a destination filename or destination directory.");
2909 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2910 [InitEmpty, Always, TestRun (
2911 [["drop_caches"; "3"]])],
2912 "drop kernel page cache, dentries and inodes",
2914 This instructs the guest kernel to drop its page cache,
2915 and/or dentries and inode caches. The parameter C<whattodrop>
2916 tells the kernel what precisely to drop, see
2917 L<http://linux-mm.org/Drop_Caches>
2919 Setting C<whattodrop> to 3 should drop everything.
2921 This automatically calls L<sync(2)> before the operation,
2922 so that the maximum guest memory is freed.");
2924 ("dmesg", (RString "kmsgs", [], []), 91, [],
2925 [InitEmpty, Always, TestRun (
2927 "return kernel messages",
2929 This returns the kernel messages (C<dmesg> output) from
2930 the guest kernel. This is sometimes useful for extended
2931 debugging of problems.
2933 Another way to get the same information is to enable
2934 verbose messages with C<guestfs_set_verbose> or by setting
2935 the environment variable C<LIBGUESTFS_DEBUG=1> before
2936 running the program.");
2938 ("ping_daemon", (RErr, [], []), 92, [],
2939 [InitEmpty, Always, TestRun (
2940 [["ping_daemon"]])],
2941 "ping the guest daemon",
2943 This is a test probe into the guestfs daemon running inside
2944 the qemu subprocess. Calling this function checks that the
2945 daemon responds to the ping message, without affecting the daemon
2946 or attached block device(s) in any other way.");
2948 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2949 [InitScratchFS, Always, TestOutputTrue (
2950 [["mkdir"; "/equal"];
2951 ["write"; "/equal/file1"; "contents of a file"];
2952 ["cp"; "/equal/file1"; "/equal/file2"];
2953 ["equal"; "/equal/file1"; "/equal/file2"]]);
2954 InitScratchFS, Always, TestOutputFalse (
2955 [["mkdir"; "/equal2"];
2956 ["write"; "/equal2/file1"; "contents of a file"];
2957 ["write"; "/equal2/file2"; "contents of another file"];
2958 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
2959 InitScratchFS, Always, TestLastFail (
2960 [["mkdir"; "/equal3"];
2961 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
2962 "test if two files have equal contents",
2964 This compares the two files C<file1> and C<file2> and returns
2965 true if their content is exactly equal, or false otherwise.
2967 The external L<cmp(1)> program is used for the comparison.");
2969 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
2970 [InitISOFS, Always, TestOutputList (
2971 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2972 InitISOFS, Always, TestOutputList (
2973 [["strings"; "/empty"]], []);
2974 (* Test for RHBZ#579608, absolute symbolic links. *)
2975 InitISOFS, Always, TestRun (
2976 [["strings"; "/abssymlink"]])],
2977 "print the printable strings in a file",
2979 This runs the L<strings(1)> command on a file and returns
2980 the list of printable strings found.");
2982 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
2983 [InitISOFS, Always, TestOutputList (
2984 [["strings_e"; "b"; "/known-5"]], []);
2985 InitScratchFS, Always, TestOutputList (
2986 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2987 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
2988 "print the printable strings in a file",
2990 This is like the C<guestfs_strings> command, but allows you to
2991 specify the encoding of strings that are looked for in
2992 the source file C<path>.
2994 Allowed encodings are:
3000 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3001 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3005 Single 8-bit-byte characters.
3009 16-bit big endian strings such as those encoded in
3010 UTF-16BE or UCS-2BE.
3012 =item l (lower case letter L)
3014 16-bit little endian such as UTF-16LE and UCS-2LE.
3015 This is useful for examining binaries in Windows guests.
3019 32-bit big endian such as UCS-4BE.
3023 32-bit little endian such as UCS-4LE.
3027 The returned strings are transcoded to UTF-8.");
3029 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3030 [InitISOFS, Always, TestOutput (
3031 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3032 (* Test for RHBZ#501888c2 regression which caused large hexdump
3033 * commands to segfault.
3035 InitISOFS, Always, TestRun (
3036 [["hexdump"; "/100krandom"]]);
3037 (* Test for RHBZ#579608, absolute symbolic links. *)
3038 InitISOFS, Always, TestRun (
3039 [["hexdump"; "/abssymlink"]])],
3040 "dump a file in hexadecimal",
3042 This runs C<hexdump -C> on the given C<path>. The result is
3043 the human-readable, canonical hex dump of the file.");
3045 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3046 [InitNone, Always, TestOutput (
3047 [["part_disk"; "/dev/sda"; "mbr"];
3048 ["mkfs"; "ext3"; "/dev/sda1"];
3049 ["mount_options"; ""; "/dev/sda1"; "/"];
3050 ["write"; "/new"; "test file"];
3051 ["umount"; "/dev/sda1"];
3052 ["zerofree"; "/dev/sda1"];
3053 ["mount_options"; ""; "/dev/sda1"; "/"];
3054 ["cat"; "/new"]], "test file")],
3055 "zero unused inodes and disk blocks on ext2/3 filesystem",
3057 This runs the I<zerofree> program on C<device>. This program
3058 claims to zero unused inodes and disk blocks on an ext2/3
3059 filesystem, thus making it possible to compress the filesystem
3062 You should B<not> run this program if the filesystem is
3065 It is possible that using this program can damage the filesystem
3066 or data on the filesystem.");
3068 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3070 "resize an LVM physical volume",
3072 This resizes (expands or shrinks) an existing LVM physical
3073 volume to match the new size of the underlying device.");
3075 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3076 Int "cyls"; Int "heads"; Int "sectors";
3077 String "line"], []), 99, [DangerWillRobinson],
3079 "modify a single partition on a block device",
3081 This runs L<sfdisk(8)> option to modify just the single
3082 partition C<n> (note: C<n> counts from 1).
3084 For other parameters, see C<guestfs_sfdisk>. You should usually
3085 pass C<0> for the cyls/heads/sectors parameters.
3087 See also: C<guestfs_part_add>");
3089 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3091 "display the partition table",
3093 This displays the partition table on C<device>, in the
3094 human-readable output of the L<sfdisk(8)> command. It is
3095 not intended to be parsed.
3097 See also: C<guestfs_part_list>");
3099 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3101 "display the kernel geometry",
3103 This displays the kernel's idea of the geometry of C<device>.
3105 The result is in human-readable format, and not designed to
3108 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3110 "display the disk geometry from the partition table",
3112 This displays the disk geometry of C<device> read from the
3113 partition table. Especially in the case where the underlying
3114 block device has been resized, this can be different from the
3115 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3117 The result is in human-readable format, and not designed to
3120 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3122 "activate or deactivate all volume groups",
3124 This command activates or (if C<activate> is false) deactivates
3125 all logical volumes in all volume groups.
3126 If activated, then they are made known to the
3127 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3128 then those devices disappear.
3130 This command is the same as running C<vgchange -a y|n>");
3132 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3134 "activate or deactivate some volume groups",
3136 This command activates or (if C<activate> is false) deactivates
3137 all logical volumes in the listed volume groups C<volgroups>.
3138 If activated, then they are made known to the
3139 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3140 then those devices disappear.
3142 This command is the same as running C<vgchange -a y|n volgroups...>
3144 Note that if C<volgroups> is an empty list then B<all> volume groups
3145 are activated or deactivated.");
3147 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3148 [InitNone, Always, TestOutput (
3149 [["part_disk"; "/dev/sda"; "mbr"];
3150 ["pvcreate"; "/dev/sda1"];
3151 ["vgcreate"; "VG"; "/dev/sda1"];
3152 ["lvcreate"; "LV"; "VG"; "10"];
3153 ["mkfs"; "ext2"; "/dev/VG/LV"];
3154 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3155 ["write"; "/new"; "test content"];
3157 ["lvresize"; "/dev/VG/LV"; "20"];
3158 ["e2fsck_f"; "/dev/VG/LV"];
3159 ["resize2fs"; "/dev/VG/LV"];
3160 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3161 ["cat"; "/new"]], "test content");
3162 InitNone, Always, TestRun (
3163 (* Make an LV smaller to test RHBZ#587484. *)
3164 [["part_disk"; "/dev/sda"; "mbr"];
3165 ["pvcreate"; "/dev/sda1"];
3166 ["vgcreate"; "VG"; "/dev/sda1"];
3167 ["lvcreate"; "LV"; "VG"; "20"];
3168 ["lvresize"; "/dev/VG/LV"; "10"]])],
3169 "resize an LVM logical volume",
3171 This resizes (expands or shrinks) an existing LVM logical
3172 volume to C<mbytes>. When reducing, data in the reduced part
3175 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3176 [], (* lvresize tests this *)
3177 "resize an ext2, ext3 or ext4 filesystem",
3179 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3180 the underlying device.
3182 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3183 on the C<device> before calling this command. For unknown reasons
3184 C<resize2fs> sometimes gives an error about this and sometimes not.
3185 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3186 calling this function.");
3188 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3189 [InitBasicFS, Always, TestOutputList (
3190 [["find"; "/"]], ["lost+found"]);
3191 InitBasicFS, Always, TestOutputList (
3195 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3196 InitScratchFS, Always, TestOutputList (
3197 [["mkdir_p"; "/find/b/c"];
3198 ["touch"; "/find/b/c/d"];
3199 ["find"; "/find/b/"]], ["c"; "c/d"])],
3200 "find all files and directories",
3202 This command lists out all files and directories, recursively,
3203 starting at C<directory>. It is essentially equivalent to
3204 running the shell command C<find directory -print> but some
3205 post-processing happens on the output, described below.
3207 This returns a list of strings I<without any prefix>. Thus
3208 if the directory structure was:
3214 then the returned list from C<guestfs_find> C</tmp> would be
3222 If C<directory> is not a directory, then this command returns
3225 The returned list is sorted.
3227 See also C<guestfs_find0>.");
3229 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3230 [], (* lvresize tests this *)
3231 "check an ext2/ext3 filesystem",
3233 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3234 filesystem checker on C<device>, noninteractively (C<-p>),
3235 even if the filesystem appears to be clean (C<-f>).
3237 This command is only needed because of C<guestfs_resize2fs>
3238 (q.v.). Normally you should use C<guestfs_fsck>.");
3240 ("sleep", (RErr, [Int "secs"], []), 109, [],
3241 [InitNone, Always, TestRun (
3243 "sleep for some seconds",
3245 Sleep for C<secs> seconds.");
3247 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3248 [InitNone, Always, TestOutputInt (
3249 [["part_disk"; "/dev/sda"; "mbr"];
3250 ["mkfs"; "ntfs"; "/dev/sda1"];
3251 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3252 InitNone, Always, TestOutputInt (
3253 [["part_disk"; "/dev/sda"; "mbr"];
3254 ["mkfs"; "ext2"; "/dev/sda1"];
3255 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3256 "probe NTFS volume",
3258 This command runs the L<ntfs-3g.probe(8)> command which probes
3259 an NTFS C<device> for mountability. (Not all NTFS volumes can
3260 be mounted read-write, and some cannot be mounted at all).
3262 C<rw> is a boolean flag. Set it to true if you want to test
3263 if the volume can be mounted read-write. Set it to false if
3264 you want to test if the volume can be mounted read-only.
3266 The return value is an integer which C<0> if the operation
3267 would succeed, or some non-zero value documented in the
3268 L<ntfs-3g.probe(8)> manual page.");
3270 ("sh", (RString "output", [String "command"], []), 111, [],
3271 [], (* XXX needs tests *)
3272 "run a command via the shell",
3274 This call runs a command from the guest filesystem via the
3277 This is like C<guestfs_command>, but passes the command to:
3279 /bin/sh -c \"command\"
3281 Depending on the guest's shell, this usually results in
3282 wildcards being expanded, shell expressions being interpolated
3285 All the provisos about C<guestfs_command> apply to this call.");
3287 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3288 [], (* XXX needs tests *)
3289 "run a command via the shell returning lines",
3291 This is the same as C<guestfs_sh>, but splits the result
3292 into a list of lines.
3294 See also: C<guestfs_command_lines>");
3296 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3297 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3298 * code in stubs.c, since all valid glob patterns must start with "/".
3299 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3301 [InitScratchFS, Always, TestOutputList (
3302 [["mkdir_p"; "/glob_expand/b/c"];
3303 ["touch"; "/glob_expand/b/c/d"];
3304 ["touch"; "/glob_expand/b/c/e"];
3305 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3306 InitScratchFS, Always, TestOutputList (
3307 [["mkdir_p"; "/glob_expand2/b/c"];
3308 ["touch"; "/glob_expand2/b/c/d"];
3309 ["touch"; "/glob_expand2/b/c/e"];
3310 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3311 InitScratchFS, Always, TestOutputList (
3312 [["mkdir_p"; "/glob_expand3/b/c"];
3313 ["touch"; "/glob_expand3/b/c/d"];
3314 ["touch"; "/glob_expand3/b/c/e"];
3315 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3316 "expand a wildcard path",
3318 This command searches for all the pathnames matching
3319 C<pattern> according to the wildcard expansion rules
3322 If no paths match, then this returns an empty list
3323 (note: not an error).
3325 It is just a wrapper around the C L<glob(3)> function
3326 with flags C<GLOB_MARK|GLOB_BRACE>.
3327 See that manual page for more details.");
3329 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3330 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3331 [["scrub_device"; "/dev/sdc"]])],
3332 "scrub (securely wipe) a device",
3334 This command writes patterns over C<device> to make data retrieval
3337 It is an interface to the L<scrub(1)> program. See that
3338 manual page for more details.");
3340 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3341 [InitScratchFS, Always, TestRun (
3342 [["write"; "/scrub_file"; "content"];
3343 ["scrub_file"; "/scrub_file"]])],
3344 "scrub (securely wipe) a file",
3346 This command writes patterns over a file to make data retrieval
3349 The file is I<removed> after scrubbing.
3351 It is an interface to the L<scrub(1)> program. See that
3352 manual page for more details.");
3354 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3355 [], (* XXX needs testing *)
3356 "scrub (securely wipe) free space",
3358 This command creates the directory C<dir> and then fills it
3359 with files until the filesystem is full, and scrubs the files
3360 as for C<guestfs_scrub_file>, and deletes them.
3361 The intention is to scrub any free space on the partition
3364 It is an interface to the L<scrub(1)> program. See that
3365 manual page for more details.");
3367 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3368 [InitScratchFS, Always, TestRun (
3369 [["mkdir"; "/mkdtemp"];
3370 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3371 "create a temporary directory",
3373 This command creates a temporary directory. The
3374 C<template> parameter should be a full pathname for the
3375 temporary directory name with the final six characters being
3378 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3379 the second one being suitable for Windows filesystems.
3381 The name of the temporary directory that was created
3384 The temporary directory is created with mode 0700
3385 and is owned by root.
3387 The caller is responsible for deleting the temporary
3388 directory and its contents after use.
3390 See also: L<mkdtemp(3)>");
3392 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3393 [InitISOFS, Always, TestOutputInt (
3394 [["wc_l"; "/10klines"]], 10000);
3395 (* Test for RHBZ#579608, absolute symbolic links. *)
3396 InitISOFS, Always, TestOutputInt (
3397 [["wc_l"; "/abssymlink"]], 10000)],
3398 "count lines in a file",
3400 This command counts the lines in a file, using the
3401 C<wc -l> external command.");
3403 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3404 [InitISOFS, Always, TestOutputInt (
3405 [["wc_w"; "/10klines"]], 10000)],
3406 "count words in a file",
3408 This command counts the words in a file, using the
3409 C<wc -w> external command.");
3411 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3412 [InitISOFS, Always, TestOutputInt (
3413 [["wc_c"; "/100kallspaces"]], 102400)],
3414 "count characters in a file",
3416 This command counts the characters in a file, using the
3417 C<wc -c> external command.");
3419 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3420 [InitISOFS, Always, TestOutputList (
3421 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3422 (* Test for RHBZ#579608, absolute symbolic links. *)
3423 InitISOFS, Always, TestOutputList (
3424 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3425 "return first 10 lines of a file",
3427 This command returns up to the first 10 lines of a file as
3428 a list of strings.");
3430 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3431 [InitISOFS, Always, TestOutputList (
3432 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3433 InitISOFS, Always, TestOutputList (
3434 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3435 InitISOFS, Always, TestOutputList (
3436 [["head_n"; "0"; "/10klines"]], [])],
3437 "return first N lines of a file",
3439 If the parameter C<nrlines> is a positive number, this returns the first
3440 C<nrlines> lines of the file C<path>.
3442 If the parameter C<nrlines> is a negative number, this returns lines
3443 from the file C<path>, excluding the last C<nrlines> lines.
3445 If the parameter C<nrlines> is zero, this returns an empty list.");
3447 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3448 [InitISOFS, Always, TestOutputList (
3449 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3450 "return last 10 lines of a file",
3452 This command returns up to the last 10 lines of a file as
3453 a list of strings.");
3455 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3456 [InitISOFS, Always, TestOutputList (
3457 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3458 InitISOFS, Always, TestOutputList (
3459 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3460 InitISOFS, Always, TestOutputList (
3461 [["tail_n"; "0"; "/10klines"]], [])],
3462 "return last N lines of a file",
3464 If the parameter C<nrlines> is a positive number, this returns the last
3465 C<nrlines> lines of the file C<path>.
3467 If the parameter C<nrlines> is a negative number, this returns lines
3468 from the file C<path>, starting with the C<-nrlines>th line.
3470 If the parameter C<nrlines> is zero, this returns an empty list.");
3472 ("df", (RString "output", [], []), 125, [],
3473 [], (* XXX Tricky to test because it depends on the exact format
3474 * of the 'df' command and other imponderables.
3476 "report file system disk space usage",
3478 This command runs the C<df> command to report disk space used.
3480 This command is mostly useful for interactive sessions. It
3481 is I<not> intended that you try to parse the output string.
3482 Use C<guestfs_statvfs> from programs.");
3484 ("df_h", (RString "output", [], []), 126, [],
3485 [], (* XXX Tricky to test because it depends on the exact format
3486 * of the 'df' command and other imponderables.
3488 "report file system disk space usage (human readable)",
3490 This command runs the C<df -h> command to report disk space used
3491 in human-readable format.
3493 This command is mostly useful for interactive sessions. It
3494 is I<not> intended that you try to parse the output string.
3495 Use C<guestfs_statvfs> from programs.");
3497 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3498 [InitISOFS, Always, TestOutputInt (
3499 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3500 "estimate file space usage",
3502 This command runs the C<du -s> command to estimate file space
3505 C<path> can be a file or a directory. If C<path> is a directory
3506 then the estimate includes the contents of the directory and all
3507 subdirectories (recursively).
3509 The result is the estimated size in I<kilobytes>
3510 (ie. units of 1024 bytes).");
3512 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3513 [InitISOFS, Always, TestOutputList (
3514 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3515 "list files in an initrd",
3517 This command lists out files contained in an initrd.
3519 The files are listed without any initial C</> character. The
3520 files are listed in the order they appear (not necessarily
3521 alphabetical). Directory names are listed as separate items.
3523 Old Linux kernels (2.4 and earlier) used a compressed ext2
3524 filesystem as initrd. We I<only> support the newer initramfs
3525 format (compressed cpio files).");
3527 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3529 "mount a file using the loop device",
3531 This command lets you mount C<file> (a filesystem image
3532 in a file) on a mount point. It is entirely equivalent to
3533 the command C<mount -o loop file mountpoint>.");
3535 ("mkswap", (RErr, [Device "device"], []), 130, [],
3536 [InitEmpty, Always, TestRun (
3537 [["part_disk"; "/dev/sda"; "mbr"];
3538 ["mkswap"; "/dev/sda1"]])],
3539 "create a swap partition",
3541 Create a swap partition on C<device>.");
3543 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3544 [InitEmpty, Always, TestRun (
3545 [["part_disk"; "/dev/sda"; "mbr"];
3546 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3547 "create a swap partition with a label",
3549 Create a swap partition on C<device> with label C<label>.
3551 Note that you cannot attach a swap label to a block device
3552 (eg. C</dev/sda>), just to a partition. This appears to be
3553 a limitation of the kernel or swap tools.");
3555 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3556 (let uuid = uuidgen () in
3557 [InitEmpty, Always, TestRun (
3558 [["part_disk"; "/dev/sda"; "mbr"];
3559 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3560 "create a swap partition with an explicit UUID",
3562 Create a swap partition on C<device> with UUID C<uuid>.");
3564 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3565 [InitScratchFS, Always, TestOutputStruct (
3566 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3567 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3568 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3569 InitScratchFS, Always, TestOutputStruct (
3570 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3571 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3572 "make block, character or FIFO devices",
3574 This call creates block or character special devices, or
3575 named pipes (FIFOs).
3577 The C<mode> parameter should be the mode, using the standard
3578 constants. C<devmajor> and C<devminor> are the
3579 device major and minor numbers, only used when creating block
3580 and character special devices.
3582 Note that, just like L<mknod(2)>, the mode must be bitwise
3583 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3584 just creates a regular file). These constants are
3585 available in the standard Linux header files, or you can use
3586 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3587 which are wrappers around this command which bitwise OR
3588 in the appropriate constant for you.
3590 The mode actually set is affected by the umask.");
3592 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3593 [InitScratchFS, Always, TestOutputStruct (
3594 [["mkfifo"; "0o777"; "/mkfifo"];
3595 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3596 "make FIFO (named pipe)",
3598 This call creates a FIFO (named pipe) called C<path> with
3599 mode C<mode>. It is just a convenient wrapper around
3602 The mode actually set is affected by the umask.");
3604 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3605 [InitScratchFS, Always, TestOutputStruct (
3606 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3607 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3608 "make block device node",
3610 This call creates a block device node called C<path> with
3611 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3612 It is just a convenient wrapper around C<guestfs_mknod>.
3614 The mode actually set is affected by the umask.");
3616 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3617 [InitScratchFS, Always, TestOutputStruct (
3618 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3619 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3620 "make char device node",
3622 This call creates a char device node called C<path> with
3623 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3624 It is just a convenient wrapper around C<guestfs_mknod>.
3626 The mode actually set is affected by the umask.");
3628 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3629 [InitEmpty, Always, TestOutputInt (
3630 [["umask"; "0o22"]], 0o22)],
3631 "set file mode creation mask (umask)",
3633 This function sets the mask used for creating new files and
3634 device nodes to C<mask & 0777>.
3636 Typical umask values would be C<022> which creates new files
3637 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3638 C<002> which creates new files with permissions like
3639 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3641 The default umask is C<022>. This is important because it
3642 means that directories and device nodes will be created with
3643 C<0644> or C<0755> mode even if you specify C<0777>.
3645 See also C<guestfs_get_umask>,
3646 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3648 This call returns the previous umask.");
3650 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3652 "read directories entries",
3654 This returns the list of directory entries in directory C<dir>.
3656 All entries in the directory are returned, including C<.> and
3657 C<..>. The entries are I<not> sorted, but returned in the same
3658 order as the underlying filesystem.
3660 Also this call returns basic file type information about each
3661 file. The C<ftyp> field will contain one of the following characters:
3699 The L<readdir(3)> call returned a C<d_type> field with an
3704 This function is primarily intended for use by programs. To
3705 get a simple list of names, use C<guestfs_ls>. To get a printable
3706 directory for human consumption, use C<guestfs_ll>.");
3708 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3710 "create partitions on a block device",
3712 This is a simplified interface to the C<guestfs_sfdisk>
3713 command, where partition sizes are specified in megabytes
3714 only (rounded to the nearest cylinder) and you don't need
3715 to specify the cyls, heads and sectors parameters which
3716 were rarely if ever used anyway.
3718 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3719 and C<guestfs_part_disk>");
3721 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3723 "determine file type inside a compressed file",
3725 This command runs C<file> after first decompressing C<path>
3728 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3730 Since 1.0.63, use C<guestfs_file> instead which can now
3731 process compressed files.");
3733 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3735 "list extended attributes of a file or directory",
3737 This call lists the extended attributes of the file or directory
3740 At the system call level, this is a combination of the
3741 L<listxattr(2)> and L<getxattr(2)> calls.
3743 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3745 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3747 "list extended attributes of a file or directory",
3749 This is the same as C<guestfs_getxattrs>, but if C<path>
3750 is a symbolic link, then it returns the extended attributes
3751 of the link itself.");
3753 ("setxattr", (RErr, [String "xattr";
3754 String "val"; Int "vallen"; (* will be BufferIn *)
3755 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3757 "set extended attribute of a file or directory",
3759 This call sets the extended attribute named C<xattr>
3760 of the file C<path> to the value C<val> (of length C<vallen>).
3761 The value is arbitrary 8 bit data.
3763 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3765 ("lsetxattr", (RErr, [String "xattr";
3766 String "val"; Int "vallen"; (* will be BufferIn *)
3767 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3769 "set extended attribute of a file or directory",
3771 This is the same as C<guestfs_setxattr>, but if C<path>
3772 is a symbolic link, then it sets an extended attribute
3773 of the link itself.");
3775 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3777 "remove extended attribute of a file or directory",
3779 This call removes the extended attribute named C<xattr>
3780 of the file C<path>.
3782 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3784 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3786 "remove extended attribute of a file or directory",
3788 This is the same as C<guestfs_removexattr>, but if C<path>
3789 is a symbolic link, then it removes an extended attribute
3790 of the link itself.");
3792 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3796 This call is similar to C<guestfs_mounts>. That call returns
3797 a list of devices. This one returns a hash table (map) of
3798 device name to directory where the device is mounted.");
3800 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3801 (* This is a special case: while you would expect a parameter
3802 * of type "Pathname", that doesn't work, because it implies
3803 * NEED_ROOT in the generated calling code in stubs.c, and
3804 * this function cannot use NEED_ROOT.
3807 "create a mountpoint",
3809 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3810 specialized calls that can be used to create extra mountpoints
3811 before mounting the first filesystem.
3813 These calls are I<only> necessary in some very limited circumstances,
3814 mainly the case where you want to mount a mix of unrelated and/or
3815 read-only filesystems together.
3817 For example, live CDs often contain a \"Russian doll\" nest of
3818 filesystems, an ISO outer layer, with a squashfs image inside, with
3819 an ext2/3 image inside that. You can unpack this as follows
3822 add-ro Fedora-11-i686-Live.iso
3826 mkmountpoint /ext3fs
3828 mount-loop /cd/LiveOS/squashfs.img /sqsh
3829 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3831 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3833 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3834 You may get unexpected errors if you try to mix these calls. It is
3835 safest to manually unmount filesystems and remove mountpoints after use.
3837 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3838 longest first, so for this to work for manual mountpoints, you
3839 must ensure that the innermost mountpoints have the longest
3840 pathnames, as in the example code above.
3842 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3844 Autosync [see C<guestfs_set_autosync>, this is set by default on
3845 handles] means that C<guestfs_umount_all> is called when the handle
3846 is closed which can also trigger these issues.");
3848 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3850 "remove a mountpoint",
3852 This calls removes a mountpoint that was previously created
3853 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3854 for full details.");
3856 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3857 [InitISOFS, Always, TestOutputBuffer (
3858 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3859 (* Test various near large, large and too large files (RHBZ#589039). *)
3860 InitScratchFS, Always, TestLastFail (
3861 [["touch"; "/read_file"];
3862 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3863 ["read_file"; "/read_file"]]);
3864 InitScratchFS, Always, TestLastFail (
3865 [["touch"; "/read_file2"];
3866 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3867 ["read_file"; "/read_file2"]]);
3868 InitScratchFS, Always, TestLastFail (
3869 [["touch"; "/read_file3"];
3870 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3871 ["read_file"; "/read_file3"]])],
3874 This calls returns the contents of the file C<path> as a
3877 Unlike C<guestfs_cat>, this function can correctly
3878 handle files that contain embedded ASCII NUL characters.
3879 However unlike C<guestfs_download>, this function is limited
3880 in the total size of file that can be handled.");
3882 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3883 [InitISOFS, Always, TestOutputList (
3884 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3885 InitISOFS, Always, TestOutputList (
3886 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3887 (* Test for RHBZ#579608, absolute symbolic links. *)
3888 InitISOFS, Always, TestOutputList (
3889 [["grep"; "nomatch"; "/abssymlink"]], [])],
3890 "return lines matching a pattern",
3892 This calls the external C<grep> program and returns the
3895 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3896 [InitISOFS, Always, TestOutputList (
3897 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3898 "return lines matching a pattern",
3900 This calls the external C<egrep> program and returns the
3903 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3904 [InitISOFS, Always, TestOutputList (
3905 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3906 "return lines matching a pattern",
3908 This calls the external C<fgrep> program and returns the
3911 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3912 [InitISOFS, Always, TestOutputList (
3913 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3914 "return lines matching a pattern",
3916 This calls the external C<grep -i> program and returns the
3919 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3920 [InitISOFS, Always, TestOutputList (
3921 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3922 "return lines matching a pattern",
3924 This calls the external C<egrep -i> program and returns the
3927 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3928 [InitISOFS, Always, TestOutputList (
3929 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3930 "return lines matching a pattern",
3932 This calls the external C<fgrep -i> program and returns the
3935 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3936 [InitISOFS, Always, TestOutputList (
3937 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3938 "return lines matching a pattern",
3940 This calls the external C<zgrep> program and returns the
3943 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3944 [InitISOFS, Always, TestOutputList (
3945 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3946 "return lines matching a pattern",
3948 This calls the external C<zegrep> program and returns the
3951 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
3952 [InitISOFS, Always, TestOutputList (
3953 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3954 "return lines matching a pattern",
3956 This calls the external C<zfgrep> program and returns the
3959 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
3960 [InitISOFS, Always, TestOutputList (
3961 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3962 "return lines matching a pattern",
3964 This calls the external C<zgrep -i> program and returns the
3967 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
3968 [InitISOFS, Always, TestOutputList (
3969 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3970 "return lines matching a pattern",
3972 This calls the external C<zegrep -i> program and returns the
3975 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
3976 [InitISOFS, Always, TestOutputList (
3977 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3978 "return lines matching a pattern",
3980 This calls the external C<zfgrep -i> program and returns the
3983 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
3984 [InitISOFS, Always, TestOutput (
3985 [["realpath"; "/../directory"]], "/directory")],
3986 "canonicalized absolute pathname",
3988 Return the canonicalized absolute pathname of C<path>. The
3989 returned path has no C<.>, C<..> or symbolic link path elements.");
3991 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
3992 [InitScratchFS, Always, TestOutputStruct (
3995 ["ln"; "/ln/a"; "/ln/b"];
3996 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
3997 "create a hard link",
3999 This command creates a hard link using the C<ln> command.");
4001 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4002 [InitScratchFS, Always, TestOutputStruct (
4003 [["mkdir"; "/ln_f"];
4004 ["touch"; "/ln_f/a"];
4005 ["touch"; "/ln_f/b"];
4006 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4007 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4008 "create a hard link",
4010 This command creates a hard link using the C<ln -f> command.
4011 The C<-f> option removes the link (C<linkname>) if it exists already.");
4013 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4014 [InitScratchFS, Always, TestOutputStruct (
4015 [["mkdir"; "/ln_s"];
4016 ["touch"; "/ln_s/a"];
4017 ["ln_s"; "a"; "/ln_s/b"];
4018 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4019 "create a symbolic link",
4021 This command creates a symbolic link using the C<ln -s> command.");
4023 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4024 [InitScratchFS, Always, TestOutput (
4025 [["mkdir_p"; "/ln_sf/b"];
4026 ["touch"; "/ln_sf/b/c"];
4027 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4028 ["readlink"; "/ln_sf/b/c"]], "../d")],
4029 "create a symbolic link",
4031 This command creates a symbolic link using the C<ln -sf> command,
4032 The C<-f> option removes the link (C<linkname>) if it exists already.");
4034 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4035 [] (* XXX tested above *),
4036 "read the target of a symbolic link",
4038 This command reads the target of a symbolic link.");
4040 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4041 [InitScratchFS, Always, TestOutputStruct (
4042 [["fallocate"; "/fallocate"; "1000000"];
4043 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4044 "preallocate a file in the guest filesystem",
4046 This command preallocates a file (containing zero bytes) named
4047 C<path> of size C<len> bytes. If the file exists already, it
4050 Do not confuse this with the guestfish-specific
4051 C<alloc> command which allocates a file in the host and
4052 attaches it as a device.");
4054 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4055 [InitPartition, Always, TestRun (
4056 [["mkswap"; "/dev/sda1"];
4057 ["swapon_device"; "/dev/sda1"];
4058 ["swapoff_device"; "/dev/sda1"]])],
4059 "enable swap on device",
4061 This command enables the libguestfs appliance to use the
4062 swap device or partition named C<device>. The increased
4063 memory is made available for all commands, for example
4064 those run using C<guestfs_command> or C<guestfs_sh>.
4066 Note that you should not swap to existing guest swap
4067 partitions unless you know what you are doing. They may
4068 contain hibernation information, or other information that
4069 the guest doesn't want you to trash. You also risk leaking
4070 information about the host to the guest this way. Instead,
4071 attach a new host device to the guest and swap on that.");
4073 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4074 [], (* XXX tested by swapon_device *)
4075 "disable swap on device",
4077 This command disables the libguestfs appliance swap
4078 device or partition named C<device>.
4079 See C<guestfs_swapon_device>.");
4081 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4082 [InitScratchFS, Always, TestRun (
4083 [["fallocate"; "/swapon_file"; "8388608"];
4084 ["mkswap_file"; "/swapon_file"];
4085 ["swapon_file"; "/swapon_file"];
4086 ["swapoff_file"; "/swapon_file"];
4087 ["rm"; "/swapon_file"]])],
4088 "enable swap on file",
4090 This command enables swap to a file.
4091 See C<guestfs_swapon_device> for other notes.");
4093 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4094 [], (* XXX tested by swapon_file *)
4095 "disable swap on file",
4097 This command disables the libguestfs appliance swap on file.");
4099 ("swapon_label", (RErr, [String "label"], []), 174, [],
4100 [InitEmpty, Always, TestRun (
4101 [["part_disk"; "/dev/sda"; "mbr"];
4102 ["mkswap_L"; "swapit"; "/dev/sda1"];
4103 ["swapon_label"; "swapit"];
4104 ["swapoff_label"; "swapit"];
4105 ["zero"; "/dev/sda"];
4106 ["blockdev_rereadpt"; "/dev/sda"]])],
4107 "enable swap on labeled swap partition",
4109 This command enables swap to a labeled swap partition.
4110 See C<guestfs_swapon_device> for other notes.");
4112 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4113 [], (* XXX tested by swapon_label *)
4114 "disable swap on labeled swap partition",
4116 This command disables the libguestfs appliance swap on
4117 labeled swap partition.");
4119 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4120 (let uuid = uuidgen () in
4121 [InitEmpty, Always, TestRun (
4122 [["mkswap_U"; uuid; "/dev/sdc"];
4123 ["swapon_uuid"; uuid];
4124 ["swapoff_uuid"; uuid]])]),
4125 "enable swap on swap partition by UUID",
4127 This command enables swap to a swap partition with the given UUID.
4128 See C<guestfs_swapon_device> for other notes.");
4130 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4131 [], (* XXX tested by swapon_uuid *)
4132 "disable swap on swap partition by UUID",
4134 This command disables the libguestfs appliance swap partition
4135 with the given UUID.");
4137 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4138 [InitScratchFS, Always, TestRun (
4139 [["fallocate"; "/mkswap_file"; "8388608"];
4140 ["mkswap_file"; "/mkswap_file"];
4141 ["rm"; "/mkswap_file"]])],
4142 "create a swap file",
4146 This command just writes a swap file signature to an existing
4147 file. To create the file itself, use something like C<guestfs_fallocate>.");
4149 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4150 [InitISOFS, Always, TestRun (
4151 [["inotify_init"; "0"]])],
4152 "create an inotify handle",
4154 This command creates a new inotify handle.
4155 The inotify subsystem can be used to notify events which happen to
4156 objects in the guest filesystem.
4158 C<maxevents> is the maximum number of events which will be
4159 queued up between calls to C<guestfs_inotify_read> or
4160 C<guestfs_inotify_files>.
4161 If this is passed as C<0>, then the kernel (or previously set)
4162 default is used. For Linux 2.6.29 the default was 16384 events.
4163 Beyond this limit, the kernel throws away events, but records
4164 the fact that it threw them away by setting a flag
4165 C<IN_Q_OVERFLOW> in the returned structure list (see
4166 C<guestfs_inotify_read>).
4168 Before any events are generated, you have to add some
4169 watches to the internal watch list. See:
4170 C<guestfs_inotify_add_watch>,
4171 C<guestfs_inotify_rm_watch> and
4172 C<guestfs_inotify_watch_all>.
4174 Queued up events should be read periodically by calling
4175 C<guestfs_inotify_read>
4176 (or C<guestfs_inotify_files> which is just a helpful
4177 wrapper around C<guestfs_inotify_read>). If you don't
4178 read the events out often enough then you risk the internal
4181 The handle should be closed after use by calling
4182 C<guestfs_inotify_close>. This also removes any
4183 watches automatically.
4185 See also L<inotify(7)> for an overview of the inotify interface
4186 as exposed by the Linux kernel, which is roughly what we expose
4187 via libguestfs. Note that there is one global inotify handle
4188 per libguestfs instance.");
4190 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4191 [InitScratchFS, Always, TestOutputList (
4192 [["mkdir"; "/inotify_add_watch"];
4193 ["inotify_init"; "0"];
4194 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4195 ["touch"; "/inotify_add_watch/a"];
4196 ["touch"; "/inotify_add_watch/b"];
4197 ["inotify_files"]], ["a"; "b"])],
4198 "add an inotify watch",
4200 Watch C<path> for the events listed in C<mask>.
4202 Note that if C<path> is a directory then events within that
4203 directory are watched, but this does I<not> happen recursively
4204 (in subdirectories).
4206 Note for non-C or non-Linux callers: the inotify events are
4207 defined by the Linux kernel ABI and are listed in
4208 C</usr/include/sys/inotify.h>.");
4210 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4212 "remove an inotify watch",
4214 Remove a previously defined inotify watch.
4215 See C<guestfs_inotify_add_watch>.");
4217 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4219 "return list of inotify events",
4221 Return the complete queue of events that have happened
4222 since the previous read call.
4224 If no events have happened, this returns an empty list.
4226 I<Note>: In order to make sure that all events have been
4227 read, you must call this function repeatedly until it
4228 returns an empty list. The reason is that the call will
4229 read events up to the maximum appliance-to-host message
4230 size and leave remaining events in the queue.");
4232 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4234 "return list of watched files that had events",
4236 This function is a helpful wrapper around C<guestfs_inotify_read>
4237 which just returns a list of pathnames of objects that were
4238 touched. The returned pathnames are sorted and deduplicated.");
4240 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4242 "close the inotify handle",
4244 This closes the inotify handle which was previously
4245 opened by inotify_init. It removes all watches, throws
4246 away any pending events, and deallocates all resources.");
4248 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4250 "set SELinux security context",
4252 This sets the SELinux security context of the daemon
4253 to the string C<context>.
4255 See the documentation about SELINUX in L<guestfs(3)>.");
4257 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4259 "get SELinux security context",
4261 This gets the SELinux security context of the daemon.
4263 See the documentation about SELINUX in L<guestfs(3)>,
4264 and C<guestfs_setcon>");
4266 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4267 [InitEmpty, Always, TestOutput (
4268 [["part_disk"; "/dev/sda"; "mbr"];
4269 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4270 ["mount_options"; ""; "/dev/sda1"; "/"];
4271 ["write"; "/new"; "new file contents"];
4272 ["cat"; "/new"]], "new file contents");
4273 InitEmpty, Always, TestRun (
4274 [["part_disk"; "/dev/sda"; "mbr"];
4275 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4276 InitEmpty, Always, TestLastFail (
4277 [["part_disk"; "/dev/sda"; "mbr"];
4278 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4279 InitEmpty, Always, TestLastFail (
4280 [["part_disk"; "/dev/sda"; "mbr"];
4281 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4282 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4283 [["part_disk"; "/dev/sda"; "mbr"];
4284 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4285 "make a filesystem with block size",
4287 This call is similar to C<guestfs_mkfs>, but it allows you to
4288 control the block size of the resulting filesystem. Supported
4289 block sizes depend on the filesystem type, but typically they
4290 are C<1024>, C<2048> or C<4096> only.
4292 For VFAT and NTFS the C<blocksize> parameter is treated as
4293 the requested cluster size.");
4295 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4296 [InitEmpty, Always, TestOutput (
4297 [["part_init"; "/dev/sda"; "mbr"];
4298 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4299 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4300 ["mke2journal"; "4096"; "/dev/sda1"];
4301 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4302 ["mount_options"; ""; "/dev/sda2"; "/"];
4303 ["write"; "/new"; "new file contents"];
4304 ["cat"; "/new"]], "new file contents")],
4305 "make ext2/3/4 external journal",
4307 This creates an ext2 external journal on C<device>. It is equivalent
4310 mke2fs -O journal_dev -b blocksize device");
4312 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4313 [InitEmpty, Always, TestOutput (
4314 [["part_init"; "/dev/sda"; "mbr"];
4315 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4316 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4317 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4318 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4319 ["mount_options"; ""; "/dev/sda2"; "/"];
4320 ["write"; "/new"; "new file contents"];
4321 ["cat"; "/new"]], "new file contents")],
4322 "make ext2/3/4 external journal with label",
4324 This creates an ext2 external journal on C<device> with label C<label>.");
4326 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4327 (let uuid = uuidgen () in
4328 [InitEmpty, Always, TestOutput (
4329 [["part_init"; "/dev/sda"; "mbr"];
4330 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4331 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4332 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4333 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4334 ["mount_options"; ""; "/dev/sda2"; "/"];
4335 ["write"; "/new"; "new file contents"];
4336 ["cat"; "/new"]], "new file contents")]),
4337 "make ext2/3/4 external journal with UUID",
4339 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4341 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4343 "make ext2/3/4 filesystem with external journal",
4345 This creates an ext2/3/4 filesystem on C<device> with
4346 an external journal on C<journal>. It is equivalent
4349 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4351 See also C<guestfs_mke2journal>.");
4353 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4355 "make ext2/3/4 filesystem with external journal",
4357 This creates an ext2/3/4 filesystem on C<device> with
4358 an external journal on the journal labeled C<label>.
4360 See also C<guestfs_mke2journal_L>.");
4362 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4364 "make ext2/3/4 filesystem with external journal",
4366 This creates an ext2/3/4 filesystem on C<device> with
4367 an external journal on the journal with UUID C<uuid>.
4369 See also C<guestfs_mke2journal_U>.");
4371 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4372 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4373 "load a kernel module",
4375 This loads a kernel module in the appliance.
4377 The kernel module must have been whitelisted when libguestfs
4378 was built (see C<appliance/kmod.whitelist.in> in the source).");
4380 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4381 [InitNone, Always, TestOutput (
4382 [["echo_daemon"; "This is a test"]], "This is a test"
4384 "echo arguments back to the client",
4386 This command concatenates the list of C<words> passed with single spaces
4387 between them and returns the resulting string.
4389 You can use this command to test the connection through to the daemon.
4391 See also C<guestfs_ping_daemon>.");
4393 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4394 [], (* There is a regression test for this. *)
4395 "find all files and directories, returning NUL-separated list",
4397 This command lists out all files and directories, recursively,
4398 starting at C<directory>, placing the resulting list in the
4399 external file called C<files>.
4401 This command works the same way as C<guestfs_find> with the
4402 following exceptions:
4408 The resulting list is written to an external file.
4412 Items (filenames) in the result are separated
4413 by C<\\0> characters. See L<find(1)> option I<-print0>.
4417 This command is not limited in the number of names that it
4422 The result list is not sorted.
4426 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4427 [InitISOFS, Always, TestOutput (
4428 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4429 InitISOFS, Always, TestOutput (
4430 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4431 InitISOFS, Always, TestOutput (
4432 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4433 InitISOFS, Always, TestLastFail (
4434 [["case_sensitive_path"; "/Known-1/"]]);
4435 InitScratchFS, Always, TestOutput (
4436 [["mkdir"; "/case_sensitive_path"];
4437 ["mkdir"; "/case_sensitive_path/bbb"];
4438 ["touch"; "/case_sensitive_path/bbb/c"];
4439 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4440 InitScratchFS, Always, TestOutput (
4441 [["mkdir"; "/case_sensitive_path2"];
4442 ["mkdir"; "/case_sensitive_path2/bbb"];
4443 ["touch"; "/case_sensitive_path2/bbb/c"];
4444 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4445 InitScratchFS, Always, TestLastFail (
4446 [["mkdir"; "/case_sensitive_path3"];
4447 ["mkdir"; "/case_sensitive_path3/bbb"];
4448 ["touch"; "/case_sensitive_path3/bbb/c"];
4449 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4450 "return true path on case-insensitive filesystem",
4452 This can be used to resolve case insensitive paths on
4453 a filesystem which is case sensitive. The use case is
4454 to resolve paths which you have read from Windows configuration
4455 files or the Windows Registry, to the true path.
4457 The command handles a peculiarity of the Linux ntfs-3g
4458 filesystem driver (and probably others), which is that although
4459 the underlying filesystem is case-insensitive, the driver
4460 exports the filesystem to Linux as case-sensitive.
4462 One consequence of this is that special directories such
4463 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4464 (or other things) depending on the precise details of how
4465 they were created. In Windows itself this would not be
4468 Bug or feature? You decide:
4469 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4471 This function resolves the true case of each element in the
4472 path and returns the case-sensitive path.
4474 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4475 might return C<\"/WINDOWS/system32\"> (the exact return value
4476 would depend on details of how the directories were originally
4477 created under Windows).
4480 This function does not handle drive names, backslashes etc.
4482 See also C<guestfs_realpath>.");
4484 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4485 [InitScratchFS, Always, TestOutput (
4486 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4487 "get the Linux VFS type corresponding to a mounted device",
4489 This command gets the filesystem type corresponding to
4490 the filesystem on C<device>.
4492 For most filesystems, the result is the name of the Linux
4493 VFS module which would be used to mount this filesystem
4494 if you mounted it without specifying the filesystem type.
4495 For example a string such as C<ext3> or C<ntfs>.");
4497 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4498 [InitScratchFS, Always, TestOutputStruct (
4499 [["write"; "/truncate"; "some stuff so size is not zero"];
4500 ["truncate"; "/truncate"];
4501 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4502 "truncate a file to zero size",
4504 This command truncates C<path> to a zero-length file. The
4505 file must exist already.");
4507 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4508 [InitScratchFS, Always, TestOutputStruct (
4509 [["touch"; "/truncate_size"];
4510 ["truncate_size"; "/truncate_size"; "1000"];
4511 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4512 "truncate a file to a particular size",
4514 This command truncates C<path> to size C<size> bytes. The file
4517 If the current file size is less than C<size> then
4518 the file is extended to the required size with zero bytes.
4519 This creates a sparse file (ie. disk blocks are not allocated
4520 for the file until you write to it). To create a non-sparse
4521 file of zeroes, use C<guestfs_fallocate64> instead.");
4523 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4524 [InitScratchFS, Always, TestOutputStruct (
4525 [["touch"; "/utimens"];
4526 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4527 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4528 "set timestamp of a file with nanosecond precision",
4530 This command sets the timestamps of a file with nanosecond
4533 C<atsecs, atnsecs> are the last access time (atime) in secs and
4534 nanoseconds from the epoch.
4536 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4537 secs and nanoseconds from the epoch.
4539 If the C<*nsecs> field contains the special value C<-1> then
4540 the corresponding timestamp is set to the current time. (The
4541 C<*secs> field is ignored in this case).
4543 If the C<*nsecs> field contains the special value C<-2> then
4544 the corresponding timestamp is left unchanged. (The
4545 C<*secs> field is ignored in this case).");
4547 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4548 [InitScratchFS, Always, TestOutputStruct (
4549 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4550 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4551 "create a directory with a particular mode",
4553 This command creates a directory, setting the initial permissions
4554 of the directory to C<mode>.
4556 For common Linux filesystems, the actual mode which is set will
4557 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4558 interpret the mode in other ways.
4560 See also C<guestfs_mkdir>, C<guestfs_umask>");
4562 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4564 "change file owner and group",
4566 Change the file owner to C<owner> and group to C<group>.
4567 This is like C<guestfs_chown> but if C<path> is a symlink then
4568 the link itself is changed, not the target.
4570 Only numeric uid and gid are supported. If you want to use
4571 names, you will need to locate and parse the password file
4572 yourself (Augeas support makes this relatively easy).");
4574 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4576 "lstat on multiple files",
4578 This call allows you to perform the C<guestfs_lstat> operation
4579 on multiple files, where all files are in the directory C<path>.
4580 C<names> is the list of files from this directory.
4582 On return you get a list of stat structs, with a one-to-one
4583 correspondence to the C<names> list. If any name did not exist
4584 or could not be lstat'd, then the C<ino> field of that structure
4587 This call is intended for programs that want to efficiently
4588 list a directory contents without making many round-trips.
4589 See also C<guestfs_lxattrlist> for a similarly efficient call
4590 for getting extended attributes. Very long directory listings
4591 might cause the protocol message size to be exceeded, causing
4592 this call to fail. The caller must split up such requests
4593 into smaller groups of names.");
4595 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4597 "lgetxattr on multiple files",
4599 This call allows you to get the extended attributes
4600 of multiple files, where all files are in the directory C<path>.
4601 C<names> is the list of files from this directory.
4603 On return you get a flat list of xattr structs which must be
4604 interpreted sequentially. The first xattr struct always has a zero-length
4605 C<attrname>. C<attrval> in this struct is zero-length
4606 to indicate there was an error doing C<lgetxattr> for this
4607 file, I<or> is a C string which is a decimal number
4608 (the number of following attributes for this file, which could
4609 be C<\"0\">). Then after the first xattr struct are the
4610 zero or more attributes for the first named file.
4611 This repeats for the second and subsequent files.
4613 This call is intended for programs that want to efficiently
4614 list a directory contents without making many round-trips.
4615 See also C<guestfs_lstatlist> for a similarly efficient call
4616 for getting standard stats. Very long directory listings
4617 might cause the protocol message size to be exceeded, causing
4618 this call to fail. The caller must split up such requests
4619 into smaller groups of names.");
4621 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4623 "readlink on multiple files",
4625 This call allows you to do a C<readlink> operation
4626 on multiple files, where all files are in the directory C<path>.
4627 C<names> is the list of files from this directory.
4629 On return you get a list of strings, with a one-to-one
4630 correspondence to the C<names> list. Each string is the
4631 value of the symbolic link.
4633 If the C<readlink(2)> operation fails on any name, then
4634 the corresponding result string is the empty string C<\"\">.
4635 However the whole operation is completed even if there
4636 were C<readlink(2)> errors, and so you can call this
4637 function with names where you don't know if they are
4638 symbolic links already (albeit slightly less efficient).
4640 This call is intended for programs that want to efficiently
4641 list a directory contents without making many round-trips.
4642 Very long directory listings might cause the protocol
4643 message size to be exceeded, causing
4644 this call to fail. The caller must split up such requests
4645 into smaller groups of names.");
4647 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4648 [InitISOFS, Always, TestOutputBuffer (
4649 [["pread"; "/known-4"; "1"; "3"]], "\n");
4650 InitISOFS, Always, TestOutputBuffer (
4651 [["pread"; "/empty"; "0"; "100"]], "")],
4652 "read part of a file",
4654 This command lets you read part of a file. It reads C<count>
4655 bytes of the file, starting at C<offset>, from file C<path>.
4657 This may read fewer bytes than requested. For further details
4658 see the L<pread(2)> system call.
4660 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4662 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4663 [InitEmpty, Always, TestRun (
4664 [["part_init"; "/dev/sda"; "gpt"]])],
4665 "create an empty partition table",
4667 This creates an empty partition table on C<device> of one of the
4668 partition types listed below. Usually C<parttype> should be
4669 either C<msdos> or C<gpt> (for large disks).
4671 Initially there are no partitions. Following this, you should
4672 call C<guestfs_part_add> for each partition required.
4674 Possible values for C<parttype> are:
4678 =item B<efi> | B<gpt>
4680 Intel EFI / GPT partition table.
4682 This is recommended for >= 2 TB partitions that will be accessed
4683 from Linux and Intel-based Mac OS X. It also has limited backwards
4684 compatibility with the C<mbr> format.
4686 =item B<mbr> | B<msdos>
4688 The standard PC \"Master Boot Record\" (MBR) format used
4689 by MS-DOS and Windows. This partition type will B<only> work
4690 for device sizes up to 2 TB. For large disks we recommend
4695 Other partition table types that may work but are not
4704 =item B<amiga> | B<rdb>
4706 Amiga \"Rigid Disk Block\" format.
4714 DASD, used on IBM mainframes.
4722 Old Mac partition format. Modern Macs use C<gpt>.
4726 NEC PC-98 format, common in Japan apparently.
4734 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4735 [InitEmpty, Always, TestRun (
4736 [["part_init"; "/dev/sda"; "mbr"];
4737 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4738 InitEmpty, Always, TestRun (
4739 [["part_init"; "/dev/sda"; "gpt"];
4740 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4741 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4742 InitEmpty, Always, TestRun (
4743 [["part_init"; "/dev/sda"; "mbr"];
4744 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4745 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4746 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4747 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4748 "add a partition to the device",
4750 This command adds a partition to C<device>. If there is no partition
4751 table on the device, call C<guestfs_part_init> first.
4753 The C<prlogex> parameter is the type of partition. Normally you
4754 should pass C<p> or C<primary> here, but MBR partition tables also
4755 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4758 C<startsect> and C<endsect> are the start and end of the partition
4759 in I<sectors>. C<endsect> may be negative, which means it counts
4760 backwards from the end of the disk (C<-1> is the last sector).
4762 Creating a partition which covers the whole disk is not so easy.
4763 Use C<guestfs_part_disk> to do that.");
4765 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4766 [InitEmpty, Always, TestRun (
4767 [["part_disk"; "/dev/sda"; "mbr"]]);
4768 InitEmpty, Always, TestRun (
4769 [["part_disk"; "/dev/sda"; "gpt"]])],
4770 "partition whole disk with a single primary partition",
4772 This command is simply a combination of C<guestfs_part_init>
4773 followed by C<guestfs_part_add> to create a single primary partition
4774 covering the whole disk.
4776 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4777 but other possible values are described in C<guestfs_part_init>.");
4779 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4780 [InitEmpty, Always, TestRun (
4781 [["part_disk"; "/dev/sda"; "mbr"];
4782 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4783 "make a partition bootable",
4785 This sets the bootable flag on partition numbered C<partnum> on
4786 device C<device>. Note that partitions are numbered from 1.
4788 The bootable flag is used by some operating systems (notably
4789 Windows) to determine which partition to boot from. It is by
4790 no means universally recognized.");
4792 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4793 [InitEmpty, Always, TestRun (
4794 [["part_disk"; "/dev/sda"; "gpt"];
4795 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4796 "set partition name",
4798 This sets the partition name on partition numbered C<partnum> on
4799 device C<device>. Note that partitions are numbered from 1.
4801 The partition name can only be set on certain types of partition
4802 table. This works on C<gpt> but not on C<mbr> partitions.");
4804 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4805 [], (* XXX Add a regression test for this. *)
4806 "list partitions on a device",
4808 This command parses the partition table on C<device> and
4809 returns the list of partitions found.
4811 The fields in the returned structure are:
4817 Partition number, counting from 1.
4821 Start of the partition I<in bytes>. To get sectors you have to
4822 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4826 End of the partition in bytes.
4830 Size of the partition in bytes.
4834 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4835 [InitEmpty, Always, TestOutput (
4836 [["part_disk"; "/dev/sda"; "gpt"];
4837 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4838 "get the partition table type",
4840 This command examines the partition table on C<device> and
4841 returns the partition table type (format) being used.
4843 Common return values include: C<msdos> (a DOS/Windows style MBR
4844 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4845 values are possible, although unusual. See C<guestfs_part_init>
4848 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4849 [InitScratchFS, Always, TestOutputBuffer (
4850 [["fill"; "0x63"; "10"; "/fill"];
4851 ["read_file"; "/fill"]], "cccccccccc")],
4852 "fill a file with octets",
4854 This command creates a new file called C<path>. The initial
4855 content of the file is C<len> octets of C<c>, where C<c>
4856 must be a number in the range C<[0..255]>.
4858 To fill a file with zero bytes (sparsely), it is
4859 much more efficient to use C<guestfs_truncate_size>.
4860 To create a file with a pattern of repeating bytes
4861 use C<guestfs_fill_pattern>.");
4863 ("available", (RErr, [StringList "groups"], []), 216, [],
4864 [InitNone, Always, TestRun [["available"; ""]]],
4865 "test availability of some parts of the API",
4867 This command is used to check the availability of some
4868 groups of functionality in the appliance, which not all builds of
4869 the libguestfs appliance will be able to provide.
4871 The libguestfs groups, and the functions that those
4872 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4873 You can also fetch this list at runtime by calling
4874 C<guestfs_available_all_groups>.
4876 The argument C<groups> is a list of group names, eg:
4877 C<[\"inotify\", \"augeas\"]> would check for the availability of
4878 the Linux inotify functions and Augeas (configuration file
4881 The command returns no error if I<all> requested groups are available.
4883 It fails with an error if one or more of the requested
4884 groups is unavailable in the appliance.
4886 If an unknown group name is included in the
4887 list of groups then an error is always returned.
4895 You must call C<guestfs_launch> before calling this function.
4897 The reason is because we don't know what groups are
4898 supported by the appliance/daemon until it is running and can
4903 If a group of functions is available, this does not necessarily
4904 mean that they will work. You still have to check for errors
4905 when calling individual API functions even if they are
4910 It is usually the job of distro packagers to build
4911 complete functionality into the libguestfs appliance.
4912 Upstream libguestfs, if built from source with all
4913 requirements satisfied, will support everything.
4917 This call was added in version C<1.0.80>. In previous
4918 versions of libguestfs all you could do would be to speculatively
4919 execute a command to find out if the daemon implemented it.
4920 See also C<guestfs_version>.
4924 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4925 [InitScratchFS, Always, TestOutputBuffer (
4927 ["write"; "/dd/src"; "hello, world"];
4928 ["dd"; "/dd/src"; "/dd/dest"];
4929 ["read_file"; "/dd/dest"]], "hello, world")],
4930 "copy from source to destination using dd",
4932 This command copies from one source device or file C<src>
4933 to another destination device or file C<dest>. Normally you
4934 would use this to copy to or from a device or partition, for
4935 example to duplicate a filesystem.
4937 If the destination is a device, it must be as large or larger
4938 than the source file or device, otherwise the copy will fail.
4939 This command cannot do partial copies (see C<guestfs_copy_size>).");
4941 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4942 [InitScratchFS, Always, TestOutputInt (
4943 [["write"; "/filesize"; "hello, world"];
4944 ["filesize"; "/filesize"]], 12)],
4945 "return the size of the file in bytes",
4947 This command returns the size of C<file> in bytes.
4949 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4950 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4951 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4953 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
4954 [InitBasicFSonLVM, Always, TestOutputList (
4955 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4956 ["lvs"]], ["/dev/VG/LV2"])],
4957 "rename an LVM logical volume",
4959 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4961 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
4962 [InitBasicFSonLVM, Always, TestOutputList (
4964 ["vg_activate"; "false"; "VG"];
4965 ["vgrename"; "VG"; "VG2"];
4966 ["vg_activate"; "true"; "VG2"];
4967 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4968 ["vgs"]], ["VG2"])],
4969 "rename an LVM volume group",
4971 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4973 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
4974 [InitISOFS, Always, TestOutputBuffer (
4975 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4976 "list the contents of a single file in an initrd",
4978 This command unpacks the file C<filename> from the initrd file
4979 called C<initrdpath>. The filename must be given I<without> the
4980 initial C</> character.
4982 For example, in guestfish you could use the following command
4983 to examine the boot script (usually called C</init>)
4984 contained in a Linux initrd or initramfs image:
4986 initrd-cat /boot/initrd-<version>.img init
4988 See also C<guestfs_initrd_list>.");
4990 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
4992 "get the UUID of a physical volume",
4994 This command returns the UUID of the LVM PV C<device>.");
4996 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
4998 "get the UUID of a volume group",
5000 This command returns the UUID of the LVM VG named C<vgname>.");
5002 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5004 "get the UUID of a logical volume",
5006 This command returns the UUID of the LVM LV C<device>.");
5008 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5010 "get the PV UUIDs containing the volume group",
5012 Given a VG called C<vgname>, this returns the UUIDs of all
5013 the physical volumes that this volume group resides on.
5015 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5016 calls to associate physical volumes and volume groups.
5018 See also C<guestfs_vglvuuids>.");
5020 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5022 "get the LV UUIDs of all LVs in the volume group",
5024 Given a VG called C<vgname>, this returns the UUIDs of all
5025 the logical volumes created in this volume group.
5027 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5028 calls to associate logical volumes and volume groups.
5030 See also C<guestfs_vgpvuuids>.");
5032 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5033 [InitScratchFS, Always, TestOutputBuffer (
5034 [["mkdir"; "/copy_size"];
5035 ["write"; "/copy_size/src"; "hello, world"];
5036 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5037 ["read_file"; "/copy_size/dest"]], "hello")],
5038 "copy size bytes from source to destination using dd",
5040 This command copies exactly C<size> bytes from one source device
5041 or file C<src> to another destination device or file C<dest>.
5043 Note this will fail if the source is too short or if the destination
5044 is not large enough.");
5046 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5047 [InitBasicFSonLVM, Always, TestRun (
5048 [["zero_device"; "/dev/VG/LV"]])],
5049 "write zeroes to an entire device",
5051 This command writes zeroes over the entire C<device>. Compare
5052 with C<guestfs_zero> which just zeroes the first few blocks of
5055 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5056 [InitScratchFS, Always, TestOutput (
5057 [["mkdir"; "/txz_in"];
5058 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5059 ["cat"; "/txz_in/hello"]], "hello\n")],
5060 "unpack compressed tarball to directory",
5062 This command uploads and unpacks local file C<tarball> (an
5063 I<xz compressed> tar file) into C<directory>.");
5065 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5067 "pack directory into compressed tarball",
5069 This command packs the contents of C<directory> and downloads
5070 it to local file C<tarball> (as an xz compressed tar archive).");
5072 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5074 "resize an NTFS filesystem",
5076 This command resizes an NTFS filesystem, expanding or
5077 shrinking it to the size of the underlying device.
5078 See also L<ntfsresize(8)>.");
5080 ("vgscan", (RErr, [], []), 232, [],
5081 [InitEmpty, Always, TestRun (
5083 "rescan for LVM physical volumes, volume groups and logical volumes",
5085 This rescans all block devices and rebuilds the list of LVM
5086 physical volumes, volume groups and logical volumes.");
5088 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5089 [InitEmpty, Always, TestRun (
5090 [["part_init"; "/dev/sda"; "mbr"];
5091 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5092 ["part_del"; "/dev/sda"; "1"]])],
5093 "delete a partition",
5095 This command deletes the partition numbered C<partnum> on C<device>.
5097 Note that in the case of MBR partitioning, deleting an
5098 extended partition also deletes any logical partitions
5101 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5102 [InitEmpty, Always, TestOutputTrue (
5103 [["part_init"; "/dev/sda"; "mbr"];
5104 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5105 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5106 ["part_get_bootable"; "/dev/sda"; "1"]])],
5107 "return true if a partition is bootable",
5109 This command returns true if the partition C<partnum> on
5110 C<device> has the bootable flag set.
5112 See also C<guestfs_part_set_bootable>.");
5114 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5115 [InitEmpty, Always, TestOutputInt (
5116 [["part_init"; "/dev/sda"; "mbr"];
5117 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5118 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5119 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5120 "get the MBR type byte (ID byte) from a partition",
5122 Returns the MBR type byte (also known as the ID byte) from
5123 the numbered partition C<partnum>.
5125 Note that only MBR (old DOS-style) partitions have type bytes.
5126 You will get undefined results for other partition table
5127 types (see C<guestfs_part_get_parttype>).");
5129 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5130 [], (* tested by part_get_mbr_id *)
5131 "set the MBR type byte (ID byte) of a partition",
5133 Sets the MBR type byte (also known as the ID byte) of
5134 the numbered partition C<partnum> to C<idbyte>. Note
5135 that the type bytes quoted in most documentation are
5136 in fact hexadecimal numbers, but usually documented
5137 without any leading \"0x\" which might be confusing.
5139 Note that only MBR (old DOS-style) partitions have type bytes.
5140 You will get undefined results for other partition table
5141 types (see C<guestfs_part_get_parttype>).");
5143 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5144 [InitISOFS, Always, TestOutputFileMD5 (
5145 [["checksum_device"; "md5"; "/dev/sdd"]],
5146 "../images/test.iso")],
5147 "compute MD5, SHAx or CRC checksum of the contents of a device",
5149 This call computes the MD5, SHAx or CRC checksum of the
5150 contents of the device named C<device>. For the types of
5151 checksums supported see the C<guestfs_checksum> command.");
5153 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5154 [InitNone, Always, TestRun (
5155 [["part_disk"; "/dev/sda"; "mbr"];
5156 ["pvcreate"; "/dev/sda1"];
5157 ["vgcreate"; "VG"; "/dev/sda1"];
5158 ["lvcreate"; "LV"; "VG"; "10"];
5159 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5160 "expand an LV to fill free space",
5162 This expands an existing logical volume C<lv> so that it fills
5163 C<pc>% of the remaining free space in the volume group. Commonly
5164 you would call this with pc = 100 which expands the logical volume
5165 as much as possible, using all remaining free space in the volume
5168 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5169 [], (* XXX Augeas code needs tests. *)
5170 "clear Augeas path",
5172 Set the value associated with C<path> to C<NULL>. This
5173 is the same as the L<augtool(1)> C<clear> command.");
5175 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5176 [InitEmpty, Always, TestOutputInt (
5177 [["get_umask"]], 0o22)],
5178 "get the current umask",
5180 Return the current umask. By default the umask is C<022>
5181 unless it has been set by calling C<guestfs_umask>.");
5183 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5185 "upload a file to the appliance (internal use only)",
5187 The C<guestfs_debug_upload> command uploads a file to
5188 the libguestfs appliance.
5190 There is no comprehensive help for this command. You have
5191 to look at the file C<daemon/debug.c> in the libguestfs source
5192 to find out what it is for.");
5194 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5195 [InitScratchFS, Always, TestOutput (
5196 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5197 ["cat"; "/base64_in"]], "hello\n")],
5198 "upload base64-encoded data to file",
5200 This command uploads base64-encoded data from C<base64file>
5203 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5205 "download file and encode as base64",
5207 This command downloads the contents of C<filename>, writing
5208 it out to local file C<base64file> encoded as base64.");
5210 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5212 "compute MD5, SHAx or CRC checksum of files in a directory",
5214 This command computes the checksums of all regular files in
5215 C<directory> and then emits a list of those checksums to
5216 the local output file C<sumsfile>.
5218 This can be used for verifying the integrity of a virtual
5219 machine. However to be properly secure you should pay
5220 attention to the output of the checksum command (it uses
5221 the ones from GNU coreutils). In particular when the
5222 filename is not printable, coreutils uses a special
5223 backslash syntax. For more information, see the GNU
5224 coreutils info file.");
5226 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5227 [InitScratchFS, Always, TestOutputBuffer (
5228 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5229 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5230 "fill a file with a repeating pattern of bytes",
5232 This function is like C<guestfs_fill> except that it creates
5233 a new file of length C<len> containing the repeating pattern
5234 of bytes in C<pattern>. The pattern is truncated if necessary
5235 to ensure the length of the file is exactly C<len> bytes.");
5237 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5238 [InitScratchFS, Always, TestOutput (
5239 [["write"; "/write"; "new file contents"];
5240 ["cat"; "/write"]], "new file contents");
5241 InitScratchFS, Always, TestOutput (
5242 [["write"; "/write2"; "\nnew file contents\n"];
5243 ["cat"; "/write2"]], "\nnew file contents\n");
5244 InitScratchFS, Always, TestOutput (
5245 [["write"; "/write3"; "\n\n"];
5246 ["cat"; "/write3"]], "\n\n");
5247 InitScratchFS, Always, TestOutput (
5248 [["write"; "/write4"; ""];
5249 ["cat"; "/write4"]], "");
5250 InitScratchFS, Always, TestOutput (
5251 [["write"; "/write5"; "\n\n\n"];
5252 ["cat"; "/write5"]], "\n\n\n");
5253 InitScratchFS, Always, TestOutput (
5254 [["write"; "/write6"; "\n"];
5255 ["cat"; "/write6"]], "\n")],
5256 "create a new file",
5258 This call creates a file called C<path>. The content of the
5259 file is the string C<content> (which can contain any 8 bit data).");
5261 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5262 [InitScratchFS, Always, TestOutput (
5263 [["write"; "/pwrite"; "new file contents"];
5264 ["pwrite"; "/pwrite"; "data"; "4"];
5265 ["cat"; "/pwrite"]], "new data contents");
5266 InitScratchFS, Always, TestOutput (
5267 [["write"; "/pwrite2"; "new file contents"];
5268 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5269 ["cat"; "/pwrite2"]], "new file is extended");
5270 InitScratchFS, Always, TestOutput (
5271 [["write"; "/pwrite3"; "new file contents"];
5272 ["pwrite"; "/pwrite3"; ""; "4"];
5273 ["cat"; "/pwrite3"]], "new file contents")],
5274 "write to part of a file",
5276 This command writes to part of a file. It writes the data
5277 buffer C<content> to the file C<path> starting at offset C<offset>.
5279 This command implements the L<pwrite(2)> system call, and like
5280 that system call it may not write the full data requested. The
5281 return value is the number of bytes that were actually written
5282 to the file. This could even be 0, although short writes are
5283 unlikely for regular files in ordinary circumstances.
5285 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5287 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5289 "resize an ext2, ext3 or ext4 filesystem (with size)",
5291 This command is the same as C<guestfs_resize2fs> except that it
5292 allows you to specify the new size (in bytes) explicitly.");
5294 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5296 "resize an LVM physical volume (with size)",
5298 This command is the same as C<guestfs_pvresize> except that it
5299 allows you to specify the new size (in bytes) explicitly.");
5301 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5303 "resize an NTFS filesystem (with size)",
5305 This command is the same as C<guestfs_ntfsresize> except that it
5306 allows you to specify the new size (in bytes) explicitly.");
5308 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5309 [InitNone, Always, TestRun [["available_all_groups"]]],
5310 "return a list of all optional groups",
5312 This command returns a list of all optional groups that this
5313 daemon knows about. Note this returns both supported and unsupported
5314 groups. To find out which ones the daemon can actually support
5315 you have to call C<guestfs_available> on each member of the
5318 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5320 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5321 [InitScratchFS, Always, TestOutputStruct (
5322 [["fallocate64"; "/fallocate64"; "1000000"];
5323 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5324 "preallocate a file in the guest filesystem",
5326 This command preallocates a file (containing zero bytes) named
5327 C<path> of size C<len> bytes. If the file exists already, it
5330 Note that this call allocates disk blocks for the file.
5331 To create a sparse file use C<guestfs_truncate_size> instead.
5333 The deprecated call C<guestfs_fallocate> does the same,
5334 but owing to an oversight it only allowed 30 bit lengths
5335 to be specified, effectively limiting the maximum size
5336 of files created through that call to 1GB.
5338 Do not confuse this with the guestfish-specific
5339 C<alloc> and C<sparse> commands which create
5340 a file in the host and attach it as a device.");
5342 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5343 [InitBasicFS, Always, TestOutput (
5344 [["set_e2label"; "/dev/sda1"; "LTEST"];
5345 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5346 "get the filesystem label",
5348 This returns the filesystem label of the filesystem on
5351 If the filesystem is unlabeled, this returns the empty string.
5353 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5355 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5356 (let uuid = uuidgen () in
5357 [InitBasicFS, Always, TestOutput (
5358 [["set_e2uuid"; "/dev/sda1"; uuid];
5359 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5360 "get the filesystem UUID",
5362 This returns the filesystem UUID of the filesystem on
5365 If the filesystem does not have a UUID, this returns the empty string.
5367 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5369 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5370 (* Can't be tested with the current framework because
5371 * the VG is being used by the mounted filesystem, so
5372 * the vgchange -an command we do first will fail.
5375 "set LVM device filter",
5377 This sets the LVM device filter so that LVM will only be
5378 able to \"see\" the block devices in the list C<devices>,
5379 and will ignore all other attached block devices.
5381 Where disk image(s) contain duplicate PVs or VGs, this
5382 command is useful to get LVM to ignore the duplicates, otherwise
5383 LVM can get confused. Note also there are two types
5384 of duplication possible: either cloned PVs/VGs which have
5385 identical UUIDs; or VGs that are not cloned but just happen
5386 to have the same name. In normal operation you cannot
5387 create this situation, but you can do it outside LVM, eg.
5388 by cloning disk images or by bit twiddling inside the LVM
5391 This command also clears the LVM cache and performs a volume
5394 You can filter whole block devices or individual partitions.
5396 You cannot use this if any VG is currently in use (eg.
5397 contains a mounted filesystem), even if you are not
5398 filtering out that VG.");
5400 ("lvm_clear_filter", (RErr, [], []), 256, [],
5401 [], (* see note on lvm_set_filter *)
5402 "clear LVM device filter",
5404 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5405 will be able to see every block device.
5407 This command also clears the LVM cache and performs a volume
5410 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5412 "open a LUKS-encrypted block device",
5414 This command opens a block device which has been encrypted
5415 according to the Linux Unified Key Setup (LUKS) standard.
5417 C<device> is the encrypted block device or partition.
5419 The caller must supply one of the keys associated with the
5420 LUKS block device, in the C<key> parameter.
5422 This creates a new block device called C</dev/mapper/mapname>.
5423 Reads and writes to this block device are decrypted from and
5424 encrypted to the underlying C<device> respectively.
5426 If this block device contains LVM volume groups, then
5427 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5428 will make them visible.");
5430 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5432 "open a LUKS-encrypted block device read-only",
5434 This is the same as C<guestfs_luks_open> except that a read-only
5435 mapping is created.");
5437 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5439 "close a LUKS device",
5441 This closes a LUKS device that was created earlier by
5442 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5443 C<device> parameter must be the name of the LUKS mapping
5444 device (ie. C</dev/mapper/mapname>) and I<not> the name
5445 of the underlying block device.");
5447 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5449 "format a block device as a LUKS encrypted device",
5451 This command erases existing data on C<device> and formats
5452 the device as a LUKS encrypted device. C<key> is the
5453 initial key, which is added to key slot C<slot>. (LUKS
5454 supports 8 key slots, numbered 0-7).");
5456 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5458 "format a block device as a LUKS encrypted device",
5460 This command is the same as C<guestfs_luks_format> but
5461 it also allows you to set the C<cipher> used.");
5463 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5465 "add a key on a LUKS encrypted device",
5467 This command adds a new key on LUKS device C<device>.
5468 C<key> is any existing key, and is used to access the device.
5469 C<newkey> is the new key to add. C<keyslot> is the key slot
5470 that will be replaced.
5472 Note that if C<keyslot> already contains a key, then this
5473 command will fail. You have to use C<guestfs_luks_kill_slot>
5474 first to remove that key.");
5476 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5478 "remove a key from a LUKS encrypted device",
5480 This command deletes the key in key slot C<keyslot> from the
5481 encrypted LUKS device C<device>. C<key> must be one of the
5484 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5485 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5486 [["is_lv"; "/dev/VG/LV"]]);
5487 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5488 [["is_lv"; "/dev/sda1"]])],
5489 "test if device is a logical volume",
5491 This command tests whether C<device> is a logical volume, and
5492 returns true iff this is the case.");
5494 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5496 "find a filesystem by UUID",
5498 This command searches the filesystems and returns the one
5499 which has the given UUID. An error is returned if no such
5500 filesystem can be found.
5502 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5504 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5506 "find a filesystem by label",
5508 This command searches the filesystems and returns the one
5509 which has the given label. An error is returned if no such
5510 filesystem can be found.
5512 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5514 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5515 [InitISOFS, Always, TestOutputFalse (
5516 [["is_chardev"; "/directory"]]);
5517 InitScratchFS, Always, TestOutputTrue (
5518 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5519 ["is_chardev"; "/is_chardev"]])],
5520 "test if character device",
5522 This returns C<true> if and only if there is a character device
5523 with the given C<path> name.
5525 See also C<guestfs_stat>.");
5527 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5528 [InitISOFS, Always, TestOutputFalse (
5529 [["is_blockdev"; "/directory"]]);
5530 InitScratchFS, Always, TestOutputTrue (
5531 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5532 ["is_blockdev"; "/is_blockdev"]])],
5533 "test if block device",
5535 This returns C<true> if and only if there is a block device
5536 with the given C<path> name.
5538 See also C<guestfs_stat>.");
5540 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5541 [InitISOFS, Always, TestOutputFalse (
5542 [["is_fifo"; "/directory"]]);
5543 InitScratchFS, Always, TestOutputTrue (
5544 [["mkfifo"; "0o777"; "/is_fifo"];
5545 ["is_fifo"; "/is_fifo"]])],
5546 "test if FIFO (named pipe)",
5548 This returns C<true> if and only if there is a FIFO (named pipe)
5549 with the given C<path> name.
5551 See also C<guestfs_stat>.");
5553 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5554 [InitISOFS, Always, TestOutputFalse (
5555 [["is_symlink"; "/directory"]]);
5556 InitISOFS, Always, TestOutputTrue (
5557 [["is_symlink"; "/abssymlink"]])],
5558 "test if symbolic link",
5560 This returns C<true> if and only if there is a symbolic link
5561 with the given C<path> name.
5563 See also C<guestfs_stat>.");
5565 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5566 (* XXX Need a positive test for sockets. *)
5567 [InitISOFS, Always, TestOutputFalse (
5568 [["is_socket"; "/directory"]])],
5571 This returns C<true> if and only if there is a Unix domain socket
5572 with the given C<path> name.
5574 See also C<guestfs_stat>.");
5576 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5577 [InitPartition, Always, TestOutputDevice (
5578 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5579 InitEmpty, Always, TestLastFail (
5580 [["part_to_dev"; "/dev/sda"]])],
5581 "convert partition name to device name",
5583 This function takes a partition name (eg. \"/dev/sdb1\") and
5584 removes the partition number, returning the device name
5587 The named partition must exist, for example as a string returned
5588 from C<guestfs_list_partitions>.");
5590 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5591 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5592 [InitScratchFS, Always, TestOutput (
5593 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5594 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5595 "upload a file from the local machine with offset",
5597 Upload local file C<filename> to C<remotefilename> on the
5600 C<remotefilename> is overwritten starting at the byte C<offset>
5601 specified. The intention is to overwrite parts of existing
5602 files or devices, although if a non-existant file is specified
5603 then it is created with a \"hole\" before C<offset>. The
5604 size of the data written is implicit in the size of the
5607 Note that there is no limit on the amount of data that
5608 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5609 and this call always writes the full amount unless an
5612 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5614 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5615 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5616 let offset = string_of_int 100 in
5617 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5618 [InitScratchFS, Always, TestOutput (
5619 (* Pick a file from cwd which isn't likely to change. *)
5620 [["mkdir"; "/download_offset"];
5621 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5622 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5623 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5624 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5625 "download a file to the local machine with offset and size",
5627 Download file C<remotefilename> and save it as C<filename>
5628 on the local machine.
5630 C<remotefilename> is read for C<size> bytes starting at C<offset>
5631 (this region must be within the file or device).
5633 Note that there is no limit on the amount of data that
5634 can be downloaded with this call, unlike with C<guestfs_pread>,
5635 and this call always reads the full amount unless an
5638 See also C<guestfs_download>, C<guestfs_pread>.");
5640 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5641 [InitPartition, Always, TestOutputListOfDevices (
5642 [["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"];
5643 ["blockdev_rereadpt"; "/dev/sda"];
5644 ["list_partitions"]], ["/dev/sdb1"])],
5645 "write to part of a device",
5647 This command writes to part of a device. It writes the data
5648 buffer C<content> to C<device> starting at offset C<offset>.
5650 This command implements the L<pwrite(2)> system call, and like
5651 that system call it may not write the full data requested
5652 (although short writes to disk devices and partitions are
5653 probably impossible with standard Linux kernels).
5655 See also C<guestfs_pwrite>.");
5657 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5658 [InitEmpty, Always, TestOutputBuffer (
5659 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5660 "read part of a device",
5662 This command lets you read part of a file. It reads C<count>
5663 bytes of C<device>, starting at C<offset>.
5665 This may read fewer bytes than requested. For further details
5666 see the L<pread(2)> system call.
5668 See also C<guestfs_pread>.");
5670 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5671 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5672 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5673 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5674 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5675 "get canonical name of an LV",
5677 This converts alternative naming schemes for LVs that you
5678 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5679 is converted to C</dev/VG/LV>.
5681 This command returns an error if the C<lvname> parameter does
5682 not refer to a logical volume.
5684 See also C<guestfs_is_lv>.");
5686 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"]), 278, [],
5687 [InitEmpty, Always, TestOutput (
5688 [["part_disk"; "/dev/sda"; "mbr"];
5689 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"];
5690 ["mount_options"; ""; "/dev/sda1"; "/"];
5691 ["write"; "/new"; "new file contents"];
5692 ["cat"; "/new"]], "new file contents")],
5693 "make a filesystem",
5695 This function creates a filesystem on C<device>. The filesystem
5696 type is C<fstype>, for example C<ext3>.
5698 The optional arguments are:
5704 The filesystem block size. Supported block sizes depend on the
5705 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5706 for Linux ext2/3 filesystems.
5708 For VFAT and NTFS the C<blocksize> parameter is treated as
5709 the requested cluster size.
5713 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5715 "get a single extended attribute",
5717 Get a single extended attribute from file C<path> named C<name>.
5718 This call follows symlinks. If you want to lookup an extended
5719 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5721 Normally it is better to get all extended attributes from a file
5722 in one go by calling C<guestfs_getxattrs>. However some Linux
5723 filesystem implementations are buggy and do not provide a way to
5724 list out attributes. For these filesystems (notably ntfs-3g)
5725 you have to know the names of the extended attributes you want
5726 in advance and call this function.
5728 Extended attribute values are blobs of binary data. If there
5729 is no extended attribute named C<name>, this returns an error.
5731 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5733 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5735 "get a single extended attribute",
5737 Get a single extended attribute from file C<path> named C<name>.
5738 If C<path> is a symlink, then this call returns an extended
5739 attribute from the symlink.
5741 Normally it is better to get all extended attributes from a file
5742 in one go by calling C<guestfs_getxattrs>. However some Linux
5743 filesystem implementations are buggy and do not provide a way to
5744 list out attributes. For these filesystems (notably ntfs-3g)
5745 you have to know the names of the extended attributes you want
5746 in advance and call this function.
5748 Extended attribute values are blobs of binary data. If there
5749 is no extended attribute named C<name>, this returns an error.
5751 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5753 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5755 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5757 This command is the same as C<guestfs_resize2fs>, but the filesystem
5758 is resized to its minimum size. This works like the C<-M> option
5759 to the C<resize2fs> command.
5761 To get the resulting size of the filesystem you should call
5762 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5763 values. These two numbers, multiplied together, give the
5764 resulting size of the minimal filesystem in bytes.");
5768 let all_functions = non_daemon_functions @ daemon_functions
5770 (* In some places we want the functions to be displayed sorted
5771 * alphabetically, so this is useful:
5773 let all_functions_sorted = List.sort action_compare all_functions
5775 (* This is used to generate the src/MAX_PROC_NR file which
5776 * contains the maximum procedure number, a surrogate for the
5777 * ABI version number. See src/Makefile.am for the details.
5780 let proc_nrs = List.map (
5781 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5782 ) daemon_functions in
5783 List.fold_left max 0 proc_nrs
5785 (* Non-API meta-commands available only in guestfish.
5787 * Note (1): style, proc_nr and tests fields are all meaningless.
5788 * The only fields which are actually used are the shortname,
5789 * FishAlias flags, shortdesc and longdesc.
5791 * Note (2): to refer to other commands, use L</shortname>.
5793 * Note (3): keep this list sorted by shortname.
5795 let fish_commands = [
5796 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5797 "allocate and add a disk file",
5798 " alloc filename size
5800 This creates an empty (zeroed) file of the given size, and then adds
5801 so it can be further examined.
5803 For more advanced image creation, see L<qemu-img(1)> utility.
5805 Size can be specified using standard suffixes, eg. C<1M>.
5807 To create a sparse file, use L</sparse> instead. To create a
5808 prepared disk image, see L</PREPARED DISK IMAGES>.");
5810 ("copy_in", (RErr,[], []), -1, [], [],
5811 "copy local files or directories into an image",
5812 " copy-in local [local ...] /remotedir
5814 C<copy-in> copies local files or directories recursively into the disk
5815 image, placing them in the directory called C</remotedir> (which must
5816 exist). This guestfish meta-command turns into a sequence of
5817 L</tar-in> and other commands as necessary.
5819 Multiple local files and directories can be specified, but the last
5820 parameter must always be a remote directory. Wildcards cannot be
5823 ("copy_out", (RErr,[], []), -1, [], [],
5824 "copy remote files or directories out of an image",
5825 " copy-out remote [remote ...] localdir
5827 C<copy-out> copies remote files or directories recursively out of the
5828 disk image, placing them on the host disk in a local directory called
5829 C<localdir> (which must exist). This guestfish meta-command turns
5830 into a sequence of L</download>, L</tar-out> and other commands as
5833 Multiple remote files and directories can be specified, but the last
5834 parameter must always be a local directory. To download to the
5835 current directory, use C<.> as in:
5839 Wildcards cannot be used in the ordinary command, but you can use
5840 them with the help of L</glob> like this:
5842 glob copy-out /home/* .");
5844 ("echo", (RErr,[], []), -1, [], [],
5845 "display a line of text",
5848 This echos the parameters to the terminal.");
5850 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5854 This is used to edit a file. It downloads the file, edits it
5855 locally using your editor, then uploads the result.
5857 The editor is C<$EDITOR>. However if you use the alternate
5858 commands C<vi> or C<emacs> you will get those corresponding
5861 ("glob", (RErr,[], []), -1, [], [],
5862 "expand wildcards in command",
5863 " glob command args...
5865 Expand wildcards in any paths in the args list, and run C<command>
5866 repeatedly on each matching path.
5868 See L</WILDCARDS AND GLOBBING>.");
5870 ("hexedit", (RErr,[], []), -1, [], [],
5871 "edit with a hex editor",
5872 " hexedit <filename|device>
5873 hexedit <filename|device> <max>
5874 hexedit <filename|device> <start> <max>
5876 Use hexedit (a hex editor) to edit all or part of a binary file
5879 This command works by downloading potentially the whole file or
5880 device, editing it locally, then uploading it. If the file or
5881 device is large, you have to specify which part you wish to edit
5882 by using C<max> and/or C<start> C<max> parameters.
5883 C<start> and C<max> are specified in bytes, with the usual
5884 modifiers allowed such as C<1M> (1 megabyte).
5886 For example to edit the first few sectors of a disk you
5891 which would allow you to edit anywhere within the first megabyte
5894 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5896 hexedit /dev/sda1 0x400 0x400
5898 (assuming the superblock is in the standard location).
5900 This command requires the external L<hexedit(1)> program. You
5901 can specify another program to use by setting the C<HEXEDITOR>
5902 environment variable.
5904 See also L</hexdump>.");
5906 ("lcd", (RErr,[], []), -1, [], [],
5907 "change working directory",
5910 Change the local directory, ie. the current directory of guestfish
5913 Note that C<!cd> won't do what you might expect.");
5915 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5919 Opens the manual page for guestfish.");
5921 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5927 This is used to view a file.
5929 The default viewer is C<$PAGER>. However if you use the alternate
5930 command C<less> you will get the C<less> command specifically.");
5932 ("reopen", (RErr,[], []), -1, [], [],
5933 "close and reopen libguestfs handle",
5936 Close and reopen the libguestfs handle. It is not necessary to use
5937 this normally, because the handle is closed properly when guestfish
5938 exits. However this is occasionally useful for testing.");
5940 ("sparse", (RErr,[], []), -1, [], [],
5941 "create a sparse disk image and add",
5942 " sparse filename size
5944 This creates an empty sparse file of the given size, and then adds
5945 so it can be further examined.
5947 In all respects it works the same as the L</alloc> command, except that
5948 the image file is allocated sparsely, which means that disk blocks are
5949 not assigned to the file until they are needed. Sparse disk files
5950 only use space when written to, but they are slower and there is a
5951 danger you could run out of real disk space during a write operation.
5953 For more advanced image creation, see L<qemu-img(1)> utility.
5955 Size can be specified using standard suffixes, eg. C<1M>.");
5957 ("supported", (RErr,[], []), -1, [], [],
5958 "list supported groups of commands",
5961 This command returns a list of the optional groups
5962 known to the daemon, and indicates which ones are
5963 supported by this build of the libguestfs appliance.
5965 See also L<guestfs(3)/AVAILABILITY>.");
5967 ("time", (RErr,[], []), -1, [], [],
5968 "print elapsed time taken to run a command",
5969 " time command args...
5971 Run the command as usual, but print the elapsed time afterwards. This
5972 can be useful for benchmarking operations.");