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\"
843 The distro could not be determined.
847 Windows does not have distributions. This string is
848 returned if the OS type is Windows.
852 Future versions of libguestfs may return other strings here.
853 The caller should be prepared to handle any string.
855 Please read L<guestfs(3)/INSPECTION> for more details.");
857 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
859 "get major version of inspected operating system",
861 This returns the major version number of the inspected operating
864 Windows uses a consistent versioning scheme which is I<not>
865 reflected in the popular public names used by the operating system.
866 Notably the operating system known as \"Windows 7\" is really
867 version 6.1 (ie. major = 6, minor = 1). You can find out the
868 real versions corresponding to releases of Windows by consulting
871 If the version could not be determined, then C<0> is returned.
873 Please read L<guestfs(3)/INSPECTION> for more details.");
875 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
877 "get minor version of inspected operating system",
879 This returns the minor version number of the inspected operating
882 If the version could not be determined, then C<0> is returned.
884 Please read L<guestfs(3)/INSPECTION> for more details.
885 See also C<guestfs_inspect_get_major_version>.");
887 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
889 "get product name of inspected operating system",
891 This returns the product name of the inspected operating
892 system. The product name is generally some freeform string
893 which can be displayed to the user, but should not be
896 If the product name could not be determined, then the
897 string C<unknown> is returned.
899 Please read L<guestfs(3)/INSPECTION> for more details.");
901 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
903 "get mountpoints of inspected operating system",
905 This returns a hash of where we think the filesystems
906 associated with this operating system should be mounted.
907 Callers should note that this is at best an educated guess
908 made by reading configuration files such as C</etc/fstab>.
909 I<In particular note> that this may return filesystems
910 which are non-existent or not mountable and callers should
911 be prepared to handle or ignore failures if they try to
914 Each element in the returned hashtable has a key which
915 is the path of the mountpoint (eg. C</boot>) and a value
916 which is the filesystem that would be mounted there
919 Non-mounted devices such as swap devices are I<not>
920 returned in this list.
922 For operating systems like Windows which still use drive
923 letters, this call will only return an entry for the first
924 drive \"mounted on\" C</>. For information about the
925 mapping of drive letters to partitions, see
926 C<guestfs_inspect_get_drive_mappings>.
928 Please read L<guestfs(3)/INSPECTION> for more details.
929 See also C<guestfs_inspect_get_filesystems>.");
931 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
933 "get filesystems associated with inspected operating system",
935 This returns a list of all the filesystems that we think
936 are associated with this operating system. This includes
937 the root filesystem, other ordinary filesystems, and
938 non-mounted devices like swap partitions.
940 In the case of a multi-boot virtual machine, it is possible
941 for a filesystem to be shared between operating systems.
943 Please read L<guestfs(3)/INSPECTION> for more details.
944 See also C<guestfs_inspect_get_mountpoints>.");
946 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
948 "set enable network flag",
950 If C<network> is true, then the network is enabled in the
951 libguestfs appliance. The default is false.
953 This affects whether commands are able to access the network
954 (see L<guestfs(3)/RUNNING COMMANDS>).
956 You must call this before calling C<guestfs_launch>, otherwise
959 ("get_network", (RBool "network", [], []), -1, [],
961 "get enable network flag",
963 This returns the enable network flag.");
965 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
969 This inspection command looks for filesystems on partitions,
970 block devices and logical volumes, returning a list of devices
971 containing filesystems and their type.
973 The return value is a hash, where the keys are the devices
974 containing filesystems, and the values are the filesystem types.
977 \"/dev/sda1\" => \"ntfs\"
978 \"/dev/sda2\" => \"ext2\"
979 \"/dev/vg_guest/lv_root\" => \"ext4\"
980 \"/dev/vg_guest/lv_swap\" => \"swap\"
982 The value can have the special value \"unknown\", meaning the
983 content of the device is undetermined or empty.
984 \"swap\" means a Linux swap partition.
986 This command runs other libguestfs commands, which might include
987 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
988 use this soon after launch and only when nothing is mounted.
990 Not all of the filesystems returned will be mountable. In
991 particular, swap partitions are returned in the list. Also
992 this command does not check that each filesystem
993 found is valid and mountable, and some filesystems might
994 be mountable but require special options. Filesystems may
995 not all belong to a single logical operating system
996 (use C<guestfs_inspect_os> to look for OSes).");
998 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
1000 "add an image to examine or modify",
1002 This function adds a virtual machine disk image C<filename> to
1003 libguestfs. The first time you call this function, the disk
1004 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1007 You don't necessarily need to be root when using libguestfs. However
1008 you obviously do need sufficient permissions to access the filename
1009 for whatever operations you want to perform (ie. read access if you
1010 just want to read the image or write access if you want to modify the
1013 This call checks that C<filename> exists.
1015 The optional arguments are:
1021 If true then the image is treated as read-only. Writes are still
1022 allowed, but they are stored in a temporary snapshot overlay which
1023 is discarded at the end. The disk that you add is not modified.
1027 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1028 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1029 Possible formats include C<raw> and C<qcow2>.
1031 Automatic detection of the format opens you up to a potential
1032 security hole when dealing with untrusted raw-format images.
1033 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1038 This rarely-used option lets you emulate the behaviour of the
1039 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1043 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1045 "get Windows systemroot of inspected operating system",
1047 This returns the Windows systemroot of the inspected guest.
1048 The systemroot is a directory path such as C</WINDOWS>.
1050 This call assumes that the guest is Windows and that the
1051 systemroot could be determined by inspection. If this is not
1052 the case then an error is returned.
1054 Please read L<guestfs(3)/INSPECTION> for more details.");
1056 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1058 "return list of operating systems found by last inspection",
1060 This function is a convenient way to get the list of root
1061 devices, as returned from a previous call to C<guestfs_inspect_os>,
1062 but without redoing the whole inspection process.
1064 This returns an empty list if either no root devices were
1065 found or the caller has not called C<guestfs_inspect_os>.
1067 Please read L<guestfs(3)/INSPECTION> for more details.");
1069 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1071 "debug the QEMU command line (internal use only)",
1073 This returns the internal QEMU command line. 'debug' commands are
1074 not part of the formal API and can be removed or changed at any time.");
1076 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1078 "add the disk(s) from a named libvirt domain",
1080 This function adds the disk(s) attached to the named libvirt
1081 domain C<dom>. It works by connecting to libvirt, requesting
1082 the domain and domain XML from libvirt, parsing it for disks,
1083 and calling C<guestfs_add_drive_opts> on each one.
1085 The number of disks added is returned. This operation is atomic:
1086 if an error is returned, then no disks are added.
1088 This function does some minimal checks to make sure the libvirt
1089 domain is not running (unless C<readonly> is true). In a future
1090 version we will try to acquire the libvirt lock on each disk.
1092 Disks must be accessible locally. This often means that adding disks
1093 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1094 will fail unless those disks are accessible via the same device path
1097 The optional C<libvirturi> parameter sets the libvirt URI
1098 (see L<http://libvirt.org/uri.html>). If this is not set then
1099 we connect to the default libvirt URI (or one set through an
1100 environment variable, see the libvirt documentation for full
1103 The optional C<live> flag controls whether this call will try
1104 to connect to a running virtual machine C<guestfsd> process if
1105 it sees a suitable E<lt>channelE<gt> element in the libvirt
1106 XML definition. The default (if the flag is omitted) is never
1107 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1110 If the C<allowuuid> flag is true (default is false) then a UUID
1111 I<may> be passed instead of the domain name. The C<dom> string is
1112 treated as a UUID first and looked up, and if that lookup fails
1113 then we treat C<dom> as a name as usual.
1115 The other optional parameters are passed directly through to
1116 C<guestfs_add_drive_opts>.");
1119 This interface is not quite baked yet. -- RWMJ 2010-11-11
1120 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1122 "add the disk(s) from a libvirt domain",
1124 This function adds the disk(s) attached to the libvirt domain C<dom>.
1125 It works by requesting the domain XML from libvirt, parsing it for
1126 disks, and calling C<guestfs_add_drive_opts> on each one.
1128 In the C API we declare C<void *dom>, but really it has type
1129 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1131 The number of disks added is returned. This operation is atomic:
1132 if an error is returned, then no disks are added.
1134 This function does some minimal checks to make sure the libvirt
1135 domain is not running (unless C<readonly> is true). In a future
1136 version we will try to acquire the libvirt lock on each disk.
1138 Disks must be accessible locally. This often means that adding disks
1139 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1140 will fail unless those disks are accessible via the same device path
1143 The optional C<live> flag controls whether this call will try
1144 to connect to a running virtual machine C<guestfsd> process if
1145 it sees a suitable E<lt>channelE<gt> element in the libvirt
1146 XML definition. The default (if the flag is omitted) is never
1147 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1150 The other optional parameters are passed directly through to
1151 C<guestfs_add_drive_opts>.");
1154 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1156 "get package format used by the operating system",
1158 This function and C<guestfs_inspect_get_package_management> return
1159 the package format and package management tool used by the
1160 inspected operating system. For example for Fedora these
1161 functions would return C<rpm> (package format) and
1162 C<yum> (package management).
1164 This returns the string C<unknown> if we could not determine the
1165 package format I<or> if the operating system does not have
1166 a real packaging system (eg. Windows).
1168 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1169 Future versions of libguestfs may return other strings.
1171 Please read L<guestfs(3)/INSPECTION> for more details.");
1173 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1175 "get package management tool used by the operating system",
1177 C<guestfs_inspect_get_package_format> and this function return
1178 the package format and package management tool used by the
1179 inspected operating system. For example for Fedora these
1180 functions would return C<rpm> (package format) and
1181 C<yum> (package management).
1183 This returns the string C<unknown> if we could not determine the
1184 package management tool I<or> if the operating system does not have
1185 a real packaging system (eg. Windows).
1187 Possible strings include: C<yum>, C<up2date>,
1188 C<apt> (for all Debian derivatives),
1189 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1190 Future versions of libguestfs may return other strings.
1192 Please read L<guestfs(3)/INSPECTION> for more details.");
1194 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1196 "get list of applications installed in the operating system",
1198 Return the list of applications installed in the operating system.
1200 I<Note:> This call works differently from other parts of the
1201 inspection API. You have to call C<guestfs_inspect_os>, then
1202 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1203 before calling this. Listing applications is a significantly
1204 more difficult operation which requires access to the full
1205 filesystem. Also note that unlike the other
1206 C<guestfs_inspect_get_*> calls which are just returning
1207 data cached in the libguestfs handle, this call actually reads
1208 parts of the mounted filesystems during the call.
1210 This returns an empty list if the inspection code was not able
1211 to determine the list of applications.
1213 The application structure contains the following fields:
1219 The name of the application. For Red Hat-derived and Debian-derived
1220 Linux guests, this is the package name.
1222 =item C<app_display_name>
1224 The display name of the application, sometimes localized to the
1225 install language of the guest operating system.
1227 If unavailable this is returned as an empty string C<\"\">.
1228 Callers needing to display something can use C<app_name> instead.
1232 For package managers which use epochs, this contains the epoch of
1233 the package (an integer). If unavailable, this is returned as C<0>.
1235 =item C<app_version>
1237 The version string of the application or package. If unavailable
1238 this is returned as an empty string C<\"\">.
1240 =item C<app_release>
1242 The release string of the application or package, for package
1243 managers that use this. If unavailable this is returned as an
1244 empty string C<\"\">.
1246 =item C<app_install_path>
1248 The installation path of the application (on operating systems
1249 such as Windows which use installation paths). This path is
1250 in the format used by the guest operating system, it is not
1253 If unavailable this is returned as an empty string C<\"\">.
1255 =item C<app_trans_path>
1257 The install path translated into a libguestfs path.
1258 If unavailable this is returned as an empty string C<\"\">.
1260 =item C<app_publisher>
1262 The name of the publisher of the application, for package
1263 managers that use this. If unavailable this is returned
1264 as an empty string C<\"\">.
1268 The URL (eg. upstream URL) of the application.
1269 If unavailable this is returned as an empty string C<\"\">.
1271 =item C<app_source_package>
1273 For packaging systems which support this, the name of the source
1274 package. If unavailable this is returned as an empty string C<\"\">.
1276 =item C<app_summary>
1278 A short (usually one line) description of the application or package.
1279 If unavailable this is returned as an empty string C<\"\">.
1281 =item C<app_description>
1283 A longer description of the application or package.
1284 If unavailable this is returned as an empty string C<\"\">.
1288 Please read L<guestfs(3)/INSPECTION> for more details.");
1290 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1292 "get hostname of the operating system",
1294 This function returns the hostname of the operating system
1295 as found by inspection of the guest's configuration files.
1297 If the hostname could not be determined, then the
1298 string C<unknown> is returned.
1300 Please read L<guestfs(3)/INSPECTION> for more details.");
1302 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1304 "get format of inspected operating system",
1306 This returns the format of the inspected operating system. You
1307 can use it to detect install images, live CDs and similar.
1309 Currently defined formats are:
1315 This is an installed operating system.
1319 The disk image being inspected is not an installed operating system,
1320 but a I<bootable> install disk, live CD, or similar.
1324 The format of this disk image is not known.
1328 Future versions of libguestfs may return other strings here.
1329 The caller should be prepared to handle any string.
1331 Please read L<guestfs(3)/INSPECTION> for more details.");
1333 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1335 "get live flag for install disk",
1337 If C<guestfs_inspect_get_format> returns C<installer> (this
1338 is an install disk), then this returns true if a live image
1339 was detected on the disk.
1341 Please read L<guestfs(3)/INSPECTION> for more details.");
1343 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1345 "get netinst (network installer) flag for install disk",
1347 If C<guestfs_inspect_get_format> returns C<installer> (this
1348 is an install disk), then this returns true if the disk is
1349 a network installer, ie. not a self-contained install CD but
1350 one which is likely to require network access to complete
1353 Please read L<guestfs(3)/INSPECTION> for more details.");
1355 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1357 "get multipart flag for install disk",
1359 If C<guestfs_inspect_get_format> returns C<installer> (this
1360 is an install disk), then this returns true if the disk is
1363 Please read L<guestfs(3)/INSPECTION> for more details.");
1365 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1367 "set the attach method",
1369 Set the method that libguestfs uses to connect to the back end
1370 guestfsd daemon. Possible methods are:
1376 Launch an appliance and connect to it. This is the ordinary method
1379 =item C<unix:I<path>>
1381 Connect to the Unix domain socket I<path>.
1383 This method lets you connect to an existing daemon or (using
1384 virtio-serial) to a live guest. For more information, see
1385 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1389 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1390 [InitNone, Always, TestOutput (
1391 [["get_attach_method"]], "appliance")],
1392 "get the attach method",
1394 Return the current attach method. See C<guestfs_set_attach_method>.");
1396 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1398 "get product variant of inspected operating system",
1400 This returns the product variant of the inspected operating
1403 For Windows guests, this returns the contents of the Registry key
1404 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1405 C<InstallationType> which is usually a string such as
1406 C<Client> or C<Server> (other values are possible). This
1407 can be used to distinguish consumer and enterprise versions
1408 of Windows that have the same version number (for example,
1409 Windows 7 and Windows 2008 Server are both version 6.1,
1410 but the former is C<Client> and the latter is C<Server>).
1412 For enterprise Linux guests, in future we intend this to return
1413 the product variant such as C<Desktop>, C<Server> and so on. But
1414 this is not implemented at present.
1416 If the product variant could not be determined, then the
1417 string C<unknown> is returned.
1419 Please read L<guestfs(3)/INSPECTION> for more details.
1420 See also C<guestfs_inspect_get_product_name>,
1421 C<guestfs_inspect_get_major_version>.");
1423 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1425 "get Windows CurrentControlSet of inspected operating system",
1427 This returns the Windows CurrentControlSet of the inspected guest.
1428 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1430 This call assumes that the guest is Windows and that the
1431 Registry could be examined by inspection. If this is not
1432 the case then an error is returned.
1434 Please read L<guestfs(3)/INSPECTION> for more details.");
1436 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1438 "get drive letter mappings",
1440 This call is useful for Windows which uses a primitive system
1441 of assigning drive letters (like \"C:\") to partitions.
1442 This inspection API examines the Windows Registry to find out
1443 how disks/partitions are mapped to drive letters, and returns
1444 a hash table as in the example below:
1450 Note that keys are drive letters. For Windows, the key is
1451 case insensitive and just contains the drive letter, without
1452 the customary colon separator character.
1454 In future we may support other operating systems that also used drive
1455 letters, but the keys for those might not be case insensitive
1456 and might be longer than 1 character. For example in OS-9,
1457 hard drives were named C<h0>, C<h1> etc.
1459 For Windows guests, currently only hard drive mappings are
1460 returned. Removable disks (eg. DVD-ROMs) are ignored.
1462 For guests that do not use drive mappings, or if the drive mappings
1463 could not be determined, this returns an empty hash table.
1465 Please read L<guestfs(3)/INSPECTION> for more details.
1466 See also C<guestfs_inspect_get_mountpoints>,
1467 C<guestfs_inspect_get_filesystems>.");
1469 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1471 "get the icon corresponding to this operating system",
1473 This function returns an icon corresponding to the inspected
1474 operating system. The icon is returned as a buffer containing a
1475 PNG image (re-encoded to PNG if necessary).
1477 If it was not possible to get an icon this function returns a
1478 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1480 Libguestfs will start by looking for a file called
1481 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1482 and if it has the correct format, the contents of this file will
1483 be returned. You can disable favicons by passing the
1484 optional C<favicon> boolean as false (default is true).
1486 If finding the favicon fails, then we look in other places in the
1487 guest for a suitable icon.
1489 If the optional C<highquality> boolean is true then
1490 only high quality icons are returned, which means only icons of
1491 high resolution with an alpha channel. The default (false) is
1492 to return any icon we can, even if it is of substandard quality.
1500 Unlike most other inspection API calls, the guest's disks must be
1501 mounted up before you call this, since it needs to read information
1502 from the guest filesystem during the call.
1506 B<Security:> The icon data comes from the untrusted guest,
1507 and should be treated with caution. PNG files have been
1508 known to contain exploits. Ensure that libpng (or other relevant
1509 libraries) are fully up to date before trying to process or
1514 The PNG image returned can be any size. It might not be square.
1515 Libguestfs tries to return the largest, highest quality
1516 icon available. The application must scale the icon to the
1521 Extracting icons from Windows guests requires the external
1522 C<wrestool> program from the C<icoutils> package, and
1523 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1524 from the C<netpbm> package. These must be installed separately.
1528 Operating system icons are usually trademarks. Seek legal
1529 advice before using trademarks in applications.
1533 ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1535 "set process group flag",
1537 If C<pgroup> is true, child processes are placed into
1538 their own process group.
1540 The practical upshot of this is that signals like C<SIGINT> (from
1541 users pressing C<^C>) won't be received by the child process.
1543 The default for this flag is false, because usually you want
1544 C<^C> to kill the subprocess.");
1546 ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1548 "get process group flag",
1550 This returns the process group flag.");
1554 (* daemon_functions are any functions which cause some action
1555 * to take place in the daemon.
1558 let daemon_functions = [
1559 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [DeprecatedBy "mount_options"],
1560 [InitEmpty, Always, TestOutput (
1561 [["part_disk"; "/dev/sda"; "mbr"];
1562 ["mkfs"; "ext2"; "/dev/sda1"];
1563 ["mount"; "/dev/sda1"; "/"];
1564 ["write"; "/new"; "new file contents"];
1565 ["cat"; "/new"]], "new file contents")],
1566 "mount a guest disk at a position in the filesystem",
1568 Mount a guest disk at a position in the filesystem. Block devices
1569 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1570 the guest. If those block devices contain partitions, they will have
1571 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1574 The rules are the same as for L<mount(2)>: A filesystem must
1575 first be mounted on C</> before others can be mounted. Other
1576 filesystems can only be mounted on directories which already
1579 The mounted filesystem is writable, if we have sufficient permissions
1580 on the underlying device.
1583 When you use this call, the filesystem options C<sync> and C<noatime>
1584 are set implicitly. This was originally done because we thought it
1585 would improve reliability, but it turns out that I<-o sync> has a
1586 very large negative performance impact and negligible effect on
1587 reliability. Therefore we recommend that you avoid using
1588 C<guestfs_mount> in any code that needs performance, and instead
1589 use C<guestfs_mount_options> (use an empty string for the first
1590 parameter if you don't want any options).");
1592 ("sync", (RErr, [], []), 2, [],
1593 [ InitEmpty, Always, TestRun [["sync"]]],
1594 "sync disks, writes are flushed through to the disk image",
1596 This syncs the disk, so that any writes are flushed through to the
1597 underlying disk image.
1599 You should always call this if you have modified a disk image, before
1600 closing the handle.");
1602 ("touch", (RErr, [Pathname "path"], []), 3, [],
1603 [InitScratchFS, Always, TestOutputTrue (
1604 [["touch"; "/touch"];
1605 ["exists"; "/touch"]])],
1606 "update file timestamps or create a new file",
1608 Touch acts like the L<touch(1)> command. It can be used to
1609 update the timestamps on a file, or, if the file does not exist,
1610 to create a new zero-length file.
1612 This command only works on regular files, and will fail on other
1613 file types such as directories, symbolic links, block special etc.");
1615 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1616 [InitISOFS, Always, TestOutput (
1617 [["cat"; "/known-2"]], "abcdef\n")],
1618 "list the contents of a file",
1620 Return the contents of the file named C<path>.
1622 Note that this function cannot correctly handle binary files
1623 (specifically, files containing C<\\0> character which is treated
1624 as end of string). For those you need to use the C<guestfs_read_file>
1625 or C<guestfs_download> functions which have a more complex interface.");
1627 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1628 [], (* XXX Tricky to test because it depends on the exact format
1629 * of the 'ls -l' command, which changes between F10 and F11.
1631 "list the files in a directory (long format)",
1633 List the files in C<directory> (relative to the root directory,
1634 there is no cwd) in the format of 'ls -la'.
1636 This command is mostly useful for interactive sessions. It
1637 is I<not> intended that you try to parse the output string.");
1639 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1640 [InitScratchFS, Always, TestOutputList (
1642 ["touch"; "/ls/new"];
1643 ["touch"; "/ls/newer"];
1644 ["touch"; "/ls/newest"];
1645 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1646 "list the files in a directory",
1648 List the files in C<directory> (relative to the root directory,
1649 there is no cwd). The '.' and '..' entries are not returned, but
1650 hidden files are shown.
1652 This command is mostly useful for interactive sessions. Programs
1653 should probably use C<guestfs_readdir> instead.");
1655 ("list_devices", (RStringList "devices", [], []), 7, [],
1656 [InitEmpty, Always, TestOutputListOfDevices (
1657 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1658 "list the block devices",
1660 List all the block devices.
1662 The full block device names are returned, eg. C</dev/sda>.
1664 See also C<guestfs_list_filesystems>.");
1666 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1667 [InitBasicFS, Always, TestOutputListOfDevices (
1668 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1669 InitEmpty, Always, TestOutputListOfDevices (
1670 [["part_init"; "/dev/sda"; "mbr"];
1671 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1672 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1673 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1674 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1675 "list the partitions",
1677 List all the partitions detected on all block devices.
1679 The full partition device names are returned, eg. C</dev/sda1>
1681 This does not return logical volumes. For that you will need to
1682 call C<guestfs_lvs>.
1684 See also C<guestfs_list_filesystems>.");
1686 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1687 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1688 [["pvs"]], ["/dev/sda1"]);
1689 InitEmpty, Always, TestOutputListOfDevices (
1690 [["part_init"; "/dev/sda"; "mbr"];
1691 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1692 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1693 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1694 ["pvcreate"; "/dev/sda1"];
1695 ["pvcreate"; "/dev/sda2"];
1696 ["pvcreate"; "/dev/sda3"];
1697 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1698 "list the LVM physical volumes (PVs)",
1700 List all the physical volumes detected. This is the equivalent
1701 of the L<pvs(8)> command.
1703 This returns a list of just the device names that contain
1704 PVs (eg. C</dev/sda2>).
1706 See also C<guestfs_pvs_full>.");
1708 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1709 [InitBasicFSonLVM, Always, TestOutputList (
1711 InitEmpty, Always, TestOutputList (
1712 [["part_init"; "/dev/sda"; "mbr"];
1713 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1714 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1715 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1716 ["pvcreate"; "/dev/sda1"];
1717 ["pvcreate"; "/dev/sda2"];
1718 ["pvcreate"; "/dev/sda3"];
1719 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1720 ["vgcreate"; "VG2"; "/dev/sda3"];
1721 ["vgs"]], ["VG1"; "VG2"])],
1722 "list the LVM volume groups (VGs)",
1724 List all the volumes groups detected. This is the equivalent
1725 of the L<vgs(8)> command.
1727 This returns a list of just the volume group names that were
1728 detected (eg. C<VolGroup00>).
1730 See also C<guestfs_vgs_full>.");
1732 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1733 [InitBasicFSonLVM, Always, TestOutputList (
1734 [["lvs"]], ["/dev/VG/LV"]);
1735 InitEmpty, Always, TestOutputList (
1736 [["part_init"; "/dev/sda"; "mbr"];
1737 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1738 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1739 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1740 ["pvcreate"; "/dev/sda1"];
1741 ["pvcreate"; "/dev/sda2"];
1742 ["pvcreate"; "/dev/sda3"];
1743 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1744 ["vgcreate"; "VG2"; "/dev/sda3"];
1745 ["lvcreate"; "LV1"; "VG1"; "50"];
1746 ["lvcreate"; "LV2"; "VG1"; "50"];
1747 ["lvcreate"; "LV3"; "VG2"; "50"];
1748 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1749 "list the LVM logical volumes (LVs)",
1751 List all the logical volumes detected. This is the equivalent
1752 of the L<lvs(8)> command.
1754 This returns a list of the logical volume device names
1755 (eg. C</dev/VolGroup00/LogVol00>).
1757 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1759 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1760 [], (* XXX how to test? *)
1761 "list the LVM physical volumes (PVs)",
1763 List all the physical volumes detected. This is the equivalent
1764 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1766 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1767 [], (* XXX how to test? *)
1768 "list the LVM volume groups (VGs)",
1770 List all the volumes groups detected. This is the equivalent
1771 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1773 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1774 [], (* XXX how to test? *)
1775 "list the LVM logical volumes (LVs)",
1777 List all the logical volumes detected. This is the equivalent
1778 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1780 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1781 [InitISOFS, Always, TestOutputList (
1782 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1783 InitISOFS, Always, TestOutputList (
1784 [["read_lines"; "/empty"]], [])],
1785 "read file as lines",
1787 Return the contents of the file named C<path>.
1789 The file contents are returned as a list of lines. Trailing
1790 C<LF> and C<CRLF> character sequences are I<not> returned.
1792 Note that this function cannot correctly handle binary files
1793 (specifically, files containing C<\\0> character which is treated
1794 as end of line). For those you need to use the C<guestfs_read_file>
1795 function which has a more complex interface.");
1797 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1798 [], (* XXX Augeas code needs tests. *)
1799 "create a new Augeas handle",
1801 Create a new Augeas handle for editing configuration files.
1802 If there was any previous Augeas handle associated with this
1803 guestfs session, then it is closed.
1805 You must call this before using any other C<guestfs_aug_*>
1808 C<root> is the filesystem root. C<root> must not be NULL,
1811 The flags are the same as the flags defined in
1812 E<lt>augeas.hE<gt>, the logical I<or> of the following
1817 =item C<AUG_SAVE_BACKUP> = 1
1819 Keep the original file with a C<.augsave> extension.
1821 =item C<AUG_SAVE_NEWFILE> = 2
1823 Save changes into a file with extension C<.augnew>, and
1824 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1826 =item C<AUG_TYPE_CHECK> = 4
1830 This option is only useful when debugging Augeas lenses. Use
1831 of this option may require additional memory for the libguestfs
1832 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1833 environment variable or call C<guestfs_set_memsize>.
1835 =item C<AUG_NO_STDINC> = 8
1837 Do not use standard load path for modules.
1839 =item C<AUG_SAVE_NOOP> = 16
1841 Make save a no-op, just record what would have been changed.
1843 =item C<AUG_NO_LOAD> = 32
1845 Do not load the tree in C<guestfs_aug_init>.
1849 To close the handle, you can call C<guestfs_aug_close>.
1851 To find out more about Augeas, see L<http://augeas.net/>.");
1853 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1854 [], (* XXX Augeas code needs tests. *)
1855 "close the current Augeas handle",
1857 Close the current Augeas handle and free up any resources
1858 used by it. After calling this, you have to call
1859 C<guestfs_aug_init> again before you can use any other
1860 Augeas functions.");
1862 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1863 [], (* XXX Augeas code needs tests. *)
1864 "define an Augeas variable",
1866 Defines an Augeas variable C<name> whose value is the result
1867 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1870 On success this returns the number of nodes in C<expr>, or
1871 C<0> if C<expr> evaluates to something which is not a nodeset.");
1873 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1874 [], (* XXX Augeas code needs tests. *)
1875 "define an Augeas node",
1877 Defines a variable C<name> whose value is the result of
1880 If C<expr> evaluates to an empty nodeset, a node is created,
1881 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1882 C<name> will be the nodeset containing that single node.
1884 On success this returns a pair containing the
1885 number of nodes in the nodeset, and a boolean flag
1886 if a node was created.");
1888 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1889 [], (* XXX Augeas code needs tests. *)
1890 "look up the value of an Augeas path",
1892 Look up the value associated with C<path>. If C<path>
1893 matches exactly one node, the C<value> is returned.");
1895 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1896 [], (* XXX Augeas code needs tests. *)
1897 "set Augeas path to value",
1899 Set the value associated with C<path> to C<val>.
1901 In the Augeas API, it is possible to clear a node by setting
1902 the value to NULL. Due to an oversight in the libguestfs API
1903 you cannot do that with this call. Instead you must use the
1904 C<guestfs_aug_clear> call.");
1906 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1907 [], (* XXX Augeas code needs tests. *)
1908 "insert a sibling Augeas node",
1910 Create a new sibling C<label> for C<path>, inserting it into
1911 the tree before or after C<path> (depending on the boolean
1914 C<path> must match exactly one existing node in the tree, and
1915 C<label> must be a label, ie. not contain C</>, C<*> or end
1916 with a bracketed index C<[N]>.");
1918 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1919 [], (* XXX Augeas code needs tests. *)
1920 "remove an Augeas path",
1922 Remove C<path> and all of its children.
1924 On success this returns the number of entries which were removed.");
1926 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1927 [], (* XXX Augeas code needs tests. *)
1930 Move the node C<src> to C<dest>. C<src> must match exactly
1931 one node. C<dest> is overwritten if it exists.");
1933 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1934 [], (* XXX Augeas code needs tests. *)
1935 "return Augeas nodes which match augpath",
1937 Returns a list of paths which match the path expression C<path>.
1938 The returned paths are sufficiently qualified so that they match
1939 exactly one node in the current tree.");
1941 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1942 [], (* XXX Augeas code needs tests. *)
1943 "write all pending Augeas changes to disk",
1945 This writes all pending changes to disk.
1947 The flags which were passed to C<guestfs_aug_init> affect exactly
1948 how files are saved.");
1950 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1951 [], (* XXX Augeas code needs tests. *)
1952 "load files into the tree",
1954 Load files into the tree.
1956 See C<aug_load> in the Augeas documentation for the full gory
1959 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1960 [], (* XXX Augeas code needs tests. *)
1961 "list Augeas nodes under augpath",
1963 This is just a shortcut for listing C<guestfs_aug_match>
1964 C<path/*> and sorting the resulting nodes into alphabetical order.");
1966 ("rm", (RErr, [Pathname "path"], []), 29, [],
1967 [InitScratchFS, Always, TestRun
1969 ["touch"; "/rm/new"];
1971 InitScratchFS, Always, TestLastFail
1972 [["rm"; "/nosuchfile"]];
1973 InitScratchFS, Always, TestLastFail
1978 Remove the single file C<path>.");
1980 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1981 [InitScratchFS, Always, TestRun
1982 [["mkdir"; "/rmdir"];
1983 ["rmdir"; "/rmdir"]];
1984 InitScratchFS, Always, TestLastFail
1985 [["rmdir"; "/rmdir2"]];
1986 InitScratchFS, Always, TestLastFail
1987 [["mkdir"; "/rmdir3"];
1988 ["touch"; "/rmdir3/new"];
1989 ["rmdir"; "/rmdir3/new"]]],
1990 "remove a directory",
1992 Remove the single directory C<path>.");
1994 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1995 [InitScratchFS, Always, TestOutputFalse
1996 [["mkdir"; "/rm_rf"];
1997 ["mkdir"; "/rm_rf/foo"];
1998 ["touch"; "/rm_rf/foo/bar"];
1999 ["rm_rf"; "/rm_rf"];
2000 ["exists"; "/rm_rf"]]],
2001 "remove a file or directory recursively",
2003 Remove the file or directory C<path>, recursively removing the
2004 contents if its a directory. This is like the C<rm -rf> shell
2007 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2008 [InitScratchFS, Always, TestOutputTrue
2009 [["mkdir"; "/mkdir"];
2010 ["is_dir"; "/mkdir"]];
2011 InitScratchFS, Always, TestLastFail
2012 [["mkdir"; "/mkdir2/foo/bar"]]],
2013 "create a directory",
2015 Create a directory named C<path>.");
2017 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2018 [InitScratchFS, Always, TestOutputTrue
2019 [["mkdir_p"; "/mkdir_p/foo/bar"];
2020 ["is_dir"; "/mkdir_p/foo/bar"]];
2021 InitScratchFS, Always, TestOutputTrue
2022 [["mkdir_p"; "/mkdir_p2/foo/bar"];
2023 ["is_dir"; "/mkdir_p2/foo"]];
2024 InitScratchFS, Always, TestOutputTrue
2025 [["mkdir_p"; "/mkdir_p3/foo/bar"];
2026 ["is_dir"; "/mkdir_p3"]];
2027 (* Regression tests for RHBZ#503133: *)
2028 InitScratchFS, Always, TestRun
2029 [["mkdir"; "/mkdir_p4"];
2030 ["mkdir_p"; "/mkdir_p4"]];
2031 InitScratchFS, Always, TestLastFail
2032 [["touch"; "/mkdir_p5"];
2033 ["mkdir_p"; "/mkdir_p5"]]],
2034 "create a directory and parents",
2036 Create a directory named C<path>, creating any parent directories
2037 as necessary. This is like the C<mkdir -p> shell command.");
2039 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2040 [], (* XXX Need stat command to test *)
2043 Change the mode (permissions) of C<path> to C<mode>. Only
2044 numeric modes are supported.
2046 I<Note>: When using this command from guestfish, C<mode>
2047 by default would be decimal, unless you prefix it with
2048 C<0> to get octal, ie. use C<0700> not C<700>.
2050 The mode actually set is affected by the umask.");
2052 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2053 [], (* XXX Need stat command to test *)
2054 "change file owner and group",
2056 Change the file owner to C<owner> and group to C<group>.
2058 Only numeric uid and gid are supported. If you want to use
2059 names, you will need to locate and parse the password file
2060 yourself (Augeas support makes this relatively easy).");
2062 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2063 [InitISOFS, Always, TestOutputTrue (
2064 [["exists"; "/empty"]]);
2065 InitISOFS, Always, TestOutputTrue (
2066 [["exists"; "/directory"]])],
2067 "test if file or directory exists",
2069 This returns C<true> if and only if there is a file, directory
2070 (or anything) with the given C<path> name.
2072 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2074 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2075 [InitISOFS, Always, TestOutputTrue (
2076 [["is_file"; "/known-1"]]);
2077 InitISOFS, Always, TestOutputFalse (
2078 [["is_file"; "/directory"]])],
2079 "test if a regular file",
2081 This returns C<true> if and only if there is a regular file
2082 with the given C<path> name. Note that it returns false for
2083 other objects like directories.
2085 See also C<guestfs_stat>.");
2087 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2088 [InitISOFS, Always, TestOutputFalse (
2089 [["is_dir"; "/known-3"]]);
2090 InitISOFS, Always, TestOutputTrue (
2091 [["is_dir"; "/directory"]])],
2092 "test if a directory",
2094 This returns C<true> if and only if there is a directory
2095 with the given C<path> name. Note that it returns false for
2096 other objects like files.
2098 See also C<guestfs_stat>.");
2100 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2101 [InitEmpty, Always, TestOutputListOfDevices (
2102 [["part_init"; "/dev/sda"; "mbr"];
2103 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2104 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2105 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2106 ["pvcreate"; "/dev/sda1"];
2107 ["pvcreate"; "/dev/sda2"];
2108 ["pvcreate"; "/dev/sda3"];
2109 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2110 "create an LVM physical volume",
2112 This creates an LVM physical volume on the named C<device>,
2113 where C<device> should usually be a partition name such
2116 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2117 [InitEmpty, Always, TestOutputList (
2118 [["part_init"; "/dev/sda"; "mbr"];
2119 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2120 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2121 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2122 ["pvcreate"; "/dev/sda1"];
2123 ["pvcreate"; "/dev/sda2"];
2124 ["pvcreate"; "/dev/sda3"];
2125 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2126 ["vgcreate"; "VG2"; "/dev/sda3"];
2127 ["vgs"]], ["VG1"; "VG2"])],
2128 "create an LVM volume group",
2130 This creates an LVM volume group called C<volgroup>
2131 from the non-empty list of physical volumes C<physvols>.");
2133 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2134 [InitEmpty, Always, TestOutputList (
2135 [["part_init"; "/dev/sda"; "mbr"];
2136 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2137 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2138 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2139 ["pvcreate"; "/dev/sda1"];
2140 ["pvcreate"; "/dev/sda2"];
2141 ["pvcreate"; "/dev/sda3"];
2142 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2143 ["vgcreate"; "VG2"; "/dev/sda3"];
2144 ["lvcreate"; "LV1"; "VG1"; "50"];
2145 ["lvcreate"; "LV2"; "VG1"; "50"];
2146 ["lvcreate"; "LV3"; "VG2"; "50"];
2147 ["lvcreate"; "LV4"; "VG2"; "50"];
2148 ["lvcreate"; "LV5"; "VG2"; "50"];
2150 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2151 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2152 "create an LVM logical volume",
2154 This creates an LVM logical volume called C<logvol>
2155 on the volume group C<volgroup>, with C<size> megabytes.");
2157 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2158 [InitEmpty, Always, TestOutput (
2159 [["part_disk"; "/dev/sda"; "mbr"];
2160 ["mkfs"; "ext2"; "/dev/sda1"];
2161 ["mount_options"; ""; "/dev/sda1"; "/"];
2162 ["write"; "/new"; "new file contents"];
2163 ["cat"; "/new"]], "new file contents")],
2164 "make a filesystem",
2166 This creates a filesystem on C<device> (usually a partition
2167 or LVM logical volume). The filesystem type is C<fstype>, for
2170 ("sfdisk", (RErr, [Device "device";
2171 Int "cyls"; Int "heads"; Int "sectors";
2172 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2174 "create partitions on a block device",
2176 This is a direct interface to the L<sfdisk(8)> program for creating
2177 partitions on block devices.
2179 C<device> should be a block device, for example C</dev/sda>.
2181 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2182 and sectors on the device, which are passed directly to sfdisk as
2183 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2184 of these, then the corresponding parameter is omitted. Usually for
2185 'large' disks, you can just pass C<0> for these, but for small
2186 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2187 out the right geometry and you will need to tell it.
2189 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2190 information refer to the L<sfdisk(8)> manpage.
2192 To create a single partition occupying the whole disk, you would
2193 pass C<lines> as a single element list, when the single element being
2194 the string C<,> (comma).
2196 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2197 C<guestfs_part_init>");
2199 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2200 (* Regression test for RHBZ#597135. *)
2201 [InitScratchFS, Always, TestLastFail
2202 [["write_file"; "/write_file"; "abc"; "10000"]]],
2205 This call creates a file called C<path>. The contents of the
2206 file is the string C<content> (which can contain any 8 bit data),
2207 with length C<size>.
2209 As a special case, if C<size> is C<0>
2210 then the length is calculated using C<strlen> (so in this case
2211 the content cannot contain embedded ASCII NULs).
2213 I<NB.> Owing to a bug, writing content containing ASCII NUL
2214 characters does I<not> work, even if the length is specified.");
2216 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2217 [InitEmpty, Always, TestOutputListOfDevices (
2218 [["part_disk"; "/dev/sda"; "mbr"];
2219 ["mkfs"; "ext2"; "/dev/sda1"];
2220 ["mount_options"; ""; "/dev/sda1"; "/"];
2221 ["mounts"]], ["/dev/sda1"]);
2222 InitEmpty, Always, TestOutputList (
2223 [["part_disk"; "/dev/sda"; "mbr"];
2224 ["mkfs"; "ext2"; "/dev/sda1"];
2225 ["mount_options"; ""; "/dev/sda1"; "/"];
2228 "unmount a filesystem",
2230 This unmounts the given filesystem. The filesystem may be
2231 specified either by its mountpoint (path) or the device which
2232 contains the filesystem.");
2234 ("mounts", (RStringList "devices", [], []), 46, [],
2235 [InitScratchFS, Always, TestOutputListOfDevices (
2236 [["mounts"]], ["/dev/sdb1"])],
2237 "show mounted filesystems",
2239 This returns the list of currently mounted filesystems. It returns
2240 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2242 Some internal mounts are not shown.
2244 See also: C<guestfs_mountpoints>");
2246 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2247 [InitScratchFS, Always, TestOutputList (
2250 (* check that umount_all can unmount nested mounts correctly: *)
2251 InitEmpty, Always, TestOutputList (
2252 [["part_init"; "/dev/sda"; "mbr"];
2253 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2254 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2255 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2256 ["mkfs"; "ext2"; "/dev/sda1"];
2257 ["mkfs"; "ext2"; "/dev/sda2"];
2258 ["mkfs"; "ext2"; "/dev/sda3"];
2259 ["mount_options"; ""; "/dev/sda1"; "/"];
2261 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2262 ["mkdir"; "/mp1/mp2"];
2263 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2264 ["mkdir"; "/mp1/mp2/mp3"];
2267 "unmount all filesystems",
2269 This unmounts all mounted filesystems.
2271 Some internal mounts are not unmounted by this call.");
2273 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2275 "remove all LVM LVs, VGs and PVs",
2277 This command removes all LVM logical volumes, volume groups
2278 and physical volumes.");
2280 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2281 [InitISOFS, Always, TestOutput (
2282 [["file"; "/empty"]], "empty");
2283 InitISOFS, Always, TestOutput (
2284 [["file"; "/known-1"]], "ASCII text");
2285 InitISOFS, Always, TestLastFail (
2286 [["file"; "/notexists"]]);
2287 InitISOFS, Always, TestOutput (
2288 [["file"; "/abssymlink"]], "symbolic link");
2289 InitISOFS, Always, TestOutput (
2290 [["file"; "/directory"]], "directory")],
2291 "determine file type",
2293 This call uses the standard L<file(1)> command to determine
2294 the type or contents of the file.
2296 This call will also transparently look inside various types
2299 The exact command which runs is C<file -zb path>. Note in
2300 particular that the filename is not prepended to the output
2303 The output depends on the output of the underlying L<file(1)>
2304 command and it can change in future in ways beyond our control.
2305 In other words, the output is not guaranteed by the ABI.
2307 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2308 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2310 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2311 [InitScratchFS, Always, TestOutput (
2312 [["mkdir"; "/command"];
2313 ["upload"; "test-command"; "/command/test-command"];
2314 ["chmod"; "0o755"; "/command/test-command"];
2315 ["command"; "/command/test-command 1"]], "Result1");
2316 InitScratchFS, Always, TestOutput (
2317 [["mkdir"; "/command2"];
2318 ["upload"; "test-command"; "/command2/test-command"];
2319 ["chmod"; "0o755"; "/command2/test-command"];
2320 ["command"; "/command2/test-command 2"]], "Result2\n");
2321 InitScratchFS, Always, TestOutput (
2322 [["mkdir"; "/command3"];
2323 ["upload"; "test-command"; "/command3/test-command"];
2324 ["chmod"; "0o755"; "/command3/test-command"];
2325 ["command"; "/command3/test-command 3"]], "\nResult3");
2326 InitScratchFS, Always, TestOutput (
2327 [["mkdir"; "/command4"];
2328 ["upload"; "test-command"; "/command4/test-command"];
2329 ["chmod"; "0o755"; "/command4/test-command"];
2330 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2331 InitScratchFS, Always, TestOutput (
2332 [["mkdir"; "/command5"];
2333 ["upload"; "test-command"; "/command5/test-command"];
2334 ["chmod"; "0o755"; "/command5/test-command"];
2335 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2336 InitScratchFS, Always, TestOutput (
2337 [["mkdir"; "/command6"];
2338 ["upload"; "test-command"; "/command6/test-command"];
2339 ["chmod"; "0o755"; "/command6/test-command"];
2340 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2341 InitScratchFS, Always, TestOutput (
2342 [["mkdir"; "/command7"];
2343 ["upload"; "test-command"; "/command7/test-command"];
2344 ["chmod"; "0o755"; "/command7/test-command"];
2345 ["command"; "/command7/test-command 7"]], "");
2346 InitScratchFS, Always, TestOutput (
2347 [["mkdir"; "/command8"];
2348 ["upload"; "test-command"; "/command8/test-command"];
2349 ["chmod"; "0o755"; "/command8/test-command"];
2350 ["command"; "/command8/test-command 8"]], "\n");
2351 InitScratchFS, Always, TestOutput (
2352 [["mkdir"; "/command9"];
2353 ["upload"; "test-command"; "/command9/test-command"];
2354 ["chmod"; "0o755"; "/command9/test-command"];
2355 ["command"; "/command9/test-command 9"]], "\n\n");
2356 InitScratchFS, Always, TestOutput (
2357 [["mkdir"; "/command10"];
2358 ["upload"; "test-command"; "/command10/test-command"];
2359 ["chmod"; "0o755"; "/command10/test-command"];
2360 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2361 InitScratchFS, Always, TestOutput (
2362 [["mkdir"; "/command11"];
2363 ["upload"; "test-command"; "/command11/test-command"];
2364 ["chmod"; "0o755"; "/command11/test-command"];
2365 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2366 InitScratchFS, Always, TestLastFail (
2367 [["mkdir"; "/command12"];
2368 ["upload"; "test-command"; "/command12/test-command"];
2369 ["chmod"; "0o755"; "/command12/test-command"];
2370 ["command"; "/command12/test-command"]])],
2371 "run a command from the guest filesystem",
2373 This call runs a command from the guest filesystem. The
2374 filesystem must be mounted, and must contain a compatible
2375 operating system (ie. something Linux, with the same
2376 or compatible processor architecture).
2378 The single parameter is an argv-style list of arguments.
2379 The first element is the name of the program to run.
2380 Subsequent elements are parameters. The list must be
2381 non-empty (ie. must contain a program name). Note that
2382 the command runs directly, and is I<not> invoked via
2383 the shell (see C<guestfs_sh>).
2385 The return value is anything printed to I<stdout> by
2388 If the command returns a non-zero exit status, then
2389 this function returns an error message. The error message
2390 string is the content of I<stderr> from the command.
2392 The C<$PATH> environment variable will contain at least
2393 C</usr/bin> and C</bin>. If you require a program from
2394 another location, you should provide the full path in the
2397 Shared libraries and data files required by the program
2398 must be available on filesystems which are mounted in the
2399 correct places. It is the caller's responsibility to ensure
2400 all filesystems that are needed are mounted at the right
2403 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2404 [InitScratchFS, Always, TestOutputList (
2405 [["mkdir"; "/command_lines"];
2406 ["upload"; "test-command"; "/command_lines/test-command"];
2407 ["chmod"; "0o755"; "/command_lines/test-command"];
2408 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2409 InitScratchFS, Always, TestOutputList (
2410 [["mkdir"; "/command_lines2"];
2411 ["upload"; "test-command"; "/command_lines2/test-command"];
2412 ["chmod"; "0o755"; "/command_lines2/test-command"];
2413 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2414 InitScratchFS, Always, TestOutputList (
2415 [["mkdir"; "/command_lines3"];
2416 ["upload"; "test-command"; "/command_lines3/test-command"];
2417 ["chmod"; "0o755"; "/command_lines3/test-command"];
2418 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2419 InitScratchFS, Always, TestOutputList (
2420 [["mkdir"; "/command_lines4"];
2421 ["upload"; "test-command"; "/command_lines4/test-command"];
2422 ["chmod"; "0o755"; "/command_lines4/test-command"];
2423 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2424 InitScratchFS, Always, TestOutputList (
2425 [["mkdir"; "/command_lines5"];
2426 ["upload"; "test-command"; "/command_lines5/test-command"];
2427 ["chmod"; "0o755"; "/command_lines5/test-command"];
2428 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2429 InitScratchFS, Always, TestOutputList (
2430 [["mkdir"; "/command_lines6"];
2431 ["upload"; "test-command"; "/command_lines6/test-command"];
2432 ["chmod"; "0o755"; "/command_lines6/test-command"];
2433 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2434 InitScratchFS, Always, TestOutputList (
2435 [["mkdir"; "/command_lines7"];
2436 ["upload"; "test-command"; "/command_lines7/test-command"];
2437 ["chmod"; "0o755"; "/command_lines7/test-command"];
2438 ["command_lines"; "/command_lines7/test-command 7"]], []);
2439 InitScratchFS, Always, TestOutputList (
2440 [["mkdir"; "/command_lines8"];
2441 ["upload"; "test-command"; "/command_lines8/test-command"];
2442 ["chmod"; "0o755"; "/command_lines8/test-command"];
2443 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2444 InitScratchFS, Always, TestOutputList (
2445 [["mkdir"; "/command_lines9"];
2446 ["upload"; "test-command"; "/command_lines9/test-command"];
2447 ["chmod"; "0o755"; "/command_lines9/test-command"];
2448 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2449 InitScratchFS, Always, TestOutputList (
2450 [["mkdir"; "/command_lines10"];
2451 ["upload"; "test-command"; "/command_lines10/test-command"];
2452 ["chmod"; "0o755"; "/command_lines10/test-command"];
2453 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2454 InitScratchFS, Always, TestOutputList (
2455 [["mkdir"; "/command_lines11"];
2456 ["upload"; "test-command"; "/command_lines11/test-command"];
2457 ["chmod"; "0o755"; "/command_lines11/test-command"];
2458 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2459 "run a command, returning lines",
2461 This is the same as C<guestfs_command>, but splits the
2462 result into a list of lines.
2464 See also: C<guestfs_sh_lines>");
2466 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2467 [InitISOFS, Always, TestOutputStruct (
2468 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2469 "get file information",
2471 Returns file information for the given C<path>.
2473 This is the same as the C<stat(2)> system call.");
2475 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2476 [InitISOFS, Always, TestOutputStruct (
2477 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2478 "get file information for a symbolic link",
2480 Returns file information for the given C<path>.
2482 This is the same as C<guestfs_stat> except that if C<path>
2483 is a symbolic link, then the link is stat-ed, not the file it
2486 This is the same as the C<lstat(2)> system call.");
2488 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2489 [InitISOFS, Always, TestOutputStruct (
2490 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2491 "get file system statistics",
2493 Returns file system statistics for any mounted file system.
2494 C<path> should be a file or directory in the mounted file system
2495 (typically it is the mount point itself, but it doesn't need to be).
2497 This is the same as the C<statvfs(2)> system call.");
2499 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2501 "get ext2/ext3/ext4 superblock details",
2503 This returns the contents of the ext2, ext3 or ext4 filesystem
2504 superblock on C<device>.
2506 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2507 manpage for more details. The list of fields returned isn't
2508 clearly defined, and depends on both the version of C<tune2fs>
2509 that libguestfs was built against, and the filesystem itself.");
2511 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2512 [InitEmpty, Always, TestOutputTrue (
2513 [["blockdev_setro"; "/dev/sda"];
2514 ["blockdev_getro"; "/dev/sda"]])],
2515 "set block device to read-only",
2517 Sets the block device named C<device> to read-only.
2519 This uses the L<blockdev(8)> command.");
2521 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2522 [InitEmpty, Always, TestOutputFalse (
2523 [["blockdev_setrw"; "/dev/sda"];
2524 ["blockdev_getro"; "/dev/sda"]])],
2525 "set block device to read-write",
2527 Sets the block device named C<device> to read-write.
2529 This uses the L<blockdev(8)> command.");
2531 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2532 [InitEmpty, Always, TestOutputTrue (
2533 [["blockdev_setro"; "/dev/sda"];
2534 ["blockdev_getro"; "/dev/sda"]])],
2535 "is block device set to read-only",
2537 Returns a boolean indicating if the block device is read-only
2538 (true if read-only, false if not).
2540 This uses the L<blockdev(8)> command.");
2542 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2543 [InitEmpty, Always, TestOutputInt (
2544 [["blockdev_getss"; "/dev/sda"]], 512)],
2545 "get sectorsize of block device",
2547 This returns the size of sectors on a block device.
2548 Usually 512, but can be larger for modern devices.
2550 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2553 This uses the L<blockdev(8)> command.");
2555 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2556 [InitEmpty, Always, TestOutputInt (
2557 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2558 "get blocksize of block device",
2560 This returns the block size of a device.
2562 (Note this is different from both I<size in blocks> and
2563 I<filesystem block size>).
2565 This uses the L<blockdev(8)> command.");
2567 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2569 "set blocksize of block device",
2571 This sets the block size of a device.
2573 (Note this is different from both I<size in blocks> and
2574 I<filesystem block size>).
2576 This uses the L<blockdev(8)> command.");
2578 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2579 [InitEmpty, Always, TestOutputInt (
2580 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2581 "get total size of device in 512-byte sectors",
2583 This returns the size of the device in units of 512-byte sectors
2584 (even if the sectorsize isn't 512 bytes ... weird).
2586 See also C<guestfs_blockdev_getss> for the real sector size of
2587 the device, and C<guestfs_blockdev_getsize64> for the more
2588 useful I<size in bytes>.
2590 This uses the L<blockdev(8)> command.");
2592 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2593 [InitEmpty, Always, TestOutputInt (
2594 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2595 "get total size of device in bytes",
2597 This returns the size of the device in bytes.
2599 See also C<guestfs_blockdev_getsz>.
2601 This uses the L<blockdev(8)> command.");
2603 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2604 [InitEmpty, Always, TestRun
2605 [["blockdev_flushbufs"; "/dev/sda"]]],
2606 "flush device buffers",
2608 This tells the kernel to flush internal buffers associated
2611 This uses the L<blockdev(8)> command.");
2613 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2614 [InitEmpty, Always, TestRun
2615 [["blockdev_rereadpt"; "/dev/sda"]]],
2616 "reread partition table",
2618 Reread the partition table on C<device>.
2620 This uses the L<blockdev(8)> command.");
2622 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2623 [InitScratchFS, Always, TestOutput (
2624 (* Pick a file from cwd which isn't likely to change. *)
2625 [["mkdir"; "/upload"];
2626 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2627 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2628 Digest.to_hex (Digest.file "COPYING.LIB"))],
2629 "upload a file from the local machine",
2631 Upload local file C<filename> to C<remotefilename> on the
2634 C<filename> can also be a named pipe.
2636 See also C<guestfs_download>.");
2638 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2639 [InitScratchFS, Always, TestOutput (
2640 (* Pick a file from cwd which isn't likely to change. *)
2641 [["mkdir"; "/download"];
2642 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2643 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2644 ["upload"; "testdownload.tmp"; "/download/upload"];
2645 ["checksum"; "md5"; "/download/upload"]],
2646 Digest.to_hex (Digest.file "COPYING.LIB"))],
2647 "download a file to the local machine",
2649 Download file C<remotefilename> and save it as C<filename>
2650 on the local machine.
2652 C<filename> can also be a named pipe.
2654 See also C<guestfs_upload>, C<guestfs_cat>.");
2656 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2657 [InitISOFS, Always, TestOutput (
2658 [["checksum"; "crc"; "/known-3"]], "2891671662");
2659 InitISOFS, Always, TestLastFail (
2660 [["checksum"; "crc"; "/notexists"]]);
2661 InitISOFS, Always, TestOutput (
2662 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2663 InitISOFS, Always, TestOutput (
2664 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2665 InitISOFS, Always, TestOutput (
2666 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2667 InitISOFS, Always, TestOutput (
2668 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2669 InitISOFS, Always, TestOutput (
2670 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2671 InitISOFS, Always, TestOutput (
2672 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2673 (* Test for RHBZ#579608, absolute symbolic links. *)
2674 InitISOFS, Always, TestOutput (
2675 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2676 "compute MD5, SHAx or CRC checksum of file",
2678 This call computes the MD5, SHAx or CRC checksum of the
2681 The type of checksum to compute is given by the C<csumtype>
2682 parameter which must have one of the following values:
2688 Compute the cyclic redundancy check (CRC) specified by POSIX
2689 for the C<cksum> command.
2693 Compute the MD5 hash (using the C<md5sum> program).
2697 Compute the SHA1 hash (using the C<sha1sum> program).
2701 Compute the SHA224 hash (using the C<sha224sum> program).
2705 Compute the SHA256 hash (using the C<sha256sum> program).
2709 Compute the SHA384 hash (using the C<sha384sum> program).
2713 Compute the SHA512 hash (using the C<sha512sum> program).
2717 The checksum is returned as a printable string.
2719 To get the checksum for a device, use C<guestfs_checksum_device>.
2721 To get the checksums for many files, use C<guestfs_checksums_out>.");
2723 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2724 [InitScratchFS, Always, TestOutput (
2725 [["mkdir"; "/tar_in"];
2726 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2727 ["cat"; "/tar_in/hello"]], "hello\n")],
2728 "unpack tarfile to directory",
2730 This command uploads and unpacks local file C<tarfile> (an
2731 I<uncompressed> tar file) into C<directory>.
2733 To upload a compressed tarball, use C<guestfs_tgz_in>
2734 or C<guestfs_txz_in>.");
2736 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2738 "pack directory into tarfile",
2740 This command packs the contents of C<directory> and downloads
2741 it to local file C<tarfile>.
2743 To download a compressed tarball, use C<guestfs_tgz_out>
2744 or C<guestfs_txz_out>.");
2746 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2747 [InitScratchFS, Always, TestOutput (
2748 [["mkdir"; "/tgz_in"];
2749 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2750 ["cat"; "/tgz_in/hello"]], "hello\n")],
2751 "unpack compressed tarball to directory",
2753 This command uploads and unpacks local file C<tarball> (a
2754 I<gzip compressed> tar file) into C<directory>.
2756 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2758 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2760 "pack directory into compressed tarball",
2762 This command packs the contents of C<directory> and downloads
2763 it to local file C<tarball>.
2765 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2767 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2768 [InitBasicFS, Always, TestLastFail (
2770 ["mount_ro"; "/dev/sda1"; "/"];
2771 ["touch"; "/new"]]);
2772 InitBasicFS, Always, TestOutput (
2773 [["write"; "/new"; "data"];
2775 ["mount_ro"; "/dev/sda1"; "/"];
2776 ["cat"; "/new"]], "data")],
2777 "mount a guest disk, read-only",
2779 This is the same as the C<guestfs_mount> command, but it
2780 mounts the filesystem with the read-only (I<-o ro>) flag.");
2782 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2784 "mount a guest disk with mount options",
2786 This is the same as the C<guestfs_mount> command, but it
2787 allows you to set the mount options as for the
2788 L<mount(8)> I<-o> flag.
2790 If the C<options> parameter is an empty string, then
2791 no options are passed (all options default to whatever
2792 the filesystem uses).");
2794 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2796 "mount a guest disk with mount options and vfstype",
2798 This is the same as the C<guestfs_mount> command, but it
2799 allows you to set both the mount options and the vfstype
2800 as for the L<mount(8)> I<-o> and I<-t> flags.");
2802 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2804 "debugging and internals",
2806 The C<guestfs_debug> command exposes some internals of
2807 C<guestfsd> (the guestfs daemon) that runs inside the
2810 There is no comprehensive help for this command. You have
2811 to look at the file C<daemon/debug.c> in the libguestfs source
2812 to find out what you can do.");
2814 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2815 [InitEmpty, Always, TestOutputList (
2816 [["part_disk"; "/dev/sda"; "mbr"];
2817 ["pvcreate"; "/dev/sda1"];
2818 ["vgcreate"; "VG"; "/dev/sda1"];
2819 ["lvcreate"; "LV1"; "VG"; "50"];
2820 ["lvcreate"; "LV2"; "VG"; "50"];
2821 ["lvremove"; "/dev/VG/LV1"];
2822 ["lvs"]], ["/dev/VG/LV2"]);
2823 InitEmpty, Always, TestOutputList (
2824 [["part_disk"; "/dev/sda"; "mbr"];
2825 ["pvcreate"; "/dev/sda1"];
2826 ["vgcreate"; "VG"; "/dev/sda1"];
2827 ["lvcreate"; "LV1"; "VG"; "50"];
2828 ["lvcreate"; "LV2"; "VG"; "50"];
2829 ["lvremove"; "/dev/VG"];
2831 InitEmpty, Always, TestOutputList (
2832 [["part_disk"; "/dev/sda"; "mbr"];
2833 ["pvcreate"; "/dev/sda1"];
2834 ["vgcreate"; "VG"; "/dev/sda1"];
2835 ["lvcreate"; "LV1"; "VG"; "50"];
2836 ["lvcreate"; "LV2"; "VG"; "50"];
2837 ["lvremove"; "/dev/VG"];
2839 "remove an LVM logical volume",
2841 Remove an LVM logical volume C<device>, where C<device> is
2842 the path to the LV, such as C</dev/VG/LV>.
2844 You can also remove all LVs in a volume group by specifying
2845 the VG name, C</dev/VG>.");
2847 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2848 [InitEmpty, Always, TestOutputList (
2849 [["part_disk"; "/dev/sda"; "mbr"];
2850 ["pvcreate"; "/dev/sda1"];
2851 ["vgcreate"; "VG"; "/dev/sda1"];
2852 ["lvcreate"; "LV1"; "VG"; "50"];
2853 ["lvcreate"; "LV2"; "VG"; "50"];
2856 InitEmpty, Always, TestOutputList (
2857 [["part_disk"; "/dev/sda"; "mbr"];
2858 ["pvcreate"; "/dev/sda1"];
2859 ["vgcreate"; "VG"; "/dev/sda1"];
2860 ["lvcreate"; "LV1"; "VG"; "50"];
2861 ["lvcreate"; "LV2"; "VG"; "50"];
2864 "remove an LVM volume group",
2866 Remove an LVM volume group C<vgname>, (for example C<VG>).
2868 This also forcibly removes all logical volumes in the volume
2871 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2872 [InitEmpty, Always, TestOutputListOfDevices (
2873 [["part_disk"; "/dev/sda"; "mbr"];
2874 ["pvcreate"; "/dev/sda1"];
2875 ["vgcreate"; "VG"; "/dev/sda1"];
2876 ["lvcreate"; "LV1"; "VG"; "50"];
2877 ["lvcreate"; "LV2"; "VG"; "50"];
2879 ["pvremove"; "/dev/sda1"];
2881 InitEmpty, Always, TestOutputListOfDevices (
2882 [["part_disk"; "/dev/sda"; "mbr"];
2883 ["pvcreate"; "/dev/sda1"];
2884 ["vgcreate"; "VG"; "/dev/sda1"];
2885 ["lvcreate"; "LV1"; "VG"; "50"];
2886 ["lvcreate"; "LV2"; "VG"; "50"];
2888 ["pvremove"; "/dev/sda1"];
2890 InitEmpty, Always, TestOutputListOfDevices (
2891 [["part_disk"; "/dev/sda"; "mbr"];
2892 ["pvcreate"; "/dev/sda1"];
2893 ["vgcreate"; "VG"; "/dev/sda1"];
2894 ["lvcreate"; "LV1"; "VG"; "50"];
2895 ["lvcreate"; "LV2"; "VG"; "50"];
2897 ["pvremove"; "/dev/sda1"];
2899 "remove an LVM physical volume",
2901 This wipes a physical volume C<device> so that LVM will no longer
2904 The implementation uses the C<pvremove> command which refuses to
2905 wipe physical volumes that contain any volume groups, so you have
2906 to remove those first.");
2908 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2909 [InitBasicFS, Always, TestOutput (
2910 [["set_e2label"; "/dev/sda1"; "testlabel"];
2911 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2912 "set the ext2/3/4 filesystem label",
2914 This sets the ext2/3/4 filesystem label of the filesystem on
2915 C<device> to C<label>. Filesystem labels are limited to
2918 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2919 to return the existing label on a filesystem.");
2921 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2923 "get the ext2/3/4 filesystem label",
2925 This returns the ext2/3/4 filesystem label of the filesystem on
2928 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2929 (let uuid = uuidgen () in
2930 [InitBasicFS, Always, TestOutput (
2931 [["set_e2uuid"; "/dev/sda1"; uuid];
2932 ["get_e2uuid"; "/dev/sda1"]], uuid);
2933 InitBasicFS, Always, TestOutput (
2934 [["set_e2uuid"; "/dev/sda1"; "clear"];
2935 ["get_e2uuid"; "/dev/sda1"]], "");
2936 (* We can't predict what UUIDs will be, so just check the commands run. *)
2937 InitBasicFS, Always, TestRun (
2938 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2939 InitBasicFS, Always, TestRun (
2940 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2941 "set the ext2/3/4 filesystem UUID",
2943 This sets the ext2/3/4 filesystem UUID of the filesystem on
2944 C<device> to C<uuid>. The format of the UUID and alternatives
2945 such as C<clear>, C<random> and C<time> are described in the
2946 L<tune2fs(8)> manpage.
2948 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2949 to return the existing UUID of a filesystem.");
2951 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2952 (* Regression test for RHBZ#597112. *)
2953 (let uuid = uuidgen () in
2954 [InitNone, Always, TestOutput (
2955 [["mke2journal"; "1024"; "/dev/sdc"];
2956 ["set_e2uuid"; "/dev/sdc"; uuid];
2957 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2958 "get the ext2/3/4 filesystem UUID",
2960 This returns the ext2/3/4 filesystem UUID of the filesystem on
2963 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2964 [InitBasicFS, Always, TestOutputInt (
2965 [["umount"; "/dev/sda1"];
2966 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2967 InitBasicFS, Always, TestOutputInt (
2968 [["umount"; "/dev/sda1"];
2969 ["zero"; "/dev/sda1"];
2970 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2971 "run the filesystem checker",
2973 This runs the filesystem checker (fsck) on C<device> which
2974 should have filesystem type C<fstype>.
2976 The returned integer is the status. See L<fsck(8)> for the
2977 list of status codes from C<fsck>.
2985 Multiple status codes can be summed together.
2989 A non-zero return code can mean \"success\", for example if
2990 errors have been corrected on the filesystem.
2994 Checking or repairing NTFS volumes is not supported
2999 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3001 ("zero", (RErr, [Device "device"], []), 85, [Progress],
3002 [InitBasicFS, Always, TestRun (
3003 [["umount"; "/dev/sda1"];
3004 ["zero"; "/dev/sda1"]])],
3005 "write zeroes to the device",
3007 This command writes zeroes over the first few blocks of C<device>.
3009 How many blocks are zeroed isn't specified (but it's I<not> enough
3010 to securely wipe the device). It should be sufficient to remove
3011 any partition tables, filesystem superblocks and so on.
3013 If blocks are already zero, then this command avoids writing
3014 zeroes. This prevents the underlying device from becoming non-sparse
3015 or growing unnecessarily.
3017 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3018 C<guestfs_is_zero_device>");
3020 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3022 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3023 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3025 [InitBasicFS, Always, TestOutputTrue (
3026 [["mkdir_p"; "/boot/grub"];
3027 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3028 ["grub_install"; "/"; "/dev/vda"];
3029 ["is_dir"; "/boot"]])],
3032 This command installs GRUB 1 (the Grand Unified Bootloader) on
3033 C<device>, with the root directory being C<root>.
3041 There is currently no way in the API to install grub2, which
3042 is used by most modern Linux guests. It is possible to run
3043 the grub2 command from the guest, although see the
3044 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3048 This uses C<grub-install> from the host. Unfortunately grub is
3049 not always compatible with itself, so this only works in rather
3050 narrow circumstances. Careful testing with each guest version
3055 If grub-install reports the error
3056 \"No suitable drive was found in the generated device map.\"
3057 it may be that you need to create a C</boot/grub/device.map>
3058 file first that contains the mapping between grub device names
3059 and Linux device names. It is usually sufficient to create
3064 replacing C</dev/vda> with the name of the installation device.
3068 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3069 [InitScratchFS, Always, TestOutput (
3071 ["write"; "/cp/old"; "file content"];
3072 ["cp"; "/cp/old"; "/cp/new"];
3073 ["cat"; "/cp/new"]], "file content");
3074 InitScratchFS, Always, TestOutputTrue (
3076 ["write"; "/cp2/old"; "file content"];
3077 ["cp"; "/cp2/old"; "/cp2/new"];
3078 ["is_file"; "/cp2/old"]]);
3079 InitScratchFS, Always, TestOutput (
3081 ["write"; "/cp3/old"; "file content"];
3082 ["mkdir"; "/cp3/dir"];
3083 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3084 ["cat"; "/cp3/dir/new"]], "file content")],
3087 This copies a file from C<src> to C<dest> where C<dest> is
3088 either a destination filename or destination directory.");
3090 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3091 [InitScratchFS, Always, TestOutput (
3092 [["mkdir"; "/cp_a1"];
3093 ["mkdir"; "/cp_a2"];
3094 ["write"; "/cp_a1/file"; "file content"];
3095 ["cp_a"; "/cp_a1"; "/cp_a2"];
3096 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3097 "copy a file or directory recursively",
3099 This copies a file or directory from C<src> to C<dest>
3100 recursively using the C<cp -a> command.");
3102 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3103 [InitScratchFS, Always, TestOutput (
3105 ["write"; "/mv/old"; "file content"];
3106 ["mv"; "/mv/old"; "/mv/new"];
3107 ["cat"; "/mv/new"]], "file content");
3108 InitScratchFS, Always, TestOutputFalse (
3110 ["write"; "/mv2/old"; "file content"];
3111 ["mv"; "/mv2/old"; "/mv2/new"];
3112 ["is_file"; "/mv2/old"]])],
3115 This moves a file from C<src> to C<dest> where C<dest> is
3116 either a destination filename or destination directory.");
3118 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3119 [InitEmpty, Always, TestRun (
3120 [["drop_caches"; "3"]])],
3121 "drop kernel page cache, dentries and inodes",
3123 This instructs the guest kernel to drop its page cache,
3124 and/or dentries and inode caches. The parameter C<whattodrop>
3125 tells the kernel what precisely to drop, see
3126 L<http://linux-mm.org/Drop_Caches>
3128 Setting C<whattodrop> to 3 should drop everything.
3130 This automatically calls L<sync(2)> before the operation,
3131 so that the maximum guest memory is freed.");
3133 ("dmesg", (RString "kmsgs", [], []), 91, [],
3134 [InitEmpty, Always, TestRun (
3136 "return kernel messages",
3138 This returns the kernel messages (C<dmesg> output) from
3139 the guest kernel. This is sometimes useful for extended
3140 debugging of problems.
3142 Another way to get the same information is to enable
3143 verbose messages with C<guestfs_set_verbose> or by setting
3144 the environment variable C<LIBGUESTFS_DEBUG=1> before
3145 running the program.");
3147 ("ping_daemon", (RErr, [], []), 92, [],
3148 [InitEmpty, Always, TestRun (
3149 [["ping_daemon"]])],
3150 "ping the guest daemon",
3152 This is a test probe into the guestfs daemon running inside
3153 the qemu subprocess. Calling this function checks that the
3154 daemon responds to the ping message, without affecting the daemon
3155 or attached block device(s) in any other way.");
3157 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3158 [InitScratchFS, Always, TestOutputTrue (
3159 [["mkdir"; "/equal"];
3160 ["write"; "/equal/file1"; "contents of a file"];
3161 ["cp"; "/equal/file1"; "/equal/file2"];
3162 ["equal"; "/equal/file1"; "/equal/file2"]]);
3163 InitScratchFS, Always, TestOutputFalse (
3164 [["mkdir"; "/equal2"];
3165 ["write"; "/equal2/file1"; "contents of a file"];
3166 ["write"; "/equal2/file2"; "contents of another file"];
3167 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3168 InitScratchFS, Always, TestLastFail (
3169 [["mkdir"; "/equal3"];
3170 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3171 "test if two files have equal contents",
3173 This compares the two files C<file1> and C<file2> and returns
3174 true if their content is exactly equal, or false otherwise.
3176 The external L<cmp(1)> program is used for the comparison.");
3178 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3179 [InitISOFS, Always, TestOutputList (
3180 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3181 InitISOFS, Always, TestOutputList (
3182 [["strings"; "/empty"]], []);
3183 (* Test for RHBZ#579608, absolute symbolic links. *)
3184 InitISOFS, Always, TestRun (
3185 [["strings"; "/abssymlink"]])],
3186 "print the printable strings in a file",
3188 This runs the L<strings(1)> command on a file and returns
3189 the list of printable strings found.");
3191 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3192 [InitISOFS, Always, TestOutputList (
3193 [["strings_e"; "b"; "/known-5"]], []);
3194 InitScratchFS, Always, TestOutputList (
3195 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3196 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3197 "print the printable strings in a file",
3199 This is like the C<guestfs_strings> command, but allows you to
3200 specify the encoding of strings that are looked for in
3201 the source file C<path>.
3203 Allowed encodings are:
3209 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3210 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3214 Single 8-bit-byte characters.
3218 16-bit big endian strings such as those encoded in
3219 UTF-16BE or UCS-2BE.
3221 =item l (lower case letter L)
3223 16-bit little endian such as UTF-16LE and UCS-2LE.
3224 This is useful for examining binaries in Windows guests.
3228 32-bit big endian such as UCS-4BE.
3232 32-bit little endian such as UCS-4LE.
3236 The returned strings are transcoded to UTF-8.");
3238 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3239 [InitISOFS, Always, TestOutput (
3240 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3241 (* Test for RHBZ#501888c2 regression which caused large hexdump
3242 * commands to segfault.
3244 InitISOFS, Always, TestRun (
3245 [["hexdump"; "/100krandom"]]);
3246 (* Test for RHBZ#579608, absolute symbolic links. *)
3247 InitISOFS, Always, TestRun (
3248 [["hexdump"; "/abssymlink"]])],
3249 "dump a file in hexadecimal",
3251 This runs C<hexdump -C> on the given C<path>. The result is
3252 the human-readable, canonical hex dump of the file.");
3254 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3255 [InitNone, Always, TestOutput (
3256 [["part_disk"; "/dev/sda"; "mbr"];
3257 ["mkfs"; "ext3"; "/dev/sda1"];
3258 ["mount_options"; ""; "/dev/sda1"; "/"];
3259 ["write"; "/new"; "test file"];
3260 ["umount"; "/dev/sda1"];
3261 ["zerofree"; "/dev/sda1"];
3262 ["mount_options"; ""; "/dev/sda1"; "/"];
3263 ["cat"; "/new"]], "test file")],
3264 "zero unused inodes and disk blocks on ext2/3 filesystem",
3266 This runs the I<zerofree> program on C<device>. This program
3267 claims to zero unused inodes and disk blocks on an ext2/3
3268 filesystem, thus making it possible to compress the filesystem
3271 You should B<not> run this program if the filesystem is
3274 It is possible that using this program can damage the filesystem
3275 or data on the filesystem.");
3277 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3279 "resize an LVM physical volume",
3281 This resizes (expands or shrinks) an existing LVM physical
3282 volume to match the new size of the underlying device.");
3284 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3285 Int "cyls"; Int "heads"; Int "sectors";
3286 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3288 "modify a single partition on a block device",
3290 This runs L<sfdisk(8)> option to modify just the single
3291 partition C<n> (note: C<n> counts from 1).
3293 For other parameters, see C<guestfs_sfdisk>. You should usually
3294 pass C<0> for the cyls/heads/sectors parameters.
3296 See also: C<guestfs_part_add>");
3298 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3300 "display the partition table",
3302 This displays the partition table on C<device>, in the
3303 human-readable output of the L<sfdisk(8)> command. It is
3304 not intended to be parsed.
3306 See also: C<guestfs_part_list>");
3308 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3310 "display the kernel geometry",
3312 This displays the kernel's idea of the geometry of C<device>.
3314 The result is in human-readable format, and not designed to
3317 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3319 "display the disk geometry from the partition table",
3321 This displays the disk geometry of C<device> read from the
3322 partition table. Especially in the case where the underlying
3323 block device has been resized, this can be different from the
3324 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3326 The result is in human-readable format, and not designed to
3329 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3331 "activate or deactivate all volume groups",
3333 This command activates or (if C<activate> is false) deactivates
3334 all logical volumes in all volume groups.
3336 This command is the same as running C<vgchange -a y|n>");
3338 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3340 "activate or deactivate some volume groups",
3342 This command activates or (if C<activate> is false) deactivates
3343 all logical volumes in the listed volume groups C<volgroups>.
3345 This command is the same as running C<vgchange -a y|n volgroups...>
3347 Note that if C<volgroups> is an empty list then B<all> volume groups
3348 are activated or deactivated.");
3350 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3351 [InitNone, Always, TestOutput (
3352 [["part_disk"; "/dev/sda"; "mbr"];
3353 ["pvcreate"; "/dev/sda1"];
3354 ["vgcreate"; "VG"; "/dev/sda1"];
3355 ["lvcreate"; "LV"; "VG"; "10"];
3356 ["mkfs"; "ext2"; "/dev/VG/LV"];
3357 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3358 ["write"; "/new"; "test content"];
3360 ["lvresize"; "/dev/VG/LV"; "20"];
3361 ["e2fsck_f"; "/dev/VG/LV"];
3362 ["resize2fs"; "/dev/VG/LV"];
3363 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3364 ["cat"; "/new"]], "test content");
3365 InitNone, Always, TestRun (
3366 (* Make an LV smaller to test RHBZ#587484. *)
3367 [["part_disk"; "/dev/sda"; "mbr"];
3368 ["pvcreate"; "/dev/sda1"];
3369 ["vgcreate"; "VG"; "/dev/sda1"];
3370 ["lvcreate"; "LV"; "VG"; "20"];
3371 ["lvresize"; "/dev/VG/LV"; "10"]])],
3372 "resize an LVM logical volume",
3374 This resizes (expands or shrinks) an existing LVM logical
3375 volume to C<mbytes>. When reducing, data in the reduced part
3378 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3379 [], (* lvresize tests this *)
3380 "resize an ext2, ext3 or ext4 filesystem",
3382 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3383 the underlying device.
3385 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3386 on the C<device> before calling this command. For unknown reasons
3387 C<resize2fs> sometimes gives an error about this and sometimes not.
3388 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3389 calling this function.");
3391 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3392 [InitBasicFS, Always, TestOutputList (
3393 [["find"; "/"]], ["lost+found"]);
3394 InitBasicFS, Always, TestOutputList (
3398 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3399 InitScratchFS, Always, TestOutputList (
3400 [["mkdir_p"; "/find/b/c"];
3401 ["touch"; "/find/b/c/d"];
3402 ["find"; "/find/b/"]], ["c"; "c/d"])],
3403 "find all files and directories",
3405 This command lists out all files and directories, recursively,
3406 starting at C<directory>. It is essentially equivalent to
3407 running the shell command C<find directory -print> but some
3408 post-processing happens on the output, described below.
3410 This returns a list of strings I<without any prefix>. Thus
3411 if the directory structure was:
3417 then the returned list from C<guestfs_find> C</tmp> would be
3425 If C<directory> is not a directory, then this command returns
3428 The returned list is sorted.
3430 See also C<guestfs_find0>.");
3432 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3433 [], (* lvresize tests this *)
3434 "check an ext2/ext3 filesystem",
3436 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3437 filesystem checker on C<device>, noninteractively (I<-p>),
3438 even if the filesystem appears to be clean (I<-f>).
3440 This command is only needed because of C<guestfs_resize2fs>
3441 (q.v.). Normally you should use C<guestfs_fsck>.");
3443 ("sleep", (RErr, [Int "secs"], []), 109, [],
3444 [InitNone, Always, TestRun (
3446 "sleep for some seconds",
3448 Sleep for C<secs> seconds.");
3450 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3451 [InitNone, Always, TestOutputInt (
3452 [["part_disk"; "/dev/sda"; "mbr"];
3453 ["mkfs"; "ntfs"; "/dev/sda1"];
3454 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3455 InitNone, Always, TestOutputInt (
3456 [["part_disk"; "/dev/sda"; "mbr"];
3457 ["mkfs"; "ext2"; "/dev/sda1"];
3458 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3459 "probe NTFS volume",
3461 This command runs the L<ntfs-3g.probe(8)> command which probes
3462 an NTFS C<device> for mountability. (Not all NTFS volumes can
3463 be mounted read-write, and some cannot be mounted at all).
3465 C<rw> is a boolean flag. Set it to true if you want to test
3466 if the volume can be mounted read-write. Set it to false if
3467 you want to test if the volume can be mounted read-only.
3469 The return value is an integer which C<0> if the operation
3470 would succeed, or some non-zero value documented in the
3471 L<ntfs-3g.probe(8)> manual page.");
3473 ("sh", (RString "output", [String "command"], []), 111, [],
3474 [], (* XXX needs tests *)
3475 "run a command via the shell",
3477 This call runs a command from the guest filesystem via the
3480 This is like C<guestfs_command>, but passes the command to:
3482 /bin/sh -c \"command\"
3484 Depending on the guest's shell, this usually results in
3485 wildcards being expanded, shell expressions being interpolated
3488 All the provisos about C<guestfs_command> apply to this call.");
3490 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3491 [], (* XXX needs tests *)
3492 "run a command via the shell returning lines",
3494 This is the same as C<guestfs_sh>, but splits the result
3495 into a list of lines.
3497 See also: C<guestfs_command_lines>");
3499 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3500 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3501 * code in stubs.c, since all valid glob patterns must start with "/".
3502 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3504 [InitScratchFS, Always, TestOutputList (
3505 [["mkdir_p"; "/glob_expand/b/c"];
3506 ["touch"; "/glob_expand/b/c/d"];
3507 ["touch"; "/glob_expand/b/c/e"];
3508 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3509 InitScratchFS, Always, TestOutputList (
3510 [["mkdir_p"; "/glob_expand2/b/c"];
3511 ["touch"; "/glob_expand2/b/c/d"];
3512 ["touch"; "/glob_expand2/b/c/e"];
3513 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3514 InitScratchFS, Always, TestOutputList (
3515 [["mkdir_p"; "/glob_expand3/b/c"];
3516 ["touch"; "/glob_expand3/b/c/d"];
3517 ["touch"; "/glob_expand3/b/c/e"];
3518 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3519 "expand a wildcard path",
3521 This command searches for all the pathnames matching
3522 C<pattern> according to the wildcard expansion rules
3525 If no paths match, then this returns an empty list
3526 (note: not an error).
3528 It is just a wrapper around the C L<glob(3)> function
3529 with flags C<GLOB_MARK|GLOB_BRACE>.
3530 See that manual page for more details.");
3532 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3533 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3534 [["scrub_device"; "/dev/sdc"]])],
3535 "scrub (securely wipe) a device",
3537 This command writes patterns over C<device> to make data retrieval
3540 It is an interface to the L<scrub(1)> program. See that
3541 manual page for more details.");
3543 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3544 [InitScratchFS, Always, TestRun (
3545 [["write"; "/scrub_file"; "content"];
3546 ["scrub_file"; "/scrub_file"]])],
3547 "scrub (securely wipe) a file",
3549 This command writes patterns over a file to make data retrieval
3552 The file is I<removed> after scrubbing.
3554 It is an interface to the L<scrub(1)> program. See that
3555 manual page for more details.");
3557 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3558 [], (* XXX needs testing *)
3559 "scrub (securely wipe) free space",
3561 This command creates the directory C<dir> and then fills it
3562 with files until the filesystem is full, and scrubs the files
3563 as for C<guestfs_scrub_file>, and deletes them.
3564 The intention is to scrub any free space on the partition
3567 It is an interface to the L<scrub(1)> program. See that
3568 manual page for more details.");
3570 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3571 [InitScratchFS, Always, TestRun (
3572 [["mkdir"; "/mkdtemp"];
3573 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3574 "create a temporary directory",
3576 This command creates a temporary directory. The
3577 C<template> parameter should be a full pathname for the
3578 temporary directory name with the final six characters being
3581 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3582 the second one being suitable for Windows filesystems.
3584 The name of the temporary directory that was created
3587 The temporary directory is created with mode 0700
3588 and is owned by root.
3590 The caller is responsible for deleting the temporary
3591 directory and its contents after use.
3593 See also: L<mkdtemp(3)>");
3595 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3596 [InitISOFS, Always, TestOutputInt (
3597 [["wc_l"; "/10klines"]], 10000);
3598 (* Test for RHBZ#579608, absolute symbolic links. *)
3599 InitISOFS, Always, TestOutputInt (
3600 [["wc_l"; "/abssymlink"]], 10000)],
3601 "count lines in a file",
3603 This command counts the lines in a file, using the
3604 C<wc -l> external command.");
3606 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3607 [InitISOFS, Always, TestOutputInt (
3608 [["wc_w"; "/10klines"]], 10000)],
3609 "count words in a file",
3611 This command counts the words in a file, using the
3612 C<wc -w> external command.");
3614 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3615 [InitISOFS, Always, TestOutputInt (
3616 [["wc_c"; "/100kallspaces"]], 102400)],
3617 "count characters in a file",
3619 This command counts the characters in a file, using the
3620 C<wc -c> external command.");
3622 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3623 [InitISOFS, Always, TestOutputList (
3624 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3625 (* Test for RHBZ#579608, absolute symbolic links. *)
3626 InitISOFS, Always, TestOutputList (
3627 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3628 "return first 10 lines of a file",
3630 This command returns up to the first 10 lines of a file as
3631 a list of strings.");
3633 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3634 [InitISOFS, Always, TestOutputList (
3635 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3636 InitISOFS, Always, TestOutputList (
3637 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3638 InitISOFS, Always, TestOutputList (
3639 [["head_n"; "0"; "/10klines"]], [])],
3640 "return first N lines of a file",
3642 If the parameter C<nrlines> is a positive number, this returns the first
3643 C<nrlines> lines of the file C<path>.
3645 If the parameter C<nrlines> is a negative number, this returns lines
3646 from the file C<path>, excluding the last C<nrlines> lines.
3648 If the parameter C<nrlines> is zero, this returns an empty list.");
3650 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3651 [InitISOFS, Always, TestOutputList (
3652 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3653 "return last 10 lines of a file",
3655 This command returns up to the last 10 lines of a file as
3656 a list of strings.");
3658 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3659 [InitISOFS, Always, TestOutputList (
3660 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3661 InitISOFS, Always, TestOutputList (
3662 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3663 InitISOFS, Always, TestOutputList (
3664 [["tail_n"; "0"; "/10klines"]], [])],
3665 "return last N lines of a file",
3667 If the parameter C<nrlines> is a positive number, this returns the last
3668 C<nrlines> lines of the file C<path>.
3670 If the parameter C<nrlines> is a negative number, this returns lines
3671 from the file C<path>, starting with the C<-nrlines>th line.
3673 If the parameter C<nrlines> is zero, this returns an empty list.");
3675 ("df", (RString "output", [], []), 125, [],
3676 [], (* XXX Tricky to test because it depends on the exact format
3677 * of the 'df' command and other imponderables.
3679 "report file system disk space usage",
3681 This command runs the C<df> command to report disk space used.
3683 This command is mostly useful for interactive sessions. It
3684 is I<not> intended that you try to parse the output string.
3685 Use C<guestfs_statvfs> from programs.");
3687 ("df_h", (RString "output", [], []), 126, [],
3688 [], (* XXX Tricky to test because it depends on the exact format
3689 * of the 'df' command and other imponderables.
3691 "report file system disk space usage (human readable)",
3693 This command runs the C<df -h> command to report disk space used
3694 in human-readable format.
3696 This command is mostly useful for interactive sessions. It
3697 is I<not> intended that you try to parse the output string.
3698 Use C<guestfs_statvfs> from programs.");
3700 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3701 [InitISOFS, Always, TestOutputInt (
3702 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3703 "estimate file space usage",
3705 This command runs the C<du -s> command to estimate file space
3708 C<path> can be a file or a directory. If C<path> is a directory
3709 then the estimate includes the contents of the directory and all
3710 subdirectories (recursively).
3712 The result is the estimated size in I<kilobytes>
3713 (ie. units of 1024 bytes).");
3715 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3716 [InitISOFS, Always, TestOutputList (
3717 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3718 "list files in an initrd",
3720 This command lists out files contained in an initrd.
3722 The files are listed without any initial C</> character. The
3723 files are listed in the order they appear (not necessarily
3724 alphabetical). Directory names are listed as separate items.
3726 Old Linux kernels (2.4 and earlier) used a compressed ext2
3727 filesystem as initrd. We I<only> support the newer initramfs
3728 format (compressed cpio files).");
3730 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3732 "mount a file using the loop device",
3734 This command lets you mount C<file> (a filesystem image
3735 in a file) on a mount point. It is entirely equivalent to
3736 the command C<mount -o loop file mountpoint>.");
3738 ("mkswap", (RErr, [Device "device"], []), 130, [],
3739 [InitEmpty, Always, TestRun (
3740 [["part_disk"; "/dev/sda"; "mbr"];
3741 ["mkswap"; "/dev/sda1"]])],
3742 "create a swap partition",
3744 Create a swap partition on C<device>.");
3746 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3747 [InitEmpty, Always, TestRun (
3748 [["part_disk"; "/dev/sda"; "mbr"];
3749 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3750 "create a swap partition with a label",
3752 Create a swap partition on C<device> with label C<label>.
3754 Note that you cannot attach a swap label to a block device
3755 (eg. C</dev/sda>), just to a partition. This appears to be
3756 a limitation of the kernel or swap tools.");
3758 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3759 (let uuid = uuidgen () in
3760 [InitEmpty, Always, TestRun (
3761 [["part_disk"; "/dev/sda"; "mbr"];
3762 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3763 "create a swap partition with an explicit UUID",
3765 Create a swap partition on C<device> with UUID C<uuid>.");
3767 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3768 [InitScratchFS, Always, TestOutputStruct (
3769 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3770 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3771 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3772 InitScratchFS, Always, TestOutputStruct (
3773 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3774 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3775 "make block, character or FIFO devices",
3777 This call creates block or character special devices, or
3778 named pipes (FIFOs).
3780 The C<mode> parameter should be the mode, using the standard
3781 constants. C<devmajor> and C<devminor> are the
3782 device major and minor numbers, only used when creating block
3783 and character special devices.
3785 Note that, just like L<mknod(2)>, the mode must be bitwise
3786 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3787 just creates a regular file). These constants are
3788 available in the standard Linux header files, or you can use
3789 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3790 which are wrappers around this command which bitwise OR
3791 in the appropriate constant for you.
3793 The mode actually set is affected by the umask.");
3795 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3796 [InitScratchFS, Always, TestOutputStruct (
3797 [["mkfifo"; "0o777"; "/mkfifo"];
3798 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3799 "make FIFO (named pipe)",
3801 This call creates a FIFO (named pipe) called C<path> with
3802 mode C<mode>. It is just a convenient wrapper around
3805 The mode actually set is affected by the umask.");
3807 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3808 [InitScratchFS, Always, TestOutputStruct (
3809 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3810 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3811 "make block device node",
3813 This call creates a block device node called C<path> with
3814 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3815 It is just a convenient wrapper around C<guestfs_mknod>.
3817 The mode actually set is affected by the umask.");
3819 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3820 [InitScratchFS, Always, TestOutputStruct (
3821 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3822 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3823 "make char device node",
3825 This call creates a char device node called C<path> with
3826 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3827 It is just a convenient wrapper around C<guestfs_mknod>.
3829 The mode actually set is affected by the umask.");
3831 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3832 [InitEmpty, Always, TestOutputInt (
3833 [["umask"; "0o22"]], 0o22)],
3834 "set file mode creation mask (umask)",
3836 This function sets the mask used for creating new files and
3837 device nodes to C<mask & 0777>.
3839 Typical umask values would be C<022> which creates new files
3840 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3841 C<002> which creates new files with permissions like
3842 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3844 The default umask is C<022>. This is important because it
3845 means that directories and device nodes will be created with
3846 C<0644> or C<0755> mode even if you specify C<0777>.
3848 See also C<guestfs_get_umask>,
3849 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3851 This call returns the previous umask.");
3853 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3855 "read directories entries",
3857 This returns the list of directory entries in directory C<dir>.
3859 All entries in the directory are returned, including C<.> and
3860 C<..>. The entries are I<not> sorted, but returned in the same
3861 order as the underlying filesystem.
3863 Also this call returns basic file type information about each
3864 file. The C<ftyp> field will contain one of the following characters:
3902 The L<readdir(3)> call returned a C<d_type> field with an
3907 This function is primarily intended for use by programs. To
3908 get a simple list of names, use C<guestfs_ls>. To get a printable
3909 directory for human consumption, use C<guestfs_ll>.");
3911 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3913 "create partitions on a block device",
3915 This is a simplified interface to the C<guestfs_sfdisk>
3916 command, where partition sizes are specified in megabytes
3917 only (rounded to the nearest cylinder) and you don't need
3918 to specify the cyls, heads and sectors parameters which
3919 were rarely if ever used anyway.
3921 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3922 and C<guestfs_part_disk>");
3924 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3926 "determine file type inside a compressed file",
3928 This command runs C<file> after first decompressing C<path>
3931 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3933 Since 1.0.63, use C<guestfs_file> instead which can now
3934 process compressed files.");
3936 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3938 "list extended attributes of a file or directory",
3940 This call lists the extended attributes of the file or directory
3943 At the system call level, this is a combination of the
3944 L<listxattr(2)> and L<getxattr(2)> calls.
3946 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3948 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3950 "list extended attributes of a file or directory",
3952 This is the same as C<guestfs_getxattrs>, but if C<path>
3953 is a symbolic link, then it returns the extended attributes
3954 of the link itself.");
3956 ("setxattr", (RErr, [String "xattr";
3957 String "val"; Int "vallen"; (* will be BufferIn *)
3958 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3960 "set extended attribute of a file or directory",
3962 This call sets the extended attribute named C<xattr>
3963 of the file C<path> to the value C<val> (of length C<vallen>).
3964 The value is arbitrary 8 bit data.
3966 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3968 ("lsetxattr", (RErr, [String "xattr";
3969 String "val"; Int "vallen"; (* will be BufferIn *)
3970 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3972 "set extended attribute of a file or directory",
3974 This is the same as C<guestfs_setxattr>, but if C<path>
3975 is a symbolic link, then it sets an extended attribute
3976 of the link itself.");
3978 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3980 "remove extended attribute of a file or directory",
3982 This call removes the extended attribute named C<xattr>
3983 of the file C<path>.
3985 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3987 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3989 "remove extended attribute of a file or directory",
3991 This is the same as C<guestfs_removexattr>, but if C<path>
3992 is a symbolic link, then it removes an extended attribute
3993 of the link itself.");
3995 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3999 This call is similar to C<guestfs_mounts>. That call returns
4000 a list of devices. This one returns a hash table (map) of
4001 device name to directory where the device is mounted.");
4003 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
4004 (* This is a special case: while you would expect a parameter
4005 * of type "Pathname", that doesn't work, because it implies
4006 * NEED_ROOT in the generated calling code in stubs.c, and
4007 * this function cannot use NEED_ROOT.
4010 "create a mountpoint",
4012 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
4013 specialized calls that can be used to create extra mountpoints
4014 before mounting the first filesystem.
4016 These calls are I<only> necessary in some very limited circumstances,
4017 mainly the case where you want to mount a mix of unrelated and/or
4018 read-only filesystems together.
4020 For example, live CDs often contain a \"Russian doll\" nest of
4021 filesystems, an ISO outer layer, with a squashfs image inside, with
4022 an ext2/3 image inside that. You can unpack this as follows
4025 add-ro Fedora-11-i686-Live.iso
4029 mkmountpoint /ext3fs
4031 mount-loop /cd/LiveOS/squashfs.img /sqsh
4032 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4034 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4036 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4037 You may get unexpected errors if you try to mix these calls. It is
4038 safest to manually unmount filesystems and remove mountpoints after use.
4040 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4041 longest first, so for this to work for manual mountpoints, you
4042 must ensure that the innermost mountpoints have the longest
4043 pathnames, as in the example code above.
4045 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4047 Autosync [see C<guestfs_set_autosync>, this is set by default on
4048 handles] can cause C<guestfs_umount_all> to be called when the handle
4049 is closed which can also trigger these issues.");
4051 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4053 "remove a mountpoint",
4055 This calls removes a mountpoint that was previously created
4056 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4057 for full details.");
4059 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4060 [InitISOFS, Always, TestOutputBuffer (
4061 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4062 (* Test various near large, large and too large files (RHBZ#589039). *)
4063 InitScratchFS, Always, TestLastFail (
4064 [["touch"; "/read_file"];
4065 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4066 ["read_file"; "/read_file"]]);
4067 InitScratchFS, Always, TestLastFail (
4068 [["touch"; "/read_file2"];
4069 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4070 ["read_file"; "/read_file2"]]);
4071 InitScratchFS, Always, TestLastFail (
4072 [["touch"; "/read_file3"];
4073 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4074 ["read_file"; "/read_file3"]])],
4077 This calls returns the contents of the file C<path> as a
4080 Unlike C<guestfs_cat>, this function can correctly
4081 handle files that contain embedded ASCII NUL characters.
4082 However unlike C<guestfs_download>, this function is limited
4083 in the total size of file that can be handled.");
4085 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4086 [InitISOFS, Always, TestOutputList (
4087 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4088 InitISOFS, Always, TestOutputList (
4089 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4090 (* Test for RHBZ#579608, absolute symbolic links. *)
4091 InitISOFS, Always, TestOutputList (
4092 [["grep"; "nomatch"; "/abssymlink"]], [])],
4093 "return lines matching a pattern",
4095 This calls the external C<grep> program and returns the
4098 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4099 [InitISOFS, Always, TestOutputList (
4100 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4101 "return lines matching a pattern",
4103 This calls the external C<egrep> program and returns the
4106 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4107 [InitISOFS, Always, TestOutputList (
4108 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4109 "return lines matching a pattern",
4111 This calls the external C<fgrep> program and returns the
4114 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4115 [InitISOFS, Always, TestOutputList (
4116 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4117 "return lines matching a pattern",
4119 This calls the external C<grep -i> program and returns the
4122 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4123 [InitISOFS, Always, TestOutputList (
4124 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4125 "return lines matching a pattern",
4127 This calls the external C<egrep -i> program and returns the
4130 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4131 [InitISOFS, Always, TestOutputList (
4132 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4133 "return lines matching a pattern",
4135 This calls the external C<fgrep -i> program and returns the
4138 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4139 [InitISOFS, Always, TestOutputList (
4140 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4141 "return lines matching a pattern",
4143 This calls the external C<zgrep> program and returns the
4146 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4147 [InitISOFS, Always, TestOutputList (
4148 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4149 "return lines matching a pattern",
4151 This calls the external C<zegrep> program and returns the
4154 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4155 [InitISOFS, Always, TestOutputList (
4156 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4157 "return lines matching a pattern",
4159 This calls the external C<zfgrep> program and returns the
4162 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4163 [InitISOFS, Always, TestOutputList (
4164 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4165 "return lines matching a pattern",
4167 This calls the external C<zgrep -i> program and returns the
4170 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4171 [InitISOFS, Always, TestOutputList (
4172 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4173 "return lines matching a pattern",
4175 This calls the external C<zegrep -i> program and returns the
4178 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4179 [InitISOFS, Always, TestOutputList (
4180 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4181 "return lines matching a pattern",
4183 This calls the external C<zfgrep -i> program and returns the
4186 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4187 [InitISOFS, Always, TestOutput (
4188 [["realpath"; "/../directory"]], "/directory")],
4189 "canonicalized absolute pathname",
4191 Return the canonicalized absolute pathname of C<path>. The
4192 returned path has no C<.>, C<..> or symbolic link path elements.");
4194 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4195 [InitScratchFS, Always, TestOutputStruct (
4198 ["ln"; "/ln/a"; "/ln/b"];
4199 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4200 "create a hard link",
4202 This command creates a hard link using the C<ln> command.");
4204 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4205 [InitScratchFS, Always, TestOutputStruct (
4206 [["mkdir"; "/ln_f"];
4207 ["touch"; "/ln_f/a"];
4208 ["touch"; "/ln_f/b"];
4209 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4210 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4211 "create a hard link",
4213 This command creates a hard link using the C<ln -f> command.
4214 The I<-f> option removes the link (C<linkname>) if it exists already.");
4216 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4217 [InitScratchFS, Always, TestOutputStruct (
4218 [["mkdir"; "/ln_s"];
4219 ["touch"; "/ln_s/a"];
4220 ["ln_s"; "a"; "/ln_s/b"];
4221 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4222 "create a symbolic link",
4224 This command creates a symbolic link using the C<ln -s> command.");
4226 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4227 [InitScratchFS, Always, TestOutput (
4228 [["mkdir_p"; "/ln_sf/b"];
4229 ["touch"; "/ln_sf/b/c"];
4230 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4231 ["readlink"; "/ln_sf/b/c"]], "../d")],
4232 "create a symbolic link",
4234 This command creates a symbolic link using the C<ln -sf> command,
4235 The I<-f> option removes the link (C<linkname>) if it exists already.");
4237 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4238 [] (* XXX tested above *),
4239 "read the target of a symbolic link",
4241 This command reads the target of a symbolic link.");
4243 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4244 [InitScratchFS, Always, TestOutputStruct (
4245 [["fallocate"; "/fallocate"; "1000000"];
4246 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4247 "preallocate a file in the guest filesystem",
4249 This command preallocates a file (containing zero bytes) named
4250 C<path> of size C<len> bytes. If the file exists already, it
4253 Do not confuse this with the guestfish-specific
4254 C<alloc> command which allocates a file in the host and
4255 attaches it as a device.");
4257 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4258 [InitPartition, Always, TestRun (
4259 [["mkswap"; "/dev/sda1"];
4260 ["swapon_device"; "/dev/sda1"];
4261 ["swapoff_device"; "/dev/sda1"]])],
4262 "enable swap on device",
4264 This command enables the libguestfs appliance to use the
4265 swap device or partition named C<device>. The increased
4266 memory is made available for all commands, for example
4267 those run using C<guestfs_command> or C<guestfs_sh>.
4269 Note that you should not swap to existing guest swap
4270 partitions unless you know what you are doing. They may
4271 contain hibernation information, or other information that
4272 the guest doesn't want you to trash. You also risk leaking
4273 information about the host to the guest this way. Instead,
4274 attach a new host device to the guest and swap on that.");
4276 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4277 [], (* XXX tested by swapon_device *)
4278 "disable swap on device",
4280 This command disables the libguestfs appliance swap
4281 device or partition named C<device>.
4282 See C<guestfs_swapon_device>.");
4284 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4285 [InitScratchFS, Always, TestRun (
4286 [["fallocate"; "/swapon_file"; "8388608"];
4287 ["mkswap_file"; "/swapon_file"];
4288 ["swapon_file"; "/swapon_file"];
4289 ["swapoff_file"; "/swapon_file"];
4290 ["rm"; "/swapon_file"]])],
4291 "enable swap on file",
4293 This command enables swap to a file.
4294 See C<guestfs_swapon_device> for other notes.");
4296 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4297 [], (* XXX tested by swapon_file *)
4298 "disable swap on file",
4300 This command disables the libguestfs appliance swap on file.");
4302 ("swapon_label", (RErr, [String "label"], []), 174, [],
4303 [InitEmpty, Always, TestRun (
4304 [["part_disk"; "/dev/sda"; "mbr"];
4305 ["mkswap_L"; "swapit"; "/dev/sda1"];
4306 ["swapon_label"; "swapit"];
4307 ["swapoff_label"; "swapit"];
4308 ["zero"; "/dev/sda"];
4309 ["blockdev_rereadpt"; "/dev/sda"]])],
4310 "enable swap on labeled swap partition",
4312 This command enables swap to a labeled swap partition.
4313 See C<guestfs_swapon_device> for other notes.");
4315 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4316 [], (* XXX tested by swapon_label *)
4317 "disable swap on labeled swap partition",
4319 This command disables the libguestfs appliance swap on
4320 labeled swap partition.");
4322 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4323 (let uuid = uuidgen () in
4324 [InitEmpty, Always, TestRun (
4325 [["mkswap_U"; uuid; "/dev/sdc"];
4326 ["swapon_uuid"; uuid];
4327 ["swapoff_uuid"; uuid]])]),
4328 "enable swap on swap partition by UUID",
4330 This command enables swap to a swap partition with the given UUID.
4331 See C<guestfs_swapon_device> for other notes.");
4333 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4334 [], (* XXX tested by swapon_uuid *)
4335 "disable swap on swap partition by UUID",
4337 This command disables the libguestfs appliance swap partition
4338 with the given UUID.");
4340 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4341 [InitScratchFS, Always, TestRun (
4342 [["fallocate"; "/mkswap_file"; "8388608"];
4343 ["mkswap_file"; "/mkswap_file"];
4344 ["rm"; "/mkswap_file"]])],
4345 "create a swap file",
4349 This command just writes a swap file signature to an existing
4350 file. To create the file itself, use something like C<guestfs_fallocate>.");
4352 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4353 [InitISOFS, Always, TestRun (
4354 [["inotify_init"; "0"]])],
4355 "create an inotify handle",
4357 This command creates a new inotify handle.
4358 The inotify subsystem can be used to notify events which happen to
4359 objects in the guest filesystem.
4361 C<maxevents> is the maximum number of events which will be
4362 queued up between calls to C<guestfs_inotify_read> or
4363 C<guestfs_inotify_files>.
4364 If this is passed as C<0>, then the kernel (or previously set)
4365 default is used. For Linux 2.6.29 the default was 16384 events.
4366 Beyond this limit, the kernel throws away events, but records
4367 the fact that it threw them away by setting a flag
4368 C<IN_Q_OVERFLOW> in the returned structure list (see
4369 C<guestfs_inotify_read>).
4371 Before any events are generated, you have to add some
4372 watches to the internal watch list. See:
4373 C<guestfs_inotify_add_watch>,
4374 C<guestfs_inotify_rm_watch> and
4375 C<guestfs_inotify_watch_all>.
4377 Queued up events should be read periodically by calling
4378 C<guestfs_inotify_read>
4379 (or C<guestfs_inotify_files> which is just a helpful
4380 wrapper around C<guestfs_inotify_read>). If you don't
4381 read the events out often enough then you risk the internal
4384 The handle should be closed after use by calling
4385 C<guestfs_inotify_close>. This also removes any
4386 watches automatically.
4388 See also L<inotify(7)> for an overview of the inotify interface
4389 as exposed by the Linux kernel, which is roughly what we expose
4390 via libguestfs. Note that there is one global inotify handle
4391 per libguestfs instance.");
4393 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4394 [InitScratchFS, Always, TestOutputList (
4395 [["mkdir"; "/inotify_add_watch"];
4396 ["inotify_init"; "0"];
4397 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4398 ["touch"; "/inotify_add_watch/a"];
4399 ["touch"; "/inotify_add_watch/b"];
4400 ["inotify_files"]], ["a"; "b"])],
4401 "add an inotify watch",
4403 Watch C<path> for the events listed in C<mask>.
4405 Note that if C<path> is a directory then events within that
4406 directory are watched, but this does I<not> happen recursively
4407 (in subdirectories).
4409 Note for non-C or non-Linux callers: the inotify events are
4410 defined by the Linux kernel ABI and are listed in
4411 C</usr/include/sys/inotify.h>.");
4413 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4415 "remove an inotify watch",
4417 Remove a previously defined inotify watch.
4418 See C<guestfs_inotify_add_watch>.");
4420 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4422 "return list of inotify events",
4424 Return the complete queue of events that have happened
4425 since the previous read call.
4427 If no events have happened, this returns an empty list.
4429 I<Note>: In order to make sure that all events have been
4430 read, you must call this function repeatedly until it
4431 returns an empty list. The reason is that the call will
4432 read events up to the maximum appliance-to-host message
4433 size and leave remaining events in the queue.");
4435 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4437 "return list of watched files that had events",
4439 This function is a helpful wrapper around C<guestfs_inotify_read>
4440 which just returns a list of pathnames of objects that were
4441 touched. The returned pathnames are sorted and deduplicated.");
4443 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4445 "close the inotify handle",
4447 This closes the inotify handle which was previously
4448 opened by inotify_init. It removes all watches, throws
4449 away any pending events, and deallocates all resources.");
4451 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4453 "set SELinux security context",
4455 This sets the SELinux security context of the daemon
4456 to the string C<context>.
4458 See the documentation about SELINUX in L<guestfs(3)>.");
4460 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4462 "get SELinux security context",
4464 This gets the SELinux security context of the daemon.
4466 See the documentation about SELINUX in L<guestfs(3)>,
4467 and C<guestfs_setcon>");
4469 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4470 [InitEmpty, Always, TestOutput (
4471 [["part_disk"; "/dev/sda"; "mbr"];
4472 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4473 ["mount_options"; ""; "/dev/sda1"; "/"];
4474 ["write"; "/new"; "new file contents"];
4475 ["cat"; "/new"]], "new file contents");
4476 InitEmpty, Always, TestRun (
4477 [["part_disk"; "/dev/sda"; "mbr"];
4478 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4479 InitEmpty, Always, TestLastFail (
4480 [["part_disk"; "/dev/sda"; "mbr"];
4481 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4482 InitEmpty, Always, TestLastFail (
4483 [["part_disk"; "/dev/sda"; "mbr"];
4484 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4485 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4486 [["part_disk"; "/dev/sda"; "mbr"];
4487 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4488 "make a filesystem with block size",
4490 This call is similar to C<guestfs_mkfs>, but it allows you to
4491 control the block size of the resulting filesystem. Supported
4492 block sizes depend on the filesystem type, but typically they
4493 are C<1024>, C<2048> or C<4096> only.
4495 For VFAT and NTFS the C<blocksize> parameter is treated as
4496 the requested cluster size.");
4498 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4499 [InitEmpty, Always, TestOutput (
4500 [["part_init"; "/dev/sda"; "mbr"];
4501 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4502 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4503 ["mke2journal"; "4096"; "/dev/sda1"];
4504 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4505 ["mount_options"; ""; "/dev/sda2"; "/"];
4506 ["write"; "/new"; "new file contents"];
4507 ["cat"; "/new"]], "new file contents")],
4508 "make ext2/3/4 external journal",
4510 This creates an ext2 external journal on C<device>. It is equivalent
4513 mke2fs -O journal_dev -b blocksize device");
4515 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4516 [InitEmpty, Always, TestOutput (
4517 [["part_init"; "/dev/sda"; "mbr"];
4518 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4519 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4520 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4521 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4522 ["mount_options"; ""; "/dev/sda2"; "/"];
4523 ["write"; "/new"; "new file contents"];
4524 ["cat"; "/new"]], "new file contents")],
4525 "make ext2/3/4 external journal with label",
4527 This creates an ext2 external journal on C<device> with label C<label>.");
4529 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4530 (let uuid = uuidgen () in
4531 [InitEmpty, Always, TestOutput (
4532 [["part_init"; "/dev/sda"; "mbr"];
4533 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4534 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4535 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4536 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4537 ["mount_options"; ""; "/dev/sda2"; "/"];
4538 ["write"; "/new"; "new file contents"];
4539 ["cat"; "/new"]], "new file contents")]),
4540 "make ext2/3/4 external journal with UUID",
4542 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4544 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4546 "make ext2/3/4 filesystem with external journal",
4548 This creates an ext2/3/4 filesystem on C<device> with
4549 an external journal on C<journal>. It is equivalent
4552 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4554 See also C<guestfs_mke2journal>.");
4556 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4558 "make ext2/3/4 filesystem with external journal",
4560 This creates an ext2/3/4 filesystem on C<device> with
4561 an external journal on the journal labeled C<label>.
4563 See also C<guestfs_mke2journal_L>.");
4565 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4567 "make ext2/3/4 filesystem with external journal",
4569 This creates an ext2/3/4 filesystem on C<device> with
4570 an external journal on the journal with UUID C<uuid>.
4572 See also C<guestfs_mke2journal_U>.");
4574 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4575 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4576 "load a kernel module",
4578 This loads a kernel module in the appliance.
4580 The kernel module must have been whitelisted when libguestfs
4581 was built (see C<appliance/kmod.whitelist.in> in the source).");
4583 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4584 [InitNone, Always, TestOutput (
4585 [["echo_daemon"; "This is a test"]], "This is a test"
4587 "echo arguments back to the client",
4589 This command concatenates the list of C<words> passed with single spaces
4590 between them and returns the resulting string.
4592 You can use this command to test the connection through to the daemon.
4594 See also C<guestfs_ping_daemon>.");
4596 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4597 [], (* There is a regression test for this. *)
4598 "find all files and directories, returning NUL-separated list",
4600 This command lists out all files and directories, recursively,
4601 starting at C<directory>, placing the resulting list in the
4602 external file called C<files>.
4604 This command works the same way as C<guestfs_find> with the
4605 following exceptions:
4611 The resulting list is written to an external file.
4615 Items (filenames) in the result are separated
4616 by C<\\0> characters. See L<find(1)> option I<-print0>.
4620 This command is not limited in the number of names that it
4625 The result list is not sorted.
4629 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4630 [InitISOFS, Always, TestOutput (
4631 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4632 InitISOFS, Always, TestOutput (
4633 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4634 InitISOFS, Always, TestOutput (
4635 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4636 InitISOFS, Always, TestLastFail (
4637 [["case_sensitive_path"; "/Known-1/"]]);
4638 InitScratchFS, Always, TestOutput (
4639 [["mkdir"; "/case_sensitive_path"];
4640 ["mkdir"; "/case_sensitive_path/bbb"];
4641 ["touch"; "/case_sensitive_path/bbb/c"];
4642 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4643 InitScratchFS, Always, TestOutput (
4644 [["mkdir"; "/case_sensitive_path2"];
4645 ["mkdir"; "/case_sensitive_path2/bbb"];
4646 ["touch"; "/case_sensitive_path2/bbb/c"];
4647 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4648 InitScratchFS, Always, TestLastFail (
4649 [["mkdir"; "/case_sensitive_path3"];
4650 ["mkdir"; "/case_sensitive_path3/bbb"];
4651 ["touch"; "/case_sensitive_path3/bbb/c"];
4652 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4653 "return true path on case-insensitive filesystem",
4655 This can be used to resolve case insensitive paths on
4656 a filesystem which is case sensitive. The use case is
4657 to resolve paths which you have read from Windows configuration
4658 files or the Windows Registry, to the true path.
4660 The command handles a peculiarity of the Linux ntfs-3g
4661 filesystem driver (and probably others), which is that although
4662 the underlying filesystem is case-insensitive, the driver
4663 exports the filesystem to Linux as case-sensitive.
4665 One consequence of this is that special directories such
4666 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4667 (or other things) depending on the precise details of how
4668 they were created. In Windows itself this would not be
4671 Bug or feature? You decide:
4672 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4674 This function resolves the true case of each element in the
4675 path and returns the case-sensitive path.
4677 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4678 might return C<\"/WINDOWS/system32\"> (the exact return value
4679 would depend on details of how the directories were originally
4680 created under Windows).
4683 This function does not handle drive names, backslashes etc.
4685 See also C<guestfs_realpath>.");
4687 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4688 [InitScratchFS, Always, TestOutput (
4689 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4690 "get the Linux VFS type corresponding to a mounted device",
4692 This command gets the filesystem type corresponding to
4693 the filesystem on C<device>.
4695 For most filesystems, the result is the name of the Linux
4696 VFS module which would be used to mount this filesystem
4697 if you mounted it without specifying the filesystem type.
4698 For example a string such as C<ext3> or C<ntfs>.");
4700 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4701 [InitScratchFS, Always, TestOutputStruct (
4702 [["write"; "/truncate"; "some stuff so size is not zero"];
4703 ["truncate"; "/truncate"];
4704 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4705 "truncate a file to zero size",
4707 This command truncates C<path> to a zero-length file. The
4708 file must exist already.");
4710 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4711 [InitScratchFS, Always, TestOutputStruct (
4712 [["touch"; "/truncate_size"];
4713 ["truncate_size"; "/truncate_size"; "1000"];
4714 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4715 "truncate a file to a particular size",
4717 This command truncates C<path> to size C<size> bytes. The file
4720 If the current file size is less than C<size> then
4721 the file is extended to the required size with zero bytes.
4722 This creates a sparse file (ie. disk blocks are not allocated
4723 for the file until you write to it). To create a non-sparse
4724 file of zeroes, use C<guestfs_fallocate64> instead.");
4726 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4727 [InitScratchFS, Always, TestOutputStruct (
4728 [["touch"; "/utimens"];
4729 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4730 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4731 "set timestamp of a file with nanosecond precision",
4733 This command sets the timestamps of a file with nanosecond
4736 C<atsecs, atnsecs> are the last access time (atime) in secs and
4737 nanoseconds from the epoch.
4739 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4740 secs and nanoseconds from the epoch.
4742 If the C<*nsecs> field contains the special value C<-1> then
4743 the corresponding timestamp is set to the current time. (The
4744 C<*secs> field is ignored in this case).
4746 If the C<*nsecs> field contains the special value C<-2> then
4747 the corresponding timestamp is left unchanged. (The
4748 C<*secs> field is ignored in this case).");
4750 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4751 [InitScratchFS, Always, TestOutputStruct (
4752 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4753 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4754 "create a directory with a particular mode",
4756 This command creates a directory, setting the initial permissions
4757 of the directory to C<mode>.
4759 For common Linux filesystems, the actual mode which is set will
4760 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4761 interpret the mode in other ways.
4763 See also C<guestfs_mkdir>, C<guestfs_umask>");
4765 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4767 "change file owner and group",
4769 Change the file owner to C<owner> and group to C<group>.
4770 This is like C<guestfs_chown> but if C<path> is a symlink then
4771 the link itself is changed, not the target.
4773 Only numeric uid and gid are supported. If you want to use
4774 names, you will need to locate and parse the password file
4775 yourself (Augeas support makes this relatively easy).");
4777 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4779 "lstat on multiple files",
4781 This call allows you to perform the C<guestfs_lstat> operation
4782 on multiple files, where all files are in the directory C<path>.
4783 C<names> is the list of files from this directory.
4785 On return you get a list of stat structs, with a one-to-one
4786 correspondence to the C<names> list. If any name did not exist
4787 or could not be lstat'd, then the C<ino> field of that structure
4790 This call is intended for programs that want to efficiently
4791 list a directory contents without making many round-trips.
4792 See also C<guestfs_lxattrlist> for a similarly efficient call
4793 for getting extended attributes. Very long directory listings
4794 might cause the protocol message size to be exceeded, causing
4795 this call to fail. The caller must split up such requests
4796 into smaller groups of names.");
4798 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4800 "lgetxattr on multiple files",
4802 This call allows you to get the extended attributes
4803 of multiple files, where all files are in the directory C<path>.
4804 C<names> is the list of files from this directory.
4806 On return you get a flat list of xattr structs which must be
4807 interpreted sequentially. The first xattr struct always has a zero-length
4808 C<attrname>. C<attrval> in this struct is zero-length
4809 to indicate there was an error doing C<lgetxattr> for this
4810 file, I<or> is a C string which is a decimal number
4811 (the number of following attributes for this file, which could
4812 be C<\"0\">). Then after the first xattr struct are the
4813 zero or more attributes for the first named file.
4814 This repeats for the second and subsequent files.
4816 This call is intended for programs that want to efficiently
4817 list a directory contents without making many round-trips.
4818 See also C<guestfs_lstatlist> for a similarly efficient call
4819 for getting standard stats. Very long directory listings
4820 might cause the protocol message size to be exceeded, causing
4821 this call to fail. The caller must split up such requests
4822 into smaller groups of names.");
4824 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4826 "readlink on multiple files",
4828 This call allows you to do a C<readlink> operation
4829 on multiple files, where all files are in the directory C<path>.
4830 C<names> is the list of files from this directory.
4832 On return you get a list of strings, with a one-to-one
4833 correspondence to the C<names> list. Each string is the
4834 value of the symbolic link.
4836 If the C<readlink(2)> operation fails on any name, then
4837 the corresponding result string is the empty string C<\"\">.
4838 However the whole operation is completed even if there
4839 were C<readlink(2)> errors, and so you can call this
4840 function with names where you don't know if they are
4841 symbolic links already (albeit slightly less efficient).
4843 This call is intended for programs that want to efficiently
4844 list a directory contents without making many round-trips.
4845 Very long directory listings might cause the protocol
4846 message size to be exceeded, causing
4847 this call to fail. The caller must split up such requests
4848 into smaller groups of names.");
4850 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4851 [InitISOFS, Always, TestOutputBuffer (
4852 [["pread"; "/known-4"; "1"; "3"]], "\n");
4853 InitISOFS, Always, TestOutputBuffer (
4854 [["pread"; "/empty"; "0"; "100"]], "")],
4855 "read part of a file",
4857 This command lets you read part of a file. It reads C<count>
4858 bytes of the file, starting at C<offset>, from file C<path>.
4860 This may read fewer bytes than requested. For further details
4861 see the L<pread(2)> system call.
4863 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4865 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4866 [InitEmpty, Always, TestRun (
4867 [["part_init"; "/dev/sda"; "gpt"]])],
4868 "create an empty partition table",
4870 This creates an empty partition table on C<device> of one of the
4871 partition types listed below. Usually C<parttype> should be
4872 either C<msdos> or C<gpt> (for large disks).
4874 Initially there are no partitions. Following this, you should
4875 call C<guestfs_part_add> for each partition required.
4877 Possible values for C<parttype> are:
4885 Intel EFI / GPT partition table.
4887 This is recommended for >= 2 TB partitions that will be accessed
4888 from Linux and Intel-based Mac OS X. It also has limited backwards
4889 compatibility with the C<mbr> format.
4895 The standard PC \"Master Boot Record\" (MBR) format used
4896 by MS-DOS and Windows. This partition type will B<only> work
4897 for device sizes up to 2 TB. For large disks we recommend
4902 Other partition table types that may work but are not
4915 Amiga \"Rigid Disk Block\" format.
4923 DASD, used on IBM mainframes.
4931 Old Mac partition format. Modern Macs use C<gpt>.
4935 NEC PC-98 format, common in Japan apparently.
4943 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4944 [InitEmpty, Always, TestRun (
4945 [["part_init"; "/dev/sda"; "mbr"];
4946 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4947 InitEmpty, Always, TestRun (
4948 [["part_init"; "/dev/sda"; "gpt"];
4949 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4950 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4951 InitEmpty, Always, TestRun (
4952 [["part_init"; "/dev/sda"; "mbr"];
4953 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4954 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4955 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4956 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4957 "add a partition to the device",
4959 This command adds a partition to C<device>. If there is no partition
4960 table on the device, call C<guestfs_part_init> first.
4962 The C<prlogex> parameter is the type of partition. Normally you
4963 should pass C<p> or C<primary> here, but MBR partition tables also
4964 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4967 C<startsect> and C<endsect> are the start and end of the partition
4968 in I<sectors>. C<endsect> may be negative, which means it counts
4969 backwards from the end of the disk (C<-1> is the last sector).
4971 Creating a partition which covers the whole disk is not so easy.
4972 Use C<guestfs_part_disk> to do that.");
4974 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4975 [InitEmpty, Always, TestRun (
4976 [["part_disk"; "/dev/sda"; "mbr"]]);
4977 InitEmpty, Always, TestRun (
4978 [["part_disk"; "/dev/sda"; "gpt"]])],
4979 "partition whole disk with a single primary partition",
4981 This command is simply a combination of C<guestfs_part_init>
4982 followed by C<guestfs_part_add> to create a single primary partition
4983 covering the whole disk.
4985 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4986 but other possible values are described in C<guestfs_part_init>.");
4988 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4989 [InitEmpty, Always, TestRun (
4990 [["part_disk"; "/dev/sda"; "mbr"];
4991 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4992 "make a partition bootable",
4994 This sets the bootable flag on partition numbered C<partnum> on
4995 device C<device>. Note that partitions are numbered from 1.
4997 The bootable flag is used by some operating systems (notably
4998 Windows) to determine which partition to boot from. It is by
4999 no means universally recognized.");
5001 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
5002 [InitEmpty, Always, TestRun (
5003 [["part_disk"; "/dev/sda"; "gpt"];
5004 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
5005 "set partition name",
5007 This sets the partition name on partition numbered C<partnum> on
5008 device C<device>. Note that partitions are numbered from 1.
5010 The partition name can only be set on certain types of partition
5011 table. This works on C<gpt> but not on C<mbr> partitions.");
5013 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
5014 [], (* XXX Add a regression test for this. *)
5015 "list partitions on a device",
5017 This command parses the partition table on C<device> and
5018 returns the list of partitions found.
5020 The fields in the returned structure are:
5026 Partition number, counting from 1.
5030 Start of the partition I<in bytes>. To get sectors you have to
5031 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5035 End of the partition in bytes.
5039 Size of the partition in bytes.
5043 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5044 [InitEmpty, Always, TestOutput (
5045 [["part_disk"; "/dev/sda"; "gpt"];
5046 ["part_get_parttype"; "/dev/sda"]], "gpt")],
5047 "get the partition table type",
5049 This command examines the partition table on C<device> and
5050 returns the partition table type (format) being used.
5052 Common return values include: C<msdos> (a DOS/Windows style MBR
5053 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5054 values are possible, although unusual. See C<guestfs_part_init>
5057 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5058 [InitScratchFS, Always, TestOutputBuffer (
5059 [["fill"; "0x63"; "10"; "/fill"];
5060 ["read_file"; "/fill"]], "cccccccccc")],
5061 "fill a file with octets",
5063 This command creates a new file called C<path>. The initial
5064 content of the file is C<len> octets of C<c>, where C<c>
5065 must be a number in the range C<[0..255]>.
5067 To fill a file with zero bytes (sparsely), it is
5068 much more efficient to use C<guestfs_truncate_size>.
5069 To create a file with a pattern of repeating bytes
5070 use C<guestfs_fill_pattern>.");
5072 ("available", (RErr, [StringList "groups"], []), 216, [],
5073 [InitNone, Always, TestRun [["available"; ""]]],
5074 "test availability of some parts of the API",
5076 This command is used to check the availability of some
5077 groups of functionality in the appliance, which not all builds of
5078 the libguestfs appliance will be able to provide.
5080 The libguestfs groups, and the functions that those
5081 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5082 You can also fetch this list at runtime by calling
5083 C<guestfs_available_all_groups>.
5085 The argument C<groups> is a list of group names, eg:
5086 C<[\"inotify\", \"augeas\"]> would check for the availability of
5087 the Linux inotify functions and Augeas (configuration file
5090 The command returns no error if I<all> requested groups are available.
5092 It fails with an error if one or more of the requested
5093 groups is unavailable in the appliance.
5095 If an unknown group name is included in the
5096 list of groups then an error is always returned.
5104 You must call C<guestfs_launch> before calling this function.
5106 The reason is because we don't know what groups are
5107 supported by the appliance/daemon until it is running and can
5112 If a group of functions is available, this does not necessarily
5113 mean that they will work. You still have to check for errors
5114 when calling individual API functions even if they are
5119 It is usually the job of distro packagers to build
5120 complete functionality into the libguestfs appliance.
5121 Upstream libguestfs, if built from source with all
5122 requirements satisfied, will support everything.
5126 This call was added in version C<1.0.80>. In previous
5127 versions of libguestfs all you could do would be to speculatively
5128 execute a command to find out if the daemon implemented it.
5129 See also C<guestfs_version>.
5133 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5134 [InitScratchFS, Always, TestOutputBuffer (
5136 ["write"; "/dd/src"; "hello, world"];
5137 ["dd"; "/dd/src"; "/dd/dest"];
5138 ["read_file"; "/dd/dest"]], "hello, world")],
5139 "copy from source to destination using dd",
5141 This command copies from one source device or file C<src>
5142 to another destination device or file C<dest>. Normally you
5143 would use this to copy to or from a device or partition, for
5144 example to duplicate a filesystem.
5146 If the destination is a device, it must be as large or larger
5147 than the source file or device, otherwise the copy will fail.
5148 This command cannot do partial copies (see C<guestfs_copy_size>).");
5150 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5151 [InitScratchFS, Always, TestOutputInt (
5152 [["write"; "/filesize"; "hello, world"];
5153 ["filesize"; "/filesize"]], 12)],
5154 "return the size of the file in bytes",
5156 This command returns the size of C<file> in bytes.
5158 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5159 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5160 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5162 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5163 [InitBasicFSonLVM, Always, TestOutputList (
5164 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5165 ["lvs"]], ["/dev/VG/LV2"])],
5166 "rename an LVM logical volume",
5168 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5170 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5171 [InitBasicFSonLVM, Always, TestOutputList (
5173 ["vg_activate"; "false"; "VG"];
5174 ["vgrename"; "VG"; "VG2"];
5175 ["vg_activate"; "true"; "VG2"];
5176 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5177 ["vgs"]], ["VG2"])],
5178 "rename an LVM volume group",
5180 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5182 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5183 [InitISOFS, Always, TestOutputBuffer (
5184 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5185 "list the contents of a single file in an initrd",
5187 This command unpacks the file C<filename> from the initrd file
5188 called C<initrdpath>. The filename must be given I<without> the
5189 initial C</> character.
5191 For example, in guestfish you could use the following command
5192 to examine the boot script (usually called C</init>)
5193 contained in a Linux initrd or initramfs image:
5195 initrd-cat /boot/initrd-<version>.img init
5197 See also C<guestfs_initrd_list>.");
5199 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5201 "get the UUID of a physical volume",
5203 This command returns the UUID of the LVM PV C<device>.");
5205 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5207 "get the UUID of a volume group",
5209 This command returns the UUID of the LVM VG named C<vgname>.");
5211 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5213 "get the UUID of a logical volume",
5215 This command returns the UUID of the LVM LV C<device>.");
5217 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5219 "get the PV UUIDs containing the volume group",
5221 Given a VG called C<vgname>, this returns the UUIDs of all
5222 the physical volumes that this volume group resides on.
5224 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5225 calls to associate physical volumes and volume groups.
5227 See also C<guestfs_vglvuuids>.");
5229 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5231 "get the LV UUIDs of all LVs in the volume group",
5233 Given a VG called C<vgname>, this returns the UUIDs of all
5234 the logical volumes created in this volume group.
5236 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5237 calls to associate logical volumes and volume groups.
5239 See also C<guestfs_vgpvuuids>.");
5241 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5242 [InitScratchFS, Always, TestOutputBuffer (
5243 [["mkdir"; "/copy_size"];
5244 ["write"; "/copy_size/src"; "hello, world"];
5245 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5246 ["read_file"; "/copy_size/dest"]], "hello")],
5247 "copy size bytes from source to destination using dd",
5249 This command copies exactly C<size> bytes from one source device
5250 or file C<src> to another destination device or file C<dest>.
5252 Note this will fail if the source is too short or if the destination
5253 is not large enough.");
5255 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5256 [InitBasicFSonLVM, Always, TestRun (
5257 [["zero_device"; "/dev/VG/LV"]])],
5258 "write zeroes to an entire device",
5260 This command writes zeroes over the entire C<device>. Compare
5261 with C<guestfs_zero> which just zeroes the first few blocks of
5264 If blocks are already zero, then this command avoids writing
5265 zeroes. This prevents the underlying device from becoming non-sparse
5266 or growing unnecessarily.");
5268 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5269 [InitScratchFS, Always, TestOutput (
5270 [["mkdir"; "/txz_in"];
5271 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5272 ["cat"; "/txz_in/hello"]], "hello\n")],
5273 "unpack compressed tarball to directory",
5275 This command uploads and unpacks local file C<tarball> (an
5276 I<xz compressed> tar file) into C<directory>.");
5278 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5280 "pack directory into compressed tarball",
5282 This command packs the contents of C<directory> and downloads
5283 it to local file C<tarball> (as an xz compressed tar archive).");
5285 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5287 "resize an NTFS filesystem",
5289 This command resizes an NTFS filesystem, expanding or
5290 shrinking it to the size of the underlying device.
5292 I<Note:> After the resize operation, the filesystem is marked
5293 as requiring a consistency check (for safety). You have to boot
5294 into Windows to perform this check and clear this condition.
5295 Furthermore, ntfsresize refuses to resize filesystems
5296 which have been marked in this way. So in effect it is
5297 not possible to call ntfsresize multiple times on a single
5298 filesystem without booting into Windows between each resize.
5300 See also L<ntfsresize(8)>.");
5302 ("vgscan", (RErr, [], []), 232, [],
5303 [InitEmpty, Always, TestRun (
5305 "rescan for LVM physical volumes, volume groups and logical volumes",
5307 This rescans all block devices and rebuilds the list of LVM
5308 physical volumes, volume groups and logical volumes.");
5310 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5311 [InitEmpty, Always, TestRun (
5312 [["part_init"; "/dev/sda"; "mbr"];
5313 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5314 ["part_del"; "/dev/sda"; "1"]])],
5315 "delete a partition",
5317 This command deletes the partition numbered C<partnum> on C<device>.
5319 Note that in the case of MBR partitioning, deleting an
5320 extended partition also deletes any logical partitions
5323 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5324 [InitEmpty, Always, TestOutputTrue (
5325 [["part_init"; "/dev/sda"; "mbr"];
5326 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5327 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5328 ["part_get_bootable"; "/dev/sda"; "1"]])],
5329 "return true if a partition is bootable",
5331 This command returns true if the partition C<partnum> on
5332 C<device> has the bootable flag set.
5334 See also C<guestfs_part_set_bootable>.");
5336 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5337 [InitEmpty, Always, TestOutputInt (
5338 [["part_init"; "/dev/sda"; "mbr"];
5339 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5340 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5341 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5342 "get the MBR type byte (ID byte) from a partition",
5344 Returns the MBR type byte (also known as the ID byte) from
5345 the numbered partition C<partnum>.
5347 Note that only MBR (old DOS-style) partitions have type bytes.
5348 You will get undefined results for other partition table
5349 types (see C<guestfs_part_get_parttype>).");
5351 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5352 [], (* tested by part_get_mbr_id *)
5353 "set the MBR type byte (ID byte) of a partition",
5355 Sets the MBR type byte (also known as the ID byte) of
5356 the numbered partition C<partnum> to C<idbyte>. Note
5357 that the type bytes quoted in most documentation are
5358 in fact hexadecimal numbers, but usually documented
5359 without any leading \"0x\" which might be confusing.
5361 Note that only MBR (old DOS-style) partitions have type bytes.
5362 You will get undefined results for other partition table
5363 types (see C<guestfs_part_get_parttype>).");
5365 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5366 [InitISOFS, Always, TestOutputFileMD5 (
5367 [["checksum_device"; "md5"; "/dev/sdd"]],
5368 "../images/test.iso")],
5369 "compute MD5, SHAx or CRC checksum of the contents of a device",
5371 This call computes the MD5, SHAx or CRC checksum of the
5372 contents of the device named C<device>. For the types of
5373 checksums supported see the C<guestfs_checksum> command.");
5375 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5376 [InitNone, Always, TestRun (
5377 [["part_disk"; "/dev/sda"; "mbr"];
5378 ["pvcreate"; "/dev/sda1"];
5379 ["vgcreate"; "VG"; "/dev/sda1"];
5380 ["lvcreate"; "LV"; "VG"; "10"];
5381 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5382 "expand an LV to fill free space",
5384 This expands an existing logical volume C<lv> so that it fills
5385 C<pc>% of the remaining free space in the volume group. Commonly
5386 you would call this with pc = 100 which expands the logical volume
5387 as much as possible, using all remaining free space in the volume
5390 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5391 [], (* XXX Augeas code needs tests. *)
5392 "clear Augeas path",
5394 Set the value associated with C<path> to C<NULL>. This
5395 is the same as the L<augtool(1)> C<clear> command.");
5397 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5398 [InitEmpty, Always, TestOutputInt (
5399 [["get_umask"]], 0o22)],
5400 "get the current umask",
5402 Return the current umask. By default the umask is C<022>
5403 unless it has been set by calling C<guestfs_umask>.");
5405 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5407 "upload a file to the appliance (internal use only)",
5409 The C<guestfs_debug_upload> command uploads a file to
5410 the libguestfs appliance.
5412 There is no comprehensive help for this command. You have
5413 to look at the file C<daemon/debug.c> in the libguestfs source
5414 to find out what it is for.");
5416 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5417 [InitScratchFS, Always, TestOutput (
5418 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5419 ["cat"; "/base64_in"]], "hello\n")],
5420 "upload base64-encoded data to file",
5422 This command uploads base64-encoded data from C<base64file>
5425 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5427 "download file and encode as base64",
5429 This command downloads the contents of C<filename>, writing
5430 it out to local file C<base64file> encoded as base64.");
5432 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5434 "compute MD5, SHAx or CRC checksum of files in a directory",
5436 This command computes the checksums of all regular files in
5437 C<directory> and then emits a list of those checksums to
5438 the local output file C<sumsfile>.
5440 This can be used for verifying the integrity of a virtual
5441 machine. However to be properly secure you should pay
5442 attention to the output of the checksum command (it uses
5443 the ones from GNU coreutils). In particular when the
5444 filename is not printable, coreutils uses a special
5445 backslash syntax. For more information, see the GNU
5446 coreutils info file.");
5448 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5449 [InitScratchFS, Always, TestOutputBuffer (
5450 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5451 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5452 "fill a file with a repeating pattern of bytes",
5454 This function is like C<guestfs_fill> except that it creates
5455 a new file of length C<len> containing the repeating pattern
5456 of bytes in C<pattern>. The pattern is truncated if necessary
5457 to ensure the length of the file is exactly C<len> bytes.");
5459 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5460 [InitScratchFS, Always, TestOutput (
5461 [["write"; "/write"; "new file contents"];
5462 ["cat"; "/write"]], "new file contents");
5463 InitScratchFS, Always, TestOutput (
5464 [["write"; "/write2"; "\nnew file contents\n"];
5465 ["cat"; "/write2"]], "\nnew file contents\n");
5466 InitScratchFS, Always, TestOutput (
5467 [["write"; "/write3"; "\n\n"];
5468 ["cat"; "/write3"]], "\n\n");
5469 InitScratchFS, Always, TestOutput (
5470 [["write"; "/write4"; ""];
5471 ["cat"; "/write4"]], "");
5472 InitScratchFS, Always, TestOutput (
5473 [["write"; "/write5"; "\n\n\n"];
5474 ["cat"; "/write5"]], "\n\n\n");
5475 InitScratchFS, Always, TestOutput (
5476 [["write"; "/write6"; "\n"];
5477 ["cat"; "/write6"]], "\n")],
5478 "create a new file",
5480 This call creates a file called C<path>. The content of the
5481 file is the string C<content> (which can contain any 8 bit data).
5483 See also C<guestfs_write_append>.");
5485 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5486 [InitScratchFS, Always, TestOutput (
5487 [["write"; "/pwrite"; "new file contents"];
5488 ["pwrite"; "/pwrite"; "data"; "4"];
5489 ["cat"; "/pwrite"]], "new data contents");
5490 InitScratchFS, Always, TestOutput (
5491 [["write"; "/pwrite2"; "new file contents"];
5492 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5493 ["cat"; "/pwrite2"]], "new file is extended");
5494 InitScratchFS, Always, TestOutput (
5495 [["write"; "/pwrite3"; "new file contents"];
5496 ["pwrite"; "/pwrite3"; ""; "4"];
5497 ["cat"; "/pwrite3"]], "new file contents")],
5498 "write to part of a file",
5500 This command writes to part of a file. It writes the data
5501 buffer C<content> to the file C<path> starting at offset C<offset>.
5503 This command implements the L<pwrite(2)> system call, and like
5504 that system call it may not write the full data requested. The
5505 return value is the number of bytes that were actually written
5506 to the file. This could even be 0, although short writes are
5507 unlikely for regular files in ordinary circumstances.
5509 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5511 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5513 "resize an ext2, ext3 or ext4 filesystem (with size)",
5515 This command is the same as C<guestfs_resize2fs> except that it
5516 allows you to specify the new size (in bytes) explicitly.");
5518 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5520 "resize an LVM physical volume (with size)",
5522 This command is the same as C<guestfs_pvresize> except that it
5523 allows you to specify the new size (in bytes) explicitly.");
5525 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5527 "resize an NTFS filesystem (with size)",
5529 This command is the same as C<guestfs_ntfsresize> except that it
5530 allows you to specify the new size (in bytes) explicitly.");
5532 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5533 [InitNone, Always, TestRun [["available_all_groups"]]],
5534 "return a list of all optional groups",
5536 This command returns a list of all optional groups that this
5537 daemon knows about. Note this returns both supported and unsupported
5538 groups. To find out which ones the daemon can actually support
5539 you have to call C<guestfs_available> on each member of the
5542 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5544 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5545 [InitScratchFS, Always, TestOutputStruct (
5546 [["fallocate64"; "/fallocate64"; "1000000"];
5547 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5548 "preallocate a file in the guest filesystem",
5550 This command preallocates a file (containing zero bytes) named
5551 C<path> of size C<len> bytes. If the file exists already, it
5554 Note that this call allocates disk blocks for the file.
5555 To create a sparse file use C<guestfs_truncate_size> instead.
5557 The deprecated call C<guestfs_fallocate> does the same,
5558 but owing to an oversight it only allowed 30 bit lengths
5559 to be specified, effectively limiting the maximum size
5560 of files created through that call to 1GB.
5562 Do not confuse this with the guestfish-specific
5563 C<alloc> and C<sparse> commands which create
5564 a file in the host and attach it as a device.");
5566 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5567 [InitBasicFS, Always, TestOutput (
5568 [["set_e2label"; "/dev/sda1"; "LTEST"];
5569 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5570 "get the filesystem label",
5572 This returns the filesystem label of the filesystem on
5575 If the filesystem is unlabeled, this returns the empty string.
5577 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5579 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5580 (let uuid = uuidgen () in
5581 [InitBasicFS, Always, TestOutput (
5582 [["set_e2uuid"; "/dev/sda1"; uuid];
5583 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5584 "get the filesystem UUID",
5586 This returns the filesystem UUID of the filesystem on
5589 If the filesystem does not have a UUID, this returns the empty string.
5591 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5593 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5594 (* Can't be tested with the current framework because
5595 * the VG is being used by the mounted filesystem, so
5596 * the vgchange -an command we do first will fail.
5599 "set LVM device filter",
5601 This sets the LVM device filter so that LVM will only be
5602 able to \"see\" the block devices in the list C<devices>,
5603 and will ignore all other attached block devices.
5605 Where disk image(s) contain duplicate PVs or VGs, this
5606 command is useful to get LVM to ignore the duplicates, otherwise
5607 LVM can get confused. Note also there are two types
5608 of duplication possible: either cloned PVs/VGs which have
5609 identical UUIDs; or VGs that are not cloned but just happen
5610 to have the same name. In normal operation you cannot
5611 create this situation, but you can do it outside LVM, eg.
5612 by cloning disk images or by bit twiddling inside the LVM
5615 This command also clears the LVM cache and performs a volume
5618 You can filter whole block devices or individual partitions.
5620 You cannot use this if any VG is currently in use (eg.
5621 contains a mounted filesystem), even if you are not
5622 filtering out that VG.");
5624 ("lvm_clear_filter", (RErr, [], []), 256, [],
5625 [], (* see note on lvm_set_filter *)
5626 "clear LVM device filter",
5628 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5629 will be able to see every block device.
5631 This command also clears the LVM cache and performs a volume
5634 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5636 "open a LUKS-encrypted block device",
5638 This command opens a block device which has been encrypted
5639 according to the Linux Unified Key Setup (LUKS) standard.
5641 C<device> is the encrypted block device or partition.
5643 The caller must supply one of the keys associated with the
5644 LUKS block device, in the C<key> parameter.
5646 This creates a new block device called C</dev/mapper/mapname>.
5647 Reads and writes to this block device are decrypted from and
5648 encrypted to the underlying C<device> respectively.
5650 If this block device contains LVM volume groups, then
5651 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5652 will make them visible.
5654 Use C<guestfs_list_dm_devices> to list all device mapper
5657 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5659 "open a LUKS-encrypted block device read-only",
5661 This is the same as C<guestfs_luks_open> except that a read-only
5662 mapping is created.");
5664 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5666 "close a LUKS device",
5668 This closes a LUKS device that was created earlier by
5669 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5670 C<device> parameter must be the name of the LUKS mapping
5671 device (ie. C</dev/mapper/mapname>) and I<not> the name
5672 of the underlying block device.");
5674 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5676 "format a block device as a LUKS encrypted device",
5678 This command erases existing data on C<device> and formats
5679 the device as a LUKS encrypted device. C<key> is the
5680 initial key, which is added to key slot C<slot>. (LUKS
5681 supports 8 key slots, numbered 0-7).");
5683 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5685 "format a block device as a LUKS encrypted device",
5687 This command is the same as C<guestfs_luks_format> but
5688 it also allows you to set the C<cipher> used.");
5690 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5692 "add a key on a LUKS encrypted device",
5694 This command adds a new key on LUKS device C<device>.
5695 C<key> is any existing key, and is used to access the device.
5696 C<newkey> is the new key to add. C<keyslot> is the key slot
5697 that will be replaced.
5699 Note that if C<keyslot> already contains a key, then this
5700 command will fail. You have to use C<guestfs_luks_kill_slot>
5701 first to remove that key.");
5703 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5705 "remove a key from a LUKS encrypted device",
5707 This command deletes the key in key slot C<keyslot> from the
5708 encrypted LUKS device C<device>. C<key> must be one of the
5711 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5712 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5713 [["is_lv"; "/dev/VG/LV"]]);
5714 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5715 [["is_lv"; "/dev/sda1"]])],
5716 "test if device is a logical volume",
5718 This command tests whether C<device> is a logical volume, and
5719 returns true iff this is the case.");
5721 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5723 "find a filesystem by UUID",
5725 This command searches the filesystems and returns the one
5726 which has the given UUID. An error is returned if no such
5727 filesystem can be found.
5729 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5731 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5733 "find a filesystem by label",
5735 This command searches the filesystems and returns the one
5736 which has the given label. An error is returned if no such
5737 filesystem can be found.
5739 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5741 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5742 [InitISOFS, Always, TestOutputFalse (
5743 [["is_chardev"; "/directory"]]);
5744 InitScratchFS, Always, TestOutputTrue (
5745 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5746 ["is_chardev"; "/is_chardev"]])],
5747 "test if character device",
5749 This returns C<true> if and only if there is a character device
5750 with the given C<path> name.
5752 See also C<guestfs_stat>.");
5754 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5755 [InitISOFS, Always, TestOutputFalse (
5756 [["is_blockdev"; "/directory"]]);
5757 InitScratchFS, Always, TestOutputTrue (
5758 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5759 ["is_blockdev"; "/is_blockdev"]])],
5760 "test if block device",
5762 This returns C<true> if and only if there is a block device
5763 with the given C<path> name.
5765 See also C<guestfs_stat>.");
5767 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5768 [InitISOFS, Always, TestOutputFalse (
5769 [["is_fifo"; "/directory"]]);
5770 InitScratchFS, Always, TestOutputTrue (
5771 [["mkfifo"; "0o777"; "/is_fifo"];
5772 ["is_fifo"; "/is_fifo"]])],
5773 "test if FIFO (named pipe)",
5775 This returns C<true> if and only if there is a FIFO (named pipe)
5776 with the given C<path> name.
5778 See also C<guestfs_stat>.");
5780 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5781 [InitISOFS, Always, TestOutputFalse (
5782 [["is_symlink"; "/directory"]]);
5783 InitISOFS, Always, TestOutputTrue (
5784 [["is_symlink"; "/abssymlink"]])],
5785 "test if symbolic link",
5787 This returns C<true> if and only if there is a symbolic link
5788 with the given C<path> name.
5790 See also C<guestfs_stat>.");
5792 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5793 (* XXX Need a positive test for sockets. *)
5794 [InitISOFS, Always, TestOutputFalse (
5795 [["is_socket"; "/directory"]])],
5798 This returns C<true> if and only if there is a Unix domain socket
5799 with the given C<path> name.
5801 See also C<guestfs_stat>.");
5803 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5804 [InitPartition, Always, TestOutputDevice (
5805 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5806 InitEmpty, Always, TestLastFail (
5807 [["part_to_dev"; "/dev/sda"]])],
5808 "convert partition name to device name",
5810 This function takes a partition name (eg. \"/dev/sdb1\") and
5811 removes the partition number, returning the device name
5814 The named partition must exist, for example as a string returned
5815 from C<guestfs_list_partitions>.");
5817 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5818 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5819 [InitScratchFS, Always, TestOutput (
5820 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5821 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5822 "upload a file from the local machine with offset",
5824 Upload local file C<filename> to C<remotefilename> on the
5827 C<remotefilename> is overwritten starting at the byte C<offset>
5828 specified. The intention is to overwrite parts of existing
5829 files or devices, although if a non-existant file is specified
5830 then it is created with a \"hole\" before C<offset>. The
5831 size of the data written is implicit in the size of the
5834 Note that there is no limit on the amount of data that
5835 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5836 and this call always writes the full amount unless an
5839 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5841 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5842 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5843 let offset = string_of_int 100 in
5844 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5845 [InitScratchFS, Always, TestOutput (
5846 (* Pick a file from cwd which isn't likely to change. *)
5847 [["mkdir"; "/download_offset"];
5848 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5849 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5850 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5851 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5852 "download a file to the local machine with offset and size",
5854 Download file C<remotefilename> and save it as C<filename>
5855 on the local machine.
5857 C<remotefilename> is read for C<size> bytes starting at C<offset>
5858 (this region must be within the file or device).
5860 Note that there is no limit on the amount of data that
5861 can be downloaded with this call, unlike with C<guestfs_pread>,
5862 and this call always reads the full amount unless an
5865 See also C<guestfs_download>, C<guestfs_pread>.");
5867 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5868 [InitPartition, Always, TestOutputListOfDevices (
5869 [["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"];
5870 ["blockdev_rereadpt"; "/dev/sda"];
5871 ["list_partitions"]], ["/dev/sdb1"])],
5872 "write to part of a device",
5874 This command writes to part of a device. It writes the data
5875 buffer C<content> to C<device> starting at offset C<offset>.
5877 This command implements the L<pwrite(2)> system call, and like
5878 that system call it may not write the full data requested
5879 (although short writes to disk devices and partitions are
5880 probably impossible with standard Linux kernels).
5882 See also C<guestfs_pwrite>.");
5884 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5885 [InitEmpty, Always, TestOutputBuffer (
5886 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5887 "read part of a device",
5889 This command lets you read part of a file. It reads C<count>
5890 bytes of C<device>, starting at C<offset>.
5892 This may read fewer bytes than requested. For further details
5893 see the L<pread(2)> system call.
5895 See also C<guestfs_pread>.");
5897 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5898 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5899 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5900 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5901 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5902 "get canonical name of an LV",
5904 This converts alternative naming schemes for LVs that you
5905 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5906 is converted to C</dev/VG/LV>.
5908 This command returns an error if the C<lvname> parameter does
5909 not refer to a logical volume.
5911 See also C<guestfs_is_lv>.");
5913 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
5914 [InitEmpty, Always, TestOutput (
5915 [["part_disk"; "/dev/sda"; "mbr"];
5916 ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
5917 ["mount_options"; ""; "/dev/sda1"; "/"];
5918 ["write"; "/new"; "new file contents"];
5919 ["cat"; "/new"]], "new file contents")],
5920 "make a filesystem",
5922 This function creates a filesystem on C<device>. The filesystem
5923 type is C<fstype>, for example C<ext3>.
5925 The optional arguments are:
5931 The filesystem block size. Supported block sizes depend on the
5932 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5933 for Linux ext2/3 filesystems.
5935 For VFAT and NTFS the C<blocksize> parameter is treated as
5936 the requested cluster size.
5938 For UFS block sizes, please see L<mkfs.ufs(8)>.
5942 This passes the I<-O> parameter to the external mkfs program.
5944 For certain filesystem types, this allows extra filesystem
5945 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5948 You cannot use this optional parameter with the C<gfs> or
5949 C<gfs2> filesystem type.
5953 This passes the I<-I> parameter to the external L<mke2fs(8)> program
5954 which sets the inode size (only for ext2/3/4 filesystems at present).
5958 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
5959 which sets sector size for ufs filesystem.
5963 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5965 "get a single extended attribute",
5967 Get a single extended attribute from file C<path> named C<name>.
5968 This call follows symlinks. If you want to lookup an extended
5969 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5971 Normally it is better to get all extended attributes from a file
5972 in one go by calling C<guestfs_getxattrs>. However some Linux
5973 filesystem implementations are buggy and do not provide a way to
5974 list out attributes. For these filesystems (notably ntfs-3g)
5975 you have to know the names of the extended attributes you want
5976 in advance and call this function.
5978 Extended attribute values are blobs of binary data. If there
5979 is no extended attribute named C<name>, this returns an error.
5981 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5983 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5985 "get a single extended attribute",
5987 Get a single extended attribute from file C<path> named C<name>.
5988 If C<path> is a symlink, then this call returns an extended
5989 attribute from the symlink.
5991 Normally it is better to get all extended attributes from a file
5992 in one go by calling C<guestfs_getxattrs>. However some Linux
5993 filesystem implementations are buggy and do not provide a way to
5994 list out attributes. For these filesystems (notably ntfs-3g)
5995 you have to know the names of the extended attributes you want
5996 in advance and call this function.
5998 Extended attribute values are blobs of binary data. If there
5999 is no extended attribute named C<name>, this returns an error.
6001 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
6003 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
6005 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
6007 This command is the same as C<guestfs_resize2fs>, but the filesystem
6008 is resized to its minimum size. This works like the I<-M> option
6009 to the C<resize2fs> command.
6011 To get the resulting size of the filesystem you should call
6012 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
6013 values. These two numbers, multiplied together, give the
6014 resulting size of the minimal filesystem in bytes.");
6016 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
6018 "internal autosync operation",
6020 This command performs the autosync operation just before the
6021 handle is closed. You should not call this command directly.
6022 Instead, use the autosync flag (C<guestfs_set_autosync>) to
6023 control whether or not this operation is performed when the
6024 handle is closed.");
6026 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6027 [InitISOFS, Always, TestOutputTrue (
6028 [["is_zero"; "/100kallzeroes"]]);
6029 InitISOFS, Always, TestOutputFalse (
6030 [["is_zero"; "/100kallspaces"]])],
6031 "test if a file contains all zero bytes",
6033 This returns true iff the file exists and the file is empty or
6034 it contains all zero bytes.");
6036 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6037 [InitBasicFS, Always, TestOutputTrue (
6038 [["umount"; "/dev/sda1"];
6039 ["zero_device"; "/dev/sda1"];
6040 ["is_zero_device"; "/dev/sda1"]]);
6041 InitBasicFS, Always, TestOutputFalse (
6042 [["is_zero_device"; "/dev/sda1"]])],
6043 "test if a device contains all zero bytes",
6045 This returns true iff the device exists and contains all zero bytes.
6047 Note that for large devices this can take a long time to run.");
6049 ("list_9p", (RStringList "mounttags", [], []), 285, [],
6051 "list 9p filesystems",
6053 List all 9p filesystems attached to the guest. A list of
6054 mount tags is returned.");
6056 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6058 "mount 9p filesystem",
6060 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6061 directory C<mountpoint>.
6063 If required, C<trans=virtio> will be automatically added to the options.
6064 Any other options required can be passed in the optional C<options>
6067 ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6069 "list device mapper devices",
6071 List all device mapper devices.
6073 The returned list contains C</dev/mapper/*> devices, eg. ones created
6074 by a previous call to C<guestfs_luks_open>.
6076 Device mapper devices which correspond to logical volumes are I<not>
6077 returned in this list. Call C<guestfs_lvs> if you want to list logical
6080 ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6082 "resize an NTFS filesystem",
6084 This command resizes an NTFS filesystem, expanding or
6085 shrinking it to the size of the underlying device.
6087 The optional parameters are:
6093 The new size (in bytes) of the filesystem. If omitted, the filesystem
6094 is resized to fit the container (eg. partition).
6098 If this option is true, then force the resize of the filesystem
6099 even if the filesystem is marked as requiring a consistency check.
6101 After the resize operation, the filesystem is always marked
6102 as requiring a consistency check (for safety). You have to boot
6103 into Windows to perform this check and clear this condition.
6104 If you I<don't> set the C<force> option then it is not
6105 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6106 single filesystem without booting into Windows between each resize.
6110 See also L<ntfsresize(8)>.");
6112 ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6114 "resize a btrfs filesystem",
6116 This command resizes a btrfs filesystem.
6118 Note that unlike other resize calls, the filesystem has to be
6119 mounted and the parameter is the mountpoint not the device
6120 (this is a requirement of btrfs itself).
6122 The optional parameters are:
6128 The new size (in bytes) of the filesystem. If omitted, the filesystem
6129 is resized to the maximum size.
6133 See also L<btrfs(8)>.");
6135 ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6136 [InitScratchFS, Always, TestOutput (
6137 [["write"; "/write_append"; "line1\n"];
6138 ["write_append"; "/write_append"; "line2\n"];
6139 ["write_append"; "/write_append"; "line3a"];
6140 ["write_append"; "/write_append"; "line3b\n"];
6141 ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6142 "append content to end of file",
6144 This call appends C<content> to the end of file C<path>. If
6145 C<path> does not exist, then a new file is created.
6147 See also C<guestfs_write>.");
6149 ("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [Int "level"]), 291, [],
6151 "output compressed file",
6153 This command compresses C<file> and writes it out to the local
6156 The compression program used is controlled by the C<ctype> parameter.
6157 Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.
6158 Some compression types may not be supported by particular builds of
6159 libguestfs, in which case you will get an error containing the
6160 substring \"not supported\".
6162 The optional C<level> parameter controls compression level. The
6163 meaning and default for this parameter depends on the compression
6164 program being used.");
6166 ("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [Int "level"]), 292, [],
6168 "output compressed device",
6170 This command compresses C<device> and writes it out to the local
6173 The C<ctype> and optional C<level> parameters have the same meaning
6174 as in C<guestfs_compress_out>.");
6178 let all_functions = non_daemon_functions @ daemon_functions
6180 (* In some places we want the functions to be displayed sorted
6181 * alphabetically, so this is useful:
6183 let all_functions_sorted = List.sort action_compare all_functions
6185 (* This is used to generate the src/MAX_PROC_NR file which
6186 * contains the maximum procedure number, a surrogate for the
6187 * ABI version number. See src/Makefile.am for the details.
6190 let proc_nrs = List.map (
6191 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6192 ) daemon_functions in
6193 List.fold_left max 0 proc_nrs
6195 (* Non-API meta-commands available only in guestfish.
6197 * Note (1): style, proc_nr and tests fields are all meaningless.
6198 * The only fields which are actually used are the shortname,
6199 * FishAlias flags, shortdesc and longdesc.
6201 * Note (2): to refer to other commands, use L</shortname>.
6203 * Note (3): keep this list sorted by shortname.
6205 let fish_commands = [
6206 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6207 "allocate and add a disk file",
6208 " alloc filename size
6210 This creates an empty (zeroed) file of the given size, and then adds
6211 so it can be further examined.
6213 For more advanced image creation, see L<qemu-img(1)> utility.
6215 Size can be specified using standard suffixes, eg. C<1M>.
6217 To create a sparse file, use L</sparse> instead. To create a
6218 prepared disk image, see L</PREPARED DISK IMAGES>.");
6220 ("copy_in", (RErr,[], []), -1, [], [],
6221 "copy local files or directories into an image",
6222 " copy-in local [local ...] /remotedir
6224 C<copy-in> copies local files or directories recursively into the disk
6225 image, placing them in the directory called C</remotedir> (which must
6226 exist). This guestfish meta-command turns into a sequence of
6227 L</tar-in> and other commands as necessary.
6229 Multiple local files and directories can be specified, but the last
6230 parameter must always be a remote directory. Wildcards cannot be
6233 ("copy_out", (RErr,[], []), -1, [], [],
6234 "copy remote files or directories out of an image",
6235 " copy-out remote [remote ...] localdir
6237 C<copy-out> copies remote files or directories recursively out of the
6238 disk image, placing them on the host disk in a local directory called
6239 C<localdir> (which must exist). This guestfish meta-command turns
6240 into a sequence of L</download>, L</tar-out> and other commands as
6243 Multiple remote files and directories can be specified, but the last
6244 parameter must always be a local directory. To download to the
6245 current directory, use C<.> as in:
6249 Wildcards cannot be used in the ordinary command, but you can use
6250 them with the help of L</glob> like this:
6252 glob copy-out /home/* .");
6254 ("display", (RErr,[], []), -1, [], [],
6258 Use C<display> (a graphical display program) to display an image
6259 file. It downloads the file, and runs C<display> on it.
6261 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6262 environment variable. For example to use the GNOME display program:
6264 export GUESTFISH_DISPLAY_IMAGE=eog
6266 See also L<display(1)>.");
6268 ("echo", (RErr,[], []), -1, [], [],
6269 "display a line of text",
6272 This echos the parameters to the terminal.");
6274 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6278 This is used to edit a file. It downloads the file, edits it
6279 locally using your editor, then uploads the result.
6281 The editor is C<$EDITOR>. However if you use the alternate
6282 commands C<vi> or C<emacs> you will get those corresponding
6285 ("glob", (RErr,[], []), -1, [], [],
6286 "expand wildcards in command",
6287 " glob command args...
6289 Expand wildcards in any paths in the args list, and run C<command>
6290 repeatedly on each matching path.
6292 See L</WILDCARDS AND GLOBBING>.");
6294 ("hexedit", (RErr,[], []), -1, [], [],
6295 "edit with a hex editor",
6296 " hexedit <filename|device>
6297 hexedit <filename|device> <max>
6298 hexedit <filename|device> <start> <max>
6300 Use hexedit (a hex editor) to edit all or part of a binary file
6303 This command works by downloading potentially the whole file or
6304 device, editing it locally, then uploading it. If the file or
6305 device is large, you have to specify which part you wish to edit
6306 by using C<max> and/or C<start> C<max> parameters.
6307 C<start> and C<max> are specified in bytes, with the usual
6308 modifiers allowed such as C<1M> (1 megabyte).
6310 For example to edit the first few sectors of a disk you
6315 which would allow you to edit anywhere within the first megabyte
6318 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6320 hexedit /dev/sda1 0x400 0x400
6322 (assuming the superblock is in the standard location).
6324 This command requires the external L<hexedit(1)> program. You
6325 can specify another program to use by setting the C<HEXEDITOR>
6326 environment variable.
6328 See also L</hexdump>.");
6330 ("lcd", (RErr,[], []), -1, [], [],
6331 "change working directory",
6334 Change the local directory, ie. the current directory of guestfish
6337 Note that C<!cd> won't do what you might expect.");
6339 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6343 Opens the manual page for guestfish.");
6345 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6351 This is used to view a file.
6353 The default viewer is C<$PAGER>. However if you use the alternate
6354 command C<less> you will get the C<less> command specifically.");
6356 ("reopen", (RErr,[], []), -1, [], [],
6357 "close and reopen libguestfs handle",
6360 Close and reopen the libguestfs handle. It is not necessary to use
6361 this normally, because the handle is closed properly when guestfish
6362 exits. However this is occasionally useful for testing.");
6364 ("setenv", (RErr,[], []), -1, [], [],
6365 "set an environment variable",
6368 Set the environment variable C<VAR> to the string C<value>.
6370 To print the value of an environment variable use a shell command
6375 ("sparse", (RErr,[], []), -1, [], [],
6376 "create a sparse disk image and add",
6377 " sparse filename size
6379 This creates an empty sparse file of the given size, and then adds
6380 so it can be further examined.
6382 In all respects it works the same as the L</alloc> command, except that
6383 the image file is allocated sparsely, which means that disk blocks are
6384 not assigned to the file until they are needed. Sparse disk files
6385 only use space when written to, but they are slower and there is a
6386 danger you could run out of real disk space during a write operation.
6388 For more advanced image creation, see L<qemu-img(1)> utility.
6390 Size can be specified using standard suffixes, eg. C<1M>.");
6392 ("supported", (RErr,[], []), -1, [], [],
6393 "list supported groups of commands",
6396 This command returns a list of the optional groups
6397 known to the daemon, and indicates which ones are
6398 supported by this build of the libguestfs appliance.
6400 See also L<guestfs(3)/AVAILABILITY>.");
6402 ("time", (RErr,[], []), -1, [], [],
6403 "print elapsed time taken to run a command",
6404 " time command args...
6406 Run the command as usual, but print the elapsed time afterwards. This
6407 can be useful for benchmarking operations.");
6409 ("unsetenv", (RErr,[], []), -1, [], [],
6410 "unset an environment variable",
6413 Remove C<VAR> from the environment.");