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; DeprecatedBy "launch"],
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, [DeprecatedBy "mount_options"],
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; DeprecatedBy "part_add"],
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 The output depends on the output of the underlying L<file(1)>
2272 command and it can change in future in ways beyond our control.
2273 In other words, the output is not guaranteed by the ABI.
2275 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2276 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2278 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2279 [InitScratchFS, Always, TestOutput (
2280 [["mkdir"; "/command"];
2281 ["upload"; "test-command"; "/command/test-command"];
2282 ["chmod"; "0o755"; "/command/test-command"];
2283 ["command"; "/command/test-command 1"]], "Result1");
2284 InitScratchFS, Always, TestOutput (
2285 [["mkdir"; "/command2"];
2286 ["upload"; "test-command"; "/command2/test-command"];
2287 ["chmod"; "0o755"; "/command2/test-command"];
2288 ["command"; "/command2/test-command 2"]], "Result2\n");
2289 InitScratchFS, Always, TestOutput (
2290 [["mkdir"; "/command3"];
2291 ["upload"; "test-command"; "/command3/test-command"];
2292 ["chmod"; "0o755"; "/command3/test-command"];
2293 ["command"; "/command3/test-command 3"]], "\nResult3");
2294 InitScratchFS, Always, TestOutput (
2295 [["mkdir"; "/command4"];
2296 ["upload"; "test-command"; "/command4/test-command"];
2297 ["chmod"; "0o755"; "/command4/test-command"];
2298 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2299 InitScratchFS, Always, TestOutput (
2300 [["mkdir"; "/command5"];
2301 ["upload"; "test-command"; "/command5/test-command"];
2302 ["chmod"; "0o755"; "/command5/test-command"];
2303 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2304 InitScratchFS, Always, TestOutput (
2305 [["mkdir"; "/command6"];
2306 ["upload"; "test-command"; "/command6/test-command"];
2307 ["chmod"; "0o755"; "/command6/test-command"];
2308 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2309 InitScratchFS, Always, TestOutput (
2310 [["mkdir"; "/command7"];
2311 ["upload"; "test-command"; "/command7/test-command"];
2312 ["chmod"; "0o755"; "/command7/test-command"];
2313 ["command"; "/command7/test-command 7"]], "");
2314 InitScratchFS, Always, TestOutput (
2315 [["mkdir"; "/command8"];
2316 ["upload"; "test-command"; "/command8/test-command"];
2317 ["chmod"; "0o755"; "/command8/test-command"];
2318 ["command"; "/command8/test-command 8"]], "\n");
2319 InitScratchFS, Always, TestOutput (
2320 [["mkdir"; "/command9"];
2321 ["upload"; "test-command"; "/command9/test-command"];
2322 ["chmod"; "0o755"; "/command9/test-command"];
2323 ["command"; "/command9/test-command 9"]], "\n\n");
2324 InitScratchFS, Always, TestOutput (
2325 [["mkdir"; "/command10"];
2326 ["upload"; "test-command"; "/command10/test-command"];
2327 ["chmod"; "0o755"; "/command10/test-command"];
2328 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2329 InitScratchFS, Always, TestOutput (
2330 [["mkdir"; "/command11"];
2331 ["upload"; "test-command"; "/command11/test-command"];
2332 ["chmod"; "0o755"; "/command11/test-command"];
2333 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2334 InitScratchFS, Always, TestLastFail (
2335 [["mkdir"; "/command12"];
2336 ["upload"; "test-command"; "/command12/test-command"];
2337 ["chmod"; "0o755"; "/command12/test-command"];
2338 ["command"; "/command12/test-command"]])],
2339 "run a command from the guest filesystem",
2341 This call runs a command from the guest filesystem. The
2342 filesystem must be mounted, and must contain a compatible
2343 operating system (ie. something Linux, with the same
2344 or compatible processor architecture).
2346 The single parameter is an argv-style list of arguments.
2347 The first element is the name of the program to run.
2348 Subsequent elements are parameters. The list must be
2349 non-empty (ie. must contain a program name). Note that
2350 the command runs directly, and is I<not> invoked via
2351 the shell (see C<guestfs_sh>).
2353 The return value is anything printed to I<stdout> by
2356 If the command returns a non-zero exit status, then
2357 this function returns an error message. The error message
2358 string is the content of I<stderr> from the command.
2360 The C<$PATH> environment variable will contain at least
2361 C</usr/bin> and C</bin>. If you require a program from
2362 another location, you should provide the full path in the
2365 Shared libraries and data files required by the program
2366 must be available on filesystems which are mounted in the
2367 correct places. It is the caller's responsibility to ensure
2368 all filesystems that are needed are mounted at the right
2371 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2372 [InitScratchFS, Always, TestOutputList (
2373 [["mkdir"; "/command_lines"];
2374 ["upload"; "test-command"; "/command_lines/test-command"];
2375 ["chmod"; "0o755"; "/command_lines/test-command"];
2376 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2377 InitScratchFS, Always, TestOutputList (
2378 [["mkdir"; "/command_lines2"];
2379 ["upload"; "test-command"; "/command_lines2/test-command"];
2380 ["chmod"; "0o755"; "/command_lines2/test-command"];
2381 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2382 InitScratchFS, Always, TestOutputList (
2383 [["mkdir"; "/command_lines3"];
2384 ["upload"; "test-command"; "/command_lines3/test-command"];
2385 ["chmod"; "0o755"; "/command_lines3/test-command"];
2386 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2387 InitScratchFS, Always, TestOutputList (
2388 [["mkdir"; "/command_lines4"];
2389 ["upload"; "test-command"; "/command_lines4/test-command"];
2390 ["chmod"; "0o755"; "/command_lines4/test-command"];
2391 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2392 InitScratchFS, Always, TestOutputList (
2393 [["mkdir"; "/command_lines5"];
2394 ["upload"; "test-command"; "/command_lines5/test-command"];
2395 ["chmod"; "0o755"; "/command_lines5/test-command"];
2396 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2397 InitScratchFS, Always, TestOutputList (
2398 [["mkdir"; "/command_lines6"];
2399 ["upload"; "test-command"; "/command_lines6/test-command"];
2400 ["chmod"; "0o755"; "/command_lines6/test-command"];
2401 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2402 InitScratchFS, Always, TestOutputList (
2403 [["mkdir"; "/command_lines7"];
2404 ["upload"; "test-command"; "/command_lines7/test-command"];
2405 ["chmod"; "0o755"; "/command_lines7/test-command"];
2406 ["command_lines"; "/command_lines7/test-command 7"]], []);
2407 InitScratchFS, Always, TestOutputList (
2408 [["mkdir"; "/command_lines8"];
2409 ["upload"; "test-command"; "/command_lines8/test-command"];
2410 ["chmod"; "0o755"; "/command_lines8/test-command"];
2411 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2412 InitScratchFS, Always, TestOutputList (
2413 [["mkdir"; "/command_lines9"];
2414 ["upload"; "test-command"; "/command_lines9/test-command"];
2415 ["chmod"; "0o755"; "/command_lines9/test-command"];
2416 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2417 InitScratchFS, Always, TestOutputList (
2418 [["mkdir"; "/command_lines10"];
2419 ["upload"; "test-command"; "/command_lines10/test-command"];
2420 ["chmod"; "0o755"; "/command_lines10/test-command"];
2421 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2422 InitScratchFS, Always, TestOutputList (
2423 [["mkdir"; "/command_lines11"];
2424 ["upload"; "test-command"; "/command_lines11/test-command"];
2425 ["chmod"; "0o755"; "/command_lines11/test-command"];
2426 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2427 "run a command, returning lines",
2429 This is the same as C<guestfs_command>, but splits the
2430 result into a list of lines.
2432 See also: C<guestfs_sh_lines>");
2434 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2435 [InitISOFS, Always, TestOutputStruct (
2436 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2437 "get file information",
2439 Returns file information for the given C<path>.
2441 This is the same as the C<stat(2)> system call.");
2443 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2444 [InitISOFS, Always, TestOutputStruct (
2445 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2446 "get file information for a symbolic link",
2448 Returns file information for the given C<path>.
2450 This is the same as C<guestfs_stat> except that if C<path>
2451 is a symbolic link, then the link is stat-ed, not the file it
2454 This is the same as the C<lstat(2)> system call.");
2456 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2457 [InitISOFS, Always, TestOutputStruct (
2458 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2459 "get file system statistics",
2461 Returns file system statistics for any mounted file system.
2462 C<path> should be a file or directory in the mounted file system
2463 (typically it is the mount point itself, but it doesn't need to be).
2465 This is the same as the C<statvfs(2)> system call.");
2467 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2469 "get ext2/ext3/ext4 superblock details",
2471 This returns the contents of the ext2, ext3 or ext4 filesystem
2472 superblock on C<device>.
2474 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2475 manpage for more details. The list of fields returned isn't
2476 clearly defined, and depends on both the version of C<tune2fs>
2477 that libguestfs was built against, and the filesystem itself.");
2479 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2480 [InitEmpty, Always, TestOutputTrue (
2481 [["blockdev_setro"; "/dev/sda"];
2482 ["blockdev_getro"; "/dev/sda"]])],
2483 "set block device to read-only",
2485 Sets the block device named C<device> to read-only.
2487 This uses the L<blockdev(8)> command.");
2489 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2490 [InitEmpty, Always, TestOutputFalse (
2491 [["blockdev_setrw"; "/dev/sda"];
2492 ["blockdev_getro"; "/dev/sda"]])],
2493 "set block device to read-write",
2495 Sets the block device named C<device> to read-write.
2497 This uses the L<blockdev(8)> command.");
2499 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2500 [InitEmpty, Always, TestOutputTrue (
2501 [["blockdev_setro"; "/dev/sda"];
2502 ["blockdev_getro"; "/dev/sda"]])],
2503 "is block device set to read-only",
2505 Returns a boolean indicating if the block device is read-only
2506 (true if read-only, false if not).
2508 This uses the L<blockdev(8)> command.");
2510 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2511 [InitEmpty, Always, TestOutputInt (
2512 [["blockdev_getss"; "/dev/sda"]], 512)],
2513 "get sectorsize of block device",
2515 This returns the size of sectors on a block device.
2516 Usually 512, but can be larger for modern devices.
2518 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2521 This uses the L<blockdev(8)> command.");
2523 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2524 [InitEmpty, Always, TestOutputInt (
2525 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2526 "get blocksize of block device",
2528 This returns the block size of a device.
2530 (Note this is different from both I<size in blocks> and
2531 I<filesystem block size>).
2533 This uses the L<blockdev(8)> command.");
2535 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2537 "set blocksize of block device",
2539 This sets the block size of a device.
2541 (Note this is different from both I<size in blocks> and
2542 I<filesystem block size>).
2544 This uses the L<blockdev(8)> command.");
2546 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2547 [InitEmpty, Always, TestOutputInt (
2548 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2549 "get total size of device in 512-byte sectors",
2551 This returns the size of the device in units of 512-byte sectors
2552 (even if the sectorsize isn't 512 bytes ... weird).
2554 See also C<guestfs_blockdev_getss> for the real sector size of
2555 the device, and C<guestfs_blockdev_getsize64> for the more
2556 useful I<size in bytes>.
2558 This uses the L<blockdev(8)> command.");
2560 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2561 [InitEmpty, Always, TestOutputInt (
2562 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2563 "get total size of device in bytes",
2565 This returns the size of the device in bytes.
2567 See also C<guestfs_blockdev_getsz>.
2569 This uses the L<blockdev(8)> command.");
2571 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2572 [InitEmpty, Always, TestRun
2573 [["blockdev_flushbufs"; "/dev/sda"]]],
2574 "flush device buffers",
2576 This tells the kernel to flush internal buffers associated
2579 This uses the L<blockdev(8)> command.");
2581 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2582 [InitEmpty, Always, TestRun
2583 [["blockdev_rereadpt"; "/dev/sda"]]],
2584 "reread partition table",
2586 Reread the partition table on C<device>.
2588 This uses the L<blockdev(8)> command.");
2590 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2591 [InitScratchFS, Always, TestOutput (
2592 (* Pick a file from cwd which isn't likely to change. *)
2593 [["mkdir"; "/upload"];
2594 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2595 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2596 Digest.to_hex (Digest.file "COPYING.LIB"))],
2597 "upload a file from the local machine",
2599 Upload local file C<filename> to C<remotefilename> on the
2602 C<filename> can also be a named pipe.
2604 See also C<guestfs_download>.");
2606 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2607 [InitScratchFS, Always, TestOutput (
2608 (* Pick a file from cwd which isn't likely to change. *)
2609 [["mkdir"; "/download"];
2610 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2611 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2612 ["upload"; "testdownload.tmp"; "/download/upload"];
2613 ["checksum"; "md5"; "/download/upload"]],
2614 Digest.to_hex (Digest.file "COPYING.LIB"))],
2615 "download a file to the local machine",
2617 Download file C<remotefilename> and save it as C<filename>
2618 on the local machine.
2620 C<filename> can also be a named pipe.
2622 See also C<guestfs_upload>, C<guestfs_cat>.");
2624 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2625 [InitISOFS, Always, TestOutput (
2626 [["checksum"; "crc"; "/known-3"]], "2891671662");
2627 InitISOFS, Always, TestLastFail (
2628 [["checksum"; "crc"; "/notexists"]]);
2629 InitISOFS, Always, TestOutput (
2630 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2631 InitISOFS, Always, TestOutput (
2632 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2633 InitISOFS, Always, TestOutput (
2634 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2635 InitISOFS, Always, TestOutput (
2636 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2637 InitISOFS, Always, TestOutput (
2638 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2639 InitISOFS, Always, TestOutput (
2640 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2641 (* Test for RHBZ#579608, absolute symbolic links. *)
2642 InitISOFS, Always, TestOutput (
2643 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2644 "compute MD5, SHAx or CRC checksum of file",
2646 This call computes the MD5, SHAx or CRC checksum of the
2649 The type of checksum to compute is given by the C<csumtype>
2650 parameter which must have one of the following values:
2656 Compute the cyclic redundancy check (CRC) specified by POSIX
2657 for the C<cksum> command.
2661 Compute the MD5 hash (using the C<md5sum> program).
2665 Compute the SHA1 hash (using the C<sha1sum> program).
2669 Compute the SHA224 hash (using the C<sha224sum> program).
2673 Compute the SHA256 hash (using the C<sha256sum> program).
2677 Compute the SHA384 hash (using the C<sha384sum> program).
2681 Compute the SHA512 hash (using the C<sha512sum> program).
2685 The checksum is returned as a printable string.
2687 To get the checksum for a device, use C<guestfs_checksum_device>.
2689 To get the checksums for many files, use C<guestfs_checksums_out>.");
2691 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2692 [InitScratchFS, Always, TestOutput (
2693 [["mkdir"; "/tar_in"];
2694 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2695 ["cat"; "/tar_in/hello"]], "hello\n")],
2696 "unpack tarfile to directory",
2698 This command uploads and unpacks local file C<tarfile> (an
2699 I<uncompressed> tar file) into C<directory>.
2701 To upload a compressed tarball, use C<guestfs_tgz_in>
2702 or C<guestfs_txz_in>.");
2704 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2706 "pack directory into tarfile",
2708 This command packs the contents of C<directory> and downloads
2709 it to local file C<tarfile>.
2711 To download a compressed tarball, use C<guestfs_tgz_out>
2712 or C<guestfs_txz_out>.");
2714 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2715 [InitScratchFS, Always, TestOutput (
2716 [["mkdir"; "/tgz_in"];
2717 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2718 ["cat"; "/tgz_in/hello"]], "hello\n")],
2719 "unpack compressed tarball to directory",
2721 This command uploads and unpacks local file C<tarball> (a
2722 I<gzip compressed> tar file) into C<directory>.
2724 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2726 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2728 "pack directory into compressed tarball",
2730 This command packs the contents of C<directory> and downloads
2731 it to local file C<tarball>.
2733 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2735 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2736 [InitBasicFS, Always, TestLastFail (
2738 ["mount_ro"; "/dev/sda1"; "/"];
2739 ["touch"; "/new"]]);
2740 InitBasicFS, Always, TestOutput (
2741 [["write"; "/new"; "data"];
2743 ["mount_ro"; "/dev/sda1"; "/"];
2744 ["cat"; "/new"]], "data")],
2745 "mount a guest disk, read-only",
2747 This is the same as the C<guestfs_mount> command, but it
2748 mounts the filesystem with the read-only (I<-o ro>) flag.");
2750 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2752 "mount a guest disk with mount options",
2754 This is the same as the C<guestfs_mount> command, but it
2755 allows you to set the mount options as for the
2756 L<mount(8)> I<-o> flag.
2758 If the C<options> parameter is an empty string, then
2759 no options are passed (all options default to whatever
2760 the filesystem uses).");
2762 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2764 "mount a guest disk with mount options and vfstype",
2766 This is the same as the C<guestfs_mount> command, but it
2767 allows you to set both the mount options and the vfstype
2768 as for the L<mount(8)> I<-o> and I<-t> flags.");
2770 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2772 "debugging and internals",
2774 The C<guestfs_debug> command exposes some internals of
2775 C<guestfsd> (the guestfs daemon) that runs inside the
2778 There is no comprehensive help for this command. You have
2779 to look at the file C<daemon/debug.c> in the libguestfs source
2780 to find out what you can do.");
2782 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2783 [InitEmpty, Always, TestOutputList (
2784 [["part_disk"; "/dev/sda"; "mbr"];
2785 ["pvcreate"; "/dev/sda1"];
2786 ["vgcreate"; "VG"; "/dev/sda1"];
2787 ["lvcreate"; "LV1"; "VG"; "50"];
2788 ["lvcreate"; "LV2"; "VG"; "50"];
2789 ["lvremove"; "/dev/VG/LV1"];
2790 ["lvs"]], ["/dev/VG/LV2"]);
2791 InitEmpty, Always, TestOutputList (
2792 [["part_disk"; "/dev/sda"; "mbr"];
2793 ["pvcreate"; "/dev/sda1"];
2794 ["vgcreate"; "VG"; "/dev/sda1"];
2795 ["lvcreate"; "LV1"; "VG"; "50"];
2796 ["lvcreate"; "LV2"; "VG"; "50"];
2797 ["lvremove"; "/dev/VG"];
2799 InitEmpty, Always, TestOutputList (
2800 [["part_disk"; "/dev/sda"; "mbr"];
2801 ["pvcreate"; "/dev/sda1"];
2802 ["vgcreate"; "VG"; "/dev/sda1"];
2803 ["lvcreate"; "LV1"; "VG"; "50"];
2804 ["lvcreate"; "LV2"; "VG"; "50"];
2805 ["lvremove"; "/dev/VG"];
2807 "remove an LVM logical volume",
2809 Remove an LVM logical volume C<device>, where C<device> is
2810 the path to the LV, such as C</dev/VG/LV>.
2812 You can also remove all LVs in a volume group by specifying
2813 the VG name, C</dev/VG>.");
2815 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2816 [InitEmpty, Always, TestOutputList (
2817 [["part_disk"; "/dev/sda"; "mbr"];
2818 ["pvcreate"; "/dev/sda1"];
2819 ["vgcreate"; "VG"; "/dev/sda1"];
2820 ["lvcreate"; "LV1"; "VG"; "50"];
2821 ["lvcreate"; "LV2"; "VG"; "50"];
2824 InitEmpty, Always, TestOutputList (
2825 [["part_disk"; "/dev/sda"; "mbr"];
2826 ["pvcreate"; "/dev/sda1"];
2827 ["vgcreate"; "VG"; "/dev/sda1"];
2828 ["lvcreate"; "LV1"; "VG"; "50"];
2829 ["lvcreate"; "LV2"; "VG"; "50"];
2832 "remove an LVM volume group",
2834 Remove an LVM volume group C<vgname>, (for example C<VG>).
2836 This also forcibly removes all logical volumes in the volume
2839 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2840 [InitEmpty, Always, TestOutputListOfDevices (
2841 [["part_disk"; "/dev/sda"; "mbr"];
2842 ["pvcreate"; "/dev/sda1"];
2843 ["vgcreate"; "VG"; "/dev/sda1"];
2844 ["lvcreate"; "LV1"; "VG"; "50"];
2845 ["lvcreate"; "LV2"; "VG"; "50"];
2847 ["pvremove"; "/dev/sda1"];
2849 InitEmpty, Always, TestOutputListOfDevices (
2850 [["part_disk"; "/dev/sda"; "mbr"];
2851 ["pvcreate"; "/dev/sda1"];
2852 ["vgcreate"; "VG"; "/dev/sda1"];
2853 ["lvcreate"; "LV1"; "VG"; "50"];
2854 ["lvcreate"; "LV2"; "VG"; "50"];
2856 ["pvremove"; "/dev/sda1"];
2858 InitEmpty, Always, TestOutputListOfDevices (
2859 [["part_disk"; "/dev/sda"; "mbr"];
2860 ["pvcreate"; "/dev/sda1"];
2861 ["vgcreate"; "VG"; "/dev/sda1"];
2862 ["lvcreate"; "LV1"; "VG"; "50"];
2863 ["lvcreate"; "LV2"; "VG"; "50"];
2865 ["pvremove"; "/dev/sda1"];
2867 "remove an LVM physical volume",
2869 This wipes a physical volume C<device> so that LVM will no longer
2872 The implementation uses the C<pvremove> command which refuses to
2873 wipe physical volumes that contain any volume groups, so you have
2874 to remove those first.");
2876 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2877 [InitBasicFS, Always, TestOutput (
2878 [["set_e2label"; "/dev/sda1"; "testlabel"];
2879 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2880 "set the ext2/3/4 filesystem label",
2882 This sets the ext2/3/4 filesystem label of the filesystem on
2883 C<device> to C<label>. Filesystem labels are limited to
2886 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2887 to return the existing label on a filesystem.");
2889 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2891 "get the ext2/3/4 filesystem label",
2893 This returns the ext2/3/4 filesystem label of the filesystem on
2896 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2897 (let uuid = uuidgen () in
2898 [InitBasicFS, Always, TestOutput (
2899 [["set_e2uuid"; "/dev/sda1"; uuid];
2900 ["get_e2uuid"; "/dev/sda1"]], uuid);
2901 InitBasicFS, Always, TestOutput (
2902 [["set_e2uuid"; "/dev/sda1"; "clear"];
2903 ["get_e2uuid"; "/dev/sda1"]], "");
2904 (* We can't predict what UUIDs will be, so just check the commands run. *)
2905 InitBasicFS, Always, TestRun (
2906 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2907 InitBasicFS, Always, TestRun (
2908 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2909 "set the ext2/3/4 filesystem UUID",
2911 This sets the ext2/3/4 filesystem UUID of the filesystem on
2912 C<device> to C<uuid>. The format of the UUID and alternatives
2913 such as C<clear>, C<random> and C<time> are described in the
2914 L<tune2fs(8)> manpage.
2916 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2917 to return the existing UUID of a filesystem.");
2919 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2920 (* Regression test for RHBZ#597112. *)
2921 (let uuid = uuidgen () in
2922 [InitNone, Always, TestOutput (
2923 [["mke2journal"; "1024"; "/dev/sdc"];
2924 ["set_e2uuid"; "/dev/sdc"; uuid];
2925 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2926 "get the ext2/3/4 filesystem UUID",
2928 This returns the ext2/3/4 filesystem UUID of the filesystem on
2931 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2932 [InitBasicFS, Always, TestOutputInt (
2933 [["umount"; "/dev/sda1"];
2934 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2935 InitBasicFS, Always, TestOutputInt (
2936 [["umount"; "/dev/sda1"];
2937 ["zero"; "/dev/sda1"];
2938 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2939 "run the filesystem checker",
2941 This runs the filesystem checker (fsck) on C<device> which
2942 should have filesystem type C<fstype>.
2944 The returned integer is the status. See L<fsck(8)> for the
2945 list of status codes from C<fsck>.
2953 Multiple status codes can be summed together.
2957 A non-zero return code can mean \"success\", for example if
2958 errors have been corrected on the filesystem.
2962 Checking or repairing NTFS volumes is not supported
2967 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2969 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2970 [InitBasicFS, Always, TestRun (
2971 [["umount"; "/dev/sda1"];
2972 ["zero"; "/dev/sda1"]])],
2973 "write zeroes to the device",
2975 This command writes zeroes over the first few blocks of C<device>.
2977 How many blocks are zeroed isn't specified (but it's I<not> enough
2978 to securely wipe the device). It should be sufficient to remove
2979 any partition tables, filesystem superblocks and so on.
2981 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
2982 C<guestfs_is_zero_device>");
2984 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2986 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2987 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2989 [InitBasicFS, Always, TestOutputTrue (
2990 [["mkdir_p"; "/boot/grub"];
2991 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2992 ["grub_install"; "/"; "/dev/vda"];
2993 ["is_dir"; "/boot"]])],
2996 This command installs GRUB (the Grand Unified Bootloader) on
2997 C<device>, with the root directory being C<root>.
2999 Note: If grub-install reports the error
3000 \"No suitable drive was found in the generated device map.\"
3001 it may be that you need to create a C</boot/grub/device.map>
3002 file first that contains the mapping between grub device names
3003 and Linux device names. It is usually sufficient to create
3008 replacing C</dev/vda> with the name of the installation device.");
3010 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3011 [InitScratchFS, Always, TestOutput (
3013 ["write"; "/cp/old"; "file content"];
3014 ["cp"; "/cp/old"; "/cp/new"];
3015 ["cat"; "/cp/new"]], "file content");
3016 InitScratchFS, Always, TestOutputTrue (
3018 ["write"; "/cp2/old"; "file content"];
3019 ["cp"; "/cp2/old"; "/cp2/new"];
3020 ["is_file"; "/cp2/old"]]);
3021 InitScratchFS, Always, TestOutput (
3023 ["write"; "/cp3/old"; "file content"];
3024 ["mkdir"; "/cp3/dir"];
3025 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3026 ["cat"; "/cp3/dir/new"]], "file content")],
3029 This copies a file from C<src> to C<dest> where C<dest> is
3030 either a destination filename or destination directory.");
3032 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3033 [InitScratchFS, Always, TestOutput (
3034 [["mkdir"; "/cp_a1"];
3035 ["mkdir"; "/cp_a2"];
3036 ["write"; "/cp_a1/file"; "file content"];
3037 ["cp_a"; "/cp_a1"; "/cp_a2"];
3038 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3039 "copy a file or directory recursively",
3041 This copies a file or directory from C<src> to C<dest>
3042 recursively using the C<cp -a> command.");
3044 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3045 [InitScratchFS, Always, TestOutput (
3047 ["write"; "/mv/old"; "file content"];
3048 ["mv"; "/mv/old"; "/mv/new"];
3049 ["cat"; "/mv/new"]], "file content");
3050 InitScratchFS, Always, TestOutputFalse (
3052 ["write"; "/mv2/old"; "file content"];
3053 ["mv"; "/mv2/old"; "/mv2/new"];
3054 ["is_file"; "/mv2/old"]])],
3057 This moves a file from C<src> to C<dest> where C<dest> is
3058 either a destination filename or destination directory.");
3060 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3061 [InitEmpty, Always, TestRun (
3062 [["drop_caches"; "3"]])],
3063 "drop kernel page cache, dentries and inodes",
3065 This instructs the guest kernel to drop its page cache,
3066 and/or dentries and inode caches. The parameter C<whattodrop>
3067 tells the kernel what precisely to drop, see
3068 L<http://linux-mm.org/Drop_Caches>
3070 Setting C<whattodrop> to 3 should drop everything.
3072 This automatically calls L<sync(2)> before the operation,
3073 so that the maximum guest memory is freed.");
3075 ("dmesg", (RString "kmsgs", [], []), 91, [],
3076 [InitEmpty, Always, TestRun (
3078 "return kernel messages",
3080 This returns the kernel messages (C<dmesg> output) from
3081 the guest kernel. This is sometimes useful for extended
3082 debugging of problems.
3084 Another way to get the same information is to enable
3085 verbose messages with C<guestfs_set_verbose> or by setting
3086 the environment variable C<LIBGUESTFS_DEBUG=1> before
3087 running the program.");
3089 ("ping_daemon", (RErr, [], []), 92, [],
3090 [InitEmpty, Always, TestRun (
3091 [["ping_daemon"]])],
3092 "ping the guest daemon",
3094 This is a test probe into the guestfs daemon running inside
3095 the qemu subprocess. Calling this function checks that the
3096 daemon responds to the ping message, without affecting the daemon
3097 or attached block device(s) in any other way.");
3099 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3100 [InitScratchFS, Always, TestOutputTrue (
3101 [["mkdir"; "/equal"];
3102 ["write"; "/equal/file1"; "contents of a file"];
3103 ["cp"; "/equal/file1"; "/equal/file2"];
3104 ["equal"; "/equal/file1"; "/equal/file2"]]);
3105 InitScratchFS, Always, TestOutputFalse (
3106 [["mkdir"; "/equal2"];
3107 ["write"; "/equal2/file1"; "contents of a file"];
3108 ["write"; "/equal2/file2"; "contents of another file"];
3109 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3110 InitScratchFS, Always, TestLastFail (
3111 [["mkdir"; "/equal3"];
3112 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3113 "test if two files have equal contents",
3115 This compares the two files C<file1> and C<file2> and returns
3116 true if their content is exactly equal, or false otherwise.
3118 The external L<cmp(1)> program is used for the comparison.");
3120 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3121 [InitISOFS, Always, TestOutputList (
3122 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3123 InitISOFS, Always, TestOutputList (
3124 [["strings"; "/empty"]], []);
3125 (* Test for RHBZ#579608, absolute symbolic links. *)
3126 InitISOFS, Always, TestRun (
3127 [["strings"; "/abssymlink"]])],
3128 "print the printable strings in a file",
3130 This runs the L<strings(1)> command on a file and returns
3131 the list of printable strings found.");
3133 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3134 [InitISOFS, Always, TestOutputList (
3135 [["strings_e"; "b"; "/known-5"]], []);
3136 InitScratchFS, Always, TestOutputList (
3137 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3138 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3139 "print the printable strings in a file",
3141 This is like the C<guestfs_strings> command, but allows you to
3142 specify the encoding of strings that are looked for in
3143 the source file C<path>.
3145 Allowed encodings are:
3151 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3152 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3156 Single 8-bit-byte characters.
3160 16-bit big endian strings such as those encoded in
3161 UTF-16BE or UCS-2BE.
3163 =item l (lower case letter L)
3165 16-bit little endian such as UTF-16LE and UCS-2LE.
3166 This is useful for examining binaries in Windows guests.
3170 32-bit big endian such as UCS-4BE.
3174 32-bit little endian such as UCS-4LE.
3178 The returned strings are transcoded to UTF-8.");
3180 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3181 [InitISOFS, Always, TestOutput (
3182 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3183 (* Test for RHBZ#501888c2 regression which caused large hexdump
3184 * commands to segfault.
3186 InitISOFS, Always, TestRun (
3187 [["hexdump"; "/100krandom"]]);
3188 (* Test for RHBZ#579608, absolute symbolic links. *)
3189 InitISOFS, Always, TestRun (
3190 [["hexdump"; "/abssymlink"]])],
3191 "dump a file in hexadecimal",
3193 This runs C<hexdump -C> on the given C<path>. The result is
3194 the human-readable, canonical hex dump of the file.");
3196 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3197 [InitNone, Always, TestOutput (
3198 [["part_disk"; "/dev/sda"; "mbr"];
3199 ["mkfs"; "ext3"; "/dev/sda1"];
3200 ["mount_options"; ""; "/dev/sda1"; "/"];
3201 ["write"; "/new"; "test file"];
3202 ["umount"; "/dev/sda1"];
3203 ["zerofree"; "/dev/sda1"];
3204 ["mount_options"; ""; "/dev/sda1"; "/"];
3205 ["cat"; "/new"]], "test file")],
3206 "zero unused inodes and disk blocks on ext2/3 filesystem",
3208 This runs the I<zerofree> program on C<device>. This program
3209 claims to zero unused inodes and disk blocks on an ext2/3
3210 filesystem, thus making it possible to compress the filesystem
3213 You should B<not> run this program if the filesystem is
3216 It is possible that using this program can damage the filesystem
3217 or data on the filesystem.");
3219 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3221 "resize an LVM physical volume",
3223 This resizes (expands or shrinks) an existing LVM physical
3224 volume to match the new size of the underlying device.");
3226 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3227 Int "cyls"; Int "heads"; Int "sectors";
3228 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3230 "modify a single partition on a block device",
3232 This runs L<sfdisk(8)> option to modify just the single
3233 partition C<n> (note: C<n> counts from 1).
3235 For other parameters, see C<guestfs_sfdisk>. You should usually
3236 pass C<0> for the cyls/heads/sectors parameters.
3238 See also: C<guestfs_part_add>");
3240 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3242 "display the partition table",
3244 This displays the partition table on C<device>, in the
3245 human-readable output of the L<sfdisk(8)> command. It is
3246 not intended to be parsed.
3248 See also: C<guestfs_part_list>");
3250 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3252 "display the kernel geometry",
3254 This displays the kernel's idea of the geometry of C<device>.
3256 The result is in human-readable format, and not designed to
3259 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3261 "display the disk geometry from the partition table",
3263 This displays the disk geometry of C<device> read from the
3264 partition table. Especially in the case where the underlying
3265 block device has been resized, this can be different from the
3266 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3268 The result is in human-readable format, and not designed to
3271 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3273 "activate or deactivate all volume groups",
3275 This command activates or (if C<activate> is false) deactivates
3276 all logical volumes in all volume groups.
3277 If activated, then they are made known to the
3278 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3279 then those devices disappear.
3281 This command is the same as running C<vgchange -a y|n>");
3283 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3285 "activate or deactivate some volume groups",
3287 This command activates or (if C<activate> is false) deactivates
3288 all logical volumes in the listed volume groups C<volgroups>.
3289 If activated, then they are made known to the
3290 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3291 then those devices disappear.
3293 This command is the same as running C<vgchange -a y|n volgroups...>
3295 Note that if C<volgroups> is an empty list then B<all> volume groups
3296 are activated or deactivated.");
3298 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3299 [InitNone, Always, TestOutput (
3300 [["part_disk"; "/dev/sda"; "mbr"];
3301 ["pvcreate"; "/dev/sda1"];
3302 ["vgcreate"; "VG"; "/dev/sda1"];
3303 ["lvcreate"; "LV"; "VG"; "10"];
3304 ["mkfs"; "ext2"; "/dev/VG/LV"];
3305 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3306 ["write"; "/new"; "test content"];
3308 ["lvresize"; "/dev/VG/LV"; "20"];
3309 ["e2fsck_f"; "/dev/VG/LV"];
3310 ["resize2fs"; "/dev/VG/LV"];
3311 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3312 ["cat"; "/new"]], "test content");
3313 InitNone, Always, TestRun (
3314 (* Make an LV smaller to test RHBZ#587484. *)
3315 [["part_disk"; "/dev/sda"; "mbr"];
3316 ["pvcreate"; "/dev/sda1"];
3317 ["vgcreate"; "VG"; "/dev/sda1"];
3318 ["lvcreate"; "LV"; "VG"; "20"];
3319 ["lvresize"; "/dev/VG/LV"; "10"]])],
3320 "resize an LVM logical volume",
3322 This resizes (expands or shrinks) an existing LVM logical
3323 volume to C<mbytes>. When reducing, data in the reduced part
3326 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3327 [], (* lvresize tests this *)
3328 "resize an ext2, ext3 or ext4 filesystem",
3330 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3331 the underlying device.
3333 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3334 on the C<device> before calling this command. For unknown reasons
3335 C<resize2fs> sometimes gives an error about this and sometimes not.
3336 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3337 calling this function.");
3339 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3340 [InitBasicFS, Always, TestOutputList (
3341 [["find"; "/"]], ["lost+found"]);
3342 InitBasicFS, Always, TestOutputList (
3346 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3347 InitScratchFS, Always, TestOutputList (
3348 [["mkdir_p"; "/find/b/c"];
3349 ["touch"; "/find/b/c/d"];
3350 ["find"; "/find/b/"]], ["c"; "c/d"])],
3351 "find all files and directories",
3353 This command lists out all files and directories, recursively,
3354 starting at C<directory>. It is essentially equivalent to
3355 running the shell command C<find directory -print> but some
3356 post-processing happens on the output, described below.
3358 This returns a list of strings I<without any prefix>. Thus
3359 if the directory structure was:
3365 then the returned list from C<guestfs_find> C</tmp> would be
3373 If C<directory> is not a directory, then this command returns
3376 The returned list is sorted.
3378 See also C<guestfs_find0>.");
3380 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3381 [], (* lvresize tests this *)
3382 "check an ext2/ext3 filesystem",
3384 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3385 filesystem checker on C<device>, noninteractively (I<-p>),
3386 even if the filesystem appears to be clean (I<-f>).
3388 This command is only needed because of C<guestfs_resize2fs>
3389 (q.v.). Normally you should use C<guestfs_fsck>.");
3391 ("sleep", (RErr, [Int "secs"], []), 109, [],
3392 [InitNone, Always, TestRun (
3394 "sleep for some seconds",
3396 Sleep for C<secs> seconds.");
3398 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3399 [InitNone, Always, TestOutputInt (
3400 [["part_disk"; "/dev/sda"; "mbr"];
3401 ["mkfs"; "ntfs"; "/dev/sda1"];
3402 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3403 InitNone, Always, TestOutputInt (
3404 [["part_disk"; "/dev/sda"; "mbr"];
3405 ["mkfs"; "ext2"; "/dev/sda1"];
3406 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3407 "probe NTFS volume",
3409 This command runs the L<ntfs-3g.probe(8)> command which probes
3410 an NTFS C<device> for mountability. (Not all NTFS volumes can
3411 be mounted read-write, and some cannot be mounted at all).
3413 C<rw> is a boolean flag. Set it to true if you want to test
3414 if the volume can be mounted read-write. Set it to false if
3415 you want to test if the volume can be mounted read-only.
3417 The return value is an integer which C<0> if the operation
3418 would succeed, or some non-zero value documented in the
3419 L<ntfs-3g.probe(8)> manual page.");
3421 ("sh", (RString "output", [String "command"], []), 111, [],
3422 [], (* XXX needs tests *)
3423 "run a command via the shell",
3425 This call runs a command from the guest filesystem via the
3428 This is like C<guestfs_command>, but passes the command to:
3430 /bin/sh -c \"command\"
3432 Depending on the guest's shell, this usually results in
3433 wildcards being expanded, shell expressions being interpolated
3436 All the provisos about C<guestfs_command> apply to this call.");
3438 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3439 [], (* XXX needs tests *)
3440 "run a command via the shell returning lines",
3442 This is the same as C<guestfs_sh>, but splits the result
3443 into a list of lines.
3445 See also: C<guestfs_command_lines>");
3447 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3448 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3449 * code in stubs.c, since all valid glob patterns must start with "/".
3450 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3452 [InitScratchFS, Always, TestOutputList (
3453 [["mkdir_p"; "/glob_expand/b/c"];
3454 ["touch"; "/glob_expand/b/c/d"];
3455 ["touch"; "/glob_expand/b/c/e"];
3456 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3457 InitScratchFS, Always, TestOutputList (
3458 [["mkdir_p"; "/glob_expand2/b/c"];
3459 ["touch"; "/glob_expand2/b/c/d"];
3460 ["touch"; "/glob_expand2/b/c/e"];
3461 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3462 InitScratchFS, Always, TestOutputList (
3463 [["mkdir_p"; "/glob_expand3/b/c"];
3464 ["touch"; "/glob_expand3/b/c/d"];
3465 ["touch"; "/glob_expand3/b/c/e"];
3466 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3467 "expand a wildcard path",
3469 This command searches for all the pathnames matching
3470 C<pattern> according to the wildcard expansion rules
3473 If no paths match, then this returns an empty list
3474 (note: not an error).
3476 It is just a wrapper around the C L<glob(3)> function
3477 with flags C<GLOB_MARK|GLOB_BRACE>.
3478 See that manual page for more details.");
3480 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3481 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3482 [["scrub_device"; "/dev/sdc"]])],
3483 "scrub (securely wipe) a device",
3485 This command writes patterns over C<device> to make data retrieval
3488 It is an interface to the L<scrub(1)> program. See that
3489 manual page for more details.");
3491 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3492 [InitScratchFS, Always, TestRun (
3493 [["write"; "/scrub_file"; "content"];
3494 ["scrub_file"; "/scrub_file"]])],
3495 "scrub (securely wipe) a file",
3497 This command writes patterns over a file to make data retrieval
3500 The file is I<removed> after scrubbing.
3502 It is an interface to the L<scrub(1)> program. See that
3503 manual page for more details.");
3505 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3506 [], (* XXX needs testing *)
3507 "scrub (securely wipe) free space",
3509 This command creates the directory C<dir> and then fills it
3510 with files until the filesystem is full, and scrubs the files
3511 as for C<guestfs_scrub_file>, and deletes them.
3512 The intention is to scrub any free space on the partition
3515 It is an interface to the L<scrub(1)> program. See that
3516 manual page for more details.");
3518 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3519 [InitScratchFS, Always, TestRun (
3520 [["mkdir"; "/mkdtemp"];
3521 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3522 "create a temporary directory",
3524 This command creates a temporary directory. The
3525 C<template> parameter should be a full pathname for the
3526 temporary directory name with the final six characters being
3529 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3530 the second one being suitable for Windows filesystems.
3532 The name of the temporary directory that was created
3535 The temporary directory is created with mode 0700
3536 and is owned by root.
3538 The caller is responsible for deleting the temporary
3539 directory and its contents after use.
3541 See also: L<mkdtemp(3)>");
3543 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3544 [InitISOFS, Always, TestOutputInt (
3545 [["wc_l"; "/10klines"]], 10000);
3546 (* Test for RHBZ#579608, absolute symbolic links. *)
3547 InitISOFS, Always, TestOutputInt (
3548 [["wc_l"; "/abssymlink"]], 10000)],
3549 "count lines in a file",
3551 This command counts the lines in a file, using the
3552 C<wc -l> external command.");
3554 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3555 [InitISOFS, Always, TestOutputInt (
3556 [["wc_w"; "/10klines"]], 10000)],
3557 "count words in a file",
3559 This command counts the words in a file, using the
3560 C<wc -w> external command.");
3562 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3563 [InitISOFS, Always, TestOutputInt (
3564 [["wc_c"; "/100kallspaces"]], 102400)],
3565 "count characters in a file",
3567 This command counts the characters in a file, using the
3568 C<wc -c> external command.");
3570 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3571 [InitISOFS, Always, TestOutputList (
3572 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3573 (* Test for RHBZ#579608, absolute symbolic links. *)
3574 InitISOFS, Always, TestOutputList (
3575 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3576 "return first 10 lines of a file",
3578 This command returns up to the first 10 lines of a file as
3579 a list of strings.");
3581 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3582 [InitISOFS, Always, TestOutputList (
3583 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3584 InitISOFS, Always, TestOutputList (
3585 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3586 InitISOFS, Always, TestOutputList (
3587 [["head_n"; "0"; "/10klines"]], [])],
3588 "return first N lines of a file",
3590 If the parameter C<nrlines> is a positive number, this returns the first
3591 C<nrlines> lines of the file C<path>.
3593 If the parameter C<nrlines> is a negative number, this returns lines
3594 from the file C<path>, excluding the last C<nrlines> lines.
3596 If the parameter C<nrlines> is zero, this returns an empty list.");
3598 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3599 [InitISOFS, Always, TestOutputList (
3600 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3601 "return last 10 lines of a file",
3603 This command returns up to the last 10 lines of a file as
3604 a list of strings.");
3606 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3607 [InitISOFS, Always, TestOutputList (
3608 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3609 InitISOFS, Always, TestOutputList (
3610 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3611 InitISOFS, Always, TestOutputList (
3612 [["tail_n"; "0"; "/10klines"]], [])],
3613 "return last N lines of a file",
3615 If the parameter C<nrlines> is a positive number, this returns the last
3616 C<nrlines> lines of the file C<path>.
3618 If the parameter C<nrlines> is a negative number, this returns lines
3619 from the file C<path>, starting with the C<-nrlines>th line.
3621 If the parameter C<nrlines> is zero, this returns an empty list.");
3623 ("df", (RString "output", [], []), 125, [],
3624 [], (* XXX Tricky to test because it depends on the exact format
3625 * of the 'df' command and other imponderables.
3627 "report file system disk space usage",
3629 This command runs the C<df> command to report disk space used.
3631 This command is mostly useful for interactive sessions. It
3632 is I<not> intended that you try to parse the output string.
3633 Use C<guestfs_statvfs> from programs.");
3635 ("df_h", (RString "output", [], []), 126, [],
3636 [], (* XXX Tricky to test because it depends on the exact format
3637 * of the 'df' command and other imponderables.
3639 "report file system disk space usage (human readable)",
3641 This command runs the C<df -h> command to report disk space used
3642 in human-readable format.
3644 This command is mostly useful for interactive sessions. It
3645 is I<not> intended that you try to parse the output string.
3646 Use C<guestfs_statvfs> from programs.");
3648 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3649 [InitISOFS, Always, TestOutputInt (
3650 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3651 "estimate file space usage",
3653 This command runs the C<du -s> command to estimate file space
3656 C<path> can be a file or a directory. If C<path> is a directory
3657 then the estimate includes the contents of the directory and all
3658 subdirectories (recursively).
3660 The result is the estimated size in I<kilobytes>
3661 (ie. units of 1024 bytes).");
3663 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3664 [InitISOFS, Always, TestOutputList (
3665 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3666 "list files in an initrd",
3668 This command lists out files contained in an initrd.
3670 The files are listed without any initial C</> character. The
3671 files are listed in the order they appear (not necessarily
3672 alphabetical). Directory names are listed as separate items.
3674 Old Linux kernels (2.4 and earlier) used a compressed ext2
3675 filesystem as initrd. We I<only> support the newer initramfs
3676 format (compressed cpio files).");
3678 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3680 "mount a file using the loop device",
3682 This command lets you mount C<file> (a filesystem image
3683 in a file) on a mount point. It is entirely equivalent to
3684 the command C<mount -o loop file mountpoint>.");
3686 ("mkswap", (RErr, [Device "device"], []), 130, [],
3687 [InitEmpty, Always, TestRun (
3688 [["part_disk"; "/dev/sda"; "mbr"];
3689 ["mkswap"; "/dev/sda1"]])],
3690 "create a swap partition",
3692 Create a swap partition on C<device>.");
3694 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3695 [InitEmpty, Always, TestRun (
3696 [["part_disk"; "/dev/sda"; "mbr"];
3697 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3698 "create a swap partition with a label",
3700 Create a swap partition on C<device> with label C<label>.
3702 Note that you cannot attach a swap label to a block device
3703 (eg. C</dev/sda>), just to a partition. This appears to be
3704 a limitation of the kernel or swap tools.");
3706 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3707 (let uuid = uuidgen () in
3708 [InitEmpty, Always, TestRun (
3709 [["part_disk"; "/dev/sda"; "mbr"];
3710 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3711 "create a swap partition with an explicit UUID",
3713 Create a swap partition on C<device> with UUID C<uuid>.");
3715 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3716 [InitScratchFS, Always, TestOutputStruct (
3717 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3718 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3719 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3720 InitScratchFS, Always, TestOutputStruct (
3721 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3722 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3723 "make block, character or FIFO devices",
3725 This call creates block or character special devices, or
3726 named pipes (FIFOs).
3728 The C<mode> parameter should be the mode, using the standard
3729 constants. C<devmajor> and C<devminor> are the
3730 device major and minor numbers, only used when creating block
3731 and character special devices.
3733 Note that, just like L<mknod(2)>, the mode must be bitwise
3734 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3735 just creates a regular file). These constants are
3736 available in the standard Linux header files, or you can use
3737 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3738 which are wrappers around this command which bitwise OR
3739 in the appropriate constant for you.
3741 The mode actually set is affected by the umask.");
3743 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3744 [InitScratchFS, Always, TestOutputStruct (
3745 [["mkfifo"; "0o777"; "/mkfifo"];
3746 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3747 "make FIFO (named pipe)",
3749 This call creates a FIFO (named pipe) called C<path> with
3750 mode C<mode>. It is just a convenient wrapper around
3753 The mode actually set is affected by the umask.");
3755 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3756 [InitScratchFS, Always, TestOutputStruct (
3757 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3758 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3759 "make block device node",
3761 This call creates a block device node called C<path> with
3762 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3763 It is just a convenient wrapper around C<guestfs_mknod>.
3765 The mode actually set is affected by the umask.");
3767 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3768 [InitScratchFS, Always, TestOutputStruct (
3769 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3770 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3771 "make char device node",
3773 This call creates a char device node called C<path> with
3774 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3775 It is just a convenient wrapper around C<guestfs_mknod>.
3777 The mode actually set is affected by the umask.");
3779 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3780 [InitEmpty, Always, TestOutputInt (
3781 [["umask"; "0o22"]], 0o22)],
3782 "set file mode creation mask (umask)",
3784 This function sets the mask used for creating new files and
3785 device nodes to C<mask & 0777>.
3787 Typical umask values would be C<022> which creates new files
3788 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3789 C<002> which creates new files with permissions like
3790 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3792 The default umask is C<022>. This is important because it
3793 means that directories and device nodes will be created with
3794 C<0644> or C<0755> mode even if you specify C<0777>.
3796 See also C<guestfs_get_umask>,
3797 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3799 This call returns the previous umask.");
3801 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3803 "read directories entries",
3805 This returns the list of directory entries in directory C<dir>.
3807 All entries in the directory are returned, including C<.> and
3808 C<..>. The entries are I<not> sorted, but returned in the same
3809 order as the underlying filesystem.
3811 Also this call returns basic file type information about each
3812 file. The C<ftyp> field will contain one of the following characters:
3850 The L<readdir(3)> call returned a C<d_type> field with an
3855 This function is primarily intended for use by programs. To
3856 get a simple list of names, use C<guestfs_ls>. To get a printable
3857 directory for human consumption, use C<guestfs_ll>.");
3859 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3861 "create partitions on a block device",
3863 This is a simplified interface to the C<guestfs_sfdisk>
3864 command, where partition sizes are specified in megabytes
3865 only (rounded to the nearest cylinder) and you don't need
3866 to specify the cyls, heads and sectors parameters which
3867 were rarely if ever used anyway.
3869 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3870 and C<guestfs_part_disk>");
3872 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3874 "determine file type inside a compressed file",
3876 This command runs C<file> after first decompressing C<path>
3879 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3881 Since 1.0.63, use C<guestfs_file> instead which can now
3882 process compressed files.");
3884 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3886 "list extended attributes of a file or directory",
3888 This call lists the extended attributes of the file or directory
3891 At the system call level, this is a combination of the
3892 L<listxattr(2)> and L<getxattr(2)> calls.
3894 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3896 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3898 "list extended attributes of a file or directory",
3900 This is the same as C<guestfs_getxattrs>, but if C<path>
3901 is a symbolic link, then it returns the extended attributes
3902 of the link itself.");
3904 ("setxattr", (RErr, [String "xattr";
3905 String "val"; Int "vallen"; (* will be BufferIn *)
3906 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3908 "set extended attribute of a file or directory",
3910 This call sets the extended attribute named C<xattr>
3911 of the file C<path> to the value C<val> (of length C<vallen>).
3912 The value is arbitrary 8 bit data.
3914 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3916 ("lsetxattr", (RErr, [String "xattr";
3917 String "val"; Int "vallen"; (* will be BufferIn *)
3918 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3920 "set extended attribute of a file or directory",
3922 This is the same as C<guestfs_setxattr>, but if C<path>
3923 is a symbolic link, then it sets an extended attribute
3924 of the link itself.");
3926 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3928 "remove extended attribute of a file or directory",
3930 This call removes the extended attribute named C<xattr>
3931 of the file C<path>.
3933 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3935 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3937 "remove extended attribute of a file or directory",
3939 This is the same as C<guestfs_removexattr>, but if C<path>
3940 is a symbolic link, then it removes an extended attribute
3941 of the link itself.");
3943 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3947 This call is similar to C<guestfs_mounts>. That call returns
3948 a list of devices. This one returns a hash table (map) of
3949 device name to directory where the device is mounted.");
3951 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3952 (* This is a special case: while you would expect a parameter
3953 * of type "Pathname", that doesn't work, because it implies
3954 * NEED_ROOT in the generated calling code in stubs.c, and
3955 * this function cannot use NEED_ROOT.
3958 "create a mountpoint",
3960 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3961 specialized calls that can be used to create extra mountpoints
3962 before mounting the first filesystem.
3964 These calls are I<only> necessary in some very limited circumstances,
3965 mainly the case where you want to mount a mix of unrelated and/or
3966 read-only filesystems together.
3968 For example, live CDs often contain a \"Russian doll\" nest of
3969 filesystems, an ISO outer layer, with a squashfs image inside, with
3970 an ext2/3 image inside that. You can unpack this as follows
3973 add-ro Fedora-11-i686-Live.iso
3977 mkmountpoint /ext3fs
3979 mount-loop /cd/LiveOS/squashfs.img /sqsh
3980 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3982 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3984 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3985 You may get unexpected errors if you try to mix these calls. It is
3986 safest to manually unmount filesystems and remove mountpoints after use.
3988 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3989 longest first, so for this to work for manual mountpoints, you
3990 must ensure that the innermost mountpoints have the longest
3991 pathnames, as in the example code above.
3993 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3995 Autosync [see C<guestfs_set_autosync>, this is set by default on
3996 handles] can cause C<guestfs_umount_all> to be called when the handle
3997 is closed which can also trigger these issues.");
3999 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4001 "remove a mountpoint",
4003 This calls removes a mountpoint that was previously created
4004 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4005 for full details.");
4007 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4008 [InitISOFS, Always, TestOutputBuffer (
4009 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4010 (* Test various near large, large and too large files (RHBZ#589039). *)
4011 InitScratchFS, Always, TestLastFail (
4012 [["touch"; "/read_file"];
4013 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4014 ["read_file"; "/read_file"]]);
4015 InitScratchFS, Always, TestLastFail (
4016 [["touch"; "/read_file2"];
4017 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4018 ["read_file"; "/read_file2"]]);
4019 InitScratchFS, Always, TestLastFail (
4020 [["touch"; "/read_file3"];
4021 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4022 ["read_file"; "/read_file3"]])],
4025 This calls returns the contents of the file C<path> as a
4028 Unlike C<guestfs_cat>, this function can correctly
4029 handle files that contain embedded ASCII NUL characters.
4030 However unlike C<guestfs_download>, this function is limited
4031 in the total size of file that can be handled.");
4033 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4034 [InitISOFS, Always, TestOutputList (
4035 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4036 InitISOFS, Always, TestOutputList (
4037 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4038 (* Test for RHBZ#579608, absolute symbolic links. *)
4039 InitISOFS, Always, TestOutputList (
4040 [["grep"; "nomatch"; "/abssymlink"]], [])],
4041 "return lines matching a pattern",
4043 This calls the external C<grep> program and returns the
4046 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4047 [InitISOFS, Always, TestOutputList (
4048 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4049 "return lines matching a pattern",
4051 This calls the external C<egrep> program and returns the
4054 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4055 [InitISOFS, Always, TestOutputList (
4056 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4057 "return lines matching a pattern",
4059 This calls the external C<fgrep> program and returns the
4062 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4063 [InitISOFS, Always, TestOutputList (
4064 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4065 "return lines matching a pattern",
4067 This calls the external C<grep -i> program and returns the
4070 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4071 [InitISOFS, Always, TestOutputList (
4072 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4073 "return lines matching a pattern",
4075 This calls the external C<egrep -i> program and returns the
4078 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4079 [InitISOFS, Always, TestOutputList (
4080 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4081 "return lines matching a pattern",
4083 This calls the external C<fgrep -i> program and returns the
4086 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4087 [InitISOFS, Always, TestOutputList (
4088 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4089 "return lines matching a pattern",
4091 This calls the external C<zgrep> program and returns the
4094 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4095 [InitISOFS, Always, TestOutputList (
4096 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4097 "return lines matching a pattern",
4099 This calls the external C<zegrep> program and returns the
4102 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4103 [InitISOFS, Always, TestOutputList (
4104 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4105 "return lines matching a pattern",
4107 This calls the external C<zfgrep> program and returns the
4110 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4111 [InitISOFS, Always, TestOutputList (
4112 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4113 "return lines matching a pattern",
4115 This calls the external C<zgrep -i> program and returns the
4118 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4119 [InitISOFS, Always, TestOutputList (
4120 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4121 "return lines matching a pattern",
4123 This calls the external C<zegrep -i> program and returns the
4126 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4127 [InitISOFS, Always, TestOutputList (
4128 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4129 "return lines matching a pattern",
4131 This calls the external C<zfgrep -i> program and returns the
4134 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4135 [InitISOFS, Always, TestOutput (
4136 [["realpath"; "/../directory"]], "/directory")],
4137 "canonicalized absolute pathname",
4139 Return the canonicalized absolute pathname of C<path>. The
4140 returned path has no C<.>, C<..> or symbolic link path elements.");
4142 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4143 [InitScratchFS, Always, TestOutputStruct (
4146 ["ln"; "/ln/a"; "/ln/b"];
4147 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4148 "create a hard link",
4150 This command creates a hard link using the C<ln> command.");
4152 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4153 [InitScratchFS, Always, TestOutputStruct (
4154 [["mkdir"; "/ln_f"];
4155 ["touch"; "/ln_f/a"];
4156 ["touch"; "/ln_f/b"];
4157 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4158 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4159 "create a hard link",
4161 This command creates a hard link using the C<ln -f> command.
4162 The I<-f> option removes the link (C<linkname>) if it exists already.");
4164 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4165 [InitScratchFS, Always, TestOutputStruct (
4166 [["mkdir"; "/ln_s"];
4167 ["touch"; "/ln_s/a"];
4168 ["ln_s"; "a"; "/ln_s/b"];
4169 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4170 "create a symbolic link",
4172 This command creates a symbolic link using the C<ln -s> command.");
4174 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4175 [InitScratchFS, Always, TestOutput (
4176 [["mkdir_p"; "/ln_sf/b"];
4177 ["touch"; "/ln_sf/b/c"];
4178 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4179 ["readlink"; "/ln_sf/b/c"]], "../d")],
4180 "create a symbolic link",
4182 This command creates a symbolic link using the C<ln -sf> command,
4183 The I<-f> option removes the link (C<linkname>) if it exists already.");
4185 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4186 [] (* XXX tested above *),
4187 "read the target of a symbolic link",
4189 This command reads the target of a symbolic link.");
4191 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4192 [InitScratchFS, Always, TestOutputStruct (
4193 [["fallocate"; "/fallocate"; "1000000"];
4194 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4195 "preallocate a file in the guest filesystem",
4197 This command preallocates a file (containing zero bytes) named
4198 C<path> of size C<len> bytes. If the file exists already, it
4201 Do not confuse this with the guestfish-specific
4202 C<alloc> command which allocates a file in the host and
4203 attaches it as a device.");
4205 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4206 [InitPartition, Always, TestRun (
4207 [["mkswap"; "/dev/sda1"];
4208 ["swapon_device"; "/dev/sda1"];
4209 ["swapoff_device"; "/dev/sda1"]])],
4210 "enable swap on device",
4212 This command enables the libguestfs appliance to use the
4213 swap device or partition named C<device>. The increased
4214 memory is made available for all commands, for example
4215 those run using C<guestfs_command> or C<guestfs_sh>.
4217 Note that you should not swap to existing guest swap
4218 partitions unless you know what you are doing. They may
4219 contain hibernation information, or other information that
4220 the guest doesn't want you to trash. You also risk leaking
4221 information about the host to the guest this way. Instead,
4222 attach a new host device to the guest and swap on that.");
4224 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4225 [], (* XXX tested by swapon_device *)
4226 "disable swap on device",
4228 This command disables the libguestfs appliance swap
4229 device or partition named C<device>.
4230 See C<guestfs_swapon_device>.");
4232 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4233 [InitScratchFS, Always, TestRun (
4234 [["fallocate"; "/swapon_file"; "8388608"];
4235 ["mkswap_file"; "/swapon_file"];
4236 ["swapon_file"; "/swapon_file"];
4237 ["swapoff_file"; "/swapon_file"];
4238 ["rm"; "/swapon_file"]])],
4239 "enable swap on file",
4241 This command enables swap to a file.
4242 See C<guestfs_swapon_device> for other notes.");
4244 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4245 [], (* XXX tested by swapon_file *)
4246 "disable swap on file",
4248 This command disables the libguestfs appliance swap on file.");
4250 ("swapon_label", (RErr, [String "label"], []), 174, [],
4251 [InitEmpty, Always, TestRun (
4252 [["part_disk"; "/dev/sda"; "mbr"];
4253 ["mkswap_L"; "swapit"; "/dev/sda1"];
4254 ["swapon_label"; "swapit"];
4255 ["swapoff_label"; "swapit"];
4256 ["zero"; "/dev/sda"];
4257 ["blockdev_rereadpt"; "/dev/sda"]])],
4258 "enable swap on labeled swap partition",
4260 This command enables swap to a labeled swap partition.
4261 See C<guestfs_swapon_device> for other notes.");
4263 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4264 [], (* XXX tested by swapon_label *)
4265 "disable swap on labeled swap partition",
4267 This command disables the libguestfs appliance swap on
4268 labeled swap partition.");
4270 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4271 (let uuid = uuidgen () in
4272 [InitEmpty, Always, TestRun (
4273 [["mkswap_U"; uuid; "/dev/sdc"];
4274 ["swapon_uuid"; uuid];
4275 ["swapoff_uuid"; uuid]])]),
4276 "enable swap on swap partition by UUID",
4278 This command enables swap to a swap partition with the given UUID.
4279 See C<guestfs_swapon_device> for other notes.");
4281 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4282 [], (* XXX tested by swapon_uuid *)
4283 "disable swap on swap partition by UUID",
4285 This command disables the libguestfs appliance swap partition
4286 with the given UUID.");
4288 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4289 [InitScratchFS, Always, TestRun (
4290 [["fallocate"; "/mkswap_file"; "8388608"];
4291 ["mkswap_file"; "/mkswap_file"];
4292 ["rm"; "/mkswap_file"]])],
4293 "create a swap file",
4297 This command just writes a swap file signature to an existing
4298 file. To create the file itself, use something like C<guestfs_fallocate>.");
4300 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4301 [InitISOFS, Always, TestRun (
4302 [["inotify_init"; "0"]])],
4303 "create an inotify handle",
4305 This command creates a new inotify handle.
4306 The inotify subsystem can be used to notify events which happen to
4307 objects in the guest filesystem.
4309 C<maxevents> is the maximum number of events which will be
4310 queued up between calls to C<guestfs_inotify_read> or
4311 C<guestfs_inotify_files>.
4312 If this is passed as C<0>, then the kernel (or previously set)
4313 default is used. For Linux 2.6.29 the default was 16384 events.
4314 Beyond this limit, the kernel throws away events, but records
4315 the fact that it threw them away by setting a flag
4316 C<IN_Q_OVERFLOW> in the returned structure list (see
4317 C<guestfs_inotify_read>).
4319 Before any events are generated, you have to add some
4320 watches to the internal watch list. See:
4321 C<guestfs_inotify_add_watch>,
4322 C<guestfs_inotify_rm_watch> and
4323 C<guestfs_inotify_watch_all>.
4325 Queued up events should be read periodically by calling
4326 C<guestfs_inotify_read>
4327 (or C<guestfs_inotify_files> which is just a helpful
4328 wrapper around C<guestfs_inotify_read>). If you don't
4329 read the events out often enough then you risk the internal
4332 The handle should be closed after use by calling
4333 C<guestfs_inotify_close>. This also removes any
4334 watches automatically.
4336 See also L<inotify(7)> for an overview of the inotify interface
4337 as exposed by the Linux kernel, which is roughly what we expose
4338 via libguestfs. Note that there is one global inotify handle
4339 per libguestfs instance.");
4341 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4342 [InitScratchFS, Always, TestOutputList (
4343 [["mkdir"; "/inotify_add_watch"];
4344 ["inotify_init"; "0"];
4345 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4346 ["touch"; "/inotify_add_watch/a"];
4347 ["touch"; "/inotify_add_watch/b"];
4348 ["inotify_files"]], ["a"; "b"])],
4349 "add an inotify watch",
4351 Watch C<path> for the events listed in C<mask>.
4353 Note that if C<path> is a directory then events within that
4354 directory are watched, but this does I<not> happen recursively
4355 (in subdirectories).
4357 Note for non-C or non-Linux callers: the inotify events are
4358 defined by the Linux kernel ABI and are listed in
4359 C</usr/include/sys/inotify.h>.");
4361 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4363 "remove an inotify watch",
4365 Remove a previously defined inotify watch.
4366 See C<guestfs_inotify_add_watch>.");
4368 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4370 "return list of inotify events",
4372 Return the complete queue of events that have happened
4373 since the previous read call.
4375 If no events have happened, this returns an empty list.
4377 I<Note>: In order to make sure that all events have been
4378 read, you must call this function repeatedly until it
4379 returns an empty list. The reason is that the call will
4380 read events up to the maximum appliance-to-host message
4381 size and leave remaining events in the queue.");
4383 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4385 "return list of watched files that had events",
4387 This function is a helpful wrapper around C<guestfs_inotify_read>
4388 which just returns a list of pathnames of objects that were
4389 touched. The returned pathnames are sorted and deduplicated.");
4391 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4393 "close the inotify handle",
4395 This closes the inotify handle which was previously
4396 opened by inotify_init. It removes all watches, throws
4397 away any pending events, and deallocates all resources.");
4399 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4401 "set SELinux security context",
4403 This sets the SELinux security context of the daemon
4404 to the string C<context>.
4406 See the documentation about SELINUX in L<guestfs(3)>.");
4408 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4410 "get SELinux security context",
4412 This gets the SELinux security context of the daemon.
4414 See the documentation about SELINUX in L<guestfs(3)>,
4415 and C<guestfs_setcon>");
4417 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4418 [InitEmpty, Always, TestOutput (
4419 [["part_disk"; "/dev/sda"; "mbr"];
4420 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4421 ["mount_options"; ""; "/dev/sda1"; "/"];
4422 ["write"; "/new"; "new file contents"];
4423 ["cat"; "/new"]], "new file contents");
4424 InitEmpty, Always, TestRun (
4425 [["part_disk"; "/dev/sda"; "mbr"];
4426 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4427 InitEmpty, Always, TestLastFail (
4428 [["part_disk"; "/dev/sda"; "mbr"];
4429 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4430 InitEmpty, Always, TestLastFail (
4431 [["part_disk"; "/dev/sda"; "mbr"];
4432 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4433 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4434 [["part_disk"; "/dev/sda"; "mbr"];
4435 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4436 "make a filesystem with block size",
4438 This call is similar to C<guestfs_mkfs>, but it allows you to
4439 control the block size of the resulting filesystem. Supported
4440 block sizes depend on the filesystem type, but typically they
4441 are C<1024>, C<2048> or C<4096> only.
4443 For VFAT and NTFS the C<blocksize> parameter is treated as
4444 the requested cluster size.");
4446 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4447 [InitEmpty, Always, TestOutput (
4448 [["part_init"; "/dev/sda"; "mbr"];
4449 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4450 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4451 ["mke2journal"; "4096"; "/dev/sda1"];
4452 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4453 ["mount_options"; ""; "/dev/sda2"; "/"];
4454 ["write"; "/new"; "new file contents"];
4455 ["cat"; "/new"]], "new file contents")],
4456 "make ext2/3/4 external journal",
4458 This creates an ext2 external journal on C<device>. It is equivalent
4461 mke2fs -O journal_dev -b blocksize device");
4463 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4464 [InitEmpty, Always, TestOutput (
4465 [["part_init"; "/dev/sda"; "mbr"];
4466 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4467 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4468 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4469 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4470 ["mount_options"; ""; "/dev/sda2"; "/"];
4471 ["write"; "/new"; "new file contents"];
4472 ["cat"; "/new"]], "new file contents")],
4473 "make ext2/3/4 external journal with label",
4475 This creates an ext2 external journal on C<device> with label C<label>.");
4477 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4478 (let uuid = uuidgen () in
4479 [InitEmpty, Always, TestOutput (
4480 [["part_init"; "/dev/sda"; "mbr"];
4481 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4482 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4483 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4484 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4485 ["mount_options"; ""; "/dev/sda2"; "/"];
4486 ["write"; "/new"; "new file contents"];
4487 ["cat"; "/new"]], "new file contents")]),
4488 "make ext2/3/4 external journal with UUID",
4490 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4492 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4494 "make ext2/3/4 filesystem with external journal",
4496 This creates an ext2/3/4 filesystem on C<device> with
4497 an external journal on C<journal>. It is equivalent
4500 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4502 See also C<guestfs_mke2journal>.");
4504 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4506 "make ext2/3/4 filesystem with external journal",
4508 This creates an ext2/3/4 filesystem on C<device> with
4509 an external journal on the journal labeled C<label>.
4511 See also C<guestfs_mke2journal_L>.");
4513 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4515 "make ext2/3/4 filesystem with external journal",
4517 This creates an ext2/3/4 filesystem on C<device> with
4518 an external journal on the journal with UUID C<uuid>.
4520 See also C<guestfs_mke2journal_U>.");
4522 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4523 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4524 "load a kernel module",
4526 This loads a kernel module in the appliance.
4528 The kernel module must have been whitelisted when libguestfs
4529 was built (see C<appliance/kmod.whitelist.in> in the source).");
4531 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4532 [InitNone, Always, TestOutput (
4533 [["echo_daemon"; "This is a test"]], "This is a test"
4535 "echo arguments back to the client",
4537 This command concatenates the list of C<words> passed with single spaces
4538 between them and returns the resulting string.
4540 You can use this command to test the connection through to the daemon.
4542 See also C<guestfs_ping_daemon>.");
4544 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4545 [], (* There is a regression test for this. *)
4546 "find all files and directories, returning NUL-separated list",
4548 This command lists out all files and directories, recursively,
4549 starting at C<directory>, placing the resulting list in the
4550 external file called C<files>.
4552 This command works the same way as C<guestfs_find> with the
4553 following exceptions:
4559 The resulting list is written to an external file.
4563 Items (filenames) in the result are separated
4564 by C<\\0> characters. See L<find(1)> option I<-print0>.
4568 This command is not limited in the number of names that it
4573 The result list is not sorted.
4577 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4578 [InitISOFS, Always, TestOutput (
4579 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4580 InitISOFS, Always, TestOutput (
4581 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4582 InitISOFS, Always, TestOutput (
4583 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4584 InitISOFS, Always, TestLastFail (
4585 [["case_sensitive_path"; "/Known-1/"]]);
4586 InitScratchFS, Always, TestOutput (
4587 [["mkdir"; "/case_sensitive_path"];
4588 ["mkdir"; "/case_sensitive_path/bbb"];
4589 ["touch"; "/case_sensitive_path/bbb/c"];
4590 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4591 InitScratchFS, Always, TestOutput (
4592 [["mkdir"; "/case_sensitive_path2"];
4593 ["mkdir"; "/case_sensitive_path2/bbb"];
4594 ["touch"; "/case_sensitive_path2/bbb/c"];
4595 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4596 InitScratchFS, Always, TestLastFail (
4597 [["mkdir"; "/case_sensitive_path3"];
4598 ["mkdir"; "/case_sensitive_path3/bbb"];
4599 ["touch"; "/case_sensitive_path3/bbb/c"];
4600 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4601 "return true path on case-insensitive filesystem",
4603 This can be used to resolve case insensitive paths on
4604 a filesystem which is case sensitive. The use case is
4605 to resolve paths which you have read from Windows configuration
4606 files or the Windows Registry, to the true path.
4608 The command handles a peculiarity of the Linux ntfs-3g
4609 filesystem driver (and probably others), which is that although
4610 the underlying filesystem is case-insensitive, the driver
4611 exports the filesystem to Linux as case-sensitive.
4613 One consequence of this is that special directories such
4614 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4615 (or other things) depending on the precise details of how
4616 they were created. In Windows itself this would not be
4619 Bug or feature? You decide:
4620 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4622 This function resolves the true case of each element in the
4623 path and returns the case-sensitive path.
4625 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4626 might return C<\"/WINDOWS/system32\"> (the exact return value
4627 would depend on details of how the directories were originally
4628 created under Windows).
4631 This function does not handle drive names, backslashes etc.
4633 See also C<guestfs_realpath>.");
4635 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4636 [InitScratchFS, Always, TestOutput (
4637 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4638 "get the Linux VFS type corresponding to a mounted device",
4640 This command gets the filesystem type corresponding to
4641 the filesystem on C<device>.
4643 For most filesystems, the result is the name of the Linux
4644 VFS module which would be used to mount this filesystem
4645 if you mounted it without specifying the filesystem type.
4646 For example a string such as C<ext3> or C<ntfs>.");
4648 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4649 [InitScratchFS, Always, TestOutputStruct (
4650 [["write"; "/truncate"; "some stuff so size is not zero"];
4651 ["truncate"; "/truncate"];
4652 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4653 "truncate a file to zero size",
4655 This command truncates C<path> to a zero-length file. The
4656 file must exist already.");
4658 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4659 [InitScratchFS, Always, TestOutputStruct (
4660 [["touch"; "/truncate_size"];
4661 ["truncate_size"; "/truncate_size"; "1000"];
4662 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4663 "truncate a file to a particular size",
4665 This command truncates C<path> to size C<size> bytes. The file
4668 If the current file size is less than C<size> then
4669 the file is extended to the required size with zero bytes.
4670 This creates a sparse file (ie. disk blocks are not allocated
4671 for the file until you write to it). To create a non-sparse
4672 file of zeroes, use C<guestfs_fallocate64> instead.");
4674 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4675 [InitScratchFS, Always, TestOutputStruct (
4676 [["touch"; "/utimens"];
4677 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4678 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4679 "set timestamp of a file with nanosecond precision",
4681 This command sets the timestamps of a file with nanosecond
4684 C<atsecs, atnsecs> are the last access time (atime) in secs and
4685 nanoseconds from the epoch.
4687 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4688 secs and nanoseconds from the epoch.
4690 If the C<*nsecs> field contains the special value C<-1> then
4691 the corresponding timestamp is set to the current time. (The
4692 C<*secs> field is ignored in this case).
4694 If the C<*nsecs> field contains the special value C<-2> then
4695 the corresponding timestamp is left unchanged. (The
4696 C<*secs> field is ignored in this case).");
4698 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4699 [InitScratchFS, Always, TestOutputStruct (
4700 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4701 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4702 "create a directory with a particular mode",
4704 This command creates a directory, setting the initial permissions
4705 of the directory to C<mode>.
4707 For common Linux filesystems, the actual mode which is set will
4708 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4709 interpret the mode in other ways.
4711 See also C<guestfs_mkdir>, C<guestfs_umask>");
4713 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4715 "change file owner and group",
4717 Change the file owner to C<owner> and group to C<group>.
4718 This is like C<guestfs_chown> but if C<path> is a symlink then
4719 the link itself is changed, not the target.
4721 Only numeric uid and gid are supported. If you want to use
4722 names, you will need to locate and parse the password file
4723 yourself (Augeas support makes this relatively easy).");
4725 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4727 "lstat on multiple files",
4729 This call allows you to perform the C<guestfs_lstat> operation
4730 on multiple files, where all files are in the directory C<path>.
4731 C<names> is the list of files from this directory.
4733 On return you get a list of stat structs, with a one-to-one
4734 correspondence to the C<names> list. If any name did not exist
4735 or could not be lstat'd, then the C<ino> field of that structure
4738 This call is intended for programs that want to efficiently
4739 list a directory contents without making many round-trips.
4740 See also C<guestfs_lxattrlist> for a similarly efficient call
4741 for getting extended attributes. Very long directory listings
4742 might cause the protocol message size to be exceeded, causing
4743 this call to fail. The caller must split up such requests
4744 into smaller groups of names.");
4746 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4748 "lgetxattr on multiple files",
4750 This call allows you to get the extended attributes
4751 of multiple files, where all files are in the directory C<path>.
4752 C<names> is the list of files from this directory.
4754 On return you get a flat list of xattr structs which must be
4755 interpreted sequentially. The first xattr struct always has a zero-length
4756 C<attrname>. C<attrval> in this struct is zero-length
4757 to indicate there was an error doing C<lgetxattr> for this
4758 file, I<or> is a C string which is a decimal number
4759 (the number of following attributes for this file, which could
4760 be C<\"0\">). Then after the first xattr struct are the
4761 zero or more attributes for the first named file.
4762 This repeats for the second and subsequent files.
4764 This call is intended for programs that want to efficiently
4765 list a directory contents without making many round-trips.
4766 See also C<guestfs_lstatlist> for a similarly efficient call
4767 for getting standard stats. Very long directory listings
4768 might cause the protocol message size to be exceeded, causing
4769 this call to fail. The caller must split up such requests
4770 into smaller groups of names.");
4772 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4774 "readlink on multiple files",
4776 This call allows you to do a C<readlink> operation
4777 on multiple files, where all files are in the directory C<path>.
4778 C<names> is the list of files from this directory.
4780 On return you get a list of strings, with a one-to-one
4781 correspondence to the C<names> list. Each string is the
4782 value of the symbolic link.
4784 If the C<readlink(2)> operation fails on any name, then
4785 the corresponding result string is the empty string C<\"\">.
4786 However the whole operation is completed even if there
4787 were C<readlink(2)> errors, and so you can call this
4788 function with names where you don't know if they are
4789 symbolic links already (albeit slightly less efficient).
4791 This call is intended for programs that want to efficiently
4792 list a directory contents without making many round-trips.
4793 Very long directory listings might cause the protocol
4794 message size to be exceeded, causing
4795 this call to fail. The caller must split up such requests
4796 into smaller groups of names.");
4798 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4799 [InitISOFS, Always, TestOutputBuffer (
4800 [["pread"; "/known-4"; "1"; "3"]], "\n");
4801 InitISOFS, Always, TestOutputBuffer (
4802 [["pread"; "/empty"; "0"; "100"]], "")],
4803 "read part of a file",
4805 This command lets you read part of a file. It reads C<count>
4806 bytes of the file, starting at C<offset>, from file C<path>.
4808 This may read fewer bytes than requested. For further details
4809 see the L<pread(2)> system call.
4811 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4813 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4814 [InitEmpty, Always, TestRun (
4815 [["part_init"; "/dev/sda"; "gpt"]])],
4816 "create an empty partition table",
4818 This creates an empty partition table on C<device> of one of the
4819 partition types listed below. Usually C<parttype> should be
4820 either C<msdos> or C<gpt> (for large disks).
4822 Initially there are no partitions. Following this, you should
4823 call C<guestfs_part_add> for each partition required.
4825 Possible values for C<parttype> are:
4829 =item B<efi> | B<gpt>
4831 Intel EFI / GPT partition table.
4833 This is recommended for >= 2 TB partitions that will be accessed
4834 from Linux and Intel-based Mac OS X. It also has limited backwards
4835 compatibility with the C<mbr> format.
4837 =item B<mbr> | B<msdos>
4839 The standard PC \"Master Boot Record\" (MBR) format used
4840 by MS-DOS and Windows. This partition type will B<only> work
4841 for device sizes up to 2 TB. For large disks we recommend
4846 Other partition table types that may work but are not
4855 =item B<amiga> | B<rdb>
4857 Amiga \"Rigid Disk Block\" format.
4865 DASD, used on IBM mainframes.
4873 Old Mac partition format. Modern Macs use C<gpt>.
4877 NEC PC-98 format, common in Japan apparently.
4885 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4886 [InitEmpty, Always, TestRun (
4887 [["part_init"; "/dev/sda"; "mbr"];
4888 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4889 InitEmpty, Always, TestRun (
4890 [["part_init"; "/dev/sda"; "gpt"];
4891 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4892 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4893 InitEmpty, Always, TestRun (
4894 [["part_init"; "/dev/sda"; "mbr"];
4895 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4896 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4897 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4898 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4899 "add a partition to the device",
4901 This command adds a partition to C<device>. If there is no partition
4902 table on the device, call C<guestfs_part_init> first.
4904 The C<prlogex> parameter is the type of partition. Normally you
4905 should pass C<p> or C<primary> here, but MBR partition tables also
4906 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4909 C<startsect> and C<endsect> are the start and end of the partition
4910 in I<sectors>. C<endsect> may be negative, which means it counts
4911 backwards from the end of the disk (C<-1> is the last sector).
4913 Creating a partition which covers the whole disk is not so easy.
4914 Use C<guestfs_part_disk> to do that.");
4916 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4917 [InitEmpty, Always, TestRun (
4918 [["part_disk"; "/dev/sda"; "mbr"]]);
4919 InitEmpty, Always, TestRun (
4920 [["part_disk"; "/dev/sda"; "gpt"]])],
4921 "partition whole disk with a single primary partition",
4923 This command is simply a combination of C<guestfs_part_init>
4924 followed by C<guestfs_part_add> to create a single primary partition
4925 covering the whole disk.
4927 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4928 but other possible values are described in C<guestfs_part_init>.");
4930 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4931 [InitEmpty, Always, TestRun (
4932 [["part_disk"; "/dev/sda"; "mbr"];
4933 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4934 "make a partition bootable",
4936 This sets the bootable flag on partition numbered C<partnum> on
4937 device C<device>. Note that partitions are numbered from 1.
4939 The bootable flag is used by some operating systems (notably
4940 Windows) to determine which partition to boot from. It is by
4941 no means universally recognized.");
4943 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4944 [InitEmpty, Always, TestRun (
4945 [["part_disk"; "/dev/sda"; "gpt"];
4946 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4947 "set partition name",
4949 This sets the partition name on partition numbered C<partnum> on
4950 device C<device>. Note that partitions are numbered from 1.
4952 The partition name can only be set on certain types of partition
4953 table. This works on C<gpt> but not on C<mbr> partitions.");
4955 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4956 [], (* XXX Add a regression test for this. *)
4957 "list partitions on a device",
4959 This command parses the partition table on C<device> and
4960 returns the list of partitions found.
4962 The fields in the returned structure are:
4968 Partition number, counting from 1.
4972 Start of the partition I<in bytes>. To get sectors you have to
4973 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4977 End of the partition in bytes.
4981 Size of the partition in bytes.
4985 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4986 [InitEmpty, Always, TestOutput (
4987 [["part_disk"; "/dev/sda"; "gpt"];
4988 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4989 "get the partition table type",
4991 This command examines the partition table on C<device> and
4992 returns the partition table type (format) being used.
4994 Common return values include: C<msdos> (a DOS/Windows style MBR
4995 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4996 values are possible, although unusual. See C<guestfs_part_init>
4999 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5000 [InitScratchFS, Always, TestOutputBuffer (
5001 [["fill"; "0x63"; "10"; "/fill"];
5002 ["read_file"; "/fill"]], "cccccccccc")],
5003 "fill a file with octets",
5005 This command creates a new file called C<path>. The initial
5006 content of the file is C<len> octets of C<c>, where C<c>
5007 must be a number in the range C<[0..255]>.
5009 To fill a file with zero bytes (sparsely), it is
5010 much more efficient to use C<guestfs_truncate_size>.
5011 To create a file with a pattern of repeating bytes
5012 use C<guestfs_fill_pattern>.");
5014 ("available", (RErr, [StringList "groups"], []), 216, [],
5015 [InitNone, Always, TestRun [["available"; ""]]],
5016 "test availability of some parts of the API",
5018 This command is used to check the availability of some
5019 groups of functionality in the appliance, which not all builds of
5020 the libguestfs appliance will be able to provide.
5022 The libguestfs groups, and the functions that those
5023 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5024 You can also fetch this list at runtime by calling
5025 C<guestfs_available_all_groups>.
5027 The argument C<groups> is a list of group names, eg:
5028 C<[\"inotify\", \"augeas\"]> would check for the availability of
5029 the Linux inotify functions and Augeas (configuration file
5032 The command returns no error if I<all> requested groups are available.
5034 It fails with an error if one or more of the requested
5035 groups is unavailable in the appliance.
5037 If an unknown group name is included in the
5038 list of groups then an error is always returned.
5046 You must call C<guestfs_launch> before calling this function.
5048 The reason is because we don't know what groups are
5049 supported by the appliance/daemon until it is running and can
5054 If a group of functions is available, this does not necessarily
5055 mean that they will work. You still have to check for errors
5056 when calling individual API functions even if they are
5061 It is usually the job of distro packagers to build
5062 complete functionality into the libguestfs appliance.
5063 Upstream libguestfs, if built from source with all
5064 requirements satisfied, will support everything.
5068 This call was added in version C<1.0.80>. In previous
5069 versions of libguestfs all you could do would be to speculatively
5070 execute a command to find out if the daemon implemented it.
5071 See also C<guestfs_version>.
5075 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5076 [InitScratchFS, Always, TestOutputBuffer (
5078 ["write"; "/dd/src"; "hello, world"];
5079 ["dd"; "/dd/src"; "/dd/dest"];
5080 ["read_file"; "/dd/dest"]], "hello, world")],
5081 "copy from source to destination using dd",
5083 This command copies from one source device or file C<src>
5084 to another destination device or file C<dest>. Normally you
5085 would use this to copy to or from a device or partition, for
5086 example to duplicate a filesystem.
5088 If the destination is a device, it must be as large or larger
5089 than the source file or device, otherwise the copy will fail.
5090 This command cannot do partial copies (see C<guestfs_copy_size>).");
5092 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5093 [InitScratchFS, Always, TestOutputInt (
5094 [["write"; "/filesize"; "hello, world"];
5095 ["filesize"; "/filesize"]], 12)],
5096 "return the size of the file in bytes",
5098 This command returns the size of C<file> in bytes.
5100 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5101 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5102 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5104 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5105 [InitBasicFSonLVM, Always, TestOutputList (
5106 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5107 ["lvs"]], ["/dev/VG/LV2"])],
5108 "rename an LVM logical volume",
5110 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5112 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5113 [InitBasicFSonLVM, Always, TestOutputList (
5115 ["vg_activate"; "false"; "VG"];
5116 ["vgrename"; "VG"; "VG2"];
5117 ["vg_activate"; "true"; "VG2"];
5118 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5119 ["vgs"]], ["VG2"])],
5120 "rename an LVM volume group",
5122 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5124 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5125 [InitISOFS, Always, TestOutputBuffer (
5126 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5127 "list the contents of a single file in an initrd",
5129 This command unpacks the file C<filename> from the initrd file
5130 called C<initrdpath>. The filename must be given I<without> the
5131 initial C</> character.
5133 For example, in guestfish you could use the following command
5134 to examine the boot script (usually called C</init>)
5135 contained in a Linux initrd or initramfs image:
5137 initrd-cat /boot/initrd-<version>.img init
5139 See also C<guestfs_initrd_list>.");
5141 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5143 "get the UUID of a physical volume",
5145 This command returns the UUID of the LVM PV C<device>.");
5147 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5149 "get the UUID of a volume group",
5151 This command returns the UUID of the LVM VG named C<vgname>.");
5153 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5155 "get the UUID of a logical volume",
5157 This command returns the UUID of the LVM LV C<device>.");
5159 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5161 "get the PV UUIDs containing the volume group",
5163 Given a VG called C<vgname>, this returns the UUIDs of all
5164 the physical volumes that this volume group resides on.
5166 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5167 calls to associate physical volumes and volume groups.
5169 See also C<guestfs_vglvuuids>.");
5171 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5173 "get the LV UUIDs of all LVs in the volume group",
5175 Given a VG called C<vgname>, this returns the UUIDs of all
5176 the logical volumes created in this volume group.
5178 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5179 calls to associate logical volumes and volume groups.
5181 See also C<guestfs_vgpvuuids>.");
5183 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5184 [InitScratchFS, Always, TestOutputBuffer (
5185 [["mkdir"; "/copy_size"];
5186 ["write"; "/copy_size/src"; "hello, world"];
5187 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5188 ["read_file"; "/copy_size/dest"]], "hello")],
5189 "copy size bytes from source to destination using dd",
5191 This command copies exactly C<size> bytes from one source device
5192 or file C<src> to another destination device or file C<dest>.
5194 Note this will fail if the source is too short or if the destination
5195 is not large enough.");
5197 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5198 [InitBasicFSonLVM, Always, TestRun (
5199 [["zero_device"; "/dev/VG/LV"]])],
5200 "write zeroes to an entire device",
5202 This command writes zeroes over the entire C<device>. Compare
5203 with C<guestfs_zero> which just zeroes the first few blocks of
5206 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5207 [InitScratchFS, Always, TestOutput (
5208 [["mkdir"; "/txz_in"];
5209 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5210 ["cat"; "/txz_in/hello"]], "hello\n")],
5211 "unpack compressed tarball to directory",
5213 This command uploads and unpacks local file C<tarball> (an
5214 I<xz compressed> tar file) into C<directory>.");
5216 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5218 "pack directory into compressed tarball",
5220 This command packs the contents of C<directory> and downloads
5221 it to local file C<tarball> (as an xz compressed tar archive).");
5223 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5225 "resize an NTFS filesystem",
5227 This command resizes an NTFS filesystem, expanding or
5228 shrinking it to the size of the underlying device.
5229 See also L<ntfsresize(8)>.");
5231 ("vgscan", (RErr, [], []), 232, [],
5232 [InitEmpty, Always, TestRun (
5234 "rescan for LVM physical volumes, volume groups and logical volumes",
5236 This rescans all block devices and rebuilds the list of LVM
5237 physical volumes, volume groups and logical volumes.");
5239 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5240 [InitEmpty, Always, TestRun (
5241 [["part_init"; "/dev/sda"; "mbr"];
5242 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5243 ["part_del"; "/dev/sda"; "1"]])],
5244 "delete a partition",
5246 This command deletes the partition numbered C<partnum> on C<device>.
5248 Note that in the case of MBR partitioning, deleting an
5249 extended partition also deletes any logical partitions
5252 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5253 [InitEmpty, Always, TestOutputTrue (
5254 [["part_init"; "/dev/sda"; "mbr"];
5255 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5256 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5257 ["part_get_bootable"; "/dev/sda"; "1"]])],
5258 "return true if a partition is bootable",
5260 This command returns true if the partition C<partnum> on
5261 C<device> has the bootable flag set.
5263 See also C<guestfs_part_set_bootable>.");
5265 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5266 [InitEmpty, Always, TestOutputInt (
5267 [["part_init"; "/dev/sda"; "mbr"];
5268 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5269 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5270 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5271 "get the MBR type byte (ID byte) from a partition",
5273 Returns the MBR type byte (also known as the ID byte) from
5274 the numbered partition C<partnum>.
5276 Note that only MBR (old DOS-style) partitions have type bytes.
5277 You will get undefined results for other partition table
5278 types (see C<guestfs_part_get_parttype>).");
5280 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5281 [], (* tested by part_get_mbr_id *)
5282 "set the MBR type byte (ID byte) of a partition",
5284 Sets the MBR type byte (also known as the ID byte) of
5285 the numbered partition C<partnum> to C<idbyte>. Note
5286 that the type bytes quoted in most documentation are
5287 in fact hexadecimal numbers, but usually documented
5288 without any leading \"0x\" which might be confusing.
5290 Note that only MBR (old DOS-style) partitions have type bytes.
5291 You will get undefined results for other partition table
5292 types (see C<guestfs_part_get_parttype>).");
5294 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5295 [InitISOFS, Always, TestOutputFileMD5 (
5296 [["checksum_device"; "md5"; "/dev/sdd"]],
5297 "../images/test.iso")],
5298 "compute MD5, SHAx or CRC checksum of the contents of a device",
5300 This call computes the MD5, SHAx or CRC checksum of the
5301 contents of the device named C<device>. For the types of
5302 checksums supported see the C<guestfs_checksum> command.");
5304 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5305 [InitNone, Always, TestRun (
5306 [["part_disk"; "/dev/sda"; "mbr"];
5307 ["pvcreate"; "/dev/sda1"];
5308 ["vgcreate"; "VG"; "/dev/sda1"];
5309 ["lvcreate"; "LV"; "VG"; "10"];
5310 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5311 "expand an LV to fill free space",
5313 This expands an existing logical volume C<lv> so that it fills
5314 C<pc>% of the remaining free space in the volume group. Commonly
5315 you would call this with pc = 100 which expands the logical volume
5316 as much as possible, using all remaining free space in the volume
5319 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5320 [], (* XXX Augeas code needs tests. *)
5321 "clear Augeas path",
5323 Set the value associated with C<path> to C<NULL>. This
5324 is the same as the L<augtool(1)> C<clear> command.");
5326 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5327 [InitEmpty, Always, TestOutputInt (
5328 [["get_umask"]], 0o22)],
5329 "get the current umask",
5331 Return the current umask. By default the umask is C<022>
5332 unless it has been set by calling C<guestfs_umask>.");
5334 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5336 "upload a file to the appliance (internal use only)",
5338 The C<guestfs_debug_upload> command uploads a file to
5339 the libguestfs appliance.
5341 There is no comprehensive help for this command. You have
5342 to look at the file C<daemon/debug.c> in the libguestfs source
5343 to find out what it is for.");
5345 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5346 [InitScratchFS, Always, TestOutput (
5347 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5348 ["cat"; "/base64_in"]], "hello\n")],
5349 "upload base64-encoded data to file",
5351 This command uploads base64-encoded data from C<base64file>
5354 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5356 "download file and encode as base64",
5358 This command downloads the contents of C<filename>, writing
5359 it out to local file C<base64file> encoded as base64.");
5361 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5363 "compute MD5, SHAx or CRC checksum of files in a directory",
5365 This command computes the checksums of all regular files in
5366 C<directory> and then emits a list of those checksums to
5367 the local output file C<sumsfile>.
5369 This can be used for verifying the integrity of a virtual
5370 machine. However to be properly secure you should pay
5371 attention to the output of the checksum command (it uses
5372 the ones from GNU coreutils). In particular when the
5373 filename is not printable, coreutils uses a special
5374 backslash syntax. For more information, see the GNU
5375 coreutils info file.");
5377 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5378 [InitScratchFS, Always, TestOutputBuffer (
5379 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5380 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5381 "fill a file with a repeating pattern of bytes",
5383 This function is like C<guestfs_fill> except that it creates
5384 a new file of length C<len> containing the repeating pattern
5385 of bytes in C<pattern>. The pattern is truncated if necessary
5386 to ensure the length of the file is exactly C<len> bytes.");
5388 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5389 [InitScratchFS, Always, TestOutput (
5390 [["write"; "/write"; "new file contents"];
5391 ["cat"; "/write"]], "new file contents");
5392 InitScratchFS, Always, TestOutput (
5393 [["write"; "/write2"; "\nnew file contents\n"];
5394 ["cat"; "/write2"]], "\nnew file contents\n");
5395 InitScratchFS, Always, TestOutput (
5396 [["write"; "/write3"; "\n\n"];
5397 ["cat"; "/write3"]], "\n\n");
5398 InitScratchFS, Always, TestOutput (
5399 [["write"; "/write4"; ""];
5400 ["cat"; "/write4"]], "");
5401 InitScratchFS, Always, TestOutput (
5402 [["write"; "/write5"; "\n\n\n"];
5403 ["cat"; "/write5"]], "\n\n\n");
5404 InitScratchFS, Always, TestOutput (
5405 [["write"; "/write6"; "\n"];
5406 ["cat"; "/write6"]], "\n")],
5407 "create a new file",
5409 This call creates a file called C<path>. The content of the
5410 file is the string C<content> (which can contain any 8 bit data).");
5412 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5413 [InitScratchFS, Always, TestOutput (
5414 [["write"; "/pwrite"; "new file contents"];
5415 ["pwrite"; "/pwrite"; "data"; "4"];
5416 ["cat"; "/pwrite"]], "new data contents");
5417 InitScratchFS, Always, TestOutput (
5418 [["write"; "/pwrite2"; "new file contents"];
5419 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5420 ["cat"; "/pwrite2"]], "new file is extended");
5421 InitScratchFS, Always, TestOutput (
5422 [["write"; "/pwrite3"; "new file contents"];
5423 ["pwrite"; "/pwrite3"; ""; "4"];
5424 ["cat"; "/pwrite3"]], "new file contents")],
5425 "write to part of a file",
5427 This command writes to part of a file. It writes the data
5428 buffer C<content> to the file C<path> starting at offset C<offset>.
5430 This command implements the L<pwrite(2)> system call, and like
5431 that system call it may not write the full data requested. The
5432 return value is the number of bytes that were actually written
5433 to the file. This could even be 0, although short writes are
5434 unlikely for regular files in ordinary circumstances.
5436 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5438 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5440 "resize an ext2, ext3 or ext4 filesystem (with size)",
5442 This command is the same as C<guestfs_resize2fs> except that it
5443 allows you to specify the new size (in bytes) explicitly.");
5445 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5447 "resize an LVM physical volume (with size)",
5449 This command is the same as C<guestfs_pvresize> except that it
5450 allows you to specify the new size (in bytes) explicitly.");
5452 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5454 "resize an NTFS filesystem (with size)",
5456 This command is the same as C<guestfs_ntfsresize> except that it
5457 allows you to specify the new size (in bytes) explicitly.");
5459 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5460 [InitNone, Always, TestRun [["available_all_groups"]]],
5461 "return a list of all optional groups",
5463 This command returns a list of all optional groups that this
5464 daemon knows about. Note this returns both supported and unsupported
5465 groups. To find out which ones the daemon can actually support
5466 you have to call C<guestfs_available> on each member of the
5469 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5471 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5472 [InitScratchFS, Always, TestOutputStruct (
5473 [["fallocate64"; "/fallocate64"; "1000000"];
5474 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5475 "preallocate a file in the guest filesystem",
5477 This command preallocates a file (containing zero bytes) named
5478 C<path> of size C<len> bytes. If the file exists already, it
5481 Note that this call allocates disk blocks for the file.
5482 To create a sparse file use C<guestfs_truncate_size> instead.
5484 The deprecated call C<guestfs_fallocate> does the same,
5485 but owing to an oversight it only allowed 30 bit lengths
5486 to be specified, effectively limiting the maximum size
5487 of files created through that call to 1GB.
5489 Do not confuse this with the guestfish-specific
5490 C<alloc> and C<sparse> commands which create
5491 a file in the host and attach it as a device.");
5493 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5494 [InitBasicFS, Always, TestOutput (
5495 [["set_e2label"; "/dev/sda1"; "LTEST"];
5496 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5497 "get the filesystem label",
5499 This returns the filesystem label of the filesystem on
5502 If the filesystem is unlabeled, this returns the empty string.
5504 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5506 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5507 (let uuid = uuidgen () in
5508 [InitBasicFS, Always, TestOutput (
5509 [["set_e2uuid"; "/dev/sda1"; uuid];
5510 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5511 "get the filesystem UUID",
5513 This returns the filesystem UUID of the filesystem on
5516 If the filesystem does not have a UUID, this returns the empty string.
5518 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5520 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5521 (* Can't be tested with the current framework because
5522 * the VG is being used by the mounted filesystem, so
5523 * the vgchange -an command we do first will fail.
5526 "set LVM device filter",
5528 This sets the LVM device filter so that LVM will only be
5529 able to \"see\" the block devices in the list C<devices>,
5530 and will ignore all other attached block devices.
5532 Where disk image(s) contain duplicate PVs or VGs, this
5533 command is useful to get LVM to ignore the duplicates, otherwise
5534 LVM can get confused. Note also there are two types
5535 of duplication possible: either cloned PVs/VGs which have
5536 identical UUIDs; or VGs that are not cloned but just happen
5537 to have the same name. In normal operation you cannot
5538 create this situation, but you can do it outside LVM, eg.
5539 by cloning disk images or by bit twiddling inside the LVM
5542 This command also clears the LVM cache and performs a volume
5545 You can filter whole block devices or individual partitions.
5547 You cannot use this if any VG is currently in use (eg.
5548 contains a mounted filesystem), even if you are not
5549 filtering out that VG.");
5551 ("lvm_clear_filter", (RErr, [], []), 256, [],
5552 [], (* see note on lvm_set_filter *)
5553 "clear LVM device filter",
5555 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5556 will be able to see every block device.
5558 This command also clears the LVM cache and performs a volume
5561 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5563 "open a LUKS-encrypted block device",
5565 This command opens a block device which has been encrypted
5566 according to the Linux Unified Key Setup (LUKS) standard.
5568 C<device> is the encrypted block device or partition.
5570 The caller must supply one of the keys associated with the
5571 LUKS block device, in the C<key> parameter.
5573 This creates a new block device called C</dev/mapper/mapname>.
5574 Reads and writes to this block device are decrypted from and
5575 encrypted to the underlying C<device> respectively.
5577 If this block device contains LVM volume groups, then
5578 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5579 will make them visible.");
5581 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5583 "open a LUKS-encrypted block device read-only",
5585 This is the same as C<guestfs_luks_open> except that a read-only
5586 mapping is created.");
5588 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5590 "close a LUKS device",
5592 This closes a LUKS device that was created earlier by
5593 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5594 C<device> parameter must be the name of the LUKS mapping
5595 device (ie. C</dev/mapper/mapname>) and I<not> the name
5596 of the underlying block device.");
5598 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5600 "format a block device as a LUKS encrypted device",
5602 This command erases existing data on C<device> and formats
5603 the device as a LUKS encrypted device. C<key> is the
5604 initial key, which is added to key slot C<slot>. (LUKS
5605 supports 8 key slots, numbered 0-7).");
5607 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5609 "format a block device as a LUKS encrypted device",
5611 This command is the same as C<guestfs_luks_format> but
5612 it also allows you to set the C<cipher> used.");
5614 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5616 "add a key on a LUKS encrypted device",
5618 This command adds a new key on LUKS device C<device>.
5619 C<key> is any existing key, and is used to access the device.
5620 C<newkey> is the new key to add. C<keyslot> is the key slot
5621 that will be replaced.
5623 Note that if C<keyslot> already contains a key, then this
5624 command will fail. You have to use C<guestfs_luks_kill_slot>
5625 first to remove that key.");
5627 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5629 "remove a key from a LUKS encrypted device",
5631 This command deletes the key in key slot C<keyslot> from the
5632 encrypted LUKS device C<device>. C<key> must be one of the
5635 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5636 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5637 [["is_lv"; "/dev/VG/LV"]]);
5638 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5639 [["is_lv"; "/dev/sda1"]])],
5640 "test if device is a logical volume",
5642 This command tests whether C<device> is a logical volume, and
5643 returns true iff this is the case.");
5645 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5647 "find a filesystem by UUID",
5649 This command searches the filesystems and returns the one
5650 which has the given UUID. An error is returned if no such
5651 filesystem can be found.
5653 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5655 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5657 "find a filesystem by label",
5659 This command searches the filesystems and returns the one
5660 which has the given label. An error is returned if no such
5661 filesystem can be found.
5663 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5665 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5666 [InitISOFS, Always, TestOutputFalse (
5667 [["is_chardev"; "/directory"]]);
5668 InitScratchFS, Always, TestOutputTrue (
5669 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5670 ["is_chardev"; "/is_chardev"]])],
5671 "test if character device",
5673 This returns C<true> if and only if there is a character device
5674 with the given C<path> name.
5676 See also C<guestfs_stat>.");
5678 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5679 [InitISOFS, Always, TestOutputFalse (
5680 [["is_blockdev"; "/directory"]]);
5681 InitScratchFS, Always, TestOutputTrue (
5682 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5683 ["is_blockdev"; "/is_blockdev"]])],
5684 "test if block device",
5686 This returns C<true> if and only if there is a block device
5687 with the given C<path> name.
5689 See also C<guestfs_stat>.");
5691 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5692 [InitISOFS, Always, TestOutputFalse (
5693 [["is_fifo"; "/directory"]]);
5694 InitScratchFS, Always, TestOutputTrue (
5695 [["mkfifo"; "0o777"; "/is_fifo"];
5696 ["is_fifo"; "/is_fifo"]])],
5697 "test if FIFO (named pipe)",
5699 This returns C<true> if and only if there is a FIFO (named pipe)
5700 with the given C<path> name.
5702 See also C<guestfs_stat>.");
5704 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5705 [InitISOFS, Always, TestOutputFalse (
5706 [["is_symlink"; "/directory"]]);
5707 InitISOFS, Always, TestOutputTrue (
5708 [["is_symlink"; "/abssymlink"]])],
5709 "test if symbolic link",
5711 This returns C<true> if and only if there is a symbolic link
5712 with the given C<path> name.
5714 See also C<guestfs_stat>.");
5716 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5717 (* XXX Need a positive test for sockets. *)
5718 [InitISOFS, Always, TestOutputFalse (
5719 [["is_socket"; "/directory"]])],
5722 This returns C<true> if and only if there is a Unix domain socket
5723 with the given C<path> name.
5725 See also C<guestfs_stat>.");
5727 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5728 [InitPartition, Always, TestOutputDevice (
5729 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5730 InitEmpty, Always, TestLastFail (
5731 [["part_to_dev"; "/dev/sda"]])],
5732 "convert partition name to device name",
5734 This function takes a partition name (eg. \"/dev/sdb1\") and
5735 removes the partition number, returning the device name
5738 The named partition must exist, for example as a string returned
5739 from C<guestfs_list_partitions>.");
5741 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5742 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5743 [InitScratchFS, Always, TestOutput (
5744 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5745 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5746 "upload a file from the local machine with offset",
5748 Upload local file C<filename> to C<remotefilename> on the
5751 C<remotefilename> is overwritten starting at the byte C<offset>
5752 specified. The intention is to overwrite parts of existing
5753 files or devices, although if a non-existant file is specified
5754 then it is created with a \"hole\" before C<offset>. The
5755 size of the data written is implicit in the size of the
5758 Note that there is no limit on the amount of data that
5759 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5760 and this call always writes the full amount unless an
5763 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5765 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5766 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5767 let offset = string_of_int 100 in
5768 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5769 [InitScratchFS, Always, TestOutput (
5770 (* Pick a file from cwd which isn't likely to change. *)
5771 [["mkdir"; "/download_offset"];
5772 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5773 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5774 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5775 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5776 "download a file to the local machine with offset and size",
5778 Download file C<remotefilename> and save it as C<filename>
5779 on the local machine.
5781 C<remotefilename> is read for C<size> bytes starting at C<offset>
5782 (this region must be within the file or device).
5784 Note that there is no limit on the amount of data that
5785 can be downloaded with this call, unlike with C<guestfs_pread>,
5786 and this call always reads the full amount unless an
5789 See also C<guestfs_download>, C<guestfs_pread>.");
5791 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5792 [InitPartition, Always, TestOutputListOfDevices (
5793 [["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"];
5794 ["blockdev_rereadpt"; "/dev/sda"];
5795 ["list_partitions"]], ["/dev/sdb1"])],
5796 "write to part of a device",
5798 This command writes to part of a device. It writes the data
5799 buffer C<content> to C<device> starting at offset C<offset>.
5801 This command implements the L<pwrite(2)> system call, and like
5802 that system call it may not write the full data requested
5803 (although short writes to disk devices and partitions are
5804 probably impossible with standard Linux kernels).
5806 See also C<guestfs_pwrite>.");
5808 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5809 [InitEmpty, Always, TestOutputBuffer (
5810 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5811 "read part of a device",
5813 This command lets you read part of a file. It reads C<count>
5814 bytes of C<device>, starting at C<offset>.
5816 This may read fewer bytes than requested. For further details
5817 see the L<pread(2)> system call.
5819 See also C<guestfs_pread>.");
5821 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5822 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5823 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5824 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5825 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5826 "get canonical name of an LV",
5828 This converts alternative naming schemes for LVs that you
5829 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5830 is converted to C</dev/VG/LV>.
5832 This command returns an error if the C<lvname> parameter does
5833 not refer to a logical volume.
5835 See also C<guestfs_is_lv>.");
5837 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5838 [InitEmpty, Always, TestOutput (
5839 [["part_disk"; "/dev/sda"; "mbr"];
5840 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5841 ["mount_options"; ""; "/dev/sda1"; "/"];
5842 ["write"; "/new"; "new file contents"];
5843 ["cat"; "/new"]], "new file contents")],
5844 "make a filesystem",
5846 This function creates a filesystem on C<device>. The filesystem
5847 type is C<fstype>, for example C<ext3>.
5849 The optional arguments are:
5855 The filesystem block size. Supported block sizes depend on the
5856 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5857 for Linux ext2/3 filesystems.
5859 For VFAT and NTFS the C<blocksize> parameter is treated as
5860 the requested cluster size.
5862 For UFS block sizes, please see L<mkfs.ufs(8)>.
5866 This passes the I<-O> parameter to the external mkfs program.
5868 For certain filesystem types, this allows extra filesystem
5869 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5872 You cannot use this optional parameter with the C<gfs> or
5873 C<gfs2> filesystem type.
5877 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5879 "get a single extended attribute",
5881 Get a single extended attribute from file C<path> named C<name>.
5882 This call follows symlinks. If you want to lookup an extended
5883 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5885 Normally it is better to get all extended attributes from a file
5886 in one go by calling C<guestfs_getxattrs>. However some Linux
5887 filesystem implementations are buggy and do not provide a way to
5888 list out attributes. For these filesystems (notably ntfs-3g)
5889 you have to know the names of the extended attributes you want
5890 in advance and call this function.
5892 Extended attribute values are blobs of binary data. If there
5893 is no extended attribute named C<name>, this returns an error.
5895 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5897 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5899 "get a single extended attribute",
5901 Get a single extended attribute from file C<path> named C<name>.
5902 If C<path> is a symlink, then this call returns an extended
5903 attribute from the symlink.
5905 Normally it is better to get all extended attributes from a file
5906 in one go by calling C<guestfs_getxattrs>. However some Linux
5907 filesystem implementations are buggy and do not provide a way to
5908 list out attributes. For these filesystems (notably ntfs-3g)
5909 you have to know the names of the extended attributes you want
5910 in advance and call this function.
5912 Extended attribute values are blobs of binary data. If there
5913 is no extended attribute named C<name>, this returns an error.
5915 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5917 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5919 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5921 This command is the same as C<guestfs_resize2fs>, but the filesystem
5922 is resized to its minimum size. This works like the I<-M> option
5923 to the C<resize2fs> command.
5925 To get the resulting size of the filesystem you should call
5926 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5927 values. These two numbers, multiplied together, give the
5928 resulting size of the minimal filesystem in bytes.");
5930 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5932 "internal autosync operation",
5934 This command performs the autosync operation just before the
5935 handle is closed. You should not call this command directly.
5936 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5937 control whether or not this operation is performed when the
5938 handle is closed.");
5940 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
5941 [InitISOFS, Always, TestOutputTrue (
5942 [["is_zero"; "/100kallzeroes"]]);
5943 InitISOFS, Always, TestOutputFalse (
5944 [["is_zero"; "/100kallspaces"]])],
5945 "test if a file contains all zero bytes",
5947 This returns true iff the file exists and the file is empty or
5948 it contains all zero bytes.");
5950 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
5951 [InitBasicFS, Always, TestOutputTrue (
5952 [["umount"; "/dev/sda1"];
5953 ["zero_device"; "/dev/sda1"];
5954 ["is_zero_device"; "/dev/sda1"]]);
5955 InitBasicFS, Always, TestOutputFalse (
5956 [["is_zero_device"; "/dev/sda1"]])],
5957 "test if a device contains all zero bytes",
5959 This returns true iff the device exists and contains all zero bytes.
5961 Note that for large devices this can take a long time to run.");
5965 let all_functions = non_daemon_functions @ daemon_functions
5967 (* In some places we want the functions to be displayed sorted
5968 * alphabetically, so this is useful:
5970 let all_functions_sorted = List.sort action_compare all_functions
5972 (* This is used to generate the src/MAX_PROC_NR file which
5973 * contains the maximum procedure number, a surrogate for the
5974 * ABI version number. See src/Makefile.am for the details.
5977 let proc_nrs = List.map (
5978 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5979 ) daemon_functions in
5980 List.fold_left max 0 proc_nrs
5982 (* Non-API meta-commands available only in guestfish.
5984 * Note (1): style, proc_nr and tests fields are all meaningless.
5985 * The only fields which are actually used are the shortname,
5986 * FishAlias flags, shortdesc and longdesc.
5988 * Note (2): to refer to other commands, use L</shortname>.
5990 * Note (3): keep this list sorted by shortname.
5992 let fish_commands = [
5993 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5994 "allocate and add a disk file",
5995 " alloc filename size
5997 This creates an empty (zeroed) file of the given size, and then adds
5998 so it can be further examined.
6000 For more advanced image creation, see L<qemu-img(1)> utility.
6002 Size can be specified using standard suffixes, eg. C<1M>.
6004 To create a sparse file, use L</sparse> instead. To create a
6005 prepared disk image, see L</PREPARED DISK IMAGES>.");
6007 ("copy_in", (RErr,[], []), -1, [], [],
6008 "copy local files or directories into an image",
6009 " copy-in local [local ...] /remotedir
6011 C<copy-in> copies local files or directories recursively into the disk
6012 image, placing them in the directory called C</remotedir> (which must
6013 exist). This guestfish meta-command turns into a sequence of
6014 L</tar-in> and other commands as necessary.
6016 Multiple local files and directories can be specified, but the last
6017 parameter must always be a remote directory. Wildcards cannot be
6020 ("copy_out", (RErr,[], []), -1, [], [],
6021 "copy remote files or directories out of an image",
6022 " copy-out remote [remote ...] localdir
6024 C<copy-out> copies remote files or directories recursively out of the
6025 disk image, placing them on the host disk in a local directory called
6026 C<localdir> (which must exist). This guestfish meta-command turns
6027 into a sequence of L</download>, L</tar-out> and other commands as
6030 Multiple remote files and directories can be specified, but the last
6031 parameter must always be a local directory. To download to the
6032 current directory, use C<.> as in:
6036 Wildcards cannot be used in the ordinary command, but you can use
6037 them with the help of L</glob> like this:
6039 glob copy-out /home/* .");
6041 ("echo", (RErr,[], []), -1, [], [],
6042 "display a line of text",
6045 This echos the parameters to the terminal.");
6047 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6051 This is used to edit a file. It downloads the file, edits it
6052 locally using your editor, then uploads the result.
6054 The editor is C<$EDITOR>. However if you use the alternate
6055 commands C<vi> or C<emacs> you will get those corresponding
6058 ("glob", (RErr,[], []), -1, [], [],
6059 "expand wildcards in command",
6060 " glob command args...
6062 Expand wildcards in any paths in the args list, and run C<command>
6063 repeatedly on each matching path.
6065 See L</WILDCARDS AND GLOBBING>.");
6067 ("hexedit", (RErr,[], []), -1, [], [],
6068 "edit with a hex editor",
6069 " hexedit <filename|device>
6070 hexedit <filename|device> <max>
6071 hexedit <filename|device> <start> <max>
6073 Use hexedit (a hex editor) to edit all or part of a binary file
6076 This command works by downloading potentially the whole file or
6077 device, editing it locally, then uploading it. If the file or
6078 device is large, you have to specify which part you wish to edit
6079 by using C<max> and/or C<start> C<max> parameters.
6080 C<start> and C<max> are specified in bytes, with the usual
6081 modifiers allowed such as C<1M> (1 megabyte).
6083 For example to edit the first few sectors of a disk you
6088 which would allow you to edit anywhere within the first megabyte
6091 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6093 hexedit /dev/sda1 0x400 0x400
6095 (assuming the superblock is in the standard location).
6097 This command requires the external L<hexedit(1)> program. You
6098 can specify another program to use by setting the C<HEXEDITOR>
6099 environment variable.
6101 See also L</hexdump>.");
6103 ("lcd", (RErr,[], []), -1, [], [],
6104 "change working directory",
6107 Change the local directory, ie. the current directory of guestfish
6110 Note that C<!cd> won't do what you might expect.");
6112 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6116 Opens the manual page for guestfish.");
6118 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6124 This is used to view a file.
6126 The default viewer is C<$PAGER>. However if you use the alternate
6127 command C<less> you will get the C<less> command specifically.");
6129 ("reopen", (RErr,[], []), -1, [], [],
6130 "close and reopen libguestfs handle",
6133 Close and reopen the libguestfs handle. It is not necessary to use
6134 this normally, because the handle is closed properly when guestfish
6135 exits. However this is occasionally useful for testing.");
6137 ("sparse", (RErr,[], []), -1, [], [],
6138 "create a sparse disk image and add",
6139 " sparse filename size
6141 This creates an empty sparse file of the given size, and then adds
6142 so it can be further examined.
6144 In all respects it works the same as the L</alloc> command, except that
6145 the image file is allocated sparsely, which means that disk blocks are
6146 not assigned to the file until they are needed. Sparse disk files
6147 only use space when written to, but they are slower and there is a
6148 danger you could run out of real disk space during a write operation.
6150 For more advanced image creation, see L<qemu-img(1)> utility.
6152 Size can be specified using standard suffixes, eg. C<1M>.");
6154 ("supported", (RErr,[], []), -1, [], [],
6155 "list supported groups of commands",
6158 This command returns a list of the optional groups
6159 known to the daemon, and indicates which ones are
6160 supported by this build of the libguestfs appliance.
6162 See also L<guestfs(3)/AVAILABILITY>.");
6164 ("time", (RErr,[], []), -1, [], [],
6165 "print elapsed time taken to run a command",
6166 " time command args...
6168 Run the command as usual, but print the elapsed time afterwards. This
6169 can be useful for benchmarking operations.");