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:
825 =item \"redhat-based\"
827 Some Red Hat-derived distro.
831 Red Hat Enterprise Linux.
833 =item \"scientificlinux\"
851 The distro could not be determined.
855 Windows does not have distributions. This string is
856 returned if the OS type is Windows.
860 Future versions of libguestfs may return other strings here.
861 The caller should be prepared to handle any string.
863 Please read L<guestfs(3)/INSPECTION> for more details.");
865 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
867 "get major version of inspected operating system",
869 This returns the major version number of the inspected operating
872 Windows uses a consistent versioning scheme which is I<not>
873 reflected in the popular public names used by the operating system.
874 Notably the operating system known as \"Windows 7\" is really
875 version 6.1 (ie. major = 6, minor = 1). You can find out the
876 real versions corresponding to releases of Windows by consulting
879 If the version could not be determined, then C<0> is returned.
881 Please read L<guestfs(3)/INSPECTION> for more details.");
883 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
885 "get minor version of inspected operating system",
887 This returns the minor version number of the inspected operating
890 If the version could not be determined, then C<0> is returned.
892 Please read L<guestfs(3)/INSPECTION> for more details.
893 See also C<guestfs_inspect_get_major_version>.");
895 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
897 "get product name of inspected operating system",
899 This returns the product name of the inspected operating
900 system. The product name is generally some freeform string
901 which can be displayed to the user, but should not be
904 If the product name could not be determined, then the
905 string C<unknown> is returned.
907 Please read L<guestfs(3)/INSPECTION> for more details.");
909 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
911 "get mountpoints of inspected operating system",
913 This returns a hash of where we think the filesystems
914 associated with this operating system should be mounted.
915 Callers should note that this is at best an educated guess
916 made by reading configuration files such as C</etc/fstab>.
917 I<In particular note> that this may return filesystems
918 which are non-existent or not mountable and callers should
919 be prepared to handle or ignore failures if they try to
922 Each element in the returned hashtable has a key which
923 is the path of the mountpoint (eg. C</boot>) and a value
924 which is the filesystem that would be mounted there
927 Non-mounted devices such as swap devices are I<not>
928 returned in this list.
930 For operating systems like Windows which still use drive
931 letters, this call will only return an entry for the first
932 drive \"mounted on\" C</>. For information about the
933 mapping of drive letters to partitions, see
934 C<guestfs_inspect_get_drive_mappings>.
936 Please read L<guestfs(3)/INSPECTION> for more details.
937 See also C<guestfs_inspect_get_filesystems>.");
939 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
941 "get filesystems associated with inspected operating system",
943 This returns a list of all the filesystems that we think
944 are associated with this operating system. This includes
945 the root filesystem, other ordinary filesystems, and
946 non-mounted devices like swap partitions.
948 In the case of a multi-boot virtual machine, it is possible
949 for a filesystem to be shared between operating systems.
951 Please read L<guestfs(3)/INSPECTION> for more details.
952 See also C<guestfs_inspect_get_mountpoints>.");
954 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
956 "set enable network flag",
958 If C<network> is true, then the network is enabled in the
959 libguestfs appliance. The default is false.
961 This affects whether commands are able to access the network
962 (see L<guestfs(3)/RUNNING COMMANDS>).
964 You must call this before calling C<guestfs_launch>, otherwise
967 ("get_network", (RBool "network", [], []), -1, [],
969 "get enable network flag",
971 This returns the enable network flag.");
973 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
977 This inspection command looks for filesystems on partitions,
978 block devices and logical volumes, returning a list of devices
979 containing filesystems and their type.
981 The return value is a hash, where the keys are the devices
982 containing filesystems, and the values are the filesystem types.
985 \"/dev/sda1\" => \"ntfs\"
986 \"/dev/sda2\" => \"ext2\"
987 \"/dev/vg_guest/lv_root\" => \"ext4\"
988 \"/dev/vg_guest/lv_swap\" => \"swap\"
990 The value can have the special value \"unknown\", meaning the
991 content of the device is undetermined or empty.
992 \"swap\" means a Linux swap partition.
994 This command runs other libguestfs commands, which might include
995 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
996 use this soon after launch and only when nothing is mounted.
998 Not all of the filesystems returned will be mountable. In
999 particular, swap partitions are returned in the list. Also
1000 this command does not check that each filesystem
1001 found is valid and mountable, and some filesystems might
1002 be mountable but require special options. Filesystems may
1003 not all belong to a single logical operating system
1004 (use C<guestfs_inspect_os> to look for OSes).");
1006 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
1008 "add an image to examine or modify",
1010 This function adds a virtual machine disk image C<filename> to
1011 libguestfs. The first time you call this function, the disk
1012 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1015 You don't necessarily need to be root when using libguestfs. However
1016 you obviously do need sufficient permissions to access the filename
1017 for whatever operations you want to perform (ie. read access if you
1018 just want to read the image or write access if you want to modify the
1021 This call checks that C<filename> exists.
1023 The optional arguments are:
1029 If true then the image is treated as read-only. Writes are still
1030 allowed, but they are stored in a temporary snapshot overlay which
1031 is discarded at the end. The disk that you add is not modified.
1035 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1036 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1037 Possible formats include C<raw> and C<qcow2>.
1039 Automatic detection of the format opens you up to a potential
1040 security hole when dealing with untrusted raw-format images.
1041 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1046 This rarely-used option lets you emulate the behaviour of the
1047 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1051 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1053 "get Windows systemroot of inspected operating system",
1055 This returns the Windows systemroot of the inspected guest.
1056 The systemroot is a directory path such as C</WINDOWS>.
1058 This call assumes that the guest is Windows and that the
1059 systemroot could be determined by inspection. If this is not
1060 the case then an error is returned.
1062 Please read L<guestfs(3)/INSPECTION> for more details.");
1064 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1066 "return list of operating systems found by last inspection",
1068 This function is a convenient way to get the list of root
1069 devices, as returned from a previous call to C<guestfs_inspect_os>,
1070 but without redoing the whole inspection process.
1072 This returns an empty list if either no root devices were
1073 found or the caller has not called C<guestfs_inspect_os>.
1075 Please read L<guestfs(3)/INSPECTION> for more details.");
1077 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1079 "debug the QEMU command line (internal use only)",
1081 This returns the internal QEMU command line. 'debug' commands are
1082 not part of the formal API and can be removed or changed at any time.");
1084 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1086 "add the disk(s) from a named libvirt domain",
1088 This function adds the disk(s) attached to the named libvirt
1089 domain C<dom>. It works by connecting to libvirt, requesting
1090 the domain and domain XML from libvirt, parsing it for disks,
1091 and calling C<guestfs_add_drive_opts> on each one.
1093 The number of disks added is returned. This operation is atomic:
1094 if an error is returned, then no disks are added.
1096 This function does some minimal checks to make sure the libvirt
1097 domain is not running (unless C<readonly> is true). In a future
1098 version we will try to acquire the libvirt lock on each disk.
1100 Disks must be accessible locally. This often means that adding disks
1101 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1102 will fail unless those disks are accessible via the same device path
1105 The optional C<libvirturi> parameter sets the libvirt URI
1106 (see L<http://libvirt.org/uri.html>). If this is not set then
1107 we connect to the default libvirt URI (or one set through an
1108 environment variable, see the libvirt documentation for full
1111 The optional C<live> flag controls whether this call will try
1112 to connect to a running virtual machine C<guestfsd> process if
1113 it sees a suitable E<lt>channelE<gt> element in the libvirt
1114 XML definition. The default (if the flag is omitted) is never
1115 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1118 If the C<allowuuid> flag is true (default is false) then a UUID
1119 I<may> be passed instead of the domain name. The C<dom> string is
1120 treated as a UUID first and looked up, and if that lookup fails
1121 then we treat C<dom> as a name as usual.
1123 The other optional parameters are passed directly through to
1124 C<guestfs_add_drive_opts>.");
1127 This interface is not quite baked yet. -- RWMJ 2010-11-11
1128 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1130 "add the disk(s) from a libvirt domain",
1132 This function adds the disk(s) attached to the libvirt domain C<dom>.
1133 It works by requesting the domain XML from libvirt, parsing it for
1134 disks, and calling C<guestfs_add_drive_opts> on each one.
1136 In the C API we declare C<void *dom>, but really it has type
1137 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1139 The number of disks added is returned. This operation is atomic:
1140 if an error is returned, then no disks are added.
1142 This function does some minimal checks to make sure the libvirt
1143 domain is not running (unless C<readonly> is true). In a future
1144 version we will try to acquire the libvirt lock on each disk.
1146 Disks must be accessible locally. This often means that adding disks
1147 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1148 will fail unless those disks are accessible via the same device path
1151 The optional C<live> flag controls whether this call will try
1152 to connect to a running virtual machine C<guestfsd> process if
1153 it sees a suitable E<lt>channelE<gt> element in the libvirt
1154 XML definition. The default (if the flag is omitted) is never
1155 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1158 The other optional parameters are passed directly through to
1159 C<guestfs_add_drive_opts>.");
1162 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1164 "get package format used by the operating system",
1166 This function and C<guestfs_inspect_get_package_management> return
1167 the package format and package management tool used by the
1168 inspected operating system. For example for Fedora these
1169 functions would return C<rpm> (package format) and
1170 C<yum> (package management).
1172 This returns the string C<unknown> if we could not determine the
1173 package format I<or> if the operating system does not have
1174 a real packaging system (eg. Windows).
1176 Possible strings include:
1177 C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, C<pkgsrc>.
1178 Future versions of libguestfs may return other strings.
1180 Please read L<guestfs(3)/INSPECTION> for more details.");
1182 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1184 "get package management tool used by the operating system",
1186 C<guestfs_inspect_get_package_format> and this function return
1187 the package format and package management tool used by the
1188 inspected operating system. For example for Fedora these
1189 functions would return C<rpm> (package format) and
1190 C<yum> (package management).
1192 This returns the string C<unknown> if we could not determine the
1193 package management tool I<or> if the operating system does not have
1194 a real packaging system (eg. Windows).
1196 Possible strings include: C<yum>, C<up2date>,
1197 C<apt> (for all Debian derivatives),
1198 C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>.
1199 Future versions of libguestfs may return other strings.
1201 Please read L<guestfs(3)/INSPECTION> for more details.");
1203 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1205 "get list of applications installed in the operating system",
1207 Return the list of applications installed in the operating system.
1209 I<Note:> This call works differently from other parts of the
1210 inspection API. You have to call C<guestfs_inspect_os>, then
1211 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1212 before calling this. Listing applications is a significantly
1213 more difficult operation which requires access to the full
1214 filesystem. Also note that unlike the other
1215 C<guestfs_inspect_get_*> calls which are just returning
1216 data cached in the libguestfs handle, this call actually reads
1217 parts of the mounted filesystems during the call.
1219 This returns an empty list if the inspection code was not able
1220 to determine the list of applications.
1222 The application structure contains the following fields:
1228 The name of the application. For Red Hat-derived and Debian-derived
1229 Linux guests, this is the package name.
1231 =item C<app_display_name>
1233 The display name of the application, sometimes localized to the
1234 install language of the guest operating system.
1236 If unavailable this is returned as an empty string C<\"\">.
1237 Callers needing to display something can use C<app_name> instead.
1241 For package managers which use epochs, this contains the epoch of
1242 the package (an integer). If unavailable, this is returned as C<0>.
1244 =item C<app_version>
1246 The version string of the application or package. If unavailable
1247 this is returned as an empty string C<\"\">.
1249 =item C<app_release>
1251 The release string of the application or package, for package
1252 managers that use this. If unavailable this is returned as an
1253 empty string C<\"\">.
1255 =item C<app_install_path>
1257 The installation path of the application (on operating systems
1258 such as Windows which use installation paths). This path is
1259 in the format used by the guest operating system, it is not
1262 If unavailable this is returned as an empty string C<\"\">.
1264 =item C<app_trans_path>
1266 The install path translated into a libguestfs path.
1267 If unavailable this is returned as an empty string C<\"\">.
1269 =item C<app_publisher>
1271 The name of the publisher of the application, for package
1272 managers that use this. If unavailable this is returned
1273 as an empty string C<\"\">.
1277 The URL (eg. upstream URL) of the application.
1278 If unavailable this is returned as an empty string C<\"\">.
1280 =item C<app_source_package>
1282 For packaging systems which support this, the name of the source
1283 package. If unavailable this is returned as an empty string C<\"\">.
1285 =item C<app_summary>
1287 A short (usually one line) description of the application or package.
1288 If unavailable this is returned as an empty string C<\"\">.
1290 =item C<app_description>
1292 A longer description of the application or package.
1293 If unavailable this is returned as an empty string C<\"\">.
1297 Please read L<guestfs(3)/INSPECTION> for more details.");
1299 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1301 "get hostname of the operating system",
1303 This function returns the hostname of the operating system
1304 as found by inspection of the guest's configuration files.
1306 If the hostname could not be determined, then the
1307 string C<unknown> is returned.
1309 Please read L<guestfs(3)/INSPECTION> for more details.");
1311 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1313 "get format of inspected operating system",
1315 This returns the format of the inspected operating system. You
1316 can use it to detect install images, live CDs and similar.
1318 Currently defined formats are:
1324 This is an installed operating system.
1328 The disk image being inspected is not an installed operating system,
1329 but a I<bootable> install disk, live CD, or similar.
1333 The format of this disk image is not known.
1337 Future versions of libguestfs may return other strings here.
1338 The caller should be prepared to handle any string.
1340 Please read L<guestfs(3)/INSPECTION> for more details.");
1342 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1344 "get live flag for install disk",
1346 If C<guestfs_inspect_get_format> returns C<installer> (this
1347 is an install disk), then this returns true if a live image
1348 was detected on the disk.
1350 Please read L<guestfs(3)/INSPECTION> for more details.");
1352 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1354 "get netinst (network installer) flag for install disk",
1356 If C<guestfs_inspect_get_format> returns C<installer> (this
1357 is an install disk), then this returns true if the disk is
1358 a network installer, ie. not a self-contained install CD but
1359 one which is likely to require network access to complete
1362 Please read L<guestfs(3)/INSPECTION> for more details.");
1364 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1366 "get multipart flag for install disk",
1368 If C<guestfs_inspect_get_format> returns C<installer> (this
1369 is an install disk), then this returns true if the disk is
1372 Please read L<guestfs(3)/INSPECTION> for more details.");
1374 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1376 "set the attach method",
1378 Set the method that libguestfs uses to connect to the back end
1379 guestfsd daemon. Possible methods are:
1385 Launch an appliance and connect to it. This is the ordinary method
1388 =item C<unix:I<path>>
1390 Connect to the Unix domain socket I<path>.
1392 This method lets you connect to an existing daemon or (using
1393 virtio-serial) to a live guest. For more information, see
1394 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1398 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1399 [InitNone, Always, TestOutput (
1400 [["get_attach_method"]], "appliance")],
1401 "get the attach method",
1403 Return the current attach method. See C<guestfs_set_attach_method>.");
1405 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1407 "get product variant of inspected operating system",
1409 This returns the product variant of the inspected operating
1412 For Windows guests, this returns the contents of the Registry key
1413 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1414 C<InstallationType> which is usually a string such as
1415 C<Client> or C<Server> (other values are possible). This
1416 can be used to distinguish consumer and enterprise versions
1417 of Windows that have the same version number (for example,
1418 Windows 7 and Windows 2008 Server are both version 6.1,
1419 but the former is C<Client> and the latter is C<Server>).
1421 For enterprise Linux guests, in future we intend this to return
1422 the product variant such as C<Desktop>, C<Server> and so on. But
1423 this is not implemented at present.
1425 If the product variant could not be determined, then the
1426 string C<unknown> is returned.
1428 Please read L<guestfs(3)/INSPECTION> for more details.
1429 See also C<guestfs_inspect_get_product_name>,
1430 C<guestfs_inspect_get_major_version>.");
1432 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1434 "get Windows CurrentControlSet of inspected operating system",
1436 This returns the Windows CurrentControlSet of the inspected guest.
1437 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1439 This call assumes that the guest is Windows and that the
1440 Registry could be examined by inspection. If this is not
1441 the case then an error is returned.
1443 Please read L<guestfs(3)/INSPECTION> for more details.");
1445 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1447 "get drive letter mappings",
1449 This call is useful for Windows which uses a primitive system
1450 of assigning drive letters (like \"C:\") to partitions.
1451 This inspection API examines the Windows Registry to find out
1452 how disks/partitions are mapped to drive letters, and returns
1453 a hash table as in the example below:
1459 Note that keys are drive letters. For Windows, the key is
1460 case insensitive and just contains the drive letter, without
1461 the customary colon separator character.
1463 In future we may support other operating systems that also used drive
1464 letters, but the keys for those might not be case insensitive
1465 and might be longer than 1 character. For example in OS-9,
1466 hard drives were named C<h0>, C<h1> etc.
1468 For Windows guests, currently only hard drive mappings are
1469 returned. Removable disks (eg. DVD-ROMs) are ignored.
1471 For guests that do not use drive mappings, or if the drive mappings
1472 could not be determined, this returns an empty hash table.
1474 Please read L<guestfs(3)/INSPECTION> for more details.
1475 See also C<guestfs_inspect_get_mountpoints>,
1476 C<guestfs_inspect_get_filesystems>.");
1478 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1480 "get the icon corresponding to this operating system",
1482 This function returns an icon corresponding to the inspected
1483 operating system. The icon is returned as a buffer containing a
1484 PNG image (re-encoded to PNG if necessary).
1486 If it was not possible to get an icon this function returns a
1487 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1489 Libguestfs will start by looking for a file called
1490 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1491 and if it has the correct format, the contents of this file will
1492 be returned. You can disable favicons by passing the
1493 optional C<favicon> boolean as false (default is true).
1495 If finding the favicon fails, then we look in other places in the
1496 guest for a suitable icon.
1498 If the optional C<highquality> boolean is true then
1499 only high quality icons are returned, which means only icons of
1500 high resolution with an alpha channel. The default (false) is
1501 to return any icon we can, even if it is of substandard quality.
1509 Unlike most other inspection API calls, the guest's disks must be
1510 mounted up before you call this, since it needs to read information
1511 from the guest filesystem during the call.
1515 B<Security:> The icon data comes from the untrusted guest,
1516 and should be treated with caution. PNG files have been
1517 known to contain exploits. Ensure that libpng (or other relevant
1518 libraries) are fully up to date before trying to process or
1523 The PNG image returned can be any size. It might not be square.
1524 Libguestfs tries to return the largest, highest quality
1525 icon available. The application must scale the icon to the
1530 Extracting icons from Windows guests requires the external
1531 C<wrestool> program from the C<icoutils> package, and
1532 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1533 from the C<netpbm> package. These must be installed separately.
1537 Operating system icons are usually trademarks. Seek legal
1538 advice before using trademarks in applications.
1542 ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1544 "set process group flag",
1546 If C<pgroup> is true, child processes are placed into
1547 their own process group.
1549 The practical upshot of this is that signals like C<SIGINT> (from
1550 users pressing C<^C>) won't be received by the child process.
1552 The default for this flag is false, because usually you want
1553 C<^C> to kill the subprocess.");
1555 ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1557 "get process group flag",
1559 This returns the process group flag.");
1561 ("set_smp", (RErr, [Int "smp"], []), -1, [FishAlias "smp"],
1563 "set number of virtual CPUs in appliance",
1565 Change the number of virtual CPUs assigned to the appliance. The
1566 default is C<1>. Increasing this may improve performance, though
1567 often it has no effect.
1569 This function must be called before C<guestfs_launch>.");
1571 ("get_smp", (RInt "smp", [], []), -1, [],
1573 "get number of virtual CPUs in appliance",
1575 This returns the number of virtual CPUs assigned to the appliance.");
1579 (* daemon_functions are any functions which cause some action
1580 * to take place in the daemon.
1583 let daemon_functions = [
1584 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1585 [InitEmpty, Always, TestOutput (
1586 [["part_disk"; "/dev/sda"; "mbr"];
1587 ["mkfs"; "ext2"; "/dev/sda1"];
1588 ["mount"; "/dev/sda1"; "/"];
1589 ["write"; "/new"; "new file contents"];
1590 ["cat"; "/new"]], "new file contents")],
1591 "mount a guest disk at a position in the filesystem",
1593 Mount a guest disk at a position in the filesystem. Block devices
1594 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1595 the guest. If those block devices contain partitions, they will have
1596 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1599 The rules are the same as for L<mount(2)>: A filesystem must
1600 first be mounted on C</> before others can be mounted. Other
1601 filesystems can only be mounted on directories which already
1604 The mounted filesystem is writable, if we have sufficient permissions
1605 on the underlying device.
1607 Before libguestfs 1.13.16, this call implicitly added the options
1608 C<sync> and C<noatime>. The C<sync> option greatly slowed
1609 writes and caused many problems for users. If your program
1610 might need to work with older versions of libguestfs, use
1611 C<guestfs_mount_options> instead (using an empty string for the
1612 first parameter if you don't want any options).");
1614 ("sync", (RErr, [], []), 2, [],
1615 [ InitEmpty, Always, TestRun [["sync"]]],
1616 "sync disks, writes are flushed through to the disk image",
1618 This syncs the disk, so that any writes are flushed through to the
1619 underlying disk image.
1621 You should always call this if you have modified a disk image, before
1622 closing the handle.");
1624 ("touch", (RErr, [Pathname "path"], []), 3, [],
1625 [InitScratchFS, Always, TestOutputTrue (
1626 [["touch"; "/touch"];
1627 ["exists"; "/touch"]])],
1628 "update file timestamps or create a new file",
1630 Touch acts like the L<touch(1)> command. It can be used to
1631 update the timestamps on a file, or, if the file does not exist,
1632 to create a new zero-length file.
1634 This command only works on regular files, and will fail on other
1635 file types such as directories, symbolic links, block special etc.");
1637 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1638 [InitISOFS, Always, TestOutput (
1639 [["cat"; "/known-2"]], "abcdef\n")],
1640 "list the contents of a file",
1642 Return the contents of the file named C<path>.
1644 Note that this function cannot correctly handle binary files
1645 (specifically, files containing C<\\0> character which is treated
1646 as end of string). For those you need to use the C<guestfs_read_file>
1647 or C<guestfs_download> functions which have a more complex interface.");
1649 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1650 [], (* XXX Tricky to test because it depends on the exact format
1651 * of the 'ls -l' command, which changes between F10 and F11.
1653 "list the files in a directory (long format)",
1655 List the files in C<directory> (relative to the root directory,
1656 there is no cwd) in the format of 'ls -la'.
1658 This command is mostly useful for interactive sessions. It
1659 is I<not> intended that you try to parse the output string.");
1661 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1662 [InitScratchFS, Always, TestOutputList (
1664 ["touch"; "/ls/new"];
1665 ["touch"; "/ls/newer"];
1666 ["touch"; "/ls/newest"];
1667 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1668 "list the files in a directory",
1670 List the files in C<directory> (relative to the root directory,
1671 there is no cwd). The '.' and '..' entries are not returned, but
1672 hidden files are shown.
1674 This command is mostly useful for interactive sessions. Programs
1675 should probably use C<guestfs_readdir> instead.");
1677 ("list_devices", (RStringList "devices", [], []), 7, [],
1678 [InitEmpty, Always, TestOutputListOfDevices (
1679 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1680 "list the block devices",
1682 List all the block devices.
1684 The full block device names are returned, eg. C</dev/sda>.
1686 See also C<guestfs_list_filesystems>.");
1688 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1689 [InitBasicFS, Always, TestOutputListOfDevices (
1690 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1691 InitEmpty, Always, TestOutputListOfDevices (
1692 [["part_init"; "/dev/sda"; "mbr"];
1693 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1694 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1695 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1696 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1697 "list the partitions",
1699 List all the partitions detected on all block devices.
1701 The full partition device names are returned, eg. C</dev/sda1>
1703 This does not return logical volumes. For that you will need to
1704 call C<guestfs_lvs>.
1706 See also C<guestfs_list_filesystems>.");
1708 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1709 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1710 [["pvs"]], ["/dev/sda1"]);
1711 InitEmpty, Always, TestOutputListOfDevices (
1712 [["part_init"; "/dev/sda"; "mbr"];
1713 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1714 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1715 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1716 ["pvcreate"; "/dev/sda1"];
1717 ["pvcreate"; "/dev/sda2"];
1718 ["pvcreate"; "/dev/sda3"];
1719 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1720 "list the LVM physical volumes (PVs)",
1722 List all the physical volumes detected. This is the equivalent
1723 of the L<pvs(8)> command.
1725 This returns a list of just the device names that contain
1726 PVs (eg. C</dev/sda2>).
1728 See also C<guestfs_pvs_full>.");
1730 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1731 [InitBasicFSonLVM, Always, TestOutputList (
1733 InitEmpty, Always, TestOutputList (
1734 [["part_init"; "/dev/sda"; "mbr"];
1735 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1736 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1737 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1738 ["pvcreate"; "/dev/sda1"];
1739 ["pvcreate"; "/dev/sda2"];
1740 ["pvcreate"; "/dev/sda3"];
1741 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1742 ["vgcreate"; "VG2"; "/dev/sda3"];
1743 ["vgs"]], ["VG1"; "VG2"])],
1744 "list the LVM volume groups (VGs)",
1746 List all the volumes groups detected. This is the equivalent
1747 of the L<vgs(8)> command.
1749 This returns a list of just the volume group names that were
1750 detected (eg. C<VolGroup00>).
1752 See also C<guestfs_vgs_full>.");
1754 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1755 [InitBasicFSonLVM, Always, TestOutputList (
1756 [["lvs"]], ["/dev/VG/LV"]);
1757 InitEmpty, Always, TestOutputList (
1758 [["part_init"; "/dev/sda"; "mbr"];
1759 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1760 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1761 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1762 ["pvcreate"; "/dev/sda1"];
1763 ["pvcreate"; "/dev/sda2"];
1764 ["pvcreate"; "/dev/sda3"];
1765 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1766 ["vgcreate"; "VG2"; "/dev/sda3"];
1767 ["lvcreate"; "LV1"; "VG1"; "50"];
1768 ["lvcreate"; "LV2"; "VG1"; "50"];
1769 ["lvcreate"; "LV3"; "VG2"; "50"];
1770 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1771 "list the LVM logical volumes (LVs)",
1773 List all the logical volumes detected. This is the equivalent
1774 of the L<lvs(8)> command.
1776 This returns a list of the logical volume device names
1777 (eg. C</dev/VolGroup00/LogVol00>).
1779 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1781 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1782 [], (* XXX how to test? *)
1783 "list the LVM physical volumes (PVs)",
1785 List all the physical volumes detected. This is the equivalent
1786 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1788 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1789 [], (* XXX how to test? *)
1790 "list the LVM volume groups (VGs)",
1792 List all the volumes groups detected. This is the equivalent
1793 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1795 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1796 [], (* XXX how to test? *)
1797 "list the LVM logical volumes (LVs)",
1799 List all the logical volumes detected. This is the equivalent
1800 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1802 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1803 [InitISOFS, Always, TestOutputList (
1804 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1805 InitISOFS, Always, TestOutputList (
1806 [["read_lines"; "/empty"]], [])],
1807 "read file as lines",
1809 Return the contents of the file named C<path>.
1811 The file contents are returned as a list of lines. Trailing
1812 C<LF> and C<CRLF> character sequences are I<not> returned.
1814 Note that this function cannot correctly handle binary files
1815 (specifically, files containing C<\\0> character which is treated
1816 as end of line). For those you need to use the C<guestfs_read_file>
1817 function which has a more complex interface.");
1819 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1820 [], (* XXX Augeas code needs tests. *)
1821 "create a new Augeas handle",
1823 Create a new Augeas handle for editing configuration files.
1824 If there was any previous Augeas handle associated with this
1825 guestfs session, then it is closed.
1827 You must call this before using any other C<guestfs_aug_*>
1830 C<root> is the filesystem root. C<root> must not be NULL,
1833 The flags are the same as the flags defined in
1834 E<lt>augeas.hE<gt>, the logical I<or> of the following
1839 =item C<AUG_SAVE_BACKUP> = 1
1841 Keep the original file with a C<.augsave> extension.
1843 =item C<AUG_SAVE_NEWFILE> = 2
1845 Save changes into a file with extension C<.augnew>, and
1846 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1848 =item C<AUG_TYPE_CHECK> = 4
1852 This option is only useful when debugging Augeas lenses. Use
1853 of this option may require additional memory for the libguestfs
1854 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1855 environment variable or call C<guestfs_set_memsize>.
1857 =item C<AUG_NO_STDINC> = 8
1859 Do not use standard load path for modules.
1861 =item C<AUG_SAVE_NOOP> = 16
1863 Make save a no-op, just record what would have been changed.
1865 =item C<AUG_NO_LOAD> = 32
1867 Do not load the tree in C<guestfs_aug_init>.
1871 To close the handle, you can call C<guestfs_aug_close>.
1873 To find out more about Augeas, see L<http://augeas.net/>.");
1875 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1876 [], (* XXX Augeas code needs tests. *)
1877 "close the current Augeas handle",
1879 Close the current Augeas handle and free up any resources
1880 used by it. After calling this, you have to call
1881 C<guestfs_aug_init> again before you can use any other
1882 Augeas functions.");
1884 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1885 [], (* XXX Augeas code needs tests. *)
1886 "define an Augeas variable",
1888 Defines an Augeas variable C<name> whose value is the result
1889 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1892 On success this returns the number of nodes in C<expr>, or
1893 C<0> if C<expr> evaluates to something which is not a nodeset.");
1895 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1896 [], (* XXX Augeas code needs tests. *)
1897 "define an Augeas node",
1899 Defines a variable C<name> whose value is the result of
1902 If C<expr> evaluates to an empty nodeset, a node is created,
1903 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1904 C<name> will be the nodeset containing that single node.
1906 On success this returns a pair containing the
1907 number of nodes in the nodeset, and a boolean flag
1908 if a node was created.");
1910 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1911 [], (* XXX Augeas code needs tests. *)
1912 "look up the value of an Augeas path",
1914 Look up the value associated with C<path>. If C<path>
1915 matches exactly one node, the C<value> is returned.");
1917 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1918 [], (* XXX Augeas code needs tests. *)
1919 "set Augeas path to value",
1921 Set the value associated with C<path> to C<val>.
1923 In the Augeas API, it is possible to clear a node by setting
1924 the value to NULL. Due to an oversight in the libguestfs API
1925 you cannot do that with this call. Instead you must use the
1926 C<guestfs_aug_clear> call.");
1928 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1929 [], (* XXX Augeas code needs tests. *)
1930 "insert a sibling Augeas node",
1932 Create a new sibling C<label> for C<path>, inserting it into
1933 the tree before or after C<path> (depending on the boolean
1936 C<path> must match exactly one existing node in the tree, and
1937 C<label> must be a label, ie. not contain C</>, C<*> or end
1938 with a bracketed index C<[N]>.");
1940 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1941 [], (* XXX Augeas code needs tests. *)
1942 "remove an Augeas path",
1944 Remove C<path> and all of its children.
1946 On success this returns the number of entries which were removed.");
1948 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1949 [], (* XXX Augeas code needs tests. *)
1952 Move the node C<src> to C<dest>. C<src> must match exactly
1953 one node. C<dest> is overwritten if it exists.");
1955 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1956 [], (* XXX Augeas code needs tests. *)
1957 "return Augeas nodes which match augpath",
1959 Returns a list of paths which match the path expression C<path>.
1960 The returned paths are sufficiently qualified so that they match
1961 exactly one node in the current tree.");
1963 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1964 [], (* XXX Augeas code needs tests. *)
1965 "write all pending Augeas changes to disk",
1967 This writes all pending changes to disk.
1969 The flags which were passed to C<guestfs_aug_init> affect exactly
1970 how files are saved.");
1972 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1973 [], (* XXX Augeas code needs tests. *)
1974 "load files into the tree",
1976 Load files into the tree.
1978 See C<aug_load> in the Augeas documentation for the full gory
1981 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1982 [], (* XXX Augeas code needs tests. *)
1983 "list Augeas nodes under augpath",
1985 This is just a shortcut for listing C<guestfs_aug_match>
1986 C<path/*> and sorting the resulting nodes into alphabetical order.");
1988 ("rm", (RErr, [Pathname "path"], []), 29, [],
1989 [InitScratchFS, Always, TestRun
1991 ["touch"; "/rm/new"];
1993 InitScratchFS, Always, TestLastFail
1994 [["rm"; "/nosuchfile"]];
1995 InitScratchFS, Always, TestLastFail
2000 Remove the single file C<path>.");
2002 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
2003 [InitScratchFS, Always, TestRun
2004 [["mkdir"; "/rmdir"];
2005 ["rmdir"; "/rmdir"]];
2006 InitScratchFS, Always, TestLastFail
2007 [["rmdir"; "/rmdir2"]];
2008 InitScratchFS, Always, TestLastFail
2009 [["mkdir"; "/rmdir3"];
2010 ["touch"; "/rmdir3/new"];
2011 ["rmdir"; "/rmdir3/new"]]],
2012 "remove a directory",
2014 Remove the single directory C<path>.");
2016 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
2017 [InitScratchFS, Always, TestOutputFalse
2018 [["mkdir"; "/rm_rf"];
2019 ["mkdir"; "/rm_rf/foo"];
2020 ["touch"; "/rm_rf/foo/bar"];
2021 ["rm_rf"; "/rm_rf"];
2022 ["exists"; "/rm_rf"]]],
2023 "remove a file or directory recursively",
2025 Remove the file or directory C<path>, recursively removing the
2026 contents if its a directory. This is like the C<rm -rf> shell
2029 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2030 [InitScratchFS, Always, TestOutputTrue
2031 [["mkdir"; "/mkdir"];
2032 ["is_dir"; "/mkdir"]];
2033 InitScratchFS, Always, TestLastFail
2034 [["mkdir"; "/mkdir2/foo/bar"]]],
2035 "create a directory",
2037 Create a directory named C<path>.");
2039 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2040 [InitScratchFS, Always, TestOutputTrue
2041 [["mkdir_p"; "/mkdir_p/foo/bar"];
2042 ["is_dir"; "/mkdir_p/foo/bar"]];
2043 InitScratchFS, Always, TestOutputTrue
2044 [["mkdir_p"; "/mkdir_p2/foo/bar"];
2045 ["is_dir"; "/mkdir_p2/foo"]];
2046 InitScratchFS, Always, TestOutputTrue
2047 [["mkdir_p"; "/mkdir_p3/foo/bar"];
2048 ["is_dir"; "/mkdir_p3"]];
2049 (* Regression tests for RHBZ#503133: *)
2050 InitScratchFS, Always, TestRun
2051 [["mkdir"; "/mkdir_p4"];
2052 ["mkdir_p"; "/mkdir_p4"]];
2053 InitScratchFS, Always, TestLastFail
2054 [["touch"; "/mkdir_p5"];
2055 ["mkdir_p"; "/mkdir_p5"]]],
2056 "create a directory and parents",
2058 Create a directory named C<path>, creating any parent directories
2059 as necessary. This is like the C<mkdir -p> shell command.");
2061 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2062 [], (* XXX Need stat command to test *)
2065 Change the mode (permissions) of C<path> to C<mode>. Only
2066 numeric modes are supported.
2068 I<Note>: When using this command from guestfish, C<mode>
2069 by default would be decimal, unless you prefix it with
2070 C<0> to get octal, ie. use C<0700> not C<700>.
2072 The mode actually set is affected by the umask.");
2074 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2075 [], (* XXX Need stat command to test *)
2076 "change file owner and group",
2078 Change the file owner to C<owner> and group to C<group>.
2080 Only numeric uid and gid are supported. If you want to use
2081 names, you will need to locate and parse the password file
2082 yourself (Augeas support makes this relatively easy).");
2084 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2085 [InitISOFS, Always, TestOutputTrue (
2086 [["exists"; "/empty"]]);
2087 InitISOFS, Always, TestOutputTrue (
2088 [["exists"; "/directory"]])],
2089 "test if file or directory exists",
2091 This returns C<true> if and only if there is a file, directory
2092 (or anything) with the given C<path> name.
2094 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2096 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2097 [InitISOFS, Always, TestOutputTrue (
2098 [["is_file"; "/known-1"]]);
2099 InitISOFS, Always, TestOutputFalse (
2100 [["is_file"; "/directory"]])],
2101 "test if a regular file",
2103 This returns C<true> if and only if there is a regular file
2104 with the given C<path> name. Note that it returns false for
2105 other objects like directories.
2107 See also C<guestfs_stat>.");
2109 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2110 [InitISOFS, Always, TestOutputFalse (
2111 [["is_dir"; "/known-3"]]);
2112 InitISOFS, Always, TestOutputTrue (
2113 [["is_dir"; "/directory"]])],
2114 "test if a directory",
2116 This returns C<true> if and only if there is a directory
2117 with the given C<path> name. Note that it returns false for
2118 other objects like files.
2120 See also C<guestfs_stat>.");
2122 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2123 [InitEmpty, Always, TestOutputListOfDevices (
2124 [["part_init"; "/dev/sda"; "mbr"];
2125 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2126 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2127 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2128 ["pvcreate"; "/dev/sda1"];
2129 ["pvcreate"; "/dev/sda2"];
2130 ["pvcreate"; "/dev/sda3"];
2131 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2132 "create an LVM physical volume",
2134 This creates an LVM physical volume on the named C<device>,
2135 where C<device> should usually be a partition name such
2138 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2139 [InitEmpty, Always, TestOutputList (
2140 [["part_init"; "/dev/sda"; "mbr"];
2141 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2142 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2143 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2144 ["pvcreate"; "/dev/sda1"];
2145 ["pvcreate"; "/dev/sda2"];
2146 ["pvcreate"; "/dev/sda3"];
2147 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2148 ["vgcreate"; "VG2"; "/dev/sda3"];
2149 ["vgs"]], ["VG1"; "VG2"])],
2150 "create an LVM volume group",
2152 This creates an LVM volume group called C<volgroup>
2153 from the non-empty list of physical volumes C<physvols>.");
2155 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2156 [InitEmpty, Always, TestOutputList (
2157 [["part_init"; "/dev/sda"; "mbr"];
2158 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2159 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2160 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2161 ["pvcreate"; "/dev/sda1"];
2162 ["pvcreate"; "/dev/sda2"];
2163 ["pvcreate"; "/dev/sda3"];
2164 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2165 ["vgcreate"; "VG2"; "/dev/sda3"];
2166 ["lvcreate"; "LV1"; "VG1"; "50"];
2167 ["lvcreate"; "LV2"; "VG1"; "50"];
2168 ["lvcreate"; "LV3"; "VG2"; "50"];
2169 ["lvcreate"; "LV4"; "VG2"; "50"];
2170 ["lvcreate"; "LV5"; "VG2"; "50"];
2172 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2173 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2174 "create an LVM logical volume",
2176 This creates an LVM logical volume called C<logvol>
2177 on the volume group C<volgroup>, with C<size> megabytes.");
2179 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2180 [InitEmpty, Always, TestOutput (
2181 [["part_disk"; "/dev/sda"; "mbr"];
2182 ["mkfs"; "ext2"; "/dev/sda1"];
2183 ["mount_options"; ""; "/dev/sda1"; "/"];
2184 ["write"; "/new"; "new file contents"];
2185 ["cat"; "/new"]], "new file contents")],
2186 "make a filesystem",
2188 This creates a filesystem on C<device> (usually a partition
2189 or LVM logical volume). The filesystem type is C<fstype>, for
2192 ("sfdisk", (RErr, [Device "device";
2193 Int "cyls"; Int "heads"; Int "sectors";
2194 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2196 "create partitions on a block device",
2198 This is a direct interface to the L<sfdisk(8)> program for creating
2199 partitions on block devices.
2201 C<device> should be a block device, for example C</dev/sda>.
2203 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2204 and sectors on the device, which are passed directly to sfdisk as
2205 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2206 of these, then the corresponding parameter is omitted. Usually for
2207 'large' disks, you can just pass C<0> for these, but for small
2208 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2209 out the right geometry and you will need to tell it.
2211 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2212 information refer to the L<sfdisk(8)> manpage.
2214 To create a single partition occupying the whole disk, you would
2215 pass C<lines> as a single element list, when the single element being
2216 the string C<,> (comma).
2218 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2219 C<guestfs_part_init>");
2221 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2222 (* Regression test for RHBZ#597135. *)
2223 [InitScratchFS, Always, TestLastFail
2224 [["write_file"; "/write_file"; "abc"; "10000"]]],
2227 This call creates a file called C<path>. The contents of the
2228 file is the string C<content> (which can contain any 8 bit data),
2229 with length C<size>.
2231 As a special case, if C<size> is C<0>
2232 then the length is calculated using C<strlen> (so in this case
2233 the content cannot contain embedded ASCII NULs).
2235 I<NB.> Owing to a bug, writing content containing ASCII NUL
2236 characters does I<not> work, even if the length is specified.");
2238 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2239 [InitEmpty, Always, TestOutputListOfDevices (
2240 [["part_disk"; "/dev/sda"; "mbr"];
2241 ["mkfs"; "ext2"; "/dev/sda1"];
2242 ["mount_options"; ""; "/dev/sda1"; "/"];
2243 ["mounts"]], ["/dev/sda1"]);
2244 InitEmpty, Always, TestOutputList (
2245 [["part_disk"; "/dev/sda"; "mbr"];
2246 ["mkfs"; "ext2"; "/dev/sda1"];
2247 ["mount_options"; ""; "/dev/sda1"; "/"];
2250 "unmount a filesystem",
2252 This unmounts the given filesystem. The filesystem may be
2253 specified either by its mountpoint (path) or the device which
2254 contains the filesystem.");
2256 ("mounts", (RStringList "devices", [], []), 46, [],
2257 [InitScratchFS, Always, TestOutputListOfDevices (
2258 [["mounts"]], ["/dev/sdb1"])],
2259 "show mounted filesystems",
2261 This returns the list of currently mounted filesystems. It returns
2262 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2264 Some internal mounts are not shown.
2266 See also: C<guestfs_mountpoints>");
2268 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2269 [InitScratchFS, Always, TestOutputList (
2272 (* check that umount_all can unmount nested mounts correctly: *)
2273 InitEmpty, Always, TestOutputList (
2274 [["part_init"; "/dev/sda"; "mbr"];
2275 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2276 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2277 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2278 ["mkfs"; "ext2"; "/dev/sda1"];
2279 ["mkfs"; "ext2"; "/dev/sda2"];
2280 ["mkfs"; "ext2"; "/dev/sda3"];
2281 ["mount_options"; ""; "/dev/sda1"; "/"];
2283 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2284 ["mkdir"; "/mp1/mp2"];
2285 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2286 ["mkdir"; "/mp1/mp2/mp3"];
2289 "unmount all filesystems",
2291 This unmounts all mounted filesystems.
2293 Some internal mounts are not unmounted by this call.");
2295 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2297 "remove all LVM LVs, VGs and PVs",
2299 This command removes all LVM logical volumes, volume groups
2300 and physical volumes.");
2302 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2303 [InitISOFS, Always, TestOutput (
2304 [["file"; "/empty"]], "empty");
2305 InitISOFS, Always, TestOutput (
2306 [["file"; "/known-1"]], "ASCII text");
2307 InitISOFS, Always, TestLastFail (
2308 [["file"; "/notexists"]]);
2309 InitISOFS, Always, TestOutput (
2310 [["file"; "/abssymlink"]], "symbolic link");
2311 InitISOFS, Always, TestOutput (
2312 [["file"; "/directory"]], "directory")],
2313 "determine file type",
2315 This call uses the standard L<file(1)> command to determine
2316 the type or contents of the file.
2318 This call will also transparently look inside various types
2321 The exact command which runs is C<file -zb path>. Note in
2322 particular that the filename is not prepended to the output
2325 The output depends on the output of the underlying L<file(1)>
2326 command and it can change in future in ways beyond our control.
2327 In other words, the output is not guaranteed by the ABI.
2329 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2330 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2332 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2333 [InitScratchFS, Always, TestOutput (
2334 [["mkdir"; "/command"];
2335 ["upload"; "test-command"; "/command/test-command"];
2336 ["chmod"; "0o755"; "/command/test-command"];
2337 ["command"; "/command/test-command 1"]], "Result1");
2338 InitScratchFS, Always, TestOutput (
2339 [["mkdir"; "/command2"];
2340 ["upload"; "test-command"; "/command2/test-command"];
2341 ["chmod"; "0o755"; "/command2/test-command"];
2342 ["command"; "/command2/test-command 2"]], "Result2\n");
2343 InitScratchFS, Always, TestOutput (
2344 [["mkdir"; "/command3"];
2345 ["upload"; "test-command"; "/command3/test-command"];
2346 ["chmod"; "0o755"; "/command3/test-command"];
2347 ["command"; "/command3/test-command 3"]], "\nResult3");
2348 InitScratchFS, Always, TestOutput (
2349 [["mkdir"; "/command4"];
2350 ["upload"; "test-command"; "/command4/test-command"];
2351 ["chmod"; "0o755"; "/command4/test-command"];
2352 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2353 InitScratchFS, Always, TestOutput (
2354 [["mkdir"; "/command5"];
2355 ["upload"; "test-command"; "/command5/test-command"];
2356 ["chmod"; "0o755"; "/command5/test-command"];
2357 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2358 InitScratchFS, Always, TestOutput (
2359 [["mkdir"; "/command6"];
2360 ["upload"; "test-command"; "/command6/test-command"];
2361 ["chmod"; "0o755"; "/command6/test-command"];
2362 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2363 InitScratchFS, Always, TestOutput (
2364 [["mkdir"; "/command7"];
2365 ["upload"; "test-command"; "/command7/test-command"];
2366 ["chmod"; "0o755"; "/command7/test-command"];
2367 ["command"; "/command7/test-command 7"]], "");
2368 InitScratchFS, Always, TestOutput (
2369 [["mkdir"; "/command8"];
2370 ["upload"; "test-command"; "/command8/test-command"];
2371 ["chmod"; "0o755"; "/command8/test-command"];
2372 ["command"; "/command8/test-command 8"]], "\n");
2373 InitScratchFS, Always, TestOutput (
2374 [["mkdir"; "/command9"];
2375 ["upload"; "test-command"; "/command9/test-command"];
2376 ["chmod"; "0o755"; "/command9/test-command"];
2377 ["command"; "/command9/test-command 9"]], "\n\n");
2378 InitScratchFS, Always, TestOutput (
2379 [["mkdir"; "/command10"];
2380 ["upload"; "test-command"; "/command10/test-command"];
2381 ["chmod"; "0o755"; "/command10/test-command"];
2382 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2383 InitScratchFS, Always, TestOutput (
2384 [["mkdir"; "/command11"];
2385 ["upload"; "test-command"; "/command11/test-command"];
2386 ["chmod"; "0o755"; "/command11/test-command"];
2387 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2388 InitScratchFS, Always, TestLastFail (
2389 [["mkdir"; "/command12"];
2390 ["upload"; "test-command"; "/command12/test-command"];
2391 ["chmod"; "0o755"; "/command12/test-command"];
2392 ["command"; "/command12/test-command"]])],
2393 "run a command from the guest filesystem",
2395 This call runs a command from the guest filesystem. The
2396 filesystem must be mounted, and must contain a compatible
2397 operating system (ie. something Linux, with the same
2398 or compatible processor architecture).
2400 The single parameter is an argv-style list of arguments.
2401 The first element is the name of the program to run.
2402 Subsequent elements are parameters. The list must be
2403 non-empty (ie. must contain a program name). Note that
2404 the command runs directly, and is I<not> invoked via
2405 the shell (see C<guestfs_sh>).
2407 The return value is anything printed to I<stdout> by
2410 If the command returns a non-zero exit status, then
2411 this function returns an error message. The error message
2412 string is the content of I<stderr> from the command.
2414 The C<$PATH> environment variable will contain at least
2415 C</usr/bin> and C</bin>. If you require a program from
2416 another location, you should provide the full path in the
2419 Shared libraries and data files required by the program
2420 must be available on filesystems which are mounted in the
2421 correct places. It is the caller's responsibility to ensure
2422 all filesystems that are needed are mounted at the right
2425 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2426 [InitScratchFS, Always, TestOutputList (
2427 [["mkdir"; "/command_lines"];
2428 ["upload"; "test-command"; "/command_lines/test-command"];
2429 ["chmod"; "0o755"; "/command_lines/test-command"];
2430 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2431 InitScratchFS, Always, TestOutputList (
2432 [["mkdir"; "/command_lines2"];
2433 ["upload"; "test-command"; "/command_lines2/test-command"];
2434 ["chmod"; "0o755"; "/command_lines2/test-command"];
2435 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2436 InitScratchFS, Always, TestOutputList (
2437 [["mkdir"; "/command_lines3"];
2438 ["upload"; "test-command"; "/command_lines3/test-command"];
2439 ["chmod"; "0o755"; "/command_lines3/test-command"];
2440 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2441 InitScratchFS, Always, TestOutputList (
2442 [["mkdir"; "/command_lines4"];
2443 ["upload"; "test-command"; "/command_lines4/test-command"];
2444 ["chmod"; "0o755"; "/command_lines4/test-command"];
2445 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2446 InitScratchFS, Always, TestOutputList (
2447 [["mkdir"; "/command_lines5"];
2448 ["upload"; "test-command"; "/command_lines5/test-command"];
2449 ["chmod"; "0o755"; "/command_lines5/test-command"];
2450 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2451 InitScratchFS, Always, TestOutputList (
2452 [["mkdir"; "/command_lines6"];
2453 ["upload"; "test-command"; "/command_lines6/test-command"];
2454 ["chmod"; "0o755"; "/command_lines6/test-command"];
2455 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2456 InitScratchFS, Always, TestOutputList (
2457 [["mkdir"; "/command_lines7"];
2458 ["upload"; "test-command"; "/command_lines7/test-command"];
2459 ["chmod"; "0o755"; "/command_lines7/test-command"];
2460 ["command_lines"; "/command_lines7/test-command 7"]], []);
2461 InitScratchFS, Always, TestOutputList (
2462 [["mkdir"; "/command_lines8"];
2463 ["upload"; "test-command"; "/command_lines8/test-command"];
2464 ["chmod"; "0o755"; "/command_lines8/test-command"];
2465 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2466 InitScratchFS, Always, TestOutputList (
2467 [["mkdir"; "/command_lines9"];
2468 ["upload"; "test-command"; "/command_lines9/test-command"];
2469 ["chmod"; "0o755"; "/command_lines9/test-command"];
2470 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2471 InitScratchFS, Always, TestOutputList (
2472 [["mkdir"; "/command_lines10"];
2473 ["upload"; "test-command"; "/command_lines10/test-command"];
2474 ["chmod"; "0o755"; "/command_lines10/test-command"];
2475 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2476 InitScratchFS, Always, TestOutputList (
2477 [["mkdir"; "/command_lines11"];
2478 ["upload"; "test-command"; "/command_lines11/test-command"];
2479 ["chmod"; "0o755"; "/command_lines11/test-command"];
2480 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2481 "run a command, returning lines",
2483 This is the same as C<guestfs_command>, but splits the
2484 result into a list of lines.
2486 See also: C<guestfs_sh_lines>");
2488 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2489 [InitISOFS, Always, TestOutputStruct (
2490 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2491 "get file information",
2493 Returns file information for the given C<path>.
2495 This is the same as the C<stat(2)> system call.");
2497 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2498 [InitISOFS, Always, TestOutputStruct (
2499 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2500 "get file information for a symbolic link",
2502 Returns file information for the given C<path>.
2504 This is the same as C<guestfs_stat> except that if C<path>
2505 is a symbolic link, then the link is stat-ed, not the file it
2508 This is the same as the C<lstat(2)> system call.");
2510 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2511 [InitISOFS, Always, TestOutputStruct (
2512 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2513 "get file system statistics",
2515 Returns file system statistics for any mounted file system.
2516 C<path> should be a file or directory in the mounted file system
2517 (typically it is the mount point itself, but it doesn't need to be).
2519 This is the same as the C<statvfs(2)> system call.");
2521 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2523 "get ext2/ext3/ext4 superblock details",
2525 This returns the contents of the ext2, ext3 or ext4 filesystem
2526 superblock on C<device>.
2528 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2529 manpage for more details. The list of fields returned isn't
2530 clearly defined, and depends on both the version of C<tune2fs>
2531 that libguestfs was built against, and the filesystem itself.");
2533 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2534 [InitEmpty, Always, TestOutputTrue (
2535 [["blockdev_setro"; "/dev/sda"];
2536 ["blockdev_getro"; "/dev/sda"]])],
2537 "set block device to read-only",
2539 Sets the block device named C<device> to read-only.
2541 This uses the L<blockdev(8)> command.");
2543 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2544 [InitEmpty, Always, TestOutputFalse (
2545 [["blockdev_setrw"; "/dev/sda"];
2546 ["blockdev_getro"; "/dev/sda"]])],
2547 "set block device to read-write",
2549 Sets the block device named C<device> to read-write.
2551 This uses the L<blockdev(8)> command.");
2553 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2554 [InitEmpty, Always, TestOutputTrue (
2555 [["blockdev_setro"; "/dev/sda"];
2556 ["blockdev_getro"; "/dev/sda"]])],
2557 "is block device set to read-only",
2559 Returns a boolean indicating if the block device is read-only
2560 (true if read-only, false if not).
2562 This uses the L<blockdev(8)> command.");
2564 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2565 [InitEmpty, Always, TestOutputInt (
2566 [["blockdev_getss"; "/dev/sda"]], 512)],
2567 "get sectorsize of block device",
2569 This returns the size of sectors on a block device.
2570 Usually 512, but can be larger for modern devices.
2572 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2575 This uses the L<blockdev(8)> command.");
2577 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2578 [InitEmpty, Always, TestOutputInt (
2579 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2580 "get blocksize of block device",
2582 This returns the block size of a device.
2584 (Note this is different from both I<size in blocks> and
2585 I<filesystem block size>).
2587 This uses the L<blockdev(8)> command.");
2589 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2591 "set blocksize of block device",
2593 This sets the block size of a device.
2595 (Note this is different from both I<size in blocks> and
2596 I<filesystem block size>).
2598 This uses the L<blockdev(8)> command.");
2600 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2601 [InitEmpty, Always, TestOutputInt (
2602 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2603 "get total size of device in 512-byte sectors",
2605 This returns the size of the device in units of 512-byte sectors
2606 (even if the sectorsize isn't 512 bytes ... weird).
2608 See also C<guestfs_blockdev_getss> for the real sector size of
2609 the device, and C<guestfs_blockdev_getsize64> for the more
2610 useful I<size in bytes>.
2612 This uses the L<blockdev(8)> command.");
2614 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2615 [InitEmpty, Always, TestOutputInt (
2616 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2617 "get total size of device in bytes",
2619 This returns the size of the device in bytes.
2621 See also C<guestfs_blockdev_getsz>.
2623 This uses the L<blockdev(8)> command.");
2625 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2626 [InitEmpty, Always, TestRun
2627 [["blockdev_flushbufs"; "/dev/sda"]]],
2628 "flush device buffers",
2630 This tells the kernel to flush internal buffers associated
2633 This uses the L<blockdev(8)> command.");
2635 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2636 [InitEmpty, Always, TestRun
2637 [["blockdev_rereadpt"; "/dev/sda"]]],
2638 "reread partition table",
2640 Reread the partition table on C<device>.
2642 This uses the L<blockdev(8)> command.");
2644 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2645 [InitScratchFS, Always, TestOutput (
2646 (* Pick a file from cwd which isn't likely to change. *)
2647 [["mkdir"; "/upload"];
2648 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2649 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2650 Digest.to_hex (Digest.file "COPYING.LIB"))],
2651 "upload a file from the local machine",
2653 Upload local file C<filename> to C<remotefilename> on the
2656 C<filename> can also be a named pipe.
2658 See also C<guestfs_download>.");
2660 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2661 [InitScratchFS, Always, TestOutput (
2662 (* Pick a file from cwd which isn't likely to change. *)
2663 [["mkdir"; "/download"];
2664 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2665 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2666 ["upload"; "testdownload.tmp"; "/download/upload"];
2667 ["checksum"; "md5"; "/download/upload"]],
2668 Digest.to_hex (Digest.file "COPYING.LIB"))],
2669 "download a file to the local machine",
2671 Download file C<remotefilename> and save it as C<filename>
2672 on the local machine.
2674 C<filename> can also be a named pipe.
2676 See also C<guestfs_upload>, C<guestfs_cat>.");
2678 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2679 [InitISOFS, Always, TestOutput (
2680 [["checksum"; "crc"; "/known-3"]], "2891671662");
2681 InitISOFS, Always, TestLastFail (
2682 [["checksum"; "crc"; "/notexists"]]);
2683 InitISOFS, Always, TestOutput (
2684 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2685 InitISOFS, Always, TestOutput (
2686 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2687 InitISOFS, Always, TestOutput (
2688 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2689 InitISOFS, Always, TestOutput (
2690 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2691 InitISOFS, Always, TestOutput (
2692 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2693 InitISOFS, Always, TestOutput (
2694 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2695 (* Test for RHBZ#579608, absolute symbolic links. *)
2696 InitISOFS, Always, TestOutput (
2697 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2698 "compute MD5, SHAx or CRC checksum of file",
2700 This call computes the MD5, SHAx or CRC checksum of the
2703 The type of checksum to compute is given by the C<csumtype>
2704 parameter which must have one of the following values:
2710 Compute the cyclic redundancy check (CRC) specified by POSIX
2711 for the C<cksum> command.
2715 Compute the MD5 hash (using the C<md5sum> program).
2719 Compute the SHA1 hash (using the C<sha1sum> program).
2723 Compute the SHA224 hash (using the C<sha224sum> program).
2727 Compute the SHA256 hash (using the C<sha256sum> program).
2731 Compute the SHA384 hash (using the C<sha384sum> program).
2735 Compute the SHA512 hash (using the C<sha512sum> program).
2739 The checksum is returned as a printable string.
2741 To get the checksum for a device, use C<guestfs_checksum_device>.
2743 To get the checksums for many files, use C<guestfs_checksums_out>.");
2745 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2746 [InitScratchFS, Always, TestOutput (
2747 [["mkdir"; "/tar_in"];
2748 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2749 ["cat"; "/tar_in/hello"]], "hello\n")],
2750 "unpack tarfile to directory",
2752 This command uploads and unpacks local file C<tarfile> (an
2753 I<uncompressed> tar file) into C<directory>.
2755 To upload a compressed tarball, use C<guestfs_tgz_in>
2756 or C<guestfs_txz_in>.");
2758 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2760 "pack directory into tarfile",
2762 This command packs the contents of C<directory> and downloads
2763 it to local file C<tarfile>.
2765 To download a compressed tarball, use C<guestfs_tgz_out>
2766 or C<guestfs_txz_out>.");
2768 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2769 [InitScratchFS, Always, TestOutput (
2770 [["mkdir"; "/tgz_in"];
2771 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2772 ["cat"; "/tgz_in/hello"]], "hello\n")],
2773 "unpack compressed tarball to directory",
2775 This command uploads and unpacks local file C<tarball> (a
2776 I<gzip compressed> tar file) into C<directory>.
2778 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2780 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2782 "pack directory into compressed tarball",
2784 This command packs the contents of C<directory> and downloads
2785 it to local file C<tarball>.
2787 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2789 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2790 [InitBasicFS, Always, TestLastFail (
2792 ["mount_ro"; "/dev/sda1"; "/"];
2793 ["touch"; "/new"]]);
2794 InitBasicFS, Always, TestOutput (
2795 [["write"; "/new"; "data"];
2797 ["mount_ro"; "/dev/sda1"; "/"];
2798 ["cat"; "/new"]], "data")],
2799 "mount a guest disk, read-only",
2801 This is the same as the C<guestfs_mount> command, but it
2802 mounts the filesystem with the read-only (I<-o ro>) flag.");
2804 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2806 "mount a guest disk with mount options",
2808 This is the same as the C<guestfs_mount> command, but it
2809 allows you to set the mount options as for the
2810 L<mount(8)> I<-o> flag.
2812 If the C<options> parameter is an empty string, then
2813 no options are passed (all options default to whatever
2814 the filesystem uses).");
2816 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2818 "mount a guest disk with mount options and vfstype",
2820 This is the same as the C<guestfs_mount> command, but it
2821 allows you to set both the mount options and the vfstype
2822 as for the L<mount(8)> I<-o> and I<-t> flags.");
2824 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2826 "debugging and internals",
2828 The C<guestfs_debug> command exposes some internals of
2829 C<guestfsd> (the guestfs daemon) that runs inside the
2832 There is no comprehensive help for this command. You have
2833 to look at the file C<daemon/debug.c> in the libguestfs source
2834 to find out what you can do.");
2836 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2837 [InitEmpty, Always, TestOutputList (
2838 [["part_disk"; "/dev/sda"; "mbr"];
2839 ["pvcreate"; "/dev/sda1"];
2840 ["vgcreate"; "VG"; "/dev/sda1"];
2841 ["lvcreate"; "LV1"; "VG"; "50"];
2842 ["lvcreate"; "LV2"; "VG"; "50"];
2843 ["lvremove"; "/dev/VG/LV1"];
2844 ["lvs"]], ["/dev/VG/LV2"]);
2845 InitEmpty, Always, TestOutputList (
2846 [["part_disk"; "/dev/sda"; "mbr"];
2847 ["pvcreate"; "/dev/sda1"];
2848 ["vgcreate"; "VG"; "/dev/sda1"];
2849 ["lvcreate"; "LV1"; "VG"; "50"];
2850 ["lvcreate"; "LV2"; "VG"; "50"];
2851 ["lvremove"; "/dev/VG"];
2853 InitEmpty, Always, TestOutputList (
2854 [["part_disk"; "/dev/sda"; "mbr"];
2855 ["pvcreate"; "/dev/sda1"];
2856 ["vgcreate"; "VG"; "/dev/sda1"];
2857 ["lvcreate"; "LV1"; "VG"; "50"];
2858 ["lvcreate"; "LV2"; "VG"; "50"];
2859 ["lvremove"; "/dev/VG"];
2861 "remove an LVM logical volume",
2863 Remove an LVM logical volume C<device>, where C<device> is
2864 the path to the LV, such as C</dev/VG/LV>.
2866 You can also remove all LVs in a volume group by specifying
2867 the VG name, C</dev/VG>.");
2869 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2870 [InitEmpty, Always, TestOutputList (
2871 [["part_disk"; "/dev/sda"; "mbr"];
2872 ["pvcreate"; "/dev/sda1"];
2873 ["vgcreate"; "VG"; "/dev/sda1"];
2874 ["lvcreate"; "LV1"; "VG"; "50"];
2875 ["lvcreate"; "LV2"; "VG"; "50"];
2878 InitEmpty, Always, TestOutputList (
2879 [["part_disk"; "/dev/sda"; "mbr"];
2880 ["pvcreate"; "/dev/sda1"];
2881 ["vgcreate"; "VG"; "/dev/sda1"];
2882 ["lvcreate"; "LV1"; "VG"; "50"];
2883 ["lvcreate"; "LV2"; "VG"; "50"];
2886 "remove an LVM volume group",
2888 Remove an LVM volume group C<vgname>, (for example C<VG>).
2890 This also forcibly removes all logical volumes in the volume
2893 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2894 [InitEmpty, Always, TestOutputListOfDevices (
2895 [["part_disk"; "/dev/sda"; "mbr"];
2896 ["pvcreate"; "/dev/sda1"];
2897 ["vgcreate"; "VG"; "/dev/sda1"];
2898 ["lvcreate"; "LV1"; "VG"; "50"];
2899 ["lvcreate"; "LV2"; "VG"; "50"];
2901 ["pvremove"; "/dev/sda1"];
2903 InitEmpty, Always, TestOutputListOfDevices (
2904 [["part_disk"; "/dev/sda"; "mbr"];
2905 ["pvcreate"; "/dev/sda1"];
2906 ["vgcreate"; "VG"; "/dev/sda1"];
2907 ["lvcreate"; "LV1"; "VG"; "50"];
2908 ["lvcreate"; "LV2"; "VG"; "50"];
2910 ["pvremove"; "/dev/sda1"];
2912 InitEmpty, Always, TestOutputListOfDevices (
2913 [["part_disk"; "/dev/sda"; "mbr"];
2914 ["pvcreate"; "/dev/sda1"];
2915 ["vgcreate"; "VG"; "/dev/sda1"];
2916 ["lvcreate"; "LV1"; "VG"; "50"];
2917 ["lvcreate"; "LV2"; "VG"; "50"];
2919 ["pvremove"; "/dev/sda1"];
2921 "remove an LVM physical volume",
2923 This wipes a physical volume C<device> so that LVM will no longer
2926 The implementation uses the C<pvremove> command which refuses to
2927 wipe physical volumes that contain any volume groups, so you have
2928 to remove those first.");
2930 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2931 [InitBasicFS, Always, TestOutput (
2932 [["set_e2label"; "/dev/sda1"; "testlabel"];
2933 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2934 "set the ext2/3/4 filesystem label",
2936 This sets the ext2/3/4 filesystem label of the filesystem on
2937 C<device> to C<label>. Filesystem labels are limited to
2940 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2941 to return the existing label on a filesystem.");
2943 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2945 "get the ext2/3/4 filesystem label",
2947 This returns the ext2/3/4 filesystem label of the filesystem on
2950 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2951 (let uuid = uuidgen () in
2952 [InitBasicFS, Always, TestOutput (
2953 [["set_e2uuid"; "/dev/sda1"; uuid];
2954 ["get_e2uuid"; "/dev/sda1"]], uuid);
2955 InitBasicFS, Always, TestOutput (
2956 [["set_e2uuid"; "/dev/sda1"; "clear"];
2957 ["get_e2uuid"; "/dev/sda1"]], "");
2958 (* We can't predict what UUIDs will be, so just check the commands run. *)
2959 InitBasicFS, Always, TestRun (
2960 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2961 InitBasicFS, Always, TestRun (
2962 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2963 "set the ext2/3/4 filesystem UUID",
2965 This sets the ext2/3/4 filesystem UUID of the filesystem on
2966 C<device> to C<uuid>. The format of the UUID and alternatives
2967 such as C<clear>, C<random> and C<time> are described in the
2968 L<tune2fs(8)> manpage.
2970 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2971 to return the existing UUID of a filesystem.");
2973 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2974 (* Regression test for RHBZ#597112. *)
2975 (let uuid = uuidgen () in
2976 [InitNone, Always, TestOutput (
2977 [["mke2journal"; "1024"; "/dev/sdc"];
2978 ["set_e2uuid"; "/dev/sdc"; uuid];
2979 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2980 "get the ext2/3/4 filesystem UUID",
2982 This returns the ext2/3/4 filesystem UUID of the filesystem on
2985 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2986 [InitBasicFS, Always, TestOutputInt (
2987 [["umount"; "/dev/sda1"];
2988 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2989 InitBasicFS, Always, TestOutputInt (
2990 [["umount"; "/dev/sda1"];
2991 ["zero"; "/dev/sda1"];
2992 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2993 "run the filesystem checker",
2995 This runs the filesystem checker (fsck) on C<device> which
2996 should have filesystem type C<fstype>.
2998 The returned integer is the status. See L<fsck(8)> for the
2999 list of status codes from C<fsck>.
3007 Multiple status codes can be summed together.
3011 A non-zero return code can mean \"success\", for example if
3012 errors have been corrected on the filesystem.
3016 Checking or repairing NTFS volumes is not supported
3021 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3023 ("zero", (RErr, [Device "device"], []), 85, [Progress],
3024 [InitBasicFS, Always, TestRun (
3025 [["umount"; "/dev/sda1"];
3026 ["zero"; "/dev/sda1"]])],
3027 "write zeroes to the device",
3029 This command writes zeroes over the first few blocks of C<device>.
3031 How many blocks are zeroed isn't specified (but it's I<not> enough
3032 to securely wipe the device). It should be sufficient to remove
3033 any partition tables, filesystem superblocks and so on.
3035 If blocks are already zero, then this command avoids writing
3036 zeroes. This prevents the underlying device from becoming non-sparse
3037 or growing unnecessarily.
3039 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3040 C<guestfs_is_zero_device>");
3042 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3044 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3045 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3047 [InitBasicFS, Always, TestOutputTrue (
3048 [["mkdir_p"; "/boot/grub"];
3049 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3050 ["grub_install"; "/"; "/dev/vda"];
3051 ["is_dir"; "/boot"]])],
3054 This command installs GRUB 1 (the Grand Unified Bootloader) on
3055 C<device>, with the root directory being C<root>.
3063 There is currently no way in the API to install grub2, which
3064 is used by most modern Linux guests. It is possible to run
3065 the grub2 command from the guest, although see the
3066 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3070 This uses C<grub-install> from the host. Unfortunately grub is
3071 not always compatible with itself, so this only works in rather
3072 narrow circumstances. Careful testing with each guest version
3077 If grub-install reports the error
3078 \"No suitable drive was found in the generated device map.\"
3079 it may be that you need to create a C</boot/grub/device.map>
3080 file first that contains the mapping between grub device names
3081 and Linux device names. It is usually sufficient to create
3086 replacing C</dev/vda> with the name of the installation device.
3090 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3091 [InitScratchFS, Always, TestOutput (
3093 ["write"; "/cp/old"; "file content"];
3094 ["cp"; "/cp/old"; "/cp/new"];
3095 ["cat"; "/cp/new"]], "file content");
3096 InitScratchFS, Always, TestOutputTrue (
3098 ["write"; "/cp2/old"; "file content"];
3099 ["cp"; "/cp2/old"; "/cp2/new"];
3100 ["is_file"; "/cp2/old"]]);
3101 InitScratchFS, Always, TestOutput (
3103 ["write"; "/cp3/old"; "file content"];
3104 ["mkdir"; "/cp3/dir"];
3105 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3106 ["cat"; "/cp3/dir/new"]], "file content")],
3109 This copies a file from C<src> to C<dest> where C<dest> is
3110 either a destination filename or destination directory.");
3112 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3113 [InitScratchFS, Always, TestOutput (
3114 [["mkdir"; "/cp_a1"];
3115 ["mkdir"; "/cp_a2"];
3116 ["write"; "/cp_a1/file"; "file content"];
3117 ["cp_a"; "/cp_a1"; "/cp_a2"];
3118 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3119 "copy a file or directory recursively",
3121 This copies a file or directory from C<src> to C<dest>
3122 recursively using the C<cp -a> command.");
3124 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3125 [InitScratchFS, Always, TestOutput (
3127 ["write"; "/mv/old"; "file content"];
3128 ["mv"; "/mv/old"; "/mv/new"];
3129 ["cat"; "/mv/new"]], "file content");
3130 InitScratchFS, Always, TestOutputFalse (
3132 ["write"; "/mv2/old"; "file content"];
3133 ["mv"; "/mv2/old"; "/mv2/new"];
3134 ["is_file"; "/mv2/old"]])],
3137 This moves a file from C<src> to C<dest> where C<dest> is
3138 either a destination filename or destination directory.");
3140 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3141 [InitEmpty, Always, TestRun (
3142 [["drop_caches"; "3"]])],
3143 "drop kernel page cache, dentries and inodes",
3145 This instructs the guest kernel to drop its page cache,
3146 and/or dentries and inode caches. The parameter C<whattodrop>
3147 tells the kernel what precisely to drop, see
3148 L<http://linux-mm.org/Drop_Caches>
3150 Setting C<whattodrop> to 3 should drop everything.
3152 This automatically calls L<sync(2)> before the operation,
3153 so that the maximum guest memory is freed.");
3155 ("dmesg", (RString "kmsgs", [], []), 91, [],
3156 [InitEmpty, Always, TestRun (
3158 "return kernel messages",
3160 This returns the kernel messages (C<dmesg> output) from
3161 the guest kernel. This is sometimes useful for extended
3162 debugging of problems.
3164 Another way to get the same information is to enable
3165 verbose messages with C<guestfs_set_verbose> or by setting
3166 the environment variable C<LIBGUESTFS_DEBUG=1> before
3167 running the program.");
3169 ("ping_daemon", (RErr, [], []), 92, [],
3170 [InitEmpty, Always, TestRun (
3171 [["ping_daemon"]])],
3172 "ping the guest daemon",
3174 This is a test probe into the guestfs daemon running inside
3175 the qemu subprocess. Calling this function checks that the
3176 daemon responds to the ping message, without affecting the daemon
3177 or attached block device(s) in any other way.");
3179 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3180 [InitScratchFS, Always, TestOutputTrue (
3181 [["mkdir"; "/equal"];
3182 ["write"; "/equal/file1"; "contents of a file"];
3183 ["cp"; "/equal/file1"; "/equal/file2"];
3184 ["equal"; "/equal/file1"; "/equal/file2"]]);
3185 InitScratchFS, Always, TestOutputFalse (
3186 [["mkdir"; "/equal2"];
3187 ["write"; "/equal2/file1"; "contents of a file"];
3188 ["write"; "/equal2/file2"; "contents of another file"];
3189 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3190 InitScratchFS, Always, TestLastFail (
3191 [["mkdir"; "/equal3"];
3192 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3193 "test if two files have equal contents",
3195 This compares the two files C<file1> and C<file2> and returns
3196 true if their content is exactly equal, or false otherwise.
3198 The external L<cmp(1)> program is used for the comparison.");
3200 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3201 [InitISOFS, Always, TestOutputList (
3202 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3203 InitISOFS, Always, TestOutputList (
3204 [["strings"; "/empty"]], []);
3205 (* Test for RHBZ#579608, absolute symbolic links. *)
3206 InitISOFS, Always, TestRun (
3207 [["strings"; "/abssymlink"]])],
3208 "print the printable strings in a file",
3210 This runs the L<strings(1)> command on a file and returns
3211 the list of printable strings found.");
3213 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3214 [InitISOFS, Always, TestOutputList (
3215 [["strings_e"; "b"; "/known-5"]], []);
3216 InitScratchFS, Always, TestOutputList (
3217 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3218 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3219 "print the printable strings in a file",
3221 This is like the C<guestfs_strings> command, but allows you to
3222 specify the encoding of strings that are looked for in
3223 the source file C<path>.
3225 Allowed encodings are:
3231 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3232 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3236 Single 8-bit-byte characters.
3240 16-bit big endian strings such as those encoded in
3241 UTF-16BE or UCS-2BE.
3243 =item l (lower case letter L)
3245 16-bit little endian such as UTF-16LE and UCS-2LE.
3246 This is useful for examining binaries in Windows guests.
3250 32-bit big endian such as UCS-4BE.
3254 32-bit little endian such as UCS-4LE.
3258 The returned strings are transcoded to UTF-8.");
3260 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3261 [InitISOFS, Always, TestOutput (
3262 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3263 (* Test for RHBZ#501888c2 regression which caused large hexdump
3264 * commands to segfault.
3266 InitISOFS, Always, TestRun (
3267 [["hexdump"; "/100krandom"]]);
3268 (* Test for RHBZ#579608, absolute symbolic links. *)
3269 InitISOFS, Always, TestRun (
3270 [["hexdump"; "/abssymlink"]])],
3271 "dump a file in hexadecimal",
3273 This runs C<hexdump -C> on the given C<path>. The result is
3274 the human-readable, canonical hex dump of the file.");
3276 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3277 [InitNone, Always, TestOutput (
3278 [["part_disk"; "/dev/sda"; "mbr"];
3279 ["mkfs"; "ext3"; "/dev/sda1"];
3280 ["mount_options"; ""; "/dev/sda1"; "/"];
3281 ["write"; "/new"; "test file"];
3282 ["umount"; "/dev/sda1"];
3283 ["zerofree"; "/dev/sda1"];
3284 ["mount_options"; ""; "/dev/sda1"; "/"];
3285 ["cat"; "/new"]], "test file")],
3286 "zero unused inodes and disk blocks on ext2/3 filesystem",
3288 This runs the I<zerofree> program on C<device>. This program
3289 claims to zero unused inodes and disk blocks on an ext2/3
3290 filesystem, thus making it possible to compress the filesystem
3293 You should B<not> run this program if the filesystem is
3296 It is possible that using this program can damage the filesystem
3297 or data on the filesystem.");
3299 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3301 "resize an LVM physical volume",
3303 This resizes (expands or shrinks) an existing LVM physical
3304 volume to match the new size of the underlying device.");
3306 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3307 Int "cyls"; Int "heads"; Int "sectors";
3308 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3310 "modify a single partition on a block device",
3312 This runs L<sfdisk(8)> option to modify just the single
3313 partition C<n> (note: C<n> counts from 1).
3315 For other parameters, see C<guestfs_sfdisk>. You should usually
3316 pass C<0> for the cyls/heads/sectors parameters.
3318 See also: C<guestfs_part_add>");
3320 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3322 "display the partition table",
3324 This displays the partition table on C<device>, in the
3325 human-readable output of the L<sfdisk(8)> command. It is
3326 not intended to be parsed.
3328 See also: C<guestfs_part_list>");
3330 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3332 "display the kernel geometry",
3334 This displays the kernel's idea of the geometry of C<device>.
3336 The result is in human-readable format, and not designed to
3339 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3341 "display the disk geometry from the partition table",
3343 This displays the disk geometry of C<device> read from the
3344 partition table. Especially in the case where the underlying
3345 block device has been resized, this can be different from the
3346 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3348 The result is in human-readable format, and not designed to
3351 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3353 "activate or deactivate all volume groups",
3355 This command activates or (if C<activate> is false) deactivates
3356 all logical volumes in all volume groups.
3358 This command is the same as running C<vgchange -a y|n>");
3360 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3362 "activate or deactivate some volume groups",
3364 This command activates or (if C<activate> is false) deactivates
3365 all logical volumes in the listed volume groups C<volgroups>.
3367 This command is the same as running C<vgchange -a y|n volgroups...>
3369 Note that if C<volgroups> is an empty list then B<all> volume groups
3370 are activated or deactivated.");
3372 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3373 [InitNone, Always, TestOutput (
3374 [["part_disk"; "/dev/sda"; "mbr"];
3375 ["pvcreate"; "/dev/sda1"];
3376 ["vgcreate"; "VG"; "/dev/sda1"];
3377 ["lvcreate"; "LV"; "VG"; "10"];
3378 ["mkfs"; "ext2"; "/dev/VG/LV"];
3379 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3380 ["write"; "/new"; "test content"];
3382 ["lvresize"; "/dev/VG/LV"; "20"];
3383 ["e2fsck_f"; "/dev/VG/LV"];
3384 ["resize2fs"; "/dev/VG/LV"];
3385 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3386 ["cat"; "/new"]], "test content");
3387 InitNone, Always, TestRun (
3388 (* Make an LV smaller to test RHBZ#587484. *)
3389 [["part_disk"; "/dev/sda"; "mbr"];
3390 ["pvcreate"; "/dev/sda1"];
3391 ["vgcreate"; "VG"; "/dev/sda1"];
3392 ["lvcreate"; "LV"; "VG"; "20"];
3393 ["lvresize"; "/dev/VG/LV"; "10"]])],
3394 "resize an LVM logical volume",
3396 This resizes (expands or shrinks) an existing LVM logical
3397 volume to C<mbytes>. When reducing, data in the reduced part
3400 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3401 [], (* lvresize tests this *)
3402 "resize an ext2, ext3 or ext4 filesystem",
3404 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3405 the underlying device.
3407 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3408 on the C<device> before calling this command. For unknown reasons
3409 C<resize2fs> sometimes gives an error about this and sometimes not.
3410 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3411 calling this function.");
3413 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3414 [InitBasicFS, Always, TestOutputList (
3415 [["find"; "/"]], ["lost+found"]);
3416 InitBasicFS, Always, TestOutputList (
3420 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3421 InitScratchFS, Always, TestOutputList (
3422 [["mkdir_p"; "/find/b/c"];
3423 ["touch"; "/find/b/c/d"];
3424 ["find"; "/find/b/"]], ["c"; "c/d"])],
3425 "find all files and directories",
3427 This command lists out all files and directories, recursively,
3428 starting at C<directory>. It is essentially equivalent to
3429 running the shell command C<find directory -print> but some
3430 post-processing happens on the output, described below.
3432 This returns a list of strings I<without any prefix>. Thus
3433 if the directory structure was:
3439 then the returned list from C<guestfs_find> C</tmp> would be
3447 If C<directory> is not a directory, then this command returns
3450 The returned list is sorted.
3452 See also C<guestfs_find0>.");
3454 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3455 [], (* lvresize tests this *)
3456 "check an ext2/ext3 filesystem",
3458 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3459 filesystem checker on C<device>, noninteractively (I<-p>),
3460 even if the filesystem appears to be clean (I<-f>).
3462 This command is only needed because of C<guestfs_resize2fs>
3463 (q.v.). Normally you should use C<guestfs_fsck>.");
3465 ("sleep", (RErr, [Int "secs"], []), 109, [],
3466 [InitNone, Always, TestRun (
3468 "sleep for some seconds",
3470 Sleep for C<secs> seconds.");
3472 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3473 [InitNone, Always, TestOutputInt (
3474 [["part_disk"; "/dev/sda"; "mbr"];
3475 ["mkfs"; "ntfs"; "/dev/sda1"];
3476 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3477 InitNone, Always, TestOutputInt (
3478 [["part_disk"; "/dev/sda"; "mbr"];
3479 ["mkfs"; "ext2"; "/dev/sda1"];
3480 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3481 "probe NTFS volume",
3483 This command runs the L<ntfs-3g.probe(8)> command which probes
3484 an NTFS C<device> for mountability. (Not all NTFS volumes can
3485 be mounted read-write, and some cannot be mounted at all).
3487 C<rw> is a boolean flag. Set it to true if you want to test
3488 if the volume can be mounted read-write. Set it to false if
3489 you want to test if the volume can be mounted read-only.
3491 The return value is an integer which C<0> if the operation
3492 would succeed, or some non-zero value documented in the
3493 L<ntfs-3g.probe(8)> manual page.");
3495 ("sh", (RString "output", [String "command"], []), 111, [],
3496 [], (* XXX needs tests *)
3497 "run a command via the shell",
3499 This call runs a command from the guest filesystem via the
3502 This is like C<guestfs_command>, but passes the command to:
3504 /bin/sh -c \"command\"
3506 Depending on the guest's shell, this usually results in
3507 wildcards being expanded, shell expressions being interpolated
3510 All the provisos about C<guestfs_command> apply to this call.");
3512 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3513 [], (* XXX needs tests *)
3514 "run a command via the shell returning lines",
3516 This is the same as C<guestfs_sh>, but splits the result
3517 into a list of lines.
3519 See also: C<guestfs_command_lines>");
3521 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3522 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3523 * code in stubs.c, since all valid glob patterns must start with "/".
3524 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3526 [InitScratchFS, Always, TestOutputList (
3527 [["mkdir_p"; "/glob_expand/b/c"];
3528 ["touch"; "/glob_expand/b/c/d"];
3529 ["touch"; "/glob_expand/b/c/e"];
3530 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3531 InitScratchFS, Always, TestOutputList (
3532 [["mkdir_p"; "/glob_expand2/b/c"];
3533 ["touch"; "/glob_expand2/b/c/d"];
3534 ["touch"; "/glob_expand2/b/c/e"];
3535 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3536 InitScratchFS, Always, TestOutputList (
3537 [["mkdir_p"; "/glob_expand3/b/c"];
3538 ["touch"; "/glob_expand3/b/c/d"];
3539 ["touch"; "/glob_expand3/b/c/e"];
3540 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3541 "expand a wildcard path",
3543 This command searches for all the pathnames matching
3544 C<pattern> according to the wildcard expansion rules
3547 If no paths match, then this returns an empty list
3548 (note: not an error).
3550 It is just a wrapper around the C L<glob(3)> function
3551 with flags C<GLOB_MARK|GLOB_BRACE>.
3552 See that manual page for more details.");
3554 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3555 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3556 [["scrub_device"; "/dev/sdc"]])],
3557 "scrub (securely wipe) a device",
3559 This command writes patterns over C<device> to make data retrieval
3562 It is an interface to the L<scrub(1)> program. See that
3563 manual page for more details.");
3565 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3566 [InitScratchFS, Always, TestRun (
3567 [["write"; "/scrub_file"; "content"];
3568 ["scrub_file"; "/scrub_file"]])],
3569 "scrub (securely wipe) a file",
3571 This command writes patterns over a file to make data retrieval
3574 The file is I<removed> after scrubbing.
3576 It is an interface to the L<scrub(1)> program. See that
3577 manual page for more details.");
3579 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3580 [], (* XXX needs testing *)
3581 "scrub (securely wipe) free space",
3583 This command creates the directory C<dir> and then fills it
3584 with files until the filesystem is full, and scrubs the files
3585 as for C<guestfs_scrub_file>, and deletes them.
3586 The intention is to scrub any free space on the partition
3589 It is an interface to the L<scrub(1)> program. See that
3590 manual page for more details.");
3592 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3593 [InitScratchFS, Always, TestRun (
3594 [["mkdir"; "/mkdtemp"];
3595 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3596 "create a temporary directory",
3598 This command creates a temporary directory. The
3599 C<template> parameter should be a full pathname for the
3600 temporary directory name with the final six characters being
3603 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3604 the second one being suitable for Windows filesystems.
3606 The name of the temporary directory that was created
3609 The temporary directory is created with mode 0700
3610 and is owned by root.
3612 The caller is responsible for deleting the temporary
3613 directory and its contents after use.
3615 See also: L<mkdtemp(3)>");
3617 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3618 [InitISOFS, Always, TestOutputInt (
3619 [["wc_l"; "/10klines"]], 10000);
3620 (* Test for RHBZ#579608, absolute symbolic links. *)
3621 InitISOFS, Always, TestOutputInt (
3622 [["wc_l"; "/abssymlink"]], 10000)],
3623 "count lines in a file",
3625 This command counts the lines in a file, using the
3626 C<wc -l> external command.");
3628 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3629 [InitISOFS, Always, TestOutputInt (
3630 [["wc_w"; "/10klines"]], 10000)],
3631 "count words in a file",
3633 This command counts the words in a file, using the
3634 C<wc -w> external command.");
3636 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3637 [InitISOFS, Always, TestOutputInt (
3638 [["wc_c"; "/100kallspaces"]], 102400)],
3639 "count characters in a file",
3641 This command counts the characters in a file, using the
3642 C<wc -c> external command.");
3644 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3645 [InitISOFS, Always, TestOutputList (
3646 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3647 (* Test for RHBZ#579608, absolute symbolic links. *)
3648 InitISOFS, Always, TestOutputList (
3649 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3650 "return first 10 lines of a file",
3652 This command returns up to the first 10 lines of a file as
3653 a list of strings.");
3655 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3656 [InitISOFS, Always, TestOutputList (
3657 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3658 InitISOFS, Always, TestOutputList (
3659 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3660 InitISOFS, Always, TestOutputList (
3661 [["head_n"; "0"; "/10klines"]], [])],
3662 "return first N lines of a file",
3664 If the parameter C<nrlines> is a positive number, this returns the first
3665 C<nrlines> lines of the file C<path>.
3667 If the parameter C<nrlines> is a negative number, this returns lines
3668 from the file C<path>, excluding the last C<nrlines> lines.
3670 If the parameter C<nrlines> is zero, this returns an empty list.");
3672 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3673 [InitISOFS, Always, TestOutputList (
3674 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3675 "return last 10 lines of a file",
3677 This command returns up to the last 10 lines of a file as
3678 a list of strings.");
3680 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3681 [InitISOFS, Always, TestOutputList (
3682 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3683 InitISOFS, Always, TestOutputList (
3684 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3685 InitISOFS, Always, TestOutputList (
3686 [["tail_n"; "0"; "/10klines"]], [])],
3687 "return last N lines of a file",
3689 If the parameter C<nrlines> is a positive number, this returns the last
3690 C<nrlines> lines of the file C<path>.
3692 If the parameter C<nrlines> is a negative number, this returns lines
3693 from the file C<path>, starting with the C<-nrlines>th line.
3695 If the parameter C<nrlines> is zero, this returns an empty list.");
3697 ("df", (RString "output", [], []), 125, [],
3698 [], (* XXX Tricky to test because it depends on the exact format
3699 * of the 'df' command and other imponderables.
3701 "report file system disk space usage",
3703 This command runs the C<df> command to report disk space used.
3705 This command is mostly useful for interactive sessions. It
3706 is I<not> intended that you try to parse the output string.
3707 Use C<guestfs_statvfs> from programs.");
3709 ("df_h", (RString "output", [], []), 126, [],
3710 [], (* XXX Tricky to test because it depends on the exact format
3711 * of the 'df' command and other imponderables.
3713 "report file system disk space usage (human readable)",
3715 This command runs the C<df -h> command to report disk space used
3716 in human-readable format.
3718 This command is mostly useful for interactive sessions. It
3719 is I<not> intended that you try to parse the output string.
3720 Use C<guestfs_statvfs> from programs.");
3722 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3723 [InitISOFS, Always, TestOutputInt (
3724 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3725 "estimate file space usage",
3727 This command runs the C<du -s> command to estimate file space
3730 C<path> can be a file or a directory. If C<path> is a directory
3731 then the estimate includes the contents of the directory and all
3732 subdirectories (recursively).
3734 The result is the estimated size in I<kilobytes>
3735 (ie. units of 1024 bytes).");
3737 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3738 [InitISOFS, Always, TestOutputList (
3739 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3740 "list files in an initrd",
3742 This command lists out files contained in an initrd.
3744 The files are listed without any initial C</> character. The
3745 files are listed in the order they appear (not necessarily
3746 alphabetical). Directory names are listed as separate items.
3748 Old Linux kernels (2.4 and earlier) used a compressed ext2
3749 filesystem as initrd. We I<only> support the newer initramfs
3750 format (compressed cpio files).");
3752 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3754 "mount a file using the loop device",
3756 This command lets you mount C<file> (a filesystem image
3757 in a file) on a mount point. It is entirely equivalent to
3758 the command C<mount -o loop file mountpoint>.");
3760 ("mkswap", (RErr, [Device "device"], []), 130, [],
3761 [InitEmpty, Always, TestRun (
3762 [["part_disk"; "/dev/sda"; "mbr"];
3763 ["mkswap"; "/dev/sda1"]])],
3764 "create a swap partition",
3766 Create a swap partition on C<device>.");
3768 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3769 [InitEmpty, Always, TestRun (
3770 [["part_disk"; "/dev/sda"; "mbr"];
3771 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3772 "create a swap partition with a label",
3774 Create a swap partition on C<device> with label C<label>.
3776 Note that you cannot attach a swap label to a block device
3777 (eg. C</dev/sda>), just to a partition. This appears to be
3778 a limitation of the kernel or swap tools.");
3780 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3781 (let uuid = uuidgen () in
3782 [InitEmpty, Always, TestRun (
3783 [["part_disk"; "/dev/sda"; "mbr"];
3784 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3785 "create a swap partition with an explicit UUID",
3787 Create a swap partition on C<device> with UUID C<uuid>.");
3789 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3790 [InitScratchFS, Always, TestOutputStruct (
3791 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3792 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3793 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3794 InitScratchFS, Always, TestOutputStruct (
3795 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3796 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3797 "make block, character or FIFO devices",
3799 This call creates block or character special devices, or
3800 named pipes (FIFOs).
3802 The C<mode> parameter should be the mode, using the standard
3803 constants. C<devmajor> and C<devminor> are the
3804 device major and minor numbers, only used when creating block
3805 and character special devices.
3807 Note that, just like L<mknod(2)>, the mode must be bitwise
3808 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3809 just creates a regular file). These constants are
3810 available in the standard Linux header files, or you can use
3811 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3812 which are wrappers around this command which bitwise OR
3813 in the appropriate constant for you.
3815 The mode actually set is affected by the umask.");
3817 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3818 [InitScratchFS, Always, TestOutputStruct (
3819 [["mkfifo"; "0o777"; "/mkfifo"];
3820 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3821 "make FIFO (named pipe)",
3823 This call creates a FIFO (named pipe) called C<path> with
3824 mode C<mode>. It is just a convenient wrapper around
3827 The mode actually set is affected by the umask.");
3829 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3830 [InitScratchFS, Always, TestOutputStruct (
3831 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3832 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3833 "make block device node",
3835 This call creates a block device node called C<path> with
3836 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3837 It is just a convenient wrapper around C<guestfs_mknod>.
3839 The mode actually set is affected by the umask.");
3841 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3842 [InitScratchFS, Always, TestOutputStruct (
3843 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3844 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3845 "make char device node",
3847 This call creates a char device node called C<path> with
3848 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3849 It is just a convenient wrapper around C<guestfs_mknod>.
3851 The mode actually set is affected by the umask.");
3853 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3854 [InitEmpty, Always, TestOutputInt (
3855 [["umask"; "0o22"]], 0o22)],
3856 "set file mode creation mask (umask)",
3858 This function sets the mask used for creating new files and
3859 device nodes to C<mask & 0777>.
3861 Typical umask values would be C<022> which creates new files
3862 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3863 C<002> which creates new files with permissions like
3864 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3866 The default umask is C<022>. This is important because it
3867 means that directories and device nodes will be created with
3868 C<0644> or C<0755> mode even if you specify C<0777>.
3870 See also C<guestfs_get_umask>,
3871 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3873 This call returns the previous umask.");
3875 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3877 "read directories entries",
3879 This returns the list of directory entries in directory C<dir>.
3881 All entries in the directory are returned, including C<.> and
3882 C<..>. The entries are I<not> sorted, but returned in the same
3883 order as the underlying filesystem.
3885 Also this call returns basic file type information about each
3886 file. The C<ftyp> field will contain one of the following characters:
3924 The L<readdir(3)> call returned a C<d_type> field with an
3929 This function is primarily intended for use by programs. To
3930 get a simple list of names, use C<guestfs_ls>. To get a printable
3931 directory for human consumption, use C<guestfs_ll>.");
3933 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3935 "create partitions on a block device",
3937 This is a simplified interface to the C<guestfs_sfdisk>
3938 command, where partition sizes are specified in megabytes
3939 only (rounded to the nearest cylinder) and you don't need
3940 to specify the cyls, heads and sectors parameters which
3941 were rarely if ever used anyway.
3943 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3944 and C<guestfs_part_disk>");
3946 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3948 "determine file type inside a compressed file",
3950 This command runs C<file> after first decompressing C<path>
3953 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3955 Since 1.0.63, use C<guestfs_file> instead which can now
3956 process compressed files.");
3958 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3960 "list extended attributes of a file or directory",
3962 This call lists the extended attributes of the file or directory
3965 At the system call level, this is a combination of the
3966 L<listxattr(2)> and L<getxattr(2)> calls.
3968 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3970 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3972 "list extended attributes of a file or directory",
3974 This is the same as C<guestfs_getxattrs>, but if C<path>
3975 is a symbolic link, then it returns the extended attributes
3976 of the link itself.");
3978 ("setxattr", (RErr, [String "xattr";
3979 String "val"; Int "vallen"; (* will be BufferIn *)
3980 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3982 "set extended attribute of a file or directory",
3984 This call sets the extended attribute named C<xattr>
3985 of the file C<path> to the value C<val> (of length C<vallen>).
3986 The value is arbitrary 8 bit data.
3988 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3990 ("lsetxattr", (RErr, [String "xattr";
3991 String "val"; Int "vallen"; (* will be BufferIn *)
3992 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3994 "set extended attribute of a file or directory",
3996 This is the same as C<guestfs_setxattr>, but if C<path>
3997 is a symbolic link, then it sets an extended attribute
3998 of the link itself.");
4000 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
4002 "remove extended attribute of a file or directory",
4004 This call removes the extended attribute named C<xattr>
4005 of the file C<path>.
4007 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
4009 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
4011 "remove extended attribute of a file or directory",
4013 This is the same as C<guestfs_removexattr>, but if C<path>
4014 is a symbolic link, then it removes an extended attribute
4015 of the link itself.");
4017 ("mountpoints", (RHashtable "mps", [], []), 147, [],
4021 This call is similar to C<guestfs_mounts>. That call returns
4022 a list of devices. This one returns a hash table (map) of
4023 device name to directory where the device is mounted.");
4025 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
4026 (* This is a special case: while you would expect a parameter
4027 * of type "Pathname", that doesn't work, because it implies
4028 * NEED_ROOT in the generated calling code in stubs.c, and
4029 * this function cannot use NEED_ROOT.
4032 "create a mountpoint",
4034 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
4035 specialized calls that can be used to create extra mountpoints
4036 before mounting the first filesystem.
4038 These calls are I<only> necessary in some very limited circumstances,
4039 mainly the case where you want to mount a mix of unrelated and/or
4040 read-only filesystems together.
4042 For example, live CDs often contain a \"Russian doll\" nest of
4043 filesystems, an ISO outer layer, with a squashfs image inside, with
4044 an ext2/3 image inside that. You can unpack this as follows
4047 add-ro Fedora-11-i686-Live.iso
4051 mkmountpoint /ext3fs
4053 mount-loop /cd/LiveOS/squashfs.img /sqsh
4054 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4056 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4058 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4059 You may get unexpected errors if you try to mix these calls. It is
4060 safest to manually unmount filesystems and remove mountpoints after use.
4062 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4063 longest first, so for this to work for manual mountpoints, you
4064 must ensure that the innermost mountpoints have the longest
4065 pathnames, as in the example code above.
4067 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4069 Autosync [see C<guestfs_set_autosync>, this is set by default on
4070 handles] can cause C<guestfs_umount_all> to be called when the handle
4071 is closed which can also trigger these issues.");
4073 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4075 "remove a mountpoint",
4077 This calls removes a mountpoint that was previously created
4078 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4079 for full details.");
4081 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4082 [InitISOFS, Always, TestOutputBuffer (
4083 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4084 (* Test various near large, large and too large files (RHBZ#589039). *)
4085 InitScratchFS, Always, TestLastFail (
4086 [["touch"; "/read_file"];
4087 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4088 ["read_file"; "/read_file"]]);
4089 InitScratchFS, Always, TestLastFail (
4090 [["touch"; "/read_file2"];
4091 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4092 ["read_file"; "/read_file2"]]);
4093 InitScratchFS, Always, TestLastFail (
4094 [["touch"; "/read_file3"];
4095 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4096 ["read_file"; "/read_file3"]])],
4099 This calls returns the contents of the file C<path> as a
4102 Unlike C<guestfs_cat>, this function can correctly
4103 handle files that contain embedded ASCII NUL characters.
4104 However unlike C<guestfs_download>, this function is limited
4105 in the total size of file that can be handled.");
4107 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4108 [InitISOFS, Always, TestOutputList (
4109 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4110 InitISOFS, Always, TestOutputList (
4111 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4112 (* Test for RHBZ#579608, absolute symbolic links. *)
4113 InitISOFS, Always, TestOutputList (
4114 [["grep"; "nomatch"; "/abssymlink"]], [])],
4115 "return lines matching a pattern",
4117 This calls the external C<grep> program and returns the
4120 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4121 [InitISOFS, Always, TestOutputList (
4122 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4123 "return lines matching a pattern",
4125 This calls the external C<egrep> program and returns the
4128 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4129 [InitISOFS, Always, TestOutputList (
4130 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4131 "return lines matching a pattern",
4133 This calls the external C<fgrep> program and returns the
4136 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4137 [InitISOFS, Always, TestOutputList (
4138 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4139 "return lines matching a pattern",
4141 This calls the external C<grep -i> program and returns the
4144 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4145 [InitISOFS, Always, TestOutputList (
4146 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4147 "return lines matching a pattern",
4149 This calls the external C<egrep -i> program and returns the
4152 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4153 [InitISOFS, Always, TestOutputList (
4154 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4155 "return lines matching a pattern",
4157 This calls the external C<fgrep -i> program and returns the
4160 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4161 [InitISOFS, Always, TestOutputList (
4162 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4163 "return lines matching a pattern",
4165 This calls the external C<zgrep> program and returns the
4168 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4169 [InitISOFS, Always, TestOutputList (
4170 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4171 "return lines matching a pattern",
4173 This calls the external C<zegrep> program and returns the
4176 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4177 [InitISOFS, Always, TestOutputList (
4178 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4179 "return lines matching a pattern",
4181 This calls the external C<zfgrep> program and returns the
4184 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4185 [InitISOFS, Always, TestOutputList (
4186 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4187 "return lines matching a pattern",
4189 This calls the external C<zgrep -i> program and returns the
4192 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4193 [InitISOFS, Always, TestOutputList (
4194 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4195 "return lines matching a pattern",
4197 This calls the external C<zegrep -i> program and returns the
4200 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4201 [InitISOFS, Always, TestOutputList (
4202 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4203 "return lines matching a pattern",
4205 This calls the external C<zfgrep -i> program and returns the
4208 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4209 [InitISOFS, Always, TestOutput (
4210 [["realpath"; "/../directory"]], "/directory")],
4211 "canonicalized absolute pathname",
4213 Return the canonicalized absolute pathname of C<path>. The
4214 returned path has no C<.>, C<..> or symbolic link path elements.");
4216 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4217 [InitScratchFS, Always, TestOutputStruct (
4220 ["ln"; "/ln/a"; "/ln/b"];
4221 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4222 "create a hard link",
4224 This command creates a hard link using the C<ln> command.");
4226 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4227 [InitScratchFS, Always, TestOutputStruct (
4228 [["mkdir"; "/ln_f"];
4229 ["touch"; "/ln_f/a"];
4230 ["touch"; "/ln_f/b"];
4231 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4232 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4233 "create a hard link",
4235 This command creates a hard link using the C<ln -f> command.
4236 The I<-f> option removes the link (C<linkname>) if it exists already.");
4238 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4239 [InitScratchFS, Always, TestOutputStruct (
4240 [["mkdir"; "/ln_s"];
4241 ["touch"; "/ln_s/a"];
4242 ["ln_s"; "a"; "/ln_s/b"];
4243 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4244 "create a symbolic link",
4246 This command creates a symbolic link using the C<ln -s> command.");
4248 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4249 [InitScratchFS, Always, TestOutput (
4250 [["mkdir_p"; "/ln_sf/b"];
4251 ["touch"; "/ln_sf/b/c"];
4252 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4253 ["readlink"; "/ln_sf/b/c"]], "../d")],
4254 "create a symbolic link",
4256 This command creates a symbolic link using the C<ln -sf> command,
4257 The I<-f> option removes the link (C<linkname>) if it exists already.");
4259 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4260 [] (* XXX tested above *),
4261 "read the target of a symbolic link",
4263 This command reads the target of a symbolic link.");
4265 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4266 [InitScratchFS, Always, TestOutputStruct (
4267 [["fallocate"; "/fallocate"; "1000000"];
4268 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4269 "preallocate a file in the guest filesystem",
4271 This command preallocates a file (containing zero bytes) named
4272 C<path> of size C<len> bytes. If the file exists already, it
4275 Do not confuse this with the guestfish-specific
4276 C<alloc> command which allocates a file in the host and
4277 attaches it as a device.");
4279 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4280 [InitPartition, Always, TestRun (
4281 [["mkswap"; "/dev/sda1"];
4282 ["swapon_device"; "/dev/sda1"];
4283 ["swapoff_device"; "/dev/sda1"]])],
4284 "enable swap on device",
4286 This command enables the libguestfs appliance to use the
4287 swap device or partition named C<device>. The increased
4288 memory is made available for all commands, for example
4289 those run using C<guestfs_command> or C<guestfs_sh>.
4291 Note that you should not swap to existing guest swap
4292 partitions unless you know what you are doing. They may
4293 contain hibernation information, or other information that
4294 the guest doesn't want you to trash. You also risk leaking
4295 information about the host to the guest this way. Instead,
4296 attach a new host device to the guest and swap on that.");
4298 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4299 [], (* XXX tested by swapon_device *)
4300 "disable swap on device",
4302 This command disables the libguestfs appliance swap
4303 device or partition named C<device>.
4304 See C<guestfs_swapon_device>.");
4306 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4307 [InitScratchFS, Always, TestRun (
4308 [["fallocate"; "/swapon_file"; "8388608"];
4309 ["mkswap_file"; "/swapon_file"];
4310 ["swapon_file"; "/swapon_file"];
4311 ["swapoff_file"; "/swapon_file"];
4312 ["rm"; "/swapon_file"]])],
4313 "enable swap on file",
4315 This command enables swap to a file.
4316 See C<guestfs_swapon_device> for other notes.");
4318 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4319 [], (* XXX tested by swapon_file *)
4320 "disable swap on file",
4322 This command disables the libguestfs appliance swap on file.");
4324 ("swapon_label", (RErr, [String "label"], []), 174, [],
4325 [InitEmpty, Always, TestRun (
4326 [["part_disk"; "/dev/sda"; "mbr"];
4327 ["mkswap_L"; "swapit"; "/dev/sda1"];
4328 ["swapon_label"; "swapit"];
4329 ["swapoff_label"; "swapit"];
4330 ["zero"; "/dev/sda"];
4331 ["blockdev_rereadpt"; "/dev/sda"]])],
4332 "enable swap on labeled swap partition",
4334 This command enables swap to a labeled swap partition.
4335 See C<guestfs_swapon_device> for other notes.");
4337 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4338 [], (* XXX tested by swapon_label *)
4339 "disable swap on labeled swap partition",
4341 This command disables the libguestfs appliance swap on
4342 labeled swap partition.");
4344 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4345 (let uuid = uuidgen () in
4346 [InitEmpty, Always, TestRun (
4347 [["mkswap_U"; uuid; "/dev/sdc"];
4348 ["swapon_uuid"; uuid];
4349 ["swapoff_uuid"; uuid]])]),
4350 "enable swap on swap partition by UUID",
4352 This command enables swap to a swap partition with the given UUID.
4353 See C<guestfs_swapon_device> for other notes.");
4355 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4356 [], (* XXX tested by swapon_uuid *)
4357 "disable swap on swap partition by UUID",
4359 This command disables the libguestfs appliance swap partition
4360 with the given UUID.");
4362 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4363 [InitScratchFS, Always, TestRun (
4364 [["fallocate"; "/mkswap_file"; "8388608"];
4365 ["mkswap_file"; "/mkswap_file"];
4366 ["rm"; "/mkswap_file"]])],
4367 "create a swap file",
4371 This command just writes a swap file signature to an existing
4372 file. To create the file itself, use something like C<guestfs_fallocate>.");
4374 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4375 [InitISOFS, Always, TestRun (
4376 [["inotify_init"; "0"]])],
4377 "create an inotify handle",
4379 This command creates a new inotify handle.
4380 The inotify subsystem can be used to notify events which happen to
4381 objects in the guest filesystem.
4383 C<maxevents> is the maximum number of events which will be
4384 queued up between calls to C<guestfs_inotify_read> or
4385 C<guestfs_inotify_files>.
4386 If this is passed as C<0>, then the kernel (or previously set)
4387 default is used. For Linux 2.6.29 the default was 16384 events.
4388 Beyond this limit, the kernel throws away events, but records
4389 the fact that it threw them away by setting a flag
4390 C<IN_Q_OVERFLOW> in the returned structure list (see
4391 C<guestfs_inotify_read>).
4393 Before any events are generated, you have to add some
4394 watches to the internal watch list. See:
4395 C<guestfs_inotify_add_watch>,
4396 C<guestfs_inotify_rm_watch> and
4397 C<guestfs_inotify_watch_all>.
4399 Queued up events should be read periodically by calling
4400 C<guestfs_inotify_read>
4401 (or C<guestfs_inotify_files> which is just a helpful
4402 wrapper around C<guestfs_inotify_read>). If you don't
4403 read the events out often enough then you risk the internal
4406 The handle should be closed after use by calling
4407 C<guestfs_inotify_close>. This also removes any
4408 watches automatically.
4410 See also L<inotify(7)> for an overview of the inotify interface
4411 as exposed by the Linux kernel, which is roughly what we expose
4412 via libguestfs. Note that there is one global inotify handle
4413 per libguestfs instance.");
4415 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4416 [InitScratchFS, Always, TestOutputList (
4417 [["mkdir"; "/inotify_add_watch"];
4418 ["inotify_init"; "0"];
4419 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4420 ["touch"; "/inotify_add_watch/a"];
4421 ["touch"; "/inotify_add_watch/b"];
4422 ["inotify_files"]], ["a"; "b"])],
4423 "add an inotify watch",
4425 Watch C<path> for the events listed in C<mask>.
4427 Note that if C<path> is a directory then events within that
4428 directory are watched, but this does I<not> happen recursively
4429 (in subdirectories).
4431 Note for non-C or non-Linux callers: the inotify events are
4432 defined by the Linux kernel ABI and are listed in
4433 C</usr/include/sys/inotify.h>.");
4435 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4437 "remove an inotify watch",
4439 Remove a previously defined inotify watch.
4440 See C<guestfs_inotify_add_watch>.");
4442 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4444 "return list of inotify events",
4446 Return the complete queue of events that have happened
4447 since the previous read call.
4449 If no events have happened, this returns an empty list.
4451 I<Note>: In order to make sure that all events have been
4452 read, you must call this function repeatedly until it
4453 returns an empty list. The reason is that the call will
4454 read events up to the maximum appliance-to-host message
4455 size and leave remaining events in the queue.");
4457 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4459 "return list of watched files that had events",
4461 This function is a helpful wrapper around C<guestfs_inotify_read>
4462 which just returns a list of pathnames of objects that were
4463 touched. The returned pathnames are sorted and deduplicated.");
4465 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4467 "close the inotify handle",
4469 This closes the inotify handle which was previously
4470 opened by inotify_init. It removes all watches, throws
4471 away any pending events, and deallocates all resources.");
4473 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4475 "set SELinux security context",
4477 This sets the SELinux security context of the daemon
4478 to the string C<context>.
4480 See the documentation about SELINUX in L<guestfs(3)>.");
4482 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4484 "get SELinux security context",
4486 This gets the SELinux security context of the daemon.
4488 See the documentation about SELINUX in L<guestfs(3)>,
4489 and C<guestfs_setcon>");
4491 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4492 [InitEmpty, Always, TestOutput (
4493 [["part_disk"; "/dev/sda"; "mbr"];
4494 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4495 ["mount_options"; ""; "/dev/sda1"; "/"];
4496 ["write"; "/new"; "new file contents"];
4497 ["cat"; "/new"]], "new file contents");
4498 InitEmpty, Always, TestRun (
4499 [["part_disk"; "/dev/sda"; "mbr"];
4500 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4501 InitEmpty, Always, TestLastFail (
4502 [["part_disk"; "/dev/sda"; "mbr"];
4503 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4504 InitEmpty, Always, TestLastFail (
4505 [["part_disk"; "/dev/sda"; "mbr"];
4506 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4507 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4508 [["part_disk"; "/dev/sda"; "mbr"];
4509 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4510 "make a filesystem with block size",
4512 This call is similar to C<guestfs_mkfs>, but it allows you to
4513 control the block size of the resulting filesystem. Supported
4514 block sizes depend on the filesystem type, but typically they
4515 are C<1024>, C<2048> or C<4096> only.
4517 For VFAT and NTFS the C<blocksize> parameter is treated as
4518 the requested cluster size.");
4520 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4521 [InitEmpty, Always, TestOutput (
4522 [["part_init"; "/dev/sda"; "mbr"];
4523 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4524 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4525 ["mke2journal"; "4096"; "/dev/sda1"];
4526 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4527 ["mount_options"; ""; "/dev/sda2"; "/"];
4528 ["write"; "/new"; "new file contents"];
4529 ["cat"; "/new"]], "new file contents")],
4530 "make ext2/3/4 external journal",
4532 This creates an ext2 external journal on C<device>. It is equivalent
4535 mke2fs -O journal_dev -b blocksize device");
4537 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4538 [InitEmpty, Always, TestOutput (
4539 [["part_init"; "/dev/sda"; "mbr"];
4540 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4541 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4542 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4543 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4544 ["mount_options"; ""; "/dev/sda2"; "/"];
4545 ["write"; "/new"; "new file contents"];
4546 ["cat"; "/new"]], "new file contents")],
4547 "make ext2/3/4 external journal with label",
4549 This creates an ext2 external journal on C<device> with label C<label>.");
4551 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4552 (let uuid = uuidgen () in
4553 [InitEmpty, Always, TestOutput (
4554 [["part_init"; "/dev/sda"; "mbr"];
4555 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4556 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4557 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4558 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4559 ["mount_options"; ""; "/dev/sda2"; "/"];
4560 ["write"; "/new"; "new file contents"];
4561 ["cat"; "/new"]], "new file contents")]),
4562 "make ext2/3/4 external journal with UUID",
4564 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4566 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4568 "make ext2/3/4 filesystem with external journal",
4570 This creates an ext2/3/4 filesystem on C<device> with
4571 an external journal on C<journal>. It is equivalent
4574 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4576 See also C<guestfs_mke2journal>.");
4578 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4580 "make ext2/3/4 filesystem with external journal",
4582 This creates an ext2/3/4 filesystem on C<device> with
4583 an external journal on the journal labeled C<label>.
4585 See also C<guestfs_mke2journal_L>.");
4587 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4589 "make ext2/3/4 filesystem with external journal",
4591 This creates an ext2/3/4 filesystem on C<device> with
4592 an external journal on the journal with UUID C<uuid>.
4594 See also C<guestfs_mke2journal_U>.");
4596 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4597 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4598 "load a kernel module",
4600 This loads a kernel module in the appliance.
4602 The kernel module must have been whitelisted when libguestfs
4603 was built (see C<appliance/kmod.whitelist.in> in the source).");
4605 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4606 [InitNone, Always, TestOutput (
4607 [["echo_daemon"; "This is a test"]], "This is a test"
4609 "echo arguments back to the client",
4611 This command concatenates the list of C<words> passed with single spaces
4612 between them and returns the resulting string.
4614 You can use this command to test the connection through to the daemon.
4616 See also C<guestfs_ping_daemon>.");
4618 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4619 [], (* There is a regression test for this. *)
4620 "find all files and directories, returning NUL-separated list",
4622 This command lists out all files and directories, recursively,
4623 starting at C<directory>, placing the resulting list in the
4624 external file called C<files>.
4626 This command works the same way as C<guestfs_find> with the
4627 following exceptions:
4633 The resulting list is written to an external file.
4637 Items (filenames) in the result are separated
4638 by C<\\0> characters. See L<find(1)> option I<-print0>.
4642 This command is not limited in the number of names that it
4647 The result list is not sorted.
4651 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4652 [InitISOFS, Always, TestOutput (
4653 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4654 InitISOFS, Always, TestOutput (
4655 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4656 InitISOFS, Always, TestOutput (
4657 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4658 InitISOFS, Always, TestLastFail (
4659 [["case_sensitive_path"; "/Known-1/"]]);
4660 InitScratchFS, Always, TestOutput (
4661 [["mkdir"; "/case_sensitive_path"];
4662 ["mkdir"; "/case_sensitive_path/bbb"];
4663 ["touch"; "/case_sensitive_path/bbb/c"];
4664 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4665 InitScratchFS, Always, TestOutput (
4666 [["mkdir"; "/case_sensitive_path2"];
4667 ["mkdir"; "/case_sensitive_path2/bbb"];
4668 ["touch"; "/case_sensitive_path2/bbb/c"];
4669 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4670 InitScratchFS, Always, TestLastFail (
4671 [["mkdir"; "/case_sensitive_path3"];
4672 ["mkdir"; "/case_sensitive_path3/bbb"];
4673 ["touch"; "/case_sensitive_path3/bbb/c"];
4674 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4675 "return true path on case-insensitive filesystem",
4677 This can be used to resolve case insensitive paths on
4678 a filesystem which is case sensitive. The use case is
4679 to resolve paths which you have read from Windows configuration
4680 files or the Windows Registry, to the true path.
4682 The command handles a peculiarity of the Linux ntfs-3g
4683 filesystem driver (and probably others), which is that although
4684 the underlying filesystem is case-insensitive, the driver
4685 exports the filesystem to Linux as case-sensitive.
4687 One consequence of this is that special directories such
4688 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4689 (or other things) depending on the precise details of how
4690 they were created. In Windows itself this would not be
4693 Bug or feature? You decide:
4694 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4696 This function resolves the true case of each element in the
4697 path and returns the case-sensitive path.
4699 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4700 might return C<\"/WINDOWS/system32\"> (the exact return value
4701 would depend on details of how the directories were originally
4702 created under Windows).
4705 This function does not handle drive names, backslashes etc.
4707 See also C<guestfs_realpath>.");
4709 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4710 [InitScratchFS, Always, TestOutput (
4711 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4712 "get the Linux VFS type corresponding to a mounted device",
4714 This command gets the filesystem type corresponding to
4715 the filesystem on C<device>.
4717 For most filesystems, the result is the name of the Linux
4718 VFS module which would be used to mount this filesystem
4719 if you mounted it without specifying the filesystem type.
4720 For example a string such as C<ext3> or C<ntfs>.");
4722 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4723 [InitScratchFS, Always, TestOutputStruct (
4724 [["write"; "/truncate"; "some stuff so size is not zero"];
4725 ["truncate"; "/truncate"];
4726 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4727 "truncate a file to zero size",
4729 This command truncates C<path> to a zero-length file. The
4730 file must exist already.");
4732 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4733 [InitScratchFS, Always, TestOutputStruct (
4734 [["touch"; "/truncate_size"];
4735 ["truncate_size"; "/truncate_size"; "1000"];
4736 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4737 "truncate a file to a particular size",
4739 This command truncates C<path> to size C<size> bytes. The file
4742 If the current file size is less than C<size> then
4743 the file is extended to the required size with zero bytes.
4744 This creates a sparse file (ie. disk blocks are not allocated
4745 for the file until you write to it). To create a non-sparse
4746 file of zeroes, use C<guestfs_fallocate64> instead.");
4748 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4749 [InitScratchFS, Always, TestOutputStruct (
4750 [["touch"; "/utimens"];
4751 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4752 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4753 "set timestamp of a file with nanosecond precision",
4755 This command sets the timestamps of a file with nanosecond
4758 C<atsecs, atnsecs> are the last access time (atime) in secs and
4759 nanoseconds from the epoch.
4761 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4762 secs and nanoseconds from the epoch.
4764 If the C<*nsecs> field contains the special value C<-1> then
4765 the corresponding timestamp is set to the current time. (The
4766 C<*secs> field is ignored in this case).
4768 If the C<*nsecs> field contains the special value C<-2> then
4769 the corresponding timestamp is left unchanged. (The
4770 C<*secs> field is ignored in this case).");
4772 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4773 [InitScratchFS, Always, TestOutputStruct (
4774 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4775 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4776 "create a directory with a particular mode",
4778 This command creates a directory, setting the initial permissions
4779 of the directory to C<mode>.
4781 For common Linux filesystems, the actual mode which is set will
4782 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4783 interpret the mode in other ways.
4785 See also C<guestfs_mkdir>, C<guestfs_umask>");
4787 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4789 "change file owner and group",
4791 Change the file owner to C<owner> and group to C<group>.
4792 This is like C<guestfs_chown> but if C<path> is a symlink then
4793 the link itself is changed, not the target.
4795 Only numeric uid and gid are supported. If you want to use
4796 names, you will need to locate and parse the password file
4797 yourself (Augeas support makes this relatively easy).");
4799 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4801 "lstat on multiple files",
4803 This call allows you to perform the C<guestfs_lstat> operation
4804 on multiple files, where all files are in the directory C<path>.
4805 C<names> is the list of files from this directory.
4807 On return you get a list of stat structs, with a one-to-one
4808 correspondence to the C<names> list. If any name did not exist
4809 or could not be lstat'd, then the C<ino> field of that structure
4812 This call is intended for programs that want to efficiently
4813 list a directory contents without making many round-trips.
4814 See also C<guestfs_lxattrlist> for a similarly efficient call
4815 for getting extended attributes. Very long directory listings
4816 might cause the protocol message size to be exceeded, causing
4817 this call to fail. The caller must split up such requests
4818 into smaller groups of names.");
4820 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4822 "lgetxattr on multiple files",
4824 This call allows you to get the extended attributes
4825 of multiple files, where all files are in the directory C<path>.
4826 C<names> is the list of files from this directory.
4828 On return you get a flat list of xattr structs which must be
4829 interpreted sequentially. The first xattr struct always has a zero-length
4830 C<attrname>. C<attrval> in this struct is zero-length
4831 to indicate there was an error doing C<lgetxattr> for this
4832 file, I<or> is a C string which is a decimal number
4833 (the number of following attributes for this file, which could
4834 be C<\"0\">). Then after the first xattr struct are the
4835 zero or more attributes for the first named file.
4836 This repeats for the second and subsequent files.
4838 This call is intended for programs that want to efficiently
4839 list a directory contents without making many round-trips.
4840 See also C<guestfs_lstatlist> for a similarly efficient call
4841 for getting standard stats. Very long directory listings
4842 might cause the protocol message size to be exceeded, causing
4843 this call to fail. The caller must split up such requests
4844 into smaller groups of names.");
4846 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4848 "readlink on multiple files",
4850 This call allows you to do a C<readlink> operation
4851 on multiple files, where all files are in the directory C<path>.
4852 C<names> is the list of files from this directory.
4854 On return you get a list of strings, with a one-to-one
4855 correspondence to the C<names> list. Each string is the
4856 value of the symbolic link.
4858 If the C<readlink(2)> operation fails on any name, then
4859 the corresponding result string is the empty string C<\"\">.
4860 However the whole operation is completed even if there
4861 were C<readlink(2)> errors, and so you can call this
4862 function with names where you don't know if they are
4863 symbolic links already (albeit slightly less efficient).
4865 This call is intended for programs that want to efficiently
4866 list a directory contents without making many round-trips.
4867 Very long directory listings might cause the protocol
4868 message size to be exceeded, causing
4869 this call to fail. The caller must split up such requests
4870 into smaller groups of names.");
4872 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4873 [InitISOFS, Always, TestOutputBuffer (
4874 [["pread"; "/known-4"; "1"; "3"]], "\n");
4875 InitISOFS, Always, TestOutputBuffer (
4876 [["pread"; "/empty"; "0"; "100"]], "")],
4877 "read part of a file",
4879 This command lets you read part of a file. It reads C<count>
4880 bytes of the file, starting at C<offset>, from file C<path>.
4882 This may read fewer bytes than requested. For further details
4883 see the L<pread(2)> system call.
4885 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4887 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4888 [InitEmpty, Always, TestRun (
4889 [["part_init"; "/dev/sda"; "gpt"]])],
4890 "create an empty partition table",
4892 This creates an empty partition table on C<device> of one of the
4893 partition types listed below. Usually C<parttype> should be
4894 either C<msdos> or C<gpt> (for large disks).
4896 Initially there are no partitions. Following this, you should
4897 call C<guestfs_part_add> for each partition required.
4899 Possible values for C<parttype> are:
4907 Intel EFI / GPT partition table.
4909 This is recommended for >= 2 TB partitions that will be accessed
4910 from Linux and Intel-based Mac OS X. It also has limited backwards
4911 compatibility with the C<mbr> format.
4917 The standard PC \"Master Boot Record\" (MBR) format used
4918 by MS-DOS and Windows. This partition type will B<only> work
4919 for device sizes up to 2 TB. For large disks we recommend
4924 Other partition table types that may work but are not
4937 Amiga \"Rigid Disk Block\" format.
4945 DASD, used on IBM mainframes.
4953 Old Mac partition format. Modern Macs use C<gpt>.
4957 NEC PC-98 format, common in Japan apparently.
4965 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4966 [InitEmpty, Always, TestRun (
4967 [["part_init"; "/dev/sda"; "mbr"];
4968 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4969 InitEmpty, Always, TestRun (
4970 [["part_init"; "/dev/sda"; "gpt"];
4971 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4972 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4973 InitEmpty, Always, TestRun (
4974 [["part_init"; "/dev/sda"; "mbr"];
4975 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4976 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4977 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4978 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4979 "add a partition to the device",
4981 This command adds a partition to C<device>. If there is no partition
4982 table on the device, call C<guestfs_part_init> first.
4984 The C<prlogex> parameter is the type of partition. Normally you
4985 should pass C<p> or C<primary> here, but MBR partition tables also
4986 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4989 C<startsect> and C<endsect> are the start and end of the partition
4990 in I<sectors>. C<endsect> may be negative, which means it counts
4991 backwards from the end of the disk (C<-1> is the last sector).
4993 Creating a partition which covers the whole disk is not so easy.
4994 Use C<guestfs_part_disk> to do that.");
4996 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4997 [InitEmpty, Always, TestRun (
4998 [["part_disk"; "/dev/sda"; "mbr"]]);
4999 InitEmpty, Always, TestRun (
5000 [["part_disk"; "/dev/sda"; "gpt"]])],
5001 "partition whole disk with a single primary partition",
5003 This command is simply a combination of C<guestfs_part_init>
5004 followed by C<guestfs_part_add> to create a single primary partition
5005 covering the whole disk.
5007 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
5008 but other possible values are described in C<guestfs_part_init>.");
5010 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
5011 [InitEmpty, Always, TestRun (
5012 [["part_disk"; "/dev/sda"; "mbr"];
5013 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
5014 "make a partition bootable",
5016 This sets the bootable flag on partition numbered C<partnum> on
5017 device C<device>. Note that partitions are numbered from 1.
5019 The bootable flag is used by some operating systems (notably
5020 Windows) to determine which partition to boot from. It is by
5021 no means universally recognized.");
5023 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
5024 [InitEmpty, Always, TestRun (
5025 [["part_disk"; "/dev/sda"; "gpt"];
5026 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
5027 "set partition name",
5029 This sets the partition name on partition numbered C<partnum> on
5030 device C<device>. Note that partitions are numbered from 1.
5032 The partition name can only be set on certain types of partition
5033 table. This works on C<gpt> but not on C<mbr> partitions.");
5035 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
5036 [], (* XXX Add a regression test for this. *)
5037 "list partitions on a device",
5039 This command parses the partition table on C<device> and
5040 returns the list of partitions found.
5042 The fields in the returned structure are:
5048 Partition number, counting from 1.
5052 Start of the partition I<in bytes>. To get sectors you have to
5053 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5057 End of the partition in bytes.
5061 Size of the partition in bytes.
5065 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5066 [InitEmpty, Always, TestOutput (
5067 [["part_disk"; "/dev/sda"; "gpt"];
5068 ["part_get_parttype"; "/dev/sda"]], "gpt")],
5069 "get the partition table type",
5071 This command examines the partition table on C<device> and
5072 returns the partition table type (format) being used.
5074 Common return values include: C<msdos> (a DOS/Windows style MBR
5075 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5076 values are possible, although unusual. See C<guestfs_part_init>
5079 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5080 [InitScratchFS, Always, TestOutputBuffer (
5081 [["fill"; "0x63"; "10"; "/fill"];
5082 ["read_file"; "/fill"]], "cccccccccc")],
5083 "fill a file with octets",
5085 This command creates a new file called C<path>. The initial
5086 content of the file is C<len> octets of C<c>, where C<c>
5087 must be a number in the range C<[0..255]>.
5089 To fill a file with zero bytes (sparsely), it is
5090 much more efficient to use C<guestfs_truncate_size>.
5091 To create a file with a pattern of repeating bytes
5092 use C<guestfs_fill_pattern>.");
5094 ("available", (RErr, [StringList "groups"], []), 216, [],
5095 [InitNone, Always, TestRun [["available"; ""]]],
5096 "test availability of some parts of the API",
5098 This command is used to check the availability of some
5099 groups of functionality in the appliance, which not all builds of
5100 the libguestfs appliance will be able to provide.
5102 The libguestfs groups, and the functions that those
5103 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5104 You can also fetch this list at runtime by calling
5105 C<guestfs_available_all_groups>.
5107 The argument C<groups> is a list of group names, eg:
5108 C<[\"inotify\", \"augeas\"]> would check for the availability of
5109 the Linux inotify functions and Augeas (configuration file
5112 The command returns no error if I<all> requested groups are available.
5114 It fails with an error if one or more of the requested
5115 groups is unavailable in the appliance.
5117 If an unknown group name is included in the
5118 list of groups then an error is always returned.
5126 You must call C<guestfs_launch> before calling this function.
5128 The reason is because we don't know what groups are
5129 supported by the appliance/daemon until it is running and can
5134 If a group of functions is available, this does not necessarily
5135 mean that they will work. You still have to check for errors
5136 when calling individual API functions even if they are
5141 It is usually the job of distro packagers to build
5142 complete functionality into the libguestfs appliance.
5143 Upstream libguestfs, if built from source with all
5144 requirements satisfied, will support everything.
5148 This call was added in version C<1.0.80>. In previous
5149 versions of libguestfs all you could do would be to speculatively
5150 execute a command to find out if the daemon implemented it.
5151 See also C<guestfs_version>.
5155 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5156 [InitScratchFS, Always, TestOutputBuffer (
5158 ["write"; "/dd/src"; "hello, world"];
5159 ["dd"; "/dd/src"; "/dd/dest"];
5160 ["read_file"; "/dd/dest"]], "hello, world")],
5161 "copy from source to destination using dd",
5163 This command copies from one source device or file C<src>
5164 to another destination device or file C<dest>. Normally you
5165 would use this to copy to or from a device or partition, for
5166 example to duplicate a filesystem.
5168 If the destination is a device, it must be as large or larger
5169 than the source file or device, otherwise the copy will fail.
5170 This command cannot do partial copies (see C<guestfs_copy_size>).");
5172 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5173 [InitScratchFS, Always, TestOutputInt (
5174 [["write"; "/filesize"; "hello, world"];
5175 ["filesize"; "/filesize"]], 12)],
5176 "return the size of the file in bytes",
5178 This command returns the size of C<file> in bytes.
5180 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5181 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5182 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5184 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5185 [InitBasicFSonLVM, Always, TestOutputList (
5186 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5187 ["lvs"]], ["/dev/VG/LV2"])],
5188 "rename an LVM logical volume",
5190 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5192 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5193 [InitBasicFSonLVM, Always, TestOutputList (
5195 ["vg_activate"; "false"; "VG"];
5196 ["vgrename"; "VG"; "VG2"];
5197 ["vg_activate"; "true"; "VG2"];
5198 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5199 ["vgs"]], ["VG2"])],
5200 "rename an LVM volume group",
5202 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5204 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5205 [InitISOFS, Always, TestOutputBuffer (
5206 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5207 "list the contents of a single file in an initrd",
5209 This command unpacks the file C<filename> from the initrd file
5210 called C<initrdpath>. The filename must be given I<without> the
5211 initial C</> character.
5213 For example, in guestfish you could use the following command
5214 to examine the boot script (usually called C</init>)
5215 contained in a Linux initrd or initramfs image:
5217 initrd-cat /boot/initrd-<version>.img init
5219 See also C<guestfs_initrd_list>.");
5221 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5223 "get the UUID of a physical volume",
5225 This command returns the UUID of the LVM PV C<device>.");
5227 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5229 "get the UUID of a volume group",
5231 This command returns the UUID of the LVM VG named C<vgname>.");
5233 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5235 "get the UUID of a logical volume",
5237 This command returns the UUID of the LVM LV C<device>.");
5239 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5241 "get the PV UUIDs containing the volume group",
5243 Given a VG called C<vgname>, this returns the UUIDs of all
5244 the physical volumes that this volume group resides on.
5246 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5247 calls to associate physical volumes and volume groups.
5249 See also C<guestfs_vglvuuids>.");
5251 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5253 "get the LV UUIDs of all LVs in the volume group",
5255 Given a VG called C<vgname>, this returns the UUIDs of all
5256 the logical volumes created in this volume group.
5258 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5259 calls to associate logical volumes and volume groups.
5261 See also C<guestfs_vgpvuuids>.");
5263 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5264 [InitScratchFS, Always, TestOutputBuffer (
5265 [["mkdir"; "/copy_size"];
5266 ["write"; "/copy_size/src"; "hello, world"];
5267 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5268 ["read_file"; "/copy_size/dest"]], "hello")],
5269 "copy size bytes from source to destination using dd",
5271 This command copies exactly C<size> bytes from one source device
5272 or file C<src> to another destination device or file C<dest>.
5274 Note this will fail if the source is too short or if the destination
5275 is not large enough.");
5277 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5278 [InitBasicFSonLVM, Always, TestRun (
5279 [["zero_device"; "/dev/VG/LV"]])],
5280 "write zeroes to an entire device",
5282 This command writes zeroes over the entire C<device>. Compare
5283 with C<guestfs_zero> which just zeroes the first few blocks of
5286 If blocks are already zero, then this command avoids writing
5287 zeroes. This prevents the underlying device from becoming non-sparse
5288 or growing unnecessarily.");
5290 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5291 [InitScratchFS, Always, TestOutput (
5292 [["mkdir"; "/txz_in"];
5293 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5294 ["cat"; "/txz_in/hello"]], "hello\n")],
5295 "unpack compressed tarball to directory",
5297 This command uploads and unpacks local file C<tarball> (an
5298 I<xz compressed> tar file) into C<directory>.");
5300 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5302 "pack directory into compressed tarball",
5304 This command packs the contents of C<directory> and downloads
5305 it to local file C<tarball> (as an xz compressed tar archive).");
5307 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5309 "resize an NTFS filesystem",
5311 This command resizes an NTFS filesystem, expanding or
5312 shrinking it to the size of the underlying device.
5314 I<Note:> After the resize operation, the filesystem is marked
5315 as requiring a consistency check (for safety). You have to boot
5316 into Windows to perform this check and clear this condition.
5317 Furthermore, ntfsresize refuses to resize filesystems
5318 which have been marked in this way. So in effect it is
5319 not possible to call ntfsresize multiple times on a single
5320 filesystem without booting into Windows between each resize.
5322 See also L<ntfsresize(8)>.");
5324 ("vgscan", (RErr, [], []), 232, [],
5325 [InitEmpty, Always, TestRun (
5327 "rescan for LVM physical volumes, volume groups and logical volumes",
5329 This rescans all block devices and rebuilds the list of LVM
5330 physical volumes, volume groups and logical volumes.");
5332 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5333 [InitEmpty, Always, TestRun (
5334 [["part_init"; "/dev/sda"; "mbr"];
5335 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5336 ["part_del"; "/dev/sda"; "1"]])],
5337 "delete a partition",
5339 This command deletes the partition numbered C<partnum> on C<device>.
5341 Note that in the case of MBR partitioning, deleting an
5342 extended partition also deletes any logical partitions
5345 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5346 [InitEmpty, Always, TestOutputTrue (
5347 [["part_init"; "/dev/sda"; "mbr"];
5348 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5349 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5350 ["part_get_bootable"; "/dev/sda"; "1"]])],
5351 "return true if a partition is bootable",
5353 This command returns true if the partition C<partnum> on
5354 C<device> has the bootable flag set.
5356 See also C<guestfs_part_set_bootable>.");
5358 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5359 [InitEmpty, Always, TestOutputInt (
5360 [["part_init"; "/dev/sda"; "mbr"];
5361 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5362 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5363 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5364 "get the MBR type byte (ID byte) from a partition",
5366 Returns the MBR type byte (also known as the ID byte) from
5367 the numbered partition C<partnum>.
5369 Note that only MBR (old DOS-style) partitions have type bytes.
5370 You will get undefined results for other partition table
5371 types (see C<guestfs_part_get_parttype>).");
5373 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5374 [], (* tested by part_get_mbr_id *)
5375 "set the MBR type byte (ID byte) of a partition",
5377 Sets the MBR type byte (also known as the ID byte) of
5378 the numbered partition C<partnum> to C<idbyte>. Note
5379 that the type bytes quoted in most documentation are
5380 in fact hexadecimal numbers, but usually documented
5381 without any leading \"0x\" which might be confusing.
5383 Note that only MBR (old DOS-style) partitions have type bytes.
5384 You will get undefined results for other partition table
5385 types (see C<guestfs_part_get_parttype>).");
5387 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5388 [InitISOFS, Always, TestOutputFileMD5 (
5389 [["checksum_device"; "md5"; "/dev/sdd"]],
5390 "../images/test.iso")],
5391 "compute MD5, SHAx or CRC checksum of the contents of a device",
5393 This call computes the MD5, SHAx or CRC checksum of the
5394 contents of the device named C<device>. For the types of
5395 checksums supported see the C<guestfs_checksum> command.");
5397 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5398 [InitNone, Always, TestRun (
5399 [["part_disk"; "/dev/sda"; "mbr"];
5400 ["pvcreate"; "/dev/sda1"];
5401 ["vgcreate"; "VG"; "/dev/sda1"];
5402 ["lvcreate"; "LV"; "VG"; "10"];
5403 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5404 "expand an LV to fill free space",
5406 This expands an existing logical volume C<lv> so that it fills
5407 C<pc>% of the remaining free space in the volume group. Commonly
5408 you would call this with pc = 100 which expands the logical volume
5409 as much as possible, using all remaining free space in the volume
5412 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5413 [], (* XXX Augeas code needs tests. *)
5414 "clear Augeas path",
5416 Set the value associated with C<path> to C<NULL>. This
5417 is the same as the L<augtool(1)> C<clear> command.");
5419 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5420 [InitEmpty, Always, TestOutputInt (
5421 [["get_umask"]], 0o22)],
5422 "get the current umask",
5424 Return the current umask. By default the umask is C<022>
5425 unless it has been set by calling C<guestfs_umask>.");
5427 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5429 "upload a file to the appliance (internal use only)",
5431 The C<guestfs_debug_upload> command uploads a file to
5432 the libguestfs appliance.
5434 There is no comprehensive help for this command. You have
5435 to look at the file C<daemon/debug.c> in the libguestfs source
5436 to find out what it is for.");
5438 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5439 [InitScratchFS, Always, TestOutput (
5440 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5441 ["cat"; "/base64_in"]], "hello\n")],
5442 "upload base64-encoded data to file",
5444 This command uploads base64-encoded data from C<base64file>
5447 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5449 "download file and encode as base64",
5451 This command downloads the contents of C<filename>, writing
5452 it out to local file C<base64file> encoded as base64.");
5454 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5456 "compute MD5, SHAx or CRC checksum of files in a directory",
5458 This command computes the checksums of all regular files in
5459 C<directory> and then emits a list of those checksums to
5460 the local output file C<sumsfile>.
5462 This can be used for verifying the integrity of a virtual
5463 machine. However to be properly secure you should pay
5464 attention to the output of the checksum command (it uses
5465 the ones from GNU coreutils). In particular when the
5466 filename is not printable, coreutils uses a special
5467 backslash syntax. For more information, see the GNU
5468 coreutils info file.");
5470 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5471 [InitScratchFS, Always, TestOutputBuffer (
5472 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5473 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5474 "fill a file with a repeating pattern of bytes",
5476 This function is like C<guestfs_fill> except that it creates
5477 a new file of length C<len> containing the repeating pattern
5478 of bytes in C<pattern>. The pattern is truncated if necessary
5479 to ensure the length of the file is exactly C<len> bytes.");
5481 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5482 [InitScratchFS, Always, TestOutput (
5483 [["write"; "/write"; "new file contents"];
5484 ["cat"; "/write"]], "new file contents");
5485 InitScratchFS, Always, TestOutput (
5486 [["write"; "/write2"; "\nnew file contents\n"];
5487 ["cat"; "/write2"]], "\nnew file contents\n");
5488 InitScratchFS, Always, TestOutput (
5489 [["write"; "/write3"; "\n\n"];
5490 ["cat"; "/write3"]], "\n\n");
5491 InitScratchFS, Always, TestOutput (
5492 [["write"; "/write4"; ""];
5493 ["cat"; "/write4"]], "");
5494 InitScratchFS, Always, TestOutput (
5495 [["write"; "/write5"; "\n\n\n"];
5496 ["cat"; "/write5"]], "\n\n\n");
5497 InitScratchFS, Always, TestOutput (
5498 [["write"; "/write6"; "\n"];
5499 ["cat"; "/write6"]], "\n")],
5500 "create a new file",
5502 This call creates a file called C<path>. The content of the
5503 file is the string C<content> (which can contain any 8 bit data).
5505 See also C<guestfs_write_append>.");
5507 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5508 [InitScratchFS, Always, TestOutput (
5509 [["write"; "/pwrite"; "new file contents"];
5510 ["pwrite"; "/pwrite"; "data"; "4"];
5511 ["cat"; "/pwrite"]], "new data contents");
5512 InitScratchFS, Always, TestOutput (
5513 [["write"; "/pwrite2"; "new file contents"];
5514 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5515 ["cat"; "/pwrite2"]], "new file is extended");
5516 InitScratchFS, Always, TestOutput (
5517 [["write"; "/pwrite3"; "new file contents"];
5518 ["pwrite"; "/pwrite3"; ""; "4"];
5519 ["cat"; "/pwrite3"]], "new file contents")],
5520 "write to part of a file",
5522 This command writes to part of a file. It writes the data
5523 buffer C<content> to the file C<path> starting at offset C<offset>.
5525 This command implements the L<pwrite(2)> system call, and like
5526 that system call it may not write the full data requested. The
5527 return value is the number of bytes that were actually written
5528 to the file. This could even be 0, although short writes are
5529 unlikely for regular files in ordinary circumstances.
5531 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5533 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5535 "resize an ext2, ext3 or ext4 filesystem (with size)",
5537 This command is the same as C<guestfs_resize2fs> except that it
5538 allows you to specify the new size (in bytes) explicitly.");
5540 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5542 "resize an LVM physical volume (with size)",
5544 This command is the same as C<guestfs_pvresize> except that it
5545 allows you to specify the new size (in bytes) explicitly.");
5547 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5549 "resize an NTFS filesystem (with size)",
5551 This command is the same as C<guestfs_ntfsresize> except that it
5552 allows you to specify the new size (in bytes) explicitly.");
5554 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5555 [InitNone, Always, TestRun [["available_all_groups"]]],
5556 "return a list of all optional groups",
5558 This command returns a list of all optional groups that this
5559 daemon knows about. Note this returns both supported and unsupported
5560 groups. To find out which ones the daemon can actually support
5561 you have to call C<guestfs_available> on each member of the
5564 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5566 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5567 [InitScratchFS, Always, TestOutputStruct (
5568 [["fallocate64"; "/fallocate64"; "1000000"];
5569 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5570 "preallocate a file in the guest filesystem",
5572 This command preallocates a file (containing zero bytes) named
5573 C<path> of size C<len> bytes. If the file exists already, it
5576 Note that this call allocates disk blocks for the file.
5577 To create a sparse file use C<guestfs_truncate_size> instead.
5579 The deprecated call C<guestfs_fallocate> does the same,
5580 but owing to an oversight it only allowed 30 bit lengths
5581 to be specified, effectively limiting the maximum size
5582 of files created through that call to 1GB.
5584 Do not confuse this with the guestfish-specific
5585 C<alloc> and C<sparse> commands which create
5586 a file in the host and attach it as a device.");
5588 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5589 [InitBasicFS, Always, TestOutput (
5590 [["set_e2label"; "/dev/sda1"; "LTEST"];
5591 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5592 "get the filesystem label",
5594 This returns the filesystem label of the filesystem on
5597 If the filesystem is unlabeled, this returns the empty string.
5599 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5601 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5602 (let uuid = uuidgen () in
5603 [InitBasicFS, Always, TestOutput (
5604 [["set_e2uuid"; "/dev/sda1"; uuid];
5605 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5606 "get the filesystem UUID",
5608 This returns the filesystem UUID of the filesystem on
5611 If the filesystem does not have a UUID, this returns the empty string.
5613 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5615 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5616 (* Can't be tested with the current framework because
5617 * the VG is being used by the mounted filesystem, so
5618 * the vgchange -an command we do first will fail.
5621 "set LVM device filter",
5623 This sets the LVM device filter so that LVM will only be
5624 able to \"see\" the block devices in the list C<devices>,
5625 and will ignore all other attached block devices.
5627 Where disk image(s) contain duplicate PVs or VGs, this
5628 command is useful to get LVM to ignore the duplicates, otherwise
5629 LVM can get confused. Note also there are two types
5630 of duplication possible: either cloned PVs/VGs which have
5631 identical UUIDs; or VGs that are not cloned but just happen
5632 to have the same name. In normal operation you cannot
5633 create this situation, but you can do it outside LVM, eg.
5634 by cloning disk images or by bit twiddling inside the LVM
5637 This command also clears the LVM cache and performs a volume
5640 You can filter whole block devices or individual partitions.
5642 You cannot use this if any VG is currently in use (eg.
5643 contains a mounted filesystem), even if you are not
5644 filtering out that VG.");
5646 ("lvm_clear_filter", (RErr, [], []), 256, [],
5647 [], (* see note on lvm_set_filter *)
5648 "clear LVM device filter",
5650 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5651 will be able to see every block device.
5653 This command also clears the LVM cache and performs a volume
5656 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5658 "open a LUKS-encrypted block device",
5660 This command opens a block device which has been encrypted
5661 according to the Linux Unified Key Setup (LUKS) standard.
5663 C<device> is the encrypted block device or partition.
5665 The caller must supply one of the keys associated with the
5666 LUKS block device, in the C<key> parameter.
5668 This creates a new block device called C</dev/mapper/mapname>.
5669 Reads and writes to this block device are decrypted from and
5670 encrypted to the underlying C<device> respectively.
5672 If this block device contains LVM volume groups, then
5673 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5674 will make them visible.
5676 Use C<guestfs_list_dm_devices> to list all device mapper
5679 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5681 "open a LUKS-encrypted block device read-only",
5683 This is the same as C<guestfs_luks_open> except that a read-only
5684 mapping is created.");
5686 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5688 "close a LUKS device",
5690 This closes a LUKS device that was created earlier by
5691 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5692 C<device> parameter must be the name of the LUKS mapping
5693 device (ie. C</dev/mapper/mapname>) and I<not> the name
5694 of the underlying block device.");
5696 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5698 "format a block device as a LUKS encrypted device",
5700 This command erases existing data on C<device> and formats
5701 the device as a LUKS encrypted device. C<key> is the
5702 initial key, which is added to key slot C<slot>. (LUKS
5703 supports 8 key slots, numbered 0-7).");
5705 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5707 "format a block device as a LUKS encrypted device",
5709 This command is the same as C<guestfs_luks_format> but
5710 it also allows you to set the C<cipher> used.");
5712 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5714 "add a key on a LUKS encrypted device",
5716 This command adds a new key on LUKS device C<device>.
5717 C<key> is any existing key, and is used to access the device.
5718 C<newkey> is the new key to add. C<keyslot> is the key slot
5719 that will be replaced.
5721 Note that if C<keyslot> already contains a key, then this
5722 command will fail. You have to use C<guestfs_luks_kill_slot>
5723 first to remove that key.");
5725 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5727 "remove a key from a LUKS encrypted device",
5729 This command deletes the key in key slot C<keyslot> from the
5730 encrypted LUKS device C<device>. C<key> must be one of the
5733 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5734 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5735 [["is_lv"; "/dev/VG/LV"]]);
5736 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5737 [["is_lv"; "/dev/sda1"]])],
5738 "test if device is a logical volume",
5740 This command tests whether C<device> is a logical volume, and
5741 returns true iff this is the case.");
5743 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5745 "find a filesystem by UUID",
5747 This command searches the filesystems and returns the one
5748 which has the given UUID. An error is returned if no such
5749 filesystem can be found.
5751 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5753 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5755 "find a filesystem by label",
5757 This command searches the filesystems and returns the one
5758 which has the given label. An error is returned if no such
5759 filesystem can be found.
5761 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5763 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5764 [InitISOFS, Always, TestOutputFalse (
5765 [["is_chardev"; "/directory"]]);
5766 InitScratchFS, Always, TestOutputTrue (
5767 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5768 ["is_chardev"; "/is_chardev"]])],
5769 "test if character device",
5771 This returns C<true> if and only if there is a character device
5772 with the given C<path> name.
5774 See also C<guestfs_stat>.");
5776 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5777 [InitISOFS, Always, TestOutputFalse (
5778 [["is_blockdev"; "/directory"]]);
5779 InitScratchFS, Always, TestOutputTrue (
5780 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5781 ["is_blockdev"; "/is_blockdev"]])],
5782 "test if block device",
5784 This returns C<true> if and only if there is a block device
5785 with the given C<path> name.
5787 See also C<guestfs_stat>.");
5789 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5790 [InitISOFS, Always, TestOutputFalse (
5791 [["is_fifo"; "/directory"]]);
5792 InitScratchFS, Always, TestOutputTrue (
5793 [["mkfifo"; "0o777"; "/is_fifo"];
5794 ["is_fifo"; "/is_fifo"]])],
5795 "test if FIFO (named pipe)",
5797 This returns C<true> if and only if there is a FIFO (named pipe)
5798 with the given C<path> name.
5800 See also C<guestfs_stat>.");
5802 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5803 [InitISOFS, Always, TestOutputFalse (
5804 [["is_symlink"; "/directory"]]);
5805 InitISOFS, Always, TestOutputTrue (
5806 [["is_symlink"; "/abssymlink"]])],
5807 "test if symbolic link",
5809 This returns C<true> if and only if there is a symbolic link
5810 with the given C<path> name.
5812 See also C<guestfs_stat>.");
5814 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5815 (* XXX Need a positive test for sockets. *)
5816 [InitISOFS, Always, TestOutputFalse (
5817 [["is_socket"; "/directory"]])],
5820 This returns C<true> if and only if there is a Unix domain socket
5821 with the given C<path> name.
5823 See also C<guestfs_stat>.");
5825 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5826 [InitPartition, Always, TestOutputDevice (
5827 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5828 InitEmpty, Always, TestLastFail (
5829 [["part_to_dev"; "/dev/sda"]])],
5830 "convert partition name to device name",
5832 This function takes a partition name (eg. \"/dev/sdb1\") and
5833 removes the partition number, returning the device name
5836 The named partition must exist, for example as a string returned
5837 from C<guestfs_list_partitions>.");
5839 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5840 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5841 [InitScratchFS, Always, TestOutput (
5842 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5843 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5844 "upload a file from the local machine with offset",
5846 Upload local file C<filename> to C<remotefilename> on the
5849 C<remotefilename> is overwritten starting at the byte C<offset>
5850 specified. The intention is to overwrite parts of existing
5851 files or devices, although if a non-existant file is specified
5852 then it is created with a \"hole\" before C<offset>. The
5853 size of the data written is implicit in the size of the
5856 Note that there is no limit on the amount of data that
5857 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5858 and this call always writes the full amount unless an
5861 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5863 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5864 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5865 let offset = string_of_int 100 in
5866 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5867 [InitScratchFS, Always, TestOutput (
5868 (* Pick a file from cwd which isn't likely to change. *)
5869 [["mkdir"; "/download_offset"];
5870 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5871 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5872 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5873 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5874 "download a file to the local machine with offset and size",
5876 Download file C<remotefilename> and save it as C<filename>
5877 on the local machine.
5879 C<remotefilename> is read for C<size> bytes starting at C<offset>
5880 (this region must be within the file or device).
5882 Note that there is no limit on the amount of data that
5883 can be downloaded with this call, unlike with C<guestfs_pread>,
5884 and this call always reads the full amount unless an
5887 See also C<guestfs_download>, C<guestfs_pread>.");
5889 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5890 [InitPartition, Always, TestOutputListOfDevices (
5891 [["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"];
5892 ["blockdev_rereadpt"; "/dev/sda"];
5893 ["list_partitions"]], ["/dev/sdb1"])],
5894 "write to part of a device",
5896 This command writes to part of a device. It writes the data
5897 buffer C<content> to C<device> starting at offset C<offset>.
5899 This command implements the L<pwrite(2)> system call, and like
5900 that system call it may not write the full data requested
5901 (although short writes to disk devices and partitions are
5902 probably impossible with standard Linux kernels).
5904 See also C<guestfs_pwrite>.");
5906 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5907 [InitEmpty, Always, TestOutputBuffer (
5908 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5909 "read part of a device",
5911 This command lets you read part of a file. It reads C<count>
5912 bytes of C<device>, starting at C<offset>.
5914 This may read fewer bytes than requested. For further details
5915 see the L<pread(2)> system call.
5917 See also C<guestfs_pread>.");
5919 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5920 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5921 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5922 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5923 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5924 "get canonical name of an LV",
5926 This converts alternative naming schemes for LVs that you
5927 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5928 is converted to C</dev/VG/LV>.
5930 This command returns an error if the C<lvname> parameter does
5931 not refer to a logical volume.
5933 See also C<guestfs_is_lv>.");
5935 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
5936 [InitEmpty, Always, TestOutput (
5937 [["part_disk"; "/dev/sda"; "mbr"];
5938 ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
5939 ["mount_options"; ""; "/dev/sda1"; "/"];
5940 ["write"; "/new"; "new file contents"];
5941 ["cat"; "/new"]], "new file contents")],
5942 "make a filesystem",
5944 This function creates a filesystem on C<device>. The filesystem
5945 type is C<fstype>, for example C<ext3>.
5947 The optional arguments are:
5953 The filesystem block size. Supported block sizes depend on the
5954 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5955 for Linux ext2/3 filesystems.
5957 For VFAT and NTFS the C<blocksize> parameter is treated as
5958 the requested cluster size.
5960 For UFS block sizes, please see L<mkfs.ufs(8)>.
5964 This passes the I<-O> parameter to the external mkfs program.
5966 For certain filesystem types, this allows extra filesystem
5967 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5970 You cannot use this optional parameter with the C<gfs> or
5971 C<gfs2> filesystem type.
5975 This passes the I<-I> parameter to the external L<mke2fs(8)> program
5976 which sets the inode size (only for ext2/3/4 filesystems at present).
5980 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
5981 which sets sector size for ufs filesystem.
5985 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5987 "get a single extended attribute",
5989 Get a single extended attribute from file C<path> named C<name>.
5990 This call follows symlinks. If you want to lookup an extended
5991 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5993 Normally it is better to get all extended attributes from a file
5994 in one go by calling C<guestfs_getxattrs>. However some Linux
5995 filesystem implementations are buggy and do not provide a way to
5996 list out attributes. For these filesystems (notably ntfs-3g)
5997 you have to know the names of the extended attributes you want
5998 in advance and call this function.
6000 Extended attribute values are blobs of binary data. If there
6001 is no extended attribute named C<name>, this returns an error.
6003 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
6005 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
6007 "get a single extended attribute",
6009 Get a single extended attribute from file C<path> named C<name>.
6010 If C<path> is a symlink, then this call returns an extended
6011 attribute from the symlink.
6013 Normally it is better to get all extended attributes from a file
6014 in one go by calling C<guestfs_getxattrs>. However some Linux
6015 filesystem implementations are buggy and do not provide a way to
6016 list out attributes. For these filesystems (notably ntfs-3g)
6017 you have to know the names of the extended attributes you want
6018 in advance and call this function.
6020 Extended attribute values are blobs of binary data. If there
6021 is no extended attribute named C<name>, this returns an error.
6023 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
6025 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
6027 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
6029 This command is the same as C<guestfs_resize2fs>, but the filesystem
6030 is resized to its minimum size. This works like the I<-M> option
6031 to the C<resize2fs> command.
6033 To get the resulting size of the filesystem you should call
6034 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
6035 values. These two numbers, multiplied together, give the
6036 resulting size of the minimal filesystem in bytes.");
6038 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
6040 "internal autosync operation",
6042 This command performs the autosync operation just before the
6043 handle is closed. You should not call this command directly.
6044 Instead, use the autosync flag (C<guestfs_set_autosync>) to
6045 control whether or not this operation is performed when the
6046 handle is closed.");
6048 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6049 [InitISOFS, Always, TestOutputTrue (
6050 [["is_zero"; "/100kallzeroes"]]);
6051 InitISOFS, Always, TestOutputFalse (
6052 [["is_zero"; "/100kallspaces"]])],
6053 "test if a file contains all zero bytes",
6055 This returns true iff the file exists and the file is empty or
6056 it contains all zero bytes.");
6058 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6059 [InitBasicFS, Always, TestOutputTrue (
6060 [["umount"; "/dev/sda1"];
6061 ["zero_device"; "/dev/sda1"];
6062 ["is_zero_device"; "/dev/sda1"]]);
6063 InitBasicFS, Always, TestOutputFalse (
6064 [["is_zero_device"; "/dev/sda1"]])],
6065 "test if a device contains all zero bytes",
6067 This returns true iff the device exists and contains all zero bytes.
6069 Note that for large devices this can take a long time to run.");
6071 ("list_9p", (RStringList "mounttags", [], []), 285, [],
6073 "list 9p filesystems",
6075 List all 9p filesystems attached to the guest. A list of
6076 mount tags is returned.");
6078 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6080 "mount 9p filesystem",
6082 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6083 directory C<mountpoint>.
6085 If required, C<trans=virtio> will be automatically added to the options.
6086 Any other options required can be passed in the optional C<options>
6089 ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6091 "list device mapper devices",
6093 List all device mapper devices.
6095 The returned list contains C</dev/mapper/*> devices, eg. ones created
6096 by a previous call to C<guestfs_luks_open>.
6098 Device mapper devices which correspond to logical volumes are I<not>
6099 returned in this list. Call C<guestfs_lvs> if you want to list logical
6102 ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6104 "resize an NTFS filesystem",
6106 This command resizes an NTFS filesystem, expanding or
6107 shrinking it to the size of the underlying device.
6109 The optional parameters are:
6115 The new size (in bytes) of the filesystem. If omitted, the filesystem
6116 is resized to fit the container (eg. partition).
6120 If this option is true, then force the resize of the filesystem
6121 even if the filesystem is marked as requiring a consistency check.
6123 After the resize operation, the filesystem is always marked
6124 as requiring a consistency check (for safety). You have to boot
6125 into Windows to perform this check and clear this condition.
6126 If you I<don't> set the C<force> option then it is not
6127 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6128 single filesystem without booting into Windows between each resize.
6132 See also L<ntfsresize(8)>.");
6134 ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6136 "resize a btrfs filesystem",
6138 This command resizes a btrfs filesystem.
6140 Note that unlike other resize calls, the filesystem has to be
6141 mounted and the parameter is the mountpoint not the device
6142 (this is a requirement of btrfs itself).
6144 The optional parameters are:
6150 The new size (in bytes) of the filesystem. If omitted, the filesystem
6151 is resized to the maximum size.
6155 See also L<btrfs(8)>.");
6157 ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6158 [InitScratchFS, Always, TestOutput (
6159 [["write"; "/write_append"; "line1\n"];
6160 ["write_append"; "/write_append"; "line2\n"];
6161 ["write_append"; "/write_append"; "line3a"];
6162 ["write_append"; "/write_append"; "line3b\n"];
6163 ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6164 "append content to end of file",
6166 This call appends C<content> to the end of file C<path>. If
6167 C<path> does not exist, then a new file is created.
6169 See also C<guestfs_write>.");
6171 ("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [Int "level"]), 291, [],
6173 "output compressed file",
6175 This command compresses C<file> and writes it out to the local
6178 The compression program used is controlled by the C<ctype> parameter.
6179 Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.
6180 Some compression types may not be supported by particular builds of
6181 libguestfs, in which case you will get an error containing the
6182 substring \"not supported\".
6184 The optional C<level> parameter controls compression level. The
6185 meaning and default for this parameter depends on the compression
6186 program being used.");
6188 ("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [Int "level"]), 292, [],
6190 "output compressed device",
6192 This command compresses C<device> and writes it out to the local
6195 The C<ctype> and optional C<level> parameters have the same meaning
6196 as in C<guestfs_compress_out>.");
6200 let all_functions = non_daemon_functions @ daemon_functions
6202 (* In some places we want the functions to be displayed sorted
6203 * alphabetically, so this is useful:
6205 let all_functions_sorted = List.sort action_compare all_functions
6207 (* This is used to generate the src/MAX_PROC_NR file which
6208 * contains the maximum procedure number, a surrogate for the
6209 * ABI version number. See src/Makefile.am for the details.
6212 let proc_nrs = List.map (
6213 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6214 ) daemon_functions in
6215 List.fold_left max 0 proc_nrs
6217 (* Non-API meta-commands available only in guestfish.
6219 * Note (1): style, proc_nr and tests fields are all meaningless.
6220 * The only fields which are actually used are the shortname,
6221 * FishAlias flags, shortdesc and longdesc.
6223 * Note (2): to refer to other commands, use L</shortname>.
6225 * Note (3): keep this list sorted by shortname.
6227 let fish_commands = [
6228 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6229 "allocate and add a disk file",
6230 " alloc filename size
6232 This creates an empty (zeroed) file of the given size, and then adds
6233 so it can be further examined.
6235 For more advanced image creation, see L<qemu-img(1)> utility.
6237 Size can be specified using standard suffixes, eg. C<1M>.
6239 To create a sparse file, use L</sparse> instead. To create a
6240 prepared disk image, see L</PREPARED DISK IMAGES>.");
6242 ("copy_in", (RErr,[], []), -1, [], [],
6243 "copy local files or directories into an image",
6244 " copy-in local [local ...] /remotedir
6246 C<copy-in> copies local files or directories recursively into the disk
6247 image, placing them in the directory called C</remotedir> (which must
6248 exist). This guestfish meta-command turns into a sequence of
6249 L</tar-in> and other commands as necessary.
6251 Multiple local files and directories can be specified, but the last
6252 parameter must always be a remote directory. Wildcards cannot be
6255 ("copy_out", (RErr,[], []), -1, [], [],
6256 "copy remote files or directories out of an image",
6257 " copy-out remote [remote ...] localdir
6259 C<copy-out> copies remote files or directories recursively out of the
6260 disk image, placing them on the host disk in a local directory called
6261 C<localdir> (which must exist). This guestfish meta-command turns
6262 into a sequence of L</download>, L</tar-out> and other commands as
6265 Multiple remote files and directories can be specified, but the last
6266 parameter must always be a local directory. To download to the
6267 current directory, use C<.> as in:
6271 Wildcards cannot be used in the ordinary command, but you can use
6272 them with the help of L</glob> like this:
6274 glob copy-out /home/* .");
6276 ("display", (RErr,[], []), -1, [], [],
6280 Use C<display> (a graphical display program) to display an image
6281 file. It downloads the file, and runs C<display> on it.
6283 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6284 environment variable. For example to use the GNOME display program:
6286 export GUESTFISH_DISPLAY_IMAGE=eog
6288 See also L<display(1)>.");
6290 ("echo", (RErr,[], []), -1, [], [],
6291 "display a line of text",
6294 This echos the parameters to the terminal.");
6296 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6300 This is used to edit a file. It downloads the file, edits it
6301 locally using your editor, then uploads the result.
6303 The editor is C<$EDITOR>. However if you use the alternate
6304 commands C<vi> or C<emacs> you will get those corresponding
6307 ("glob", (RErr,[], []), -1, [], [],
6308 "expand wildcards in command",
6309 " glob command args...
6311 Expand wildcards in any paths in the args list, and run C<command>
6312 repeatedly on each matching path.
6314 See L</WILDCARDS AND GLOBBING>.");
6316 ("hexedit", (RErr,[], []), -1, [], [],
6317 "edit with a hex editor",
6318 " hexedit <filename|device>
6319 hexedit <filename|device> <max>
6320 hexedit <filename|device> <start> <max>
6322 Use hexedit (a hex editor) to edit all or part of a binary file
6325 This command works by downloading potentially the whole file or
6326 device, editing it locally, then uploading it. If the file or
6327 device is large, you have to specify which part you wish to edit
6328 by using C<max> and/or C<start> C<max> parameters.
6329 C<start> and C<max> are specified in bytes, with the usual
6330 modifiers allowed such as C<1M> (1 megabyte).
6332 For example to edit the first few sectors of a disk you
6337 which would allow you to edit anywhere within the first megabyte
6340 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6342 hexedit /dev/sda1 0x400 0x400
6344 (assuming the superblock is in the standard location).
6346 This command requires the external L<hexedit(1)> program. You
6347 can specify another program to use by setting the C<HEXEDITOR>
6348 environment variable.
6350 See also L</hexdump>.");
6352 ("lcd", (RErr,[], []), -1, [], [],
6353 "change working directory",
6356 Change the local directory, ie. the current directory of guestfish
6359 Note that C<!cd> won't do what you might expect.");
6361 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6365 Opens the manual page for guestfish.");
6367 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6373 This is used to view a file.
6375 The default viewer is C<$PAGER>. However if you use the alternate
6376 command C<less> you will get the C<less> command specifically.");
6378 ("reopen", (RErr,[], []), -1, [], [],
6379 "close and reopen libguestfs handle",
6382 Close and reopen the libguestfs handle. It is not necessary to use
6383 this normally, because the handle is closed properly when guestfish
6384 exits. However this is occasionally useful for testing.");
6386 ("setenv", (RErr,[], []), -1, [], [],
6387 "set an environment variable",
6390 Set the environment variable C<VAR> to the string C<value>.
6392 To print the value of an environment variable use a shell command
6397 ("sparse", (RErr,[], []), -1, [], [],
6398 "create a sparse disk image and add",
6399 " sparse filename size
6401 This creates an empty sparse file of the given size, and then adds
6402 so it can be further examined.
6404 In all respects it works the same as the L</alloc> command, except that
6405 the image file is allocated sparsely, which means that disk blocks are
6406 not assigned to the file until they are needed. Sparse disk files
6407 only use space when written to, but they are slower and there is a
6408 danger you could run out of real disk space during a write operation.
6410 For more advanced image creation, see L<qemu-img(1)> utility.
6412 Size can be specified using standard suffixes, eg. C<1M>.");
6414 ("supported", (RErr,[], []), -1, [], [],
6415 "list supported groups of commands",
6418 This command returns a list of the optional groups
6419 known to the daemon, and indicates which ones are
6420 supported by this build of the libguestfs appliance.
6422 See also L<guestfs(3)/AVAILABILITY>.");
6424 ("time", (RErr,[], []), -1, [], [],
6425 "print elapsed time taken to run a command",
6426 " time command args...
6428 Run the command as usual, but print the elapsed time afterwards. This
6429 can be useful for benchmarking operations.");
6431 ("unsetenv", (RErr,[], []), -1, [], [],
6432 "unset an environment variable",
6435 Remove C<VAR> from the environment.");