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:
821 =item \"redhat-based\"
823 Some Red Hat-derived distro.
827 Red Hat Enterprise Linux.
829 =item \"scientificlinux\"
847 The distro could not be determined.
851 Windows does not have distributions. This string is
852 returned if the OS type is Windows.
856 Future versions of libguestfs may return other strings here.
857 The caller should be prepared to handle any string.
859 Please read L<guestfs(3)/INSPECTION> for more details.");
861 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
863 "get major version of inspected operating system",
865 This returns the major version number of the inspected operating
868 Windows uses a consistent versioning scheme which is I<not>
869 reflected in the popular public names used by the operating system.
870 Notably the operating system known as \"Windows 7\" is really
871 version 6.1 (ie. major = 6, minor = 1). You can find out the
872 real versions corresponding to releases of Windows by consulting
875 If the version could not be determined, then C<0> is returned.
877 Please read L<guestfs(3)/INSPECTION> for more details.");
879 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
881 "get minor version of inspected operating system",
883 This returns the minor version number of the inspected operating
886 If the version could not be determined, then C<0> is returned.
888 Please read L<guestfs(3)/INSPECTION> for more details.
889 See also C<guestfs_inspect_get_major_version>.");
891 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
893 "get product name of inspected operating system",
895 This returns the product name of the inspected operating
896 system. The product name is generally some freeform string
897 which can be displayed to the user, but should not be
900 If the product name could not be determined, then the
901 string C<unknown> is returned.
903 Please read L<guestfs(3)/INSPECTION> for more details.");
905 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
907 "get mountpoints of inspected operating system",
909 This returns a hash of where we think the filesystems
910 associated with this operating system should be mounted.
911 Callers should note that this is at best an educated guess
912 made by reading configuration files such as C</etc/fstab>.
913 I<In particular note> that this may return filesystems
914 which are non-existent or not mountable and callers should
915 be prepared to handle or ignore failures if they try to
918 Each element in the returned hashtable has a key which
919 is the path of the mountpoint (eg. C</boot>) and a value
920 which is the filesystem that would be mounted there
923 Non-mounted devices such as swap devices are I<not>
924 returned in this list.
926 For operating systems like Windows which still use drive
927 letters, this call will only return an entry for the first
928 drive \"mounted on\" C</>. For information about the
929 mapping of drive letters to partitions, see
930 C<guestfs_inspect_get_drive_mappings>.
932 Please read L<guestfs(3)/INSPECTION> for more details.
933 See also C<guestfs_inspect_get_filesystems>.");
935 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
937 "get filesystems associated with inspected operating system",
939 This returns a list of all the filesystems that we think
940 are associated with this operating system. This includes
941 the root filesystem, other ordinary filesystems, and
942 non-mounted devices like swap partitions.
944 In the case of a multi-boot virtual machine, it is possible
945 for a filesystem to be shared between operating systems.
947 Please read L<guestfs(3)/INSPECTION> for more details.
948 See also C<guestfs_inspect_get_mountpoints>.");
950 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
952 "set enable network flag",
954 If C<network> is true, then the network is enabled in the
955 libguestfs appliance. The default is false.
957 This affects whether commands are able to access the network
958 (see L<guestfs(3)/RUNNING COMMANDS>).
960 You must call this before calling C<guestfs_launch>, otherwise
963 ("get_network", (RBool "network", [], []), -1, [],
965 "get enable network flag",
967 This returns the enable network flag.");
969 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
973 This inspection command looks for filesystems on partitions,
974 block devices and logical volumes, returning a list of devices
975 containing filesystems and their type.
977 The return value is a hash, where the keys are the devices
978 containing filesystems, and the values are the filesystem types.
981 \"/dev/sda1\" => \"ntfs\"
982 \"/dev/sda2\" => \"ext2\"
983 \"/dev/vg_guest/lv_root\" => \"ext4\"
984 \"/dev/vg_guest/lv_swap\" => \"swap\"
986 The value can have the special value \"unknown\", meaning the
987 content of the device is undetermined or empty.
988 \"swap\" means a Linux swap partition.
990 This command runs other libguestfs commands, which might include
991 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
992 use this soon after launch and only when nothing is mounted.
994 Not all of the filesystems returned will be mountable. In
995 particular, swap partitions are returned in the list. Also
996 this command does not check that each filesystem
997 found is valid and mountable, and some filesystems might
998 be mountable but require special options. Filesystems may
999 not all belong to a single logical operating system
1000 (use C<guestfs_inspect_os> to look for OSes).");
1002 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
1004 "add an image to examine or modify",
1006 This function adds a virtual machine disk image C<filename> to
1007 libguestfs. The first time you call this function, the disk
1008 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1011 You don't necessarily need to be root when using libguestfs. However
1012 you obviously do need sufficient permissions to access the filename
1013 for whatever operations you want to perform (ie. read access if you
1014 just want to read the image or write access if you want to modify the
1017 This call checks that C<filename> exists.
1019 The optional arguments are:
1025 If true then the image is treated as read-only. Writes are still
1026 allowed, but they are stored in a temporary snapshot overlay which
1027 is discarded at the end. The disk that you add is not modified.
1031 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1032 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1033 Possible formats include C<raw> and C<qcow2>.
1035 Automatic detection of the format opens you up to a potential
1036 security hole when dealing with untrusted raw-format images.
1037 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1042 This rarely-used option lets you emulate the behaviour of the
1043 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1047 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1049 "get Windows systemroot of inspected operating system",
1051 This returns the Windows systemroot of the inspected guest.
1052 The systemroot is a directory path such as C</WINDOWS>.
1054 This call assumes that the guest is Windows and that the
1055 systemroot could be determined by inspection. If this is not
1056 the case then an error is returned.
1058 Please read L<guestfs(3)/INSPECTION> for more details.");
1060 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1062 "return list of operating systems found by last inspection",
1064 This function is a convenient way to get the list of root
1065 devices, as returned from a previous call to C<guestfs_inspect_os>,
1066 but without redoing the whole inspection process.
1068 This returns an empty list if either no root devices were
1069 found or the caller has not called C<guestfs_inspect_os>.
1071 Please read L<guestfs(3)/INSPECTION> for more details.");
1073 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1075 "debug the QEMU command line (internal use only)",
1077 This returns the internal QEMU command line. 'debug' commands are
1078 not part of the formal API and can be removed or changed at any time.");
1080 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1082 "add the disk(s) from a named libvirt domain",
1084 This function adds the disk(s) attached to the named libvirt
1085 domain C<dom>. It works by connecting to libvirt, requesting
1086 the domain and domain XML from libvirt, parsing it for disks,
1087 and calling C<guestfs_add_drive_opts> on each one.
1089 The number of disks added is returned. This operation is atomic:
1090 if an error is returned, then no disks are added.
1092 This function does some minimal checks to make sure the libvirt
1093 domain is not running (unless C<readonly> is true). In a future
1094 version we will try to acquire the libvirt lock on each disk.
1096 Disks must be accessible locally. This often means that adding disks
1097 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1098 will fail unless those disks are accessible via the same device path
1101 The optional C<libvirturi> parameter sets the libvirt URI
1102 (see L<http://libvirt.org/uri.html>). If this is not set then
1103 we connect to the default libvirt URI (or one set through an
1104 environment variable, see the libvirt documentation for full
1107 The optional C<live> flag controls whether this call will try
1108 to connect to a running virtual machine C<guestfsd> process if
1109 it sees a suitable E<lt>channelE<gt> element in the libvirt
1110 XML definition. The default (if the flag is omitted) is never
1111 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1114 If the C<allowuuid> flag is true (default is false) then a UUID
1115 I<may> be passed instead of the domain name. The C<dom> string is
1116 treated as a UUID first and looked up, and if that lookup fails
1117 then we treat C<dom> as a name as usual.
1119 The other optional parameters are passed directly through to
1120 C<guestfs_add_drive_opts>.");
1123 This interface is not quite baked yet. -- RWMJ 2010-11-11
1124 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1126 "add the disk(s) from a libvirt domain",
1128 This function adds the disk(s) attached to the libvirt domain C<dom>.
1129 It works by requesting the domain XML from libvirt, parsing it for
1130 disks, and calling C<guestfs_add_drive_opts> on each one.
1132 In the C API we declare C<void *dom>, but really it has type
1133 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1135 The number of disks added is returned. This operation is atomic:
1136 if an error is returned, then no disks are added.
1138 This function does some minimal checks to make sure the libvirt
1139 domain is not running (unless C<readonly> is true). In a future
1140 version we will try to acquire the libvirt lock on each disk.
1142 Disks must be accessible locally. This often means that adding disks
1143 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1144 will fail unless those disks are accessible via the same device path
1147 The optional C<live> flag controls whether this call will try
1148 to connect to a running virtual machine C<guestfsd> process if
1149 it sees a suitable E<lt>channelE<gt> element in the libvirt
1150 XML definition. The default (if the flag is omitted) is never
1151 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1154 The other optional parameters are passed directly through to
1155 C<guestfs_add_drive_opts>.");
1158 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1160 "get package format used by the operating system",
1162 This function and C<guestfs_inspect_get_package_management> return
1163 the package format and package management tool used by the
1164 inspected operating system. For example for Fedora these
1165 functions would return C<rpm> (package format) and
1166 C<yum> (package management).
1168 This returns the string C<unknown> if we could not determine the
1169 package format I<or> if the operating system does not have
1170 a real packaging system (eg. Windows).
1172 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1173 Future versions of libguestfs may return other strings.
1175 Please read L<guestfs(3)/INSPECTION> for more details.");
1177 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1179 "get package management tool used by the operating system",
1181 C<guestfs_inspect_get_package_format> and this function return
1182 the package format and package management tool used by the
1183 inspected operating system. For example for Fedora these
1184 functions would return C<rpm> (package format) and
1185 C<yum> (package management).
1187 This returns the string C<unknown> if we could not determine the
1188 package management tool I<or> if the operating system does not have
1189 a real packaging system (eg. Windows).
1191 Possible strings include: C<yum>, C<up2date>,
1192 C<apt> (for all Debian derivatives),
1193 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1194 Future versions of libguestfs may return other strings.
1196 Please read L<guestfs(3)/INSPECTION> for more details.");
1198 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1200 "get list of applications installed in the operating system",
1202 Return the list of applications installed in the operating system.
1204 I<Note:> This call works differently from other parts of the
1205 inspection API. You have to call C<guestfs_inspect_os>, then
1206 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1207 before calling this. Listing applications is a significantly
1208 more difficult operation which requires access to the full
1209 filesystem. Also note that unlike the other
1210 C<guestfs_inspect_get_*> calls which are just returning
1211 data cached in the libguestfs handle, this call actually reads
1212 parts of the mounted filesystems during the call.
1214 This returns an empty list if the inspection code was not able
1215 to determine the list of applications.
1217 The application structure contains the following fields:
1223 The name of the application. For Red Hat-derived and Debian-derived
1224 Linux guests, this is the package name.
1226 =item C<app_display_name>
1228 The display name of the application, sometimes localized to the
1229 install language of the guest operating system.
1231 If unavailable this is returned as an empty string C<\"\">.
1232 Callers needing to display something can use C<app_name> instead.
1236 For package managers which use epochs, this contains the epoch of
1237 the package (an integer). If unavailable, this is returned as C<0>.
1239 =item C<app_version>
1241 The version string of the application or package. If unavailable
1242 this is returned as an empty string C<\"\">.
1244 =item C<app_release>
1246 The release string of the application or package, for package
1247 managers that use this. If unavailable this is returned as an
1248 empty string C<\"\">.
1250 =item C<app_install_path>
1252 The installation path of the application (on operating systems
1253 such as Windows which use installation paths). This path is
1254 in the format used by the guest operating system, it is not
1257 If unavailable this is returned as an empty string C<\"\">.
1259 =item C<app_trans_path>
1261 The install path translated into a libguestfs path.
1262 If unavailable this is returned as an empty string C<\"\">.
1264 =item C<app_publisher>
1266 The name of the publisher of the application, for package
1267 managers that use this. If unavailable this is returned
1268 as an empty string C<\"\">.
1272 The URL (eg. upstream URL) of the application.
1273 If unavailable this is returned as an empty string C<\"\">.
1275 =item C<app_source_package>
1277 For packaging systems which support this, the name of the source
1278 package. If unavailable this is returned as an empty string C<\"\">.
1280 =item C<app_summary>
1282 A short (usually one line) description of the application or package.
1283 If unavailable this is returned as an empty string C<\"\">.
1285 =item C<app_description>
1287 A longer description of the application or package.
1288 If unavailable this is returned as an empty string C<\"\">.
1292 Please read L<guestfs(3)/INSPECTION> for more details.");
1294 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1296 "get hostname of the operating system",
1298 This function returns the hostname of the operating system
1299 as found by inspection of the guest's configuration files.
1301 If the hostname could not be determined, then the
1302 string C<unknown> is returned.
1304 Please read L<guestfs(3)/INSPECTION> for more details.");
1306 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1308 "get format of inspected operating system",
1310 This returns the format of the inspected operating system. You
1311 can use it to detect install images, live CDs and similar.
1313 Currently defined formats are:
1319 This is an installed operating system.
1323 The disk image being inspected is not an installed operating system,
1324 but a I<bootable> install disk, live CD, or similar.
1328 The format of this disk image is not known.
1332 Future versions of libguestfs may return other strings here.
1333 The caller should be prepared to handle any string.
1335 Please read L<guestfs(3)/INSPECTION> for more details.");
1337 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1339 "get live flag for install disk",
1341 If C<guestfs_inspect_get_format> returns C<installer> (this
1342 is an install disk), then this returns true if a live image
1343 was detected on the disk.
1345 Please read L<guestfs(3)/INSPECTION> for more details.");
1347 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1349 "get netinst (network installer) flag for install disk",
1351 If C<guestfs_inspect_get_format> returns C<installer> (this
1352 is an install disk), then this returns true if the disk is
1353 a network installer, ie. not a self-contained install CD but
1354 one which is likely to require network access to complete
1357 Please read L<guestfs(3)/INSPECTION> for more details.");
1359 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1361 "get multipart flag for install disk",
1363 If C<guestfs_inspect_get_format> returns C<installer> (this
1364 is an install disk), then this returns true if the disk is
1367 Please read L<guestfs(3)/INSPECTION> for more details.");
1369 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1371 "set the attach method",
1373 Set the method that libguestfs uses to connect to the back end
1374 guestfsd daemon. Possible methods are:
1380 Launch an appliance and connect to it. This is the ordinary method
1383 =item C<unix:I<path>>
1385 Connect to the Unix domain socket I<path>.
1387 This method lets you connect to an existing daemon or (using
1388 virtio-serial) to a live guest. For more information, see
1389 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1393 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1394 [InitNone, Always, TestOutput (
1395 [["get_attach_method"]], "appliance")],
1396 "get the attach method",
1398 Return the current attach method. See C<guestfs_set_attach_method>.");
1400 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1402 "get product variant of inspected operating system",
1404 This returns the product variant of the inspected operating
1407 For Windows guests, this returns the contents of the Registry key
1408 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1409 C<InstallationType> which is usually a string such as
1410 C<Client> or C<Server> (other values are possible). This
1411 can be used to distinguish consumer and enterprise versions
1412 of Windows that have the same version number (for example,
1413 Windows 7 and Windows 2008 Server are both version 6.1,
1414 but the former is C<Client> and the latter is C<Server>).
1416 For enterprise Linux guests, in future we intend this to return
1417 the product variant such as C<Desktop>, C<Server> and so on. But
1418 this is not implemented at present.
1420 If the product variant could not be determined, then the
1421 string C<unknown> is returned.
1423 Please read L<guestfs(3)/INSPECTION> for more details.
1424 See also C<guestfs_inspect_get_product_name>,
1425 C<guestfs_inspect_get_major_version>.");
1427 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1429 "get Windows CurrentControlSet of inspected operating system",
1431 This returns the Windows CurrentControlSet of the inspected guest.
1432 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1434 This call assumes that the guest is Windows and that the
1435 Registry could be examined by inspection. If this is not
1436 the case then an error is returned.
1438 Please read L<guestfs(3)/INSPECTION> for more details.");
1440 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1442 "get drive letter mappings",
1444 This call is useful for Windows which uses a primitive system
1445 of assigning drive letters (like \"C:\") to partitions.
1446 This inspection API examines the Windows Registry to find out
1447 how disks/partitions are mapped to drive letters, and returns
1448 a hash table as in the example below:
1454 Note that keys are drive letters. For Windows, the key is
1455 case insensitive and just contains the drive letter, without
1456 the customary colon separator character.
1458 In future we may support other operating systems that also used drive
1459 letters, but the keys for those might not be case insensitive
1460 and might be longer than 1 character. For example in OS-9,
1461 hard drives were named C<h0>, C<h1> etc.
1463 For Windows guests, currently only hard drive mappings are
1464 returned. Removable disks (eg. DVD-ROMs) are ignored.
1466 For guests that do not use drive mappings, or if the drive mappings
1467 could not be determined, this returns an empty hash table.
1469 Please read L<guestfs(3)/INSPECTION> for more details.
1470 See also C<guestfs_inspect_get_mountpoints>,
1471 C<guestfs_inspect_get_filesystems>.");
1473 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1475 "get the icon corresponding to this operating system",
1477 This function returns an icon corresponding to the inspected
1478 operating system. The icon is returned as a buffer containing a
1479 PNG image (re-encoded to PNG if necessary).
1481 If it was not possible to get an icon this function returns a
1482 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1484 Libguestfs will start by looking for a file called
1485 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1486 and if it has the correct format, the contents of this file will
1487 be returned. You can disable favicons by passing the
1488 optional C<favicon> boolean as false (default is true).
1490 If finding the favicon fails, then we look in other places in the
1491 guest for a suitable icon.
1493 If the optional C<highquality> boolean is true then
1494 only high quality icons are returned, which means only icons of
1495 high resolution with an alpha channel. The default (false) is
1496 to return any icon we can, even if it is of substandard quality.
1504 Unlike most other inspection API calls, the guest's disks must be
1505 mounted up before you call this, since it needs to read information
1506 from the guest filesystem during the call.
1510 B<Security:> The icon data comes from the untrusted guest,
1511 and should be treated with caution. PNG files have been
1512 known to contain exploits. Ensure that libpng (or other relevant
1513 libraries) are fully up to date before trying to process or
1518 The PNG image returned can be any size. It might not be square.
1519 Libguestfs tries to return the largest, highest quality
1520 icon available. The application must scale the icon to the
1525 Extracting icons from Windows guests requires the external
1526 C<wrestool> program from the C<icoutils> package, and
1527 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1528 from the C<netpbm> package. These must be installed separately.
1532 Operating system icons are usually trademarks. Seek legal
1533 advice before using trademarks in applications.
1537 ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1539 "set process group flag",
1541 If C<pgroup> is true, child processes are placed into
1542 their own process group.
1544 The practical upshot of this is that signals like C<SIGINT> (from
1545 users pressing C<^C>) won't be received by the child process.
1547 The default for this flag is false, because usually you want
1548 C<^C> to kill the subprocess.");
1550 ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1552 "get process group flag",
1554 This returns the process group flag.");
1556 ("set_smp", (RErr, [Int "smp"], []), -1, [FishAlias "smp"],
1558 "set number of virtual CPUs in appliance",
1560 Change the number of virtual CPUs assigned to the appliance. The
1561 default is C<1>. Increasing this may improve performance, though
1562 often it has no effect.
1564 This function must be called before C<guestfs_launch>.");
1566 ("get_smp", (RInt "smp", [], []), -1, [],
1568 "get number of virtual CPUs in appliance",
1570 This returns the number of virtual CPUs assigned to the appliance.");
1574 (* daemon_functions are any functions which cause some action
1575 * to take place in the daemon.
1578 let daemon_functions = [
1579 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1580 [InitEmpty, Always, TestOutput (
1581 [["part_disk"; "/dev/sda"; "mbr"];
1582 ["mkfs"; "ext2"; "/dev/sda1"];
1583 ["mount"; "/dev/sda1"; "/"];
1584 ["write"; "/new"; "new file contents"];
1585 ["cat"; "/new"]], "new file contents")],
1586 "mount a guest disk at a position in the filesystem",
1588 Mount a guest disk at a position in the filesystem. Block devices
1589 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1590 the guest. If those block devices contain partitions, they will have
1591 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1594 The rules are the same as for L<mount(2)>: A filesystem must
1595 first be mounted on C</> before others can be mounted. Other
1596 filesystems can only be mounted on directories which already
1599 The mounted filesystem is writable, if we have sufficient permissions
1600 on the underlying device.
1602 Before libguestfs 1.13.16, this call implicitly added the options
1603 C<sync> and C<noatime>. The C<sync> option greatly slowed
1604 writes and caused many problems for users. If your program
1605 might need to work with older versions of libguestfs, use
1606 C<guestfs_mount_options> instead (using an empty string for the
1607 first parameter if you don't want any options).");
1609 ("sync", (RErr, [], []), 2, [],
1610 [ InitEmpty, Always, TestRun [["sync"]]],
1611 "sync disks, writes are flushed through to the disk image",
1613 This syncs the disk, so that any writes are flushed through to the
1614 underlying disk image.
1616 You should always call this if you have modified a disk image, before
1617 closing the handle.");
1619 ("touch", (RErr, [Pathname "path"], []), 3, [],
1620 [InitScratchFS, Always, TestOutputTrue (
1621 [["touch"; "/touch"];
1622 ["exists"; "/touch"]])],
1623 "update file timestamps or create a new file",
1625 Touch acts like the L<touch(1)> command. It can be used to
1626 update the timestamps on a file, or, if the file does not exist,
1627 to create a new zero-length file.
1629 This command only works on regular files, and will fail on other
1630 file types such as directories, symbolic links, block special etc.");
1632 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1633 [InitISOFS, Always, TestOutput (
1634 [["cat"; "/known-2"]], "abcdef\n")],
1635 "list the contents of a file",
1637 Return the contents of the file named C<path>.
1639 Note that this function cannot correctly handle binary files
1640 (specifically, files containing C<\\0> character which is treated
1641 as end of string). For those you need to use the C<guestfs_read_file>
1642 or C<guestfs_download> functions which have a more complex interface.");
1644 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1645 [], (* XXX Tricky to test because it depends on the exact format
1646 * of the 'ls -l' command, which changes between F10 and F11.
1648 "list the files in a directory (long format)",
1650 List the files in C<directory> (relative to the root directory,
1651 there is no cwd) in the format of 'ls -la'.
1653 This command is mostly useful for interactive sessions. It
1654 is I<not> intended that you try to parse the output string.");
1656 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1657 [InitScratchFS, Always, TestOutputList (
1659 ["touch"; "/ls/new"];
1660 ["touch"; "/ls/newer"];
1661 ["touch"; "/ls/newest"];
1662 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1663 "list the files in a directory",
1665 List the files in C<directory> (relative to the root directory,
1666 there is no cwd). The '.' and '..' entries are not returned, but
1667 hidden files are shown.
1669 This command is mostly useful for interactive sessions. Programs
1670 should probably use C<guestfs_readdir> instead.");
1672 ("list_devices", (RStringList "devices", [], []), 7, [],
1673 [InitEmpty, Always, TestOutputListOfDevices (
1674 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1675 "list the block devices",
1677 List all the block devices.
1679 The full block device names are returned, eg. C</dev/sda>.
1681 See also C<guestfs_list_filesystems>.");
1683 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1684 [InitBasicFS, Always, TestOutputListOfDevices (
1685 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1686 InitEmpty, Always, TestOutputListOfDevices (
1687 [["part_init"; "/dev/sda"; "mbr"];
1688 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1689 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1690 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1691 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1692 "list the partitions",
1694 List all the partitions detected on all block devices.
1696 The full partition device names are returned, eg. C</dev/sda1>
1698 This does not return logical volumes. For that you will need to
1699 call C<guestfs_lvs>.
1701 See also C<guestfs_list_filesystems>.");
1703 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1704 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1705 [["pvs"]], ["/dev/sda1"]);
1706 InitEmpty, Always, TestOutputListOfDevices (
1707 [["part_init"; "/dev/sda"; "mbr"];
1708 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1709 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1710 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1711 ["pvcreate"; "/dev/sda1"];
1712 ["pvcreate"; "/dev/sda2"];
1713 ["pvcreate"; "/dev/sda3"];
1714 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1715 "list the LVM physical volumes (PVs)",
1717 List all the physical volumes detected. This is the equivalent
1718 of the L<pvs(8)> command.
1720 This returns a list of just the device names that contain
1721 PVs (eg. C</dev/sda2>).
1723 See also C<guestfs_pvs_full>.");
1725 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1726 [InitBasicFSonLVM, Always, TestOutputList (
1728 InitEmpty, Always, TestOutputList (
1729 [["part_init"; "/dev/sda"; "mbr"];
1730 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1731 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1732 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1733 ["pvcreate"; "/dev/sda1"];
1734 ["pvcreate"; "/dev/sda2"];
1735 ["pvcreate"; "/dev/sda3"];
1736 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1737 ["vgcreate"; "VG2"; "/dev/sda3"];
1738 ["vgs"]], ["VG1"; "VG2"])],
1739 "list the LVM volume groups (VGs)",
1741 List all the volumes groups detected. This is the equivalent
1742 of the L<vgs(8)> command.
1744 This returns a list of just the volume group names that were
1745 detected (eg. C<VolGroup00>).
1747 See also C<guestfs_vgs_full>.");
1749 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1750 [InitBasicFSonLVM, Always, TestOutputList (
1751 [["lvs"]], ["/dev/VG/LV"]);
1752 InitEmpty, Always, TestOutputList (
1753 [["part_init"; "/dev/sda"; "mbr"];
1754 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1755 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1756 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1757 ["pvcreate"; "/dev/sda1"];
1758 ["pvcreate"; "/dev/sda2"];
1759 ["pvcreate"; "/dev/sda3"];
1760 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1761 ["vgcreate"; "VG2"; "/dev/sda3"];
1762 ["lvcreate"; "LV1"; "VG1"; "50"];
1763 ["lvcreate"; "LV2"; "VG1"; "50"];
1764 ["lvcreate"; "LV3"; "VG2"; "50"];
1765 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1766 "list the LVM logical volumes (LVs)",
1768 List all the logical volumes detected. This is the equivalent
1769 of the L<lvs(8)> command.
1771 This returns a list of the logical volume device names
1772 (eg. C</dev/VolGroup00/LogVol00>).
1774 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1776 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1777 [], (* XXX how to test? *)
1778 "list the LVM physical volumes (PVs)",
1780 List all the physical volumes detected. This is the equivalent
1781 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1783 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1784 [], (* XXX how to test? *)
1785 "list the LVM volume groups (VGs)",
1787 List all the volumes groups detected. This is the equivalent
1788 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1790 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1791 [], (* XXX how to test? *)
1792 "list the LVM logical volumes (LVs)",
1794 List all the logical volumes detected. This is the equivalent
1795 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1797 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1798 [InitISOFS, Always, TestOutputList (
1799 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1800 InitISOFS, Always, TestOutputList (
1801 [["read_lines"; "/empty"]], [])],
1802 "read file as lines",
1804 Return the contents of the file named C<path>.
1806 The file contents are returned as a list of lines. Trailing
1807 C<LF> and C<CRLF> character sequences are I<not> returned.
1809 Note that this function cannot correctly handle binary files
1810 (specifically, files containing C<\\0> character which is treated
1811 as end of line). For those you need to use the C<guestfs_read_file>
1812 function which has a more complex interface.");
1814 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1815 [], (* XXX Augeas code needs tests. *)
1816 "create a new Augeas handle",
1818 Create a new Augeas handle for editing configuration files.
1819 If there was any previous Augeas handle associated with this
1820 guestfs session, then it is closed.
1822 You must call this before using any other C<guestfs_aug_*>
1825 C<root> is the filesystem root. C<root> must not be NULL,
1828 The flags are the same as the flags defined in
1829 E<lt>augeas.hE<gt>, the logical I<or> of the following
1834 =item C<AUG_SAVE_BACKUP> = 1
1836 Keep the original file with a C<.augsave> extension.
1838 =item C<AUG_SAVE_NEWFILE> = 2
1840 Save changes into a file with extension C<.augnew>, and
1841 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1843 =item C<AUG_TYPE_CHECK> = 4
1847 This option is only useful when debugging Augeas lenses. Use
1848 of this option may require additional memory for the libguestfs
1849 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1850 environment variable or call C<guestfs_set_memsize>.
1852 =item C<AUG_NO_STDINC> = 8
1854 Do not use standard load path for modules.
1856 =item C<AUG_SAVE_NOOP> = 16
1858 Make save a no-op, just record what would have been changed.
1860 =item C<AUG_NO_LOAD> = 32
1862 Do not load the tree in C<guestfs_aug_init>.
1866 To close the handle, you can call C<guestfs_aug_close>.
1868 To find out more about Augeas, see L<http://augeas.net/>.");
1870 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1871 [], (* XXX Augeas code needs tests. *)
1872 "close the current Augeas handle",
1874 Close the current Augeas handle and free up any resources
1875 used by it. After calling this, you have to call
1876 C<guestfs_aug_init> again before you can use any other
1877 Augeas functions.");
1879 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1880 [], (* XXX Augeas code needs tests. *)
1881 "define an Augeas variable",
1883 Defines an Augeas variable C<name> whose value is the result
1884 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1887 On success this returns the number of nodes in C<expr>, or
1888 C<0> if C<expr> evaluates to something which is not a nodeset.");
1890 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1891 [], (* XXX Augeas code needs tests. *)
1892 "define an Augeas node",
1894 Defines a variable C<name> whose value is the result of
1897 If C<expr> evaluates to an empty nodeset, a node is created,
1898 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1899 C<name> will be the nodeset containing that single node.
1901 On success this returns a pair containing the
1902 number of nodes in the nodeset, and a boolean flag
1903 if a node was created.");
1905 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1906 [], (* XXX Augeas code needs tests. *)
1907 "look up the value of an Augeas path",
1909 Look up the value associated with C<path>. If C<path>
1910 matches exactly one node, the C<value> is returned.");
1912 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1913 [], (* XXX Augeas code needs tests. *)
1914 "set Augeas path to value",
1916 Set the value associated with C<path> to C<val>.
1918 In the Augeas API, it is possible to clear a node by setting
1919 the value to NULL. Due to an oversight in the libguestfs API
1920 you cannot do that with this call. Instead you must use the
1921 C<guestfs_aug_clear> call.");
1923 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1924 [], (* XXX Augeas code needs tests. *)
1925 "insert a sibling Augeas node",
1927 Create a new sibling C<label> for C<path>, inserting it into
1928 the tree before or after C<path> (depending on the boolean
1931 C<path> must match exactly one existing node in the tree, and
1932 C<label> must be a label, ie. not contain C</>, C<*> or end
1933 with a bracketed index C<[N]>.");
1935 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1936 [], (* XXX Augeas code needs tests. *)
1937 "remove an Augeas path",
1939 Remove C<path> and all of its children.
1941 On success this returns the number of entries which were removed.");
1943 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1944 [], (* XXX Augeas code needs tests. *)
1947 Move the node C<src> to C<dest>. C<src> must match exactly
1948 one node. C<dest> is overwritten if it exists.");
1950 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1951 [], (* XXX Augeas code needs tests. *)
1952 "return Augeas nodes which match augpath",
1954 Returns a list of paths which match the path expression C<path>.
1955 The returned paths are sufficiently qualified so that they match
1956 exactly one node in the current tree.");
1958 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1959 [], (* XXX Augeas code needs tests. *)
1960 "write all pending Augeas changes to disk",
1962 This writes all pending changes to disk.
1964 The flags which were passed to C<guestfs_aug_init> affect exactly
1965 how files are saved.");
1967 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1968 [], (* XXX Augeas code needs tests. *)
1969 "load files into the tree",
1971 Load files into the tree.
1973 See C<aug_load> in the Augeas documentation for the full gory
1976 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1977 [], (* XXX Augeas code needs tests. *)
1978 "list Augeas nodes under augpath",
1980 This is just a shortcut for listing C<guestfs_aug_match>
1981 C<path/*> and sorting the resulting nodes into alphabetical order.");
1983 ("rm", (RErr, [Pathname "path"], []), 29, [],
1984 [InitScratchFS, Always, TestRun
1986 ["touch"; "/rm/new"];
1988 InitScratchFS, Always, TestLastFail
1989 [["rm"; "/nosuchfile"]];
1990 InitScratchFS, Always, TestLastFail
1995 Remove the single file C<path>.");
1997 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1998 [InitScratchFS, Always, TestRun
1999 [["mkdir"; "/rmdir"];
2000 ["rmdir"; "/rmdir"]];
2001 InitScratchFS, Always, TestLastFail
2002 [["rmdir"; "/rmdir2"]];
2003 InitScratchFS, Always, TestLastFail
2004 [["mkdir"; "/rmdir3"];
2005 ["touch"; "/rmdir3/new"];
2006 ["rmdir"; "/rmdir3/new"]]],
2007 "remove a directory",
2009 Remove the single directory C<path>.");
2011 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
2012 [InitScratchFS, Always, TestOutputFalse
2013 [["mkdir"; "/rm_rf"];
2014 ["mkdir"; "/rm_rf/foo"];
2015 ["touch"; "/rm_rf/foo/bar"];
2016 ["rm_rf"; "/rm_rf"];
2017 ["exists"; "/rm_rf"]]],
2018 "remove a file or directory recursively",
2020 Remove the file or directory C<path>, recursively removing the
2021 contents if its a directory. This is like the C<rm -rf> shell
2024 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2025 [InitScratchFS, Always, TestOutputTrue
2026 [["mkdir"; "/mkdir"];
2027 ["is_dir"; "/mkdir"]];
2028 InitScratchFS, Always, TestLastFail
2029 [["mkdir"; "/mkdir2/foo/bar"]]],
2030 "create a directory",
2032 Create a directory named C<path>.");
2034 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2035 [InitScratchFS, Always, TestOutputTrue
2036 [["mkdir_p"; "/mkdir_p/foo/bar"];
2037 ["is_dir"; "/mkdir_p/foo/bar"]];
2038 InitScratchFS, Always, TestOutputTrue
2039 [["mkdir_p"; "/mkdir_p2/foo/bar"];
2040 ["is_dir"; "/mkdir_p2/foo"]];
2041 InitScratchFS, Always, TestOutputTrue
2042 [["mkdir_p"; "/mkdir_p3/foo/bar"];
2043 ["is_dir"; "/mkdir_p3"]];
2044 (* Regression tests for RHBZ#503133: *)
2045 InitScratchFS, Always, TestRun
2046 [["mkdir"; "/mkdir_p4"];
2047 ["mkdir_p"; "/mkdir_p4"]];
2048 InitScratchFS, Always, TestLastFail
2049 [["touch"; "/mkdir_p5"];
2050 ["mkdir_p"; "/mkdir_p5"]]],
2051 "create a directory and parents",
2053 Create a directory named C<path>, creating any parent directories
2054 as necessary. This is like the C<mkdir -p> shell command.");
2056 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2057 [], (* XXX Need stat command to test *)
2060 Change the mode (permissions) of C<path> to C<mode>. Only
2061 numeric modes are supported.
2063 I<Note>: When using this command from guestfish, C<mode>
2064 by default would be decimal, unless you prefix it with
2065 C<0> to get octal, ie. use C<0700> not C<700>.
2067 The mode actually set is affected by the umask.");
2069 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2070 [], (* XXX Need stat command to test *)
2071 "change file owner and group",
2073 Change the file owner to C<owner> and group to C<group>.
2075 Only numeric uid and gid are supported. If you want to use
2076 names, you will need to locate and parse the password file
2077 yourself (Augeas support makes this relatively easy).");
2079 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2080 [InitISOFS, Always, TestOutputTrue (
2081 [["exists"; "/empty"]]);
2082 InitISOFS, Always, TestOutputTrue (
2083 [["exists"; "/directory"]])],
2084 "test if file or directory exists",
2086 This returns C<true> if and only if there is a file, directory
2087 (or anything) with the given C<path> name.
2089 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2091 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2092 [InitISOFS, Always, TestOutputTrue (
2093 [["is_file"; "/known-1"]]);
2094 InitISOFS, Always, TestOutputFalse (
2095 [["is_file"; "/directory"]])],
2096 "test if a regular file",
2098 This returns C<true> if and only if there is a regular file
2099 with the given C<path> name. Note that it returns false for
2100 other objects like directories.
2102 See also C<guestfs_stat>.");
2104 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2105 [InitISOFS, Always, TestOutputFalse (
2106 [["is_dir"; "/known-3"]]);
2107 InitISOFS, Always, TestOutputTrue (
2108 [["is_dir"; "/directory"]])],
2109 "test if a directory",
2111 This returns C<true> if and only if there is a directory
2112 with the given C<path> name. Note that it returns false for
2113 other objects like files.
2115 See also C<guestfs_stat>.");
2117 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2118 [InitEmpty, Always, TestOutputListOfDevices (
2119 [["part_init"; "/dev/sda"; "mbr"];
2120 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2121 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2122 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2123 ["pvcreate"; "/dev/sda1"];
2124 ["pvcreate"; "/dev/sda2"];
2125 ["pvcreate"; "/dev/sda3"];
2126 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2127 "create an LVM physical volume",
2129 This creates an LVM physical volume on the named C<device>,
2130 where C<device> should usually be a partition name such
2133 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [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 ["vgs"]], ["VG1"; "VG2"])],
2145 "create an LVM volume group",
2147 This creates an LVM volume group called C<volgroup>
2148 from the non-empty list of physical volumes C<physvols>.");
2150 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2151 [InitEmpty, Always, TestOutputList (
2152 [["part_init"; "/dev/sda"; "mbr"];
2153 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2154 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2155 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2156 ["pvcreate"; "/dev/sda1"];
2157 ["pvcreate"; "/dev/sda2"];
2158 ["pvcreate"; "/dev/sda3"];
2159 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2160 ["vgcreate"; "VG2"; "/dev/sda3"];
2161 ["lvcreate"; "LV1"; "VG1"; "50"];
2162 ["lvcreate"; "LV2"; "VG1"; "50"];
2163 ["lvcreate"; "LV3"; "VG2"; "50"];
2164 ["lvcreate"; "LV4"; "VG2"; "50"];
2165 ["lvcreate"; "LV5"; "VG2"; "50"];
2167 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2168 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2169 "create an LVM logical volume",
2171 This creates an LVM logical volume called C<logvol>
2172 on the volume group C<volgroup>, with C<size> megabytes.");
2174 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2175 [InitEmpty, Always, TestOutput (
2176 [["part_disk"; "/dev/sda"; "mbr"];
2177 ["mkfs"; "ext2"; "/dev/sda1"];
2178 ["mount_options"; ""; "/dev/sda1"; "/"];
2179 ["write"; "/new"; "new file contents"];
2180 ["cat"; "/new"]], "new file contents")],
2181 "make a filesystem",
2183 This creates a filesystem on C<device> (usually a partition
2184 or LVM logical volume). The filesystem type is C<fstype>, for
2187 ("sfdisk", (RErr, [Device "device";
2188 Int "cyls"; Int "heads"; Int "sectors";
2189 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2191 "create partitions on a block device",
2193 This is a direct interface to the L<sfdisk(8)> program for creating
2194 partitions on block devices.
2196 C<device> should be a block device, for example C</dev/sda>.
2198 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2199 and sectors on the device, which are passed directly to sfdisk as
2200 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2201 of these, then the corresponding parameter is omitted. Usually for
2202 'large' disks, you can just pass C<0> for these, but for small
2203 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2204 out the right geometry and you will need to tell it.
2206 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2207 information refer to the L<sfdisk(8)> manpage.
2209 To create a single partition occupying the whole disk, you would
2210 pass C<lines> as a single element list, when the single element being
2211 the string C<,> (comma).
2213 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2214 C<guestfs_part_init>");
2216 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2217 (* Regression test for RHBZ#597135. *)
2218 [InitScratchFS, Always, TestLastFail
2219 [["write_file"; "/write_file"; "abc"; "10000"]]],
2222 This call creates a file called C<path>. The contents of the
2223 file is the string C<content> (which can contain any 8 bit data),
2224 with length C<size>.
2226 As a special case, if C<size> is C<0>
2227 then the length is calculated using C<strlen> (so in this case
2228 the content cannot contain embedded ASCII NULs).
2230 I<NB.> Owing to a bug, writing content containing ASCII NUL
2231 characters does I<not> work, even if the length is specified.");
2233 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2234 [InitEmpty, Always, TestOutputListOfDevices (
2235 [["part_disk"; "/dev/sda"; "mbr"];
2236 ["mkfs"; "ext2"; "/dev/sda1"];
2237 ["mount_options"; ""; "/dev/sda1"; "/"];
2238 ["mounts"]], ["/dev/sda1"]);
2239 InitEmpty, Always, TestOutputList (
2240 [["part_disk"; "/dev/sda"; "mbr"];
2241 ["mkfs"; "ext2"; "/dev/sda1"];
2242 ["mount_options"; ""; "/dev/sda1"; "/"];
2245 "unmount a filesystem",
2247 This unmounts the given filesystem. The filesystem may be
2248 specified either by its mountpoint (path) or the device which
2249 contains the filesystem.");
2251 ("mounts", (RStringList "devices", [], []), 46, [],
2252 [InitScratchFS, Always, TestOutputListOfDevices (
2253 [["mounts"]], ["/dev/sdb1"])],
2254 "show mounted filesystems",
2256 This returns the list of currently mounted filesystems. It returns
2257 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2259 Some internal mounts are not shown.
2261 See also: C<guestfs_mountpoints>");
2263 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2264 [InitScratchFS, Always, TestOutputList (
2267 (* check that umount_all can unmount nested mounts correctly: *)
2268 InitEmpty, Always, TestOutputList (
2269 [["part_init"; "/dev/sda"; "mbr"];
2270 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2271 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2272 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2273 ["mkfs"; "ext2"; "/dev/sda1"];
2274 ["mkfs"; "ext2"; "/dev/sda2"];
2275 ["mkfs"; "ext2"; "/dev/sda3"];
2276 ["mount_options"; ""; "/dev/sda1"; "/"];
2278 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2279 ["mkdir"; "/mp1/mp2"];
2280 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2281 ["mkdir"; "/mp1/mp2/mp3"];
2284 "unmount all filesystems",
2286 This unmounts all mounted filesystems.
2288 Some internal mounts are not unmounted by this call.");
2290 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2292 "remove all LVM LVs, VGs and PVs",
2294 This command removes all LVM logical volumes, volume groups
2295 and physical volumes.");
2297 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2298 [InitISOFS, Always, TestOutput (
2299 [["file"; "/empty"]], "empty");
2300 InitISOFS, Always, TestOutput (
2301 [["file"; "/known-1"]], "ASCII text");
2302 InitISOFS, Always, TestLastFail (
2303 [["file"; "/notexists"]]);
2304 InitISOFS, Always, TestOutput (
2305 [["file"; "/abssymlink"]], "symbolic link");
2306 InitISOFS, Always, TestOutput (
2307 [["file"; "/directory"]], "directory")],
2308 "determine file type",
2310 This call uses the standard L<file(1)> command to determine
2311 the type or contents of the file.
2313 This call will also transparently look inside various types
2316 The exact command which runs is C<file -zb path>. Note in
2317 particular that the filename is not prepended to the output
2320 The output depends on the output of the underlying L<file(1)>
2321 command and it can change in future in ways beyond our control.
2322 In other words, the output is not guaranteed by the ABI.
2324 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2325 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2327 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2328 [InitScratchFS, Always, TestOutput (
2329 [["mkdir"; "/command"];
2330 ["upload"; "test-command"; "/command/test-command"];
2331 ["chmod"; "0o755"; "/command/test-command"];
2332 ["command"; "/command/test-command 1"]], "Result1");
2333 InitScratchFS, Always, TestOutput (
2334 [["mkdir"; "/command2"];
2335 ["upload"; "test-command"; "/command2/test-command"];
2336 ["chmod"; "0o755"; "/command2/test-command"];
2337 ["command"; "/command2/test-command 2"]], "Result2\n");
2338 InitScratchFS, Always, TestOutput (
2339 [["mkdir"; "/command3"];
2340 ["upload"; "test-command"; "/command3/test-command"];
2341 ["chmod"; "0o755"; "/command3/test-command"];
2342 ["command"; "/command3/test-command 3"]], "\nResult3");
2343 InitScratchFS, Always, TestOutput (
2344 [["mkdir"; "/command4"];
2345 ["upload"; "test-command"; "/command4/test-command"];
2346 ["chmod"; "0o755"; "/command4/test-command"];
2347 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2348 InitScratchFS, Always, TestOutput (
2349 [["mkdir"; "/command5"];
2350 ["upload"; "test-command"; "/command5/test-command"];
2351 ["chmod"; "0o755"; "/command5/test-command"];
2352 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2353 InitScratchFS, Always, TestOutput (
2354 [["mkdir"; "/command6"];
2355 ["upload"; "test-command"; "/command6/test-command"];
2356 ["chmod"; "0o755"; "/command6/test-command"];
2357 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2358 InitScratchFS, Always, TestOutput (
2359 [["mkdir"; "/command7"];
2360 ["upload"; "test-command"; "/command7/test-command"];
2361 ["chmod"; "0o755"; "/command7/test-command"];
2362 ["command"; "/command7/test-command 7"]], "");
2363 InitScratchFS, Always, TestOutput (
2364 [["mkdir"; "/command8"];
2365 ["upload"; "test-command"; "/command8/test-command"];
2366 ["chmod"; "0o755"; "/command8/test-command"];
2367 ["command"; "/command8/test-command 8"]], "\n");
2368 InitScratchFS, Always, TestOutput (
2369 [["mkdir"; "/command9"];
2370 ["upload"; "test-command"; "/command9/test-command"];
2371 ["chmod"; "0o755"; "/command9/test-command"];
2372 ["command"; "/command9/test-command 9"]], "\n\n");
2373 InitScratchFS, Always, TestOutput (
2374 [["mkdir"; "/command10"];
2375 ["upload"; "test-command"; "/command10/test-command"];
2376 ["chmod"; "0o755"; "/command10/test-command"];
2377 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2378 InitScratchFS, Always, TestOutput (
2379 [["mkdir"; "/command11"];
2380 ["upload"; "test-command"; "/command11/test-command"];
2381 ["chmod"; "0o755"; "/command11/test-command"];
2382 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2383 InitScratchFS, Always, TestLastFail (
2384 [["mkdir"; "/command12"];
2385 ["upload"; "test-command"; "/command12/test-command"];
2386 ["chmod"; "0o755"; "/command12/test-command"];
2387 ["command"; "/command12/test-command"]])],
2388 "run a command from the guest filesystem",
2390 This call runs a command from the guest filesystem. The
2391 filesystem must be mounted, and must contain a compatible
2392 operating system (ie. something Linux, with the same
2393 or compatible processor architecture).
2395 The single parameter is an argv-style list of arguments.
2396 The first element is the name of the program to run.
2397 Subsequent elements are parameters. The list must be
2398 non-empty (ie. must contain a program name). Note that
2399 the command runs directly, and is I<not> invoked via
2400 the shell (see C<guestfs_sh>).
2402 The return value is anything printed to I<stdout> by
2405 If the command returns a non-zero exit status, then
2406 this function returns an error message. The error message
2407 string is the content of I<stderr> from the command.
2409 The C<$PATH> environment variable will contain at least
2410 C</usr/bin> and C</bin>. If you require a program from
2411 another location, you should provide the full path in the
2414 Shared libraries and data files required by the program
2415 must be available on filesystems which are mounted in the
2416 correct places. It is the caller's responsibility to ensure
2417 all filesystems that are needed are mounted at the right
2420 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2421 [InitScratchFS, Always, TestOutputList (
2422 [["mkdir"; "/command_lines"];
2423 ["upload"; "test-command"; "/command_lines/test-command"];
2424 ["chmod"; "0o755"; "/command_lines/test-command"];
2425 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2426 InitScratchFS, Always, TestOutputList (
2427 [["mkdir"; "/command_lines2"];
2428 ["upload"; "test-command"; "/command_lines2/test-command"];
2429 ["chmod"; "0o755"; "/command_lines2/test-command"];
2430 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2431 InitScratchFS, Always, TestOutputList (
2432 [["mkdir"; "/command_lines3"];
2433 ["upload"; "test-command"; "/command_lines3/test-command"];
2434 ["chmod"; "0o755"; "/command_lines3/test-command"];
2435 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2436 InitScratchFS, Always, TestOutputList (
2437 [["mkdir"; "/command_lines4"];
2438 ["upload"; "test-command"; "/command_lines4/test-command"];
2439 ["chmod"; "0o755"; "/command_lines4/test-command"];
2440 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2441 InitScratchFS, Always, TestOutputList (
2442 [["mkdir"; "/command_lines5"];
2443 ["upload"; "test-command"; "/command_lines5/test-command"];
2444 ["chmod"; "0o755"; "/command_lines5/test-command"];
2445 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2446 InitScratchFS, Always, TestOutputList (
2447 [["mkdir"; "/command_lines6"];
2448 ["upload"; "test-command"; "/command_lines6/test-command"];
2449 ["chmod"; "0o755"; "/command_lines6/test-command"];
2450 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2451 InitScratchFS, Always, TestOutputList (
2452 [["mkdir"; "/command_lines7"];
2453 ["upload"; "test-command"; "/command_lines7/test-command"];
2454 ["chmod"; "0o755"; "/command_lines7/test-command"];
2455 ["command_lines"; "/command_lines7/test-command 7"]], []);
2456 InitScratchFS, Always, TestOutputList (
2457 [["mkdir"; "/command_lines8"];
2458 ["upload"; "test-command"; "/command_lines8/test-command"];
2459 ["chmod"; "0o755"; "/command_lines8/test-command"];
2460 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2461 InitScratchFS, Always, TestOutputList (
2462 [["mkdir"; "/command_lines9"];
2463 ["upload"; "test-command"; "/command_lines9/test-command"];
2464 ["chmod"; "0o755"; "/command_lines9/test-command"];
2465 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2466 InitScratchFS, Always, TestOutputList (
2467 [["mkdir"; "/command_lines10"];
2468 ["upload"; "test-command"; "/command_lines10/test-command"];
2469 ["chmod"; "0o755"; "/command_lines10/test-command"];
2470 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2471 InitScratchFS, Always, TestOutputList (
2472 [["mkdir"; "/command_lines11"];
2473 ["upload"; "test-command"; "/command_lines11/test-command"];
2474 ["chmod"; "0o755"; "/command_lines11/test-command"];
2475 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2476 "run a command, returning lines",
2478 This is the same as C<guestfs_command>, but splits the
2479 result into a list of lines.
2481 See also: C<guestfs_sh_lines>");
2483 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2484 [InitISOFS, Always, TestOutputStruct (
2485 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2486 "get file information",
2488 Returns file information for the given C<path>.
2490 This is the same as the C<stat(2)> system call.");
2492 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2493 [InitISOFS, Always, TestOutputStruct (
2494 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2495 "get file information for a symbolic link",
2497 Returns file information for the given C<path>.
2499 This is the same as C<guestfs_stat> except that if C<path>
2500 is a symbolic link, then the link is stat-ed, not the file it
2503 This is the same as the C<lstat(2)> system call.");
2505 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2506 [InitISOFS, Always, TestOutputStruct (
2507 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2508 "get file system statistics",
2510 Returns file system statistics for any mounted file system.
2511 C<path> should be a file or directory in the mounted file system
2512 (typically it is the mount point itself, but it doesn't need to be).
2514 This is the same as the C<statvfs(2)> system call.");
2516 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2518 "get ext2/ext3/ext4 superblock details",
2520 This returns the contents of the ext2, ext3 or ext4 filesystem
2521 superblock on C<device>.
2523 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2524 manpage for more details. The list of fields returned isn't
2525 clearly defined, and depends on both the version of C<tune2fs>
2526 that libguestfs was built against, and the filesystem itself.");
2528 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2529 [InitEmpty, Always, TestOutputTrue (
2530 [["blockdev_setro"; "/dev/sda"];
2531 ["blockdev_getro"; "/dev/sda"]])],
2532 "set block device to read-only",
2534 Sets the block device named C<device> to read-only.
2536 This uses the L<blockdev(8)> command.");
2538 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2539 [InitEmpty, Always, TestOutputFalse (
2540 [["blockdev_setrw"; "/dev/sda"];
2541 ["blockdev_getro"; "/dev/sda"]])],
2542 "set block device to read-write",
2544 Sets the block device named C<device> to read-write.
2546 This uses the L<blockdev(8)> command.");
2548 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2549 [InitEmpty, Always, TestOutputTrue (
2550 [["blockdev_setro"; "/dev/sda"];
2551 ["blockdev_getro"; "/dev/sda"]])],
2552 "is block device set to read-only",
2554 Returns a boolean indicating if the block device is read-only
2555 (true if read-only, false if not).
2557 This uses the L<blockdev(8)> command.");
2559 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2560 [InitEmpty, Always, TestOutputInt (
2561 [["blockdev_getss"; "/dev/sda"]], 512)],
2562 "get sectorsize of block device",
2564 This returns the size of sectors on a block device.
2565 Usually 512, but can be larger for modern devices.
2567 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2570 This uses the L<blockdev(8)> command.");
2572 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2573 [InitEmpty, Always, TestOutputInt (
2574 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2575 "get blocksize of block device",
2577 This returns the block size of a device.
2579 (Note this is different from both I<size in blocks> and
2580 I<filesystem block size>).
2582 This uses the L<blockdev(8)> command.");
2584 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2586 "set blocksize of block device",
2588 This sets the block size of a device.
2590 (Note this is different from both I<size in blocks> and
2591 I<filesystem block size>).
2593 This uses the L<blockdev(8)> command.");
2595 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2596 [InitEmpty, Always, TestOutputInt (
2597 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2598 "get total size of device in 512-byte sectors",
2600 This returns the size of the device in units of 512-byte sectors
2601 (even if the sectorsize isn't 512 bytes ... weird).
2603 See also C<guestfs_blockdev_getss> for the real sector size of
2604 the device, and C<guestfs_blockdev_getsize64> for the more
2605 useful I<size in bytes>.
2607 This uses the L<blockdev(8)> command.");
2609 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2610 [InitEmpty, Always, TestOutputInt (
2611 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2612 "get total size of device in bytes",
2614 This returns the size of the device in bytes.
2616 See also C<guestfs_blockdev_getsz>.
2618 This uses the L<blockdev(8)> command.");
2620 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2621 [InitEmpty, Always, TestRun
2622 [["blockdev_flushbufs"; "/dev/sda"]]],
2623 "flush device buffers",
2625 This tells the kernel to flush internal buffers associated
2628 This uses the L<blockdev(8)> command.");
2630 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2631 [InitEmpty, Always, TestRun
2632 [["blockdev_rereadpt"; "/dev/sda"]]],
2633 "reread partition table",
2635 Reread the partition table on C<device>.
2637 This uses the L<blockdev(8)> command.");
2639 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2640 [InitScratchFS, Always, TestOutput (
2641 (* Pick a file from cwd which isn't likely to change. *)
2642 [["mkdir"; "/upload"];
2643 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2644 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2645 Digest.to_hex (Digest.file "COPYING.LIB"))],
2646 "upload a file from the local machine",
2648 Upload local file C<filename> to C<remotefilename> on the
2651 C<filename> can also be a named pipe.
2653 See also C<guestfs_download>.");
2655 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2656 [InitScratchFS, Always, TestOutput (
2657 (* Pick a file from cwd which isn't likely to change. *)
2658 [["mkdir"; "/download"];
2659 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2660 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2661 ["upload"; "testdownload.tmp"; "/download/upload"];
2662 ["checksum"; "md5"; "/download/upload"]],
2663 Digest.to_hex (Digest.file "COPYING.LIB"))],
2664 "download a file to the local machine",
2666 Download file C<remotefilename> and save it as C<filename>
2667 on the local machine.
2669 C<filename> can also be a named pipe.
2671 See also C<guestfs_upload>, C<guestfs_cat>.");
2673 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2674 [InitISOFS, Always, TestOutput (
2675 [["checksum"; "crc"; "/known-3"]], "2891671662");
2676 InitISOFS, Always, TestLastFail (
2677 [["checksum"; "crc"; "/notexists"]]);
2678 InitISOFS, Always, TestOutput (
2679 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2680 InitISOFS, Always, TestOutput (
2681 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2682 InitISOFS, Always, TestOutput (
2683 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2684 InitISOFS, Always, TestOutput (
2685 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2686 InitISOFS, Always, TestOutput (
2687 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2688 InitISOFS, Always, TestOutput (
2689 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2690 (* Test for RHBZ#579608, absolute symbolic links. *)
2691 InitISOFS, Always, TestOutput (
2692 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2693 "compute MD5, SHAx or CRC checksum of file",
2695 This call computes the MD5, SHAx or CRC checksum of the
2698 The type of checksum to compute is given by the C<csumtype>
2699 parameter which must have one of the following values:
2705 Compute the cyclic redundancy check (CRC) specified by POSIX
2706 for the C<cksum> command.
2710 Compute the MD5 hash (using the C<md5sum> program).
2714 Compute the SHA1 hash (using the C<sha1sum> program).
2718 Compute the SHA224 hash (using the C<sha224sum> program).
2722 Compute the SHA256 hash (using the C<sha256sum> program).
2726 Compute the SHA384 hash (using the C<sha384sum> program).
2730 Compute the SHA512 hash (using the C<sha512sum> program).
2734 The checksum is returned as a printable string.
2736 To get the checksum for a device, use C<guestfs_checksum_device>.
2738 To get the checksums for many files, use C<guestfs_checksums_out>.");
2740 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2741 [InitScratchFS, Always, TestOutput (
2742 [["mkdir"; "/tar_in"];
2743 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2744 ["cat"; "/tar_in/hello"]], "hello\n")],
2745 "unpack tarfile to directory",
2747 This command uploads and unpacks local file C<tarfile> (an
2748 I<uncompressed> tar file) into C<directory>.
2750 To upload a compressed tarball, use C<guestfs_tgz_in>
2751 or C<guestfs_txz_in>.");
2753 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2755 "pack directory into tarfile",
2757 This command packs the contents of C<directory> and downloads
2758 it to local file C<tarfile>.
2760 To download a compressed tarball, use C<guestfs_tgz_out>
2761 or C<guestfs_txz_out>.");
2763 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2764 [InitScratchFS, Always, TestOutput (
2765 [["mkdir"; "/tgz_in"];
2766 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2767 ["cat"; "/tgz_in/hello"]], "hello\n")],
2768 "unpack compressed tarball to directory",
2770 This command uploads and unpacks local file C<tarball> (a
2771 I<gzip compressed> tar file) into C<directory>.
2773 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2775 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2777 "pack directory into compressed tarball",
2779 This command packs the contents of C<directory> and downloads
2780 it to local file C<tarball>.
2782 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2784 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2785 [InitBasicFS, Always, TestLastFail (
2787 ["mount_ro"; "/dev/sda1"; "/"];
2788 ["touch"; "/new"]]);
2789 InitBasicFS, Always, TestOutput (
2790 [["write"; "/new"; "data"];
2792 ["mount_ro"; "/dev/sda1"; "/"];
2793 ["cat"; "/new"]], "data")],
2794 "mount a guest disk, read-only",
2796 This is the same as the C<guestfs_mount> command, but it
2797 mounts the filesystem with the read-only (I<-o ro>) flag.");
2799 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2801 "mount a guest disk with mount options",
2803 This is the same as the C<guestfs_mount> command, but it
2804 allows you to set the mount options as for the
2805 L<mount(8)> I<-o> flag.
2807 If the C<options> parameter is an empty string, then
2808 no options are passed (all options default to whatever
2809 the filesystem uses).");
2811 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2813 "mount a guest disk with mount options and vfstype",
2815 This is the same as the C<guestfs_mount> command, but it
2816 allows you to set both the mount options and the vfstype
2817 as for the L<mount(8)> I<-o> and I<-t> flags.");
2819 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2821 "debugging and internals",
2823 The C<guestfs_debug> command exposes some internals of
2824 C<guestfsd> (the guestfs daemon) that runs inside the
2827 There is no comprehensive help for this command. You have
2828 to look at the file C<daemon/debug.c> in the libguestfs source
2829 to find out what you can do.");
2831 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2832 [InitEmpty, Always, TestOutputList (
2833 [["part_disk"; "/dev/sda"; "mbr"];
2834 ["pvcreate"; "/dev/sda1"];
2835 ["vgcreate"; "VG"; "/dev/sda1"];
2836 ["lvcreate"; "LV1"; "VG"; "50"];
2837 ["lvcreate"; "LV2"; "VG"; "50"];
2838 ["lvremove"; "/dev/VG/LV1"];
2839 ["lvs"]], ["/dev/VG/LV2"]);
2840 InitEmpty, Always, TestOutputList (
2841 [["part_disk"; "/dev/sda"; "mbr"];
2842 ["pvcreate"; "/dev/sda1"];
2843 ["vgcreate"; "VG"; "/dev/sda1"];
2844 ["lvcreate"; "LV1"; "VG"; "50"];
2845 ["lvcreate"; "LV2"; "VG"; "50"];
2846 ["lvremove"; "/dev/VG"];
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"];
2854 ["lvremove"; "/dev/VG"];
2856 "remove an LVM logical volume",
2858 Remove an LVM logical volume C<device>, where C<device> is
2859 the path to the LV, such as C</dev/VG/LV>.
2861 You can also remove all LVs in a volume group by specifying
2862 the VG name, C</dev/VG>.");
2864 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2865 [InitEmpty, Always, TestOutputList (
2866 [["part_disk"; "/dev/sda"; "mbr"];
2867 ["pvcreate"; "/dev/sda1"];
2868 ["vgcreate"; "VG"; "/dev/sda1"];
2869 ["lvcreate"; "LV1"; "VG"; "50"];
2870 ["lvcreate"; "LV2"; "VG"; "50"];
2873 InitEmpty, Always, TestOutputList (
2874 [["part_disk"; "/dev/sda"; "mbr"];
2875 ["pvcreate"; "/dev/sda1"];
2876 ["vgcreate"; "VG"; "/dev/sda1"];
2877 ["lvcreate"; "LV1"; "VG"; "50"];
2878 ["lvcreate"; "LV2"; "VG"; "50"];
2881 "remove an LVM volume group",
2883 Remove an LVM volume group C<vgname>, (for example C<VG>).
2885 This also forcibly removes all logical volumes in the volume
2888 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2889 [InitEmpty, Always, TestOutputListOfDevices (
2890 [["part_disk"; "/dev/sda"; "mbr"];
2891 ["pvcreate"; "/dev/sda1"];
2892 ["vgcreate"; "VG"; "/dev/sda1"];
2893 ["lvcreate"; "LV1"; "VG"; "50"];
2894 ["lvcreate"; "LV2"; "VG"; "50"];
2896 ["pvremove"; "/dev/sda1"];
2898 InitEmpty, Always, TestOutputListOfDevices (
2899 [["part_disk"; "/dev/sda"; "mbr"];
2900 ["pvcreate"; "/dev/sda1"];
2901 ["vgcreate"; "VG"; "/dev/sda1"];
2902 ["lvcreate"; "LV1"; "VG"; "50"];
2903 ["lvcreate"; "LV2"; "VG"; "50"];
2905 ["pvremove"; "/dev/sda1"];
2907 InitEmpty, Always, TestOutputListOfDevices (
2908 [["part_disk"; "/dev/sda"; "mbr"];
2909 ["pvcreate"; "/dev/sda1"];
2910 ["vgcreate"; "VG"; "/dev/sda1"];
2911 ["lvcreate"; "LV1"; "VG"; "50"];
2912 ["lvcreate"; "LV2"; "VG"; "50"];
2914 ["pvremove"; "/dev/sda1"];
2916 "remove an LVM physical volume",
2918 This wipes a physical volume C<device> so that LVM will no longer
2921 The implementation uses the C<pvremove> command which refuses to
2922 wipe physical volumes that contain any volume groups, so you have
2923 to remove those first.");
2925 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2926 [InitBasicFS, Always, TestOutput (
2927 [["set_e2label"; "/dev/sda1"; "testlabel"];
2928 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2929 "set the ext2/3/4 filesystem label",
2931 This sets the ext2/3/4 filesystem label of the filesystem on
2932 C<device> to C<label>. Filesystem labels are limited to
2935 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2936 to return the existing label on a filesystem.");
2938 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2940 "get the ext2/3/4 filesystem label",
2942 This returns the ext2/3/4 filesystem label of the filesystem on
2945 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2946 (let uuid = uuidgen () in
2947 [InitBasicFS, Always, TestOutput (
2948 [["set_e2uuid"; "/dev/sda1"; uuid];
2949 ["get_e2uuid"; "/dev/sda1"]], uuid);
2950 InitBasicFS, Always, TestOutput (
2951 [["set_e2uuid"; "/dev/sda1"; "clear"];
2952 ["get_e2uuid"; "/dev/sda1"]], "");
2953 (* We can't predict what UUIDs will be, so just check the commands run. *)
2954 InitBasicFS, Always, TestRun (
2955 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2956 InitBasicFS, Always, TestRun (
2957 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2958 "set the ext2/3/4 filesystem UUID",
2960 This sets the ext2/3/4 filesystem UUID of the filesystem on
2961 C<device> to C<uuid>. The format of the UUID and alternatives
2962 such as C<clear>, C<random> and C<time> are described in the
2963 L<tune2fs(8)> manpage.
2965 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2966 to return the existing UUID of a filesystem.");
2968 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2969 (* Regression test for RHBZ#597112. *)
2970 (let uuid = uuidgen () in
2971 [InitNone, Always, TestOutput (
2972 [["mke2journal"; "1024"; "/dev/sdc"];
2973 ["set_e2uuid"; "/dev/sdc"; uuid];
2974 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2975 "get the ext2/3/4 filesystem UUID",
2977 This returns the ext2/3/4 filesystem UUID of the filesystem on
2980 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2981 [InitBasicFS, Always, TestOutputInt (
2982 [["umount"; "/dev/sda1"];
2983 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2984 InitBasicFS, Always, TestOutputInt (
2985 [["umount"; "/dev/sda1"];
2986 ["zero"; "/dev/sda1"];
2987 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2988 "run the filesystem checker",
2990 This runs the filesystem checker (fsck) on C<device> which
2991 should have filesystem type C<fstype>.
2993 The returned integer is the status. See L<fsck(8)> for the
2994 list of status codes from C<fsck>.
3002 Multiple status codes can be summed together.
3006 A non-zero return code can mean \"success\", for example if
3007 errors have been corrected on the filesystem.
3011 Checking or repairing NTFS volumes is not supported
3016 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3018 ("zero", (RErr, [Device "device"], []), 85, [Progress],
3019 [InitBasicFS, Always, TestRun (
3020 [["umount"; "/dev/sda1"];
3021 ["zero"; "/dev/sda1"]])],
3022 "write zeroes to the device",
3024 This command writes zeroes over the first few blocks of C<device>.
3026 How many blocks are zeroed isn't specified (but it's I<not> enough
3027 to securely wipe the device). It should be sufficient to remove
3028 any partition tables, filesystem superblocks and so on.
3030 If blocks are already zero, then this command avoids writing
3031 zeroes. This prevents the underlying device from becoming non-sparse
3032 or growing unnecessarily.
3034 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3035 C<guestfs_is_zero_device>");
3037 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3039 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3040 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3042 [InitBasicFS, Always, TestOutputTrue (
3043 [["mkdir_p"; "/boot/grub"];
3044 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3045 ["grub_install"; "/"; "/dev/vda"];
3046 ["is_dir"; "/boot"]])],
3049 This command installs GRUB 1 (the Grand Unified Bootloader) on
3050 C<device>, with the root directory being C<root>.
3058 There is currently no way in the API to install grub2, which
3059 is used by most modern Linux guests. It is possible to run
3060 the grub2 command from the guest, although see the
3061 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3065 This uses C<grub-install> from the host. Unfortunately grub is
3066 not always compatible with itself, so this only works in rather
3067 narrow circumstances. Careful testing with each guest version
3072 If grub-install reports the error
3073 \"No suitable drive was found in the generated device map.\"
3074 it may be that you need to create a C</boot/grub/device.map>
3075 file first that contains the mapping between grub device names
3076 and Linux device names. It is usually sufficient to create
3081 replacing C</dev/vda> with the name of the installation device.
3085 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3086 [InitScratchFS, Always, TestOutput (
3088 ["write"; "/cp/old"; "file content"];
3089 ["cp"; "/cp/old"; "/cp/new"];
3090 ["cat"; "/cp/new"]], "file content");
3091 InitScratchFS, Always, TestOutputTrue (
3093 ["write"; "/cp2/old"; "file content"];
3094 ["cp"; "/cp2/old"; "/cp2/new"];
3095 ["is_file"; "/cp2/old"]]);
3096 InitScratchFS, Always, TestOutput (
3098 ["write"; "/cp3/old"; "file content"];
3099 ["mkdir"; "/cp3/dir"];
3100 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3101 ["cat"; "/cp3/dir/new"]], "file content")],
3104 This copies a file from C<src> to C<dest> where C<dest> is
3105 either a destination filename or destination directory.");
3107 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3108 [InitScratchFS, Always, TestOutput (
3109 [["mkdir"; "/cp_a1"];
3110 ["mkdir"; "/cp_a2"];
3111 ["write"; "/cp_a1/file"; "file content"];
3112 ["cp_a"; "/cp_a1"; "/cp_a2"];
3113 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3114 "copy a file or directory recursively",
3116 This copies a file or directory from C<src> to C<dest>
3117 recursively using the C<cp -a> command.");
3119 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3120 [InitScratchFS, Always, TestOutput (
3122 ["write"; "/mv/old"; "file content"];
3123 ["mv"; "/mv/old"; "/mv/new"];
3124 ["cat"; "/mv/new"]], "file content");
3125 InitScratchFS, Always, TestOutputFalse (
3127 ["write"; "/mv2/old"; "file content"];
3128 ["mv"; "/mv2/old"; "/mv2/new"];
3129 ["is_file"; "/mv2/old"]])],
3132 This moves a file from C<src> to C<dest> where C<dest> is
3133 either a destination filename or destination directory.");
3135 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3136 [InitEmpty, Always, TestRun (
3137 [["drop_caches"; "3"]])],
3138 "drop kernel page cache, dentries and inodes",
3140 This instructs the guest kernel to drop its page cache,
3141 and/or dentries and inode caches. The parameter C<whattodrop>
3142 tells the kernel what precisely to drop, see
3143 L<http://linux-mm.org/Drop_Caches>
3145 Setting C<whattodrop> to 3 should drop everything.
3147 This automatically calls L<sync(2)> before the operation,
3148 so that the maximum guest memory is freed.");
3150 ("dmesg", (RString "kmsgs", [], []), 91, [],
3151 [InitEmpty, Always, TestRun (
3153 "return kernel messages",
3155 This returns the kernel messages (C<dmesg> output) from
3156 the guest kernel. This is sometimes useful for extended
3157 debugging of problems.
3159 Another way to get the same information is to enable
3160 verbose messages with C<guestfs_set_verbose> or by setting
3161 the environment variable C<LIBGUESTFS_DEBUG=1> before
3162 running the program.");
3164 ("ping_daemon", (RErr, [], []), 92, [],
3165 [InitEmpty, Always, TestRun (
3166 [["ping_daemon"]])],
3167 "ping the guest daemon",
3169 This is a test probe into the guestfs daemon running inside
3170 the qemu subprocess. Calling this function checks that the
3171 daemon responds to the ping message, without affecting the daemon
3172 or attached block device(s) in any other way.");
3174 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3175 [InitScratchFS, Always, TestOutputTrue (
3176 [["mkdir"; "/equal"];
3177 ["write"; "/equal/file1"; "contents of a file"];
3178 ["cp"; "/equal/file1"; "/equal/file2"];
3179 ["equal"; "/equal/file1"; "/equal/file2"]]);
3180 InitScratchFS, Always, TestOutputFalse (
3181 [["mkdir"; "/equal2"];
3182 ["write"; "/equal2/file1"; "contents of a file"];
3183 ["write"; "/equal2/file2"; "contents of another file"];
3184 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3185 InitScratchFS, Always, TestLastFail (
3186 [["mkdir"; "/equal3"];
3187 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3188 "test if two files have equal contents",
3190 This compares the two files C<file1> and C<file2> and returns
3191 true if their content is exactly equal, or false otherwise.
3193 The external L<cmp(1)> program is used for the comparison.");
3195 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3196 [InitISOFS, Always, TestOutputList (
3197 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3198 InitISOFS, Always, TestOutputList (
3199 [["strings"; "/empty"]], []);
3200 (* Test for RHBZ#579608, absolute symbolic links. *)
3201 InitISOFS, Always, TestRun (
3202 [["strings"; "/abssymlink"]])],
3203 "print the printable strings in a file",
3205 This runs the L<strings(1)> command on a file and returns
3206 the list of printable strings found.");
3208 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3209 [InitISOFS, Always, TestOutputList (
3210 [["strings_e"; "b"; "/known-5"]], []);
3211 InitScratchFS, Always, TestOutputList (
3212 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3213 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3214 "print the printable strings in a file",
3216 This is like the C<guestfs_strings> command, but allows you to
3217 specify the encoding of strings that are looked for in
3218 the source file C<path>.
3220 Allowed encodings are:
3226 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3227 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3231 Single 8-bit-byte characters.
3235 16-bit big endian strings such as those encoded in
3236 UTF-16BE or UCS-2BE.
3238 =item l (lower case letter L)
3240 16-bit little endian such as UTF-16LE and UCS-2LE.
3241 This is useful for examining binaries in Windows guests.
3245 32-bit big endian such as UCS-4BE.
3249 32-bit little endian such as UCS-4LE.
3253 The returned strings are transcoded to UTF-8.");
3255 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3256 [InitISOFS, Always, TestOutput (
3257 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3258 (* Test for RHBZ#501888c2 regression which caused large hexdump
3259 * commands to segfault.
3261 InitISOFS, Always, TestRun (
3262 [["hexdump"; "/100krandom"]]);
3263 (* Test for RHBZ#579608, absolute symbolic links. *)
3264 InitISOFS, Always, TestRun (
3265 [["hexdump"; "/abssymlink"]])],
3266 "dump a file in hexadecimal",
3268 This runs C<hexdump -C> on the given C<path>. The result is
3269 the human-readable, canonical hex dump of the file.");
3271 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3272 [InitNone, Always, TestOutput (
3273 [["part_disk"; "/dev/sda"; "mbr"];
3274 ["mkfs"; "ext3"; "/dev/sda1"];
3275 ["mount_options"; ""; "/dev/sda1"; "/"];
3276 ["write"; "/new"; "test file"];
3277 ["umount"; "/dev/sda1"];
3278 ["zerofree"; "/dev/sda1"];
3279 ["mount_options"; ""; "/dev/sda1"; "/"];
3280 ["cat"; "/new"]], "test file")],
3281 "zero unused inodes and disk blocks on ext2/3 filesystem",
3283 This runs the I<zerofree> program on C<device>. This program
3284 claims to zero unused inodes and disk blocks on an ext2/3
3285 filesystem, thus making it possible to compress the filesystem
3288 You should B<not> run this program if the filesystem is
3291 It is possible that using this program can damage the filesystem
3292 or data on the filesystem.");
3294 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3296 "resize an LVM physical volume",
3298 This resizes (expands or shrinks) an existing LVM physical
3299 volume to match the new size of the underlying device.");
3301 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3302 Int "cyls"; Int "heads"; Int "sectors";
3303 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3305 "modify a single partition on a block device",
3307 This runs L<sfdisk(8)> option to modify just the single
3308 partition C<n> (note: C<n> counts from 1).
3310 For other parameters, see C<guestfs_sfdisk>. You should usually
3311 pass C<0> for the cyls/heads/sectors parameters.
3313 See also: C<guestfs_part_add>");
3315 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3317 "display the partition table",
3319 This displays the partition table on C<device>, in the
3320 human-readable output of the L<sfdisk(8)> command. It is
3321 not intended to be parsed.
3323 See also: C<guestfs_part_list>");
3325 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3327 "display the kernel geometry",
3329 This displays the kernel's idea of the geometry of C<device>.
3331 The result is in human-readable format, and not designed to
3334 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3336 "display the disk geometry from the partition table",
3338 This displays the disk geometry of C<device> read from the
3339 partition table. Especially in the case where the underlying
3340 block device has been resized, this can be different from the
3341 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3343 The result is in human-readable format, and not designed to
3346 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3348 "activate or deactivate all volume groups",
3350 This command activates or (if C<activate> is false) deactivates
3351 all logical volumes in all volume groups.
3353 This command is the same as running C<vgchange -a y|n>");
3355 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3357 "activate or deactivate some volume groups",
3359 This command activates or (if C<activate> is false) deactivates
3360 all logical volumes in the listed volume groups C<volgroups>.
3362 This command is the same as running C<vgchange -a y|n volgroups...>
3364 Note that if C<volgroups> is an empty list then B<all> volume groups
3365 are activated or deactivated.");
3367 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3368 [InitNone, Always, TestOutput (
3369 [["part_disk"; "/dev/sda"; "mbr"];
3370 ["pvcreate"; "/dev/sda1"];
3371 ["vgcreate"; "VG"; "/dev/sda1"];
3372 ["lvcreate"; "LV"; "VG"; "10"];
3373 ["mkfs"; "ext2"; "/dev/VG/LV"];
3374 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3375 ["write"; "/new"; "test content"];
3377 ["lvresize"; "/dev/VG/LV"; "20"];
3378 ["e2fsck_f"; "/dev/VG/LV"];
3379 ["resize2fs"; "/dev/VG/LV"];
3380 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3381 ["cat"; "/new"]], "test content");
3382 InitNone, Always, TestRun (
3383 (* Make an LV smaller to test RHBZ#587484. *)
3384 [["part_disk"; "/dev/sda"; "mbr"];
3385 ["pvcreate"; "/dev/sda1"];
3386 ["vgcreate"; "VG"; "/dev/sda1"];
3387 ["lvcreate"; "LV"; "VG"; "20"];
3388 ["lvresize"; "/dev/VG/LV"; "10"]])],
3389 "resize an LVM logical volume",
3391 This resizes (expands or shrinks) an existing LVM logical
3392 volume to C<mbytes>. When reducing, data in the reduced part
3395 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3396 [], (* lvresize tests this *)
3397 "resize an ext2, ext3 or ext4 filesystem",
3399 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3400 the underlying device.
3402 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3403 on the C<device> before calling this command. For unknown reasons
3404 C<resize2fs> sometimes gives an error about this and sometimes not.
3405 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3406 calling this function.");
3408 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3409 [InitBasicFS, Always, TestOutputList (
3410 [["find"; "/"]], ["lost+found"]);
3411 InitBasicFS, Always, TestOutputList (
3415 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3416 InitScratchFS, Always, TestOutputList (
3417 [["mkdir_p"; "/find/b/c"];
3418 ["touch"; "/find/b/c/d"];
3419 ["find"; "/find/b/"]], ["c"; "c/d"])],
3420 "find all files and directories",
3422 This command lists out all files and directories, recursively,
3423 starting at C<directory>. It is essentially equivalent to
3424 running the shell command C<find directory -print> but some
3425 post-processing happens on the output, described below.
3427 This returns a list of strings I<without any prefix>. Thus
3428 if the directory structure was:
3434 then the returned list from C<guestfs_find> C</tmp> would be
3442 If C<directory> is not a directory, then this command returns
3445 The returned list is sorted.
3447 See also C<guestfs_find0>.");
3449 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3450 [], (* lvresize tests this *)
3451 "check an ext2/ext3 filesystem",
3453 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3454 filesystem checker on C<device>, noninteractively (I<-p>),
3455 even if the filesystem appears to be clean (I<-f>).
3457 This command is only needed because of C<guestfs_resize2fs>
3458 (q.v.). Normally you should use C<guestfs_fsck>.");
3460 ("sleep", (RErr, [Int "secs"], []), 109, [],
3461 [InitNone, Always, TestRun (
3463 "sleep for some seconds",
3465 Sleep for C<secs> seconds.");
3467 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3468 [InitNone, Always, TestOutputInt (
3469 [["part_disk"; "/dev/sda"; "mbr"];
3470 ["mkfs"; "ntfs"; "/dev/sda1"];
3471 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3472 InitNone, Always, TestOutputInt (
3473 [["part_disk"; "/dev/sda"; "mbr"];
3474 ["mkfs"; "ext2"; "/dev/sda1"];
3475 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3476 "probe NTFS volume",
3478 This command runs the L<ntfs-3g.probe(8)> command which probes
3479 an NTFS C<device> for mountability. (Not all NTFS volumes can
3480 be mounted read-write, and some cannot be mounted at all).
3482 C<rw> is a boolean flag. Set it to true if you want to test
3483 if the volume can be mounted read-write. Set it to false if
3484 you want to test if the volume can be mounted read-only.
3486 The return value is an integer which C<0> if the operation
3487 would succeed, or some non-zero value documented in the
3488 L<ntfs-3g.probe(8)> manual page.");
3490 ("sh", (RString "output", [String "command"], []), 111, [],
3491 [], (* XXX needs tests *)
3492 "run a command via the shell",
3494 This call runs a command from the guest filesystem via the
3497 This is like C<guestfs_command>, but passes the command to:
3499 /bin/sh -c \"command\"
3501 Depending on the guest's shell, this usually results in
3502 wildcards being expanded, shell expressions being interpolated
3505 All the provisos about C<guestfs_command> apply to this call.");
3507 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3508 [], (* XXX needs tests *)
3509 "run a command via the shell returning lines",
3511 This is the same as C<guestfs_sh>, but splits the result
3512 into a list of lines.
3514 See also: C<guestfs_command_lines>");
3516 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3517 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3518 * code in stubs.c, since all valid glob patterns must start with "/".
3519 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3521 [InitScratchFS, Always, TestOutputList (
3522 [["mkdir_p"; "/glob_expand/b/c"];
3523 ["touch"; "/glob_expand/b/c/d"];
3524 ["touch"; "/glob_expand/b/c/e"];
3525 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3526 InitScratchFS, Always, TestOutputList (
3527 [["mkdir_p"; "/glob_expand2/b/c"];
3528 ["touch"; "/glob_expand2/b/c/d"];
3529 ["touch"; "/glob_expand2/b/c/e"];
3530 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3531 InitScratchFS, Always, TestOutputList (
3532 [["mkdir_p"; "/glob_expand3/b/c"];
3533 ["touch"; "/glob_expand3/b/c/d"];
3534 ["touch"; "/glob_expand3/b/c/e"];
3535 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3536 "expand a wildcard path",
3538 This command searches for all the pathnames matching
3539 C<pattern> according to the wildcard expansion rules
3542 If no paths match, then this returns an empty list
3543 (note: not an error).
3545 It is just a wrapper around the C L<glob(3)> function
3546 with flags C<GLOB_MARK|GLOB_BRACE>.
3547 See that manual page for more details.");
3549 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3550 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3551 [["scrub_device"; "/dev/sdc"]])],
3552 "scrub (securely wipe) a device",
3554 This command writes patterns over C<device> to make data retrieval
3557 It is an interface to the L<scrub(1)> program. See that
3558 manual page for more details.");
3560 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3561 [InitScratchFS, Always, TestRun (
3562 [["write"; "/scrub_file"; "content"];
3563 ["scrub_file"; "/scrub_file"]])],
3564 "scrub (securely wipe) a file",
3566 This command writes patterns over a file to make data retrieval
3569 The file is I<removed> after scrubbing.
3571 It is an interface to the L<scrub(1)> program. See that
3572 manual page for more details.");
3574 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3575 [], (* XXX needs testing *)
3576 "scrub (securely wipe) free space",
3578 This command creates the directory C<dir> and then fills it
3579 with files until the filesystem is full, and scrubs the files
3580 as for C<guestfs_scrub_file>, and deletes them.
3581 The intention is to scrub any free space on the partition
3584 It is an interface to the L<scrub(1)> program. See that
3585 manual page for more details.");
3587 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3588 [InitScratchFS, Always, TestRun (
3589 [["mkdir"; "/mkdtemp"];
3590 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3591 "create a temporary directory",
3593 This command creates a temporary directory. The
3594 C<template> parameter should be a full pathname for the
3595 temporary directory name with the final six characters being
3598 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3599 the second one being suitable for Windows filesystems.
3601 The name of the temporary directory that was created
3604 The temporary directory is created with mode 0700
3605 and is owned by root.
3607 The caller is responsible for deleting the temporary
3608 directory and its contents after use.
3610 See also: L<mkdtemp(3)>");
3612 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3613 [InitISOFS, Always, TestOutputInt (
3614 [["wc_l"; "/10klines"]], 10000);
3615 (* Test for RHBZ#579608, absolute symbolic links. *)
3616 InitISOFS, Always, TestOutputInt (
3617 [["wc_l"; "/abssymlink"]], 10000)],
3618 "count lines in a file",
3620 This command counts the lines in a file, using the
3621 C<wc -l> external command.");
3623 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3624 [InitISOFS, Always, TestOutputInt (
3625 [["wc_w"; "/10klines"]], 10000)],
3626 "count words in a file",
3628 This command counts the words in a file, using the
3629 C<wc -w> external command.");
3631 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3632 [InitISOFS, Always, TestOutputInt (
3633 [["wc_c"; "/100kallspaces"]], 102400)],
3634 "count characters in a file",
3636 This command counts the characters in a file, using the
3637 C<wc -c> external command.");
3639 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3640 [InitISOFS, Always, TestOutputList (
3641 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3642 (* Test for RHBZ#579608, absolute symbolic links. *)
3643 InitISOFS, Always, TestOutputList (
3644 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3645 "return first 10 lines of a file",
3647 This command returns up to the first 10 lines of a file as
3648 a list of strings.");
3650 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3651 [InitISOFS, Always, TestOutputList (
3652 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3653 InitISOFS, Always, TestOutputList (
3654 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3655 InitISOFS, Always, TestOutputList (
3656 [["head_n"; "0"; "/10klines"]], [])],
3657 "return first N lines of a file",
3659 If the parameter C<nrlines> is a positive number, this returns the first
3660 C<nrlines> lines of the file C<path>.
3662 If the parameter C<nrlines> is a negative number, this returns lines
3663 from the file C<path>, excluding the last C<nrlines> lines.
3665 If the parameter C<nrlines> is zero, this returns an empty list.");
3667 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3668 [InitISOFS, Always, TestOutputList (
3669 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3670 "return last 10 lines of a file",
3672 This command returns up to the last 10 lines of a file as
3673 a list of strings.");
3675 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3676 [InitISOFS, Always, TestOutputList (
3677 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3678 InitISOFS, Always, TestOutputList (
3679 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3680 InitISOFS, Always, TestOutputList (
3681 [["tail_n"; "0"; "/10klines"]], [])],
3682 "return last N lines of a file",
3684 If the parameter C<nrlines> is a positive number, this returns the last
3685 C<nrlines> lines of the file C<path>.
3687 If the parameter C<nrlines> is a negative number, this returns lines
3688 from the file C<path>, starting with the C<-nrlines>th line.
3690 If the parameter C<nrlines> is zero, this returns an empty list.");
3692 ("df", (RString "output", [], []), 125, [],
3693 [], (* XXX Tricky to test because it depends on the exact format
3694 * of the 'df' command and other imponderables.
3696 "report file system disk space usage",
3698 This command runs the C<df> command to report disk space used.
3700 This command is mostly useful for interactive sessions. It
3701 is I<not> intended that you try to parse the output string.
3702 Use C<guestfs_statvfs> from programs.");
3704 ("df_h", (RString "output", [], []), 126, [],
3705 [], (* XXX Tricky to test because it depends on the exact format
3706 * of the 'df' command and other imponderables.
3708 "report file system disk space usage (human readable)",
3710 This command runs the C<df -h> command to report disk space used
3711 in human-readable format.
3713 This command is mostly useful for interactive sessions. It
3714 is I<not> intended that you try to parse the output string.
3715 Use C<guestfs_statvfs> from programs.");
3717 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3718 [InitISOFS, Always, TestOutputInt (
3719 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3720 "estimate file space usage",
3722 This command runs the C<du -s> command to estimate file space
3725 C<path> can be a file or a directory. If C<path> is a directory
3726 then the estimate includes the contents of the directory and all
3727 subdirectories (recursively).
3729 The result is the estimated size in I<kilobytes>
3730 (ie. units of 1024 bytes).");
3732 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3733 [InitISOFS, Always, TestOutputList (
3734 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3735 "list files in an initrd",
3737 This command lists out files contained in an initrd.
3739 The files are listed without any initial C</> character. The
3740 files are listed in the order they appear (not necessarily
3741 alphabetical). Directory names are listed as separate items.
3743 Old Linux kernels (2.4 and earlier) used a compressed ext2
3744 filesystem as initrd. We I<only> support the newer initramfs
3745 format (compressed cpio files).");
3747 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3749 "mount a file using the loop device",
3751 This command lets you mount C<file> (a filesystem image
3752 in a file) on a mount point. It is entirely equivalent to
3753 the command C<mount -o loop file mountpoint>.");
3755 ("mkswap", (RErr, [Device "device"], []), 130, [],
3756 [InitEmpty, Always, TestRun (
3757 [["part_disk"; "/dev/sda"; "mbr"];
3758 ["mkswap"; "/dev/sda1"]])],
3759 "create a swap partition",
3761 Create a swap partition on C<device>.");
3763 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3764 [InitEmpty, Always, TestRun (
3765 [["part_disk"; "/dev/sda"; "mbr"];
3766 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3767 "create a swap partition with a label",
3769 Create a swap partition on C<device> with label C<label>.
3771 Note that you cannot attach a swap label to a block device
3772 (eg. C</dev/sda>), just to a partition. This appears to be
3773 a limitation of the kernel or swap tools.");
3775 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3776 (let uuid = uuidgen () in
3777 [InitEmpty, Always, TestRun (
3778 [["part_disk"; "/dev/sda"; "mbr"];
3779 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3780 "create a swap partition with an explicit UUID",
3782 Create a swap partition on C<device> with UUID C<uuid>.");
3784 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3785 [InitScratchFS, Always, TestOutputStruct (
3786 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3787 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3788 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3789 InitScratchFS, Always, TestOutputStruct (
3790 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3791 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3792 "make block, character or FIFO devices",
3794 This call creates block or character special devices, or
3795 named pipes (FIFOs).
3797 The C<mode> parameter should be the mode, using the standard
3798 constants. C<devmajor> and C<devminor> are the
3799 device major and minor numbers, only used when creating block
3800 and character special devices.
3802 Note that, just like L<mknod(2)>, the mode must be bitwise
3803 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3804 just creates a regular file). These constants are
3805 available in the standard Linux header files, or you can use
3806 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3807 which are wrappers around this command which bitwise OR
3808 in the appropriate constant for you.
3810 The mode actually set is affected by the umask.");
3812 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3813 [InitScratchFS, Always, TestOutputStruct (
3814 [["mkfifo"; "0o777"; "/mkfifo"];
3815 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3816 "make FIFO (named pipe)",
3818 This call creates a FIFO (named pipe) called C<path> with
3819 mode C<mode>. It is just a convenient wrapper around
3822 The mode actually set is affected by the umask.");
3824 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3825 [InitScratchFS, Always, TestOutputStruct (
3826 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3827 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3828 "make block device node",
3830 This call creates a block device node called C<path> with
3831 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3832 It is just a convenient wrapper around C<guestfs_mknod>.
3834 The mode actually set is affected by the umask.");
3836 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3837 [InitScratchFS, Always, TestOutputStruct (
3838 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3839 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3840 "make char device node",
3842 This call creates a char device node called C<path> with
3843 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3844 It is just a convenient wrapper around C<guestfs_mknod>.
3846 The mode actually set is affected by the umask.");
3848 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3849 [InitEmpty, Always, TestOutputInt (
3850 [["umask"; "0o22"]], 0o22)],
3851 "set file mode creation mask (umask)",
3853 This function sets the mask used for creating new files and
3854 device nodes to C<mask & 0777>.
3856 Typical umask values would be C<022> which creates new files
3857 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3858 C<002> which creates new files with permissions like
3859 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3861 The default umask is C<022>. This is important because it
3862 means that directories and device nodes will be created with
3863 C<0644> or C<0755> mode even if you specify C<0777>.
3865 See also C<guestfs_get_umask>,
3866 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3868 This call returns the previous umask.");
3870 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3872 "read directories entries",
3874 This returns the list of directory entries in directory C<dir>.
3876 All entries in the directory are returned, including C<.> and
3877 C<..>. The entries are I<not> sorted, but returned in the same
3878 order as the underlying filesystem.
3880 Also this call returns basic file type information about each
3881 file. The C<ftyp> field will contain one of the following characters:
3919 The L<readdir(3)> call returned a C<d_type> field with an
3924 This function is primarily intended for use by programs. To
3925 get a simple list of names, use C<guestfs_ls>. To get a printable
3926 directory for human consumption, use C<guestfs_ll>.");
3928 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3930 "create partitions on a block device",
3932 This is a simplified interface to the C<guestfs_sfdisk>
3933 command, where partition sizes are specified in megabytes
3934 only (rounded to the nearest cylinder) and you don't need
3935 to specify the cyls, heads and sectors parameters which
3936 were rarely if ever used anyway.
3938 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3939 and C<guestfs_part_disk>");
3941 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3943 "determine file type inside a compressed file",
3945 This command runs C<file> after first decompressing C<path>
3948 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3950 Since 1.0.63, use C<guestfs_file> instead which can now
3951 process compressed files.");
3953 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3955 "list extended attributes of a file or directory",
3957 This call lists the extended attributes of the file or directory
3960 At the system call level, this is a combination of the
3961 L<listxattr(2)> and L<getxattr(2)> calls.
3963 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3965 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3967 "list extended attributes of a file or directory",
3969 This is the same as C<guestfs_getxattrs>, but if C<path>
3970 is a symbolic link, then it returns the extended attributes
3971 of the link itself.");
3973 ("setxattr", (RErr, [String "xattr";
3974 String "val"; Int "vallen"; (* will be BufferIn *)
3975 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3977 "set extended attribute of a file or directory",
3979 This call sets the extended attribute named C<xattr>
3980 of the file C<path> to the value C<val> (of length C<vallen>).
3981 The value is arbitrary 8 bit data.
3983 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3985 ("lsetxattr", (RErr, [String "xattr";
3986 String "val"; Int "vallen"; (* will be BufferIn *)
3987 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3989 "set extended attribute of a file or directory",
3991 This is the same as C<guestfs_setxattr>, but if C<path>
3992 is a symbolic link, then it sets an extended attribute
3993 of the link itself.");
3995 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3997 "remove extended attribute of a file or directory",
3999 This call removes the extended attribute named C<xattr>
4000 of the file C<path>.
4002 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
4004 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
4006 "remove extended attribute of a file or directory",
4008 This is the same as C<guestfs_removexattr>, but if C<path>
4009 is a symbolic link, then it removes an extended attribute
4010 of the link itself.");
4012 ("mountpoints", (RHashtable "mps", [], []), 147, [],
4016 This call is similar to C<guestfs_mounts>. That call returns
4017 a list of devices. This one returns a hash table (map) of
4018 device name to directory where the device is mounted.");
4020 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
4021 (* This is a special case: while you would expect a parameter
4022 * of type "Pathname", that doesn't work, because it implies
4023 * NEED_ROOT in the generated calling code in stubs.c, and
4024 * this function cannot use NEED_ROOT.
4027 "create a mountpoint",
4029 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
4030 specialized calls that can be used to create extra mountpoints
4031 before mounting the first filesystem.
4033 These calls are I<only> necessary in some very limited circumstances,
4034 mainly the case where you want to mount a mix of unrelated and/or
4035 read-only filesystems together.
4037 For example, live CDs often contain a \"Russian doll\" nest of
4038 filesystems, an ISO outer layer, with a squashfs image inside, with
4039 an ext2/3 image inside that. You can unpack this as follows
4042 add-ro Fedora-11-i686-Live.iso
4046 mkmountpoint /ext3fs
4048 mount-loop /cd/LiveOS/squashfs.img /sqsh
4049 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4051 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4053 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4054 You may get unexpected errors if you try to mix these calls. It is
4055 safest to manually unmount filesystems and remove mountpoints after use.
4057 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4058 longest first, so for this to work for manual mountpoints, you
4059 must ensure that the innermost mountpoints have the longest
4060 pathnames, as in the example code above.
4062 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4064 Autosync [see C<guestfs_set_autosync>, this is set by default on
4065 handles] can cause C<guestfs_umount_all> to be called when the handle
4066 is closed which can also trigger these issues.");
4068 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4070 "remove a mountpoint",
4072 This calls removes a mountpoint that was previously created
4073 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4074 for full details.");
4076 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4077 [InitISOFS, Always, TestOutputBuffer (
4078 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4079 (* Test various near large, large and too large files (RHBZ#589039). *)
4080 InitScratchFS, Always, TestLastFail (
4081 [["touch"; "/read_file"];
4082 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4083 ["read_file"; "/read_file"]]);
4084 InitScratchFS, Always, TestLastFail (
4085 [["touch"; "/read_file2"];
4086 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4087 ["read_file"; "/read_file2"]]);
4088 InitScratchFS, Always, TestLastFail (
4089 [["touch"; "/read_file3"];
4090 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4091 ["read_file"; "/read_file3"]])],
4094 This calls returns the contents of the file C<path> as a
4097 Unlike C<guestfs_cat>, this function can correctly
4098 handle files that contain embedded ASCII NUL characters.
4099 However unlike C<guestfs_download>, this function is limited
4100 in the total size of file that can be handled.");
4102 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4103 [InitISOFS, Always, TestOutputList (
4104 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4105 InitISOFS, Always, TestOutputList (
4106 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4107 (* Test for RHBZ#579608, absolute symbolic links. *)
4108 InitISOFS, Always, TestOutputList (
4109 [["grep"; "nomatch"; "/abssymlink"]], [])],
4110 "return lines matching a pattern",
4112 This calls the external C<grep> program and returns the
4115 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4116 [InitISOFS, Always, TestOutputList (
4117 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4118 "return lines matching a pattern",
4120 This calls the external C<egrep> program and returns the
4123 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4124 [InitISOFS, Always, TestOutputList (
4125 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4126 "return lines matching a pattern",
4128 This calls the external C<fgrep> program and returns the
4131 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4132 [InitISOFS, Always, TestOutputList (
4133 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4134 "return lines matching a pattern",
4136 This calls the external C<grep -i> program and returns the
4139 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4140 [InitISOFS, Always, TestOutputList (
4141 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4142 "return lines matching a pattern",
4144 This calls the external C<egrep -i> program and returns the
4147 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4148 [InitISOFS, Always, TestOutputList (
4149 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4150 "return lines matching a pattern",
4152 This calls the external C<fgrep -i> program and returns the
4155 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4156 [InitISOFS, Always, TestOutputList (
4157 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4158 "return lines matching a pattern",
4160 This calls the external C<zgrep> program and returns the
4163 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4164 [InitISOFS, Always, TestOutputList (
4165 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4166 "return lines matching a pattern",
4168 This calls the external C<zegrep> program and returns the
4171 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4172 [InitISOFS, Always, TestOutputList (
4173 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4174 "return lines matching a pattern",
4176 This calls the external C<zfgrep> program and returns the
4179 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4180 [InitISOFS, Always, TestOutputList (
4181 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4182 "return lines matching a pattern",
4184 This calls the external C<zgrep -i> program and returns the
4187 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4188 [InitISOFS, Always, TestOutputList (
4189 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4190 "return lines matching a pattern",
4192 This calls the external C<zegrep -i> program and returns the
4195 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4196 [InitISOFS, Always, TestOutputList (
4197 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4198 "return lines matching a pattern",
4200 This calls the external C<zfgrep -i> program and returns the
4203 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4204 [InitISOFS, Always, TestOutput (
4205 [["realpath"; "/../directory"]], "/directory")],
4206 "canonicalized absolute pathname",
4208 Return the canonicalized absolute pathname of C<path>. The
4209 returned path has no C<.>, C<..> or symbolic link path elements.");
4211 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4212 [InitScratchFS, Always, TestOutputStruct (
4215 ["ln"; "/ln/a"; "/ln/b"];
4216 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4217 "create a hard link",
4219 This command creates a hard link using the C<ln> command.");
4221 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4222 [InitScratchFS, Always, TestOutputStruct (
4223 [["mkdir"; "/ln_f"];
4224 ["touch"; "/ln_f/a"];
4225 ["touch"; "/ln_f/b"];
4226 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4227 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4228 "create a hard link",
4230 This command creates a hard link using the C<ln -f> command.
4231 The I<-f> option removes the link (C<linkname>) if it exists already.");
4233 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4234 [InitScratchFS, Always, TestOutputStruct (
4235 [["mkdir"; "/ln_s"];
4236 ["touch"; "/ln_s/a"];
4237 ["ln_s"; "a"; "/ln_s/b"];
4238 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4239 "create a symbolic link",
4241 This command creates a symbolic link using the C<ln -s> command.");
4243 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4244 [InitScratchFS, Always, TestOutput (
4245 [["mkdir_p"; "/ln_sf/b"];
4246 ["touch"; "/ln_sf/b/c"];
4247 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4248 ["readlink"; "/ln_sf/b/c"]], "../d")],
4249 "create a symbolic link",
4251 This command creates a symbolic link using the C<ln -sf> command,
4252 The I<-f> option removes the link (C<linkname>) if it exists already.");
4254 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4255 [] (* XXX tested above *),
4256 "read the target of a symbolic link",
4258 This command reads the target of a symbolic link.");
4260 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4261 [InitScratchFS, Always, TestOutputStruct (
4262 [["fallocate"; "/fallocate"; "1000000"];
4263 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4264 "preallocate a file in the guest filesystem",
4266 This command preallocates a file (containing zero bytes) named
4267 C<path> of size C<len> bytes. If the file exists already, it
4270 Do not confuse this with the guestfish-specific
4271 C<alloc> command which allocates a file in the host and
4272 attaches it as a device.");
4274 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4275 [InitPartition, Always, TestRun (
4276 [["mkswap"; "/dev/sda1"];
4277 ["swapon_device"; "/dev/sda1"];
4278 ["swapoff_device"; "/dev/sda1"]])],
4279 "enable swap on device",
4281 This command enables the libguestfs appliance to use the
4282 swap device or partition named C<device>. The increased
4283 memory is made available for all commands, for example
4284 those run using C<guestfs_command> or C<guestfs_sh>.
4286 Note that you should not swap to existing guest swap
4287 partitions unless you know what you are doing. They may
4288 contain hibernation information, or other information that
4289 the guest doesn't want you to trash. You also risk leaking
4290 information about the host to the guest this way. Instead,
4291 attach a new host device to the guest and swap on that.");
4293 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4294 [], (* XXX tested by swapon_device *)
4295 "disable swap on device",
4297 This command disables the libguestfs appliance swap
4298 device or partition named C<device>.
4299 See C<guestfs_swapon_device>.");
4301 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4302 [InitScratchFS, Always, TestRun (
4303 [["fallocate"; "/swapon_file"; "8388608"];
4304 ["mkswap_file"; "/swapon_file"];
4305 ["swapon_file"; "/swapon_file"];
4306 ["swapoff_file"; "/swapon_file"];
4307 ["rm"; "/swapon_file"]])],
4308 "enable swap on file",
4310 This command enables swap to a file.
4311 See C<guestfs_swapon_device> for other notes.");
4313 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4314 [], (* XXX tested by swapon_file *)
4315 "disable swap on file",
4317 This command disables the libguestfs appliance swap on file.");
4319 ("swapon_label", (RErr, [String "label"], []), 174, [],
4320 [InitEmpty, Always, TestRun (
4321 [["part_disk"; "/dev/sda"; "mbr"];
4322 ["mkswap_L"; "swapit"; "/dev/sda1"];
4323 ["swapon_label"; "swapit"];
4324 ["swapoff_label"; "swapit"];
4325 ["zero"; "/dev/sda"];
4326 ["blockdev_rereadpt"; "/dev/sda"]])],
4327 "enable swap on labeled swap partition",
4329 This command enables swap to a labeled swap partition.
4330 See C<guestfs_swapon_device> for other notes.");
4332 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4333 [], (* XXX tested by swapon_label *)
4334 "disable swap on labeled swap partition",
4336 This command disables the libguestfs appliance swap on
4337 labeled swap partition.");
4339 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4340 (let uuid = uuidgen () in
4341 [InitEmpty, Always, TestRun (
4342 [["mkswap_U"; uuid; "/dev/sdc"];
4343 ["swapon_uuid"; uuid];
4344 ["swapoff_uuid"; uuid]])]),
4345 "enable swap on swap partition by UUID",
4347 This command enables swap to a swap partition with the given UUID.
4348 See C<guestfs_swapon_device> for other notes.");
4350 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4351 [], (* XXX tested by swapon_uuid *)
4352 "disable swap on swap partition by UUID",
4354 This command disables the libguestfs appliance swap partition
4355 with the given UUID.");
4357 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4358 [InitScratchFS, Always, TestRun (
4359 [["fallocate"; "/mkswap_file"; "8388608"];
4360 ["mkswap_file"; "/mkswap_file"];
4361 ["rm"; "/mkswap_file"]])],
4362 "create a swap file",
4366 This command just writes a swap file signature to an existing
4367 file. To create the file itself, use something like C<guestfs_fallocate>.");
4369 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4370 [InitISOFS, Always, TestRun (
4371 [["inotify_init"; "0"]])],
4372 "create an inotify handle",
4374 This command creates a new inotify handle.
4375 The inotify subsystem can be used to notify events which happen to
4376 objects in the guest filesystem.
4378 C<maxevents> is the maximum number of events which will be
4379 queued up between calls to C<guestfs_inotify_read> or
4380 C<guestfs_inotify_files>.
4381 If this is passed as C<0>, then the kernel (or previously set)
4382 default is used. For Linux 2.6.29 the default was 16384 events.
4383 Beyond this limit, the kernel throws away events, but records
4384 the fact that it threw them away by setting a flag
4385 C<IN_Q_OVERFLOW> in the returned structure list (see
4386 C<guestfs_inotify_read>).
4388 Before any events are generated, you have to add some
4389 watches to the internal watch list. See:
4390 C<guestfs_inotify_add_watch>,
4391 C<guestfs_inotify_rm_watch> and
4392 C<guestfs_inotify_watch_all>.
4394 Queued up events should be read periodically by calling
4395 C<guestfs_inotify_read>
4396 (or C<guestfs_inotify_files> which is just a helpful
4397 wrapper around C<guestfs_inotify_read>). If you don't
4398 read the events out often enough then you risk the internal
4401 The handle should be closed after use by calling
4402 C<guestfs_inotify_close>. This also removes any
4403 watches automatically.
4405 See also L<inotify(7)> for an overview of the inotify interface
4406 as exposed by the Linux kernel, which is roughly what we expose
4407 via libguestfs. Note that there is one global inotify handle
4408 per libguestfs instance.");
4410 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4411 [InitScratchFS, Always, TestOutputList (
4412 [["mkdir"; "/inotify_add_watch"];
4413 ["inotify_init"; "0"];
4414 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4415 ["touch"; "/inotify_add_watch/a"];
4416 ["touch"; "/inotify_add_watch/b"];
4417 ["inotify_files"]], ["a"; "b"])],
4418 "add an inotify watch",
4420 Watch C<path> for the events listed in C<mask>.
4422 Note that if C<path> is a directory then events within that
4423 directory are watched, but this does I<not> happen recursively
4424 (in subdirectories).
4426 Note for non-C or non-Linux callers: the inotify events are
4427 defined by the Linux kernel ABI and are listed in
4428 C</usr/include/sys/inotify.h>.");
4430 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4432 "remove an inotify watch",
4434 Remove a previously defined inotify watch.
4435 See C<guestfs_inotify_add_watch>.");
4437 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4439 "return list of inotify events",
4441 Return the complete queue of events that have happened
4442 since the previous read call.
4444 If no events have happened, this returns an empty list.
4446 I<Note>: In order to make sure that all events have been
4447 read, you must call this function repeatedly until it
4448 returns an empty list. The reason is that the call will
4449 read events up to the maximum appliance-to-host message
4450 size and leave remaining events in the queue.");
4452 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4454 "return list of watched files that had events",
4456 This function is a helpful wrapper around C<guestfs_inotify_read>
4457 which just returns a list of pathnames of objects that were
4458 touched. The returned pathnames are sorted and deduplicated.");
4460 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4462 "close the inotify handle",
4464 This closes the inotify handle which was previously
4465 opened by inotify_init. It removes all watches, throws
4466 away any pending events, and deallocates all resources.");
4468 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4470 "set SELinux security context",
4472 This sets the SELinux security context of the daemon
4473 to the string C<context>.
4475 See the documentation about SELINUX in L<guestfs(3)>.");
4477 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4479 "get SELinux security context",
4481 This gets the SELinux security context of the daemon.
4483 See the documentation about SELINUX in L<guestfs(3)>,
4484 and C<guestfs_setcon>");
4486 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4487 [InitEmpty, Always, TestOutput (
4488 [["part_disk"; "/dev/sda"; "mbr"];
4489 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4490 ["mount_options"; ""; "/dev/sda1"; "/"];
4491 ["write"; "/new"; "new file contents"];
4492 ["cat"; "/new"]], "new file contents");
4493 InitEmpty, Always, TestRun (
4494 [["part_disk"; "/dev/sda"; "mbr"];
4495 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4496 InitEmpty, Always, TestLastFail (
4497 [["part_disk"; "/dev/sda"; "mbr"];
4498 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4499 InitEmpty, Always, TestLastFail (
4500 [["part_disk"; "/dev/sda"; "mbr"];
4501 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4502 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4503 [["part_disk"; "/dev/sda"; "mbr"];
4504 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4505 "make a filesystem with block size",
4507 This call is similar to C<guestfs_mkfs>, but it allows you to
4508 control the block size of the resulting filesystem. Supported
4509 block sizes depend on the filesystem type, but typically they
4510 are C<1024>, C<2048> or C<4096> only.
4512 For VFAT and NTFS the C<blocksize> parameter is treated as
4513 the requested cluster size.");
4515 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
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"; "4096"; "/dev/sda1"];
4521 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4522 ["mount_options"; ""; "/dev/sda2"; "/"];
4523 ["write"; "/new"; "new file contents"];
4524 ["cat"; "/new"]], "new file contents")],
4525 "make ext2/3/4 external journal",
4527 This creates an ext2 external journal on C<device>. It is equivalent
4530 mke2fs -O journal_dev -b blocksize device");
4532 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4533 [InitEmpty, Always, TestOutput (
4534 [["part_init"; "/dev/sda"; "mbr"];
4535 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4536 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4537 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4538 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4539 ["mount_options"; ""; "/dev/sda2"; "/"];
4540 ["write"; "/new"; "new file contents"];
4541 ["cat"; "/new"]], "new file contents")],
4542 "make ext2/3/4 external journal with label",
4544 This creates an ext2 external journal on C<device> with label C<label>.");
4546 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4547 (let uuid = uuidgen () in
4548 [InitEmpty, Always, TestOutput (
4549 [["part_init"; "/dev/sda"; "mbr"];
4550 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4551 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4552 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4553 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4554 ["mount_options"; ""; "/dev/sda2"; "/"];
4555 ["write"; "/new"; "new file contents"];
4556 ["cat"; "/new"]], "new file contents")]),
4557 "make ext2/3/4 external journal with UUID",
4559 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4561 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4563 "make ext2/3/4 filesystem with external journal",
4565 This creates an ext2/3/4 filesystem on C<device> with
4566 an external journal on C<journal>. It is equivalent
4569 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4571 See also C<guestfs_mke2journal>.");
4573 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4575 "make ext2/3/4 filesystem with external journal",
4577 This creates an ext2/3/4 filesystem on C<device> with
4578 an external journal on the journal labeled C<label>.
4580 See also C<guestfs_mke2journal_L>.");
4582 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4584 "make ext2/3/4 filesystem with external journal",
4586 This creates an ext2/3/4 filesystem on C<device> with
4587 an external journal on the journal with UUID C<uuid>.
4589 See also C<guestfs_mke2journal_U>.");
4591 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4592 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4593 "load a kernel module",
4595 This loads a kernel module in the appliance.
4597 The kernel module must have been whitelisted when libguestfs
4598 was built (see C<appliance/kmod.whitelist.in> in the source).");
4600 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4601 [InitNone, Always, TestOutput (
4602 [["echo_daemon"; "This is a test"]], "This is a test"
4604 "echo arguments back to the client",
4606 This command concatenates the list of C<words> passed with single spaces
4607 between them and returns the resulting string.
4609 You can use this command to test the connection through to the daemon.
4611 See also C<guestfs_ping_daemon>.");
4613 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4614 [], (* There is a regression test for this. *)
4615 "find all files and directories, returning NUL-separated list",
4617 This command lists out all files and directories, recursively,
4618 starting at C<directory>, placing the resulting list in the
4619 external file called C<files>.
4621 This command works the same way as C<guestfs_find> with the
4622 following exceptions:
4628 The resulting list is written to an external file.
4632 Items (filenames) in the result are separated
4633 by C<\\0> characters. See L<find(1)> option I<-print0>.
4637 This command is not limited in the number of names that it
4642 The result list is not sorted.
4646 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4647 [InitISOFS, Always, TestOutput (
4648 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4649 InitISOFS, Always, TestOutput (
4650 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4651 InitISOFS, Always, TestOutput (
4652 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4653 InitISOFS, Always, TestLastFail (
4654 [["case_sensitive_path"; "/Known-1/"]]);
4655 InitScratchFS, Always, TestOutput (
4656 [["mkdir"; "/case_sensitive_path"];
4657 ["mkdir"; "/case_sensitive_path/bbb"];
4658 ["touch"; "/case_sensitive_path/bbb/c"];
4659 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4660 InitScratchFS, Always, TestOutput (
4661 [["mkdir"; "/case_sensitive_path2"];
4662 ["mkdir"; "/case_sensitive_path2/bbb"];
4663 ["touch"; "/case_sensitive_path2/bbb/c"];
4664 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4665 InitScratchFS, Always, TestLastFail (
4666 [["mkdir"; "/case_sensitive_path3"];
4667 ["mkdir"; "/case_sensitive_path3/bbb"];
4668 ["touch"; "/case_sensitive_path3/bbb/c"];
4669 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4670 "return true path on case-insensitive filesystem",
4672 This can be used to resolve case insensitive paths on
4673 a filesystem which is case sensitive. The use case is
4674 to resolve paths which you have read from Windows configuration
4675 files or the Windows Registry, to the true path.
4677 The command handles a peculiarity of the Linux ntfs-3g
4678 filesystem driver (and probably others), which is that although
4679 the underlying filesystem is case-insensitive, the driver
4680 exports the filesystem to Linux as case-sensitive.
4682 One consequence of this is that special directories such
4683 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4684 (or other things) depending on the precise details of how
4685 they were created. In Windows itself this would not be
4688 Bug or feature? You decide:
4689 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4691 This function resolves the true case of each element in the
4692 path and returns the case-sensitive path.
4694 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4695 might return C<\"/WINDOWS/system32\"> (the exact return value
4696 would depend on details of how the directories were originally
4697 created under Windows).
4700 This function does not handle drive names, backslashes etc.
4702 See also C<guestfs_realpath>.");
4704 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4705 [InitScratchFS, Always, TestOutput (
4706 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4707 "get the Linux VFS type corresponding to a mounted device",
4709 This command gets the filesystem type corresponding to
4710 the filesystem on C<device>.
4712 For most filesystems, the result is the name of the Linux
4713 VFS module which would be used to mount this filesystem
4714 if you mounted it without specifying the filesystem type.
4715 For example a string such as C<ext3> or C<ntfs>.");
4717 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4718 [InitScratchFS, Always, TestOutputStruct (
4719 [["write"; "/truncate"; "some stuff so size is not zero"];
4720 ["truncate"; "/truncate"];
4721 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4722 "truncate a file to zero size",
4724 This command truncates C<path> to a zero-length file. The
4725 file must exist already.");
4727 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4728 [InitScratchFS, Always, TestOutputStruct (
4729 [["touch"; "/truncate_size"];
4730 ["truncate_size"; "/truncate_size"; "1000"];
4731 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4732 "truncate a file to a particular size",
4734 This command truncates C<path> to size C<size> bytes. The file
4737 If the current file size is less than C<size> then
4738 the file is extended to the required size with zero bytes.
4739 This creates a sparse file (ie. disk blocks are not allocated
4740 for the file until you write to it). To create a non-sparse
4741 file of zeroes, use C<guestfs_fallocate64> instead.");
4743 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4744 [InitScratchFS, Always, TestOutputStruct (
4745 [["touch"; "/utimens"];
4746 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4747 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4748 "set timestamp of a file with nanosecond precision",
4750 This command sets the timestamps of a file with nanosecond
4753 C<atsecs, atnsecs> are the last access time (atime) in secs and
4754 nanoseconds from the epoch.
4756 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4757 secs and nanoseconds from the epoch.
4759 If the C<*nsecs> field contains the special value C<-1> then
4760 the corresponding timestamp is set to the current time. (The
4761 C<*secs> field is ignored in this case).
4763 If the C<*nsecs> field contains the special value C<-2> then
4764 the corresponding timestamp is left unchanged. (The
4765 C<*secs> field is ignored in this case).");
4767 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4768 [InitScratchFS, Always, TestOutputStruct (
4769 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4770 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4771 "create a directory with a particular mode",
4773 This command creates a directory, setting the initial permissions
4774 of the directory to C<mode>.
4776 For common Linux filesystems, the actual mode which is set will
4777 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4778 interpret the mode in other ways.
4780 See also C<guestfs_mkdir>, C<guestfs_umask>");
4782 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4784 "change file owner and group",
4786 Change the file owner to C<owner> and group to C<group>.
4787 This is like C<guestfs_chown> but if C<path> is a symlink then
4788 the link itself is changed, not the target.
4790 Only numeric uid and gid are supported. If you want to use
4791 names, you will need to locate and parse the password file
4792 yourself (Augeas support makes this relatively easy).");
4794 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4796 "lstat on multiple files",
4798 This call allows you to perform the C<guestfs_lstat> operation
4799 on multiple files, where all files are in the directory C<path>.
4800 C<names> is the list of files from this directory.
4802 On return you get a list of stat structs, with a one-to-one
4803 correspondence to the C<names> list. If any name did not exist
4804 or could not be lstat'd, then the C<ino> field of that structure
4807 This call is intended for programs that want to efficiently
4808 list a directory contents without making many round-trips.
4809 See also C<guestfs_lxattrlist> for a similarly efficient call
4810 for getting extended attributes. Very long directory listings
4811 might cause the protocol message size to be exceeded, causing
4812 this call to fail. The caller must split up such requests
4813 into smaller groups of names.");
4815 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4817 "lgetxattr on multiple files",
4819 This call allows you to get the extended attributes
4820 of multiple files, where all files are in the directory C<path>.
4821 C<names> is the list of files from this directory.
4823 On return you get a flat list of xattr structs which must be
4824 interpreted sequentially. The first xattr struct always has a zero-length
4825 C<attrname>. C<attrval> in this struct is zero-length
4826 to indicate there was an error doing C<lgetxattr> for this
4827 file, I<or> is a C string which is a decimal number
4828 (the number of following attributes for this file, which could
4829 be C<\"0\">). Then after the first xattr struct are the
4830 zero or more attributes for the first named file.
4831 This repeats for the second and subsequent files.
4833 This call is intended for programs that want to efficiently
4834 list a directory contents without making many round-trips.
4835 See also C<guestfs_lstatlist> for a similarly efficient call
4836 for getting standard stats. Very long directory listings
4837 might cause the protocol message size to be exceeded, causing
4838 this call to fail. The caller must split up such requests
4839 into smaller groups of names.");
4841 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4843 "readlink on multiple files",
4845 This call allows you to do a C<readlink> operation
4846 on multiple files, where all files are in the directory C<path>.
4847 C<names> is the list of files from this directory.
4849 On return you get a list of strings, with a one-to-one
4850 correspondence to the C<names> list. Each string is the
4851 value of the symbolic link.
4853 If the C<readlink(2)> operation fails on any name, then
4854 the corresponding result string is the empty string C<\"\">.
4855 However the whole operation is completed even if there
4856 were C<readlink(2)> errors, and so you can call this
4857 function with names where you don't know if they are
4858 symbolic links already (albeit slightly less efficient).
4860 This call is intended for programs that want to efficiently
4861 list a directory contents without making many round-trips.
4862 Very long directory listings might cause the protocol
4863 message size to be exceeded, causing
4864 this call to fail. The caller must split up such requests
4865 into smaller groups of names.");
4867 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4868 [InitISOFS, Always, TestOutputBuffer (
4869 [["pread"; "/known-4"; "1"; "3"]], "\n");
4870 InitISOFS, Always, TestOutputBuffer (
4871 [["pread"; "/empty"; "0"; "100"]], "")],
4872 "read part of a file",
4874 This command lets you read part of a file. It reads C<count>
4875 bytes of the file, starting at C<offset>, from file C<path>.
4877 This may read fewer bytes than requested. For further details
4878 see the L<pread(2)> system call.
4880 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4882 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4883 [InitEmpty, Always, TestRun (
4884 [["part_init"; "/dev/sda"; "gpt"]])],
4885 "create an empty partition table",
4887 This creates an empty partition table on C<device> of one of the
4888 partition types listed below. Usually C<parttype> should be
4889 either C<msdos> or C<gpt> (for large disks).
4891 Initially there are no partitions. Following this, you should
4892 call C<guestfs_part_add> for each partition required.
4894 Possible values for C<parttype> are:
4902 Intel EFI / GPT partition table.
4904 This is recommended for >= 2 TB partitions that will be accessed
4905 from Linux and Intel-based Mac OS X. It also has limited backwards
4906 compatibility with the C<mbr> format.
4912 The standard PC \"Master Boot Record\" (MBR) format used
4913 by MS-DOS and Windows. This partition type will B<only> work
4914 for device sizes up to 2 TB. For large disks we recommend
4919 Other partition table types that may work but are not
4932 Amiga \"Rigid Disk Block\" format.
4940 DASD, used on IBM mainframes.
4948 Old Mac partition format. Modern Macs use C<gpt>.
4952 NEC PC-98 format, common in Japan apparently.
4960 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4961 [InitEmpty, Always, TestRun (
4962 [["part_init"; "/dev/sda"; "mbr"];
4963 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4964 InitEmpty, Always, TestRun (
4965 [["part_init"; "/dev/sda"; "gpt"];
4966 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4967 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4968 InitEmpty, Always, TestRun (
4969 [["part_init"; "/dev/sda"; "mbr"];
4970 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4971 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4972 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4973 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4974 "add a partition to the device",
4976 This command adds a partition to C<device>. If there is no partition
4977 table on the device, call C<guestfs_part_init> first.
4979 The C<prlogex> parameter is the type of partition. Normally you
4980 should pass C<p> or C<primary> here, but MBR partition tables also
4981 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4984 C<startsect> and C<endsect> are the start and end of the partition
4985 in I<sectors>. C<endsect> may be negative, which means it counts
4986 backwards from the end of the disk (C<-1> is the last sector).
4988 Creating a partition which covers the whole disk is not so easy.
4989 Use C<guestfs_part_disk> to do that.");
4991 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4992 [InitEmpty, Always, TestRun (
4993 [["part_disk"; "/dev/sda"; "mbr"]]);
4994 InitEmpty, Always, TestRun (
4995 [["part_disk"; "/dev/sda"; "gpt"]])],
4996 "partition whole disk with a single primary partition",
4998 This command is simply a combination of C<guestfs_part_init>
4999 followed by C<guestfs_part_add> to create a single primary partition
5000 covering the whole disk.
5002 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
5003 but other possible values are described in C<guestfs_part_init>.");
5005 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
5006 [InitEmpty, Always, TestRun (
5007 [["part_disk"; "/dev/sda"; "mbr"];
5008 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
5009 "make a partition bootable",
5011 This sets the bootable flag on partition numbered C<partnum> on
5012 device C<device>. Note that partitions are numbered from 1.
5014 The bootable flag is used by some operating systems (notably
5015 Windows) to determine which partition to boot from. It is by
5016 no means universally recognized.");
5018 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
5019 [InitEmpty, Always, TestRun (
5020 [["part_disk"; "/dev/sda"; "gpt"];
5021 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
5022 "set partition name",
5024 This sets the partition name on partition numbered C<partnum> on
5025 device C<device>. Note that partitions are numbered from 1.
5027 The partition name can only be set on certain types of partition
5028 table. This works on C<gpt> but not on C<mbr> partitions.");
5030 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
5031 [], (* XXX Add a regression test for this. *)
5032 "list partitions on a device",
5034 This command parses the partition table on C<device> and
5035 returns the list of partitions found.
5037 The fields in the returned structure are:
5043 Partition number, counting from 1.
5047 Start of the partition I<in bytes>. To get sectors you have to
5048 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5052 End of the partition in bytes.
5056 Size of the partition in bytes.
5060 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5061 [InitEmpty, Always, TestOutput (
5062 [["part_disk"; "/dev/sda"; "gpt"];
5063 ["part_get_parttype"; "/dev/sda"]], "gpt")],
5064 "get the partition table type",
5066 This command examines the partition table on C<device> and
5067 returns the partition table type (format) being used.
5069 Common return values include: C<msdos> (a DOS/Windows style MBR
5070 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5071 values are possible, although unusual. See C<guestfs_part_init>
5074 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5075 [InitScratchFS, Always, TestOutputBuffer (
5076 [["fill"; "0x63"; "10"; "/fill"];
5077 ["read_file"; "/fill"]], "cccccccccc")],
5078 "fill a file with octets",
5080 This command creates a new file called C<path>. The initial
5081 content of the file is C<len> octets of C<c>, where C<c>
5082 must be a number in the range C<[0..255]>.
5084 To fill a file with zero bytes (sparsely), it is
5085 much more efficient to use C<guestfs_truncate_size>.
5086 To create a file with a pattern of repeating bytes
5087 use C<guestfs_fill_pattern>.");
5089 ("available", (RErr, [StringList "groups"], []), 216, [],
5090 [InitNone, Always, TestRun [["available"; ""]]],
5091 "test availability of some parts of the API",
5093 This command is used to check the availability of some
5094 groups of functionality in the appliance, which not all builds of
5095 the libguestfs appliance will be able to provide.
5097 The libguestfs groups, and the functions that those
5098 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5099 You can also fetch this list at runtime by calling
5100 C<guestfs_available_all_groups>.
5102 The argument C<groups> is a list of group names, eg:
5103 C<[\"inotify\", \"augeas\"]> would check for the availability of
5104 the Linux inotify functions and Augeas (configuration file
5107 The command returns no error if I<all> requested groups are available.
5109 It fails with an error if one or more of the requested
5110 groups is unavailable in the appliance.
5112 If an unknown group name is included in the
5113 list of groups then an error is always returned.
5121 You must call C<guestfs_launch> before calling this function.
5123 The reason is because we don't know what groups are
5124 supported by the appliance/daemon until it is running and can
5129 If a group of functions is available, this does not necessarily
5130 mean that they will work. You still have to check for errors
5131 when calling individual API functions even if they are
5136 It is usually the job of distro packagers to build
5137 complete functionality into the libguestfs appliance.
5138 Upstream libguestfs, if built from source with all
5139 requirements satisfied, will support everything.
5143 This call was added in version C<1.0.80>. In previous
5144 versions of libguestfs all you could do would be to speculatively
5145 execute a command to find out if the daemon implemented it.
5146 See also C<guestfs_version>.
5150 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5151 [InitScratchFS, Always, TestOutputBuffer (
5153 ["write"; "/dd/src"; "hello, world"];
5154 ["dd"; "/dd/src"; "/dd/dest"];
5155 ["read_file"; "/dd/dest"]], "hello, world")],
5156 "copy from source to destination using dd",
5158 This command copies from one source device or file C<src>
5159 to another destination device or file C<dest>. Normally you
5160 would use this to copy to or from a device or partition, for
5161 example to duplicate a filesystem.
5163 If the destination is a device, it must be as large or larger
5164 than the source file or device, otherwise the copy will fail.
5165 This command cannot do partial copies (see C<guestfs_copy_size>).");
5167 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5168 [InitScratchFS, Always, TestOutputInt (
5169 [["write"; "/filesize"; "hello, world"];
5170 ["filesize"; "/filesize"]], 12)],
5171 "return the size of the file in bytes",
5173 This command returns the size of C<file> in bytes.
5175 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5176 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5177 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5179 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5180 [InitBasicFSonLVM, Always, TestOutputList (
5181 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5182 ["lvs"]], ["/dev/VG/LV2"])],
5183 "rename an LVM logical volume",
5185 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5187 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5188 [InitBasicFSonLVM, Always, TestOutputList (
5190 ["vg_activate"; "false"; "VG"];
5191 ["vgrename"; "VG"; "VG2"];
5192 ["vg_activate"; "true"; "VG2"];
5193 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5194 ["vgs"]], ["VG2"])],
5195 "rename an LVM volume group",
5197 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5199 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5200 [InitISOFS, Always, TestOutputBuffer (
5201 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5202 "list the contents of a single file in an initrd",
5204 This command unpacks the file C<filename> from the initrd file
5205 called C<initrdpath>. The filename must be given I<without> the
5206 initial C</> character.
5208 For example, in guestfish you could use the following command
5209 to examine the boot script (usually called C</init>)
5210 contained in a Linux initrd or initramfs image:
5212 initrd-cat /boot/initrd-<version>.img init
5214 See also C<guestfs_initrd_list>.");
5216 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5218 "get the UUID of a physical volume",
5220 This command returns the UUID of the LVM PV C<device>.");
5222 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5224 "get the UUID of a volume group",
5226 This command returns the UUID of the LVM VG named C<vgname>.");
5228 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5230 "get the UUID of a logical volume",
5232 This command returns the UUID of the LVM LV C<device>.");
5234 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5236 "get the PV UUIDs containing the volume group",
5238 Given a VG called C<vgname>, this returns the UUIDs of all
5239 the physical volumes that this volume group resides on.
5241 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5242 calls to associate physical volumes and volume groups.
5244 See also C<guestfs_vglvuuids>.");
5246 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5248 "get the LV UUIDs of all LVs in the volume group",
5250 Given a VG called C<vgname>, this returns the UUIDs of all
5251 the logical volumes created in this volume group.
5253 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5254 calls to associate logical volumes and volume groups.
5256 See also C<guestfs_vgpvuuids>.");
5258 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5259 [InitScratchFS, Always, TestOutputBuffer (
5260 [["mkdir"; "/copy_size"];
5261 ["write"; "/copy_size/src"; "hello, world"];
5262 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5263 ["read_file"; "/copy_size/dest"]], "hello")],
5264 "copy size bytes from source to destination using dd",
5266 This command copies exactly C<size> bytes from one source device
5267 or file C<src> to another destination device or file C<dest>.
5269 Note this will fail if the source is too short or if the destination
5270 is not large enough.");
5272 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5273 [InitBasicFSonLVM, Always, TestRun (
5274 [["zero_device"; "/dev/VG/LV"]])],
5275 "write zeroes to an entire device",
5277 This command writes zeroes over the entire C<device>. Compare
5278 with C<guestfs_zero> which just zeroes the first few blocks of
5281 If blocks are already zero, then this command avoids writing
5282 zeroes. This prevents the underlying device from becoming non-sparse
5283 or growing unnecessarily.");
5285 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5286 [InitScratchFS, Always, TestOutput (
5287 [["mkdir"; "/txz_in"];
5288 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5289 ["cat"; "/txz_in/hello"]], "hello\n")],
5290 "unpack compressed tarball to directory",
5292 This command uploads and unpacks local file C<tarball> (an
5293 I<xz compressed> tar file) into C<directory>.");
5295 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5297 "pack directory into compressed tarball",
5299 This command packs the contents of C<directory> and downloads
5300 it to local file C<tarball> (as an xz compressed tar archive).");
5302 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5304 "resize an NTFS filesystem",
5306 This command resizes an NTFS filesystem, expanding or
5307 shrinking it to the size of the underlying device.
5309 I<Note:> After the resize operation, the filesystem is marked
5310 as requiring a consistency check (for safety). You have to boot
5311 into Windows to perform this check and clear this condition.
5312 Furthermore, ntfsresize refuses to resize filesystems
5313 which have been marked in this way. So in effect it is
5314 not possible to call ntfsresize multiple times on a single
5315 filesystem without booting into Windows between each resize.
5317 See also L<ntfsresize(8)>.");
5319 ("vgscan", (RErr, [], []), 232, [],
5320 [InitEmpty, Always, TestRun (
5322 "rescan for LVM physical volumes, volume groups and logical volumes",
5324 This rescans all block devices and rebuilds the list of LVM
5325 physical volumes, volume groups and logical volumes.");
5327 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5328 [InitEmpty, Always, TestRun (
5329 [["part_init"; "/dev/sda"; "mbr"];
5330 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5331 ["part_del"; "/dev/sda"; "1"]])],
5332 "delete a partition",
5334 This command deletes the partition numbered C<partnum> on C<device>.
5336 Note that in the case of MBR partitioning, deleting an
5337 extended partition also deletes any logical partitions
5340 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5341 [InitEmpty, Always, TestOutputTrue (
5342 [["part_init"; "/dev/sda"; "mbr"];
5343 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5344 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5345 ["part_get_bootable"; "/dev/sda"; "1"]])],
5346 "return true if a partition is bootable",
5348 This command returns true if the partition C<partnum> on
5349 C<device> has the bootable flag set.
5351 See also C<guestfs_part_set_bootable>.");
5353 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5354 [InitEmpty, Always, TestOutputInt (
5355 [["part_init"; "/dev/sda"; "mbr"];
5356 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5357 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5358 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5359 "get the MBR type byte (ID byte) from a partition",
5361 Returns the MBR type byte (also known as the ID byte) from
5362 the numbered partition C<partnum>.
5364 Note that only MBR (old DOS-style) partitions have type bytes.
5365 You will get undefined results for other partition table
5366 types (see C<guestfs_part_get_parttype>).");
5368 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5369 [], (* tested by part_get_mbr_id *)
5370 "set the MBR type byte (ID byte) of a partition",
5372 Sets the MBR type byte (also known as the ID byte) of
5373 the numbered partition C<partnum> to C<idbyte>. Note
5374 that the type bytes quoted in most documentation are
5375 in fact hexadecimal numbers, but usually documented
5376 without any leading \"0x\" which might be confusing.
5378 Note that only MBR (old DOS-style) partitions have type bytes.
5379 You will get undefined results for other partition table
5380 types (see C<guestfs_part_get_parttype>).");
5382 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5383 [InitISOFS, Always, TestOutputFileMD5 (
5384 [["checksum_device"; "md5"; "/dev/sdd"]],
5385 "../images/test.iso")],
5386 "compute MD5, SHAx or CRC checksum of the contents of a device",
5388 This call computes the MD5, SHAx or CRC checksum of the
5389 contents of the device named C<device>. For the types of
5390 checksums supported see the C<guestfs_checksum> command.");
5392 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5393 [InitNone, Always, TestRun (
5394 [["part_disk"; "/dev/sda"; "mbr"];
5395 ["pvcreate"; "/dev/sda1"];
5396 ["vgcreate"; "VG"; "/dev/sda1"];
5397 ["lvcreate"; "LV"; "VG"; "10"];
5398 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5399 "expand an LV to fill free space",
5401 This expands an existing logical volume C<lv> so that it fills
5402 C<pc>% of the remaining free space in the volume group. Commonly
5403 you would call this with pc = 100 which expands the logical volume
5404 as much as possible, using all remaining free space in the volume
5407 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5408 [], (* XXX Augeas code needs tests. *)
5409 "clear Augeas path",
5411 Set the value associated with C<path> to C<NULL>. This
5412 is the same as the L<augtool(1)> C<clear> command.");
5414 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5415 [InitEmpty, Always, TestOutputInt (
5416 [["get_umask"]], 0o22)],
5417 "get the current umask",
5419 Return the current umask. By default the umask is C<022>
5420 unless it has been set by calling C<guestfs_umask>.");
5422 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5424 "upload a file to the appliance (internal use only)",
5426 The C<guestfs_debug_upload> command uploads a file to
5427 the libguestfs appliance.
5429 There is no comprehensive help for this command. You have
5430 to look at the file C<daemon/debug.c> in the libguestfs source
5431 to find out what it is for.");
5433 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5434 [InitScratchFS, Always, TestOutput (
5435 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5436 ["cat"; "/base64_in"]], "hello\n")],
5437 "upload base64-encoded data to file",
5439 This command uploads base64-encoded data from C<base64file>
5442 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5444 "download file and encode as base64",
5446 This command downloads the contents of C<filename>, writing
5447 it out to local file C<base64file> encoded as base64.");
5449 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5451 "compute MD5, SHAx or CRC checksum of files in a directory",
5453 This command computes the checksums of all regular files in
5454 C<directory> and then emits a list of those checksums to
5455 the local output file C<sumsfile>.
5457 This can be used for verifying the integrity of a virtual
5458 machine. However to be properly secure you should pay
5459 attention to the output of the checksum command (it uses
5460 the ones from GNU coreutils). In particular when the
5461 filename is not printable, coreutils uses a special
5462 backslash syntax. For more information, see the GNU
5463 coreutils info file.");
5465 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5466 [InitScratchFS, Always, TestOutputBuffer (
5467 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5468 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5469 "fill a file with a repeating pattern of bytes",
5471 This function is like C<guestfs_fill> except that it creates
5472 a new file of length C<len> containing the repeating pattern
5473 of bytes in C<pattern>. The pattern is truncated if necessary
5474 to ensure the length of the file is exactly C<len> bytes.");
5476 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5477 [InitScratchFS, Always, TestOutput (
5478 [["write"; "/write"; "new file contents"];
5479 ["cat"; "/write"]], "new file contents");
5480 InitScratchFS, Always, TestOutput (
5481 [["write"; "/write2"; "\nnew file contents\n"];
5482 ["cat"; "/write2"]], "\nnew file contents\n");
5483 InitScratchFS, Always, TestOutput (
5484 [["write"; "/write3"; "\n\n"];
5485 ["cat"; "/write3"]], "\n\n");
5486 InitScratchFS, Always, TestOutput (
5487 [["write"; "/write4"; ""];
5488 ["cat"; "/write4"]], "");
5489 InitScratchFS, Always, TestOutput (
5490 [["write"; "/write5"; "\n\n\n"];
5491 ["cat"; "/write5"]], "\n\n\n");
5492 InitScratchFS, Always, TestOutput (
5493 [["write"; "/write6"; "\n"];
5494 ["cat"; "/write6"]], "\n")],
5495 "create a new file",
5497 This call creates a file called C<path>. The content of the
5498 file is the string C<content> (which can contain any 8 bit data).
5500 See also C<guestfs_write_append>.");
5502 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5503 [InitScratchFS, Always, TestOutput (
5504 [["write"; "/pwrite"; "new file contents"];
5505 ["pwrite"; "/pwrite"; "data"; "4"];
5506 ["cat"; "/pwrite"]], "new data contents");
5507 InitScratchFS, Always, TestOutput (
5508 [["write"; "/pwrite2"; "new file contents"];
5509 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5510 ["cat"; "/pwrite2"]], "new file is extended");
5511 InitScratchFS, Always, TestOutput (
5512 [["write"; "/pwrite3"; "new file contents"];
5513 ["pwrite"; "/pwrite3"; ""; "4"];
5514 ["cat"; "/pwrite3"]], "new file contents")],
5515 "write to part of a file",
5517 This command writes to part of a file. It writes the data
5518 buffer C<content> to the file C<path> starting at offset C<offset>.
5520 This command implements the L<pwrite(2)> system call, and like
5521 that system call it may not write the full data requested. The
5522 return value is the number of bytes that were actually written
5523 to the file. This could even be 0, although short writes are
5524 unlikely for regular files in ordinary circumstances.
5526 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5528 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5530 "resize an ext2, ext3 or ext4 filesystem (with size)",
5532 This command is the same as C<guestfs_resize2fs> except that it
5533 allows you to specify the new size (in bytes) explicitly.");
5535 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5537 "resize an LVM physical volume (with size)",
5539 This command is the same as C<guestfs_pvresize> except that it
5540 allows you to specify the new size (in bytes) explicitly.");
5542 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5544 "resize an NTFS filesystem (with size)",
5546 This command is the same as C<guestfs_ntfsresize> except that it
5547 allows you to specify the new size (in bytes) explicitly.");
5549 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5550 [InitNone, Always, TestRun [["available_all_groups"]]],
5551 "return a list of all optional groups",
5553 This command returns a list of all optional groups that this
5554 daemon knows about. Note this returns both supported and unsupported
5555 groups. To find out which ones the daemon can actually support
5556 you have to call C<guestfs_available> on each member of the
5559 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5561 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5562 [InitScratchFS, Always, TestOutputStruct (
5563 [["fallocate64"; "/fallocate64"; "1000000"];
5564 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5565 "preallocate a file in the guest filesystem",
5567 This command preallocates a file (containing zero bytes) named
5568 C<path> of size C<len> bytes. If the file exists already, it
5571 Note that this call allocates disk blocks for the file.
5572 To create a sparse file use C<guestfs_truncate_size> instead.
5574 The deprecated call C<guestfs_fallocate> does the same,
5575 but owing to an oversight it only allowed 30 bit lengths
5576 to be specified, effectively limiting the maximum size
5577 of files created through that call to 1GB.
5579 Do not confuse this with the guestfish-specific
5580 C<alloc> and C<sparse> commands which create
5581 a file in the host and attach it as a device.");
5583 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5584 [InitBasicFS, Always, TestOutput (
5585 [["set_e2label"; "/dev/sda1"; "LTEST"];
5586 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5587 "get the filesystem label",
5589 This returns the filesystem label of the filesystem on
5592 If the filesystem is unlabeled, this returns the empty string.
5594 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5596 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5597 (let uuid = uuidgen () in
5598 [InitBasicFS, Always, TestOutput (
5599 [["set_e2uuid"; "/dev/sda1"; uuid];
5600 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5601 "get the filesystem UUID",
5603 This returns the filesystem UUID of the filesystem on
5606 If the filesystem does not have a UUID, this returns the empty string.
5608 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5610 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5611 (* Can't be tested with the current framework because
5612 * the VG is being used by the mounted filesystem, so
5613 * the vgchange -an command we do first will fail.
5616 "set LVM device filter",
5618 This sets the LVM device filter so that LVM will only be
5619 able to \"see\" the block devices in the list C<devices>,
5620 and will ignore all other attached block devices.
5622 Where disk image(s) contain duplicate PVs or VGs, this
5623 command is useful to get LVM to ignore the duplicates, otherwise
5624 LVM can get confused. Note also there are two types
5625 of duplication possible: either cloned PVs/VGs which have
5626 identical UUIDs; or VGs that are not cloned but just happen
5627 to have the same name. In normal operation you cannot
5628 create this situation, but you can do it outside LVM, eg.
5629 by cloning disk images or by bit twiddling inside the LVM
5632 This command also clears the LVM cache and performs a volume
5635 You can filter whole block devices or individual partitions.
5637 You cannot use this if any VG is currently in use (eg.
5638 contains a mounted filesystem), even if you are not
5639 filtering out that VG.");
5641 ("lvm_clear_filter", (RErr, [], []), 256, [],
5642 [], (* see note on lvm_set_filter *)
5643 "clear LVM device filter",
5645 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5646 will be able to see every block device.
5648 This command also clears the LVM cache and performs a volume
5651 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5653 "open a LUKS-encrypted block device",
5655 This command opens a block device which has been encrypted
5656 according to the Linux Unified Key Setup (LUKS) standard.
5658 C<device> is the encrypted block device or partition.
5660 The caller must supply one of the keys associated with the
5661 LUKS block device, in the C<key> parameter.
5663 This creates a new block device called C</dev/mapper/mapname>.
5664 Reads and writes to this block device are decrypted from and
5665 encrypted to the underlying C<device> respectively.
5667 If this block device contains LVM volume groups, then
5668 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5669 will make them visible.
5671 Use C<guestfs_list_dm_devices> to list all device mapper
5674 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5676 "open a LUKS-encrypted block device read-only",
5678 This is the same as C<guestfs_luks_open> except that a read-only
5679 mapping is created.");
5681 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5683 "close a LUKS device",
5685 This closes a LUKS device that was created earlier by
5686 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5687 C<device> parameter must be the name of the LUKS mapping
5688 device (ie. C</dev/mapper/mapname>) and I<not> the name
5689 of the underlying block device.");
5691 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5693 "format a block device as a LUKS encrypted device",
5695 This command erases existing data on C<device> and formats
5696 the device as a LUKS encrypted device. C<key> is the
5697 initial key, which is added to key slot C<slot>. (LUKS
5698 supports 8 key slots, numbered 0-7).");
5700 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5702 "format a block device as a LUKS encrypted device",
5704 This command is the same as C<guestfs_luks_format> but
5705 it also allows you to set the C<cipher> used.");
5707 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5709 "add a key on a LUKS encrypted device",
5711 This command adds a new key on LUKS device C<device>.
5712 C<key> is any existing key, and is used to access the device.
5713 C<newkey> is the new key to add. C<keyslot> is the key slot
5714 that will be replaced.
5716 Note that if C<keyslot> already contains a key, then this
5717 command will fail. You have to use C<guestfs_luks_kill_slot>
5718 first to remove that key.");
5720 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5722 "remove a key from a LUKS encrypted device",
5724 This command deletes the key in key slot C<keyslot> from the
5725 encrypted LUKS device C<device>. C<key> must be one of the
5728 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5729 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5730 [["is_lv"; "/dev/VG/LV"]]);
5731 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5732 [["is_lv"; "/dev/sda1"]])],
5733 "test if device is a logical volume",
5735 This command tests whether C<device> is a logical volume, and
5736 returns true iff this is the case.");
5738 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5740 "find a filesystem by UUID",
5742 This command searches the filesystems and returns the one
5743 which has the given UUID. An error is returned if no such
5744 filesystem can be found.
5746 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5748 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5750 "find a filesystem by label",
5752 This command searches the filesystems and returns the one
5753 which has the given label. An error is returned if no such
5754 filesystem can be found.
5756 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5758 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5759 [InitISOFS, Always, TestOutputFalse (
5760 [["is_chardev"; "/directory"]]);
5761 InitScratchFS, Always, TestOutputTrue (
5762 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5763 ["is_chardev"; "/is_chardev"]])],
5764 "test if character device",
5766 This returns C<true> if and only if there is a character device
5767 with the given C<path> name.
5769 See also C<guestfs_stat>.");
5771 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5772 [InitISOFS, Always, TestOutputFalse (
5773 [["is_blockdev"; "/directory"]]);
5774 InitScratchFS, Always, TestOutputTrue (
5775 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5776 ["is_blockdev"; "/is_blockdev"]])],
5777 "test if block device",
5779 This returns C<true> if and only if there is a block device
5780 with the given C<path> name.
5782 See also C<guestfs_stat>.");
5784 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5785 [InitISOFS, Always, TestOutputFalse (
5786 [["is_fifo"; "/directory"]]);
5787 InitScratchFS, Always, TestOutputTrue (
5788 [["mkfifo"; "0o777"; "/is_fifo"];
5789 ["is_fifo"; "/is_fifo"]])],
5790 "test if FIFO (named pipe)",
5792 This returns C<true> if and only if there is a FIFO (named pipe)
5793 with the given C<path> name.
5795 See also C<guestfs_stat>.");
5797 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5798 [InitISOFS, Always, TestOutputFalse (
5799 [["is_symlink"; "/directory"]]);
5800 InitISOFS, Always, TestOutputTrue (
5801 [["is_symlink"; "/abssymlink"]])],
5802 "test if symbolic link",
5804 This returns C<true> if and only if there is a symbolic link
5805 with the given C<path> name.
5807 See also C<guestfs_stat>.");
5809 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5810 (* XXX Need a positive test for sockets. *)
5811 [InitISOFS, Always, TestOutputFalse (
5812 [["is_socket"; "/directory"]])],
5815 This returns C<true> if and only if there is a Unix domain socket
5816 with the given C<path> name.
5818 See also C<guestfs_stat>.");
5820 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5821 [InitPartition, Always, TestOutputDevice (
5822 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5823 InitEmpty, Always, TestLastFail (
5824 [["part_to_dev"; "/dev/sda"]])],
5825 "convert partition name to device name",
5827 This function takes a partition name (eg. \"/dev/sdb1\") and
5828 removes the partition number, returning the device name
5831 The named partition must exist, for example as a string returned
5832 from C<guestfs_list_partitions>.");
5834 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5835 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5836 [InitScratchFS, Always, TestOutput (
5837 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5838 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5839 "upload a file from the local machine with offset",
5841 Upload local file C<filename> to C<remotefilename> on the
5844 C<remotefilename> is overwritten starting at the byte C<offset>
5845 specified. The intention is to overwrite parts of existing
5846 files or devices, although if a non-existant file is specified
5847 then it is created with a \"hole\" before C<offset>. The
5848 size of the data written is implicit in the size of the
5851 Note that there is no limit on the amount of data that
5852 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5853 and this call always writes the full amount unless an
5856 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5858 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5859 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5860 let offset = string_of_int 100 in
5861 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5862 [InitScratchFS, Always, TestOutput (
5863 (* Pick a file from cwd which isn't likely to change. *)
5864 [["mkdir"; "/download_offset"];
5865 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5866 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5867 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5868 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5869 "download a file to the local machine with offset and size",
5871 Download file C<remotefilename> and save it as C<filename>
5872 on the local machine.
5874 C<remotefilename> is read for C<size> bytes starting at C<offset>
5875 (this region must be within the file or device).
5877 Note that there is no limit on the amount of data that
5878 can be downloaded with this call, unlike with C<guestfs_pread>,
5879 and this call always reads the full amount unless an
5882 See also C<guestfs_download>, C<guestfs_pread>.");
5884 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5885 [InitPartition, Always, TestOutputListOfDevices (
5886 [["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"];
5887 ["blockdev_rereadpt"; "/dev/sda"];
5888 ["list_partitions"]], ["/dev/sdb1"])],
5889 "write to part of a device",
5891 This command writes to part of a device. It writes the data
5892 buffer C<content> to C<device> starting at offset C<offset>.
5894 This command implements the L<pwrite(2)> system call, and like
5895 that system call it may not write the full data requested
5896 (although short writes to disk devices and partitions are
5897 probably impossible with standard Linux kernels).
5899 See also C<guestfs_pwrite>.");
5901 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5902 [InitEmpty, Always, TestOutputBuffer (
5903 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5904 "read part of a device",
5906 This command lets you read part of a file. It reads C<count>
5907 bytes of C<device>, starting at C<offset>.
5909 This may read fewer bytes than requested. For further details
5910 see the L<pread(2)> system call.
5912 See also C<guestfs_pread>.");
5914 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5915 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5916 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5917 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5918 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5919 "get canonical name of an LV",
5921 This converts alternative naming schemes for LVs that you
5922 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5923 is converted to C</dev/VG/LV>.
5925 This command returns an error if the C<lvname> parameter does
5926 not refer to a logical volume.
5928 See also C<guestfs_is_lv>.");
5930 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
5931 [InitEmpty, Always, TestOutput (
5932 [["part_disk"; "/dev/sda"; "mbr"];
5933 ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
5934 ["mount_options"; ""; "/dev/sda1"; "/"];
5935 ["write"; "/new"; "new file contents"];
5936 ["cat"; "/new"]], "new file contents")],
5937 "make a filesystem",
5939 This function creates a filesystem on C<device>. The filesystem
5940 type is C<fstype>, for example C<ext3>.
5942 The optional arguments are:
5948 The filesystem block size. Supported block sizes depend on the
5949 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5950 for Linux ext2/3 filesystems.
5952 For VFAT and NTFS the C<blocksize> parameter is treated as
5953 the requested cluster size.
5955 For UFS block sizes, please see L<mkfs.ufs(8)>.
5959 This passes the I<-O> parameter to the external mkfs program.
5961 For certain filesystem types, this allows extra filesystem
5962 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5965 You cannot use this optional parameter with the C<gfs> or
5966 C<gfs2> filesystem type.
5970 This passes the I<-I> parameter to the external L<mke2fs(8)> program
5971 which sets the inode size (only for ext2/3/4 filesystems at present).
5975 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
5976 which sets sector size for ufs filesystem.
5980 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5982 "get a single extended attribute",
5984 Get a single extended attribute from file C<path> named C<name>.
5985 This call follows symlinks. If you want to lookup an extended
5986 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5988 Normally it is better to get all extended attributes from a file
5989 in one go by calling C<guestfs_getxattrs>. However some Linux
5990 filesystem implementations are buggy and do not provide a way to
5991 list out attributes. For these filesystems (notably ntfs-3g)
5992 you have to know the names of the extended attributes you want
5993 in advance and call this function.
5995 Extended attribute values are blobs of binary data. If there
5996 is no extended attribute named C<name>, this returns an error.
5998 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
6000 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
6002 "get a single extended attribute",
6004 Get a single extended attribute from file C<path> named C<name>.
6005 If C<path> is a symlink, then this call returns an extended
6006 attribute from the symlink.
6008 Normally it is better to get all extended attributes from a file
6009 in one go by calling C<guestfs_getxattrs>. However some Linux
6010 filesystem implementations are buggy and do not provide a way to
6011 list out attributes. For these filesystems (notably ntfs-3g)
6012 you have to know the names of the extended attributes you want
6013 in advance and call this function.
6015 Extended attribute values are blobs of binary data. If there
6016 is no extended attribute named C<name>, this returns an error.
6018 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
6020 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
6022 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
6024 This command is the same as C<guestfs_resize2fs>, but the filesystem
6025 is resized to its minimum size. This works like the I<-M> option
6026 to the C<resize2fs> command.
6028 To get the resulting size of the filesystem you should call
6029 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
6030 values. These two numbers, multiplied together, give the
6031 resulting size of the minimal filesystem in bytes.");
6033 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
6035 "internal autosync operation",
6037 This command performs the autosync operation just before the
6038 handle is closed. You should not call this command directly.
6039 Instead, use the autosync flag (C<guestfs_set_autosync>) to
6040 control whether or not this operation is performed when the
6041 handle is closed.");
6043 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6044 [InitISOFS, Always, TestOutputTrue (
6045 [["is_zero"; "/100kallzeroes"]]);
6046 InitISOFS, Always, TestOutputFalse (
6047 [["is_zero"; "/100kallspaces"]])],
6048 "test if a file contains all zero bytes",
6050 This returns true iff the file exists and the file is empty or
6051 it contains all zero bytes.");
6053 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6054 [InitBasicFS, Always, TestOutputTrue (
6055 [["umount"; "/dev/sda1"];
6056 ["zero_device"; "/dev/sda1"];
6057 ["is_zero_device"; "/dev/sda1"]]);
6058 InitBasicFS, Always, TestOutputFalse (
6059 [["is_zero_device"; "/dev/sda1"]])],
6060 "test if a device contains all zero bytes",
6062 This returns true iff the device exists and contains all zero bytes.
6064 Note that for large devices this can take a long time to run.");
6066 ("list_9p", (RStringList "mounttags", [], []), 285, [],
6068 "list 9p filesystems",
6070 List all 9p filesystems attached to the guest. A list of
6071 mount tags is returned.");
6073 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6075 "mount 9p filesystem",
6077 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6078 directory C<mountpoint>.
6080 If required, C<trans=virtio> will be automatically added to the options.
6081 Any other options required can be passed in the optional C<options>
6084 ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6086 "list device mapper devices",
6088 List all device mapper devices.
6090 The returned list contains C</dev/mapper/*> devices, eg. ones created
6091 by a previous call to C<guestfs_luks_open>.
6093 Device mapper devices which correspond to logical volumes are I<not>
6094 returned in this list. Call C<guestfs_lvs> if you want to list logical
6097 ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6099 "resize an NTFS filesystem",
6101 This command resizes an NTFS filesystem, expanding or
6102 shrinking it to the size of the underlying device.
6104 The optional parameters are:
6110 The new size (in bytes) of the filesystem. If omitted, the filesystem
6111 is resized to fit the container (eg. partition).
6115 If this option is true, then force the resize of the filesystem
6116 even if the filesystem is marked as requiring a consistency check.
6118 After the resize operation, the filesystem is always marked
6119 as requiring a consistency check (for safety). You have to boot
6120 into Windows to perform this check and clear this condition.
6121 If you I<don't> set the C<force> option then it is not
6122 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6123 single filesystem without booting into Windows between each resize.
6127 See also L<ntfsresize(8)>.");
6129 ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6131 "resize a btrfs filesystem",
6133 This command resizes a btrfs filesystem.
6135 Note that unlike other resize calls, the filesystem has to be
6136 mounted and the parameter is the mountpoint not the device
6137 (this is a requirement of btrfs itself).
6139 The optional parameters are:
6145 The new size (in bytes) of the filesystem. If omitted, the filesystem
6146 is resized to the maximum size.
6150 See also L<btrfs(8)>.");
6152 ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6153 [InitScratchFS, Always, TestOutput (
6154 [["write"; "/write_append"; "line1\n"];
6155 ["write_append"; "/write_append"; "line2\n"];
6156 ["write_append"; "/write_append"; "line3a"];
6157 ["write_append"; "/write_append"; "line3b\n"];
6158 ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6159 "append content to end of file",
6161 This call appends C<content> to the end of file C<path>. If
6162 C<path> does not exist, then a new file is created.
6164 See also C<guestfs_write>.");
6166 ("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [Int "level"]), 291, [],
6168 "output compressed file",
6170 This command compresses C<file> and writes it out to the local
6173 The compression program used is controlled by the C<ctype> parameter.
6174 Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.
6175 Some compression types may not be supported by particular builds of
6176 libguestfs, in which case you will get an error containing the
6177 substring \"not supported\".
6179 The optional C<level> parameter controls compression level. The
6180 meaning and default for this parameter depends on the compression
6181 program being used.");
6183 ("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [Int "level"]), 292, [],
6185 "output compressed device",
6187 This command compresses C<device> and writes it out to the local
6190 The C<ctype> and optional C<level> parameters have the same meaning
6191 as in C<guestfs_compress_out>.");
6195 let all_functions = non_daemon_functions @ daemon_functions
6197 (* In some places we want the functions to be displayed sorted
6198 * alphabetically, so this is useful:
6200 let all_functions_sorted = List.sort action_compare all_functions
6202 (* This is used to generate the src/MAX_PROC_NR file which
6203 * contains the maximum procedure number, a surrogate for the
6204 * ABI version number. See src/Makefile.am for the details.
6207 let proc_nrs = List.map (
6208 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6209 ) daemon_functions in
6210 List.fold_left max 0 proc_nrs
6212 (* Non-API meta-commands available only in guestfish.
6214 * Note (1): style, proc_nr and tests fields are all meaningless.
6215 * The only fields which are actually used are the shortname,
6216 * FishAlias flags, shortdesc and longdesc.
6218 * Note (2): to refer to other commands, use L</shortname>.
6220 * Note (3): keep this list sorted by shortname.
6222 let fish_commands = [
6223 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6224 "allocate and add a disk file",
6225 " alloc filename size
6227 This creates an empty (zeroed) file of the given size, and then adds
6228 so it can be further examined.
6230 For more advanced image creation, see L<qemu-img(1)> utility.
6232 Size can be specified using standard suffixes, eg. C<1M>.
6234 To create a sparse file, use L</sparse> instead. To create a
6235 prepared disk image, see L</PREPARED DISK IMAGES>.");
6237 ("copy_in", (RErr,[], []), -1, [], [],
6238 "copy local files or directories into an image",
6239 " copy-in local [local ...] /remotedir
6241 C<copy-in> copies local files or directories recursively into the disk
6242 image, placing them in the directory called C</remotedir> (which must
6243 exist). This guestfish meta-command turns into a sequence of
6244 L</tar-in> and other commands as necessary.
6246 Multiple local files and directories can be specified, but the last
6247 parameter must always be a remote directory. Wildcards cannot be
6250 ("copy_out", (RErr,[], []), -1, [], [],
6251 "copy remote files or directories out of an image",
6252 " copy-out remote [remote ...] localdir
6254 C<copy-out> copies remote files or directories recursively out of the
6255 disk image, placing them on the host disk in a local directory called
6256 C<localdir> (which must exist). This guestfish meta-command turns
6257 into a sequence of L</download>, L</tar-out> and other commands as
6260 Multiple remote files and directories can be specified, but the last
6261 parameter must always be a local directory. To download to the
6262 current directory, use C<.> as in:
6266 Wildcards cannot be used in the ordinary command, but you can use
6267 them with the help of L</glob> like this:
6269 glob copy-out /home/* .");
6271 ("display", (RErr,[], []), -1, [], [],
6275 Use C<display> (a graphical display program) to display an image
6276 file. It downloads the file, and runs C<display> on it.
6278 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6279 environment variable. For example to use the GNOME display program:
6281 export GUESTFISH_DISPLAY_IMAGE=eog
6283 See also L<display(1)>.");
6285 ("echo", (RErr,[], []), -1, [], [],
6286 "display a line of text",
6289 This echos the parameters to the terminal.");
6291 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6295 This is used to edit a file. It downloads the file, edits it
6296 locally using your editor, then uploads the result.
6298 The editor is C<$EDITOR>. However if you use the alternate
6299 commands C<vi> or C<emacs> you will get those corresponding
6302 ("glob", (RErr,[], []), -1, [], [],
6303 "expand wildcards in command",
6304 " glob command args...
6306 Expand wildcards in any paths in the args list, and run C<command>
6307 repeatedly on each matching path.
6309 See L</WILDCARDS AND GLOBBING>.");
6311 ("hexedit", (RErr,[], []), -1, [], [],
6312 "edit with a hex editor",
6313 " hexedit <filename|device>
6314 hexedit <filename|device> <max>
6315 hexedit <filename|device> <start> <max>
6317 Use hexedit (a hex editor) to edit all or part of a binary file
6320 This command works by downloading potentially the whole file or
6321 device, editing it locally, then uploading it. If the file or
6322 device is large, you have to specify which part you wish to edit
6323 by using C<max> and/or C<start> C<max> parameters.
6324 C<start> and C<max> are specified in bytes, with the usual
6325 modifiers allowed such as C<1M> (1 megabyte).
6327 For example to edit the first few sectors of a disk you
6332 which would allow you to edit anywhere within the first megabyte
6335 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6337 hexedit /dev/sda1 0x400 0x400
6339 (assuming the superblock is in the standard location).
6341 This command requires the external L<hexedit(1)> program. You
6342 can specify another program to use by setting the C<HEXEDITOR>
6343 environment variable.
6345 See also L</hexdump>.");
6347 ("lcd", (RErr,[], []), -1, [], [],
6348 "change working directory",
6351 Change the local directory, ie. the current directory of guestfish
6354 Note that C<!cd> won't do what you might expect.");
6356 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6360 Opens the manual page for guestfish.");
6362 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6368 This is used to view a file.
6370 The default viewer is C<$PAGER>. However if you use the alternate
6371 command C<less> you will get the C<less> command specifically.");
6373 ("reopen", (RErr,[], []), -1, [], [],
6374 "close and reopen libguestfs handle",
6377 Close and reopen the libguestfs handle. It is not necessary to use
6378 this normally, because the handle is closed properly when guestfish
6379 exits. However this is occasionally useful for testing.");
6381 ("setenv", (RErr,[], []), -1, [], [],
6382 "set an environment variable",
6385 Set the environment variable C<VAR> to the string C<value>.
6387 To print the value of an environment variable use a shell command
6392 ("sparse", (RErr,[], []), -1, [], [],
6393 "create a sparse disk image and add",
6394 " sparse filename size
6396 This creates an empty sparse file of the given size, and then adds
6397 so it can be further examined.
6399 In all respects it works the same as the L</alloc> command, except that
6400 the image file is allocated sparsely, which means that disk blocks are
6401 not assigned to the file until they are needed. Sparse disk files
6402 only use space when written to, but they are slower and there is a
6403 danger you could run out of real disk space during a write operation.
6405 For more advanced image creation, see L<qemu-img(1)> utility.
6407 Size can be specified using standard suffixes, eg. C<1M>.");
6409 ("supported", (RErr,[], []), -1, [], [],
6410 "list supported groups of commands",
6413 This command returns a list of the optional groups
6414 known to the daemon, and indicates which ones are
6415 supported by this build of the libguestfs appliance.
6417 See also L<guestfs(3)/AVAILABILITY>.");
6419 ("time", (RErr,[], []), -1, [], [],
6420 "print elapsed time taken to run a command",
6421 " time command args...
6423 Run the command as usual, but print the elapsed time afterwards. This
6424 can be useful for benchmarking operations.");
6426 ("unsetenv", (RErr,[], []), -1, [], [],
6427 "unset an environment variable",
6430 Remove C<VAR> from the environment.");