2 * Copyright (C) 2009-2011 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.
840 The distro could not be determined.
844 Windows does not have distributions. This string is
845 returned if the OS type is Windows.
849 Future versions of libguestfs may return other strings here.
850 The caller should be prepared to handle any string.
852 Please read L<guestfs(3)/INSPECTION> for more details.");
854 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
856 "get major version of inspected operating system",
858 This function should only be called with a root device string
859 as returned by C<guestfs_inspect_os>.
861 This returns the major version number of the inspected operating
864 Windows uses a consistent versioning scheme which is I<not>
865 reflected in the popular public names used by the operating system.
866 Notably the operating system known as \"Windows 7\" is really
867 version 6.1 (ie. major = 6, minor = 1). You can find out the
868 real versions corresponding to releases of Windows by consulting
871 If the version could not be determined, then C<0> is returned.
873 Please read L<guestfs(3)/INSPECTION> for more details.");
875 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
877 "get minor version of inspected operating system",
879 This function should only be called with a root device string
880 as returned by C<guestfs_inspect_os>.
882 This returns the minor version number of the inspected operating
885 If the version could not be determined, then C<0> is returned.
887 Please read L<guestfs(3)/INSPECTION> for more details.
888 See also C<guestfs_inspect_get_major_version>.");
890 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
892 "get product name of inspected operating system",
894 This function should only be called with a root device string
895 as returned by C<guestfs_inspect_os>.
897 This returns the product name of the inspected operating
898 system. The product name is generally some freeform string
899 which can be displayed to the user, but should not be
902 If the product name could not be determined, then the
903 string C<unknown> is returned.
905 Please read L<guestfs(3)/INSPECTION> for more details.");
907 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
909 "get mountpoints of inspected operating system",
911 This function should only be called with a root device string
912 as returned by C<guestfs_inspect_os>.
914 This returns a hash of where we think the filesystems
915 associated with this operating system should be mounted.
916 Callers should note that this is at best an educated guess
917 made by reading configuration files such as C</etc/fstab>.
918 I<In particular note> that this may return filesystems
919 which are non-existent or not mountable and callers should
920 be prepared to handle or ignore failures if they try to
923 Each element in the returned hashtable has a key which
924 is the path of the mountpoint (eg. C</boot>) and a value
925 which is the filesystem that would be mounted there
928 Non-mounted devices such as swap devices are I<not>
929 returned in this list.
931 Please read L<guestfs(3)/INSPECTION> for more details.
932 See also C<guestfs_inspect_get_filesystems>.");
934 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
936 "get filesystems associated with inspected operating system",
938 This function should only be called with a root device string
939 as returned by C<guestfs_inspect_os>.
941 This returns a list of all the filesystems that we think
942 are associated with this operating system. This includes
943 the root filesystem, other ordinary filesystems, and
944 non-mounted devices like swap partitions.
946 In the case of a multi-boot virtual machine, it is possible
947 for a filesystem to be shared between operating systems.
949 Please read L<guestfs(3)/INSPECTION> for more details.
950 See also C<guestfs_inspect_get_mountpoints>.");
952 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
954 "set enable network flag",
956 If C<network> is true, then the network is enabled in the
957 libguestfs appliance. The default is false.
959 This affects whether commands are able to access the network
960 (see L<guestfs(3)/RUNNING COMMANDS>).
962 You must call this before calling C<guestfs_launch>, otherwise
965 ("get_network", (RBool "network", [], []), -1, [],
967 "get enable network flag",
969 This returns the enable network flag.");
971 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
975 This inspection command looks for filesystems on partitions,
976 block devices and logical volumes, returning a list of devices
977 containing filesystems and their type.
979 The return value is a hash, where the keys are the devices
980 containing filesystems, and the values are the filesystem types.
983 \"/dev/sda1\" => \"ntfs\"
984 \"/dev/sda2\" => \"ext2\"
985 \"/dev/vg_guest/lv_root\" => \"ext4\"
986 \"/dev/vg_guest/lv_swap\" => \"swap\"
988 The value can have the special value \"unknown\", meaning the
989 content of the device is undetermined or empty.
990 \"swap\" means a Linux swap partition.
992 This command runs other libguestfs commands, which might include
993 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
994 use this soon after launch and only when nothing is mounted.
996 Not all of the filesystems returned will be mountable. In
997 particular, swap partitions are returned in the list. Also
998 this command does not check that each filesystem
999 found is valid and mountable, and some filesystems might
1000 be mountable but require special options. Filesystems may
1001 not all belong to a single logical operating system
1002 (use C<guestfs_inspect_os> to look for OSes).");
1004 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
1006 "add an image to examine or modify",
1008 This function adds a virtual machine disk image C<filename> to
1009 libguestfs. The first time you call this function, the disk
1010 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1013 You don't necessarily need to be root when using libguestfs. However
1014 you obviously do need sufficient permissions to access the filename
1015 for whatever operations you want to perform (ie. read access if you
1016 just want to read the image or write access if you want to modify the
1019 This call checks that C<filename> exists.
1021 The optional arguments are:
1027 If true then the image is treated as read-only. Writes are still
1028 allowed, but they are stored in a temporary snapshot overlay which
1029 is discarded at the end. The disk that you add is not modified.
1033 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1034 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1035 Possible formats include C<raw> and C<qcow2>.
1037 Automatic detection of the format opens you up to a potential
1038 security hole when dealing with untrusted raw-format images.
1039 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1044 This rarely-used option lets you emulate the behaviour of the
1045 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1049 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1051 "get Windows systemroot of inspected operating system",
1053 This function should only be called with a root device string
1054 as returned by C<guestfs_inspect_os>.
1056 This returns the Windows systemroot of the inspected guest.
1057 The systemroot is a directory path such as C</WINDOWS>.
1059 This call assumes that the guest is Windows and that the
1060 systemroot could be determined by inspection. If this is not
1061 the case then an error is returned.
1063 Please read L<guestfs(3)/INSPECTION> for more details.");
1065 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1067 "return list of operating systems found by last inspection",
1069 This function is a convenient way to get the list of root
1070 devices, as returned from a previous call to C<guestfs_inspect_os>,
1071 but without redoing the whole inspection process.
1073 This returns an empty list if either no root devices were
1074 found or the caller has not called C<guestfs_inspect_os>.
1076 Please read L<guestfs(3)/INSPECTION> for more details.");
1078 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1080 "debug the QEMU command line (internal use only)",
1082 This returns the internal QEMU command line. 'debug' commands are
1083 not part of the formal API and can be removed or changed at any time.");
1085 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"]), -1, [FishAlias "domain"],
1087 "add the disk(s) from a named libvirt domain",
1089 This function adds the disk(s) attached to the named libvirt
1090 domain C<dom>. It works by connecting to libvirt, requesting
1091 the domain and domain XML from libvirt, parsing it for disks,
1092 and calling C<guestfs_add_drive_opts> on each one.
1094 The number of disks added is returned. This operation is atomic:
1095 if an error is returned, then no disks are added.
1097 This function does some minimal checks to make sure the libvirt
1098 domain is not running (unless C<readonly> is true). In a future
1099 version we will try to acquire the libvirt lock on each disk.
1101 Disks must be accessible locally. This often means that adding disks
1102 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1103 will fail unless those disks are accessible via the same device path
1106 The optional C<libvirturi> parameter sets the libvirt URI
1107 (see L<http://libvirt.org/uri.html>). If this is not set then
1108 we connect to the default libvirt URI (or one set through an
1109 environment variable, see the libvirt documentation for full
1112 The optional C<live> flag controls whether this call will try
1113 to connect to a running virtual machine C<guestfsd> process if
1114 it sees a suitable E<lt>channelE<gt> element in the libvirt
1115 XML definition. The default (if the flag is omitted) is never
1116 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1119 The other optional parameters are passed directly through to
1120 C<guestfs_add_drive_opts>.");
1123 This interface is not quite baked yet. -- RWMJ 2010-11-11
1124 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1126 "add the disk(s) from a libvirt domain",
1128 This function adds the disk(s) attached to the libvirt domain C<dom>.
1129 It works by requesting the domain XML from libvirt, parsing it for
1130 disks, and calling C<guestfs_add_drive_opts> on each one.
1132 In the C API we declare C<void *dom>, but really it has type
1133 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1135 The number of disks added is returned. This operation is atomic:
1136 if an error is returned, then no disks are added.
1138 This function does some minimal checks to make sure the libvirt
1139 domain is not running (unless C<readonly> is true). In a future
1140 version we will try to acquire the libvirt lock on each disk.
1142 Disks must be accessible locally. This often means that adding disks
1143 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1144 will fail unless those disks are accessible via the same device path
1147 The optional C<live> flag controls whether this call will try
1148 to connect to a running virtual machine C<guestfsd> process if
1149 it sees a suitable E<lt>channelE<gt> element in the libvirt
1150 XML definition. The default (if the flag is omitted) is never
1151 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1154 The other optional parameters are passed directly through to
1155 C<guestfs_add_drive_opts>.");
1158 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1160 "get package format used by the operating system",
1162 This function should only be called with a root device string
1163 as returned by C<guestfs_inspect_os>.
1165 This function and C<guestfs_inspect_get_package_management> return
1166 the package format and package management tool used by the
1167 inspected operating system. For example for Fedora these
1168 functions would return C<rpm> (package format) and
1169 C<yum> (package management).
1171 This returns the string C<unknown> if we could not determine the
1172 package format I<or> if the operating system does not have
1173 a real packaging system (eg. Windows).
1175 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1176 Future versions of libguestfs may return other strings.
1178 Please read L<guestfs(3)/INSPECTION> for more details.");
1180 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1182 "get package management tool used by the operating system",
1184 This function should only be called with a root device string
1185 as returned by C<guestfs_inspect_os>.
1187 C<guestfs_inspect_get_package_format> and this function return
1188 the package format and package management tool used by the
1189 inspected operating system. For example for Fedora these
1190 functions would return C<rpm> (package format) and
1191 C<yum> (package management).
1193 This returns the string C<unknown> if we could not determine the
1194 package management tool I<or> if the operating system does not have
1195 a real packaging system (eg. Windows).
1197 Possible strings include: C<yum>, C<up2date>,
1198 C<apt> (for all Debian derivatives),
1199 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1200 Future versions of libguestfs may return other strings.
1202 Please read L<guestfs(3)/INSPECTION> for more details.");
1204 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1206 "get list of applications installed in the operating system",
1208 This function should only be called with a root device string
1209 as returned by C<guestfs_inspect_os>.
1211 Return the list of applications installed in the operating system.
1213 I<Note:> This call works differently from other parts of the
1214 inspection API. You have to call C<guestfs_inspect_os>, then
1215 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1216 before calling this. Listing applications is a significantly
1217 more difficult operation which requires access to the full
1218 filesystem. Also note that unlike the other
1219 C<guestfs_inspect_get_*> calls which are just returning
1220 data cached in the libguestfs handle, this call actually reads
1221 parts of the mounted filesystems during the call.
1223 This returns an empty list if the inspection code was not able
1224 to determine the list of applications.
1226 The application structure contains the following fields:
1232 The name of the application. For Red Hat-derived and Debian-derived
1233 Linux guests, this is the package name.
1235 =item C<app_display_name>
1237 The display name of the application, sometimes localized to the
1238 install language of the guest operating system.
1240 If unavailable this is returned as an empty string C<\"\">.
1241 Callers needing to display something can use C<app_name> instead.
1245 For package managers which use epochs, this contains the epoch of
1246 the package (an integer). If unavailable, this is returned as C<0>.
1248 =item C<app_version>
1250 The version string of the application or package. If unavailable
1251 this is returned as an empty string C<\"\">.
1253 =item C<app_release>
1255 The release string of the application or package, for package
1256 managers that use this. If unavailable this is returned as an
1257 empty string C<\"\">.
1259 =item C<app_install_path>
1261 The installation path of the application (on operating systems
1262 such as Windows which use installation paths). This path is
1263 in the format used by the guest operating system, it is not
1266 If unavailable this is returned as an empty string C<\"\">.
1268 =item C<app_trans_path>
1270 The install path translated into a libguestfs path.
1271 If unavailable this is returned as an empty string C<\"\">.
1273 =item C<app_publisher>
1275 The name of the publisher of the application, for package
1276 managers that use this. If unavailable this is returned
1277 as an empty string C<\"\">.
1281 The URL (eg. upstream URL) of the application.
1282 If unavailable this is returned as an empty string C<\"\">.
1284 =item C<app_source_package>
1286 For packaging systems which support this, the name of the source
1287 package. If unavailable this is returned as an empty string C<\"\">.
1289 =item C<app_summary>
1291 A short (usually one line) description of the application or package.
1292 If unavailable this is returned as an empty string C<\"\">.
1294 =item C<app_description>
1296 A longer description of the application or package.
1297 If unavailable this is returned as an empty string C<\"\">.
1301 Please read L<guestfs(3)/INSPECTION> for more details.");
1303 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1305 "get hostname of the operating system",
1307 This function should only be called with a root device string
1308 as returned by C<guestfs_inspect_os>.
1310 This function returns the hostname of the operating system
1311 as found by inspection of the guest's configuration files.
1313 If the hostname could not be determined, then the
1314 string C<unknown> is returned.
1316 Please read L<guestfs(3)/INSPECTION> for more details.");
1318 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1320 "get format of inspected operating system",
1322 This function should only be called with a root device string
1323 as returned by C<guestfs_inspect_os>.
1325 This returns the format of the inspected operating system. You
1326 can use it to detect install images, live CDs and similar.
1328 Currently defined formats are:
1334 This is an installed operating system.
1338 The disk image being inspected is not an installed operating system,
1339 but a I<bootable> install disk, live CD, or similar.
1343 The format of this disk image is not known.
1347 Future versions of libguestfs may return other strings here.
1348 The caller should be prepared to handle any string.
1350 Please read L<guestfs(3)/INSPECTION> for more details.");
1352 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1354 "get live flag for install disk",
1356 This function should only be called with a root device string
1357 as returned by C<guestfs_inspect_os>.
1359 If C<guestfs_inspect_get_format> returns C<installer> (this
1360 is an install disk), then this returns true if a live image
1361 was detected on the disk.
1363 Please read L<guestfs(3)/INSPECTION> for more details.");
1365 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1367 "get netinst (network installer) flag for install disk",
1369 This function should only be called with a root device string
1370 as returned by C<guestfs_inspect_os>.
1372 If C<guestfs_inspect_get_format> returns C<installer> (this
1373 is an install disk), then this returns true if the disk is
1374 a network installer, ie. not a self-contained install CD but
1375 one which is likely to require network access to complete
1378 Please read L<guestfs(3)/INSPECTION> for more details.");
1380 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1382 "get multipart flag for install disk",
1384 This function should only be called with a root device string
1385 as returned by C<guestfs_inspect_os>.
1387 If C<guestfs_inspect_get_format> returns C<installer> (this
1388 is an install disk), then this returns true if the disk is
1391 Please read L<guestfs(3)/INSPECTION> for more details.");
1393 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1395 "set the attach method",
1397 Set the method that libguestfs uses to connect to the back end
1398 guestfsd daemon. Possible methods are:
1404 Launch an appliance and connect to it. This is the ordinary method
1407 =item C<unix:I<path>>
1409 Connect to the Unix domain socket I<path>.
1411 This method lets you connect to an existing daemon or (using
1412 virtio-serial) to a live guest. For more information, see
1413 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1417 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1418 [InitNone, Always, TestOutput (
1419 [["get_attach_method"]], "appliance")],
1420 "get the attach method",
1422 Return the current attach method. See C<guestfs_set_attach_method>.");
1424 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1426 "get product variant of inspected operating system",
1428 This function should only be called with a root device string
1429 as returned by C<guestfs_inspect_os>.
1431 This returns the product variant of the inspected operating
1434 For Windows guests, this returns the contents of the Registry key
1435 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1436 C<InstallationType> which is usually a string such as
1437 C<Client> or C<Server> (other values are possible). This
1438 can be used to distinguish consumer and enterprise versions
1439 of Windows that have the same version number (for example,
1440 Windows 7 and Windows 2008 Server are both version 6.1,
1441 but the former is C<Client> and the latter is C<Server>).
1443 For enterprise Linux guests, in future we intend this to return
1444 the product variant such as C<Desktop>, C<Server> and so on. But
1445 this is not implemented at present.
1447 If the product variant could not be determined, then the
1448 string C<unknown> is returned.
1450 Please read L<guestfs(3)/INSPECTION> for more details.
1451 See also C<guestfs_inspect_get_product_name>,
1452 C<guestfs_inspect_get_major_version>.");
1456 (* daemon_functions are any functions which cause some action
1457 * to take place in the daemon.
1460 let daemon_functions = [
1461 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1462 [InitEmpty, Always, TestOutput (
1463 [["part_disk"; "/dev/sda"; "mbr"];
1464 ["mkfs"; "ext2"; "/dev/sda1"];
1465 ["mount"; "/dev/sda1"; "/"];
1466 ["write"; "/new"; "new file contents"];
1467 ["cat"; "/new"]], "new file contents")],
1468 "mount a guest disk at a position in the filesystem",
1470 Mount a guest disk at a position in the filesystem. Block devices
1471 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1472 the guest. If those block devices contain partitions, they will have
1473 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1476 The rules are the same as for L<mount(2)>: A filesystem must
1477 first be mounted on C</> before others can be mounted. Other
1478 filesystems can only be mounted on directories which already
1481 The mounted filesystem is writable, if we have sufficient permissions
1482 on the underlying device.
1485 When you use this call, the filesystem options C<sync> and C<noatime>
1486 are set implicitly. This was originally done because we thought it
1487 would improve reliability, but it turns out that I<-o sync> has a
1488 very large negative performance impact and negligible effect on
1489 reliability. Therefore we recommend that you avoid using
1490 C<guestfs_mount> in any code that needs performance, and instead
1491 use C<guestfs_mount_options> (use an empty string for the first
1492 parameter if you don't want any options).");
1494 ("sync", (RErr, [], []), 2, [],
1495 [ InitEmpty, Always, TestRun [["sync"]]],
1496 "sync disks, writes are flushed through to the disk image",
1498 This syncs the disk, so that any writes are flushed through to the
1499 underlying disk image.
1501 You should always call this if you have modified a disk image, before
1502 closing the handle.");
1504 ("touch", (RErr, [Pathname "path"], []), 3, [],
1505 [InitScratchFS, Always, TestOutputTrue (
1506 [["touch"; "/touch"];
1507 ["exists"; "/touch"]])],
1508 "update file timestamps or create a new file",
1510 Touch acts like the L<touch(1)> command. It can be used to
1511 update the timestamps on a file, or, if the file does not exist,
1512 to create a new zero-length file.
1514 This command only works on regular files, and will fail on other
1515 file types such as directories, symbolic links, block special etc.");
1517 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1518 [InitISOFS, Always, TestOutput (
1519 [["cat"; "/known-2"]], "abcdef\n")],
1520 "list the contents of a file",
1522 Return the contents of the file named C<path>.
1524 Note that this function cannot correctly handle binary files
1525 (specifically, files containing C<\\0> character which is treated
1526 as end of string). For those you need to use the C<guestfs_read_file>
1527 or C<guestfs_download> functions which have a more complex interface.");
1529 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1530 [], (* XXX Tricky to test because it depends on the exact format
1531 * of the 'ls -l' command, which changes between F10 and F11.
1533 "list the files in a directory (long format)",
1535 List the files in C<directory> (relative to the root directory,
1536 there is no cwd) in the format of 'ls -la'.
1538 This command is mostly useful for interactive sessions. It
1539 is I<not> intended that you try to parse the output string.");
1541 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1542 [InitScratchFS, Always, TestOutputList (
1544 ["touch"; "/ls/new"];
1545 ["touch"; "/ls/newer"];
1546 ["touch"; "/ls/newest"];
1547 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1548 "list the files in a directory",
1550 List the files in C<directory> (relative to the root directory,
1551 there is no cwd). The '.' and '..' entries are not returned, but
1552 hidden files are shown.
1554 This command is mostly useful for interactive sessions. Programs
1555 should probably use C<guestfs_readdir> instead.");
1557 ("list_devices", (RStringList "devices", [], []), 7, [],
1558 [InitEmpty, Always, TestOutputListOfDevices (
1559 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1560 "list the block devices",
1562 List all the block devices.
1564 The full block device names are returned, eg. C</dev/sda>.
1566 See also C<guestfs_list_filesystems>.");
1568 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1569 [InitBasicFS, Always, TestOutputListOfDevices (
1570 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1571 InitEmpty, Always, TestOutputListOfDevices (
1572 [["part_init"; "/dev/sda"; "mbr"];
1573 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1574 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1575 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1576 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1577 "list the partitions",
1579 List all the partitions detected on all block devices.
1581 The full partition device names are returned, eg. C</dev/sda1>
1583 This does not return logical volumes. For that you will need to
1584 call C<guestfs_lvs>.
1586 See also C<guestfs_list_filesystems>.");
1588 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1589 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1590 [["pvs"]], ["/dev/sda1"]);
1591 InitEmpty, Always, TestOutputListOfDevices (
1592 [["part_init"; "/dev/sda"; "mbr"];
1593 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1594 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1595 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1596 ["pvcreate"; "/dev/sda1"];
1597 ["pvcreate"; "/dev/sda2"];
1598 ["pvcreate"; "/dev/sda3"];
1599 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1600 "list the LVM physical volumes (PVs)",
1602 List all the physical volumes detected. This is the equivalent
1603 of the L<pvs(8)> command.
1605 This returns a list of just the device names that contain
1606 PVs (eg. C</dev/sda2>).
1608 See also C<guestfs_pvs_full>.");
1610 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1611 [InitBasicFSonLVM, Always, TestOutputList (
1613 InitEmpty, Always, TestOutputList (
1614 [["part_init"; "/dev/sda"; "mbr"];
1615 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1616 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1617 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1618 ["pvcreate"; "/dev/sda1"];
1619 ["pvcreate"; "/dev/sda2"];
1620 ["pvcreate"; "/dev/sda3"];
1621 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1622 ["vgcreate"; "VG2"; "/dev/sda3"];
1623 ["vgs"]], ["VG1"; "VG2"])],
1624 "list the LVM volume groups (VGs)",
1626 List all the volumes groups detected. This is the equivalent
1627 of the L<vgs(8)> command.
1629 This returns a list of just the volume group names that were
1630 detected (eg. C<VolGroup00>).
1632 See also C<guestfs_vgs_full>.");
1634 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1635 [InitBasicFSonLVM, Always, TestOutputList (
1636 [["lvs"]], ["/dev/VG/LV"]);
1637 InitEmpty, Always, TestOutputList (
1638 [["part_init"; "/dev/sda"; "mbr"];
1639 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1640 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1641 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1642 ["pvcreate"; "/dev/sda1"];
1643 ["pvcreate"; "/dev/sda2"];
1644 ["pvcreate"; "/dev/sda3"];
1645 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1646 ["vgcreate"; "VG2"; "/dev/sda3"];
1647 ["lvcreate"; "LV1"; "VG1"; "50"];
1648 ["lvcreate"; "LV2"; "VG1"; "50"];
1649 ["lvcreate"; "LV3"; "VG2"; "50"];
1650 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1651 "list the LVM logical volumes (LVs)",
1653 List all the logical volumes detected. This is the equivalent
1654 of the L<lvs(8)> command.
1656 This returns a list of the logical volume device names
1657 (eg. C</dev/VolGroup00/LogVol00>).
1659 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1661 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1662 [], (* XXX how to test? *)
1663 "list the LVM physical volumes (PVs)",
1665 List all the physical volumes detected. This is the equivalent
1666 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1668 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1669 [], (* XXX how to test? *)
1670 "list the LVM volume groups (VGs)",
1672 List all the volumes groups detected. This is the equivalent
1673 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1675 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1676 [], (* XXX how to test? *)
1677 "list the LVM logical volumes (LVs)",
1679 List all the logical volumes detected. This is the equivalent
1680 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1682 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1683 [InitISOFS, Always, TestOutputList (
1684 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1685 InitISOFS, Always, TestOutputList (
1686 [["read_lines"; "/empty"]], [])],
1687 "read file as lines",
1689 Return the contents of the file named C<path>.
1691 The file contents are returned as a list of lines. Trailing
1692 C<LF> and C<CRLF> character sequences are I<not> returned.
1694 Note that this function cannot correctly handle binary files
1695 (specifically, files containing C<\\0> character which is treated
1696 as end of line). For those you need to use the C<guestfs_read_file>
1697 function which has a more complex interface.");
1699 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1700 [], (* XXX Augeas code needs tests. *)
1701 "create a new Augeas handle",
1703 Create a new Augeas handle for editing configuration files.
1704 If there was any previous Augeas handle associated with this
1705 guestfs session, then it is closed.
1707 You must call this before using any other C<guestfs_aug_*>
1710 C<root> is the filesystem root. C<root> must not be NULL,
1713 The flags are the same as the flags defined in
1714 E<lt>augeas.hE<gt>, the logical I<or> of the following
1719 =item C<AUG_SAVE_BACKUP> = 1
1721 Keep the original file with a C<.augsave> extension.
1723 =item C<AUG_SAVE_NEWFILE> = 2
1725 Save changes into a file with extension C<.augnew>, and
1726 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1728 =item C<AUG_TYPE_CHECK> = 4
1730 Typecheck lenses (can be expensive).
1732 =item C<AUG_NO_STDINC> = 8
1734 Do not use standard load path for modules.
1736 =item C<AUG_SAVE_NOOP> = 16
1738 Make save a no-op, just record what would have been changed.
1740 =item C<AUG_NO_LOAD> = 32
1742 Do not load the tree in C<guestfs_aug_init>.
1746 To close the handle, you can call C<guestfs_aug_close>.
1748 To find out more about Augeas, see L<http://augeas.net/>.");
1750 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1751 [], (* XXX Augeas code needs tests. *)
1752 "close the current Augeas handle",
1754 Close the current Augeas handle and free up any resources
1755 used by it. After calling this, you have to call
1756 C<guestfs_aug_init> again before you can use any other
1757 Augeas functions.");
1759 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1760 [], (* XXX Augeas code needs tests. *)
1761 "define an Augeas variable",
1763 Defines an Augeas variable C<name> whose value is the result
1764 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1767 On success this returns the number of nodes in C<expr>, or
1768 C<0> if C<expr> evaluates to something which is not a nodeset.");
1770 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1771 [], (* XXX Augeas code needs tests. *)
1772 "define an Augeas node",
1774 Defines a variable C<name> whose value is the result of
1777 If C<expr> evaluates to an empty nodeset, a node is created,
1778 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1779 C<name> will be the nodeset containing that single node.
1781 On success this returns a pair containing the
1782 number of nodes in the nodeset, and a boolean flag
1783 if a node was created.");
1785 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1786 [], (* XXX Augeas code needs tests. *)
1787 "look up the value of an Augeas path",
1789 Look up the value associated with C<path>. If C<path>
1790 matches exactly one node, the C<value> is returned.");
1792 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1793 [], (* XXX Augeas code needs tests. *)
1794 "set Augeas path to value",
1796 Set the value associated with C<path> to C<val>.
1798 In the Augeas API, it is possible to clear a node by setting
1799 the value to NULL. Due to an oversight in the libguestfs API
1800 you cannot do that with this call. Instead you must use the
1801 C<guestfs_aug_clear> call.");
1803 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1804 [], (* XXX Augeas code needs tests. *)
1805 "insert a sibling Augeas node",
1807 Create a new sibling C<label> for C<path>, inserting it into
1808 the tree before or after C<path> (depending on the boolean
1811 C<path> must match exactly one existing node in the tree, and
1812 C<label> must be a label, ie. not contain C</>, C<*> or end
1813 with a bracketed index C<[N]>.");
1815 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1816 [], (* XXX Augeas code needs tests. *)
1817 "remove an Augeas path",
1819 Remove C<path> and all of its children.
1821 On success this returns the number of entries which were removed.");
1823 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1824 [], (* XXX Augeas code needs tests. *)
1827 Move the node C<src> to C<dest>. C<src> must match exactly
1828 one node. C<dest> is overwritten if it exists.");
1830 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1831 [], (* XXX Augeas code needs tests. *)
1832 "return Augeas nodes which match augpath",
1834 Returns a list of paths which match the path expression C<path>.
1835 The returned paths are sufficiently qualified so that they match
1836 exactly one node in the current tree.");
1838 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1839 [], (* XXX Augeas code needs tests. *)
1840 "write all pending Augeas changes to disk",
1842 This writes all pending changes to disk.
1844 The flags which were passed to C<guestfs_aug_init> affect exactly
1845 how files are saved.");
1847 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1848 [], (* XXX Augeas code needs tests. *)
1849 "load files into the tree",
1851 Load files into the tree.
1853 See C<aug_load> in the Augeas documentation for the full gory
1856 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1857 [], (* XXX Augeas code needs tests. *)
1858 "list Augeas nodes under augpath",
1860 This is just a shortcut for listing C<guestfs_aug_match>
1861 C<path/*> and sorting the resulting nodes into alphabetical order.");
1863 ("rm", (RErr, [Pathname "path"], []), 29, [],
1864 [InitScratchFS, Always, TestRun
1866 ["touch"; "/rm/new"];
1868 InitScratchFS, Always, TestLastFail
1869 [["rm"; "/nosuchfile"]];
1870 InitScratchFS, Always, TestLastFail
1875 Remove the single file C<path>.");
1877 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1878 [InitScratchFS, Always, TestRun
1879 [["mkdir"; "/rmdir"];
1880 ["rmdir"; "/rmdir"]];
1881 InitScratchFS, Always, TestLastFail
1882 [["rmdir"; "/rmdir2"]];
1883 InitScratchFS, Always, TestLastFail
1884 [["mkdir"; "/rmdir3"];
1885 ["touch"; "/rmdir3/new"];
1886 ["rmdir"; "/rmdir3/new"]]],
1887 "remove a directory",
1889 Remove the single directory C<path>.");
1891 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1892 [InitScratchFS, Always, TestOutputFalse
1893 [["mkdir"; "/rm_rf"];
1894 ["mkdir"; "/rm_rf/foo"];
1895 ["touch"; "/rm_rf/foo/bar"];
1896 ["rm_rf"; "/rm_rf"];
1897 ["exists"; "/rm_rf"]]],
1898 "remove a file or directory recursively",
1900 Remove the file or directory C<path>, recursively removing the
1901 contents if its a directory. This is like the C<rm -rf> shell
1904 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1905 [InitScratchFS, Always, TestOutputTrue
1906 [["mkdir"; "/mkdir"];
1907 ["is_dir"; "/mkdir"]];
1908 InitScratchFS, Always, TestLastFail
1909 [["mkdir"; "/mkdir2/foo/bar"]]],
1910 "create a directory",
1912 Create a directory named C<path>.");
1914 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1915 [InitScratchFS, Always, TestOutputTrue
1916 [["mkdir_p"; "/mkdir_p/foo/bar"];
1917 ["is_dir"; "/mkdir_p/foo/bar"]];
1918 InitScratchFS, Always, TestOutputTrue
1919 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1920 ["is_dir"; "/mkdir_p2/foo"]];
1921 InitScratchFS, Always, TestOutputTrue
1922 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1923 ["is_dir"; "/mkdir_p3"]];
1924 (* Regression tests for RHBZ#503133: *)
1925 InitScratchFS, Always, TestRun
1926 [["mkdir"; "/mkdir_p4"];
1927 ["mkdir_p"; "/mkdir_p4"]];
1928 InitScratchFS, Always, TestLastFail
1929 [["touch"; "/mkdir_p5"];
1930 ["mkdir_p"; "/mkdir_p5"]]],
1931 "create a directory and parents",
1933 Create a directory named C<path>, creating any parent directories
1934 as necessary. This is like the C<mkdir -p> shell command.");
1936 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1937 [], (* XXX Need stat command to test *)
1940 Change the mode (permissions) of C<path> to C<mode>. Only
1941 numeric modes are supported.
1943 I<Note>: When using this command from guestfish, C<mode>
1944 by default would be decimal, unless you prefix it with
1945 C<0> to get octal, ie. use C<0700> not C<700>.
1947 The mode actually set is affected by the umask.");
1949 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1950 [], (* XXX Need stat command to test *)
1951 "change file owner and group",
1953 Change the file owner to C<owner> and group to C<group>.
1955 Only numeric uid and gid are supported. If you want to use
1956 names, you will need to locate and parse the password file
1957 yourself (Augeas support makes this relatively easy).");
1959 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1960 [InitISOFS, Always, TestOutputTrue (
1961 [["exists"; "/empty"]]);
1962 InitISOFS, Always, TestOutputTrue (
1963 [["exists"; "/directory"]])],
1964 "test if file or directory exists",
1966 This returns C<true> if and only if there is a file, directory
1967 (or anything) with the given C<path> name.
1969 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1971 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1972 [InitISOFS, Always, TestOutputTrue (
1973 [["is_file"; "/known-1"]]);
1974 InitISOFS, Always, TestOutputFalse (
1975 [["is_file"; "/directory"]])],
1976 "test if a regular file",
1978 This returns C<true> if and only if there is a regular file
1979 with the given C<path> name. Note that it returns false for
1980 other objects like directories.
1982 See also C<guestfs_stat>.");
1984 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1985 [InitISOFS, Always, TestOutputFalse (
1986 [["is_dir"; "/known-3"]]);
1987 InitISOFS, Always, TestOutputTrue (
1988 [["is_dir"; "/directory"]])],
1989 "test if a directory",
1991 This returns C<true> if and only if there is a directory
1992 with the given C<path> name. Note that it returns false for
1993 other objects like files.
1995 See also C<guestfs_stat>.");
1997 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
1998 [InitEmpty, Always, TestOutputListOfDevices (
1999 [["part_init"; "/dev/sda"; "mbr"];
2000 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2001 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2002 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2003 ["pvcreate"; "/dev/sda1"];
2004 ["pvcreate"; "/dev/sda2"];
2005 ["pvcreate"; "/dev/sda3"];
2006 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2007 "create an LVM physical volume",
2009 This creates an LVM physical volume on the named C<device>,
2010 where C<device> should usually be a partition name such
2013 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2014 [InitEmpty, Always, TestOutputList (
2015 [["part_init"; "/dev/sda"; "mbr"];
2016 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2017 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2018 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2019 ["pvcreate"; "/dev/sda1"];
2020 ["pvcreate"; "/dev/sda2"];
2021 ["pvcreate"; "/dev/sda3"];
2022 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2023 ["vgcreate"; "VG2"; "/dev/sda3"];
2024 ["vgs"]], ["VG1"; "VG2"])],
2025 "create an LVM volume group",
2027 This creates an LVM volume group called C<volgroup>
2028 from the non-empty list of physical volumes C<physvols>.");
2030 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2031 [InitEmpty, Always, TestOutputList (
2032 [["part_init"; "/dev/sda"; "mbr"];
2033 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2034 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2035 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2036 ["pvcreate"; "/dev/sda1"];
2037 ["pvcreate"; "/dev/sda2"];
2038 ["pvcreate"; "/dev/sda3"];
2039 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2040 ["vgcreate"; "VG2"; "/dev/sda3"];
2041 ["lvcreate"; "LV1"; "VG1"; "50"];
2042 ["lvcreate"; "LV2"; "VG1"; "50"];
2043 ["lvcreate"; "LV3"; "VG2"; "50"];
2044 ["lvcreate"; "LV4"; "VG2"; "50"];
2045 ["lvcreate"; "LV5"; "VG2"; "50"];
2047 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2048 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2049 "create an LVM logical volume",
2051 This creates an LVM logical volume called C<logvol>
2052 on the volume group C<volgroup>, with C<size> megabytes.");
2054 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2055 [InitEmpty, Always, TestOutput (
2056 [["part_disk"; "/dev/sda"; "mbr"];
2057 ["mkfs"; "ext2"; "/dev/sda1"];
2058 ["mount_options"; ""; "/dev/sda1"; "/"];
2059 ["write"; "/new"; "new file contents"];
2060 ["cat"; "/new"]], "new file contents")],
2061 "make a filesystem",
2063 This creates a filesystem on C<device> (usually a partition
2064 or LVM logical volume). The filesystem type is C<fstype>, for
2067 ("sfdisk", (RErr, [Device "device";
2068 Int "cyls"; Int "heads"; Int "sectors";
2069 StringList "lines"], []), 43, [DangerWillRobinson],
2071 "create partitions on a block device",
2073 This is a direct interface to the L<sfdisk(8)> program for creating
2074 partitions on block devices.
2076 C<device> should be a block device, for example C</dev/sda>.
2078 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2079 and sectors on the device, which are passed directly to sfdisk as
2080 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2081 of these, then the corresponding parameter is omitted. Usually for
2082 'large' disks, you can just pass C<0> for these, but for small
2083 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2084 out the right geometry and you will need to tell it.
2086 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2087 information refer to the L<sfdisk(8)> manpage.
2089 To create a single partition occupying the whole disk, you would
2090 pass C<lines> as a single element list, when the single element being
2091 the string C<,> (comma).
2093 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2094 C<guestfs_part_init>");
2096 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2097 (* Regression test for RHBZ#597135. *)
2098 [InitScratchFS, Always, TestLastFail
2099 [["write_file"; "/write_file"; "abc"; "10000"]]],
2102 This call creates a file called C<path>. The contents of the
2103 file is the string C<content> (which can contain any 8 bit data),
2104 with length C<size>.
2106 As a special case, if C<size> is C<0>
2107 then the length is calculated using C<strlen> (so in this case
2108 the content cannot contain embedded ASCII NULs).
2110 I<NB.> Owing to a bug, writing content containing ASCII NUL
2111 characters does I<not> work, even if the length is specified.");
2113 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2114 [InitEmpty, Always, TestOutputListOfDevices (
2115 [["part_disk"; "/dev/sda"; "mbr"];
2116 ["mkfs"; "ext2"; "/dev/sda1"];
2117 ["mount_options"; ""; "/dev/sda1"; "/"];
2118 ["mounts"]], ["/dev/sda1"]);
2119 InitEmpty, Always, TestOutputList (
2120 [["part_disk"; "/dev/sda"; "mbr"];
2121 ["mkfs"; "ext2"; "/dev/sda1"];
2122 ["mount_options"; ""; "/dev/sda1"; "/"];
2125 "unmount a filesystem",
2127 This unmounts the given filesystem. The filesystem may be
2128 specified either by its mountpoint (path) or the device which
2129 contains the filesystem.");
2131 ("mounts", (RStringList "devices", [], []), 46, [],
2132 [InitScratchFS, Always, TestOutputListOfDevices (
2133 [["mounts"]], ["/dev/sdb1"])],
2134 "show mounted filesystems",
2136 This returns the list of currently mounted filesystems. It returns
2137 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2139 Some internal mounts are not shown.
2141 See also: C<guestfs_mountpoints>");
2143 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2144 [InitScratchFS, Always, TestOutputList (
2147 (* check that umount_all can unmount nested mounts correctly: *)
2148 InitEmpty, Always, TestOutputList (
2149 [["part_init"; "/dev/sda"; "mbr"];
2150 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2151 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2152 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2153 ["mkfs"; "ext2"; "/dev/sda1"];
2154 ["mkfs"; "ext2"; "/dev/sda2"];
2155 ["mkfs"; "ext2"; "/dev/sda3"];
2156 ["mount_options"; ""; "/dev/sda1"; "/"];
2158 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2159 ["mkdir"; "/mp1/mp2"];
2160 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2161 ["mkdir"; "/mp1/mp2/mp3"];
2164 "unmount all filesystems",
2166 This unmounts all mounted filesystems.
2168 Some internal mounts are not unmounted by this call.");
2170 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2172 "remove all LVM LVs, VGs and PVs",
2174 This command removes all LVM logical volumes, volume groups
2175 and physical volumes.");
2177 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2178 [InitISOFS, Always, TestOutput (
2179 [["file"; "/empty"]], "empty");
2180 InitISOFS, Always, TestOutput (
2181 [["file"; "/known-1"]], "ASCII text");
2182 InitISOFS, Always, TestLastFail (
2183 [["file"; "/notexists"]]);
2184 InitISOFS, Always, TestOutput (
2185 [["file"; "/abssymlink"]], "symbolic link");
2186 InitISOFS, Always, TestOutput (
2187 [["file"; "/directory"]], "directory")],
2188 "determine file type",
2190 This call uses the standard L<file(1)> command to determine
2191 the type or contents of the file.
2193 This call will also transparently look inside various types
2196 The exact command which runs is C<file -zb path>. Note in
2197 particular that the filename is not prepended to the output
2200 This command can also be used on C</dev/> devices
2201 (and partitions, LV names). You can for example use this
2202 to determine if a device contains a filesystem, although
2203 it's usually better to use C<guestfs_vfs_type>.
2205 If the C<path> does not begin with C</dev/> then
2206 this command only works for the content of regular files.
2207 For other file types (directory, symbolic link etc) it
2208 will just return the string C<directory> etc.");
2210 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2211 [InitScratchFS, Always, TestOutput (
2212 [["mkdir"; "/command"];
2213 ["upload"; "test-command"; "/command/test-command"];
2214 ["chmod"; "0o755"; "/command/test-command"];
2215 ["command"; "/command/test-command 1"]], "Result1");
2216 InitScratchFS, Always, TestOutput (
2217 [["mkdir"; "/command2"];
2218 ["upload"; "test-command"; "/command2/test-command"];
2219 ["chmod"; "0o755"; "/command2/test-command"];
2220 ["command"; "/command2/test-command 2"]], "Result2\n");
2221 InitScratchFS, Always, TestOutput (
2222 [["mkdir"; "/command3"];
2223 ["upload"; "test-command"; "/command3/test-command"];
2224 ["chmod"; "0o755"; "/command3/test-command"];
2225 ["command"; "/command3/test-command 3"]], "\nResult3");
2226 InitScratchFS, Always, TestOutput (
2227 [["mkdir"; "/command4"];
2228 ["upload"; "test-command"; "/command4/test-command"];
2229 ["chmod"; "0o755"; "/command4/test-command"];
2230 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2231 InitScratchFS, Always, TestOutput (
2232 [["mkdir"; "/command5"];
2233 ["upload"; "test-command"; "/command5/test-command"];
2234 ["chmod"; "0o755"; "/command5/test-command"];
2235 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2236 InitScratchFS, Always, TestOutput (
2237 [["mkdir"; "/command6"];
2238 ["upload"; "test-command"; "/command6/test-command"];
2239 ["chmod"; "0o755"; "/command6/test-command"];
2240 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2241 InitScratchFS, Always, TestOutput (
2242 [["mkdir"; "/command7"];
2243 ["upload"; "test-command"; "/command7/test-command"];
2244 ["chmod"; "0o755"; "/command7/test-command"];
2245 ["command"; "/command7/test-command 7"]], "");
2246 InitScratchFS, Always, TestOutput (
2247 [["mkdir"; "/command8"];
2248 ["upload"; "test-command"; "/command8/test-command"];
2249 ["chmod"; "0o755"; "/command8/test-command"];
2250 ["command"; "/command8/test-command 8"]], "\n");
2251 InitScratchFS, Always, TestOutput (
2252 [["mkdir"; "/command9"];
2253 ["upload"; "test-command"; "/command9/test-command"];
2254 ["chmod"; "0o755"; "/command9/test-command"];
2255 ["command"; "/command9/test-command 9"]], "\n\n");
2256 InitScratchFS, Always, TestOutput (
2257 [["mkdir"; "/command10"];
2258 ["upload"; "test-command"; "/command10/test-command"];
2259 ["chmod"; "0o755"; "/command10/test-command"];
2260 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2261 InitScratchFS, Always, TestOutput (
2262 [["mkdir"; "/command11"];
2263 ["upload"; "test-command"; "/command11/test-command"];
2264 ["chmod"; "0o755"; "/command11/test-command"];
2265 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2266 InitScratchFS, Always, TestLastFail (
2267 [["mkdir"; "/command12"];
2268 ["upload"; "test-command"; "/command12/test-command"];
2269 ["chmod"; "0o755"; "/command12/test-command"];
2270 ["command"; "/command12/test-command"]])],
2271 "run a command from the guest filesystem",
2273 This call runs a command from the guest filesystem. The
2274 filesystem must be mounted, and must contain a compatible
2275 operating system (ie. something Linux, with the same
2276 or compatible processor architecture).
2278 The single parameter is an argv-style list of arguments.
2279 The first element is the name of the program to run.
2280 Subsequent elements are parameters. The list must be
2281 non-empty (ie. must contain a program name). Note that
2282 the command runs directly, and is I<not> invoked via
2283 the shell (see C<guestfs_sh>).
2285 The return value is anything printed to I<stdout> by
2288 If the command returns a non-zero exit status, then
2289 this function returns an error message. The error message
2290 string is the content of I<stderr> from the command.
2292 The C<$PATH> environment variable will contain at least
2293 C</usr/bin> and C</bin>. If you require a program from
2294 another location, you should provide the full path in the
2297 Shared libraries and data files required by the program
2298 must be available on filesystems which are mounted in the
2299 correct places. It is the caller's responsibility to ensure
2300 all filesystems that are needed are mounted at the right
2303 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2304 [InitScratchFS, Always, TestOutputList (
2305 [["mkdir"; "/command_lines"];
2306 ["upload"; "test-command"; "/command_lines/test-command"];
2307 ["chmod"; "0o755"; "/command_lines/test-command"];
2308 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2309 InitScratchFS, Always, TestOutputList (
2310 [["mkdir"; "/command_lines2"];
2311 ["upload"; "test-command"; "/command_lines2/test-command"];
2312 ["chmod"; "0o755"; "/command_lines2/test-command"];
2313 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2314 InitScratchFS, Always, TestOutputList (
2315 [["mkdir"; "/command_lines3"];
2316 ["upload"; "test-command"; "/command_lines3/test-command"];
2317 ["chmod"; "0o755"; "/command_lines3/test-command"];
2318 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2319 InitScratchFS, Always, TestOutputList (
2320 [["mkdir"; "/command_lines4"];
2321 ["upload"; "test-command"; "/command_lines4/test-command"];
2322 ["chmod"; "0o755"; "/command_lines4/test-command"];
2323 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2324 InitScratchFS, Always, TestOutputList (
2325 [["mkdir"; "/command_lines5"];
2326 ["upload"; "test-command"; "/command_lines5/test-command"];
2327 ["chmod"; "0o755"; "/command_lines5/test-command"];
2328 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2329 InitScratchFS, Always, TestOutputList (
2330 [["mkdir"; "/command_lines6"];
2331 ["upload"; "test-command"; "/command_lines6/test-command"];
2332 ["chmod"; "0o755"; "/command_lines6/test-command"];
2333 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2334 InitScratchFS, Always, TestOutputList (
2335 [["mkdir"; "/command_lines7"];
2336 ["upload"; "test-command"; "/command_lines7/test-command"];
2337 ["chmod"; "0o755"; "/command_lines7/test-command"];
2338 ["command_lines"; "/command_lines7/test-command 7"]], []);
2339 InitScratchFS, Always, TestOutputList (
2340 [["mkdir"; "/command_lines8"];
2341 ["upload"; "test-command"; "/command_lines8/test-command"];
2342 ["chmod"; "0o755"; "/command_lines8/test-command"];
2343 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2344 InitScratchFS, Always, TestOutputList (
2345 [["mkdir"; "/command_lines9"];
2346 ["upload"; "test-command"; "/command_lines9/test-command"];
2347 ["chmod"; "0o755"; "/command_lines9/test-command"];
2348 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2349 InitScratchFS, Always, TestOutputList (
2350 [["mkdir"; "/command_lines10"];
2351 ["upload"; "test-command"; "/command_lines10/test-command"];
2352 ["chmod"; "0o755"; "/command_lines10/test-command"];
2353 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2354 InitScratchFS, Always, TestOutputList (
2355 [["mkdir"; "/command_lines11"];
2356 ["upload"; "test-command"; "/command_lines11/test-command"];
2357 ["chmod"; "0o755"; "/command_lines11/test-command"];
2358 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2359 "run a command, returning lines",
2361 This is the same as C<guestfs_command>, but splits the
2362 result into a list of lines.
2364 See also: C<guestfs_sh_lines>");
2366 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2367 [InitISOFS, Always, TestOutputStruct (
2368 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2369 "get file information",
2371 Returns file information for the given C<path>.
2373 This is the same as the C<stat(2)> system call.");
2375 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2376 [InitISOFS, Always, TestOutputStruct (
2377 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2378 "get file information for a symbolic link",
2380 Returns file information for the given C<path>.
2382 This is the same as C<guestfs_stat> except that if C<path>
2383 is a symbolic link, then the link is stat-ed, not the file it
2386 This is the same as the C<lstat(2)> system call.");
2388 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2389 [InitISOFS, Always, TestOutputStruct (
2390 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2391 "get file system statistics",
2393 Returns file system statistics for any mounted file system.
2394 C<path> should be a file or directory in the mounted file system
2395 (typically it is the mount point itself, but it doesn't need to be).
2397 This is the same as the C<statvfs(2)> system call.");
2399 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2401 "get ext2/ext3/ext4 superblock details",
2403 This returns the contents of the ext2, ext3 or ext4 filesystem
2404 superblock on C<device>.
2406 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2407 manpage for more details. The list of fields returned isn't
2408 clearly defined, and depends on both the version of C<tune2fs>
2409 that libguestfs was built against, and the filesystem itself.");
2411 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2412 [InitEmpty, Always, TestOutputTrue (
2413 [["blockdev_setro"; "/dev/sda"];
2414 ["blockdev_getro"; "/dev/sda"]])],
2415 "set block device to read-only",
2417 Sets the block device named C<device> to read-only.
2419 This uses the L<blockdev(8)> command.");
2421 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2422 [InitEmpty, Always, TestOutputFalse (
2423 [["blockdev_setrw"; "/dev/sda"];
2424 ["blockdev_getro"; "/dev/sda"]])],
2425 "set block device to read-write",
2427 Sets the block device named C<device> to read-write.
2429 This uses the L<blockdev(8)> command.");
2431 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2432 [InitEmpty, Always, TestOutputTrue (
2433 [["blockdev_setro"; "/dev/sda"];
2434 ["blockdev_getro"; "/dev/sda"]])],
2435 "is block device set to read-only",
2437 Returns a boolean indicating if the block device is read-only
2438 (true if read-only, false if not).
2440 This uses the L<blockdev(8)> command.");
2442 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2443 [InitEmpty, Always, TestOutputInt (
2444 [["blockdev_getss"; "/dev/sda"]], 512)],
2445 "get sectorsize of block device",
2447 This returns the size of sectors on a block device.
2448 Usually 512, but can be larger for modern devices.
2450 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2453 This uses the L<blockdev(8)> command.");
2455 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2456 [InitEmpty, Always, TestOutputInt (
2457 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2458 "get blocksize of block device",
2460 This returns the block size of a device.
2462 (Note this is different from both I<size in blocks> and
2463 I<filesystem block size>).
2465 This uses the L<blockdev(8)> command.");
2467 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2469 "set blocksize of block device",
2471 This sets the block size of a device.
2473 (Note this is different from both I<size in blocks> and
2474 I<filesystem block size>).
2476 This uses the L<blockdev(8)> command.");
2478 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2479 [InitEmpty, Always, TestOutputInt (
2480 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2481 "get total size of device in 512-byte sectors",
2483 This returns the size of the device in units of 512-byte sectors
2484 (even if the sectorsize isn't 512 bytes ... weird).
2486 See also C<guestfs_blockdev_getss> for the real sector size of
2487 the device, and C<guestfs_blockdev_getsize64> for the more
2488 useful I<size in bytes>.
2490 This uses the L<blockdev(8)> command.");
2492 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2493 [InitEmpty, Always, TestOutputInt (
2494 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2495 "get total size of device in bytes",
2497 This returns the size of the device in bytes.
2499 See also C<guestfs_blockdev_getsz>.
2501 This uses the L<blockdev(8)> command.");
2503 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2504 [InitEmpty, Always, TestRun
2505 [["blockdev_flushbufs"; "/dev/sda"]]],
2506 "flush device buffers",
2508 This tells the kernel to flush internal buffers associated
2511 This uses the L<blockdev(8)> command.");
2513 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2514 [InitEmpty, Always, TestRun
2515 [["blockdev_rereadpt"; "/dev/sda"]]],
2516 "reread partition table",
2518 Reread the partition table on C<device>.
2520 This uses the L<blockdev(8)> command.");
2522 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2523 [InitScratchFS, Always, TestOutput (
2524 (* Pick a file from cwd which isn't likely to change. *)
2525 [["mkdir"; "/upload"];
2526 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2527 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2528 Digest.to_hex (Digest.file "COPYING.LIB"))],
2529 "upload a file from the local machine",
2531 Upload local file C<filename> to C<remotefilename> on the
2534 C<filename> can also be a named pipe.
2536 See also C<guestfs_download>.");
2538 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2539 [InitScratchFS, Always, TestOutput (
2540 (* Pick a file from cwd which isn't likely to change. *)
2541 [["mkdir"; "/download"];
2542 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2543 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2544 ["upload"; "testdownload.tmp"; "/download/upload"];
2545 ["checksum"; "md5"; "/download/upload"]],
2546 Digest.to_hex (Digest.file "COPYING.LIB"))],
2547 "download a file to the local machine",
2549 Download file C<remotefilename> and save it as C<filename>
2550 on the local machine.
2552 C<filename> can also be a named pipe.
2554 See also C<guestfs_upload>, C<guestfs_cat>.");
2556 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2557 [InitISOFS, Always, TestOutput (
2558 [["checksum"; "crc"; "/known-3"]], "2891671662");
2559 InitISOFS, Always, TestLastFail (
2560 [["checksum"; "crc"; "/notexists"]]);
2561 InitISOFS, Always, TestOutput (
2562 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2563 InitISOFS, Always, TestOutput (
2564 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2565 InitISOFS, Always, TestOutput (
2566 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2567 InitISOFS, Always, TestOutput (
2568 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2569 InitISOFS, Always, TestOutput (
2570 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2571 InitISOFS, Always, TestOutput (
2572 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2573 (* Test for RHBZ#579608, absolute symbolic links. *)
2574 InitISOFS, Always, TestOutput (
2575 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2576 "compute MD5, SHAx or CRC checksum of file",
2578 This call computes the MD5, SHAx or CRC checksum of the
2581 The type of checksum to compute is given by the C<csumtype>
2582 parameter which must have one of the following values:
2588 Compute the cyclic redundancy check (CRC) specified by POSIX
2589 for the C<cksum> command.
2593 Compute the MD5 hash (using the C<md5sum> program).
2597 Compute the SHA1 hash (using the C<sha1sum> program).
2601 Compute the SHA224 hash (using the C<sha224sum> program).
2605 Compute the SHA256 hash (using the C<sha256sum> program).
2609 Compute the SHA384 hash (using the C<sha384sum> program).
2613 Compute the SHA512 hash (using the C<sha512sum> program).
2617 The checksum is returned as a printable string.
2619 To get the checksum for a device, use C<guestfs_checksum_device>.
2621 To get the checksums for many files, use C<guestfs_checksums_out>.");
2623 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2624 [InitScratchFS, Always, TestOutput (
2625 [["mkdir"; "/tar_in"];
2626 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2627 ["cat"; "/tar_in/hello"]], "hello\n")],
2628 "unpack tarfile to directory",
2630 This command uploads and unpacks local file C<tarfile> (an
2631 I<uncompressed> tar file) into C<directory>.
2633 To upload a compressed tarball, use C<guestfs_tgz_in>
2634 or C<guestfs_txz_in>.");
2636 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2638 "pack directory into tarfile",
2640 This command packs the contents of C<directory> and downloads
2641 it to local file C<tarfile>.
2643 To download a compressed tarball, use C<guestfs_tgz_out>
2644 or C<guestfs_txz_out>.");
2646 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2647 [InitScratchFS, Always, TestOutput (
2648 [["mkdir"; "/tgz_in"];
2649 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2650 ["cat"; "/tgz_in/hello"]], "hello\n")],
2651 "unpack compressed tarball to directory",
2653 This command uploads and unpacks local file C<tarball> (a
2654 I<gzip compressed> tar file) into C<directory>.
2656 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2658 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2660 "pack directory into compressed tarball",
2662 This command packs the contents of C<directory> and downloads
2663 it to local file C<tarball>.
2665 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2667 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2668 [InitBasicFS, Always, TestLastFail (
2670 ["mount_ro"; "/dev/sda1"; "/"];
2671 ["touch"; "/new"]]);
2672 InitBasicFS, Always, TestOutput (
2673 [["write"; "/new"; "data"];
2675 ["mount_ro"; "/dev/sda1"; "/"];
2676 ["cat"; "/new"]], "data")],
2677 "mount a guest disk, read-only",
2679 This is the same as the C<guestfs_mount> command, but it
2680 mounts the filesystem with the read-only (I<-o ro>) flag.");
2682 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2684 "mount a guest disk with mount options",
2686 This is the same as the C<guestfs_mount> command, but it
2687 allows you to set the mount options as for the
2688 L<mount(8)> I<-o> flag.
2690 If the C<options> parameter is an empty string, then
2691 no options are passed (all options default to whatever
2692 the filesystem uses).");
2694 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2696 "mount a guest disk with mount options and vfstype",
2698 This is the same as the C<guestfs_mount> command, but it
2699 allows you to set both the mount options and the vfstype
2700 as for the L<mount(8)> I<-o> and I<-t> flags.");
2702 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2704 "debugging and internals",
2706 The C<guestfs_debug> command exposes some internals of
2707 C<guestfsd> (the guestfs daemon) that runs inside the
2710 There is no comprehensive help for this command. You have
2711 to look at the file C<daemon/debug.c> in the libguestfs source
2712 to find out what you can do.");
2714 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2715 [InitEmpty, Always, TestOutputList (
2716 [["part_disk"; "/dev/sda"; "mbr"];
2717 ["pvcreate"; "/dev/sda1"];
2718 ["vgcreate"; "VG"; "/dev/sda1"];
2719 ["lvcreate"; "LV1"; "VG"; "50"];
2720 ["lvcreate"; "LV2"; "VG"; "50"];
2721 ["lvremove"; "/dev/VG/LV1"];
2722 ["lvs"]], ["/dev/VG/LV2"]);
2723 InitEmpty, Always, TestOutputList (
2724 [["part_disk"; "/dev/sda"; "mbr"];
2725 ["pvcreate"; "/dev/sda1"];
2726 ["vgcreate"; "VG"; "/dev/sda1"];
2727 ["lvcreate"; "LV1"; "VG"; "50"];
2728 ["lvcreate"; "LV2"; "VG"; "50"];
2729 ["lvremove"; "/dev/VG"];
2731 InitEmpty, Always, TestOutputList (
2732 [["part_disk"; "/dev/sda"; "mbr"];
2733 ["pvcreate"; "/dev/sda1"];
2734 ["vgcreate"; "VG"; "/dev/sda1"];
2735 ["lvcreate"; "LV1"; "VG"; "50"];
2736 ["lvcreate"; "LV2"; "VG"; "50"];
2737 ["lvremove"; "/dev/VG"];
2739 "remove an LVM logical volume",
2741 Remove an LVM logical volume C<device>, where C<device> is
2742 the path to the LV, such as C</dev/VG/LV>.
2744 You can also remove all LVs in a volume group by specifying
2745 the VG name, C</dev/VG>.");
2747 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2748 [InitEmpty, Always, TestOutputList (
2749 [["part_disk"; "/dev/sda"; "mbr"];
2750 ["pvcreate"; "/dev/sda1"];
2751 ["vgcreate"; "VG"; "/dev/sda1"];
2752 ["lvcreate"; "LV1"; "VG"; "50"];
2753 ["lvcreate"; "LV2"; "VG"; "50"];
2756 InitEmpty, Always, TestOutputList (
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"];
2764 "remove an LVM volume group",
2766 Remove an LVM volume group C<vgname>, (for example C<VG>).
2768 This also forcibly removes all logical volumes in the volume
2771 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2772 [InitEmpty, Always, TestOutputListOfDevices (
2773 [["part_disk"; "/dev/sda"; "mbr"];
2774 ["pvcreate"; "/dev/sda1"];
2775 ["vgcreate"; "VG"; "/dev/sda1"];
2776 ["lvcreate"; "LV1"; "VG"; "50"];
2777 ["lvcreate"; "LV2"; "VG"; "50"];
2779 ["pvremove"; "/dev/sda1"];
2781 InitEmpty, Always, TestOutputListOfDevices (
2782 [["part_disk"; "/dev/sda"; "mbr"];
2783 ["pvcreate"; "/dev/sda1"];
2784 ["vgcreate"; "VG"; "/dev/sda1"];
2785 ["lvcreate"; "LV1"; "VG"; "50"];
2786 ["lvcreate"; "LV2"; "VG"; "50"];
2788 ["pvremove"; "/dev/sda1"];
2790 InitEmpty, Always, TestOutputListOfDevices (
2791 [["part_disk"; "/dev/sda"; "mbr"];
2792 ["pvcreate"; "/dev/sda1"];
2793 ["vgcreate"; "VG"; "/dev/sda1"];
2794 ["lvcreate"; "LV1"; "VG"; "50"];
2795 ["lvcreate"; "LV2"; "VG"; "50"];
2797 ["pvremove"; "/dev/sda1"];
2799 "remove an LVM physical volume",
2801 This wipes a physical volume C<device> so that LVM will no longer
2804 The implementation uses the C<pvremove> command which refuses to
2805 wipe physical volumes that contain any volume groups, so you have
2806 to remove those first.");
2808 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2809 [InitBasicFS, Always, TestOutput (
2810 [["set_e2label"; "/dev/sda1"; "testlabel"];
2811 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2812 "set the ext2/3/4 filesystem label",
2814 This sets the ext2/3/4 filesystem label of the filesystem on
2815 C<device> to C<label>. Filesystem labels are limited to
2818 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2819 to return the existing label on a filesystem.");
2821 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2823 "get the ext2/3/4 filesystem label",
2825 This returns the ext2/3/4 filesystem label of the filesystem on
2828 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2829 (let uuid = uuidgen () in
2830 [InitBasicFS, Always, TestOutput (
2831 [["set_e2uuid"; "/dev/sda1"; uuid];
2832 ["get_e2uuid"; "/dev/sda1"]], uuid);
2833 InitBasicFS, Always, TestOutput (
2834 [["set_e2uuid"; "/dev/sda1"; "clear"];
2835 ["get_e2uuid"; "/dev/sda1"]], "");
2836 (* We can't predict what UUIDs will be, so just check the commands run. *)
2837 InitBasicFS, Always, TestRun (
2838 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2839 InitBasicFS, Always, TestRun (
2840 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2841 "set the ext2/3/4 filesystem UUID",
2843 This sets the ext2/3/4 filesystem UUID of the filesystem on
2844 C<device> to C<uuid>. The format of the UUID and alternatives
2845 such as C<clear>, C<random> and C<time> are described in the
2846 L<tune2fs(8)> manpage.
2848 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2849 to return the existing UUID of a filesystem.");
2851 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2852 (* Regression test for RHBZ#597112. *)
2853 (let uuid = uuidgen () in
2854 [InitNone, Always, TestOutput (
2855 [["mke2journal"; "1024"; "/dev/sdc"];
2856 ["set_e2uuid"; "/dev/sdc"; uuid];
2857 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2858 "get the ext2/3/4 filesystem UUID",
2860 This returns the ext2/3/4 filesystem UUID of the filesystem on
2863 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2864 [InitBasicFS, Always, TestOutputInt (
2865 [["umount"; "/dev/sda1"];
2866 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2867 InitBasicFS, Always, TestOutputInt (
2868 [["umount"; "/dev/sda1"];
2869 ["zero"; "/dev/sda1"];
2870 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2871 "run the filesystem checker",
2873 This runs the filesystem checker (fsck) on C<device> which
2874 should have filesystem type C<fstype>.
2876 The returned integer is the status. See L<fsck(8)> for the
2877 list of status codes from C<fsck>.
2885 Multiple status codes can be summed together.
2889 A non-zero return code can mean \"success\", for example if
2890 errors have been corrected on the filesystem.
2894 Checking or repairing NTFS volumes is not supported
2899 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2901 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2902 [InitBasicFS, Always, TestOutput (
2903 [["umount"; "/dev/sda1"];
2904 ["zero"; "/dev/sda1"];
2905 ["file"; "/dev/sda1"]], "data")],
2906 "write zeroes to the device",
2908 This command writes zeroes over the first few blocks of C<device>.
2910 How many blocks are zeroed isn't specified (but it's I<not> enough
2911 to securely wipe the device). It should be sufficient to remove
2912 any partition tables, filesystem superblocks and so on.
2914 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2916 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2918 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2919 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2921 [InitBasicFS, Always, TestOutputTrue (
2922 [["mkdir_p"; "/boot/grub"];
2923 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2924 ["grub_install"; "/"; "/dev/vda"];
2925 ["is_dir"; "/boot"]])],
2928 This command installs GRUB (the Grand Unified Bootloader) on
2929 C<device>, with the root directory being C<root>.
2931 Note: If grub-install reports the error
2932 \"No suitable drive was found in the generated device map.\"
2933 it may be that you need to create a C</boot/grub/device.map>
2934 file first that contains the mapping between grub device names
2935 and Linux device names. It is usually sufficient to create
2940 replacing C</dev/vda> with the name of the installation device.");
2942 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2943 [InitScratchFS, Always, TestOutput (
2945 ["write"; "/cp/old"; "file content"];
2946 ["cp"; "/cp/old"; "/cp/new"];
2947 ["cat"; "/cp/new"]], "file content");
2948 InitScratchFS, Always, TestOutputTrue (
2950 ["write"; "/cp2/old"; "file content"];
2951 ["cp"; "/cp2/old"; "/cp2/new"];
2952 ["is_file"; "/cp2/old"]]);
2953 InitScratchFS, Always, TestOutput (
2955 ["write"; "/cp3/old"; "file content"];
2956 ["mkdir"; "/cp3/dir"];
2957 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2958 ["cat"; "/cp3/dir/new"]], "file content")],
2961 This copies a file from C<src> to C<dest> where C<dest> is
2962 either a destination filename or destination directory.");
2964 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2965 [InitScratchFS, Always, TestOutput (
2966 [["mkdir"; "/cp_a1"];
2967 ["mkdir"; "/cp_a2"];
2968 ["write"; "/cp_a1/file"; "file content"];
2969 ["cp_a"; "/cp_a1"; "/cp_a2"];
2970 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2971 "copy a file or directory recursively",
2973 This copies a file or directory from C<src> to C<dest>
2974 recursively using the C<cp -a> command.");
2976 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2977 [InitScratchFS, Always, TestOutput (
2979 ["write"; "/mv/old"; "file content"];
2980 ["mv"; "/mv/old"; "/mv/new"];
2981 ["cat"; "/mv/new"]], "file content");
2982 InitScratchFS, Always, TestOutputFalse (
2984 ["write"; "/mv2/old"; "file content"];
2985 ["mv"; "/mv2/old"; "/mv2/new"];
2986 ["is_file"; "/mv2/old"]])],
2989 This moves a file from C<src> to C<dest> where C<dest> is
2990 either a destination filename or destination directory.");
2992 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
2993 [InitEmpty, Always, TestRun (
2994 [["drop_caches"; "3"]])],
2995 "drop kernel page cache, dentries and inodes",
2997 This instructs the guest kernel to drop its page cache,
2998 and/or dentries and inode caches. The parameter C<whattodrop>
2999 tells the kernel what precisely to drop, see
3000 L<http://linux-mm.org/Drop_Caches>
3002 Setting C<whattodrop> to 3 should drop everything.
3004 This automatically calls L<sync(2)> before the operation,
3005 so that the maximum guest memory is freed.");
3007 ("dmesg", (RString "kmsgs", [], []), 91, [],
3008 [InitEmpty, Always, TestRun (
3010 "return kernel messages",
3012 This returns the kernel messages (C<dmesg> output) from
3013 the guest kernel. This is sometimes useful for extended
3014 debugging of problems.
3016 Another way to get the same information is to enable
3017 verbose messages with C<guestfs_set_verbose> or by setting
3018 the environment variable C<LIBGUESTFS_DEBUG=1> before
3019 running the program.");
3021 ("ping_daemon", (RErr, [], []), 92, [],
3022 [InitEmpty, Always, TestRun (
3023 [["ping_daemon"]])],
3024 "ping the guest daemon",
3026 This is a test probe into the guestfs daemon running inside
3027 the qemu subprocess. Calling this function checks that the
3028 daemon responds to the ping message, without affecting the daemon
3029 or attached block device(s) in any other way.");
3031 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3032 [InitScratchFS, Always, TestOutputTrue (
3033 [["mkdir"; "/equal"];
3034 ["write"; "/equal/file1"; "contents of a file"];
3035 ["cp"; "/equal/file1"; "/equal/file2"];
3036 ["equal"; "/equal/file1"; "/equal/file2"]]);
3037 InitScratchFS, Always, TestOutputFalse (
3038 [["mkdir"; "/equal2"];
3039 ["write"; "/equal2/file1"; "contents of a file"];
3040 ["write"; "/equal2/file2"; "contents of another file"];
3041 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3042 InitScratchFS, Always, TestLastFail (
3043 [["mkdir"; "/equal3"];
3044 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3045 "test if two files have equal contents",
3047 This compares the two files C<file1> and C<file2> and returns
3048 true if their content is exactly equal, or false otherwise.
3050 The external L<cmp(1)> program is used for the comparison.");
3052 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3053 [InitISOFS, Always, TestOutputList (
3054 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3055 InitISOFS, Always, TestOutputList (
3056 [["strings"; "/empty"]], []);
3057 (* Test for RHBZ#579608, absolute symbolic links. *)
3058 InitISOFS, Always, TestRun (
3059 [["strings"; "/abssymlink"]])],
3060 "print the printable strings in a file",
3062 This runs the L<strings(1)> command on a file and returns
3063 the list of printable strings found.");
3065 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3066 [InitISOFS, Always, TestOutputList (
3067 [["strings_e"; "b"; "/known-5"]], []);
3068 InitScratchFS, Always, TestOutputList (
3069 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3070 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3071 "print the printable strings in a file",
3073 This is like the C<guestfs_strings> command, but allows you to
3074 specify the encoding of strings that are looked for in
3075 the source file C<path>.
3077 Allowed encodings are:
3083 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3084 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3088 Single 8-bit-byte characters.
3092 16-bit big endian strings such as those encoded in
3093 UTF-16BE or UCS-2BE.
3095 =item l (lower case letter L)
3097 16-bit little endian such as UTF-16LE and UCS-2LE.
3098 This is useful for examining binaries in Windows guests.
3102 32-bit big endian such as UCS-4BE.
3106 32-bit little endian such as UCS-4LE.
3110 The returned strings are transcoded to UTF-8.");
3112 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3113 [InitISOFS, Always, TestOutput (
3114 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3115 (* Test for RHBZ#501888c2 regression which caused large hexdump
3116 * commands to segfault.
3118 InitISOFS, Always, TestRun (
3119 [["hexdump"; "/100krandom"]]);
3120 (* Test for RHBZ#579608, absolute symbolic links. *)
3121 InitISOFS, Always, TestRun (
3122 [["hexdump"; "/abssymlink"]])],
3123 "dump a file in hexadecimal",
3125 This runs C<hexdump -C> on the given C<path>. The result is
3126 the human-readable, canonical hex dump of the file.");
3128 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3129 [InitNone, Always, TestOutput (
3130 [["part_disk"; "/dev/sda"; "mbr"];
3131 ["mkfs"; "ext3"; "/dev/sda1"];
3132 ["mount_options"; ""; "/dev/sda1"; "/"];
3133 ["write"; "/new"; "test file"];
3134 ["umount"; "/dev/sda1"];
3135 ["zerofree"; "/dev/sda1"];
3136 ["mount_options"; ""; "/dev/sda1"; "/"];
3137 ["cat"; "/new"]], "test file")],
3138 "zero unused inodes and disk blocks on ext2/3 filesystem",
3140 This runs the I<zerofree> program on C<device>. This program
3141 claims to zero unused inodes and disk blocks on an ext2/3
3142 filesystem, thus making it possible to compress the filesystem
3145 You should B<not> run this program if the filesystem is
3148 It is possible that using this program can damage the filesystem
3149 or data on the filesystem.");
3151 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3153 "resize an LVM physical volume",
3155 This resizes (expands or shrinks) an existing LVM physical
3156 volume to match the new size of the underlying device.");
3158 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3159 Int "cyls"; Int "heads"; Int "sectors";
3160 String "line"], []), 99, [DangerWillRobinson],
3162 "modify a single partition on a block device",
3164 This runs L<sfdisk(8)> option to modify just the single
3165 partition C<n> (note: C<n> counts from 1).
3167 For other parameters, see C<guestfs_sfdisk>. You should usually
3168 pass C<0> for the cyls/heads/sectors parameters.
3170 See also: C<guestfs_part_add>");
3172 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3174 "display the partition table",
3176 This displays the partition table on C<device>, in the
3177 human-readable output of the L<sfdisk(8)> command. It is
3178 not intended to be parsed.
3180 See also: C<guestfs_part_list>");
3182 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3184 "display the kernel geometry",
3186 This displays the kernel's idea of the geometry of C<device>.
3188 The result is in human-readable format, and not designed to
3191 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3193 "display the disk geometry from the partition table",
3195 This displays the disk geometry of C<device> read from the
3196 partition table. Especially in the case where the underlying
3197 block device has been resized, this can be different from the
3198 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3200 The result is in human-readable format, and not designed to
3203 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3205 "activate or deactivate all volume groups",
3207 This command activates or (if C<activate> is false) deactivates
3208 all logical volumes in all volume groups.
3209 If activated, then they are made known to the
3210 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3211 then those devices disappear.
3213 This command is the same as running C<vgchange -a y|n>");
3215 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3217 "activate or deactivate some volume groups",
3219 This command activates or (if C<activate> is false) deactivates
3220 all logical volumes in the listed volume groups C<volgroups>.
3221 If activated, then they are made known to the
3222 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3223 then those devices disappear.
3225 This command is the same as running C<vgchange -a y|n volgroups...>
3227 Note that if C<volgroups> is an empty list then B<all> volume groups
3228 are activated or deactivated.");
3230 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3231 [InitNone, Always, TestOutput (
3232 [["part_disk"; "/dev/sda"; "mbr"];
3233 ["pvcreate"; "/dev/sda1"];
3234 ["vgcreate"; "VG"; "/dev/sda1"];
3235 ["lvcreate"; "LV"; "VG"; "10"];
3236 ["mkfs"; "ext2"; "/dev/VG/LV"];
3237 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3238 ["write"; "/new"; "test content"];
3240 ["lvresize"; "/dev/VG/LV"; "20"];
3241 ["e2fsck_f"; "/dev/VG/LV"];
3242 ["resize2fs"; "/dev/VG/LV"];
3243 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3244 ["cat"; "/new"]], "test content");
3245 InitNone, Always, TestRun (
3246 (* Make an LV smaller to test RHBZ#587484. *)
3247 [["part_disk"; "/dev/sda"; "mbr"];
3248 ["pvcreate"; "/dev/sda1"];
3249 ["vgcreate"; "VG"; "/dev/sda1"];
3250 ["lvcreate"; "LV"; "VG"; "20"];
3251 ["lvresize"; "/dev/VG/LV"; "10"]])],
3252 "resize an LVM logical volume",
3254 This resizes (expands or shrinks) an existing LVM logical
3255 volume to C<mbytes>. When reducing, data in the reduced part
3258 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3259 [], (* lvresize tests this *)
3260 "resize an ext2, ext3 or ext4 filesystem",
3262 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3263 the underlying device.
3265 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3266 on the C<device> before calling this command. For unknown reasons
3267 C<resize2fs> sometimes gives an error about this and sometimes not.
3268 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3269 calling this function.");
3271 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3272 [InitBasicFS, Always, TestOutputList (
3273 [["find"; "/"]], ["lost+found"]);
3274 InitBasicFS, Always, TestOutputList (
3278 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3279 InitScratchFS, Always, TestOutputList (
3280 [["mkdir_p"; "/find/b/c"];
3281 ["touch"; "/find/b/c/d"];
3282 ["find"; "/find/b/"]], ["c"; "c/d"])],
3283 "find all files and directories",
3285 This command lists out all files and directories, recursively,
3286 starting at C<directory>. It is essentially equivalent to
3287 running the shell command C<find directory -print> but some
3288 post-processing happens on the output, described below.
3290 This returns a list of strings I<without any prefix>. Thus
3291 if the directory structure was:
3297 then the returned list from C<guestfs_find> C</tmp> would be
3305 If C<directory> is not a directory, then this command returns
3308 The returned list is sorted.
3310 See also C<guestfs_find0>.");
3312 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3313 [], (* lvresize tests this *)
3314 "check an ext2/ext3 filesystem",
3316 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3317 filesystem checker on C<device>, noninteractively (C<-p>),
3318 even if the filesystem appears to be clean (C<-f>).
3320 This command is only needed because of C<guestfs_resize2fs>
3321 (q.v.). Normally you should use C<guestfs_fsck>.");
3323 ("sleep", (RErr, [Int "secs"], []), 109, [],
3324 [InitNone, Always, TestRun (
3326 "sleep for some seconds",
3328 Sleep for C<secs> seconds.");
3330 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3331 [InitNone, Always, TestOutputInt (
3332 [["part_disk"; "/dev/sda"; "mbr"];
3333 ["mkfs"; "ntfs"; "/dev/sda1"];
3334 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3335 InitNone, Always, TestOutputInt (
3336 [["part_disk"; "/dev/sda"; "mbr"];
3337 ["mkfs"; "ext2"; "/dev/sda1"];
3338 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3339 "probe NTFS volume",
3341 This command runs the L<ntfs-3g.probe(8)> command which probes
3342 an NTFS C<device> for mountability. (Not all NTFS volumes can
3343 be mounted read-write, and some cannot be mounted at all).
3345 C<rw> is a boolean flag. Set it to true if you want to test
3346 if the volume can be mounted read-write. Set it to false if
3347 you want to test if the volume can be mounted read-only.
3349 The return value is an integer which C<0> if the operation
3350 would succeed, or some non-zero value documented in the
3351 L<ntfs-3g.probe(8)> manual page.");
3353 ("sh", (RString "output", [String "command"], []), 111, [],
3354 [], (* XXX needs tests *)
3355 "run a command via the shell",
3357 This call runs a command from the guest filesystem via the
3360 This is like C<guestfs_command>, but passes the command to:
3362 /bin/sh -c \"command\"
3364 Depending on the guest's shell, this usually results in
3365 wildcards being expanded, shell expressions being interpolated
3368 All the provisos about C<guestfs_command> apply to this call.");
3370 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3371 [], (* XXX needs tests *)
3372 "run a command via the shell returning lines",
3374 This is the same as C<guestfs_sh>, but splits the result
3375 into a list of lines.
3377 See also: C<guestfs_command_lines>");
3379 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3380 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3381 * code in stubs.c, since all valid glob patterns must start with "/".
3382 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3384 [InitScratchFS, Always, TestOutputList (
3385 [["mkdir_p"; "/glob_expand/b/c"];
3386 ["touch"; "/glob_expand/b/c/d"];
3387 ["touch"; "/glob_expand/b/c/e"];
3388 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3389 InitScratchFS, Always, TestOutputList (
3390 [["mkdir_p"; "/glob_expand2/b/c"];
3391 ["touch"; "/glob_expand2/b/c/d"];
3392 ["touch"; "/glob_expand2/b/c/e"];
3393 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3394 InitScratchFS, Always, TestOutputList (
3395 [["mkdir_p"; "/glob_expand3/b/c"];
3396 ["touch"; "/glob_expand3/b/c/d"];
3397 ["touch"; "/glob_expand3/b/c/e"];
3398 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3399 "expand a wildcard path",
3401 This command searches for all the pathnames matching
3402 C<pattern> according to the wildcard expansion rules
3405 If no paths match, then this returns an empty list
3406 (note: not an error).
3408 It is just a wrapper around the C L<glob(3)> function
3409 with flags C<GLOB_MARK|GLOB_BRACE>.
3410 See that manual page for more details.");
3412 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3413 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3414 [["scrub_device"; "/dev/sdc"]])],
3415 "scrub (securely wipe) a device",
3417 This command writes patterns over C<device> to make data retrieval
3420 It is an interface to the L<scrub(1)> program. See that
3421 manual page for more details.");
3423 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3424 [InitScratchFS, Always, TestRun (
3425 [["write"; "/scrub_file"; "content"];
3426 ["scrub_file"; "/scrub_file"]])],
3427 "scrub (securely wipe) a file",
3429 This command writes patterns over a file to make data retrieval
3432 The file is I<removed> after scrubbing.
3434 It is an interface to the L<scrub(1)> program. See that
3435 manual page for more details.");
3437 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3438 [], (* XXX needs testing *)
3439 "scrub (securely wipe) free space",
3441 This command creates the directory C<dir> and then fills it
3442 with files until the filesystem is full, and scrubs the files
3443 as for C<guestfs_scrub_file>, and deletes them.
3444 The intention is to scrub any free space on the partition
3447 It is an interface to the L<scrub(1)> program. See that
3448 manual page for more details.");
3450 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3451 [InitScratchFS, Always, TestRun (
3452 [["mkdir"; "/mkdtemp"];
3453 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3454 "create a temporary directory",
3456 This command creates a temporary directory. The
3457 C<template> parameter should be a full pathname for the
3458 temporary directory name with the final six characters being
3461 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3462 the second one being suitable for Windows filesystems.
3464 The name of the temporary directory that was created
3467 The temporary directory is created with mode 0700
3468 and is owned by root.
3470 The caller is responsible for deleting the temporary
3471 directory and its contents after use.
3473 See also: L<mkdtemp(3)>");
3475 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3476 [InitISOFS, Always, TestOutputInt (
3477 [["wc_l"; "/10klines"]], 10000);
3478 (* Test for RHBZ#579608, absolute symbolic links. *)
3479 InitISOFS, Always, TestOutputInt (
3480 [["wc_l"; "/abssymlink"]], 10000)],
3481 "count lines in a file",
3483 This command counts the lines in a file, using the
3484 C<wc -l> external command.");
3486 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3487 [InitISOFS, Always, TestOutputInt (
3488 [["wc_w"; "/10klines"]], 10000)],
3489 "count words in a file",
3491 This command counts the words in a file, using the
3492 C<wc -w> external command.");
3494 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3495 [InitISOFS, Always, TestOutputInt (
3496 [["wc_c"; "/100kallspaces"]], 102400)],
3497 "count characters in a file",
3499 This command counts the characters in a file, using the
3500 C<wc -c> external command.");
3502 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3503 [InitISOFS, Always, TestOutputList (
3504 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3505 (* Test for RHBZ#579608, absolute symbolic links. *)
3506 InitISOFS, Always, TestOutputList (
3507 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3508 "return first 10 lines of a file",
3510 This command returns up to the first 10 lines of a file as
3511 a list of strings.");
3513 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3514 [InitISOFS, Always, TestOutputList (
3515 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3516 InitISOFS, Always, TestOutputList (
3517 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3518 InitISOFS, Always, TestOutputList (
3519 [["head_n"; "0"; "/10klines"]], [])],
3520 "return first N lines of a file",
3522 If the parameter C<nrlines> is a positive number, this returns the first
3523 C<nrlines> lines of the file C<path>.
3525 If the parameter C<nrlines> is a negative number, this returns lines
3526 from the file C<path>, excluding the last C<nrlines> lines.
3528 If the parameter C<nrlines> is zero, this returns an empty list.");
3530 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3531 [InitISOFS, Always, TestOutputList (
3532 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3533 "return last 10 lines of a file",
3535 This command returns up to the last 10 lines of a file as
3536 a list of strings.");
3538 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3539 [InitISOFS, Always, TestOutputList (
3540 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3541 InitISOFS, Always, TestOutputList (
3542 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3543 InitISOFS, Always, TestOutputList (
3544 [["tail_n"; "0"; "/10klines"]], [])],
3545 "return last N lines of a file",
3547 If the parameter C<nrlines> is a positive number, this returns the last
3548 C<nrlines> lines of the file C<path>.
3550 If the parameter C<nrlines> is a negative number, this returns lines
3551 from the file C<path>, starting with the C<-nrlines>th line.
3553 If the parameter C<nrlines> is zero, this returns an empty list.");
3555 ("df", (RString "output", [], []), 125, [],
3556 [], (* XXX Tricky to test because it depends on the exact format
3557 * of the 'df' command and other imponderables.
3559 "report file system disk space usage",
3561 This command runs the C<df> command to report disk space used.
3563 This command is mostly useful for interactive sessions. It
3564 is I<not> intended that you try to parse the output string.
3565 Use C<guestfs_statvfs> from programs.");
3567 ("df_h", (RString "output", [], []), 126, [],
3568 [], (* XXX Tricky to test because it depends on the exact format
3569 * of the 'df' command and other imponderables.
3571 "report file system disk space usage (human readable)",
3573 This command runs the C<df -h> command to report disk space used
3574 in human-readable format.
3576 This command is mostly useful for interactive sessions. It
3577 is I<not> intended that you try to parse the output string.
3578 Use C<guestfs_statvfs> from programs.");
3580 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [],
3581 [InitISOFS, Always, TestOutputInt (
3582 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3583 "estimate file space usage",
3585 This command runs the C<du -s> command to estimate file space
3588 C<path> can be a file or a directory. If C<path> is a directory
3589 then the estimate includes the contents of the directory and all
3590 subdirectories (recursively).
3592 The result is the estimated size in I<kilobytes>
3593 (ie. units of 1024 bytes).");
3595 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3596 [InitISOFS, Always, TestOutputList (
3597 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3598 "list files in an initrd",
3600 This command lists out files contained in an initrd.
3602 The files are listed without any initial C</> character. The
3603 files are listed in the order they appear (not necessarily
3604 alphabetical). Directory names are listed as separate items.
3606 Old Linux kernels (2.4 and earlier) used a compressed ext2
3607 filesystem as initrd. We I<only> support the newer initramfs
3608 format (compressed cpio files).");
3610 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3612 "mount a file using the loop device",
3614 This command lets you mount C<file> (a filesystem image
3615 in a file) on a mount point. It is entirely equivalent to
3616 the command C<mount -o loop file mountpoint>.");
3618 ("mkswap", (RErr, [Device "device"], []), 130, [],
3619 [InitEmpty, Always, TestRun (
3620 [["part_disk"; "/dev/sda"; "mbr"];
3621 ["mkswap"; "/dev/sda1"]])],
3622 "create a swap partition",
3624 Create a swap partition on C<device>.");
3626 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3627 [InitEmpty, Always, TestRun (
3628 [["part_disk"; "/dev/sda"; "mbr"];
3629 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3630 "create a swap partition with a label",
3632 Create a swap partition on C<device> with label C<label>.
3634 Note that you cannot attach a swap label to a block device
3635 (eg. C</dev/sda>), just to a partition. This appears to be
3636 a limitation of the kernel or swap tools.");
3638 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3639 (let uuid = uuidgen () in
3640 [InitEmpty, Always, TestRun (
3641 [["part_disk"; "/dev/sda"; "mbr"];
3642 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3643 "create a swap partition with an explicit UUID",
3645 Create a swap partition on C<device> with UUID C<uuid>.");
3647 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3648 [InitScratchFS, Always, TestOutputStruct (
3649 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3650 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3651 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3652 InitScratchFS, Always, TestOutputStruct (
3653 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3654 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3655 "make block, character or FIFO devices",
3657 This call creates block or character special devices, or
3658 named pipes (FIFOs).
3660 The C<mode> parameter should be the mode, using the standard
3661 constants. C<devmajor> and C<devminor> are the
3662 device major and minor numbers, only used when creating block
3663 and character special devices.
3665 Note that, just like L<mknod(2)>, the mode must be bitwise
3666 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3667 just creates a regular file). These constants are
3668 available in the standard Linux header files, or you can use
3669 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3670 which are wrappers around this command which bitwise OR
3671 in the appropriate constant for you.
3673 The mode actually set is affected by the umask.");
3675 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3676 [InitScratchFS, Always, TestOutputStruct (
3677 [["mkfifo"; "0o777"; "/mkfifo"];
3678 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3679 "make FIFO (named pipe)",
3681 This call creates a FIFO (named pipe) called C<path> with
3682 mode C<mode>. It is just a convenient wrapper around
3685 The mode actually set is affected by the umask.");
3687 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3688 [InitScratchFS, Always, TestOutputStruct (
3689 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3690 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3691 "make block device node",
3693 This call creates a block device node called C<path> with
3694 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3695 It is just a convenient wrapper around C<guestfs_mknod>.
3697 The mode actually set is affected by the umask.");
3699 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3700 [InitScratchFS, Always, TestOutputStruct (
3701 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3702 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3703 "make char device node",
3705 This call creates a char device node called C<path> with
3706 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3707 It is just a convenient wrapper around C<guestfs_mknod>.
3709 The mode actually set is affected by the umask.");
3711 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3712 [InitEmpty, Always, TestOutputInt (
3713 [["umask"; "0o22"]], 0o22)],
3714 "set file mode creation mask (umask)",
3716 This function sets the mask used for creating new files and
3717 device nodes to C<mask & 0777>.
3719 Typical umask values would be C<022> which creates new files
3720 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3721 C<002> which creates new files with permissions like
3722 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3724 The default umask is C<022>. This is important because it
3725 means that directories and device nodes will be created with
3726 C<0644> or C<0755> mode even if you specify C<0777>.
3728 See also C<guestfs_get_umask>,
3729 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3731 This call returns the previous umask.");
3733 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3735 "read directories entries",
3737 This returns the list of directory entries in directory C<dir>.
3739 All entries in the directory are returned, including C<.> and
3740 C<..>. The entries are I<not> sorted, but returned in the same
3741 order as the underlying filesystem.
3743 Also this call returns basic file type information about each
3744 file. The C<ftyp> field will contain one of the following characters:
3782 The L<readdir(3)> call returned a C<d_type> field with an
3787 This function is primarily intended for use by programs. To
3788 get a simple list of names, use C<guestfs_ls>. To get a printable
3789 directory for human consumption, use C<guestfs_ll>.");
3791 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3793 "create partitions on a block device",
3795 This is a simplified interface to the C<guestfs_sfdisk>
3796 command, where partition sizes are specified in megabytes
3797 only (rounded to the nearest cylinder) and you don't need
3798 to specify the cyls, heads and sectors parameters which
3799 were rarely if ever used anyway.
3801 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3802 and C<guestfs_part_disk>");
3804 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3806 "determine file type inside a compressed file",
3808 This command runs C<file> after first decompressing C<path>
3811 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3813 Since 1.0.63, use C<guestfs_file> instead which can now
3814 process compressed files.");
3816 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3818 "list extended attributes of a file or directory",
3820 This call lists the extended attributes of the file or directory
3823 At the system call level, this is a combination of the
3824 L<listxattr(2)> and L<getxattr(2)> calls.
3826 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3828 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3830 "list extended attributes of a file or directory",
3832 This is the same as C<guestfs_getxattrs>, but if C<path>
3833 is a symbolic link, then it returns the extended attributes
3834 of the link itself.");
3836 ("setxattr", (RErr, [String "xattr";
3837 String "val"; Int "vallen"; (* will be BufferIn *)
3838 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3840 "set extended attribute of a file or directory",
3842 This call sets the extended attribute named C<xattr>
3843 of the file C<path> to the value C<val> (of length C<vallen>).
3844 The value is arbitrary 8 bit data.
3846 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3848 ("lsetxattr", (RErr, [String "xattr";
3849 String "val"; Int "vallen"; (* will be BufferIn *)
3850 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3852 "set extended attribute of a file or directory",
3854 This is the same as C<guestfs_setxattr>, but if C<path>
3855 is a symbolic link, then it sets an extended attribute
3856 of the link itself.");
3858 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3860 "remove extended attribute of a file or directory",
3862 This call removes the extended attribute named C<xattr>
3863 of the file C<path>.
3865 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3867 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3869 "remove extended attribute of a file or directory",
3871 This is the same as C<guestfs_removexattr>, but if C<path>
3872 is a symbolic link, then it removes an extended attribute
3873 of the link itself.");
3875 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3879 This call is similar to C<guestfs_mounts>. That call returns
3880 a list of devices. This one returns a hash table (map) of
3881 device name to directory where the device is mounted.");
3883 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3884 (* This is a special case: while you would expect a parameter
3885 * of type "Pathname", that doesn't work, because it implies
3886 * NEED_ROOT in the generated calling code in stubs.c, and
3887 * this function cannot use NEED_ROOT.
3890 "create a mountpoint",
3892 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3893 specialized calls that can be used to create extra mountpoints
3894 before mounting the first filesystem.
3896 These calls are I<only> necessary in some very limited circumstances,
3897 mainly the case where you want to mount a mix of unrelated and/or
3898 read-only filesystems together.
3900 For example, live CDs often contain a \"Russian doll\" nest of
3901 filesystems, an ISO outer layer, with a squashfs image inside, with
3902 an ext2/3 image inside that. You can unpack this as follows
3905 add-ro Fedora-11-i686-Live.iso
3909 mkmountpoint /ext3fs
3911 mount-loop /cd/LiveOS/squashfs.img /sqsh
3912 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3914 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3916 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3917 You may get unexpected errors if you try to mix these calls. It is
3918 safest to manually unmount filesystems and remove mountpoints after use.
3920 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3921 longest first, so for this to work for manual mountpoints, you
3922 must ensure that the innermost mountpoints have the longest
3923 pathnames, as in the example code above.
3925 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3927 Autosync [see C<guestfs_set_autosync>, this is set by default on
3928 handles] can cause C<guestfs_umount_all> to be called when the handle
3929 is closed which can also trigger these issues.");
3931 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3933 "remove a mountpoint",
3935 This calls removes a mountpoint that was previously created
3936 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3937 for full details.");
3939 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3940 [InitISOFS, Always, TestOutputBuffer (
3941 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3942 (* Test various near large, large and too large files (RHBZ#589039). *)
3943 InitScratchFS, Always, TestLastFail (
3944 [["touch"; "/read_file"];
3945 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3946 ["read_file"; "/read_file"]]);
3947 InitScratchFS, Always, TestLastFail (
3948 [["touch"; "/read_file2"];
3949 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3950 ["read_file"; "/read_file2"]]);
3951 InitScratchFS, Always, TestLastFail (
3952 [["touch"; "/read_file3"];
3953 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3954 ["read_file"; "/read_file3"]])],
3957 This calls returns the contents of the file C<path> as a
3960 Unlike C<guestfs_cat>, this function can correctly
3961 handle files that contain embedded ASCII NUL characters.
3962 However unlike C<guestfs_download>, this function is limited
3963 in the total size of file that can be handled.");
3965 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3966 [InitISOFS, Always, TestOutputList (
3967 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3968 InitISOFS, Always, TestOutputList (
3969 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3970 (* Test for RHBZ#579608, absolute symbolic links. *)
3971 InitISOFS, Always, TestOutputList (
3972 [["grep"; "nomatch"; "/abssymlink"]], [])],
3973 "return lines matching a pattern",
3975 This calls the external C<grep> program and returns the
3978 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3979 [InitISOFS, Always, TestOutputList (
3980 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3981 "return lines matching a pattern",
3983 This calls the external C<egrep> program and returns the
3986 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3987 [InitISOFS, Always, TestOutputList (
3988 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3989 "return lines matching a pattern",
3991 This calls the external C<fgrep> program and returns the
3994 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
3995 [InitISOFS, Always, TestOutputList (
3996 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3997 "return lines matching a pattern",
3999 This calls the external C<grep -i> program and returns the
4002 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4003 [InitISOFS, Always, TestOutputList (
4004 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4005 "return lines matching a pattern",
4007 This calls the external C<egrep -i> program and returns the
4010 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4011 [InitISOFS, Always, TestOutputList (
4012 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4013 "return lines matching a pattern",
4015 This calls the external C<fgrep -i> program and returns the
4018 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4019 [InitISOFS, Always, TestOutputList (
4020 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4021 "return lines matching a pattern",
4023 This calls the external C<zgrep> program and returns the
4026 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4027 [InitISOFS, Always, TestOutputList (
4028 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4029 "return lines matching a pattern",
4031 This calls the external C<zegrep> program and returns the
4034 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4035 [InitISOFS, Always, TestOutputList (
4036 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4037 "return lines matching a pattern",
4039 This calls the external C<zfgrep> program and returns the
4042 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4043 [InitISOFS, Always, TestOutputList (
4044 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4045 "return lines matching a pattern",
4047 This calls the external C<zgrep -i> program and returns the
4050 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4051 [InitISOFS, Always, TestOutputList (
4052 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4053 "return lines matching a pattern",
4055 This calls the external C<zegrep -i> program and returns the
4058 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4059 [InitISOFS, Always, TestOutputList (
4060 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4061 "return lines matching a pattern",
4063 This calls the external C<zfgrep -i> program and returns the
4066 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4067 [InitISOFS, Always, TestOutput (
4068 [["realpath"; "/../directory"]], "/directory")],
4069 "canonicalized absolute pathname",
4071 Return the canonicalized absolute pathname of C<path>. The
4072 returned path has no C<.>, C<..> or symbolic link path elements.");
4074 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4075 [InitScratchFS, Always, TestOutputStruct (
4078 ["ln"; "/ln/a"; "/ln/b"];
4079 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4080 "create a hard link",
4082 This command creates a hard link using the C<ln> command.");
4084 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4085 [InitScratchFS, Always, TestOutputStruct (
4086 [["mkdir"; "/ln_f"];
4087 ["touch"; "/ln_f/a"];
4088 ["touch"; "/ln_f/b"];
4089 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4090 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4091 "create a hard link",
4093 This command creates a hard link using the C<ln -f> command.
4094 The C<-f> option removes the link (C<linkname>) if it exists already.");
4096 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4097 [InitScratchFS, Always, TestOutputStruct (
4098 [["mkdir"; "/ln_s"];
4099 ["touch"; "/ln_s/a"];
4100 ["ln_s"; "a"; "/ln_s/b"];
4101 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4102 "create a symbolic link",
4104 This command creates a symbolic link using the C<ln -s> command.");
4106 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4107 [InitScratchFS, Always, TestOutput (
4108 [["mkdir_p"; "/ln_sf/b"];
4109 ["touch"; "/ln_sf/b/c"];
4110 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4111 ["readlink"; "/ln_sf/b/c"]], "../d")],
4112 "create a symbolic link",
4114 This command creates a symbolic link using the C<ln -sf> command,
4115 The C<-f> option removes the link (C<linkname>) if it exists already.");
4117 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4118 [] (* XXX tested above *),
4119 "read the target of a symbolic link",
4121 This command reads the target of a symbolic link.");
4123 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4124 [InitScratchFS, Always, TestOutputStruct (
4125 [["fallocate"; "/fallocate"; "1000000"];
4126 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4127 "preallocate a file in the guest filesystem",
4129 This command preallocates a file (containing zero bytes) named
4130 C<path> of size C<len> bytes. If the file exists already, it
4133 Do not confuse this with the guestfish-specific
4134 C<alloc> command which allocates a file in the host and
4135 attaches it as a device.");
4137 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4138 [InitPartition, Always, TestRun (
4139 [["mkswap"; "/dev/sda1"];
4140 ["swapon_device"; "/dev/sda1"];
4141 ["swapoff_device"; "/dev/sda1"]])],
4142 "enable swap on device",
4144 This command enables the libguestfs appliance to use the
4145 swap device or partition named C<device>. The increased
4146 memory is made available for all commands, for example
4147 those run using C<guestfs_command> or C<guestfs_sh>.
4149 Note that you should not swap to existing guest swap
4150 partitions unless you know what you are doing. They may
4151 contain hibernation information, or other information that
4152 the guest doesn't want you to trash. You also risk leaking
4153 information about the host to the guest this way. Instead,
4154 attach a new host device to the guest and swap on that.");
4156 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4157 [], (* XXX tested by swapon_device *)
4158 "disable swap on device",
4160 This command disables the libguestfs appliance swap
4161 device or partition named C<device>.
4162 See C<guestfs_swapon_device>.");
4164 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4165 [InitScratchFS, Always, TestRun (
4166 [["fallocate"; "/swapon_file"; "8388608"];
4167 ["mkswap_file"; "/swapon_file"];
4168 ["swapon_file"; "/swapon_file"];
4169 ["swapoff_file"; "/swapon_file"];
4170 ["rm"; "/swapon_file"]])],
4171 "enable swap on file",
4173 This command enables swap to a file.
4174 See C<guestfs_swapon_device> for other notes.");
4176 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4177 [], (* XXX tested by swapon_file *)
4178 "disable swap on file",
4180 This command disables the libguestfs appliance swap on file.");
4182 ("swapon_label", (RErr, [String "label"], []), 174, [],
4183 [InitEmpty, Always, TestRun (
4184 [["part_disk"; "/dev/sda"; "mbr"];
4185 ["mkswap_L"; "swapit"; "/dev/sda1"];
4186 ["swapon_label"; "swapit"];
4187 ["swapoff_label"; "swapit"];
4188 ["zero"; "/dev/sda"];
4189 ["blockdev_rereadpt"; "/dev/sda"]])],
4190 "enable swap on labeled swap partition",
4192 This command enables swap to a labeled swap partition.
4193 See C<guestfs_swapon_device> for other notes.");
4195 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4196 [], (* XXX tested by swapon_label *)
4197 "disable swap on labeled swap partition",
4199 This command disables the libguestfs appliance swap on
4200 labeled swap partition.");
4202 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4203 (let uuid = uuidgen () in
4204 [InitEmpty, Always, TestRun (
4205 [["mkswap_U"; uuid; "/dev/sdc"];
4206 ["swapon_uuid"; uuid];
4207 ["swapoff_uuid"; uuid]])]),
4208 "enable swap on swap partition by UUID",
4210 This command enables swap to a swap partition with the given UUID.
4211 See C<guestfs_swapon_device> for other notes.");
4213 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4214 [], (* XXX tested by swapon_uuid *)
4215 "disable swap on swap partition by UUID",
4217 This command disables the libguestfs appliance swap partition
4218 with the given UUID.");
4220 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4221 [InitScratchFS, Always, TestRun (
4222 [["fallocate"; "/mkswap_file"; "8388608"];
4223 ["mkswap_file"; "/mkswap_file"];
4224 ["rm"; "/mkswap_file"]])],
4225 "create a swap file",
4229 This command just writes a swap file signature to an existing
4230 file. To create the file itself, use something like C<guestfs_fallocate>.");
4232 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4233 [InitISOFS, Always, TestRun (
4234 [["inotify_init"; "0"]])],
4235 "create an inotify handle",
4237 This command creates a new inotify handle.
4238 The inotify subsystem can be used to notify events which happen to
4239 objects in the guest filesystem.
4241 C<maxevents> is the maximum number of events which will be
4242 queued up between calls to C<guestfs_inotify_read> or
4243 C<guestfs_inotify_files>.
4244 If this is passed as C<0>, then the kernel (or previously set)
4245 default is used. For Linux 2.6.29 the default was 16384 events.
4246 Beyond this limit, the kernel throws away events, but records
4247 the fact that it threw them away by setting a flag
4248 C<IN_Q_OVERFLOW> in the returned structure list (see
4249 C<guestfs_inotify_read>).
4251 Before any events are generated, you have to add some
4252 watches to the internal watch list. See:
4253 C<guestfs_inotify_add_watch>,
4254 C<guestfs_inotify_rm_watch> and
4255 C<guestfs_inotify_watch_all>.
4257 Queued up events should be read periodically by calling
4258 C<guestfs_inotify_read>
4259 (or C<guestfs_inotify_files> which is just a helpful
4260 wrapper around C<guestfs_inotify_read>). If you don't
4261 read the events out often enough then you risk the internal
4264 The handle should be closed after use by calling
4265 C<guestfs_inotify_close>. This also removes any
4266 watches automatically.
4268 See also L<inotify(7)> for an overview of the inotify interface
4269 as exposed by the Linux kernel, which is roughly what we expose
4270 via libguestfs. Note that there is one global inotify handle
4271 per libguestfs instance.");
4273 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4274 [InitScratchFS, Always, TestOutputList (
4275 [["mkdir"; "/inotify_add_watch"];
4276 ["inotify_init"; "0"];
4277 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4278 ["touch"; "/inotify_add_watch/a"];
4279 ["touch"; "/inotify_add_watch/b"];
4280 ["inotify_files"]], ["a"; "b"])],
4281 "add an inotify watch",
4283 Watch C<path> for the events listed in C<mask>.
4285 Note that if C<path> is a directory then events within that
4286 directory are watched, but this does I<not> happen recursively
4287 (in subdirectories).
4289 Note for non-C or non-Linux callers: the inotify events are
4290 defined by the Linux kernel ABI and are listed in
4291 C</usr/include/sys/inotify.h>.");
4293 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4295 "remove an inotify watch",
4297 Remove a previously defined inotify watch.
4298 See C<guestfs_inotify_add_watch>.");
4300 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4302 "return list of inotify events",
4304 Return the complete queue of events that have happened
4305 since the previous read call.
4307 If no events have happened, this returns an empty list.
4309 I<Note>: In order to make sure that all events have been
4310 read, you must call this function repeatedly until it
4311 returns an empty list. The reason is that the call will
4312 read events up to the maximum appliance-to-host message
4313 size and leave remaining events in the queue.");
4315 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4317 "return list of watched files that had events",
4319 This function is a helpful wrapper around C<guestfs_inotify_read>
4320 which just returns a list of pathnames of objects that were
4321 touched. The returned pathnames are sorted and deduplicated.");
4323 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4325 "close the inotify handle",
4327 This closes the inotify handle which was previously
4328 opened by inotify_init. It removes all watches, throws
4329 away any pending events, and deallocates all resources.");
4331 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4333 "set SELinux security context",
4335 This sets the SELinux security context of the daemon
4336 to the string C<context>.
4338 See the documentation about SELINUX in L<guestfs(3)>.");
4340 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4342 "get SELinux security context",
4344 This gets the SELinux security context of the daemon.
4346 See the documentation about SELINUX in L<guestfs(3)>,
4347 and C<guestfs_setcon>");
4349 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4350 [InitEmpty, Always, TestOutput (
4351 [["part_disk"; "/dev/sda"; "mbr"];
4352 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4353 ["mount_options"; ""; "/dev/sda1"; "/"];
4354 ["write"; "/new"; "new file contents"];
4355 ["cat"; "/new"]], "new file contents");
4356 InitEmpty, Always, TestRun (
4357 [["part_disk"; "/dev/sda"; "mbr"];
4358 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4359 InitEmpty, Always, TestLastFail (
4360 [["part_disk"; "/dev/sda"; "mbr"];
4361 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4362 InitEmpty, Always, TestLastFail (
4363 [["part_disk"; "/dev/sda"; "mbr"];
4364 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4365 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4366 [["part_disk"; "/dev/sda"; "mbr"];
4367 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4368 "make a filesystem with block size",
4370 This call is similar to C<guestfs_mkfs>, but it allows you to
4371 control the block size of the resulting filesystem. Supported
4372 block sizes depend on the filesystem type, but typically they
4373 are C<1024>, C<2048> or C<4096> only.
4375 For VFAT and NTFS the C<blocksize> parameter is treated as
4376 the requested cluster size.");
4378 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4379 [InitEmpty, Always, TestOutput (
4380 [["part_init"; "/dev/sda"; "mbr"];
4381 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4382 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4383 ["mke2journal"; "4096"; "/dev/sda1"];
4384 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4385 ["mount_options"; ""; "/dev/sda2"; "/"];
4386 ["write"; "/new"; "new file contents"];
4387 ["cat"; "/new"]], "new file contents")],
4388 "make ext2/3/4 external journal",
4390 This creates an ext2 external journal on C<device>. It is equivalent
4393 mke2fs -O journal_dev -b blocksize device");
4395 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4396 [InitEmpty, Always, TestOutput (
4397 [["part_init"; "/dev/sda"; "mbr"];
4398 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4399 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4400 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4401 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4402 ["mount_options"; ""; "/dev/sda2"; "/"];
4403 ["write"; "/new"; "new file contents"];
4404 ["cat"; "/new"]], "new file contents")],
4405 "make ext2/3/4 external journal with label",
4407 This creates an ext2 external journal on C<device> with label C<label>.");
4409 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4410 (let uuid = uuidgen () in
4411 [InitEmpty, Always, TestOutput (
4412 [["part_init"; "/dev/sda"; "mbr"];
4413 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4414 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4415 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4416 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4417 ["mount_options"; ""; "/dev/sda2"; "/"];
4418 ["write"; "/new"; "new file contents"];
4419 ["cat"; "/new"]], "new file contents")]),
4420 "make ext2/3/4 external journal with UUID",
4422 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4424 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4426 "make ext2/3/4 filesystem with external journal",
4428 This creates an ext2/3/4 filesystem on C<device> with
4429 an external journal on C<journal>. It is equivalent
4432 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4434 See also C<guestfs_mke2journal>.");
4436 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4438 "make ext2/3/4 filesystem with external journal",
4440 This creates an ext2/3/4 filesystem on C<device> with
4441 an external journal on the journal labeled C<label>.
4443 See also C<guestfs_mke2journal_L>.");
4445 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4447 "make ext2/3/4 filesystem with external journal",
4449 This creates an ext2/3/4 filesystem on C<device> with
4450 an external journal on the journal with UUID C<uuid>.
4452 See also C<guestfs_mke2journal_U>.");
4454 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4455 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4456 "load a kernel module",
4458 This loads a kernel module in the appliance.
4460 The kernel module must have been whitelisted when libguestfs
4461 was built (see C<appliance/kmod.whitelist.in> in the source).");
4463 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4464 [InitNone, Always, TestOutput (
4465 [["echo_daemon"; "This is a test"]], "This is a test"
4467 "echo arguments back to the client",
4469 This command concatenates the list of C<words> passed with single spaces
4470 between them and returns the resulting string.
4472 You can use this command to test the connection through to the daemon.
4474 See also C<guestfs_ping_daemon>.");
4476 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4477 [], (* There is a regression test for this. *)
4478 "find all files and directories, returning NUL-separated list",
4480 This command lists out all files and directories, recursively,
4481 starting at C<directory>, placing the resulting list in the
4482 external file called C<files>.
4484 This command works the same way as C<guestfs_find> with the
4485 following exceptions:
4491 The resulting list is written to an external file.
4495 Items (filenames) in the result are separated
4496 by C<\\0> characters. See L<find(1)> option I<-print0>.
4500 This command is not limited in the number of names that it
4505 The result list is not sorted.
4509 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4510 [InitISOFS, Always, TestOutput (
4511 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4512 InitISOFS, Always, TestOutput (
4513 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4514 InitISOFS, Always, TestOutput (
4515 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4516 InitISOFS, Always, TestLastFail (
4517 [["case_sensitive_path"; "/Known-1/"]]);
4518 InitScratchFS, Always, TestOutput (
4519 [["mkdir"; "/case_sensitive_path"];
4520 ["mkdir"; "/case_sensitive_path/bbb"];
4521 ["touch"; "/case_sensitive_path/bbb/c"];
4522 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4523 InitScratchFS, Always, TestOutput (
4524 [["mkdir"; "/case_sensitive_path2"];
4525 ["mkdir"; "/case_sensitive_path2/bbb"];
4526 ["touch"; "/case_sensitive_path2/bbb/c"];
4527 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4528 InitScratchFS, Always, TestLastFail (
4529 [["mkdir"; "/case_sensitive_path3"];
4530 ["mkdir"; "/case_sensitive_path3/bbb"];
4531 ["touch"; "/case_sensitive_path3/bbb/c"];
4532 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4533 "return true path on case-insensitive filesystem",
4535 This can be used to resolve case insensitive paths on
4536 a filesystem which is case sensitive. The use case is
4537 to resolve paths which you have read from Windows configuration
4538 files or the Windows Registry, to the true path.
4540 The command handles a peculiarity of the Linux ntfs-3g
4541 filesystem driver (and probably others), which is that although
4542 the underlying filesystem is case-insensitive, the driver
4543 exports the filesystem to Linux as case-sensitive.
4545 One consequence of this is that special directories such
4546 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4547 (or other things) depending on the precise details of how
4548 they were created. In Windows itself this would not be
4551 Bug or feature? You decide:
4552 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4554 This function resolves the true case of each element in the
4555 path and returns the case-sensitive path.
4557 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4558 might return C<\"/WINDOWS/system32\"> (the exact return value
4559 would depend on details of how the directories were originally
4560 created under Windows).
4563 This function does not handle drive names, backslashes etc.
4565 See also C<guestfs_realpath>.");
4567 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4568 [InitScratchFS, Always, TestOutput (
4569 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4570 "get the Linux VFS type corresponding to a mounted device",
4572 This command gets the filesystem type corresponding to
4573 the filesystem on C<device>.
4575 For most filesystems, the result is the name of the Linux
4576 VFS module which would be used to mount this filesystem
4577 if you mounted it without specifying the filesystem type.
4578 For example a string such as C<ext3> or C<ntfs>.");
4580 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4581 [InitScratchFS, Always, TestOutputStruct (
4582 [["write"; "/truncate"; "some stuff so size is not zero"];
4583 ["truncate"; "/truncate"];
4584 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4585 "truncate a file to zero size",
4587 This command truncates C<path> to a zero-length file. The
4588 file must exist already.");
4590 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4591 [InitScratchFS, Always, TestOutputStruct (
4592 [["touch"; "/truncate_size"];
4593 ["truncate_size"; "/truncate_size"; "1000"];
4594 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4595 "truncate a file to a particular size",
4597 This command truncates C<path> to size C<size> bytes. The file
4600 If the current file size is less than C<size> then
4601 the file is extended to the required size with zero bytes.
4602 This creates a sparse file (ie. disk blocks are not allocated
4603 for the file until you write to it). To create a non-sparse
4604 file of zeroes, use C<guestfs_fallocate64> instead.");
4606 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4607 [InitScratchFS, Always, TestOutputStruct (
4608 [["touch"; "/utimens"];
4609 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4610 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4611 "set timestamp of a file with nanosecond precision",
4613 This command sets the timestamps of a file with nanosecond
4616 C<atsecs, atnsecs> are the last access time (atime) in secs and
4617 nanoseconds from the epoch.
4619 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4620 secs and nanoseconds from the epoch.
4622 If the C<*nsecs> field contains the special value C<-1> then
4623 the corresponding timestamp is set to the current time. (The
4624 C<*secs> field is ignored in this case).
4626 If the C<*nsecs> field contains the special value C<-2> then
4627 the corresponding timestamp is left unchanged. (The
4628 C<*secs> field is ignored in this case).");
4630 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4631 [InitScratchFS, Always, TestOutputStruct (
4632 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4633 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4634 "create a directory with a particular mode",
4636 This command creates a directory, setting the initial permissions
4637 of the directory to C<mode>.
4639 For common Linux filesystems, the actual mode which is set will
4640 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4641 interpret the mode in other ways.
4643 See also C<guestfs_mkdir>, C<guestfs_umask>");
4645 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4647 "change file owner and group",
4649 Change the file owner to C<owner> and group to C<group>.
4650 This is like C<guestfs_chown> but if C<path> is a symlink then
4651 the link itself is changed, not the target.
4653 Only numeric uid and gid are supported. If you want to use
4654 names, you will need to locate and parse the password file
4655 yourself (Augeas support makes this relatively easy).");
4657 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4659 "lstat on multiple files",
4661 This call allows you to perform the C<guestfs_lstat> operation
4662 on multiple files, where all files are in the directory C<path>.
4663 C<names> is the list of files from this directory.
4665 On return you get a list of stat structs, with a one-to-one
4666 correspondence to the C<names> list. If any name did not exist
4667 or could not be lstat'd, then the C<ino> field of that structure
4670 This call is intended for programs that want to efficiently
4671 list a directory contents without making many round-trips.
4672 See also C<guestfs_lxattrlist> for a similarly efficient call
4673 for getting extended attributes. Very long directory listings
4674 might cause the protocol message size to be exceeded, causing
4675 this call to fail. The caller must split up such requests
4676 into smaller groups of names.");
4678 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4680 "lgetxattr on multiple files",
4682 This call allows you to get the extended attributes
4683 of multiple files, where all files are in the directory C<path>.
4684 C<names> is the list of files from this directory.
4686 On return you get a flat list of xattr structs which must be
4687 interpreted sequentially. The first xattr struct always has a zero-length
4688 C<attrname>. C<attrval> in this struct is zero-length
4689 to indicate there was an error doing C<lgetxattr> for this
4690 file, I<or> is a C string which is a decimal number
4691 (the number of following attributes for this file, which could
4692 be C<\"0\">). Then after the first xattr struct are the
4693 zero or more attributes for the first named file.
4694 This repeats for the second and subsequent files.
4696 This call is intended for programs that want to efficiently
4697 list a directory contents without making many round-trips.
4698 See also C<guestfs_lstatlist> for a similarly efficient call
4699 for getting standard stats. Very long directory listings
4700 might cause the protocol message size to be exceeded, causing
4701 this call to fail. The caller must split up such requests
4702 into smaller groups of names.");
4704 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4706 "readlink on multiple files",
4708 This call allows you to do a C<readlink> operation
4709 on multiple files, where all files are in the directory C<path>.
4710 C<names> is the list of files from this directory.
4712 On return you get a list of strings, with a one-to-one
4713 correspondence to the C<names> list. Each string is the
4714 value of the symbolic link.
4716 If the C<readlink(2)> operation fails on any name, then
4717 the corresponding result string is the empty string C<\"\">.
4718 However the whole operation is completed even if there
4719 were C<readlink(2)> errors, and so you can call this
4720 function with names where you don't know if they are
4721 symbolic links already (albeit slightly less efficient).
4723 This call is intended for programs that want to efficiently
4724 list a directory contents without making many round-trips.
4725 Very long directory listings might cause the protocol
4726 message size to be exceeded, causing
4727 this call to fail. The caller must split up such requests
4728 into smaller groups of names.");
4730 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4731 [InitISOFS, Always, TestOutputBuffer (
4732 [["pread"; "/known-4"; "1"; "3"]], "\n");
4733 InitISOFS, Always, TestOutputBuffer (
4734 [["pread"; "/empty"; "0"; "100"]], "")],
4735 "read part of a file",
4737 This command lets you read part of a file. It reads C<count>
4738 bytes of the file, starting at C<offset>, from file C<path>.
4740 This may read fewer bytes than requested. For further details
4741 see the L<pread(2)> system call.
4743 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4745 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4746 [InitEmpty, Always, TestRun (
4747 [["part_init"; "/dev/sda"; "gpt"]])],
4748 "create an empty partition table",
4750 This creates an empty partition table on C<device> of one of the
4751 partition types listed below. Usually C<parttype> should be
4752 either C<msdos> or C<gpt> (for large disks).
4754 Initially there are no partitions. Following this, you should
4755 call C<guestfs_part_add> for each partition required.
4757 Possible values for C<parttype> are:
4761 =item B<efi> | B<gpt>
4763 Intel EFI / GPT partition table.
4765 This is recommended for >= 2 TB partitions that will be accessed
4766 from Linux and Intel-based Mac OS X. It also has limited backwards
4767 compatibility with the C<mbr> format.
4769 =item B<mbr> | B<msdos>
4771 The standard PC \"Master Boot Record\" (MBR) format used
4772 by MS-DOS and Windows. This partition type will B<only> work
4773 for device sizes up to 2 TB. For large disks we recommend
4778 Other partition table types that may work but are not
4787 =item B<amiga> | B<rdb>
4789 Amiga \"Rigid Disk Block\" format.
4797 DASD, used on IBM mainframes.
4805 Old Mac partition format. Modern Macs use C<gpt>.
4809 NEC PC-98 format, common in Japan apparently.
4817 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4818 [InitEmpty, Always, TestRun (
4819 [["part_init"; "/dev/sda"; "mbr"];
4820 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4821 InitEmpty, Always, TestRun (
4822 [["part_init"; "/dev/sda"; "gpt"];
4823 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4824 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4825 InitEmpty, Always, TestRun (
4826 [["part_init"; "/dev/sda"; "mbr"];
4827 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4828 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4829 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4830 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4831 "add a partition to the device",
4833 This command adds a partition to C<device>. If there is no partition
4834 table on the device, call C<guestfs_part_init> first.
4836 The C<prlogex> parameter is the type of partition. Normally you
4837 should pass C<p> or C<primary> here, but MBR partition tables also
4838 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4841 C<startsect> and C<endsect> are the start and end of the partition
4842 in I<sectors>. C<endsect> may be negative, which means it counts
4843 backwards from the end of the disk (C<-1> is the last sector).
4845 Creating a partition which covers the whole disk is not so easy.
4846 Use C<guestfs_part_disk> to do that.");
4848 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4849 [InitEmpty, Always, TestRun (
4850 [["part_disk"; "/dev/sda"; "mbr"]]);
4851 InitEmpty, Always, TestRun (
4852 [["part_disk"; "/dev/sda"; "gpt"]])],
4853 "partition whole disk with a single primary partition",
4855 This command is simply a combination of C<guestfs_part_init>
4856 followed by C<guestfs_part_add> to create a single primary partition
4857 covering the whole disk.
4859 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4860 but other possible values are described in C<guestfs_part_init>.");
4862 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4863 [InitEmpty, Always, TestRun (
4864 [["part_disk"; "/dev/sda"; "mbr"];
4865 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4866 "make a partition bootable",
4868 This sets the bootable flag on partition numbered C<partnum> on
4869 device C<device>. Note that partitions are numbered from 1.
4871 The bootable flag is used by some operating systems (notably
4872 Windows) to determine which partition to boot from. It is by
4873 no means universally recognized.");
4875 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4876 [InitEmpty, Always, TestRun (
4877 [["part_disk"; "/dev/sda"; "gpt"];
4878 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4879 "set partition name",
4881 This sets the partition name on partition numbered C<partnum> on
4882 device C<device>. Note that partitions are numbered from 1.
4884 The partition name can only be set on certain types of partition
4885 table. This works on C<gpt> but not on C<mbr> partitions.");
4887 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4888 [], (* XXX Add a regression test for this. *)
4889 "list partitions on a device",
4891 This command parses the partition table on C<device> and
4892 returns the list of partitions found.
4894 The fields in the returned structure are:
4900 Partition number, counting from 1.
4904 Start of the partition I<in bytes>. To get sectors you have to
4905 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4909 End of the partition in bytes.
4913 Size of the partition in bytes.
4917 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4918 [InitEmpty, Always, TestOutput (
4919 [["part_disk"; "/dev/sda"; "gpt"];
4920 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4921 "get the partition table type",
4923 This command examines the partition table on C<device> and
4924 returns the partition table type (format) being used.
4926 Common return values include: C<msdos> (a DOS/Windows style MBR
4927 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4928 values are possible, although unusual. See C<guestfs_part_init>
4931 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4932 [InitScratchFS, Always, TestOutputBuffer (
4933 [["fill"; "0x63"; "10"; "/fill"];
4934 ["read_file"; "/fill"]], "cccccccccc")],
4935 "fill a file with octets",
4937 This command creates a new file called C<path>. The initial
4938 content of the file is C<len> octets of C<c>, where C<c>
4939 must be a number in the range C<[0..255]>.
4941 To fill a file with zero bytes (sparsely), it is
4942 much more efficient to use C<guestfs_truncate_size>.
4943 To create a file with a pattern of repeating bytes
4944 use C<guestfs_fill_pattern>.");
4946 ("available", (RErr, [StringList "groups"], []), 216, [],
4947 [InitNone, Always, TestRun [["available"; ""]]],
4948 "test availability of some parts of the API",
4950 This command is used to check the availability of some
4951 groups of functionality in the appliance, which not all builds of
4952 the libguestfs appliance will be able to provide.
4954 The libguestfs groups, and the functions that those
4955 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4956 You can also fetch this list at runtime by calling
4957 C<guestfs_available_all_groups>.
4959 The argument C<groups> is a list of group names, eg:
4960 C<[\"inotify\", \"augeas\"]> would check for the availability of
4961 the Linux inotify functions and Augeas (configuration file
4964 The command returns no error if I<all> requested groups are available.
4966 It fails with an error if one or more of the requested
4967 groups is unavailable in the appliance.
4969 If an unknown group name is included in the
4970 list of groups then an error is always returned.
4978 You must call C<guestfs_launch> before calling this function.
4980 The reason is because we don't know what groups are
4981 supported by the appliance/daemon until it is running and can
4986 If a group of functions is available, this does not necessarily
4987 mean that they will work. You still have to check for errors
4988 when calling individual API functions even if they are
4993 It is usually the job of distro packagers to build
4994 complete functionality into the libguestfs appliance.
4995 Upstream libguestfs, if built from source with all
4996 requirements satisfied, will support everything.
5000 This call was added in version C<1.0.80>. In previous
5001 versions of libguestfs all you could do would be to speculatively
5002 execute a command to find out if the daemon implemented it.
5003 See also C<guestfs_version>.
5007 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5008 [InitScratchFS, Always, TestOutputBuffer (
5010 ["write"; "/dd/src"; "hello, world"];
5011 ["dd"; "/dd/src"; "/dd/dest"];
5012 ["read_file"; "/dd/dest"]], "hello, world")],
5013 "copy from source to destination using dd",
5015 This command copies from one source device or file C<src>
5016 to another destination device or file C<dest>. Normally you
5017 would use this to copy to or from a device or partition, for
5018 example to duplicate a filesystem.
5020 If the destination is a device, it must be as large or larger
5021 than the source file or device, otherwise the copy will fail.
5022 This command cannot do partial copies (see C<guestfs_copy_size>).");
5024 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5025 [InitScratchFS, Always, TestOutputInt (
5026 [["write"; "/filesize"; "hello, world"];
5027 ["filesize"; "/filesize"]], 12)],
5028 "return the size of the file in bytes",
5030 This command returns the size of C<file> in bytes.
5032 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5033 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5034 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5036 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5037 [InitBasicFSonLVM, Always, TestOutputList (
5038 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5039 ["lvs"]], ["/dev/VG/LV2"])],
5040 "rename an LVM logical volume",
5042 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5044 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5045 [InitBasicFSonLVM, Always, TestOutputList (
5047 ["vg_activate"; "false"; "VG"];
5048 ["vgrename"; "VG"; "VG2"];
5049 ["vg_activate"; "true"; "VG2"];
5050 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5051 ["vgs"]], ["VG2"])],
5052 "rename an LVM volume group",
5054 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5056 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5057 [InitISOFS, Always, TestOutputBuffer (
5058 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5059 "list the contents of a single file in an initrd",
5061 This command unpacks the file C<filename> from the initrd file
5062 called C<initrdpath>. The filename must be given I<without> the
5063 initial C</> character.
5065 For example, in guestfish you could use the following command
5066 to examine the boot script (usually called C</init>)
5067 contained in a Linux initrd or initramfs image:
5069 initrd-cat /boot/initrd-<version>.img init
5071 See also C<guestfs_initrd_list>.");
5073 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5075 "get the UUID of a physical volume",
5077 This command returns the UUID of the LVM PV C<device>.");
5079 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5081 "get the UUID of a volume group",
5083 This command returns the UUID of the LVM VG named C<vgname>.");
5085 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5087 "get the UUID of a logical volume",
5089 This command returns the UUID of the LVM LV C<device>.");
5091 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5093 "get the PV UUIDs containing the volume group",
5095 Given a VG called C<vgname>, this returns the UUIDs of all
5096 the physical volumes that this volume group resides on.
5098 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5099 calls to associate physical volumes and volume groups.
5101 See also C<guestfs_vglvuuids>.");
5103 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5105 "get the LV UUIDs of all LVs in the volume group",
5107 Given a VG called C<vgname>, this returns the UUIDs of all
5108 the logical volumes created in this volume group.
5110 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5111 calls to associate logical volumes and volume groups.
5113 See also C<guestfs_vgpvuuids>.");
5115 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5116 [InitScratchFS, Always, TestOutputBuffer (
5117 [["mkdir"; "/copy_size"];
5118 ["write"; "/copy_size/src"; "hello, world"];
5119 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5120 ["read_file"; "/copy_size/dest"]], "hello")],
5121 "copy size bytes from source to destination using dd",
5123 This command copies exactly C<size> bytes from one source device
5124 or file C<src> to another destination device or file C<dest>.
5126 Note this will fail if the source is too short or if the destination
5127 is not large enough.");
5129 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5130 [InitBasicFSonLVM, Always, TestRun (
5131 [["zero_device"; "/dev/VG/LV"]])],
5132 "write zeroes to an entire device",
5134 This command writes zeroes over the entire C<device>. Compare
5135 with C<guestfs_zero> which just zeroes the first few blocks of
5138 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5139 [InitScratchFS, Always, TestOutput (
5140 [["mkdir"; "/txz_in"];
5141 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5142 ["cat"; "/txz_in/hello"]], "hello\n")],
5143 "unpack compressed tarball to directory",
5145 This command uploads and unpacks local file C<tarball> (an
5146 I<xz compressed> tar file) into C<directory>.");
5148 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5150 "pack directory into compressed tarball",
5152 This command packs the contents of C<directory> and downloads
5153 it to local file C<tarball> (as an xz compressed tar archive).");
5155 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5157 "resize an NTFS filesystem",
5159 This command resizes an NTFS filesystem, expanding or
5160 shrinking it to the size of the underlying device.
5161 See also L<ntfsresize(8)>.");
5163 ("vgscan", (RErr, [], []), 232, [],
5164 [InitEmpty, Always, TestRun (
5166 "rescan for LVM physical volumes, volume groups and logical volumes",
5168 This rescans all block devices and rebuilds the list of LVM
5169 physical volumes, volume groups and logical volumes.");
5171 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5172 [InitEmpty, Always, TestRun (
5173 [["part_init"; "/dev/sda"; "mbr"];
5174 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5175 ["part_del"; "/dev/sda"; "1"]])],
5176 "delete a partition",
5178 This command deletes the partition numbered C<partnum> on C<device>.
5180 Note that in the case of MBR partitioning, deleting an
5181 extended partition also deletes any logical partitions
5184 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5185 [InitEmpty, Always, TestOutputTrue (
5186 [["part_init"; "/dev/sda"; "mbr"];
5187 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5188 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5189 ["part_get_bootable"; "/dev/sda"; "1"]])],
5190 "return true if a partition is bootable",
5192 This command returns true if the partition C<partnum> on
5193 C<device> has the bootable flag set.
5195 See also C<guestfs_part_set_bootable>.");
5197 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5198 [InitEmpty, Always, TestOutputInt (
5199 [["part_init"; "/dev/sda"; "mbr"];
5200 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5201 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5202 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5203 "get the MBR type byte (ID byte) from a partition",
5205 Returns the MBR type byte (also known as the ID byte) from
5206 the numbered partition C<partnum>.
5208 Note that only MBR (old DOS-style) partitions have type bytes.
5209 You will get undefined results for other partition table
5210 types (see C<guestfs_part_get_parttype>).");
5212 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5213 [], (* tested by part_get_mbr_id *)
5214 "set the MBR type byte (ID byte) of a partition",
5216 Sets the MBR type byte (also known as the ID byte) of
5217 the numbered partition C<partnum> to C<idbyte>. Note
5218 that the type bytes quoted in most documentation are
5219 in fact hexadecimal numbers, but usually documented
5220 without any leading \"0x\" which might be confusing.
5222 Note that only MBR (old DOS-style) partitions have type bytes.
5223 You will get undefined results for other partition table
5224 types (see C<guestfs_part_get_parttype>).");
5226 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5227 [InitISOFS, Always, TestOutputFileMD5 (
5228 [["checksum_device"; "md5"; "/dev/sdd"]],
5229 "../images/test.iso")],
5230 "compute MD5, SHAx or CRC checksum of the contents of a device",
5232 This call computes the MD5, SHAx or CRC checksum of the
5233 contents of the device named C<device>. For the types of
5234 checksums supported see the C<guestfs_checksum> command.");
5236 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5237 [InitNone, Always, TestRun (
5238 [["part_disk"; "/dev/sda"; "mbr"];
5239 ["pvcreate"; "/dev/sda1"];
5240 ["vgcreate"; "VG"; "/dev/sda1"];
5241 ["lvcreate"; "LV"; "VG"; "10"];
5242 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5243 "expand an LV to fill free space",
5245 This expands an existing logical volume C<lv> so that it fills
5246 C<pc>% of the remaining free space in the volume group. Commonly
5247 you would call this with pc = 100 which expands the logical volume
5248 as much as possible, using all remaining free space in the volume
5251 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5252 [], (* XXX Augeas code needs tests. *)
5253 "clear Augeas path",
5255 Set the value associated with C<path> to C<NULL>. This
5256 is the same as the L<augtool(1)> C<clear> command.");
5258 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5259 [InitEmpty, Always, TestOutputInt (
5260 [["get_umask"]], 0o22)],
5261 "get the current umask",
5263 Return the current umask. By default the umask is C<022>
5264 unless it has been set by calling C<guestfs_umask>.");
5266 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5268 "upload a file to the appliance (internal use only)",
5270 The C<guestfs_debug_upload> command uploads a file to
5271 the libguestfs appliance.
5273 There is no comprehensive help for this command. You have
5274 to look at the file C<daemon/debug.c> in the libguestfs source
5275 to find out what it is for.");
5277 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5278 [InitScratchFS, Always, TestOutput (
5279 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5280 ["cat"; "/base64_in"]], "hello\n")],
5281 "upload base64-encoded data to file",
5283 This command uploads base64-encoded data from C<base64file>
5286 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5288 "download file and encode as base64",
5290 This command downloads the contents of C<filename>, writing
5291 it out to local file C<base64file> encoded as base64.");
5293 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5295 "compute MD5, SHAx or CRC checksum of files in a directory",
5297 This command computes the checksums of all regular files in
5298 C<directory> and then emits a list of those checksums to
5299 the local output file C<sumsfile>.
5301 This can be used for verifying the integrity of a virtual
5302 machine. However to be properly secure you should pay
5303 attention to the output of the checksum command (it uses
5304 the ones from GNU coreutils). In particular when the
5305 filename is not printable, coreutils uses a special
5306 backslash syntax. For more information, see the GNU
5307 coreutils info file.");
5309 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5310 [InitScratchFS, Always, TestOutputBuffer (
5311 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5312 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5313 "fill a file with a repeating pattern of bytes",
5315 This function is like C<guestfs_fill> except that it creates
5316 a new file of length C<len> containing the repeating pattern
5317 of bytes in C<pattern>. The pattern is truncated if necessary
5318 to ensure the length of the file is exactly C<len> bytes.");
5320 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5321 [InitScratchFS, Always, TestOutput (
5322 [["write"; "/write"; "new file contents"];
5323 ["cat"; "/write"]], "new file contents");
5324 InitScratchFS, Always, TestOutput (
5325 [["write"; "/write2"; "\nnew file contents\n"];
5326 ["cat"; "/write2"]], "\nnew file contents\n");
5327 InitScratchFS, Always, TestOutput (
5328 [["write"; "/write3"; "\n\n"];
5329 ["cat"; "/write3"]], "\n\n");
5330 InitScratchFS, Always, TestOutput (
5331 [["write"; "/write4"; ""];
5332 ["cat"; "/write4"]], "");
5333 InitScratchFS, Always, TestOutput (
5334 [["write"; "/write5"; "\n\n\n"];
5335 ["cat"; "/write5"]], "\n\n\n");
5336 InitScratchFS, Always, TestOutput (
5337 [["write"; "/write6"; "\n"];
5338 ["cat"; "/write6"]], "\n")],
5339 "create a new file",
5341 This call creates a file called C<path>. The content of the
5342 file is the string C<content> (which can contain any 8 bit data).");
5344 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5345 [InitScratchFS, Always, TestOutput (
5346 [["write"; "/pwrite"; "new file contents"];
5347 ["pwrite"; "/pwrite"; "data"; "4"];
5348 ["cat"; "/pwrite"]], "new data contents");
5349 InitScratchFS, Always, TestOutput (
5350 [["write"; "/pwrite2"; "new file contents"];
5351 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5352 ["cat"; "/pwrite2"]], "new file is extended");
5353 InitScratchFS, Always, TestOutput (
5354 [["write"; "/pwrite3"; "new file contents"];
5355 ["pwrite"; "/pwrite3"; ""; "4"];
5356 ["cat"; "/pwrite3"]], "new file contents")],
5357 "write to part of a file",
5359 This command writes to part of a file. It writes the data
5360 buffer C<content> to the file C<path> starting at offset C<offset>.
5362 This command implements the L<pwrite(2)> system call, and like
5363 that system call it may not write the full data requested. The
5364 return value is the number of bytes that were actually written
5365 to the file. This could even be 0, although short writes are
5366 unlikely for regular files in ordinary circumstances.
5368 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5370 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5372 "resize an ext2, ext3 or ext4 filesystem (with size)",
5374 This command is the same as C<guestfs_resize2fs> except that it
5375 allows you to specify the new size (in bytes) explicitly.");
5377 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5379 "resize an LVM physical volume (with size)",
5381 This command is the same as C<guestfs_pvresize> except that it
5382 allows you to specify the new size (in bytes) explicitly.");
5384 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5386 "resize an NTFS filesystem (with size)",
5388 This command is the same as C<guestfs_ntfsresize> except that it
5389 allows you to specify the new size (in bytes) explicitly.");
5391 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5392 [InitNone, Always, TestRun [["available_all_groups"]]],
5393 "return a list of all optional groups",
5395 This command returns a list of all optional groups that this
5396 daemon knows about. Note this returns both supported and unsupported
5397 groups. To find out which ones the daemon can actually support
5398 you have to call C<guestfs_available> on each member of the
5401 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5403 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5404 [InitScratchFS, Always, TestOutputStruct (
5405 [["fallocate64"; "/fallocate64"; "1000000"];
5406 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5407 "preallocate a file in the guest filesystem",
5409 This command preallocates a file (containing zero bytes) named
5410 C<path> of size C<len> bytes. If the file exists already, it
5413 Note that this call allocates disk blocks for the file.
5414 To create a sparse file use C<guestfs_truncate_size> instead.
5416 The deprecated call C<guestfs_fallocate> does the same,
5417 but owing to an oversight it only allowed 30 bit lengths
5418 to be specified, effectively limiting the maximum size
5419 of files created through that call to 1GB.
5421 Do not confuse this with the guestfish-specific
5422 C<alloc> and C<sparse> commands which create
5423 a file in the host and attach it as a device.");
5425 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5426 [InitBasicFS, Always, TestOutput (
5427 [["set_e2label"; "/dev/sda1"; "LTEST"];
5428 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5429 "get the filesystem label",
5431 This returns the filesystem label of the filesystem on
5434 If the filesystem is unlabeled, this returns the empty string.
5436 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5438 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5439 (let uuid = uuidgen () in
5440 [InitBasicFS, Always, TestOutput (
5441 [["set_e2uuid"; "/dev/sda1"; uuid];
5442 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5443 "get the filesystem UUID",
5445 This returns the filesystem UUID of the filesystem on
5448 If the filesystem does not have a UUID, this returns the empty string.
5450 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5452 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5453 (* Can't be tested with the current framework because
5454 * the VG is being used by the mounted filesystem, so
5455 * the vgchange -an command we do first will fail.
5458 "set LVM device filter",
5460 This sets the LVM device filter so that LVM will only be
5461 able to \"see\" the block devices in the list C<devices>,
5462 and will ignore all other attached block devices.
5464 Where disk image(s) contain duplicate PVs or VGs, this
5465 command is useful to get LVM to ignore the duplicates, otherwise
5466 LVM can get confused. Note also there are two types
5467 of duplication possible: either cloned PVs/VGs which have
5468 identical UUIDs; or VGs that are not cloned but just happen
5469 to have the same name. In normal operation you cannot
5470 create this situation, but you can do it outside LVM, eg.
5471 by cloning disk images or by bit twiddling inside the LVM
5474 This command also clears the LVM cache and performs a volume
5477 You can filter whole block devices or individual partitions.
5479 You cannot use this if any VG is currently in use (eg.
5480 contains a mounted filesystem), even if you are not
5481 filtering out that VG.");
5483 ("lvm_clear_filter", (RErr, [], []), 256, [],
5484 [], (* see note on lvm_set_filter *)
5485 "clear LVM device filter",
5487 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5488 will be able to see every block device.
5490 This command also clears the LVM cache and performs a volume
5493 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5495 "open a LUKS-encrypted block device",
5497 This command opens a block device which has been encrypted
5498 according to the Linux Unified Key Setup (LUKS) standard.
5500 C<device> is the encrypted block device or partition.
5502 The caller must supply one of the keys associated with the
5503 LUKS block device, in the C<key> parameter.
5505 This creates a new block device called C</dev/mapper/mapname>.
5506 Reads and writes to this block device are decrypted from and
5507 encrypted to the underlying C<device> respectively.
5509 If this block device contains LVM volume groups, then
5510 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5511 will make them visible.");
5513 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5515 "open a LUKS-encrypted block device read-only",
5517 This is the same as C<guestfs_luks_open> except that a read-only
5518 mapping is created.");
5520 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5522 "close a LUKS device",
5524 This closes a LUKS device that was created earlier by
5525 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5526 C<device> parameter must be the name of the LUKS mapping
5527 device (ie. C</dev/mapper/mapname>) and I<not> the name
5528 of the underlying block device.");
5530 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5532 "format a block device as a LUKS encrypted device",
5534 This command erases existing data on C<device> and formats
5535 the device as a LUKS encrypted device. C<key> is the
5536 initial key, which is added to key slot C<slot>. (LUKS
5537 supports 8 key slots, numbered 0-7).");
5539 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5541 "format a block device as a LUKS encrypted device",
5543 This command is the same as C<guestfs_luks_format> but
5544 it also allows you to set the C<cipher> used.");
5546 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5548 "add a key on a LUKS encrypted device",
5550 This command adds a new key on LUKS device C<device>.
5551 C<key> is any existing key, and is used to access the device.
5552 C<newkey> is the new key to add. C<keyslot> is the key slot
5553 that will be replaced.
5555 Note that if C<keyslot> already contains a key, then this
5556 command will fail. You have to use C<guestfs_luks_kill_slot>
5557 first to remove that key.");
5559 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5561 "remove a key from a LUKS encrypted device",
5563 This command deletes the key in key slot C<keyslot> from the
5564 encrypted LUKS device C<device>. C<key> must be one of the
5567 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5568 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5569 [["is_lv"; "/dev/VG/LV"]]);
5570 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5571 [["is_lv"; "/dev/sda1"]])],
5572 "test if device is a logical volume",
5574 This command tests whether C<device> is a logical volume, and
5575 returns true iff this is the case.");
5577 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5579 "find a filesystem by UUID",
5581 This command searches the filesystems and returns the one
5582 which has the given UUID. An error is returned if no such
5583 filesystem can be found.
5585 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5587 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5589 "find a filesystem by label",
5591 This command searches the filesystems and returns the one
5592 which has the given label. An error is returned if no such
5593 filesystem can be found.
5595 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5597 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5598 [InitISOFS, Always, TestOutputFalse (
5599 [["is_chardev"; "/directory"]]);
5600 InitScratchFS, Always, TestOutputTrue (
5601 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5602 ["is_chardev"; "/is_chardev"]])],
5603 "test if character device",
5605 This returns C<true> if and only if there is a character device
5606 with the given C<path> name.
5608 See also C<guestfs_stat>.");
5610 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5611 [InitISOFS, Always, TestOutputFalse (
5612 [["is_blockdev"; "/directory"]]);
5613 InitScratchFS, Always, TestOutputTrue (
5614 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5615 ["is_blockdev"; "/is_blockdev"]])],
5616 "test if block device",
5618 This returns C<true> if and only if there is a block device
5619 with the given C<path> name.
5621 See also C<guestfs_stat>.");
5623 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5624 [InitISOFS, Always, TestOutputFalse (
5625 [["is_fifo"; "/directory"]]);
5626 InitScratchFS, Always, TestOutputTrue (
5627 [["mkfifo"; "0o777"; "/is_fifo"];
5628 ["is_fifo"; "/is_fifo"]])],
5629 "test if FIFO (named pipe)",
5631 This returns C<true> if and only if there is a FIFO (named pipe)
5632 with the given C<path> name.
5634 See also C<guestfs_stat>.");
5636 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5637 [InitISOFS, Always, TestOutputFalse (
5638 [["is_symlink"; "/directory"]]);
5639 InitISOFS, Always, TestOutputTrue (
5640 [["is_symlink"; "/abssymlink"]])],
5641 "test if symbolic link",
5643 This returns C<true> if and only if there is a symbolic link
5644 with the given C<path> name.
5646 See also C<guestfs_stat>.");
5648 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5649 (* XXX Need a positive test for sockets. *)
5650 [InitISOFS, Always, TestOutputFalse (
5651 [["is_socket"; "/directory"]])],
5654 This returns C<true> if and only if there is a Unix domain socket
5655 with the given C<path> name.
5657 See also C<guestfs_stat>.");
5659 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5660 [InitPartition, Always, TestOutputDevice (
5661 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5662 InitEmpty, Always, TestLastFail (
5663 [["part_to_dev"; "/dev/sda"]])],
5664 "convert partition name to device name",
5666 This function takes a partition name (eg. \"/dev/sdb1\") and
5667 removes the partition number, returning the device name
5670 The named partition must exist, for example as a string returned
5671 from C<guestfs_list_partitions>.");
5673 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5674 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5675 [InitScratchFS, Always, TestOutput (
5676 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5677 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5678 "upload a file from the local machine with offset",
5680 Upload local file C<filename> to C<remotefilename> on the
5683 C<remotefilename> is overwritten starting at the byte C<offset>
5684 specified. The intention is to overwrite parts of existing
5685 files or devices, although if a non-existant file is specified
5686 then it is created with a \"hole\" before C<offset>. The
5687 size of the data written is implicit in the size of the
5690 Note that there is no limit on the amount of data that
5691 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5692 and this call always writes the full amount unless an
5695 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5697 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5698 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5699 let offset = string_of_int 100 in
5700 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5701 [InitScratchFS, Always, TestOutput (
5702 (* Pick a file from cwd which isn't likely to change. *)
5703 [["mkdir"; "/download_offset"];
5704 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5705 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5706 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5707 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5708 "download a file to the local machine with offset and size",
5710 Download file C<remotefilename> and save it as C<filename>
5711 on the local machine.
5713 C<remotefilename> is read for C<size> bytes starting at C<offset>
5714 (this region must be within the file or device).
5716 Note that there is no limit on the amount of data that
5717 can be downloaded with this call, unlike with C<guestfs_pread>,
5718 and this call always reads the full amount unless an
5721 See also C<guestfs_download>, C<guestfs_pread>.");
5723 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5724 [InitPartition, Always, TestOutputListOfDevices (
5725 [["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"];
5726 ["blockdev_rereadpt"; "/dev/sda"];
5727 ["list_partitions"]], ["/dev/sdb1"])],
5728 "write to part of a device",
5730 This command writes to part of a device. It writes the data
5731 buffer C<content> to C<device> starting at offset C<offset>.
5733 This command implements the L<pwrite(2)> system call, and like
5734 that system call it may not write the full data requested
5735 (although short writes to disk devices and partitions are
5736 probably impossible with standard Linux kernels).
5738 See also C<guestfs_pwrite>.");
5740 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5741 [InitEmpty, Always, TestOutputBuffer (
5742 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5743 "read part of a device",
5745 This command lets you read part of a file. It reads C<count>
5746 bytes of C<device>, starting at C<offset>.
5748 This may read fewer bytes than requested. For further details
5749 see the L<pread(2)> system call.
5751 See also C<guestfs_pread>.");
5753 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5754 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5755 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5756 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5757 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5758 "get canonical name of an LV",
5760 This converts alternative naming schemes for LVs that you
5761 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5762 is converted to C</dev/VG/LV>.
5764 This command returns an error if the C<lvname> parameter does
5765 not refer to a logical volume.
5767 See also C<guestfs_is_lv>.");
5769 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5770 [InitEmpty, Always, TestOutput (
5771 [["part_disk"; "/dev/sda"; "mbr"];
5772 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5773 ["mount_options"; ""; "/dev/sda1"; "/"];
5774 ["write"; "/new"; "new file contents"];
5775 ["cat"; "/new"]], "new file contents")],
5776 "make a filesystem",
5778 This function creates a filesystem on C<device>. The filesystem
5779 type is C<fstype>, for example C<ext3>.
5781 The optional arguments are:
5787 The filesystem block size. Supported block sizes depend on the
5788 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5789 for Linux ext2/3 filesystems.
5791 For VFAT and NTFS the C<blocksize> parameter is treated as
5792 the requested cluster size.
5794 For UFS block sizes, please see L<mkfs.ufs(8)>.
5798 This passes the C<-O> parameter to the external mkfs program.
5800 For certain filesystem types, this allows extra filesystem
5801 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5804 You cannot use this optional parameter with the C<gfs> or
5805 C<gfs2> filesystem type.
5809 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5811 "get a single extended attribute",
5813 Get a single extended attribute from file C<path> named C<name>.
5814 This call follows symlinks. If you want to lookup an extended
5815 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5817 Normally it is better to get all extended attributes from a file
5818 in one go by calling C<guestfs_getxattrs>. However some Linux
5819 filesystem implementations are buggy and do not provide a way to
5820 list out attributes. For these filesystems (notably ntfs-3g)
5821 you have to know the names of the extended attributes you want
5822 in advance and call this function.
5824 Extended attribute values are blobs of binary data. If there
5825 is no extended attribute named C<name>, this returns an error.
5827 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5829 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5831 "get a single extended attribute",
5833 Get a single extended attribute from file C<path> named C<name>.
5834 If C<path> is a symlink, then this call returns an extended
5835 attribute from the symlink.
5837 Normally it is better to get all extended attributes from a file
5838 in one go by calling C<guestfs_getxattrs>. However some Linux
5839 filesystem implementations are buggy and do not provide a way to
5840 list out attributes. For these filesystems (notably ntfs-3g)
5841 you have to know the names of the extended attributes you want
5842 in advance and call this function.
5844 Extended attribute values are blobs of binary data. If there
5845 is no extended attribute named C<name>, this returns an error.
5847 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5849 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5851 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5853 This command is the same as C<guestfs_resize2fs>, but the filesystem
5854 is resized to its minimum size. This works like the C<-M> option
5855 to the C<resize2fs> command.
5857 To get the resulting size of the filesystem you should call
5858 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5859 values. These two numbers, multiplied together, give the
5860 resulting size of the minimal filesystem in bytes.");
5862 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5864 "internal autosync operation",
5866 This command performs the autosync operation just before the
5867 handle is closed. You should not call this command directly.
5868 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5869 control whether or not this operation is performed when the
5870 handle is closed.");
5874 let all_functions = non_daemon_functions @ daemon_functions
5876 (* In some places we want the functions to be displayed sorted
5877 * alphabetically, so this is useful:
5879 let all_functions_sorted = List.sort action_compare all_functions
5881 (* This is used to generate the src/MAX_PROC_NR file which
5882 * contains the maximum procedure number, a surrogate for the
5883 * ABI version number. See src/Makefile.am for the details.
5886 let proc_nrs = List.map (
5887 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5888 ) daemon_functions in
5889 List.fold_left max 0 proc_nrs
5891 (* Non-API meta-commands available only in guestfish.
5893 * Note (1): style, proc_nr and tests fields are all meaningless.
5894 * The only fields which are actually used are the shortname,
5895 * FishAlias flags, shortdesc and longdesc.
5897 * Note (2): to refer to other commands, use L</shortname>.
5899 * Note (3): keep this list sorted by shortname.
5901 let fish_commands = [
5902 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5903 "allocate and add a disk file",
5904 " alloc filename size
5906 This creates an empty (zeroed) file of the given size, and then adds
5907 so it can be further examined.
5909 For more advanced image creation, see L<qemu-img(1)> utility.
5911 Size can be specified using standard suffixes, eg. C<1M>.
5913 To create a sparse file, use L</sparse> instead. To create a
5914 prepared disk image, see L</PREPARED DISK IMAGES>.");
5916 ("copy_in", (RErr,[], []), -1, [], [],
5917 "copy local files or directories into an image",
5918 " copy-in local [local ...] /remotedir
5920 C<copy-in> copies local files or directories recursively into the disk
5921 image, placing them in the directory called C</remotedir> (which must
5922 exist). This guestfish meta-command turns into a sequence of
5923 L</tar-in> and other commands as necessary.
5925 Multiple local files and directories can be specified, but the last
5926 parameter must always be a remote directory. Wildcards cannot be
5929 ("copy_out", (RErr,[], []), -1, [], [],
5930 "copy remote files or directories out of an image",
5931 " copy-out remote [remote ...] localdir
5933 C<copy-out> copies remote files or directories recursively out of the
5934 disk image, placing them on the host disk in a local directory called
5935 C<localdir> (which must exist). This guestfish meta-command turns
5936 into a sequence of L</download>, L</tar-out> and other commands as
5939 Multiple remote files and directories can be specified, but the last
5940 parameter must always be a local directory. To download to the
5941 current directory, use C<.> as in:
5945 Wildcards cannot be used in the ordinary command, but you can use
5946 them with the help of L</glob> like this:
5948 glob copy-out /home/* .");
5950 ("echo", (RErr,[], []), -1, [], [],
5951 "display a line of text",
5954 This echos the parameters to the terminal.");
5956 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
5960 This is used to edit a file. It downloads the file, edits it
5961 locally using your editor, then uploads the result.
5963 The editor is C<$EDITOR>. However if you use the alternate
5964 commands C<vi> or C<emacs> you will get those corresponding
5967 ("glob", (RErr,[], []), -1, [], [],
5968 "expand wildcards in command",
5969 " glob command args...
5971 Expand wildcards in any paths in the args list, and run C<command>
5972 repeatedly on each matching path.
5974 See L</WILDCARDS AND GLOBBING>.");
5976 ("hexedit", (RErr,[], []), -1, [], [],
5977 "edit with a hex editor",
5978 " hexedit <filename|device>
5979 hexedit <filename|device> <max>
5980 hexedit <filename|device> <start> <max>
5982 Use hexedit (a hex editor) to edit all or part of a binary file
5985 This command works by downloading potentially the whole file or
5986 device, editing it locally, then uploading it. If the file or
5987 device is large, you have to specify which part you wish to edit
5988 by using C<max> and/or C<start> C<max> parameters.
5989 C<start> and C<max> are specified in bytes, with the usual
5990 modifiers allowed such as C<1M> (1 megabyte).
5992 For example to edit the first few sectors of a disk you
5997 which would allow you to edit anywhere within the first megabyte
6000 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6002 hexedit /dev/sda1 0x400 0x400
6004 (assuming the superblock is in the standard location).
6006 This command requires the external L<hexedit(1)> program. You
6007 can specify another program to use by setting the C<HEXEDITOR>
6008 environment variable.
6010 See also L</hexdump>.");
6012 ("lcd", (RErr,[], []), -1, [], [],
6013 "change working directory",
6016 Change the local directory, ie. the current directory of guestfish
6019 Note that C<!cd> won't do what you might expect.");
6021 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6025 Opens the manual page for guestfish.");
6027 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6033 This is used to view a file.
6035 The default viewer is C<$PAGER>. However if you use the alternate
6036 command C<less> you will get the C<less> command specifically.");
6038 ("reopen", (RErr,[], []), -1, [], [],
6039 "close and reopen libguestfs handle",
6042 Close and reopen the libguestfs handle. It is not necessary to use
6043 this normally, because the handle is closed properly when guestfish
6044 exits. However this is occasionally useful for testing.");
6046 ("sparse", (RErr,[], []), -1, [], [],
6047 "create a sparse disk image and add",
6048 " sparse filename size
6050 This creates an empty sparse file of the given size, and then adds
6051 so it can be further examined.
6053 In all respects it works the same as the L</alloc> command, except that
6054 the image file is allocated sparsely, which means that disk blocks are
6055 not assigned to the file until they are needed. Sparse disk files
6056 only use space when written to, but they are slower and there is a
6057 danger you could run out of real disk space during a write operation.
6059 For more advanced image creation, see L<qemu-img(1)> utility.
6061 Size can be specified using standard suffixes, eg. C<1M>.");
6063 ("supported", (RErr,[], []), -1, [], [],
6064 "list supported groups of commands",
6067 This command returns a list of the optional groups
6068 known to the daemon, and indicates which ones are
6069 supported by this build of the libguestfs appliance.
6071 See also L<guestfs(3)/AVAILABILITY>.");
6073 ("time", (RErr,[], []), -1, [], [],
6074 "print elapsed time taken to run a command",
6075 " time command args...
6077 Run the command as usual, but print the elapsed time afterwards. This
6078 can be useful for benchmarking operations.");