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"; Progress],
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 I<-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 I<-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:
826 =item \"redhat-based\"
828 Some Red Hat-derived distro.
832 Red Hat Enterprise Linux.
834 =item \"scientificlinux\"
848 The distro could not be determined.
852 Windows does not have distributions. This string is
853 returned if the OS type is Windows.
857 Future versions of libguestfs may return other strings here.
858 The caller should be prepared to handle any string.
860 Please read L<guestfs(3)/INSPECTION> for more details.");
862 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
864 "get major version of inspected operating system",
866 This function should only be called with a root device string
867 as returned by C<guestfs_inspect_os>.
869 This returns the major version number of the inspected operating
872 Windows uses a consistent versioning scheme which is I<not>
873 reflected in the popular public names used by the operating system.
874 Notably the operating system known as \"Windows 7\" is really
875 version 6.1 (ie. major = 6, minor = 1). You can find out the
876 real versions corresponding to releases of Windows by consulting
879 If the version could not be determined, then C<0> is returned.
881 Please read L<guestfs(3)/INSPECTION> for more details.");
883 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
885 "get minor version of inspected operating system",
887 This function should only be called with a root device string
888 as returned by C<guestfs_inspect_os>.
890 This returns the minor version number of the inspected operating
893 If the version could not be determined, then C<0> is returned.
895 Please read L<guestfs(3)/INSPECTION> for more details.
896 See also C<guestfs_inspect_get_major_version>.");
898 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
900 "get product name of inspected operating system",
902 This function should only be called with a root device string
903 as returned by C<guestfs_inspect_os>.
905 This returns the product name of the inspected operating
906 system. The product name is generally some freeform string
907 which can be displayed to the user, but should not be
910 If the product name could not be determined, then the
911 string C<unknown> is returned.
913 Please read L<guestfs(3)/INSPECTION> for more details.");
915 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
917 "get mountpoints of inspected operating system",
919 This function should only be called with a root device string
920 as returned by C<guestfs_inspect_os>.
922 This returns a hash of where we think the filesystems
923 associated with this operating system should be mounted.
924 Callers should note that this is at best an educated guess
925 made by reading configuration files such as C</etc/fstab>.
926 I<In particular note> that this may return filesystems
927 which are non-existent or not mountable and callers should
928 be prepared to handle or ignore failures if they try to
931 Each element in the returned hashtable has a key which
932 is the path of the mountpoint (eg. C</boot>) and a value
933 which is the filesystem that would be mounted there
936 Non-mounted devices such as swap devices are I<not>
937 returned in this list.
939 For operating systems like Windows which still use drive
940 letters, this call will only return an entry for the first
941 drive \"mounted on\" C</>. For information about the
942 mapping of drive letters to partitions, see
943 C<guestfs_inspect_get_drive_mappings>.
945 Please read L<guestfs(3)/INSPECTION> for more details.
946 See also C<guestfs_inspect_get_filesystems>.");
948 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
950 "get filesystems associated with inspected operating system",
952 This function should only be called with a root device string
953 as returned by C<guestfs_inspect_os>.
955 This returns a list of all the filesystems that we think
956 are associated with this operating system. This includes
957 the root filesystem, other ordinary filesystems, and
958 non-mounted devices like swap partitions.
960 In the case of a multi-boot virtual machine, it is possible
961 for a filesystem to be shared between operating systems.
963 Please read L<guestfs(3)/INSPECTION> for more details.
964 See also C<guestfs_inspect_get_mountpoints>.");
966 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
968 "set enable network flag",
970 If C<network> is true, then the network is enabled in the
971 libguestfs appliance. The default is false.
973 This affects whether commands are able to access the network
974 (see L<guestfs(3)/RUNNING COMMANDS>).
976 You must call this before calling C<guestfs_launch>, otherwise
979 ("get_network", (RBool "network", [], []), -1, [],
981 "get enable network flag",
983 This returns the enable network flag.");
985 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
989 This inspection command looks for filesystems on partitions,
990 block devices and logical volumes, returning a list of devices
991 containing filesystems and their type.
993 The return value is a hash, where the keys are the devices
994 containing filesystems, and the values are the filesystem types.
997 \"/dev/sda1\" => \"ntfs\"
998 \"/dev/sda2\" => \"ext2\"
999 \"/dev/vg_guest/lv_root\" => \"ext4\"
1000 \"/dev/vg_guest/lv_swap\" => \"swap\"
1002 The value can have the special value \"unknown\", meaning the
1003 content of the device is undetermined or empty.
1004 \"swap\" means a Linux swap partition.
1006 This command runs other libguestfs commands, which might include
1007 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
1008 use this soon after launch and only when nothing is mounted.
1010 Not all of the filesystems returned will be mountable. In
1011 particular, swap partitions are returned in the list. Also
1012 this command does not check that each filesystem
1013 found is valid and mountable, and some filesystems might
1014 be mountable but require special options. Filesystems may
1015 not all belong to a single logical operating system
1016 (use C<guestfs_inspect_os> to look for OSes).");
1018 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
1020 "add an image to examine or modify",
1022 This function adds a virtual machine disk image C<filename> to
1023 libguestfs. The first time you call this function, the disk
1024 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1027 You don't necessarily need to be root when using libguestfs. However
1028 you obviously do need sufficient permissions to access the filename
1029 for whatever operations you want to perform (ie. read access if you
1030 just want to read the image or write access if you want to modify the
1033 This call checks that C<filename> exists.
1035 The optional arguments are:
1041 If true then the image is treated as read-only. Writes are still
1042 allowed, but they are stored in a temporary snapshot overlay which
1043 is discarded at the end. The disk that you add is not modified.
1047 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1048 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1049 Possible formats include C<raw> and C<qcow2>.
1051 Automatic detection of the format opens you up to a potential
1052 security hole when dealing with untrusted raw-format images.
1053 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1058 This rarely-used option lets you emulate the behaviour of the
1059 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1063 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1065 "get Windows systemroot of inspected operating system",
1067 This function should only be called with a root device string
1068 as returned by C<guestfs_inspect_os>.
1070 This returns the Windows systemroot of the inspected guest.
1071 The systemroot is a directory path such as C</WINDOWS>.
1073 This call assumes that the guest is Windows and that the
1074 systemroot could be determined by inspection. If this is not
1075 the case then an error is returned.
1077 Please read L<guestfs(3)/INSPECTION> for more details.");
1079 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1081 "return list of operating systems found by last inspection",
1083 This function is a convenient way to get the list of root
1084 devices, as returned from a previous call to C<guestfs_inspect_os>,
1085 but without redoing the whole inspection process.
1087 This returns an empty list if either no root devices were
1088 found or the caller has not called C<guestfs_inspect_os>.
1090 Please read L<guestfs(3)/INSPECTION> for more details.");
1092 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1094 "debug the QEMU command line (internal use only)",
1096 This returns the internal QEMU command line. 'debug' commands are
1097 not part of the formal API and can be removed or changed at any time.");
1099 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1101 "add the disk(s) from a named libvirt domain",
1103 This function adds the disk(s) attached to the named libvirt
1104 domain C<dom>. It works by connecting to libvirt, requesting
1105 the domain and domain XML from libvirt, parsing it for disks,
1106 and calling C<guestfs_add_drive_opts> on each one.
1108 The number of disks added is returned. This operation is atomic:
1109 if an error is returned, then no disks are added.
1111 This function does some minimal checks to make sure the libvirt
1112 domain is not running (unless C<readonly> is true). In a future
1113 version we will try to acquire the libvirt lock on each disk.
1115 Disks must be accessible locally. This often means that adding disks
1116 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1117 will fail unless those disks are accessible via the same device path
1120 The optional C<libvirturi> parameter sets the libvirt URI
1121 (see L<http://libvirt.org/uri.html>). If this is not set then
1122 we connect to the default libvirt URI (or one set through an
1123 environment variable, see the libvirt documentation for full
1126 The optional C<live> flag controls whether this call will try
1127 to connect to a running virtual machine C<guestfsd> process if
1128 it sees a suitable E<lt>channelE<gt> element in the libvirt
1129 XML definition. The default (if the flag is omitted) is never
1130 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1133 If the C<allowuuid> flag is true (default is false) then a UUID
1134 I<may> be passed instead of the domain name. The C<dom> string is
1135 treated as a UUID first and looked up, and if that lookup fails
1136 then we treat C<dom> as a name as usual.
1138 The other optional parameters are passed directly through to
1139 C<guestfs_add_drive_opts>.");
1142 This interface is not quite baked yet. -- RWMJ 2010-11-11
1143 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1145 "add the disk(s) from a libvirt domain",
1147 This function adds the disk(s) attached to the libvirt domain C<dom>.
1148 It works by requesting the domain XML from libvirt, parsing it for
1149 disks, and calling C<guestfs_add_drive_opts> on each one.
1151 In the C API we declare C<void *dom>, but really it has type
1152 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1154 The number of disks added is returned. This operation is atomic:
1155 if an error is returned, then no disks are added.
1157 This function does some minimal checks to make sure the libvirt
1158 domain is not running (unless C<readonly> is true). In a future
1159 version we will try to acquire the libvirt lock on each disk.
1161 Disks must be accessible locally. This often means that adding disks
1162 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1163 will fail unless those disks are accessible via the same device path
1166 The optional C<live> flag controls whether this call will try
1167 to connect to a running virtual machine C<guestfsd> process if
1168 it sees a suitable E<lt>channelE<gt> element in the libvirt
1169 XML definition. The default (if the flag is omitted) is never
1170 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1173 The other optional parameters are passed directly through to
1174 C<guestfs_add_drive_opts>.");
1177 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1179 "get package format used by the operating system",
1181 This function should only be called with a root device string
1182 as returned by C<guestfs_inspect_os>.
1184 This function and C<guestfs_inspect_get_package_management> return
1185 the package format and package management tool used by the
1186 inspected operating system. For example for Fedora these
1187 functions would return C<rpm> (package format) and
1188 C<yum> (package management).
1190 This returns the string C<unknown> if we could not determine the
1191 package format I<or> if the operating system does not have
1192 a real packaging system (eg. Windows).
1194 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1195 Future versions of libguestfs may return other strings.
1197 Please read L<guestfs(3)/INSPECTION> for more details.");
1199 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1201 "get package management tool used by the operating system",
1203 This function should only be called with a root device string
1204 as returned by C<guestfs_inspect_os>.
1206 C<guestfs_inspect_get_package_format> and this function return
1207 the package format and package management tool used by the
1208 inspected operating system. For example for Fedora these
1209 functions would return C<rpm> (package format) and
1210 C<yum> (package management).
1212 This returns the string C<unknown> if we could not determine the
1213 package management tool I<or> if the operating system does not have
1214 a real packaging system (eg. Windows).
1216 Possible strings include: C<yum>, C<up2date>,
1217 C<apt> (for all Debian derivatives),
1218 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1219 Future versions of libguestfs may return other strings.
1221 Please read L<guestfs(3)/INSPECTION> for more details.");
1223 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1225 "get list of applications installed in the operating system",
1227 This function should only be called with a root device string
1228 as returned by C<guestfs_inspect_os>.
1230 Return the list of applications installed in the operating system.
1232 I<Note:> This call works differently from other parts of the
1233 inspection API. You have to call C<guestfs_inspect_os>, then
1234 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1235 before calling this. Listing applications is a significantly
1236 more difficult operation which requires access to the full
1237 filesystem. Also note that unlike the other
1238 C<guestfs_inspect_get_*> calls which are just returning
1239 data cached in the libguestfs handle, this call actually reads
1240 parts of the mounted filesystems during the call.
1242 This returns an empty list if the inspection code was not able
1243 to determine the list of applications.
1245 The application structure contains the following fields:
1251 The name of the application. For Red Hat-derived and Debian-derived
1252 Linux guests, this is the package name.
1254 =item C<app_display_name>
1256 The display name of the application, sometimes localized to the
1257 install language of the guest operating system.
1259 If unavailable this is returned as an empty string C<\"\">.
1260 Callers needing to display something can use C<app_name> instead.
1264 For package managers which use epochs, this contains the epoch of
1265 the package (an integer). If unavailable, this is returned as C<0>.
1267 =item C<app_version>
1269 The version string of the application or package. If unavailable
1270 this is returned as an empty string C<\"\">.
1272 =item C<app_release>
1274 The release string of the application or package, for package
1275 managers that use this. If unavailable this is returned as an
1276 empty string C<\"\">.
1278 =item C<app_install_path>
1280 The installation path of the application (on operating systems
1281 such as Windows which use installation paths). This path is
1282 in the format used by the guest operating system, it is not
1285 If unavailable this is returned as an empty string C<\"\">.
1287 =item C<app_trans_path>
1289 The install path translated into a libguestfs path.
1290 If unavailable this is returned as an empty string C<\"\">.
1292 =item C<app_publisher>
1294 The name of the publisher of the application, for package
1295 managers that use this. If unavailable this is returned
1296 as an empty string C<\"\">.
1300 The URL (eg. upstream URL) of the application.
1301 If unavailable this is returned as an empty string C<\"\">.
1303 =item C<app_source_package>
1305 For packaging systems which support this, the name of the source
1306 package. If unavailable this is returned as an empty string C<\"\">.
1308 =item C<app_summary>
1310 A short (usually one line) description of the application or package.
1311 If unavailable this is returned as an empty string C<\"\">.
1313 =item C<app_description>
1315 A longer description of the application or package.
1316 If unavailable this is returned as an empty string C<\"\">.
1320 Please read L<guestfs(3)/INSPECTION> for more details.");
1322 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1324 "get hostname of the operating system",
1326 This function should only be called with a root device string
1327 as returned by C<guestfs_inspect_os>.
1329 This function returns the hostname of the operating system
1330 as found by inspection of the guest's configuration files.
1332 If the hostname could not be determined, then the
1333 string C<unknown> is returned.
1335 Please read L<guestfs(3)/INSPECTION> for more details.");
1337 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1339 "get format of inspected operating system",
1341 This function should only be called with a root device string
1342 as returned by C<guestfs_inspect_os>.
1344 This returns the format of the inspected operating system. You
1345 can use it to detect install images, live CDs and similar.
1347 Currently defined formats are:
1353 This is an installed operating system.
1357 The disk image being inspected is not an installed operating system,
1358 but a I<bootable> install disk, live CD, or similar.
1362 The format of this disk image is not known.
1366 Future versions of libguestfs may return other strings here.
1367 The caller should be prepared to handle any string.
1369 Please read L<guestfs(3)/INSPECTION> for more details.");
1371 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1373 "get live flag for install disk",
1375 This function should only be called with a root device string
1376 as returned by C<guestfs_inspect_os>.
1378 If C<guestfs_inspect_get_format> returns C<installer> (this
1379 is an install disk), then this returns true if a live image
1380 was detected on the disk.
1382 Please read L<guestfs(3)/INSPECTION> for more details.");
1384 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1386 "get netinst (network installer) flag for install disk",
1388 This function should only be called with a root device string
1389 as returned by C<guestfs_inspect_os>.
1391 If C<guestfs_inspect_get_format> returns C<installer> (this
1392 is an install disk), then this returns true if the disk is
1393 a network installer, ie. not a self-contained install CD but
1394 one which is likely to require network access to complete
1397 Please read L<guestfs(3)/INSPECTION> for more details.");
1399 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1401 "get multipart flag for install disk",
1403 This function should only be called with a root device string
1404 as returned by C<guestfs_inspect_os>.
1406 If C<guestfs_inspect_get_format> returns C<installer> (this
1407 is an install disk), then this returns true if the disk is
1410 Please read L<guestfs(3)/INSPECTION> for more details.");
1412 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1414 "set the attach method",
1416 Set the method that libguestfs uses to connect to the back end
1417 guestfsd daemon. Possible methods are:
1423 Launch an appliance and connect to it. This is the ordinary method
1426 =item C<unix:I<path>>
1428 Connect to the Unix domain socket I<path>.
1430 This method lets you connect to an existing daemon or (using
1431 virtio-serial) to a live guest. For more information, see
1432 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1436 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1437 [InitNone, Always, TestOutput (
1438 [["get_attach_method"]], "appliance")],
1439 "get the attach method",
1441 Return the current attach method. See C<guestfs_set_attach_method>.");
1443 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1445 "get product variant of inspected operating system",
1447 This function should only be called with a root device string
1448 as returned by C<guestfs_inspect_os>.
1450 This returns the product variant of the inspected operating
1453 For Windows guests, this returns the contents of the Registry key
1454 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1455 C<InstallationType> which is usually a string such as
1456 C<Client> or C<Server> (other values are possible). This
1457 can be used to distinguish consumer and enterprise versions
1458 of Windows that have the same version number (for example,
1459 Windows 7 and Windows 2008 Server are both version 6.1,
1460 but the former is C<Client> and the latter is C<Server>).
1462 For enterprise Linux guests, in future we intend this to return
1463 the product variant such as C<Desktop>, C<Server> and so on. But
1464 this is not implemented at present.
1466 If the product variant could not be determined, then the
1467 string C<unknown> is returned.
1469 Please read L<guestfs(3)/INSPECTION> for more details.
1470 See also C<guestfs_inspect_get_product_name>,
1471 C<guestfs_inspect_get_major_version>.");
1473 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1475 "get Windows CurrentControlSet of inspected operating system",
1477 This function should only be called with a root device string
1478 as returned by C<guestfs_inspect_os>.
1480 This returns the Windows CurrentControlSet of the inspected guest.
1481 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1483 This call assumes that the guest is Windows and that the
1484 Registry could be examined by inspection. If this is not
1485 the case then an error is returned.
1487 Please read L<guestfs(3)/INSPECTION> for more details.");
1489 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1491 "get drive letter mappings",
1493 This function should only be called with a root device string
1494 as returned by C<guestfs_inspect_os>.
1496 This call is useful for Windows which uses a primitive system
1497 of assigning drive letters (like \"C:\") to partitions.
1498 This inspection API examines the Windows Registry to find out
1499 how disks/partitions are mapped to drive letters, and returns
1500 a hash table as in the example below:
1506 Note that keys are drive letters. For Windows, the key is
1507 case insensitive and just contains the drive letter, without
1508 the customary colon separator character.
1510 In future we may support other operating systems that also used drive
1511 letters, but the keys for those might not be case insensitive
1512 and might be longer than 1 character. For example in OS-9,
1513 hard drives were named C<h0>, C<h1> etc.
1515 For Windows guests, currently only hard drive mappings are
1516 returned. Removable disks (eg. DVD-ROMs) are ignored.
1518 For guests that do not use drive mappings, or if the drive mappings
1519 could not be determined, this returns an empty hash table.
1521 Please read L<guestfs(3)/INSPECTION> for more details.
1522 See also C<guestfs_inspect_get_mountpoints>,
1523 C<guestfs_inspect_get_filesystems>.");
1527 (* daemon_functions are any functions which cause some action
1528 * to take place in the daemon.
1531 let daemon_functions = [
1532 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1533 [InitEmpty, Always, TestOutput (
1534 [["part_disk"; "/dev/sda"; "mbr"];
1535 ["mkfs"; "ext2"; "/dev/sda1"];
1536 ["mount"; "/dev/sda1"; "/"];
1537 ["write"; "/new"; "new file contents"];
1538 ["cat"; "/new"]], "new file contents")],
1539 "mount a guest disk at a position in the filesystem",
1541 Mount a guest disk at a position in the filesystem. Block devices
1542 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1543 the guest. If those block devices contain partitions, they will have
1544 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1547 The rules are the same as for L<mount(2)>: A filesystem must
1548 first be mounted on C</> before others can be mounted. Other
1549 filesystems can only be mounted on directories which already
1552 The mounted filesystem is writable, if we have sufficient permissions
1553 on the underlying device.
1556 When you use this call, the filesystem options C<sync> and C<noatime>
1557 are set implicitly. This was originally done because we thought it
1558 would improve reliability, but it turns out that I<-o sync> has a
1559 very large negative performance impact and negligible effect on
1560 reliability. Therefore we recommend that you avoid using
1561 C<guestfs_mount> in any code that needs performance, and instead
1562 use C<guestfs_mount_options> (use an empty string for the first
1563 parameter if you don't want any options).");
1565 ("sync", (RErr, [], []), 2, [],
1566 [ InitEmpty, Always, TestRun [["sync"]]],
1567 "sync disks, writes are flushed through to the disk image",
1569 This syncs the disk, so that any writes are flushed through to the
1570 underlying disk image.
1572 You should always call this if you have modified a disk image, before
1573 closing the handle.");
1575 ("touch", (RErr, [Pathname "path"], []), 3, [],
1576 [InitScratchFS, Always, TestOutputTrue (
1577 [["touch"; "/touch"];
1578 ["exists"; "/touch"]])],
1579 "update file timestamps or create a new file",
1581 Touch acts like the L<touch(1)> command. It can be used to
1582 update the timestamps on a file, or, if the file does not exist,
1583 to create a new zero-length file.
1585 This command only works on regular files, and will fail on other
1586 file types such as directories, symbolic links, block special etc.");
1588 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1589 [InitISOFS, Always, TestOutput (
1590 [["cat"; "/known-2"]], "abcdef\n")],
1591 "list the contents of a file",
1593 Return the contents of the file named C<path>.
1595 Note that this function cannot correctly handle binary files
1596 (specifically, files containing C<\\0> character which is treated
1597 as end of string). For those you need to use the C<guestfs_read_file>
1598 or C<guestfs_download> functions which have a more complex interface.");
1600 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1601 [], (* XXX Tricky to test because it depends on the exact format
1602 * of the 'ls -l' command, which changes between F10 and F11.
1604 "list the files in a directory (long format)",
1606 List the files in C<directory> (relative to the root directory,
1607 there is no cwd) in the format of 'ls -la'.
1609 This command is mostly useful for interactive sessions. It
1610 is I<not> intended that you try to parse the output string.");
1612 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1613 [InitScratchFS, Always, TestOutputList (
1615 ["touch"; "/ls/new"];
1616 ["touch"; "/ls/newer"];
1617 ["touch"; "/ls/newest"];
1618 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1619 "list the files in a directory",
1621 List the files in C<directory> (relative to the root directory,
1622 there is no cwd). The '.' and '..' entries are not returned, but
1623 hidden files are shown.
1625 This command is mostly useful for interactive sessions. Programs
1626 should probably use C<guestfs_readdir> instead.");
1628 ("list_devices", (RStringList "devices", [], []), 7, [],
1629 [InitEmpty, Always, TestOutputListOfDevices (
1630 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1631 "list the block devices",
1633 List all the block devices.
1635 The full block device names are returned, eg. C</dev/sda>.
1637 See also C<guestfs_list_filesystems>.");
1639 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1640 [InitBasicFS, Always, TestOutputListOfDevices (
1641 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1642 InitEmpty, Always, TestOutputListOfDevices (
1643 [["part_init"; "/dev/sda"; "mbr"];
1644 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1645 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1646 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1647 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1648 "list the partitions",
1650 List all the partitions detected on all block devices.
1652 The full partition device names are returned, eg. C</dev/sda1>
1654 This does not return logical volumes. For that you will need to
1655 call C<guestfs_lvs>.
1657 See also C<guestfs_list_filesystems>.");
1659 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1660 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1661 [["pvs"]], ["/dev/sda1"]);
1662 InitEmpty, Always, TestOutputListOfDevices (
1663 [["part_init"; "/dev/sda"; "mbr"];
1664 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1665 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1666 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1667 ["pvcreate"; "/dev/sda1"];
1668 ["pvcreate"; "/dev/sda2"];
1669 ["pvcreate"; "/dev/sda3"];
1670 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1671 "list the LVM physical volumes (PVs)",
1673 List all the physical volumes detected. This is the equivalent
1674 of the L<pvs(8)> command.
1676 This returns a list of just the device names that contain
1677 PVs (eg. C</dev/sda2>).
1679 See also C<guestfs_pvs_full>.");
1681 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1682 [InitBasicFSonLVM, Always, TestOutputList (
1684 InitEmpty, Always, TestOutputList (
1685 [["part_init"; "/dev/sda"; "mbr"];
1686 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1687 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1688 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1689 ["pvcreate"; "/dev/sda1"];
1690 ["pvcreate"; "/dev/sda2"];
1691 ["pvcreate"; "/dev/sda3"];
1692 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1693 ["vgcreate"; "VG2"; "/dev/sda3"];
1694 ["vgs"]], ["VG1"; "VG2"])],
1695 "list the LVM volume groups (VGs)",
1697 List all the volumes groups detected. This is the equivalent
1698 of the L<vgs(8)> command.
1700 This returns a list of just the volume group names that were
1701 detected (eg. C<VolGroup00>).
1703 See also C<guestfs_vgs_full>.");
1705 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1706 [InitBasicFSonLVM, Always, TestOutputList (
1707 [["lvs"]], ["/dev/VG/LV"]);
1708 InitEmpty, Always, TestOutputList (
1709 [["part_init"; "/dev/sda"; "mbr"];
1710 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1711 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1712 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1713 ["pvcreate"; "/dev/sda1"];
1714 ["pvcreate"; "/dev/sda2"];
1715 ["pvcreate"; "/dev/sda3"];
1716 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1717 ["vgcreate"; "VG2"; "/dev/sda3"];
1718 ["lvcreate"; "LV1"; "VG1"; "50"];
1719 ["lvcreate"; "LV2"; "VG1"; "50"];
1720 ["lvcreate"; "LV3"; "VG2"; "50"];
1721 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1722 "list the LVM logical volumes (LVs)",
1724 List all the logical volumes detected. This is the equivalent
1725 of the L<lvs(8)> command.
1727 This returns a list of the logical volume device names
1728 (eg. C</dev/VolGroup00/LogVol00>).
1730 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1732 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1733 [], (* XXX how to test? *)
1734 "list the LVM physical volumes (PVs)",
1736 List all the physical volumes detected. This is the equivalent
1737 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1739 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1740 [], (* XXX how to test? *)
1741 "list the LVM volume groups (VGs)",
1743 List all the volumes groups detected. This is the equivalent
1744 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1746 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1747 [], (* XXX how to test? *)
1748 "list the LVM logical volumes (LVs)",
1750 List all the logical volumes detected. This is the equivalent
1751 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1753 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1754 [InitISOFS, Always, TestOutputList (
1755 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1756 InitISOFS, Always, TestOutputList (
1757 [["read_lines"; "/empty"]], [])],
1758 "read file as lines",
1760 Return the contents of the file named C<path>.
1762 The file contents are returned as a list of lines. Trailing
1763 C<LF> and C<CRLF> character sequences are I<not> returned.
1765 Note that this function cannot correctly handle binary files
1766 (specifically, files containing C<\\0> character which is treated
1767 as end of line). For those you need to use the C<guestfs_read_file>
1768 function which has a more complex interface.");
1770 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1771 [], (* XXX Augeas code needs tests. *)
1772 "create a new Augeas handle",
1774 Create a new Augeas handle for editing configuration files.
1775 If there was any previous Augeas handle associated with this
1776 guestfs session, then it is closed.
1778 You must call this before using any other C<guestfs_aug_*>
1781 C<root> is the filesystem root. C<root> must not be NULL,
1784 The flags are the same as the flags defined in
1785 E<lt>augeas.hE<gt>, the logical I<or> of the following
1790 =item C<AUG_SAVE_BACKUP> = 1
1792 Keep the original file with a C<.augsave> extension.
1794 =item C<AUG_SAVE_NEWFILE> = 2
1796 Save changes into a file with extension C<.augnew>, and
1797 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1799 =item C<AUG_TYPE_CHECK> = 4
1801 Typecheck lenses (can be expensive).
1803 =item C<AUG_NO_STDINC> = 8
1805 Do not use standard load path for modules.
1807 =item C<AUG_SAVE_NOOP> = 16
1809 Make save a no-op, just record what would have been changed.
1811 =item C<AUG_NO_LOAD> = 32
1813 Do not load the tree in C<guestfs_aug_init>.
1817 To close the handle, you can call C<guestfs_aug_close>.
1819 To find out more about Augeas, see L<http://augeas.net/>.");
1821 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1822 [], (* XXX Augeas code needs tests. *)
1823 "close the current Augeas handle",
1825 Close the current Augeas handle and free up any resources
1826 used by it. After calling this, you have to call
1827 C<guestfs_aug_init> again before you can use any other
1828 Augeas functions.");
1830 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1831 [], (* XXX Augeas code needs tests. *)
1832 "define an Augeas variable",
1834 Defines an Augeas variable C<name> whose value is the result
1835 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1838 On success this returns the number of nodes in C<expr>, or
1839 C<0> if C<expr> evaluates to something which is not a nodeset.");
1841 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1842 [], (* XXX Augeas code needs tests. *)
1843 "define an Augeas node",
1845 Defines a variable C<name> whose value is the result of
1848 If C<expr> evaluates to an empty nodeset, a node is created,
1849 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1850 C<name> will be the nodeset containing that single node.
1852 On success this returns a pair containing the
1853 number of nodes in the nodeset, and a boolean flag
1854 if a node was created.");
1856 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1857 [], (* XXX Augeas code needs tests. *)
1858 "look up the value of an Augeas path",
1860 Look up the value associated with C<path>. If C<path>
1861 matches exactly one node, the C<value> is returned.");
1863 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1864 [], (* XXX Augeas code needs tests. *)
1865 "set Augeas path to value",
1867 Set the value associated with C<path> to C<val>.
1869 In the Augeas API, it is possible to clear a node by setting
1870 the value to NULL. Due to an oversight in the libguestfs API
1871 you cannot do that with this call. Instead you must use the
1872 C<guestfs_aug_clear> call.");
1874 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1875 [], (* XXX Augeas code needs tests. *)
1876 "insert a sibling Augeas node",
1878 Create a new sibling C<label> for C<path>, inserting it into
1879 the tree before or after C<path> (depending on the boolean
1882 C<path> must match exactly one existing node in the tree, and
1883 C<label> must be a label, ie. not contain C</>, C<*> or end
1884 with a bracketed index C<[N]>.");
1886 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1887 [], (* XXX Augeas code needs tests. *)
1888 "remove an Augeas path",
1890 Remove C<path> and all of its children.
1892 On success this returns the number of entries which were removed.");
1894 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1895 [], (* XXX Augeas code needs tests. *)
1898 Move the node C<src> to C<dest>. C<src> must match exactly
1899 one node. C<dest> is overwritten if it exists.");
1901 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1902 [], (* XXX Augeas code needs tests. *)
1903 "return Augeas nodes which match augpath",
1905 Returns a list of paths which match the path expression C<path>.
1906 The returned paths are sufficiently qualified so that they match
1907 exactly one node in the current tree.");
1909 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1910 [], (* XXX Augeas code needs tests. *)
1911 "write all pending Augeas changes to disk",
1913 This writes all pending changes to disk.
1915 The flags which were passed to C<guestfs_aug_init> affect exactly
1916 how files are saved.");
1918 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1919 [], (* XXX Augeas code needs tests. *)
1920 "load files into the tree",
1922 Load files into the tree.
1924 See C<aug_load> in the Augeas documentation for the full gory
1927 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1928 [], (* XXX Augeas code needs tests. *)
1929 "list Augeas nodes under augpath",
1931 This is just a shortcut for listing C<guestfs_aug_match>
1932 C<path/*> and sorting the resulting nodes into alphabetical order.");
1934 ("rm", (RErr, [Pathname "path"], []), 29, [],
1935 [InitScratchFS, Always, TestRun
1937 ["touch"; "/rm/new"];
1939 InitScratchFS, Always, TestLastFail
1940 [["rm"; "/nosuchfile"]];
1941 InitScratchFS, Always, TestLastFail
1946 Remove the single file C<path>.");
1948 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1949 [InitScratchFS, Always, TestRun
1950 [["mkdir"; "/rmdir"];
1951 ["rmdir"; "/rmdir"]];
1952 InitScratchFS, Always, TestLastFail
1953 [["rmdir"; "/rmdir2"]];
1954 InitScratchFS, Always, TestLastFail
1955 [["mkdir"; "/rmdir3"];
1956 ["touch"; "/rmdir3/new"];
1957 ["rmdir"; "/rmdir3/new"]]],
1958 "remove a directory",
1960 Remove the single directory C<path>.");
1962 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1963 [InitScratchFS, Always, TestOutputFalse
1964 [["mkdir"; "/rm_rf"];
1965 ["mkdir"; "/rm_rf/foo"];
1966 ["touch"; "/rm_rf/foo/bar"];
1967 ["rm_rf"; "/rm_rf"];
1968 ["exists"; "/rm_rf"]]],
1969 "remove a file or directory recursively",
1971 Remove the file or directory C<path>, recursively removing the
1972 contents if its a directory. This is like the C<rm -rf> shell
1975 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1976 [InitScratchFS, Always, TestOutputTrue
1977 [["mkdir"; "/mkdir"];
1978 ["is_dir"; "/mkdir"]];
1979 InitScratchFS, Always, TestLastFail
1980 [["mkdir"; "/mkdir2/foo/bar"]]],
1981 "create a directory",
1983 Create a directory named C<path>.");
1985 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1986 [InitScratchFS, Always, TestOutputTrue
1987 [["mkdir_p"; "/mkdir_p/foo/bar"];
1988 ["is_dir"; "/mkdir_p/foo/bar"]];
1989 InitScratchFS, Always, TestOutputTrue
1990 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1991 ["is_dir"; "/mkdir_p2/foo"]];
1992 InitScratchFS, Always, TestOutputTrue
1993 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1994 ["is_dir"; "/mkdir_p3"]];
1995 (* Regression tests for RHBZ#503133: *)
1996 InitScratchFS, Always, TestRun
1997 [["mkdir"; "/mkdir_p4"];
1998 ["mkdir_p"; "/mkdir_p4"]];
1999 InitScratchFS, Always, TestLastFail
2000 [["touch"; "/mkdir_p5"];
2001 ["mkdir_p"; "/mkdir_p5"]]],
2002 "create a directory and parents",
2004 Create a directory named C<path>, creating any parent directories
2005 as necessary. This is like the C<mkdir -p> shell command.");
2007 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2008 [], (* XXX Need stat command to test *)
2011 Change the mode (permissions) of C<path> to C<mode>. Only
2012 numeric modes are supported.
2014 I<Note>: When using this command from guestfish, C<mode>
2015 by default would be decimal, unless you prefix it with
2016 C<0> to get octal, ie. use C<0700> not C<700>.
2018 The mode actually set is affected by the umask.");
2020 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2021 [], (* XXX Need stat command to test *)
2022 "change file owner and group",
2024 Change the file owner to C<owner> and group to C<group>.
2026 Only numeric uid and gid are supported. If you want to use
2027 names, you will need to locate and parse the password file
2028 yourself (Augeas support makes this relatively easy).");
2030 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2031 [InitISOFS, Always, TestOutputTrue (
2032 [["exists"; "/empty"]]);
2033 InitISOFS, Always, TestOutputTrue (
2034 [["exists"; "/directory"]])],
2035 "test if file or directory exists",
2037 This returns C<true> if and only if there is a file, directory
2038 (or anything) with the given C<path> name.
2040 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2042 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2043 [InitISOFS, Always, TestOutputTrue (
2044 [["is_file"; "/known-1"]]);
2045 InitISOFS, Always, TestOutputFalse (
2046 [["is_file"; "/directory"]])],
2047 "test if a regular file",
2049 This returns C<true> if and only if there is a regular file
2050 with the given C<path> name. Note that it returns false for
2051 other objects like directories.
2053 See also C<guestfs_stat>.");
2055 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2056 [InitISOFS, Always, TestOutputFalse (
2057 [["is_dir"; "/known-3"]]);
2058 InitISOFS, Always, TestOutputTrue (
2059 [["is_dir"; "/directory"]])],
2060 "test if a directory",
2062 This returns C<true> if and only if there is a directory
2063 with the given C<path> name. Note that it returns false for
2064 other objects like files.
2066 See also C<guestfs_stat>.");
2068 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2069 [InitEmpty, Always, TestOutputListOfDevices (
2070 [["part_init"; "/dev/sda"; "mbr"];
2071 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2072 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2073 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2074 ["pvcreate"; "/dev/sda1"];
2075 ["pvcreate"; "/dev/sda2"];
2076 ["pvcreate"; "/dev/sda3"];
2077 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2078 "create an LVM physical volume",
2080 This creates an LVM physical volume on the named C<device>,
2081 where C<device> should usually be a partition name such
2084 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2085 [InitEmpty, Always, TestOutputList (
2086 [["part_init"; "/dev/sda"; "mbr"];
2087 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2088 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2089 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2090 ["pvcreate"; "/dev/sda1"];
2091 ["pvcreate"; "/dev/sda2"];
2092 ["pvcreate"; "/dev/sda3"];
2093 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2094 ["vgcreate"; "VG2"; "/dev/sda3"];
2095 ["vgs"]], ["VG1"; "VG2"])],
2096 "create an LVM volume group",
2098 This creates an LVM volume group called C<volgroup>
2099 from the non-empty list of physical volumes C<physvols>.");
2101 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2102 [InitEmpty, Always, TestOutputList (
2103 [["part_init"; "/dev/sda"; "mbr"];
2104 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2105 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2106 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2107 ["pvcreate"; "/dev/sda1"];
2108 ["pvcreate"; "/dev/sda2"];
2109 ["pvcreate"; "/dev/sda3"];
2110 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2111 ["vgcreate"; "VG2"; "/dev/sda3"];
2112 ["lvcreate"; "LV1"; "VG1"; "50"];
2113 ["lvcreate"; "LV2"; "VG1"; "50"];
2114 ["lvcreate"; "LV3"; "VG2"; "50"];
2115 ["lvcreate"; "LV4"; "VG2"; "50"];
2116 ["lvcreate"; "LV5"; "VG2"; "50"];
2118 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2119 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2120 "create an LVM logical volume",
2122 This creates an LVM logical volume called C<logvol>
2123 on the volume group C<volgroup>, with C<size> megabytes.");
2125 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2126 [InitEmpty, Always, TestOutput (
2127 [["part_disk"; "/dev/sda"; "mbr"];
2128 ["mkfs"; "ext2"; "/dev/sda1"];
2129 ["mount_options"; ""; "/dev/sda1"; "/"];
2130 ["write"; "/new"; "new file contents"];
2131 ["cat"; "/new"]], "new file contents")],
2132 "make a filesystem",
2134 This creates a filesystem on C<device> (usually a partition
2135 or LVM logical volume). The filesystem type is C<fstype>, for
2138 ("sfdisk", (RErr, [Device "device";
2139 Int "cyls"; Int "heads"; Int "sectors";
2140 StringList "lines"], []), 43, [DangerWillRobinson],
2142 "create partitions on a block device",
2144 This is a direct interface to the L<sfdisk(8)> program for creating
2145 partitions on block devices.
2147 C<device> should be a block device, for example C</dev/sda>.
2149 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2150 and sectors on the device, which are passed directly to sfdisk as
2151 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2152 of these, then the corresponding parameter is omitted. Usually for
2153 'large' disks, you can just pass C<0> for these, but for small
2154 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2155 out the right geometry and you will need to tell it.
2157 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2158 information refer to the L<sfdisk(8)> manpage.
2160 To create a single partition occupying the whole disk, you would
2161 pass C<lines> as a single element list, when the single element being
2162 the string C<,> (comma).
2164 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2165 C<guestfs_part_init>");
2167 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2168 (* Regression test for RHBZ#597135. *)
2169 [InitScratchFS, Always, TestLastFail
2170 [["write_file"; "/write_file"; "abc"; "10000"]]],
2173 This call creates a file called C<path>. The contents of the
2174 file is the string C<content> (which can contain any 8 bit data),
2175 with length C<size>.
2177 As a special case, if C<size> is C<0>
2178 then the length is calculated using C<strlen> (so in this case
2179 the content cannot contain embedded ASCII NULs).
2181 I<NB.> Owing to a bug, writing content containing ASCII NUL
2182 characters does I<not> work, even if the length is specified.");
2184 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2185 [InitEmpty, Always, TestOutputListOfDevices (
2186 [["part_disk"; "/dev/sda"; "mbr"];
2187 ["mkfs"; "ext2"; "/dev/sda1"];
2188 ["mount_options"; ""; "/dev/sda1"; "/"];
2189 ["mounts"]], ["/dev/sda1"]);
2190 InitEmpty, Always, TestOutputList (
2191 [["part_disk"; "/dev/sda"; "mbr"];
2192 ["mkfs"; "ext2"; "/dev/sda1"];
2193 ["mount_options"; ""; "/dev/sda1"; "/"];
2196 "unmount a filesystem",
2198 This unmounts the given filesystem. The filesystem may be
2199 specified either by its mountpoint (path) or the device which
2200 contains the filesystem.");
2202 ("mounts", (RStringList "devices", [], []), 46, [],
2203 [InitScratchFS, Always, TestOutputListOfDevices (
2204 [["mounts"]], ["/dev/sdb1"])],
2205 "show mounted filesystems",
2207 This returns the list of currently mounted filesystems. It returns
2208 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2210 Some internal mounts are not shown.
2212 See also: C<guestfs_mountpoints>");
2214 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2215 [InitScratchFS, Always, TestOutputList (
2218 (* check that umount_all can unmount nested mounts correctly: *)
2219 InitEmpty, Always, TestOutputList (
2220 [["part_init"; "/dev/sda"; "mbr"];
2221 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2222 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2223 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2224 ["mkfs"; "ext2"; "/dev/sda1"];
2225 ["mkfs"; "ext2"; "/dev/sda2"];
2226 ["mkfs"; "ext2"; "/dev/sda3"];
2227 ["mount_options"; ""; "/dev/sda1"; "/"];
2229 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2230 ["mkdir"; "/mp1/mp2"];
2231 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2232 ["mkdir"; "/mp1/mp2/mp3"];
2235 "unmount all filesystems",
2237 This unmounts all mounted filesystems.
2239 Some internal mounts are not unmounted by this call.");
2241 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2243 "remove all LVM LVs, VGs and PVs",
2245 This command removes all LVM logical volumes, volume groups
2246 and physical volumes.");
2248 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2249 [InitISOFS, Always, TestOutput (
2250 [["file"; "/empty"]], "empty");
2251 InitISOFS, Always, TestOutput (
2252 [["file"; "/known-1"]], "ASCII text");
2253 InitISOFS, Always, TestLastFail (
2254 [["file"; "/notexists"]]);
2255 InitISOFS, Always, TestOutput (
2256 [["file"; "/abssymlink"]], "symbolic link");
2257 InitISOFS, Always, TestOutput (
2258 [["file"; "/directory"]], "directory")],
2259 "determine file type",
2261 This call uses the standard L<file(1)> command to determine
2262 the type or contents of the file.
2264 This call will also transparently look inside various types
2267 The exact command which runs is C<file -zb path>. Note in
2268 particular that the filename is not prepended to the output
2271 This command can also be used on C</dev/> devices
2272 (and partitions, LV names). You can for example use this
2273 to determine if a device contains a filesystem, although
2274 it's usually better to use C<guestfs_vfs_type>.
2276 If the C<path> does not begin with C</dev/> then
2277 this command only works for the content of regular files.
2278 For other file types (directory, symbolic link etc) it
2279 will just return the string C<directory> etc.");
2281 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2282 [InitScratchFS, Always, TestOutput (
2283 [["mkdir"; "/command"];
2284 ["upload"; "test-command"; "/command/test-command"];
2285 ["chmod"; "0o755"; "/command/test-command"];
2286 ["command"; "/command/test-command 1"]], "Result1");
2287 InitScratchFS, Always, TestOutput (
2288 [["mkdir"; "/command2"];
2289 ["upload"; "test-command"; "/command2/test-command"];
2290 ["chmod"; "0o755"; "/command2/test-command"];
2291 ["command"; "/command2/test-command 2"]], "Result2\n");
2292 InitScratchFS, Always, TestOutput (
2293 [["mkdir"; "/command3"];
2294 ["upload"; "test-command"; "/command3/test-command"];
2295 ["chmod"; "0o755"; "/command3/test-command"];
2296 ["command"; "/command3/test-command 3"]], "\nResult3");
2297 InitScratchFS, Always, TestOutput (
2298 [["mkdir"; "/command4"];
2299 ["upload"; "test-command"; "/command4/test-command"];
2300 ["chmod"; "0o755"; "/command4/test-command"];
2301 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2302 InitScratchFS, Always, TestOutput (
2303 [["mkdir"; "/command5"];
2304 ["upload"; "test-command"; "/command5/test-command"];
2305 ["chmod"; "0o755"; "/command5/test-command"];
2306 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2307 InitScratchFS, Always, TestOutput (
2308 [["mkdir"; "/command6"];
2309 ["upload"; "test-command"; "/command6/test-command"];
2310 ["chmod"; "0o755"; "/command6/test-command"];
2311 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2312 InitScratchFS, Always, TestOutput (
2313 [["mkdir"; "/command7"];
2314 ["upload"; "test-command"; "/command7/test-command"];
2315 ["chmod"; "0o755"; "/command7/test-command"];
2316 ["command"; "/command7/test-command 7"]], "");
2317 InitScratchFS, Always, TestOutput (
2318 [["mkdir"; "/command8"];
2319 ["upload"; "test-command"; "/command8/test-command"];
2320 ["chmod"; "0o755"; "/command8/test-command"];
2321 ["command"; "/command8/test-command 8"]], "\n");
2322 InitScratchFS, Always, TestOutput (
2323 [["mkdir"; "/command9"];
2324 ["upload"; "test-command"; "/command9/test-command"];
2325 ["chmod"; "0o755"; "/command9/test-command"];
2326 ["command"; "/command9/test-command 9"]], "\n\n");
2327 InitScratchFS, Always, TestOutput (
2328 [["mkdir"; "/command10"];
2329 ["upload"; "test-command"; "/command10/test-command"];
2330 ["chmod"; "0o755"; "/command10/test-command"];
2331 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2332 InitScratchFS, Always, TestOutput (
2333 [["mkdir"; "/command11"];
2334 ["upload"; "test-command"; "/command11/test-command"];
2335 ["chmod"; "0o755"; "/command11/test-command"];
2336 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2337 InitScratchFS, Always, TestLastFail (
2338 [["mkdir"; "/command12"];
2339 ["upload"; "test-command"; "/command12/test-command"];
2340 ["chmod"; "0o755"; "/command12/test-command"];
2341 ["command"; "/command12/test-command"]])],
2342 "run a command from the guest filesystem",
2344 This call runs a command from the guest filesystem. The
2345 filesystem must be mounted, and must contain a compatible
2346 operating system (ie. something Linux, with the same
2347 or compatible processor architecture).
2349 The single parameter is an argv-style list of arguments.
2350 The first element is the name of the program to run.
2351 Subsequent elements are parameters. The list must be
2352 non-empty (ie. must contain a program name). Note that
2353 the command runs directly, and is I<not> invoked via
2354 the shell (see C<guestfs_sh>).
2356 The return value is anything printed to I<stdout> by
2359 If the command returns a non-zero exit status, then
2360 this function returns an error message. The error message
2361 string is the content of I<stderr> from the command.
2363 The C<$PATH> environment variable will contain at least
2364 C</usr/bin> and C</bin>. If you require a program from
2365 another location, you should provide the full path in the
2368 Shared libraries and data files required by the program
2369 must be available on filesystems which are mounted in the
2370 correct places. It is the caller's responsibility to ensure
2371 all filesystems that are needed are mounted at the right
2374 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2375 [InitScratchFS, Always, TestOutputList (
2376 [["mkdir"; "/command_lines"];
2377 ["upload"; "test-command"; "/command_lines/test-command"];
2378 ["chmod"; "0o755"; "/command_lines/test-command"];
2379 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2380 InitScratchFS, Always, TestOutputList (
2381 [["mkdir"; "/command_lines2"];
2382 ["upload"; "test-command"; "/command_lines2/test-command"];
2383 ["chmod"; "0o755"; "/command_lines2/test-command"];
2384 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2385 InitScratchFS, Always, TestOutputList (
2386 [["mkdir"; "/command_lines3"];
2387 ["upload"; "test-command"; "/command_lines3/test-command"];
2388 ["chmod"; "0o755"; "/command_lines3/test-command"];
2389 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2390 InitScratchFS, Always, TestOutputList (
2391 [["mkdir"; "/command_lines4"];
2392 ["upload"; "test-command"; "/command_lines4/test-command"];
2393 ["chmod"; "0o755"; "/command_lines4/test-command"];
2394 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2395 InitScratchFS, Always, TestOutputList (
2396 [["mkdir"; "/command_lines5"];
2397 ["upload"; "test-command"; "/command_lines5/test-command"];
2398 ["chmod"; "0o755"; "/command_lines5/test-command"];
2399 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2400 InitScratchFS, Always, TestOutputList (
2401 [["mkdir"; "/command_lines6"];
2402 ["upload"; "test-command"; "/command_lines6/test-command"];
2403 ["chmod"; "0o755"; "/command_lines6/test-command"];
2404 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2405 InitScratchFS, Always, TestOutputList (
2406 [["mkdir"; "/command_lines7"];
2407 ["upload"; "test-command"; "/command_lines7/test-command"];
2408 ["chmod"; "0o755"; "/command_lines7/test-command"];
2409 ["command_lines"; "/command_lines7/test-command 7"]], []);
2410 InitScratchFS, Always, TestOutputList (
2411 [["mkdir"; "/command_lines8"];
2412 ["upload"; "test-command"; "/command_lines8/test-command"];
2413 ["chmod"; "0o755"; "/command_lines8/test-command"];
2414 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2415 InitScratchFS, Always, TestOutputList (
2416 [["mkdir"; "/command_lines9"];
2417 ["upload"; "test-command"; "/command_lines9/test-command"];
2418 ["chmod"; "0o755"; "/command_lines9/test-command"];
2419 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2420 InitScratchFS, Always, TestOutputList (
2421 [["mkdir"; "/command_lines10"];
2422 ["upload"; "test-command"; "/command_lines10/test-command"];
2423 ["chmod"; "0o755"; "/command_lines10/test-command"];
2424 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2425 InitScratchFS, Always, TestOutputList (
2426 [["mkdir"; "/command_lines11"];
2427 ["upload"; "test-command"; "/command_lines11/test-command"];
2428 ["chmod"; "0o755"; "/command_lines11/test-command"];
2429 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2430 "run a command, returning lines",
2432 This is the same as C<guestfs_command>, but splits the
2433 result into a list of lines.
2435 See also: C<guestfs_sh_lines>");
2437 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2438 [InitISOFS, Always, TestOutputStruct (
2439 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2440 "get file information",
2442 Returns file information for the given C<path>.
2444 This is the same as the C<stat(2)> system call.");
2446 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2447 [InitISOFS, Always, TestOutputStruct (
2448 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2449 "get file information for a symbolic link",
2451 Returns file information for the given C<path>.
2453 This is the same as C<guestfs_stat> except that if C<path>
2454 is a symbolic link, then the link is stat-ed, not the file it
2457 This is the same as the C<lstat(2)> system call.");
2459 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2460 [InitISOFS, Always, TestOutputStruct (
2461 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2462 "get file system statistics",
2464 Returns file system statistics for any mounted file system.
2465 C<path> should be a file or directory in the mounted file system
2466 (typically it is the mount point itself, but it doesn't need to be).
2468 This is the same as the C<statvfs(2)> system call.");
2470 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2472 "get ext2/ext3/ext4 superblock details",
2474 This returns the contents of the ext2, ext3 or ext4 filesystem
2475 superblock on C<device>.
2477 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2478 manpage for more details. The list of fields returned isn't
2479 clearly defined, and depends on both the version of C<tune2fs>
2480 that libguestfs was built against, and the filesystem itself.");
2482 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2483 [InitEmpty, Always, TestOutputTrue (
2484 [["blockdev_setro"; "/dev/sda"];
2485 ["blockdev_getro"; "/dev/sda"]])],
2486 "set block device to read-only",
2488 Sets the block device named C<device> to read-only.
2490 This uses the L<blockdev(8)> command.");
2492 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2493 [InitEmpty, Always, TestOutputFalse (
2494 [["blockdev_setrw"; "/dev/sda"];
2495 ["blockdev_getro"; "/dev/sda"]])],
2496 "set block device to read-write",
2498 Sets the block device named C<device> to read-write.
2500 This uses the L<blockdev(8)> command.");
2502 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2503 [InitEmpty, Always, TestOutputTrue (
2504 [["blockdev_setro"; "/dev/sda"];
2505 ["blockdev_getro"; "/dev/sda"]])],
2506 "is block device set to read-only",
2508 Returns a boolean indicating if the block device is read-only
2509 (true if read-only, false if not).
2511 This uses the L<blockdev(8)> command.");
2513 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2514 [InitEmpty, Always, TestOutputInt (
2515 [["blockdev_getss"; "/dev/sda"]], 512)],
2516 "get sectorsize of block device",
2518 This returns the size of sectors on a block device.
2519 Usually 512, but can be larger for modern devices.
2521 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2524 This uses the L<blockdev(8)> command.");
2526 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2527 [InitEmpty, Always, TestOutputInt (
2528 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2529 "get blocksize of block device",
2531 This returns the block size of a device.
2533 (Note this is different from both I<size in blocks> and
2534 I<filesystem block size>).
2536 This uses the L<blockdev(8)> command.");
2538 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2540 "set blocksize of block device",
2542 This sets the block size of a device.
2544 (Note this is different from both I<size in blocks> and
2545 I<filesystem block size>).
2547 This uses the L<blockdev(8)> command.");
2549 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2550 [InitEmpty, Always, TestOutputInt (
2551 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2552 "get total size of device in 512-byte sectors",
2554 This returns the size of the device in units of 512-byte sectors
2555 (even if the sectorsize isn't 512 bytes ... weird).
2557 See also C<guestfs_blockdev_getss> for the real sector size of
2558 the device, and C<guestfs_blockdev_getsize64> for the more
2559 useful I<size in bytes>.
2561 This uses the L<blockdev(8)> command.");
2563 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2564 [InitEmpty, Always, TestOutputInt (
2565 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2566 "get total size of device in bytes",
2568 This returns the size of the device in bytes.
2570 See also C<guestfs_blockdev_getsz>.
2572 This uses the L<blockdev(8)> command.");
2574 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2575 [InitEmpty, Always, TestRun
2576 [["blockdev_flushbufs"; "/dev/sda"]]],
2577 "flush device buffers",
2579 This tells the kernel to flush internal buffers associated
2582 This uses the L<blockdev(8)> command.");
2584 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2585 [InitEmpty, Always, TestRun
2586 [["blockdev_rereadpt"; "/dev/sda"]]],
2587 "reread partition table",
2589 Reread the partition table on C<device>.
2591 This uses the L<blockdev(8)> command.");
2593 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2594 [InitScratchFS, Always, TestOutput (
2595 (* Pick a file from cwd which isn't likely to change. *)
2596 [["mkdir"; "/upload"];
2597 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2598 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2599 Digest.to_hex (Digest.file "COPYING.LIB"))],
2600 "upload a file from the local machine",
2602 Upload local file C<filename> to C<remotefilename> on the
2605 C<filename> can also be a named pipe.
2607 See also C<guestfs_download>.");
2609 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2610 [InitScratchFS, Always, TestOutput (
2611 (* Pick a file from cwd which isn't likely to change. *)
2612 [["mkdir"; "/download"];
2613 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2614 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2615 ["upload"; "testdownload.tmp"; "/download/upload"];
2616 ["checksum"; "md5"; "/download/upload"]],
2617 Digest.to_hex (Digest.file "COPYING.LIB"))],
2618 "download a file to the local machine",
2620 Download file C<remotefilename> and save it as C<filename>
2621 on the local machine.
2623 C<filename> can also be a named pipe.
2625 See also C<guestfs_upload>, C<guestfs_cat>.");
2627 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2628 [InitISOFS, Always, TestOutput (
2629 [["checksum"; "crc"; "/known-3"]], "2891671662");
2630 InitISOFS, Always, TestLastFail (
2631 [["checksum"; "crc"; "/notexists"]]);
2632 InitISOFS, Always, TestOutput (
2633 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2634 InitISOFS, Always, TestOutput (
2635 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2636 InitISOFS, Always, TestOutput (
2637 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2638 InitISOFS, Always, TestOutput (
2639 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2640 InitISOFS, Always, TestOutput (
2641 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2642 InitISOFS, Always, TestOutput (
2643 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2644 (* Test for RHBZ#579608, absolute symbolic links. *)
2645 InitISOFS, Always, TestOutput (
2646 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2647 "compute MD5, SHAx or CRC checksum of file",
2649 This call computes the MD5, SHAx or CRC checksum of the
2652 The type of checksum to compute is given by the C<csumtype>
2653 parameter which must have one of the following values:
2659 Compute the cyclic redundancy check (CRC) specified by POSIX
2660 for the C<cksum> command.
2664 Compute the MD5 hash (using the C<md5sum> program).
2668 Compute the SHA1 hash (using the C<sha1sum> program).
2672 Compute the SHA224 hash (using the C<sha224sum> program).
2676 Compute the SHA256 hash (using the C<sha256sum> program).
2680 Compute the SHA384 hash (using the C<sha384sum> program).
2684 Compute the SHA512 hash (using the C<sha512sum> program).
2688 The checksum is returned as a printable string.
2690 To get the checksum for a device, use C<guestfs_checksum_device>.
2692 To get the checksums for many files, use C<guestfs_checksums_out>.");
2694 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2695 [InitScratchFS, Always, TestOutput (
2696 [["mkdir"; "/tar_in"];
2697 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2698 ["cat"; "/tar_in/hello"]], "hello\n")],
2699 "unpack tarfile to directory",
2701 This command uploads and unpacks local file C<tarfile> (an
2702 I<uncompressed> tar file) into C<directory>.
2704 To upload a compressed tarball, use C<guestfs_tgz_in>
2705 or C<guestfs_txz_in>.");
2707 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2709 "pack directory into tarfile",
2711 This command packs the contents of C<directory> and downloads
2712 it to local file C<tarfile>.
2714 To download a compressed tarball, use C<guestfs_tgz_out>
2715 or C<guestfs_txz_out>.");
2717 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2718 [InitScratchFS, Always, TestOutput (
2719 [["mkdir"; "/tgz_in"];
2720 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2721 ["cat"; "/tgz_in/hello"]], "hello\n")],
2722 "unpack compressed tarball to directory",
2724 This command uploads and unpacks local file C<tarball> (a
2725 I<gzip compressed> tar file) into C<directory>.
2727 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2729 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2731 "pack directory into compressed tarball",
2733 This command packs the contents of C<directory> and downloads
2734 it to local file C<tarball>.
2736 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2738 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2739 [InitBasicFS, Always, TestLastFail (
2741 ["mount_ro"; "/dev/sda1"; "/"];
2742 ["touch"; "/new"]]);
2743 InitBasicFS, Always, TestOutput (
2744 [["write"; "/new"; "data"];
2746 ["mount_ro"; "/dev/sda1"; "/"];
2747 ["cat"; "/new"]], "data")],
2748 "mount a guest disk, read-only",
2750 This is the same as the C<guestfs_mount> command, but it
2751 mounts the filesystem with the read-only (I<-o ro>) flag.");
2753 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2755 "mount a guest disk with mount options",
2757 This is the same as the C<guestfs_mount> command, but it
2758 allows you to set the mount options as for the
2759 L<mount(8)> I<-o> flag.
2761 If the C<options> parameter is an empty string, then
2762 no options are passed (all options default to whatever
2763 the filesystem uses).");
2765 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2767 "mount a guest disk with mount options and vfstype",
2769 This is the same as the C<guestfs_mount> command, but it
2770 allows you to set both the mount options and the vfstype
2771 as for the L<mount(8)> I<-o> and I<-t> flags.");
2773 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2775 "debugging and internals",
2777 The C<guestfs_debug> command exposes some internals of
2778 C<guestfsd> (the guestfs daemon) that runs inside the
2781 There is no comprehensive help for this command. You have
2782 to look at the file C<daemon/debug.c> in the libguestfs source
2783 to find out what you can do.");
2785 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2786 [InitEmpty, Always, TestOutputList (
2787 [["part_disk"; "/dev/sda"; "mbr"];
2788 ["pvcreate"; "/dev/sda1"];
2789 ["vgcreate"; "VG"; "/dev/sda1"];
2790 ["lvcreate"; "LV1"; "VG"; "50"];
2791 ["lvcreate"; "LV2"; "VG"; "50"];
2792 ["lvremove"; "/dev/VG/LV1"];
2793 ["lvs"]], ["/dev/VG/LV2"]);
2794 InitEmpty, Always, TestOutputList (
2795 [["part_disk"; "/dev/sda"; "mbr"];
2796 ["pvcreate"; "/dev/sda1"];
2797 ["vgcreate"; "VG"; "/dev/sda1"];
2798 ["lvcreate"; "LV1"; "VG"; "50"];
2799 ["lvcreate"; "LV2"; "VG"; "50"];
2800 ["lvremove"; "/dev/VG"];
2802 InitEmpty, Always, TestOutputList (
2803 [["part_disk"; "/dev/sda"; "mbr"];
2804 ["pvcreate"; "/dev/sda1"];
2805 ["vgcreate"; "VG"; "/dev/sda1"];
2806 ["lvcreate"; "LV1"; "VG"; "50"];
2807 ["lvcreate"; "LV2"; "VG"; "50"];
2808 ["lvremove"; "/dev/VG"];
2810 "remove an LVM logical volume",
2812 Remove an LVM logical volume C<device>, where C<device> is
2813 the path to the LV, such as C</dev/VG/LV>.
2815 You can also remove all LVs in a volume group by specifying
2816 the VG name, C</dev/VG>.");
2818 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2819 [InitEmpty, Always, TestOutputList (
2820 [["part_disk"; "/dev/sda"; "mbr"];
2821 ["pvcreate"; "/dev/sda1"];
2822 ["vgcreate"; "VG"; "/dev/sda1"];
2823 ["lvcreate"; "LV1"; "VG"; "50"];
2824 ["lvcreate"; "LV2"; "VG"; "50"];
2827 InitEmpty, Always, TestOutputList (
2828 [["part_disk"; "/dev/sda"; "mbr"];
2829 ["pvcreate"; "/dev/sda1"];
2830 ["vgcreate"; "VG"; "/dev/sda1"];
2831 ["lvcreate"; "LV1"; "VG"; "50"];
2832 ["lvcreate"; "LV2"; "VG"; "50"];
2835 "remove an LVM volume group",
2837 Remove an LVM volume group C<vgname>, (for example C<VG>).
2839 This also forcibly removes all logical volumes in the volume
2842 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2843 [InitEmpty, Always, TestOutputListOfDevices (
2844 [["part_disk"; "/dev/sda"; "mbr"];
2845 ["pvcreate"; "/dev/sda1"];
2846 ["vgcreate"; "VG"; "/dev/sda1"];
2847 ["lvcreate"; "LV1"; "VG"; "50"];
2848 ["lvcreate"; "LV2"; "VG"; "50"];
2850 ["pvremove"; "/dev/sda1"];
2852 InitEmpty, Always, TestOutputListOfDevices (
2853 [["part_disk"; "/dev/sda"; "mbr"];
2854 ["pvcreate"; "/dev/sda1"];
2855 ["vgcreate"; "VG"; "/dev/sda1"];
2856 ["lvcreate"; "LV1"; "VG"; "50"];
2857 ["lvcreate"; "LV2"; "VG"; "50"];
2859 ["pvremove"; "/dev/sda1"];
2861 InitEmpty, Always, TestOutputListOfDevices (
2862 [["part_disk"; "/dev/sda"; "mbr"];
2863 ["pvcreate"; "/dev/sda1"];
2864 ["vgcreate"; "VG"; "/dev/sda1"];
2865 ["lvcreate"; "LV1"; "VG"; "50"];
2866 ["lvcreate"; "LV2"; "VG"; "50"];
2868 ["pvremove"; "/dev/sda1"];
2870 "remove an LVM physical volume",
2872 This wipes a physical volume C<device> so that LVM will no longer
2875 The implementation uses the C<pvremove> command which refuses to
2876 wipe physical volumes that contain any volume groups, so you have
2877 to remove those first.");
2879 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2880 [InitBasicFS, Always, TestOutput (
2881 [["set_e2label"; "/dev/sda1"; "testlabel"];
2882 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2883 "set the ext2/3/4 filesystem label",
2885 This sets the ext2/3/4 filesystem label of the filesystem on
2886 C<device> to C<label>. Filesystem labels are limited to
2889 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2890 to return the existing label on a filesystem.");
2892 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2894 "get the ext2/3/4 filesystem label",
2896 This returns the ext2/3/4 filesystem label of the filesystem on
2899 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2900 (let uuid = uuidgen () in
2901 [InitBasicFS, Always, TestOutput (
2902 [["set_e2uuid"; "/dev/sda1"; uuid];
2903 ["get_e2uuid"; "/dev/sda1"]], uuid);
2904 InitBasicFS, Always, TestOutput (
2905 [["set_e2uuid"; "/dev/sda1"; "clear"];
2906 ["get_e2uuid"; "/dev/sda1"]], "");
2907 (* We can't predict what UUIDs will be, so just check the commands run. *)
2908 InitBasicFS, Always, TestRun (
2909 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2910 InitBasicFS, Always, TestRun (
2911 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2912 "set the ext2/3/4 filesystem UUID",
2914 This sets the ext2/3/4 filesystem UUID of the filesystem on
2915 C<device> to C<uuid>. The format of the UUID and alternatives
2916 such as C<clear>, C<random> and C<time> are described in the
2917 L<tune2fs(8)> manpage.
2919 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2920 to return the existing UUID of a filesystem.");
2922 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2923 (* Regression test for RHBZ#597112. *)
2924 (let uuid = uuidgen () in
2925 [InitNone, Always, TestOutput (
2926 [["mke2journal"; "1024"; "/dev/sdc"];
2927 ["set_e2uuid"; "/dev/sdc"; uuid];
2928 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2929 "get the ext2/3/4 filesystem UUID",
2931 This returns the ext2/3/4 filesystem UUID of the filesystem on
2934 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2935 [InitBasicFS, Always, TestOutputInt (
2936 [["umount"; "/dev/sda1"];
2937 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2938 InitBasicFS, Always, TestOutputInt (
2939 [["umount"; "/dev/sda1"];
2940 ["zero"; "/dev/sda1"];
2941 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2942 "run the filesystem checker",
2944 This runs the filesystem checker (fsck) on C<device> which
2945 should have filesystem type C<fstype>.
2947 The returned integer is the status. See L<fsck(8)> for the
2948 list of status codes from C<fsck>.
2956 Multiple status codes can be summed together.
2960 A non-zero return code can mean \"success\", for example if
2961 errors have been corrected on the filesystem.
2965 Checking or repairing NTFS volumes is not supported
2970 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2972 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2973 [InitBasicFS, Always, TestOutput (
2974 [["umount"; "/dev/sda1"];
2975 ["zero"; "/dev/sda1"];
2976 ["file"; "/dev/sda1"]], "data")],
2977 "write zeroes to the device",
2979 This command writes zeroes over the first few blocks of C<device>.
2981 How many blocks are zeroed isn't specified (but it's I<not> enough
2982 to securely wipe the device). It should be sufficient to remove
2983 any partition tables, filesystem superblocks and so on.
2985 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2987 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2989 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2990 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2992 [InitBasicFS, Always, TestOutputTrue (
2993 [["mkdir_p"; "/boot/grub"];
2994 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2995 ["grub_install"; "/"; "/dev/vda"];
2996 ["is_dir"; "/boot"]])],
2999 This command installs GRUB (the Grand Unified Bootloader) on
3000 C<device>, with the root directory being C<root>.
3002 Note: If grub-install reports the error
3003 \"No suitable drive was found in the generated device map.\"
3004 it may be that you need to create a C</boot/grub/device.map>
3005 file first that contains the mapping between grub device names
3006 and Linux device names. It is usually sufficient to create
3011 replacing C</dev/vda> with the name of the installation device.");
3013 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3014 [InitScratchFS, Always, TestOutput (
3016 ["write"; "/cp/old"; "file content"];
3017 ["cp"; "/cp/old"; "/cp/new"];
3018 ["cat"; "/cp/new"]], "file content");
3019 InitScratchFS, Always, TestOutputTrue (
3021 ["write"; "/cp2/old"; "file content"];
3022 ["cp"; "/cp2/old"; "/cp2/new"];
3023 ["is_file"; "/cp2/old"]]);
3024 InitScratchFS, Always, TestOutput (
3026 ["write"; "/cp3/old"; "file content"];
3027 ["mkdir"; "/cp3/dir"];
3028 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3029 ["cat"; "/cp3/dir/new"]], "file content")],
3032 This copies a file from C<src> to C<dest> where C<dest> is
3033 either a destination filename or destination directory.");
3035 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3036 [InitScratchFS, Always, TestOutput (
3037 [["mkdir"; "/cp_a1"];
3038 ["mkdir"; "/cp_a2"];
3039 ["write"; "/cp_a1/file"; "file content"];
3040 ["cp_a"; "/cp_a1"; "/cp_a2"];
3041 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3042 "copy a file or directory recursively",
3044 This copies a file or directory from C<src> to C<dest>
3045 recursively using the C<cp -a> command.");
3047 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3048 [InitScratchFS, Always, TestOutput (
3050 ["write"; "/mv/old"; "file content"];
3051 ["mv"; "/mv/old"; "/mv/new"];
3052 ["cat"; "/mv/new"]], "file content");
3053 InitScratchFS, Always, TestOutputFalse (
3055 ["write"; "/mv2/old"; "file content"];
3056 ["mv"; "/mv2/old"; "/mv2/new"];
3057 ["is_file"; "/mv2/old"]])],
3060 This moves a file from C<src> to C<dest> where C<dest> is
3061 either a destination filename or destination directory.");
3063 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3064 [InitEmpty, Always, TestRun (
3065 [["drop_caches"; "3"]])],
3066 "drop kernel page cache, dentries and inodes",
3068 This instructs the guest kernel to drop its page cache,
3069 and/or dentries and inode caches. The parameter C<whattodrop>
3070 tells the kernel what precisely to drop, see
3071 L<http://linux-mm.org/Drop_Caches>
3073 Setting C<whattodrop> to 3 should drop everything.
3075 This automatically calls L<sync(2)> before the operation,
3076 so that the maximum guest memory is freed.");
3078 ("dmesg", (RString "kmsgs", [], []), 91, [],
3079 [InitEmpty, Always, TestRun (
3081 "return kernel messages",
3083 This returns the kernel messages (C<dmesg> output) from
3084 the guest kernel. This is sometimes useful for extended
3085 debugging of problems.
3087 Another way to get the same information is to enable
3088 verbose messages with C<guestfs_set_verbose> or by setting
3089 the environment variable C<LIBGUESTFS_DEBUG=1> before
3090 running the program.");
3092 ("ping_daemon", (RErr, [], []), 92, [],
3093 [InitEmpty, Always, TestRun (
3094 [["ping_daemon"]])],
3095 "ping the guest daemon",
3097 This is a test probe into the guestfs daemon running inside
3098 the qemu subprocess. Calling this function checks that the
3099 daemon responds to the ping message, without affecting the daemon
3100 or attached block device(s) in any other way.");
3102 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3103 [InitScratchFS, Always, TestOutputTrue (
3104 [["mkdir"; "/equal"];
3105 ["write"; "/equal/file1"; "contents of a file"];
3106 ["cp"; "/equal/file1"; "/equal/file2"];
3107 ["equal"; "/equal/file1"; "/equal/file2"]]);
3108 InitScratchFS, Always, TestOutputFalse (
3109 [["mkdir"; "/equal2"];
3110 ["write"; "/equal2/file1"; "contents of a file"];
3111 ["write"; "/equal2/file2"; "contents of another file"];
3112 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3113 InitScratchFS, Always, TestLastFail (
3114 [["mkdir"; "/equal3"];
3115 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3116 "test if two files have equal contents",
3118 This compares the two files C<file1> and C<file2> and returns
3119 true if their content is exactly equal, or false otherwise.
3121 The external L<cmp(1)> program is used for the comparison.");
3123 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3124 [InitISOFS, Always, TestOutputList (
3125 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3126 InitISOFS, Always, TestOutputList (
3127 [["strings"; "/empty"]], []);
3128 (* Test for RHBZ#579608, absolute symbolic links. *)
3129 InitISOFS, Always, TestRun (
3130 [["strings"; "/abssymlink"]])],
3131 "print the printable strings in a file",
3133 This runs the L<strings(1)> command on a file and returns
3134 the list of printable strings found.");
3136 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3137 [InitISOFS, Always, TestOutputList (
3138 [["strings_e"; "b"; "/known-5"]], []);
3139 InitScratchFS, Always, TestOutputList (
3140 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3141 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3142 "print the printable strings in a file",
3144 This is like the C<guestfs_strings> command, but allows you to
3145 specify the encoding of strings that are looked for in
3146 the source file C<path>.
3148 Allowed encodings are:
3154 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3155 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3159 Single 8-bit-byte characters.
3163 16-bit big endian strings such as those encoded in
3164 UTF-16BE or UCS-2BE.
3166 =item l (lower case letter L)
3168 16-bit little endian such as UTF-16LE and UCS-2LE.
3169 This is useful for examining binaries in Windows guests.
3173 32-bit big endian such as UCS-4BE.
3177 32-bit little endian such as UCS-4LE.
3181 The returned strings are transcoded to UTF-8.");
3183 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3184 [InitISOFS, Always, TestOutput (
3185 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3186 (* Test for RHBZ#501888c2 regression which caused large hexdump
3187 * commands to segfault.
3189 InitISOFS, Always, TestRun (
3190 [["hexdump"; "/100krandom"]]);
3191 (* Test for RHBZ#579608, absolute symbolic links. *)
3192 InitISOFS, Always, TestRun (
3193 [["hexdump"; "/abssymlink"]])],
3194 "dump a file in hexadecimal",
3196 This runs C<hexdump -C> on the given C<path>. The result is
3197 the human-readable, canonical hex dump of the file.");
3199 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3200 [InitNone, Always, TestOutput (
3201 [["part_disk"; "/dev/sda"; "mbr"];
3202 ["mkfs"; "ext3"; "/dev/sda1"];
3203 ["mount_options"; ""; "/dev/sda1"; "/"];
3204 ["write"; "/new"; "test file"];
3205 ["umount"; "/dev/sda1"];
3206 ["zerofree"; "/dev/sda1"];
3207 ["mount_options"; ""; "/dev/sda1"; "/"];
3208 ["cat"; "/new"]], "test file")],
3209 "zero unused inodes and disk blocks on ext2/3 filesystem",
3211 This runs the I<zerofree> program on C<device>. This program
3212 claims to zero unused inodes and disk blocks on an ext2/3
3213 filesystem, thus making it possible to compress the filesystem
3216 You should B<not> run this program if the filesystem is
3219 It is possible that using this program can damage the filesystem
3220 or data on the filesystem.");
3222 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3224 "resize an LVM physical volume",
3226 This resizes (expands or shrinks) an existing LVM physical
3227 volume to match the new size of the underlying device.");
3229 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3230 Int "cyls"; Int "heads"; Int "sectors";
3231 String "line"], []), 99, [DangerWillRobinson],
3233 "modify a single partition on a block device",
3235 This runs L<sfdisk(8)> option to modify just the single
3236 partition C<n> (note: C<n> counts from 1).
3238 For other parameters, see C<guestfs_sfdisk>. You should usually
3239 pass C<0> for the cyls/heads/sectors parameters.
3241 See also: C<guestfs_part_add>");
3243 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [],
3245 "display the partition table",
3247 This displays the partition table on C<device>, in the
3248 human-readable output of the L<sfdisk(8)> command. It is
3249 not intended to be parsed.
3251 See also: C<guestfs_part_list>");
3253 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3255 "display the kernel geometry",
3257 This displays the kernel's idea of the geometry of C<device>.
3259 The result is in human-readable format, and not designed to
3262 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3264 "display the disk geometry from the partition table",
3266 This displays the disk geometry of C<device> read from the
3267 partition table. Especially in the case where the underlying
3268 block device has been resized, this can be different from the
3269 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3271 The result is in human-readable format, and not designed to
3274 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3276 "activate or deactivate all volume groups",
3278 This command activates or (if C<activate> is false) deactivates
3279 all logical volumes in all volume groups.
3280 If activated, then they are made known to the
3281 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3282 then those devices disappear.
3284 This command is the same as running C<vgchange -a y|n>");
3286 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3288 "activate or deactivate some volume groups",
3290 This command activates or (if C<activate> is false) deactivates
3291 all logical volumes in the listed volume groups C<volgroups>.
3292 If activated, then they are made known to the
3293 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3294 then those devices disappear.
3296 This command is the same as running C<vgchange -a y|n volgroups...>
3298 Note that if C<volgroups> is an empty list then B<all> volume groups
3299 are activated or deactivated.");
3301 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3302 [InitNone, Always, TestOutput (
3303 [["part_disk"; "/dev/sda"; "mbr"];
3304 ["pvcreate"; "/dev/sda1"];
3305 ["vgcreate"; "VG"; "/dev/sda1"];
3306 ["lvcreate"; "LV"; "VG"; "10"];
3307 ["mkfs"; "ext2"; "/dev/VG/LV"];
3308 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3309 ["write"; "/new"; "test content"];
3311 ["lvresize"; "/dev/VG/LV"; "20"];
3312 ["e2fsck_f"; "/dev/VG/LV"];
3313 ["resize2fs"; "/dev/VG/LV"];
3314 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3315 ["cat"; "/new"]], "test content");
3316 InitNone, Always, TestRun (
3317 (* Make an LV smaller to test RHBZ#587484. *)
3318 [["part_disk"; "/dev/sda"; "mbr"];
3319 ["pvcreate"; "/dev/sda1"];
3320 ["vgcreate"; "VG"; "/dev/sda1"];
3321 ["lvcreate"; "LV"; "VG"; "20"];
3322 ["lvresize"; "/dev/VG/LV"; "10"]])],
3323 "resize an LVM logical volume",
3325 This resizes (expands or shrinks) an existing LVM logical
3326 volume to C<mbytes>. When reducing, data in the reduced part
3329 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3330 [], (* lvresize tests this *)
3331 "resize an ext2, ext3 or ext4 filesystem",
3333 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3334 the underlying device.
3336 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3337 on the C<device> before calling this command. For unknown reasons
3338 C<resize2fs> sometimes gives an error about this and sometimes not.
3339 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3340 calling this function.");
3342 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3343 [InitBasicFS, Always, TestOutputList (
3344 [["find"; "/"]], ["lost+found"]);
3345 InitBasicFS, Always, TestOutputList (
3349 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3350 InitScratchFS, Always, TestOutputList (
3351 [["mkdir_p"; "/find/b/c"];
3352 ["touch"; "/find/b/c/d"];
3353 ["find"; "/find/b/"]], ["c"; "c/d"])],
3354 "find all files and directories",
3356 This command lists out all files and directories, recursively,
3357 starting at C<directory>. It is essentially equivalent to
3358 running the shell command C<find directory -print> but some
3359 post-processing happens on the output, described below.
3361 This returns a list of strings I<without any prefix>. Thus
3362 if the directory structure was:
3368 then the returned list from C<guestfs_find> C</tmp> would be
3376 If C<directory> is not a directory, then this command returns
3379 The returned list is sorted.
3381 See also C<guestfs_find0>.");
3383 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3384 [], (* lvresize tests this *)
3385 "check an ext2/ext3 filesystem",
3387 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3388 filesystem checker on C<device>, noninteractively (I<-p>),
3389 even if the filesystem appears to be clean (I<-f>).
3391 This command is only needed because of C<guestfs_resize2fs>
3392 (q.v.). Normally you should use C<guestfs_fsck>.");
3394 ("sleep", (RErr, [Int "secs"], []), 109, [],
3395 [InitNone, Always, TestRun (
3397 "sleep for some seconds",
3399 Sleep for C<secs> seconds.");
3401 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3402 [InitNone, Always, TestOutputInt (
3403 [["part_disk"; "/dev/sda"; "mbr"];
3404 ["mkfs"; "ntfs"; "/dev/sda1"];
3405 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3406 InitNone, Always, TestOutputInt (
3407 [["part_disk"; "/dev/sda"; "mbr"];
3408 ["mkfs"; "ext2"; "/dev/sda1"];
3409 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3410 "probe NTFS volume",
3412 This command runs the L<ntfs-3g.probe(8)> command which probes
3413 an NTFS C<device> for mountability. (Not all NTFS volumes can
3414 be mounted read-write, and some cannot be mounted at all).
3416 C<rw> is a boolean flag. Set it to true if you want to test
3417 if the volume can be mounted read-write. Set it to false if
3418 you want to test if the volume can be mounted read-only.
3420 The return value is an integer which C<0> if the operation
3421 would succeed, or some non-zero value documented in the
3422 L<ntfs-3g.probe(8)> manual page.");
3424 ("sh", (RString "output", [String "command"], []), 111, [],
3425 [], (* XXX needs tests *)
3426 "run a command via the shell",
3428 This call runs a command from the guest filesystem via the
3431 This is like C<guestfs_command>, but passes the command to:
3433 /bin/sh -c \"command\"
3435 Depending on the guest's shell, this usually results in
3436 wildcards being expanded, shell expressions being interpolated
3439 All the provisos about C<guestfs_command> apply to this call.");
3441 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3442 [], (* XXX needs tests *)
3443 "run a command via the shell returning lines",
3445 This is the same as C<guestfs_sh>, but splits the result
3446 into a list of lines.
3448 See also: C<guestfs_command_lines>");
3450 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3451 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3452 * code in stubs.c, since all valid glob patterns must start with "/".
3453 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3455 [InitScratchFS, Always, TestOutputList (
3456 [["mkdir_p"; "/glob_expand/b/c"];
3457 ["touch"; "/glob_expand/b/c/d"];
3458 ["touch"; "/glob_expand/b/c/e"];
3459 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3460 InitScratchFS, Always, TestOutputList (
3461 [["mkdir_p"; "/glob_expand2/b/c"];
3462 ["touch"; "/glob_expand2/b/c/d"];
3463 ["touch"; "/glob_expand2/b/c/e"];
3464 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3465 InitScratchFS, Always, TestOutputList (
3466 [["mkdir_p"; "/glob_expand3/b/c"];
3467 ["touch"; "/glob_expand3/b/c/d"];
3468 ["touch"; "/glob_expand3/b/c/e"];
3469 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3470 "expand a wildcard path",
3472 This command searches for all the pathnames matching
3473 C<pattern> according to the wildcard expansion rules
3476 If no paths match, then this returns an empty list
3477 (note: not an error).
3479 It is just a wrapper around the C L<glob(3)> function
3480 with flags C<GLOB_MARK|GLOB_BRACE>.
3481 See that manual page for more details.");
3483 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3484 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3485 [["scrub_device"; "/dev/sdc"]])],
3486 "scrub (securely wipe) a device",
3488 This command writes patterns over C<device> to make data retrieval
3491 It is an interface to the L<scrub(1)> program. See that
3492 manual page for more details.");
3494 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3495 [InitScratchFS, Always, TestRun (
3496 [["write"; "/scrub_file"; "content"];
3497 ["scrub_file"; "/scrub_file"]])],
3498 "scrub (securely wipe) a file",
3500 This command writes patterns over a file to make data retrieval
3503 The file is I<removed> after scrubbing.
3505 It is an interface to the L<scrub(1)> program. See that
3506 manual page for more details.");
3508 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3509 [], (* XXX needs testing *)
3510 "scrub (securely wipe) free space",
3512 This command creates the directory C<dir> and then fills it
3513 with files until the filesystem is full, and scrubs the files
3514 as for C<guestfs_scrub_file>, and deletes them.
3515 The intention is to scrub any free space on the partition
3518 It is an interface to the L<scrub(1)> program. See that
3519 manual page for more details.");
3521 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3522 [InitScratchFS, Always, TestRun (
3523 [["mkdir"; "/mkdtemp"];
3524 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3525 "create a temporary directory",
3527 This command creates a temporary directory. The
3528 C<template> parameter should be a full pathname for the
3529 temporary directory name with the final six characters being
3532 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3533 the second one being suitable for Windows filesystems.
3535 The name of the temporary directory that was created
3538 The temporary directory is created with mode 0700
3539 and is owned by root.
3541 The caller is responsible for deleting the temporary
3542 directory and its contents after use.
3544 See also: L<mkdtemp(3)>");
3546 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3547 [InitISOFS, Always, TestOutputInt (
3548 [["wc_l"; "/10klines"]], 10000);
3549 (* Test for RHBZ#579608, absolute symbolic links. *)
3550 InitISOFS, Always, TestOutputInt (
3551 [["wc_l"; "/abssymlink"]], 10000)],
3552 "count lines in a file",
3554 This command counts the lines in a file, using the
3555 C<wc -l> external command.");
3557 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3558 [InitISOFS, Always, TestOutputInt (
3559 [["wc_w"; "/10klines"]], 10000)],
3560 "count words in a file",
3562 This command counts the words in a file, using the
3563 C<wc -w> external command.");
3565 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3566 [InitISOFS, Always, TestOutputInt (
3567 [["wc_c"; "/100kallspaces"]], 102400)],
3568 "count characters in a file",
3570 This command counts the characters in a file, using the
3571 C<wc -c> external command.");
3573 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3574 [InitISOFS, Always, TestOutputList (
3575 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3576 (* Test for RHBZ#579608, absolute symbolic links. *)
3577 InitISOFS, Always, TestOutputList (
3578 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3579 "return first 10 lines of a file",
3581 This command returns up to the first 10 lines of a file as
3582 a list of strings.");
3584 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3585 [InitISOFS, Always, TestOutputList (
3586 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3587 InitISOFS, Always, TestOutputList (
3588 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3589 InitISOFS, Always, TestOutputList (
3590 [["head_n"; "0"; "/10klines"]], [])],
3591 "return first N lines of a file",
3593 If the parameter C<nrlines> is a positive number, this returns the first
3594 C<nrlines> lines of the file C<path>.
3596 If the parameter C<nrlines> is a negative number, this returns lines
3597 from the file C<path>, excluding the last C<nrlines> lines.
3599 If the parameter C<nrlines> is zero, this returns an empty list.");
3601 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3602 [InitISOFS, Always, TestOutputList (
3603 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3604 "return last 10 lines of a file",
3606 This command returns up to the last 10 lines of a file as
3607 a list of strings.");
3609 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3610 [InitISOFS, Always, TestOutputList (
3611 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3612 InitISOFS, Always, TestOutputList (
3613 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3614 InitISOFS, Always, TestOutputList (
3615 [["tail_n"; "0"; "/10klines"]], [])],
3616 "return last N lines of a file",
3618 If the parameter C<nrlines> is a positive number, this returns the last
3619 C<nrlines> lines of the file C<path>.
3621 If the parameter C<nrlines> is a negative number, this returns lines
3622 from the file C<path>, starting with the C<-nrlines>th line.
3624 If the parameter C<nrlines> is zero, this returns an empty list.");
3626 ("df", (RString "output", [], []), 125, [],
3627 [], (* XXX Tricky to test because it depends on the exact format
3628 * of the 'df' command and other imponderables.
3630 "report file system disk space usage",
3632 This command runs the C<df> command to report disk space used.
3634 This command is mostly useful for interactive sessions. It
3635 is I<not> intended that you try to parse the output string.
3636 Use C<guestfs_statvfs> from programs.");
3638 ("df_h", (RString "output", [], []), 126, [],
3639 [], (* XXX Tricky to test because it depends on the exact format
3640 * of the 'df' command and other imponderables.
3642 "report file system disk space usage (human readable)",
3644 This command runs the C<df -h> command to report disk space used
3645 in human-readable format.
3647 This command is mostly useful for interactive sessions. It
3648 is I<not> intended that you try to parse the output string.
3649 Use C<guestfs_statvfs> from programs.");
3651 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3652 [InitISOFS, Always, TestOutputInt (
3653 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3654 "estimate file space usage",
3656 This command runs the C<du -s> command to estimate file space
3659 C<path> can be a file or a directory. If C<path> is a directory
3660 then the estimate includes the contents of the directory and all
3661 subdirectories (recursively).
3663 The result is the estimated size in I<kilobytes>
3664 (ie. units of 1024 bytes).");
3666 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3667 [InitISOFS, Always, TestOutputList (
3668 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3669 "list files in an initrd",
3671 This command lists out files contained in an initrd.
3673 The files are listed without any initial C</> character. The
3674 files are listed in the order they appear (not necessarily
3675 alphabetical). Directory names are listed as separate items.
3677 Old Linux kernels (2.4 and earlier) used a compressed ext2
3678 filesystem as initrd. We I<only> support the newer initramfs
3679 format (compressed cpio files).");
3681 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3683 "mount a file using the loop device",
3685 This command lets you mount C<file> (a filesystem image
3686 in a file) on a mount point. It is entirely equivalent to
3687 the command C<mount -o loop file mountpoint>.");
3689 ("mkswap", (RErr, [Device "device"], []), 130, [],
3690 [InitEmpty, Always, TestRun (
3691 [["part_disk"; "/dev/sda"; "mbr"];
3692 ["mkswap"; "/dev/sda1"]])],
3693 "create a swap partition",
3695 Create a swap partition on C<device>.");
3697 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3698 [InitEmpty, Always, TestRun (
3699 [["part_disk"; "/dev/sda"; "mbr"];
3700 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3701 "create a swap partition with a label",
3703 Create a swap partition on C<device> with label C<label>.
3705 Note that you cannot attach a swap label to a block device
3706 (eg. C</dev/sda>), just to a partition. This appears to be
3707 a limitation of the kernel or swap tools.");
3709 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3710 (let uuid = uuidgen () in
3711 [InitEmpty, Always, TestRun (
3712 [["part_disk"; "/dev/sda"; "mbr"];
3713 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3714 "create a swap partition with an explicit UUID",
3716 Create a swap partition on C<device> with UUID C<uuid>.");
3718 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3719 [InitScratchFS, Always, TestOutputStruct (
3720 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3721 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3722 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3723 InitScratchFS, Always, TestOutputStruct (
3724 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3725 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3726 "make block, character or FIFO devices",
3728 This call creates block or character special devices, or
3729 named pipes (FIFOs).
3731 The C<mode> parameter should be the mode, using the standard
3732 constants. C<devmajor> and C<devminor> are the
3733 device major and minor numbers, only used when creating block
3734 and character special devices.
3736 Note that, just like L<mknod(2)>, the mode must be bitwise
3737 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3738 just creates a regular file). These constants are
3739 available in the standard Linux header files, or you can use
3740 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3741 which are wrappers around this command which bitwise OR
3742 in the appropriate constant for you.
3744 The mode actually set is affected by the umask.");
3746 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3747 [InitScratchFS, Always, TestOutputStruct (
3748 [["mkfifo"; "0o777"; "/mkfifo"];
3749 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3750 "make FIFO (named pipe)",
3752 This call creates a FIFO (named pipe) called C<path> with
3753 mode C<mode>. It is just a convenient wrapper around
3756 The mode actually set is affected by the umask.");
3758 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3759 [InitScratchFS, Always, TestOutputStruct (
3760 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3761 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3762 "make block device node",
3764 This call creates a block device node called C<path> with
3765 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3766 It is just a convenient wrapper around C<guestfs_mknod>.
3768 The mode actually set is affected by the umask.");
3770 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3771 [InitScratchFS, Always, TestOutputStruct (
3772 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3773 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3774 "make char device node",
3776 This call creates a char device node called C<path> with
3777 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3778 It is just a convenient wrapper around C<guestfs_mknod>.
3780 The mode actually set is affected by the umask.");
3782 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3783 [InitEmpty, Always, TestOutputInt (
3784 [["umask"; "0o22"]], 0o22)],
3785 "set file mode creation mask (umask)",
3787 This function sets the mask used for creating new files and
3788 device nodes to C<mask & 0777>.
3790 Typical umask values would be C<022> which creates new files
3791 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3792 C<002> which creates new files with permissions like
3793 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3795 The default umask is C<022>. This is important because it
3796 means that directories and device nodes will be created with
3797 C<0644> or C<0755> mode even if you specify C<0777>.
3799 See also C<guestfs_get_umask>,
3800 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3802 This call returns the previous umask.");
3804 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3806 "read directories entries",
3808 This returns the list of directory entries in directory C<dir>.
3810 All entries in the directory are returned, including C<.> and
3811 C<..>. The entries are I<not> sorted, but returned in the same
3812 order as the underlying filesystem.
3814 Also this call returns basic file type information about each
3815 file. The C<ftyp> field will contain one of the following characters:
3853 The L<readdir(3)> call returned a C<d_type> field with an
3858 This function is primarily intended for use by programs. To
3859 get a simple list of names, use C<guestfs_ls>. To get a printable
3860 directory for human consumption, use C<guestfs_ll>.");
3862 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson],
3864 "create partitions on a block device",
3866 This is a simplified interface to the C<guestfs_sfdisk>
3867 command, where partition sizes are specified in megabytes
3868 only (rounded to the nearest cylinder) and you don't need
3869 to specify the cyls, heads and sectors parameters which
3870 were rarely if ever used anyway.
3872 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3873 and C<guestfs_part_disk>");
3875 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3877 "determine file type inside a compressed file",
3879 This command runs C<file> after first decompressing C<path>
3882 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3884 Since 1.0.63, use C<guestfs_file> instead which can now
3885 process compressed files.");
3887 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3889 "list extended attributes of a file or directory",
3891 This call lists the extended attributes of the file or directory
3894 At the system call level, this is a combination of the
3895 L<listxattr(2)> and L<getxattr(2)> calls.
3897 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3899 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3901 "list extended attributes of a file or directory",
3903 This is the same as C<guestfs_getxattrs>, but if C<path>
3904 is a symbolic link, then it returns the extended attributes
3905 of the link itself.");
3907 ("setxattr", (RErr, [String "xattr";
3908 String "val"; Int "vallen"; (* will be BufferIn *)
3909 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3911 "set extended attribute of a file or directory",
3913 This call sets the extended attribute named C<xattr>
3914 of the file C<path> to the value C<val> (of length C<vallen>).
3915 The value is arbitrary 8 bit data.
3917 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3919 ("lsetxattr", (RErr, [String "xattr";
3920 String "val"; Int "vallen"; (* will be BufferIn *)
3921 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3923 "set extended attribute of a file or directory",
3925 This is the same as C<guestfs_setxattr>, but if C<path>
3926 is a symbolic link, then it sets an extended attribute
3927 of the link itself.");
3929 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3931 "remove extended attribute of a file or directory",
3933 This call removes the extended attribute named C<xattr>
3934 of the file C<path>.
3936 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3938 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3940 "remove extended attribute of a file or directory",
3942 This is the same as C<guestfs_removexattr>, but if C<path>
3943 is a symbolic link, then it removes an extended attribute
3944 of the link itself.");
3946 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3950 This call is similar to C<guestfs_mounts>. That call returns
3951 a list of devices. This one returns a hash table (map) of
3952 device name to directory where the device is mounted.");
3954 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3955 (* This is a special case: while you would expect a parameter
3956 * of type "Pathname", that doesn't work, because it implies
3957 * NEED_ROOT in the generated calling code in stubs.c, and
3958 * this function cannot use NEED_ROOT.
3961 "create a mountpoint",
3963 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3964 specialized calls that can be used to create extra mountpoints
3965 before mounting the first filesystem.
3967 These calls are I<only> necessary in some very limited circumstances,
3968 mainly the case where you want to mount a mix of unrelated and/or
3969 read-only filesystems together.
3971 For example, live CDs often contain a \"Russian doll\" nest of
3972 filesystems, an ISO outer layer, with a squashfs image inside, with
3973 an ext2/3 image inside that. You can unpack this as follows
3976 add-ro Fedora-11-i686-Live.iso
3980 mkmountpoint /ext3fs
3982 mount-loop /cd/LiveOS/squashfs.img /sqsh
3983 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3985 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3987 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3988 You may get unexpected errors if you try to mix these calls. It is
3989 safest to manually unmount filesystems and remove mountpoints after use.
3991 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3992 longest first, so for this to work for manual mountpoints, you
3993 must ensure that the innermost mountpoints have the longest
3994 pathnames, as in the example code above.
3996 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3998 Autosync [see C<guestfs_set_autosync>, this is set by default on
3999 handles] can cause C<guestfs_umount_all> to be called when the handle
4000 is closed which can also trigger these issues.");
4002 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4004 "remove a mountpoint",
4006 This calls removes a mountpoint that was previously created
4007 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4008 for full details.");
4010 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4011 [InitISOFS, Always, TestOutputBuffer (
4012 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4013 (* Test various near large, large and too large files (RHBZ#589039). *)
4014 InitScratchFS, Always, TestLastFail (
4015 [["touch"; "/read_file"];
4016 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4017 ["read_file"; "/read_file"]]);
4018 InitScratchFS, Always, TestLastFail (
4019 [["touch"; "/read_file2"];
4020 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4021 ["read_file"; "/read_file2"]]);
4022 InitScratchFS, Always, TestLastFail (
4023 [["touch"; "/read_file3"];
4024 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4025 ["read_file"; "/read_file3"]])],
4028 This calls returns the contents of the file C<path> as a
4031 Unlike C<guestfs_cat>, this function can correctly
4032 handle files that contain embedded ASCII NUL characters.
4033 However unlike C<guestfs_download>, this function is limited
4034 in the total size of file that can be handled.");
4036 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4037 [InitISOFS, Always, TestOutputList (
4038 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4039 InitISOFS, Always, TestOutputList (
4040 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4041 (* Test for RHBZ#579608, absolute symbolic links. *)
4042 InitISOFS, Always, TestOutputList (
4043 [["grep"; "nomatch"; "/abssymlink"]], [])],
4044 "return lines matching a pattern",
4046 This calls the external C<grep> program and returns the
4049 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4050 [InitISOFS, Always, TestOutputList (
4051 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4052 "return lines matching a pattern",
4054 This calls the external C<egrep> program and returns the
4057 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4058 [InitISOFS, Always, TestOutputList (
4059 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4060 "return lines matching a pattern",
4062 This calls the external C<fgrep> program and returns the
4065 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4066 [InitISOFS, Always, TestOutputList (
4067 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4068 "return lines matching a pattern",
4070 This calls the external C<grep -i> program and returns the
4073 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4074 [InitISOFS, Always, TestOutputList (
4075 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4076 "return lines matching a pattern",
4078 This calls the external C<egrep -i> program and returns the
4081 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4082 [InitISOFS, Always, TestOutputList (
4083 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4084 "return lines matching a pattern",
4086 This calls the external C<fgrep -i> program and returns the
4089 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4090 [InitISOFS, Always, TestOutputList (
4091 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4092 "return lines matching a pattern",
4094 This calls the external C<zgrep> program and returns the
4097 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4098 [InitISOFS, Always, TestOutputList (
4099 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4100 "return lines matching a pattern",
4102 This calls the external C<zegrep> program and returns the
4105 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4106 [InitISOFS, Always, TestOutputList (
4107 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4108 "return lines matching a pattern",
4110 This calls the external C<zfgrep> program and returns the
4113 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4114 [InitISOFS, Always, TestOutputList (
4115 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4116 "return lines matching a pattern",
4118 This calls the external C<zgrep -i> program and returns the
4121 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4122 [InitISOFS, Always, TestOutputList (
4123 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4124 "return lines matching a pattern",
4126 This calls the external C<zegrep -i> program and returns the
4129 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4130 [InitISOFS, Always, TestOutputList (
4131 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4132 "return lines matching a pattern",
4134 This calls the external C<zfgrep -i> program and returns the
4137 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4138 [InitISOFS, Always, TestOutput (
4139 [["realpath"; "/../directory"]], "/directory")],
4140 "canonicalized absolute pathname",
4142 Return the canonicalized absolute pathname of C<path>. The
4143 returned path has no C<.>, C<..> or symbolic link path elements.");
4145 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4146 [InitScratchFS, Always, TestOutputStruct (
4149 ["ln"; "/ln/a"; "/ln/b"];
4150 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4151 "create a hard link",
4153 This command creates a hard link using the C<ln> command.");
4155 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4156 [InitScratchFS, Always, TestOutputStruct (
4157 [["mkdir"; "/ln_f"];
4158 ["touch"; "/ln_f/a"];
4159 ["touch"; "/ln_f/b"];
4160 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4161 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4162 "create a hard link",
4164 This command creates a hard link using the C<ln -f> command.
4165 The I<-f> option removes the link (C<linkname>) if it exists already.");
4167 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4168 [InitScratchFS, Always, TestOutputStruct (
4169 [["mkdir"; "/ln_s"];
4170 ["touch"; "/ln_s/a"];
4171 ["ln_s"; "a"; "/ln_s/b"];
4172 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4173 "create a symbolic link",
4175 This command creates a symbolic link using the C<ln -s> command.");
4177 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4178 [InitScratchFS, Always, TestOutput (
4179 [["mkdir_p"; "/ln_sf/b"];
4180 ["touch"; "/ln_sf/b/c"];
4181 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4182 ["readlink"; "/ln_sf/b/c"]], "../d")],
4183 "create a symbolic link",
4185 This command creates a symbolic link using the C<ln -sf> command,
4186 The I<-f> option removes the link (C<linkname>) if it exists already.");
4188 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4189 [] (* XXX tested above *),
4190 "read the target of a symbolic link",
4192 This command reads the target of a symbolic link.");
4194 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4195 [InitScratchFS, Always, TestOutputStruct (
4196 [["fallocate"; "/fallocate"; "1000000"];
4197 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4198 "preallocate a file in the guest filesystem",
4200 This command preallocates a file (containing zero bytes) named
4201 C<path> of size C<len> bytes. If the file exists already, it
4204 Do not confuse this with the guestfish-specific
4205 C<alloc> command which allocates a file in the host and
4206 attaches it as a device.");
4208 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4209 [InitPartition, Always, TestRun (
4210 [["mkswap"; "/dev/sda1"];
4211 ["swapon_device"; "/dev/sda1"];
4212 ["swapoff_device"; "/dev/sda1"]])],
4213 "enable swap on device",
4215 This command enables the libguestfs appliance to use the
4216 swap device or partition named C<device>. The increased
4217 memory is made available for all commands, for example
4218 those run using C<guestfs_command> or C<guestfs_sh>.
4220 Note that you should not swap to existing guest swap
4221 partitions unless you know what you are doing. They may
4222 contain hibernation information, or other information that
4223 the guest doesn't want you to trash. You also risk leaking
4224 information about the host to the guest this way. Instead,
4225 attach a new host device to the guest and swap on that.");
4227 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4228 [], (* XXX tested by swapon_device *)
4229 "disable swap on device",
4231 This command disables the libguestfs appliance swap
4232 device or partition named C<device>.
4233 See C<guestfs_swapon_device>.");
4235 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4236 [InitScratchFS, Always, TestRun (
4237 [["fallocate"; "/swapon_file"; "8388608"];
4238 ["mkswap_file"; "/swapon_file"];
4239 ["swapon_file"; "/swapon_file"];
4240 ["swapoff_file"; "/swapon_file"];
4241 ["rm"; "/swapon_file"]])],
4242 "enable swap on file",
4244 This command enables swap to a file.
4245 See C<guestfs_swapon_device> for other notes.");
4247 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4248 [], (* XXX tested by swapon_file *)
4249 "disable swap on file",
4251 This command disables the libguestfs appliance swap on file.");
4253 ("swapon_label", (RErr, [String "label"], []), 174, [],
4254 [InitEmpty, Always, TestRun (
4255 [["part_disk"; "/dev/sda"; "mbr"];
4256 ["mkswap_L"; "swapit"; "/dev/sda1"];
4257 ["swapon_label"; "swapit"];
4258 ["swapoff_label"; "swapit"];
4259 ["zero"; "/dev/sda"];
4260 ["blockdev_rereadpt"; "/dev/sda"]])],
4261 "enable swap on labeled swap partition",
4263 This command enables swap to a labeled swap partition.
4264 See C<guestfs_swapon_device> for other notes.");
4266 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4267 [], (* XXX tested by swapon_label *)
4268 "disable swap on labeled swap partition",
4270 This command disables the libguestfs appliance swap on
4271 labeled swap partition.");
4273 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4274 (let uuid = uuidgen () in
4275 [InitEmpty, Always, TestRun (
4276 [["mkswap_U"; uuid; "/dev/sdc"];
4277 ["swapon_uuid"; uuid];
4278 ["swapoff_uuid"; uuid]])]),
4279 "enable swap on swap partition by UUID",
4281 This command enables swap to a swap partition with the given UUID.
4282 See C<guestfs_swapon_device> for other notes.");
4284 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4285 [], (* XXX tested by swapon_uuid *)
4286 "disable swap on swap partition by UUID",
4288 This command disables the libguestfs appliance swap partition
4289 with the given UUID.");
4291 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4292 [InitScratchFS, Always, TestRun (
4293 [["fallocate"; "/mkswap_file"; "8388608"];
4294 ["mkswap_file"; "/mkswap_file"];
4295 ["rm"; "/mkswap_file"]])],
4296 "create a swap file",
4300 This command just writes a swap file signature to an existing
4301 file. To create the file itself, use something like C<guestfs_fallocate>.");
4303 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4304 [InitISOFS, Always, TestRun (
4305 [["inotify_init"; "0"]])],
4306 "create an inotify handle",
4308 This command creates a new inotify handle.
4309 The inotify subsystem can be used to notify events which happen to
4310 objects in the guest filesystem.
4312 C<maxevents> is the maximum number of events which will be
4313 queued up between calls to C<guestfs_inotify_read> or
4314 C<guestfs_inotify_files>.
4315 If this is passed as C<0>, then the kernel (or previously set)
4316 default is used. For Linux 2.6.29 the default was 16384 events.
4317 Beyond this limit, the kernel throws away events, but records
4318 the fact that it threw them away by setting a flag
4319 C<IN_Q_OVERFLOW> in the returned structure list (see
4320 C<guestfs_inotify_read>).
4322 Before any events are generated, you have to add some
4323 watches to the internal watch list. See:
4324 C<guestfs_inotify_add_watch>,
4325 C<guestfs_inotify_rm_watch> and
4326 C<guestfs_inotify_watch_all>.
4328 Queued up events should be read periodically by calling
4329 C<guestfs_inotify_read>
4330 (or C<guestfs_inotify_files> which is just a helpful
4331 wrapper around C<guestfs_inotify_read>). If you don't
4332 read the events out often enough then you risk the internal
4335 The handle should be closed after use by calling
4336 C<guestfs_inotify_close>. This also removes any
4337 watches automatically.
4339 See also L<inotify(7)> for an overview of the inotify interface
4340 as exposed by the Linux kernel, which is roughly what we expose
4341 via libguestfs. Note that there is one global inotify handle
4342 per libguestfs instance.");
4344 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4345 [InitScratchFS, Always, TestOutputList (
4346 [["mkdir"; "/inotify_add_watch"];
4347 ["inotify_init"; "0"];
4348 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4349 ["touch"; "/inotify_add_watch/a"];
4350 ["touch"; "/inotify_add_watch/b"];
4351 ["inotify_files"]], ["a"; "b"])],
4352 "add an inotify watch",
4354 Watch C<path> for the events listed in C<mask>.
4356 Note that if C<path> is a directory then events within that
4357 directory are watched, but this does I<not> happen recursively
4358 (in subdirectories).
4360 Note for non-C or non-Linux callers: the inotify events are
4361 defined by the Linux kernel ABI and are listed in
4362 C</usr/include/sys/inotify.h>.");
4364 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4366 "remove an inotify watch",
4368 Remove a previously defined inotify watch.
4369 See C<guestfs_inotify_add_watch>.");
4371 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4373 "return list of inotify events",
4375 Return the complete queue of events that have happened
4376 since the previous read call.
4378 If no events have happened, this returns an empty list.
4380 I<Note>: In order to make sure that all events have been
4381 read, you must call this function repeatedly until it
4382 returns an empty list. The reason is that the call will
4383 read events up to the maximum appliance-to-host message
4384 size and leave remaining events in the queue.");
4386 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4388 "return list of watched files that had events",
4390 This function is a helpful wrapper around C<guestfs_inotify_read>
4391 which just returns a list of pathnames of objects that were
4392 touched. The returned pathnames are sorted and deduplicated.");
4394 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4396 "close the inotify handle",
4398 This closes the inotify handle which was previously
4399 opened by inotify_init. It removes all watches, throws
4400 away any pending events, and deallocates all resources.");
4402 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4404 "set SELinux security context",
4406 This sets the SELinux security context of the daemon
4407 to the string C<context>.
4409 See the documentation about SELINUX in L<guestfs(3)>.");
4411 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4413 "get SELinux security context",
4415 This gets the SELinux security context of the daemon.
4417 See the documentation about SELINUX in L<guestfs(3)>,
4418 and C<guestfs_setcon>");
4420 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4421 [InitEmpty, Always, TestOutput (
4422 [["part_disk"; "/dev/sda"; "mbr"];
4423 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4424 ["mount_options"; ""; "/dev/sda1"; "/"];
4425 ["write"; "/new"; "new file contents"];
4426 ["cat"; "/new"]], "new file contents");
4427 InitEmpty, Always, TestRun (
4428 [["part_disk"; "/dev/sda"; "mbr"];
4429 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4430 InitEmpty, Always, TestLastFail (
4431 [["part_disk"; "/dev/sda"; "mbr"];
4432 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4433 InitEmpty, Always, TestLastFail (
4434 [["part_disk"; "/dev/sda"; "mbr"];
4435 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4436 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4437 [["part_disk"; "/dev/sda"; "mbr"];
4438 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4439 "make a filesystem with block size",
4441 This call is similar to C<guestfs_mkfs>, but it allows you to
4442 control the block size of the resulting filesystem. Supported
4443 block sizes depend on the filesystem type, but typically they
4444 are C<1024>, C<2048> or C<4096> only.
4446 For VFAT and NTFS the C<blocksize> parameter is treated as
4447 the requested cluster size.");
4449 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4450 [InitEmpty, Always, TestOutput (
4451 [["part_init"; "/dev/sda"; "mbr"];
4452 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4453 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4454 ["mke2journal"; "4096"; "/dev/sda1"];
4455 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4456 ["mount_options"; ""; "/dev/sda2"; "/"];
4457 ["write"; "/new"; "new file contents"];
4458 ["cat"; "/new"]], "new file contents")],
4459 "make ext2/3/4 external journal",
4461 This creates an ext2 external journal on C<device>. It is equivalent
4464 mke2fs -O journal_dev -b blocksize device");
4466 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4467 [InitEmpty, Always, TestOutput (
4468 [["part_init"; "/dev/sda"; "mbr"];
4469 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4470 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4471 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4472 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4473 ["mount_options"; ""; "/dev/sda2"; "/"];
4474 ["write"; "/new"; "new file contents"];
4475 ["cat"; "/new"]], "new file contents")],
4476 "make ext2/3/4 external journal with label",
4478 This creates an ext2 external journal on C<device> with label C<label>.");
4480 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4481 (let uuid = uuidgen () in
4482 [InitEmpty, Always, TestOutput (
4483 [["part_init"; "/dev/sda"; "mbr"];
4484 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4485 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4486 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4487 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4488 ["mount_options"; ""; "/dev/sda2"; "/"];
4489 ["write"; "/new"; "new file contents"];
4490 ["cat"; "/new"]], "new file contents")]),
4491 "make ext2/3/4 external journal with UUID",
4493 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4495 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4497 "make ext2/3/4 filesystem with external journal",
4499 This creates an ext2/3/4 filesystem on C<device> with
4500 an external journal on C<journal>. It is equivalent
4503 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4505 See also C<guestfs_mke2journal>.");
4507 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4509 "make ext2/3/4 filesystem with external journal",
4511 This creates an ext2/3/4 filesystem on C<device> with
4512 an external journal on the journal labeled C<label>.
4514 See also C<guestfs_mke2journal_L>.");
4516 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4518 "make ext2/3/4 filesystem with external journal",
4520 This creates an ext2/3/4 filesystem on C<device> with
4521 an external journal on the journal with UUID C<uuid>.
4523 See also C<guestfs_mke2journal_U>.");
4525 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4526 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4527 "load a kernel module",
4529 This loads a kernel module in the appliance.
4531 The kernel module must have been whitelisted when libguestfs
4532 was built (see C<appliance/kmod.whitelist.in> in the source).");
4534 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4535 [InitNone, Always, TestOutput (
4536 [["echo_daemon"; "This is a test"]], "This is a test"
4538 "echo arguments back to the client",
4540 This command concatenates the list of C<words> passed with single spaces
4541 between them and returns the resulting string.
4543 You can use this command to test the connection through to the daemon.
4545 See also C<guestfs_ping_daemon>.");
4547 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4548 [], (* There is a regression test for this. *)
4549 "find all files and directories, returning NUL-separated list",
4551 This command lists out all files and directories, recursively,
4552 starting at C<directory>, placing the resulting list in the
4553 external file called C<files>.
4555 This command works the same way as C<guestfs_find> with the
4556 following exceptions:
4562 The resulting list is written to an external file.
4566 Items (filenames) in the result are separated
4567 by C<\\0> characters. See L<find(1)> option I<-print0>.
4571 This command is not limited in the number of names that it
4576 The result list is not sorted.
4580 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4581 [InitISOFS, Always, TestOutput (
4582 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4583 InitISOFS, Always, TestOutput (
4584 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4585 InitISOFS, Always, TestOutput (
4586 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4587 InitISOFS, Always, TestLastFail (
4588 [["case_sensitive_path"; "/Known-1/"]]);
4589 InitScratchFS, Always, TestOutput (
4590 [["mkdir"; "/case_sensitive_path"];
4591 ["mkdir"; "/case_sensitive_path/bbb"];
4592 ["touch"; "/case_sensitive_path/bbb/c"];
4593 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4594 InitScratchFS, Always, TestOutput (
4595 [["mkdir"; "/case_sensitive_path2"];
4596 ["mkdir"; "/case_sensitive_path2/bbb"];
4597 ["touch"; "/case_sensitive_path2/bbb/c"];
4598 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4599 InitScratchFS, Always, TestLastFail (
4600 [["mkdir"; "/case_sensitive_path3"];
4601 ["mkdir"; "/case_sensitive_path3/bbb"];
4602 ["touch"; "/case_sensitive_path3/bbb/c"];
4603 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4604 "return true path on case-insensitive filesystem",
4606 This can be used to resolve case insensitive paths on
4607 a filesystem which is case sensitive. The use case is
4608 to resolve paths which you have read from Windows configuration
4609 files or the Windows Registry, to the true path.
4611 The command handles a peculiarity of the Linux ntfs-3g
4612 filesystem driver (and probably others), which is that although
4613 the underlying filesystem is case-insensitive, the driver
4614 exports the filesystem to Linux as case-sensitive.
4616 One consequence of this is that special directories such
4617 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4618 (or other things) depending on the precise details of how
4619 they were created. In Windows itself this would not be
4622 Bug or feature? You decide:
4623 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4625 This function resolves the true case of each element in the
4626 path and returns the case-sensitive path.
4628 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4629 might return C<\"/WINDOWS/system32\"> (the exact return value
4630 would depend on details of how the directories were originally
4631 created under Windows).
4634 This function does not handle drive names, backslashes etc.
4636 See also C<guestfs_realpath>.");
4638 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4639 [InitScratchFS, Always, TestOutput (
4640 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4641 "get the Linux VFS type corresponding to a mounted device",
4643 This command gets the filesystem type corresponding to
4644 the filesystem on C<device>.
4646 For most filesystems, the result is the name of the Linux
4647 VFS module which would be used to mount this filesystem
4648 if you mounted it without specifying the filesystem type.
4649 For example a string such as C<ext3> or C<ntfs>.");
4651 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4652 [InitScratchFS, Always, TestOutputStruct (
4653 [["write"; "/truncate"; "some stuff so size is not zero"];
4654 ["truncate"; "/truncate"];
4655 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4656 "truncate a file to zero size",
4658 This command truncates C<path> to a zero-length file. The
4659 file must exist already.");
4661 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4662 [InitScratchFS, Always, TestOutputStruct (
4663 [["touch"; "/truncate_size"];
4664 ["truncate_size"; "/truncate_size"; "1000"];
4665 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4666 "truncate a file to a particular size",
4668 This command truncates C<path> to size C<size> bytes. The file
4671 If the current file size is less than C<size> then
4672 the file is extended to the required size with zero bytes.
4673 This creates a sparse file (ie. disk blocks are not allocated
4674 for the file until you write to it). To create a non-sparse
4675 file of zeroes, use C<guestfs_fallocate64> instead.");
4677 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4678 [InitScratchFS, Always, TestOutputStruct (
4679 [["touch"; "/utimens"];
4680 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4681 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4682 "set timestamp of a file with nanosecond precision",
4684 This command sets the timestamps of a file with nanosecond
4687 C<atsecs, atnsecs> are the last access time (atime) in secs and
4688 nanoseconds from the epoch.
4690 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4691 secs and nanoseconds from the epoch.
4693 If the C<*nsecs> field contains the special value C<-1> then
4694 the corresponding timestamp is set to the current time. (The
4695 C<*secs> field is ignored in this case).
4697 If the C<*nsecs> field contains the special value C<-2> then
4698 the corresponding timestamp is left unchanged. (The
4699 C<*secs> field is ignored in this case).");
4701 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4702 [InitScratchFS, Always, TestOutputStruct (
4703 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4704 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4705 "create a directory with a particular mode",
4707 This command creates a directory, setting the initial permissions
4708 of the directory to C<mode>.
4710 For common Linux filesystems, the actual mode which is set will
4711 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4712 interpret the mode in other ways.
4714 See also C<guestfs_mkdir>, C<guestfs_umask>");
4716 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4718 "change file owner and group",
4720 Change the file owner to C<owner> and group to C<group>.
4721 This is like C<guestfs_chown> but if C<path> is a symlink then
4722 the link itself is changed, not the target.
4724 Only numeric uid and gid are supported. If you want to use
4725 names, you will need to locate and parse the password file
4726 yourself (Augeas support makes this relatively easy).");
4728 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4730 "lstat on multiple files",
4732 This call allows you to perform the C<guestfs_lstat> operation
4733 on multiple files, where all files are in the directory C<path>.
4734 C<names> is the list of files from this directory.
4736 On return you get a list of stat structs, with a one-to-one
4737 correspondence to the C<names> list. If any name did not exist
4738 or could not be lstat'd, then the C<ino> field of that structure
4741 This call is intended for programs that want to efficiently
4742 list a directory contents without making many round-trips.
4743 See also C<guestfs_lxattrlist> for a similarly efficient call
4744 for getting extended attributes. Very long directory listings
4745 might cause the protocol message size to be exceeded, causing
4746 this call to fail. The caller must split up such requests
4747 into smaller groups of names.");
4749 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4751 "lgetxattr on multiple files",
4753 This call allows you to get the extended attributes
4754 of multiple files, where all files are in the directory C<path>.
4755 C<names> is the list of files from this directory.
4757 On return you get a flat list of xattr structs which must be
4758 interpreted sequentially. The first xattr struct always has a zero-length
4759 C<attrname>. C<attrval> in this struct is zero-length
4760 to indicate there was an error doing C<lgetxattr> for this
4761 file, I<or> is a C string which is a decimal number
4762 (the number of following attributes for this file, which could
4763 be C<\"0\">). Then after the first xattr struct are the
4764 zero or more attributes for the first named file.
4765 This repeats for the second and subsequent files.
4767 This call is intended for programs that want to efficiently
4768 list a directory contents without making many round-trips.
4769 See also C<guestfs_lstatlist> for a similarly efficient call
4770 for getting standard stats. Very long directory listings
4771 might cause the protocol message size to be exceeded, causing
4772 this call to fail. The caller must split up such requests
4773 into smaller groups of names.");
4775 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4777 "readlink on multiple files",
4779 This call allows you to do a C<readlink> operation
4780 on multiple files, where all files are in the directory C<path>.
4781 C<names> is the list of files from this directory.
4783 On return you get a list of strings, with a one-to-one
4784 correspondence to the C<names> list. Each string is the
4785 value of the symbolic link.
4787 If the C<readlink(2)> operation fails on any name, then
4788 the corresponding result string is the empty string C<\"\">.
4789 However the whole operation is completed even if there
4790 were C<readlink(2)> errors, and so you can call this
4791 function with names where you don't know if they are
4792 symbolic links already (albeit slightly less efficient).
4794 This call is intended for programs that want to efficiently
4795 list a directory contents without making many round-trips.
4796 Very long directory listings might cause the protocol
4797 message size to be exceeded, causing
4798 this call to fail. The caller must split up such requests
4799 into smaller groups of names.");
4801 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4802 [InitISOFS, Always, TestOutputBuffer (
4803 [["pread"; "/known-4"; "1"; "3"]], "\n");
4804 InitISOFS, Always, TestOutputBuffer (
4805 [["pread"; "/empty"; "0"; "100"]], "")],
4806 "read part of a file",
4808 This command lets you read part of a file. It reads C<count>
4809 bytes of the file, starting at C<offset>, from file C<path>.
4811 This may read fewer bytes than requested. For further details
4812 see the L<pread(2)> system call.
4814 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4816 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4817 [InitEmpty, Always, TestRun (
4818 [["part_init"; "/dev/sda"; "gpt"]])],
4819 "create an empty partition table",
4821 This creates an empty partition table on C<device> of one of the
4822 partition types listed below. Usually C<parttype> should be
4823 either C<msdos> or C<gpt> (for large disks).
4825 Initially there are no partitions. Following this, you should
4826 call C<guestfs_part_add> for each partition required.
4828 Possible values for C<parttype> are:
4832 =item B<efi> | B<gpt>
4834 Intel EFI / GPT partition table.
4836 This is recommended for >= 2 TB partitions that will be accessed
4837 from Linux and Intel-based Mac OS X. It also has limited backwards
4838 compatibility with the C<mbr> format.
4840 =item B<mbr> | B<msdos>
4842 The standard PC \"Master Boot Record\" (MBR) format used
4843 by MS-DOS and Windows. This partition type will B<only> work
4844 for device sizes up to 2 TB. For large disks we recommend
4849 Other partition table types that may work but are not
4858 =item B<amiga> | B<rdb>
4860 Amiga \"Rigid Disk Block\" format.
4868 DASD, used on IBM mainframes.
4876 Old Mac partition format. Modern Macs use C<gpt>.
4880 NEC PC-98 format, common in Japan apparently.
4888 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4889 [InitEmpty, Always, TestRun (
4890 [["part_init"; "/dev/sda"; "mbr"];
4891 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4892 InitEmpty, Always, TestRun (
4893 [["part_init"; "/dev/sda"; "gpt"];
4894 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4895 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4896 InitEmpty, Always, TestRun (
4897 [["part_init"; "/dev/sda"; "mbr"];
4898 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4899 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4900 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4901 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4902 "add a partition to the device",
4904 This command adds a partition to C<device>. If there is no partition
4905 table on the device, call C<guestfs_part_init> first.
4907 The C<prlogex> parameter is the type of partition. Normally you
4908 should pass C<p> or C<primary> here, but MBR partition tables also
4909 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4912 C<startsect> and C<endsect> are the start and end of the partition
4913 in I<sectors>. C<endsect> may be negative, which means it counts
4914 backwards from the end of the disk (C<-1> is the last sector).
4916 Creating a partition which covers the whole disk is not so easy.
4917 Use C<guestfs_part_disk> to do that.");
4919 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4920 [InitEmpty, Always, TestRun (
4921 [["part_disk"; "/dev/sda"; "mbr"]]);
4922 InitEmpty, Always, TestRun (
4923 [["part_disk"; "/dev/sda"; "gpt"]])],
4924 "partition whole disk with a single primary partition",
4926 This command is simply a combination of C<guestfs_part_init>
4927 followed by C<guestfs_part_add> to create a single primary partition
4928 covering the whole disk.
4930 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4931 but other possible values are described in C<guestfs_part_init>.");
4933 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4934 [InitEmpty, Always, TestRun (
4935 [["part_disk"; "/dev/sda"; "mbr"];
4936 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4937 "make a partition bootable",
4939 This sets the bootable flag on partition numbered C<partnum> on
4940 device C<device>. Note that partitions are numbered from 1.
4942 The bootable flag is used by some operating systems (notably
4943 Windows) to determine which partition to boot from. It is by
4944 no means universally recognized.");
4946 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4947 [InitEmpty, Always, TestRun (
4948 [["part_disk"; "/dev/sda"; "gpt"];
4949 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4950 "set partition name",
4952 This sets the partition name on partition numbered C<partnum> on
4953 device C<device>. Note that partitions are numbered from 1.
4955 The partition name can only be set on certain types of partition
4956 table. This works on C<gpt> but not on C<mbr> partitions.");
4958 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4959 [], (* XXX Add a regression test for this. *)
4960 "list partitions on a device",
4962 This command parses the partition table on C<device> and
4963 returns the list of partitions found.
4965 The fields in the returned structure are:
4971 Partition number, counting from 1.
4975 Start of the partition I<in bytes>. To get sectors you have to
4976 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4980 End of the partition in bytes.
4984 Size of the partition in bytes.
4988 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4989 [InitEmpty, Always, TestOutput (
4990 [["part_disk"; "/dev/sda"; "gpt"];
4991 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4992 "get the partition table type",
4994 This command examines the partition table on C<device> and
4995 returns the partition table type (format) being used.
4997 Common return values include: C<msdos> (a DOS/Windows style MBR
4998 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4999 values are possible, although unusual. See C<guestfs_part_init>
5002 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5003 [InitScratchFS, Always, TestOutputBuffer (
5004 [["fill"; "0x63"; "10"; "/fill"];
5005 ["read_file"; "/fill"]], "cccccccccc")],
5006 "fill a file with octets",
5008 This command creates a new file called C<path>. The initial
5009 content of the file is C<len> octets of C<c>, where C<c>
5010 must be a number in the range C<[0..255]>.
5012 To fill a file with zero bytes (sparsely), it is
5013 much more efficient to use C<guestfs_truncate_size>.
5014 To create a file with a pattern of repeating bytes
5015 use C<guestfs_fill_pattern>.");
5017 ("available", (RErr, [StringList "groups"], []), 216, [],
5018 [InitNone, Always, TestRun [["available"; ""]]],
5019 "test availability of some parts of the API",
5021 This command is used to check the availability of some
5022 groups of functionality in the appliance, which not all builds of
5023 the libguestfs appliance will be able to provide.
5025 The libguestfs groups, and the functions that those
5026 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5027 You can also fetch this list at runtime by calling
5028 C<guestfs_available_all_groups>.
5030 The argument C<groups> is a list of group names, eg:
5031 C<[\"inotify\", \"augeas\"]> would check for the availability of
5032 the Linux inotify functions and Augeas (configuration file
5035 The command returns no error if I<all> requested groups are available.
5037 It fails with an error if one or more of the requested
5038 groups is unavailable in the appliance.
5040 If an unknown group name is included in the
5041 list of groups then an error is always returned.
5049 You must call C<guestfs_launch> before calling this function.
5051 The reason is because we don't know what groups are
5052 supported by the appliance/daemon until it is running and can
5057 If a group of functions is available, this does not necessarily
5058 mean that they will work. You still have to check for errors
5059 when calling individual API functions even if they are
5064 It is usually the job of distro packagers to build
5065 complete functionality into the libguestfs appliance.
5066 Upstream libguestfs, if built from source with all
5067 requirements satisfied, will support everything.
5071 This call was added in version C<1.0.80>. In previous
5072 versions of libguestfs all you could do would be to speculatively
5073 execute a command to find out if the daemon implemented it.
5074 See also C<guestfs_version>.
5078 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5079 [InitScratchFS, Always, TestOutputBuffer (
5081 ["write"; "/dd/src"; "hello, world"];
5082 ["dd"; "/dd/src"; "/dd/dest"];
5083 ["read_file"; "/dd/dest"]], "hello, world")],
5084 "copy from source to destination using dd",
5086 This command copies from one source device or file C<src>
5087 to another destination device or file C<dest>. Normally you
5088 would use this to copy to or from a device or partition, for
5089 example to duplicate a filesystem.
5091 If the destination is a device, it must be as large or larger
5092 than the source file or device, otherwise the copy will fail.
5093 This command cannot do partial copies (see C<guestfs_copy_size>).");
5095 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5096 [InitScratchFS, Always, TestOutputInt (
5097 [["write"; "/filesize"; "hello, world"];
5098 ["filesize"; "/filesize"]], 12)],
5099 "return the size of the file in bytes",
5101 This command returns the size of C<file> in bytes.
5103 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5104 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5105 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5107 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5108 [InitBasicFSonLVM, Always, TestOutputList (
5109 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5110 ["lvs"]], ["/dev/VG/LV2"])],
5111 "rename an LVM logical volume",
5113 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5115 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5116 [InitBasicFSonLVM, Always, TestOutputList (
5118 ["vg_activate"; "false"; "VG"];
5119 ["vgrename"; "VG"; "VG2"];
5120 ["vg_activate"; "true"; "VG2"];
5121 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5122 ["vgs"]], ["VG2"])],
5123 "rename an LVM volume group",
5125 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5127 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5128 [InitISOFS, Always, TestOutputBuffer (
5129 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5130 "list the contents of a single file in an initrd",
5132 This command unpacks the file C<filename> from the initrd file
5133 called C<initrdpath>. The filename must be given I<without> the
5134 initial C</> character.
5136 For example, in guestfish you could use the following command
5137 to examine the boot script (usually called C</init>)
5138 contained in a Linux initrd or initramfs image:
5140 initrd-cat /boot/initrd-<version>.img init
5142 See also C<guestfs_initrd_list>.");
5144 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5146 "get the UUID of a physical volume",
5148 This command returns the UUID of the LVM PV C<device>.");
5150 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5152 "get the UUID of a volume group",
5154 This command returns the UUID of the LVM VG named C<vgname>.");
5156 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5158 "get the UUID of a logical volume",
5160 This command returns the UUID of the LVM LV C<device>.");
5162 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5164 "get the PV UUIDs containing the volume group",
5166 Given a VG called C<vgname>, this returns the UUIDs of all
5167 the physical volumes that this volume group resides on.
5169 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5170 calls to associate physical volumes and volume groups.
5172 See also C<guestfs_vglvuuids>.");
5174 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5176 "get the LV UUIDs of all LVs in the volume group",
5178 Given a VG called C<vgname>, this returns the UUIDs of all
5179 the logical volumes created in this volume group.
5181 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5182 calls to associate logical volumes and volume groups.
5184 See also C<guestfs_vgpvuuids>.");
5186 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5187 [InitScratchFS, Always, TestOutputBuffer (
5188 [["mkdir"; "/copy_size"];
5189 ["write"; "/copy_size/src"; "hello, world"];
5190 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5191 ["read_file"; "/copy_size/dest"]], "hello")],
5192 "copy size bytes from source to destination using dd",
5194 This command copies exactly C<size> bytes from one source device
5195 or file C<src> to another destination device or file C<dest>.
5197 Note this will fail if the source is too short or if the destination
5198 is not large enough.");
5200 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5201 [InitBasicFSonLVM, Always, TestRun (
5202 [["zero_device"; "/dev/VG/LV"]])],
5203 "write zeroes to an entire device",
5205 This command writes zeroes over the entire C<device>. Compare
5206 with C<guestfs_zero> which just zeroes the first few blocks of
5209 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5210 [InitScratchFS, Always, TestOutput (
5211 [["mkdir"; "/txz_in"];
5212 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5213 ["cat"; "/txz_in/hello"]], "hello\n")],
5214 "unpack compressed tarball to directory",
5216 This command uploads and unpacks local file C<tarball> (an
5217 I<xz compressed> tar file) into C<directory>.");
5219 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5221 "pack directory into compressed tarball",
5223 This command packs the contents of C<directory> and downloads
5224 it to local file C<tarball> (as an xz compressed tar archive).");
5226 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5228 "resize an NTFS filesystem",
5230 This command resizes an NTFS filesystem, expanding or
5231 shrinking it to the size of the underlying device.
5232 See also L<ntfsresize(8)>.");
5234 ("vgscan", (RErr, [], []), 232, [],
5235 [InitEmpty, Always, TestRun (
5237 "rescan for LVM physical volumes, volume groups and logical volumes",
5239 This rescans all block devices and rebuilds the list of LVM
5240 physical volumes, volume groups and logical volumes.");
5242 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5243 [InitEmpty, Always, TestRun (
5244 [["part_init"; "/dev/sda"; "mbr"];
5245 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5246 ["part_del"; "/dev/sda"; "1"]])],
5247 "delete a partition",
5249 This command deletes the partition numbered C<partnum> on C<device>.
5251 Note that in the case of MBR partitioning, deleting an
5252 extended partition also deletes any logical partitions
5255 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5256 [InitEmpty, Always, TestOutputTrue (
5257 [["part_init"; "/dev/sda"; "mbr"];
5258 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5259 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5260 ["part_get_bootable"; "/dev/sda"; "1"]])],
5261 "return true if a partition is bootable",
5263 This command returns true if the partition C<partnum> on
5264 C<device> has the bootable flag set.
5266 See also C<guestfs_part_set_bootable>.");
5268 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5269 [InitEmpty, Always, TestOutputInt (
5270 [["part_init"; "/dev/sda"; "mbr"];
5271 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5272 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5273 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5274 "get the MBR type byte (ID byte) from a partition",
5276 Returns the MBR type byte (also known as the ID byte) from
5277 the numbered partition C<partnum>.
5279 Note that only MBR (old DOS-style) partitions have type bytes.
5280 You will get undefined results for other partition table
5281 types (see C<guestfs_part_get_parttype>).");
5283 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5284 [], (* tested by part_get_mbr_id *)
5285 "set the MBR type byte (ID byte) of a partition",
5287 Sets the MBR type byte (also known as the ID byte) of
5288 the numbered partition C<partnum> to C<idbyte>. Note
5289 that the type bytes quoted in most documentation are
5290 in fact hexadecimal numbers, but usually documented
5291 without any leading \"0x\" which might be confusing.
5293 Note that only MBR (old DOS-style) partitions have type bytes.
5294 You will get undefined results for other partition table
5295 types (see C<guestfs_part_get_parttype>).");
5297 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5298 [InitISOFS, Always, TestOutputFileMD5 (
5299 [["checksum_device"; "md5"; "/dev/sdd"]],
5300 "../images/test.iso")],
5301 "compute MD5, SHAx or CRC checksum of the contents of a device",
5303 This call computes the MD5, SHAx or CRC checksum of the
5304 contents of the device named C<device>. For the types of
5305 checksums supported see the C<guestfs_checksum> command.");
5307 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5308 [InitNone, Always, TestRun (
5309 [["part_disk"; "/dev/sda"; "mbr"];
5310 ["pvcreate"; "/dev/sda1"];
5311 ["vgcreate"; "VG"; "/dev/sda1"];
5312 ["lvcreate"; "LV"; "VG"; "10"];
5313 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5314 "expand an LV to fill free space",
5316 This expands an existing logical volume C<lv> so that it fills
5317 C<pc>% of the remaining free space in the volume group. Commonly
5318 you would call this with pc = 100 which expands the logical volume
5319 as much as possible, using all remaining free space in the volume
5322 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5323 [], (* XXX Augeas code needs tests. *)
5324 "clear Augeas path",
5326 Set the value associated with C<path> to C<NULL>. This
5327 is the same as the L<augtool(1)> C<clear> command.");
5329 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5330 [InitEmpty, Always, TestOutputInt (
5331 [["get_umask"]], 0o22)],
5332 "get the current umask",
5334 Return the current umask. By default the umask is C<022>
5335 unless it has been set by calling C<guestfs_umask>.");
5337 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5339 "upload a file to the appliance (internal use only)",
5341 The C<guestfs_debug_upload> command uploads a file to
5342 the libguestfs appliance.
5344 There is no comprehensive help for this command. You have
5345 to look at the file C<daemon/debug.c> in the libguestfs source
5346 to find out what it is for.");
5348 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5349 [InitScratchFS, Always, TestOutput (
5350 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5351 ["cat"; "/base64_in"]], "hello\n")],
5352 "upload base64-encoded data to file",
5354 This command uploads base64-encoded data from C<base64file>
5357 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5359 "download file and encode as base64",
5361 This command downloads the contents of C<filename>, writing
5362 it out to local file C<base64file> encoded as base64.");
5364 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5366 "compute MD5, SHAx or CRC checksum of files in a directory",
5368 This command computes the checksums of all regular files in
5369 C<directory> and then emits a list of those checksums to
5370 the local output file C<sumsfile>.
5372 This can be used for verifying the integrity of a virtual
5373 machine. However to be properly secure you should pay
5374 attention to the output of the checksum command (it uses
5375 the ones from GNU coreutils). In particular when the
5376 filename is not printable, coreutils uses a special
5377 backslash syntax. For more information, see the GNU
5378 coreutils info file.");
5380 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5381 [InitScratchFS, Always, TestOutputBuffer (
5382 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5383 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5384 "fill a file with a repeating pattern of bytes",
5386 This function is like C<guestfs_fill> except that it creates
5387 a new file of length C<len> containing the repeating pattern
5388 of bytes in C<pattern>. The pattern is truncated if necessary
5389 to ensure the length of the file is exactly C<len> bytes.");
5391 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5392 [InitScratchFS, Always, TestOutput (
5393 [["write"; "/write"; "new file contents"];
5394 ["cat"; "/write"]], "new file contents");
5395 InitScratchFS, Always, TestOutput (
5396 [["write"; "/write2"; "\nnew file contents\n"];
5397 ["cat"; "/write2"]], "\nnew file contents\n");
5398 InitScratchFS, Always, TestOutput (
5399 [["write"; "/write3"; "\n\n"];
5400 ["cat"; "/write3"]], "\n\n");
5401 InitScratchFS, Always, TestOutput (
5402 [["write"; "/write4"; ""];
5403 ["cat"; "/write4"]], "");
5404 InitScratchFS, Always, TestOutput (
5405 [["write"; "/write5"; "\n\n\n"];
5406 ["cat"; "/write5"]], "\n\n\n");
5407 InitScratchFS, Always, TestOutput (
5408 [["write"; "/write6"; "\n"];
5409 ["cat"; "/write6"]], "\n")],
5410 "create a new file",
5412 This call creates a file called C<path>. The content of the
5413 file is the string C<content> (which can contain any 8 bit data).");
5415 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5416 [InitScratchFS, Always, TestOutput (
5417 [["write"; "/pwrite"; "new file contents"];
5418 ["pwrite"; "/pwrite"; "data"; "4"];
5419 ["cat"; "/pwrite"]], "new data contents");
5420 InitScratchFS, Always, TestOutput (
5421 [["write"; "/pwrite2"; "new file contents"];
5422 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5423 ["cat"; "/pwrite2"]], "new file is extended");
5424 InitScratchFS, Always, TestOutput (
5425 [["write"; "/pwrite3"; "new file contents"];
5426 ["pwrite"; "/pwrite3"; ""; "4"];
5427 ["cat"; "/pwrite3"]], "new file contents")],
5428 "write to part of a file",
5430 This command writes to part of a file. It writes the data
5431 buffer C<content> to the file C<path> starting at offset C<offset>.
5433 This command implements the L<pwrite(2)> system call, and like
5434 that system call it may not write the full data requested. The
5435 return value is the number of bytes that were actually written
5436 to the file. This could even be 0, although short writes are
5437 unlikely for regular files in ordinary circumstances.
5439 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5441 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5443 "resize an ext2, ext3 or ext4 filesystem (with size)",
5445 This command is the same as C<guestfs_resize2fs> except that it
5446 allows you to specify the new size (in bytes) explicitly.");
5448 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5450 "resize an LVM physical volume (with size)",
5452 This command is the same as C<guestfs_pvresize> except that it
5453 allows you to specify the new size (in bytes) explicitly.");
5455 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5457 "resize an NTFS filesystem (with size)",
5459 This command is the same as C<guestfs_ntfsresize> except that it
5460 allows you to specify the new size (in bytes) explicitly.");
5462 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5463 [InitNone, Always, TestRun [["available_all_groups"]]],
5464 "return a list of all optional groups",
5466 This command returns a list of all optional groups that this
5467 daemon knows about. Note this returns both supported and unsupported
5468 groups. To find out which ones the daemon can actually support
5469 you have to call C<guestfs_available> on each member of the
5472 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5474 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5475 [InitScratchFS, Always, TestOutputStruct (
5476 [["fallocate64"; "/fallocate64"; "1000000"];
5477 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5478 "preallocate a file in the guest filesystem",
5480 This command preallocates a file (containing zero bytes) named
5481 C<path> of size C<len> bytes. If the file exists already, it
5484 Note that this call allocates disk blocks for the file.
5485 To create a sparse file use C<guestfs_truncate_size> instead.
5487 The deprecated call C<guestfs_fallocate> does the same,
5488 but owing to an oversight it only allowed 30 bit lengths
5489 to be specified, effectively limiting the maximum size
5490 of files created through that call to 1GB.
5492 Do not confuse this with the guestfish-specific
5493 C<alloc> and C<sparse> commands which create
5494 a file in the host and attach it as a device.");
5496 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5497 [InitBasicFS, Always, TestOutput (
5498 [["set_e2label"; "/dev/sda1"; "LTEST"];
5499 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5500 "get the filesystem label",
5502 This returns the filesystem label of the filesystem on
5505 If the filesystem is unlabeled, this returns the empty string.
5507 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5509 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5510 (let uuid = uuidgen () in
5511 [InitBasicFS, Always, TestOutput (
5512 [["set_e2uuid"; "/dev/sda1"; uuid];
5513 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5514 "get the filesystem UUID",
5516 This returns the filesystem UUID of the filesystem on
5519 If the filesystem does not have a UUID, this returns the empty string.
5521 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5523 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5524 (* Can't be tested with the current framework because
5525 * the VG is being used by the mounted filesystem, so
5526 * the vgchange -an command we do first will fail.
5529 "set LVM device filter",
5531 This sets the LVM device filter so that LVM will only be
5532 able to \"see\" the block devices in the list C<devices>,
5533 and will ignore all other attached block devices.
5535 Where disk image(s) contain duplicate PVs or VGs, this
5536 command is useful to get LVM to ignore the duplicates, otherwise
5537 LVM can get confused. Note also there are two types
5538 of duplication possible: either cloned PVs/VGs which have
5539 identical UUIDs; or VGs that are not cloned but just happen
5540 to have the same name. In normal operation you cannot
5541 create this situation, but you can do it outside LVM, eg.
5542 by cloning disk images or by bit twiddling inside the LVM
5545 This command also clears the LVM cache and performs a volume
5548 You can filter whole block devices or individual partitions.
5550 You cannot use this if any VG is currently in use (eg.
5551 contains a mounted filesystem), even if you are not
5552 filtering out that VG.");
5554 ("lvm_clear_filter", (RErr, [], []), 256, [],
5555 [], (* see note on lvm_set_filter *)
5556 "clear LVM device filter",
5558 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5559 will be able to see every block device.
5561 This command also clears the LVM cache and performs a volume
5564 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5566 "open a LUKS-encrypted block device",
5568 This command opens a block device which has been encrypted
5569 according to the Linux Unified Key Setup (LUKS) standard.
5571 C<device> is the encrypted block device or partition.
5573 The caller must supply one of the keys associated with the
5574 LUKS block device, in the C<key> parameter.
5576 This creates a new block device called C</dev/mapper/mapname>.
5577 Reads and writes to this block device are decrypted from and
5578 encrypted to the underlying C<device> respectively.
5580 If this block device contains LVM volume groups, then
5581 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5582 will make them visible.");
5584 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5586 "open a LUKS-encrypted block device read-only",
5588 This is the same as C<guestfs_luks_open> except that a read-only
5589 mapping is created.");
5591 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5593 "close a LUKS device",
5595 This closes a LUKS device that was created earlier by
5596 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5597 C<device> parameter must be the name of the LUKS mapping
5598 device (ie. C</dev/mapper/mapname>) and I<not> the name
5599 of the underlying block device.");
5601 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5603 "format a block device as a LUKS encrypted device",
5605 This command erases existing data on C<device> and formats
5606 the device as a LUKS encrypted device. C<key> is the
5607 initial key, which is added to key slot C<slot>. (LUKS
5608 supports 8 key slots, numbered 0-7).");
5610 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5612 "format a block device as a LUKS encrypted device",
5614 This command is the same as C<guestfs_luks_format> but
5615 it also allows you to set the C<cipher> used.");
5617 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5619 "add a key on a LUKS encrypted device",
5621 This command adds a new key on LUKS device C<device>.
5622 C<key> is any existing key, and is used to access the device.
5623 C<newkey> is the new key to add. C<keyslot> is the key slot
5624 that will be replaced.
5626 Note that if C<keyslot> already contains a key, then this
5627 command will fail. You have to use C<guestfs_luks_kill_slot>
5628 first to remove that key.");
5630 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5632 "remove a key from a LUKS encrypted device",
5634 This command deletes the key in key slot C<keyslot> from the
5635 encrypted LUKS device C<device>. C<key> must be one of the
5638 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5639 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5640 [["is_lv"; "/dev/VG/LV"]]);
5641 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5642 [["is_lv"; "/dev/sda1"]])],
5643 "test if device is a logical volume",
5645 This command tests whether C<device> is a logical volume, and
5646 returns true iff this is the case.");
5648 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5650 "find a filesystem by UUID",
5652 This command searches the filesystems and returns the one
5653 which has the given UUID. An error is returned if no such
5654 filesystem can be found.
5656 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5658 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5660 "find a filesystem by label",
5662 This command searches the filesystems and returns the one
5663 which has the given label. An error is returned if no such
5664 filesystem can be found.
5666 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5668 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5669 [InitISOFS, Always, TestOutputFalse (
5670 [["is_chardev"; "/directory"]]);
5671 InitScratchFS, Always, TestOutputTrue (
5672 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5673 ["is_chardev"; "/is_chardev"]])],
5674 "test if character device",
5676 This returns C<true> if and only if there is a character device
5677 with the given C<path> name.
5679 See also C<guestfs_stat>.");
5681 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5682 [InitISOFS, Always, TestOutputFalse (
5683 [["is_blockdev"; "/directory"]]);
5684 InitScratchFS, Always, TestOutputTrue (
5685 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5686 ["is_blockdev"; "/is_blockdev"]])],
5687 "test if block device",
5689 This returns C<true> if and only if there is a block device
5690 with the given C<path> name.
5692 See also C<guestfs_stat>.");
5694 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5695 [InitISOFS, Always, TestOutputFalse (
5696 [["is_fifo"; "/directory"]]);
5697 InitScratchFS, Always, TestOutputTrue (
5698 [["mkfifo"; "0o777"; "/is_fifo"];
5699 ["is_fifo"; "/is_fifo"]])],
5700 "test if FIFO (named pipe)",
5702 This returns C<true> if and only if there is a FIFO (named pipe)
5703 with the given C<path> name.
5705 See also C<guestfs_stat>.");
5707 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5708 [InitISOFS, Always, TestOutputFalse (
5709 [["is_symlink"; "/directory"]]);
5710 InitISOFS, Always, TestOutputTrue (
5711 [["is_symlink"; "/abssymlink"]])],
5712 "test if symbolic link",
5714 This returns C<true> if and only if there is a symbolic link
5715 with the given C<path> name.
5717 See also C<guestfs_stat>.");
5719 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5720 (* XXX Need a positive test for sockets. *)
5721 [InitISOFS, Always, TestOutputFalse (
5722 [["is_socket"; "/directory"]])],
5725 This returns C<true> if and only if there is a Unix domain socket
5726 with the given C<path> name.
5728 See also C<guestfs_stat>.");
5730 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5731 [InitPartition, Always, TestOutputDevice (
5732 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5733 InitEmpty, Always, TestLastFail (
5734 [["part_to_dev"; "/dev/sda"]])],
5735 "convert partition name to device name",
5737 This function takes a partition name (eg. \"/dev/sdb1\") and
5738 removes the partition number, returning the device name
5741 The named partition must exist, for example as a string returned
5742 from C<guestfs_list_partitions>.");
5744 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5745 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5746 [InitScratchFS, Always, TestOutput (
5747 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5748 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5749 "upload a file from the local machine with offset",
5751 Upload local file C<filename> to C<remotefilename> on the
5754 C<remotefilename> is overwritten starting at the byte C<offset>
5755 specified. The intention is to overwrite parts of existing
5756 files or devices, although if a non-existant file is specified
5757 then it is created with a \"hole\" before C<offset>. The
5758 size of the data written is implicit in the size of the
5761 Note that there is no limit on the amount of data that
5762 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5763 and this call always writes the full amount unless an
5766 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5768 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5769 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5770 let offset = string_of_int 100 in
5771 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5772 [InitScratchFS, Always, TestOutput (
5773 (* Pick a file from cwd which isn't likely to change. *)
5774 [["mkdir"; "/download_offset"];
5775 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5776 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5777 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5778 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5779 "download a file to the local machine with offset and size",
5781 Download file C<remotefilename> and save it as C<filename>
5782 on the local machine.
5784 C<remotefilename> is read for C<size> bytes starting at C<offset>
5785 (this region must be within the file or device).
5787 Note that there is no limit on the amount of data that
5788 can be downloaded with this call, unlike with C<guestfs_pread>,
5789 and this call always reads the full amount unless an
5792 See also C<guestfs_download>, C<guestfs_pread>.");
5794 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5795 [InitPartition, Always, TestOutputListOfDevices (
5796 [["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"];
5797 ["blockdev_rereadpt"; "/dev/sda"];
5798 ["list_partitions"]], ["/dev/sdb1"])],
5799 "write to part of a device",
5801 This command writes to part of a device. It writes the data
5802 buffer C<content> to C<device> starting at offset C<offset>.
5804 This command implements the L<pwrite(2)> system call, and like
5805 that system call it may not write the full data requested
5806 (although short writes to disk devices and partitions are
5807 probably impossible with standard Linux kernels).
5809 See also C<guestfs_pwrite>.");
5811 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5812 [InitEmpty, Always, TestOutputBuffer (
5813 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5814 "read part of a device",
5816 This command lets you read part of a file. It reads C<count>
5817 bytes of C<device>, starting at C<offset>.
5819 This may read fewer bytes than requested. For further details
5820 see the L<pread(2)> system call.
5822 See also C<guestfs_pread>.");
5824 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5825 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5826 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5827 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5828 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5829 "get canonical name of an LV",
5831 This converts alternative naming schemes for LVs that you
5832 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5833 is converted to C</dev/VG/LV>.
5835 This command returns an error if the C<lvname> parameter does
5836 not refer to a logical volume.
5838 See also C<guestfs_is_lv>.");
5840 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5841 [InitEmpty, Always, TestOutput (
5842 [["part_disk"; "/dev/sda"; "mbr"];
5843 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5844 ["mount_options"; ""; "/dev/sda1"; "/"];
5845 ["write"; "/new"; "new file contents"];
5846 ["cat"; "/new"]], "new file contents")],
5847 "make a filesystem",
5849 This function creates a filesystem on C<device>. The filesystem
5850 type is C<fstype>, for example C<ext3>.
5852 The optional arguments are:
5858 The filesystem block size. Supported block sizes depend on the
5859 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5860 for Linux ext2/3 filesystems.
5862 For VFAT and NTFS the C<blocksize> parameter is treated as
5863 the requested cluster size.
5865 For UFS block sizes, please see L<mkfs.ufs(8)>.
5869 This passes the I<-O> parameter to the external mkfs program.
5871 For certain filesystem types, this allows extra filesystem
5872 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5875 You cannot use this optional parameter with the C<gfs> or
5876 C<gfs2> filesystem type.
5880 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5882 "get a single extended attribute",
5884 Get a single extended attribute from file C<path> named C<name>.
5885 This call follows symlinks. If you want to lookup an extended
5886 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5888 Normally it is better to get all extended attributes from a file
5889 in one go by calling C<guestfs_getxattrs>. However some Linux
5890 filesystem implementations are buggy and do not provide a way to
5891 list out attributes. For these filesystems (notably ntfs-3g)
5892 you have to know the names of the extended attributes you want
5893 in advance and call this function.
5895 Extended attribute values are blobs of binary data. If there
5896 is no extended attribute named C<name>, this returns an error.
5898 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5900 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5902 "get a single extended attribute",
5904 Get a single extended attribute from file C<path> named C<name>.
5905 If C<path> is a symlink, then this call returns an extended
5906 attribute from the symlink.
5908 Normally it is better to get all extended attributes from a file
5909 in one go by calling C<guestfs_getxattrs>. However some Linux
5910 filesystem implementations are buggy and do not provide a way to
5911 list out attributes. For these filesystems (notably ntfs-3g)
5912 you have to know the names of the extended attributes you want
5913 in advance and call this function.
5915 Extended attribute values are blobs of binary data. If there
5916 is no extended attribute named C<name>, this returns an error.
5918 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5920 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5922 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5924 This command is the same as C<guestfs_resize2fs>, but the filesystem
5925 is resized to its minimum size. This works like the I<-M> option
5926 to the C<resize2fs> command.
5928 To get the resulting size of the filesystem you should call
5929 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5930 values. These two numbers, multiplied together, give the
5931 resulting size of the minimal filesystem in bytes.");
5933 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5935 "internal autosync operation",
5937 This command performs the autosync operation just before the
5938 handle is closed. You should not call this command directly.
5939 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5940 control whether or not this operation is performed when the
5941 handle is closed.");
5945 let all_functions = non_daemon_functions @ daemon_functions
5947 (* In some places we want the functions to be displayed sorted
5948 * alphabetically, so this is useful:
5950 let all_functions_sorted = List.sort action_compare all_functions
5952 (* This is used to generate the src/MAX_PROC_NR file which
5953 * contains the maximum procedure number, a surrogate for the
5954 * ABI version number. See src/Makefile.am for the details.
5957 let proc_nrs = List.map (
5958 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5959 ) daemon_functions in
5960 List.fold_left max 0 proc_nrs
5962 (* Non-API meta-commands available only in guestfish.
5964 * Note (1): style, proc_nr and tests fields are all meaningless.
5965 * The only fields which are actually used are the shortname,
5966 * FishAlias flags, shortdesc and longdesc.
5968 * Note (2): to refer to other commands, use L</shortname>.
5970 * Note (3): keep this list sorted by shortname.
5972 let fish_commands = [
5973 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5974 "allocate and add a disk file",
5975 " alloc filename size
5977 This creates an empty (zeroed) file of the given size, and then adds
5978 so it can be further examined.
5980 For more advanced image creation, see L<qemu-img(1)> utility.
5982 Size can be specified using standard suffixes, eg. C<1M>.
5984 To create a sparse file, use L</sparse> instead. To create a
5985 prepared disk image, see L</PREPARED DISK IMAGES>.");
5987 ("copy_in", (RErr,[], []), -1, [], [],
5988 "copy local files or directories into an image",
5989 " copy-in local [local ...] /remotedir
5991 C<copy-in> copies local files or directories recursively into the disk
5992 image, placing them in the directory called C</remotedir> (which must
5993 exist). This guestfish meta-command turns into a sequence of
5994 L</tar-in> and other commands as necessary.
5996 Multiple local files and directories can be specified, but the last
5997 parameter must always be a remote directory. Wildcards cannot be
6000 ("copy_out", (RErr,[], []), -1, [], [],
6001 "copy remote files or directories out of an image",
6002 " copy-out remote [remote ...] localdir
6004 C<copy-out> copies remote files or directories recursively out of the
6005 disk image, placing them on the host disk in a local directory called
6006 C<localdir> (which must exist). This guestfish meta-command turns
6007 into a sequence of L</download>, L</tar-out> and other commands as
6010 Multiple remote files and directories can be specified, but the last
6011 parameter must always be a local directory. To download to the
6012 current directory, use C<.> as in:
6016 Wildcards cannot be used in the ordinary command, but you can use
6017 them with the help of L</glob> like this:
6019 glob copy-out /home/* .");
6021 ("echo", (RErr,[], []), -1, [], [],
6022 "display a line of text",
6025 This echos the parameters to the terminal.");
6027 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6031 This is used to edit a file. It downloads the file, edits it
6032 locally using your editor, then uploads the result.
6034 The editor is C<$EDITOR>. However if you use the alternate
6035 commands C<vi> or C<emacs> you will get those corresponding
6038 ("glob", (RErr,[], []), -1, [], [],
6039 "expand wildcards in command",
6040 " glob command args...
6042 Expand wildcards in any paths in the args list, and run C<command>
6043 repeatedly on each matching path.
6045 See L</WILDCARDS AND GLOBBING>.");
6047 ("hexedit", (RErr,[], []), -1, [], [],
6048 "edit with a hex editor",
6049 " hexedit <filename|device>
6050 hexedit <filename|device> <max>
6051 hexedit <filename|device> <start> <max>
6053 Use hexedit (a hex editor) to edit all or part of a binary file
6056 This command works by downloading potentially the whole file or
6057 device, editing it locally, then uploading it. If the file or
6058 device is large, you have to specify which part you wish to edit
6059 by using C<max> and/or C<start> C<max> parameters.
6060 C<start> and C<max> are specified in bytes, with the usual
6061 modifiers allowed such as C<1M> (1 megabyte).
6063 For example to edit the first few sectors of a disk you
6068 which would allow you to edit anywhere within the first megabyte
6071 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6073 hexedit /dev/sda1 0x400 0x400
6075 (assuming the superblock is in the standard location).
6077 This command requires the external L<hexedit(1)> program. You
6078 can specify another program to use by setting the C<HEXEDITOR>
6079 environment variable.
6081 See also L</hexdump>.");
6083 ("lcd", (RErr,[], []), -1, [], [],
6084 "change working directory",
6087 Change the local directory, ie. the current directory of guestfish
6090 Note that C<!cd> won't do what you might expect.");
6092 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6096 Opens the manual page for guestfish.");
6098 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6104 This is used to view a file.
6106 The default viewer is C<$PAGER>. However if you use the alternate
6107 command C<less> you will get the C<less> command specifically.");
6109 ("reopen", (RErr,[], []), -1, [], [],
6110 "close and reopen libguestfs handle",
6113 Close and reopen the libguestfs handle. It is not necessary to use
6114 this normally, because the handle is closed properly when guestfish
6115 exits. However this is occasionally useful for testing.");
6117 ("sparse", (RErr,[], []), -1, [], [],
6118 "create a sparse disk image and add",
6119 " sparse filename size
6121 This creates an empty sparse file of the given size, and then adds
6122 so it can be further examined.
6124 In all respects it works the same as the L</alloc> command, except that
6125 the image file is allocated sparsely, which means that disk blocks are
6126 not assigned to the file until they are needed. Sparse disk files
6127 only use space when written to, but they are slower and there is a
6128 danger you could run out of real disk space during a write operation.
6130 For more advanced image creation, see L<qemu-img(1)> utility.
6132 Size can be specified using standard suffixes, eg. C<1M>.");
6134 ("supported", (RErr,[], []), -1, [], [],
6135 "list supported groups of commands",
6138 This command returns a list of the optional groups
6139 known to the daemon, and indicates which ones are
6140 supported by this build of the libguestfs appliance.
6142 See also L<guestfs(3)/AVAILABILITY>.");
6144 ("time", (RErr,[], []), -1, [], [],
6145 "print elapsed time taken to run a command",
6146 " time command args...
6148 Run the command as usual, but print the elapsed time afterwards. This
6149 can be useful for benchmarking operations.");