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 returns the type of the inspected operating system.
730 Currently defined types are:
736 Any Linux-based operating system.
740 Any Microsoft Windows operating system.
748 The operating system type could not be determined.
752 Future versions of libguestfs may return other strings here.
753 The caller should be prepared to handle any string.
755 Please read L<guestfs(3)/INSPECTION> for more details.");
757 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
759 "get architecture of inspected operating system",
761 This returns the architecture of the inspected operating system.
762 The possible return values are listed under
763 C<guestfs_file_architecture>.
765 If the architecture could not be determined, then the
766 string C<unknown> is returned.
768 Please read L<guestfs(3)/INSPECTION> for more details.");
770 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
772 "get distro of inspected operating system",
774 This returns the distro (distribution) of the inspected operating
777 Currently defined distros are:
817 =item \"redhat-based\"
819 Some Red Hat-derived distro.
823 Red Hat Enterprise Linux.
825 =item \"scientificlinux\"
839 The distro could not be determined.
843 Windows does not have distributions. This string is
844 returned if the OS type is Windows.
848 Future versions of libguestfs may return other strings here.
849 The caller should be prepared to handle any string.
851 Please read L<guestfs(3)/INSPECTION> for more details.");
853 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
855 "get major version of inspected operating system",
857 This returns the major version number of the inspected operating
860 Windows uses a consistent versioning scheme which is I<not>
861 reflected in the popular public names used by the operating system.
862 Notably the operating system known as \"Windows 7\" is really
863 version 6.1 (ie. major = 6, minor = 1). You can find out the
864 real versions corresponding to releases of Windows by consulting
867 If the version could not be determined, then C<0> is returned.
869 Please read L<guestfs(3)/INSPECTION> for more details.");
871 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
873 "get minor version of inspected operating system",
875 This returns the minor version number of the inspected operating
878 If the version could not be determined, then C<0> is returned.
880 Please read L<guestfs(3)/INSPECTION> for more details.
881 See also C<guestfs_inspect_get_major_version>.");
883 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
885 "get product name of inspected operating system",
887 This returns the product name of the inspected operating
888 system. The product name is generally some freeform string
889 which can be displayed to the user, but should not be
892 If the product name could not be determined, then the
893 string C<unknown> is returned.
895 Please read L<guestfs(3)/INSPECTION> for more details.");
897 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
899 "get mountpoints of inspected operating system",
901 This returns a hash of where we think the filesystems
902 associated with this operating system should be mounted.
903 Callers should note that this is at best an educated guess
904 made by reading configuration files such as C</etc/fstab>.
905 I<In particular note> that this may return filesystems
906 which are non-existent or not mountable and callers should
907 be prepared to handle or ignore failures if they try to
910 Each element in the returned hashtable has a key which
911 is the path of the mountpoint (eg. C</boot>) and a value
912 which is the filesystem that would be mounted there
915 Non-mounted devices such as swap devices are I<not>
916 returned in this list.
918 For operating systems like Windows which still use drive
919 letters, this call will only return an entry for the first
920 drive \"mounted on\" C</>. For information about the
921 mapping of drive letters to partitions, see
922 C<guestfs_inspect_get_drive_mappings>.
924 Please read L<guestfs(3)/INSPECTION> for more details.
925 See also C<guestfs_inspect_get_filesystems>.");
927 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
929 "get filesystems associated with inspected operating system",
931 This returns a list of all the filesystems that we think
932 are associated with this operating system. This includes
933 the root filesystem, other ordinary filesystems, and
934 non-mounted devices like swap partitions.
936 In the case of a multi-boot virtual machine, it is possible
937 for a filesystem to be shared between operating systems.
939 Please read L<guestfs(3)/INSPECTION> for more details.
940 See also C<guestfs_inspect_get_mountpoints>.");
942 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
944 "set enable network flag",
946 If C<network> is true, then the network is enabled in the
947 libguestfs appliance. The default is false.
949 This affects whether commands are able to access the network
950 (see L<guestfs(3)/RUNNING COMMANDS>).
952 You must call this before calling C<guestfs_launch>, otherwise
955 ("get_network", (RBool "network", [], []), -1, [],
957 "get enable network flag",
959 This returns the enable network flag.");
961 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
965 This inspection command looks for filesystems on partitions,
966 block devices and logical volumes, returning a list of devices
967 containing filesystems and their type.
969 The return value is a hash, where the keys are the devices
970 containing filesystems, and the values are the filesystem types.
973 \"/dev/sda1\" => \"ntfs\"
974 \"/dev/sda2\" => \"ext2\"
975 \"/dev/vg_guest/lv_root\" => \"ext4\"
976 \"/dev/vg_guest/lv_swap\" => \"swap\"
978 The value can have the special value \"unknown\", meaning the
979 content of the device is undetermined or empty.
980 \"swap\" means a Linux swap partition.
982 This command runs other libguestfs commands, which might include
983 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
984 use this soon after launch and only when nothing is mounted.
986 Not all of the filesystems returned will be mountable. In
987 particular, swap partitions are returned in the list. Also
988 this command does not check that each filesystem
989 found is valid and mountable, and some filesystems might
990 be mountable but require special options. Filesystems may
991 not all belong to a single logical operating system
992 (use C<guestfs_inspect_os> to look for OSes).");
994 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
996 "add an image to examine or modify",
998 This function adds a virtual machine disk image C<filename> to
999 libguestfs. The first time you call this function, the disk
1000 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1003 You don't necessarily need to be root when using libguestfs. However
1004 you obviously do need sufficient permissions to access the filename
1005 for whatever operations you want to perform (ie. read access if you
1006 just want to read the image or write access if you want to modify the
1009 This call checks that C<filename> exists.
1011 The optional arguments are:
1017 If true then the image is treated as read-only. Writes are still
1018 allowed, but they are stored in a temporary snapshot overlay which
1019 is discarded at the end. The disk that you add is not modified.
1023 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1024 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1025 Possible formats include C<raw> and C<qcow2>.
1027 Automatic detection of the format opens you up to a potential
1028 security hole when dealing with untrusted raw-format images.
1029 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1034 This rarely-used option lets you emulate the behaviour of the
1035 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1039 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1041 "get Windows systemroot of inspected operating system",
1043 This returns the Windows systemroot of the inspected guest.
1044 The systemroot is a directory path such as C</WINDOWS>.
1046 This call assumes that the guest is Windows and that the
1047 systemroot could be determined by inspection. If this is not
1048 the case then an error is returned.
1050 Please read L<guestfs(3)/INSPECTION> for more details.");
1052 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1054 "return list of operating systems found by last inspection",
1056 This function is a convenient way to get the list of root
1057 devices, as returned from a previous call to C<guestfs_inspect_os>,
1058 but without redoing the whole inspection process.
1060 This returns an empty list if either no root devices were
1061 found or the caller has not called C<guestfs_inspect_os>.
1063 Please read L<guestfs(3)/INSPECTION> for more details.");
1065 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1067 "debug the QEMU command line (internal use only)",
1069 This returns the internal QEMU command line. 'debug' commands are
1070 not part of the formal API and can be removed or changed at any time.");
1072 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1074 "add the disk(s) from a named libvirt domain",
1076 This function adds the disk(s) attached to the named libvirt
1077 domain C<dom>. It works by connecting to libvirt, requesting
1078 the domain and domain XML from libvirt, parsing it for disks,
1079 and calling C<guestfs_add_drive_opts> on each one.
1081 The number of disks added is returned. This operation is atomic:
1082 if an error is returned, then no disks are added.
1084 This function does some minimal checks to make sure the libvirt
1085 domain is not running (unless C<readonly> is true). In a future
1086 version we will try to acquire the libvirt lock on each disk.
1088 Disks must be accessible locally. This often means that adding disks
1089 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1090 will fail unless those disks are accessible via the same device path
1093 The optional C<libvirturi> parameter sets the libvirt URI
1094 (see L<http://libvirt.org/uri.html>). If this is not set then
1095 we connect to the default libvirt URI (or one set through an
1096 environment variable, see the libvirt documentation for full
1099 The optional C<live> flag controls whether this call will try
1100 to connect to a running virtual machine C<guestfsd> process if
1101 it sees a suitable E<lt>channelE<gt> element in the libvirt
1102 XML definition. The default (if the flag is omitted) is never
1103 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1106 If the C<allowuuid> flag is true (default is false) then a UUID
1107 I<may> be passed instead of the domain name. The C<dom> string is
1108 treated as a UUID first and looked up, and if that lookup fails
1109 then we treat C<dom> as a name as usual.
1111 The other optional parameters are passed directly through to
1112 C<guestfs_add_drive_opts>.");
1115 This interface is not quite baked yet. -- RWMJ 2010-11-11
1116 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1118 "add the disk(s) from a libvirt domain",
1120 This function adds the disk(s) attached to the libvirt domain C<dom>.
1121 It works by requesting the domain XML from libvirt, parsing it for
1122 disks, and calling C<guestfs_add_drive_opts> on each one.
1124 In the C API we declare C<void *dom>, but really it has type
1125 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1127 The number of disks added is returned. This operation is atomic:
1128 if an error is returned, then no disks are added.
1130 This function does some minimal checks to make sure the libvirt
1131 domain is not running (unless C<readonly> is true). In a future
1132 version we will try to acquire the libvirt lock on each disk.
1134 Disks must be accessible locally. This often means that adding disks
1135 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1136 will fail unless those disks are accessible via the same device path
1139 The optional C<live> flag controls whether this call will try
1140 to connect to a running virtual machine C<guestfsd> process if
1141 it sees a suitable E<lt>channelE<gt> element in the libvirt
1142 XML definition. The default (if the flag is omitted) is never
1143 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1146 The other optional parameters are passed directly through to
1147 C<guestfs_add_drive_opts>.");
1150 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1152 "get package format used by the operating system",
1154 This function and C<guestfs_inspect_get_package_management> return
1155 the package format and package management tool used by the
1156 inspected operating system. For example for Fedora these
1157 functions would return C<rpm> (package format) and
1158 C<yum> (package management).
1160 This returns the string C<unknown> if we could not determine the
1161 package format I<or> if the operating system does not have
1162 a real packaging system (eg. Windows).
1164 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1165 Future versions of libguestfs may return other strings.
1167 Please read L<guestfs(3)/INSPECTION> for more details.");
1169 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1171 "get package management tool used by the operating system",
1173 C<guestfs_inspect_get_package_format> and this function return
1174 the package format and package management tool used by the
1175 inspected operating system. For example for Fedora these
1176 functions would return C<rpm> (package format) and
1177 C<yum> (package management).
1179 This returns the string C<unknown> if we could not determine the
1180 package management tool I<or> if the operating system does not have
1181 a real packaging system (eg. Windows).
1183 Possible strings include: C<yum>, C<up2date>,
1184 C<apt> (for all Debian derivatives),
1185 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1186 Future versions of libguestfs may return other strings.
1188 Please read L<guestfs(3)/INSPECTION> for more details.");
1190 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1192 "get list of applications installed in the operating system",
1194 Return the list of applications installed in the operating system.
1196 I<Note:> This call works differently from other parts of the
1197 inspection API. You have to call C<guestfs_inspect_os>, then
1198 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1199 before calling this. Listing applications is a significantly
1200 more difficult operation which requires access to the full
1201 filesystem. Also note that unlike the other
1202 C<guestfs_inspect_get_*> calls which are just returning
1203 data cached in the libguestfs handle, this call actually reads
1204 parts of the mounted filesystems during the call.
1206 This returns an empty list if the inspection code was not able
1207 to determine the list of applications.
1209 The application structure contains the following fields:
1215 The name of the application. For Red Hat-derived and Debian-derived
1216 Linux guests, this is the package name.
1218 =item C<app_display_name>
1220 The display name of the application, sometimes localized to the
1221 install language of the guest operating system.
1223 If unavailable this is returned as an empty string C<\"\">.
1224 Callers needing to display something can use C<app_name> instead.
1228 For package managers which use epochs, this contains the epoch of
1229 the package (an integer). If unavailable, this is returned as C<0>.
1231 =item C<app_version>
1233 The version string of the application or package. If unavailable
1234 this is returned as an empty string C<\"\">.
1236 =item C<app_release>
1238 The release string of the application or package, for package
1239 managers that use this. If unavailable this is returned as an
1240 empty string C<\"\">.
1242 =item C<app_install_path>
1244 The installation path of the application (on operating systems
1245 such as Windows which use installation paths). This path is
1246 in the format used by the guest operating system, it is not
1249 If unavailable this is returned as an empty string C<\"\">.
1251 =item C<app_trans_path>
1253 The install path translated into a libguestfs path.
1254 If unavailable this is returned as an empty string C<\"\">.
1256 =item C<app_publisher>
1258 The name of the publisher of the application, for package
1259 managers that use this. If unavailable this is returned
1260 as an empty string C<\"\">.
1264 The URL (eg. upstream URL) of the application.
1265 If unavailable this is returned as an empty string C<\"\">.
1267 =item C<app_source_package>
1269 For packaging systems which support this, the name of the source
1270 package. If unavailable this is returned as an empty string C<\"\">.
1272 =item C<app_summary>
1274 A short (usually one line) description of the application or package.
1275 If unavailable this is returned as an empty string C<\"\">.
1277 =item C<app_description>
1279 A longer description of the application or package.
1280 If unavailable this is returned as an empty string C<\"\">.
1284 Please read L<guestfs(3)/INSPECTION> for more details.");
1286 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1288 "get hostname of the operating system",
1290 This function returns the hostname of the operating system
1291 as found by inspection of the guest's configuration files.
1293 If the hostname could not be determined, then the
1294 string C<unknown> is returned.
1296 Please read L<guestfs(3)/INSPECTION> for more details.");
1298 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1300 "get format of inspected operating system",
1302 This returns the format of the inspected operating system. You
1303 can use it to detect install images, live CDs and similar.
1305 Currently defined formats are:
1311 This is an installed operating system.
1315 The disk image being inspected is not an installed operating system,
1316 but a I<bootable> install disk, live CD, or similar.
1320 The format of this disk image is not known.
1324 Future versions of libguestfs may return other strings here.
1325 The caller should be prepared to handle any string.
1327 Please read L<guestfs(3)/INSPECTION> for more details.");
1329 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1331 "get live flag for install disk",
1333 If C<guestfs_inspect_get_format> returns C<installer> (this
1334 is an install disk), then this returns true if a live image
1335 was detected on the disk.
1337 Please read L<guestfs(3)/INSPECTION> for more details.");
1339 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1341 "get netinst (network installer) flag for install disk",
1343 If C<guestfs_inspect_get_format> returns C<installer> (this
1344 is an install disk), then this returns true if the disk is
1345 a network installer, ie. not a self-contained install CD but
1346 one which is likely to require network access to complete
1349 Please read L<guestfs(3)/INSPECTION> for more details.");
1351 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1353 "get multipart flag for install disk",
1355 If C<guestfs_inspect_get_format> returns C<installer> (this
1356 is an install disk), then this returns true if the disk is
1359 Please read L<guestfs(3)/INSPECTION> for more details.");
1361 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1363 "set the attach method",
1365 Set the method that libguestfs uses to connect to the back end
1366 guestfsd daemon. Possible methods are:
1372 Launch an appliance and connect to it. This is the ordinary method
1375 =item C<unix:I<path>>
1377 Connect to the Unix domain socket I<path>.
1379 This method lets you connect to an existing daemon or (using
1380 virtio-serial) to a live guest. For more information, see
1381 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1385 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1386 [InitNone, Always, TestOutput (
1387 [["get_attach_method"]], "appliance")],
1388 "get the attach method",
1390 Return the current attach method. See C<guestfs_set_attach_method>.");
1392 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1394 "get product variant of inspected operating system",
1396 This returns the product variant of the inspected operating
1399 For Windows guests, this returns the contents of the Registry key
1400 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1401 C<InstallationType> which is usually a string such as
1402 C<Client> or C<Server> (other values are possible). This
1403 can be used to distinguish consumer and enterprise versions
1404 of Windows that have the same version number (for example,
1405 Windows 7 and Windows 2008 Server are both version 6.1,
1406 but the former is C<Client> and the latter is C<Server>).
1408 For enterprise Linux guests, in future we intend this to return
1409 the product variant such as C<Desktop>, C<Server> and so on. But
1410 this is not implemented at present.
1412 If the product variant could not be determined, then the
1413 string C<unknown> is returned.
1415 Please read L<guestfs(3)/INSPECTION> for more details.
1416 See also C<guestfs_inspect_get_product_name>,
1417 C<guestfs_inspect_get_major_version>.");
1419 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1421 "get Windows CurrentControlSet of inspected operating system",
1423 This returns the Windows CurrentControlSet of the inspected guest.
1424 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1426 This call assumes that the guest is Windows and that the
1427 Registry could be examined by inspection. If this is not
1428 the case then an error is returned.
1430 Please read L<guestfs(3)/INSPECTION> for more details.");
1432 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1434 "get drive letter mappings",
1436 This call is useful for Windows which uses a primitive system
1437 of assigning drive letters (like \"C:\") to partitions.
1438 This inspection API examines the Windows Registry to find out
1439 how disks/partitions are mapped to drive letters, and returns
1440 a hash table as in the example below:
1446 Note that keys are drive letters. For Windows, the key is
1447 case insensitive and just contains the drive letter, without
1448 the customary colon separator character.
1450 In future we may support other operating systems that also used drive
1451 letters, but the keys for those might not be case insensitive
1452 and might be longer than 1 character. For example in OS-9,
1453 hard drives were named C<h0>, C<h1> etc.
1455 For Windows guests, currently only hard drive mappings are
1456 returned. Removable disks (eg. DVD-ROMs) are ignored.
1458 For guests that do not use drive mappings, or if the drive mappings
1459 could not be determined, this returns an empty hash table.
1461 Please read L<guestfs(3)/INSPECTION> for more details.
1462 See also C<guestfs_inspect_get_mountpoints>,
1463 C<guestfs_inspect_get_filesystems>.");
1467 (* daemon_functions are any functions which cause some action
1468 * to take place in the daemon.
1471 let daemon_functions = [
1472 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [DeprecatedBy "mount_options"],
1473 [InitEmpty, Always, TestOutput (
1474 [["part_disk"; "/dev/sda"; "mbr"];
1475 ["mkfs"; "ext2"; "/dev/sda1"];
1476 ["mount"; "/dev/sda1"; "/"];
1477 ["write"; "/new"; "new file contents"];
1478 ["cat"; "/new"]], "new file contents")],
1479 "mount a guest disk at a position in the filesystem",
1481 Mount a guest disk at a position in the filesystem. Block devices
1482 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1483 the guest. If those block devices contain partitions, they will have
1484 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1487 The rules are the same as for L<mount(2)>: A filesystem must
1488 first be mounted on C</> before others can be mounted. Other
1489 filesystems can only be mounted on directories which already
1492 The mounted filesystem is writable, if we have sufficient permissions
1493 on the underlying device.
1496 When you use this call, the filesystem options C<sync> and C<noatime>
1497 are set implicitly. This was originally done because we thought it
1498 would improve reliability, but it turns out that I<-o sync> has a
1499 very large negative performance impact and negligible effect on
1500 reliability. Therefore we recommend that you avoid using
1501 C<guestfs_mount> in any code that needs performance, and instead
1502 use C<guestfs_mount_options> (use an empty string for the first
1503 parameter if you don't want any options).");
1505 ("sync", (RErr, [], []), 2, [],
1506 [ InitEmpty, Always, TestRun [["sync"]]],
1507 "sync disks, writes are flushed through to the disk image",
1509 This syncs the disk, so that any writes are flushed through to the
1510 underlying disk image.
1512 You should always call this if you have modified a disk image, before
1513 closing the handle.");
1515 ("touch", (RErr, [Pathname "path"], []), 3, [],
1516 [InitScratchFS, Always, TestOutputTrue (
1517 [["touch"; "/touch"];
1518 ["exists"; "/touch"]])],
1519 "update file timestamps or create a new file",
1521 Touch acts like the L<touch(1)> command. It can be used to
1522 update the timestamps on a file, or, if the file does not exist,
1523 to create a new zero-length file.
1525 This command only works on regular files, and will fail on other
1526 file types such as directories, symbolic links, block special etc.");
1528 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1529 [InitISOFS, Always, TestOutput (
1530 [["cat"; "/known-2"]], "abcdef\n")],
1531 "list the contents of a file",
1533 Return the contents of the file named C<path>.
1535 Note that this function cannot correctly handle binary files
1536 (specifically, files containing C<\\0> character which is treated
1537 as end of string). For those you need to use the C<guestfs_read_file>
1538 or C<guestfs_download> functions which have a more complex interface.");
1540 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1541 [], (* XXX Tricky to test because it depends on the exact format
1542 * of the 'ls -l' command, which changes between F10 and F11.
1544 "list the files in a directory (long format)",
1546 List the files in C<directory> (relative to the root directory,
1547 there is no cwd) in the format of 'ls -la'.
1549 This command is mostly useful for interactive sessions. It
1550 is I<not> intended that you try to parse the output string.");
1552 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1553 [InitScratchFS, Always, TestOutputList (
1555 ["touch"; "/ls/new"];
1556 ["touch"; "/ls/newer"];
1557 ["touch"; "/ls/newest"];
1558 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1559 "list the files in a directory",
1561 List the files in C<directory> (relative to the root directory,
1562 there is no cwd). The '.' and '..' entries are not returned, but
1563 hidden files are shown.
1565 This command is mostly useful for interactive sessions. Programs
1566 should probably use C<guestfs_readdir> instead.");
1568 ("list_devices", (RStringList "devices", [], []), 7, [],
1569 [InitEmpty, Always, TestOutputListOfDevices (
1570 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1571 "list the block devices",
1573 List all the block devices.
1575 The full block device names are returned, eg. C</dev/sda>.
1577 See also C<guestfs_list_filesystems>.");
1579 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1580 [InitBasicFS, Always, TestOutputListOfDevices (
1581 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1582 InitEmpty, Always, TestOutputListOfDevices (
1583 [["part_init"; "/dev/sda"; "mbr"];
1584 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1585 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1586 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1587 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1588 "list the partitions",
1590 List all the partitions detected on all block devices.
1592 The full partition device names are returned, eg. C</dev/sda1>
1594 This does not return logical volumes. For that you will need to
1595 call C<guestfs_lvs>.
1597 See also C<guestfs_list_filesystems>.");
1599 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1600 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1601 [["pvs"]], ["/dev/sda1"]);
1602 InitEmpty, Always, TestOutputListOfDevices (
1603 [["part_init"; "/dev/sda"; "mbr"];
1604 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1605 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1606 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1607 ["pvcreate"; "/dev/sda1"];
1608 ["pvcreate"; "/dev/sda2"];
1609 ["pvcreate"; "/dev/sda3"];
1610 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1611 "list the LVM physical volumes (PVs)",
1613 List all the physical volumes detected. This is the equivalent
1614 of the L<pvs(8)> command.
1616 This returns a list of just the device names that contain
1617 PVs (eg. C</dev/sda2>).
1619 See also C<guestfs_pvs_full>.");
1621 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1622 [InitBasicFSonLVM, Always, TestOutputList (
1624 InitEmpty, Always, TestOutputList (
1625 [["part_init"; "/dev/sda"; "mbr"];
1626 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1627 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1628 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1629 ["pvcreate"; "/dev/sda1"];
1630 ["pvcreate"; "/dev/sda2"];
1631 ["pvcreate"; "/dev/sda3"];
1632 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1633 ["vgcreate"; "VG2"; "/dev/sda3"];
1634 ["vgs"]], ["VG1"; "VG2"])],
1635 "list the LVM volume groups (VGs)",
1637 List all the volumes groups detected. This is the equivalent
1638 of the L<vgs(8)> command.
1640 This returns a list of just the volume group names that were
1641 detected (eg. C<VolGroup00>).
1643 See also C<guestfs_vgs_full>.");
1645 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1646 [InitBasicFSonLVM, Always, TestOutputList (
1647 [["lvs"]], ["/dev/VG/LV"]);
1648 InitEmpty, Always, TestOutputList (
1649 [["part_init"; "/dev/sda"; "mbr"];
1650 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1651 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1652 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1653 ["pvcreate"; "/dev/sda1"];
1654 ["pvcreate"; "/dev/sda2"];
1655 ["pvcreate"; "/dev/sda3"];
1656 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1657 ["vgcreate"; "VG2"; "/dev/sda3"];
1658 ["lvcreate"; "LV1"; "VG1"; "50"];
1659 ["lvcreate"; "LV2"; "VG1"; "50"];
1660 ["lvcreate"; "LV3"; "VG2"; "50"];
1661 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1662 "list the LVM logical volumes (LVs)",
1664 List all the logical volumes detected. This is the equivalent
1665 of the L<lvs(8)> command.
1667 This returns a list of the logical volume device names
1668 (eg. C</dev/VolGroup00/LogVol00>).
1670 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1672 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1673 [], (* XXX how to test? *)
1674 "list the LVM physical volumes (PVs)",
1676 List all the physical volumes detected. This is the equivalent
1677 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1679 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1680 [], (* XXX how to test? *)
1681 "list the LVM volume groups (VGs)",
1683 List all the volumes groups detected. This is the equivalent
1684 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1686 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1687 [], (* XXX how to test? *)
1688 "list the LVM logical volumes (LVs)",
1690 List all the logical volumes detected. This is the equivalent
1691 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1693 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1694 [InitISOFS, Always, TestOutputList (
1695 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1696 InitISOFS, Always, TestOutputList (
1697 [["read_lines"; "/empty"]], [])],
1698 "read file as lines",
1700 Return the contents of the file named C<path>.
1702 The file contents are returned as a list of lines. Trailing
1703 C<LF> and C<CRLF> character sequences are I<not> returned.
1705 Note that this function cannot correctly handle binary files
1706 (specifically, files containing C<\\0> character which is treated
1707 as end of line). For those you need to use the C<guestfs_read_file>
1708 function which has a more complex interface.");
1710 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1711 [], (* XXX Augeas code needs tests. *)
1712 "create a new Augeas handle",
1714 Create a new Augeas handle for editing configuration files.
1715 If there was any previous Augeas handle associated with this
1716 guestfs session, then it is closed.
1718 You must call this before using any other C<guestfs_aug_*>
1721 C<root> is the filesystem root. C<root> must not be NULL,
1724 The flags are the same as the flags defined in
1725 E<lt>augeas.hE<gt>, the logical I<or> of the following
1730 =item C<AUG_SAVE_BACKUP> = 1
1732 Keep the original file with a C<.augsave> extension.
1734 =item C<AUG_SAVE_NEWFILE> = 2
1736 Save changes into a file with extension C<.augnew>, and
1737 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1739 =item C<AUG_TYPE_CHECK> = 4
1741 Typecheck lenses (can be expensive).
1743 =item C<AUG_NO_STDINC> = 8
1745 Do not use standard load path for modules.
1747 =item C<AUG_SAVE_NOOP> = 16
1749 Make save a no-op, just record what would have been changed.
1751 =item C<AUG_NO_LOAD> = 32
1753 Do not load the tree in C<guestfs_aug_init>.
1757 To close the handle, you can call C<guestfs_aug_close>.
1759 To find out more about Augeas, see L<http://augeas.net/>.");
1761 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1762 [], (* XXX Augeas code needs tests. *)
1763 "close the current Augeas handle",
1765 Close the current Augeas handle and free up any resources
1766 used by it. After calling this, you have to call
1767 C<guestfs_aug_init> again before you can use any other
1768 Augeas functions.");
1770 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1771 [], (* XXX Augeas code needs tests. *)
1772 "define an Augeas variable",
1774 Defines an Augeas variable C<name> whose value is the result
1775 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1778 On success this returns the number of nodes in C<expr>, or
1779 C<0> if C<expr> evaluates to something which is not a nodeset.");
1781 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1782 [], (* XXX Augeas code needs tests. *)
1783 "define an Augeas node",
1785 Defines a variable C<name> whose value is the result of
1788 If C<expr> evaluates to an empty nodeset, a node is created,
1789 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1790 C<name> will be the nodeset containing that single node.
1792 On success this returns a pair containing the
1793 number of nodes in the nodeset, and a boolean flag
1794 if a node was created.");
1796 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1797 [], (* XXX Augeas code needs tests. *)
1798 "look up the value of an Augeas path",
1800 Look up the value associated with C<path>. If C<path>
1801 matches exactly one node, the C<value> is returned.");
1803 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1804 [], (* XXX Augeas code needs tests. *)
1805 "set Augeas path to value",
1807 Set the value associated with C<path> to C<val>.
1809 In the Augeas API, it is possible to clear a node by setting
1810 the value to NULL. Due to an oversight in the libguestfs API
1811 you cannot do that with this call. Instead you must use the
1812 C<guestfs_aug_clear> call.");
1814 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1815 [], (* XXX Augeas code needs tests. *)
1816 "insert a sibling Augeas node",
1818 Create a new sibling C<label> for C<path>, inserting it into
1819 the tree before or after C<path> (depending on the boolean
1822 C<path> must match exactly one existing node in the tree, and
1823 C<label> must be a label, ie. not contain C</>, C<*> or end
1824 with a bracketed index C<[N]>.");
1826 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1827 [], (* XXX Augeas code needs tests. *)
1828 "remove an Augeas path",
1830 Remove C<path> and all of its children.
1832 On success this returns the number of entries which were removed.");
1834 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1835 [], (* XXX Augeas code needs tests. *)
1838 Move the node C<src> to C<dest>. C<src> must match exactly
1839 one node. C<dest> is overwritten if it exists.");
1841 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1842 [], (* XXX Augeas code needs tests. *)
1843 "return Augeas nodes which match augpath",
1845 Returns a list of paths which match the path expression C<path>.
1846 The returned paths are sufficiently qualified so that they match
1847 exactly one node in the current tree.");
1849 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1850 [], (* XXX Augeas code needs tests. *)
1851 "write all pending Augeas changes to disk",
1853 This writes all pending changes to disk.
1855 The flags which were passed to C<guestfs_aug_init> affect exactly
1856 how files are saved.");
1858 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1859 [], (* XXX Augeas code needs tests. *)
1860 "load files into the tree",
1862 Load files into the tree.
1864 See C<aug_load> in the Augeas documentation for the full gory
1867 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1868 [], (* XXX Augeas code needs tests. *)
1869 "list Augeas nodes under augpath",
1871 This is just a shortcut for listing C<guestfs_aug_match>
1872 C<path/*> and sorting the resulting nodes into alphabetical order.");
1874 ("rm", (RErr, [Pathname "path"], []), 29, [],
1875 [InitScratchFS, Always, TestRun
1877 ["touch"; "/rm/new"];
1879 InitScratchFS, Always, TestLastFail
1880 [["rm"; "/nosuchfile"]];
1881 InitScratchFS, Always, TestLastFail
1886 Remove the single file C<path>.");
1888 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1889 [InitScratchFS, Always, TestRun
1890 [["mkdir"; "/rmdir"];
1891 ["rmdir"; "/rmdir"]];
1892 InitScratchFS, Always, TestLastFail
1893 [["rmdir"; "/rmdir2"]];
1894 InitScratchFS, Always, TestLastFail
1895 [["mkdir"; "/rmdir3"];
1896 ["touch"; "/rmdir3/new"];
1897 ["rmdir"; "/rmdir3/new"]]],
1898 "remove a directory",
1900 Remove the single directory C<path>.");
1902 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1903 [InitScratchFS, Always, TestOutputFalse
1904 [["mkdir"; "/rm_rf"];
1905 ["mkdir"; "/rm_rf/foo"];
1906 ["touch"; "/rm_rf/foo/bar"];
1907 ["rm_rf"; "/rm_rf"];
1908 ["exists"; "/rm_rf"]]],
1909 "remove a file or directory recursively",
1911 Remove the file or directory C<path>, recursively removing the
1912 contents if its a directory. This is like the C<rm -rf> shell
1915 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1916 [InitScratchFS, Always, TestOutputTrue
1917 [["mkdir"; "/mkdir"];
1918 ["is_dir"; "/mkdir"]];
1919 InitScratchFS, Always, TestLastFail
1920 [["mkdir"; "/mkdir2/foo/bar"]]],
1921 "create a directory",
1923 Create a directory named C<path>.");
1925 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1926 [InitScratchFS, Always, TestOutputTrue
1927 [["mkdir_p"; "/mkdir_p/foo/bar"];
1928 ["is_dir"; "/mkdir_p/foo/bar"]];
1929 InitScratchFS, Always, TestOutputTrue
1930 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1931 ["is_dir"; "/mkdir_p2/foo"]];
1932 InitScratchFS, Always, TestOutputTrue
1933 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1934 ["is_dir"; "/mkdir_p3"]];
1935 (* Regression tests for RHBZ#503133: *)
1936 InitScratchFS, Always, TestRun
1937 [["mkdir"; "/mkdir_p4"];
1938 ["mkdir_p"; "/mkdir_p4"]];
1939 InitScratchFS, Always, TestLastFail
1940 [["touch"; "/mkdir_p5"];
1941 ["mkdir_p"; "/mkdir_p5"]]],
1942 "create a directory and parents",
1944 Create a directory named C<path>, creating any parent directories
1945 as necessary. This is like the C<mkdir -p> shell command.");
1947 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
1948 [], (* XXX Need stat command to test *)
1951 Change the mode (permissions) of C<path> to C<mode>. Only
1952 numeric modes are supported.
1954 I<Note>: When using this command from guestfish, C<mode>
1955 by default would be decimal, unless you prefix it with
1956 C<0> to get octal, ie. use C<0700> not C<700>.
1958 The mode actually set is affected by the umask.");
1960 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
1961 [], (* XXX Need stat command to test *)
1962 "change file owner and group",
1964 Change the file owner to C<owner> and group to C<group>.
1966 Only numeric uid and gid are supported. If you want to use
1967 names, you will need to locate and parse the password file
1968 yourself (Augeas support makes this relatively easy).");
1970 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
1971 [InitISOFS, Always, TestOutputTrue (
1972 [["exists"; "/empty"]]);
1973 InitISOFS, Always, TestOutputTrue (
1974 [["exists"; "/directory"]])],
1975 "test if file or directory exists",
1977 This returns C<true> if and only if there is a file, directory
1978 (or anything) with the given C<path> name.
1980 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1982 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
1983 [InitISOFS, Always, TestOutputTrue (
1984 [["is_file"; "/known-1"]]);
1985 InitISOFS, Always, TestOutputFalse (
1986 [["is_file"; "/directory"]])],
1987 "test if a regular file",
1989 This returns C<true> if and only if there is a regular file
1990 with the given C<path> name. Note that it returns false for
1991 other objects like directories.
1993 See also C<guestfs_stat>.");
1995 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
1996 [InitISOFS, Always, TestOutputFalse (
1997 [["is_dir"; "/known-3"]]);
1998 InitISOFS, Always, TestOutputTrue (
1999 [["is_dir"; "/directory"]])],
2000 "test if a directory",
2002 This returns C<true> if and only if there is a directory
2003 with the given C<path> name. Note that it returns false for
2004 other objects like files.
2006 See also C<guestfs_stat>.");
2008 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2009 [InitEmpty, Always, TestOutputListOfDevices (
2010 [["part_init"; "/dev/sda"; "mbr"];
2011 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2012 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2013 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2014 ["pvcreate"; "/dev/sda1"];
2015 ["pvcreate"; "/dev/sda2"];
2016 ["pvcreate"; "/dev/sda3"];
2017 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2018 "create an LVM physical volume",
2020 This creates an LVM physical volume on the named C<device>,
2021 where C<device> should usually be a partition name such
2024 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2025 [InitEmpty, Always, TestOutputList (
2026 [["part_init"; "/dev/sda"; "mbr"];
2027 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2028 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2029 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2030 ["pvcreate"; "/dev/sda1"];
2031 ["pvcreate"; "/dev/sda2"];
2032 ["pvcreate"; "/dev/sda3"];
2033 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2034 ["vgcreate"; "VG2"; "/dev/sda3"];
2035 ["vgs"]], ["VG1"; "VG2"])],
2036 "create an LVM volume group",
2038 This creates an LVM volume group called C<volgroup>
2039 from the non-empty list of physical volumes C<physvols>.");
2041 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2042 [InitEmpty, Always, TestOutputList (
2043 [["part_init"; "/dev/sda"; "mbr"];
2044 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2045 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2046 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2047 ["pvcreate"; "/dev/sda1"];
2048 ["pvcreate"; "/dev/sda2"];
2049 ["pvcreate"; "/dev/sda3"];
2050 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2051 ["vgcreate"; "VG2"; "/dev/sda3"];
2052 ["lvcreate"; "LV1"; "VG1"; "50"];
2053 ["lvcreate"; "LV2"; "VG1"; "50"];
2054 ["lvcreate"; "LV3"; "VG2"; "50"];
2055 ["lvcreate"; "LV4"; "VG2"; "50"];
2056 ["lvcreate"; "LV5"; "VG2"; "50"];
2058 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2059 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2060 "create an LVM logical volume",
2062 This creates an LVM logical volume called C<logvol>
2063 on the volume group C<volgroup>, with C<size> megabytes.");
2065 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2066 [InitEmpty, Always, TestOutput (
2067 [["part_disk"; "/dev/sda"; "mbr"];
2068 ["mkfs"; "ext2"; "/dev/sda1"];
2069 ["mount_options"; ""; "/dev/sda1"; "/"];
2070 ["write"; "/new"; "new file contents"];
2071 ["cat"; "/new"]], "new file contents")],
2072 "make a filesystem",
2074 This creates a filesystem on C<device> (usually a partition
2075 or LVM logical volume). The filesystem type is C<fstype>, for
2078 ("sfdisk", (RErr, [Device "device";
2079 Int "cyls"; Int "heads"; Int "sectors";
2080 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2082 "create partitions on a block device",
2084 This is a direct interface to the L<sfdisk(8)> program for creating
2085 partitions on block devices.
2087 C<device> should be a block device, for example C</dev/sda>.
2089 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2090 and sectors on the device, which are passed directly to sfdisk as
2091 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2092 of these, then the corresponding parameter is omitted. Usually for
2093 'large' disks, you can just pass C<0> for these, but for small
2094 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2095 out the right geometry and you will need to tell it.
2097 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2098 information refer to the L<sfdisk(8)> manpage.
2100 To create a single partition occupying the whole disk, you would
2101 pass C<lines> as a single element list, when the single element being
2102 the string C<,> (comma).
2104 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2105 C<guestfs_part_init>");
2107 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2108 (* Regression test for RHBZ#597135. *)
2109 [InitScratchFS, Always, TestLastFail
2110 [["write_file"; "/write_file"; "abc"; "10000"]]],
2113 This call creates a file called C<path>. The contents of the
2114 file is the string C<content> (which can contain any 8 bit data),
2115 with length C<size>.
2117 As a special case, if C<size> is C<0>
2118 then the length is calculated using C<strlen> (so in this case
2119 the content cannot contain embedded ASCII NULs).
2121 I<NB.> Owing to a bug, writing content containing ASCII NUL
2122 characters does I<not> work, even if the length is specified.");
2124 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2125 [InitEmpty, Always, TestOutputListOfDevices (
2126 [["part_disk"; "/dev/sda"; "mbr"];
2127 ["mkfs"; "ext2"; "/dev/sda1"];
2128 ["mount_options"; ""; "/dev/sda1"; "/"];
2129 ["mounts"]], ["/dev/sda1"]);
2130 InitEmpty, Always, TestOutputList (
2131 [["part_disk"; "/dev/sda"; "mbr"];
2132 ["mkfs"; "ext2"; "/dev/sda1"];
2133 ["mount_options"; ""; "/dev/sda1"; "/"];
2136 "unmount a filesystem",
2138 This unmounts the given filesystem. The filesystem may be
2139 specified either by its mountpoint (path) or the device which
2140 contains the filesystem.");
2142 ("mounts", (RStringList "devices", [], []), 46, [],
2143 [InitScratchFS, Always, TestOutputListOfDevices (
2144 [["mounts"]], ["/dev/sdb1"])],
2145 "show mounted filesystems",
2147 This returns the list of currently mounted filesystems. It returns
2148 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2150 Some internal mounts are not shown.
2152 See also: C<guestfs_mountpoints>");
2154 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2155 [InitScratchFS, Always, TestOutputList (
2158 (* check that umount_all can unmount nested mounts correctly: *)
2159 InitEmpty, Always, TestOutputList (
2160 [["part_init"; "/dev/sda"; "mbr"];
2161 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2162 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2163 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2164 ["mkfs"; "ext2"; "/dev/sda1"];
2165 ["mkfs"; "ext2"; "/dev/sda2"];
2166 ["mkfs"; "ext2"; "/dev/sda3"];
2167 ["mount_options"; ""; "/dev/sda1"; "/"];
2169 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2170 ["mkdir"; "/mp1/mp2"];
2171 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2172 ["mkdir"; "/mp1/mp2/mp3"];
2175 "unmount all filesystems",
2177 This unmounts all mounted filesystems.
2179 Some internal mounts are not unmounted by this call.");
2181 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2183 "remove all LVM LVs, VGs and PVs",
2185 This command removes all LVM logical volumes, volume groups
2186 and physical volumes.");
2188 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2189 [InitISOFS, Always, TestOutput (
2190 [["file"; "/empty"]], "empty");
2191 InitISOFS, Always, TestOutput (
2192 [["file"; "/known-1"]], "ASCII text");
2193 InitISOFS, Always, TestLastFail (
2194 [["file"; "/notexists"]]);
2195 InitISOFS, Always, TestOutput (
2196 [["file"; "/abssymlink"]], "symbolic link");
2197 InitISOFS, Always, TestOutput (
2198 [["file"; "/directory"]], "directory")],
2199 "determine file type",
2201 This call uses the standard L<file(1)> command to determine
2202 the type or contents of the file.
2204 This call will also transparently look inside various types
2207 The exact command which runs is C<file -zb path>. Note in
2208 particular that the filename is not prepended to the output
2211 The output depends on the output of the underlying L<file(1)>
2212 command and it can change in future in ways beyond our control.
2213 In other words, the output is not guaranteed by the ABI.
2215 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2216 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2218 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2219 [InitScratchFS, Always, TestOutput (
2220 [["mkdir"; "/command"];
2221 ["upload"; "test-command"; "/command/test-command"];
2222 ["chmod"; "0o755"; "/command/test-command"];
2223 ["command"; "/command/test-command 1"]], "Result1");
2224 InitScratchFS, Always, TestOutput (
2225 [["mkdir"; "/command2"];
2226 ["upload"; "test-command"; "/command2/test-command"];
2227 ["chmod"; "0o755"; "/command2/test-command"];
2228 ["command"; "/command2/test-command 2"]], "Result2\n");
2229 InitScratchFS, Always, TestOutput (
2230 [["mkdir"; "/command3"];
2231 ["upload"; "test-command"; "/command3/test-command"];
2232 ["chmod"; "0o755"; "/command3/test-command"];
2233 ["command"; "/command3/test-command 3"]], "\nResult3");
2234 InitScratchFS, Always, TestOutput (
2235 [["mkdir"; "/command4"];
2236 ["upload"; "test-command"; "/command4/test-command"];
2237 ["chmod"; "0o755"; "/command4/test-command"];
2238 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2239 InitScratchFS, Always, TestOutput (
2240 [["mkdir"; "/command5"];
2241 ["upload"; "test-command"; "/command5/test-command"];
2242 ["chmod"; "0o755"; "/command5/test-command"];
2243 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2244 InitScratchFS, Always, TestOutput (
2245 [["mkdir"; "/command6"];
2246 ["upload"; "test-command"; "/command6/test-command"];
2247 ["chmod"; "0o755"; "/command6/test-command"];
2248 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2249 InitScratchFS, Always, TestOutput (
2250 [["mkdir"; "/command7"];
2251 ["upload"; "test-command"; "/command7/test-command"];
2252 ["chmod"; "0o755"; "/command7/test-command"];
2253 ["command"; "/command7/test-command 7"]], "");
2254 InitScratchFS, Always, TestOutput (
2255 [["mkdir"; "/command8"];
2256 ["upload"; "test-command"; "/command8/test-command"];
2257 ["chmod"; "0o755"; "/command8/test-command"];
2258 ["command"; "/command8/test-command 8"]], "\n");
2259 InitScratchFS, Always, TestOutput (
2260 [["mkdir"; "/command9"];
2261 ["upload"; "test-command"; "/command9/test-command"];
2262 ["chmod"; "0o755"; "/command9/test-command"];
2263 ["command"; "/command9/test-command 9"]], "\n\n");
2264 InitScratchFS, Always, TestOutput (
2265 [["mkdir"; "/command10"];
2266 ["upload"; "test-command"; "/command10/test-command"];
2267 ["chmod"; "0o755"; "/command10/test-command"];
2268 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2269 InitScratchFS, Always, TestOutput (
2270 [["mkdir"; "/command11"];
2271 ["upload"; "test-command"; "/command11/test-command"];
2272 ["chmod"; "0o755"; "/command11/test-command"];
2273 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2274 InitScratchFS, Always, TestLastFail (
2275 [["mkdir"; "/command12"];
2276 ["upload"; "test-command"; "/command12/test-command"];
2277 ["chmod"; "0o755"; "/command12/test-command"];
2278 ["command"; "/command12/test-command"]])],
2279 "run a command from the guest filesystem",
2281 This call runs a command from the guest filesystem. The
2282 filesystem must be mounted, and must contain a compatible
2283 operating system (ie. something Linux, with the same
2284 or compatible processor architecture).
2286 The single parameter is an argv-style list of arguments.
2287 The first element is the name of the program to run.
2288 Subsequent elements are parameters. The list must be
2289 non-empty (ie. must contain a program name). Note that
2290 the command runs directly, and is I<not> invoked via
2291 the shell (see C<guestfs_sh>).
2293 The return value is anything printed to I<stdout> by
2296 If the command returns a non-zero exit status, then
2297 this function returns an error message. The error message
2298 string is the content of I<stderr> from the command.
2300 The C<$PATH> environment variable will contain at least
2301 C</usr/bin> and C</bin>. If you require a program from
2302 another location, you should provide the full path in the
2305 Shared libraries and data files required by the program
2306 must be available on filesystems which are mounted in the
2307 correct places. It is the caller's responsibility to ensure
2308 all filesystems that are needed are mounted at the right
2311 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2312 [InitScratchFS, Always, TestOutputList (
2313 [["mkdir"; "/command_lines"];
2314 ["upload"; "test-command"; "/command_lines/test-command"];
2315 ["chmod"; "0o755"; "/command_lines/test-command"];
2316 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2317 InitScratchFS, Always, TestOutputList (
2318 [["mkdir"; "/command_lines2"];
2319 ["upload"; "test-command"; "/command_lines2/test-command"];
2320 ["chmod"; "0o755"; "/command_lines2/test-command"];
2321 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2322 InitScratchFS, Always, TestOutputList (
2323 [["mkdir"; "/command_lines3"];
2324 ["upload"; "test-command"; "/command_lines3/test-command"];
2325 ["chmod"; "0o755"; "/command_lines3/test-command"];
2326 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2327 InitScratchFS, Always, TestOutputList (
2328 [["mkdir"; "/command_lines4"];
2329 ["upload"; "test-command"; "/command_lines4/test-command"];
2330 ["chmod"; "0o755"; "/command_lines4/test-command"];
2331 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2332 InitScratchFS, Always, TestOutputList (
2333 [["mkdir"; "/command_lines5"];
2334 ["upload"; "test-command"; "/command_lines5/test-command"];
2335 ["chmod"; "0o755"; "/command_lines5/test-command"];
2336 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2337 InitScratchFS, Always, TestOutputList (
2338 [["mkdir"; "/command_lines6"];
2339 ["upload"; "test-command"; "/command_lines6/test-command"];
2340 ["chmod"; "0o755"; "/command_lines6/test-command"];
2341 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2342 InitScratchFS, Always, TestOutputList (
2343 [["mkdir"; "/command_lines7"];
2344 ["upload"; "test-command"; "/command_lines7/test-command"];
2345 ["chmod"; "0o755"; "/command_lines7/test-command"];
2346 ["command_lines"; "/command_lines7/test-command 7"]], []);
2347 InitScratchFS, Always, TestOutputList (
2348 [["mkdir"; "/command_lines8"];
2349 ["upload"; "test-command"; "/command_lines8/test-command"];
2350 ["chmod"; "0o755"; "/command_lines8/test-command"];
2351 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2352 InitScratchFS, Always, TestOutputList (
2353 [["mkdir"; "/command_lines9"];
2354 ["upload"; "test-command"; "/command_lines9/test-command"];
2355 ["chmod"; "0o755"; "/command_lines9/test-command"];
2356 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2357 InitScratchFS, Always, TestOutputList (
2358 [["mkdir"; "/command_lines10"];
2359 ["upload"; "test-command"; "/command_lines10/test-command"];
2360 ["chmod"; "0o755"; "/command_lines10/test-command"];
2361 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2362 InitScratchFS, Always, TestOutputList (
2363 [["mkdir"; "/command_lines11"];
2364 ["upload"; "test-command"; "/command_lines11/test-command"];
2365 ["chmod"; "0o755"; "/command_lines11/test-command"];
2366 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2367 "run a command, returning lines",
2369 This is the same as C<guestfs_command>, but splits the
2370 result into a list of lines.
2372 See also: C<guestfs_sh_lines>");
2374 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2375 [InitISOFS, Always, TestOutputStruct (
2376 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2377 "get file information",
2379 Returns file information for the given C<path>.
2381 This is the same as the C<stat(2)> system call.");
2383 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2384 [InitISOFS, Always, TestOutputStruct (
2385 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2386 "get file information for a symbolic link",
2388 Returns file information for the given C<path>.
2390 This is the same as C<guestfs_stat> except that if C<path>
2391 is a symbolic link, then the link is stat-ed, not the file it
2394 This is the same as the C<lstat(2)> system call.");
2396 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2397 [InitISOFS, Always, TestOutputStruct (
2398 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2399 "get file system statistics",
2401 Returns file system statistics for any mounted file system.
2402 C<path> should be a file or directory in the mounted file system
2403 (typically it is the mount point itself, but it doesn't need to be).
2405 This is the same as the C<statvfs(2)> system call.");
2407 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2409 "get ext2/ext3/ext4 superblock details",
2411 This returns the contents of the ext2, ext3 or ext4 filesystem
2412 superblock on C<device>.
2414 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2415 manpage for more details. The list of fields returned isn't
2416 clearly defined, and depends on both the version of C<tune2fs>
2417 that libguestfs was built against, and the filesystem itself.");
2419 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2420 [InitEmpty, Always, TestOutputTrue (
2421 [["blockdev_setro"; "/dev/sda"];
2422 ["blockdev_getro"; "/dev/sda"]])],
2423 "set block device to read-only",
2425 Sets the block device named C<device> to read-only.
2427 This uses the L<blockdev(8)> command.");
2429 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2430 [InitEmpty, Always, TestOutputFalse (
2431 [["blockdev_setrw"; "/dev/sda"];
2432 ["blockdev_getro"; "/dev/sda"]])],
2433 "set block device to read-write",
2435 Sets the block device named C<device> to read-write.
2437 This uses the L<blockdev(8)> command.");
2439 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2440 [InitEmpty, Always, TestOutputTrue (
2441 [["blockdev_setro"; "/dev/sda"];
2442 ["blockdev_getro"; "/dev/sda"]])],
2443 "is block device set to read-only",
2445 Returns a boolean indicating if the block device is read-only
2446 (true if read-only, false if not).
2448 This uses the L<blockdev(8)> command.");
2450 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2451 [InitEmpty, Always, TestOutputInt (
2452 [["blockdev_getss"; "/dev/sda"]], 512)],
2453 "get sectorsize of block device",
2455 This returns the size of sectors on a block device.
2456 Usually 512, but can be larger for modern devices.
2458 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2461 This uses the L<blockdev(8)> command.");
2463 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2464 [InitEmpty, Always, TestOutputInt (
2465 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2466 "get blocksize of block device",
2468 This returns the block size of a device.
2470 (Note this is different from both I<size in blocks> and
2471 I<filesystem block size>).
2473 This uses the L<blockdev(8)> command.");
2475 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2477 "set blocksize of block device",
2479 This sets the block size of a device.
2481 (Note this is different from both I<size in blocks> and
2482 I<filesystem block size>).
2484 This uses the L<blockdev(8)> command.");
2486 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2487 [InitEmpty, Always, TestOutputInt (
2488 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2489 "get total size of device in 512-byte sectors",
2491 This returns the size of the device in units of 512-byte sectors
2492 (even if the sectorsize isn't 512 bytes ... weird).
2494 See also C<guestfs_blockdev_getss> for the real sector size of
2495 the device, and C<guestfs_blockdev_getsize64> for the more
2496 useful I<size in bytes>.
2498 This uses the L<blockdev(8)> command.");
2500 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2501 [InitEmpty, Always, TestOutputInt (
2502 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2503 "get total size of device in bytes",
2505 This returns the size of the device in bytes.
2507 See also C<guestfs_blockdev_getsz>.
2509 This uses the L<blockdev(8)> command.");
2511 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2512 [InitEmpty, Always, TestRun
2513 [["blockdev_flushbufs"; "/dev/sda"]]],
2514 "flush device buffers",
2516 This tells the kernel to flush internal buffers associated
2519 This uses the L<blockdev(8)> command.");
2521 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2522 [InitEmpty, Always, TestRun
2523 [["blockdev_rereadpt"; "/dev/sda"]]],
2524 "reread partition table",
2526 Reread the partition table on C<device>.
2528 This uses the L<blockdev(8)> command.");
2530 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2531 [InitScratchFS, Always, TestOutput (
2532 (* Pick a file from cwd which isn't likely to change. *)
2533 [["mkdir"; "/upload"];
2534 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2535 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2536 Digest.to_hex (Digest.file "COPYING.LIB"))],
2537 "upload a file from the local machine",
2539 Upload local file C<filename> to C<remotefilename> on the
2542 C<filename> can also be a named pipe.
2544 See also C<guestfs_download>.");
2546 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2547 [InitScratchFS, Always, TestOutput (
2548 (* Pick a file from cwd which isn't likely to change. *)
2549 [["mkdir"; "/download"];
2550 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2551 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2552 ["upload"; "testdownload.tmp"; "/download/upload"];
2553 ["checksum"; "md5"; "/download/upload"]],
2554 Digest.to_hex (Digest.file "COPYING.LIB"))],
2555 "download a file to the local machine",
2557 Download file C<remotefilename> and save it as C<filename>
2558 on the local machine.
2560 C<filename> can also be a named pipe.
2562 See also C<guestfs_upload>, C<guestfs_cat>.");
2564 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2565 [InitISOFS, Always, TestOutput (
2566 [["checksum"; "crc"; "/known-3"]], "2891671662");
2567 InitISOFS, Always, TestLastFail (
2568 [["checksum"; "crc"; "/notexists"]]);
2569 InitISOFS, Always, TestOutput (
2570 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2571 InitISOFS, Always, TestOutput (
2572 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2573 InitISOFS, Always, TestOutput (
2574 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2575 InitISOFS, Always, TestOutput (
2576 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2577 InitISOFS, Always, TestOutput (
2578 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2579 InitISOFS, Always, TestOutput (
2580 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2581 (* Test for RHBZ#579608, absolute symbolic links. *)
2582 InitISOFS, Always, TestOutput (
2583 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2584 "compute MD5, SHAx or CRC checksum of file",
2586 This call computes the MD5, SHAx or CRC checksum of the
2589 The type of checksum to compute is given by the C<csumtype>
2590 parameter which must have one of the following values:
2596 Compute the cyclic redundancy check (CRC) specified by POSIX
2597 for the C<cksum> command.
2601 Compute the MD5 hash (using the C<md5sum> program).
2605 Compute the SHA1 hash (using the C<sha1sum> program).
2609 Compute the SHA224 hash (using the C<sha224sum> program).
2613 Compute the SHA256 hash (using the C<sha256sum> program).
2617 Compute the SHA384 hash (using the C<sha384sum> program).
2621 Compute the SHA512 hash (using the C<sha512sum> program).
2625 The checksum is returned as a printable string.
2627 To get the checksum for a device, use C<guestfs_checksum_device>.
2629 To get the checksums for many files, use C<guestfs_checksums_out>.");
2631 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2632 [InitScratchFS, Always, TestOutput (
2633 [["mkdir"; "/tar_in"];
2634 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2635 ["cat"; "/tar_in/hello"]], "hello\n")],
2636 "unpack tarfile to directory",
2638 This command uploads and unpacks local file C<tarfile> (an
2639 I<uncompressed> tar file) into C<directory>.
2641 To upload a compressed tarball, use C<guestfs_tgz_in>
2642 or C<guestfs_txz_in>.");
2644 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2646 "pack directory into tarfile",
2648 This command packs the contents of C<directory> and downloads
2649 it to local file C<tarfile>.
2651 To download a compressed tarball, use C<guestfs_tgz_out>
2652 or C<guestfs_txz_out>.");
2654 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2655 [InitScratchFS, Always, TestOutput (
2656 [["mkdir"; "/tgz_in"];
2657 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2658 ["cat"; "/tgz_in/hello"]], "hello\n")],
2659 "unpack compressed tarball to directory",
2661 This command uploads and unpacks local file C<tarball> (a
2662 I<gzip compressed> tar file) into C<directory>.
2664 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2666 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2668 "pack directory into compressed tarball",
2670 This command packs the contents of C<directory> and downloads
2671 it to local file C<tarball>.
2673 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2675 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2676 [InitBasicFS, Always, TestLastFail (
2678 ["mount_ro"; "/dev/sda1"; "/"];
2679 ["touch"; "/new"]]);
2680 InitBasicFS, Always, TestOutput (
2681 [["write"; "/new"; "data"];
2683 ["mount_ro"; "/dev/sda1"; "/"];
2684 ["cat"; "/new"]], "data")],
2685 "mount a guest disk, read-only",
2687 This is the same as the C<guestfs_mount> command, but it
2688 mounts the filesystem with the read-only (I<-o ro>) flag.");
2690 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2692 "mount a guest disk with mount options",
2694 This is the same as the C<guestfs_mount> command, but it
2695 allows you to set the mount options as for the
2696 L<mount(8)> I<-o> flag.
2698 If the C<options> parameter is an empty string, then
2699 no options are passed (all options default to whatever
2700 the filesystem uses).");
2702 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2704 "mount a guest disk with mount options and vfstype",
2706 This is the same as the C<guestfs_mount> command, but it
2707 allows you to set both the mount options and the vfstype
2708 as for the L<mount(8)> I<-o> and I<-t> flags.");
2710 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2712 "debugging and internals",
2714 The C<guestfs_debug> command exposes some internals of
2715 C<guestfsd> (the guestfs daemon) that runs inside the
2718 There is no comprehensive help for this command. You have
2719 to look at the file C<daemon/debug.c> in the libguestfs source
2720 to find out what you can do.");
2722 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2723 [InitEmpty, Always, TestOutputList (
2724 [["part_disk"; "/dev/sda"; "mbr"];
2725 ["pvcreate"; "/dev/sda1"];
2726 ["vgcreate"; "VG"; "/dev/sda1"];
2727 ["lvcreate"; "LV1"; "VG"; "50"];
2728 ["lvcreate"; "LV2"; "VG"; "50"];
2729 ["lvremove"; "/dev/VG/LV1"];
2730 ["lvs"]], ["/dev/VG/LV2"]);
2731 InitEmpty, Always, TestOutputList (
2732 [["part_disk"; "/dev/sda"; "mbr"];
2733 ["pvcreate"; "/dev/sda1"];
2734 ["vgcreate"; "VG"; "/dev/sda1"];
2735 ["lvcreate"; "LV1"; "VG"; "50"];
2736 ["lvcreate"; "LV2"; "VG"; "50"];
2737 ["lvremove"; "/dev/VG"];
2739 InitEmpty, Always, TestOutputList (
2740 [["part_disk"; "/dev/sda"; "mbr"];
2741 ["pvcreate"; "/dev/sda1"];
2742 ["vgcreate"; "VG"; "/dev/sda1"];
2743 ["lvcreate"; "LV1"; "VG"; "50"];
2744 ["lvcreate"; "LV2"; "VG"; "50"];
2745 ["lvremove"; "/dev/VG"];
2747 "remove an LVM logical volume",
2749 Remove an LVM logical volume C<device>, where C<device> is
2750 the path to the LV, such as C</dev/VG/LV>.
2752 You can also remove all LVs in a volume group by specifying
2753 the VG name, C</dev/VG>.");
2755 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2756 [InitEmpty, Always, TestOutputList (
2757 [["part_disk"; "/dev/sda"; "mbr"];
2758 ["pvcreate"; "/dev/sda1"];
2759 ["vgcreate"; "VG"; "/dev/sda1"];
2760 ["lvcreate"; "LV1"; "VG"; "50"];
2761 ["lvcreate"; "LV2"; "VG"; "50"];
2764 InitEmpty, Always, TestOutputList (
2765 [["part_disk"; "/dev/sda"; "mbr"];
2766 ["pvcreate"; "/dev/sda1"];
2767 ["vgcreate"; "VG"; "/dev/sda1"];
2768 ["lvcreate"; "LV1"; "VG"; "50"];
2769 ["lvcreate"; "LV2"; "VG"; "50"];
2772 "remove an LVM volume group",
2774 Remove an LVM volume group C<vgname>, (for example C<VG>).
2776 This also forcibly removes all logical volumes in the volume
2779 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2780 [InitEmpty, Always, TestOutputListOfDevices (
2781 [["part_disk"; "/dev/sda"; "mbr"];
2782 ["pvcreate"; "/dev/sda1"];
2783 ["vgcreate"; "VG"; "/dev/sda1"];
2784 ["lvcreate"; "LV1"; "VG"; "50"];
2785 ["lvcreate"; "LV2"; "VG"; "50"];
2787 ["pvremove"; "/dev/sda1"];
2789 InitEmpty, Always, TestOutputListOfDevices (
2790 [["part_disk"; "/dev/sda"; "mbr"];
2791 ["pvcreate"; "/dev/sda1"];
2792 ["vgcreate"; "VG"; "/dev/sda1"];
2793 ["lvcreate"; "LV1"; "VG"; "50"];
2794 ["lvcreate"; "LV2"; "VG"; "50"];
2796 ["pvremove"; "/dev/sda1"];
2798 InitEmpty, Always, TestOutputListOfDevices (
2799 [["part_disk"; "/dev/sda"; "mbr"];
2800 ["pvcreate"; "/dev/sda1"];
2801 ["vgcreate"; "VG"; "/dev/sda1"];
2802 ["lvcreate"; "LV1"; "VG"; "50"];
2803 ["lvcreate"; "LV2"; "VG"; "50"];
2805 ["pvremove"; "/dev/sda1"];
2807 "remove an LVM physical volume",
2809 This wipes a physical volume C<device> so that LVM will no longer
2812 The implementation uses the C<pvremove> command which refuses to
2813 wipe physical volumes that contain any volume groups, so you have
2814 to remove those first.");
2816 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2817 [InitBasicFS, Always, TestOutput (
2818 [["set_e2label"; "/dev/sda1"; "testlabel"];
2819 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2820 "set the ext2/3/4 filesystem label",
2822 This sets the ext2/3/4 filesystem label of the filesystem on
2823 C<device> to C<label>. Filesystem labels are limited to
2826 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2827 to return the existing label on a filesystem.");
2829 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2831 "get the ext2/3/4 filesystem label",
2833 This returns the ext2/3/4 filesystem label of the filesystem on
2836 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2837 (let uuid = uuidgen () in
2838 [InitBasicFS, Always, TestOutput (
2839 [["set_e2uuid"; "/dev/sda1"; uuid];
2840 ["get_e2uuid"; "/dev/sda1"]], uuid);
2841 InitBasicFS, Always, TestOutput (
2842 [["set_e2uuid"; "/dev/sda1"; "clear"];
2843 ["get_e2uuid"; "/dev/sda1"]], "");
2844 (* We can't predict what UUIDs will be, so just check the commands run. *)
2845 InitBasicFS, Always, TestRun (
2846 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2847 InitBasicFS, Always, TestRun (
2848 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2849 "set the ext2/3/4 filesystem UUID",
2851 This sets the ext2/3/4 filesystem UUID of the filesystem on
2852 C<device> to C<uuid>. The format of the UUID and alternatives
2853 such as C<clear>, C<random> and C<time> are described in the
2854 L<tune2fs(8)> manpage.
2856 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2857 to return the existing UUID of a filesystem.");
2859 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2860 (* Regression test for RHBZ#597112. *)
2861 (let uuid = uuidgen () in
2862 [InitNone, Always, TestOutput (
2863 [["mke2journal"; "1024"; "/dev/sdc"];
2864 ["set_e2uuid"; "/dev/sdc"; uuid];
2865 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2866 "get the ext2/3/4 filesystem UUID",
2868 This returns the ext2/3/4 filesystem UUID of the filesystem on
2871 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2872 [InitBasicFS, Always, TestOutputInt (
2873 [["umount"; "/dev/sda1"];
2874 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2875 InitBasicFS, Always, TestOutputInt (
2876 [["umount"; "/dev/sda1"];
2877 ["zero"; "/dev/sda1"];
2878 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2879 "run the filesystem checker",
2881 This runs the filesystem checker (fsck) on C<device> which
2882 should have filesystem type C<fstype>.
2884 The returned integer is the status. See L<fsck(8)> for the
2885 list of status codes from C<fsck>.
2893 Multiple status codes can be summed together.
2897 A non-zero return code can mean \"success\", for example if
2898 errors have been corrected on the filesystem.
2902 Checking or repairing NTFS volumes is not supported
2907 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2909 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2910 [InitBasicFS, Always, TestRun (
2911 [["umount"; "/dev/sda1"];
2912 ["zero"; "/dev/sda1"]])],
2913 "write zeroes to the device",
2915 This command writes zeroes over the first few blocks of C<device>.
2917 How many blocks are zeroed isn't specified (but it's I<not> enough
2918 to securely wipe the device). It should be sufficient to remove
2919 any partition tables, filesystem superblocks and so on.
2921 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
2922 C<guestfs_is_zero_device>");
2924 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2926 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2927 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2929 [InitBasicFS, Always, TestOutputTrue (
2930 [["mkdir_p"; "/boot/grub"];
2931 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2932 ["grub_install"; "/"; "/dev/vda"];
2933 ["is_dir"; "/boot"]])],
2936 This command installs GRUB (the Grand Unified Bootloader) on
2937 C<device>, with the root directory being C<root>.
2939 Note: If grub-install reports the error
2940 \"No suitable drive was found in the generated device map.\"
2941 it may be that you need to create a C</boot/grub/device.map>
2942 file first that contains the mapping between grub device names
2943 and Linux device names. It is usually sufficient to create
2948 replacing C</dev/vda> with the name of the installation device.");
2950 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
2951 [InitScratchFS, Always, TestOutput (
2953 ["write"; "/cp/old"; "file content"];
2954 ["cp"; "/cp/old"; "/cp/new"];
2955 ["cat"; "/cp/new"]], "file content");
2956 InitScratchFS, Always, TestOutputTrue (
2958 ["write"; "/cp2/old"; "file content"];
2959 ["cp"; "/cp2/old"; "/cp2/new"];
2960 ["is_file"; "/cp2/old"]]);
2961 InitScratchFS, Always, TestOutput (
2963 ["write"; "/cp3/old"; "file content"];
2964 ["mkdir"; "/cp3/dir"];
2965 ["cp"; "/cp3/old"; "/cp3/dir/new"];
2966 ["cat"; "/cp3/dir/new"]], "file content")],
2969 This copies a file from C<src> to C<dest> where C<dest> is
2970 either a destination filename or destination directory.");
2972 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
2973 [InitScratchFS, Always, TestOutput (
2974 [["mkdir"; "/cp_a1"];
2975 ["mkdir"; "/cp_a2"];
2976 ["write"; "/cp_a1/file"; "file content"];
2977 ["cp_a"; "/cp_a1"; "/cp_a2"];
2978 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
2979 "copy a file or directory recursively",
2981 This copies a file or directory from C<src> to C<dest>
2982 recursively using the C<cp -a> command.");
2984 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
2985 [InitScratchFS, Always, TestOutput (
2987 ["write"; "/mv/old"; "file content"];
2988 ["mv"; "/mv/old"; "/mv/new"];
2989 ["cat"; "/mv/new"]], "file content");
2990 InitScratchFS, Always, TestOutputFalse (
2992 ["write"; "/mv2/old"; "file content"];
2993 ["mv"; "/mv2/old"; "/mv2/new"];
2994 ["is_file"; "/mv2/old"]])],
2997 This moves a file from C<src> to C<dest> where C<dest> is
2998 either a destination filename or destination directory.");
3000 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3001 [InitEmpty, Always, TestRun (
3002 [["drop_caches"; "3"]])],
3003 "drop kernel page cache, dentries and inodes",
3005 This instructs the guest kernel to drop its page cache,
3006 and/or dentries and inode caches. The parameter C<whattodrop>
3007 tells the kernel what precisely to drop, see
3008 L<http://linux-mm.org/Drop_Caches>
3010 Setting C<whattodrop> to 3 should drop everything.
3012 This automatically calls L<sync(2)> before the operation,
3013 so that the maximum guest memory is freed.");
3015 ("dmesg", (RString "kmsgs", [], []), 91, [],
3016 [InitEmpty, Always, TestRun (
3018 "return kernel messages",
3020 This returns the kernel messages (C<dmesg> output) from
3021 the guest kernel. This is sometimes useful for extended
3022 debugging of problems.
3024 Another way to get the same information is to enable
3025 verbose messages with C<guestfs_set_verbose> or by setting
3026 the environment variable C<LIBGUESTFS_DEBUG=1> before
3027 running the program.");
3029 ("ping_daemon", (RErr, [], []), 92, [],
3030 [InitEmpty, Always, TestRun (
3031 [["ping_daemon"]])],
3032 "ping the guest daemon",
3034 This is a test probe into the guestfs daemon running inside
3035 the qemu subprocess. Calling this function checks that the
3036 daemon responds to the ping message, without affecting the daemon
3037 or attached block device(s) in any other way.");
3039 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3040 [InitScratchFS, Always, TestOutputTrue (
3041 [["mkdir"; "/equal"];
3042 ["write"; "/equal/file1"; "contents of a file"];
3043 ["cp"; "/equal/file1"; "/equal/file2"];
3044 ["equal"; "/equal/file1"; "/equal/file2"]]);
3045 InitScratchFS, Always, TestOutputFalse (
3046 [["mkdir"; "/equal2"];
3047 ["write"; "/equal2/file1"; "contents of a file"];
3048 ["write"; "/equal2/file2"; "contents of another file"];
3049 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3050 InitScratchFS, Always, TestLastFail (
3051 [["mkdir"; "/equal3"];
3052 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3053 "test if two files have equal contents",
3055 This compares the two files C<file1> and C<file2> and returns
3056 true if their content is exactly equal, or false otherwise.
3058 The external L<cmp(1)> program is used for the comparison.");
3060 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3061 [InitISOFS, Always, TestOutputList (
3062 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3063 InitISOFS, Always, TestOutputList (
3064 [["strings"; "/empty"]], []);
3065 (* Test for RHBZ#579608, absolute symbolic links. *)
3066 InitISOFS, Always, TestRun (
3067 [["strings"; "/abssymlink"]])],
3068 "print the printable strings in a file",
3070 This runs the L<strings(1)> command on a file and returns
3071 the list of printable strings found.");
3073 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3074 [InitISOFS, Always, TestOutputList (
3075 [["strings_e"; "b"; "/known-5"]], []);
3076 InitScratchFS, Always, TestOutputList (
3077 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3078 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3079 "print the printable strings in a file",
3081 This is like the C<guestfs_strings> command, but allows you to
3082 specify the encoding of strings that are looked for in
3083 the source file C<path>.
3085 Allowed encodings are:
3091 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3092 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3096 Single 8-bit-byte characters.
3100 16-bit big endian strings such as those encoded in
3101 UTF-16BE or UCS-2BE.
3103 =item l (lower case letter L)
3105 16-bit little endian such as UTF-16LE and UCS-2LE.
3106 This is useful for examining binaries in Windows guests.
3110 32-bit big endian such as UCS-4BE.
3114 32-bit little endian such as UCS-4LE.
3118 The returned strings are transcoded to UTF-8.");
3120 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3121 [InitISOFS, Always, TestOutput (
3122 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3123 (* Test for RHBZ#501888c2 regression which caused large hexdump
3124 * commands to segfault.
3126 InitISOFS, Always, TestRun (
3127 [["hexdump"; "/100krandom"]]);
3128 (* Test for RHBZ#579608, absolute symbolic links. *)
3129 InitISOFS, Always, TestRun (
3130 [["hexdump"; "/abssymlink"]])],
3131 "dump a file in hexadecimal",
3133 This runs C<hexdump -C> on the given C<path>. The result is
3134 the human-readable, canonical hex dump of the file.");
3136 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3137 [InitNone, Always, TestOutput (
3138 [["part_disk"; "/dev/sda"; "mbr"];
3139 ["mkfs"; "ext3"; "/dev/sda1"];
3140 ["mount_options"; ""; "/dev/sda1"; "/"];
3141 ["write"; "/new"; "test file"];
3142 ["umount"; "/dev/sda1"];
3143 ["zerofree"; "/dev/sda1"];
3144 ["mount_options"; ""; "/dev/sda1"; "/"];
3145 ["cat"; "/new"]], "test file")],
3146 "zero unused inodes and disk blocks on ext2/3 filesystem",
3148 This runs the I<zerofree> program on C<device>. This program
3149 claims to zero unused inodes and disk blocks on an ext2/3
3150 filesystem, thus making it possible to compress the filesystem
3153 You should B<not> run this program if the filesystem is
3156 It is possible that using this program can damage the filesystem
3157 or data on the filesystem.");
3159 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3161 "resize an LVM physical volume",
3163 This resizes (expands or shrinks) an existing LVM physical
3164 volume to match the new size of the underlying device.");
3166 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3167 Int "cyls"; Int "heads"; Int "sectors";
3168 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3170 "modify a single partition on a block device",
3172 This runs L<sfdisk(8)> option to modify just the single
3173 partition C<n> (note: C<n> counts from 1).
3175 For other parameters, see C<guestfs_sfdisk>. You should usually
3176 pass C<0> for the cyls/heads/sectors parameters.
3178 See also: C<guestfs_part_add>");
3180 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3182 "display the partition table",
3184 This displays the partition table on C<device>, in the
3185 human-readable output of the L<sfdisk(8)> command. It is
3186 not intended to be parsed.
3188 See also: C<guestfs_part_list>");
3190 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3192 "display the kernel geometry",
3194 This displays the kernel's idea of the geometry of C<device>.
3196 The result is in human-readable format, and not designed to
3199 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3201 "display the disk geometry from the partition table",
3203 This displays the disk geometry of C<device> read from the
3204 partition table. Especially in the case where the underlying
3205 block device has been resized, this can be different from the
3206 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3208 The result is in human-readable format, and not designed to
3211 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3213 "activate or deactivate all volume groups",
3215 This command activates or (if C<activate> is false) deactivates
3216 all logical volumes in all volume groups.
3217 If activated, then they are made known to the
3218 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3219 then those devices disappear.
3221 This command is the same as running C<vgchange -a y|n>");
3223 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3225 "activate or deactivate some volume groups",
3227 This command activates or (if C<activate> is false) deactivates
3228 all logical volumes in the listed volume groups C<volgroups>.
3229 If activated, then they are made known to the
3230 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3231 then those devices disappear.
3233 This command is the same as running C<vgchange -a y|n volgroups...>
3235 Note that if C<volgroups> is an empty list then B<all> volume groups
3236 are activated or deactivated.");
3238 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3239 [InitNone, Always, TestOutput (
3240 [["part_disk"; "/dev/sda"; "mbr"];
3241 ["pvcreate"; "/dev/sda1"];
3242 ["vgcreate"; "VG"; "/dev/sda1"];
3243 ["lvcreate"; "LV"; "VG"; "10"];
3244 ["mkfs"; "ext2"; "/dev/VG/LV"];
3245 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3246 ["write"; "/new"; "test content"];
3248 ["lvresize"; "/dev/VG/LV"; "20"];
3249 ["e2fsck_f"; "/dev/VG/LV"];
3250 ["resize2fs"; "/dev/VG/LV"];
3251 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3252 ["cat"; "/new"]], "test content");
3253 InitNone, Always, TestRun (
3254 (* Make an LV smaller to test RHBZ#587484. *)
3255 [["part_disk"; "/dev/sda"; "mbr"];
3256 ["pvcreate"; "/dev/sda1"];
3257 ["vgcreate"; "VG"; "/dev/sda1"];
3258 ["lvcreate"; "LV"; "VG"; "20"];
3259 ["lvresize"; "/dev/VG/LV"; "10"]])],
3260 "resize an LVM logical volume",
3262 This resizes (expands or shrinks) an existing LVM logical
3263 volume to C<mbytes>. When reducing, data in the reduced part
3266 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3267 [], (* lvresize tests this *)
3268 "resize an ext2, ext3 or ext4 filesystem",
3270 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3271 the underlying device.
3273 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3274 on the C<device> before calling this command. For unknown reasons
3275 C<resize2fs> sometimes gives an error about this and sometimes not.
3276 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3277 calling this function.");
3279 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3280 [InitBasicFS, Always, TestOutputList (
3281 [["find"; "/"]], ["lost+found"]);
3282 InitBasicFS, Always, TestOutputList (
3286 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3287 InitScratchFS, Always, TestOutputList (
3288 [["mkdir_p"; "/find/b/c"];
3289 ["touch"; "/find/b/c/d"];
3290 ["find"; "/find/b/"]], ["c"; "c/d"])],
3291 "find all files and directories",
3293 This command lists out all files and directories, recursively,
3294 starting at C<directory>. It is essentially equivalent to
3295 running the shell command C<find directory -print> but some
3296 post-processing happens on the output, described below.
3298 This returns a list of strings I<without any prefix>. Thus
3299 if the directory structure was:
3305 then the returned list from C<guestfs_find> C</tmp> would be
3313 If C<directory> is not a directory, then this command returns
3316 The returned list is sorted.
3318 See also C<guestfs_find0>.");
3320 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3321 [], (* lvresize tests this *)
3322 "check an ext2/ext3 filesystem",
3324 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3325 filesystem checker on C<device>, noninteractively (I<-p>),
3326 even if the filesystem appears to be clean (I<-f>).
3328 This command is only needed because of C<guestfs_resize2fs>
3329 (q.v.). Normally you should use C<guestfs_fsck>.");
3331 ("sleep", (RErr, [Int "secs"], []), 109, [],
3332 [InitNone, Always, TestRun (
3334 "sleep for some seconds",
3336 Sleep for C<secs> seconds.");
3338 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3339 [InitNone, Always, TestOutputInt (
3340 [["part_disk"; "/dev/sda"; "mbr"];
3341 ["mkfs"; "ntfs"; "/dev/sda1"];
3342 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3343 InitNone, Always, TestOutputInt (
3344 [["part_disk"; "/dev/sda"; "mbr"];
3345 ["mkfs"; "ext2"; "/dev/sda1"];
3346 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3347 "probe NTFS volume",
3349 This command runs the L<ntfs-3g.probe(8)> command which probes
3350 an NTFS C<device> for mountability. (Not all NTFS volumes can
3351 be mounted read-write, and some cannot be mounted at all).
3353 C<rw> is a boolean flag. Set it to true if you want to test
3354 if the volume can be mounted read-write. Set it to false if
3355 you want to test if the volume can be mounted read-only.
3357 The return value is an integer which C<0> if the operation
3358 would succeed, or some non-zero value documented in the
3359 L<ntfs-3g.probe(8)> manual page.");
3361 ("sh", (RString "output", [String "command"], []), 111, [],
3362 [], (* XXX needs tests *)
3363 "run a command via the shell",
3365 This call runs a command from the guest filesystem via the
3368 This is like C<guestfs_command>, but passes the command to:
3370 /bin/sh -c \"command\"
3372 Depending on the guest's shell, this usually results in
3373 wildcards being expanded, shell expressions being interpolated
3376 All the provisos about C<guestfs_command> apply to this call.");
3378 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3379 [], (* XXX needs tests *)
3380 "run a command via the shell returning lines",
3382 This is the same as C<guestfs_sh>, but splits the result
3383 into a list of lines.
3385 See also: C<guestfs_command_lines>");
3387 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3388 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3389 * code in stubs.c, since all valid glob patterns must start with "/".
3390 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3392 [InitScratchFS, Always, TestOutputList (
3393 [["mkdir_p"; "/glob_expand/b/c"];
3394 ["touch"; "/glob_expand/b/c/d"];
3395 ["touch"; "/glob_expand/b/c/e"];
3396 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3397 InitScratchFS, Always, TestOutputList (
3398 [["mkdir_p"; "/glob_expand2/b/c"];
3399 ["touch"; "/glob_expand2/b/c/d"];
3400 ["touch"; "/glob_expand2/b/c/e"];
3401 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3402 InitScratchFS, Always, TestOutputList (
3403 [["mkdir_p"; "/glob_expand3/b/c"];
3404 ["touch"; "/glob_expand3/b/c/d"];
3405 ["touch"; "/glob_expand3/b/c/e"];
3406 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3407 "expand a wildcard path",
3409 This command searches for all the pathnames matching
3410 C<pattern> according to the wildcard expansion rules
3413 If no paths match, then this returns an empty list
3414 (note: not an error).
3416 It is just a wrapper around the C L<glob(3)> function
3417 with flags C<GLOB_MARK|GLOB_BRACE>.
3418 See that manual page for more details.");
3420 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3421 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3422 [["scrub_device"; "/dev/sdc"]])],
3423 "scrub (securely wipe) a device",
3425 This command writes patterns over C<device> to make data retrieval
3428 It is an interface to the L<scrub(1)> program. See that
3429 manual page for more details.");
3431 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3432 [InitScratchFS, Always, TestRun (
3433 [["write"; "/scrub_file"; "content"];
3434 ["scrub_file"; "/scrub_file"]])],
3435 "scrub (securely wipe) a file",
3437 This command writes patterns over a file to make data retrieval
3440 The file is I<removed> after scrubbing.
3442 It is an interface to the L<scrub(1)> program. See that
3443 manual page for more details.");
3445 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3446 [], (* XXX needs testing *)
3447 "scrub (securely wipe) free space",
3449 This command creates the directory C<dir> and then fills it
3450 with files until the filesystem is full, and scrubs the files
3451 as for C<guestfs_scrub_file>, and deletes them.
3452 The intention is to scrub any free space on the partition
3455 It is an interface to the L<scrub(1)> program. See that
3456 manual page for more details.");
3458 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3459 [InitScratchFS, Always, TestRun (
3460 [["mkdir"; "/mkdtemp"];
3461 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3462 "create a temporary directory",
3464 This command creates a temporary directory. The
3465 C<template> parameter should be a full pathname for the
3466 temporary directory name with the final six characters being
3469 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3470 the second one being suitable for Windows filesystems.
3472 The name of the temporary directory that was created
3475 The temporary directory is created with mode 0700
3476 and is owned by root.
3478 The caller is responsible for deleting the temporary
3479 directory and its contents after use.
3481 See also: L<mkdtemp(3)>");
3483 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3484 [InitISOFS, Always, TestOutputInt (
3485 [["wc_l"; "/10klines"]], 10000);
3486 (* Test for RHBZ#579608, absolute symbolic links. *)
3487 InitISOFS, Always, TestOutputInt (
3488 [["wc_l"; "/abssymlink"]], 10000)],
3489 "count lines in a file",
3491 This command counts the lines in a file, using the
3492 C<wc -l> external command.");
3494 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3495 [InitISOFS, Always, TestOutputInt (
3496 [["wc_w"; "/10klines"]], 10000)],
3497 "count words in a file",
3499 This command counts the words in a file, using the
3500 C<wc -w> external command.");
3502 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3503 [InitISOFS, Always, TestOutputInt (
3504 [["wc_c"; "/100kallspaces"]], 102400)],
3505 "count characters in a file",
3507 This command counts the characters in a file, using the
3508 C<wc -c> external command.");
3510 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3511 [InitISOFS, Always, TestOutputList (
3512 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3513 (* Test for RHBZ#579608, absolute symbolic links. *)
3514 InitISOFS, Always, TestOutputList (
3515 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3516 "return first 10 lines of a file",
3518 This command returns up to the first 10 lines of a file as
3519 a list of strings.");
3521 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3522 [InitISOFS, Always, TestOutputList (
3523 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3524 InitISOFS, Always, TestOutputList (
3525 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3526 InitISOFS, Always, TestOutputList (
3527 [["head_n"; "0"; "/10klines"]], [])],
3528 "return first N lines of a file",
3530 If the parameter C<nrlines> is a positive number, this returns the first
3531 C<nrlines> lines of the file C<path>.
3533 If the parameter C<nrlines> is a negative number, this returns lines
3534 from the file C<path>, excluding the last C<nrlines> lines.
3536 If the parameter C<nrlines> is zero, this returns an empty list.");
3538 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3539 [InitISOFS, Always, TestOutputList (
3540 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3541 "return last 10 lines of a file",
3543 This command returns up to the last 10 lines of a file as
3544 a list of strings.");
3546 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3547 [InitISOFS, Always, TestOutputList (
3548 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3549 InitISOFS, Always, TestOutputList (
3550 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3551 InitISOFS, Always, TestOutputList (
3552 [["tail_n"; "0"; "/10klines"]], [])],
3553 "return last N lines of a file",
3555 If the parameter C<nrlines> is a positive number, this returns the last
3556 C<nrlines> lines of the file C<path>.
3558 If the parameter C<nrlines> is a negative number, this returns lines
3559 from the file C<path>, starting with the C<-nrlines>th line.
3561 If the parameter C<nrlines> is zero, this returns an empty list.");
3563 ("df", (RString "output", [], []), 125, [],
3564 [], (* XXX Tricky to test because it depends on the exact format
3565 * of the 'df' command and other imponderables.
3567 "report file system disk space usage",
3569 This command runs the C<df> command to report disk space used.
3571 This command is mostly useful for interactive sessions. It
3572 is I<not> intended that you try to parse the output string.
3573 Use C<guestfs_statvfs> from programs.");
3575 ("df_h", (RString "output", [], []), 126, [],
3576 [], (* XXX Tricky to test because it depends on the exact format
3577 * of the 'df' command and other imponderables.
3579 "report file system disk space usage (human readable)",
3581 This command runs the C<df -h> command to report disk space used
3582 in human-readable format.
3584 This command is mostly useful for interactive sessions. It
3585 is I<not> intended that you try to parse the output string.
3586 Use C<guestfs_statvfs> from programs.");
3588 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3589 [InitISOFS, Always, TestOutputInt (
3590 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3591 "estimate file space usage",
3593 This command runs the C<du -s> command to estimate file space
3596 C<path> can be a file or a directory. If C<path> is a directory
3597 then the estimate includes the contents of the directory and all
3598 subdirectories (recursively).
3600 The result is the estimated size in I<kilobytes>
3601 (ie. units of 1024 bytes).");
3603 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3604 [InitISOFS, Always, TestOutputList (
3605 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3606 "list files in an initrd",
3608 This command lists out files contained in an initrd.
3610 The files are listed without any initial C</> character. The
3611 files are listed in the order they appear (not necessarily
3612 alphabetical). Directory names are listed as separate items.
3614 Old Linux kernels (2.4 and earlier) used a compressed ext2
3615 filesystem as initrd. We I<only> support the newer initramfs
3616 format (compressed cpio files).");
3618 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3620 "mount a file using the loop device",
3622 This command lets you mount C<file> (a filesystem image
3623 in a file) on a mount point. It is entirely equivalent to
3624 the command C<mount -o loop file mountpoint>.");
3626 ("mkswap", (RErr, [Device "device"], []), 130, [],
3627 [InitEmpty, Always, TestRun (
3628 [["part_disk"; "/dev/sda"; "mbr"];
3629 ["mkswap"; "/dev/sda1"]])],
3630 "create a swap partition",
3632 Create a swap partition on C<device>.");
3634 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3635 [InitEmpty, Always, TestRun (
3636 [["part_disk"; "/dev/sda"; "mbr"];
3637 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3638 "create a swap partition with a label",
3640 Create a swap partition on C<device> with label C<label>.
3642 Note that you cannot attach a swap label to a block device
3643 (eg. C</dev/sda>), just to a partition. This appears to be
3644 a limitation of the kernel or swap tools.");
3646 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3647 (let uuid = uuidgen () in
3648 [InitEmpty, Always, TestRun (
3649 [["part_disk"; "/dev/sda"; "mbr"];
3650 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3651 "create a swap partition with an explicit UUID",
3653 Create a swap partition on C<device> with UUID C<uuid>.");
3655 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3656 [InitScratchFS, Always, TestOutputStruct (
3657 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3658 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3659 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3660 InitScratchFS, Always, TestOutputStruct (
3661 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3662 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3663 "make block, character or FIFO devices",
3665 This call creates block or character special devices, or
3666 named pipes (FIFOs).
3668 The C<mode> parameter should be the mode, using the standard
3669 constants. C<devmajor> and C<devminor> are the
3670 device major and minor numbers, only used when creating block
3671 and character special devices.
3673 Note that, just like L<mknod(2)>, the mode must be bitwise
3674 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3675 just creates a regular file). These constants are
3676 available in the standard Linux header files, or you can use
3677 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3678 which are wrappers around this command which bitwise OR
3679 in the appropriate constant for you.
3681 The mode actually set is affected by the umask.");
3683 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3684 [InitScratchFS, Always, TestOutputStruct (
3685 [["mkfifo"; "0o777"; "/mkfifo"];
3686 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3687 "make FIFO (named pipe)",
3689 This call creates a FIFO (named pipe) called C<path> with
3690 mode C<mode>. It is just a convenient wrapper around
3693 The mode actually set is affected by the umask.");
3695 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3696 [InitScratchFS, Always, TestOutputStruct (
3697 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3698 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3699 "make block device node",
3701 This call creates a block device node called C<path> with
3702 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3703 It is just a convenient wrapper around C<guestfs_mknod>.
3705 The mode actually set is affected by the umask.");
3707 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3708 [InitScratchFS, Always, TestOutputStruct (
3709 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3710 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3711 "make char device node",
3713 This call creates a char device node called C<path> with
3714 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3715 It is just a convenient wrapper around C<guestfs_mknod>.
3717 The mode actually set is affected by the umask.");
3719 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3720 [InitEmpty, Always, TestOutputInt (
3721 [["umask"; "0o22"]], 0o22)],
3722 "set file mode creation mask (umask)",
3724 This function sets the mask used for creating new files and
3725 device nodes to C<mask & 0777>.
3727 Typical umask values would be C<022> which creates new files
3728 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3729 C<002> which creates new files with permissions like
3730 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3732 The default umask is C<022>. This is important because it
3733 means that directories and device nodes will be created with
3734 C<0644> or C<0755> mode even if you specify C<0777>.
3736 See also C<guestfs_get_umask>,
3737 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3739 This call returns the previous umask.");
3741 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3743 "read directories entries",
3745 This returns the list of directory entries in directory C<dir>.
3747 All entries in the directory are returned, including C<.> and
3748 C<..>. The entries are I<not> sorted, but returned in the same
3749 order as the underlying filesystem.
3751 Also this call returns basic file type information about each
3752 file. The C<ftyp> field will contain one of the following characters:
3790 The L<readdir(3)> call returned a C<d_type> field with an
3795 This function is primarily intended for use by programs. To
3796 get a simple list of names, use C<guestfs_ls>. To get a printable
3797 directory for human consumption, use C<guestfs_ll>.");
3799 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3801 "create partitions on a block device",
3803 This is a simplified interface to the C<guestfs_sfdisk>
3804 command, where partition sizes are specified in megabytes
3805 only (rounded to the nearest cylinder) and you don't need
3806 to specify the cyls, heads and sectors parameters which
3807 were rarely if ever used anyway.
3809 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3810 and C<guestfs_part_disk>");
3812 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3814 "determine file type inside a compressed file",
3816 This command runs C<file> after first decompressing C<path>
3819 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3821 Since 1.0.63, use C<guestfs_file> instead which can now
3822 process compressed files.");
3824 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3826 "list extended attributes of a file or directory",
3828 This call lists the extended attributes of the file or directory
3831 At the system call level, this is a combination of the
3832 L<listxattr(2)> and L<getxattr(2)> calls.
3834 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3836 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3838 "list extended attributes of a file or directory",
3840 This is the same as C<guestfs_getxattrs>, but if C<path>
3841 is a symbolic link, then it returns the extended attributes
3842 of the link itself.");
3844 ("setxattr", (RErr, [String "xattr";
3845 String "val"; Int "vallen"; (* will be BufferIn *)
3846 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3848 "set extended attribute of a file or directory",
3850 This call sets the extended attribute named C<xattr>
3851 of the file C<path> to the value C<val> (of length C<vallen>).
3852 The value is arbitrary 8 bit data.
3854 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3856 ("lsetxattr", (RErr, [String "xattr";
3857 String "val"; Int "vallen"; (* will be BufferIn *)
3858 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3860 "set extended attribute of a file or directory",
3862 This is the same as C<guestfs_setxattr>, but if C<path>
3863 is a symbolic link, then it sets an extended attribute
3864 of the link itself.");
3866 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3868 "remove extended attribute of a file or directory",
3870 This call removes the extended attribute named C<xattr>
3871 of the file C<path>.
3873 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3875 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3877 "remove extended attribute of a file or directory",
3879 This is the same as C<guestfs_removexattr>, but if C<path>
3880 is a symbolic link, then it removes an extended attribute
3881 of the link itself.");
3883 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3887 This call is similar to C<guestfs_mounts>. That call returns
3888 a list of devices. This one returns a hash table (map) of
3889 device name to directory where the device is mounted.");
3891 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3892 (* This is a special case: while you would expect a parameter
3893 * of type "Pathname", that doesn't work, because it implies
3894 * NEED_ROOT in the generated calling code in stubs.c, and
3895 * this function cannot use NEED_ROOT.
3898 "create a mountpoint",
3900 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3901 specialized calls that can be used to create extra mountpoints
3902 before mounting the first filesystem.
3904 These calls are I<only> necessary in some very limited circumstances,
3905 mainly the case where you want to mount a mix of unrelated and/or
3906 read-only filesystems together.
3908 For example, live CDs often contain a \"Russian doll\" nest of
3909 filesystems, an ISO outer layer, with a squashfs image inside, with
3910 an ext2/3 image inside that. You can unpack this as follows
3913 add-ro Fedora-11-i686-Live.iso
3917 mkmountpoint /ext3fs
3919 mount-loop /cd/LiveOS/squashfs.img /sqsh
3920 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3922 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3924 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3925 You may get unexpected errors if you try to mix these calls. It is
3926 safest to manually unmount filesystems and remove mountpoints after use.
3928 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3929 longest first, so for this to work for manual mountpoints, you
3930 must ensure that the innermost mountpoints have the longest
3931 pathnames, as in the example code above.
3933 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3935 Autosync [see C<guestfs_set_autosync>, this is set by default on
3936 handles] can cause C<guestfs_umount_all> to be called when the handle
3937 is closed which can also trigger these issues.");
3939 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3941 "remove a mountpoint",
3943 This calls removes a mountpoint that was previously created
3944 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3945 for full details.");
3947 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
3948 [InitISOFS, Always, TestOutputBuffer (
3949 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3950 (* Test various near large, large and too large files (RHBZ#589039). *)
3951 InitScratchFS, Always, TestLastFail (
3952 [["touch"; "/read_file"];
3953 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3954 ["read_file"; "/read_file"]]);
3955 InitScratchFS, Always, TestLastFail (
3956 [["touch"; "/read_file2"];
3957 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3958 ["read_file"; "/read_file2"]]);
3959 InitScratchFS, Always, TestLastFail (
3960 [["touch"; "/read_file3"];
3961 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3962 ["read_file"; "/read_file3"]])],
3965 This calls returns the contents of the file C<path> as a
3968 Unlike C<guestfs_cat>, this function can correctly
3969 handle files that contain embedded ASCII NUL characters.
3970 However unlike C<guestfs_download>, this function is limited
3971 in the total size of file that can be handled.");
3973 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
3974 [InitISOFS, Always, TestOutputList (
3975 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3976 InitISOFS, Always, TestOutputList (
3977 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3978 (* Test for RHBZ#579608, absolute symbolic links. *)
3979 InitISOFS, Always, TestOutputList (
3980 [["grep"; "nomatch"; "/abssymlink"]], [])],
3981 "return lines matching a pattern",
3983 This calls the external C<grep> program and returns the
3986 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
3987 [InitISOFS, Always, TestOutputList (
3988 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3989 "return lines matching a pattern",
3991 This calls the external C<egrep> program and returns the
3994 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
3995 [InitISOFS, Always, TestOutputList (
3996 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3997 "return lines matching a pattern",
3999 This calls the external C<fgrep> program and returns the
4002 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4003 [InitISOFS, Always, TestOutputList (
4004 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4005 "return lines matching a pattern",
4007 This calls the external C<grep -i> program and returns the
4010 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4011 [InitISOFS, Always, TestOutputList (
4012 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4013 "return lines matching a pattern",
4015 This calls the external C<egrep -i> program and returns the
4018 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4019 [InitISOFS, Always, TestOutputList (
4020 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4021 "return lines matching a pattern",
4023 This calls the external C<fgrep -i> program and returns the
4026 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4027 [InitISOFS, Always, TestOutputList (
4028 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4029 "return lines matching a pattern",
4031 This calls the external C<zgrep> program and returns the
4034 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4035 [InitISOFS, Always, TestOutputList (
4036 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4037 "return lines matching a pattern",
4039 This calls the external C<zegrep> program and returns the
4042 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4043 [InitISOFS, Always, TestOutputList (
4044 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4045 "return lines matching a pattern",
4047 This calls the external C<zfgrep> program and returns the
4050 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4051 [InitISOFS, Always, TestOutputList (
4052 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4053 "return lines matching a pattern",
4055 This calls the external C<zgrep -i> program and returns the
4058 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4059 [InitISOFS, Always, TestOutputList (
4060 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4061 "return lines matching a pattern",
4063 This calls the external C<zegrep -i> program and returns the
4066 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4067 [InitISOFS, Always, TestOutputList (
4068 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4069 "return lines matching a pattern",
4071 This calls the external C<zfgrep -i> program and returns the
4074 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4075 [InitISOFS, Always, TestOutput (
4076 [["realpath"; "/../directory"]], "/directory")],
4077 "canonicalized absolute pathname",
4079 Return the canonicalized absolute pathname of C<path>. The
4080 returned path has no C<.>, C<..> or symbolic link path elements.");
4082 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4083 [InitScratchFS, Always, TestOutputStruct (
4086 ["ln"; "/ln/a"; "/ln/b"];
4087 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4088 "create a hard link",
4090 This command creates a hard link using the C<ln> command.");
4092 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4093 [InitScratchFS, Always, TestOutputStruct (
4094 [["mkdir"; "/ln_f"];
4095 ["touch"; "/ln_f/a"];
4096 ["touch"; "/ln_f/b"];
4097 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4098 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4099 "create a hard link",
4101 This command creates a hard link using the C<ln -f> command.
4102 The I<-f> option removes the link (C<linkname>) if it exists already.");
4104 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4105 [InitScratchFS, Always, TestOutputStruct (
4106 [["mkdir"; "/ln_s"];
4107 ["touch"; "/ln_s/a"];
4108 ["ln_s"; "a"; "/ln_s/b"];
4109 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4110 "create a symbolic link",
4112 This command creates a symbolic link using the C<ln -s> command.");
4114 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4115 [InitScratchFS, Always, TestOutput (
4116 [["mkdir_p"; "/ln_sf/b"];
4117 ["touch"; "/ln_sf/b/c"];
4118 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4119 ["readlink"; "/ln_sf/b/c"]], "../d")],
4120 "create a symbolic link",
4122 This command creates a symbolic link using the C<ln -sf> command,
4123 The I<-f> option removes the link (C<linkname>) if it exists already.");
4125 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4126 [] (* XXX tested above *),
4127 "read the target of a symbolic link",
4129 This command reads the target of a symbolic link.");
4131 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4132 [InitScratchFS, Always, TestOutputStruct (
4133 [["fallocate"; "/fallocate"; "1000000"];
4134 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4135 "preallocate a file in the guest filesystem",
4137 This command preallocates a file (containing zero bytes) named
4138 C<path> of size C<len> bytes. If the file exists already, it
4141 Do not confuse this with the guestfish-specific
4142 C<alloc> command which allocates a file in the host and
4143 attaches it as a device.");
4145 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4146 [InitPartition, Always, TestRun (
4147 [["mkswap"; "/dev/sda1"];
4148 ["swapon_device"; "/dev/sda1"];
4149 ["swapoff_device"; "/dev/sda1"]])],
4150 "enable swap on device",
4152 This command enables the libguestfs appliance to use the
4153 swap device or partition named C<device>. The increased
4154 memory is made available for all commands, for example
4155 those run using C<guestfs_command> or C<guestfs_sh>.
4157 Note that you should not swap to existing guest swap
4158 partitions unless you know what you are doing. They may
4159 contain hibernation information, or other information that
4160 the guest doesn't want you to trash. You also risk leaking
4161 information about the host to the guest this way. Instead,
4162 attach a new host device to the guest and swap on that.");
4164 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4165 [], (* XXX tested by swapon_device *)
4166 "disable swap on device",
4168 This command disables the libguestfs appliance swap
4169 device or partition named C<device>.
4170 See C<guestfs_swapon_device>.");
4172 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4173 [InitScratchFS, Always, TestRun (
4174 [["fallocate"; "/swapon_file"; "8388608"];
4175 ["mkswap_file"; "/swapon_file"];
4176 ["swapon_file"; "/swapon_file"];
4177 ["swapoff_file"; "/swapon_file"];
4178 ["rm"; "/swapon_file"]])],
4179 "enable swap on file",
4181 This command enables swap to a file.
4182 See C<guestfs_swapon_device> for other notes.");
4184 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4185 [], (* XXX tested by swapon_file *)
4186 "disable swap on file",
4188 This command disables the libguestfs appliance swap on file.");
4190 ("swapon_label", (RErr, [String "label"], []), 174, [],
4191 [InitEmpty, Always, TestRun (
4192 [["part_disk"; "/dev/sda"; "mbr"];
4193 ["mkswap_L"; "swapit"; "/dev/sda1"];
4194 ["swapon_label"; "swapit"];
4195 ["swapoff_label"; "swapit"];
4196 ["zero"; "/dev/sda"];
4197 ["blockdev_rereadpt"; "/dev/sda"]])],
4198 "enable swap on labeled swap partition",
4200 This command enables swap to a labeled swap partition.
4201 See C<guestfs_swapon_device> for other notes.");
4203 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4204 [], (* XXX tested by swapon_label *)
4205 "disable swap on labeled swap partition",
4207 This command disables the libguestfs appliance swap on
4208 labeled swap partition.");
4210 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4211 (let uuid = uuidgen () in
4212 [InitEmpty, Always, TestRun (
4213 [["mkswap_U"; uuid; "/dev/sdc"];
4214 ["swapon_uuid"; uuid];
4215 ["swapoff_uuid"; uuid]])]),
4216 "enable swap on swap partition by UUID",
4218 This command enables swap to a swap partition with the given UUID.
4219 See C<guestfs_swapon_device> for other notes.");
4221 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4222 [], (* XXX tested by swapon_uuid *)
4223 "disable swap on swap partition by UUID",
4225 This command disables the libguestfs appliance swap partition
4226 with the given UUID.");
4228 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4229 [InitScratchFS, Always, TestRun (
4230 [["fallocate"; "/mkswap_file"; "8388608"];
4231 ["mkswap_file"; "/mkswap_file"];
4232 ["rm"; "/mkswap_file"]])],
4233 "create a swap file",
4237 This command just writes a swap file signature to an existing
4238 file. To create the file itself, use something like C<guestfs_fallocate>.");
4240 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4241 [InitISOFS, Always, TestRun (
4242 [["inotify_init"; "0"]])],
4243 "create an inotify handle",
4245 This command creates a new inotify handle.
4246 The inotify subsystem can be used to notify events which happen to
4247 objects in the guest filesystem.
4249 C<maxevents> is the maximum number of events which will be
4250 queued up between calls to C<guestfs_inotify_read> or
4251 C<guestfs_inotify_files>.
4252 If this is passed as C<0>, then the kernel (or previously set)
4253 default is used. For Linux 2.6.29 the default was 16384 events.
4254 Beyond this limit, the kernel throws away events, but records
4255 the fact that it threw them away by setting a flag
4256 C<IN_Q_OVERFLOW> in the returned structure list (see
4257 C<guestfs_inotify_read>).
4259 Before any events are generated, you have to add some
4260 watches to the internal watch list. See:
4261 C<guestfs_inotify_add_watch>,
4262 C<guestfs_inotify_rm_watch> and
4263 C<guestfs_inotify_watch_all>.
4265 Queued up events should be read periodically by calling
4266 C<guestfs_inotify_read>
4267 (or C<guestfs_inotify_files> which is just a helpful
4268 wrapper around C<guestfs_inotify_read>). If you don't
4269 read the events out often enough then you risk the internal
4272 The handle should be closed after use by calling
4273 C<guestfs_inotify_close>. This also removes any
4274 watches automatically.
4276 See also L<inotify(7)> for an overview of the inotify interface
4277 as exposed by the Linux kernel, which is roughly what we expose
4278 via libguestfs. Note that there is one global inotify handle
4279 per libguestfs instance.");
4281 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4282 [InitScratchFS, Always, TestOutputList (
4283 [["mkdir"; "/inotify_add_watch"];
4284 ["inotify_init"; "0"];
4285 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4286 ["touch"; "/inotify_add_watch/a"];
4287 ["touch"; "/inotify_add_watch/b"];
4288 ["inotify_files"]], ["a"; "b"])],
4289 "add an inotify watch",
4291 Watch C<path> for the events listed in C<mask>.
4293 Note that if C<path> is a directory then events within that
4294 directory are watched, but this does I<not> happen recursively
4295 (in subdirectories).
4297 Note for non-C or non-Linux callers: the inotify events are
4298 defined by the Linux kernel ABI and are listed in
4299 C</usr/include/sys/inotify.h>.");
4301 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4303 "remove an inotify watch",
4305 Remove a previously defined inotify watch.
4306 See C<guestfs_inotify_add_watch>.");
4308 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4310 "return list of inotify events",
4312 Return the complete queue of events that have happened
4313 since the previous read call.
4315 If no events have happened, this returns an empty list.
4317 I<Note>: In order to make sure that all events have been
4318 read, you must call this function repeatedly until it
4319 returns an empty list. The reason is that the call will
4320 read events up to the maximum appliance-to-host message
4321 size and leave remaining events in the queue.");
4323 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4325 "return list of watched files that had events",
4327 This function is a helpful wrapper around C<guestfs_inotify_read>
4328 which just returns a list of pathnames of objects that were
4329 touched. The returned pathnames are sorted and deduplicated.");
4331 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4333 "close the inotify handle",
4335 This closes the inotify handle which was previously
4336 opened by inotify_init. It removes all watches, throws
4337 away any pending events, and deallocates all resources.");
4339 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4341 "set SELinux security context",
4343 This sets the SELinux security context of the daemon
4344 to the string C<context>.
4346 See the documentation about SELINUX in L<guestfs(3)>.");
4348 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4350 "get SELinux security context",
4352 This gets the SELinux security context of the daemon.
4354 See the documentation about SELINUX in L<guestfs(3)>,
4355 and C<guestfs_setcon>");
4357 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4358 [InitEmpty, Always, TestOutput (
4359 [["part_disk"; "/dev/sda"; "mbr"];
4360 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4361 ["mount_options"; ""; "/dev/sda1"; "/"];
4362 ["write"; "/new"; "new file contents"];
4363 ["cat"; "/new"]], "new file contents");
4364 InitEmpty, Always, TestRun (
4365 [["part_disk"; "/dev/sda"; "mbr"];
4366 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4367 InitEmpty, Always, TestLastFail (
4368 [["part_disk"; "/dev/sda"; "mbr"];
4369 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4370 InitEmpty, Always, TestLastFail (
4371 [["part_disk"; "/dev/sda"; "mbr"];
4372 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4373 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4374 [["part_disk"; "/dev/sda"; "mbr"];
4375 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4376 "make a filesystem with block size",
4378 This call is similar to C<guestfs_mkfs>, but it allows you to
4379 control the block size of the resulting filesystem. Supported
4380 block sizes depend on the filesystem type, but typically they
4381 are C<1024>, C<2048> or C<4096> only.
4383 For VFAT and NTFS the C<blocksize> parameter is treated as
4384 the requested cluster size.");
4386 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4387 [InitEmpty, Always, TestOutput (
4388 [["part_init"; "/dev/sda"; "mbr"];
4389 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4390 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4391 ["mke2journal"; "4096"; "/dev/sda1"];
4392 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4393 ["mount_options"; ""; "/dev/sda2"; "/"];
4394 ["write"; "/new"; "new file contents"];
4395 ["cat"; "/new"]], "new file contents")],
4396 "make ext2/3/4 external journal",
4398 This creates an ext2 external journal on C<device>. It is equivalent
4401 mke2fs -O journal_dev -b blocksize device");
4403 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4404 [InitEmpty, Always, TestOutput (
4405 [["part_init"; "/dev/sda"; "mbr"];
4406 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4407 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4408 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4409 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4410 ["mount_options"; ""; "/dev/sda2"; "/"];
4411 ["write"; "/new"; "new file contents"];
4412 ["cat"; "/new"]], "new file contents")],
4413 "make ext2/3/4 external journal with label",
4415 This creates an ext2 external journal on C<device> with label C<label>.");
4417 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4418 (let uuid = uuidgen () in
4419 [InitEmpty, Always, TestOutput (
4420 [["part_init"; "/dev/sda"; "mbr"];
4421 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4422 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4423 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4424 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4425 ["mount_options"; ""; "/dev/sda2"; "/"];
4426 ["write"; "/new"; "new file contents"];
4427 ["cat"; "/new"]], "new file contents")]),
4428 "make ext2/3/4 external journal with UUID",
4430 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4432 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4434 "make ext2/3/4 filesystem with external journal",
4436 This creates an ext2/3/4 filesystem on C<device> with
4437 an external journal on C<journal>. It is equivalent
4440 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4442 See also C<guestfs_mke2journal>.");
4444 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4446 "make ext2/3/4 filesystem with external journal",
4448 This creates an ext2/3/4 filesystem on C<device> with
4449 an external journal on the journal labeled C<label>.
4451 See also C<guestfs_mke2journal_L>.");
4453 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4455 "make ext2/3/4 filesystem with external journal",
4457 This creates an ext2/3/4 filesystem on C<device> with
4458 an external journal on the journal with UUID C<uuid>.
4460 See also C<guestfs_mke2journal_U>.");
4462 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4463 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4464 "load a kernel module",
4466 This loads a kernel module in the appliance.
4468 The kernel module must have been whitelisted when libguestfs
4469 was built (see C<appliance/kmod.whitelist.in> in the source).");
4471 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4472 [InitNone, Always, TestOutput (
4473 [["echo_daemon"; "This is a test"]], "This is a test"
4475 "echo arguments back to the client",
4477 This command concatenates the list of C<words> passed with single spaces
4478 between them and returns the resulting string.
4480 You can use this command to test the connection through to the daemon.
4482 See also C<guestfs_ping_daemon>.");
4484 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4485 [], (* There is a regression test for this. *)
4486 "find all files and directories, returning NUL-separated list",
4488 This command lists out all files and directories, recursively,
4489 starting at C<directory>, placing the resulting list in the
4490 external file called C<files>.
4492 This command works the same way as C<guestfs_find> with the
4493 following exceptions:
4499 The resulting list is written to an external file.
4503 Items (filenames) in the result are separated
4504 by C<\\0> characters. See L<find(1)> option I<-print0>.
4508 This command is not limited in the number of names that it
4513 The result list is not sorted.
4517 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4518 [InitISOFS, Always, TestOutput (
4519 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4520 InitISOFS, Always, TestOutput (
4521 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4522 InitISOFS, Always, TestOutput (
4523 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4524 InitISOFS, Always, TestLastFail (
4525 [["case_sensitive_path"; "/Known-1/"]]);
4526 InitScratchFS, Always, TestOutput (
4527 [["mkdir"; "/case_sensitive_path"];
4528 ["mkdir"; "/case_sensitive_path/bbb"];
4529 ["touch"; "/case_sensitive_path/bbb/c"];
4530 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4531 InitScratchFS, Always, TestOutput (
4532 [["mkdir"; "/case_sensitive_path2"];
4533 ["mkdir"; "/case_sensitive_path2/bbb"];
4534 ["touch"; "/case_sensitive_path2/bbb/c"];
4535 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4536 InitScratchFS, Always, TestLastFail (
4537 [["mkdir"; "/case_sensitive_path3"];
4538 ["mkdir"; "/case_sensitive_path3/bbb"];
4539 ["touch"; "/case_sensitive_path3/bbb/c"];
4540 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4541 "return true path on case-insensitive filesystem",
4543 This can be used to resolve case insensitive paths on
4544 a filesystem which is case sensitive. The use case is
4545 to resolve paths which you have read from Windows configuration
4546 files or the Windows Registry, to the true path.
4548 The command handles a peculiarity of the Linux ntfs-3g
4549 filesystem driver (and probably others), which is that although
4550 the underlying filesystem is case-insensitive, the driver
4551 exports the filesystem to Linux as case-sensitive.
4553 One consequence of this is that special directories such
4554 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4555 (or other things) depending on the precise details of how
4556 they were created. In Windows itself this would not be
4559 Bug or feature? You decide:
4560 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4562 This function resolves the true case of each element in the
4563 path and returns the case-sensitive path.
4565 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4566 might return C<\"/WINDOWS/system32\"> (the exact return value
4567 would depend on details of how the directories were originally
4568 created under Windows).
4571 This function does not handle drive names, backslashes etc.
4573 See also C<guestfs_realpath>.");
4575 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4576 [InitScratchFS, Always, TestOutput (
4577 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4578 "get the Linux VFS type corresponding to a mounted device",
4580 This command gets the filesystem type corresponding to
4581 the filesystem on C<device>.
4583 For most filesystems, the result is the name of the Linux
4584 VFS module which would be used to mount this filesystem
4585 if you mounted it without specifying the filesystem type.
4586 For example a string such as C<ext3> or C<ntfs>.");
4588 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4589 [InitScratchFS, Always, TestOutputStruct (
4590 [["write"; "/truncate"; "some stuff so size is not zero"];
4591 ["truncate"; "/truncate"];
4592 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4593 "truncate a file to zero size",
4595 This command truncates C<path> to a zero-length file. The
4596 file must exist already.");
4598 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4599 [InitScratchFS, Always, TestOutputStruct (
4600 [["touch"; "/truncate_size"];
4601 ["truncate_size"; "/truncate_size"; "1000"];
4602 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4603 "truncate a file to a particular size",
4605 This command truncates C<path> to size C<size> bytes. The file
4608 If the current file size is less than C<size> then
4609 the file is extended to the required size with zero bytes.
4610 This creates a sparse file (ie. disk blocks are not allocated
4611 for the file until you write to it). To create a non-sparse
4612 file of zeroes, use C<guestfs_fallocate64> instead.");
4614 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4615 [InitScratchFS, Always, TestOutputStruct (
4616 [["touch"; "/utimens"];
4617 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4618 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4619 "set timestamp of a file with nanosecond precision",
4621 This command sets the timestamps of a file with nanosecond
4624 C<atsecs, atnsecs> are the last access time (atime) in secs and
4625 nanoseconds from the epoch.
4627 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4628 secs and nanoseconds from the epoch.
4630 If the C<*nsecs> field contains the special value C<-1> then
4631 the corresponding timestamp is set to the current time. (The
4632 C<*secs> field is ignored in this case).
4634 If the C<*nsecs> field contains the special value C<-2> then
4635 the corresponding timestamp is left unchanged. (The
4636 C<*secs> field is ignored in this case).");
4638 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4639 [InitScratchFS, Always, TestOutputStruct (
4640 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4641 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4642 "create a directory with a particular mode",
4644 This command creates a directory, setting the initial permissions
4645 of the directory to C<mode>.
4647 For common Linux filesystems, the actual mode which is set will
4648 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4649 interpret the mode in other ways.
4651 See also C<guestfs_mkdir>, C<guestfs_umask>");
4653 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4655 "change file owner and group",
4657 Change the file owner to C<owner> and group to C<group>.
4658 This is like C<guestfs_chown> but if C<path> is a symlink then
4659 the link itself is changed, not the target.
4661 Only numeric uid and gid are supported. If you want to use
4662 names, you will need to locate and parse the password file
4663 yourself (Augeas support makes this relatively easy).");
4665 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4667 "lstat on multiple files",
4669 This call allows you to perform the C<guestfs_lstat> operation
4670 on multiple files, where all files are in the directory C<path>.
4671 C<names> is the list of files from this directory.
4673 On return you get a list of stat structs, with a one-to-one
4674 correspondence to the C<names> list. If any name did not exist
4675 or could not be lstat'd, then the C<ino> field of that structure
4678 This call is intended for programs that want to efficiently
4679 list a directory contents without making many round-trips.
4680 See also C<guestfs_lxattrlist> for a similarly efficient call
4681 for getting extended attributes. Very long directory listings
4682 might cause the protocol message size to be exceeded, causing
4683 this call to fail. The caller must split up such requests
4684 into smaller groups of names.");
4686 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4688 "lgetxattr on multiple files",
4690 This call allows you to get the extended attributes
4691 of multiple files, where all files are in the directory C<path>.
4692 C<names> is the list of files from this directory.
4694 On return you get a flat list of xattr structs which must be
4695 interpreted sequentially. The first xattr struct always has a zero-length
4696 C<attrname>. C<attrval> in this struct is zero-length
4697 to indicate there was an error doing C<lgetxattr> for this
4698 file, I<or> is a C string which is a decimal number
4699 (the number of following attributes for this file, which could
4700 be C<\"0\">). Then after the first xattr struct are the
4701 zero or more attributes for the first named file.
4702 This repeats for the second and subsequent files.
4704 This call is intended for programs that want to efficiently
4705 list a directory contents without making many round-trips.
4706 See also C<guestfs_lstatlist> for a similarly efficient call
4707 for getting standard stats. Very long directory listings
4708 might cause the protocol message size to be exceeded, causing
4709 this call to fail. The caller must split up such requests
4710 into smaller groups of names.");
4712 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4714 "readlink on multiple files",
4716 This call allows you to do a C<readlink> operation
4717 on multiple files, where all files are in the directory C<path>.
4718 C<names> is the list of files from this directory.
4720 On return you get a list of strings, with a one-to-one
4721 correspondence to the C<names> list. Each string is the
4722 value of the symbolic link.
4724 If the C<readlink(2)> operation fails on any name, then
4725 the corresponding result string is the empty string C<\"\">.
4726 However the whole operation is completed even if there
4727 were C<readlink(2)> errors, and so you can call this
4728 function with names where you don't know if they are
4729 symbolic links already (albeit slightly less efficient).
4731 This call is intended for programs that want to efficiently
4732 list a directory contents without making many round-trips.
4733 Very long directory listings might cause the protocol
4734 message size to be exceeded, causing
4735 this call to fail. The caller must split up such requests
4736 into smaller groups of names.");
4738 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4739 [InitISOFS, Always, TestOutputBuffer (
4740 [["pread"; "/known-4"; "1"; "3"]], "\n");
4741 InitISOFS, Always, TestOutputBuffer (
4742 [["pread"; "/empty"; "0"; "100"]], "")],
4743 "read part of a file",
4745 This command lets you read part of a file. It reads C<count>
4746 bytes of the file, starting at C<offset>, from file C<path>.
4748 This may read fewer bytes than requested. For further details
4749 see the L<pread(2)> system call.
4751 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4753 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4754 [InitEmpty, Always, TestRun (
4755 [["part_init"; "/dev/sda"; "gpt"]])],
4756 "create an empty partition table",
4758 This creates an empty partition table on C<device> of one of the
4759 partition types listed below. Usually C<parttype> should be
4760 either C<msdos> or C<gpt> (for large disks).
4762 Initially there are no partitions. Following this, you should
4763 call C<guestfs_part_add> for each partition required.
4765 Possible values for C<parttype> are:
4769 =item B<efi> | B<gpt>
4771 Intel EFI / GPT partition table.
4773 This is recommended for >= 2 TB partitions that will be accessed
4774 from Linux and Intel-based Mac OS X. It also has limited backwards
4775 compatibility with the C<mbr> format.
4777 =item B<mbr> | B<msdos>
4779 The standard PC \"Master Boot Record\" (MBR) format used
4780 by MS-DOS and Windows. This partition type will B<only> work
4781 for device sizes up to 2 TB. For large disks we recommend
4786 Other partition table types that may work but are not
4795 =item B<amiga> | B<rdb>
4797 Amiga \"Rigid Disk Block\" format.
4805 DASD, used on IBM mainframes.
4813 Old Mac partition format. Modern Macs use C<gpt>.
4817 NEC PC-98 format, common in Japan apparently.
4825 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4826 [InitEmpty, Always, TestRun (
4827 [["part_init"; "/dev/sda"; "mbr"];
4828 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4829 InitEmpty, Always, TestRun (
4830 [["part_init"; "/dev/sda"; "gpt"];
4831 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4832 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4833 InitEmpty, Always, TestRun (
4834 [["part_init"; "/dev/sda"; "mbr"];
4835 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4836 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4837 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4838 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4839 "add a partition to the device",
4841 This command adds a partition to C<device>. If there is no partition
4842 table on the device, call C<guestfs_part_init> first.
4844 The C<prlogex> parameter is the type of partition. Normally you
4845 should pass C<p> or C<primary> here, but MBR partition tables also
4846 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4849 C<startsect> and C<endsect> are the start and end of the partition
4850 in I<sectors>. C<endsect> may be negative, which means it counts
4851 backwards from the end of the disk (C<-1> is the last sector).
4853 Creating a partition which covers the whole disk is not so easy.
4854 Use C<guestfs_part_disk> to do that.");
4856 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4857 [InitEmpty, Always, TestRun (
4858 [["part_disk"; "/dev/sda"; "mbr"]]);
4859 InitEmpty, Always, TestRun (
4860 [["part_disk"; "/dev/sda"; "gpt"]])],
4861 "partition whole disk with a single primary partition",
4863 This command is simply a combination of C<guestfs_part_init>
4864 followed by C<guestfs_part_add> to create a single primary partition
4865 covering the whole disk.
4867 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4868 but other possible values are described in C<guestfs_part_init>.");
4870 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4871 [InitEmpty, Always, TestRun (
4872 [["part_disk"; "/dev/sda"; "mbr"];
4873 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4874 "make a partition bootable",
4876 This sets the bootable flag on partition numbered C<partnum> on
4877 device C<device>. Note that partitions are numbered from 1.
4879 The bootable flag is used by some operating systems (notably
4880 Windows) to determine which partition to boot from. It is by
4881 no means universally recognized.");
4883 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4884 [InitEmpty, Always, TestRun (
4885 [["part_disk"; "/dev/sda"; "gpt"];
4886 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4887 "set partition name",
4889 This sets the partition name on partition numbered C<partnum> on
4890 device C<device>. Note that partitions are numbered from 1.
4892 The partition name can only be set on certain types of partition
4893 table. This works on C<gpt> but not on C<mbr> partitions.");
4895 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4896 [], (* XXX Add a regression test for this. *)
4897 "list partitions on a device",
4899 This command parses the partition table on C<device> and
4900 returns the list of partitions found.
4902 The fields in the returned structure are:
4908 Partition number, counting from 1.
4912 Start of the partition I<in bytes>. To get sectors you have to
4913 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4917 End of the partition in bytes.
4921 Size of the partition in bytes.
4925 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4926 [InitEmpty, Always, TestOutput (
4927 [["part_disk"; "/dev/sda"; "gpt"];
4928 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4929 "get the partition table type",
4931 This command examines the partition table on C<device> and
4932 returns the partition table type (format) being used.
4934 Common return values include: C<msdos> (a DOS/Windows style MBR
4935 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4936 values are possible, although unusual. See C<guestfs_part_init>
4939 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4940 [InitScratchFS, Always, TestOutputBuffer (
4941 [["fill"; "0x63"; "10"; "/fill"];
4942 ["read_file"; "/fill"]], "cccccccccc")],
4943 "fill a file with octets",
4945 This command creates a new file called C<path>. The initial
4946 content of the file is C<len> octets of C<c>, where C<c>
4947 must be a number in the range C<[0..255]>.
4949 To fill a file with zero bytes (sparsely), it is
4950 much more efficient to use C<guestfs_truncate_size>.
4951 To create a file with a pattern of repeating bytes
4952 use C<guestfs_fill_pattern>.");
4954 ("available", (RErr, [StringList "groups"], []), 216, [],
4955 [InitNone, Always, TestRun [["available"; ""]]],
4956 "test availability of some parts of the API",
4958 This command is used to check the availability of some
4959 groups of functionality in the appliance, which not all builds of
4960 the libguestfs appliance will be able to provide.
4962 The libguestfs groups, and the functions that those
4963 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4964 You can also fetch this list at runtime by calling
4965 C<guestfs_available_all_groups>.
4967 The argument C<groups> is a list of group names, eg:
4968 C<[\"inotify\", \"augeas\"]> would check for the availability of
4969 the Linux inotify functions and Augeas (configuration file
4972 The command returns no error if I<all> requested groups are available.
4974 It fails with an error if one or more of the requested
4975 groups is unavailable in the appliance.
4977 If an unknown group name is included in the
4978 list of groups then an error is always returned.
4986 You must call C<guestfs_launch> before calling this function.
4988 The reason is because we don't know what groups are
4989 supported by the appliance/daemon until it is running and can
4994 If a group of functions is available, this does not necessarily
4995 mean that they will work. You still have to check for errors
4996 when calling individual API functions even if they are
5001 It is usually the job of distro packagers to build
5002 complete functionality into the libguestfs appliance.
5003 Upstream libguestfs, if built from source with all
5004 requirements satisfied, will support everything.
5008 This call was added in version C<1.0.80>. In previous
5009 versions of libguestfs all you could do would be to speculatively
5010 execute a command to find out if the daemon implemented it.
5011 See also C<guestfs_version>.
5015 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5016 [InitScratchFS, Always, TestOutputBuffer (
5018 ["write"; "/dd/src"; "hello, world"];
5019 ["dd"; "/dd/src"; "/dd/dest"];
5020 ["read_file"; "/dd/dest"]], "hello, world")],
5021 "copy from source to destination using dd",
5023 This command copies from one source device or file C<src>
5024 to another destination device or file C<dest>. Normally you
5025 would use this to copy to or from a device or partition, for
5026 example to duplicate a filesystem.
5028 If the destination is a device, it must be as large or larger
5029 than the source file or device, otherwise the copy will fail.
5030 This command cannot do partial copies (see C<guestfs_copy_size>).");
5032 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5033 [InitScratchFS, Always, TestOutputInt (
5034 [["write"; "/filesize"; "hello, world"];
5035 ["filesize"; "/filesize"]], 12)],
5036 "return the size of the file in bytes",
5038 This command returns the size of C<file> in bytes.
5040 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5041 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5042 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5044 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5045 [InitBasicFSonLVM, Always, TestOutputList (
5046 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5047 ["lvs"]], ["/dev/VG/LV2"])],
5048 "rename an LVM logical volume",
5050 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5052 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5053 [InitBasicFSonLVM, Always, TestOutputList (
5055 ["vg_activate"; "false"; "VG"];
5056 ["vgrename"; "VG"; "VG2"];
5057 ["vg_activate"; "true"; "VG2"];
5058 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5059 ["vgs"]], ["VG2"])],
5060 "rename an LVM volume group",
5062 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5064 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5065 [InitISOFS, Always, TestOutputBuffer (
5066 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5067 "list the contents of a single file in an initrd",
5069 This command unpacks the file C<filename> from the initrd file
5070 called C<initrdpath>. The filename must be given I<without> the
5071 initial C</> character.
5073 For example, in guestfish you could use the following command
5074 to examine the boot script (usually called C</init>)
5075 contained in a Linux initrd or initramfs image:
5077 initrd-cat /boot/initrd-<version>.img init
5079 See also C<guestfs_initrd_list>.");
5081 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5083 "get the UUID of a physical volume",
5085 This command returns the UUID of the LVM PV C<device>.");
5087 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5089 "get the UUID of a volume group",
5091 This command returns the UUID of the LVM VG named C<vgname>.");
5093 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5095 "get the UUID of a logical volume",
5097 This command returns the UUID of the LVM LV C<device>.");
5099 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5101 "get the PV UUIDs containing the volume group",
5103 Given a VG called C<vgname>, this returns the UUIDs of all
5104 the physical volumes that this volume group resides on.
5106 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5107 calls to associate physical volumes and volume groups.
5109 See also C<guestfs_vglvuuids>.");
5111 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5113 "get the LV UUIDs of all LVs in the volume group",
5115 Given a VG called C<vgname>, this returns the UUIDs of all
5116 the logical volumes created in this volume group.
5118 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5119 calls to associate logical volumes and volume groups.
5121 See also C<guestfs_vgpvuuids>.");
5123 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5124 [InitScratchFS, Always, TestOutputBuffer (
5125 [["mkdir"; "/copy_size"];
5126 ["write"; "/copy_size/src"; "hello, world"];
5127 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5128 ["read_file"; "/copy_size/dest"]], "hello")],
5129 "copy size bytes from source to destination using dd",
5131 This command copies exactly C<size> bytes from one source device
5132 or file C<src> to another destination device or file C<dest>.
5134 Note this will fail if the source is too short or if the destination
5135 is not large enough.");
5137 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5138 [InitBasicFSonLVM, Always, TestRun (
5139 [["zero_device"; "/dev/VG/LV"]])],
5140 "write zeroes to an entire device",
5142 This command writes zeroes over the entire C<device>. Compare
5143 with C<guestfs_zero> which just zeroes the first few blocks of
5146 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5147 [InitScratchFS, Always, TestOutput (
5148 [["mkdir"; "/txz_in"];
5149 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5150 ["cat"; "/txz_in/hello"]], "hello\n")],
5151 "unpack compressed tarball to directory",
5153 This command uploads and unpacks local file C<tarball> (an
5154 I<xz compressed> tar file) into C<directory>.");
5156 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5158 "pack directory into compressed tarball",
5160 This command packs the contents of C<directory> and downloads
5161 it to local file C<tarball> (as an xz compressed tar archive).");
5163 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5165 "resize an NTFS filesystem",
5167 This command resizes an NTFS filesystem, expanding or
5168 shrinking it to the size of the underlying device.
5169 See also L<ntfsresize(8)>.");
5171 ("vgscan", (RErr, [], []), 232, [],
5172 [InitEmpty, Always, TestRun (
5174 "rescan for LVM physical volumes, volume groups and logical volumes",
5176 This rescans all block devices and rebuilds the list of LVM
5177 physical volumes, volume groups and logical volumes.");
5179 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5180 [InitEmpty, Always, TestRun (
5181 [["part_init"; "/dev/sda"; "mbr"];
5182 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5183 ["part_del"; "/dev/sda"; "1"]])],
5184 "delete a partition",
5186 This command deletes the partition numbered C<partnum> on C<device>.
5188 Note that in the case of MBR partitioning, deleting an
5189 extended partition also deletes any logical partitions
5192 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5193 [InitEmpty, Always, TestOutputTrue (
5194 [["part_init"; "/dev/sda"; "mbr"];
5195 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5196 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5197 ["part_get_bootable"; "/dev/sda"; "1"]])],
5198 "return true if a partition is bootable",
5200 This command returns true if the partition C<partnum> on
5201 C<device> has the bootable flag set.
5203 See also C<guestfs_part_set_bootable>.");
5205 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5206 [InitEmpty, Always, TestOutputInt (
5207 [["part_init"; "/dev/sda"; "mbr"];
5208 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5209 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5210 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5211 "get the MBR type byte (ID byte) from a partition",
5213 Returns the MBR type byte (also known as the ID byte) from
5214 the numbered partition C<partnum>.
5216 Note that only MBR (old DOS-style) partitions have type bytes.
5217 You will get undefined results for other partition table
5218 types (see C<guestfs_part_get_parttype>).");
5220 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5221 [], (* tested by part_get_mbr_id *)
5222 "set the MBR type byte (ID byte) of a partition",
5224 Sets the MBR type byte (also known as the ID byte) of
5225 the numbered partition C<partnum> to C<idbyte>. Note
5226 that the type bytes quoted in most documentation are
5227 in fact hexadecimal numbers, but usually documented
5228 without any leading \"0x\" which might be confusing.
5230 Note that only MBR (old DOS-style) partitions have type bytes.
5231 You will get undefined results for other partition table
5232 types (see C<guestfs_part_get_parttype>).");
5234 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5235 [InitISOFS, Always, TestOutputFileMD5 (
5236 [["checksum_device"; "md5"; "/dev/sdd"]],
5237 "../images/test.iso")],
5238 "compute MD5, SHAx or CRC checksum of the contents of a device",
5240 This call computes the MD5, SHAx or CRC checksum of the
5241 contents of the device named C<device>. For the types of
5242 checksums supported see the C<guestfs_checksum> command.");
5244 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5245 [InitNone, Always, TestRun (
5246 [["part_disk"; "/dev/sda"; "mbr"];
5247 ["pvcreate"; "/dev/sda1"];
5248 ["vgcreate"; "VG"; "/dev/sda1"];
5249 ["lvcreate"; "LV"; "VG"; "10"];
5250 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5251 "expand an LV to fill free space",
5253 This expands an existing logical volume C<lv> so that it fills
5254 C<pc>% of the remaining free space in the volume group. Commonly
5255 you would call this with pc = 100 which expands the logical volume
5256 as much as possible, using all remaining free space in the volume
5259 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5260 [], (* XXX Augeas code needs tests. *)
5261 "clear Augeas path",
5263 Set the value associated with C<path> to C<NULL>. This
5264 is the same as the L<augtool(1)> C<clear> command.");
5266 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5267 [InitEmpty, Always, TestOutputInt (
5268 [["get_umask"]], 0o22)],
5269 "get the current umask",
5271 Return the current umask. By default the umask is C<022>
5272 unless it has been set by calling C<guestfs_umask>.");
5274 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5276 "upload a file to the appliance (internal use only)",
5278 The C<guestfs_debug_upload> command uploads a file to
5279 the libguestfs appliance.
5281 There is no comprehensive help for this command. You have
5282 to look at the file C<daemon/debug.c> in the libguestfs source
5283 to find out what it is for.");
5285 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5286 [InitScratchFS, Always, TestOutput (
5287 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5288 ["cat"; "/base64_in"]], "hello\n")],
5289 "upload base64-encoded data to file",
5291 This command uploads base64-encoded data from C<base64file>
5294 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5296 "download file and encode as base64",
5298 This command downloads the contents of C<filename>, writing
5299 it out to local file C<base64file> encoded as base64.");
5301 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5303 "compute MD5, SHAx or CRC checksum of files in a directory",
5305 This command computes the checksums of all regular files in
5306 C<directory> and then emits a list of those checksums to
5307 the local output file C<sumsfile>.
5309 This can be used for verifying the integrity of a virtual
5310 machine. However to be properly secure you should pay
5311 attention to the output of the checksum command (it uses
5312 the ones from GNU coreutils). In particular when the
5313 filename is not printable, coreutils uses a special
5314 backslash syntax. For more information, see the GNU
5315 coreutils info file.");
5317 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5318 [InitScratchFS, Always, TestOutputBuffer (
5319 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5320 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5321 "fill a file with a repeating pattern of bytes",
5323 This function is like C<guestfs_fill> except that it creates
5324 a new file of length C<len> containing the repeating pattern
5325 of bytes in C<pattern>. The pattern is truncated if necessary
5326 to ensure the length of the file is exactly C<len> bytes.");
5328 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5329 [InitScratchFS, Always, TestOutput (
5330 [["write"; "/write"; "new file contents"];
5331 ["cat"; "/write"]], "new file contents");
5332 InitScratchFS, Always, TestOutput (
5333 [["write"; "/write2"; "\nnew file contents\n"];
5334 ["cat"; "/write2"]], "\nnew file contents\n");
5335 InitScratchFS, Always, TestOutput (
5336 [["write"; "/write3"; "\n\n"];
5337 ["cat"; "/write3"]], "\n\n");
5338 InitScratchFS, Always, TestOutput (
5339 [["write"; "/write4"; ""];
5340 ["cat"; "/write4"]], "");
5341 InitScratchFS, Always, TestOutput (
5342 [["write"; "/write5"; "\n\n\n"];
5343 ["cat"; "/write5"]], "\n\n\n");
5344 InitScratchFS, Always, TestOutput (
5345 [["write"; "/write6"; "\n"];
5346 ["cat"; "/write6"]], "\n")],
5347 "create a new file",
5349 This call creates a file called C<path>. The content of the
5350 file is the string C<content> (which can contain any 8 bit data).");
5352 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5353 [InitScratchFS, Always, TestOutput (
5354 [["write"; "/pwrite"; "new file contents"];
5355 ["pwrite"; "/pwrite"; "data"; "4"];
5356 ["cat"; "/pwrite"]], "new data contents");
5357 InitScratchFS, Always, TestOutput (
5358 [["write"; "/pwrite2"; "new file contents"];
5359 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5360 ["cat"; "/pwrite2"]], "new file is extended");
5361 InitScratchFS, Always, TestOutput (
5362 [["write"; "/pwrite3"; "new file contents"];
5363 ["pwrite"; "/pwrite3"; ""; "4"];
5364 ["cat"; "/pwrite3"]], "new file contents")],
5365 "write to part of a file",
5367 This command writes to part of a file. It writes the data
5368 buffer C<content> to the file C<path> starting at offset C<offset>.
5370 This command implements the L<pwrite(2)> system call, and like
5371 that system call it may not write the full data requested. The
5372 return value is the number of bytes that were actually written
5373 to the file. This could even be 0, although short writes are
5374 unlikely for regular files in ordinary circumstances.
5376 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5378 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5380 "resize an ext2, ext3 or ext4 filesystem (with size)",
5382 This command is the same as C<guestfs_resize2fs> except that it
5383 allows you to specify the new size (in bytes) explicitly.");
5385 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5387 "resize an LVM physical volume (with size)",
5389 This command is the same as C<guestfs_pvresize> except that it
5390 allows you to specify the new size (in bytes) explicitly.");
5392 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5394 "resize an NTFS filesystem (with size)",
5396 This command is the same as C<guestfs_ntfsresize> except that it
5397 allows you to specify the new size (in bytes) explicitly.");
5399 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5400 [InitNone, Always, TestRun [["available_all_groups"]]],
5401 "return a list of all optional groups",
5403 This command returns a list of all optional groups that this
5404 daemon knows about. Note this returns both supported and unsupported
5405 groups. To find out which ones the daemon can actually support
5406 you have to call C<guestfs_available> on each member of the
5409 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5411 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5412 [InitScratchFS, Always, TestOutputStruct (
5413 [["fallocate64"; "/fallocate64"; "1000000"];
5414 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5415 "preallocate a file in the guest filesystem",
5417 This command preallocates a file (containing zero bytes) named
5418 C<path> of size C<len> bytes. If the file exists already, it
5421 Note that this call allocates disk blocks for the file.
5422 To create a sparse file use C<guestfs_truncate_size> instead.
5424 The deprecated call C<guestfs_fallocate> does the same,
5425 but owing to an oversight it only allowed 30 bit lengths
5426 to be specified, effectively limiting the maximum size
5427 of files created through that call to 1GB.
5429 Do not confuse this with the guestfish-specific
5430 C<alloc> and C<sparse> commands which create
5431 a file in the host and attach it as a device.");
5433 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5434 [InitBasicFS, Always, TestOutput (
5435 [["set_e2label"; "/dev/sda1"; "LTEST"];
5436 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5437 "get the filesystem label",
5439 This returns the filesystem label of the filesystem on
5442 If the filesystem is unlabeled, this returns the empty string.
5444 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5446 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5447 (let uuid = uuidgen () in
5448 [InitBasicFS, Always, TestOutput (
5449 [["set_e2uuid"; "/dev/sda1"; uuid];
5450 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5451 "get the filesystem UUID",
5453 This returns the filesystem UUID of the filesystem on
5456 If the filesystem does not have a UUID, this returns the empty string.
5458 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5460 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5461 (* Can't be tested with the current framework because
5462 * the VG is being used by the mounted filesystem, so
5463 * the vgchange -an command we do first will fail.
5466 "set LVM device filter",
5468 This sets the LVM device filter so that LVM will only be
5469 able to \"see\" the block devices in the list C<devices>,
5470 and will ignore all other attached block devices.
5472 Where disk image(s) contain duplicate PVs or VGs, this
5473 command is useful to get LVM to ignore the duplicates, otherwise
5474 LVM can get confused. Note also there are two types
5475 of duplication possible: either cloned PVs/VGs which have
5476 identical UUIDs; or VGs that are not cloned but just happen
5477 to have the same name. In normal operation you cannot
5478 create this situation, but you can do it outside LVM, eg.
5479 by cloning disk images or by bit twiddling inside the LVM
5482 This command also clears the LVM cache and performs a volume
5485 You can filter whole block devices or individual partitions.
5487 You cannot use this if any VG is currently in use (eg.
5488 contains a mounted filesystem), even if you are not
5489 filtering out that VG.");
5491 ("lvm_clear_filter", (RErr, [], []), 256, [],
5492 [], (* see note on lvm_set_filter *)
5493 "clear LVM device filter",
5495 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5496 will be able to see every block device.
5498 This command also clears the LVM cache and performs a volume
5501 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5503 "open a LUKS-encrypted block device",
5505 This command opens a block device which has been encrypted
5506 according to the Linux Unified Key Setup (LUKS) standard.
5508 C<device> is the encrypted block device or partition.
5510 The caller must supply one of the keys associated with the
5511 LUKS block device, in the C<key> parameter.
5513 This creates a new block device called C</dev/mapper/mapname>.
5514 Reads and writes to this block device are decrypted from and
5515 encrypted to the underlying C<device> respectively.
5517 If this block device contains LVM volume groups, then
5518 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5519 will make them visible.");
5521 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5523 "open a LUKS-encrypted block device read-only",
5525 This is the same as C<guestfs_luks_open> except that a read-only
5526 mapping is created.");
5528 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5530 "close a LUKS device",
5532 This closes a LUKS device that was created earlier by
5533 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5534 C<device> parameter must be the name of the LUKS mapping
5535 device (ie. C</dev/mapper/mapname>) and I<not> the name
5536 of the underlying block device.");
5538 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5540 "format a block device as a LUKS encrypted device",
5542 This command erases existing data on C<device> and formats
5543 the device as a LUKS encrypted device. C<key> is the
5544 initial key, which is added to key slot C<slot>. (LUKS
5545 supports 8 key slots, numbered 0-7).");
5547 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5549 "format a block device as a LUKS encrypted device",
5551 This command is the same as C<guestfs_luks_format> but
5552 it also allows you to set the C<cipher> used.");
5554 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5556 "add a key on a LUKS encrypted device",
5558 This command adds a new key on LUKS device C<device>.
5559 C<key> is any existing key, and is used to access the device.
5560 C<newkey> is the new key to add. C<keyslot> is the key slot
5561 that will be replaced.
5563 Note that if C<keyslot> already contains a key, then this
5564 command will fail. You have to use C<guestfs_luks_kill_slot>
5565 first to remove that key.");
5567 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5569 "remove a key from a LUKS encrypted device",
5571 This command deletes the key in key slot C<keyslot> from the
5572 encrypted LUKS device C<device>. C<key> must be one of the
5575 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5576 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5577 [["is_lv"; "/dev/VG/LV"]]);
5578 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5579 [["is_lv"; "/dev/sda1"]])],
5580 "test if device is a logical volume",
5582 This command tests whether C<device> is a logical volume, and
5583 returns true iff this is the case.");
5585 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5587 "find a filesystem by UUID",
5589 This command searches the filesystems and returns the one
5590 which has the given UUID. An error is returned if no such
5591 filesystem can be found.
5593 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5595 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5597 "find a filesystem by label",
5599 This command searches the filesystems and returns the one
5600 which has the given label. An error is returned if no such
5601 filesystem can be found.
5603 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5605 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5606 [InitISOFS, Always, TestOutputFalse (
5607 [["is_chardev"; "/directory"]]);
5608 InitScratchFS, Always, TestOutputTrue (
5609 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5610 ["is_chardev"; "/is_chardev"]])],
5611 "test if character device",
5613 This returns C<true> if and only if there is a character device
5614 with the given C<path> name.
5616 See also C<guestfs_stat>.");
5618 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5619 [InitISOFS, Always, TestOutputFalse (
5620 [["is_blockdev"; "/directory"]]);
5621 InitScratchFS, Always, TestOutputTrue (
5622 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5623 ["is_blockdev"; "/is_blockdev"]])],
5624 "test if block device",
5626 This returns C<true> if and only if there is a block device
5627 with the given C<path> name.
5629 See also C<guestfs_stat>.");
5631 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5632 [InitISOFS, Always, TestOutputFalse (
5633 [["is_fifo"; "/directory"]]);
5634 InitScratchFS, Always, TestOutputTrue (
5635 [["mkfifo"; "0o777"; "/is_fifo"];
5636 ["is_fifo"; "/is_fifo"]])],
5637 "test if FIFO (named pipe)",
5639 This returns C<true> if and only if there is a FIFO (named pipe)
5640 with the given C<path> name.
5642 See also C<guestfs_stat>.");
5644 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5645 [InitISOFS, Always, TestOutputFalse (
5646 [["is_symlink"; "/directory"]]);
5647 InitISOFS, Always, TestOutputTrue (
5648 [["is_symlink"; "/abssymlink"]])],
5649 "test if symbolic link",
5651 This returns C<true> if and only if there is a symbolic link
5652 with the given C<path> name.
5654 See also C<guestfs_stat>.");
5656 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5657 (* XXX Need a positive test for sockets. *)
5658 [InitISOFS, Always, TestOutputFalse (
5659 [["is_socket"; "/directory"]])],
5662 This returns C<true> if and only if there is a Unix domain socket
5663 with the given C<path> name.
5665 See also C<guestfs_stat>.");
5667 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5668 [InitPartition, Always, TestOutputDevice (
5669 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5670 InitEmpty, Always, TestLastFail (
5671 [["part_to_dev"; "/dev/sda"]])],
5672 "convert partition name to device name",
5674 This function takes a partition name (eg. \"/dev/sdb1\") and
5675 removes the partition number, returning the device name
5678 The named partition must exist, for example as a string returned
5679 from C<guestfs_list_partitions>.");
5681 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5682 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5683 [InitScratchFS, Always, TestOutput (
5684 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5685 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5686 "upload a file from the local machine with offset",
5688 Upload local file C<filename> to C<remotefilename> on the
5691 C<remotefilename> is overwritten starting at the byte C<offset>
5692 specified. The intention is to overwrite parts of existing
5693 files or devices, although if a non-existant file is specified
5694 then it is created with a \"hole\" before C<offset>. The
5695 size of the data written is implicit in the size of the
5698 Note that there is no limit on the amount of data that
5699 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5700 and this call always writes the full amount unless an
5703 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5705 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5706 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5707 let offset = string_of_int 100 in
5708 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5709 [InitScratchFS, Always, TestOutput (
5710 (* Pick a file from cwd which isn't likely to change. *)
5711 [["mkdir"; "/download_offset"];
5712 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5713 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5714 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5715 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5716 "download a file to the local machine with offset and size",
5718 Download file C<remotefilename> and save it as C<filename>
5719 on the local machine.
5721 C<remotefilename> is read for C<size> bytes starting at C<offset>
5722 (this region must be within the file or device).
5724 Note that there is no limit on the amount of data that
5725 can be downloaded with this call, unlike with C<guestfs_pread>,
5726 and this call always reads the full amount unless an
5729 See also C<guestfs_download>, C<guestfs_pread>.");
5731 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5732 [InitPartition, Always, TestOutputListOfDevices (
5733 [["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"];
5734 ["blockdev_rereadpt"; "/dev/sda"];
5735 ["list_partitions"]], ["/dev/sdb1"])],
5736 "write to part of a device",
5738 This command writes to part of a device. It writes the data
5739 buffer C<content> to C<device> starting at offset C<offset>.
5741 This command implements the L<pwrite(2)> system call, and like
5742 that system call it may not write the full data requested
5743 (although short writes to disk devices and partitions are
5744 probably impossible with standard Linux kernels).
5746 See also C<guestfs_pwrite>.");
5748 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5749 [InitEmpty, Always, TestOutputBuffer (
5750 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5751 "read part of a device",
5753 This command lets you read part of a file. It reads C<count>
5754 bytes of C<device>, starting at C<offset>.
5756 This may read fewer bytes than requested. For further details
5757 see the L<pread(2)> system call.
5759 See also C<guestfs_pread>.");
5761 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5762 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5763 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5764 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5765 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5766 "get canonical name of an LV",
5768 This converts alternative naming schemes for LVs that you
5769 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5770 is converted to C</dev/VG/LV>.
5772 This command returns an error if the C<lvname> parameter does
5773 not refer to a logical volume.
5775 See also C<guestfs_is_lv>.");
5777 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5778 [InitEmpty, Always, TestOutput (
5779 [["part_disk"; "/dev/sda"; "mbr"];
5780 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5781 ["mount_options"; ""; "/dev/sda1"; "/"];
5782 ["write"; "/new"; "new file contents"];
5783 ["cat"; "/new"]], "new file contents")],
5784 "make a filesystem",
5786 This function creates a filesystem on C<device>. The filesystem
5787 type is C<fstype>, for example C<ext3>.
5789 The optional arguments are:
5795 The filesystem block size. Supported block sizes depend on the
5796 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5797 for Linux ext2/3 filesystems.
5799 For VFAT and NTFS the C<blocksize> parameter is treated as
5800 the requested cluster size.
5802 For UFS block sizes, please see L<mkfs.ufs(8)>.
5806 This passes the I<-O> parameter to the external mkfs program.
5808 For certain filesystem types, this allows extra filesystem
5809 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5812 You cannot use this optional parameter with the C<gfs> or
5813 C<gfs2> filesystem type.
5817 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5819 "get a single extended attribute",
5821 Get a single extended attribute from file C<path> named C<name>.
5822 This call follows symlinks. If you want to lookup an extended
5823 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5825 Normally it is better to get all extended attributes from a file
5826 in one go by calling C<guestfs_getxattrs>. However some Linux
5827 filesystem implementations are buggy and do not provide a way to
5828 list out attributes. For these filesystems (notably ntfs-3g)
5829 you have to know the names of the extended attributes you want
5830 in advance and call this function.
5832 Extended attribute values are blobs of binary data. If there
5833 is no extended attribute named C<name>, this returns an error.
5835 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5837 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5839 "get a single extended attribute",
5841 Get a single extended attribute from file C<path> named C<name>.
5842 If C<path> is a symlink, then this call returns an extended
5843 attribute from the symlink.
5845 Normally it is better to get all extended attributes from a file
5846 in one go by calling C<guestfs_getxattrs>. However some Linux
5847 filesystem implementations are buggy and do not provide a way to
5848 list out attributes. For these filesystems (notably ntfs-3g)
5849 you have to know the names of the extended attributes you want
5850 in advance and call this function.
5852 Extended attribute values are blobs of binary data. If there
5853 is no extended attribute named C<name>, this returns an error.
5855 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5857 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5859 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5861 This command is the same as C<guestfs_resize2fs>, but the filesystem
5862 is resized to its minimum size. This works like the I<-M> option
5863 to the C<resize2fs> command.
5865 To get the resulting size of the filesystem you should call
5866 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5867 values. These two numbers, multiplied together, give the
5868 resulting size of the minimal filesystem in bytes.");
5870 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5872 "internal autosync operation",
5874 This command performs the autosync operation just before the
5875 handle is closed. You should not call this command directly.
5876 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5877 control whether or not this operation is performed when the
5878 handle is closed.");
5880 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
5881 [InitISOFS, Always, TestOutputTrue (
5882 [["is_zero"; "/100kallzeroes"]]);
5883 InitISOFS, Always, TestOutputFalse (
5884 [["is_zero"; "/100kallspaces"]])],
5885 "test if a file contains all zero bytes",
5887 This returns true iff the file exists and the file is empty or
5888 it contains all zero bytes.");
5890 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
5891 [InitBasicFS, Always, TestOutputTrue (
5892 [["umount"; "/dev/sda1"];
5893 ["zero_device"; "/dev/sda1"];
5894 ["is_zero_device"; "/dev/sda1"]]);
5895 InitBasicFS, Always, TestOutputFalse (
5896 [["is_zero_device"; "/dev/sda1"]])],
5897 "test if a device contains all zero bytes",
5899 This returns true iff the device exists and contains all zero bytes.
5901 Note that for large devices this can take a long time to run.");
5903 ("list_9p", (RStringList "mounttags", [], []), 285, [],
5905 "list 9p filesystems",
5907 List all 9p filesystems attached to the guest. A list of
5908 mount tags is returned.");
5910 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
5912 "mount 9p filesystem",
5914 Mount the virtio-9p filesystem with the tag C<mounttag> on the
5915 directory C<mountpoint>.
5917 If required, C<trans=virtio> will be automatically added to the options.
5918 Any other options required can be passed in the optional C<options>
5923 let all_functions = non_daemon_functions @ daemon_functions
5925 (* In some places we want the functions to be displayed sorted
5926 * alphabetically, so this is useful:
5928 let all_functions_sorted = List.sort action_compare all_functions
5930 (* This is used to generate the src/MAX_PROC_NR file which
5931 * contains the maximum procedure number, a surrogate for the
5932 * ABI version number. See src/Makefile.am for the details.
5935 let proc_nrs = List.map (
5936 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5937 ) daemon_functions in
5938 List.fold_left max 0 proc_nrs
5940 (* Non-API meta-commands available only in guestfish.
5942 * Note (1): style, proc_nr and tests fields are all meaningless.
5943 * The only fields which are actually used are the shortname,
5944 * FishAlias flags, shortdesc and longdesc.
5946 * Note (2): to refer to other commands, use L</shortname>.
5948 * Note (3): keep this list sorted by shortname.
5950 let fish_commands = [
5951 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5952 "allocate and add a disk file",
5953 " alloc filename size
5955 This creates an empty (zeroed) file of the given size, and then adds
5956 so it can be further examined.
5958 For more advanced image creation, see L<qemu-img(1)> utility.
5960 Size can be specified using standard suffixes, eg. C<1M>.
5962 To create a sparse file, use L</sparse> instead. To create a
5963 prepared disk image, see L</PREPARED DISK IMAGES>.");
5965 ("copy_in", (RErr,[], []), -1, [], [],
5966 "copy local files or directories into an image",
5967 " copy-in local [local ...] /remotedir
5969 C<copy-in> copies local files or directories recursively into the disk
5970 image, placing them in the directory called C</remotedir> (which must
5971 exist). This guestfish meta-command turns into a sequence of
5972 L</tar-in> and other commands as necessary.
5974 Multiple local files and directories can be specified, but the last
5975 parameter must always be a remote directory. Wildcards cannot be
5978 ("copy_out", (RErr,[], []), -1, [], [],
5979 "copy remote files or directories out of an image",
5980 " copy-out remote [remote ...] localdir
5982 C<copy-out> copies remote files or directories recursively out of the
5983 disk image, placing them on the host disk in a local directory called
5984 C<localdir> (which must exist). This guestfish meta-command turns
5985 into a sequence of L</download>, L</tar-out> and other commands as
5988 Multiple remote files and directories can be specified, but the last
5989 parameter must always be a local directory. To download to the
5990 current directory, use C<.> as in:
5994 Wildcards cannot be used in the ordinary command, but you can use
5995 them with the help of L</glob> like this:
5997 glob copy-out /home/* .");
5999 ("echo", (RErr,[], []), -1, [], [],
6000 "display a line of text",
6003 This echos the parameters to the terminal.");
6005 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6009 This is used to edit a file. It downloads the file, edits it
6010 locally using your editor, then uploads the result.
6012 The editor is C<$EDITOR>. However if you use the alternate
6013 commands C<vi> or C<emacs> you will get those corresponding
6016 ("glob", (RErr,[], []), -1, [], [],
6017 "expand wildcards in command",
6018 " glob command args...
6020 Expand wildcards in any paths in the args list, and run C<command>
6021 repeatedly on each matching path.
6023 See L</WILDCARDS AND GLOBBING>.");
6025 ("hexedit", (RErr,[], []), -1, [], [],
6026 "edit with a hex editor",
6027 " hexedit <filename|device>
6028 hexedit <filename|device> <max>
6029 hexedit <filename|device> <start> <max>
6031 Use hexedit (a hex editor) to edit all or part of a binary file
6034 This command works by downloading potentially the whole file or
6035 device, editing it locally, then uploading it. If the file or
6036 device is large, you have to specify which part you wish to edit
6037 by using C<max> and/or C<start> C<max> parameters.
6038 C<start> and C<max> are specified in bytes, with the usual
6039 modifiers allowed such as C<1M> (1 megabyte).
6041 For example to edit the first few sectors of a disk you
6046 which would allow you to edit anywhere within the first megabyte
6049 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6051 hexedit /dev/sda1 0x400 0x400
6053 (assuming the superblock is in the standard location).
6055 This command requires the external L<hexedit(1)> program. You
6056 can specify another program to use by setting the C<HEXEDITOR>
6057 environment variable.
6059 See also L</hexdump>.");
6061 ("lcd", (RErr,[], []), -1, [], [],
6062 "change working directory",
6065 Change the local directory, ie. the current directory of guestfish
6068 Note that C<!cd> won't do what you might expect.");
6070 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6074 Opens the manual page for guestfish.");
6076 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6082 This is used to view a file.
6084 The default viewer is C<$PAGER>. However if you use the alternate
6085 command C<less> you will get the C<less> command specifically.");
6087 ("reopen", (RErr,[], []), -1, [], [],
6088 "close and reopen libguestfs handle",
6091 Close and reopen the libguestfs handle. It is not necessary to use
6092 this normally, because the handle is closed properly when guestfish
6093 exits. However this is occasionally useful for testing.");
6095 ("sparse", (RErr,[], []), -1, [], [],
6096 "create a sparse disk image and add",
6097 " sparse filename size
6099 This creates an empty sparse file of the given size, and then adds
6100 so it can be further examined.
6102 In all respects it works the same as the L</alloc> command, except that
6103 the image file is allocated sparsely, which means that disk blocks are
6104 not assigned to the file until they are needed. Sparse disk files
6105 only use space when written to, but they are slower and there is a
6106 danger you could run out of real disk space during a write operation.
6108 For more advanced image creation, see L<qemu-img(1)> utility.
6110 Size can be specified using standard suffixes, eg. C<1M>.");
6112 ("supported", (RErr,[], []), -1, [], [],
6113 "list supported groups of commands",
6116 This command returns a list of the optional groups
6117 known to the daemon, and indicates which ones are
6118 supported by this build of the libguestfs appliance.
6120 See also L<guestfs(3)/AVAILABILITY>.");
6122 ("time", (RErr,[], []), -1, [], [],
6123 "print elapsed time taken to run a command",
6124 " time command args...
6126 Run the command as usual, but print the elapsed time afterwards. This
6127 can be useful for benchmarking operations.");