2 * Copyright (C) 2009-2010 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter C<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form C<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to make filesystems consistent and synchronized
286 when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages.
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
308 Verbose messages are normally sent to C<stderr>, unless you
309 register a callback to send them somewhere else (see
310 C<guestfs_set_event_callback>).");
312 ("get_verbose", (RBool "verbose", [], []), -1, [],
316 This returns the verbose messages flag.");
318 ("is_ready", (RBool "ready", [], []), -1, [],
319 [InitNone, Always, TestOutputTrue (
321 "is ready to accept commands",
323 This returns true iff this handle is ready to accept commands
324 (in the C<READY> state).
326 For more information on states, see L<guestfs(3)>.");
328 ("is_config", (RBool "config", [], []), -1, [],
329 [InitNone, Always, TestOutputFalse (
331 "is in configuration state",
333 This returns true iff this handle is being configured
334 (in the C<CONFIG> state).
336 For more information on states, see L<guestfs(3)>.");
338 ("is_launching", (RBool "launching", [], []), -1, [],
339 [InitNone, Always, TestOutputFalse (
340 [["is_launching"]])],
341 "is launching subprocess",
343 This returns true iff this handle is launching the subprocess
344 (in the C<LAUNCHING> state).
346 For more information on states, see L<guestfs(3)>.");
348 ("is_busy", (RBool "busy", [], []), -1, [],
349 [InitNone, Always, TestOutputFalse (
351 "is busy processing a command",
353 This returns true iff this handle is busy processing a command
354 (in the C<BUSY> state).
356 For more information on states, see L<guestfs(3)>.");
358 ("get_state", (RInt "state", [], []), -1, [],
360 "get the current state",
362 This returns the current state as an opaque integer. This is
363 only useful for printing debug and internal error messages.
365 For more information on states, see L<guestfs(3)>.");
367 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
368 [InitNone, Always, TestOutputInt (
369 [["set_memsize"; "500"];
370 ["get_memsize"]], 500)],
371 "set memory allocated to the qemu subprocess",
373 This sets the memory size in megabytes allocated to the
374 qemu subprocess. This only has any effect if called before
377 You can also change this by setting the environment
378 variable C<LIBGUESTFS_MEMSIZE> before the handle is
381 For more information on the architecture of libguestfs,
382 see L<guestfs(3)>.");
384 ("get_memsize", (RInt "memsize", [], []), -1, [],
385 [InitNone, Always, TestOutputIntOp (
386 [["get_memsize"]], ">=", 256)],
387 "get memory allocated to the qemu subprocess",
389 This gets the memory size in megabytes allocated to the
392 If C<guestfs_set_memsize> was not called
393 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
394 then this returns the compiled-in default value for memsize.
396 For more information on the architecture of libguestfs,
397 see L<guestfs(3)>.");
399 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
400 [InitNone, Always, TestOutputIntOp (
401 [["get_pid"]], ">=", 1)],
402 "get PID of qemu subprocess",
404 Return the process ID of the qemu subprocess. If there is no
405 qemu subprocess, then this will return an error.
407 This is an internal call used for debugging and testing.");
409 ("version", (RStruct ("version", "version"), [], []), -1, [],
410 [InitNone, Always, TestOutputStruct (
411 [["version"]], [CompareWithInt ("major", 1)])],
412 "get the library version number",
414 Return the libguestfs version number that the program is linked
417 Note that because of dynamic linking this is not necessarily
418 the version of libguestfs that you compiled against. You can
419 compile the program, and then at runtime dynamically link
420 against a completely different C<libguestfs.so> library.
422 This call was added in version C<1.0.58>. In previous
423 versions of libguestfs there was no way to get the version
424 number. From C code you can use dynamic linker functions
425 to find out if this symbol exists (if it doesn't, then
426 it's an earlier version).
428 The call returns a structure with four elements. The first
429 three (C<major>, C<minor> and C<release>) are numbers and
430 correspond to the usual version triplet. The fourth element
431 (C<extra>) is a string and is normally empty, but may be
432 used for distro-specific information.
434 To construct the original version string:
435 C<$major.$minor.$release$extra>
437 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
439 I<Note:> Don't use this call to test for availability
440 of features. In enterprise distributions we backport
441 features from later versions into earlier versions,
442 making this an unreliable way to test for features.
443 Use C<guestfs_available> instead.");
445 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
446 [InitNone, Always, TestOutputTrue (
447 [["set_selinux"; "true"];
449 "set SELinux enabled or disabled at appliance boot",
451 This sets the selinux flag that is passed to the appliance
452 at boot time. The default is C<selinux=0> (disabled).
454 Note that if SELinux is enabled, it is always in
455 Permissive mode (C<enforcing=0>).
457 For more information on the architecture of libguestfs,
458 see L<guestfs(3)>.");
460 ("get_selinux", (RBool "selinux", [], []), -1, [],
462 "get SELinux enabled flag",
464 This returns the current setting of the selinux flag which
465 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
467 For more information on the architecture of libguestfs,
468 see L<guestfs(3)>.");
470 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
471 [InitNone, Always, TestOutputFalse (
472 [["set_trace"; "false"];
474 "enable or disable command traces",
476 If the command trace flag is set to 1, then libguestfs
477 calls, parameters and return values are traced.
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 Trace messages are normally sent to C<stderr>, unless you
487 register a callback to send them somewhere else (see
488 C<guestfs_set_event_callback>).");
490 ("get_trace", (RBool "trace", [], []), -1, [],
492 "get command trace enabled flag",
494 Return the command trace flag.");
496 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
497 [InitNone, Always, TestOutputFalse (
498 [["set_direct"; "false"];
500 "enable or disable direct appliance mode",
502 If the direct appliance mode flag is enabled, then stdin and
503 stdout are passed directly through to the appliance once it
506 One consequence of this is that log messages aren't caught
507 by the library and handled by C<guestfs_set_log_message_callback>,
508 but go straight to stdout.
510 You probably don't want to use this unless you know what you
513 The default is disabled.");
515 ("get_direct", (RBool "direct", [], []), -1, [],
517 "get direct appliance mode flag",
519 Return the direct appliance mode flag.");
521 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
522 [InitNone, Always, TestOutputTrue (
523 [["set_recovery_proc"; "true"];
524 ["get_recovery_proc"]])],
525 "enable or disable the recovery process",
527 If this is called with the parameter C<false> then
528 C<guestfs_launch> does not create a recovery process. The
529 purpose of the recovery process is to stop runaway qemu
530 processes in the case where the main program aborts abruptly.
532 This only has any effect if called before C<guestfs_launch>,
533 and the default is true.
535 About the only time when you would want to disable this is
536 if the main process will fork itself into the background
537 (\"daemonize\" itself). In this case the recovery process
538 thinks that the main program has disappeared and so kills
539 qemu, which is not very helpful.");
541 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
543 "get recovery process enabled flag",
545 Return the recovery process enabled flag.");
547 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
549 "add a drive specifying the QEMU block emulation to use",
551 This is the same as C<guestfs_add_drive> but it allows you
552 to specify the QEMU interface emulation to use at run time.");
554 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
556 "add a drive read-only specifying the QEMU block emulation to use",
558 This is the same as C<guestfs_add_drive_ro> but it allows you
559 to specify the QEMU interface emulation to use at run time.");
561 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
562 [InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-win32.exe"]], "i386");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-i586.so"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-sparc.so"]], "sparc");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-win32.dll"]], "i386");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
582 InitISOFS, Always, TestOutput (
583 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
584 InitISOFS, Always, TestOutput (
585 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
586 "detect the architecture of a binary file",
588 This detects the architecture of the binary C<filename>,
589 and returns it if known.
591 Currently defined architectures are:
597 This string is returned for all 32 bit i386, i486, i586, i686 binaries
598 irrespective of the precise processor requirements of the binary.
610 64 bit SPARC V9 and above.
626 Libguestfs may return other architecture strings in future.
628 The function works on at least the following types of files:
634 many types of Un*x and Linux binary
638 many types of Un*x and Linux shared library
642 Windows Win32 and Win64 binaries
646 Windows Win32 and Win64 DLLs
648 Win32 binaries and DLLs return C<i386>.
650 Win64 binaries and DLLs return C<x86_64>.
658 Linux new-style initrd images
662 some non-x86 Linux vmlinuz kernels
666 What it can't do currently:
672 static libraries (libfoo.a)
676 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
680 x86 Linux vmlinuz kernels
682 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
683 compressed code, and are horribly hard to unpack. If you want to find
684 the architecture of a kernel, use the architecture of the associated
685 initrd or kernel module(s) instead.
689 ("inspect_os", (RStringList "roots", [], []), -1, [],
691 "inspect disk and return list of operating systems found",
693 This function uses other libguestfs functions and certain
694 heuristics to inspect the disk(s) (usually disks belonging to
695 a virtual machine), looking for operating systems.
697 The list returned is empty if no operating systems were found.
699 If one operating system was found, then this returns a list with
700 a single element, which is the name of the root filesystem of
701 this operating system. It is also possible for this function
702 to return a list containing more than one element, indicating
703 a dual-boot or multi-boot virtual machine, with each element being
704 the root filesystem of one of the operating systems.
706 You can pass the root string(s) returned to other
707 C<guestfs_inspect_get_*> functions in order to query further
708 information about each operating system, such as the name
711 This function uses other libguestfs features such as
712 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
713 and unmount filesystems and look at the contents. This should
714 be called with no disks currently mounted. The function may also
715 use Augeas, so any existing Augeas handle will be closed.
717 This function cannot decrypt encrypted disks. The caller
718 must do that first (supplying the necessary keys) if the
721 Please read L<guestfs(3)/INSPECTION> for more details.
723 See also C<guestfs_list_filesystems>.");
725 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
727 "get type of inspected operating system",
729 This function should only be called with a root device string
730 as returned by C<guestfs_inspect_os>.
732 This returns the type of the inspected operating system.
733 Currently defined types are:
739 Any Linux-based operating system.
743 Any Microsoft Windows operating system.
751 The operating system type could not be determined.
755 Future versions of libguestfs may return other strings here.
756 The caller should be prepared to handle any string.
758 Please read L<guestfs(3)/INSPECTION> for more details.");
760 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
762 "get architecture of inspected operating system",
764 This function should only be called with a root device string
765 as returned by C<guestfs_inspect_os>.
767 This returns the architecture of the inspected operating system.
768 The possible return values are listed under
769 C<guestfs_file_architecture>.
771 If the architecture could not be determined, then the
772 string C<unknown> is returned.
774 Please read L<guestfs(3)/INSPECTION> for more details.");
776 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
778 "get distro of inspected operating system",
780 This function should only be called with a root device string
781 as returned by C<guestfs_inspect_os>.
783 This returns the distro (distribution) of the inspected operating
786 Currently defined distros are:
822 =item \"redhat-based\"
824 Some Red Hat-derived distro.
828 Red Hat Enterprise Linux and some derivatives.
836 The distro could not be determined.
840 Windows does not have distributions. This string is
841 returned if the OS type is Windows.
845 Future versions of libguestfs may return other strings here.
846 The caller should be prepared to handle any string.
848 Please read L<guestfs(3)/INSPECTION> for more details.");
850 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
852 "get major version of inspected operating system",
854 This function should only be called with a root device string
855 as returned by C<guestfs_inspect_os>.
857 This returns the major version number of the inspected operating
860 Windows uses a consistent versioning scheme which is I<not>
861 reflected in the popular public names used by the operating system.
862 Notably the operating system known as \"Windows 7\" is really
863 version 6.1 (ie. major = 6, minor = 1). You can find out the
864 real versions corresponding to releases of Windows by consulting
867 If the version could not be determined, then C<0> is returned.
869 Please read L<guestfs(3)/INSPECTION> for more details.");
871 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
873 "get minor version of inspected operating system",
875 This function should only be called with a root device string
876 as returned by C<guestfs_inspect_os>.
878 This returns the minor version number of the inspected operating
881 If the version could not be determined, then C<0> is returned.
883 Please read L<guestfs(3)/INSPECTION> for more details.
884 See also C<guestfs_inspect_get_major_version>.");
886 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
888 "get product name of inspected operating system",
890 This function should only be called with a root device string
891 as returned by C<guestfs_inspect_os>.
893 This returns the product name of the inspected operating
894 system. The product name is generally some freeform string
895 which can be displayed to the user, but should not be
898 If the product name could not be determined, then the
899 string C<unknown> is returned.
901 Please read L<guestfs(3)/INSPECTION> for more details.");
903 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
905 "get mountpoints of inspected operating system",
907 This function should only be called with a root device string
908 as returned by C<guestfs_inspect_os>.
910 This returns a hash of where we think the filesystems
911 associated with this operating system should be mounted.
912 Callers should note that this is at best an educated guess
913 made by reading configuration files such as C</etc/fstab>.
914 I<In particular note> that this may return filesystems
915 which are non-existent or not mountable and callers should
916 be prepared to handle or ignore failures if they try to
919 Each element in the returned hashtable has a key which
920 is the path of the mountpoint (eg. C</boot>) and a value
921 which is the filesystem that would be mounted there
924 Non-mounted devices such as swap devices are I<not>
925 returned in this list.
927 Please read L<guestfs(3)/INSPECTION> for more details.
928 See also C<guestfs_inspect_get_filesystems>.");
930 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
932 "get filesystems associated with inspected operating system",
934 This function should only be called with a root device string
935 as returned by C<guestfs_inspect_os>.
937 This returns a list of all the filesystems that we think
938 are associated with this operating system. This includes
939 the root filesystem, other ordinary filesystems, and
940 non-mounted devices like swap partitions.
942 In the case of a multi-boot virtual machine, it is possible
943 for a filesystem to be shared between operating systems.
945 Please read L<guestfs(3)/INSPECTION> for more details.
946 See also C<guestfs_inspect_get_mountpoints>.");
948 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
950 "set enable network flag",
952 If C<network> is true, then the network is enabled in the
953 libguestfs appliance. The default is false.
955 This affects whether commands are able to access the network
956 (see L<guestfs(3)/RUNNING COMMANDS>).
958 You must call this before calling C<guestfs_launch>, otherwise
961 ("get_network", (RBool "network", [], []), -1, [],
963 "get enable network flag",
965 This returns the enable network flag.");
967 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
971 This inspection command looks for filesystems on partitions,
972 block devices and logical volumes, returning a list of devices
973 containing filesystems and their type.
975 The return value is a hash, where the keys are the devices
976 containing filesystems, and the values are the filesystem types.
979 \"/dev/sda1\" => \"ntfs\"
980 \"/dev/sda2\" => \"ext2\"
981 \"/dev/vg_guest/lv_root\" => \"ext4\"
982 \"/dev/vg_guest/lv_swap\" => \"swap\"
984 The value can have the special value \"unknown\", meaning the
985 content of the device is undetermined or empty.
986 \"swap\" means a Linux swap partition.
988 This command runs other libguestfs commands, which might include
989 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
990 use this soon after launch and only when nothing is mounted.
992 Not all of the filesystems returned will be mountable. In
993 particular, swap partitions are returned in the list. Also
994 this command does not check that each filesystem
995 found is valid and mountable, and some filesystems might
996 be mountable but require special options. Filesystems may
997 not all belong to a single logical operating system
998 (use C<guestfs_inspect_os> to look for OSes).");
1000 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
1002 "add an image to examine or modify",
1004 This function adds a virtual machine disk image C<filename> to
1005 libguestfs. The first time you call this function, the disk
1006 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1009 You don't necessarily need to be root when using libguestfs. However
1010 you obviously do need sufficient permissions to access the filename
1011 for whatever operations you want to perform (ie. read access if you
1012 just want to read the image or write access if you want to modify the
1015 This call checks that C<filename> exists.
1017 The optional arguments are:
1023 If true then the image is treated as read-only. Writes are still
1024 allowed, but they are stored in a temporary snapshot overlay which
1025 is discarded at the end. The disk that you add is not modified.
1029 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1030 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1031 Possible formats include C<raw> and C<qcow2>.
1033 Automatic detection of the format opens you up to a potential
1034 security hole when dealing with untrusted raw-format images.
1035 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1040 This rarely-used option lets you emulate the behaviour of the
1041 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1045 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1047 "get Windows systemroot of inspected operating system",
1049 This function should only be called with a root device string
1050 as returned by C<guestfs_inspect_os>.
1052 This returns the Windows systemroot of the inspected guest.
1053 The systemroot is a directory path such as C</WINDOWS>.
1055 This call assumes that the guest is Windows and that the
1056 systemroot could be determined by inspection. If this is not
1057 the case then an error is returned.
1059 Please read L<guestfs(3)/INSPECTION> for more details.");
1061 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1063 "return list of operating systems found by last inspection",
1065 This function is a convenient way to get the list of root
1066 devices, as returned from a previous call to C<guestfs_inspect_os>,
1067 but without redoing the whole inspection process.
1069 This returns an empty list if either no root devices were
1070 found or the caller has not called C<guestfs_inspect_os>.
1072 Please read L<guestfs(3)/INSPECTION> for more details.");
1074 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1076 "debug the QEMU command line (internal use only)",
1078 This returns the internal QEMU command line. 'debug' commands are
1079 not part of the formal API and can be removed or changed at any time.");
1081 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"]), -1, [FishAlias "domain"],
1083 "add the disk(s) from a named libvirt domain",
1085 This function adds the disk(s) attached to the named libvirt
1086 domain C<dom>. It works by connecting to libvirt, requesting
1087 the domain and domain XML from libvirt, parsing it for disks,
1088 and calling C<guestfs_add_drive_opts> on each one.
1090 The number of disks added is returned. This operation is atomic:
1091 if an error is returned, then no disks are added.
1093 This function does some minimal checks to make sure the libvirt
1094 domain is not running (unless C<readonly> is true). In a future
1095 version we will try to acquire the libvirt lock on each disk.
1097 Disks must be accessible locally. This often means that adding disks
1098 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1099 will fail unless those disks are accessible via the same device path
1102 The optional C<libvirturi> parameter sets the libvirt URI
1103 (see L<http://libvirt.org/uri.html>). If this is not set then
1104 we connect to the default libvirt URI (or one set through an
1105 environment variable, see the libvirt documentation for full
1108 The optional C<live> flag controls whether this call will try
1109 to connect to a running virtual machine C<guestfsd> process if
1110 it sees a suitable E<lt>channelE<gt> element in the libvirt
1111 XML definition. The default (if the flag is omitted) is never
1112 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1115 The other optional parameters are passed directly through to
1116 C<guestfs_add_drive_opts>.");
1119 This interface is not quite baked yet. -- RWMJ 2010-11-11
1120 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1122 "add the disk(s) from a libvirt domain",
1124 This function adds the disk(s) attached to the libvirt domain C<dom>.
1125 It works by requesting the domain XML from libvirt, parsing it for
1126 disks, and calling C<guestfs_add_drive_opts> on each one.
1128 In the C API we declare C<void *dom>, but really it has type
1129 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1131 The number of disks added is returned. This operation is atomic:
1132 if an error is returned, then no disks are added.
1134 This function does some minimal checks to make sure the libvirt
1135 domain is not running (unless C<readonly> is true). In a future
1136 version we will try to acquire the libvirt lock on each disk.
1138 Disks must be accessible locally. This often means that adding disks
1139 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1140 will fail unless those disks are accessible via the same device path
1143 The optional C<live> flag controls whether this call will try
1144 to connect to a running virtual machine C<guestfsd> process if
1145 it sees a suitable E<lt>channelE<gt> element in the libvirt
1146 XML definition. The default (if the flag is omitted) is never
1147 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1150 The other optional parameters are passed directly through to
1151 C<guestfs_add_drive_opts>.");
1154 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1156 "get package format used by the operating system",
1158 This function should only be called with a root device string
1159 as returned by C<guestfs_inspect_os>.
1161 This function and C<guestfs_inspect_get_package_management> return
1162 the package format and package management tool used by the
1163 inspected operating system. For example for Fedora these
1164 functions would return C<rpm> (package format) and
1165 C<yum> (package management).
1167 This returns the string C<unknown> if we could not determine the
1168 package format I<or> if the operating system does not have
1169 a real packaging system (eg. Windows).
1171 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1172 Future versions of libguestfs may return other strings.
1174 Please read L<guestfs(3)/INSPECTION> for more details.");
1176 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1178 "get package management tool used by the operating system",
1180 This function should only be called with a root device string
1181 as returned by C<guestfs_inspect_os>.
1183 C<guestfs_inspect_get_package_format> and this function return
1184 the package format and package management tool used by the
1185 inspected operating system. For example for Fedora these
1186 functions would return C<rpm> (package format) and
1187 C<yum> (package management).
1189 This returns the string C<unknown> if we could not determine the
1190 package management tool I<or> if the operating system does not have
1191 a real packaging system (eg. Windows).
1193 Possible strings include: C<yum>, C<up2date>,
1194 C<apt> (for all Debian derivatives),
1195 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1196 Future versions of libguestfs may return other strings.
1198 Please read L<guestfs(3)/INSPECTION> for more details.");
1200 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1202 "get list of applications installed in the operating system",
1204 This function should only be called with a root device string
1205 as returned by C<guestfs_inspect_os>.
1207 Return the list of applications installed in the operating system.
1209 I<Note:> This call works differently from other parts of the
1210 inspection API. You have to call C<guestfs_inspect_os>, then
1211 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1212 before calling this. Listing applications is a significantly
1213 more difficult operation which requires access to the full
1214 filesystem. Also note that unlike the other
1215 C<guestfs_inspect_get_*> calls which are just returning
1216 data cached in the libguestfs handle, this call actually reads
1217 parts of the mounted filesystems during the call.
1219 This returns an empty list if the inspection code was not able
1220 to determine the list of applications.
1222 The application structure contains the following fields:
1228 The name of the application. For Red Hat-derived and Debian-derived
1229 Linux guests, this is the package name.
1231 =item C<app_display_name>
1233 The display name of the application, sometimes localized to the
1234 install language of the guest operating system.
1236 If unavailable this is returned as an empty string C<\"\">.
1237 Callers needing to display something can use C<app_name> instead.
1241 For package managers which use epochs, this contains the epoch of
1242 the package (an integer). If unavailable, this is returned as C<0>.
1244 =item C<app_version>
1246 The version string of the application or package. If unavailable
1247 this is returned as an empty string C<\"\">.
1249 =item C<app_release>
1251 The release string of the application or package, for package
1252 managers that use this. If unavailable this is returned as an
1253 empty string C<\"\">.
1255 =item C<app_install_path>
1257 The installation path of the application (on operating systems
1258 such as Windows which use installation paths). This path is
1259 in the format used by the guest operating system, it is not
1262 If unavailable this is returned as an empty string C<\"\">.
1264 =item C<app_trans_path>
1266 The install path translated into a libguestfs path.
1267 If unavailable this is returned as an empty string C<\"\">.
1269 =item C<app_publisher>
1271 The name of the publisher of the application, for package
1272 managers that use this. If unavailable this is returned
1273 as an empty string C<\"\">.
1277 The URL (eg. upstream URL) of the application.
1278 If unavailable this is returned as an empty string C<\"\">.
1280 =item C<app_source_package>
1282 For packaging systems which support this, the name of the source
1283 package. If unavailable this is returned as an empty string C<\"\">.
1285 =item C<app_summary>
1287 A short (usually one line) description of the application or package.
1288 If unavailable this is returned as an empty string C<\"\">.
1290 =item C<app_description>
1292 A longer description of the application or package.
1293 If unavailable this is returned as an empty string C<\"\">.
1297 Please read L<guestfs(3)/INSPECTION> for more details.");
1299 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1301 "get hostname of the operating system",
1303 This function should only be called with a root device string
1304 as returned by C<guestfs_inspect_os>.
1306 This function returns the hostname of the operating system
1307 as found by inspection of the guest's configuration files.
1309 If the hostname could not be determined, then the
1310 string C<unknown> is returned.
1312 Please read L<guestfs(3)/INSPECTION> for more details.");
1314 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1316 "get format of inspected operating system",
1318 This function should only be called with a root device string
1319 as returned by C<guestfs_inspect_os>.
1321 This returns the format of the inspected operating system. You
1322 can use it to detect install images, live CDs and similar.
1324 Currently defined formats are:
1330 This is an installed operating system.
1334 The disk image being inspected is not an installed operating system,
1335 but a I<bootable> install disk, live CD, or similar.
1339 The format of this disk image is not known.
1343 Future versions of libguestfs may return other strings here.
1344 The caller should be prepared to handle any string.
1346 Please read L<guestfs(3)/INSPECTION> for more details.");
1348 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1350 "get live flag for install disk",
1352 This function should only be called with a root device string
1353 as returned by C<guestfs_inspect_os>.
1355 If C<guestfs_inspect_get_format> returns C<installer> (this
1356 is an install disk), then this returns true if a live image
1357 was detected on the disk.
1359 Please read L<guestfs(3)/INSPECTION> for more details.");
1361 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1363 "get netinst (network installer) flag for install disk",
1365 This function should only be called with a root device string
1366 as returned by C<guestfs_inspect_os>.
1368 If C<guestfs_inspect_get_format> returns C<installer> (this
1369 is an install disk), then this returns true if the disk is
1370 a network installer, ie. not a self-contained install CD but
1371 one which is likely to require network access to complete
1374 Please read L<guestfs(3)/INSPECTION> for more details.");
1376 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1378 "get multipart flag for install disk",
1380 This function should only be called with a root device string
1381 as returned by C<guestfs_inspect_os>.
1383 If C<guestfs_inspect_get_format> returns C<installer> (this
1384 is an install disk), then this returns true if the disk is
1387 Please read L<guestfs(3)/INSPECTION> for more details.");
1389 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1391 "set the attach method",
1393 Set the method that libguestfs uses to connect to the back end
1394 guestfsd daemon. Possible methods are:
1400 Launch an appliance and connect to it. This is the ordinary method
1403 =item C<unix:I<path>>
1405 Connect to the Unix domain socket I<path>.
1407 This method lets you connect to an existing daemon or (using
1408 virtio-serial) to a live guest. For more information, see
1409 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1413 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1414 [InitNone, Always, TestOutput (
1415 [["get_attach_method"]], "appliance")],
1416 "get the attach method",
1418 Return the current attach method. See C<guestfs_set_attach_method>.");
1422 (* daemon_functions are any functions which cause some action
1423 * to take place in the daemon.
1426 let daemon_functions = [
1427 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1428 [InitEmpty, Always, TestOutput (
1429 [["part_disk"; "/dev/sda"; "mbr"];
1430 ["mkfs"; "ext2"; "/dev/sda1"];
1431 ["mount"; "/dev/sda1"; "/"];
1432 ["write"; "/new"; "new file contents"];
1433 ["cat"; "/new"]], "new file contents")],
1434 "mount a guest disk at a position in the filesystem",
1436 Mount a guest disk at a position in the filesystem. Block devices
1437 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1438 the guest. If those block devices contain partitions, they will have
1439 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1442 The rules are the same as for L<mount(2)>: A filesystem must
1443 first be mounted on C</> before others can be mounted. Other
1444 filesystems can only be mounted on directories which already
1447 The mounted filesystem is writable, if we have sufficient permissions
1448 on the underlying device.
1451 When you use this call, the filesystem options C<sync> and C<noatime>
1452 are set implicitly. This was originally done because we thought it
1453 would improve reliability, but it turns out that I<-o sync> has a
1454 very large negative performance impact and negligible effect on
1455 reliability. Therefore we recommend that you avoid using
1456 C<guestfs_mount> in any code that needs performance, and instead
1457 use C<guestfs_mount_options> (use an empty string for the first
1458 parameter if you don't want any options).");
1460 ("sync", (RErr, [], []), 2, [],
1461 [ InitEmpty, Always, TestRun [["sync"]]],
1462 "sync disks, writes are flushed through to the disk image",
1464 This syncs the disk, so that any writes are flushed through to the
1465 underlying disk image.
1467 You should always call this if you have modified a disk image, before
1468 closing the handle.");
1470 ("touch", (RErr, [Pathname "path"], []), 3, [],
1471 [InitScratchFS, Always, TestOutputTrue (
1472 [["touch"; "/touch"];
1473 ["exists"; "/touch"]])],
1474 "update file timestamps or create a new file",
1476 Touch acts like the L<touch(1)> command. It can be used to
1477 update the timestamps on a file, or, if the file does not exist,
1478 to create a new zero-length file.
1480 This command only works on regular files, and will fail on other
1481 file types such as directories, symbolic links, block special etc.");
1483 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1484 [InitISOFS, Always, TestOutput (
1485 [["cat"; "/known-2"]], "abcdef\n")],
1486 "list the contents of a file",
1488 Return the contents of the file named C<path>.
1490 Note that this function cannot correctly handle binary files
1491 (specifically, files containing C<\\0> character which is treated
1492 as end of string). For those you need to use the C<guestfs_read_file>
1493 or C<guestfs_download> functions which have a more complex interface.");
1495 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1496 [], (* XXX Tricky to test because it depends on the exact format
1497 * of the 'ls -l' command, which changes between F10 and F11.
1499 "list the files in a directory (long format)",
1501 List the files in C<directory> (relative to the root directory,
1502 there is no cwd) in the format of 'ls -la'.
1504 This command is mostly useful for interactive sessions. It
1505 is I<not> intended that you try to parse the output string.");
1507 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1508 [InitScratchFS, Always, TestOutputList (
1510 ["touch"; "/ls/new"];
1511 ["touch"; "/ls/newer"];
1512 ["touch"; "/ls/newest"];
1513 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1514 "list the files in a directory",
1516 List the files in C<directory> (relative to the root directory,
1517 there is no cwd). The '.' and '..' entries are not returned, but
1518 hidden files are shown.
1520 This command is mostly useful for interactive sessions. Programs
1521 should probably use C<guestfs_readdir> instead.");
1523 ("list_devices", (RStringList "devices", [], []), 7, [],
1524 [InitEmpty, Always, TestOutputListOfDevices (
1525 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1526 "list the block devices",
1528 List all the block devices.
1530 The full block device names are returned, eg. C</dev/sda>.
1532 See also C<guestfs_list_filesystems>.");
1534 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1535 [InitBasicFS, Always, TestOutputListOfDevices (
1536 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1537 InitEmpty, Always, TestOutputListOfDevices (
1538 [["part_init"; "/dev/sda"; "mbr"];
1539 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1540 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1541 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1542 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1543 "list the partitions",
1545 List all the partitions detected on all block devices.
1547 The full partition device names are returned, eg. C</dev/sda1>
1549 This does not return logical volumes. For that you will need to
1550 call C<guestfs_lvs>.
1552 See also C<guestfs_list_filesystems>.");
1554 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1555 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1556 [["pvs"]], ["/dev/sda1"]);
1557 InitEmpty, Always, TestOutputListOfDevices (
1558 [["part_init"; "/dev/sda"; "mbr"];
1559 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1560 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1561 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1562 ["pvcreate"; "/dev/sda1"];
1563 ["pvcreate"; "/dev/sda2"];
1564 ["pvcreate"; "/dev/sda3"];
1565 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1566 "list the LVM physical volumes (PVs)",
1568 List all the physical volumes detected. This is the equivalent
1569 of the L<pvs(8)> command.
1571 This returns a list of just the device names that contain
1572 PVs (eg. C</dev/sda2>).
1574 See also C<guestfs_pvs_full>.");
1576 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1577 [InitBasicFSonLVM, Always, TestOutputList (
1579 InitEmpty, Always, TestOutputList (
1580 [["part_init"; "/dev/sda"; "mbr"];
1581 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1582 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1583 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1584 ["pvcreate"; "/dev/sda1"];
1585 ["pvcreate"; "/dev/sda2"];
1586 ["pvcreate"; "/dev/sda3"];
1587 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1588 ["vgcreate"; "VG2"; "/dev/sda3"];
1589 ["vgs"]], ["VG1"; "VG2"])],
1590 "list the LVM volume groups (VGs)",
1592 List all the volumes groups detected. This is the equivalent
1593 of the L<vgs(8)> command.
1595 This returns a list of just the volume group names that were
1596 detected (eg. C<VolGroup00>).
1598 See also C<guestfs_vgs_full>.");
1600 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1601 [InitBasicFSonLVM, Always, TestOutputList (
1602 [["lvs"]], ["/dev/VG/LV"]);
1603 InitEmpty, Always, TestOutputList (
1604 [["part_init"; "/dev/sda"; "mbr"];
1605 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1606 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1607 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1608 ["pvcreate"; "/dev/sda1"];
1609 ["pvcreate"; "/dev/sda2"];
1610 ["pvcreate"; "/dev/sda3"];
1611 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1612 ["vgcreate"; "VG2"; "/dev/sda3"];
1613 ["lvcreate"; "LV1"; "VG1"; "50"];
1614 ["lvcreate"; "LV2"; "VG1"; "50"];
1615 ["lvcreate"; "LV3"; "VG2"; "50"];
1616 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1617 "list the LVM logical volumes (LVs)",
1619 List all the logical volumes detected. This is the equivalent
1620 of the L<lvs(8)> command.
1622 This returns a list of the logical volume device names
1623 (eg. C</dev/VolGroup00/LogVol00>).
1625 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1627 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1628 [], (* XXX how to test? *)
1629 "list the LVM physical volumes (PVs)",
1631 List all the physical volumes detected. This is the equivalent
1632 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1634 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1635 [], (* XXX how to test? *)
1636 "list the LVM volume groups (VGs)",
1638 List all the volumes groups detected. This is the equivalent
1639 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1641 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1642 [], (* XXX how to test? *)
1643 "list the LVM logical volumes (LVs)",
1645 List all the logical volumes detected. This is the equivalent
1646 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1648 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1649 [InitISOFS, Always, TestOutputList (
1650 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1651 InitISOFS, Always, TestOutputList (
1652 [["read_lines"; "/empty"]], [])],
1653 "read file as lines",
1655 Return the contents of the file named C<path>.
1657 The file contents are returned as a list of lines. Trailing
1658 C<LF> and C<CRLF> character sequences are I<not> returned.
1660 Note that this function cannot correctly handle binary files
1661 (specifically, files containing C<\\0> character which is treated
1662 as end of line). For those you need to use the C<guestfs_read_file>
1663 function which has a more complex interface.");
1665 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1666 [], (* XXX Augeas code needs tests. *)
1667 "create a new Augeas handle",
1669 Create a new Augeas handle for editing configuration files.
1670 If there was any previous Augeas handle associated with this
1671 guestfs session, then it is closed.
1673 You must call this before using any other C<guestfs_aug_*>
1676 C<root> is the filesystem root. C<root> must not be NULL,
1679 The flags are the same as the flags defined in
1680 E<lt>augeas.hE<gt>, the logical I<or> of the following
1685 =item C<AUG_SAVE_BACKUP> = 1
1687 Keep the original file with a C<.augsave> extension.
1689 =item C<AUG_SAVE_NEWFILE> = 2
1691 Save changes into a file with extension C<.augnew>, and
1692 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1694 =item C<AUG_TYPE_CHECK> = 4
1696 Typecheck lenses (can be expensive).
1698 =item C<AUG_NO_STDINC> = 8
1700 Do not use standard load path for modules.
1702 =item C<AUG_SAVE_NOOP> = 16
1704 Make save a no-op, just record what would have been changed.
1706 =item C<AUG_NO_LOAD> = 32
1708 Do not load the tree in C<guestfs_aug_init>.
1712 To close the handle, you can call C<guestfs_aug_close>.
1714 To find out more about Augeas, see L<http://augeas.net/>.");
1716 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1717 [], (* XXX Augeas code needs tests. *)
1718 "close the current Augeas handle",
1720 Close the current Augeas handle and free up any resources
1721 used by it. After calling this, you have to call
1722 C<guestfs_aug_init> again before you can use any other
1723 Augeas functions.");
1725 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1726 [], (* XXX Augeas code needs tests. *)
1727 "define an Augeas variable",
1729 Defines an Augeas variable C<name> whose value is the result
1730 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1733 On success this returns the number of nodes in C<expr>, or
1734 C<0> if C<expr> evaluates to something which is not a nodeset.");
1736 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1737 [], (* XXX Augeas code needs tests. *)
1738 "define an Augeas node",
1740 Defines a variable C<name> whose value is the result of
1743 If C<expr> evaluates to an empty nodeset, a node is created,
1744 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1745 C<name> will be the nodeset containing that single node.
1747 On success this returns a pair containing the
1748 number of nodes in the nodeset, and a boolean flag
1749 if a node was created.");
1751 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1752 [], (* XXX Augeas code needs tests. *)
1753 "look up the value of an Augeas path",
1755 Look up the value associated with C<path>. If C<path>
1756 matches exactly one node, the C<value> is returned.");
1758 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1759 [], (* XXX Augeas code needs tests. *)
1760 "set Augeas path to value",
1762 Set the value associated with C<path> to C<val>.
1764 In the Augeas API, it is possible to clear a node by setting
1765 the value to NULL. Due to an oversight in the libguestfs API
1766 you cannot do that with this call. Instead you must use the
1767 C<guestfs_aug_clear> call.");
1769 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1770 [], (* XXX Augeas code needs tests. *)
1771 "insert a sibling Augeas node",
1773 Create a new sibling C<label> for C<path>, inserting it into
1774 the tree before or after C<path> (depending on the boolean
1777 C<path> must match exactly one existing node in the tree, and
1778 C<label> must be a label, ie. not contain C</>, C<*> or end
1779 with a bracketed index C<[N]>.");
1781 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1782 [], (* XXX Augeas code needs tests. *)
1783 "remove an Augeas path",
1785 Remove C<path> and all of its children.
1787 On success this returns the number of entries which were removed.");
1789 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1790 [], (* XXX Augeas code needs tests. *)
1793 Move the node C<src> to C<dest>. C<src> must match exactly
1794 one node. C<dest> is overwritten if it exists.");
1796 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1797 [], (* XXX Augeas code needs tests. *)
1798 "return Augeas nodes which match augpath",
1800 Returns a list of paths which match the path expression C<path>.
1801 The returned paths are sufficiently qualified so that they match
1802 exactly one node in the current tree.");
1804 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1805 [], (* XXX Augeas code needs tests. *)
1806 "write all pending Augeas changes to disk",
1808 This writes all pending changes to disk.
1810 The flags which were passed to C<guestfs_aug_init> affect exactly
1811 how files are saved.");
1813 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1814 [], (* XXX Augeas code needs tests. *)
1815 "load files into the tree",
1817 Load files into the tree.
1819 See C<aug_load> in the Augeas documentation for the full gory
1822 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1823 [], (* XXX Augeas code needs tests. *)
1824 "list Augeas nodes under augpath",
1826 This is just a shortcut for listing C<guestfs_aug_match>
1827 C<path/*> and sorting the resulting nodes into alphabetical order.");
1829 ("rm", (RErr, [Pathname "path"], []), 29, [],
1830 [InitScratchFS, Always, TestRun
1832 ["touch"; "/rm/new"];
1834 InitScratchFS, Always, TestLastFail
1835 [["rm"; "/nosuchfile"]];
1836 InitScratchFS, Always, TestLastFail
1841 Remove the single file C<path>.");
1843 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1844 [InitScratchFS, Always, TestRun
1845 [["mkdir"; "/rmdir"];
1846 ["rmdir"; "/rmdir"]];
1847 InitScratchFS, Always, TestLastFail
1848 [["rmdir"; "/rmdir2"]];
1849 InitScratchFS, Always, TestLastFail
1850 [["mkdir"; "/rmdir3"];
1851 ["touch"; "/rmdir3/new"];
1852 ["rmdir"; "/rmdir3/new"]]],
1853 "remove a directory",
1855 Remove the single directory C<path>.");
1857 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1858 [InitScratchFS, Always, TestOutputFalse
1859 [["mkdir"; "/rm_rf"];
1860 ["mkdir"; "/rm_rf/foo"];
1861 ["touch"; "/rm_rf/foo/bar"];
1862 ["rm_rf"; "/rm_rf"];
1863 ["exists"; "/rm_rf"]]],
1864 "remove a file or directory recursively",
1866 Remove the file or directory C<path>, recursively removing the
1867 contents if its a directory. This is like the C<rm -rf> shell
1870 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1871 [InitScratchFS, Always, TestOutputTrue
1872 [["mkdir"; "/mkdir"];
1873 ["is_dir"; "/mkdir"]];
1874 InitScratchFS, Always, TestLastFail
1875 [["mkdir"; "/mkdir2/foo/bar"]]],
1876 "create a directory",
1878 Create a directory named C<path>.");
1880 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1881 [InitScratchFS, Always, TestOutputTrue
1882 [["mkdir_p"; "/mkdir_p/foo/bar"];
1883 ["is_dir"; "/mkdir_p/foo/bar"]];
1884 InitScratchFS, Always, TestOutputTrue
1885 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1886 ["is_dir"; "/mkdir_p2/foo"]];
1887 InitScratchFS, Always, TestOutputTrue
1888 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1889 ["is_dir"; "/mkdir_p3"]];
1890 (* Regression tests for RHBZ#503133: *)
1891 InitScratchFS, Always, TestRun
1892 [["mkdir"; "/mkdir_p4"];
1893 ["mkdir_p"; "/mkdir_p4"]];
1894 InitScratchFS, Always, TestLastFail
1895 [["touch"; "/mkdir_p5"];
1896 ["mkdir_p"; "/mkdir_p5"]]],
1897 "create a directory and parents",
1899 Create a directory named C<path>, creating any parent directories
1900 as necessary. This is like the C<mkdir -p> shell command.");
1902 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1903 [], (* XXX Need stat command to test *)
1906 Change the mode (permissions) of C<path> to C<mode>. Only
1907 numeric modes are supported.
1909 I<Note>: When using this command from guestfish, C<mode>
1910 by default would be decimal, unless you prefix it with
1911 C<0> to get octal, ie. use C<0700> not C<700>.
1913 The mode actually set is affected by the umask.");
1915 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1916 [], (* XXX Need stat command to test *)
1917 "change file owner and group",
1919 Change the file owner to C<owner> and group to C<group>.
1921 Only numeric uid and gid are supported. If you want to use
1922 names, you will need to locate and parse the password file
1923 yourself (Augeas support makes this relatively easy).");
1925 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1926 [InitISOFS, Always, TestOutputTrue (
1927 [["exists"; "/empty"]]);
1928 InitISOFS, Always, TestOutputTrue (
1929 [["exists"; "/directory"]])],
1930 "test if file or directory exists",
1932 This returns C<true> if and only if there is a file, directory
1933 (or anything) with the given C<path> name.
1935 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1937 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1938 [InitISOFS, Always, TestOutputTrue (
1939 [["is_file"; "/known-1"]]);
1940 InitISOFS, Always, TestOutputFalse (
1941 [["is_file"; "/directory"]])],
1942 "test if a regular file",
1944 This returns C<true> if and only if there is a regular file
1945 with the given C<path> name. Note that it returns false for
1946 other objects like directories.
1948 See also C<guestfs_stat>.");
1950 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1951 [InitISOFS, Always, TestOutputFalse (
1952 [["is_dir"; "/known-3"]]);
1953 InitISOFS, Always, TestOutputTrue (
1954 [["is_dir"; "/directory"]])],
1955 "test if a directory",
1957 This returns C<true> if and only if there is a directory
1958 with the given C<path> name. Note that it returns false for
1959 other objects like files.
1961 See also C<guestfs_stat>.");
1963 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1964 [InitEmpty, Always, TestOutputListOfDevices (
1965 [["part_init"; "/dev/sda"; "mbr"];
1966 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1967 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1968 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1969 ["pvcreate"; "/dev/sda1"];
1970 ["pvcreate"; "/dev/sda2"];
1971 ["pvcreate"; "/dev/sda3"];
1972 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1973 "create an LVM physical volume",
1975 This creates an LVM physical volume on the named C<device>,
1976 where C<device> should usually be a partition name such
1979 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
1980 [InitEmpty, Always, TestOutputList (
1981 [["part_init"; "/dev/sda"; "mbr"];
1982 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1983 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1984 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1985 ["pvcreate"; "/dev/sda1"];
1986 ["pvcreate"; "/dev/sda2"];
1987 ["pvcreate"; "/dev/sda3"];
1988 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1989 ["vgcreate"; "VG2"; "/dev/sda3"];
1990 ["vgs"]], ["VG1"; "VG2"])],
1991 "create an LVM volume group",
1993 This creates an LVM volume group called C<volgroup>
1994 from the non-empty list of physical volumes C<physvols>.");
1996 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
1997 [InitEmpty, Always, TestOutputList (
1998 [["part_init"; "/dev/sda"; "mbr"];
1999 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2000 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2001 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2002 ["pvcreate"; "/dev/sda1"];
2003 ["pvcreate"; "/dev/sda2"];
2004 ["pvcreate"; "/dev/sda3"];
2005 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2006 ["vgcreate"; "VG2"; "/dev/sda3"];
2007 ["lvcreate"; "LV1"; "VG1"; "50"];
2008 ["lvcreate"; "LV2"; "VG1"; "50"];
2009 ["lvcreate"; "LV3"; "VG2"; "50"];
2010 ["lvcreate"; "LV4"; "VG2"; "50"];
2011 ["lvcreate"; "LV5"; "VG2"; "50"];
2013 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2014 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2015 "create an LVM logical volume",
2017 This creates an LVM logical volume called C<logvol>
2018 on the volume group C<volgroup>, with C<size> megabytes.");
2020 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2021 [InitEmpty, Always, TestOutput (
2022 [["part_disk"; "/dev/sda"; "mbr"];
2023 ["mkfs"; "ext2"; "/dev/sda1"];
2024 ["mount_options"; ""; "/dev/sda1"; "/"];
2025 ["write"; "/new"; "new file contents"];
2026 ["cat"; "/new"]], "new file contents")],
2027 "make a filesystem",
2029 This creates a filesystem on C<device> (usually a partition
2030 or LVM logical volume). The filesystem type is C<fstype>, for
2033 ("sfdisk", (RErr, [Device "device";
2034 Int "cyls"; Int "heads"; Int "sectors";
2035 StringList "lines"], []), 43, [DangerWillRobinson],
2037 "create partitions on a block device",
2039 This is a direct interface to the L<sfdisk(8)> program for creating
2040 partitions on block devices.
2042 C<device> should be a block device, for example C</dev/sda>.
2044 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2045 and sectors on the device, which are passed directly to sfdisk as
2046 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2047 of these, then the corresponding parameter is omitted. Usually for
2048 'large' disks, you can just pass C<0> for these, but for small
2049 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2050 out the right geometry and you will need to tell it.
2052 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2053 information refer to the L<sfdisk(8)> manpage.
2055 To create a single partition occupying the whole disk, you would
2056 pass C<lines> as a single element list, when the single element being
2057 the string C<,> (comma).
2059 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2060 C<guestfs_part_init>");
2062 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2063 (* Regression test for RHBZ#597135. *)
2064 [InitScratchFS, Always, TestLastFail
2065 [["write_file"; "/write_file"; "abc"; "10000"]]],
2068 This call creates a file called C<path>. The contents of the
2069 file is the string C<content> (which can contain any 8 bit data),
2070 with length C<size>.
2072 As a special case, if C<size> is C<0>
2073 then the length is calculated using C<strlen> (so in this case
2074 the content cannot contain embedded ASCII NULs).
2076 I<NB.> Owing to a bug, writing content containing ASCII NUL
2077 characters does I<not> work, even if the length is specified.");
2079 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2080 [InitEmpty, Always, TestOutputListOfDevices (
2081 [["part_disk"; "/dev/sda"; "mbr"];
2082 ["mkfs"; "ext2"; "/dev/sda1"];
2083 ["mount_options"; ""; "/dev/sda1"; "/"];
2084 ["mounts"]], ["/dev/sda1"]);
2085 InitEmpty, Always, TestOutputList (
2086 [["part_disk"; "/dev/sda"; "mbr"];
2087 ["mkfs"; "ext2"; "/dev/sda1"];
2088 ["mount_options"; ""; "/dev/sda1"; "/"];
2091 "unmount a filesystem",
2093 This unmounts the given filesystem. The filesystem may be
2094 specified either by its mountpoint (path) or the device which
2095 contains the filesystem.");
2097 ("mounts", (RStringList "devices", [], []), 46, [],
2098 [InitScratchFS, Always, TestOutputListOfDevices (
2099 [["mounts"]], ["/dev/sdb1"])],
2100 "show mounted filesystems",
2102 This returns the list of currently mounted filesystems. It returns
2103 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2105 Some internal mounts are not shown.
2107 See also: C<guestfs_mountpoints>");
2109 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2110 [InitScratchFS, Always, TestOutputList (
2113 (* check that umount_all can unmount nested mounts correctly: *)
2114 InitEmpty, Always, TestOutputList (
2115 [["part_init"; "/dev/sda"; "mbr"];
2116 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2117 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2118 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2119 ["mkfs"; "ext2"; "/dev/sda1"];
2120 ["mkfs"; "ext2"; "/dev/sda2"];
2121 ["mkfs"; "ext2"; "/dev/sda3"];
2122 ["mount_options"; ""; "/dev/sda1"; "/"];
2124 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2125 ["mkdir"; "/mp1/mp2"];
2126 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2127 ["mkdir"; "/mp1/mp2/mp3"];
2130 "unmount all filesystems",
2132 This unmounts all mounted filesystems.
2134 Some internal mounts are not unmounted by this call.");
2136 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2138 "remove all LVM LVs, VGs and PVs",
2140 This command removes all LVM logical volumes, volume groups
2141 and physical volumes.");
2143 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2144 [InitISOFS, Always, TestOutput (
2145 [["file"; "/empty"]], "empty");
2146 InitISOFS, Always, TestOutput (
2147 [["file"; "/known-1"]], "ASCII text");
2148 InitISOFS, Always, TestLastFail (
2149 [["file"; "/notexists"]]);
2150 InitISOFS, Always, TestOutput (
2151 [["file"; "/abssymlink"]], "symbolic link");
2152 InitISOFS, Always, TestOutput (
2153 [["file"; "/directory"]], "directory")],
2154 "determine file type",
2156 This call uses the standard L<file(1)> command to determine
2157 the type or contents of the file.
2159 This call will also transparently look inside various types
2162 The exact command which runs is C<file -zb path>. Note in
2163 particular that the filename is not prepended to the output
2166 This command can also be used on C</dev/> devices
2167 (and partitions, LV names). You can for example use this
2168 to determine if a device contains a filesystem, although
2169 it's usually better to use C<guestfs_vfs_type>.
2171 If the C<path> does not begin with C</dev/> then
2172 this command only works for the content of regular files.
2173 For other file types (directory, symbolic link etc) it
2174 will just return the string C<directory> etc.");
2176 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2177 [InitScratchFS, Always, TestOutput (
2178 [["mkdir"; "/command"];
2179 ["upload"; "test-command"; "/command/test-command"];
2180 ["chmod"; "0o755"; "/command/test-command"];
2181 ["command"; "/command/test-command 1"]], "Result1");
2182 InitScratchFS, Always, TestOutput (
2183 [["mkdir"; "/command2"];
2184 ["upload"; "test-command"; "/command2/test-command"];
2185 ["chmod"; "0o755"; "/command2/test-command"];
2186 ["command"; "/command2/test-command 2"]], "Result2\n");
2187 InitScratchFS, Always, TestOutput (
2188 [["mkdir"; "/command3"];
2189 ["upload"; "test-command"; "/command3/test-command"];
2190 ["chmod"; "0o755"; "/command3/test-command"];
2191 ["command"; "/command3/test-command 3"]], "\nResult3");
2192 InitScratchFS, Always, TestOutput (
2193 [["mkdir"; "/command4"];
2194 ["upload"; "test-command"; "/command4/test-command"];
2195 ["chmod"; "0o755"; "/command4/test-command"];
2196 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2197 InitScratchFS, Always, TestOutput (
2198 [["mkdir"; "/command5"];
2199 ["upload"; "test-command"; "/command5/test-command"];
2200 ["chmod"; "0o755"; "/command5/test-command"];
2201 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2202 InitScratchFS, Always, TestOutput (
2203 [["mkdir"; "/command6"];
2204 ["upload"; "test-command"; "/command6/test-command"];
2205 ["chmod"; "0o755"; "/command6/test-command"];
2206 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2207 InitScratchFS, Always, TestOutput (
2208 [["mkdir"; "/command7"];
2209 ["upload"; "test-command"; "/command7/test-command"];
2210 ["chmod"; "0o755"; "/command7/test-command"];
2211 ["command"; "/command7/test-command 7"]], "");
2212 InitScratchFS, Always, TestOutput (
2213 [["mkdir"; "/command8"];
2214 ["upload"; "test-command"; "/command8/test-command"];
2215 ["chmod"; "0o755"; "/command8/test-command"];
2216 ["command"; "/command8/test-command 8"]], "\n");
2217 InitScratchFS, Always, TestOutput (
2218 [["mkdir"; "/command9"];
2219 ["upload"; "test-command"; "/command9/test-command"];
2220 ["chmod"; "0o755"; "/command9/test-command"];
2221 ["command"; "/command9/test-command 9"]], "\n\n");
2222 InitScratchFS, Always, TestOutput (
2223 [["mkdir"; "/command10"];
2224 ["upload"; "test-command"; "/command10/test-command"];
2225 ["chmod"; "0o755"; "/command10/test-command"];
2226 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2227 InitScratchFS, Always, TestOutput (
2228 [["mkdir"; "/command11"];
2229 ["upload"; "test-command"; "/command11/test-command"];
2230 ["chmod"; "0o755"; "/command11/test-command"];
2231 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2232 InitScratchFS, Always, TestLastFail (
2233 [["mkdir"; "/command12"];
2234 ["upload"; "test-command"; "/command12/test-command"];
2235 ["chmod"; "0o755"; "/command12/test-command"];
2236 ["command"; "/command12/test-command"]])],
2237 "run a command from the guest filesystem",
2239 This call runs a command from the guest filesystem. The
2240 filesystem must be mounted, and must contain a compatible
2241 operating system (ie. something Linux, with the same
2242 or compatible processor architecture).
2244 The single parameter is an argv-style list of arguments.
2245 The first element is the name of the program to run.
2246 Subsequent elements are parameters. The list must be
2247 non-empty (ie. must contain a program name). Note that
2248 the command runs directly, and is I<not> invoked via
2249 the shell (see C<guestfs_sh>).
2251 The return value is anything printed to I<stdout> by
2254 If the command returns a non-zero exit status, then
2255 this function returns an error message. The error message
2256 string is the content of I<stderr> from the command.
2258 The C<$PATH> environment variable will contain at least
2259 C</usr/bin> and C</bin>. If you require a program from
2260 another location, you should provide the full path in the
2263 Shared libraries and data files required by the program
2264 must be available on filesystems which are mounted in the
2265 correct places. It is the caller's responsibility to ensure
2266 all filesystems that are needed are mounted at the right
2269 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2270 [InitScratchFS, Always, TestOutputList (
2271 [["mkdir"; "/command_lines"];
2272 ["upload"; "test-command"; "/command_lines/test-command"];
2273 ["chmod"; "0o755"; "/command_lines/test-command"];
2274 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2275 InitScratchFS, Always, TestOutputList (
2276 [["mkdir"; "/command_lines2"];
2277 ["upload"; "test-command"; "/command_lines2/test-command"];
2278 ["chmod"; "0o755"; "/command_lines2/test-command"];
2279 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2280 InitScratchFS, Always, TestOutputList (
2281 [["mkdir"; "/command_lines3"];
2282 ["upload"; "test-command"; "/command_lines3/test-command"];
2283 ["chmod"; "0o755"; "/command_lines3/test-command"];
2284 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2285 InitScratchFS, Always, TestOutputList (
2286 [["mkdir"; "/command_lines4"];
2287 ["upload"; "test-command"; "/command_lines4/test-command"];
2288 ["chmod"; "0o755"; "/command_lines4/test-command"];
2289 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2290 InitScratchFS, Always, TestOutputList (
2291 [["mkdir"; "/command_lines5"];
2292 ["upload"; "test-command"; "/command_lines5/test-command"];
2293 ["chmod"; "0o755"; "/command_lines5/test-command"];
2294 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2295 InitScratchFS, Always, TestOutputList (
2296 [["mkdir"; "/command_lines6"];
2297 ["upload"; "test-command"; "/command_lines6/test-command"];
2298 ["chmod"; "0o755"; "/command_lines6/test-command"];
2299 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2300 InitScratchFS, Always, TestOutputList (
2301 [["mkdir"; "/command_lines7"];
2302 ["upload"; "test-command"; "/command_lines7/test-command"];
2303 ["chmod"; "0o755"; "/command_lines7/test-command"];
2304 ["command_lines"; "/command_lines7/test-command 7"]], []);
2305 InitScratchFS, Always, TestOutputList (
2306 [["mkdir"; "/command_lines8"];
2307 ["upload"; "test-command"; "/command_lines8/test-command"];
2308 ["chmod"; "0o755"; "/command_lines8/test-command"];
2309 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2310 InitScratchFS, Always, TestOutputList (
2311 [["mkdir"; "/command_lines9"];
2312 ["upload"; "test-command"; "/command_lines9/test-command"];
2313 ["chmod"; "0o755"; "/command_lines9/test-command"];
2314 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2315 InitScratchFS, Always, TestOutputList (
2316 [["mkdir"; "/command_lines10"];
2317 ["upload"; "test-command"; "/command_lines10/test-command"];
2318 ["chmod"; "0o755"; "/command_lines10/test-command"];
2319 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2320 InitScratchFS, Always, TestOutputList (
2321 [["mkdir"; "/command_lines11"];
2322 ["upload"; "test-command"; "/command_lines11/test-command"];
2323 ["chmod"; "0o755"; "/command_lines11/test-command"];
2324 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2325 "run a command, returning lines",
2327 This is the same as C<guestfs_command>, but splits the
2328 result into a list of lines.
2330 See also: C<guestfs_sh_lines>");
2332 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2333 [InitISOFS, Always, TestOutputStruct (
2334 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2335 "get file information",
2337 Returns file information for the given C<path>.
2339 This is the same as the C<stat(2)> system call.");
2341 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2342 [InitISOFS, Always, TestOutputStruct (
2343 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2344 "get file information for a symbolic link",
2346 Returns file information for the given C<path>.
2348 This is the same as C<guestfs_stat> except that if C<path>
2349 is a symbolic link, then the link is stat-ed, not the file it
2352 This is the same as the C<lstat(2)> system call.");
2354 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2355 [InitISOFS, Always, TestOutputStruct (
2356 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2357 "get file system statistics",
2359 Returns file system statistics for any mounted file system.
2360 C<path> should be a file or directory in the mounted file system
2361 (typically it is the mount point itself, but it doesn't need to be).
2363 This is the same as the C<statvfs(2)> system call.");
2365 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2367 "get ext2/ext3/ext4 superblock details",
2369 This returns the contents of the ext2, ext3 or ext4 filesystem
2370 superblock on C<device>.
2372 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2373 manpage for more details. The list of fields returned isn't
2374 clearly defined, and depends on both the version of C<tune2fs>
2375 that libguestfs was built against, and the filesystem itself.");
2377 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2378 [InitEmpty, Always, TestOutputTrue (
2379 [["blockdev_setro"; "/dev/sda"];
2380 ["blockdev_getro"; "/dev/sda"]])],
2381 "set block device to read-only",
2383 Sets the block device named C<device> to read-only.
2385 This uses the L<blockdev(8)> command.");
2387 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2388 [InitEmpty, Always, TestOutputFalse (
2389 [["blockdev_setrw"; "/dev/sda"];
2390 ["blockdev_getro"; "/dev/sda"]])],
2391 "set block device to read-write",
2393 Sets the block device named C<device> to read-write.
2395 This uses the L<blockdev(8)> command.");
2397 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2398 [InitEmpty, Always, TestOutputTrue (
2399 [["blockdev_setro"; "/dev/sda"];
2400 ["blockdev_getro"; "/dev/sda"]])],
2401 "is block device set to read-only",
2403 Returns a boolean indicating if the block device is read-only
2404 (true if read-only, false if not).
2406 This uses the L<blockdev(8)> command.");
2408 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2409 [InitEmpty, Always, TestOutputInt (
2410 [["blockdev_getss"; "/dev/sda"]], 512)],
2411 "get sectorsize of block device",
2413 This returns the size of sectors on a block device.
2414 Usually 512, but can be larger for modern devices.
2416 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2419 This uses the L<blockdev(8)> command.");
2421 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2422 [InitEmpty, Always, TestOutputInt (
2423 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2424 "get blocksize of block device",
2426 This returns the block size of a device.
2428 (Note this is different from both I<size in blocks> and
2429 I<filesystem block size>).
2431 This uses the L<blockdev(8)> command.");
2433 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2435 "set blocksize of block device",
2437 This sets the block size of a device.
2439 (Note this is different from both I<size in blocks> and
2440 I<filesystem block size>).
2442 This uses the L<blockdev(8)> command.");
2444 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2445 [InitEmpty, Always, TestOutputInt (
2446 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2447 "get total size of device in 512-byte sectors",
2449 This returns the size of the device in units of 512-byte sectors
2450 (even if the sectorsize isn't 512 bytes ... weird).
2452 See also C<guestfs_blockdev_getss> for the real sector size of
2453 the device, and C<guestfs_blockdev_getsize64> for the more
2454 useful I<size in bytes>.
2456 This uses the L<blockdev(8)> command.");
2458 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2459 [InitEmpty, Always, TestOutputInt (
2460 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2461 "get total size of device in bytes",
2463 This returns the size of the device in bytes.
2465 See also C<guestfs_blockdev_getsz>.
2467 This uses the L<blockdev(8)> command.");
2469 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2470 [InitEmpty, Always, TestRun
2471 [["blockdev_flushbufs"; "/dev/sda"]]],
2472 "flush device buffers",
2474 This tells the kernel to flush internal buffers associated
2477 This uses the L<blockdev(8)> command.");
2479 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2480 [InitEmpty, Always, TestRun
2481 [["blockdev_rereadpt"; "/dev/sda"]]],
2482 "reread partition table",
2484 Reread the partition table on C<device>.
2486 This uses the L<blockdev(8)> command.");
2488 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2489 [InitScratchFS, Always, TestOutput (
2490 (* Pick a file from cwd which isn't likely to change. *)
2491 [["mkdir"; "/upload"];
2492 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2493 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2494 Digest.to_hex (Digest.file "COPYING.LIB"))],
2495 "upload a file from the local machine",
2497 Upload local file C<filename> to C<remotefilename> on the
2500 C<filename> can also be a named pipe.
2502 See also C<guestfs_download>.");
2504 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2505 [InitScratchFS, Always, TestOutput (
2506 (* Pick a file from cwd which isn't likely to change. *)
2507 [["mkdir"; "/download"];
2508 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2509 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2510 ["upload"; "testdownload.tmp"; "/download/upload"];
2511 ["checksum"; "md5"; "/download/upload"]],
2512 Digest.to_hex (Digest.file "COPYING.LIB"))],
2513 "download a file to the local machine",
2515 Download file C<remotefilename> and save it as C<filename>
2516 on the local machine.
2518 C<filename> can also be a named pipe.
2520 See also C<guestfs_upload>, C<guestfs_cat>.");
2522 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2523 [InitISOFS, Always, TestOutput (
2524 [["checksum"; "crc"; "/known-3"]], "2891671662");
2525 InitISOFS, Always, TestLastFail (
2526 [["checksum"; "crc"; "/notexists"]]);
2527 InitISOFS, Always, TestOutput (
2528 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2529 InitISOFS, Always, TestOutput (
2530 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2531 InitISOFS, Always, TestOutput (
2532 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2533 InitISOFS, Always, TestOutput (
2534 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2535 InitISOFS, Always, TestOutput (
2536 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2537 InitISOFS, Always, TestOutput (
2538 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2539 (* Test for RHBZ#579608, absolute symbolic links. *)
2540 InitISOFS, Always, TestOutput (
2541 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2542 "compute MD5, SHAx or CRC checksum of file",
2544 This call computes the MD5, SHAx or CRC checksum of the
2547 The type of checksum to compute is given by the C<csumtype>
2548 parameter which must have one of the following values:
2554 Compute the cyclic redundancy check (CRC) specified by POSIX
2555 for the C<cksum> command.
2559 Compute the MD5 hash (using the C<md5sum> program).
2563 Compute the SHA1 hash (using the C<sha1sum> program).
2567 Compute the SHA224 hash (using the C<sha224sum> program).
2571 Compute the SHA256 hash (using the C<sha256sum> program).
2575 Compute the SHA384 hash (using the C<sha384sum> program).
2579 Compute the SHA512 hash (using the C<sha512sum> program).
2583 The checksum is returned as a printable string.
2585 To get the checksum for a device, use C<guestfs_checksum_device>.
2587 To get the checksums for many files, use C<guestfs_checksums_out>.");
2589 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2590 [InitScratchFS, Always, TestOutput (
2591 [["mkdir"; "/tar_in"];
2592 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2593 ["cat"; "/tar_in/hello"]], "hello\n")],
2594 "unpack tarfile to directory",
2596 This command uploads and unpacks local file C<tarfile> (an
2597 I<uncompressed> tar file) into C<directory>.
2599 To upload a compressed tarball, use C<guestfs_tgz_in>
2600 or C<guestfs_txz_in>.");
2602 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2604 "pack directory into tarfile",
2606 This command packs the contents of C<directory> and downloads
2607 it to local file C<tarfile>.
2609 To download a compressed tarball, use C<guestfs_tgz_out>
2610 or C<guestfs_txz_out>.");
2612 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2613 [InitScratchFS, Always, TestOutput (
2614 [["mkdir"; "/tgz_in"];
2615 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2616 ["cat"; "/tgz_in/hello"]], "hello\n")],
2617 "unpack compressed tarball to directory",
2619 This command uploads and unpacks local file C<tarball> (a
2620 I<gzip compressed> tar file) into C<directory>.
2622 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2624 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2626 "pack directory into compressed tarball",
2628 This command packs the contents of C<directory> and downloads
2629 it to local file C<tarball>.
2631 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2633 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2634 [InitBasicFS, Always, TestLastFail (
2636 ["mount_ro"; "/dev/sda1"; "/"];
2637 ["touch"; "/new"]]);
2638 InitBasicFS, Always, TestOutput (
2639 [["write"; "/new"; "data"];
2641 ["mount_ro"; "/dev/sda1"; "/"];
2642 ["cat"; "/new"]], "data")],
2643 "mount a guest disk, read-only",
2645 This is the same as the C<guestfs_mount> command, but it
2646 mounts the filesystem with the read-only (I<-o ro>) flag.");
2648 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2650 "mount a guest disk with mount options",
2652 This is the same as the C<guestfs_mount> command, but it
2653 allows you to set the mount options as for the
2654 L<mount(8)> I<-o> flag.
2656 If the C<options> parameter is an empty string, then
2657 no options are passed (all options default to whatever
2658 the filesystem uses).");
2660 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2662 "mount a guest disk with mount options and vfstype",
2664 This is the same as the C<guestfs_mount> command, but it
2665 allows you to set both the mount options and the vfstype
2666 as for the L<mount(8)> I<-o> and I<-t> flags.");
2668 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2670 "debugging and internals",
2672 The C<guestfs_debug> command exposes some internals of
2673 C<guestfsd> (the guestfs daemon) that runs inside the
2676 There is no comprehensive help for this command. You have
2677 to look at the file C<daemon/debug.c> in the libguestfs source
2678 to find out what you can do.");
2680 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2681 [InitEmpty, Always, TestOutputList (
2682 [["part_disk"; "/dev/sda"; "mbr"];
2683 ["pvcreate"; "/dev/sda1"];
2684 ["vgcreate"; "VG"; "/dev/sda1"];
2685 ["lvcreate"; "LV1"; "VG"; "50"];
2686 ["lvcreate"; "LV2"; "VG"; "50"];
2687 ["lvremove"; "/dev/VG/LV1"];
2688 ["lvs"]], ["/dev/VG/LV2"]);
2689 InitEmpty, Always, TestOutputList (
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"];
2695 ["lvremove"; "/dev/VG"];
2697 InitEmpty, Always, TestOutputList (
2698 [["part_disk"; "/dev/sda"; "mbr"];
2699 ["pvcreate"; "/dev/sda1"];
2700 ["vgcreate"; "VG"; "/dev/sda1"];
2701 ["lvcreate"; "LV1"; "VG"; "50"];
2702 ["lvcreate"; "LV2"; "VG"; "50"];
2703 ["lvremove"; "/dev/VG"];
2705 "remove an LVM logical volume",
2707 Remove an LVM logical volume C<device>, where C<device> is
2708 the path to the LV, such as C</dev/VG/LV>.
2710 You can also remove all LVs in a volume group by specifying
2711 the VG name, C</dev/VG>.");
2713 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2714 [InitEmpty, Always, TestOutputList (
2715 [["part_disk"; "/dev/sda"; "mbr"];
2716 ["pvcreate"; "/dev/sda1"];
2717 ["vgcreate"; "VG"; "/dev/sda1"];
2718 ["lvcreate"; "LV1"; "VG"; "50"];
2719 ["lvcreate"; "LV2"; "VG"; "50"];
2722 InitEmpty, Always, TestOutputList (
2723 [["part_disk"; "/dev/sda"; "mbr"];
2724 ["pvcreate"; "/dev/sda1"];
2725 ["vgcreate"; "VG"; "/dev/sda1"];
2726 ["lvcreate"; "LV1"; "VG"; "50"];
2727 ["lvcreate"; "LV2"; "VG"; "50"];
2730 "remove an LVM volume group",
2732 Remove an LVM volume group C<vgname>, (for example C<VG>).
2734 This also forcibly removes all logical volumes in the volume
2737 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2738 [InitEmpty, Always, TestOutputListOfDevices (
2739 [["part_disk"; "/dev/sda"; "mbr"];
2740 ["pvcreate"; "/dev/sda1"];
2741 ["vgcreate"; "VG"; "/dev/sda1"];
2742 ["lvcreate"; "LV1"; "VG"; "50"];
2743 ["lvcreate"; "LV2"; "VG"; "50"];
2745 ["pvremove"; "/dev/sda1"];
2747 InitEmpty, Always, TestOutputListOfDevices (
2748 [["part_disk"; "/dev/sda"; "mbr"];
2749 ["pvcreate"; "/dev/sda1"];
2750 ["vgcreate"; "VG"; "/dev/sda1"];
2751 ["lvcreate"; "LV1"; "VG"; "50"];
2752 ["lvcreate"; "LV2"; "VG"; "50"];
2754 ["pvremove"; "/dev/sda1"];
2756 InitEmpty, Always, TestOutputListOfDevices (
2757 [["part_disk"; "/dev/sda"; "mbr"];
2758 ["pvcreate"; "/dev/sda1"];
2759 ["vgcreate"; "VG"; "/dev/sda1"];
2760 ["lvcreate"; "LV1"; "VG"; "50"];
2761 ["lvcreate"; "LV2"; "VG"; "50"];
2763 ["pvremove"; "/dev/sda1"];
2765 "remove an LVM physical volume",
2767 This wipes a physical volume C<device> so that LVM will no longer
2770 The implementation uses the C<pvremove> command which refuses to
2771 wipe physical volumes that contain any volume groups, so you have
2772 to remove those first.");
2774 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2775 [InitBasicFS, Always, TestOutput (
2776 [["set_e2label"; "/dev/sda1"; "testlabel"];
2777 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2778 "set the ext2/3/4 filesystem label",
2780 This sets the ext2/3/4 filesystem label of the filesystem on
2781 C<device> to C<label>. Filesystem labels are limited to
2784 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2785 to return the existing label on a filesystem.");
2787 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2789 "get the ext2/3/4 filesystem label",
2791 This returns the ext2/3/4 filesystem label of the filesystem on
2794 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2795 (let uuid = uuidgen () in
2796 [InitBasicFS, Always, TestOutput (
2797 [["set_e2uuid"; "/dev/sda1"; uuid];
2798 ["get_e2uuid"; "/dev/sda1"]], uuid);
2799 InitBasicFS, Always, TestOutput (
2800 [["set_e2uuid"; "/dev/sda1"; "clear"];
2801 ["get_e2uuid"; "/dev/sda1"]], "");
2802 (* We can't predict what UUIDs will be, so just check the commands run. *)
2803 InitBasicFS, Always, TestRun (
2804 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2805 InitBasicFS, Always, TestRun (
2806 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2807 "set the ext2/3/4 filesystem UUID",
2809 This sets the ext2/3/4 filesystem UUID of the filesystem on
2810 C<device> to C<uuid>. The format of the UUID and alternatives
2811 such as C<clear>, C<random> and C<time> are described in the
2812 L<tune2fs(8)> manpage.
2814 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2815 to return the existing UUID of a filesystem.");
2817 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2818 (* Regression test for RHBZ#597112. *)
2819 (let uuid = uuidgen () in
2820 [InitNone, Always, TestOutput (
2821 [["mke2journal"; "1024"; "/dev/sdc"];
2822 ["set_e2uuid"; "/dev/sdc"; uuid];
2823 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2824 "get the ext2/3/4 filesystem UUID",
2826 This returns the ext2/3/4 filesystem UUID of the filesystem on
2829 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2830 [InitBasicFS, Always, TestOutputInt (
2831 [["umount"; "/dev/sda1"];
2832 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2833 InitBasicFS, Always, TestOutputInt (
2834 [["umount"; "/dev/sda1"];
2835 ["zero"; "/dev/sda1"];
2836 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2837 "run the filesystem checker",
2839 This runs the filesystem checker (fsck) on C<device> which
2840 should have filesystem type C<fstype>.
2842 The returned integer is the status. See L<fsck(8)> for the
2843 list of status codes from C<fsck>.
2851 Multiple status codes can be summed together.
2855 A non-zero return code can mean \"success\", for example if
2856 errors have been corrected on the filesystem.
2860 Checking or repairing NTFS volumes is not supported
2865 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2867 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2868 [InitBasicFS, Always, TestOutput (
2869 [["umount"; "/dev/sda1"];
2870 ["zero"; "/dev/sda1"];
2871 ["file"; "/dev/sda1"]], "data")],
2872 "write zeroes to the device",
2874 This command writes zeroes over the first few blocks of C<device>.
2876 How many blocks are zeroed isn't specified (but it's I<not> enough
2877 to securely wipe the device). It should be sufficient to remove
2878 any partition tables, filesystem superblocks and so on.
2880 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2882 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2884 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2885 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2887 [InitBasicFS, Always, TestOutputTrue (
2888 [["mkdir_p"; "/boot/grub"];
2889 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2890 ["grub_install"; "/"; "/dev/vda"];
2891 ["is_dir"; "/boot"]])],
2894 This command installs GRUB (the Grand Unified Bootloader) on
2895 C<device>, with the root directory being C<root>.
2897 Note: If grub-install reports the error
2898 \"No suitable drive was found in the generated device map.\"
2899 it may be that you need to create a C</boot/grub/device.map>
2900 file first that contains the mapping between grub device names
2901 and Linux device names. It is usually sufficient to create
2906 replacing C</dev/vda> with the name of the installation device.");
2908 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2909 [InitScratchFS, Always, TestOutput (
2911 ["write"; "/cp/old"; "file content"];
2912 ["cp"; "/cp/old"; "/cp/new"];
2913 ["cat"; "/cp/new"]], "file content");
2914 InitScratchFS, Always, TestOutputTrue (
2916 ["write"; "/cp2/old"; "file content"];
2917 ["cp"; "/cp2/old"; "/cp2/new"];
2918 ["is_file"; "/cp2/old"]]);
2919 InitScratchFS, Always, TestOutput (
2921 ["write"; "/cp3/old"; "file content"];
2922 ["mkdir"; "/cp3/dir"];
2923 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2924 ["cat"; "/cp3/dir/new"]], "file content")],
2927 This copies a file from C<src> to C<dest> where C<dest> is
2928 either a destination filename or destination directory.");
2930 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2931 [InitScratchFS, Always, TestOutput (
2932 [["mkdir"; "/cp_a1"];
2933 ["mkdir"; "/cp_a2"];
2934 ["write"; "/cp_a1/file"; "file content"];
2935 ["cp_a"; "/cp_a1"; "/cp_a2"];
2936 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2937 "copy a file or directory recursively",
2939 This copies a file or directory from C<src> to C<dest>
2940 recursively using the C<cp -a> command.");
2942 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2943 [InitScratchFS, Always, TestOutput (
2945 ["write"; "/mv/old"; "file content"];
2946 ["mv"; "/mv/old"; "/mv/new"];
2947 ["cat"; "/mv/new"]], "file content");
2948 InitScratchFS, Always, TestOutputFalse (
2950 ["write"; "/mv2/old"; "file content"];
2951 ["mv"; "/mv2/old"; "/mv2/new"];
2952 ["is_file"; "/mv2/old"]])],
2955 This moves a file from C<src> to C<dest> where C<dest> is
2956 either a destination filename or destination directory.");
2958 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2959 [InitEmpty, Always, TestRun (
2960 [["drop_caches"; "3"]])],
2961 "drop kernel page cache, dentries and inodes",
2963 This instructs the guest kernel to drop its page cache,
2964 and/or dentries and inode caches. The parameter C<whattodrop>
2965 tells the kernel what precisely to drop, see
2966 L<http://linux-mm.org/Drop_Caches>
2968 Setting C<whattodrop> to 3 should drop everything.
2970 This automatically calls L<sync(2)> before the operation,
2971 so that the maximum guest memory is freed.");
2973 ("dmesg", (RString "kmsgs", [], []), 91, [],
2974 [InitEmpty, Always, TestRun (
2976 "return kernel messages",
2978 This returns the kernel messages (C<dmesg> output) from
2979 the guest kernel. This is sometimes useful for extended
2980 debugging of problems.
2982 Another way to get the same information is to enable
2983 verbose messages with C<guestfs_set_verbose> or by setting
2984 the environment variable C<LIBGUESTFS_DEBUG=1> before
2985 running the program.");
2987 ("ping_daemon", (RErr, [], []), 92, [],
2988 [InitEmpty, Always, TestRun (
2989 [["ping_daemon"]])],
2990 "ping the guest daemon",
2992 This is a test probe into the guestfs daemon running inside
2993 the qemu subprocess. Calling this function checks that the
2994 daemon responds to the ping message, without affecting the daemon
2995 or attached block device(s) in any other way.");
2997 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
2998 [InitScratchFS, Always, TestOutputTrue (
2999 [["mkdir"; "/equal"];
3000 ["write"; "/equal/file1"; "contents of a file"];
3001 ["cp"; "/equal/file1"; "/equal/file2"];
3002 ["equal"; "/equal/file1"; "/equal/file2"]]);
3003 InitScratchFS, Always, TestOutputFalse (
3004 [["mkdir"; "/equal2"];
3005 ["write"; "/equal2/file1"; "contents of a file"];
3006 ["write"; "/equal2/file2"; "contents of another file"];
3007 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3008 InitScratchFS, Always, TestLastFail (
3009 [["mkdir"; "/equal3"];
3010 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3011 "test if two files have equal contents",
3013 This compares the two files C<file1> and C<file2> and returns
3014 true if their content is exactly equal, or false otherwise.
3016 The external L<cmp(1)> program is used for the comparison.");
3018 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3019 [InitISOFS, Always, TestOutputList (
3020 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3021 InitISOFS, Always, TestOutputList (
3022 [["strings"; "/empty"]], []);
3023 (* Test for RHBZ#579608, absolute symbolic links. *)
3024 InitISOFS, Always, TestRun (
3025 [["strings"; "/abssymlink"]])],
3026 "print the printable strings in a file",
3028 This runs the L<strings(1)> command on a file and returns
3029 the list of printable strings found.");
3031 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3032 [InitISOFS, Always, TestOutputList (
3033 [["strings_e"; "b"; "/known-5"]], []);
3034 InitScratchFS, Always, TestOutputList (
3035 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3036 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3037 "print the printable strings in a file",
3039 This is like the C<guestfs_strings> command, but allows you to
3040 specify the encoding of strings that are looked for in
3041 the source file C<path>.
3043 Allowed encodings are:
3049 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3050 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3054 Single 8-bit-byte characters.
3058 16-bit big endian strings such as those encoded in
3059 UTF-16BE or UCS-2BE.
3061 =item l (lower case letter L)
3063 16-bit little endian such as UTF-16LE and UCS-2LE.
3064 This is useful for examining binaries in Windows guests.
3068 32-bit big endian such as UCS-4BE.
3072 32-bit little endian such as UCS-4LE.
3076 The returned strings are transcoded to UTF-8.");
3078 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3079 [InitISOFS, Always, TestOutput (
3080 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3081 (* Test for RHBZ#501888c2 regression which caused large hexdump
3082 * commands to segfault.
3084 InitISOFS, Always, TestRun (
3085 [["hexdump"; "/100krandom"]]);
3086 (* Test for RHBZ#579608, absolute symbolic links. *)
3087 InitISOFS, Always, TestRun (
3088 [["hexdump"; "/abssymlink"]])],
3089 "dump a file in hexadecimal",
3091 This runs C<hexdump -C> on the given C<path>. The result is
3092 the human-readable, canonical hex dump of the file.");
3094 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3095 [InitNone, Always, TestOutput (
3096 [["part_disk"; "/dev/sda"; "mbr"];
3097 ["mkfs"; "ext3"; "/dev/sda1"];
3098 ["mount_options"; ""; "/dev/sda1"; "/"];
3099 ["write"; "/new"; "test file"];
3100 ["umount"; "/dev/sda1"];
3101 ["zerofree"; "/dev/sda1"];
3102 ["mount_options"; ""; "/dev/sda1"; "/"];
3103 ["cat"; "/new"]], "test file")],
3104 "zero unused inodes and disk blocks on ext2/3 filesystem",
3106 This runs the I<zerofree> program on C<device>. This program
3107 claims to zero unused inodes and disk blocks on an ext2/3
3108 filesystem, thus making it possible to compress the filesystem
3111 You should B<not> run this program if the filesystem is
3114 It is possible that using this program can damage the filesystem
3115 or data on the filesystem.");
3117 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3119 "resize an LVM physical volume",
3121 This resizes (expands or shrinks) an existing LVM physical
3122 volume to match the new size of the underlying device.");
3124 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3125 Int "cyls"; Int "heads"; Int "sectors";
3126 String "line"], []), 99, [DangerWillRobinson],
3128 "modify a single partition on a block device",
3130 This runs L<sfdisk(8)> option to modify just the single
3131 partition C<n> (note: C<n> counts from 1).
3133 For other parameters, see C<guestfs_sfdisk>. You should usually
3134 pass C<0> for the cyls/heads/sectors parameters.
3136 See also: C<guestfs_part_add>");
3138 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3140 "display the partition table",
3142 This displays the partition table on C<device>, in the
3143 human-readable output of the L<sfdisk(8)> command. It is
3144 not intended to be parsed.
3146 See also: C<guestfs_part_list>");
3148 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3150 "display the kernel geometry",
3152 This displays the kernel's idea of the geometry of C<device>.
3154 The result is in human-readable format, and not designed to
3157 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3159 "display the disk geometry from the partition table",
3161 This displays the disk geometry of C<device> read from the
3162 partition table. Especially in the case where the underlying
3163 block device has been resized, this can be different from the
3164 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3166 The result is in human-readable format, and not designed to
3169 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3171 "activate or deactivate all volume groups",
3173 This command activates or (if C<activate> is false) deactivates
3174 all logical volumes in all volume groups.
3175 If activated, then they are made known to the
3176 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3177 then those devices disappear.
3179 This command is the same as running C<vgchange -a y|n>");
3181 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3183 "activate or deactivate some volume groups",
3185 This command activates or (if C<activate> is false) deactivates
3186 all logical volumes in the listed volume groups C<volgroups>.
3187 If activated, then they are made known to the
3188 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3189 then those devices disappear.
3191 This command is the same as running C<vgchange -a y|n volgroups...>
3193 Note that if C<volgroups> is an empty list then B<all> volume groups
3194 are activated or deactivated.");
3196 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3197 [InitNone, Always, TestOutput (
3198 [["part_disk"; "/dev/sda"; "mbr"];
3199 ["pvcreate"; "/dev/sda1"];
3200 ["vgcreate"; "VG"; "/dev/sda1"];
3201 ["lvcreate"; "LV"; "VG"; "10"];
3202 ["mkfs"; "ext2"; "/dev/VG/LV"];
3203 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3204 ["write"; "/new"; "test content"];
3206 ["lvresize"; "/dev/VG/LV"; "20"];
3207 ["e2fsck_f"; "/dev/VG/LV"];
3208 ["resize2fs"; "/dev/VG/LV"];
3209 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3210 ["cat"; "/new"]], "test content");
3211 InitNone, Always, TestRun (
3212 (* Make an LV smaller to test RHBZ#587484. *)
3213 [["part_disk"; "/dev/sda"; "mbr"];
3214 ["pvcreate"; "/dev/sda1"];
3215 ["vgcreate"; "VG"; "/dev/sda1"];
3216 ["lvcreate"; "LV"; "VG"; "20"];
3217 ["lvresize"; "/dev/VG/LV"; "10"]])],
3218 "resize an LVM logical volume",
3220 This resizes (expands or shrinks) an existing LVM logical
3221 volume to C<mbytes>. When reducing, data in the reduced part
3224 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3225 [], (* lvresize tests this *)
3226 "resize an ext2, ext3 or ext4 filesystem",
3228 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3229 the underlying device.
3231 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3232 on the C<device> before calling this command. For unknown reasons
3233 C<resize2fs> sometimes gives an error about this and sometimes not.
3234 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3235 calling this function.");
3237 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3238 [InitBasicFS, Always, TestOutputList (
3239 [["find"; "/"]], ["lost+found"]);
3240 InitBasicFS, Always, TestOutputList (
3244 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3245 InitScratchFS, Always, TestOutputList (
3246 [["mkdir_p"; "/find/b/c"];
3247 ["touch"; "/find/b/c/d"];
3248 ["find"; "/find/b/"]], ["c"; "c/d"])],
3249 "find all files and directories",
3251 This command lists out all files and directories, recursively,
3252 starting at C<directory>. It is essentially equivalent to
3253 running the shell command C<find directory -print> but some
3254 post-processing happens on the output, described below.
3256 This returns a list of strings I<without any prefix>. Thus
3257 if the directory structure was:
3263 then the returned list from C<guestfs_find> C</tmp> would be
3271 If C<directory> is not a directory, then this command returns
3274 The returned list is sorted.
3276 See also C<guestfs_find0>.");
3278 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3279 [], (* lvresize tests this *)
3280 "check an ext2/ext3 filesystem",
3282 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3283 filesystem checker on C<device>, noninteractively (C<-p>),
3284 even if the filesystem appears to be clean (C<-f>).
3286 This command is only needed because of C<guestfs_resize2fs>
3287 (q.v.). Normally you should use C<guestfs_fsck>.");
3289 ("sleep", (RErr, [Int "secs"], []), 109, [],
3290 [InitNone, Always, TestRun (
3292 "sleep for some seconds",
3294 Sleep for C<secs> seconds.");
3296 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3297 [InitNone, Always, TestOutputInt (
3298 [["part_disk"; "/dev/sda"; "mbr"];
3299 ["mkfs"; "ntfs"; "/dev/sda1"];
3300 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3301 InitNone, Always, TestOutputInt (
3302 [["part_disk"; "/dev/sda"; "mbr"];
3303 ["mkfs"; "ext2"; "/dev/sda1"];
3304 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3305 "probe NTFS volume",
3307 This command runs the L<ntfs-3g.probe(8)> command which probes
3308 an NTFS C<device> for mountability. (Not all NTFS volumes can
3309 be mounted read-write, and some cannot be mounted at all).
3311 C<rw> is a boolean flag. Set it to true if you want to test
3312 if the volume can be mounted read-write. Set it to false if
3313 you want to test if the volume can be mounted read-only.
3315 The return value is an integer which C<0> if the operation
3316 would succeed, or some non-zero value documented in the
3317 L<ntfs-3g.probe(8)> manual page.");
3319 ("sh", (RString "output", [String "command"], []), 111, [],
3320 [], (* XXX needs tests *)
3321 "run a command via the shell",
3323 This call runs a command from the guest filesystem via the
3326 This is like C<guestfs_command>, but passes the command to:
3328 /bin/sh -c \"command\"
3330 Depending on the guest's shell, this usually results in
3331 wildcards being expanded, shell expressions being interpolated
3334 All the provisos about C<guestfs_command> apply to this call.");
3336 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3337 [], (* XXX needs tests *)
3338 "run a command via the shell returning lines",
3340 This is the same as C<guestfs_sh>, but splits the result
3341 into a list of lines.
3343 See also: C<guestfs_command_lines>");
3345 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3346 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3347 * code in stubs.c, since all valid glob patterns must start with "/".
3348 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3350 [InitScratchFS, Always, TestOutputList (
3351 [["mkdir_p"; "/glob_expand/b/c"];
3352 ["touch"; "/glob_expand/b/c/d"];
3353 ["touch"; "/glob_expand/b/c/e"];
3354 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3355 InitScratchFS, Always, TestOutputList (
3356 [["mkdir_p"; "/glob_expand2/b/c"];
3357 ["touch"; "/glob_expand2/b/c/d"];
3358 ["touch"; "/glob_expand2/b/c/e"];
3359 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3360 InitScratchFS, Always, TestOutputList (
3361 [["mkdir_p"; "/glob_expand3/b/c"];
3362 ["touch"; "/glob_expand3/b/c/d"];
3363 ["touch"; "/glob_expand3/b/c/e"];
3364 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3365 "expand a wildcard path",
3367 This command searches for all the pathnames matching
3368 C<pattern> according to the wildcard expansion rules
3371 If no paths match, then this returns an empty list
3372 (note: not an error).
3374 It is just a wrapper around the C L<glob(3)> function
3375 with flags C<GLOB_MARK|GLOB_BRACE>.
3376 See that manual page for more details.");
3378 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3379 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3380 [["scrub_device"; "/dev/sdc"]])],
3381 "scrub (securely wipe) a device",
3383 This command writes patterns over C<device> to make data retrieval
3386 It is an interface to the L<scrub(1)> program. See that
3387 manual page for more details.");
3389 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3390 [InitScratchFS, Always, TestRun (
3391 [["write"; "/scrub_file"; "content"];
3392 ["scrub_file"; "/scrub_file"]])],
3393 "scrub (securely wipe) a file",
3395 This command writes patterns over a file to make data retrieval
3398 The file is I<removed> after scrubbing.
3400 It is an interface to the L<scrub(1)> program. See that
3401 manual page for more details.");
3403 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3404 [], (* XXX needs testing *)
3405 "scrub (securely wipe) free space",
3407 This command creates the directory C<dir> and then fills it
3408 with files until the filesystem is full, and scrubs the files
3409 as for C<guestfs_scrub_file>, and deletes them.
3410 The intention is to scrub any free space on the partition
3413 It is an interface to the L<scrub(1)> program. See that
3414 manual page for more details.");
3416 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3417 [InitScratchFS, Always, TestRun (
3418 [["mkdir"; "/mkdtemp"];
3419 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3420 "create a temporary directory",
3422 This command creates a temporary directory. The
3423 C<template> parameter should be a full pathname for the
3424 temporary directory name with the final six characters being
3427 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3428 the second one being suitable for Windows filesystems.
3430 The name of the temporary directory that was created
3433 The temporary directory is created with mode 0700
3434 and is owned by root.
3436 The caller is responsible for deleting the temporary
3437 directory and its contents after use.
3439 See also: L<mkdtemp(3)>");
3441 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3442 [InitISOFS, Always, TestOutputInt (
3443 [["wc_l"; "/10klines"]], 10000);
3444 (* Test for RHBZ#579608, absolute symbolic links. *)
3445 InitISOFS, Always, TestOutputInt (
3446 [["wc_l"; "/abssymlink"]], 10000)],
3447 "count lines in a file",
3449 This command counts the lines in a file, using the
3450 C<wc -l> external command.");
3452 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3453 [InitISOFS, Always, TestOutputInt (
3454 [["wc_w"; "/10klines"]], 10000)],
3455 "count words in a file",
3457 This command counts the words in a file, using the
3458 C<wc -w> external command.");
3460 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3461 [InitISOFS, Always, TestOutputInt (
3462 [["wc_c"; "/100kallspaces"]], 102400)],
3463 "count characters in a file",
3465 This command counts the characters in a file, using the
3466 C<wc -c> external command.");
3468 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3469 [InitISOFS, Always, TestOutputList (
3470 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3471 (* Test for RHBZ#579608, absolute symbolic links. *)
3472 InitISOFS, Always, TestOutputList (
3473 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3474 "return first 10 lines of a file",
3476 This command returns up to the first 10 lines of a file as
3477 a list of strings.");
3479 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3480 [InitISOFS, Always, TestOutputList (
3481 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3482 InitISOFS, Always, TestOutputList (
3483 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3484 InitISOFS, Always, TestOutputList (
3485 [["head_n"; "0"; "/10klines"]], [])],
3486 "return first N lines of a file",
3488 If the parameter C<nrlines> is a positive number, this returns the first
3489 C<nrlines> lines of the file C<path>.
3491 If the parameter C<nrlines> is a negative number, this returns lines
3492 from the file C<path>, excluding the last C<nrlines> lines.
3494 If the parameter C<nrlines> is zero, this returns an empty list.");
3496 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3497 [InitISOFS, Always, TestOutputList (
3498 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3499 "return last 10 lines of a file",
3501 This command returns up to the last 10 lines of a file as
3502 a list of strings.");
3504 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3505 [InitISOFS, Always, TestOutputList (
3506 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3507 InitISOFS, Always, TestOutputList (
3508 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3509 InitISOFS, Always, TestOutputList (
3510 [["tail_n"; "0"; "/10klines"]], [])],
3511 "return last N lines of a file",
3513 If the parameter C<nrlines> is a positive number, this returns the last
3514 C<nrlines> lines of the file C<path>.
3516 If the parameter C<nrlines> is a negative number, this returns lines
3517 from the file C<path>, starting with the C<-nrlines>th line.
3519 If the parameter C<nrlines> is zero, this returns an empty list.");
3521 ("df", (RString "output", [], []), 125, [],
3522 [], (* XXX Tricky to test because it depends on the exact format
3523 * of the 'df' command and other imponderables.
3525 "report file system disk space usage",
3527 This command runs the C<df> command to report disk space used.
3529 This command is mostly useful for interactive sessions. It
3530 is I<not> intended that you try to parse the output string.
3531 Use C<guestfs_statvfs> from programs.");
3533 ("df_h", (RString "output", [], []), 126, [],
3534 [], (* XXX Tricky to test because it depends on the exact format
3535 * of the 'df' command and other imponderables.
3537 "report file system disk space usage (human readable)",
3539 This command runs the C<df -h> command to report disk space used
3540 in human-readable format.
3542 This command is mostly useful for interactive sessions. It
3543 is I<not> intended that you try to parse the output string.
3544 Use C<guestfs_statvfs> from programs.");
3546 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3547 [InitISOFS, Always, TestOutputInt (
3548 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3549 "estimate file space usage",
3551 This command runs the C<du -s> command to estimate file space
3554 C<path> can be a file or a directory. If C<path> is a directory
3555 then the estimate includes the contents of the directory and all
3556 subdirectories (recursively).
3558 The result is the estimated size in I<kilobytes>
3559 (ie. units of 1024 bytes).");
3561 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3562 [InitISOFS, Always, TestOutputList (
3563 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3564 "list files in an initrd",
3566 This command lists out files contained in an initrd.
3568 The files are listed without any initial C</> character. The
3569 files are listed in the order they appear (not necessarily
3570 alphabetical). Directory names are listed as separate items.
3572 Old Linux kernels (2.4 and earlier) used a compressed ext2
3573 filesystem as initrd. We I<only> support the newer initramfs
3574 format (compressed cpio files).");
3576 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3578 "mount a file using the loop device",
3580 This command lets you mount C<file> (a filesystem image
3581 in a file) on a mount point. It is entirely equivalent to
3582 the command C<mount -o loop file mountpoint>.");
3584 ("mkswap", (RErr, [Device "device"], []), 130, [],
3585 [InitEmpty, Always, TestRun (
3586 [["part_disk"; "/dev/sda"; "mbr"];
3587 ["mkswap"; "/dev/sda1"]])],
3588 "create a swap partition",
3590 Create a swap partition on C<device>.");
3592 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3593 [InitEmpty, Always, TestRun (
3594 [["part_disk"; "/dev/sda"; "mbr"];
3595 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3596 "create a swap partition with a label",
3598 Create a swap partition on C<device> with label C<label>.
3600 Note that you cannot attach a swap label to a block device
3601 (eg. C</dev/sda>), just to a partition. This appears to be
3602 a limitation of the kernel or swap tools.");
3604 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3605 (let uuid = uuidgen () in
3606 [InitEmpty, Always, TestRun (
3607 [["part_disk"; "/dev/sda"; "mbr"];
3608 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3609 "create a swap partition with an explicit UUID",
3611 Create a swap partition on C<device> with UUID C<uuid>.");
3613 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3614 [InitScratchFS, Always, TestOutputStruct (
3615 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3616 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3617 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3618 InitScratchFS, Always, TestOutputStruct (
3619 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3620 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3621 "make block, character or FIFO devices",
3623 This call creates block or character special devices, or
3624 named pipes (FIFOs).
3626 The C<mode> parameter should be the mode, using the standard
3627 constants. C<devmajor> and C<devminor> are the
3628 device major and minor numbers, only used when creating block
3629 and character special devices.
3631 Note that, just like L<mknod(2)>, the mode must be bitwise
3632 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3633 just creates a regular file). These constants are
3634 available in the standard Linux header files, or you can use
3635 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3636 which are wrappers around this command which bitwise OR
3637 in the appropriate constant for you.
3639 The mode actually set is affected by the umask.");
3641 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3642 [InitScratchFS, Always, TestOutputStruct (
3643 [["mkfifo"; "0o777"; "/mkfifo"];
3644 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3645 "make FIFO (named pipe)",
3647 This call creates a FIFO (named pipe) called C<path> with
3648 mode C<mode>. It is just a convenient wrapper around
3651 The mode actually set is affected by the umask.");
3653 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3654 [InitScratchFS, Always, TestOutputStruct (
3655 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3656 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3657 "make block device node",
3659 This call creates a block device node called C<path> with
3660 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3661 It is just a convenient wrapper around C<guestfs_mknod>.
3663 The mode actually set is affected by the umask.");
3665 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3666 [InitScratchFS, Always, TestOutputStruct (
3667 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3668 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3669 "make char device node",
3671 This call creates a char device node called C<path> with
3672 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3673 It is just a convenient wrapper around C<guestfs_mknod>.
3675 The mode actually set is affected by the umask.");
3677 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3678 [InitEmpty, Always, TestOutputInt (
3679 [["umask"; "0o22"]], 0o22)],
3680 "set file mode creation mask (umask)",
3682 This function sets the mask used for creating new files and
3683 device nodes to C<mask & 0777>.
3685 Typical umask values would be C<022> which creates new files
3686 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3687 C<002> which creates new files with permissions like
3688 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3690 The default umask is C<022>. This is important because it
3691 means that directories and device nodes will be created with
3692 C<0644> or C<0755> mode even if you specify C<0777>.
3694 See also C<guestfs_get_umask>,
3695 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3697 This call returns the previous umask.");
3699 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3701 "read directories entries",
3703 This returns the list of directory entries in directory C<dir>.
3705 All entries in the directory are returned, including C<.> and
3706 C<..>. The entries are I<not> sorted, but returned in the same
3707 order as the underlying filesystem.
3709 Also this call returns basic file type information about each
3710 file. The C<ftyp> field will contain one of the following characters:
3748 The L<readdir(3)> call returned a C<d_type> field with an
3753 This function is primarily intended for use by programs. To
3754 get a simple list of names, use C<guestfs_ls>. To get a printable
3755 directory for human consumption, use C<guestfs_ll>.");
3757 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3759 "create partitions on a block device",
3761 This is a simplified interface to the C<guestfs_sfdisk>
3762 command, where partition sizes are specified in megabytes
3763 only (rounded to the nearest cylinder) and you don't need
3764 to specify the cyls, heads and sectors parameters which
3765 were rarely if ever used anyway.
3767 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3768 and C<guestfs_part_disk>");
3770 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3772 "determine file type inside a compressed file",
3774 This command runs C<file> after first decompressing C<path>
3777 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3779 Since 1.0.63, use C<guestfs_file> instead which can now
3780 process compressed files.");
3782 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3784 "list extended attributes of a file or directory",
3786 This call lists the extended attributes of the file or directory
3789 At the system call level, this is a combination of the
3790 L<listxattr(2)> and L<getxattr(2)> calls.
3792 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3794 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3796 "list extended attributes of a file or directory",
3798 This is the same as C<guestfs_getxattrs>, but if C<path>
3799 is a symbolic link, then it returns the extended attributes
3800 of the link itself.");
3802 ("setxattr", (RErr, [String "xattr";
3803 String "val"; Int "vallen"; (* will be BufferIn *)
3804 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3806 "set extended attribute of a file or directory",
3808 This call sets the extended attribute named C<xattr>
3809 of the file C<path> to the value C<val> (of length C<vallen>).
3810 The value is arbitrary 8 bit data.
3812 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3814 ("lsetxattr", (RErr, [String "xattr";
3815 String "val"; Int "vallen"; (* will be BufferIn *)
3816 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3818 "set extended attribute of a file or directory",
3820 This is the same as C<guestfs_setxattr>, but if C<path>
3821 is a symbolic link, then it sets an extended attribute
3822 of the link itself.");
3824 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3826 "remove extended attribute of a file or directory",
3828 This call removes the extended attribute named C<xattr>
3829 of the file C<path>.
3831 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3833 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3835 "remove extended attribute of a file or directory",
3837 This is the same as C<guestfs_removexattr>, but if C<path>
3838 is a symbolic link, then it removes an extended attribute
3839 of the link itself.");
3841 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3845 This call is similar to C<guestfs_mounts>. That call returns
3846 a list of devices. This one returns a hash table (map) of
3847 device name to directory where the device is mounted.");
3849 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3850 (* This is a special case: while you would expect a parameter
3851 * of type "Pathname", that doesn't work, because it implies
3852 * NEED_ROOT in the generated calling code in stubs.c, and
3853 * this function cannot use NEED_ROOT.
3856 "create a mountpoint",
3858 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3859 specialized calls that can be used to create extra mountpoints
3860 before mounting the first filesystem.
3862 These calls are I<only> necessary in some very limited circumstances,
3863 mainly the case where you want to mount a mix of unrelated and/or
3864 read-only filesystems together.
3866 For example, live CDs often contain a \"Russian doll\" nest of
3867 filesystems, an ISO outer layer, with a squashfs image inside, with
3868 an ext2/3 image inside that. You can unpack this as follows
3871 add-ro Fedora-11-i686-Live.iso
3875 mkmountpoint /ext3fs
3877 mount-loop /cd/LiveOS/squashfs.img /sqsh
3878 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3880 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3882 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3883 You may get unexpected errors if you try to mix these calls. It is
3884 safest to manually unmount filesystems and remove mountpoints after use.
3886 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3887 longest first, so for this to work for manual mountpoints, you
3888 must ensure that the innermost mountpoints have the longest
3889 pathnames, as in the example code above.
3891 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3893 Autosync [see C<guestfs_set_autosync>, this is set by default on
3894 handles] can cause C<guestfs_umount_all> to be called when the handle
3895 is closed which can also trigger these issues.");
3897 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3899 "remove a mountpoint",
3901 This calls removes a mountpoint that was previously created
3902 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3903 for full details.");
3905 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3906 [InitISOFS, Always, TestOutputBuffer (
3907 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3908 (* Test various near large, large and too large files (RHBZ#589039). *)
3909 InitScratchFS, Always, TestLastFail (
3910 [["touch"; "/read_file"];
3911 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3912 ["read_file"; "/read_file"]]);
3913 InitScratchFS, Always, TestLastFail (
3914 [["touch"; "/read_file2"];
3915 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3916 ["read_file"; "/read_file2"]]);
3917 InitScratchFS, Always, TestLastFail (
3918 [["touch"; "/read_file3"];
3919 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3920 ["read_file"; "/read_file3"]])],
3923 This calls returns the contents of the file C<path> as a
3926 Unlike C<guestfs_cat>, this function can correctly
3927 handle files that contain embedded ASCII NUL characters.
3928 However unlike C<guestfs_download>, this function is limited
3929 in the total size of file that can be handled.");
3931 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3932 [InitISOFS, Always, TestOutputList (
3933 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3934 InitISOFS, Always, TestOutputList (
3935 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3936 (* Test for RHBZ#579608, absolute symbolic links. *)
3937 InitISOFS, Always, TestOutputList (
3938 [["grep"; "nomatch"; "/abssymlink"]], [])],
3939 "return lines matching a pattern",
3941 This calls the external C<grep> program and returns the
3944 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3945 [InitISOFS, Always, TestOutputList (
3946 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3947 "return lines matching a pattern",
3949 This calls the external C<egrep> program and returns the
3952 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3953 [InitISOFS, Always, TestOutputList (
3954 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3955 "return lines matching a pattern",
3957 This calls the external C<fgrep> program and returns the
3960 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3961 [InitISOFS, Always, TestOutputList (
3962 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3963 "return lines matching a pattern",
3965 This calls the external C<grep -i> program and returns the
3968 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
3969 [InitISOFS, Always, TestOutputList (
3970 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3971 "return lines matching a pattern",
3973 This calls the external C<egrep -i> program and returns the
3976 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
3977 [InitISOFS, Always, TestOutputList (
3978 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3979 "return lines matching a pattern",
3981 This calls the external C<fgrep -i> program and returns the
3984 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
3985 [InitISOFS, Always, TestOutputList (
3986 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3987 "return lines matching a pattern",
3989 This calls the external C<zgrep> program and returns the
3992 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
3993 [InitISOFS, Always, TestOutputList (
3994 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3995 "return lines matching a pattern",
3997 This calls the external C<zegrep> program and returns the
4000 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4001 [InitISOFS, Always, TestOutputList (
4002 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4003 "return lines matching a pattern",
4005 This calls the external C<zfgrep> program and returns the
4008 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4009 [InitISOFS, Always, TestOutputList (
4010 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4011 "return lines matching a pattern",
4013 This calls the external C<zgrep -i> program and returns the
4016 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4017 [InitISOFS, Always, TestOutputList (
4018 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4019 "return lines matching a pattern",
4021 This calls the external C<zegrep -i> program and returns the
4024 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4025 [InitISOFS, Always, TestOutputList (
4026 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4027 "return lines matching a pattern",
4029 This calls the external C<zfgrep -i> program and returns the
4032 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4033 [InitISOFS, Always, TestOutput (
4034 [["realpath"; "/../directory"]], "/directory")],
4035 "canonicalized absolute pathname",
4037 Return the canonicalized absolute pathname of C<path>. The
4038 returned path has no C<.>, C<..> or symbolic link path elements.");
4040 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4041 [InitScratchFS, Always, TestOutputStruct (
4044 ["ln"; "/ln/a"; "/ln/b"];
4045 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4046 "create a hard link",
4048 This command creates a hard link using the C<ln> command.");
4050 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4051 [InitScratchFS, Always, TestOutputStruct (
4052 [["mkdir"; "/ln_f"];
4053 ["touch"; "/ln_f/a"];
4054 ["touch"; "/ln_f/b"];
4055 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4056 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4057 "create a hard link",
4059 This command creates a hard link using the C<ln -f> command.
4060 The C<-f> option removes the link (C<linkname>) if it exists already.");
4062 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4063 [InitScratchFS, Always, TestOutputStruct (
4064 [["mkdir"; "/ln_s"];
4065 ["touch"; "/ln_s/a"];
4066 ["ln_s"; "a"; "/ln_s/b"];
4067 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4068 "create a symbolic link",
4070 This command creates a symbolic link using the C<ln -s> command.");
4072 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4073 [InitScratchFS, Always, TestOutput (
4074 [["mkdir_p"; "/ln_sf/b"];
4075 ["touch"; "/ln_sf/b/c"];
4076 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4077 ["readlink"; "/ln_sf/b/c"]], "../d")],
4078 "create a symbolic link",
4080 This command creates a symbolic link using the C<ln -sf> command,
4081 The C<-f> option removes the link (C<linkname>) if it exists already.");
4083 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4084 [] (* XXX tested above *),
4085 "read the target of a symbolic link",
4087 This command reads the target of a symbolic link.");
4089 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4090 [InitScratchFS, Always, TestOutputStruct (
4091 [["fallocate"; "/fallocate"; "1000000"];
4092 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4093 "preallocate a file in the guest filesystem",
4095 This command preallocates a file (containing zero bytes) named
4096 C<path> of size C<len> bytes. If the file exists already, it
4099 Do not confuse this with the guestfish-specific
4100 C<alloc> command which allocates a file in the host and
4101 attaches it as a device.");
4103 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4104 [InitPartition, Always, TestRun (
4105 [["mkswap"; "/dev/sda1"];
4106 ["swapon_device"; "/dev/sda1"];
4107 ["swapoff_device"; "/dev/sda1"]])],
4108 "enable swap on device",
4110 This command enables the libguestfs appliance to use the
4111 swap device or partition named C<device>. The increased
4112 memory is made available for all commands, for example
4113 those run using C<guestfs_command> or C<guestfs_sh>.
4115 Note that you should not swap to existing guest swap
4116 partitions unless you know what you are doing. They may
4117 contain hibernation information, or other information that
4118 the guest doesn't want you to trash. You also risk leaking
4119 information about the host to the guest this way. Instead,
4120 attach a new host device to the guest and swap on that.");
4122 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4123 [], (* XXX tested by swapon_device *)
4124 "disable swap on device",
4126 This command disables the libguestfs appliance swap
4127 device or partition named C<device>.
4128 See C<guestfs_swapon_device>.");
4130 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4131 [InitScratchFS, Always, TestRun (
4132 [["fallocate"; "/swapon_file"; "8388608"];
4133 ["mkswap_file"; "/swapon_file"];
4134 ["swapon_file"; "/swapon_file"];
4135 ["swapoff_file"; "/swapon_file"];
4136 ["rm"; "/swapon_file"]])],
4137 "enable swap on file",
4139 This command enables swap to a file.
4140 See C<guestfs_swapon_device> for other notes.");
4142 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4143 [], (* XXX tested by swapon_file *)
4144 "disable swap on file",
4146 This command disables the libguestfs appliance swap on file.");
4148 ("swapon_label", (RErr, [String "label"], []), 174, [],
4149 [InitEmpty, Always, TestRun (
4150 [["part_disk"; "/dev/sda"; "mbr"];
4151 ["mkswap_L"; "swapit"; "/dev/sda1"];
4152 ["swapon_label"; "swapit"];
4153 ["swapoff_label"; "swapit"];
4154 ["zero"; "/dev/sda"];
4155 ["blockdev_rereadpt"; "/dev/sda"]])],
4156 "enable swap on labeled swap partition",
4158 This command enables swap to a labeled swap partition.
4159 See C<guestfs_swapon_device> for other notes.");
4161 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4162 [], (* XXX tested by swapon_label *)
4163 "disable swap on labeled swap partition",
4165 This command disables the libguestfs appliance swap on
4166 labeled swap partition.");
4168 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4169 (let uuid = uuidgen () in
4170 [InitEmpty, Always, TestRun (
4171 [["mkswap_U"; uuid; "/dev/sdc"];
4172 ["swapon_uuid"; uuid];
4173 ["swapoff_uuid"; uuid]])]),
4174 "enable swap on swap partition by UUID",
4176 This command enables swap to a swap partition with the given UUID.
4177 See C<guestfs_swapon_device> for other notes.");
4179 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4180 [], (* XXX tested by swapon_uuid *)
4181 "disable swap on swap partition by UUID",
4183 This command disables the libguestfs appliance swap partition
4184 with the given UUID.");
4186 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4187 [InitScratchFS, Always, TestRun (
4188 [["fallocate"; "/mkswap_file"; "8388608"];
4189 ["mkswap_file"; "/mkswap_file"];
4190 ["rm"; "/mkswap_file"]])],
4191 "create a swap file",
4195 This command just writes a swap file signature to an existing
4196 file. To create the file itself, use something like C<guestfs_fallocate>.");
4198 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4199 [InitISOFS, Always, TestRun (
4200 [["inotify_init"; "0"]])],
4201 "create an inotify handle",
4203 This command creates a new inotify handle.
4204 The inotify subsystem can be used to notify events which happen to
4205 objects in the guest filesystem.
4207 C<maxevents> is the maximum number of events which will be
4208 queued up between calls to C<guestfs_inotify_read> or
4209 C<guestfs_inotify_files>.
4210 If this is passed as C<0>, then the kernel (or previously set)
4211 default is used. For Linux 2.6.29 the default was 16384 events.
4212 Beyond this limit, the kernel throws away events, but records
4213 the fact that it threw them away by setting a flag
4214 C<IN_Q_OVERFLOW> in the returned structure list (see
4215 C<guestfs_inotify_read>).
4217 Before any events are generated, you have to add some
4218 watches to the internal watch list. See:
4219 C<guestfs_inotify_add_watch>,
4220 C<guestfs_inotify_rm_watch> and
4221 C<guestfs_inotify_watch_all>.
4223 Queued up events should be read periodically by calling
4224 C<guestfs_inotify_read>
4225 (or C<guestfs_inotify_files> which is just a helpful
4226 wrapper around C<guestfs_inotify_read>). If you don't
4227 read the events out often enough then you risk the internal
4230 The handle should be closed after use by calling
4231 C<guestfs_inotify_close>. This also removes any
4232 watches automatically.
4234 See also L<inotify(7)> for an overview of the inotify interface
4235 as exposed by the Linux kernel, which is roughly what we expose
4236 via libguestfs. Note that there is one global inotify handle
4237 per libguestfs instance.");
4239 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4240 [InitScratchFS, Always, TestOutputList (
4241 [["mkdir"; "/inotify_add_watch"];
4242 ["inotify_init"; "0"];
4243 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4244 ["touch"; "/inotify_add_watch/a"];
4245 ["touch"; "/inotify_add_watch/b"];
4246 ["inotify_files"]], ["a"; "b"])],
4247 "add an inotify watch",
4249 Watch C<path> for the events listed in C<mask>.
4251 Note that if C<path> is a directory then events within that
4252 directory are watched, but this does I<not> happen recursively
4253 (in subdirectories).
4255 Note for non-C or non-Linux callers: the inotify events are
4256 defined by the Linux kernel ABI and are listed in
4257 C</usr/include/sys/inotify.h>.");
4259 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4261 "remove an inotify watch",
4263 Remove a previously defined inotify watch.
4264 See C<guestfs_inotify_add_watch>.");
4266 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4268 "return list of inotify events",
4270 Return the complete queue of events that have happened
4271 since the previous read call.
4273 If no events have happened, this returns an empty list.
4275 I<Note>: In order to make sure that all events have been
4276 read, you must call this function repeatedly until it
4277 returns an empty list. The reason is that the call will
4278 read events up to the maximum appliance-to-host message
4279 size and leave remaining events in the queue.");
4281 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4283 "return list of watched files that had events",
4285 This function is a helpful wrapper around C<guestfs_inotify_read>
4286 which just returns a list of pathnames of objects that were
4287 touched. The returned pathnames are sorted and deduplicated.");
4289 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4291 "close the inotify handle",
4293 This closes the inotify handle which was previously
4294 opened by inotify_init. It removes all watches, throws
4295 away any pending events, and deallocates all resources.");
4297 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4299 "set SELinux security context",
4301 This sets the SELinux security context of the daemon
4302 to the string C<context>.
4304 See the documentation about SELINUX in L<guestfs(3)>.");
4306 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4308 "get SELinux security context",
4310 This gets the SELinux security context of the daemon.
4312 See the documentation about SELINUX in L<guestfs(3)>,
4313 and C<guestfs_setcon>");
4315 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4316 [InitEmpty, Always, TestOutput (
4317 [["part_disk"; "/dev/sda"; "mbr"];
4318 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4319 ["mount_options"; ""; "/dev/sda1"; "/"];
4320 ["write"; "/new"; "new file contents"];
4321 ["cat"; "/new"]], "new file contents");
4322 InitEmpty, Always, TestRun (
4323 [["part_disk"; "/dev/sda"; "mbr"];
4324 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4325 InitEmpty, Always, TestLastFail (
4326 [["part_disk"; "/dev/sda"; "mbr"];
4327 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4328 InitEmpty, Always, TestLastFail (
4329 [["part_disk"; "/dev/sda"; "mbr"];
4330 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4331 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4332 [["part_disk"; "/dev/sda"; "mbr"];
4333 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4334 "make a filesystem with block size",
4336 This call is similar to C<guestfs_mkfs>, but it allows you to
4337 control the block size of the resulting filesystem. Supported
4338 block sizes depend on the filesystem type, but typically they
4339 are C<1024>, C<2048> or C<4096> only.
4341 For VFAT and NTFS the C<blocksize> parameter is treated as
4342 the requested cluster size.");
4344 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4345 [InitEmpty, Always, TestOutput (
4346 [["part_init"; "/dev/sda"; "mbr"];
4347 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4348 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4349 ["mke2journal"; "4096"; "/dev/sda1"];
4350 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4351 ["mount_options"; ""; "/dev/sda2"; "/"];
4352 ["write"; "/new"; "new file contents"];
4353 ["cat"; "/new"]], "new file contents")],
4354 "make ext2/3/4 external journal",
4356 This creates an ext2 external journal on C<device>. It is equivalent
4359 mke2fs -O journal_dev -b blocksize device");
4361 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4362 [InitEmpty, Always, TestOutput (
4363 [["part_init"; "/dev/sda"; "mbr"];
4364 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4365 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4366 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4367 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4368 ["mount_options"; ""; "/dev/sda2"; "/"];
4369 ["write"; "/new"; "new file contents"];
4370 ["cat"; "/new"]], "new file contents")],
4371 "make ext2/3/4 external journal with label",
4373 This creates an ext2 external journal on C<device> with label C<label>.");
4375 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4376 (let uuid = uuidgen () in
4377 [InitEmpty, Always, TestOutput (
4378 [["part_init"; "/dev/sda"; "mbr"];
4379 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4380 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4381 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4382 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4383 ["mount_options"; ""; "/dev/sda2"; "/"];
4384 ["write"; "/new"; "new file contents"];
4385 ["cat"; "/new"]], "new file contents")]),
4386 "make ext2/3/4 external journal with UUID",
4388 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4390 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4392 "make ext2/3/4 filesystem with external journal",
4394 This creates an ext2/3/4 filesystem on C<device> with
4395 an external journal on C<journal>. It is equivalent
4398 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4400 See also C<guestfs_mke2journal>.");
4402 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4404 "make ext2/3/4 filesystem with external journal",
4406 This creates an ext2/3/4 filesystem on C<device> with
4407 an external journal on the journal labeled C<label>.
4409 See also C<guestfs_mke2journal_L>.");
4411 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4413 "make ext2/3/4 filesystem with external journal",
4415 This creates an ext2/3/4 filesystem on C<device> with
4416 an external journal on the journal with UUID C<uuid>.
4418 See also C<guestfs_mke2journal_U>.");
4420 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4421 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4422 "load a kernel module",
4424 This loads a kernel module in the appliance.
4426 The kernel module must have been whitelisted when libguestfs
4427 was built (see C<appliance/kmod.whitelist.in> in the source).");
4429 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4430 [InitNone, Always, TestOutput (
4431 [["echo_daemon"; "This is a test"]], "This is a test"
4433 "echo arguments back to the client",
4435 This command concatenates the list of C<words> passed with single spaces
4436 between them and returns the resulting string.
4438 You can use this command to test the connection through to the daemon.
4440 See also C<guestfs_ping_daemon>.");
4442 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4443 [], (* There is a regression test for this. *)
4444 "find all files and directories, returning NUL-separated list",
4446 This command lists out all files and directories, recursively,
4447 starting at C<directory>, placing the resulting list in the
4448 external file called C<files>.
4450 This command works the same way as C<guestfs_find> with the
4451 following exceptions:
4457 The resulting list is written to an external file.
4461 Items (filenames) in the result are separated
4462 by C<\\0> characters. See L<find(1)> option I<-print0>.
4466 This command is not limited in the number of names that it
4471 The result list is not sorted.
4475 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4476 [InitISOFS, Always, TestOutput (
4477 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4478 InitISOFS, Always, TestOutput (
4479 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4480 InitISOFS, Always, TestOutput (
4481 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4482 InitISOFS, Always, TestLastFail (
4483 [["case_sensitive_path"; "/Known-1/"]]);
4484 InitScratchFS, Always, TestOutput (
4485 [["mkdir"; "/case_sensitive_path"];
4486 ["mkdir"; "/case_sensitive_path/bbb"];
4487 ["touch"; "/case_sensitive_path/bbb/c"];
4488 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4489 InitScratchFS, Always, TestOutput (
4490 [["mkdir"; "/case_sensitive_path2"];
4491 ["mkdir"; "/case_sensitive_path2/bbb"];
4492 ["touch"; "/case_sensitive_path2/bbb/c"];
4493 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4494 InitScratchFS, Always, TestLastFail (
4495 [["mkdir"; "/case_sensitive_path3"];
4496 ["mkdir"; "/case_sensitive_path3/bbb"];
4497 ["touch"; "/case_sensitive_path3/bbb/c"];
4498 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4499 "return true path on case-insensitive filesystem",
4501 This can be used to resolve case insensitive paths on
4502 a filesystem which is case sensitive. The use case is
4503 to resolve paths which you have read from Windows configuration
4504 files or the Windows Registry, to the true path.
4506 The command handles a peculiarity of the Linux ntfs-3g
4507 filesystem driver (and probably others), which is that although
4508 the underlying filesystem is case-insensitive, the driver
4509 exports the filesystem to Linux as case-sensitive.
4511 One consequence of this is that special directories such
4512 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4513 (or other things) depending on the precise details of how
4514 they were created. In Windows itself this would not be
4517 Bug or feature? You decide:
4518 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4520 This function resolves the true case of each element in the
4521 path and returns the case-sensitive path.
4523 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4524 might return C<\"/WINDOWS/system32\"> (the exact return value
4525 would depend on details of how the directories were originally
4526 created under Windows).
4529 This function does not handle drive names, backslashes etc.
4531 See also C<guestfs_realpath>.");
4533 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4534 [InitScratchFS, Always, TestOutput (
4535 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4536 "get the Linux VFS type corresponding to a mounted device",
4538 This command gets the filesystem type corresponding to
4539 the filesystem on C<device>.
4541 For most filesystems, the result is the name of the Linux
4542 VFS module which would be used to mount this filesystem
4543 if you mounted it without specifying the filesystem type.
4544 For example a string such as C<ext3> or C<ntfs>.");
4546 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4547 [InitScratchFS, Always, TestOutputStruct (
4548 [["write"; "/truncate"; "some stuff so size is not zero"];
4549 ["truncate"; "/truncate"];
4550 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4551 "truncate a file to zero size",
4553 This command truncates C<path> to a zero-length file. The
4554 file must exist already.");
4556 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4557 [InitScratchFS, Always, TestOutputStruct (
4558 [["touch"; "/truncate_size"];
4559 ["truncate_size"; "/truncate_size"; "1000"];
4560 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4561 "truncate a file to a particular size",
4563 This command truncates C<path> to size C<size> bytes. The file
4566 If the current file size is less than C<size> then
4567 the file is extended to the required size with zero bytes.
4568 This creates a sparse file (ie. disk blocks are not allocated
4569 for the file until you write to it). To create a non-sparse
4570 file of zeroes, use C<guestfs_fallocate64> instead.");
4572 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4573 [InitScratchFS, Always, TestOutputStruct (
4574 [["touch"; "/utimens"];
4575 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4576 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4577 "set timestamp of a file with nanosecond precision",
4579 This command sets the timestamps of a file with nanosecond
4582 C<atsecs, atnsecs> are the last access time (atime) in secs and
4583 nanoseconds from the epoch.
4585 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4586 secs and nanoseconds from the epoch.
4588 If the C<*nsecs> field contains the special value C<-1> then
4589 the corresponding timestamp is set to the current time. (The
4590 C<*secs> field is ignored in this case).
4592 If the C<*nsecs> field contains the special value C<-2> then
4593 the corresponding timestamp is left unchanged. (The
4594 C<*secs> field is ignored in this case).");
4596 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4597 [InitScratchFS, Always, TestOutputStruct (
4598 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4599 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4600 "create a directory with a particular mode",
4602 This command creates a directory, setting the initial permissions
4603 of the directory to C<mode>.
4605 For common Linux filesystems, the actual mode which is set will
4606 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4607 interpret the mode in other ways.
4609 See also C<guestfs_mkdir>, C<guestfs_umask>");
4611 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4613 "change file owner and group",
4615 Change the file owner to C<owner> and group to C<group>.
4616 This is like C<guestfs_chown> but if C<path> is a symlink then
4617 the link itself is changed, not the target.
4619 Only numeric uid and gid are supported. If you want to use
4620 names, you will need to locate and parse the password file
4621 yourself (Augeas support makes this relatively easy).");
4623 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4625 "lstat on multiple files",
4627 This call allows you to perform the C<guestfs_lstat> operation
4628 on multiple files, where all files are in the directory C<path>.
4629 C<names> is the list of files from this directory.
4631 On return you get a list of stat structs, with a one-to-one
4632 correspondence to the C<names> list. If any name did not exist
4633 or could not be lstat'd, then the C<ino> field of that structure
4636 This call is intended for programs that want to efficiently
4637 list a directory contents without making many round-trips.
4638 See also C<guestfs_lxattrlist> for a similarly efficient call
4639 for getting extended attributes. Very long directory listings
4640 might cause the protocol message size to be exceeded, causing
4641 this call to fail. The caller must split up such requests
4642 into smaller groups of names.");
4644 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4646 "lgetxattr on multiple files",
4648 This call allows you to get the extended attributes
4649 of multiple files, where all files are in the directory C<path>.
4650 C<names> is the list of files from this directory.
4652 On return you get a flat list of xattr structs which must be
4653 interpreted sequentially. The first xattr struct always has a zero-length
4654 C<attrname>. C<attrval> in this struct is zero-length
4655 to indicate there was an error doing C<lgetxattr> for this
4656 file, I<or> is a C string which is a decimal number
4657 (the number of following attributes for this file, which could
4658 be C<\"0\">). Then after the first xattr struct are the
4659 zero or more attributes for the first named file.
4660 This repeats for the second and subsequent files.
4662 This call is intended for programs that want to efficiently
4663 list a directory contents without making many round-trips.
4664 See also C<guestfs_lstatlist> for a similarly efficient call
4665 for getting standard stats. Very long directory listings
4666 might cause the protocol message size to be exceeded, causing
4667 this call to fail. The caller must split up such requests
4668 into smaller groups of names.");
4670 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4672 "readlink on multiple files",
4674 This call allows you to do a C<readlink> operation
4675 on multiple files, where all files are in the directory C<path>.
4676 C<names> is the list of files from this directory.
4678 On return you get a list of strings, with a one-to-one
4679 correspondence to the C<names> list. Each string is the
4680 value of the symbolic link.
4682 If the C<readlink(2)> operation fails on any name, then
4683 the corresponding result string is the empty string C<\"\">.
4684 However the whole operation is completed even if there
4685 were C<readlink(2)> errors, and so you can call this
4686 function with names where you don't know if they are
4687 symbolic links already (albeit slightly less efficient).
4689 This call is intended for programs that want to efficiently
4690 list a directory contents without making many round-trips.
4691 Very long directory listings might cause the protocol
4692 message size to be exceeded, causing
4693 this call to fail. The caller must split up such requests
4694 into smaller groups of names.");
4696 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4697 [InitISOFS, Always, TestOutputBuffer (
4698 [["pread"; "/known-4"; "1"; "3"]], "\n");
4699 InitISOFS, Always, TestOutputBuffer (
4700 [["pread"; "/empty"; "0"; "100"]], "")],
4701 "read part of a file",
4703 This command lets you read part of a file. It reads C<count>
4704 bytes of the file, starting at C<offset>, from file C<path>.
4706 This may read fewer bytes than requested. For further details
4707 see the L<pread(2)> system call.
4709 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4711 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4712 [InitEmpty, Always, TestRun (
4713 [["part_init"; "/dev/sda"; "gpt"]])],
4714 "create an empty partition table",
4716 This creates an empty partition table on C<device> of one of the
4717 partition types listed below. Usually C<parttype> should be
4718 either C<msdos> or C<gpt> (for large disks).
4720 Initially there are no partitions. Following this, you should
4721 call C<guestfs_part_add> for each partition required.
4723 Possible values for C<parttype> are:
4727 =item B<efi> | B<gpt>
4729 Intel EFI / GPT partition table.
4731 This is recommended for >= 2 TB partitions that will be accessed
4732 from Linux and Intel-based Mac OS X. It also has limited backwards
4733 compatibility with the C<mbr> format.
4735 =item B<mbr> | B<msdos>
4737 The standard PC \"Master Boot Record\" (MBR) format used
4738 by MS-DOS and Windows. This partition type will B<only> work
4739 for device sizes up to 2 TB. For large disks we recommend
4744 Other partition table types that may work but are not
4753 =item B<amiga> | B<rdb>
4755 Amiga \"Rigid Disk Block\" format.
4763 DASD, used on IBM mainframes.
4771 Old Mac partition format. Modern Macs use C<gpt>.
4775 NEC PC-98 format, common in Japan apparently.
4783 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4784 [InitEmpty, Always, TestRun (
4785 [["part_init"; "/dev/sda"; "mbr"];
4786 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4787 InitEmpty, Always, TestRun (
4788 [["part_init"; "/dev/sda"; "gpt"];
4789 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4790 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4791 InitEmpty, Always, TestRun (
4792 [["part_init"; "/dev/sda"; "mbr"];
4793 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4794 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4795 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4796 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4797 "add a partition to the device",
4799 This command adds a partition to C<device>. If there is no partition
4800 table on the device, call C<guestfs_part_init> first.
4802 The C<prlogex> parameter is the type of partition. Normally you
4803 should pass C<p> or C<primary> here, but MBR partition tables also
4804 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4807 C<startsect> and C<endsect> are the start and end of the partition
4808 in I<sectors>. C<endsect> may be negative, which means it counts
4809 backwards from the end of the disk (C<-1> is the last sector).
4811 Creating a partition which covers the whole disk is not so easy.
4812 Use C<guestfs_part_disk> to do that.");
4814 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4815 [InitEmpty, Always, TestRun (
4816 [["part_disk"; "/dev/sda"; "mbr"]]);
4817 InitEmpty, Always, TestRun (
4818 [["part_disk"; "/dev/sda"; "gpt"]])],
4819 "partition whole disk with a single primary partition",
4821 This command is simply a combination of C<guestfs_part_init>
4822 followed by C<guestfs_part_add> to create a single primary partition
4823 covering the whole disk.
4825 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4826 but other possible values are described in C<guestfs_part_init>.");
4828 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4829 [InitEmpty, Always, TestRun (
4830 [["part_disk"; "/dev/sda"; "mbr"];
4831 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4832 "make a partition bootable",
4834 This sets the bootable flag on partition numbered C<partnum> on
4835 device C<device>. Note that partitions are numbered from 1.
4837 The bootable flag is used by some operating systems (notably
4838 Windows) to determine which partition to boot from. It is by
4839 no means universally recognized.");
4841 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4842 [InitEmpty, Always, TestRun (
4843 [["part_disk"; "/dev/sda"; "gpt"];
4844 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4845 "set partition name",
4847 This sets the partition name on partition numbered C<partnum> on
4848 device C<device>. Note that partitions are numbered from 1.
4850 The partition name can only be set on certain types of partition
4851 table. This works on C<gpt> but not on C<mbr> partitions.");
4853 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4854 [], (* XXX Add a regression test for this. *)
4855 "list partitions on a device",
4857 This command parses the partition table on C<device> and
4858 returns the list of partitions found.
4860 The fields in the returned structure are:
4866 Partition number, counting from 1.
4870 Start of the partition I<in bytes>. To get sectors you have to
4871 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4875 End of the partition in bytes.
4879 Size of the partition in bytes.
4883 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4884 [InitEmpty, Always, TestOutput (
4885 [["part_disk"; "/dev/sda"; "gpt"];
4886 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4887 "get the partition table type",
4889 This command examines the partition table on C<device> and
4890 returns the partition table type (format) being used.
4892 Common return values include: C<msdos> (a DOS/Windows style MBR
4893 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4894 values are possible, although unusual. See C<guestfs_part_init>
4897 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4898 [InitScratchFS, Always, TestOutputBuffer (
4899 [["fill"; "0x63"; "10"; "/fill"];
4900 ["read_file"; "/fill"]], "cccccccccc")],
4901 "fill a file with octets",
4903 This command creates a new file called C<path>. The initial
4904 content of the file is C<len> octets of C<c>, where C<c>
4905 must be a number in the range C<[0..255]>.
4907 To fill a file with zero bytes (sparsely), it is
4908 much more efficient to use C<guestfs_truncate_size>.
4909 To create a file with a pattern of repeating bytes
4910 use C<guestfs_fill_pattern>.");
4912 ("available", (RErr, [StringList "groups"], []), 216, [],
4913 [InitNone, Always, TestRun [["available"; ""]]],
4914 "test availability of some parts of the API",
4916 This command is used to check the availability of some
4917 groups of functionality in the appliance, which not all builds of
4918 the libguestfs appliance will be able to provide.
4920 The libguestfs groups, and the functions that those
4921 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4922 You can also fetch this list at runtime by calling
4923 C<guestfs_available_all_groups>.
4925 The argument C<groups> is a list of group names, eg:
4926 C<[\"inotify\", \"augeas\"]> would check for the availability of
4927 the Linux inotify functions and Augeas (configuration file
4930 The command returns no error if I<all> requested groups are available.
4932 It fails with an error if one or more of the requested
4933 groups is unavailable in the appliance.
4935 If an unknown group name is included in the
4936 list of groups then an error is always returned.
4944 You must call C<guestfs_launch> before calling this function.
4946 The reason is because we don't know what groups are
4947 supported by the appliance/daemon until it is running and can
4952 If a group of functions is available, this does not necessarily
4953 mean that they will work. You still have to check for errors
4954 when calling individual API functions even if they are
4959 It is usually the job of distro packagers to build
4960 complete functionality into the libguestfs appliance.
4961 Upstream libguestfs, if built from source with all
4962 requirements satisfied, will support everything.
4966 This call was added in version C<1.0.80>. In previous
4967 versions of libguestfs all you could do would be to speculatively
4968 execute a command to find out if the daemon implemented it.
4969 See also C<guestfs_version>.
4973 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
4974 [InitScratchFS, Always, TestOutputBuffer (
4976 ["write"; "/dd/src"; "hello, world"];
4977 ["dd"; "/dd/src"; "/dd/dest"];
4978 ["read_file"; "/dd/dest"]], "hello, world")],
4979 "copy from source to destination using dd",
4981 This command copies from one source device or file C<src>
4982 to another destination device or file C<dest>. Normally you
4983 would use this to copy to or from a device or partition, for
4984 example to duplicate a filesystem.
4986 If the destination is a device, it must be as large or larger
4987 than the source file or device, otherwise the copy will fail.
4988 This command cannot do partial copies (see C<guestfs_copy_size>).");
4990 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
4991 [InitScratchFS, Always, TestOutputInt (
4992 [["write"; "/filesize"; "hello, world"];
4993 ["filesize"; "/filesize"]], 12)],
4994 "return the size of the file in bytes",
4996 This command returns the size of C<file> in bytes.
4998 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4999 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5000 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5002 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5003 [InitBasicFSonLVM, Always, TestOutputList (
5004 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5005 ["lvs"]], ["/dev/VG/LV2"])],
5006 "rename an LVM logical volume",
5008 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5010 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5011 [InitBasicFSonLVM, Always, TestOutputList (
5013 ["vg_activate"; "false"; "VG"];
5014 ["vgrename"; "VG"; "VG2"];
5015 ["vg_activate"; "true"; "VG2"];
5016 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5017 ["vgs"]], ["VG2"])],
5018 "rename an LVM volume group",
5020 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5022 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5023 [InitISOFS, Always, TestOutputBuffer (
5024 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5025 "list the contents of a single file in an initrd",
5027 This command unpacks the file C<filename> from the initrd file
5028 called C<initrdpath>. The filename must be given I<without> the
5029 initial C</> character.
5031 For example, in guestfish you could use the following command
5032 to examine the boot script (usually called C</init>)
5033 contained in a Linux initrd or initramfs image:
5035 initrd-cat /boot/initrd-<version>.img init
5037 See also C<guestfs_initrd_list>.");
5039 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5041 "get the UUID of a physical volume",
5043 This command returns the UUID of the LVM PV C<device>.");
5045 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5047 "get the UUID of a volume group",
5049 This command returns the UUID of the LVM VG named C<vgname>.");
5051 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5053 "get the UUID of a logical volume",
5055 This command returns the UUID of the LVM LV C<device>.");
5057 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5059 "get the PV UUIDs containing the volume group",
5061 Given a VG called C<vgname>, this returns the UUIDs of all
5062 the physical volumes that this volume group resides on.
5064 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5065 calls to associate physical volumes and volume groups.
5067 See also C<guestfs_vglvuuids>.");
5069 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5071 "get the LV UUIDs of all LVs in the volume group",
5073 Given a VG called C<vgname>, this returns the UUIDs of all
5074 the logical volumes created in this volume group.
5076 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5077 calls to associate logical volumes and volume groups.
5079 See also C<guestfs_vgpvuuids>.");
5081 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5082 [InitScratchFS, Always, TestOutputBuffer (
5083 [["mkdir"; "/copy_size"];
5084 ["write"; "/copy_size/src"; "hello, world"];
5085 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5086 ["read_file"; "/copy_size/dest"]], "hello")],
5087 "copy size bytes from source to destination using dd",
5089 This command copies exactly C<size> bytes from one source device
5090 or file C<src> to another destination device or file C<dest>.
5092 Note this will fail if the source is too short or if the destination
5093 is not large enough.");
5095 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5096 [InitBasicFSonLVM, Always, TestRun (
5097 [["zero_device"; "/dev/VG/LV"]])],
5098 "write zeroes to an entire device",
5100 This command writes zeroes over the entire C<device>. Compare
5101 with C<guestfs_zero> which just zeroes the first few blocks of
5104 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5105 [InitScratchFS, Always, TestOutput (
5106 [["mkdir"; "/txz_in"];
5107 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5108 ["cat"; "/txz_in/hello"]], "hello\n")],
5109 "unpack compressed tarball to directory",
5111 This command uploads and unpacks local file C<tarball> (an
5112 I<xz compressed> tar file) into C<directory>.");
5114 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5116 "pack directory into compressed tarball",
5118 This command packs the contents of C<directory> and downloads
5119 it to local file C<tarball> (as an xz compressed tar archive).");
5121 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5123 "resize an NTFS filesystem",
5125 This command resizes an NTFS filesystem, expanding or
5126 shrinking it to the size of the underlying device.
5127 See also L<ntfsresize(8)>.");
5129 ("vgscan", (RErr, [], []), 232, [],
5130 [InitEmpty, Always, TestRun (
5132 "rescan for LVM physical volumes, volume groups and logical volumes",
5134 This rescans all block devices and rebuilds the list of LVM
5135 physical volumes, volume groups and logical volumes.");
5137 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5138 [InitEmpty, Always, TestRun (
5139 [["part_init"; "/dev/sda"; "mbr"];
5140 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5141 ["part_del"; "/dev/sda"; "1"]])],
5142 "delete a partition",
5144 This command deletes the partition numbered C<partnum> on C<device>.
5146 Note that in the case of MBR partitioning, deleting an
5147 extended partition also deletes any logical partitions
5150 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5151 [InitEmpty, Always, TestOutputTrue (
5152 [["part_init"; "/dev/sda"; "mbr"];
5153 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5154 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5155 ["part_get_bootable"; "/dev/sda"; "1"]])],
5156 "return true if a partition is bootable",
5158 This command returns true if the partition C<partnum> on
5159 C<device> has the bootable flag set.
5161 See also C<guestfs_part_set_bootable>.");
5163 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5164 [InitEmpty, Always, TestOutputInt (
5165 [["part_init"; "/dev/sda"; "mbr"];
5166 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5167 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5168 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5169 "get the MBR type byte (ID byte) from a partition",
5171 Returns the MBR type byte (also known as the ID byte) from
5172 the numbered partition C<partnum>.
5174 Note that only MBR (old DOS-style) partitions have type bytes.
5175 You will get undefined results for other partition table
5176 types (see C<guestfs_part_get_parttype>).");
5178 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5179 [], (* tested by part_get_mbr_id *)
5180 "set the MBR type byte (ID byte) of a partition",
5182 Sets the MBR type byte (also known as the ID byte) of
5183 the numbered partition C<partnum> to C<idbyte>. Note
5184 that the type bytes quoted in most documentation are
5185 in fact hexadecimal numbers, but usually documented
5186 without any leading \"0x\" which might be confusing.
5188 Note that only MBR (old DOS-style) partitions have type bytes.
5189 You will get undefined results for other partition table
5190 types (see C<guestfs_part_get_parttype>).");
5192 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5193 [InitISOFS, Always, TestOutputFileMD5 (
5194 [["checksum_device"; "md5"; "/dev/sdd"]],
5195 "../images/test.iso")],
5196 "compute MD5, SHAx or CRC checksum of the contents of a device",
5198 This call computes the MD5, SHAx or CRC checksum of the
5199 contents of the device named C<device>. For the types of
5200 checksums supported see the C<guestfs_checksum> command.");
5202 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5203 [InitNone, Always, TestRun (
5204 [["part_disk"; "/dev/sda"; "mbr"];
5205 ["pvcreate"; "/dev/sda1"];
5206 ["vgcreate"; "VG"; "/dev/sda1"];
5207 ["lvcreate"; "LV"; "VG"; "10"];
5208 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5209 "expand an LV to fill free space",
5211 This expands an existing logical volume C<lv> so that it fills
5212 C<pc>% of the remaining free space in the volume group. Commonly
5213 you would call this with pc = 100 which expands the logical volume
5214 as much as possible, using all remaining free space in the volume
5217 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5218 [], (* XXX Augeas code needs tests. *)
5219 "clear Augeas path",
5221 Set the value associated with C<path> to C<NULL>. This
5222 is the same as the L<augtool(1)> C<clear> command.");
5224 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5225 [InitEmpty, Always, TestOutputInt (
5226 [["get_umask"]], 0o22)],
5227 "get the current umask",
5229 Return the current umask. By default the umask is C<022>
5230 unless it has been set by calling C<guestfs_umask>.");
5232 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5234 "upload a file to the appliance (internal use only)",
5236 The C<guestfs_debug_upload> command uploads a file to
5237 the libguestfs appliance.
5239 There is no comprehensive help for this command. You have
5240 to look at the file C<daemon/debug.c> in the libguestfs source
5241 to find out what it is for.");
5243 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5244 [InitScratchFS, Always, TestOutput (
5245 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5246 ["cat"; "/base64_in"]], "hello\n")],
5247 "upload base64-encoded data to file",
5249 This command uploads base64-encoded data from C<base64file>
5252 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5254 "download file and encode as base64",
5256 This command downloads the contents of C<filename>, writing
5257 it out to local file C<base64file> encoded as base64.");
5259 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5261 "compute MD5, SHAx or CRC checksum of files in a directory",
5263 This command computes the checksums of all regular files in
5264 C<directory> and then emits a list of those checksums to
5265 the local output file C<sumsfile>.
5267 This can be used for verifying the integrity of a virtual
5268 machine. However to be properly secure you should pay
5269 attention to the output of the checksum command (it uses
5270 the ones from GNU coreutils). In particular when the
5271 filename is not printable, coreutils uses a special
5272 backslash syntax. For more information, see the GNU
5273 coreutils info file.");
5275 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5276 [InitScratchFS, Always, TestOutputBuffer (
5277 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5278 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5279 "fill a file with a repeating pattern of bytes",
5281 This function is like C<guestfs_fill> except that it creates
5282 a new file of length C<len> containing the repeating pattern
5283 of bytes in C<pattern>. The pattern is truncated if necessary
5284 to ensure the length of the file is exactly C<len> bytes.");
5286 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5287 [InitScratchFS, Always, TestOutput (
5288 [["write"; "/write"; "new file contents"];
5289 ["cat"; "/write"]], "new file contents");
5290 InitScratchFS, Always, TestOutput (
5291 [["write"; "/write2"; "\nnew file contents\n"];
5292 ["cat"; "/write2"]], "\nnew file contents\n");
5293 InitScratchFS, Always, TestOutput (
5294 [["write"; "/write3"; "\n\n"];
5295 ["cat"; "/write3"]], "\n\n");
5296 InitScratchFS, Always, TestOutput (
5297 [["write"; "/write4"; ""];
5298 ["cat"; "/write4"]], "");
5299 InitScratchFS, Always, TestOutput (
5300 [["write"; "/write5"; "\n\n\n"];
5301 ["cat"; "/write5"]], "\n\n\n");
5302 InitScratchFS, Always, TestOutput (
5303 [["write"; "/write6"; "\n"];
5304 ["cat"; "/write6"]], "\n")],
5305 "create a new file",
5307 This call creates a file called C<path>. The content of the
5308 file is the string C<content> (which can contain any 8 bit data).");
5310 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5311 [InitScratchFS, Always, TestOutput (
5312 [["write"; "/pwrite"; "new file contents"];
5313 ["pwrite"; "/pwrite"; "data"; "4"];
5314 ["cat"; "/pwrite"]], "new data contents");
5315 InitScratchFS, Always, TestOutput (
5316 [["write"; "/pwrite2"; "new file contents"];
5317 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5318 ["cat"; "/pwrite2"]], "new file is extended");
5319 InitScratchFS, Always, TestOutput (
5320 [["write"; "/pwrite3"; "new file contents"];
5321 ["pwrite"; "/pwrite3"; ""; "4"];
5322 ["cat"; "/pwrite3"]], "new file contents")],
5323 "write to part of a file",
5325 This command writes to part of a file. It writes the data
5326 buffer C<content> to the file C<path> starting at offset C<offset>.
5328 This command implements the L<pwrite(2)> system call, and like
5329 that system call it may not write the full data requested. The
5330 return value is the number of bytes that were actually written
5331 to the file. This could even be 0, although short writes are
5332 unlikely for regular files in ordinary circumstances.
5334 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5336 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5338 "resize an ext2, ext3 or ext4 filesystem (with size)",
5340 This command is the same as C<guestfs_resize2fs> except that it
5341 allows you to specify the new size (in bytes) explicitly.");
5343 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5345 "resize an LVM physical volume (with size)",
5347 This command is the same as C<guestfs_pvresize> except that it
5348 allows you to specify the new size (in bytes) explicitly.");
5350 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5352 "resize an NTFS filesystem (with size)",
5354 This command is the same as C<guestfs_ntfsresize> except that it
5355 allows you to specify the new size (in bytes) explicitly.");
5357 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5358 [InitNone, Always, TestRun [["available_all_groups"]]],
5359 "return a list of all optional groups",
5361 This command returns a list of all optional groups that this
5362 daemon knows about. Note this returns both supported and unsupported
5363 groups. To find out which ones the daemon can actually support
5364 you have to call C<guestfs_available> on each member of the
5367 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5369 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5370 [InitScratchFS, Always, TestOutputStruct (
5371 [["fallocate64"; "/fallocate64"; "1000000"];
5372 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5373 "preallocate a file in the guest filesystem",
5375 This command preallocates a file (containing zero bytes) named
5376 C<path> of size C<len> bytes. If the file exists already, it
5379 Note that this call allocates disk blocks for the file.
5380 To create a sparse file use C<guestfs_truncate_size> instead.
5382 The deprecated call C<guestfs_fallocate> does the same,
5383 but owing to an oversight it only allowed 30 bit lengths
5384 to be specified, effectively limiting the maximum size
5385 of files created through that call to 1GB.
5387 Do not confuse this with the guestfish-specific
5388 C<alloc> and C<sparse> commands which create
5389 a file in the host and attach it as a device.");
5391 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5392 [InitBasicFS, Always, TestOutput (
5393 [["set_e2label"; "/dev/sda1"; "LTEST"];
5394 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5395 "get the filesystem label",
5397 This returns the filesystem label of the filesystem on
5400 If the filesystem is unlabeled, this returns the empty string.
5402 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5404 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5405 (let uuid = uuidgen () in
5406 [InitBasicFS, Always, TestOutput (
5407 [["set_e2uuid"; "/dev/sda1"; uuid];
5408 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5409 "get the filesystem UUID",
5411 This returns the filesystem UUID of the filesystem on
5414 If the filesystem does not have a UUID, this returns the empty string.
5416 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5418 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5419 (* Can't be tested with the current framework because
5420 * the VG is being used by the mounted filesystem, so
5421 * the vgchange -an command we do first will fail.
5424 "set LVM device filter",
5426 This sets the LVM device filter so that LVM will only be
5427 able to \"see\" the block devices in the list C<devices>,
5428 and will ignore all other attached block devices.
5430 Where disk image(s) contain duplicate PVs or VGs, this
5431 command is useful to get LVM to ignore the duplicates, otherwise
5432 LVM can get confused. Note also there are two types
5433 of duplication possible: either cloned PVs/VGs which have
5434 identical UUIDs; or VGs that are not cloned but just happen
5435 to have the same name. In normal operation you cannot
5436 create this situation, but you can do it outside LVM, eg.
5437 by cloning disk images or by bit twiddling inside the LVM
5440 This command also clears the LVM cache and performs a volume
5443 You can filter whole block devices or individual partitions.
5445 You cannot use this if any VG is currently in use (eg.
5446 contains a mounted filesystem), even if you are not
5447 filtering out that VG.");
5449 ("lvm_clear_filter", (RErr, [], []), 256, [],
5450 [], (* see note on lvm_set_filter *)
5451 "clear LVM device filter",
5453 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5454 will be able to see every block device.
5456 This command also clears the LVM cache and performs a volume
5459 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5461 "open a LUKS-encrypted block device",
5463 This command opens a block device which has been encrypted
5464 according to the Linux Unified Key Setup (LUKS) standard.
5466 C<device> is the encrypted block device or partition.
5468 The caller must supply one of the keys associated with the
5469 LUKS block device, in the C<key> parameter.
5471 This creates a new block device called C</dev/mapper/mapname>.
5472 Reads and writes to this block device are decrypted from and
5473 encrypted to the underlying C<device> respectively.
5475 If this block device contains LVM volume groups, then
5476 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5477 will make them visible.");
5479 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5481 "open a LUKS-encrypted block device read-only",
5483 This is the same as C<guestfs_luks_open> except that a read-only
5484 mapping is created.");
5486 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5488 "close a LUKS device",
5490 This closes a LUKS device that was created earlier by
5491 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5492 C<device> parameter must be the name of the LUKS mapping
5493 device (ie. C</dev/mapper/mapname>) and I<not> the name
5494 of the underlying block device.");
5496 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5498 "format a block device as a LUKS encrypted device",
5500 This command erases existing data on C<device> and formats
5501 the device as a LUKS encrypted device. C<key> is the
5502 initial key, which is added to key slot C<slot>. (LUKS
5503 supports 8 key slots, numbered 0-7).");
5505 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5507 "format a block device as a LUKS encrypted device",
5509 This command is the same as C<guestfs_luks_format> but
5510 it also allows you to set the C<cipher> used.");
5512 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5514 "add a key on a LUKS encrypted device",
5516 This command adds a new key on LUKS device C<device>.
5517 C<key> is any existing key, and is used to access the device.
5518 C<newkey> is the new key to add. C<keyslot> is the key slot
5519 that will be replaced.
5521 Note that if C<keyslot> already contains a key, then this
5522 command will fail. You have to use C<guestfs_luks_kill_slot>
5523 first to remove that key.");
5525 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5527 "remove a key from a LUKS encrypted device",
5529 This command deletes the key in key slot C<keyslot> from the
5530 encrypted LUKS device C<device>. C<key> must be one of the
5533 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5534 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5535 [["is_lv"; "/dev/VG/LV"]]);
5536 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5537 [["is_lv"; "/dev/sda1"]])],
5538 "test if device is a logical volume",
5540 This command tests whether C<device> is a logical volume, and
5541 returns true iff this is the case.");
5543 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5545 "find a filesystem by UUID",
5547 This command searches the filesystems and returns the one
5548 which has the given UUID. An error is returned if no such
5549 filesystem can be found.
5551 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5553 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5555 "find a filesystem by label",
5557 This command searches the filesystems and returns the one
5558 which has the given label. An error is returned if no such
5559 filesystem can be found.
5561 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5563 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5564 [InitISOFS, Always, TestOutputFalse (
5565 [["is_chardev"; "/directory"]]);
5566 InitScratchFS, Always, TestOutputTrue (
5567 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5568 ["is_chardev"; "/is_chardev"]])],
5569 "test if character device",
5571 This returns C<true> if and only if there is a character device
5572 with the given C<path> name.
5574 See also C<guestfs_stat>.");
5576 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5577 [InitISOFS, Always, TestOutputFalse (
5578 [["is_blockdev"; "/directory"]]);
5579 InitScratchFS, Always, TestOutputTrue (
5580 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5581 ["is_blockdev"; "/is_blockdev"]])],
5582 "test if block device",
5584 This returns C<true> if and only if there is a block device
5585 with the given C<path> name.
5587 See also C<guestfs_stat>.");
5589 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5590 [InitISOFS, Always, TestOutputFalse (
5591 [["is_fifo"; "/directory"]]);
5592 InitScratchFS, Always, TestOutputTrue (
5593 [["mkfifo"; "0o777"; "/is_fifo"];
5594 ["is_fifo"; "/is_fifo"]])],
5595 "test if FIFO (named pipe)",
5597 This returns C<true> if and only if there is a FIFO (named pipe)
5598 with the given C<path> name.
5600 See also C<guestfs_stat>.");
5602 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5603 [InitISOFS, Always, TestOutputFalse (
5604 [["is_symlink"; "/directory"]]);
5605 InitISOFS, Always, TestOutputTrue (
5606 [["is_symlink"; "/abssymlink"]])],
5607 "test if symbolic link",
5609 This returns C<true> if and only if there is a symbolic link
5610 with the given C<path> name.
5612 See also C<guestfs_stat>.");
5614 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5615 (* XXX Need a positive test for sockets. *)
5616 [InitISOFS, Always, TestOutputFalse (
5617 [["is_socket"; "/directory"]])],
5620 This returns C<true> if and only if there is a Unix domain socket
5621 with the given C<path> name.
5623 See also C<guestfs_stat>.");
5625 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5626 [InitPartition, Always, TestOutputDevice (
5627 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5628 InitEmpty, Always, TestLastFail (
5629 [["part_to_dev"; "/dev/sda"]])],
5630 "convert partition name to device name",
5632 This function takes a partition name (eg. \"/dev/sdb1\") and
5633 removes the partition number, returning the device name
5636 The named partition must exist, for example as a string returned
5637 from C<guestfs_list_partitions>.");
5639 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5640 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5641 [InitScratchFS, Always, TestOutput (
5642 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5643 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5644 "upload a file from the local machine with offset",
5646 Upload local file C<filename> to C<remotefilename> on the
5649 C<remotefilename> is overwritten starting at the byte C<offset>
5650 specified. The intention is to overwrite parts of existing
5651 files or devices, although if a non-existant file is specified
5652 then it is created with a \"hole\" before C<offset>. The
5653 size of the data written is implicit in the size of the
5656 Note that there is no limit on the amount of data that
5657 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5658 and this call always writes the full amount unless an
5661 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5663 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5664 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5665 let offset = string_of_int 100 in
5666 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5667 [InitScratchFS, Always, TestOutput (
5668 (* Pick a file from cwd which isn't likely to change. *)
5669 [["mkdir"; "/download_offset"];
5670 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5671 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5672 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5673 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5674 "download a file to the local machine with offset and size",
5676 Download file C<remotefilename> and save it as C<filename>
5677 on the local machine.
5679 C<remotefilename> is read for C<size> bytes starting at C<offset>
5680 (this region must be within the file or device).
5682 Note that there is no limit on the amount of data that
5683 can be downloaded with this call, unlike with C<guestfs_pread>,
5684 and this call always reads the full amount unless an
5687 See also C<guestfs_download>, C<guestfs_pread>.");
5689 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5690 [InitPartition, Always, TestOutputListOfDevices (
5691 [["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"];
5692 ["blockdev_rereadpt"; "/dev/sda"];
5693 ["list_partitions"]], ["/dev/sdb1"])],
5694 "write to part of a device",
5696 This command writes to part of a device. It writes the data
5697 buffer C<content> to C<device> starting at offset C<offset>.
5699 This command implements the L<pwrite(2)> system call, and like
5700 that system call it may not write the full data requested
5701 (although short writes to disk devices and partitions are
5702 probably impossible with standard Linux kernels).
5704 See also C<guestfs_pwrite>.");
5706 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5707 [InitEmpty, Always, TestOutputBuffer (
5708 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5709 "read part of a device",
5711 This command lets you read part of a file. It reads C<count>
5712 bytes of C<device>, starting at C<offset>.
5714 This may read fewer bytes than requested. For further details
5715 see the L<pread(2)> system call.
5717 See also C<guestfs_pread>.");
5719 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5720 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5721 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5722 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5723 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5724 "get canonical name of an LV",
5726 This converts alternative naming schemes for LVs that you
5727 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5728 is converted to C</dev/VG/LV>.
5730 This command returns an error if the C<lvname> parameter does
5731 not refer to a logical volume.
5733 See also C<guestfs_is_lv>.");
5735 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5736 [InitEmpty, Always, TestOutput (
5737 [["part_disk"; "/dev/sda"; "mbr"];
5738 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5739 ["mount_options"; ""; "/dev/sda1"; "/"];
5740 ["write"; "/new"; "new file contents"];
5741 ["cat"; "/new"]], "new file contents")],
5742 "make a filesystem",
5744 This function creates a filesystem on C<device>. The filesystem
5745 type is C<fstype>, for example C<ext3>.
5747 The optional arguments are:
5753 The filesystem block size. Supported block sizes depend on the
5754 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5755 for Linux ext2/3 filesystems.
5757 For VFAT and NTFS the C<blocksize> parameter is treated as
5758 the requested cluster size.
5760 For UFS block sizes, please see L<mkfs.ufs(8)>.
5764 This passes the C<-O> parameter to the external mkfs program.
5766 For certain filesystem types, this allows extra filesystem
5767 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5770 You cannot use this optional parameter with the C<gfs> or
5771 C<gfs2> filesystem type.
5775 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5777 "get a single extended attribute",
5779 Get a single extended attribute from file C<path> named C<name>.
5780 This call follows symlinks. If you want to lookup an extended
5781 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5783 Normally it is better to get all extended attributes from a file
5784 in one go by calling C<guestfs_getxattrs>. However some Linux
5785 filesystem implementations are buggy and do not provide a way to
5786 list out attributes. For these filesystems (notably ntfs-3g)
5787 you have to know the names of the extended attributes you want
5788 in advance and call this function.
5790 Extended attribute values are blobs of binary data. If there
5791 is no extended attribute named C<name>, this returns an error.
5793 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5795 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5797 "get a single extended attribute",
5799 Get a single extended attribute from file C<path> named C<name>.
5800 If C<path> is a symlink, then this call returns an extended
5801 attribute from the symlink.
5803 Normally it is better to get all extended attributes from a file
5804 in one go by calling C<guestfs_getxattrs>. However some Linux
5805 filesystem implementations are buggy and do not provide a way to
5806 list out attributes. For these filesystems (notably ntfs-3g)
5807 you have to know the names of the extended attributes you want
5808 in advance and call this function.
5810 Extended attribute values are blobs of binary data. If there
5811 is no extended attribute named C<name>, this returns an error.
5813 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5815 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5817 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5819 This command is the same as C<guestfs_resize2fs>, but the filesystem
5820 is resized to its minimum size. This works like the C<-M> option
5821 to the C<resize2fs> command.
5823 To get the resulting size of the filesystem you should call
5824 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5825 values. These two numbers, multiplied together, give the
5826 resulting size of the minimal filesystem in bytes.");
5828 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5830 "internal autosync operation",
5832 This command performs the autosync operation just before the
5833 handle is closed. You should not call this command directly.
5834 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5835 control whether or not this operation is performed when the
5836 handle is closed.");
5840 let all_functions = non_daemon_functions @ daemon_functions
5842 (* In some places we want the functions to be displayed sorted
5843 * alphabetically, so this is useful:
5845 let all_functions_sorted = List.sort action_compare all_functions
5847 (* This is used to generate the src/MAX_PROC_NR file which
5848 * contains the maximum procedure number, a surrogate for the
5849 * ABI version number. See src/Makefile.am for the details.
5852 let proc_nrs = List.map (
5853 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5854 ) daemon_functions in
5855 List.fold_left max 0 proc_nrs
5857 (* Non-API meta-commands available only in guestfish.
5859 * Note (1): style, proc_nr and tests fields are all meaningless.
5860 * The only fields which are actually used are the shortname,
5861 * FishAlias flags, shortdesc and longdesc.
5863 * Note (2): to refer to other commands, use L</shortname>.
5865 * Note (3): keep this list sorted by shortname.
5867 let fish_commands = [
5868 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5869 "allocate and add a disk file",
5870 " alloc filename size
5872 This creates an empty (zeroed) file of the given size, and then adds
5873 so it can be further examined.
5875 For more advanced image creation, see L<qemu-img(1)> utility.
5877 Size can be specified using standard suffixes, eg. C<1M>.
5879 To create a sparse file, use L</sparse> instead. To create a
5880 prepared disk image, see L</PREPARED DISK IMAGES>.");
5882 ("copy_in", (RErr,[], []), -1, [], [],
5883 "copy local files or directories into an image",
5884 " copy-in local [local ...] /remotedir
5886 C<copy-in> copies local files or directories recursively into the disk
5887 image, placing them in the directory called C</remotedir> (which must
5888 exist). This guestfish meta-command turns into a sequence of
5889 L</tar-in> and other commands as necessary.
5891 Multiple local files and directories can be specified, but the last
5892 parameter must always be a remote directory. Wildcards cannot be
5895 ("copy_out", (RErr,[], []), -1, [], [],
5896 "copy remote files or directories out of an image",
5897 " copy-out remote [remote ...] localdir
5899 C<copy-out> copies remote files or directories recursively out of the
5900 disk image, placing them on the host disk in a local directory called
5901 C<localdir> (which must exist). This guestfish meta-command turns
5902 into a sequence of L</download>, L</tar-out> and other commands as
5905 Multiple remote files and directories can be specified, but the last
5906 parameter must always be a local directory. To download to the
5907 current directory, use C<.> as in:
5911 Wildcards cannot be used in the ordinary command, but you can use
5912 them with the help of L</glob> like this:
5914 glob copy-out /home/* .");
5916 ("echo", (RErr,[], []), -1, [], [],
5917 "display a line of text",
5920 This echos the parameters to the terminal.");
5922 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5926 This is used to edit a file. It downloads the file, edits it
5927 locally using your editor, then uploads the result.
5929 The editor is C<$EDITOR>. However if you use the alternate
5930 commands C<vi> or C<emacs> you will get those corresponding
5933 ("glob", (RErr,[], []), -1, [], [],
5934 "expand wildcards in command",
5935 " glob command args...
5937 Expand wildcards in any paths in the args list, and run C<command>
5938 repeatedly on each matching path.
5940 See L</WILDCARDS AND GLOBBING>.");
5942 ("hexedit", (RErr,[], []), -1, [], [],
5943 "edit with a hex editor",
5944 " hexedit <filename|device>
5945 hexedit <filename|device> <max>
5946 hexedit <filename|device> <start> <max>
5948 Use hexedit (a hex editor) to edit all or part of a binary file
5951 This command works by downloading potentially the whole file or
5952 device, editing it locally, then uploading it. If the file or
5953 device is large, you have to specify which part you wish to edit
5954 by using C<max> and/or C<start> C<max> parameters.
5955 C<start> and C<max> are specified in bytes, with the usual
5956 modifiers allowed such as C<1M> (1 megabyte).
5958 For example to edit the first few sectors of a disk you
5963 which would allow you to edit anywhere within the first megabyte
5966 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
5968 hexedit /dev/sda1 0x400 0x400
5970 (assuming the superblock is in the standard location).
5972 This command requires the external L<hexedit(1)> program. You
5973 can specify another program to use by setting the C<HEXEDITOR>
5974 environment variable.
5976 See also L</hexdump>.");
5978 ("lcd", (RErr,[], []), -1, [], [],
5979 "change working directory",
5982 Change the local directory, ie. the current directory of guestfish
5985 Note that C<!cd> won't do what you might expect.");
5987 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
5991 Opens the manual page for guestfish.");
5993 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
5999 This is used to view a file.
6001 The default viewer is C<$PAGER>. However if you use the alternate
6002 command C<less> you will get the C<less> command specifically.");
6004 ("reopen", (RErr,[], []), -1, [], [],
6005 "close and reopen libguestfs handle",
6008 Close and reopen the libguestfs handle. It is not necessary to use
6009 this normally, because the handle is closed properly when guestfish
6010 exits. However this is occasionally useful for testing.");
6012 ("sparse", (RErr,[], []), -1, [], [],
6013 "create a sparse disk image and add",
6014 " sparse filename size
6016 This creates an empty sparse file of the given size, and then adds
6017 so it can be further examined.
6019 In all respects it works the same as the L</alloc> command, except that
6020 the image file is allocated sparsely, which means that disk blocks are
6021 not assigned to the file until they are needed. Sparse disk files
6022 only use space when written to, but they are slower and there is a
6023 danger you could run out of real disk space during a write operation.
6025 For more advanced image creation, see L<qemu-img(1)> utility.
6027 Size can be specified using standard suffixes, eg. C<1M>.");
6029 ("supported", (RErr,[], []), -1, [], [],
6030 "list supported groups of commands",
6033 This command returns a list of the optional groups
6034 known to the daemon, and indicates which ones are
6035 supported by this build of the libguestfs appliance.
6037 See also L<guestfs(3)/AVAILABILITY>.");
6039 ("time", (RErr,[], []), -1, [], [],
6040 "print elapsed time taken to run a command",
6041 " time command args...
6043 Run the command as usual, but print the elapsed time afterwards. This
6044 can be useful for benchmarking operations.");