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: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1177 Future versions of libguestfs may return other strings.
1179 Please read L<guestfs(3)/INSPECTION> for more details.");
1181 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1183 "get package management tool used by the operating system",
1185 C<guestfs_inspect_get_package_format> and this function return
1186 the package format and package management tool used by the
1187 inspected operating system. For example for Fedora these
1188 functions would return C<rpm> (package format) and
1189 C<yum> (package management).
1191 This returns the string C<unknown> if we could not determine the
1192 package management tool I<or> if the operating system does not have
1193 a real packaging system (eg. Windows).
1195 Possible strings include: C<yum>, C<up2date>,
1196 C<apt> (for all Debian derivatives),
1197 C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>.
1198 Future versions of libguestfs may return other strings.
1200 Please read L<guestfs(3)/INSPECTION> for more details.");
1202 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1204 "get list of applications installed in the operating system",
1206 Return the list of applications installed in the operating system.
1208 I<Note:> This call works differently from other parts of the
1209 inspection API. You have to call C<guestfs_inspect_os>, then
1210 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1211 before calling this. Listing applications is a significantly
1212 more difficult operation which requires access to the full
1213 filesystem. Also note that unlike the other
1214 C<guestfs_inspect_get_*> calls which are just returning
1215 data cached in the libguestfs handle, this call actually reads
1216 parts of the mounted filesystems during the call.
1218 This returns an empty list if the inspection code was not able
1219 to determine the list of applications.
1221 The application structure contains the following fields:
1227 The name of the application. For Red Hat-derived and Debian-derived
1228 Linux guests, this is the package name.
1230 =item C<app_display_name>
1232 The display name of the application, sometimes localized to the
1233 install language of the guest operating system.
1235 If unavailable this is returned as an empty string C<\"\">.
1236 Callers needing to display something can use C<app_name> instead.
1240 For package managers which use epochs, this contains the epoch of
1241 the package (an integer). If unavailable, this is returned as C<0>.
1243 =item C<app_version>
1245 The version string of the application or package. If unavailable
1246 this is returned as an empty string C<\"\">.
1248 =item C<app_release>
1250 The release string of the application or package, for package
1251 managers that use this. If unavailable this is returned as an
1252 empty string C<\"\">.
1254 =item C<app_install_path>
1256 The installation path of the application (on operating systems
1257 such as Windows which use installation paths). This path is
1258 in the format used by the guest operating system, it is not
1261 If unavailable this is returned as an empty string C<\"\">.
1263 =item C<app_trans_path>
1265 The install path translated into a libguestfs path.
1266 If unavailable this is returned as an empty string C<\"\">.
1268 =item C<app_publisher>
1270 The name of the publisher of the application, for package
1271 managers that use this. If unavailable this is returned
1272 as an empty string C<\"\">.
1276 The URL (eg. upstream URL) of the application.
1277 If unavailable this is returned as an empty string C<\"\">.
1279 =item C<app_source_package>
1281 For packaging systems which support this, the name of the source
1282 package. If unavailable this is returned as an empty string C<\"\">.
1284 =item C<app_summary>
1286 A short (usually one line) description of the application or package.
1287 If unavailable this is returned as an empty string C<\"\">.
1289 =item C<app_description>
1291 A longer description of the application or package.
1292 If unavailable this is returned as an empty string C<\"\">.
1296 Please read L<guestfs(3)/INSPECTION> for more details.");
1298 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1300 "get hostname of the operating system",
1302 This function returns the hostname of the operating system
1303 as found by inspection of the guest's configuration files.
1305 If the hostname could not be determined, then the
1306 string C<unknown> is returned.
1308 Please read L<guestfs(3)/INSPECTION> for more details.");
1310 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1312 "get format of inspected operating system",
1314 This returns the format of the inspected operating system. You
1315 can use it to detect install images, live CDs and similar.
1317 Currently defined formats are:
1323 This is an installed operating system.
1327 The disk image being inspected is not an installed operating system,
1328 but a I<bootable> install disk, live CD, or similar.
1332 The format of this disk image is not known.
1336 Future versions of libguestfs may return other strings here.
1337 The caller should be prepared to handle any string.
1339 Please read L<guestfs(3)/INSPECTION> for more details.");
1341 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1343 "get live flag for install disk",
1345 If C<guestfs_inspect_get_format> returns C<installer> (this
1346 is an install disk), then this returns true if a live image
1347 was detected on the disk.
1349 Please read L<guestfs(3)/INSPECTION> for more details.");
1351 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1353 "get netinst (network installer) flag for install disk",
1355 If C<guestfs_inspect_get_format> returns C<installer> (this
1356 is an install disk), then this returns true if the disk is
1357 a network installer, ie. not a self-contained install CD but
1358 one which is likely to require network access to complete
1361 Please read L<guestfs(3)/INSPECTION> for more details.");
1363 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1365 "get multipart flag for install disk",
1367 If C<guestfs_inspect_get_format> returns C<installer> (this
1368 is an install disk), then this returns true if the disk is
1371 Please read L<guestfs(3)/INSPECTION> for more details.");
1373 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1375 "set the attach method",
1377 Set the method that libguestfs uses to connect to the back end
1378 guestfsd daemon. Possible methods are:
1384 Launch an appliance and connect to it. This is the ordinary method
1387 =item C<unix:I<path>>
1389 Connect to the Unix domain socket I<path>.
1391 This method lets you connect to an existing daemon or (using
1392 virtio-serial) to a live guest. For more information, see
1393 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1397 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1398 [InitNone, Always, TestOutput (
1399 [["get_attach_method"]], "appliance")],
1400 "get the attach method",
1402 Return the current attach method. See C<guestfs_set_attach_method>.");
1404 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1406 "get product variant of inspected operating system",
1408 This returns the product variant of the inspected operating
1411 For Windows guests, this returns the contents of the Registry key
1412 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1413 C<InstallationType> which is usually a string such as
1414 C<Client> or C<Server> (other values are possible). This
1415 can be used to distinguish consumer and enterprise versions
1416 of Windows that have the same version number (for example,
1417 Windows 7 and Windows 2008 Server are both version 6.1,
1418 but the former is C<Client> and the latter is C<Server>).
1420 For enterprise Linux guests, in future we intend this to return
1421 the product variant such as C<Desktop>, C<Server> and so on. But
1422 this is not implemented at present.
1424 If the product variant could not be determined, then the
1425 string C<unknown> is returned.
1427 Please read L<guestfs(3)/INSPECTION> for more details.
1428 See also C<guestfs_inspect_get_product_name>,
1429 C<guestfs_inspect_get_major_version>.");
1431 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1433 "get Windows CurrentControlSet of inspected operating system",
1435 This returns the Windows CurrentControlSet of the inspected guest.
1436 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1438 This call assumes that the guest is Windows and that the
1439 Registry could be examined by inspection. If this is not
1440 the case then an error is returned.
1442 Please read L<guestfs(3)/INSPECTION> for more details.");
1444 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1446 "get drive letter mappings",
1448 This call is useful for Windows which uses a primitive system
1449 of assigning drive letters (like \"C:\") to partitions.
1450 This inspection API examines the Windows Registry to find out
1451 how disks/partitions are mapped to drive letters, and returns
1452 a hash table as in the example below:
1458 Note that keys are drive letters. For Windows, the key is
1459 case insensitive and just contains the drive letter, without
1460 the customary colon separator character.
1462 In future we may support other operating systems that also used drive
1463 letters, but the keys for those might not be case insensitive
1464 and might be longer than 1 character. For example in OS-9,
1465 hard drives were named C<h0>, C<h1> etc.
1467 For Windows guests, currently only hard drive mappings are
1468 returned. Removable disks (eg. DVD-ROMs) are ignored.
1470 For guests that do not use drive mappings, or if the drive mappings
1471 could not be determined, this returns an empty hash table.
1473 Please read L<guestfs(3)/INSPECTION> for more details.
1474 See also C<guestfs_inspect_get_mountpoints>,
1475 C<guestfs_inspect_get_filesystems>.");
1477 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1479 "get the icon corresponding to this operating system",
1481 This function returns an icon corresponding to the inspected
1482 operating system. The icon is returned as a buffer containing a
1483 PNG image (re-encoded to PNG if necessary).
1485 If it was not possible to get an icon this function returns a
1486 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1488 Libguestfs will start by looking for a file called
1489 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1490 and if it has the correct format, the contents of this file will
1491 be returned. You can disable favicons by passing the
1492 optional C<favicon> boolean as false (default is true).
1494 If finding the favicon fails, then we look in other places in the
1495 guest for a suitable icon.
1497 If the optional C<highquality> boolean is true then
1498 only high quality icons are returned, which means only icons of
1499 high resolution with an alpha channel. The default (false) is
1500 to return any icon we can, even if it is of substandard quality.
1508 Unlike most other inspection API calls, the guest's disks must be
1509 mounted up before you call this, since it needs to read information
1510 from the guest filesystem during the call.
1514 B<Security:> The icon data comes from the untrusted guest,
1515 and should be treated with caution. PNG files have been
1516 known to contain exploits. Ensure that libpng (or other relevant
1517 libraries) are fully up to date before trying to process or
1522 The PNG image returned can be any size. It might not be square.
1523 Libguestfs tries to return the largest, highest quality
1524 icon available. The application must scale the icon to the
1529 Extracting icons from Windows guests requires the external
1530 C<wrestool> program from the C<icoutils> package, and
1531 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1532 from the C<netpbm> package. These must be installed separately.
1536 Operating system icons are usually trademarks. Seek legal
1537 advice before using trademarks in applications.
1541 ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1543 "set process group flag",
1545 If C<pgroup> is true, child processes are placed into
1546 their own process group.
1548 The practical upshot of this is that signals like C<SIGINT> (from
1549 users pressing C<^C>) won't be received by the child process.
1551 The default for this flag is false, because usually you want
1552 C<^C> to kill the subprocess.");
1554 ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1556 "get process group flag",
1558 This returns the process group flag.");
1560 ("set_smp", (RErr, [Int "smp"], []), -1, [FishAlias "smp"],
1562 "set number of virtual CPUs in appliance",
1564 Change the number of virtual CPUs assigned to the appliance. The
1565 default is C<1>. Increasing this may improve performance, though
1566 often it has no effect.
1568 This function must be called before C<guestfs_launch>.");
1570 ("get_smp", (RInt "smp", [], []), -1, [],
1572 "get number of virtual CPUs in appliance",
1574 This returns the number of virtual CPUs assigned to the appliance.");
1578 (* daemon_functions are any functions which cause some action
1579 * to take place in the daemon.
1582 let daemon_functions = [
1583 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1584 [InitEmpty, Always, TestOutput (
1585 [["part_disk"; "/dev/sda"; "mbr"];
1586 ["mkfs"; "ext2"; "/dev/sda1"];
1587 ["mount"; "/dev/sda1"; "/"];
1588 ["write"; "/new"; "new file contents"];
1589 ["cat"; "/new"]], "new file contents")],
1590 "mount a guest disk at a position in the filesystem",
1592 Mount a guest disk at a position in the filesystem. Block devices
1593 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1594 the guest. If those block devices contain partitions, they will have
1595 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1598 The rules are the same as for L<mount(2)>: A filesystem must
1599 first be mounted on C</> before others can be mounted. Other
1600 filesystems can only be mounted on directories which already
1603 The mounted filesystem is writable, if we have sufficient permissions
1604 on the underlying device.
1606 Before libguestfs 1.13.16, this call implicitly added the options
1607 C<sync> and C<noatime>. The C<sync> option greatly slowed
1608 writes and caused many problems for users. If your program
1609 might need to work with older versions of libguestfs, use
1610 C<guestfs_mount_options> instead (using an empty string for the
1611 first parameter if you don't want any options).");
1613 ("sync", (RErr, [], []), 2, [],
1614 [ InitEmpty, Always, TestRun [["sync"]]],
1615 "sync disks, writes are flushed through to the disk image",
1617 This syncs the disk, so that any writes are flushed through to the
1618 underlying disk image.
1620 You should always call this if you have modified a disk image, before
1621 closing the handle.");
1623 ("touch", (RErr, [Pathname "path"], []), 3, [],
1624 [InitScratchFS, Always, TestOutputTrue (
1625 [["touch"; "/touch"];
1626 ["exists"; "/touch"]])],
1627 "update file timestamps or create a new file",
1629 Touch acts like the L<touch(1)> command. It can be used to
1630 update the timestamps on a file, or, if the file does not exist,
1631 to create a new zero-length file.
1633 This command only works on regular files, and will fail on other
1634 file types such as directories, symbolic links, block special etc.");
1636 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1637 [InitISOFS, Always, TestOutput (
1638 [["cat"; "/known-2"]], "abcdef\n")],
1639 "list the contents of a file",
1641 Return the contents of the file named C<path>.
1643 Note that this function cannot correctly handle binary files
1644 (specifically, files containing C<\\0> character which is treated
1645 as end of string). For those you need to use the C<guestfs_read_file>
1646 or C<guestfs_download> functions which have a more complex interface.");
1648 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1649 [], (* XXX Tricky to test because it depends on the exact format
1650 * of the 'ls -l' command, which changes between F10 and F11.
1652 "list the files in a directory (long format)",
1654 List the files in C<directory> (relative to the root directory,
1655 there is no cwd) in the format of 'ls -la'.
1657 This command is mostly useful for interactive sessions. It
1658 is I<not> intended that you try to parse the output string.");
1660 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1661 [InitScratchFS, Always, TestOutputList (
1663 ["touch"; "/ls/new"];
1664 ["touch"; "/ls/newer"];
1665 ["touch"; "/ls/newest"];
1666 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1667 "list the files in a directory",
1669 List the files in C<directory> (relative to the root directory,
1670 there is no cwd). The '.' and '..' entries are not returned, but
1671 hidden files are shown.
1673 This command is mostly useful for interactive sessions. Programs
1674 should probably use C<guestfs_readdir> instead.");
1676 ("list_devices", (RStringList "devices", [], []), 7, [],
1677 [InitEmpty, Always, TestOutputListOfDevices (
1678 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1679 "list the block devices",
1681 List all the block devices.
1683 The full block device names are returned, eg. C</dev/sda>.
1685 See also C<guestfs_list_filesystems>.");
1687 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1688 [InitBasicFS, Always, TestOutputListOfDevices (
1689 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1690 InitEmpty, Always, TestOutputListOfDevices (
1691 [["part_init"; "/dev/sda"; "mbr"];
1692 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1693 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1694 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1695 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1696 "list the partitions",
1698 List all the partitions detected on all block devices.
1700 The full partition device names are returned, eg. C</dev/sda1>
1702 This does not return logical volumes. For that you will need to
1703 call C<guestfs_lvs>.
1705 See also C<guestfs_list_filesystems>.");
1707 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1708 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1709 [["pvs"]], ["/dev/sda1"]);
1710 InitEmpty, Always, TestOutputListOfDevices (
1711 [["part_init"; "/dev/sda"; "mbr"];
1712 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1713 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1714 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1715 ["pvcreate"; "/dev/sda1"];
1716 ["pvcreate"; "/dev/sda2"];
1717 ["pvcreate"; "/dev/sda3"];
1718 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1719 "list the LVM physical volumes (PVs)",
1721 List all the physical volumes detected. This is the equivalent
1722 of the L<pvs(8)> command.
1724 This returns a list of just the device names that contain
1725 PVs (eg. C</dev/sda2>).
1727 See also C<guestfs_pvs_full>.");
1729 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1730 [InitBasicFSonLVM, Always, TestOutputList (
1732 InitEmpty, Always, TestOutputList (
1733 [["part_init"; "/dev/sda"; "mbr"];
1734 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1735 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1736 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1737 ["pvcreate"; "/dev/sda1"];
1738 ["pvcreate"; "/dev/sda2"];
1739 ["pvcreate"; "/dev/sda3"];
1740 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1741 ["vgcreate"; "VG2"; "/dev/sda3"];
1742 ["vgs"]], ["VG1"; "VG2"])],
1743 "list the LVM volume groups (VGs)",
1745 List all the volumes groups detected. This is the equivalent
1746 of the L<vgs(8)> command.
1748 This returns a list of just the volume group names that were
1749 detected (eg. C<VolGroup00>).
1751 See also C<guestfs_vgs_full>.");
1753 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1754 [InitBasicFSonLVM, Always, TestOutputList (
1755 [["lvs"]], ["/dev/VG/LV"]);
1756 InitEmpty, Always, TestOutputList (
1757 [["part_init"; "/dev/sda"; "mbr"];
1758 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1759 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1760 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1761 ["pvcreate"; "/dev/sda1"];
1762 ["pvcreate"; "/dev/sda2"];
1763 ["pvcreate"; "/dev/sda3"];
1764 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1765 ["vgcreate"; "VG2"; "/dev/sda3"];
1766 ["lvcreate"; "LV1"; "VG1"; "50"];
1767 ["lvcreate"; "LV2"; "VG1"; "50"];
1768 ["lvcreate"; "LV3"; "VG2"; "50"];
1769 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1770 "list the LVM logical volumes (LVs)",
1772 List all the logical volumes detected. This is the equivalent
1773 of the L<lvs(8)> command.
1775 This returns a list of the logical volume device names
1776 (eg. C</dev/VolGroup00/LogVol00>).
1778 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1780 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1781 [], (* XXX how to test? *)
1782 "list the LVM physical volumes (PVs)",
1784 List all the physical volumes detected. This is the equivalent
1785 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1787 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1788 [], (* XXX how to test? *)
1789 "list the LVM volume groups (VGs)",
1791 List all the volumes groups detected. This is the equivalent
1792 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1794 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1795 [], (* XXX how to test? *)
1796 "list the LVM logical volumes (LVs)",
1798 List all the logical volumes detected. This is the equivalent
1799 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1801 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1802 [InitISOFS, Always, TestOutputList (
1803 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1804 InitISOFS, Always, TestOutputList (
1805 [["read_lines"; "/empty"]], [])],
1806 "read file as lines",
1808 Return the contents of the file named C<path>.
1810 The file contents are returned as a list of lines. Trailing
1811 C<LF> and C<CRLF> character sequences are I<not> returned.
1813 Note that this function cannot correctly handle binary files
1814 (specifically, files containing C<\\0> character which is treated
1815 as end of line). For those you need to use the C<guestfs_read_file>
1816 function which has a more complex interface.");
1818 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1819 [], (* XXX Augeas code needs tests. *)
1820 "create a new Augeas handle",
1822 Create a new Augeas handle for editing configuration files.
1823 If there was any previous Augeas handle associated with this
1824 guestfs session, then it is closed.
1826 You must call this before using any other C<guestfs_aug_*>
1829 C<root> is the filesystem root. C<root> must not be NULL,
1832 The flags are the same as the flags defined in
1833 E<lt>augeas.hE<gt>, the logical I<or> of the following
1838 =item C<AUG_SAVE_BACKUP> = 1
1840 Keep the original file with a C<.augsave> extension.
1842 =item C<AUG_SAVE_NEWFILE> = 2
1844 Save changes into a file with extension C<.augnew>, and
1845 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1847 =item C<AUG_TYPE_CHECK> = 4
1851 This option is only useful when debugging Augeas lenses. Use
1852 of this option may require additional memory for the libguestfs
1853 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1854 environment variable or call C<guestfs_set_memsize>.
1856 =item C<AUG_NO_STDINC> = 8
1858 Do not use standard load path for modules.
1860 =item C<AUG_SAVE_NOOP> = 16
1862 Make save a no-op, just record what would have been changed.
1864 =item C<AUG_NO_LOAD> = 32
1866 Do not load the tree in C<guestfs_aug_init>.
1870 To close the handle, you can call C<guestfs_aug_close>.
1872 To find out more about Augeas, see L<http://augeas.net/>.");
1874 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1875 [], (* XXX Augeas code needs tests. *)
1876 "close the current Augeas handle",
1878 Close the current Augeas handle and free up any resources
1879 used by it. After calling this, you have to call
1880 C<guestfs_aug_init> again before you can use any other
1881 Augeas functions.");
1883 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1884 [], (* XXX Augeas code needs tests. *)
1885 "define an Augeas variable",
1887 Defines an Augeas variable C<name> whose value is the result
1888 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1891 On success this returns the number of nodes in C<expr>, or
1892 C<0> if C<expr> evaluates to something which is not a nodeset.");
1894 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1895 [], (* XXX Augeas code needs tests. *)
1896 "define an Augeas node",
1898 Defines a variable C<name> whose value is the result of
1901 If C<expr> evaluates to an empty nodeset, a node is created,
1902 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1903 C<name> will be the nodeset containing that single node.
1905 On success this returns a pair containing the
1906 number of nodes in the nodeset, and a boolean flag
1907 if a node was created.");
1909 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1910 [], (* XXX Augeas code needs tests. *)
1911 "look up the value of an Augeas path",
1913 Look up the value associated with C<path>. If C<path>
1914 matches exactly one node, the C<value> is returned.");
1916 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1917 [], (* XXX Augeas code needs tests. *)
1918 "set Augeas path to value",
1920 Set the value associated with C<path> to C<val>.
1922 In the Augeas API, it is possible to clear a node by setting
1923 the value to NULL. Due to an oversight in the libguestfs API
1924 you cannot do that with this call. Instead you must use the
1925 C<guestfs_aug_clear> call.");
1927 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1928 [], (* XXX Augeas code needs tests. *)
1929 "insert a sibling Augeas node",
1931 Create a new sibling C<label> for C<path>, inserting it into
1932 the tree before or after C<path> (depending on the boolean
1935 C<path> must match exactly one existing node in the tree, and
1936 C<label> must be a label, ie. not contain C</>, C<*> or end
1937 with a bracketed index C<[N]>.");
1939 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1940 [], (* XXX Augeas code needs tests. *)
1941 "remove an Augeas path",
1943 Remove C<path> and all of its children.
1945 On success this returns the number of entries which were removed.");
1947 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1948 [], (* XXX Augeas code needs tests. *)
1951 Move the node C<src> to C<dest>. C<src> must match exactly
1952 one node. C<dest> is overwritten if it exists.");
1954 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1955 [], (* XXX Augeas code needs tests. *)
1956 "return Augeas nodes which match augpath",
1958 Returns a list of paths which match the path expression C<path>.
1959 The returned paths are sufficiently qualified so that they match
1960 exactly one node in the current tree.");
1962 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1963 [], (* XXX Augeas code needs tests. *)
1964 "write all pending Augeas changes to disk",
1966 This writes all pending changes to disk.
1968 The flags which were passed to C<guestfs_aug_init> affect exactly
1969 how files are saved.");
1971 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1972 [], (* XXX Augeas code needs tests. *)
1973 "load files into the tree",
1975 Load files into the tree.
1977 See C<aug_load> in the Augeas documentation for the full gory
1980 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1981 [], (* XXX Augeas code needs tests. *)
1982 "list Augeas nodes under augpath",
1984 This is just a shortcut for listing C<guestfs_aug_match>
1985 C<path/*> and sorting the resulting nodes into alphabetical order.");
1987 ("rm", (RErr, [Pathname "path"], []), 29, [],
1988 [InitScratchFS, Always, TestRun
1990 ["touch"; "/rm/new"];
1992 InitScratchFS, Always, TestLastFail
1993 [["rm"; "/nosuchfile"]];
1994 InitScratchFS, Always, TestLastFail
1999 Remove the single file C<path>.");
2001 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
2002 [InitScratchFS, Always, TestRun
2003 [["mkdir"; "/rmdir"];
2004 ["rmdir"; "/rmdir"]];
2005 InitScratchFS, Always, TestLastFail
2006 [["rmdir"; "/rmdir2"]];
2007 InitScratchFS, Always, TestLastFail
2008 [["mkdir"; "/rmdir3"];
2009 ["touch"; "/rmdir3/new"];
2010 ["rmdir"; "/rmdir3/new"]]],
2011 "remove a directory",
2013 Remove the single directory C<path>.");
2015 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
2016 [InitScratchFS, Always, TestOutputFalse
2017 [["mkdir"; "/rm_rf"];
2018 ["mkdir"; "/rm_rf/foo"];
2019 ["touch"; "/rm_rf/foo/bar"];
2020 ["rm_rf"; "/rm_rf"];
2021 ["exists"; "/rm_rf"]]],
2022 "remove a file or directory recursively",
2024 Remove the file or directory C<path>, recursively removing the
2025 contents if its a directory. This is like the C<rm -rf> shell
2028 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2029 [InitScratchFS, Always, TestOutputTrue
2030 [["mkdir"; "/mkdir"];
2031 ["is_dir"; "/mkdir"]];
2032 InitScratchFS, Always, TestLastFail
2033 [["mkdir"; "/mkdir2/foo/bar"]]],
2034 "create a directory",
2036 Create a directory named C<path>.");
2038 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2039 [InitScratchFS, Always, TestOutputTrue
2040 [["mkdir_p"; "/mkdir_p/foo/bar"];
2041 ["is_dir"; "/mkdir_p/foo/bar"]];
2042 InitScratchFS, Always, TestOutputTrue
2043 [["mkdir_p"; "/mkdir_p2/foo/bar"];
2044 ["is_dir"; "/mkdir_p2/foo"]];
2045 InitScratchFS, Always, TestOutputTrue
2046 [["mkdir_p"; "/mkdir_p3/foo/bar"];
2047 ["is_dir"; "/mkdir_p3"]];
2048 (* Regression tests for RHBZ#503133: *)
2049 InitScratchFS, Always, TestRun
2050 [["mkdir"; "/mkdir_p4"];
2051 ["mkdir_p"; "/mkdir_p4"]];
2052 InitScratchFS, Always, TestLastFail
2053 [["touch"; "/mkdir_p5"];
2054 ["mkdir_p"; "/mkdir_p5"]]],
2055 "create a directory and parents",
2057 Create a directory named C<path>, creating any parent directories
2058 as necessary. This is like the C<mkdir -p> shell command.");
2060 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2061 [], (* XXX Need stat command to test *)
2064 Change the mode (permissions) of C<path> to C<mode>. Only
2065 numeric modes are supported.
2067 I<Note>: When using this command from guestfish, C<mode>
2068 by default would be decimal, unless you prefix it with
2069 C<0> to get octal, ie. use C<0700> not C<700>.
2071 The mode actually set is affected by the umask.");
2073 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2074 [], (* XXX Need stat command to test *)
2075 "change file owner and group",
2077 Change the file owner to C<owner> and group to C<group>.
2079 Only numeric uid and gid are supported. If you want to use
2080 names, you will need to locate and parse the password file
2081 yourself (Augeas support makes this relatively easy).");
2083 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2084 [InitISOFS, Always, TestOutputTrue (
2085 [["exists"; "/empty"]]);
2086 InitISOFS, Always, TestOutputTrue (
2087 [["exists"; "/directory"]])],
2088 "test if file or directory exists",
2090 This returns C<true> if and only if there is a file, directory
2091 (or anything) with the given C<path> name.
2093 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2095 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2096 [InitISOFS, Always, TestOutputTrue (
2097 [["is_file"; "/known-1"]]);
2098 InitISOFS, Always, TestOutputFalse (
2099 [["is_file"; "/directory"]])],
2100 "test if a regular file",
2102 This returns C<true> if and only if there is a regular file
2103 with the given C<path> name. Note that it returns false for
2104 other objects like directories.
2106 See also C<guestfs_stat>.");
2108 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2109 [InitISOFS, Always, TestOutputFalse (
2110 [["is_dir"; "/known-3"]]);
2111 InitISOFS, Always, TestOutputTrue (
2112 [["is_dir"; "/directory"]])],
2113 "test if a directory",
2115 This returns C<true> if and only if there is a directory
2116 with the given C<path> name. Note that it returns false for
2117 other objects like files.
2119 See also C<guestfs_stat>.");
2121 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2122 [InitEmpty, Always, TestOutputListOfDevices (
2123 [["part_init"; "/dev/sda"; "mbr"];
2124 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2125 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2126 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2127 ["pvcreate"; "/dev/sda1"];
2128 ["pvcreate"; "/dev/sda2"];
2129 ["pvcreate"; "/dev/sda3"];
2130 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2131 "create an LVM physical volume",
2133 This creates an LVM physical volume on the named C<device>,
2134 where C<device> should usually be a partition name such
2137 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2138 [InitEmpty, Always, TestOutputList (
2139 [["part_init"; "/dev/sda"; "mbr"];
2140 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2141 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2142 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2143 ["pvcreate"; "/dev/sda1"];
2144 ["pvcreate"; "/dev/sda2"];
2145 ["pvcreate"; "/dev/sda3"];
2146 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2147 ["vgcreate"; "VG2"; "/dev/sda3"];
2148 ["vgs"]], ["VG1"; "VG2"])],
2149 "create an LVM volume group",
2151 This creates an LVM volume group called C<volgroup>
2152 from the non-empty list of physical volumes C<physvols>.");
2154 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2155 [InitEmpty, Always, TestOutputList (
2156 [["part_init"; "/dev/sda"; "mbr"];
2157 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2158 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2159 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2160 ["pvcreate"; "/dev/sda1"];
2161 ["pvcreate"; "/dev/sda2"];
2162 ["pvcreate"; "/dev/sda3"];
2163 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2164 ["vgcreate"; "VG2"; "/dev/sda3"];
2165 ["lvcreate"; "LV1"; "VG1"; "50"];
2166 ["lvcreate"; "LV2"; "VG1"; "50"];
2167 ["lvcreate"; "LV3"; "VG2"; "50"];
2168 ["lvcreate"; "LV4"; "VG2"; "50"];
2169 ["lvcreate"; "LV5"; "VG2"; "50"];
2171 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2172 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2173 "create an LVM logical volume",
2175 This creates an LVM logical volume called C<logvol>
2176 on the volume group C<volgroup>, with C<size> megabytes.");
2178 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2179 [InitEmpty, Always, TestOutput (
2180 [["part_disk"; "/dev/sda"; "mbr"];
2181 ["mkfs"; "ext2"; "/dev/sda1"];
2182 ["mount_options"; ""; "/dev/sda1"; "/"];
2183 ["write"; "/new"; "new file contents"];
2184 ["cat"; "/new"]], "new file contents")],
2185 "make a filesystem",
2187 This creates a filesystem on C<device> (usually a partition
2188 or LVM logical volume). The filesystem type is C<fstype>, for
2191 ("sfdisk", (RErr, [Device "device";
2192 Int "cyls"; Int "heads"; Int "sectors";
2193 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2195 "create partitions on a block device",
2197 This is a direct interface to the L<sfdisk(8)> program for creating
2198 partitions on block devices.
2200 C<device> should be a block device, for example C</dev/sda>.
2202 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2203 and sectors on the device, which are passed directly to sfdisk as
2204 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2205 of these, then the corresponding parameter is omitted. Usually for
2206 'large' disks, you can just pass C<0> for these, but for small
2207 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2208 out the right geometry and you will need to tell it.
2210 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2211 information refer to the L<sfdisk(8)> manpage.
2213 To create a single partition occupying the whole disk, you would
2214 pass C<lines> as a single element list, when the single element being
2215 the string C<,> (comma).
2217 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2218 C<guestfs_part_init>");
2220 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2221 (* Regression test for RHBZ#597135. *)
2222 [InitScratchFS, Always, TestLastFail
2223 [["write_file"; "/write_file"; "abc"; "10000"]]],
2226 This call creates a file called C<path>. The contents of the
2227 file is the string C<content> (which can contain any 8 bit data),
2228 with length C<size>.
2230 As a special case, if C<size> is C<0>
2231 then the length is calculated using C<strlen> (so in this case
2232 the content cannot contain embedded ASCII NULs).
2234 I<NB.> Owing to a bug, writing content containing ASCII NUL
2235 characters does I<not> work, even if the length is specified.");
2237 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2238 [InitEmpty, Always, TestOutputListOfDevices (
2239 [["part_disk"; "/dev/sda"; "mbr"];
2240 ["mkfs"; "ext2"; "/dev/sda1"];
2241 ["mount_options"; ""; "/dev/sda1"; "/"];
2242 ["mounts"]], ["/dev/sda1"]);
2243 InitEmpty, Always, TestOutputList (
2244 [["part_disk"; "/dev/sda"; "mbr"];
2245 ["mkfs"; "ext2"; "/dev/sda1"];
2246 ["mount_options"; ""; "/dev/sda1"; "/"];
2249 "unmount a filesystem",
2251 This unmounts the given filesystem. The filesystem may be
2252 specified either by its mountpoint (path) or the device which
2253 contains the filesystem.");
2255 ("mounts", (RStringList "devices", [], []), 46, [],
2256 [InitScratchFS, Always, TestOutputListOfDevices (
2257 [["mounts"]], ["/dev/sdb1"])],
2258 "show mounted filesystems",
2260 This returns the list of currently mounted filesystems. It returns
2261 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2263 Some internal mounts are not shown.
2265 See also: C<guestfs_mountpoints>");
2267 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2268 [InitScratchFS, Always, TestOutputList (
2271 (* check that umount_all can unmount nested mounts correctly: *)
2272 InitEmpty, Always, TestOutputList (
2273 [["part_init"; "/dev/sda"; "mbr"];
2274 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2275 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2276 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2277 ["mkfs"; "ext2"; "/dev/sda1"];
2278 ["mkfs"; "ext2"; "/dev/sda2"];
2279 ["mkfs"; "ext2"; "/dev/sda3"];
2280 ["mount_options"; ""; "/dev/sda1"; "/"];
2282 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2283 ["mkdir"; "/mp1/mp2"];
2284 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2285 ["mkdir"; "/mp1/mp2/mp3"];
2288 "unmount all filesystems",
2290 This unmounts all mounted filesystems.
2292 Some internal mounts are not unmounted by this call.");
2294 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2296 "remove all LVM LVs, VGs and PVs",
2298 This command removes all LVM logical volumes, volume groups
2299 and physical volumes.");
2301 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2302 [InitISOFS, Always, TestOutput (
2303 [["file"; "/empty"]], "empty");
2304 InitISOFS, Always, TestOutput (
2305 [["file"; "/known-1"]], "ASCII text");
2306 InitISOFS, Always, TestLastFail (
2307 [["file"; "/notexists"]]);
2308 InitISOFS, Always, TestOutput (
2309 [["file"; "/abssymlink"]], "symbolic link");
2310 InitISOFS, Always, TestOutput (
2311 [["file"; "/directory"]], "directory")],
2312 "determine file type",
2314 This call uses the standard L<file(1)> command to determine
2315 the type or contents of the file.
2317 This call will also transparently look inside various types
2320 The exact command which runs is C<file -zb path>. Note in
2321 particular that the filename is not prepended to the output
2324 The output depends on the output of the underlying L<file(1)>
2325 command and it can change in future in ways beyond our control.
2326 In other words, the output is not guaranteed by the ABI.
2328 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2329 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2331 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2332 [InitScratchFS, Always, TestOutput (
2333 [["mkdir"; "/command"];
2334 ["upload"; "test-command"; "/command/test-command"];
2335 ["chmod"; "0o755"; "/command/test-command"];
2336 ["command"; "/command/test-command 1"]], "Result1");
2337 InitScratchFS, Always, TestOutput (
2338 [["mkdir"; "/command2"];
2339 ["upload"; "test-command"; "/command2/test-command"];
2340 ["chmod"; "0o755"; "/command2/test-command"];
2341 ["command"; "/command2/test-command 2"]], "Result2\n");
2342 InitScratchFS, Always, TestOutput (
2343 [["mkdir"; "/command3"];
2344 ["upload"; "test-command"; "/command3/test-command"];
2345 ["chmod"; "0o755"; "/command3/test-command"];
2346 ["command"; "/command3/test-command 3"]], "\nResult3");
2347 InitScratchFS, Always, TestOutput (
2348 [["mkdir"; "/command4"];
2349 ["upload"; "test-command"; "/command4/test-command"];
2350 ["chmod"; "0o755"; "/command4/test-command"];
2351 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2352 InitScratchFS, Always, TestOutput (
2353 [["mkdir"; "/command5"];
2354 ["upload"; "test-command"; "/command5/test-command"];
2355 ["chmod"; "0o755"; "/command5/test-command"];
2356 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2357 InitScratchFS, Always, TestOutput (
2358 [["mkdir"; "/command6"];
2359 ["upload"; "test-command"; "/command6/test-command"];
2360 ["chmod"; "0o755"; "/command6/test-command"];
2361 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2362 InitScratchFS, Always, TestOutput (
2363 [["mkdir"; "/command7"];
2364 ["upload"; "test-command"; "/command7/test-command"];
2365 ["chmod"; "0o755"; "/command7/test-command"];
2366 ["command"; "/command7/test-command 7"]], "");
2367 InitScratchFS, Always, TestOutput (
2368 [["mkdir"; "/command8"];
2369 ["upload"; "test-command"; "/command8/test-command"];
2370 ["chmod"; "0o755"; "/command8/test-command"];
2371 ["command"; "/command8/test-command 8"]], "\n");
2372 InitScratchFS, Always, TestOutput (
2373 [["mkdir"; "/command9"];
2374 ["upload"; "test-command"; "/command9/test-command"];
2375 ["chmod"; "0o755"; "/command9/test-command"];
2376 ["command"; "/command9/test-command 9"]], "\n\n");
2377 InitScratchFS, Always, TestOutput (
2378 [["mkdir"; "/command10"];
2379 ["upload"; "test-command"; "/command10/test-command"];
2380 ["chmod"; "0o755"; "/command10/test-command"];
2381 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2382 InitScratchFS, Always, TestOutput (
2383 [["mkdir"; "/command11"];
2384 ["upload"; "test-command"; "/command11/test-command"];
2385 ["chmod"; "0o755"; "/command11/test-command"];
2386 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2387 InitScratchFS, Always, TestLastFail (
2388 [["mkdir"; "/command12"];
2389 ["upload"; "test-command"; "/command12/test-command"];
2390 ["chmod"; "0o755"; "/command12/test-command"];
2391 ["command"; "/command12/test-command"]])],
2392 "run a command from the guest filesystem",
2394 This call runs a command from the guest filesystem. The
2395 filesystem must be mounted, and must contain a compatible
2396 operating system (ie. something Linux, with the same
2397 or compatible processor architecture).
2399 The single parameter is an argv-style list of arguments.
2400 The first element is the name of the program to run.
2401 Subsequent elements are parameters. The list must be
2402 non-empty (ie. must contain a program name). Note that
2403 the command runs directly, and is I<not> invoked via
2404 the shell (see C<guestfs_sh>).
2406 The return value is anything printed to I<stdout> by
2409 If the command returns a non-zero exit status, then
2410 this function returns an error message. The error message
2411 string is the content of I<stderr> from the command.
2413 The C<$PATH> environment variable will contain at least
2414 C</usr/bin> and C</bin>. If you require a program from
2415 another location, you should provide the full path in the
2418 Shared libraries and data files required by the program
2419 must be available on filesystems which are mounted in the
2420 correct places. It is the caller's responsibility to ensure
2421 all filesystems that are needed are mounted at the right
2424 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2425 [InitScratchFS, Always, TestOutputList (
2426 [["mkdir"; "/command_lines"];
2427 ["upload"; "test-command"; "/command_lines/test-command"];
2428 ["chmod"; "0o755"; "/command_lines/test-command"];
2429 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2430 InitScratchFS, Always, TestOutputList (
2431 [["mkdir"; "/command_lines2"];
2432 ["upload"; "test-command"; "/command_lines2/test-command"];
2433 ["chmod"; "0o755"; "/command_lines2/test-command"];
2434 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2435 InitScratchFS, Always, TestOutputList (
2436 [["mkdir"; "/command_lines3"];
2437 ["upload"; "test-command"; "/command_lines3/test-command"];
2438 ["chmod"; "0o755"; "/command_lines3/test-command"];
2439 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2440 InitScratchFS, Always, TestOutputList (
2441 [["mkdir"; "/command_lines4"];
2442 ["upload"; "test-command"; "/command_lines4/test-command"];
2443 ["chmod"; "0o755"; "/command_lines4/test-command"];
2444 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2445 InitScratchFS, Always, TestOutputList (
2446 [["mkdir"; "/command_lines5"];
2447 ["upload"; "test-command"; "/command_lines5/test-command"];
2448 ["chmod"; "0o755"; "/command_lines5/test-command"];
2449 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2450 InitScratchFS, Always, TestOutputList (
2451 [["mkdir"; "/command_lines6"];
2452 ["upload"; "test-command"; "/command_lines6/test-command"];
2453 ["chmod"; "0o755"; "/command_lines6/test-command"];
2454 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2455 InitScratchFS, Always, TestOutputList (
2456 [["mkdir"; "/command_lines7"];
2457 ["upload"; "test-command"; "/command_lines7/test-command"];
2458 ["chmod"; "0o755"; "/command_lines7/test-command"];
2459 ["command_lines"; "/command_lines7/test-command 7"]], []);
2460 InitScratchFS, Always, TestOutputList (
2461 [["mkdir"; "/command_lines8"];
2462 ["upload"; "test-command"; "/command_lines8/test-command"];
2463 ["chmod"; "0o755"; "/command_lines8/test-command"];
2464 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2465 InitScratchFS, Always, TestOutputList (
2466 [["mkdir"; "/command_lines9"];
2467 ["upload"; "test-command"; "/command_lines9/test-command"];
2468 ["chmod"; "0o755"; "/command_lines9/test-command"];
2469 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2470 InitScratchFS, Always, TestOutputList (
2471 [["mkdir"; "/command_lines10"];
2472 ["upload"; "test-command"; "/command_lines10/test-command"];
2473 ["chmod"; "0o755"; "/command_lines10/test-command"];
2474 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2475 InitScratchFS, Always, TestOutputList (
2476 [["mkdir"; "/command_lines11"];
2477 ["upload"; "test-command"; "/command_lines11/test-command"];
2478 ["chmod"; "0o755"; "/command_lines11/test-command"];
2479 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2480 "run a command, returning lines",
2482 This is the same as C<guestfs_command>, but splits the
2483 result into a list of lines.
2485 See also: C<guestfs_sh_lines>");
2487 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2488 [InitISOFS, Always, TestOutputStruct (
2489 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2490 "get file information",
2492 Returns file information for the given C<path>.
2494 This is the same as the C<stat(2)> system call.");
2496 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2497 [InitISOFS, Always, TestOutputStruct (
2498 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2499 "get file information for a symbolic link",
2501 Returns file information for the given C<path>.
2503 This is the same as C<guestfs_stat> except that if C<path>
2504 is a symbolic link, then the link is stat-ed, not the file it
2507 This is the same as the C<lstat(2)> system call.");
2509 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2510 [InitISOFS, Always, TestOutputStruct (
2511 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2512 "get file system statistics",
2514 Returns file system statistics for any mounted file system.
2515 C<path> should be a file or directory in the mounted file system
2516 (typically it is the mount point itself, but it doesn't need to be).
2518 This is the same as the C<statvfs(2)> system call.");
2520 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2522 "get ext2/ext3/ext4 superblock details",
2524 This returns the contents of the ext2, ext3 or ext4 filesystem
2525 superblock on C<device>.
2527 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2528 manpage for more details. The list of fields returned isn't
2529 clearly defined, and depends on both the version of C<tune2fs>
2530 that libguestfs was built against, and the filesystem itself.");
2532 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2533 [InitEmpty, Always, TestOutputTrue (
2534 [["blockdev_setro"; "/dev/sda"];
2535 ["blockdev_getro"; "/dev/sda"]])],
2536 "set block device to read-only",
2538 Sets the block device named C<device> to read-only.
2540 This uses the L<blockdev(8)> command.");
2542 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2543 [InitEmpty, Always, TestOutputFalse (
2544 [["blockdev_setrw"; "/dev/sda"];
2545 ["blockdev_getro"; "/dev/sda"]])],
2546 "set block device to read-write",
2548 Sets the block device named C<device> to read-write.
2550 This uses the L<blockdev(8)> command.");
2552 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2553 [InitEmpty, Always, TestOutputTrue (
2554 [["blockdev_setro"; "/dev/sda"];
2555 ["blockdev_getro"; "/dev/sda"]])],
2556 "is block device set to read-only",
2558 Returns a boolean indicating if the block device is read-only
2559 (true if read-only, false if not).
2561 This uses the L<blockdev(8)> command.");
2563 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2564 [InitEmpty, Always, TestOutputInt (
2565 [["blockdev_getss"; "/dev/sda"]], 512)],
2566 "get sectorsize of block device",
2568 This returns the size of sectors on a block device.
2569 Usually 512, but can be larger for modern devices.
2571 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2574 This uses the L<blockdev(8)> command.");
2576 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2577 [InitEmpty, Always, TestOutputInt (
2578 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2579 "get blocksize of block device",
2581 This returns the block size of a device.
2583 (Note this is different from both I<size in blocks> and
2584 I<filesystem block size>).
2586 This uses the L<blockdev(8)> command.");
2588 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2590 "set blocksize of block device",
2592 This sets the block size of a device.
2594 (Note this is different from both I<size in blocks> and
2595 I<filesystem block size>).
2597 This uses the L<blockdev(8)> command.");
2599 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2600 [InitEmpty, Always, TestOutputInt (
2601 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2602 "get total size of device in 512-byte sectors",
2604 This returns the size of the device in units of 512-byte sectors
2605 (even if the sectorsize isn't 512 bytes ... weird).
2607 See also C<guestfs_blockdev_getss> for the real sector size of
2608 the device, and C<guestfs_blockdev_getsize64> for the more
2609 useful I<size in bytes>.
2611 This uses the L<blockdev(8)> command.");
2613 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2614 [InitEmpty, Always, TestOutputInt (
2615 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2616 "get total size of device in bytes",
2618 This returns the size of the device in bytes.
2620 See also C<guestfs_blockdev_getsz>.
2622 This uses the L<blockdev(8)> command.");
2624 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2625 [InitEmpty, Always, TestRun
2626 [["blockdev_flushbufs"; "/dev/sda"]]],
2627 "flush device buffers",
2629 This tells the kernel to flush internal buffers associated
2632 This uses the L<blockdev(8)> command.");
2634 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2635 [InitEmpty, Always, TestRun
2636 [["blockdev_rereadpt"; "/dev/sda"]]],
2637 "reread partition table",
2639 Reread the partition table on C<device>.
2641 This uses the L<blockdev(8)> command.");
2643 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2644 [InitScratchFS, Always, TestOutput (
2645 (* Pick a file from cwd which isn't likely to change. *)
2646 [["mkdir"; "/upload"];
2647 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2648 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2649 Digest.to_hex (Digest.file "COPYING.LIB"))],
2650 "upload a file from the local machine",
2652 Upload local file C<filename> to C<remotefilename> on the
2655 C<filename> can also be a named pipe.
2657 See also C<guestfs_download>.");
2659 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2660 [InitScratchFS, Always, TestOutput (
2661 (* Pick a file from cwd which isn't likely to change. *)
2662 [["mkdir"; "/download"];
2663 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2664 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2665 ["upload"; "testdownload.tmp"; "/download/upload"];
2666 ["checksum"; "md5"; "/download/upload"]],
2667 Digest.to_hex (Digest.file "COPYING.LIB"))],
2668 "download a file to the local machine",
2670 Download file C<remotefilename> and save it as C<filename>
2671 on the local machine.
2673 C<filename> can also be a named pipe.
2675 See also C<guestfs_upload>, C<guestfs_cat>.");
2677 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2678 [InitISOFS, Always, TestOutput (
2679 [["checksum"; "crc"; "/known-3"]], "2891671662");
2680 InitISOFS, Always, TestLastFail (
2681 [["checksum"; "crc"; "/notexists"]]);
2682 InitISOFS, Always, TestOutput (
2683 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2684 InitISOFS, Always, TestOutput (
2685 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2686 InitISOFS, Always, TestOutput (
2687 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2688 InitISOFS, Always, TestOutput (
2689 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2690 InitISOFS, Always, TestOutput (
2691 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2692 InitISOFS, Always, TestOutput (
2693 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2694 (* Test for RHBZ#579608, absolute symbolic links. *)
2695 InitISOFS, Always, TestOutput (
2696 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2697 "compute MD5, SHAx or CRC checksum of file",
2699 This call computes the MD5, SHAx or CRC checksum of the
2702 The type of checksum to compute is given by the C<csumtype>
2703 parameter which must have one of the following values:
2709 Compute the cyclic redundancy check (CRC) specified by POSIX
2710 for the C<cksum> command.
2714 Compute the MD5 hash (using the C<md5sum> program).
2718 Compute the SHA1 hash (using the C<sha1sum> program).
2722 Compute the SHA224 hash (using the C<sha224sum> program).
2726 Compute the SHA256 hash (using the C<sha256sum> program).
2730 Compute the SHA384 hash (using the C<sha384sum> program).
2734 Compute the SHA512 hash (using the C<sha512sum> program).
2738 The checksum is returned as a printable string.
2740 To get the checksum for a device, use C<guestfs_checksum_device>.
2742 To get the checksums for many files, use C<guestfs_checksums_out>.");
2744 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2745 [InitScratchFS, Always, TestOutput (
2746 [["mkdir"; "/tar_in"];
2747 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2748 ["cat"; "/tar_in/hello"]], "hello\n")],
2749 "unpack tarfile to directory",
2751 This command uploads and unpacks local file C<tarfile> (an
2752 I<uncompressed> tar file) into C<directory>.
2754 To upload a compressed tarball, use C<guestfs_tgz_in>
2755 or C<guestfs_txz_in>.");
2757 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2759 "pack directory into tarfile",
2761 This command packs the contents of C<directory> and downloads
2762 it to local file C<tarfile>.
2764 To download a compressed tarball, use C<guestfs_tgz_out>
2765 or C<guestfs_txz_out>.");
2767 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2768 [InitScratchFS, Always, TestOutput (
2769 [["mkdir"; "/tgz_in"];
2770 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2771 ["cat"; "/tgz_in/hello"]], "hello\n")],
2772 "unpack compressed tarball to directory",
2774 This command uploads and unpacks local file C<tarball> (a
2775 I<gzip compressed> tar file) into C<directory>.
2777 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2779 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2781 "pack directory into compressed tarball",
2783 This command packs the contents of C<directory> and downloads
2784 it to local file C<tarball>.
2786 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2788 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2789 [InitBasicFS, Always, TestLastFail (
2791 ["mount_ro"; "/dev/sda1"; "/"];
2792 ["touch"; "/new"]]);
2793 InitBasicFS, Always, TestOutput (
2794 [["write"; "/new"; "data"];
2796 ["mount_ro"; "/dev/sda1"; "/"];
2797 ["cat"; "/new"]], "data")],
2798 "mount a guest disk, read-only",
2800 This is the same as the C<guestfs_mount> command, but it
2801 mounts the filesystem with the read-only (I<-o ro>) flag.");
2803 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2805 "mount a guest disk with mount options",
2807 This is the same as the C<guestfs_mount> command, but it
2808 allows you to set the mount options as for the
2809 L<mount(8)> I<-o> flag.
2811 If the C<options> parameter is an empty string, then
2812 no options are passed (all options default to whatever
2813 the filesystem uses).");
2815 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2817 "mount a guest disk with mount options and vfstype",
2819 This is the same as the C<guestfs_mount> command, but it
2820 allows you to set both the mount options and the vfstype
2821 as for the L<mount(8)> I<-o> and I<-t> flags.");
2823 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2825 "debugging and internals",
2827 The C<guestfs_debug> command exposes some internals of
2828 C<guestfsd> (the guestfs daemon) that runs inside the
2831 There is no comprehensive help for this command. You have
2832 to look at the file C<daemon/debug.c> in the libguestfs source
2833 to find out what you can do.");
2835 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2836 [InitEmpty, Always, TestOutputList (
2837 [["part_disk"; "/dev/sda"; "mbr"];
2838 ["pvcreate"; "/dev/sda1"];
2839 ["vgcreate"; "VG"; "/dev/sda1"];
2840 ["lvcreate"; "LV1"; "VG"; "50"];
2841 ["lvcreate"; "LV2"; "VG"; "50"];
2842 ["lvremove"; "/dev/VG/LV1"];
2843 ["lvs"]], ["/dev/VG/LV2"]);
2844 InitEmpty, Always, TestOutputList (
2845 [["part_disk"; "/dev/sda"; "mbr"];
2846 ["pvcreate"; "/dev/sda1"];
2847 ["vgcreate"; "VG"; "/dev/sda1"];
2848 ["lvcreate"; "LV1"; "VG"; "50"];
2849 ["lvcreate"; "LV2"; "VG"; "50"];
2850 ["lvremove"; "/dev/VG"];
2852 InitEmpty, Always, TestOutputList (
2853 [["part_disk"; "/dev/sda"; "mbr"];
2854 ["pvcreate"; "/dev/sda1"];
2855 ["vgcreate"; "VG"; "/dev/sda1"];
2856 ["lvcreate"; "LV1"; "VG"; "50"];
2857 ["lvcreate"; "LV2"; "VG"; "50"];
2858 ["lvremove"; "/dev/VG"];
2860 "remove an LVM logical volume",
2862 Remove an LVM logical volume C<device>, where C<device> is
2863 the path to the LV, such as C</dev/VG/LV>.
2865 You can also remove all LVs in a volume group by specifying
2866 the VG name, C</dev/VG>.");
2868 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2869 [InitEmpty, Always, TestOutputList (
2870 [["part_disk"; "/dev/sda"; "mbr"];
2871 ["pvcreate"; "/dev/sda1"];
2872 ["vgcreate"; "VG"; "/dev/sda1"];
2873 ["lvcreate"; "LV1"; "VG"; "50"];
2874 ["lvcreate"; "LV2"; "VG"; "50"];
2877 InitEmpty, Always, TestOutputList (
2878 [["part_disk"; "/dev/sda"; "mbr"];
2879 ["pvcreate"; "/dev/sda1"];
2880 ["vgcreate"; "VG"; "/dev/sda1"];
2881 ["lvcreate"; "LV1"; "VG"; "50"];
2882 ["lvcreate"; "LV2"; "VG"; "50"];
2885 "remove an LVM volume group",
2887 Remove an LVM volume group C<vgname>, (for example C<VG>).
2889 This also forcibly removes all logical volumes in the volume
2892 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2893 [InitEmpty, Always, TestOutputListOfDevices (
2894 [["part_disk"; "/dev/sda"; "mbr"];
2895 ["pvcreate"; "/dev/sda1"];
2896 ["vgcreate"; "VG"; "/dev/sda1"];
2897 ["lvcreate"; "LV1"; "VG"; "50"];
2898 ["lvcreate"; "LV2"; "VG"; "50"];
2900 ["pvremove"; "/dev/sda1"];
2902 InitEmpty, Always, TestOutputListOfDevices (
2903 [["part_disk"; "/dev/sda"; "mbr"];
2904 ["pvcreate"; "/dev/sda1"];
2905 ["vgcreate"; "VG"; "/dev/sda1"];
2906 ["lvcreate"; "LV1"; "VG"; "50"];
2907 ["lvcreate"; "LV2"; "VG"; "50"];
2909 ["pvremove"; "/dev/sda1"];
2911 InitEmpty, Always, TestOutputListOfDevices (
2912 [["part_disk"; "/dev/sda"; "mbr"];
2913 ["pvcreate"; "/dev/sda1"];
2914 ["vgcreate"; "VG"; "/dev/sda1"];
2915 ["lvcreate"; "LV1"; "VG"; "50"];
2916 ["lvcreate"; "LV2"; "VG"; "50"];
2918 ["pvremove"; "/dev/sda1"];
2920 "remove an LVM physical volume",
2922 This wipes a physical volume C<device> so that LVM will no longer
2925 The implementation uses the C<pvremove> command which refuses to
2926 wipe physical volumes that contain any volume groups, so you have
2927 to remove those first.");
2929 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2930 [InitBasicFS, Always, TestOutput (
2931 [["set_e2label"; "/dev/sda1"; "testlabel"];
2932 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2933 "set the ext2/3/4 filesystem label",
2935 This sets the ext2/3/4 filesystem label of the filesystem on
2936 C<device> to C<label>. Filesystem labels are limited to
2939 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2940 to return the existing label on a filesystem.");
2942 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2944 "get the ext2/3/4 filesystem label",
2946 This returns the ext2/3/4 filesystem label of the filesystem on
2949 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2950 (let uuid = uuidgen () in
2951 [InitBasicFS, Always, TestOutput (
2952 [["set_e2uuid"; "/dev/sda1"; uuid];
2953 ["get_e2uuid"; "/dev/sda1"]], uuid);
2954 InitBasicFS, Always, TestOutput (
2955 [["set_e2uuid"; "/dev/sda1"; "clear"];
2956 ["get_e2uuid"; "/dev/sda1"]], "");
2957 (* We can't predict what UUIDs will be, so just check the commands run. *)
2958 InitBasicFS, Always, TestRun (
2959 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2960 InitBasicFS, Always, TestRun (
2961 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2962 "set the ext2/3/4 filesystem UUID",
2964 This sets the ext2/3/4 filesystem UUID of the filesystem on
2965 C<device> to C<uuid>. The format of the UUID and alternatives
2966 such as C<clear>, C<random> and C<time> are described in the
2967 L<tune2fs(8)> manpage.
2969 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2970 to return the existing UUID of a filesystem.");
2972 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2973 (* Regression test for RHBZ#597112. *)
2974 (let uuid = uuidgen () in
2975 [InitNone, Always, TestOutput (
2976 [["mke2journal"; "1024"; "/dev/sdc"];
2977 ["set_e2uuid"; "/dev/sdc"; uuid];
2978 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2979 "get the ext2/3/4 filesystem UUID",
2981 This returns the ext2/3/4 filesystem UUID of the filesystem on
2984 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2985 [InitBasicFS, Always, TestOutputInt (
2986 [["umount"; "/dev/sda1"];
2987 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2988 InitBasicFS, Always, TestOutputInt (
2989 [["umount"; "/dev/sda1"];
2990 ["zero"; "/dev/sda1"];
2991 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2992 "run the filesystem checker",
2994 This runs the filesystem checker (fsck) on C<device> which
2995 should have filesystem type C<fstype>.
2997 The returned integer is the status. See L<fsck(8)> for the
2998 list of status codes from C<fsck>.
3006 Multiple status codes can be summed together.
3010 A non-zero return code can mean \"success\", for example if
3011 errors have been corrected on the filesystem.
3015 Checking or repairing NTFS volumes is not supported
3020 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3022 ("zero", (RErr, [Device "device"], []), 85, [Progress],
3023 [InitBasicFS, Always, TestRun (
3024 [["umount"; "/dev/sda1"];
3025 ["zero"; "/dev/sda1"]])],
3026 "write zeroes to the device",
3028 This command writes zeroes over the first few blocks of C<device>.
3030 How many blocks are zeroed isn't specified (but it's I<not> enough
3031 to securely wipe the device). It should be sufficient to remove
3032 any partition tables, filesystem superblocks and so on.
3034 If blocks are already zero, then this command avoids writing
3035 zeroes. This prevents the underlying device from becoming non-sparse
3036 or growing unnecessarily.
3038 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3039 C<guestfs_is_zero_device>");
3041 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3043 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3044 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3046 [InitBasicFS, Always, TestOutputTrue (
3047 [["mkdir_p"; "/boot/grub"];
3048 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3049 ["grub_install"; "/"; "/dev/vda"];
3050 ["is_dir"; "/boot"]])],
3053 This command installs GRUB 1 (the Grand Unified Bootloader) on
3054 C<device>, with the root directory being C<root>.
3062 There is currently no way in the API to install grub2, which
3063 is used by most modern Linux guests. It is possible to run
3064 the grub2 command from the guest, although see the
3065 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3069 This uses C<grub-install> from the host. Unfortunately grub is
3070 not always compatible with itself, so this only works in rather
3071 narrow circumstances. Careful testing with each guest version
3076 If grub-install reports the error
3077 \"No suitable drive was found in the generated device map.\"
3078 it may be that you need to create a C</boot/grub/device.map>
3079 file first that contains the mapping between grub device names
3080 and Linux device names. It is usually sufficient to create
3085 replacing C</dev/vda> with the name of the installation device.
3089 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3090 [InitScratchFS, Always, TestOutput (
3092 ["write"; "/cp/old"; "file content"];
3093 ["cp"; "/cp/old"; "/cp/new"];
3094 ["cat"; "/cp/new"]], "file content");
3095 InitScratchFS, Always, TestOutputTrue (
3097 ["write"; "/cp2/old"; "file content"];
3098 ["cp"; "/cp2/old"; "/cp2/new"];
3099 ["is_file"; "/cp2/old"]]);
3100 InitScratchFS, Always, TestOutput (
3102 ["write"; "/cp3/old"; "file content"];
3103 ["mkdir"; "/cp3/dir"];
3104 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3105 ["cat"; "/cp3/dir/new"]], "file content")],
3108 This copies a file from C<src> to C<dest> where C<dest> is
3109 either a destination filename or destination directory.");
3111 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3112 [InitScratchFS, Always, TestOutput (
3113 [["mkdir"; "/cp_a1"];
3114 ["mkdir"; "/cp_a2"];
3115 ["write"; "/cp_a1/file"; "file content"];
3116 ["cp_a"; "/cp_a1"; "/cp_a2"];
3117 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3118 "copy a file or directory recursively",
3120 This copies a file or directory from C<src> to C<dest>
3121 recursively using the C<cp -a> command.");
3123 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3124 [InitScratchFS, Always, TestOutput (
3126 ["write"; "/mv/old"; "file content"];
3127 ["mv"; "/mv/old"; "/mv/new"];
3128 ["cat"; "/mv/new"]], "file content");
3129 InitScratchFS, Always, TestOutputFalse (
3131 ["write"; "/mv2/old"; "file content"];
3132 ["mv"; "/mv2/old"; "/mv2/new"];
3133 ["is_file"; "/mv2/old"]])],
3136 This moves a file from C<src> to C<dest> where C<dest> is
3137 either a destination filename or destination directory.");
3139 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3140 [InitEmpty, Always, TestRun (
3141 [["drop_caches"; "3"]])],
3142 "drop kernel page cache, dentries and inodes",
3144 This instructs the guest kernel to drop its page cache,
3145 and/or dentries and inode caches. The parameter C<whattodrop>
3146 tells the kernel what precisely to drop, see
3147 L<http://linux-mm.org/Drop_Caches>
3149 Setting C<whattodrop> to 3 should drop everything.
3151 This automatically calls L<sync(2)> before the operation,
3152 so that the maximum guest memory is freed.");
3154 ("dmesg", (RString "kmsgs", [], []), 91, [],
3155 [InitEmpty, Always, TestRun (
3157 "return kernel messages",
3159 This returns the kernel messages (C<dmesg> output) from
3160 the guest kernel. This is sometimes useful for extended
3161 debugging of problems.
3163 Another way to get the same information is to enable
3164 verbose messages with C<guestfs_set_verbose> or by setting
3165 the environment variable C<LIBGUESTFS_DEBUG=1> before
3166 running the program.");
3168 ("ping_daemon", (RErr, [], []), 92, [],
3169 [InitEmpty, Always, TestRun (
3170 [["ping_daemon"]])],
3171 "ping the guest daemon",
3173 This is a test probe into the guestfs daemon running inside
3174 the qemu subprocess. Calling this function checks that the
3175 daemon responds to the ping message, without affecting the daemon
3176 or attached block device(s) in any other way.");
3178 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3179 [InitScratchFS, Always, TestOutputTrue (
3180 [["mkdir"; "/equal"];
3181 ["write"; "/equal/file1"; "contents of a file"];
3182 ["cp"; "/equal/file1"; "/equal/file2"];
3183 ["equal"; "/equal/file1"; "/equal/file2"]]);
3184 InitScratchFS, Always, TestOutputFalse (
3185 [["mkdir"; "/equal2"];
3186 ["write"; "/equal2/file1"; "contents of a file"];
3187 ["write"; "/equal2/file2"; "contents of another file"];
3188 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3189 InitScratchFS, Always, TestLastFail (
3190 [["mkdir"; "/equal3"];
3191 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3192 "test if two files have equal contents",
3194 This compares the two files C<file1> and C<file2> and returns
3195 true if their content is exactly equal, or false otherwise.
3197 The external L<cmp(1)> program is used for the comparison.");
3199 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3200 [InitISOFS, Always, TestOutputList (
3201 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3202 InitISOFS, Always, TestOutputList (
3203 [["strings"; "/empty"]], []);
3204 (* Test for RHBZ#579608, absolute symbolic links. *)
3205 InitISOFS, Always, TestRun (
3206 [["strings"; "/abssymlink"]])],
3207 "print the printable strings in a file",
3209 This runs the L<strings(1)> command on a file and returns
3210 the list of printable strings found.");
3212 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3213 [InitISOFS, Always, TestOutputList (
3214 [["strings_e"; "b"; "/known-5"]], []);
3215 InitScratchFS, Always, TestOutputList (
3216 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3217 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3218 "print the printable strings in a file",
3220 This is like the C<guestfs_strings> command, but allows you to
3221 specify the encoding of strings that are looked for in
3222 the source file C<path>.
3224 Allowed encodings are:
3230 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3231 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3235 Single 8-bit-byte characters.
3239 16-bit big endian strings such as those encoded in
3240 UTF-16BE or UCS-2BE.
3242 =item l (lower case letter L)
3244 16-bit little endian such as UTF-16LE and UCS-2LE.
3245 This is useful for examining binaries in Windows guests.
3249 32-bit big endian such as UCS-4BE.
3253 32-bit little endian such as UCS-4LE.
3257 The returned strings are transcoded to UTF-8.");
3259 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3260 [InitISOFS, Always, TestOutput (
3261 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3262 (* Test for RHBZ#501888c2 regression which caused large hexdump
3263 * commands to segfault.
3265 InitISOFS, Always, TestRun (
3266 [["hexdump"; "/100krandom"]]);
3267 (* Test for RHBZ#579608, absolute symbolic links. *)
3268 InitISOFS, Always, TestRun (
3269 [["hexdump"; "/abssymlink"]])],
3270 "dump a file in hexadecimal",
3272 This runs C<hexdump -C> on the given C<path>. The result is
3273 the human-readable, canonical hex dump of the file.");
3275 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3276 [InitNone, Always, TestOutput (
3277 [["part_disk"; "/dev/sda"; "mbr"];
3278 ["mkfs"; "ext3"; "/dev/sda1"];
3279 ["mount_options"; ""; "/dev/sda1"; "/"];
3280 ["write"; "/new"; "test file"];
3281 ["umount"; "/dev/sda1"];
3282 ["zerofree"; "/dev/sda1"];
3283 ["mount_options"; ""; "/dev/sda1"; "/"];
3284 ["cat"; "/new"]], "test file")],
3285 "zero unused inodes and disk blocks on ext2/3 filesystem",
3287 This runs the I<zerofree> program on C<device>. This program
3288 claims to zero unused inodes and disk blocks on an ext2/3
3289 filesystem, thus making it possible to compress the filesystem
3292 You should B<not> run this program if the filesystem is
3295 It is possible that using this program can damage the filesystem
3296 or data on the filesystem.");
3298 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3300 "resize an LVM physical volume",
3302 This resizes (expands or shrinks) an existing LVM physical
3303 volume to match the new size of the underlying device.");
3305 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3306 Int "cyls"; Int "heads"; Int "sectors";
3307 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3309 "modify a single partition on a block device",
3311 This runs L<sfdisk(8)> option to modify just the single
3312 partition C<n> (note: C<n> counts from 1).
3314 For other parameters, see C<guestfs_sfdisk>. You should usually
3315 pass C<0> for the cyls/heads/sectors parameters.
3317 See also: C<guestfs_part_add>");
3319 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3321 "display the partition table",
3323 This displays the partition table on C<device>, in the
3324 human-readable output of the L<sfdisk(8)> command. It is
3325 not intended to be parsed.
3327 See also: C<guestfs_part_list>");
3329 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3331 "display the kernel geometry",
3333 This displays the kernel's idea of the geometry of C<device>.
3335 The result is in human-readable format, and not designed to
3338 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3340 "display the disk geometry from the partition table",
3342 This displays the disk geometry of C<device> read from the
3343 partition table. Especially in the case where the underlying
3344 block device has been resized, this can be different from the
3345 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3347 The result is in human-readable format, and not designed to
3350 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3352 "activate or deactivate all volume groups",
3354 This command activates or (if C<activate> is false) deactivates
3355 all logical volumes in all volume groups.
3357 This command is the same as running C<vgchange -a y|n>");
3359 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3361 "activate or deactivate some volume groups",
3363 This command activates or (if C<activate> is false) deactivates
3364 all logical volumes in the listed volume groups C<volgroups>.
3366 This command is the same as running C<vgchange -a y|n volgroups...>
3368 Note that if C<volgroups> is an empty list then B<all> volume groups
3369 are activated or deactivated.");
3371 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3372 [InitNone, Always, TestOutput (
3373 [["part_disk"; "/dev/sda"; "mbr"];
3374 ["pvcreate"; "/dev/sda1"];
3375 ["vgcreate"; "VG"; "/dev/sda1"];
3376 ["lvcreate"; "LV"; "VG"; "10"];
3377 ["mkfs"; "ext2"; "/dev/VG/LV"];
3378 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3379 ["write"; "/new"; "test content"];
3381 ["lvresize"; "/dev/VG/LV"; "20"];
3382 ["e2fsck_f"; "/dev/VG/LV"];
3383 ["resize2fs"; "/dev/VG/LV"];
3384 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3385 ["cat"; "/new"]], "test content");
3386 InitNone, Always, TestRun (
3387 (* Make an LV smaller to test RHBZ#587484. *)
3388 [["part_disk"; "/dev/sda"; "mbr"];
3389 ["pvcreate"; "/dev/sda1"];
3390 ["vgcreate"; "VG"; "/dev/sda1"];
3391 ["lvcreate"; "LV"; "VG"; "20"];
3392 ["lvresize"; "/dev/VG/LV"; "10"]])],
3393 "resize an LVM logical volume",
3395 This resizes (expands or shrinks) an existing LVM logical
3396 volume to C<mbytes>. When reducing, data in the reduced part
3399 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3400 [], (* lvresize tests this *)
3401 "resize an ext2, ext3 or ext4 filesystem",
3403 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3404 the underlying device.
3406 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3407 on the C<device> before calling this command. For unknown reasons
3408 C<resize2fs> sometimes gives an error about this and sometimes not.
3409 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3410 calling this function.");
3412 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3413 [InitBasicFS, Always, TestOutputList (
3414 [["find"; "/"]], ["lost+found"]);
3415 InitBasicFS, Always, TestOutputList (
3419 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3420 InitScratchFS, Always, TestOutputList (
3421 [["mkdir_p"; "/find/b/c"];
3422 ["touch"; "/find/b/c/d"];
3423 ["find"; "/find/b/"]], ["c"; "c/d"])],
3424 "find all files and directories",
3426 This command lists out all files and directories, recursively,
3427 starting at C<directory>. It is essentially equivalent to
3428 running the shell command C<find directory -print> but some
3429 post-processing happens on the output, described below.
3431 This returns a list of strings I<without any prefix>. Thus
3432 if the directory structure was:
3438 then the returned list from C<guestfs_find> C</tmp> would be
3446 If C<directory> is not a directory, then this command returns
3449 The returned list is sorted.
3451 See also C<guestfs_find0>.");
3453 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3454 [], (* lvresize tests this *)
3455 "check an ext2/ext3 filesystem",
3457 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3458 filesystem checker on C<device>, noninteractively (I<-p>),
3459 even if the filesystem appears to be clean (I<-f>).
3461 This command is only needed because of C<guestfs_resize2fs>
3462 (q.v.). Normally you should use C<guestfs_fsck>.");
3464 ("sleep", (RErr, [Int "secs"], []), 109, [],
3465 [InitNone, Always, TestRun (
3467 "sleep for some seconds",
3469 Sleep for C<secs> seconds.");
3471 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3472 [InitNone, Always, TestOutputInt (
3473 [["part_disk"; "/dev/sda"; "mbr"];
3474 ["mkfs"; "ntfs"; "/dev/sda1"];
3475 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3476 InitNone, Always, TestOutputInt (
3477 [["part_disk"; "/dev/sda"; "mbr"];
3478 ["mkfs"; "ext2"; "/dev/sda1"];
3479 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3480 "probe NTFS volume",
3482 This command runs the L<ntfs-3g.probe(8)> command which probes
3483 an NTFS C<device> for mountability. (Not all NTFS volumes can
3484 be mounted read-write, and some cannot be mounted at all).
3486 C<rw> is a boolean flag. Set it to true if you want to test
3487 if the volume can be mounted read-write. Set it to false if
3488 you want to test if the volume can be mounted read-only.
3490 The return value is an integer which C<0> if the operation
3491 would succeed, or some non-zero value documented in the
3492 L<ntfs-3g.probe(8)> manual page.");
3494 ("sh", (RString "output", [String "command"], []), 111, [],
3495 [], (* XXX needs tests *)
3496 "run a command via the shell",
3498 This call runs a command from the guest filesystem via the
3501 This is like C<guestfs_command>, but passes the command to:
3503 /bin/sh -c \"command\"
3505 Depending on the guest's shell, this usually results in
3506 wildcards being expanded, shell expressions being interpolated
3509 All the provisos about C<guestfs_command> apply to this call.");
3511 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3512 [], (* XXX needs tests *)
3513 "run a command via the shell returning lines",
3515 This is the same as C<guestfs_sh>, but splits the result
3516 into a list of lines.
3518 See also: C<guestfs_command_lines>");
3520 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3521 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3522 * code in stubs.c, since all valid glob patterns must start with "/".
3523 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3525 [InitScratchFS, Always, TestOutputList (
3526 [["mkdir_p"; "/glob_expand/b/c"];
3527 ["touch"; "/glob_expand/b/c/d"];
3528 ["touch"; "/glob_expand/b/c/e"];
3529 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3530 InitScratchFS, Always, TestOutputList (
3531 [["mkdir_p"; "/glob_expand2/b/c"];
3532 ["touch"; "/glob_expand2/b/c/d"];
3533 ["touch"; "/glob_expand2/b/c/e"];
3534 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3535 InitScratchFS, Always, TestOutputList (
3536 [["mkdir_p"; "/glob_expand3/b/c"];
3537 ["touch"; "/glob_expand3/b/c/d"];
3538 ["touch"; "/glob_expand3/b/c/e"];
3539 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3540 "expand a wildcard path",
3542 This command searches for all the pathnames matching
3543 C<pattern> according to the wildcard expansion rules
3546 If no paths match, then this returns an empty list
3547 (note: not an error).
3549 It is just a wrapper around the C L<glob(3)> function
3550 with flags C<GLOB_MARK|GLOB_BRACE>.
3551 See that manual page for more details.");
3553 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3554 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3555 [["scrub_device"; "/dev/sdc"]])],
3556 "scrub (securely wipe) a device",
3558 This command writes patterns over C<device> to make data retrieval
3561 It is an interface to the L<scrub(1)> program. See that
3562 manual page for more details.");
3564 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3565 [InitScratchFS, Always, TestRun (
3566 [["write"; "/scrub_file"; "content"];
3567 ["scrub_file"; "/scrub_file"]])],
3568 "scrub (securely wipe) a file",
3570 This command writes patterns over a file to make data retrieval
3573 The file is I<removed> after scrubbing.
3575 It is an interface to the L<scrub(1)> program. See that
3576 manual page for more details.");
3578 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3579 [], (* XXX needs testing *)
3580 "scrub (securely wipe) free space",
3582 This command creates the directory C<dir> and then fills it
3583 with files until the filesystem is full, and scrubs the files
3584 as for C<guestfs_scrub_file>, and deletes them.
3585 The intention is to scrub any free space on the partition
3588 It is an interface to the L<scrub(1)> program. See that
3589 manual page for more details.");
3591 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3592 [InitScratchFS, Always, TestRun (
3593 [["mkdir"; "/mkdtemp"];
3594 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3595 "create a temporary directory",
3597 This command creates a temporary directory. The
3598 C<template> parameter should be a full pathname for the
3599 temporary directory name with the final six characters being
3602 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3603 the second one being suitable for Windows filesystems.
3605 The name of the temporary directory that was created
3608 The temporary directory is created with mode 0700
3609 and is owned by root.
3611 The caller is responsible for deleting the temporary
3612 directory and its contents after use.
3614 See also: L<mkdtemp(3)>");
3616 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3617 [InitISOFS, Always, TestOutputInt (
3618 [["wc_l"; "/10klines"]], 10000);
3619 (* Test for RHBZ#579608, absolute symbolic links. *)
3620 InitISOFS, Always, TestOutputInt (
3621 [["wc_l"; "/abssymlink"]], 10000)],
3622 "count lines in a file",
3624 This command counts the lines in a file, using the
3625 C<wc -l> external command.");
3627 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3628 [InitISOFS, Always, TestOutputInt (
3629 [["wc_w"; "/10klines"]], 10000)],
3630 "count words in a file",
3632 This command counts the words in a file, using the
3633 C<wc -w> external command.");
3635 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3636 [InitISOFS, Always, TestOutputInt (
3637 [["wc_c"; "/100kallspaces"]], 102400)],
3638 "count characters in a file",
3640 This command counts the characters in a file, using the
3641 C<wc -c> external command.");
3643 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3644 [InitISOFS, Always, TestOutputList (
3645 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3646 (* Test for RHBZ#579608, absolute symbolic links. *)
3647 InitISOFS, Always, TestOutputList (
3648 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3649 "return first 10 lines of a file",
3651 This command returns up to the first 10 lines of a file as
3652 a list of strings.");
3654 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3655 [InitISOFS, Always, TestOutputList (
3656 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3657 InitISOFS, Always, TestOutputList (
3658 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3659 InitISOFS, Always, TestOutputList (
3660 [["head_n"; "0"; "/10klines"]], [])],
3661 "return first N lines of a file",
3663 If the parameter C<nrlines> is a positive number, this returns the first
3664 C<nrlines> lines of the file C<path>.
3666 If the parameter C<nrlines> is a negative number, this returns lines
3667 from the file C<path>, excluding the last C<nrlines> lines.
3669 If the parameter C<nrlines> is zero, this returns an empty list.");
3671 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3672 [InitISOFS, Always, TestOutputList (
3673 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3674 "return last 10 lines of a file",
3676 This command returns up to the last 10 lines of a file as
3677 a list of strings.");
3679 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3680 [InitISOFS, Always, TestOutputList (
3681 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3682 InitISOFS, Always, TestOutputList (
3683 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3684 InitISOFS, Always, TestOutputList (
3685 [["tail_n"; "0"; "/10klines"]], [])],
3686 "return last N lines of a file",
3688 If the parameter C<nrlines> is a positive number, this returns the last
3689 C<nrlines> lines of the file C<path>.
3691 If the parameter C<nrlines> is a negative number, this returns lines
3692 from the file C<path>, starting with the C<-nrlines>th line.
3694 If the parameter C<nrlines> is zero, this returns an empty list.");
3696 ("df", (RString "output", [], []), 125, [],
3697 [], (* XXX Tricky to test because it depends on the exact format
3698 * of the 'df' command and other imponderables.
3700 "report file system disk space usage",
3702 This command runs the C<df> command to report disk space used.
3704 This command is mostly useful for interactive sessions. It
3705 is I<not> intended that you try to parse the output string.
3706 Use C<guestfs_statvfs> from programs.");
3708 ("df_h", (RString "output", [], []), 126, [],
3709 [], (* XXX Tricky to test because it depends on the exact format
3710 * of the 'df' command and other imponderables.
3712 "report file system disk space usage (human readable)",
3714 This command runs the C<df -h> command to report disk space used
3715 in human-readable format.
3717 This command is mostly useful for interactive sessions. It
3718 is I<not> intended that you try to parse the output string.
3719 Use C<guestfs_statvfs> from programs.");
3721 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3722 [InitISOFS, Always, TestOutputInt (
3723 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3724 "estimate file space usage",
3726 This command runs the C<du -s> command to estimate file space
3729 C<path> can be a file or a directory. If C<path> is a directory
3730 then the estimate includes the contents of the directory and all
3731 subdirectories (recursively).
3733 The result is the estimated size in I<kilobytes>
3734 (ie. units of 1024 bytes).");
3736 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3737 [InitISOFS, Always, TestOutputList (
3738 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3739 "list files in an initrd",
3741 This command lists out files contained in an initrd.
3743 The files are listed without any initial C</> character. The
3744 files are listed in the order they appear (not necessarily
3745 alphabetical). Directory names are listed as separate items.
3747 Old Linux kernels (2.4 and earlier) used a compressed ext2
3748 filesystem as initrd. We I<only> support the newer initramfs
3749 format (compressed cpio files).");
3751 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3753 "mount a file using the loop device",
3755 This command lets you mount C<file> (a filesystem image
3756 in a file) on a mount point. It is entirely equivalent to
3757 the command C<mount -o loop file mountpoint>.");
3759 ("mkswap", (RErr, [Device "device"], []), 130, [],
3760 [InitEmpty, Always, TestRun (
3761 [["part_disk"; "/dev/sda"; "mbr"];
3762 ["mkswap"; "/dev/sda1"]])],
3763 "create a swap partition",
3765 Create a swap partition on C<device>.");
3767 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3768 [InitEmpty, Always, TestRun (
3769 [["part_disk"; "/dev/sda"; "mbr"];
3770 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3771 "create a swap partition with a label",
3773 Create a swap partition on C<device> with label C<label>.
3775 Note that you cannot attach a swap label to a block device
3776 (eg. C</dev/sda>), just to a partition. This appears to be
3777 a limitation of the kernel or swap tools.");
3779 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3780 (let uuid = uuidgen () in
3781 [InitEmpty, Always, TestRun (
3782 [["part_disk"; "/dev/sda"; "mbr"];
3783 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3784 "create a swap partition with an explicit UUID",
3786 Create a swap partition on C<device> with UUID C<uuid>.");
3788 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3789 [InitScratchFS, Always, TestOutputStruct (
3790 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3791 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3792 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3793 InitScratchFS, Always, TestOutputStruct (
3794 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3795 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3796 "make block, character or FIFO devices",
3798 This call creates block or character special devices, or
3799 named pipes (FIFOs).
3801 The C<mode> parameter should be the mode, using the standard
3802 constants. C<devmajor> and C<devminor> are the
3803 device major and minor numbers, only used when creating block
3804 and character special devices.
3806 Note that, just like L<mknod(2)>, the mode must be bitwise
3807 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3808 just creates a regular file). These constants are
3809 available in the standard Linux header files, or you can use
3810 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3811 which are wrappers around this command which bitwise OR
3812 in the appropriate constant for you.
3814 The mode actually set is affected by the umask.");
3816 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3817 [InitScratchFS, Always, TestOutputStruct (
3818 [["mkfifo"; "0o777"; "/mkfifo"];
3819 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3820 "make FIFO (named pipe)",
3822 This call creates a FIFO (named pipe) called C<path> with
3823 mode C<mode>. It is just a convenient wrapper around
3826 The mode actually set is affected by the umask.");
3828 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3829 [InitScratchFS, Always, TestOutputStruct (
3830 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3831 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3832 "make block device node",
3834 This call creates a block device node called C<path> with
3835 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3836 It is just a convenient wrapper around C<guestfs_mknod>.
3838 The mode actually set is affected by the umask.");
3840 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3841 [InitScratchFS, Always, TestOutputStruct (
3842 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3843 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3844 "make char device node",
3846 This call creates a char device node called C<path> with
3847 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3848 It is just a convenient wrapper around C<guestfs_mknod>.
3850 The mode actually set is affected by the umask.");
3852 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3853 [InitEmpty, Always, TestOutputInt (
3854 [["umask"; "0o22"]], 0o22)],
3855 "set file mode creation mask (umask)",
3857 This function sets the mask used for creating new files and
3858 device nodes to C<mask & 0777>.
3860 Typical umask values would be C<022> which creates new files
3861 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3862 C<002> which creates new files with permissions like
3863 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3865 The default umask is C<022>. This is important because it
3866 means that directories and device nodes will be created with
3867 C<0644> or C<0755> mode even if you specify C<0777>.
3869 See also C<guestfs_get_umask>,
3870 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3872 This call returns the previous umask.");
3874 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3876 "read directories entries",
3878 This returns the list of directory entries in directory C<dir>.
3880 All entries in the directory are returned, including C<.> and
3881 C<..>. The entries are I<not> sorted, but returned in the same
3882 order as the underlying filesystem.
3884 Also this call returns basic file type information about each
3885 file. The C<ftyp> field will contain one of the following characters:
3923 The L<readdir(3)> call returned a C<d_type> field with an
3928 This function is primarily intended for use by programs. To
3929 get a simple list of names, use C<guestfs_ls>. To get a printable
3930 directory for human consumption, use C<guestfs_ll>.");
3932 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3934 "create partitions on a block device",
3936 This is a simplified interface to the C<guestfs_sfdisk>
3937 command, where partition sizes are specified in megabytes
3938 only (rounded to the nearest cylinder) and you don't need
3939 to specify the cyls, heads and sectors parameters which
3940 were rarely if ever used anyway.
3942 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3943 and C<guestfs_part_disk>");
3945 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3947 "determine file type inside a compressed file",
3949 This command runs C<file> after first decompressing C<path>
3952 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3954 Since 1.0.63, use C<guestfs_file> instead which can now
3955 process compressed files.");
3957 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3959 "list extended attributes of a file or directory",
3961 This call lists the extended attributes of the file or directory
3964 At the system call level, this is a combination of the
3965 L<listxattr(2)> and L<getxattr(2)> calls.
3967 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3969 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3971 "list extended attributes of a file or directory",
3973 This is the same as C<guestfs_getxattrs>, but if C<path>
3974 is a symbolic link, then it returns the extended attributes
3975 of the link itself.");
3977 ("setxattr", (RErr, [String "xattr";
3978 String "val"; Int "vallen"; (* will be BufferIn *)
3979 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3981 "set extended attribute of a file or directory",
3983 This call sets the extended attribute named C<xattr>
3984 of the file C<path> to the value C<val> (of length C<vallen>).
3985 The value is arbitrary 8 bit data.
3987 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3989 ("lsetxattr", (RErr, [String "xattr";
3990 String "val"; Int "vallen"; (* will be BufferIn *)
3991 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3993 "set extended attribute of a file or directory",
3995 This is the same as C<guestfs_setxattr>, but if C<path>
3996 is a symbolic link, then it sets an extended attribute
3997 of the link itself.");
3999 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
4001 "remove extended attribute of a file or directory",
4003 This call removes the extended attribute named C<xattr>
4004 of the file C<path>.
4006 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
4008 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
4010 "remove extended attribute of a file or directory",
4012 This is the same as C<guestfs_removexattr>, but if C<path>
4013 is a symbolic link, then it removes an extended attribute
4014 of the link itself.");
4016 ("mountpoints", (RHashtable "mps", [], []), 147, [],
4020 This call is similar to C<guestfs_mounts>. That call returns
4021 a list of devices. This one returns a hash table (map) of
4022 device name to directory where the device is mounted.");
4024 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
4025 (* This is a special case: while you would expect a parameter
4026 * of type "Pathname", that doesn't work, because it implies
4027 * NEED_ROOT in the generated calling code in stubs.c, and
4028 * this function cannot use NEED_ROOT.
4031 "create a mountpoint",
4033 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
4034 specialized calls that can be used to create extra mountpoints
4035 before mounting the first filesystem.
4037 These calls are I<only> necessary in some very limited circumstances,
4038 mainly the case where you want to mount a mix of unrelated and/or
4039 read-only filesystems together.
4041 For example, live CDs often contain a \"Russian doll\" nest of
4042 filesystems, an ISO outer layer, with a squashfs image inside, with
4043 an ext2/3 image inside that. You can unpack this as follows
4046 add-ro Fedora-11-i686-Live.iso
4050 mkmountpoint /ext3fs
4052 mount-loop /cd/LiveOS/squashfs.img /sqsh
4053 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4055 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4057 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4058 You may get unexpected errors if you try to mix these calls. It is
4059 safest to manually unmount filesystems and remove mountpoints after use.
4061 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4062 longest first, so for this to work for manual mountpoints, you
4063 must ensure that the innermost mountpoints have the longest
4064 pathnames, as in the example code above.
4066 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4068 Autosync [see C<guestfs_set_autosync>, this is set by default on
4069 handles] can cause C<guestfs_umount_all> to be called when the handle
4070 is closed which can also trigger these issues.");
4072 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4074 "remove a mountpoint",
4076 This calls removes a mountpoint that was previously created
4077 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4078 for full details.");
4080 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4081 [InitISOFS, Always, TestOutputBuffer (
4082 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4083 (* Test various near large, large and too large files (RHBZ#589039). *)
4084 InitScratchFS, Always, TestLastFail (
4085 [["touch"; "/read_file"];
4086 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4087 ["read_file"; "/read_file"]]);
4088 InitScratchFS, Always, TestLastFail (
4089 [["touch"; "/read_file2"];
4090 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4091 ["read_file"; "/read_file2"]]);
4092 InitScratchFS, Always, TestLastFail (
4093 [["touch"; "/read_file3"];
4094 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4095 ["read_file"; "/read_file3"]])],
4098 This calls returns the contents of the file C<path> as a
4101 Unlike C<guestfs_cat>, this function can correctly
4102 handle files that contain embedded ASCII NUL characters.
4103 However unlike C<guestfs_download>, this function is limited
4104 in the total size of file that can be handled.");
4106 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4107 [InitISOFS, Always, TestOutputList (
4108 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4109 InitISOFS, Always, TestOutputList (
4110 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4111 (* Test for RHBZ#579608, absolute symbolic links. *)
4112 InitISOFS, Always, TestOutputList (
4113 [["grep"; "nomatch"; "/abssymlink"]], [])],
4114 "return lines matching a pattern",
4116 This calls the external C<grep> program and returns the
4119 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4120 [InitISOFS, Always, TestOutputList (
4121 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4122 "return lines matching a pattern",
4124 This calls the external C<egrep> program and returns the
4127 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4128 [InitISOFS, Always, TestOutputList (
4129 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4130 "return lines matching a pattern",
4132 This calls the external C<fgrep> program and returns the
4135 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4136 [InitISOFS, Always, TestOutputList (
4137 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4138 "return lines matching a pattern",
4140 This calls the external C<grep -i> program and returns the
4143 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4144 [InitISOFS, Always, TestOutputList (
4145 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4146 "return lines matching a pattern",
4148 This calls the external C<egrep -i> program and returns the
4151 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4152 [InitISOFS, Always, TestOutputList (
4153 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4154 "return lines matching a pattern",
4156 This calls the external C<fgrep -i> program and returns the
4159 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4160 [InitISOFS, Always, TestOutputList (
4161 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4162 "return lines matching a pattern",
4164 This calls the external C<zgrep> program and returns the
4167 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4168 [InitISOFS, Always, TestOutputList (
4169 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4170 "return lines matching a pattern",
4172 This calls the external C<zegrep> program and returns the
4175 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4176 [InitISOFS, Always, TestOutputList (
4177 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4178 "return lines matching a pattern",
4180 This calls the external C<zfgrep> program and returns the
4183 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4184 [InitISOFS, Always, TestOutputList (
4185 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4186 "return lines matching a pattern",
4188 This calls the external C<zgrep -i> program and returns the
4191 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4192 [InitISOFS, Always, TestOutputList (
4193 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4194 "return lines matching a pattern",
4196 This calls the external C<zegrep -i> program and returns the
4199 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4200 [InitISOFS, Always, TestOutputList (
4201 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4202 "return lines matching a pattern",
4204 This calls the external C<zfgrep -i> program and returns the
4207 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4208 [InitISOFS, Always, TestOutput (
4209 [["realpath"; "/../directory"]], "/directory")],
4210 "canonicalized absolute pathname",
4212 Return the canonicalized absolute pathname of C<path>. The
4213 returned path has no C<.>, C<..> or symbolic link path elements.");
4215 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4216 [InitScratchFS, Always, TestOutputStruct (
4219 ["ln"; "/ln/a"; "/ln/b"];
4220 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4221 "create a hard link",
4223 This command creates a hard link using the C<ln> command.");
4225 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4226 [InitScratchFS, Always, TestOutputStruct (
4227 [["mkdir"; "/ln_f"];
4228 ["touch"; "/ln_f/a"];
4229 ["touch"; "/ln_f/b"];
4230 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4231 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4232 "create a hard link",
4234 This command creates a hard link using the C<ln -f> command.
4235 The I<-f> option removes the link (C<linkname>) if it exists already.");
4237 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4238 [InitScratchFS, Always, TestOutputStruct (
4239 [["mkdir"; "/ln_s"];
4240 ["touch"; "/ln_s/a"];
4241 ["ln_s"; "a"; "/ln_s/b"];
4242 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4243 "create a symbolic link",
4245 This command creates a symbolic link using the C<ln -s> command.");
4247 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4248 [InitScratchFS, Always, TestOutput (
4249 [["mkdir_p"; "/ln_sf/b"];
4250 ["touch"; "/ln_sf/b/c"];
4251 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4252 ["readlink"; "/ln_sf/b/c"]], "../d")],
4253 "create a symbolic link",
4255 This command creates a symbolic link using the C<ln -sf> command,
4256 The I<-f> option removes the link (C<linkname>) if it exists already.");
4258 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4259 [] (* XXX tested above *),
4260 "read the target of a symbolic link",
4262 This command reads the target of a symbolic link.");
4264 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4265 [InitScratchFS, Always, TestOutputStruct (
4266 [["fallocate"; "/fallocate"; "1000000"];
4267 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4268 "preallocate a file in the guest filesystem",
4270 This command preallocates a file (containing zero bytes) named
4271 C<path> of size C<len> bytes. If the file exists already, it
4274 Do not confuse this with the guestfish-specific
4275 C<alloc> command which allocates a file in the host and
4276 attaches it as a device.");
4278 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4279 [InitPartition, Always, TestRun (
4280 [["mkswap"; "/dev/sda1"];
4281 ["swapon_device"; "/dev/sda1"];
4282 ["swapoff_device"; "/dev/sda1"]])],
4283 "enable swap on device",
4285 This command enables the libguestfs appliance to use the
4286 swap device or partition named C<device>. The increased
4287 memory is made available for all commands, for example
4288 those run using C<guestfs_command> or C<guestfs_sh>.
4290 Note that you should not swap to existing guest swap
4291 partitions unless you know what you are doing. They may
4292 contain hibernation information, or other information that
4293 the guest doesn't want you to trash. You also risk leaking
4294 information about the host to the guest this way. Instead,
4295 attach a new host device to the guest and swap on that.");
4297 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4298 [], (* XXX tested by swapon_device *)
4299 "disable swap on device",
4301 This command disables the libguestfs appliance swap
4302 device or partition named C<device>.
4303 See C<guestfs_swapon_device>.");
4305 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4306 [InitScratchFS, Always, TestRun (
4307 [["fallocate"; "/swapon_file"; "8388608"];
4308 ["mkswap_file"; "/swapon_file"];
4309 ["swapon_file"; "/swapon_file"];
4310 ["swapoff_file"; "/swapon_file"];
4311 ["rm"; "/swapon_file"]])],
4312 "enable swap on file",
4314 This command enables swap to a file.
4315 See C<guestfs_swapon_device> for other notes.");
4317 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4318 [], (* XXX tested by swapon_file *)
4319 "disable swap on file",
4321 This command disables the libguestfs appliance swap on file.");
4323 ("swapon_label", (RErr, [String "label"], []), 174, [],
4324 [InitEmpty, Always, TestRun (
4325 [["part_disk"; "/dev/sda"; "mbr"];
4326 ["mkswap_L"; "swapit"; "/dev/sda1"];
4327 ["swapon_label"; "swapit"];
4328 ["swapoff_label"; "swapit"];
4329 ["zero"; "/dev/sda"];
4330 ["blockdev_rereadpt"; "/dev/sda"]])],
4331 "enable swap on labeled swap partition",
4333 This command enables swap to a labeled swap partition.
4334 See C<guestfs_swapon_device> for other notes.");
4336 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4337 [], (* XXX tested by swapon_label *)
4338 "disable swap on labeled swap partition",
4340 This command disables the libguestfs appliance swap on
4341 labeled swap partition.");
4343 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4344 (let uuid = uuidgen () in
4345 [InitEmpty, Always, TestRun (
4346 [["mkswap_U"; uuid; "/dev/sdc"];
4347 ["swapon_uuid"; uuid];
4348 ["swapoff_uuid"; uuid]])]),
4349 "enable swap on swap partition by UUID",
4351 This command enables swap to a swap partition with the given UUID.
4352 See C<guestfs_swapon_device> for other notes.");
4354 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4355 [], (* XXX tested by swapon_uuid *)
4356 "disable swap on swap partition by UUID",
4358 This command disables the libguestfs appliance swap partition
4359 with the given UUID.");
4361 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4362 [InitScratchFS, Always, TestRun (
4363 [["fallocate"; "/mkswap_file"; "8388608"];
4364 ["mkswap_file"; "/mkswap_file"];
4365 ["rm"; "/mkswap_file"]])],
4366 "create a swap file",
4370 This command just writes a swap file signature to an existing
4371 file. To create the file itself, use something like C<guestfs_fallocate>.");
4373 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4374 [InitISOFS, Always, TestRun (
4375 [["inotify_init"; "0"]])],
4376 "create an inotify handle",
4378 This command creates a new inotify handle.
4379 The inotify subsystem can be used to notify events which happen to
4380 objects in the guest filesystem.
4382 C<maxevents> is the maximum number of events which will be
4383 queued up between calls to C<guestfs_inotify_read> or
4384 C<guestfs_inotify_files>.
4385 If this is passed as C<0>, then the kernel (or previously set)
4386 default is used. For Linux 2.6.29 the default was 16384 events.
4387 Beyond this limit, the kernel throws away events, but records
4388 the fact that it threw them away by setting a flag
4389 C<IN_Q_OVERFLOW> in the returned structure list (see
4390 C<guestfs_inotify_read>).
4392 Before any events are generated, you have to add some
4393 watches to the internal watch list. See:
4394 C<guestfs_inotify_add_watch>,
4395 C<guestfs_inotify_rm_watch> and
4396 C<guestfs_inotify_watch_all>.
4398 Queued up events should be read periodically by calling
4399 C<guestfs_inotify_read>
4400 (or C<guestfs_inotify_files> which is just a helpful
4401 wrapper around C<guestfs_inotify_read>). If you don't
4402 read the events out often enough then you risk the internal
4405 The handle should be closed after use by calling
4406 C<guestfs_inotify_close>. This also removes any
4407 watches automatically.
4409 See also L<inotify(7)> for an overview of the inotify interface
4410 as exposed by the Linux kernel, which is roughly what we expose
4411 via libguestfs. Note that there is one global inotify handle
4412 per libguestfs instance.");
4414 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4415 [InitScratchFS, Always, TestOutputList (
4416 [["mkdir"; "/inotify_add_watch"];
4417 ["inotify_init"; "0"];
4418 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4419 ["touch"; "/inotify_add_watch/a"];
4420 ["touch"; "/inotify_add_watch/b"];
4421 ["inotify_files"]], ["a"; "b"])],
4422 "add an inotify watch",
4424 Watch C<path> for the events listed in C<mask>.
4426 Note that if C<path> is a directory then events within that
4427 directory are watched, but this does I<not> happen recursively
4428 (in subdirectories).
4430 Note for non-C or non-Linux callers: the inotify events are
4431 defined by the Linux kernel ABI and are listed in
4432 C</usr/include/sys/inotify.h>.");
4434 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4436 "remove an inotify watch",
4438 Remove a previously defined inotify watch.
4439 See C<guestfs_inotify_add_watch>.");
4441 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4443 "return list of inotify events",
4445 Return the complete queue of events that have happened
4446 since the previous read call.
4448 If no events have happened, this returns an empty list.
4450 I<Note>: In order to make sure that all events have been
4451 read, you must call this function repeatedly until it
4452 returns an empty list. The reason is that the call will
4453 read events up to the maximum appliance-to-host message
4454 size and leave remaining events in the queue.");
4456 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4458 "return list of watched files that had events",
4460 This function is a helpful wrapper around C<guestfs_inotify_read>
4461 which just returns a list of pathnames of objects that were
4462 touched. The returned pathnames are sorted and deduplicated.");
4464 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4466 "close the inotify handle",
4468 This closes the inotify handle which was previously
4469 opened by inotify_init. It removes all watches, throws
4470 away any pending events, and deallocates all resources.");
4472 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4474 "set SELinux security context",
4476 This sets the SELinux security context of the daemon
4477 to the string C<context>.
4479 See the documentation about SELINUX in L<guestfs(3)>.");
4481 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4483 "get SELinux security context",
4485 This gets the SELinux security context of the daemon.
4487 See the documentation about SELINUX in L<guestfs(3)>,
4488 and C<guestfs_setcon>");
4490 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4491 [InitEmpty, Always, TestOutput (
4492 [["part_disk"; "/dev/sda"; "mbr"];
4493 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4494 ["mount_options"; ""; "/dev/sda1"; "/"];
4495 ["write"; "/new"; "new file contents"];
4496 ["cat"; "/new"]], "new file contents");
4497 InitEmpty, Always, TestRun (
4498 [["part_disk"; "/dev/sda"; "mbr"];
4499 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4500 InitEmpty, Always, TestLastFail (
4501 [["part_disk"; "/dev/sda"; "mbr"];
4502 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4503 InitEmpty, Always, TestLastFail (
4504 [["part_disk"; "/dev/sda"; "mbr"];
4505 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4506 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4507 [["part_disk"; "/dev/sda"; "mbr"];
4508 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4509 "make a filesystem with block size",
4511 This call is similar to C<guestfs_mkfs>, but it allows you to
4512 control the block size of the resulting filesystem. Supported
4513 block sizes depend on the filesystem type, but typically they
4514 are C<1024>, C<2048> or C<4096> only.
4516 For VFAT and NTFS the C<blocksize> parameter is treated as
4517 the requested cluster size.");
4519 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4520 [InitEmpty, Always, TestOutput (
4521 [["part_init"; "/dev/sda"; "mbr"];
4522 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4523 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4524 ["mke2journal"; "4096"; "/dev/sda1"];
4525 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4526 ["mount_options"; ""; "/dev/sda2"; "/"];
4527 ["write"; "/new"; "new file contents"];
4528 ["cat"; "/new"]], "new file contents")],
4529 "make ext2/3/4 external journal",
4531 This creates an ext2 external journal on C<device>. It is equivalent
4534 mke2fs -O journal_dev -b blocksize device");
4536 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4537 [InitEmpty, Always, TestOutput (
4538 [["part_init"; "/dev/sda"; "mbr"];
4539 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4540 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4541 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4542 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4543 ["mount_options"; ""; "/dev/sda2"; "/"];
4544 ["write"; "/new"; "new file contents"];
4545 ["cat"; "/new"]], "new file contents")],
4546 "make ext2/3/4 external journal with label",
4548 This creates an ext2 external journal on C<device> with label C<label>.");
4550 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4551 (let uuid = uuidgen () in
4552 [InitEmpty, Always, TestOutput (
4553 [["part_init"; "/dev/sda"; "mbr"];
4554 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4555 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4556 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4557 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4558 ["mount_options"; ""; "/dev/sda2"; "/"];
4559 ["write"; "/new"; "new file contents"];
4560 ["cat"; "/new"]], "new file contents")]),
4561 "make ext2/3/4 external journal with UUID",
4563 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4565 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4567 "make ext2/3/4 filesystem with external journal",
4569 This creates an ext2/3/4 filesystem on C<device> with
4570 an external journal on C<journal>. It is equivalent
4573 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4575 See also C<guestfs_mke2journal>.");
4577 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4579 "make ext2/3/4 filesystem with external journal",
4581 This creates an ext2/3/4 filesystem on C<device> with
4582 an external journal on the journal labeled C<label>.
4584 See also C<guestfs_mke2journal_L>.");
4586 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4588 "make ext2/3/4 filesystem with external journal",
4590 This creates an ext2/3/4 filesystem on C<device> with
4591 an external journal on the journal with UUID C<uuid>.
4593 See also C<guestfs_mke2journal_U>.");
4595 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4596 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4597 "load a kernel module",
4599 This loads a kernel module in the appliance.
4601 The kernel module must have been whitelisted when libguestfs
4602 was built (see C<appliance/kmod.whitelist.in> in the source).");
4604 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4605 [InitNone, Always, TestOutput (
4606 [["echo_daemon"; "This is a test"]], "This is a test"
4608 "echo arguments back to the client",
4610 This command concatenates the list of C<words> passed with single spaces
4611 between them and returns the resulting string.
4613 You can use this command to test the connection through to the daemon.
4615 See also C<guestfs_ping_daemon>.");
4617 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4618 [], (* There is a regression test for this. *)
4619 "find all files and directories, returning NUL-separated list",
4621 This command lists out all files and directories, recursively,
4622 starting at C<directory>, placing the resulting list in the
4623 external file called C<files>.
4625 This command works the same way as C<guestfs_find> with the
4626 following exceptions:
4632 The resulting list is written to an external file.
4636 Items (filenames) in the result are separated
4637 by C<\\0> characters. See L<find(1)> option I<-print0>.
4641 This command is not limited in the number of names that it
4646 The result list is not sorted.
4650 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4651 [InitISOFS, Always, TestOutput (
4652 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4653 InitISOFS, Always, TestOutput (
4654 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4655 InitISOFS, Always, TestOutput (
4656 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4657 InitISOFS, Always, TestLastFail (
4658 [["case_sensitive_path"; "/Known-1/"]]);
4659 InitScratchFS, Always, TestOutput (
4660 [["mkdir"; "/case_sensitive_path"];
4661 ["mkdir"; "/case_sensitive_path/bbb"];
4662 ["touch"; "/case_sensitive_path/bbb/c"];
4663 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4664 InitScratchFS, Always, TestOutput (
4665 [["mkdir"; "/case_sensitive_path2"];
4666 ["mkdir"; "/case_sensitive_path2/bbb"];
4667 ["touch"; "/case_sensitive_path2/bbb/c"];
4668 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4669 InitScratchFS, Always, TestLastFail (
4670 [["mkdir"; "/case_sensitive_path3"];
4671 ["mkdir"; "/case_sensitive_path3/bbb"];
4672 ["touch"; "/case_sensitive_path3/bbb/c"];
4673 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4674 "return true path on case-insensitive filesystem",
4676 This can be used to resolve case insensitive paths on
4677 a filesystem which is case sensitive. The use case is
4678 to resolve paths which you have read from Windows configuration
4679 files or the Windows Registry, to the true path.
4681 The command handles a peculiarity of the Linux ntfs-3g
4682 filesystem driver (and probably others), which is that although
4683 the underlying filesystem is case-insensitive, the driver
4684 exports the filesystem to Linux as case-sensitive.
4686 One consequence of this is that special directories such
4687 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4688 (or other things) depending on the precise details of how
4689 they were created. In Windows itself this would not be
4692 Bug or feature? You decide:
4693 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4695 This function resolves the true case of each element in the
4696 path and returns the case-sensitive path.
4698 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4699 might return C<\"/WINDOWS/system32\"> (the exact return value
4700 would depend on details of how the directories were originally
4701 created under Windows).
4704 This function does not handle drive names, backslashes etc.
4706 See also C<guestfs_realpath>.");
4708 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4709 [InitScratchFS, Always, TestOutput (
4710 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4711 "get the Linux VFS type corresponding to a mounted device",
4713 This command gets the filesystem type corresponding to
4714 the filesystem on C<device>.
4716 For most filesystems, the result is the name of the Linux
4717 VFS module which would be used to mount this filesystem
4718 if you mounted it without specifying the filesystem type.
4719 For example a string such as C<ext3> or C<ntfs>.");
4721 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4722 [InitScratchFS, Always, TestOutputStruct (
4723 [["write"; "/truncate"; "some stuff so size is not zero"];
4724 ["truncate"; "/truncate"];
4725 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4726 "truncate a file to zero size",
4728 This command truncates C<path> to a zero-length file. The
4729 file must exist already.");
4731 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4732 [InitScratchFS, Always, TestOutputStruct (
4733 [["touch"; "/truncate_size"];
4734 ["truncate_size"; "/truncate_size"; "1000"];
4735 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4736 "truncate a file to a particular size",
4738 This command truncates C<path> to size C<size> bytes. The file
4741 If the current file size is less than C<size> then
4742 the file is extended to the required size with zero bytes.
4743 This creates a sparse file (ie. disk blocks are not allocated
4744 for the file until you write to it). To create a non-sparse
4745 file of zeroes, use C<guestfs_fallocate64> instead.");
4747 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4748 [InitScratchFS, Always, TestOutputStruct (
4749 [["touch"; "/utimens"];
4750 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4751 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4752 "set timestamp of a file with nanosecond precision",
4754 This command sets the timestamps of a file with nanosecond
4757 C<atsecs, atnsecs> are the last access time (atime) in secs and
4758 nanoseconds from the epoch.
4760 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4761 secs and nanoseconds from the epoch.
4763 If the C<*nsecs> field contains the special value C<-1> then
4764 the corresponding timestamp is set to the current time. (The
4765 C<*secs> field is ignored in this case).
4767 If the C<*nsecs> field contains the special value C<-2> then
4768 the corresponding timestamp is left unchanged. (The
4769 C<*secs> field is ignored in this case).");
4771 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4772 [InitScratchFS, Always, TestOutputStruct (
4773 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4774 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4775 "create a directory with a particular mode",
4777 This command creates a directory, setting the initial permissions
4778 of the directory to C<mode>.
4780 For common Linux filesystems, the actual mode which is set will
4781 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4782 interpret the mode in other ways.
4784 See also C<guestfs_mkdir>, C<guestfs_umask>");
4786 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4788 "change file owner and group",
4790 Change the file owner to C<owner> and group to C<group>.
4791 This is like C<guestfs_chown> but if C<path> is a symlink then
4792 the link itself is changed, not the target.
4794 Only numeric uid and gid are supported. If you want to use
4795 names, you will need to locate and parse the password file
4796 yourself (Augeas support makes this relatively easy).");
4798 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4800 "lstat on multiple files",
4802 This call allows you to perform the C<guestfs_lstat> operation
4803 on multiple files, where all files are in the directory C<path>.
4804 C<names> is the list of files from this directory.
4806 On return you get a list of stat structs, with a one-to-one
4807 correspondence to the C<names> list. If any name did not exist
4808 or could not be lstat'd, then the C<ino> field of that structure
4811 This call is intended for programs that want to efficiently
4812 list a directory contents without making many round-trips.
4813 See also C<guestfs_lxattrlist> for a similarly efficient call
4814 for getting extended attributes. Very long directory listings
4815 might cause the protocol message size to be exceeded, causing
4816 this call to fail. The caller must split up such requests
4817 into smaller groups of names.");
4819 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4821 "lgetxattr on multiple files",
4823 This call allows you to get the extended attributes
4824 of multiple files, where all files are in the directory C<path>.
4825 C<names> is the list of files from this directory.
4827 On return you get a flat list of xattr structs which must be
4828 interpreted sequentially. The first xattr struct always has a zero-length
4829 C<attrname>. C<attrval> in this struct is zero-length
4830 to indicate there was an error doing C<lgetxattr> for this
4831 file, I<or> is a C string which is a decimal number
4832 (the number of following attributes for this file, which could
4833 be C<\"0\">). Then after the first xattr struct are the
4834 zero or more attributes for the first named file.
4835 This repeats for the second and subsequent files.
4837 This call is intended for programs that want to efficiently
4838 list a directory contents without making many round-trips.
4839 See also C<guestfs_lstatlist> for a similarly efficient call
4840 for getting standard stats. Very long directory listings
4841 might cause the protocol message size to be exceeded, causing
4842 this call to fail. The caller must split up such requests
4843 into smaller groups of names.");
4845 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4847 "readlink on multiple files",
4849 This call allows you to do a C<readlink> operation
4850 on multiple files, where all files are in the directory C<path>.
4851 C<names> is the list of files from this directory.
4853 On return you get a list of strings, with a one-to-one
4854 correspondence to the C<names> list. Each string is the
4855 value of the symbolic link.
4857 If the C<readlink(2)> operation fails on any name, then
4858 the corresponding result string is the empty string C<\"\">.
4859 However the whole operation is completed even if there
4860 were C<readlink(2)> errors, and so you can call this
4861 function with names where you don't know if they are
4862 symbolic links already (albeit slightly less efficient).
4864 This call is intended for programs that want to efficiently
4865 list a directory contents without making many round-trips.
4866 Very long directory listings might cause the protocol
4867 message size to be exceeded, causing
4868 this call to fail. The caller must split up such requests
4869 into smaller groups of names.");
4871 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4872 [InitISOFS, Always, TestOutputBuffer (
4873 [["pread"; "/known-4"; "1"; "3"]], "\n");
4874 InitISOFS, Always, TestOutputBuffer (
4875 [["pread"; "/empty"; "0"; "100"]], "")],
4876 "read part of a file",
4878 This command lets you read part of a file. It reads C<count>
4879 bytes of the file, starting at C<offset>, from file C<path>.
4881 This may read fewer bytes than requested. For further details
4882 see the L<pread(2)> system call.
4884 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4886 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4887 [InitEmpty, Always, TestRun (
4888 [["part_init"; "/dev/sda"; "gpt"]])],
4889 "create an empty partition table",
4891 This creates an empty partition table on C<device> of one of the
4892 partition types listed below. Usually C<parttype> should be
4893 either C<msdos> or C<gpt> (for large disks).
4895 Initially there are no partitions. Following this, you should
4896 call C<guestfs_part_add> for each partition required.
4898 Possible values for C<parttype> are:
4906 Intel EFI / GPT partition table.
4908 This is recommended for >= 2 TB partitions that will be accessed
4909 from Linux and Intel-based Mac OS X. It also has limited backwards
4910 compatibility with the C<mbr> format.
4916 The standard PC \"Master Boot Record\" (MBR) format used
4917 by MS-DOS and Windows. This partition type will B<only> work
4918 for device sizes up to 2 TB. For large disks we recommend
4923 Other partition table types that may work but are not
4936 Amiga \"Rigid Disk Block\" format.
4944 DASD, used on IBM mainframes.
4952 Old Mac partition format. Modern Macs use C<gpt>.
4956 NEC PC-98 format, common in Japan apparently.
4964 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4965 [InitEmpty, Always, TestRun (
4966 [["part_init"; "/dev/sda"; "mbr"];
4967 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4968 InitEmpty, Always, TestRun (
4969 [["part_init"; "/dev/sda"; "gpt"];
4970 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4971 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4972 InitEmpty, Always, TestRun (
4973 [["part_init"; "/dev/sda"; "mbr"];
4974 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4975 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4976 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4977 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4978 "add a partition to the device",
4980 This command adds a partition to C<device>. If there is no partition
4981 table on the device, call C<guestfs_part_init> first.
4983 The C<prlogex> parameter is the type of partition. Normally you
4984 should pass C<p> or C<primary> here, but MBR partition tables also
4985 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4988 C<startsect> and C<endsect> are the start and end of the partition
4989 in I<sectors>. C<endsect> may be negative, which means it counts
4990 backwards from the end of the disk (C<-1> is the last sector).
4992 Creating a partition which covers the whole disk is not so easy.
4993 Use C<guestfs_part_disk> to do that.");
4995 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4996 [InitEmpty, Always, TestRun (
4997 [["part_disk"; "/dev/sda"; "mbr"]]);
4998 InitEmpty, Always, TestRun (
4999 [["part_disk"; "/dev/sda"; "gpt"]])],
5000 "partition whole disk with a single primary partition",
5002 This command is simply a combination of C<guestfs_part_init>
5003 followed by C<guestfs_part_add> to create a single primary partition
5004 covering the whole disk.
5006 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
5007 but other possible values are described in C<guestfs_part_init>.");
5009 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
5010 [InitEmpty, Always, TestRun (
5011 [["part_disk"; "/dev/sda"; "mbr"];
5012 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
5013 "make a partition bootable",
5015 This sets the bootable flag on partition numbered C<partnum> on
5016 device C<device>. Note that partitions are numbered from 1.
5018 The bootable flag is used by some operating systems (notably
5019 Windows) to determine which partition to boot from. It is by
5020 no means universally recognized.");
5022 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
5023 [InitEmpty, Always, TestRun (
5024 [["part_disk"; "/dev/sda"; "gpt"];
5025 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
5026 "set partition name",
5028 This sets the partition name on partition numbered C<partnum> on
5029 device C<device>. Note that partitions are numbered from 1.
5031 The partition name can only be set on certain types of partition
5032 table. This works on C<gpt> but not on C<mbr> partitions.");
5034 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
5035 [], (* XXX Add a regression test for this. *)
5036 "list partitions on a device",
5038 This command parses the partition table on C<device> and
5039 returns the list of partitions found.
5041 The fields in the returned structure are:
5047 Partition number, counting from 1.
5051 Start of the partition I<in bytes>. To get sectors you have to
5052 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5056 End of the partition in bytes.
5060 Size of the partition in bytes.
5064 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5065 [InitEmpty, Always, TestOutput (
5066 [["part_disk"; "/dev/sda"; "gpt"];
5067 ["part_get_parttype"; "/dev/sda"]], "gpt")],
5068 "get the partition table type",
5070 This command examines the partition table on C<device> and
5071 returns the partition table type (format) being used.
5073 Common return values include: C<msdos> (a DOS/Windows style MBR
5074 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5075 values are possible, although unusual. See C<guestfs_part_init>
5078 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5079 [InitScratchFS, Always, TestOutputBuffer (
5080 [["fill"; "0x63"; "10"; "/fill"];
5081 ["read_file"; "/fill"]], "cccccccccc")],
5082 "fill a file with octets",
5084 This command creates a new file called C<path>. The initial
5085 content of the file is C<len> octets of C<c>, where C<c>
5086 must be a number in the range C<[0..255]>.
5088 To fill a file with zero bytes (sparsely), it is
5089 much more efficient to use C<guestfs_truncate_size>.
5090 To create a file with a pattern of repeating bytes
5091 use C<guestfs_fill_pattern>.");
5093 ("available", (RErr, [StringList "groups"], []), 216, [],
5094 [InitNone, Always, TestRun [["available"; ""]]],
5095 "test availability of some parts of the API",
5097 This command is used to check the availability of some
5098 groups of functionality in the appliance, which not all builds of
5099 the libguestfs appliance will be able to provide.
5101 The libguestfs groups, and the functions that those
5102 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5103 You can also fetch this list at runtime by calling
5104 C<guestfs_available_all_groups>.
5106 The argument C<groups> is a list of group names, eg:
5107 C<[\"inotify\", \"augeas\"]> would check for the availability of
5108 the Linux inotify functions and Augeas (configuration file
5111 The command returns no error if I<all> requested groups are available.
5113 It fails with an error if one or more of the requested
5114 groups is unavailable in the appliance.
5116 If an unknown group name is included in the
5117 list of groups then an error is always returned.
5125 You must call C<guestfs_launch> before calling this function.
5127 The reason is because we don't know what groups are
5128 supported by the appliance/daemon until it is running and can
5133 If a group of functions is available, this does not necessarily
5134 mean that they will work. You still have to check for errors
5135 when calling individual API functions even if they are
5140 It is usually the job of distro packagers to build
5141 complete functionality into the libguestfs appliance.
5142 Upstream libguestfs, if built from source with all
5143 requirements satisfied, will support everything.
5147 This call was added in version C<1.0.80>. In previous
5148 versions of libguestfs all you could do would be to speculatively
5149 execute a command to find out if the daemon implemented it.
5150 See also C<guestfs_version>.
5154 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5155 [InitScratchFS, Always, TestOutputBuffer (
5157 ["write"; "/dd/src"; "hello, world"];
5158 ["dd"; "/dd/src"; "/dd/dest"];
5159 ["read_file"; "/dd/dest"]], "hello, world")],
5160 "copy from source to destination using dd",
5162 This command copies from one source device or file C<src>
5163 to another destination device or file C<dest>. Normally you
5164 would use this to copy to or from a device or partition, for
5165 example to duplicate a filesystem.
5167 If the destination is a device, it must be as large or larger
5168 than the source file or device, otherwise the copy will fail.
5169 This command cannot do partial copies (see C<guestfs_copy_size>).");
5171 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5172 [InitScratchFS, Always, TestOutputInt (
5173 [["write"; "/filesize"; "hello, world"];
5174 ["filesize"; "/filesize"]], 12)],
5175 "return the size of the file in bytes",
5177 This command returns the size of C<file> in bytes.
5179 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5180 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5181 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5183 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5184 [InitBasicFSonLVM, Always, TestOutputList (
5185 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5186 ["lvs"]], ["/dev/VG/LV2"])],
5187 "rename an LVM logical volume",
5189 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5191 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5192 [InitBasicFSonLVM, Always, TestOutputList (
5194 ["vg_activate"; "false"; "VG"];
5195 ["vgrename"; "VG"; "VG2"];
5196 ["vg_activate"; "true"; "VG2"];
5197 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5198 ["vgs"]], ["VG2"])],
5199 "rename an LVM volume group",
5201 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5203 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5204 [InitISOFS, Always, TestOutputBuffer (
5205 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5206 "list the contents of a single file in an initrd",
5208 This command unpacks the file C<filename> from the initrd file
5209 called C<initrdpath>. The filename must be given I<without> the
5210 initial C</> character.
5212 For example, in guestfish you could use the following command
5213 to examine the boot script (usually called C</init>)
5214 contained in a Linux initrd or initramfs image:
5216 initrd-cat /boot/initrd-<version>.img init
5218 See also C<guestfs_initrd_list>.");
5220 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5222 "get the UUID of a physical volume",
5224 This command returns the UUID of the LVM PV C<device>.");
5226 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5228 "get the UUID of a volume group",
5230 This command returns the UUID of the LVM VG named C<vgname>.");
5232 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5234 "get the UUID of a logical volume",
5236 This command returns the UUID of the LVM LV C<device>.");
5238 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5240 "get the PV UUIDs containing the volume group",
5242 Given a VG called C<vgname>, this returns the UUIDs of all
5243 the physical volumes that this volume group resides on.
5245 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5246 calls to associate physical volumes and volume groups.
5248 See also C<guestfs_vglvuuids>.");
5250 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5252 "get the LV UUIDs of all LVs in the volume group",
5254 Given a VG called C<vgname>, this returns the UUIDs of all
5255 the logical volumes created in this volume group.
5257 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5258 calls to associate logical volumes and volume groups.
5260 See also C<guestfs_vgpvuuids>.");
5262 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5263 [InitScratchFS, Always, TestOutputBuffer (
5264 [["mkdir"; "/copy_size"];
5265 ["write"; "/copy_size/src"; "hello, world"];
5266 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5267 ["read_file"; "/copy_size/dest"]], "hello")],
5268 "copy size bytes from source to destination using dd",
5270 This command copies exactly C<size> bytes from one source device
5271 or file C<src> to another destination device or file C<dest>.
5273 Note this will fail if the source is too short or if the destination
5274 is not large enough.");
5276 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5277 [InitBasicFSonLVM, Always, TestRun (
5278 [["zero_device"; "/dev/VG/LV"]])],
5279 "write zeroes to an entire device",
5281 This command writes zeroes over the entire C<device>. Compare
5282 with C<guestfs_zero> which just zeroes the first few blocks of
5285 If blocks are already zero, then this command avoids writing
5286 zeroes. This prevents the underlying device from becoming non-sparse
5287 or growing unnecessarily.");
5289 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5290 [InitScratchFS, Always, TestOutput (
5291 [["mkdir"; "/txz_in"];
5292 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5293 ["cat"; "/txz_in/hello"]], "hello\n")],
5294 "unpack compressed tarball to directory",
5296 This command uploads and unpacks local file C<tarball> (an
5297 I<xz compressed> tar file) into C<directory>.");
5299 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5301 "pack directory into compressed tarball",
5303 This command packs the contents of C<directory> and downloads
5304 it to local file C<tarball> (as an xz compressed tar archive).");
5306 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5308 "resize an NTFS filesystem",
5310 This command resizes an NTFS filesystem, expanding or
5311 shrinking it to the size of the underlying device.
5313 I<Note:> After the resize operation, the filesystem is marked
5314 as requiring a consistency check (for safety). You have to boot
5315 into Windows to perform this check and clear this condition.
5316 Furthermore, ntfsresize refuses to resize filesystems
5317 which have been marked in this way. So in effect it is
5318 not possible to call ntfsresize multiple times on a single
5319 filesystem without booting into Windows between each resize.
5321 See also L<ntfsresize(8)>.");
5323 ("vgscan", (RErr, [], []), 232, [],
5324 [InitEmpty, Always, TestRun (
5326 "rescan for LVM physical volumes, volume groups and logical volumes",
5328 This rescans all block devices and rebuilds the list of LVM
5329 physical volumes, volume groups and logical volumes.");
5331 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5332 [InitEmpty, Always, TestRun (
5333 [["part_init"; "/dev/sda"; "mbr"];
5334 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5335 ["part_del"; "/dev/sda"; "1"]])],
5336 "delete a partition",
5338 This command deletes the partition numbered C<partnum> on C<device>.
5340 Note that in the case of MBR partitioning, deleting an
5341 extended partition also deletes any logical partitions
5344 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5345 [InitEmpty, Always, TestOutputTrue (
5346 [["part_init"; "/dev/sda"; "mbr"];
5347 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5348 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5349 ["part_get_bootable"; "/dev/sda"; "1"]])],
5350 "return true if a partition is bootable",
5352 This command returns true if the partition C<partnum> on
5353 C<device> has the bootable flag set.
5355 See also C<guestfs_part_set_bootable>.");
5357 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5358 [InitEmpty, Always, TestOutputInt (
5359 [["part_init"; "/dev/sda"; "mbr"];
5360 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5361 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5362 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5363 "get the MBR type byte (ID byte) from a partition",
5365 Returns the MBR type byte (also known as the ID byte) from
5366 the numbered partition C<partnum>.
5368 Note that only MBR (old DOS-style) partitions have type bytes.
5369 You will get undefined results for other partition table
5370 types (see C<guestfs_part_get_parttype>).");
5372 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5373 [], (* tested by part_get_mbr_id *)
5374 "set the MBR type byte (ID byte) of a partition",
5376 Sets the MBR type byte (also known as the ID byte) of
5377 the numbered partition C<partnum> to C<idbyte>. Note
5378 that the type bytes quoted in most documentation are
5379 in fact hexadecimal numbers, but usually documented
5380 without any leading \"0x\" which might be confusing.
5382 Note that only MBR (old DOS-style) partitions have type bytes.
5383 You will get undefined results for other partition table
5384 types (see C<guestfs_part_get_parttype>).");
5386 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5387 [InitISOFS, Always, TestOutputFileMD5 (
5388 [["checksum_device"; "md5"; "/dev/sdd"]],
5389 "../images/test.iso")],
5390 "compute MD5, SHAx or CRC checksum of the contents of a device",
5392 This call computes the MD5, SHAx or CRC checksum of the
5393 contents of the device named C<device>. For the types of
5394 checksums supported see the C<guestfs_checksum> command.");
5396 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5397 [InitNone, Always, TestRun (
5398 [["part_disk"; "/dev/sda"; "mbr"];
5399 ["pvcreate"; "/dev/sda1"];
5400 ["vgcreate"; "VG"; "/dev/sda1"];
5401 ["lvcreate"; "LV"; "VG"; "10"];
5402 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5403 "expand an LV to fill free space",
5405 This expands an existing logical volume C<lv> so that it fills
5406 C<pc>% of the remaining free space in the volume group. Commonly
5407 you would call this with pc = 100 which expands the logical volume
5408 as much as possible, using all remaining free space in the volume
5411 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5412 [], (* XXX Augeas code needs tests. *)
5413 "clear Augeas path",
5415 Set the value associated with C<path> to C<NULL>. This
5416 is the same as the L<augtool(1)> C<clear> command.");
5418 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5419 [InitEmpty, Always, TestOutputInt (
5420 [["get_umask"]], 0o22)],
5421 "get the current umask",
5423 Return the current umask. By default the umask is C<022>
5424 unless it has been set by calling C<guestfs_umask>.");
5426 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5428 "upload a file to the appliance (internal use only)",
5430 The C<guestfs_debug_upload> command uploads a file to
5431 the libguestfs appliance.
5433 There is no comprehensive help for this command. You have
5434 to look at the file C<daemon/debug.c> in the libguestfs source
5435 to find out what it is for.");
5437 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5438 [InitScratchFS, Always, TestOutput (
5439 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5440 ["cat"; "/base64_in"]], "hello\n")],
5441 "upload base64-encoded data to file",
5443 This command uploads base64-encoded data from C<base64file>
5446 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5448 "download file and encode as base64",
5450 This command downloads the contents of C<filename>, writing
5451 it out to local file C<base64file> encoded as base64.");
5453 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5455 "compute MD5, SHAx or CRC checksum of files in a directory",
5457 This command computes the checksums of all regular files in
5458 C<directory> and then emits a list of those checksums to
5459 the local output file C<sumsfile>.
5461 This can be used for verifying the integrity of a virtual
5462 machine. However to be properly secure you should pay
5463 attention to the output of the checksum command (it uses
5464 the ones from GNU coreutils). In particular when the
5465 filename is not printable, coreutils uses a special
5466 backslash syntax. For more information, see the GNU
5467 coreutils info file.");
5469 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5470 [InitScratchFS, Always, TestOutputBuffer (
5471 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5472 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5473 "fill a file with a repeating pattern of bytes",
5475 This function is like C<guestfs_fill> except that it creates
5476 a new file of length C<len> containing the repeating pattern
5477 of bytes in C<pattern>. The pattern is truncated if necessary
5478 to ensure the length of the file is exactly C<len> bytes.");
5480 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5481 [InitScratchFS, Always, TestOutput (
5482 [["write"; "/write"; "new file contents"];
5483 ["cat"; "/write"]], "new file contents");
5484 InitScratchFS, Always, TestOutput (
5485 [["write"; "/write2"; "\nnew file contents\n"];
5486 ["cat"; "/write2"]], "\nnew file contents\n");
5487 InitScratchFS, Always, TestOutput (
5488 [["write"; "/write3"; "\n\n"];
5489 ["cat"; "/write3"]], "\n\n");
5490 InitScratchFS, Always, TestOutput (
5491 [["write"; "/write4"; ""];
5492 ["cat"; "/write4"]], "");
5493 InitScratchFS, Always, TestOutput (
5494 [["write"; "/write5"; "\n\n\n"];
5495 ["cat"; "/write5"]], "\n\n\n");
5496 InitScratchFS, Always, TestOutput (
5497 [["write"; "/write6"; "\n"];
5498 ["cat"; "/write6"]], "\n")],
5499 "create a new file",
5501 This call creates a file called C<path>. The content of the
5502 file is the string C<content> (which can contain any 8 bit data).
5504 See also C<guestfs_write_append>.");
5506 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5507 [InitScratchFS, Always, TestOutput (
5508 [["write"; "/pwrite"; "new file contents"];
5509 ["pwrite"; "/pwrite"; "data"; "4"];
5510 ["cat"; "/pwrite"]], "new data contents");
5511 InitScratchFS, Always, TestOutput (
5512 [["write"; "/pwrite2"; "new file contents"];
5513 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5514 ["cat"; "/pwrite2"]], "new file is extended");
5515 InitScratchFS, Always, TestOutput (
5516 [["write"; "/pwrite3"; "new file contents"];
5517 ["pwrite"; "/pwrite3"; ""; "4"];
5518 ["cat"; "/pwrite3"]], "new file contents")],
5519 "write to part of a file",
5521 This command writes to part of a file. It writes the data
5522 buffer C<content> to the file C<path> starting at offset C<offset>.
5524 This command implements the L<pwrite(2)> system call, and like
5525 that system call it may not write the full data requested. The
5526 return value is the number of bytes that were actually written
5527 to the file. This could even be 0, although short writes are
5528 unlikely for regular files in ordinary circumstances.
5530 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5532 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5534 "resize an ext2, ext3 or ext4 filesystem (with size)",
5536 This command is the same as C<guestfs_resize2fs> except that it
5537 allows you to specify the new size (in bytes) explicitly.");
5539 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5541 "resize an LVM physical volume (with size)",
5543 This command is the same as C<guestfs_pvresize> except that it
5544 allows you to specify the new size (in bytes) explicitly.");
5546 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5548 "resize an NTFS filesystem (with size)",
5550 This command is the same as C<guestfs_ntfsresize> except that it
5551 allows you to specify the new size (in bytes) explicitly.");
5553 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5554 [InitNone, Always, TestRun [["available_all_groups"]]],
5555 "return a list of all optional groups",
5557 This command returns a list of all optional groups that this
5558 daemon knows about. Note this returns both supported and unsupported
5559 groups. To find out which ones the daemon can actually support
5560 you have to call C<guestfs_available> on each member of the
5563 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5565 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5566 [InitScratchFS, Always, TestOutputStruct (
5567 [["fallocate64"; "/fallocate64"; "1000000"];
5568 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5569 "preallocate a file in the guest filesystem",
5571 This command preallocates a file (containing zero bytes) named
5572 C<path> of size C<len> bytes. If the file exists already, it
5575 Note that this call allocates disk blocks for the file.
5576 To create a sparse file use C<guestfs_truncate_size> instead.
5578 The deprecated call C<guestfs_fallocate> does the same,
5579 but owing to an oversight it only allowed 30 bit lengths
5580 to be specified, effectively limiting the maximum size
5581 of files created through that call to 1GB.
5583 Do not confuse this with the guestfish-specific
5584 C<alloc> and C<sparse> commands which create
5585 a file in the host and attach it as a device.");
5587 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5588 [InitBasicFS, Always, TestOutput (
5589 [["set_e2label"; "/dev/sda1"; "LTEST"];
5590 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5591 "get the filesystem label",
5593 This returns the filesystem label of the filesystem on
5596 If the filesystem is unlabeled, this returns the empty string.
5598 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5600 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5601 (let uuid = uuidgen () in
5602 [InitBasicFS, Always, TestOutput (
5603 [["set_e2uuid"; "/dev/sda1"; uuid];
5604 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5605 "get the filesystem UUID",
5607 This returns the filesystem UUID of the filesystem on
5610 If the filesystem does not have a UUID, this returns the empty string.
5612 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5614 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5615 (* Can't be tested with the current framework because
5616 * the VG is being used by the mounted filesystem, so
5617 * the vgchange -an command we do first will fail.
5620 "set LVM device filter",
5622 This sets the LVM device filter so that LVM will only be
5623 able to \"see\" the block devices in the list C<devices>,
5624 and will ignore all other attached block devices.
5626 Where disk image(s) contain duplicate PVs or VGs, this
5627 command is useful to get LVM to ignore the duplicates, otherwise
5628 LVM can get confused. Note also there are two types
5629 of duplication possible: either cloned PVs/VGs which have
5630 identical UUIDs; or VGs that are not cloned but just happen
5631 to have the same name. In normal operation you cannot
5632 create this situation, but you can do it outside LVM, eg.
5633 by cloning disk images or by bit twiddling inside the LVM
5636 This command also clears the LVM cache and performs a volume
5639 You can filter whole block devices or individual partitions.
5641 You cannot use this if any VG is currently in use (eg.
5642 contains a mounted filesystem), even if you are not
5643 filtering out that VG.");
5645 ("lvm_clear_filter", (RErr, [], []), 256, [],
5646 [], (* see note on lvm_set_filter *)
5647 "clear LVM device filter",
5649 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5650 will be able to see every block device.
5652 This command also clears the LVM cache and performs a volume
5655 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5657 "open a LUKS-encrypted block device",
5659 This command opens a block device which has been encrypted
5660 according to the Linux Unified Key Setup (LUKS) standard.
5662 C<device> is the encrypted block device or partition.
5664 The caller must supply one of the keys associated with the
5665 LUKS block device, in the C<key> parameter.
5667 This creates a new block device called C</dev/mapper/mapname>.
5668 Reads and writes to this block device are decrypted from and
5669 encrypted to the underlying C<device> respectively.
5671 If this block device contains LVM volume groups, then
5672 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5673 will make them visible.
5675 Use C<guestfs_list_dm_devices> to list all device mapper
5678 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5680 "open a LUKS-encrypted block device read-only",
5682 This is the same as C<guestfs_luks_open> except that a read-only
5683 mapping is created.");
5685 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5687 "close a LUKS device",
5689 This closes a LUKS device that was created earlier by
5690 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5691 C<device> parameter must be the name of the LUKS mapping
5692 device (ie. C</dev/mapper/mapname>) and I<not> the name
5693 of the underlying block device.");
5695 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5697 "format a block device as a LUKS encrypted device",
5699 This command erases existing data on C<device> and formats
5700 the device as a LUKS encrypted device. C<key> is the
5701 initial key, which is added to key slot C<slot>. (LUKS
5702 supports 8 key slots, numbered 0-7).");
5704 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5706 "format a block device as a LUKS encrypted device",
5708 This command is the same as C<guestfs_luks_format> but
5709 it also allows you to set the C<cipher> used.");
5711 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5713 "add a key on a LUKS encrypted device",
5715 This command adds a new key on LUKS device C<device>.
5716 C<key> is any existing key, and is used to access the device.
5717 C<newkey> is the new key to add. C<keyslot> is the key slot
5718 that will be replaced.
5720 Note that if C<keyslot> already contains a key, then this
5721 command will fail. You have to use C<guestfs_luks_kill_slot>
5722 first to remove that key.");
5724 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5726 "remove a key from a LUKS encrypted device",
5728 This command deletes the key in key slot C<keyslot> from the
5729 encrypted LUKS device C<device>. C<key> must be one of the
5732 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5733 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5734 [["is_lv"; "/dev/VG/LV"]]);
5735 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5736 [["is_lv"; "/dev/sda1"]])],
5737 "test if device is a logical volume",
5739 This command tests whether C<device> is a logical volume, and
5740 returns true iff this is the case.");
5742 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5744 "find a filesystem by UUID",
5746 This command searches the filesystems and returns the one
5747 which has the given UUID. An error is returned if no such
5748 filesystem can be found.
5750 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5752 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5754 "find a filesystem by label",
5756 This command searches the filesystems and returns the one
5757 which has the given label. An error is returned if no such
5758 filesystem can be found.
5760 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5762 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5763 [InitISOFS, Always, TestOutputFalse (
5764 [["is_chardev"; "/directory"]]);
5765 InitScratchFS, Always, TestOutputTrue (
5766 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5767 ["is_chardev"; "/is_chardev"]])],
5768 "test if character device",
5770 This returns C<true> if and only if there is a character device
5771 with the given C<path> name.
5773 See also C<guestfs_stat>.");
5775 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5776 [InitISOFS, Always, TestOutputFalse (
5777 [["is_blockdev"; "/directory"]]);
5778 InitScratchFS, Always, TestOutputTrue (
5779 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5780 ["is_blockdev"; "/is_blockdev"]])],
5781 "test if block device",
5783 This returns C<true> if and only if there is a block device
5784 with the given C<path> name.
5786 See also C<guestfs_stat>.");
5788 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5789 [InitISOFS, Always, TestOutputFalse (
5790 [["is_fifo"; "/directory"]]);
5791 InitScratchFS, Always, TestOutputTrue (
5792 [["mkfifo"; "0o777"; "/is_fifo"];
5793 ["is_fifo"; "/is_fifo"]])],
5794 "test if FIFO (named pipe)",
5796 This returns C<true> if and only if there is a FIFO (named pipe)
5797 with the given C<path> name.
5799 See also C<guestfs_stat>.");
5801 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5802 [InitISOFS, Always, TestOutputFalse (
5803 [["is_symlink"; "/directory"]]);
5804 InitISOFS, Always, TestOutputTrue (
5805 [["is_symlink"; "/abssymlink"]])],
5806 "test if symbolic link",
5808 This returns C<true> if and only if there is a symbolic link
5809 with the given C<path> name.
5811 See also C<guestfs_stat>.");
5813 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5814 (* XXX Need a positive test for sockets. *)
5815 [InitISOFS, Always, TestOutputFalse (
5816 [["is_socket"; "/directory"]])],
5819 This returns C<true> if and only if there is a Unix domain socket
5820 with the given C<path> name.
5822 See also C<guestfs_stat>.");
5824 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5825 [InitPartition, Always, TestOutputDevice (
5826 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5827 InitEmpty, Always, TestLastFail (
5828 [["part_to_dev"; "/dev/sda"]])],
5829 "convert partition name to device name",
5831 This function takes a partition name (eg. \"/dev/sdb1\") and
5832 removes the partition number, returning the device name
5835 The named partition must exist, for example as a string returned
5836 from C<guestfs_list_partitions>.");
5838 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5839 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5840 [InitScratchFS, Always, TestOutput (
5841 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5842 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5843 "upload a file from the local machine with offset",
5845 Upload local file C<filename> to C<remotefilename> on the
5848 C<remotefilename> is overwritten starting at the byte C<offset>
5849 specified. The intention is to overwrite parts of existing
5850 files or devices, although if a non-existant file is specified
5851 then it is created with a \"hole\" before C<offset>. The
5852 size of the data written is implicit in the size of the
5855 Note that there is no limit on the amount of data that
5856 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5857 and this call always writes the full amount unless an
5860 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5862 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5863 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5864 let offset = string_of_int 100 in
5865 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5866 [InitScratchFS, Always, TestOutput (
5867 (* Pick a file from cwd which isn't likely to change. *)
5868 [["mkdir"; "/download_offset"];
5869 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5870 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5871 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5872 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5873 "download a file to the local machine with offset and size",
5875 Download file C<remotefilename> and save it as C<filename>
5876 on the local machine.
5878 C<remotefilename> is read for C<size> bytes starting at C<offset>
5879 (this region must be within the file or device).
5881 Note that there is no limit on the amount of data that
5882 can be downloaded with this call, unlike with C<guestfs_pread>,
5883 and this call always reads the full amount unless an
5886 See also C<guestfs_download>, C<guestfs_pread>.");
5888 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5889 [InitPartition, Always, TestOutputListOfDevices (
5890 [["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"];
5891 ["blockdev_rereadpt"; "/dev/sda"];
5892 ["list_partitions"]], ["/dev/sdb1"])],
5893 "write to part of a device",
5895 This command writes to part of a device. It writes the data
5896 buffer C<content> to C<device> starting at offset C<offset>.
5898 This command implements the L<pwrite(2)> system call, and like
5899 that system call it may not write the full data requested
5900 (although short writes to disk devices and partitions are
5901 probably impossible with standard Linux kernels).
5903 See also C<guestfs_pwrite>.");
5905 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5906 [InitEmpty, Always, TestOutputBuffer (
5907 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5908 "read part of a device",
5910 This command lets you read part of a file. It reads C<count>
5911 bytes of C<device>, starting at C<offset>.
5913 This may read fewer bytes than requested. For further details
5914 see the L<pread(2)> system call.
5916 See also C<guestfs_pread>.");
5918 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5919 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5920 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5921 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5922 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5923 "get canonical name of an LV",
5925 This converts alternative naming schemes for LVs that you
5926 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5927 is converted to C</dev/VG/LV>.
5929 This command returns an error if the C<lvname> parameter does
5930 not refer to a logical volume.
5932 See also C<guestfs_is_lv>.");
5934 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
5935 [InitEmpty, Always, TestOutput (
5936 [["part_disk"; "/dev/sda"; "mbr"];
5937 ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
5938 ["mount_options"; ""; "/dev/sda1"; "/"];
5939 ["write"; "/new"; "new file contents"];
5940 ["cat"; "/new"]], "new file contents")],
5941 "make a filesystem",
5943 This function creates a filesystem on C<device>. The filesystem
5944 type is C<fstype>, for example C<ext3>.
5946 The optional arguments are:
5952 The filesystem block size. Supported block sizes depend on the
5953 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5954 for Linux ext2/3 filesystems.
5956 For VFAT and NTFS the C<blocksize> parameter is treated as
5957 the requested cluster size.
5959 For UFS block sizes, please see L<mkfs.ufs(8)>.
5963 This passes the I<-O> parameter to the external mkfs program.
5965 For certain filesystem types, this allows extra filesystem
5966 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5969 You cannot use this optional parameter with the C<gfs> or
5970 C<gfs2> filesystem type.
5974 This passes the I<-I> parameter to the external L<mke2fs(8)> program
5975 which sets the inode size (only for ext2/3/4 filesystems at present).
5979 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
5980 which sets sector size for ufs filesystem.
5984 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5986 "get a single extended attribute",
5988 Get a single extended attribute from file C<path> named C<name>.
5989 This call follows symlinks. If you want to lookup an extended
5990 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5992 Normally it is better to get all extended attributes from a file
5993 in one go by calling C<guestfs_getxattrs>. However some Linux
5994 filesystem implementations are buggy and do not provide a way to
5995 list out attributes. For these filesystems (notably ntfs-3g)
5996 you have to know the names of the extended attributes you want
5997 in advance and call this function.
5999 Extended attribute values are blobs of binary data. If there
6000 is no extended attribute named C<name>, this returns an error.
6002 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
6004 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
6006 "get a single extended attribute",
6008 Get a single extended attribute from file C<path> named C<name>.
6009 If C<path> is a symlink, then this call returns an extended
6010 attribute from the symlink.
6012 Normally it is better to get all extended attributes from a file
6013 in one go by calling C<guestfs_getxattrs>. However some Linux
6014 filesystem implementations are buggy and do not provide a way to
6015 list out attributes. For these filesystems (notably ntfs-3g)
6016 you have to know the names of the extended attributes you want
6017 in advance and call this function.
6019 Extended attribute values are blobs of binary data. If there
6020 is no extended attribute named C<name>, this returns an error.
6022 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
6024 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
6026 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
6028 This command is the same as C<guestfs_resize2fs>, but the filesystem
6029 is resized to its minimum size. This works like the I<-M> option
6030 to the C<resize2fs> command.
6032 To get the resulting size of the filesystem you should call
6033 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
6034 values. These two numbers, multiplied together, give the
6035 resulting size of the minimal filesystem in bytes.");
6037 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
6039 "internal autosync operation",
6041 This command performs the autosync operation just before the
6042 handle is closed. You should not call this command directly.
6043 Instead, use the autosync flag (C<guestfs_set_autosync>) to
6044 control whether or not this operation is performed when the
6045 handle is closed.");
6047 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6048 [InitISOFS, Always, TestOutputTrue (
6049 [["is_zero"; "/100kallzeroes"]]);
6050 InitISOFS, Always, TestOutputFalse (
6051 [["is_zero"; "/100kallspaces"]])],
6052 "test if a file contains all zero bytes",
6054 This returns true iff the file exists and the file is empty or
6055 it contains all zero bytes.");
6057 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6058 [InitBasicFS, Always, TestOutputTrue (
6059 [["umount"; "/dev/sda1"];
6060 ["zero_device"; "/dev/sda1"];
6061 ["is_zero_device"; "/dev/sda1"]]);
6062 InitBasicFS, Always, TestOutputFalse (
6063 [["is_zero_device"; "/dev/sda1"]])],
6064 "test if a device contains all zero bytes",
6066 This returns true iff the device exists and contains all zero bytes.
6068 Note that for large devices this can take a long time to run.");
6070 ("list_9p", (RStringList "mounttags", [], []), 285, [],
6072 "list 9p filesystems",
6074 List all 9p filesystems attached to the guest. A list of
6075 mount tags is returned.");
6077 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6079 "mount 9p filesystem",
6081 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6082 directory C<mountpoint>.
6084 If required, C<trans=virtio> will be automatically added to the options.
6085 Any other options required can be passed in the optional C<options>
6088 ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6090 "list device mapper devices",
6092 List all device mapper devices.
6094 The returned list contains C</dev/mapper/*> devices, eg. ones created
6095 by a previous call to C<guestfs_luks_open>.
6097 Device mapper devices which correspond to logical volumes are I<not>
6098 returned in this list. Call C<guestfs_lvs> if you want to list logical
6101 ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6103 "resize an NTFS filesystem",
6105 This command resizes an NTFS filesystem, expanding or
6106 shrinking it to the size of the underlying device.
6108 The optional parameters are:
6114 The new size (in bytes) of the filesystem. If omitted, the filesystem
6115 is resized to fit the container (eg. partition).
6119 If this option is true, then force the resize of the filesystem
6120 even if the filesystem is marked as requiring a consistency check.
6122 After the resize operation, the filesystem is always marked
6123 as requiring a consistency check (for safety). You have to boot
6124 into Windows to perform this check and clear this condition.
6125 If you I<don't> set the C<force> option then it is not
6126 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6127 single filesystem without booting into Windows between each resize.
6131 See also L<ntfsresize(8)>.");
6133 ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6135 "resize a btrfs filesystem",
6137 This command resizes a btrfs filesystem.
6139 Note that unlike other resize calls, the filesystem has to be
6140 mounted and the parameter is the mountpoint not the device
6141 (this is a requirement of btrfs itself).
6143 The optional parameters are:
6149 The new size (in bytes) of the filesystem. If omitted, the filesystem
6150 is resized to the maximum size.
6154 See also L<btrfs(8)>.");
6156 ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6157 [InitScratchFS, Always, TestOutput (
6158 [["write"; "/write_append"; "line1\n"];
6159 ["write_append"; "/write_append"; "line2\n"];
6160 ["write_append"; "/write_append"; "line3a"];
6161 ["write_append"; "/write_append"; "line3b\n"];
6162 ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6163 "append content to end of file",
6165 This call appends C<content> to the end of file C<path>. If
6166 C<path> does not exist, then a new file is created.
6168 See also C<guestfs_write>.");
6170 ("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [Int "level"]), 291, [],
6172 "output compressed file",
6174 This command compresses C<file> and writes it out to the local
6177 The compression program used is controlled by the C<ctype> parameter.
6178 Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.
6179 Some compression types may not be supported by particular builds of
6180 libguestfs, in which case you will get an error containing the
6181 substring \"not supported\".
6183 The optional C<level> parameter controls compression level. The
6184 meaning and default for this parameter depends on the compression
6185 program being used.");
6187 ("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [Int "level"]), 292, [],
6189 "output compressed device",
6191 This command compresses C<device> and writes it out to the local
6194 The C<ctype> and optional C<level> parameters have the same meaning
6195 as in C<guestfs_compress_out>.");
6199 let all_functions = non_daemon_functions @ daemon_functions
6201 (* In some places we want the functions to be displayed sorted
6202 * alphabetically, so this is useful:
6204 let all_functions_sorted = List.sort action_compare all_functions
6206 (* This is used to generate the src/MAX_PROC_NR file which
6207 * contains the maximum procedure number, a surrogate for the
6208 * ABI version number. See src/Makefile.am for the details.
6211 let proc_nrs = List.map (
6212 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6213 ) daemon_functions in
6214 List.fold_left max 0 proc_nrs
6216 (* Non-API meta-commands available only in guestfish.
6218 * Note (1): style, proc_nr and tests fields are all meaningless.
6219 * The only fields which are actually used are the shortname,
6220 * FishAlias flags, shortdesc and longdesc.
6222 * Note (2): to refer to other commands, use L</shortname>.
6224 * Note (3): keep this list sorted by shortname.
6226 let fish_commands = [
6227 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6228 "allocate and add a disk file",
6229 " alloc filename size
6231 This creates an empty (zeroed) file of the given size, and then adds
6232 so it can be further examined.
6234 For more advanced image creation, see L<qemu-img(1)> utility.
6236 Size can be specified using standard suffixes, eg. C<1M>.
6238 To create a sparse file, use L</sparse> instead. To create a
6239 prepared disk image, see L</PREPARED DISK IMAGES>.");
6241 ("copy_in", (RErr,[], []), -1, [], [],
6242 "copy local files or directories into an image",
6243 " copy-in local [local ...] /remotedir
6245 C<copy-in> copies local files or directories recursively into the disk
6246 image, placing them in the directory called C</remotedir> (which must
6247 exist). This guestfish meta-command turns into a sequence of
6248 L</tar-in> and other commands as necessary.
6250 Multiple local files and directories can be specified, but the last
6251 parameter must always be a remote directory. Wildcards cannot be
6254 ("copy_out", (RErr,[], []), -1, [], [],
6255 "copy remote files or directories out of an image",
6256 " copy-out remote [remote ...] localdir
6258 C<copy-out> copies remote files or directories recursively out of the
6259 disk image, placing them on the host disk in a local directory called
6260 C<localdir> (which must exist). This guestfish meta-command turns
6261 into a sequence of L</download>, L</tar-out> and other commands as
6264 Multiple remote files and directories can be specified, but the last
6265 parameter must always be a local directory. To download to the
6266 current directory, use C<.> as in:
6270 Wildcards cannot be used in the ordinary command, but you can use
6271 them with the help of L</glob> like this:
6273 glob copy-out /home/* .");
6275 ("display", (RErr,[], []), -1, [], [],
6279 Use C<display> (a graphical display program) to display an image
6280 file. It downloads the file, and runs C<display> on it.
6282 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6283 environment variable. For example to use the GNOME display program:
6285 export GUESTFISH_DISPLAY_IMAGE=eog
6287 See also L<display(1)>.");
6289 ("echo", (RErr,[], []), -1, [], [],
6290 "display a line of text",
6293 This echos the parameters to the terminal.");
6295 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6299 This is used to edit a file. It downloads the file, edits it
6300 locally using your editor, then uploads the result.
6302 The editor is C<$EDITOR>. However if you use the alternate
6303 commands C<vi> or C<emacs> you will get those corresponding
6306 ("glob", (RErr,[], []), -1, [], [],
6307 "expand wildcards in command",
6308 " glob command args...
6310 Expand wildcards in any paths in the args list, and run C<command>
6311 repeatedly on each matching path.
6313 See L</WILDCARDS AND GLOBBING>.");
6315 ("hexedit", (RErr,[], []), -1, [], [],
6316 "edit with a hex editor",
6317 " hexedit <filename|device>
6318 hexedit <filename|device> <max>
6319 hexedit <filename|device> <start> <max>
6321 Use hexedit (a hex editor) to edit all or part of a binary file
6324 This command works by downloading potentially the whole file or
6325 device, editing it locally, then uploading it. If the file or
6326 device is large, you have to specify which part you wish to edit
6327 by using C<max> and/or C<start> C<max> parameters.
6328 C<start> and C<max> are specified in bytes, with the usual
6329 modifiers allowed such as C<1M> (1 megabyte).
6331 For example to edit the first few sectors of a disk you
6336 which would allow you to edit anywhere within the first megabyte
6339 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6341 hexedit /dev/sda1 0x400 0x400
6343 (assuming the superblock is in the standard location).
6345 This command requires the external L<hexedit(1)> program. You
6346 can specify another program to use by setting the C<HEXEDITOR>
6347 environment variable.
6349 See also L</hexdump>.");
6351 ("lcd", (RErr,[], []), -1, [], [],
6352 "change working directory",
6355 Change the local directory, ie. the current directory of guestfish
6358 Note that C<!cd> won't do what you might expect.");
6360 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6364 Opens the manual page for guestfish.");
6366 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6372 This is used to view a file.
6374 The default viewer is C<$PAGER>. However if you use the alternate
6375 command C<less> you will get the C<less> command specifically.");
6377 ("reopen", (RErr,[], []), -1, [], [],
6378 "close and reopen libguestfs handle",
6381 Close and reopen the libguestfs handle. It is not necessary to use
6382 this normally, because the handle is closed properly when guestfish
6383 exits. However this is occasionally useful for testing.");
6385 ("setenv", (RErr,[], []), -1, [], [],
6386 "set an environment variable",
6389 Set the environment variable C<VAR> to the string C<value>.
6391 To print the value of an environment variable use a shell command
6396 ("sparse", (RErr,[], []), -1, [], [],
6397 "create a sparse disk image and add",
6398 " sparse filename size
6400 This creates an empty sparse file of the given size, and then adds
6401 so it can be further examined.
6403 In all respects it works the same as the L</alloc> command, except that
6404 the image file is allocated sparsely, which means that disk blocks are
6405 not assigned to the file until they are needed. Sparse disk files
6406 only use space when written to, but they are slower and there is a
6407 danger you could run out of real disk space during a write operation.
6409 For more advanced image creation, see L<qemu-img(1)> utility.
6411 Size can be specified using standard suffixes, eg. C<1M>.");
6413 ("supported", (RErr,[], []), -1, [], [],
6414 "list supported groups of commands",
6417 This command returns a list of the optional groups
6418 known to the daemon, and indicates which ones are
6419 supported by this build of the libguestfs appliance.
6421 See also L<guestfs(3)/AVAILABILITY>.");
6423 ("time", (RErr,[], []), -1, [], [],
6424 "print elapsed time taken to run a command",
6425 " time command args...
6427 Run the command as usual, but print the elapsed time afterwards. This
6428 can be useful for benchmarking operations.");
6430 ("unsetenv", (RErr,[], []), -1, [], [],
6431 "unset an environment variable",
6434 Remove C<VAR> from the environment.");