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.
752 The operating system type could not be determined.
756 Future versions of libguestfs may return other strings here.
757 The caller should be prepared to handle any string.
759 Please read L<guestfs(3)/INSPECTION> for more details.");
761 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
763 "get architecture of inspected operating system",
765 This returns the architecture of the inspected operating system.
766 The possible return values are listed under
767 C<guestfs_file_architecture>.
769 If the architecture could not be determined, then the
770 string C<unknown> is returned.
772 Please read L<guestfs(3)/INSPECTION> for more details.");
774 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
776 "get distro of inspected operating system",
778 This returns the distro (distribution) of the inspected operating
781 Currently defined distros are:
829 =item \"redhat-based\"
831 Some Red Hat-derived distro.
835 Red Hat Enterprise Linux.
837 =item \"scientificlinux\"
855 The distro could not be determined.
859 Windows does not have distributions. This string is
860 returned if the OS type is Windows.
864 Future versions of libguestfs may return other strings here.
865 The caller should be prepared to handle any string.
867 Please read L<guestfs(3)/INSPECTION> for more details.");
869 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
871 "get major version of inspected operating system",
873 This returns the major version number of the inspected operating
876 Windows uses a consistent versioning scheme which is I<not>
877 reflected in the popular public names used by the operating system.
878 Notably the operating system known as \"Windows 7\" is really
879 version 6.1 (ie. major = 6, minor = 1). You can find out the
880 real versions corresponding to releases of Windows by consulting
883 If the version could not be determined, then C<0> is returned.
885 Please read L<guestfs(3)/INSPECTION> for more details.");
887 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
889 "get minor version of inspected operating system",
891 This returns the minor version number of the inspected operating
894 If the version could not be determined, then C<0> is returned.
896 Please read L<guestfs(3)/INSPECTION> for more details.
897 See also C<guestfs_inspect_get_major_version>.");
899 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
901 "get product name of inspected operating system",
903 This returns the product name of the inspected operating
904 system. The product name is generally some freeform string
905 which can be displayed to the user, but should not be
908 If the product name could not be determined, then the
909 string C<unknown> is returned.
911 Please read L<guestfs(3)/INSPECTION> for more details.");
913 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
915 "get mountpoints of inspected operating system",
917 This returns a hash of where we think the filesystems
918 associated with this operating system should be mounted.
919 Callers should note that this is at best an educated guess
920 made by reading configuration files such as C</etc/fstab>.
921 I<In particular note> that this may return filesystems
922 which are non-existent or not mountable and callers should
923 be prepared to handle or ignore failures if they try to
926 Each element in the returned hashtable has a key which
927 is the path of the mountpoint (eg. C</boot>) and a value
928 which is the filesystem that would be mounted there
931 Non-mounted devices such as swap devices are I<not>
932 returned in this list.
934 For operating systems like Windows which still use drive
935 letters, this call will only return an entry for the first
936 drive \"mounted on\" C</>. For information about the
937 mapping of drive letters to partitions, see
938 C<guestfs_inspect_get_drive_mappings>.
940 Please read L<guestfs(3)/INSPECTION> for more details.
941 See also C<guestfs_inspect_get_filesystems>.");
943 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
945 "get filesystems associated with inspected operating system",
947 This returns a list of all the filesystems that we think
948 are associated with this operating system. This includes
949 the root filesystem, other ordinary filesystems, and
950 non-mounted devices like swap partitions.
952 In the case of a multi-boot virtual machine, it is possible
953 for a filesystem to be shared between operating systems.
955 Please read L<guestfs(3)/INSPECTION> for more details.
956 See also C<guestfs_inspect_get_mountpoints>.");
958 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
960 "set enable network flag",
962 If C<network> is true, then the network is enabled in the
963 libguestfs appliance. The default is false.
965 This affects whether commands are able to access the network
966 (see L<guestfs(3)/RUNNING COMMANDS>).
968 You must call this before calling C<guestfs_launch>, otherwise
971 ("get_network", (RBool "network", [], []), -1, [],
973 "get enable network flag",
975 This returns the enable network flag.");
977 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
981 This inspection command looks for filesystems on partitions,
982 block devices and logical volumes, returning a list of devices
983 containing filesystems and their type.
985 The return value is a hash, where the keys are the devices
986 containing filesystems, and the values are the filesystem types.
989 \"/dev/sda1\" => \"ntfs\"
990 \"/dev/sda2\" => \"ext2\"
991 \"/dev/vg_guest/lv_root\" => \"ext4\"
992 \"/dev/vg_guest/lv_swap\" => \"swap\"
994 The value can have the special value \"unknown\", meaning the
995 content of the device is undetermined or empty.
996 \"swap\" means a Linux swap partition.
998 This command runs other libguestfs commands, which might include
999 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
1000 use this soon after launch and only when nothing is mounted.
1002 Not all of the filesystems returned will be mountable. In
1003 particular, swap partitions are returned in the list. Also
1004 this command does not check that each filesystem
1005 found is valid and mountable, and some filesystems might
1006 be mountable but require special options. Filesystems may
1007 not all belong to a single logical operating system
1008 (use C<guestfs_inspect_os> to look for OSes).");
1010 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"; String "name"]), -1, [FishAlias "add"],
1012 "add an image to examine or modify",
1014 This function adds a virtual machine disk image C<filename> to
1015 libguestfs. The first time you call this function, the disk
1016 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1019 You don't necessarily need to be root when using libguestfs. However
1020 you obviously do need sufficient permissions to access the filename
1021 for whatever operations you want to perform (ie. read access if you
1022 just want to read the image or write access if you want to modify the
1025 This call checks that C<filename> exists.
1027 The optional arguments are:
1033 If true then the image is treated as read-only. Writes are still
1034 allowed, but they are stored in a temporary snapshot overlay which
1035 is discarded at the end. The disk that you add is not modified.
1039 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1040 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1041 Possible formats include C<raw> and C<qcow2>.
1043 Automatic detection of the format opens you up to a potential
1044 security hole when dealing with untrusted raw-format images.
1045 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1050 This rarely-used option lets you emulate the behaviour of the
1051 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1055 The name the drive had in the original guest, e.g. /dev/sdb. This is used as a
1056 hint to the guest inspection process if it is available.
1060 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1062 "get Windows systemroot of inspected operating system",
1064 This returns the Windows systemroot of the inspected guest.
1065 The systemroot is a directory path such as C</WINDOWS>.
1067 This call assumes that the guest is Windows and that the
1068 systemroot could be determined by inspection. If this is not
1069 the case then an error is returned.
1071 Please read L<guestfs(3)/INSPECTION> for more details.");
1073 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1075 "return list of operating systems found by last inspection",
1077 This function is a convenient way to get the list of root
1078 devices, as returned from a previous call to C<guestfs_inspect_os>,
1079 but without redoing the whole inspection process.
1081 This returns an empty list if either no root devices were
1082 found or the caller has not called C<guestfs_inspect_os>.
1084 Please read L<guestfs(3)/INSPECTION> for more details.");
1086 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1088 "debug the QEMU command line (internal use only)",
1090 This returns the internal QEMU command line. 'debug' commands are
1091 not part of the formal API and can be removed or changed at any time.");
1093 ("debug_drives", (RStringList "cmdline", [], []), -1, [NotInDocs],
1095 "debug the drives (internal use only)",
1097 This returns the internal list of drives. 'debug' commands are
1098 not part of the formal API and can be removed or changed at any time.");
1100 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1102 "add the disk(s) from a named libvirt domain",
1104 This function adds the disk(s) attached to the named libvirt
1105 domain C<dom>. It works by connecting to libvirt, requesting
1106 the domain and domain XML from libvirt, parsing it for disks,
1107 and calling C<guestfs_add_drive_opts> on each one.
1109 The number of disks added is returned. This operation is atomic:
1110 if an error is returned, then no disks are added.
1112 This function does some minimal checks to make sure the libvirt
1113 domain is not running (unless C<readonly> is true). In a future
1114 version we will try to acquire the libvirt lock on each disk.
1116 Disks must be accessible locally. This often means that adding disks
1117 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1118 will fail unless those disks are accessible via the same device path
1121 The optional C<libvirturi> parameter sets the libvirt URI
1122 (see L<http://libvirt.org/uri.html>). If this is not set then
1123 we connect to the default libvirt URI (or one set through an
1124 environment variable, see the libvirt documentation for full
1127 The optional C<live> flag controls whether this call will try
1128 to connect to a running virtual machine C<guestfsd> process if
1129 it sees a suitable E<lt>channelE<gt> element in the libvirt
1130 XML definition. The default (if the flag is omitted) is never
1131 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1134 If the C<allowuuid> flag is true (default is false) then a UUID
1135 I<may> be passed instead of the domain name. The C<dom> string is
1136 treated as a UUID first and looked up, and if that lookup fails
1137 then we treat C<dom> as a name as usual.
1139 The other optional parameters are passed directly through to
1140 C<guestfs_add_drive_opts>.");
1143 This interface is not quite baked yet. -- RWMJ 2010-11-11
1144 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1146 "add the disk(s) from a libvirt domain",
1148 This function adds the disk(s) attached to the libvirt domain C<dom>.
1149 It works by requesting the domain XML from libvirt, parsing it for
1150 disks, and calling C<guestfs_add_drive_opts> on each one.
1152 In the C API we declare C<void *dom>, but really it has type
1153 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1155 The number of disks added is returned. This operation is atomic:
1156 if an error is returned, then no disks are added.
1158 This function does some minimal checks to make sure the libvirt
1159 domain is not running (unless C<readonly> is true). In a future
1160 version we will try to acquire the libvirt lock on each disk.
1162 Disks must be accessible locally. This often means that adding disks
1163 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1164 will fail unless those disks are accessible via the same device path
1167 The optional C<live> flag controls whether this call will try
1168 to connect to a running virtual machine C<guestfsd> process if
1169 it sees a suitable E<lt>channelE<gt> element in the libvirt
1170 XML definition. The default (if the flag is omitted) is never
1171 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1174 The other optional parameters are passed directly through to
1175 C<guestfs_add_drive_opts>.");
1178 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1180 "get package format used by the operating system",
1182 This function and C<guestfs_inspect_get_package_management> return
1183 the package format and package management tool used by the
1184 inspected operating system. For example for Fedora these
1185 functions would return C<rpm> (package format) and
1186 C<yum> (package management).
1188 This returns the string C<unknown> if we could not determine the
1189 package format I<or> if the operating system does not have
1190 a real packaging system (eg. Windows).
1192 Possible strings include:
1193 C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, C<pkgsrc>.
1194 Future versions of libguestfs may return other strings.
1196 Please read L<guestfs(3)/INSPECTION> for more details.");
1198 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1200 "get package management tool used by the operating system",
1202 C<guestfs_inspect_get_package_format> and this function return
1203 the package format and package management tool used by the
1204 inspected operating system. For example for Fedora these
1205 functions would return C<rpm> (package format) and
1206 C<yum> (package management).
1208 This returns the string C<unknown> if we could not determine the
1209 package management tool I<or> if the operating system does not have
1210 a real packaging system (eg. Windows).
1212 Possible strings include: C<yum>, C<up2date>,
1213 C<apt> (for all Debian derivatives),
1214 C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>.
1215 Future versions of libguestfs may return other strings.
1217 Please read L<guestfs(3)/INSPECTION> for more details.");
1219 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1221 "get list of applications installed in the operating system",
1223 Return the list of applications installed in the operating system.
1225 I<Note:> This call works differently from other parts of the
1226 inspection API. You have to call C<guestfs_inspect_os>, then
1227 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1228 before calling this. Listing applications is a significantly
1229 more difficult operation which requires access to the full
1230 filesystem. Also note that unlike the other
1231 C<guestfs_inspect_get_*> calls which are just returning
1232 data cached in the libguestfs handle, this call actually reads
1233 parts of the mounted filesystems during the call.
1235 This returns an empty list if the inspection code was not able
1236 to determine the list of applications.
1238 The application structure contains the following fields:
1244 The name of the application. For Red Hat-derived and Debian-derived
1245 Linux guests, this is the package name.
1247 =item C<app_display_name>
1249 The display name of the application, sometimes localized to the
1250 install language of the guest operating system.
1252 If unavailable this is returned as an empty string C<\"\">.
1253 Callers needing to display something can use C<app_name> instead.
1257 For package managers which use epochs, this contains the epoch of
1258 the package (an integer). If unavailable, this is returned as C<0>.
1260 =item C<app_version>
1262 The version string of the application or package. If unavailable
1263 this is returned as an empty string C<\"\">.
1265 =item C<app_release>
1267 The release string of the application or package, for package
1268 managers that use this. If unavailable this is returned as an
1269 empty string C<\"\">.
1271 =item C<app_install_path>
1273 The installation path of the application (on operating systems
1274 such as Windows which use installation paths). This path is
1275 in the format used by the guest operating system, it is not
1278 If unavailable this is returned as an empty string C<\"\">.
1280 =item C<app_trans_path>
1282 The install path translated into a libguestfs path.
1283 If unavailable this is returned as an empty string C<\"\">.
1285 =item C<app_publisher>
1287 The name of the publisher of the application, for package
1288 managers that use this. If unavailable this is returned
1289 as an empty string C<\"\">.
1293 The URL (eg. upstream URL) of the application.
1294 If unavailable this is returned as an empty string C<\"\">.
1296 =item C<app_source_package>
1298 For packaging systems which support this, the name of the source
1299 package. If unavailable this is returned as an empty string C<\"\">.
1301 =item C<app_summary>
1303 A short (usually one line) description of the application or package.
1304 If unavailable this is returned as an empty string C<\"\">.
1306 =item C<app_description>
1308 A longer description of the application or package.
1309 If unavailable this is returned as an empty string C<\"\">.
1313 Please read L<guestfs(3)/INSPECTION> for more details.");
1315 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1317 "get hostname of the operating system",
1319 This function returns the hostname of the operating system
1320 as found by inspection of the guest's configuration files.
1322 If the hostname could not be determined, then the
1323 string C<unknown> is returned.
1325 Please read L<guestfs(3)/INSPECTION> for more details.");
1327 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1329 "get format of inspected operating system",
1331 This returns the format of the inspected operating system. You
1332 can use it to detect install images, live CDs and similar.
1334 Currently defined formats are:
1340 This is an installed operating system.
1344 The disk image being inspected is not an installed operating system,
1345 but a I<bootable> install disk, live CD, or similar.
1349 The format of this disk image is not known.
1353 Future versions of libguestfs may return other strings here.
1354 The caller should be prepared to handle any string.
1356 Please read L<guestfs(3)/INSPECTION> for more details.");
1358 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1360 "get live flag for install disk",
1362 If C<guestfs_inspect_get_format> returns C<installer> (this
1363 is an install disk), then this returns true if a live image
1364 was detected on the disk.
1366 Please read L<guestfs(3)/INSPECTION> for more details.");
1368 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1370 "get netinst (network installer) flag for install disk",
1372 If C<guestfs_inspect_get_format> returns C<installer> (this
1373 is an install disk), then this returns true if the disk is
1374 a network installer, ie. not a self-contained install CD but
1375 one which is likely to require network access to complete
1378 Please read L<guestfs(3)/INSPECTION> for more details.");
1380 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1382 "get multipart flag for install disk",
1384 If C<guestfs_inspect_get_format> returns C<installer> (this
1385 is an install disk), then this returns true if the disk is
1388 Please read L<guestfs(3)/INSPECTION> for more details.");
1390 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1392 "set the attach method",
1394 Set the method that libguestfs uses to connect to the back end
1395 guestfsd daemon. Possible methods are:
1401 Launch an appliance and connect to it. This is the ordinary method
1404 =item C<unix:I<path>>
1406 Connect to the Unix domain socket I<path>.
1408 This method lets you connect to an existing daemon or (using
1409 virtio-serial) to a live guest. For more information, see
1410 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1414 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1415 [InitNone, Always, TestOutput (
1416 [["get_attach_method"]], "appliance")],
1417 "get the attach method",
1419 Return the current attach method. See C<guestfs_set_attach_method>.");
1421 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1423 "get product variant of inspected operating system",
1425 This returns the product variant of the inspected operating
1428 For Windows guests, this returns the contents of the Registry key
1429 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1430 C<InstallationType> which is usually a string such as
1431 C<Client> or C<Server> (other values are possible). This
1432 can be used to distinguish consumer and enterprise versions
1433 of Windows that have the same version number (for example,
1434 Windows 7 and Windows 2008 Server are both version 6.1,
1435 but the former is C<Client> and the latter is C<Server>).
1437 For enterprise Linux guests, in future we intend this to return
1438 the product variant such as C<Desktop>, C<Server> and so on. But
1439 this is not implemented at present.
1441 If the product variant could not be determined, then the
1442 string C<unknown> is returned.
1444 Please read L<guestfs(3)/INSPECTION> for more details.
1445 See also C<guestfs_inspect_get_product_name>,
1446 C<guestfs_inspect_get_major_version>.");
1448 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1450 "get Windows CurrentControlSet of inspected operating system",
1452 This returns the Windows CurrentControlSet of the inspected guest.
1453 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1455 This call assumes that the guest is Windows and that the
1456 Registry could be examined by inspection. If this is not
1457 the case then an error is returned.
1459 Please read L<guestfs(3)/INSPECTION> for more details.");
1461 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1463 "get drive letter mappings",
1465 This call is useful for Windows which uses a primitive system
1466 of assigning drive letters (like \"C:\") to partitions.
1467 This inspection API examines the Windows Registry to find out
1468 how disks/partitions are mapped to drive letters, and returns
1469 a hash table as in the example below:
1475 Note that keys are drive letters. For Windows, the key is
1476 case insensitive and just contains the drive letter, without
1477 the customary colon separator character.
1479 In future we may support other operating systems that also used drive
1480 letters, but the keys for those might not be case insensitive
1481 and might be longer than 1 character. For example in OS-9,
1482 hard drives were named C<h0>, C<h1> etc.
1484 For Windows guests, currently only hard drive mappings are
1485 returned. Removable disks (eg. DVD-ROMs) are ignored.
1487 For guests that do not use drive mappings, or if the drive mappings
1488 could not be determined, this returns an empty hash table.
1490 Please read L<guestfs(3)/INSPECTION> for more details.
1491 See also C<guestfs_inspect_get_mountpoints>,
1492 C<guestfs_inspect_get_filesystems>.");
1494 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1496 "get the icon corresponding to this operating system",
1498 This function returns an icon corresponding to the inspected
1499 operating system. The icon is returned as a buffer containing a
1500 PNG image (re-encoded to PNG if necessary).
1502 If it was not possible to get an icon this function returns a
1503 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1505 Libguestfs will start by looking for a file called
1506 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1507 and if it has the correct format, the contents of this file will
1508 be returned. You can disable favicons by passing the
1509 optional C<favicon> boolean as false (default is true).
1511 If finding the favicon fails, then we look in other places in the
1512 guest for a suitable icon.
1514 If the optional C<highquality> boolean is true then
1515 only high quality icons are returned, which means only icons of
1516 high resolution with an alpha channel. The default (false) is
1517 to return any icon we can, even if it is of substandard quality.
1525 Unlike most other inspection API calls, the guest's disks must be
1526 mounted up before you call this, since it needs to read information
1527 from the guest filesystem during the call.
1531 B<Security:> The icon data comes from the untrusted guest,
1532 and should be treated with caution. PNG files have been
1533 known to contain exploits. Ensure that libpng (or other relevant
1534 libraries) are fully up to date before trying to process or
1539 The PNG image returned can be any size. It might not be square.
1540 Libguestfs tries to return the largest, highest quality
1541 icon available. The application must scale the icon to the
1546 Extracting icons from Windows guests requires the external
1547 C<wrestool> program from the C<icoutils> package, and
1548 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1549 from the C<netpbm> package. These must be installed separately.
1553 Operating system icons are usually trademarks. Seek legal
1554 advice before using trademarks in applications.
1558 ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1560 "set process group flag",
1562 If C<pgroup> is true, child processes are placed into
1563 their own process group.
1565 The practical upshot of this is that signals like C<SIGINT> (from
1566 users pressing C<^C>) won't be received by the child process.
1568 The default for this flag is false, because usually you want
1569 C<^C> to kill the subprocess.");
1571 ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1573 "get process group flag",
1575 This returns the process group flag.");
1577 ("set_smp", (RErr, [Int "smp"], []), -1, [FishAlias "smp"],
1579 "set number of virtual CPUs in appliance",
1581 Change the number of virtual CPUs assigned to the appliance. The
1582 default is C<1>. Increasing this may improve performance, though
1583 often it has no effect.
1585 This function must be called before C<guestfs_launch>.");
1587 ("get_smp", (RInt "smp", [], []), -1, [],
1589 "get number of virtual CPUs in appliance",
1591 This returns the number of virtual CPUs assigned to the appliance.");
1595 (* daemon_functions are any functions which cause some action
1596 * to take place in the daemon.
1599 let daemon_functions = [
1600 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1601 [InitEmpty, Always, TestOutput (
1602 [["part_disk"; "/dev/sda"; "mbr"];
1603 ["mkfs"; "ext2"; "/dev/sda1"];
1604 ["mount"; "/dev/sda1"; "/"];
1605 ["write"; "/new"; "new file contents"];
1606 ["cat"; "/new"]], "new file contents")],
1607 "mount a guest disk at a position in the filesystem",
1609 Mount a guest disk at a position in the filesystem. Block devices
1610 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1611 the guest. If those block devices contain partitions, they will have
1612 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1615 The rules are the same as for L<mount(2)>: A filesystem must
1616 first be mounted on C</> before others can be mounted. Other
1617 filesystems can only be mounted on directories which already
1620 The mounted filesystem is writable, if we have sufficient permissions
1621 on the underlying device.
1623 Before libguestfs 1.13.16, this call implicitly added the options
1624 C<sync> and C<noatime>. The C<sync> option greatly slowed
1625 writes and caused many problems for users. If your program
1626 might need to work with older versions of libguestfs, use
1627 C<guestfs_mount_options> instead (using an empty string for the
1628 first parameter if you don't want any options).");
1630 ("sync", (RErr, [], []), 2, [],
1631 [ InitEmpty, Always, TestRun [["sync"]]],
1632 "sync disks, writes are flushed through to the disk image",
1634 This syncs the disk, so that any writes are flushed through to the
1635 underlying disk image.
1637 You should always call this if you have modified a disk image, before
1638 closing the handle.");
1640 ("touch", (RErr, [Pathname "path"], []), 3, [],
1641 [InitScratchFS, Always, TestOutputTrue (
1642 [["touch"; "/touch"];
1643 ["exists"; "/touch"]])],
1644 "update file timestamps or create a new file",
1646 Touch acts like the L<touch(1)> command. It can be used to
1647 update the timestamps on a file, or, if the file does not exist,
1648 to create a new zero-length file.
1650 This command only works on regular files, and will fail on other
1651 file types such as directories, symbolic links, block special etc.");
1653 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1654 [InitISOFS, Always, TestOutput (
1655 [["cat"; "/known-2"]], "abcdef\n")],
1656 "list the contents of a file",
1658 Return the contents of the file named C<path>.
1660 Note that this function cannot correctly handle binary files
1661 (specifically, files containing C<\\0> character which is treated
1662 as end of string). For those you need to use the C<guestfs_read_file>
1663 or C<guestfs_download> functions which have a more complex interface.");
1665 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1666 [], (* XXX Tricky to test because it depends on the exact format
1667 * of the 'ls -l' command, which changes between F10 and F11.
1669 "list the files in a directory (long format)",
1671 List the files in C<directory> (relative to the root directory,
1672 there is no cwd) in the format of 'ls -la'.
1674 This command is mostly useful for interactive sessions. It
1675 is I<not> intended that you try to parse the output string.");
1677 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1678 [InitScratchFS, Always, TestOutputList (
1680 ["touch"; "/ls/new"];
1681 ["touch"; "/ls/newer"];
1682 ["touch"; "/ls/newest"];
1683 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1684 "list the files in a directory",
1686 List the files in C<directory> (relative to the root directory,
1687 there is no cwd). The '.' and '..' entries are not returned, but
1688 hidden files are shown.
1690 This command is mostly useful for interactive sessions. Programs
1691 should probably use C<guestfs_readdir> instead.");
1693 ("list_devices", (RStringList "devices", [], []), 7, [],
1694 [InitEmpty, Always, TestOutputListOfDevices (
1695 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1696 "list the block devices",
1698 List all the block devices.
1700 The full block device names are returned, eg. C</dev/sda>.
1702 See also C<guestfs_list_filesystems>.");
1704 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1705 [InitBasicFS, Always, TestOutputListOfDevices (
1706 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1707 InitEmpty, Always, TestOutputListOfDevices (
1708 [["part_init"; "/dev/sda"; "mbr"];
1709 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1710 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1711 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1712 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1713 "list the partitions",
1715 List all the partitions detected on all block devices.
1717 The full partition device names are returned, eg. C</dev/sda1>
1719 This does not return logical volumes. For that you will need to
1720 call C<guestfs_lvs>.
1722 See also C<guestfs_list_filesystems>.");
1724 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1725 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1726 [["pvs"]], ["/dev/sda1"]);
1727 InitEmpty, Always, TestOutputListOfDevices (
1728 [["part_init"; "/dev/sda"; "mbr"];
1729 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1730 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1731 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1732 ["pvcreate"; "/dev/sda1"];
1733 ["pvcreate"; "/dev/sda2"];
1734 ["pvcreate"; "/dev/sda3"];
1735 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1736 "list the LVM physical volumes (PVs)",
1738 List all the physical volumes detected. This is the equivalent
1739 of the L<pvs(8)> command.
1741 This returns a list of just the device names that contain
1742 PVs (eg. C</dev/sda2>).
1744 See also C<guestfs_pvs_full>.");
1746 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1747 [InitBasicFSonLVM, Always, TestOutputList (
1749 InitEmpty, Always, TestOutputList (
1750 [["part_init"; "/dev/sda"; "mbr"];
1751 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1752 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1753 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1754 ["pvcreate"; "/dev/sda1"];
1755 ["pvcreate"; "/dev/sda2"];
1756 ["pvcreate"; "/dev/sda3"];
1757 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1758 ["vgcreate"; "VG2"; "/dev/sda3"];
1759 ["vgs"]], ["VG1"; "VG2"])],
1760 "list the LVM volume groups (VGs)",
1762 List all the volumes groups detected. This is the equivalent
1763 of the L<vgs(8)> command.
1765 This returns a list of just the volume group names that were
1766 detected (eg. C<VolGroup00>).
1768 See also C<guestfs_vgs_full>.");
1770 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1771 [InitBasicFSonLVM, Always, TestOutputList (
1772 [["lvs"]], ["/dev/VG/LV"]);
1773 InitEmpty, Always, TestOutputList (
1774 [["part_init"; "/dev/sda"; "mbr"];
1775 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1776 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1777 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1778 ["pvcreate"; "/dev/sda1"];
1779 ["pvcreate"; "/dev/sda2"];
1780 ["pvcreate"; "/dev/sda3"];
1781 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1782 ["vgcreate"; "VG2"; "/dev/sda3"];
1783 ["lvcreate"; "LV1"; "VG1"; "50"];
1784 ["lvcreate"; "LV2"; "VG1"; "50"];
1785 ["lvcreate"; "LV3"; "VG2"; "50"];
1786 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1787 "list the LVM logical volumes (LVs)",
1789 List all the logical volumes detected. This is the equivalent
1790 of the L<lvs(8)> command.
1792 This returns a list of the logical volume device names
1793 (eg. C</dev/VolGroup00/LogVol00>).
1795 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1797 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1798 [], (* XXX how to test? *)
1799 "list the LVM physical volumes (PVs)",
1801 List all the physical volumes detected. This is the equivalent
1802 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1804 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1805 [], (* XXX how to test? *)
1806 "list the LVM volume groups (VGs)",
1808 List all the volumes groups detected. This is the equivalent
1809 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1811 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1812 [], (* XXX how to test? *)
1813 "list the LVM logical volumes (LVs)",
1815 List all the logical volumes detected. This is the equivalent
1816 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1818 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1819 [InitISOFS, Always, TestOutputList (
1820 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1821 InitISOFS, Always, TestOutputList (
1822 [["read_lines"; "/empty"]], [])],
1823 "read file as lines",
1825 Return the contents of the file named C<path>.
1827 The file contents are returned as a list of lines. Trailing
1828 C<LF> and C<CRLF> character sequences are I<not> returned.
1830 Note that this function cannot correctly handle binary files
1831 (specifically, files containing C<\\0> character which is treated
1832 as end of line). For those you need to use the C<guestfs_read_file>
1833 function which has a more complex interface.");
1835 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1836 [], (* XXX Augeas code needs tests. *)
1837 "create a new Augeas handle",
1839 Create a new Augeas handle for editing configuration files.
1840 If there was any previous Augeas handle associated with this
1841 guestfs session, then it is closed.
1843 You must call this before using any other C<guestfs_aug_*>
1846 C<root> is the filesystem root. C<root> must not be NULL,
1849 The flags are the same as the flags defined in
1850 E<lt>augeas.hE<gt>, the logical I<or> of the following
1855 =item C<AUG_SAVE_BACKUP> = 1
1857 Keep the original file with a C<.augsave> extension.
1859 =item C<AUG_SAVE_NEWFILE> = 2
1861 Save changes into a file with extension C<.augnew>, and
1862 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1864 =item C<AUG_TYPE_CHECK> = 4
1868 This option is only useful when debugging Augeas lenses. Use
1869 of this option may require additional memory for the libguestfs
1870 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1871 environment variable or call C<guestfs_set_memsize>.
1873 =item C<AUG_NO_STDINC> = 8
1875 Do not use standard load path for modules.
1877 =item C<AUG_SAVE_NOOP> = 16
1879 Make save a no-op, just record what would have been changed.
1881 =item C<AUG_NO_LOAD> = 32
1883 Do not load the tree in C<guestfs_aug_init>.
1887 To close the handle, you can call C<guestfs_aug_close>.
1889 To find out more about Augeas, see L<http://augeas.net/>.");
1891 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1892 [], (* XXX Augeas code needs tests. *)
1893 "close the current Augeas handle",
1895 Close the current Augeas handle and free up any resources
1896 used by it. After calling this, you have to call
1897 C<guestfs_aug_init> again before you can use any other
1898 Augeas functions.");
1900 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1901 [], (* XXX Augeas code needs tests. *)
1902 "define an Augeas variable",
1904 Defines an Augeas variable C<name> whose value is the result
1905 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1908 On success this returns the number of nodes in C<expr>, or
1909 C<0> if C<expr> evaluates to something which is not a nodeset.");
1911 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1912 [], (* XXX Augeas code needs tests. *)
1913 "define an Augeas node",
1915 Defines a variable C<name> whose value is the result of
1918 If C<expr> evaluates to an empty nodeset, a node is created,
1919 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1920 C<name> will be the nodeset containing that single node.
1922 On success this returns a pair containing the
1923 number of nodes in the nodeset, and a boolean flag
1924 if a node was created.");
1926 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1927 [], (* XXX Augeas code needs tests. *)
1928 "look up the value of an Augeas path",
1930 Look up the value associated with C<path>. If C<path>
1931 matches exactly one node, the C<value> is returned.");
1933 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1934 [], (* XXX Augeas code needs tests. *)
1935 "set Augeas path to value",
1937 Set the value associated with C<path> to C<val>.
1939 In the Augeas API, it is possible to clear a node by setting
1940 the value to NULL. Due to an oversight in the libguestfs API
1941 you cannot do that with this call. Instead you must use the
1942 C<guestfs_aug_clear> call.");
1944 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1945 [], (* XXX Augeas code needs tests. *)
1946 "insert a sibling Augeas node",
1948 Create a new sibling C<label> for C<path>, inserting it into
1949 the tree before or after C<path> (depending on the boolean
1952 C<path> must match exactly one existing node in the tree, and
1953 C<label> must be a label, ie. not contain C</>, C<*> or end
1954 with a bracketed index C<[N]>.");
1956 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1957 [], (* XXX Augeas code needs tests. *)
1958 "remove an Augeas path",
1960 Remove C<path> and all of its children.
1962 On success this returns the number of entries which were removed.");
1964 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1965 [], (* XXX Augeas code needs tests. *)
1968 Move the node C<src> to C<dest>. C<src> must match exactly
1969 one node. C<dest> is overwritten if it exists.");
1971 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1972 [], (* XXX Augeas code needs tests. *)
1973 "return Augeas nodes which match augpath",
1975 Returns a list of paths which match the path expression C<path>.
1976 The returned paths are sufficiently qualified so that they match
1977 exactly one node in the current tree.");
1979 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1980 [], (* XXX Augeas code needs tests. *)
1981 "write all pending Augeas changes to disk",
1983 This writes all pending changes to disk.
1985 The flags which were passed to C<guestfs_aug_init> affect exactly
1986 how files are saved.");
1988 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1989 [], (* XXX Augeas code needs tests. *)
1990 "load files into the tree",
1992 Load files into the tree.
1994 See C<aug_load> in the Augeas documentation for the full gory
1997 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1998 [], (* XXX Augeas code needs tests. *)
1999 "list Augeas nodes under augpath",
2001 This is just a shortcut for listing C<guestfs_aug_match>
2002 C<path/*> and sorting the resulting nodes into alphabetical order.");
2004 ("rm", (RErr, [Pathname "path"], []), 29, [],
2005 [InitScratchFS, Always, TestRun
2007 ["touch"; "/rm/new"];
2009 InitScratchFS, Always, TestLastFail
2010 [["rm"; "/nosuchfile"]];
2011 InitScratchFS, Always, TestLastFail
2016 Remove the single file C<path>.");
2018 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
2019 [InitScratchFS, Always, TestRun
2020 [["mkdir"; "/rmdir"];
2021 ["rmdir"; "/rmdir"]];
2022 InitScratchFS, Always, TestLastFail
2023 [["rmdir"; "/rmdir2"]];
2024 InitScratchFS, Always, TestLastFail
2025 [["mkdir"; "/rmdir3"];
2026 ["touch"; "/rmdir3/new"];
2027 ["rmdir"; "/rmdir3/new"]]],
2028 "remove a directory",
2030 Remove the single directory C<path>.");
2032 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
2033 [InitScratchFS, Always, TestOutputFalse
2034 [["mkdir"; "/rm_rf"];
2035 ["mkdir"; "/rm_rf/foo"];
2036 ["touch"; "/rm_rf/foo/bar"];
2037 ["rm_rf"; "/rm_rf"];
2038 ["exists"; "/rm_rf"]]],
2039 "remove a file or directory recursively",
2041 Remove the file or directory C<path>, recursively removing the
2042 contents if its a directory. This is like the C<rm -rf> shell
2045 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2046 [InitScratchFS, Always, TestOutputTrue
2047 [["mkdir"; "/mkdir"];
2048 ["is_dir"; "/mkdir"]];
2049 InitScratchFS, Always, TestLastFail
2050 [["mkdir"; "/mkdir2/foo/bar"]]],
2051 "create a directory",
2053 Create a directory named C<path>.");
2055 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2056 [InitScratchFS, Always, TestOutputTrue
2057 [["mkdir_p"; "/mkdir_p/foo/bar"];
2058 ["is_dir"; "/mkdir_p/foo/bar"]];
2059 InitScratchFS, Always, TestOutputTrue
2060 [["mkdir_p"; "/mkdir_p2/foo/bar"];
2061 ["is_dir"; "/mkdir_p2/foo"]];
2062 InitScratchFS, Always, TestOutputTrue
2063 [["mkdir_p"; "/mkdir_p3/foo/bar"];
2064 ["is_dir"; "/mkdir_p3"]];
2065 (* Regression tests for RHBZ#503133: *)
2066 InitScratchFS, Always, TestRun
2067 [["mkdir"; "/mkdir_p4"];
2068 ["mkdir_p"; "/mkdir_p4"]];
2069 InitScratchFS, Always, TestLastFail
2070 [["touch"; "/mkdir_p5"];
2071 ["mkdir_p"; "/mkdir_p5"]]],
2072 "create a directory and parents",
2074 Create a directory named C<path>, creating any parent directories
2075 as necessary. This is like the C<mkdir -p> shell command.");
2077 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2078 [], (* XXX Need stat command to test *)
2081 Change the mode (permissions) of C<path> to C<mode>. Only
2082 numeric modes are supported.
2084 I<Note>: When using this command from guestfish, C<mode>
2085 by default would be decimal, unless you prefix it with
2086 C<0> to get octal, ie. use C<0700> not C<700>.
2088 The mode actually set is affected by the umask.");
2090 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2091 [], (* XXX Need stat command to test *)
2092 "change file owner and group",
2094 Change the file owner to C<owner> and group to C<group>.
2096 Only numeric uid and gid are supported. If you want to use
2097 names, you will need to locate and parse the password file
2098 yourself (Augeas support makes this relatively easy).");
2100 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2101 [InitISOFS, Always, TestOutputTrue (
2102 [["exists"; "/empty"]]);
2103 InitISOFS, Always, TestOutputTrue (
2104 [["exists"; "/directory"]])],
2105 "test if file or directory exists",
2107 This returns C<true> if and only if there is a file, directory
2108 (or anything) with the given C<path> name.
2110 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2112 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2113 [InitISOFS, Always, TestOutputTrue (
2114 [["is_file"; "/known-1"]]);
2115 InitISOFS, Always, TestOutputFalse (
2116 [["is_file"; "/directory"]])],
2117 "test if a regular file",
2119 This returns C<true> if and only if there is a regular file
2120 with the given C<path> name. Note that it returns false for
2121 other objects like directories.
2123 See also C<guestfs_stat>.");
2125 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2126 [InitISOFS, Always, TestOutputFalse (
2127 [["is_dir"; "/known-3"]]);
2128 InitISOFS, Always, TestOutputTrue (
2129 [["is_dir"; "/directory"]])],
2130 "test if a directory",
2132 This returns C<true> if and only if there is a directory
2133 with the given C<path> name. Note that it returns false for
2134 other objects like files.
2136 See also C<guestfs_stat>.");
2138 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2139 [InitEmpty, Always, TestOutputListOfDevices (
2140 [["part_init"; "/dev/sda"; "mbr"];
2141 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2142 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2143 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2144 ["pvcreate"; "/dev/sda1"];
2145 ["pvcreate"; "/dev/sda2"];
2146 ["pvcreate"; "/dev/sda3"];
2147 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2148 "create an LVM physical volume",
2150 This creates an LVM physical volume on the named C<device>,
2151 where C<device> should usually be a partition name such
2154 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [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 ["vgs"]], ["VG1"; "VG2"])],
2166 "create an LVM volume group",
2168 This creates an LVM volume group called C<volgroup>
2169 from the non-empty list of physical volumes C<physvols>.");
2171 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2172 [InitEmpty, Always, TestOutputList (
2173 [["part_init"; "/dev/sda"; "mbr"];
2174 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2175 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2176 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2177 ["pvcreate"; "/dev/sda1"];
2178 ["pvcreate"; "/dev/sda2"];
2179 ["pvcreate"; "/dev/sda3"];
2180 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2181 ["vgcreate"; "VG2"; "/dev/sda3"];
2182 ["lvcreate"; "LV1"; "VG1"; "50"];
2183 ["lvcreate"; "LV2"; "VG1"; "50"];
2184 ["lvcreate"; "LV3"; "VG2"; "50"];
2185 ["lvcreate"; "LV4"; "VG2"; "50"];
2186 ["lvcreate"; "LV5"; "VG2"; "50"];
2188 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2189 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2190 "create an LVM logical volume",
2192 This creates an LVM logical volume called C<logvol>
2193 on the volume group C<volgroup>, with C<size> megabytes.");
2195 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2196 [InitEmpty, Always, TestOutput (
2197 [["part_disk"; "/dev/sda"; "mbr"];
2198 ["mkfs"; "ext2"; "/dev/sda1"];
2199 ["mount_options"; ""; "/dev/sda1"; "/"];
2200 ["write"; "/new"; "new file contents"];
2201 ["cat"; "/new"]], "new file contents")],
2202 "make a filesystem",
2204 This creates a filesystem on C<device> (usually a partition
2205 or LVM logical volume). The filesystem type is C<fstype>, for
2208 ("sfdisk", (RErr, [Device "device";
2209 Int "cyls"; Int "heads"; Int "sectors";
2210 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2212 "create partitions on a block device",
2214 This is a direct interface to the L<sfdisk(8)> program for creating
2215 partitions on block devices.
2217 C<device> should be a block device, for example C</dev/sda>.
2219 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2220 and sectors on the device, which are passed directly to sfdisk as
2221 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2222 of these, then the corresponding parameter is omitted. Usually for
2223 'large' disks, you can just pass C<0> for these, but for small
2224 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2225 out the right geometry and you will need to tell it.
2227 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2228 information refer to the L<sfdisk(8)> manpage.
2230 To create a single partition occupying the whole disk, you would
2231 pass C<lines> as a single element list, when the single element being
2232 the string C<,> (comma).
2234 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2235 C<guestfs_part_init>");
2237 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2238 (* Regression test for RHBZ#597135. *)
2239 [InitScratchFS, Always, TestLastFail
2240 [["write_file"; "/write_file"; "abc"; "10000"]]],
2243 This call creates a file called C<path>. The contents of the
2244 file is the string C<content> (which can contain any 8 bit data),
2245 with length C<size>.
2247 As a special case, if C<size> is C<0>
2248 then the length is calculated using C<strlen> (so in this case
2249 the content cannot contain embedded ASCII NULs).
2251 I<NB.> Owing to a bug, writing content containing ASCII NUL
2252 characters does I<not> work, even if the length is specified.");
2254 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2255 [InitEmpty, Always, TestOutputListOfDevices (
2256 [["part_disk"; "/dev/sda"; "mbr"];
2257 ["mkfs"; "ext2"; "/dev/sda1"];
2258 ["mount_options"; ""; "/dev/sda1"; "/"];
2259 ["mounts"]], ["/dev/sda1"]);
2260 InitEmpty, Always, TestOutputList (
2261 [["part_disk"; "/dev/sda"; "mbr"];
2262 ["mkfs"; "ext2"; "/dev/sda1"];
2263 ["mount_options"; ""; "/dev/sda1"; "/"];
2266 "unmount a filesystem",
2268 This unmounts the given filesystem. The filesystem may be
2269 specified either by its mountpoint (path) or the device which
2270 contains the filesystem.");
2272 ("mounts", (RStringList "devices", [], []), 46, [],
2273 [InitScratchFS, Always, TestOutputListOfDevices (
2274 [["mounts"]], ["/dev/sdb1"])],
2275 "show mounted filesystems",
2277 This returns the list of currently mounted filesystems. It returns
2278 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2280 Some internal mounts are not shown.
2282 See also: C<guestfs_mountpoints>");
2284 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2285 [InitScratchFS, Always, TestOutputList (
2288 (* check that umount_all can unmount nested mounts correctly: *)
2289 InitEmpty, Always, TestOutputList (
2290 [["part_init"; "/dev/sda"; "mbr"];
2291 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2292 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2293 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2294 ["mkfs"; "ext2"; "/dev/sda1"];
2295 ["mkfs"; "ext2"; "/dev/sda2"];
2296 ["mkfs"; "ext2"; "/dev/sda3"];
2297 ["mount_options"; ""; "/dev/sda1"; "/"];
2299 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2300 ["mkdir"; "/mp1/mp2"];
2301 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2302 ["mkdir"; "/mp1/mp2/mp3"];
2305 "unmount all filesystems",
2307 This unmounts all mounted filesystems.
2309 Some internal mounts are not unmounted by this call.");
2311 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2313 "remove all LVM LVs, VGs and PVs",
2315 This command removes all LVM logical volumes, volume groups
2316 and physical volumes.");
2318 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2319 [InitISOFS, Always, TestOutput (
2320 [["file"; "/empty"]], "empty");
2321 InitISOFS, Always, TestOutput (
2322 [["file"; "/known-1"]], "ASCII text");
2323 InitISOFS, Always, TestLastFail (
2324 [["file"; "/notexists"]]);
2325 InitISOFS, Always, TestOutput (
2326 [["file"; "/abssymlink"]], "symbolic link");
2327 InitISOFS, Always, TestOutput (
2328 [["file"; "/directory"]], "directory")],
2329 "determine file type",
2331 This call uses the standard L<file(1)> command to determine
2332 the type or contents of the file.
2334 This call will also transparently look inside various types
2337 The exact command which runs is C<file -zb path>. Note in
2338 particular that the filename is not prepended to the output
2341 The output depends on the output of the underlying L<file(1)>
2342 command and it can change in future in ways beyond our control.
2343 In other words, the output is not guaranteed by the ABI.
2345 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2346 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2348 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2349 [InitScratchFS, Always, TestOutput (
2350 [["mkdir"; "/command"];
2351 ["upload"; "test-command"; "/command/test-command"];
2352 ["chmod"; "0o755"; "/command/test-command"];
2353 ["command"; "/command/test-command 1"]], "Result1");
2354 InitScratchFS, Always, TestOutput (
2355 [["mkdir"; "/command2"];
2356 ["upload"; "test-command"; "/command2/test-command"];
2357 ["chmod"; "0o755"; "/command2/test-command"];
2358 ["command"; "/command2/test-command 2"]], "Result2\n");
2359 InitScratchFS, Always, TestOutput (
2360 [["mkdir"; "/command3"];
2361 ["upload"; "test-command"; "/command3/test-command"];
2362 ["chmod"; "0o755"; "/command3/test-command"];
2363 ["command"; "/command3/test-command 3"]], "\nResult3");
2364 InitScratchFS, Always, TestOutput (
2365 [["mkdir"; "/command4"];
2366 ["upload"; "test-command"; "/command4/test-command"];
2367 ["chmod"; "0o755"; "/command4/test-command"];
2368 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2369 InitScratchFS, Always, TestOutput (
2370 [["mkdir"; "/command5"];
2371 ["upload"; "test-command"; "/command5/test-command"];
2372 ["chmod"; "0o755"; "/command5/test-command"];
2373 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2374 InitScratchFS, Always, TestOutput (
2375 [["mkdir"; "/command6"];
2376 ["upload"; "test-command"; "/command6/test-command"];
2377 ["chmod"; "0o755"; "/command6/test-command"];
2378 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2379 InitScratchFS, Always, TestOutput (
2380 [["mkdir"; "/command7"];
2381 ["upload"; "test-command"; "/command7/test-command"];
2382 ["chmod"; "0o755"; "/command7/test-command"];
2383 ["command"; "/command7/test-command 7"]], "");
2384 InitScratchFS, Always, TestOutput (
2385 [["mkdir"; "/command8"];
2386 ["upload"; "test-command"; "/command8/test-command"];
2387 ["chmod"; "0o755"; "/command8/test-command"];
2388 ["command"; "/command8/test-command 8"]], "\n");
2389 InitScratchFS, Always, TestOutput (
2390 [["mkdir"; "/command9"];
2391 ["upload"; "test-command"; "/command9/test-command"];
2392 ["chmod"; "0o755"; "/command9/test-command"];
2393 ["command"; "/command9/test-command 9"]], "\n\n");
2394 InitScratchFS, Always, TestOutput (
2395 [["mkdir"; "/command10"];
2396 ["upload"; "test-command"; "/command10/test-command"];
2397 ["chmod"; "0o755"; "/command10/test-command"];
2398 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2399 InitScratchFS, Always, TestOutput (
2400 [["mkdir"; "/command11"];
2401 ["upload"; "test-command"; "/command11/test-command"];
2402 ["chmod"; "0o755"; "/command11/test-command"];
2403 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2404 InitScratchFS, Always, TestLastFail (
2405 [["mkdir"; "/command12"];
2406 ["upload"; "test-command"; "/command12/test-command"];
2407 ["chmod"; "0o755"; "/command12/test-command"];
2408 ["command"; "/command12/test-command"]])],
2409 "run a command from the guest filesystem",
2411 This call runs a command from the guest filesystem. The
2412 filesystem must be mounted, and must contain a compatible
2413 operating system (ie. something Linux, with the same
2414 or compatible processor architecture).
2416 The single parameter is an argv-style list of arguments.
2417 The first element is the name of the program to run.
2418 Subsequent elements are parameters. The list must be
2419 non-empty (ie. must contain a program name). Note that
2420 the command runs directly, and is I<not> invoked via
2421 the shell (see C<guestfs_sh>).
2423 The return value is anything printed to I<stdout> by
2426 If the command returns a non-zero exit status, then
2427 this function returns an error message. The error message
2428 string is the content of I<stderr> from the command.
2430 The C<$PATH> environment variable will contain at least
2431 C</usr/bin> and C</bin>. If you require a program from
2432 another location, you should provide the full path in the
2435 Shared libraries and data files required by the program
2436 must be available on filesystems which are mounted in the
2437 correct places. It is the caller's responsibility to ensure
2438 all filesystems that are needed are mounted at the right
2441 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2442 [InitScratchFS, Always, TestOutputList (
2443 [["mkdir"; "/command_lines"];
2444 ["upload"; "test-command"; "/command_lines/test-command"];
2445 ["chmod"; "0o755"; "/command_lines/test-command"];
2446 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2447 InitScratchFS, Always, TestOutputList (
2448 [["mkdir"; "/command_lines2"];
2449 ["upload"; "test-command"; "/command_lines2/test-command"];
2450 ["chmod"; "0o755"; "/command_lines2/test-command"];
2451 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2452 InitScratchFS, Always, TestOutputList (
2453 [["mkdir"; "/command_lines3"];
2454 ["upload"; "test-command"; "/command_lines3/test-command"];
2455 ["chmod"; "0o755"; "/command_lines3/test-command"];
2456 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2457 InitScratchFS, Always, TestOutputList (
2458 [["mkdir"; "/command_lines4"];
2459 ["upload"; "test-command"; "/command_lines4/test-command"];
2460 ["chmod"; "0o755"; "/command_lines4/test-command"];
2461 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2462 InitScratchFS, Always, TestOutputList (
2463 [["mkdir"; "/command_lines5"];
2464 ["upload"; "test-command"; "/command_lines5/test-command"];
2465 ["chmod"; "0o755"; "/command_lines5/test-command"];
2466 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2467 InitScratchFS, Always, TestOutputList (
2468 [["mkdir"; "/command_lines6"];
2469 ["upload"; "test-command"; "/command_lines6/test-command"];
2470 ["chmod"; "0o755"; "/command_lines6/test-command"];
2471 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2472 InitScratchFS, Always, TestOutputList (
2473 [["mkdir"; "/command_lines7"];
2474 ["upload"; "test-command"; "/command_lines7/test-command"];
2475 ["chmod"; "0o755"; "/command_lines7/test-command"];
2476 ["command_lines"; "/command_lines7/test-command 7"]], []);
2477 InitScratchFS, Always, TestOutputList (
2478 [["mkdir"; "/command_lines8"];
2479 ["upload"; "test-command"; "/command_lines8/test-command"];
2480 ["chmod"; "0o755"; "/command_lines8/test-command"];
2481 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2482 InitScratchFS, Always, TestOutputList (
2483 [["mkdir"; "/command_lines9"];
2484 ["upload"; "test-command"; "/command_lines9/test-command"];
2485 ["chmod"; "0o755"; "/command_lines9/test-command"];
2486 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2487 InitScratchFS, Always, TestOutputList (
2488 [["mkdir"; "/command_lines10"];
2489 ["upload"; "test-command"; "/command_lines10/test-command"];
2490 ["chmod"; "0o755"; "/command_lines10/test-command"];
2491 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2492 InitScratchFS, Always, TestOutputList (
2493 [["mkdir"; "/command_lines11"];
2494 ["upload"; "test-command"; "/command_lines11/test-command"];
2495 ["chmod"; "0o755"; "/command_lines11/test-command"];
2496 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2497 "run a command, returning lines",
2499 This is the same as C<guestfs_command>, but splits the
2500 result into a list of lines.
2502 See also: C<guestfs_sh_lines>");
2504 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2505 [InitISOFS, Always, TestOutputStruct (
2506 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2507 "get file information",
2509 Returns file information for the given C<path>.
2511 This is the same as the C<stat(2)> system call.");
2513 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2514 [InitISOFS, Always, TestOutputStruct (
2515 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2516 "get file information for a symbolic link",
2518 Returns file information for the given C<path>.
2520 This is the same as C<guestfs_stat> except that if C<path>
2521 is a symbolic link, then the link is stat-ed, not the file it
2524 This is the same as the C<lstat(2)> system call.");
2526 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2527 [InitISOFS, Always, TestOutputStruct (
2528 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2529 "get file system statistics",
2531 Returns file system statistics for any mounted file system.
2532 C<path> should be a file or directory in the mounted file system
2533 (typically it is the mount point itself, but it doesn't need to be).
2535 This is the same as the C<statvfs(2)> system call.");
2537 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2539 "get ext2/ext3/ext4 superblock details",
2541 This returns the contents of the ext2, ext3 or ext4 filesystem
2542 superblock on C<device>.
2544 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2545 manpage for more details. The list of fields returned isn't
2546 clearly defined, and depends on both the version of C<tune2fs>
2547 that libguestfs was built against, and the filesystem itself.");
2549 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2550 [InitEmpty, Always, TestOutputTrue (
2551 [["blockdev_setro"; "/dev/sda"];
2552 ["blockdev_getro"; "/dev/sda"]])],
2553 "set block device to read-only",
2555 Sets the block device named C<device> to read-only.
2557 This uses the L<blockdev(8)> command.");
2559 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2560 [InitEmpty, Always, TestOutputFalse (
2561 [["blockdev_setrw"; "/dev/sda"];
2562 ["blockdev_getro"; "/dev/sda"]])],
2563 "set block device to read-write",
2565 Sets the block device named C<device> to read-write.
2567 This uses the L<blockdev(8)> command.");
2569 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2570 [InitEmpty, Always, TestOutputTrue (
2571 [["blockdev_setro"; "/dev/sda"];
2572 ["blockdev_getro"; "/dev/sda"]])],
2573 "is block device set to read-only",
2575 Returns a boolean indicating if the block device is read-only
2576 (true if read-only, false if not).
2578 This uses the L<blockdev(8)> command.");
2580 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2581 [InitEmpty, Always, TestOutputInt (
2582 [["blockdev_getss"; "/dev/sda"]], 512)],
2583 "get sectorsize of block device",
2585 This returns the size of sectors on a block device.
2586 Usually 512, but can be larger for modern devices.
2588 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2591 This uses the L<blockdev(8)> command.");
2593 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2594 [InitEmpty, Always, TestOutputInt (
2595 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2596 "get blocksize of block device",
2598 This returns the block size of a device.
2600 (Note this is different from both I<size in blocks> and
2601 I<filesystem block size>).
2603 This uses the L<blockdev(8)> command.");
2605 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2607 "set blocksize of block device",
2609 This sets the block size of a device.
2611 (Note this is different from both I<size in blocks> and
2612 I<filesystem block size>).
2614 This uses the L<blockdev(8)> command.");
2616 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2617 [InitEmpty, Always, TestOutputInt (
2618 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2619 "get total size of device in 512-byte sectors",
2621 This returns the size of the device in units of 512-byte sectors
2622 (even if the sectorsize isn't 512 bytes ... weird).
2624 See also C<guestfs_blockdev_getss> for the real sector size of
2625 the device, and C<guestfs_blockdev_getsize64> for the more
2626 useful I<size in bytes>.
2628 This uses the L<blockdev(8)> command.");
2630 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2631 [InitEmpty, Always, TestOutputInt (
2632 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2633 "get total size of device in bytes",
2635 This returns the size of the device in bytes.
2637 See also C<guestfs_blockdev_getsz>.
2639 This uses the L<blockdev(8)> command.");
2641 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2642 [InitEmpty, Always, TestRun
2643 [["blockdev_flushbufs"; "/dev/sda"]]],
2644 "flush device buffers",
2646 This tells the kernel to flush internal buffers associated
2649 This uses the L<blockdev(8)> command.");
2651 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2652 [InitEmpty, Always, TestRun
2653 [["blockdev_rereadpt"; "/dev/sda"]]],
2654 "reread partition table",
2656 Reread the partition table on C<device>.
2658 This uses the L<blockdev(8)> command.");
2660 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2661 [InitScratchFS, Always, TestOutput (
2662 (* Pick a file from cwd which isn't likely to change. *)
2663 [["mkdir"; "/upload"];
2664 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2665 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2666 Digest.to_hex (Digest.file "COPYING.LIB"))],
2667 "upload a file from the local machine",
2669 Upload local file C<filename> to C<remotefilename> on the
2672 C<filename> can also be a named pipe.
2674 See also C<guestfs_download>.");
2676 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2677 [InitScratchFS, Always, TestOutput (
2678 (* Pick a file from cwd which isn't likely to change. *)
2679 [["mkdir"; "/download"];
2680 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2681 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2682 ["upload"; "testdownload.tmp"; "/download/upload"];
2683 ["checksum"; "md5"; "/download/upload"]],
2684 Digest.to_hex (Digest.file "COPYING.LIB"))],
2685 "download a file to the local machine",
2687 Download file C<remotefilename> and save it as C<filename>
2688 on the local machine.
2690 C<filename> can also be a named pipe.
2692 See also C<guestfs_upload>, C<guestfs_cat>.");
2694 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2695 [InitISOFS, Always, TestOutput (
2696 [["checksum"; "crc"; "/known-3"]], "2891671662");
2697 InitISOFS, Always, TestLastFail (
2698 [["checksum"; "crc"; "/notexists"]]);
2699 InitISOFS, Always, TestOutput (
2700 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2701 InitISOFS, Always, TestOutput (
2702 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2703 InitISOFS, Always, TestOutput (
2704 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2705 InitISOFS, Always, TestOutput (
2706 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2707 InitISOFS, Always, TestOutput (
2708 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2709 InitISOFS, Always, TestOutput (
2710 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2711 (* Test for RHBZ#579608, absolute symbolic links. *)
2712 InitISOFS, Always, TestOutput (
2713 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2714 "compute MD5, SHAx or CRC checksum of file",
2716 This call computes the MD5, SHAx or CRC checksum of the
2719 The type of checksum to compute is given by the C<csumtype>
2720 parameter which must have one of the following values:
2726 Compute the cyclic redundancy check (CRC) specified by POSIX
2727 for the C<cksum> command.
2731 Compute the MD5 hash (using the C<md5sum> program).
2735 Compute the SHA1 hash (using the C<sha1sum> program).
2739 Compute the SHA224 hash (using the C<sha224sum> program).
2743 Compute the SHA256 hash (using the C<sha256sum> program).
2747 Compute the SHA384 hash (using the C<sha384sum> program).
2751 Compute the SHA512 hash (using the C<sha512sum> program).
2755 The checksum is returned as a printable string.
2757 To get the checksum for a device, use C<guestfs_checksum_device>.
2759 To get the checksums for many files, use C<guestfs_checksums_out>.");
2761 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2762 [InitScratchFS, Always, TestOutput (
2763 [["mkdir"; "/tar_in"];
2764 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2765 ["cat"; "/tar_in/hello"]], "hello\n")],
2766 "unpack tarfile to directory",
2768 This command uploads and unpacks local file C<tarfile> (an
2769 I<uncompressed> tar file) into C<directory>.
2771 To upload a compressed tarball, use C<guestfs_tgz_in>
2772 or C<guestfs_txz_in>.");
2774 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2776 "pack directory into tarfile",
2778 This command packs the contents of C<directory> and downloads
2779 it to local file C<tarfile>.
2781 To download a compressed tarball, use C<guestfs_tgz_out>
2782 or C<guestfs_txz_out>.");
2784 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2785 [InitScratchFS, Always, TestOutput (
2786 [["mkdir"; "/tgz_in"];
2787 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2788 ["cat"; "/tgz_in/hello"]], "hello\n")],
2789 "unpack compressed tarball to directory",
2791 This command uploads and unpacks local file C<tarball> (a
2792 I<gzip compressed> tar file) into C<directory>.
2794 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2796 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2798 "pack directory into compressed tarball",
2800 This command packs the contents of C<directory> and downloads
2801 it to local file C<tarball>.
2803 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2805 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2806 [InitBasicFS, Always, TestLastFail (
2808 ["mount_ro"; "/dev/sda1"; "/"];
2809 ["touch"; "/new"]]);
2810 InitBasicFS, Always, TestOutput (
2811 [["write"; "/new"; "data"];
2813 ["mount_ro"; "/dev/sda1"; "/"];
2814 ["cat"; "/new"]], "data")],
2815 "mount a guest disk, read-only",
2817 This is the same as the C<guestfs_mount> command, but it
2818 mounts the filesystem with the read-only (I<-o ro>) flag.");
2820 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2822 "mount a guest disk with mount options",
2824 This is the same as the C<guestfs_mount> command, but it
2825 allows you to set the mount options as for the
2826 L<mount(8)> I<-o> flag.
2828 If the C<options> parameter is an empty string, then
2829 no options are passed (all options default to whatever
2830 the filesystem uses).");
2832 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2834 "mount a guest disk with mount options and vfstype",
2836 This is the same as the C<guestfs_mount> command, but it
2837 allows you to set both the mount options and the vfstype
2838 as for the L<mount(8)> I<-o> and I<-t> flags.");
2840 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2842 "debugging and internals",
2844 The C<guestfs_debug> command exposes some internals of
2845 C<guestfsd> (the guestfs daemon) that runs inside the
2848 There is no comprehensive help for this command. You have
2849 to look at the file C<daemon/debug.c> in the libguestfs source
2850 to find out what you can do.");
2852 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2853 [InitEmpty, Always, TestOutputList (
2854 [["part_disk"; "/dev/sda"; "mbr"];
2855 ["pvcreate"; "/dev/sda1"];
2856 ["vgcreate"; "VG"; "/dev/sda1"];
2857 ["lvcreate"; "LV1"; "VG"; "50"];
2858 ["lvcreate"; "LV2"; "VG"; "50"];
2859 ["lvremove"; "/dev/VG/LV1"];
2860 ["lvs"]], ["/dev/VG/LV2"]);
2861 InitEmpty, Always, TestOutputList (
2862 [["part_disk"; "/dev/sda"; "mbr"];
2863 ["pvcreate"; "/dev/sda1"];
2864 ["vgcreate"; "VG"; "/dev/sda1"];
2865 ["lvcreate"; "LV1"; "VG"; "50"];
2866 ["lvcreate"; "LV2"; "VG"; "50"];
2867 ["lvremove"; "/dev/VG"];
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"];
2875 ["lvremove"; "/dev/VG"];
2877 "remove an LVM logical volume",
2879 Remove an LVM logical volume C<device>, where C<device> is
2880 the path to the LV, such as C</dev/VG/LV>.
2882 You can also remove all LVs in a volume group by specifying
2883 the VG name, C</dev/VG>.");
2885 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2886 [InitEmpty, Always, TestOutputList (
2887 [["part_disk"; "/dev/sda"; "mbr"];
2888 ["pvcreate"; "/dev/sda1"];
2889 ["vgcreate"; "VG"; "/dev/sda1"];
2890 ["lvcreate"; "LV1"; "VG"; "50"];
2891 ["lvcreate"; "LV2"; "VG"; "50"];
2894 InitEmpty, Always, TestOutputList (
2895 [["part_disk"; "/dev/sda"; "mbr"];
2896 ["pvcreate"; "/dev/sda1"];
2897 ["vgcreate"; "VG"; "/dev/sda1"];
2898 ["lvcreate"; "LV1"; "VG"; "50"];
2899 ["lvcreate"; "LV2"; "VG"; "50"];
2902 "remove an LVM volume group",
2904 Remove an LVM volume group C<vgname>, (for example C<VG>).
2906 This also forcibly removes all logical volumes in the volume
2909 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2910 [InitEmpty, Always, TestOutputListOfDevices (
2911 [["part_disk"; "/dev/sda"; "mbr"];
2912 ["pvcreate"; "/dev/sda1"];
2913 ["vgcreate"; "VG"; "/dev/sda1"];
2914 ["lvcreate"; "LV1"; "VG"; "50"];
2915 ["lvcreate"; "LV2"; "VG"; "50"];
2917 ["pvremove"; "/dev/sda1"];
2919 InitEmpty, Always, TestOutputListOfDevices (
2920 [["part_disk"; "/dev/sda"; "mbr"];
2921 ["pvcreate"; "/dev/sda1"];
2922 ["vgcreate"; "VG"; "/dev/sda1"];
2923 ["lvcreate"; "LV1"; "VG"; "50"];
2924 ["lvcreate"; "LV2"; "VG"; "50"];
2926 ["pvremove"; "/dev/sda1"];
2928 InitEmpty, Always, TestOutputListOfDevices (
2929 [["part_disk"; "/dev/sda"; "mbr"];
2930 ["pvcreate"; "/dev/sda1"];
2931 ["vgcreate"; "VG"; "/dev/sda1"];
2932 ["lvcreate"; "LV1"; "VG"; "50"];
2933 ["lvcreate"; "LV2"; "VG"; "50"];
2935 ["pvremove"; "/dev/sda1"];
2937 "remove an LVM physical volume",
2939 This wipes a physical volume C<device> so that LVM will no longer
2942 The implementation uses the C<pvremove> command which refuses to
2943 wipe physical volumes that contain any volume groups, so you have
2944 to remove those first.");
2946 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2947 [InitBasicFS, Always, TestOutput (
2948 [["set_e2label"; "/dev/sda1"; "testlabel"];
2949 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2950 "set the ext2/3/4 filesystem label",
2952 This sets the ext2/3/4 filesystem label of the filesystem on
2953 C<device> to C<label>. Filesystem labels are limited to
2956 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2957 to return the existing label on a filesystem.");
2959 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2961 "get the ext2/3/4 filesystem label",
2963 This returns the ext2/3/4 filesystem label of the filesystem on
2966 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2967 (let uuid = uuidgen () in
2968 [InitBasicFS, Always, TestOutput (
2969 [["set_e2uuid"; "/dev/sda1"; uuid];
2970 ["get_e2uuid"; "/dev/sda1"]], uuid);
2971 InitBasicFS, Always, TestOutput (
2972 [["set_e2uuid"; "/dev/sda1"; "clear"];
2973 ["get_e2uuid"; "/dev/sda1"]], "");
2974 (* We can't predict what UUIDs will be, so just check the commands run. *)
2975 InitBasicFS, Always, TestRun (
2976 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2977 InitBasicFS, Always, TestRun (
2978 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2979 "set the ext2/3/4 filesystem UUID",
2981 This sets the ext2/3/4 filesystem UUID of the filesystem on
2982 C<device> to C<uuid>. The format of the UUID and alternatives
2983 such as C<clear>, C<random> and C<time> are described in the
2984 L<tune2fs(8)> manpage.
2986 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2987 to return the existing UUID of a filesystem.");
2989 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2990 (* Regression test for RHBZ#597112. *)
2991 (let uuid = uuidgen () in
2992 [InitNone, Always, TestOutput (
2993 [["mke2journal"; "1024"; "/dev/sdc"];
2994 ["set_e2uuid"; "/dev/sdc"; uuid];
2995 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2996 "get the ext2/3/4 filesystem UUID",
2998 This returns the ext2/3/4 filesystem UUID of the filesystem on
3001 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
3002 [InitBasicFS, Always, TestOutputInt (
3003 [["umount"; "/dev/sda1"];
3004 ["fsck"; "ext2"; "/dev/sda1"]], 0);
3005 InitBasicFS, Always, TestOutputInt (
3006 [["umount"; "/dev/sda1"];
3007 ["zero"; "/dev/sda1"];
3008 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
3009 "run the filesystem checker",
3011 This runs the filesystem checker (fsck) on C<device> which
3012 should have filesystem type C<fstype>.
3014 The returned integer is the status. See L<fsck(8)> for the
3015 list of status codes from C<fsck>.
3023 Multiple status codes can be summed together.
3027 A non-zero return code can mean \"success\", for example if
3028 errors have been corrected on the filesystem.
3032 Checking or repairing NTFS volumes is not supported
3037 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3039 ("zero", (RErr, [Device "device"], []), 85, [Progress],
3040 [InitBasicFS, Always, TestRun (
3041 [["umount"; "/dev/sda1"];
3042 ["zero"; "/dev/sda1"]])],
3043 "write zeroes to the device",
3045 This command writes zeroes over the first few blocks of C<device>.
3047 How many blocks are zeroed isn't specified (but it's I<not> enough
3048 to securely wipe the device). It should be sufficient to remove
3049 any partition tables, filesystem superblocks and so on.
3051 If blocks are already zero, then this command avoids writing
3052 zeroes. This prevents the underlying device from becoming non-sparse
3053 or growing unnecessarily.
3055 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3056 C<guestfs_is_zero_device>");
3058 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3060 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3061 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3063 [InitBasicFS, Always, TestOutputTrue (
3064 [["mkdir_p"; "/boot/grub"];
3065 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3066 ["grub_install"; "/"; "/dev/vda"];
3067 ["is_dir"; "/boot"]])],
3070 This command installs GRUB 1 (the Grand Unified Bootloader) on
3071 C<device>, with the root directory being C<root>.
3079 There is currently no way in the API to install grub2, which
3080 is used by most modern Linux guests. It is possible to run
3081 the grub2 command from the guest, although see the
3082 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3086 This uses C<grub-install> from the host. Unfortunately grub is
3087 not always compatible with itself, so this only works in rather
3088 narrow circumstances. Careful testing with each guest version
3093 If grub-install reports the error
3094 \"No suitable drive was found in the generated device map.\"
3095 it may be that you need to create a C</boot/grub/device.map>
3096 file first that contains the mapping between grub device names
3097 and Linux device names. It is usually sufficient to create
3102 replacing C</dev/vda> with the name of the installation device.
3106 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3107 [InitScratchFS, Always, TestOutput (
3109 ["write"; "/cp/old"; "file content"];
3110 ["cp"; "/cp/old"; "/cp/new"];
3111 ["cat"; "/cp/new"]], "file content");
3112 InitScratchFS, Always, TestOutputTrue (
3114 ["write"; "/cp2/old"; "file content"];
3115 ["cp"; "/cp2/old"; "/cp2/new"];
3116 ["is_file"; "/cp2/old"]]);
3117 InitScratchFS, Always, TestOutput (
3119 ["write"; "/cp3/old"; "file content"];
3120 ["mkdir"; "/cp3/dir"];
3121 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3122 ["cat"; "/cp3/dir/new"]], "file content")],
3125 This copies a file from C<src> to C<dest> where C<dest> is
3126 either a destination filename or destination directory.");
3128 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3129 [InitScratchFS, Always, TestOutput (
3130 [["mkdir"; "/cp_a1"];
3131 ["mkdir"; "/cp_a2"];
3132 ["write"; "/cp_a1/file"; "file content"];
3133 ["cp_a"; "/cp_a1"; "/cp_a2"];
3134 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3135 "copy a file or directory recursively",
3137 This copies a file or directory from C<src> to C<dest>
3138 recursively using the C<cp -a> command.");
3140 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3141 [InitScratchFS, Always, TestOutput (
3143 ["write"; "/mv/old"; "file content"];
3144 ["mv"; "/mv/old"; "/mv/new"];
3145 ["cat"; "/mv/new"]], "file content");
3146 InitScratchFS, Always, TestOutputFalse (
3148 ["write"; "/mv2/old"; "file content"];
3149 ["mv"; "/mv2/old"; "/mv2/new"];
3150 ["is_file"; "/mv2/old"]])],
3153 This moves a file from C<src> to C<dest> where C<dest> is
3154 either a destination filename or destination directory.");
3156 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3157 [InitEmpty, Always, TestRun (
3158 [["drop_caches"; "3"]])],
3159 "drop kernel page cache, dentries and inodes",
3161 This instructs the guest kernel to drop its page cache,
3162 and/or dentries and inode caches. The parameter C<whattodrop>
3163 tells the kernel what precisely to drop, see
3164 L<http://linux-mm.org/Drop_Caches>
3166 Setting C<whattodrop> to 3 should drop everything.
3168 This automatically calls L<sync(2)> before the operation,
3169 so that the maximum guest memory is freed.");
3171 ("dmesg", (RString "kmsgs", [], []), 91, [],
3172 [InitEmpty, Always, TestRun (
3174 "return kernel messages",
3176 This returns the kernel messages (C<dmesg> output) from
3177 the guest kernel. This is sometimes useful for extended
3178 debugging of problems.
3180 Another way to get the same information is to enable
3181 verbose messages with C<guestfs_set_verbose> or by setting
3182 the environment variable C<LIBGUESTFS_DEBUG=1> before
3183 running the program.");
3185 ("ping_daemon", (RErr, [], []), 92, [],
3186 [InitEmpty, Always, TestRun (
3187 [["ping_daemon"]])],
3188 "ping the guest daemon",
3190 This is a test probe into the guestfs daemon running inside
3191 the qemu subprocess. Calling this function checks that the
3192 daemon responds to the ping message, without affecting the daemon
3193 or attached block device(s) in any other way.");
3195 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3196 [InitScratchFS, Always, TestOutputTrue (
3197 [["mkdir"; "/equal"];
3198 ["write"; "/equal/file1"; "contents of a file"];
3199 ["cp"; "/equal/file1"; "/equal/file2"];
3200 ["equal"; "/equal/file1"; "/equal/file2"]]);
3201 InitScratchFS, Always, TestOutputFalse (
3202 [["mkdir"; "/equal2"];
3203 ["write"; "/equal2/file1"; "contents of a file"];
3204 ["write"; "/equal2/file2"; "contents of another file"];
3205 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3206 InitScratchFS, Always, TestLastFail (
3207 [["mkdir"; "/equal3"];
3208 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3209 "test if two files have equal contents",
3211 This compares the two files C<file1> and C<file2> and returns
3212 true if their content is exactly equal, or false otherwise.
3214 The external L<cmp(1)> program is used for the comparison.");
3216 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3217 [InitISOFS, Always, TestOutputList (
3218 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3219 InitISOFS, Always, TestOutputList (
3220 [["strings"; "/empty"]], []);
3221 (* Test for RHBZ#579608, absolute symbolic links. *)
3222 InitISOFS, Always, TestRun (
3223 [["strings"; "/abssymlink"]])],
3224 "print the printable strings in a file",
3226 This runs the L<strings(1)> command on a file and returns
3227 the list of printable strings found.");
3229 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3230 [InitISOFS, Always, TestOutputList (
3231 [["strings_e"; "b"; "/known-5"]], []);
3232 InitScratchFS, Always, TestOutputList (
3233 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3234 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3235 "print the printable strings in a file",
3237 This is like the C<guestfs_strings> command, but allows you to
3238 specify the encoding of strings that are looked for in
3239 the source file C<path>.
3241 Allowed encodings are:
3247 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3248 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3252 Single 8-bit-byte characters.
3256 16-bit big endian strings such as those encoded in
3257 UTF-16BE or UCS-2BE.
3259 =item l (lower case letter L)
3261 16-bit little endian such as UTF-16LE and UCS-2LE.
3262 This is useful for examining binaries in Windows guests.
3266 32-bit big endian such as UCS-4BE.
3270 32-bit little endian such as UCS-4LE.
3274 The returned strings are transcoded to UTF-8.");
3276 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3277 [InitISOFS, Always, TestOutput (
3278 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3279 (* Test for RHBZ#501888c2 regression which caused large hexdump
3280 * commands to segfault.
3282 InitISOFS, Always, TestRun (
3283 [["hexdump"; "/100krandom"]]);
3284 (* Test for RHBZ#579608, absolute symbolic links. *)
3285 InitISOFS, Always, TestRun (
3286 [["hexdump"; "/abssymlink"]])],
3287 "dump a file in hexadecimal",
3289 This runs C<hexdump -C> on the given C<path>. The result is
3290 the human-readable, canonical hex dump of the file.");
3292 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3293 [InitNone, Always, TestOutput (
3294 [["part_disk"; "/dev/sda"; "mbr"];
3295 ["mkfs"; "ext3"; "/dev/sda1"];
3296 ["mount_options"; ""; "/dev/sda1"; "/"];
3297 ["write"; "/new"; "test file"];
3298 ["umount"; "/dev/sda1"];
3299 ["zerofree"; "/dev/sda1"];
3300 ["mount_options"; ""; "/dev/sda1"; "/"];
3301 ["cat"; "/new"]], "test file")],
3302 "zero unused inodes and disk blocks on ext2/3 filesystem",
3304 This runs the I<zerofree> program on C<device>. This program
3305 claims to zero unused inodes and disk blocks on an ext2/3
3306 filesystem, thus making it possible to compress the filesystem
3309 You should B<not> run this program if the filesystem is
3312 It is possible that using this program can damage the filesystem
3313 or data on the filesystem.");
3315 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3317 "resize an LVM physical volume",
3319 This resizes (expands or shrinks) an existing LVM physical
3320 volume to match the new size of the underlying device.");
3322 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3323 Int "cyls"; Int "heads"; Int "sectors";
3324 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3326 "modify a single partition on a block device",
3328 This runs L<sfdisk(8)> option to modify just the single
3329 partition C<n> (note: C<n> counts from 1).
3331 For other parameters, see C<guestfs_sfdisk>. You should usually
3332 pass C<0> for the cyls/heads/sectors parameters.
3334 See also: C<guestfs_part_add>");
3336 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3338 "display the partition table",
3340 This displays the partition table on C<device>, in the
3341 human-readable output of the L<sfdisk(8)> command. It is
3342 not intended to be parsed.
3344 See also: C<guestfs_part_list>");
3346 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3348 "display the kernel geometry",
3350 This displays the kernel's idea of the geometry of C<device>.
3352 The result is in human-readable format, and not designed to
3355 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3357 "display the disk geometry from the partition table",
3359 This displays the disk geometry of C<device> read from the
3360 partition table. Especially in the case where the underlying
3361 block device has been resized, this can be different from the
3362 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3364 The result is in human-readable format, and not designed to
3367 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3369 "activate or deactivate all volume groups",
3371 This command activates or (if C<activate> is false) deactivates
3372 all logical volumes in all volume groups.
3374 This command is the same as running C<vgchange -a y|n>");
3376 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3378 "activate or deactivate some volume groups",
3380 This command activates or (if C<activate> is false) deactivates
3381 all logical volumes in the listed volume groups C<volgroups>.
3383 This command is the same as running C<vgchange -a y|n volgroups...>
3385 Note that if C<volgroups> is an empty list then B<all> volume groups
3386 are activated or deactivated.");
3388 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3389 [InitNone, Always, TestOutput (
3390 [["part_disk"; "/dev/sda"; "mbr"];
3391 ["pvcreate"; "/dev/sda1"];
3392 ["vgcreate"; "VG"; "/dev/sda1"];
3393 ["lvcreate"; "LV"; "VG"; "10"];
3394 ["mkfs"; "ext2"; "/dev/VG/LV"];
3395 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3396 ["write"; "/new"; "test content"];
3398 ["lvresize"; "/dev/VG/LV"; "20"];
3399 ["e2fsck_f"; "/dev/VG/LV"];
3400 ["resize2fs"; "/dev/VG/LV"];
3401 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3402 ["cat"; "/new"]], "test content");
3403 InitNone, Always, TestRun (
3404 (* Make an LV smaller to test RHBZ#587484. *)
3405 [["part_disk"; "/dev/sda"; "mbr"];
3406 ["pvcreate"; "/dev/sda1"];
3407 ["vgcreate"; "VG"; "/dev/sda1"];
3408 ["lvcreate"; "LV"; "VG"; "20"];
3409 ["lvresize"; "/dev/VG/LV"; "10"]])],
3410 "resize an LVM logical volume",
3412 This resizes (expands or shrinks) an existing LVM logical
3413 volume to C<mbytes>. When reducing, data in the reduced part
3416 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3417 [], (* lvresize tests this *)
3418 "resize an ext2, ext3 or ext4 filesystem",
3420 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3421 the underlying device.
3423 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3424 on the C<device> before calling this command. For unknown reasons
3425 C<resize2fs> sometimes gives an error about this and sometimes not.
3426 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3427 calling this function.");
3429 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3430 [InitBasicFS, Always, TestOutputList (
3431 [["find"; "/"]], ["lost+found"]);
3432 InitBasicFS, Always, TestOutputList (
3436 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3437 InitScratchFS, Always, TestOutputList (
3438 [["mkdir_p"; "/find/b/c"];
3439 ["touch"; "/find/b/c/d"];
3440 ["find"; "/find/b/"]], ["c"; "c/d"])],
3441 "find all files and directories",
3443 This command lists out all files and directories, recursively,
3444 starting at C<directory>. It is essentially equivalent to
3445 running the shell command C<find directory -print> but some
3446 post-processing happens on the output, described below.
3448 This returns a list of strings I<without any prefix>. Thus
3449 if the directory structure was:
3455 then the returned list from C<guestfs_find> C</tmp> would be
3463 If C<directory> is not a directory, then this command returns
3466 The returned list is sorted.
3468 See also C<guestfs_find0>.");
3470 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3471 [], (* lvresize tests this *)
3472 "check an ext2/ext3 filesystem",
3474 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3475 filesystem checker on C<device>, noninteractively (I<-p>),
3476 even if the filesystem appears to be clean (I<-f>).
3478 This command is only needed because of C<guestfs_resize2fs>
3479 (q.v.). Normally you should use C<guestfs_fsck>.");
3481 ("sleep", (RErr, [Int "secs"], []), 109, [],
3482 [InitNone, Always, TestRun (
3484 "sleep for some seconds",
3486 Sleep for C<secs> seconds.");
3488 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3489 [InitNone, Always, TestOutputInt (
3490 [["part_disk"; "/dev/sda"; "mbr"];
3491 ["mkfs"; "ntfs"; "/dev/sda1"];
3492 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3493 InitNone, Always, TestOutputInt (
3494 [["part_disk"; "/dev/sda"; "mbr"];
3495 ["mkfs"; "ext2"; "/dev/sda1"];
3496 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3497 "probe NTFS volume",
3499 This command runs the L<ntfs-3g.probe(8)> command which probes
3500 an NTFS C<device> for mountability. (Not all NTFS volumes can
3501 be mounted read-write, and some cannot be mounted at all).
3503 C<rw> is a boolean flag. Set it to true if you want to test
3504 if the volume can be mounted read-write. Set it to false if
3505 you want to test if the volume can be mounted read-only.
3507 The return value is an integer which C<0> if the operation
3508 would succeed, or some non-zero value documented in the
3509 L<ntfs-3g.probe(8)> manual page.");
3511 ("sh", (RString "output", [String "command"], []), 111, [],
3512 [], (* XXX needs tests *)
3513 "run a command via the shell",
3515 This call runs a command from the guest filesystem via the
3518 This is like C<guestfs_command>, but passes the command to:
3520 /bin/sh -c \"command\"
3522 Depending on the guest's shell, this usually results in
3523 wildcards being expanded, shell expressions being interpolated
3526 All the provisos about C<guestfs_command> apply to this call.");
3528 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3529 [], (* XXX needs tests *)
3530 "run a command via the shell returning lines",
3532 This is the same as C<guestfs_sh>, but splits the result
3533 into a list of lines.
3535 See also: C<guestfs_command_lines>");
3537 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3538 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3539 * code in stubs.c, since all valid glob patterns must start with "/".
3540 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3542 [InitScratchFS, Always, TestOutputList (
3543 [["mkdir_p"; "/glob_expand/b/c"];
3544 ["touch"; "/glob_expand/b/c/d"];
3545 ["touch"; "/glob_expand/b/c/e"];
3546 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3547 InitScratchFS, Always, TestOutputList (
3548 [["mkdir_p"; "/glob_expand2/b/c"];
3549 ["touch"; "/glob_expand2/b/c/d"];
3550 ["touch"; "/glob_expand2/b/c/e"];
3551 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3552 InitScratchFS, Always, TestOutputList (
3553 [["mkdir_p"; "/glob_expand3/b/c"];
3554 ["touch"; "/glob_expand3/b/c/d"];
3555 ["touch"; "/glob_expand3/b/c/e"];
3556 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3557 "expand a wildcard path",
3559 This command searches for all the pathnames matching
3560 C<pattern> according to the wildcard expansion rules
3563 If no paths match, then this returns an empty list
3564 (note: not an error).
3566 It is just a wrapper around the C L<glob(3)> function
3567 with flags C<GLOB_MARK|GLOB_BRACE>.
3568 See that manual page for more details.");
3570 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3571 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3572 [["scrub_device"; "/dev/sdc"]])],
3573 "scrub (securely wipe) a device",
3575 This command writes patterns over C<device> to make data retrieval
3578 It is an interface to the L<scrub(1)> program. See that
3579 manual page for more details.");
3581 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3582 [InitScratchFS, Always, TestRun (
3583 [["write"; "/scrub_file"; "content"];
3584 ["scrub_file"; "/scrub_file"]])],
3585 "scrub (securely wipe) a file",
3587 This command writes patterns over a file to make data retrieval
3590 The file is I<removed> after scrubbing.
3592 It is an interface to the L<scrub(1)> program. See that
3593 manual page for more details.");
3595 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3596 [], (* XXX needs testing *)
3597 "scrub (securely wipe) free space",
3599 This command creates the directory C<dir> and then fills it
3600 with files until the filesystem is full, and scrubs the files
3601 as for C<guestfs_scrub_file>, and deletes them.
3602 The intention is to scrub any free space on the partition
3605 It is an interface to the L<scrub(1)> program. See that
3606 manual page for more details.");
3608 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3609 [InitScratchFS, Always, TestRun (
3610 [["mkdir"; "/mkdtemp"];
3611 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3612 "create a temporary directory",
3614 This command creates a temporary directory. The
3615 C<template> parameter should be a full pathname for the
3616 temporary directory name with the final six characters being
3619 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3620 the second one being suitable for Windows filesystems.
3622 The name of the temporary directory that was created
3625 The temporary directory is created with mode 0700
3626 and is owned by root.
3628 The caller is responsible for deleting the temporary
3629 directory and its contents after use.
3631 See also: L<mkdtemp(3)>");
3633 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3634 [InitISOFS, Always, TestOutputInt (
3635 [["wc_l"; "/10klines"]], 10000);
3636 (* Test for RHBZ#579608, absolute symbolic links. *)
3637 InitISOFS, Always, TestOutputInt (
3638 [["wc_l"; "/abssymlink"]], 10000)],
3639 "count lines in a file",
3641 This command counts the lines in a file, using the
3642 C<wc -l> external command.");
3644 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3645 [InitISOFS, Always, TestOutputInt (
3646 [["wc_w"; "/10klines"]], 10000)],
3647 "count words in a file",
3649 This command counts the words in a file, using the
3650 C<wc -w> external command.");
3652 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3653 [InitISOFS, Always, TestOutputInt (
3654 [["wc_c"; "/100kallspaces"]], 102400)],
3655 "count characters in a file",
3657 This command counts the characters in a file, using the
3658 C<wc -c> external command.");
3660 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3661 [InitISOFS, Always, TestOutputList (
3662 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3663 (* Test for RHBZ#579608, absolute symbolic links. *)
3664 InitISOFS, Always, TestOutputList (
3665 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3666 "return first 10 lines of a file",
3668 This command returns up to the first 10 lines of a file as
3669 a list of strings.");
3671 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3672 [InitISOFS, Always, TestOutputList (
3673 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3674 InitISOFS, Always, TestOutputList (
3675 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3676 InitISOFS, Always, TestOutputList (
3677 [["head_n"; "0"; "/10klines"]], [])],
3678 "return first N lines of a file",
3680 If the parameter C<nrlines> is a positive number, this returns the first
3681 C<nrlines> lines of the file C<path>.
3683 If the parameter C<nrlines> is a negative number, this returns lines
3684 from the file C<path>, excluding the last C<nrlines> lines.
3686 If the parameter C<nrlines> is zero, this returns an empty list.");
3688 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3689 [InitISOFS, Always, TestOutputList (
3690 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3691 "return last 10 lines of a file",
3693 This command returns up to the last 10 lines of a file as
3694 a list of strings.");
3696 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3697 [InitISOFS, Always, TestOutputList (
3698 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3699 InitISOFS, Always, TestOutputList (
3700 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3701 InitISOFS, Always, TestOutputList (
3702 [["tail_n"; "0"; "/10klines"]], [])],
3703 "return last N lines of a file",
3705 If the parameter C<nrlines> is a positive number, this returns the last
3706 C<nrlines> lines of the file C<path>.
3708 If the parameter C<nrlines> is a negative number, this returns lines
3709 from the file C<path>, starting with the C<-nrlines>th line.
3711 If the parameter C<nrlines> is zero, this returns an empty list.");
3713 ("df", (RString "output", [], []), 125, [],
3714 [], (* XXX Tricky to test because it depends on the exact format
3715 * of the 'df' command and other imponderables.
3717 "report file system disk space usage",
3719 This command runs the C<df> command to report disk space used.
3721 This command is mostly useful for interactive sessions. It
3722 is I<not> intended that you try to parse the output string.
3723 Use C<guestfs_statvfs> from programs.");
3725 ("df_h", (RString "output", [], []), 126, [],
3726 [], (* XXX Tricky to test because it depends on the exact format
3727 * of the 'df' command and other imponderables.
3729 "report file system disk space usage (human readable)",
3731 This command runs the C<df -h> command to report disk space used
3732 in human-readable format.
3734 This command is mostly useful for interactive sessions. It
3735 is I<not> intended that you try to parse the output string.
3736 Use C<guestfs_statvfs> from programs.");
3738 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3739 [InitISOFS, Always, TestOutputInt (
3740 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3741 "estimate file space usage",
3743 This command runs the C<du -s> command to estimate file space
3746 C<path> can be a file or a directory. If C<path> is a directory
3747 then the estimate includes the contents of the directory and all
3748 subdirectories (recursively).
3750 The result is the estimated size in I<kilobytes>
3751 (ie. units of 1024 bytes).");
3753 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3754 [InitISOFS, Always, TestOutputList (
3755 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3756 "list files in an initrd",
3758 This command lists out files contained in an initrd.
3760 The files are listed without any initial C</> character. The
3761 files are listed in the order they appear (not necessarily
3762 alphabetical). Directory names are listed as separate items.
3764 Old Linux kernels (2.4 and earlier) used a compressed ext2
3765 filesystem as initrd. We I<only> support the newer initramfs
3766 format (compressed cpio files).");
3768 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3770 "mount a file using the loop device",
3772 This command lets you mount C<file> (a filesystem image
3773 in a file) on a mount point. It is entirely equivalent to
3774 the command C<mount -o loop file mountpoint>.");
3776 ("mkswap", (RErr, [Device "device"], []), 130, [],
3777 [InitEmpty, Always, TestRun (
3778 [["part_disk"; "/dev/sda"; "mbr"];
3779 ["mkswap"; "/dev/sda1"]])],
3780 "create a swap partition",
3782 Create a swap partition on C<device>.");
3784 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3785 [InitEmpty, Always, TestRun (
3786 [["part_disk"; "/dev/sda"; "mbr"];
3787 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3788 "create a swap partition with a label",
3790 Create a swap partition on C<device> with label C<label>.
3792 Note that you cannot attach a swap label to a block device
3793 (eg. C</dev/sda>), just to a partition. This appears to be
3794 a limitation of the kernel or swap tools.");
3796 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3797 (let uuid = uuidgen () in
3798 [InitEmpty, Always, TestRun (
3799 [["part_disk"; "/dev/sda"; "mbr"];
3800 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3801 "create a swap partition with an explicit UUID",
3803 Create a swap partition on C<device> with UUID C<uuid>.");
3805 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3806 [InitScratchFS, Always, TestOutputStruct (
3807 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3808 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3809 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3810 InitScratchFS, Always, TestOutputStruct (
3811 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3812 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3813 "make block, character or FIFO devices",
3815 This call creates block or character special devices, or
3816 named pipes (FIFOs).
3818 The C<mode> parameter should be the mode, using the standard
3819 constants. C<devmajor> and C<devminor> are the
3820 device major and minor numbers, only used when creating block
3821 and character special devices.
3823 Note that, just like L<mknod(2)>, the mode must be bitwise
3824 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3825 just creates a regular file). These constants are
3826 available in the standard Linux header files, or you can use
3827 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3828 which are wrappers around this command which bitwise OR
3829 in the appropriate constant for you.
3831 The mode actually set is affected by the umask.");
3833 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3834 [InitScratchFS, Always, TestOutputStruct (
3835 [["mkfifo"; "0o777"; "/mkfifo"];
3836 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3837 "make FIFO (named pipe)",
3839 This call creates a FIFO (named pipe) called C<path> with
3840 mode C<mode>. It is just a convenient wrapper around
3843 The mode actually set is affected by the umask.");
3845 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3846 [InitScratchFS, Always, TestOutputStruct (
3847 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3848 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3849 "make block device node",
3851 This call creates a block device node called C<path> with
3852 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3853 It is just a convenient wrapper around C<guestfs_mknod>.
3855 The mode actually set is affected by the umask.");
3857 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3858 [InitScratchFS, Always, TestOutputStruct (
3859 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3860 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3861 "make char device node",
3863 This call creates a char device node called C<path> with
3864 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3865 It is just a convenient wrapper around C<guestfs_mknod>.
3867 The mode actually set is affected by the umask.");
3869 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3870 [InitEmpty, Always, TestOutputInt (
3871 [["umask"; "0o22"]], 0o22)],
3872 "set file mode creation mask (umask)",
3874 This function sets the mask used for creating new files and
3875 device nodes to C<mask & 0777>.
3877 Typical umask values would be C<022> which creates new files
3878 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3879 C<002> which creates new files with permissions like
3880 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3882 The default umask is C<022>. This is important because it
3883 means that directories and device nodes will be created with
3884 C<0644> or C<0755> mode even if you specify C<0777>.
3886 See also C<guestfs_get_umask>,
3887 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3889 This call returns the previous umask.");
3891 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3893 "read directories entries",
3895 This returns the list of directory entries in directory C<dir>.
3897 All entries in the directory are returned, including C<.> and
3898 C<..>. The entries are I<not> sorted, but returned in the same
3899 order as the underlying filesystem.
3901 Also this call returns basic file type information about each
3902 file. The C<ftyp> field will contain one of the following characters:
3940 The L<readdir(3)> call returned a C<d_type> field with an
3945 This function is primarily intended for use by programs. To
3946 get a simple list of names, use C<guestfs_ls>. To get a printable
3947 directory for human consumption, use C<guestfs_ll>.");
3949 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3951 "create partitions on a block device",
3953 This is a simplified interface to the C<guestfs_sfdisk>
3954 command, where partition sizes are specified in megabytes
3955 only (rounded to the nearest cylinder) and you don't need
3956 to specify the cyls, heads and sectors parameters which
3957 were rarely if ever used anyway.
3959 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3960 and C<guestfs_part_disk>");
3962 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3964 "determine file type inside a compressed file",
3966 This command runs C<file> after first decompressing C<path>
3969 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3971 Since 1.0.63, use C<guestfs_file> instead which can now
3972 process compressed files.");
3974 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3976 "list extended attributes of a file or directory",
3978 This call lists the extended attributes of the file or directory
3981 At the system call level, this is a combination of the
3982 L<listxattr(2)> and L<getxattr(2)> calls.
3984 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3986 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3988 "list extended attributes of a file or directory",
3990 This is the same as C<guestfs_getxattrs>, but if C<path>
3991 is a symbolic link, then it returns the extended attributes
3992 of the link itself.");
3994 ("setxattr", (RErr, [String "xattr";
3995 String "val"; Int "vallen"; (* will be BufferIn *)
3996 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3998 "set extended attribute of a file or directory",
4000 This call sets the extended attribute named C<xattr>
4001 of the file C<path> to the value C<val> (of length C<vallen>).
4002 The value is arbitrary 8 bit data.
4004 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
4006 ("lsetxattr", (RErr, [String "xattr";
4007 String "val"; Int "vallen"; (* will be BufferIn *)
4008 Pathname "path"], []), 144, [Optional "linuxxattrs"],
4010 "set extended attribute of a file or directory",
4012 This is the same as C<guestfs_setxattr>, but if C<path>
4013 is a symbolic link, then it sets an extended attribute
4014 of the link itself.");
4016 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
4018 "remove extended attribute of a file or directory",
4020 This call removes the extended attribute named C<xattr>
4021 of the file C<path>.
4023 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
4025 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
4027 "remove extended attribute of a file or directory",
4029 This is the same as C<guestfs_removexattr>, but if C<path>
4030 is a symbolic link, then it removes an extended attribute
4031 of the link itself.");
4033 ("mountpoints", (RHashtable "mps", [], []), 147, [],
4037 This call is similar to C<guestfs_mounts>. That call returns
4038 a list of devices. This one returns a hash table (map) of
4039 device name to directory where the device is mounted.");
4041 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
4042 (* This is a special case: while you would expect a parameter
4043 * of type "Pathname", that doesn't work, because it implies
4044 * NEED_ROOT in the generated calling code in stubs.c, and
4045 * this function cannot use NEED_ROOT.
4048 "create a mountpoint",
4050 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
4051 specialized calls that can be used to create extra mountpoints
4052 before mounting the first filesystem.
4054 These calls are I<only> necessary in some very limited circumstances,
4055 mainly the case where you want to mount a mix of unrelated and/or
4056 read-only filesystems together.
4058 For example, live CDs often contain a \"Russian doll\" nest of
4059 filesystems, an ISO outer layer, with a squashfs image inside, with
4060 an ext2/3 image inside that. You can unpack this as follows
4063 add-ro Fedora-11-i686-Live.iso
4067 mkmountpoint /ext3fs
4069 mount-loop /cd/LiveOS/squashfs.img /sqsh
4070 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4072 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4074 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4075 You may get unexpected errors if you try to mix these calls. It is
4076 safest to manually unmount filesystems and remove mountpoints after use.
4078 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4079 longest first, so for this to work for manual mountpoints, you
4080 must ensure that the innermost mountpoints have the longest
4081 pathnames, as in the example code above.
4083 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4085 Autosync [see C<guestfs_set_autosync>, this is set by default on
4086 handles] can cause C<guestfs_umount_all> to be called when the handle
4087 is closed which can also trigger these issues.");
4089 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4091 "remove a mountpoint",
4093 This calls removes a mountpoint that was previously created
4094 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4095 for full details.");
4097 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4098 [InitISOFS, Always, TestOutputBuffer (
4099 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4100 (* Test various near large, large and too large files (RHBZ#589039). *)
4101 InitScratchFS, Always, TestLastFail (
4102 [["touch"; "/read_file"];
4103 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4104 ["read_file"; "/read_file"]]);
4105 InitScratchFS, Always, TestLastFail (
4106 [["touch"; "/read_file2"];
4107 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4108 ["read_file"; "/read_file2"]]);
4109 InitScratchFS, Always, TestLastFail (
4110 [["touch"; "/read_file3"];
4111 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4112 ["read_file"; "/read_file3"]])],
4115 This calls returns the contents of the file C<path> as a
4118 Unlike C<guestfs_cat>, this function can correctly
4119 handle files that contain embedded ASCII NUL characters.
4120 However unlike C<guestfs_download>, this function is limited
4121 in the total size of file that can be handled.");
4123 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4124 [InitISOFS, Always, TestOutputList (
4125 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4126 InitISOFS, Always, TestOutputList (
4127 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4128 (* Test for RHBZ#579608, absolute symbolic links. *)
4129 InitISOFS, Always, TestOutputList (
4130 [["grep"; "nomatch"; "/abssymlink"]], [])],
4131 "return lines matching a pattern",
4133 This calls the external C<grep> program and returns the
4136 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4137 [InitISOFS, Always, TestOutputList (
4138 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4139 "return lines matching a pattern",
4141 This calls the external C<egrep> program and returns the
4144 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4145 [InitISOFS, Always, TestOutputList (
4146 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4147 "return lines matching a pattern",
4149 This calls the external C<fgrep> program and returns the
4152 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4153 [InitISOFS, Always, TestOutputList (
4154 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4155 "return lines matching a pattern",
4157 This calls the external C<grep -i> program and returns the
4160 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4161 [InitISOFS, Always, TestOutputList (
4162 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4163 "return lines matching a pattern",
4165 This calls the external C<egrep -i> program and returns the
4168 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4169 [InitISOFS, Always, TestOutputList (
4170 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4171 "return lines matching a pattern",
4173 This calls the external C<fgrep -i> program and returns the
4176 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4177 [InitISOFS, Always, TestOutputList (
4178 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4179 "return lines matching a pattern",
4181 This calls the external C<zgrep> program and returns the
4184 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4185 [InitISOFS, Always, TestOutputList (
4186 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4187 "return lines matching a pattern",
4189 This calls the external C<zegrep> program and returns the
4192 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4193 [InitISOFS, Always, TestOutputList (
4194 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4195 "return lines matching a pattern",
4197 This calls the external C<zfgrep> program and returns the
4200 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4201 [InitISOFS, Always, TestOutputList (
4202 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4203 "return lines matching a pattern",
4205 This calls the external C<zgrep -i> program and returns the
4208 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4209 [InitISOFS, Always, TestOutputList (
4210 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4211 "return lines matching a pattern",
4213 This calls the external C<zegrep -i> program and returns the
4216 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4217 [InitISOFS, Always, TestOutputList (
4218 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4219 "return lines matching a pattern",
4221 This calls the external C<zfgrep -i> program and returns the
4224 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4225 [InitISOFS, Always, TestOutput (
4226 [["realpath"; "/../directory"]], "/directory")],
4227 "canonicalized absolute pathname",
4229 Return the canonicalized absolute pathname of C<path>. The
4230 returned path has no C<.>, C<..> or symbolic link path elements.");
4232 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4233 [InitScratchFS, Always, TestOutputStruct (
4236 ["ln"; "/ln/a"; "/ln/b"];
4237 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4238 "create a hard link",
4240 This command creates a hard link using the C<ln> command.");
4242 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4243 [InitScratchFS, Always, TestOutputStruct (
4244 [["mkdir"; "/ln_f"];
4245 ["touch"; "/ln_f/a"];
4246 ["touch"; "/ln_f/b"];
4247 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4248 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4249 "create a hard link",
4251 This command creates a hard link using the C<ln -f> command.
4252 The I<-f> option removes the link (C<linkname>) if it exists already.");
4254 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4255 [InitScratchFS, Always, TestOutputStruct (
4256 [["mkdir"; "/ln_s"];
4257 ["touch"; "/ln_s/a"];
4258 ["ln_s"; "a"; "/ln_s/b"];
4259 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4260 "create a symbolic link",
4262 This command creates a symbolic link using the C<ln -s> command.");
4264 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4265 [InitScratchFS, Always, TestOutput (
4266 [["mkdir_p"; "/ln_sf/b"];
4267 ["touch"; "/ln_sf/b/c"];
4268 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4269 ["readlink"; "/ln_sf/b/c"]], "../d")],
4270 "create a symbolic link",
4272 This command creates a symbolic link using the C<ln -sf> command,
4273 The I<-f> option removes the link (C<linkname>) if it exists already.");
4275 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4276 [] (* XXX tested above *),
4277 "read the target of a symbolic link",
4279 This command reads the target of a symbolic link.");
4281 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4282 [InitScratchFS, Always, TestOutputStruct (
4283 [["fallocate"; "/fallocate"; "1000000"];
4284 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4285 "preallocate a file in the guest filesystem",
4287 This command preallocates a file (containing zero bytes) named
4288 C<path> of size C<len> bytes. If the file exists already, it
4291 Do not confuse this with the guestfish-specific
4292 C<alloc> command which allocates a file in the host and
4293 attaches it as a device.");
4295 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4296 [InitPartition, Always, TestRun (
4297 [["mkswap"; "/dev/sda1"];
4298 ["swapon_device"; "/dev/sda1"];
4299 ["swapoff_device"; "/dev/sda1"]])],
4300 "enable swap on device",
4302 This command enables the libguestfs appliance to use the
4303 swap device or partition named C<device>. The increased
4304 memory is made available for all commands, for example
4305 those run using C<guestfs_command> or C<guestfs_sh>.
4307 Note that you should not swap to existing guest swap
4308 partitions unless you know what you are doing. They may
4309 contain hibernation information, or other information that
4310 the guest doesn't want you to trash. You also risk leaking
4311 information about the host to the guest this way. Instead,
4312 attach a new host device to the guest and swap on that.");
4314 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4315 [], (* XXX tested by swapon_device *)
4316 "disable swap on device",
4318 This command disables the libguestfs appliance swap
4319 device or partition named C<device>.
4320 See C<guestfs_swapon_device>.");
4322 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4323 [InitScratchFS, Always, TestRun (
4324 [["fallocate"; "/swapon_file"; "8388608"];
4325 ["mkswap_file"; "/swapon_file"];
4326 ["swapon_file"; "/swapon_file"];
4327 ["swapoff_file"; "/swapon_file"];
4328 ["rm"; "/swapon_file"]])],
4329 "enable swap on file",
4331 This command enables swap to a file.
4332 See C<guestfs_swapon_device> for other notes.");
4334 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4335 [], (* XXX tested by swapon_file *)
4336 "disable swap on file",
4338 This command disables the libguestfs appliance swap on file.");
4340 ("swapon_label", (RErr, [String "label"], []), 174, [],
4341 [InitEmpty, Always, TestRun (
4342 [["part_disk"; "/dev/sda"; "mbr"];
4343 ["mkswap_L"; "swapit"; "/dev/sda1"];
4344 ["swapon_label"; "swapit"];
4345 ["swapoff_label"; "swapit"];
4346 ["zero"; "/dev/sda"];
4347 ["blockdev_rereadpt"; "/dev/sda"]])],
4348 "enable swap on labeled swap partition",
4350 This command enables swap to a labeled swap partition.
4351 See C<guestfs_swapon_device> for other notes.");
4353 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4354 [], (* XXX tested by swapon_label *)
4355 "disable swap on labeled swap partition",
4357 This command disables the libguestfs appliance swap on
4358 labeled swap partition.");
4360 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4361 (let uuid = uuidgen () in
4362 [InitEmpty, Always, TestRun (
4363 [["mkswap_U"; uuid; "/dev/sdc"];
4364 ["swapon_uuid"; uuid];
4365 ["swapoff_uuid"; uuid]])]),
4366 "enable swap on swap partition by UUID",
4368 This command enables swap to a swap partition with the given UUID.
4369 See C<guestfs_swapon_device> for other notes.");
4371 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4372 [], (* XXX tested by swapon_uuid *)
4373 "disable swap on swap partition by UUID",
4375 This command disables the libguestfs appliance swap partition
4376 with the given UUID.");
4378 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4379 [InitScratchFS, Always, TestRun (
4380 [["fallocate"; "/mkswap_file"; "8388608"];
4381 ["mkswap_file"; "/mkswap_file"];
4382 ["rm"; "/mkswap_file"]])],
4383 "create a swap file",
4387 This command just writes a swap file signature to an existing
4388 file. To create the file itself, use something like C<guestfs_fallocate>.");
4390 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4391 [InitISOFS, Always, TestRun (
4392 [["inotify_init"; "0"]])],
4393 "create an inotify handle",
4395 This command creates a new inotify handle.
4396 The inotify subsystem can be used to notify events which happen to
4397 objects in the guest filesystem.
4399 C<maxevents> is the maximum number of events which will be
4400 queued up between calls to C<guestfs_inotify_read> or
4401 C<guestfs_inotify_files>.
4402 If this is passed as C<0>, then the kernel (or previously set)
4403 default is used. For Linux 2.6.29 the default was 16384 events.
4404 Beyond this limit, the kernel throws away events, but records
4405 the fact that it threw them away by setting a flag
4406 C<IN_Q_OVERFLOW> in the returned structure list (see
4407 C<guestfs_inotify_read>).
4409 Before any events are generated, you have to add some
4410 watches to the internal watch list. See:
4411 C<guestfs_inotify_add_watch>,
4412 C<guestfs_inotify_rm_watch> and
4413 C<guestfs_inotify_watch_all>.
4415 Queued up events should be read periodically by calling
4416 C<guestfs_inotify_read>
4417 (or C<guestfs_inotify_files> which is just a helpful
4418 wrapper around C<guestfs_inotify_read>). If you don't
4419 read the events out often enough then you risk the internal
4422 The handle should be closed after use by calling
4423 C<guestfs_inotify_close>. This also removes any
4424 watches automatically.
4426 See also L<inotify(7)> for an overview of the inotify interface
4427 as exposed by the Linux kernel, which is roughly what we expose
4428 via libguestfs. Note that there is one global inotify handle
4429 per libguestfs instance.");
4431 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4432 [InitScratchFS, Always, TestOutputList (
4433 [["mkdir"; "/inotify_add_watch"];
4434 ["inotify_init"; "0"];
4435 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4436 ["touch"; "/inotify_add_watch/a"];
4437 ["touch"; "/inotify_add_watch/b"];
4438 ["inotify_files"]], ["a"; "b"])],
4439 "add an inotify watch",
4441 Watch C<path> for the events listed in C<mask>.
4443 Note that if C<path> is a directory then events within that
4444 directory are watched, but this does I<not> happen recursively
4445 (in subdirectories).
4447 Note for non-C or non-Linux callers: the inotify events are
4448 defined by the Linux kernel ABI and are listed in
4449 C</usr/include/sys/inotify.h>.");
4451 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4453 "remove an inotify watch",
4455 Remove a previously defined inotify watch.
4456 See C<guestfs_inotify_add_watch>.");
4458 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4460 "return list of inotify events",
4462 Return the complete queue of events that have happened
4463 since the previous read call.
4465 If no events have happened, this returns an empty list.
4467 I<Note>: In order to make sure that all events have been
4468 read, you must call this function repeatedly until it
4469 returns an empty list. The reason is that the call will
4470 read events up to the maximum appliance-to-host message
4471 size and leave remaining events in the queue.");
4473 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4475 "return list of watched files that had events",
4477 This function is a helpful wrapper around C<guestfs_inotify_read>
4478 which just returns a list of pathnames of objects that were
4479 touched. The returned pathnames are sorted and deduplicated.");
4481 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4483 "close the inotify handle",
4485 This closes the inotify handle which was previously
4486 opened by inotify_init. It removes all watches, throws
4487 away any pending events, and deallocates all resources.");
4489 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4491 "set SELinux security context",
4493 This sets the SELinux security context of the daemon
4494 to the string C<context>.
4496 See the documentation about SELINUX in L<guestfs(3)>.");
4498 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4500 "get SELinux security context",
4502 This gets the SELinux security context of the daemon.
4504 See the documentation about SELINUX in L<guestfs(3)>,
4505 and C<guestfs_setcon>");
4507 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4508 [InitEmpty, Always, TestOutput (
4509 [["part_disk"; "/dev/sda"; "mbr"];
4510 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4511 ["mount_options"; ""; "/dev/sda1"; "/"];
4512 ["write"; "/new"; "new file contents"];
4513 ["cat"; "/new"]], "new file contents");
4514 InitEmpty, Always, TestRun (
4515 [["part_disk"; "/dev/sda"; "mbr"];
4516 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4517 InitEmpty, Always, TestLastFail (
4518 [["part_disk"; "/dev/sda"; "mbr"];
4519 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4520 InitEmpty, Always, TestLastFail (
4521 [["part_disk"; "/dev/sda"; "mbr"];
4522 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4523 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4524 [["part_disk"; "/dev/sda"; "mbr"];
4525 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4526 "make a filesystem with block size",
4528 This call is similar to C<guestfs_mkfs>, but it allows you to
4529 control the block size of the resulting filesystem. Supported
4530 block sizes depend on the filesystem type, but typically they
4531 are C<1024>, C<2048> or C<4096> only.
4533 For VFAT and NTFS the C<blocksize> parameter is treated as
4534 the requested cluster size.");
4536 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
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"; "4096"; "/dev/sda1"];
4542 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4543 ["mount_options"; ""; "/dev/sda2"; "/"];
4544 ["write"; "/new"; "new file contents"];
4545 ["cat"; "/new"]], "new file contents")],
4546 "make ext2/3/4 external journal",
4548 This creates an ext2 external journal on C<device>. It is equivalent
4551 mke2fs -O journal_dev -b blocksize device");
4553 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4554 [InitEmpty, Always, TestOutput (
4555 [["part_init"; "/dev/sda"; "mbr"];
4556 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4557 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4558 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4559 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4560 ["mount_options"; ""; "/dev/sda2"; "/"];
4561 ["write"; "/new"; "new file contents"];
4562 ["cat"; "/new"]], "new file contents")],
4563 "make ext2/3/4 external journal with label",
4565 This creates an ext2 external journal on C<device> with label C<label>.");
4567 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4568 (let uuid = uuidgen () in
4569 [InitEmpty, Always, TestOutput (
4570 [["part_init"; "/dev/sda"; "mbr"];
4571 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4572 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4573 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4574 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4575 ["mount_options"; ""; "/dev/sda2"; "/"];
4576 ["write"; "/new"; "new file contents"];
4577 ["cat"; "/new"]], "new file contents")]),
4578 "make ext2/3/4 external journal with UUID",
4580 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4582 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4584 "make ext2/3/4 filesystem with external journal",
4586 This creates an ext2/3/4 filesystem on C<device> with
4587 an external journal on C<journal>. It is equivalent
4590 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4592 See also C<guestfs_mke2journal>.");
4594 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4596 "make ext2/3/4 filesystem with external journal",
4598 This creates an ext2/3/4 filesystem on C<device> with
4599 an external journal on the journal labeled C<label>.
4601 See also C<guestfs_mke2journal_L>.");
4603 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4605 "make ext2/3/4 filesystem with external journal",
4607 This creates an ext2/3/4 filesystem on C<device> with
4608 an external journal on the journal with UUID C<uuid>.
4610 See also C<guestfs_mke2journal_U>.");
4612 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4613 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4614 "load a kernel module",
4616 This loads a kernel module in the appliance.
4618 The kernel module must have been whitelisted when libguestfs
4619 was built (see C<appliance/kmod.whitelist.in> in the source).");
4621 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4622 [InitNone, Always, TestOutput (
4623 [["echo_daemon"; "This is a test"]], "This is a test"
4625 "echo arguments back to the client",
4627 This command concatenates the list of C<words> passed with single spaces
4628 between them and returns the resulting string.
4630 You can use this command to test the connection through to the daemon.
4632 See also C<guestfs_ping_daemon>.");
4634 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4635 [], (* There is a regression test for this. *)
4636 "find all files and directories, returning NUL-separated list",
4638 This command lists out all files and directories, recursively,
4639 starting at C<directory>, placing the resulting list in the
4640 external file called C<files>.
4642 This command works the same way as C<guestfs_find> with the
4643 following exceptions:
4649 The resulting list is written to an external file.
4653 Items (filenames) in the result are separated
4654 by C<\\0> characters. See L<find(1)> option I<-print0>.
4658 This command is not limited in the number of names that it
4663 The result list is not sorted.
4667 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4668 [InitISOFS, Always, TestOutput (
4669 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4670 InitISOFS, Always, TestOutput (
4671 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4672 InitISOFS, Always, TestOutput (
4673 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4674 InitISOFS, Always, TestLastFail (
4675 [["case_sensitive_path"; "/Known-1/"]]);
4676 InitScratchFS, Always, TestOutput (
4677 [["mkdir"; "/case_sensitive_path"];
4678 ["mkdir"; "/case_sensitive_path/bbb"];
4679 ["touch"; "/case_sensitive_path/bbb/c"];
4680 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4681 InitScratchFS, Always, TestOutput (
4682 [["mkdir"; "/case_sensitive_path2"];
4683 ["mkdir"; "/case_sensitive_path2/bbb"];
4684 ["touch"; "/case_sensitive_path2/bbb/c"];
4685 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4686 InitScratchFS, Always, TestLastFail (
4687 [["mkdir"; "/case_sensitive_path3"];
4688 ["mkdir"; "/case_sensitive_path3/bbb"];
4689 ["touch"; "/case_sensitive_path3/bbb/c"];
4690 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4691 "return true path on case-insensitive filesystem",
4693 This can be used to resolve case insensitive paths on
4694 a filesystem which is case sensitive. The use case is
4695 to resolve paths which you have read from Windows configuration
4696 files or the Windows Registry, to the true path.
4698 The command handles a peculiarity of the Linux ntfs-3g
4699 filesystem driver (and probably others), which is that although
4700 the underlying filesystem is case-insensitive, the driver
4701 exports the filesystem to Linux as case-sensitive.
4703 One consequence of this is that special directories such
4704 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4705 (or other things) depending on the precise details of how
4706 they were created. In Windows itself this would not be
4709 Bug or feature? You decide:
4710 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4712 This function resolves the true case of each element in the
4713 path and returns the case-sensitive path.
4715 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4716 might return C<\"/WINDOWS/system32\"> (the exact return value
4717 would depend on details of how the directories were originally
4718 created under Windows).
4721 This function does not handle drive names, backslashes etc.
4723 See also C<guestfs_realpath>.");
4725 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4726 [InitScratchFS, Always, TestOutput (
4727 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4728 "get the Linux VFS type corresponding to a mounted device",
4730 This command gets the filesystem type corresponding to
4731 the filesystem on C<device>.
4733 For most filesystems, the result is the name of the Linux
4734 VFS module which would be used to mount this filesystem
4735 if you mounted it without specifying the filesystem type.
4736 For example a string such as C<ext3> or C<ntfs>.");
4738 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4739 [InitScratchFS, Always, TestOutputStruct (
4740 [["write"; "/truncate"; "some stuff so size is not zero"];
4741 ["truncate"; "/truncate"];
4742 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4743 "truncate a file to zero size",
4745 This command truncates C<path> to a zero-length file. The
4746 file must exist already.");
4748 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4749 [InitScratchFS, Always, TestOutputStruct (
4750 [["touch"; "/truncate_size"];
4751 ["truncate_size"; "/truncate_size"; "1000"];
4752 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4753 "truncate a file to a particular size",
4755 This command truncates C<path> to size C<size> bytes. The file
4758 If the current file size is less than C<size> then
4759 the file is extended to the required size with zero bytes.
4760 This creates a sparse file (ie. disk blocks are not allocated
4761 for the file until you write to it). To create a non-sparse
4762 file of zeroes, use C<guestfs_fallocate64> instead.");
4764 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4765 [InitScratchFS, Always, TestOutputStruct (
4766 [["touch"; "/utimens"];
4767 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4768 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4769 "set timestamp of a file with nanosecond precision",
4771 This command sets the timestamps of a file with nanosecond
4774 C<atsecs, atnsecs> are the last access time (atime) in secs and
4775 nanoseconds from the epoch.
4777 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4778 secs and nanoseconds from the epoch.
4780 If the C<*nsecs> field contains the special value C<-1> then
4781 the corresponding timestamp is set to the current time. (The
4782 C<*secs> field is ignored in this case).
4784 If the C<*nsecs> field contains the special value C<-2> then
4785 the corresponding timestamp is left unchanged. (The
4786 C<*secs> field is ignored in this case).");
4788 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4789 [InitScratchFS, Always, TestOutputStruct (
4790 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4791 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4792 "create a directory with a particular mode",
4794 This command creates a directory, setting the initial permissions
4795 of the directory to C<mode>.
4797 For common Linux filesystems, the actual mode which is set will
4798 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4799 interpret the mode in other ways.
4801 See also C<guestfs_mkdir>, C<guestfs_umask>");
4803 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4805 "change file owner and group",
4807 Change the file owner to C<owner> and group to C<group>.
4808 This is like C<guestfs_chown> but if C<path> is a symlink then
4809 the link itself is changed, not the target.
4811 Only numeric uid and gid are supported. If you want to use
4812 names, you will need to locate and parse the password file
4813 yourself (Augeas support makes this relatively easy).");
4815 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4817 "lstat on multiple files",
4819 This call allows you to perform the C<guestfs_lstat> operation
4820 on multiple files, where all files are in the directory C<path>.
4821 C<names> is the list of files from this directory.
4823 On return you get a list of stat structs, with a one-to-one
4824 correspondence to the C<names> list. If any name did not exist
4825 or could not be lstat'd, then the C<ino> field of that structure
4828 This call is intended for programs that want to efficiently
4829 list a directory contents without making many round-trips.
4830 See also C<guestfs_lxattrlist> for a similarly efficient call
4831 for getting extended attributes. Very long directory listings
4832 might cause the protocol message size to be exceeded, causing
4833 this call to fail. The caller must split up such requests
4834 into smaller groups of names.");
4836 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4838 "lgetxattr on multiple files",
4840 This call allows you to get the extended attributes
4841 of multiple files, where all files are in the directory C<path>.
4842 C<names> is the list of files from this directory.
4844 On return you get a flat list of xattr structs which must be
4845 interpreted sequentially. The first xattr struct always has a zero-length
4846 C<attrname>. C<attrval> in this struct is zero-length
4847 to indicate there was an error doing C<lgetxattr> for this
4848 file, I<or> is a C string which is a decimal number
4849 (the number of following attributes for this file, which could
4850 be C<\"0\">). Then after the first xattr struct are the
4851 zero or more attributes for the first named file.
4852 This repeats for the second and subsequent files.
4854 This call is intended for programs that want to efficiently
4855 list a directory contents without making many round-trips.
4856 See also C<guestfs_lstatlist> for a similarly efficient call
4857 for getting standard stats. Very long directory listings
4858 might cause the protocol message size to be exceeded, causing
4859 this call to fail. The caller must split up such requests
4860 into smaller groups of names.");
4862 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4864 "readlink on multiple files",
4866 This call allows you to do a C<readlink> operation
4867 on multiple files, where all files are in the directory C<path>.
4868 C<names> is the list of files from this directory.
4870 On return you get a list of strings, with a one-to-one
4871 correspondence to the C<names> list. Each string is the
4872 value of the symbolic link.
4874 If the C<readlink(2)> operation fails on any name, then
4875 the corresponding result string is the empty string C<\"\">.
4876 However the whole operation is completed even if there
4877 were C<readlink(2)> errors, and so you can call this
4878 function with names where you don't know if they are
4879 symbolic links already (albeit slightly less efficient).
4881 This call is intended for programs that want to efficiently
4882 list a directory contents without making many round-trips.
4883 Very long directory listings might cause the protocol
4884 message size to be exceeded, causing
4885 this call to fail. The caller must split up such requests
4886 into smaller groups of names.");
4888 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4889 [InitISOFS, Always, TestOutputBuffer (
4890 [["pread"; "/known-4"; "1"; "3"]], "\n");
4891 InitISOFS, Always, TestOutputBuffer (
4892 [["pread"; "/empty"; "0"; "100"]], "")],
4893 "read part of a file",
4895 This command lets you read part of a file. It reads C<count>
4896 bytes of the file, starting at C<offset>, from file C<path>.
4898 This may read fewer bytes than requested. For further details
4899 see the L<pread(2)> system call.
4901 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4903 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4904 [InitEmpty, Always, TestRun (
4905 [["part_init"; "/dev/sda"; "gpt"]])],
4906 "create an empty partition table",
4908 This creates an empty partition table on C<device> of one of the
4909 partition types listed below. Usually C<parttype> should be
4910 either C<msdos> or C<gpt> (for large disks).
4912 Initially there are no partitions. Following this, you should
4913 call C<guestfs_part_add> for each partition required.
4915 Possible values for C<parttype> are:
4923 Intel EFI / GPT partition table.
4925 This is recommended for >= 2 TB partitions that will be accessed
4926 from Linux and Intel-based Mac OS X. It also has limited backwards
4927 compatibility with the C<mbr> format.
4933 The standard PC \"Master Boot Record\" (MBR) format used
4934 by MS-DOS and Windows. This partition type will B<only> work
4935 for device sizes up to 2 TB. For large disks we recommend
4940 Other partition table types that may work but are not
4953 Amiga \"Rigid Disk Block\" format.
4961 DASD, used on IBM mainframes.
4969 Old Mac partition format. Modern Macs use C<gpt>.
4973 NEC PC-98 format, common in Japan apparently.
4981 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4982 [InitEmpty, Always, TestRun (
4983 [["part_init"; "/dev/sda"; "mbr"];
4984 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4985 InitEmpty, Always, TestRun (
4986 [["part_init"; "/dev/sda"; "gpt"];
4987 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4988 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4989 InitEmpty, Always, TestRun (
4990 [["part_init"; "/dev/sda"; "mbr"];
4991 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4992 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4993 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4994 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4995 "add a partition to the device",
4997 This command adds a partition to C<device>. If there is no partition
4998 table on the device, call C<guestfs_part_init> first.
5000 The C<prlogex> parameter is the type of partition. Normally you
5001 should pass C<p> or C<primary> here, but MBR partition tables also
5002 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
5005 C<startsect> and C<endsect> are the start and end of the partition
5006 in I<sectors>. C<endsect> may be negative, which means it counts
5007 backwards from the end of the disk (C<-1> is the last sector).
5009 Creating a partition which covers the whole disk is not so easy.
5010 Use C<guestfs_part_disk> to do that.");
5012 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
5013 [InitEmpty, Always, TestRun (
5014 [["part_disk"; "/dev/sda"; "mbr"]]);
5015 InitEmpty, Always, TestRun (
5016 [["part_disk"; "/dev/sda"; "gpt"]])],
5017 "partition whole disk with a single primary partition",
5019 This command is simply a combination of C<guestfs_part_init>
5020 followed by C<guestfs_part_add> to create a single primary partition
5021 covering the whole disk.
5023 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
5024 but other possible values are described in C<guestfs_part_init>.");
5026 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
5027 [InitEmpty, Always, TestRun (
5028 [["part_disk"; "/dev/sda"; "mbr"];
5029 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
5030 "make a partition bootable",
5032 This sets the bootable flag on partition numbered C<partnum> on
5033 device C<device>. Note that partitions are numbered from 1.
5035 The bootable flag is used by some operating systems (notably
5036 Windows) to determine which partition to boot from. It is by
5037 no means universally recognized.");
5039 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
5040 [InitEmpty, Always, TestRun (
5041 [["part_disk"; "/dev/sda"; "gpt"];
5042 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
5043 "set partition name",
5045 This sets the partition name on partition numbered C<partnum> on
5046 device C<device>. Note that partitions are numbered from 1.
5048 The partition name can only be set on certain types of partition
5049 table. This works on C<gpt> but not on C<mbr> partitions.");
5051 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
5052 [], (* XXX Add a regression test for this. *)
5053 "list partitions on a device",
5055 This command parses the partition table on C<device> and
5056 returns the list of partitions found.
5058 The fields in the returned structure are:
5064 Partition number, counting from 1.
5068 Start of the partition I<in bytes>. To get sectors you have to
5069 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5073 End of the partition in bytes.
5077 Size of the partition in bytes.
5081 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5082 [InitEmpty, Always, TestOutput (
5083 [["part_disk"; "/dev/sda"; "gpt"];
5084 ["part_get_parttype"; "/dev/sda"]], "gpt")],
5085 "get the partition table type",
5087 This command examines the partition table on C<device> and
5088 returns the partition table type (format) being used.
5090 Common return values include: C<msdos> (a DOS/Windows style MBR
5091 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5092 values are possible, although unusual. See C<guestfs_part_init>
5095 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5096 [InitScratchFS, Always, TestOutputBuffer (
5097 [["fill"; "0x63"; "10"; "/fill"];
5098 ["read_file"; "/fill"]], "cccccccccc")],
5099 "fill a file with octets",
5101 This command creates a new file called C<path>. The initial
5102 content of the file is C<len> octets of C<c>, where C<c>
5103 must be a number in the range C<[0..255]>.
5105 To fill a file with zero bytes (sparsely), it is
5106 much more efficient to use C<guestfs_truncate_size>.
5107 To create a file with a pattern of repeating bytes
5108 use C<guestfs_fill_pattern>.");
5110 ("available", (RErr, [StringList "groups"], []), 216, [],
5111 [InitNone, Always, TestRun [["available"; ""]]],
5112 "test availability of some parts of the API",
5114 This command is used to check the availability of some
5115 groups of functionality in the appliance, which not all builds of
5116 the libguestfs appliance will be able to provide.
5118 The libguestfs groups, and the functions that those
5119 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5120 You can also fetch this list at runtime by calling
5121 C<guestfs_available_all_groups>.
5123 The argument C<groups> is a list of group names, eg:
5124 C<[\"inotify\", \"augeas\"]> would check for the availability of
5125 the Linux inotify functions and Augeas (configuration file
5128 The command returns no error if I<all> requested groups are available.
5130 It fails with an error if one or more of the requested
5131 groups is unavailable in the appliance.
5133 If an unknown group name is included in the
5134 list of groups then an error is always returned.
5142 You must call C<guestfs_launch> before calling this function.
5144 The reason is because we don't know what groups are
5145 supported by the appliance/daemon until it is running and can
5150 If a group of functions is available, this does not necessarily
5151 mean that they will work. You still have to check for errors
5152 when calling individual API functions even if they are
5157 It is usually the job of distro packagers to build
5158 complete functionality into the libguestfs appliance.
5159 Upstream libguestfs, if built from source with all
5160 requirements satisfied, will support everything.
5164 This call was added in version C<1.0.80>. In previous
5165 versions of libguestfs all you could do would be to speculatively
5166 execute a command to find out if the daemon implemented it.
5167 See also C<guestfs_version>.
5171 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5172 [InitScratchFS, Always, TestOutputBuffer (
5174 ["write"; "/dd/src"; "hello, world"];
5175 ["dd"; "/dd/src"; "/dd/dest"];
5176 ["read_file"; "/dd/dest"]], "hello, world")],
5177 "copy from source to destination using dd",
5179 This command copies from one source device or file C<src>
5180 to another destination device or file C<dest>. Normally you
5181 would use this to copy to or from a device or partition, for
5182 example to duplicate a filesystem.
5184 If the destination is a device, it must be as large or larger
5185 than the source file or device, otherwise the copy will fail.
5186 This command cannot do partial copies (see C<guestfs_copy_size>).");
5188 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5189 [InitScratchFS, Always, TestOutputInt (
5190 [["write"; "/filesize"; "hello, world"];
5191 ["filesize"; "/filesize"]], 12)],
5192 "return the size of the file in bytes",
5194 This command returns the size of C<file> in bytes.
5196 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5197 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5198 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5200 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5201 [InitBasicFSonLVM, Always, TestOutputList (
5202 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5203 ["lvs"]], ["/dev/VG/LV2"])],
5204 "rename an LVM logical volume",
5206 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5208 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5209 [InitBasicFSonLVM, Always, TestOutputList (
5211 ["vg_activate"; "false"; "VG"];
5212 ["vgrename"; "VG"; "VG2"];
5213 ["vg_activate"; "true"; "VG2"];
5214 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5215 ["vgs"]], ["VG2"])],
5216 "rename an LVM volume group",
5218 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5220 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5221 [InitISOFS, Always, TestOutputBuffer (
5222 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5223 "list the contents of a single file in an initrd",
5225 This command unpacks the file C<filename> from the initrd file
5226 called C<initrdpath>. The filename must be given I<without> the
5227 initial C</> character.
5229 For example, in guestfish you could use the following command
5230 to examine the boot script (usually called C</init>)
5231 contained in a Linux initrd or initramfs image:
5233 initrd-cat /boot/initrd-<version>.img init
5235 See also C<guestfs_initrd_list>.");
5237 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5239 "get the UUID of a physical volume",
5241 This command returns the UUID of the LVM PV C<device>.");
5243 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5245 "get the UUID of a volume group",
5247 This command returns the UUID of the LVM VG named C<vgname>.");
5249 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5251 "get the UUID of a logical volume",
5253 This command returns the UUID of the LVM LV C<device>.");
5255 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5257 "get the PV UUIDs containing the volume group",
5259 Given a VG called C<vgname>, this returns the UUIDs of all
5260 the physical volumes that this volume group resides on.
5262 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5263 calls to associate physical volumes and volume groups.
5265 See also C<guestfs_vglvuuids>.");
5267 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5269 "get the LV UUIDs of all LVs in the volume group",
5271 Given a VG called C<vgname>, this returns the UUIDs of all
5272 the logical volumes created in this volume group.
5274 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5275 calls to associate logical volumes and volume groups.
5277 See also C<guestfs_vgpvuuids>.");
5279 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5280 [InitScratchFS, Always, TestOutputBuffer (
5281 [["mkdir"; "/copy_size"];
5282 ["write"; "/copy_size/src"; "hello, world"];
5283 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5284 ["read_file"; "/copy_size/dest"]], "hello")],
5285 "copy size bytes from source to destination using dd",
5287 This command copies exactly C<size> bytes from one source device
5288 or file C<src> to another destination device or file C<dest>.
5290 Note this will fail if the source is too short or if the destination
5291 is not large enough.");
5293 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5294 [InitBasicFSonLVM, Always, TestRun (
5295 [["zero_device"; "/dev/VG/LV"]])],
5296 "write zeroes to an entire device",
5298 This command writes zeroes over the entire C<device>. Compare
5299 with C<guestfs_zero> which just zeroes the first few blocks of
5302 If blocks are already zero, then this command avoids writing
5303 zeroes. This prevents the underlying device from becoming non-sparse
5304 or growing unnecessarily.");
5306 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5307 [InitScratchFS, Always, TestOutput (
5308 [["mkdir"; "/txz_in"];
5309 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5310 ["cat"; "/txz_in/hello"]], "hello\n")],
5311 "unpack compressed tarball to directory",
5313 This command uploads and unpacks local file C<tarball> (an
5314 I<xz compressed> tar file) into C<directory>.");
5316 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5318 "pack directory into compressed tarball",
5320 This command packs the contents of C<directory> and downloads
5321 it to local file C<tarball> (as an xz compressed tar archive).");
5323 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5325 "resize an NTFS filesystem",
5327 This command resizes an NTFS filesystem, expanding or
5328 shrinking it to the size of the underlying device.
5330 I<Note:> After the resize operation, the filesystem is marked
5331 as requiring a consistency check (for safety). You have to boot
5332 into Windows to perform this check and clear this condition.
5333 Furthermore, ntfsresize refuses to resize filesystems
5334 which have been marked in this way. So in effect it is
5335 not possible to call ntfsresize multiple times on a single
5336 filesystem without booting into Windows between each resize.
5338 See also L<ntfsresize(8)>.");
5340 ("vgscan", (RErr, [], []), 232, [],
5341 [InitEmpty, Always, TestRun (
5343 "rescan for LVM physical volumes, volume groups and logical volumes",
5345 This rescans all block devices and rebuilds the list of LVM
5346 physical volumes, volume groups and logical volumes.");
5348 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5349 [InitEmpty, Always, TestRun (
5350 [["part_init"; "/dev/sda"; "mbr"];
5351 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5352 ["part_del"; "/dev/sda"; "1"]])],
5353 "delete a partition",
5355 This command deletes the partition numbered C<partnum> on C<device>.
5357 Note that in the case of MBR partitioning, deleting an
5358 extended partition also deletes any logical partitions
5361 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5362 [InitEmpty, Always, TestOutputTrue (
5363 [["part_init"; "/dev/sda"; "mbr"];
5364 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5365 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5366 ["part_get_bootable"; "/dev/sda"; "1"]])],
5367 "return true if a partition is bootable",
5369 This command returns true if the partition C<partnum> on
5370 C<device> has the bootable flag set.
5372 See also C<guestfs_part_set_bootable>.");
5374 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5375 [InitEmpty, Always, TestOutputInt (
5376 [["part_init"; "/dev/sda"; "mbr"];
5377 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5378 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5379 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5380 "get the MBR type byte (ID byte) from a partition",
5382 Returns the MBR type byte (also known as the ID byte) from
5383 the numbered partition C<partnum>.
5385 Note that only MBR (old DOS-style) partitions have type bytes.
5386 You will get undefined results for other partition table
5387 types (see C<guestfs_part_get_parttype>).");
5389 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5390 [], (* tested by part_get_mbr_id *)
5391 "set the MBR type byte (ID byte) of a partition",
5393 Sets the MBR type byte (also known as the ID byte) of
5394 the numbered partition C<partnum> to C<idbyte>. Note
5395 that the type bytes quoted in most documentation are
5396 in fact hexadecimal numbers, but usually documented
5397 without any leading \"0x\" which might be confusing.
5399 Note that only MBR (old DOS-style) partitions have type bytes.
5400 You will get undefined results for other partition table
5401 types (see C<guestfs_part_get_parttype>).");
5403 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5404 [InitISOFS, Always, TestOutputFileMD5 (
5405 [["checksum_device"; "md5"; "/dev/sdd"]],
5406 "../images/test.iso")],
5407 "compute MD5, SHAx or CRC checksum of the contents of a device",
5409 This call computes the MD5, SHAx or CRC checksum of the
5410 contents of the device named C<device>. For the types of
5411 checksums supported see the C<guestfs_checksum> command.");
5413 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5414 [InitNone, Always, TestRun (
5415 [["part_disk"; "/dev/sda"; "mbr"];
5416 ["pvcreate"; "/dev/sda1"];
5417 ["vgcreate"; "VG"; "/dev/sda1"];
5418 ["lvcreate"; "LV"; "VG"; "10"];
5419 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5420 "expand an LV to fill free space",
5422 This expands an existing logical volume C<lv> so that it fills
5423 C<pc>% of the remaining free space in the volume group. Commonly
5424 you would call this with pc = 100 which expands the logical volume
5425 as much as possible, using all remaining free space in the volume
5428 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5429 [], (* XXX Augeas code needs tests. *)
5430 "clear Augeas path",
5432 Set the value associated with C<path> to C<NULL>. This
5433 is the same as the L<augtool(1)> C<clear> command.");
5435 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5436 [InitEmpty, Always, TestOutputInt (
5437 [["get_umask"]], 0o22)],
5438 "get the current umask",
5440 Return the current umask. By default the umask is C<022>
5441 unless it has been set by calling C<guestfs_umask>.");
5443 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5445 "upload a file to the appliance (internal use only)",
5447 The C<guestfs_debug_upload> command uploads a file to
5448 the libguestfs appliance.
5450 There is no comprehensive help for this command. You have
5451 to look at the file C<daemon/debug.c> in the libguestfs source
5452 to find out what it is for.");
5454 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5455 [InitScratchFS, Always, TestOutput (
5456 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5457 ["cat"; "/base64_in"]], "hello\n")],
5458 "upload base64-encoded data to file",
5460 This command uploads base64-encoded data from C<base64file>
5463 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5465 "download file and encode as base64",
5467 This command downloads the contents of C<filename>, writing
5468 it out to local file C<base64file> encoded as base64.");
5470 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5472 "compute MD5, SHAx or CRC checksum of files in a directory",
5474 This command computes the checksums of all regular files in
5475 C<directory> and then emits a list of those checksums to
5476 the local output file C<sumsfile>.
5478 This can be used for verifying the integrity of a virtual
5479 machine. However to be properly secure you should pay
5480 attention to the output of the checksum command (it uses
5481 the ones from GNU coreutils). In particular when the
5482 filename is not printable, coreutils uses a special
5483 backslash syntax. For more information, see the GNU
5484 coreutils info file.");
5486 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5487 [InitScratchFS, Always, TestOutputBuffer (
5488 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5489 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5490 "fill a file with a repeating pattern of bytes",
5492 This function is like C<guestfs_fill> except that it creates
5493 a new file of length C<len> containing the repeating pattern
5494 of bytes in C<pattern>. The pattern is truncated if necessary
5495 to ensure the length of the file is exactly C<len> bytes.");
5497 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5498 [InitScratchFS, Always, TestOutput (
5499 [["write"; "/write"; "new file contents"];
5500 ["cat"; "/write"]], "new file contents");
5501 InitScratchFS, Always, TestOutput (
5502 [["write"; "/write2"; "\nnew file contents\n"];
5503 ["cat"; "/write2"]], "\nnew file contents\n");
5504 InitScratchFS, Always, TestOutput (
5505 [["write"; "/write3"; "\n\n"];
5506 ["cat"; "/write3"]], "\n\n");
5507 InitScratchFS, Always, TestOutput (
5508 [["write"; "/write4"; ""];
5509 ["cat"; "/write4"]], "");
5510 InitScratchFS, Always, TestOutput (
5511 [["write"; "/write5"; "\n\n\n"];
5512 ["cat"; "/write5"]], "\n\n\n");
5513 InitScratchFS, Always, TestOutput (
5514 [["write"; "/write6"; "\n"];
5515 ["cat"; "/write6"]], "\n")],
5516 "create a new file",
5518 This call creates a file called C<path>. The content of the
5519 file is the string C<content> (which can contain any 8 bit data).
5521 See also C<guestfs_write_append>.");
5523 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5524 [InitScratchFS, Always, TestOutput (
5525 [["write"; "/pwrite"; "new file contents"];
5526 ["pwrite"; "/pwrite"; "data"; "4"];
5527 ["cat"; "/pwrite"]], "new data contents");
5528 InitScratchFS, Always, TestOutput (
5529 [["write"; "/pwrite2"; "new file contents"];
5530 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5531 ["cat"; "/pwrite2"]], "new file is extended");
5532 InitScratchFS, Always, TestOutput (
5533 [["write"; "/pwrite3"; "new file contents"];
5534 ["pwrite"; "/pwrite3"; ""; "4"];
5535 ["cat"; "/pwrite3"]], "new file contents")],
5536 "write to part of a file",
5538 This command writes to part of a file. It writes the data
5539 buffer C<content> to the file C<path> starting at offset C<offset>.
5541 This command implements the L<pwrite(2)> system call, and like
5542 that system call it may not write the full data requested. The
5543 return value is the number of bytes that were actually written
5544 to the file. This could even be 0, although short writes are
5545 unlikely for regular files in ordinary circumstances.
5547 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5549 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5551 "resize an ext2, ext3 or ext4 filesystem (with size)",
5553 This command is the same as C<guestfs_resize2fs> except that it
5554 allows you to specify the new size (in bytes) explicitly.");
5556 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5558 "resize an LVM physical volume (with size)",
5560 This command is the same as C<guestfs_pvresize> except that it
5561 allows you to specify the new size (in bytes) explicitly.");
5563 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5565 "resize an NTFS filesystem (with size)",
5567 This command is the same as C<guestfs_ntfsresize> except that it
5568 allows you to specify the new size (in bytes) explicitly.");
5570 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5571 [InitNone, Always, TestRun [["available_all_groups"]]],
5572 "return a list of all optional groups",
5574 This command returns a list of all optional groups that this
5575 daemon knows about. Note this returns both supported and unsupported
5576 groups. To find out which ones the daemon can actually support
5577 you have to call C<guestfs_available> on each member of the
5580 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5582 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5583 [InitScratchFS, Always, TestOutputStruct (
5584 [["fallocate64"; "/fallocate64"; "1000000"];
5585 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5586 "preallocate a file in the guest filesystem",
5588 This command preallocates a file (containing zero bytes) named
5589 C<path> of size C<len> bytes. If the file exists already, it
5592 Note that this call allocates disk blocks for the file.
5593 To create a sparse file use C<guestfs_truncate_size> instead.
5595 The deprecated call C<guestfs_fallocate> does the same,
5596 but owing to an oversight it only allowed 30 bit lengths
5597 to be specified, effectively limiting the maximum size
5598 of files created through that call to 1GB.
5600 Do not confuse this with the guestfish-specific
5601 C<alloc> and C<sparse> commands which create
5602 a file in the host and attach it as a device.");
5604 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5605 [InitBasicFS, Always, TestOutput (
5606 [["set_e2label"; "/dev/sda1"; "LTEST"];
5607 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5608 "get the filesystem label",
5610 This returns the filesystem label of the filesystem on
5613 If the filesystem is unlabeled, this returns the empty string.
5615 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5617 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5618 (let uuid = uuidgen () in
5619 [InitBasicFS, Always, TestOutput (
5620 [["set_e2uuid"; "/dev/sda1"; uuid];
5621 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5622 "get the filesystem UUID",
5624 This returns the filesystem UUID of the filesystem on
5627 If the filesystem does not have a UUID, this returns the empty string.
5629 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5631 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5632 (* Can't be tested with the current framework because
5633 * the VG is being used by the mounted filesystem, so
5634 * the vgchange -an command we do first will fail.
5637 "set LVM device filter",
5639 This sets the LVM device filter so that LVM will only be
5640 able to \"see\" the block devices in the list C<devices>,
5641 and will ignore all other attached block devices.
5643 Where disk image(s) contain duplicate PVs or VGs, this
5644 command is useful to get LVM to ignore the duplicates, otherwise
5645 LVM can get confused. Note also there are two types
5646 of duplication possible: either cloned PVs/VGs which have
5647 identical UUIDs; or VGs that are not cloned but just happen
5648 to have the same name. In normal operation you cannot
5649 create this situation, but you can do it outside LVM, eg.
5650 by cloning disk images or by bit twiddling inside the LVM
5653 This command also clears the LVM cache and performs a volume
5656 You can filter whole block devices or individual partitions.
5658 You cannot use this if any VG is currently in use (eg.
5659 contains a mounted filesystem), even if you are not
5660 filtering out that VG.");
5662 ("lvm_clear_filter", (RErr, [], []), 256, [],
5663 [], (* see note on lvm_set_filter *)
5664 "clear LVM device filter",
5666 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5667 will be able to see every block device.
5669 This command also clears the LVM cache and performs a volume
5672 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5674 "open a LUKS-encrypted block device",
5676 This command opens a block device which has been encrypted
5677 according to the Linux Unified Key Setup (LUKS) standard.
5679 C<device> is the encrypted block device or partition.
5681 The caller must supply one of the keys associated with the
5682 LUKS block device, in the C<key> parameter.
5684 This creates a new block device called C</dev/mapper/mapname>.
5685 Reads and writes to this block device are decrypted from and
5686 encrypted to the underlying C<device> respectively.
5688 If this block device contains LVM volume groups, then
5689 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5690 will make them visible.
5692 Use C<guestfs_list_dm_devices> to list all device mapper
5695 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5697 "open a LUKS-encrypted block device read-only",
5699 This is the same as C<guestfs_luks_open> except that a read-only
5700 mapping is created.");
5702 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5704 "close a LUKS device",
5706 This closes a LUKS device that was created earlier by
5707 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5708 C<device> parameter must be the name of the LUKS mapping
5709 device (ie. C</dev/mapper/mapname>) and I<not> the name
5710 of the underlying block device.");
5712 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5714 "format a block device as a LUKS encrypted device",
5716 This command erases existing data on C<device> and formats
5717 the device as a LUKS encrypted device. C<key> is the
5718 initial key, which is added to key slot C<slot>. (LUKS
5719 supports 8 key slots, numbered 0-7).");
5721 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5723 "format a block device as a LUKS encrypted device",
5725 This command is the same as C<guestfs_luks_format> but
5726 it also allows you to set the C<cipher> used.");
5728 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5730 "add a key on a LUKS encrypted device",
5732 This command adds a new key on LUKS device C<device>.
5733 C<key> is any existing key, and is used to access the device.
5734 C<newkey> is the new key to add. C<keyslot> is the key slot
5735 that will be replaced.
5737 Note that if C<keyslot> already contains a key, then this
5738 command will fail. You have to use C<guestfs_luks_kill_slot>
5739 first to remove that key.");
5741 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5743 "remove a key from a LUKS encrypted device",
5745 This command deletes the key in key slot C<keyslot> from the
5746 encrypted LUKS device C<device>. C<key> must be one of the
5749 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5750 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5751 [["is_lv"; "/dev/VG/LV"]]);
5752 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5753 [["is_lv"; "/dev/sda1"]])],
5754 "test if device is a logical volume",
5756 This command tests whether C<device> is a logical volume, and
5757 returns true iff this is the case.");
5759 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5761 "find a filesystem by UUID",
5763 This command searches the filesystems and returns the one
5764 which has the given UUID. An error is returned if no such
5765 filesystem can be found.
5767 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5769 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5771 "find a filesystem by label",
5773 This command searches the filesystems and returns the one
5774 which has the given label. An error is returned if no such
5775 filesystem can be found.
5777 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5779 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5780 [InitISOFS, Always, TestOutputFalse (
5781 [["is_chardev"; "/directory"]]);
5782 InitScratchFS, Always, TestOutputTrue (
5783 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5784 ["is_chardev"; "/is_chardev"]])],
5785 "test if character device",
5787 This returns C<true> if and only if there is a character device
5788 with the given C<path> name.
5790 See also C<guestfs_stat>.");
5792 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5793 [InitISOFS, Always, TestOutputFalse (
5794 [["is_blockdev"; "/directory"]]);
5795 InitScratchFS, Always, TestOutputTrue (
5796 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5797 ["is_blockdev"; "/is_blockdev"]])],
5798 "test if block device",
5800 This returns C<true> if and only if there is a block device
5801 with the given C<path> name.
5803 See also C<guestfs_stat>.");
5805 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5806 [InitISOFS, Always, TestOutputFalse (
5807 [["is_fifo"; "/directory"]]);
5808 InitScratchFS, Always, TestOutputTrue (
5809 [["mkfifo"; "0o777"; "/is_fifo"];
5810 ["is_fifo"; "/is_fifo"]])],
5811 "test if FIFO (named pipe)",
5813 This returns C<true> if and only if there is a FIFO (named pipe)
5814 with the given C<path> name.
5816 See also C<guestfs_stat>.");
5818 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5819 [InitISOFS, Always, TestOutputFalse (
5820 [["is_symlink"; "/directory"]]);
5821 InitISOFS, Always, TestOutputTrue (
5822 [["is_symlink"; "/abssymlink"]])],
5823 "test if symbolic link",
5825 This returns C<true> if and only if there is a symbolic link
5826 with the given C<path> name.
5828 See also C<guestfs_stat>.");
5830 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5831 (* XXX Need a positive test for sockets. *)
5832 [InitISOFS, Always, TestOutputFalse (
5833 [["is_socket"; "/directory"]])],
5836 This returns C<true> if and only if there is a Unix domain socket
5837 with the given C<path> name.
5839 See also C<guestfs_stat>.");
5841 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5842 [InitPartition, Always, TestOutputDevice (
5843 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5844 InitEmpty, Always, TestLastFail (
5845 [["part_to_dev"; "/dev/sda"]])],
5846 "convert partition name to device name",
5848 This function takes a partition name (eg. \"/dev/sdb1\") and
5849 removes the partition number, returning the device name
5852 The named partition must exist, for example as a string returned
5853 from C<guestfs_list_partitions>.");
5855 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5856 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5857 [InitScratchFS, Always, TestOutput (
5858 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5859 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5860 "upload a file from the local machine with offset",
5862 Upload local file C<filename> to C<remotefilename> on the
5865 C<remotefilename> is overwritten starting at the byte C<offset>
5866 specified. The intention is to overwrite parts of existing
5867 files or devices, although if a non-existant file is specified
5868 then it is created with a \"hole\" before C<offset>. The
5869 size of the data written is implicit in the size of the
5872 Note that there is no limit on the amount of data that
5873 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5874 and this call always writes the full amount unless an
5877 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5879 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5880 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5881 let offset = string_of_int 100 in
5882 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5883 [InitScratchFS, Always, TestOutput (
5884 (* Pick a file from cwd which isn't likely to change. *)
5885 [["mkdir"; "/download_offset"];
5886 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5887 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5888 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5889 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5890 "download a file to the local machine with offset and size",
5892 Download file C<remotefilename> and save it as C<filename>
5893 on the local machine.
5895 C<remotefilename> is read for C<size> bytes starting at C<offset>
5896 (this region must be within the file or device).
5898 Note that there is no limit on the amount of data that
5899 can be downloaded with this call, unlike with C<guestfs_pread>,
5900 and this call always reads the full amount unless an
5903 See also C<guestfs_download>, C<guestfs_pread>.");
5905 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5906 [InitPartition, Always, TestOutputListOfDevices (
5907 [["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"];
5908 ["blockdev_rereadpt"; "/dev/sda"];
5909 ["list_partitions"]], ["/dev/sdb1"])],
5910 "write to part of a device",
5912 This command writes to part of a device. It writes the data
5913 buffer C<content> to C<device> starting at offset C<offset>.
5915 This command implements the L<pwrite(2)> system call, and like
5916 that system call it may not write the full data requested
5917 (although short writes to disk devices and partitions are
5918 probably impossible with standard Linux kernels).
5920 See also C<guestfs_pwrite>.");
5922 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5923 [InitEmpty, Always, TestOutputBuffer (
5924 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5925 "read part of a device",
5927 This command lets you read part of a file. It reads C<count>
5928 bytes of C<device>, starting at C<offset>.
5930 This may read fewer bytes than requested. For further details
5931 see the L<pread(2)> system call.
5933 See also C<guestfs_pread>.");
5935 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5936 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5937 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5938 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5939 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5940 "get canonical name of an LV",
5942 This converts alternative naming schemes for LVs that you
5943 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5944 is converted to C</dev/VG/LV>.
5946 This command returns an error if the C<lvname> parameter does
5947 not refer to a logical volume.
5949 See also C<guestfs_is_lv>.");
5951 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
5952 [InitEmpty, Always, TestOutput (
5953 [["part_disk"; "/dev/sda"; "mbr"];
5954 ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
5955 ["mount_options"; ""; "/dev/sda1"; "/"];
5956 ["write"; "/new"; "new file contents"];
5957 ["cat"; "/new"]], "new file contents")],
5958 "make a filesystem",
5960 This function creates a filesystem on C<device>. The filesystem
5961 type is C<fstype>, for example C<ext3>.
5963 The optional arguments are:
5969 The filesystem block size. Supported block sizes depend on the
5970 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5971 for Linux ext2/3 filesystems.
5973 For VFAT and NTFS the C<blocksize> parameter is treated as
5974 the requested cluster size.
5976 For UFS block sizes, please see L<mkfs.ufs(8)>.
5980 This passes the I<-O> parameter to the external mkfs program.
5982 For certain filesystem types, this allows extra filesystem
5983 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5986 You cannot use this optional parameter with the C<gfs> or
5987 C<gfs2> filesystem type.
5991 This passes the I<-I> parameter to the external L<mke2fs(8)> program
5992 which sets the inode size (only for ext2/3/4 filesystems at present).
5996 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
5997 which sets sector size for ufs filesystem.
6001 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
6003 "get a single extended attribute",
6005 Get a single extended attribute from file C<path> named C<name>.
6006 This call follows symlinks. If you want to lookup an extended
6007 attribute for the symlink itself, use C<guestfs_lgetxattr>.
6009 Normally it is better to get all extended attributes from a file
6010 in one go by calling C<guestfs_getxattrs>. However some Linux
6011 filesystem implementations are buggy and do not provide a way to
6012 list out attributes. For these filesystems (notably ntfs-3g)
6013 you have to know the names of the extended attributes you want
6014 in advance and call this function.
6016 Extended attribute values are blobs of binary data. If there
6017 is no extended attribute named C<name>, this returns an error.
6019 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
6021 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
6023 "get a single extended attribute",
6025 Get a single extended attribute from file C<path> named C<name>.
6026 If C<path> is a symlink, then this call returns an extended
6027 attribute from the symlink.
6029 Normally it is better to get all extended attributes from a file
6030 in one go by calling C<guestfs_getxattrs>. However some Linux
6031 filesystem implementations are buggy and do not provide a way to
6032 list out attributes. For these filesystems (notably ntfs-3g)
6033 you have to know the names of the extended attributes you want
6034 in advance and call this function.
6036 Extended attribute values are blobs of binary data. If there
6037 is no extended attribute named C<name>, this returns an error.
6039 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
6041 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
6043 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
6045 This command is the same as C<guestfs_resize2fs>, but the filesystem
6046 is resized to its minimum size. This works like the I<-M> option
6047 to the C<resize2fs> command.
6049 To get the resulting size of the filesystem you should call
6050 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
6051 values. These two numbers, multiplied together, give the
6052 resulting size of the minimal filesystem in bytes.");
6054 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
6056 "internal autosync operation",
6058 This command performs the autosync operation just before the
6059 handle is closed. You should not call this command directly.
6060 Instead, use the autosync flag (C<guestfs_set_autosync>) to
6061 control whether or not this operation is performed when the
6062 handle is closed.");
6064 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6065 [InitISOFS, Always, TestOutputTrue (
6066 [["is_zero"; "/100kallzeroes"]]);
6067 InitISOFS, Always, TestOutputFalse (
6068 [["is_zero"; "/100kallspaces"]])],
6069 "test if a file contains all zero bytes",
6071 This returns true iff the file exists and the file is empty or
6072 it contains all zero bytes.");
6074 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6075 [InitBasicFS, Always, TestOutputTrue (
6076 [["umount"; "/dev/sda1"];
6077 ["zero_device"; "/dev/sda1"];
6078 ["is_zero_device"; "/dev/sda1"]]);
6079 InitBasicFS, Always, TestOutputFalse (
6080 [["is_zero_device"; "/dev/sda1"]])],
6081 "test if a device contains all zero bytes",
6083 This returns true iff the device exists and contains all zero bytes.
6085 Note that for large devices this can take a long time to run.");
6087 ("list_9p", (RStringList "mounttags", [], []), 285, [],
6089 "list 9p filesystems",
6091 List all 9p filesystems attached to the guest. A list of
6092 mount tags is returned.");
6094 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6096 "mount 9p filesystem",
6098 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6099 directory C<mountpoint>.
6101 If required, C<trans=virtio> will be automatically added to the options.
6102 Any other options required can be passed in the optional C<options>
6105 ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6107 "list device mapper devices",
6109 List all device mapper devices.
6111 The returned list contains C</dev/mapper/*> devices, eg. ones created
6112 by a previous call to C<guestfs_luks_open>.
6114 Device mapper devices which correspond to logical volumes are I<not>
6115 returned in this list. Call C<guestfs_lvs> if you want to list logical
6118 ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6120 "resize an NTFS filesystem",
6122 This command resizes an NTFS filesystem, expanding or
6123 shrinking it to the size of the underlying device.
6125 The optional parameters are:
6131 The new size (in bytes) of the filesystem. If omitted, the filesystem
6132 is resized to fit the container (eg. partition).
6136 If this option is true, then force the resize of the filesystem
6137 even if the filesystem is marked as requiring a consistency check.
6139 After the resize operation, the filesystem is always marked
6140 as requiring a consistency check (for safety). You have to boot
6141 into Windows to perform this check and clear this condition.
6142 If you I<don't> set the C<force> option then it is not
6143 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6144 single filesystem without booting into Windows between each resize.
6148 See also L<ntfsresize(8)>.");
6150 ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6152 "resize a btrfs filesystem",
6154 This command resizes a btrfs filesystem.
6156 Note that unlike other resize calls, the filesystem has to be
6157 mounted and the parameter is the mountpoint not the device
6158 (this is a requirement of btrfs itself).
6160 The optional parameters are:
6166 The new size (in bytes) of the filesystem. If omitted, the filesystem
6167 is resized to the maximum size.
6171 See also L<btrfs(8)>.");
6173 ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6174 [InitScratchFS, Always, TestOutput (
6175 [["write"; "/write_append"; "line1\n"];
6176 ["write_append"; "/write_append"; "line2\n"];
6177 ["write_append"; "/write_append"; "line3a"];
6178 ["write_append"; "/write_append"; "line3b\n"];
6179 ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6180 "append content to end of file",
6182 This call appends C<content> to the end of file C<path>. If
6183 C<path> does not exist, then a new file is created.
6185 See also C<guestfs_write>.");
6187 ("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [Int "level"]), 291, [],
6189 "output compressed file",
6191 This command compresses C<file> and writes it out to the local
6194 The compression program used is controlled by the C<ctype> parameter.
6195 Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.
6196 Some compression types may not be supported by particular builds of
6197 libguestfs, in which case you will get an error containing the
6198 substring \"not supported\".
6200 The optional C<level> parameter controls compression level. The
6201 meaning and default for this parameter depends on the compression
6202 program being used.");
6204 ("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [Int "level"]), 292, [],
6206 "output compressed device",
6208 This command compresses C<device> and writes it out to the local
6211 The C<ctype> and optional C<level> parameters have the same meaning
6212 as in C<guestfs_compress_out>.");
6216 let all_functions = non_daemon_functions @ daemon_functions
6218 (* In some places we want the functions to be displayed sorted
6219 * alphabetically, so this is useful:
6221 let all_functions_sorted = List.sort action_compare all_functions
6223 (* This is used to generate the src/MAX_PROC_NR file which
6224 * contains the maximum procedure number, a surrogate for the
6225 * ABI version number. See src/Makefile.am for the details.
6228 let proc_nrs = List.map (
6229 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6230 ) daemon_functions in
6231 List.fold_left max 0 proc_nrs
6233 (* Non-API meta-commands available only in guestfish.
6235 * Note (1): style, proc_nr and tests fields are all meaningless.
6236 * The only fields which are actually used are the shortname,
6237 * FishAlias flags, shortdesc and longdesc.
6239 * Note (2): to refer to other commands, use L</shortname>.
6241 * Note (3): keep this list sorted by shortname.
6243 let fish_commands = [
6244 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6245 "allocate and add a disk file",
6246 " alloc filename size
6248 This creates an empty (zeroed) file of the given size, and then adds
6249 so it can be further examined.
6251 For more advanced image creation, see L<qemu-img(1)> utility.
6253 Size can be specified using standard suffixes, eg. C<1M>.
6255 To create a sparse file, use L</sparse> instead. To create a
6256 prepared disk image, see L</PREPARED DISK IMAGES>.");
6258 ("copy_in", (RErr,[], []), -1, [], [],
6259 "copy local files or directories into an image",
6260 " copy-in local [local ...] /remotedir
6262 C<copy-in> copies local files or directories recursively into the disk
6263 image, placing them in the directory called C</remotedir> (which must
6264 exist). This guestfish meta-command turns into a sequence of
6265 L</tar-in> and other commands as necessary.
6267 Multiple local files and directories can be specified, but the last
6268 parameter must always be a remote directory. Wildcards cannot be
6271 ("copy_out", (RErr,[], []), -1, [], [],
6272 "copy remote files or directories out of an image",
6273 " copy-out remote [remote ...] localdir
6275 C<copy-out> copies remote files or directories recursively out of the
6276 disk image, placing them on the host disk in a local directory called
6277 C<localdir> (which must exist). This guestfish meta-command turns
6278 into a sequence of L</download>, L</tar-out> and other commands as
6281 Multiple remote files and directories can be specified, but the last
6282 parameter must always be a local directory. To download to the
6283 current directory, use C<.> as in:
6287 Wildcards cannot be used in the ordinary command, but you can use
6288 them with the help of L</glob> like this:
6290 glob copy-out /home/* .");
6292 ("display", (RErr,[], []), -1, [], [],
6296 Use C<display> (a graphical display program) to display an image
6297 file. It downloads the file, and runs C<display> on it.
6299 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6300 environment variable. For example to use the GNOME display program:
6302 export GUESTFISH_DISPLAY_IMAGE=eog
6304 See also L<display(1)>.");
6306 ("echo", (RErr,[], []), -1, [], [],
6307 "display a line of text",
6310 This echos the parameters to the terminal.");
6312 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6316 This is used to edit a file. It downloads the file, edits it
6317 locally using your editor, then uploads the result.
6319 The editor is C<$EDITOR>. However if you use the alternate
6320 commands C<vi> or C<emacs> you will get those corresponding
6323 ("glob", (RErr,[], []), -1, [], [],
6324 "expand wildcards in command",
6325 " glob command args...
6327 Expand wildcards in any paths in the args list, and run C<command>
6328 repeatedly on each matching path.
6330 See L</WILDCARDS AND GLOBBING>.");
6332 ("hexedit", (RErr,[], []), -1, [], [],
6333 "edit with a hex editor",
6334 " hexedit <filename|device>
6335 hexedit <filename|device> <max>
6336 hexedit <filename|device> <start> <max>
6338 Use hexedit (a hex editor) to edit all or part of a binary file
6341 This command works by downloading potentially the whole file or
6342 device, editing it locally, then uploading it. If the file or
6343 device is large, you have to specify which part you wish to edit
6344 by using C<max> and/or C<start> C<max> parameters.
6345 C<start> and C<max> are specified in bytes, with the usual
6346 modifiers allowed such as C<1M> (1 megabyte).
6348 For example to edit the first few sectors of a disk you
6353 which would allow you to edit anywhere within the first megabyte
6356 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6358 hexedit /dev/sda1 0x400 0x400
6360 (assuming the superblock is in the standard location).
6362 This command requires the external L<hexedit(1)> program. You
6363 can specify another program to use by setting the C<HEXEDITOR>
6364 environment variable.
6366 See also L</hexdump>.");
6368 ("lcd", (RErr,[], []), -1, [], [],
6369 "change working directory",
6372 Change the local directory, ie. the current directory of guestfish
6375 Note that C<!cd> won't do what you might expect.");
6377 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6381 Opens the manual page for guestfish.");
6383 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6389 This is used to view a file.
6391 The default viewer is C<$PAGER>. However if you use the alternate
6392 command C<less> you will get the C<less> command specifically.");
6394 ("reopen", (RErr,[], []), -1, [], [],
6395 "close and reopen libguestfs handle",
6398 Close and reopen the libguestfs handle. It is not necessary to use
6399 this normally, because the handle is closed properly when guestfish
6400 exits. However this is occasionally useful for testing.");
6402 ("setenv", (RErr,[], []), -1, [], [],
6403 "set an environment variable",
6406 Set the environment variable C<VAR> to the string C<value>.
6408 To print the value of an environment variable use a shell command
6413 ("sparse", (RErr,[], []), -1, [], [],
6414 "create a sparse disk image and add",
6415 " sparse filename size
6417 This creates an empty sparse file of the given size, and then adds
6418 so it can be further examined.
6420 In all respects it works the same as the L</alloc> command, except that
6421 the image file is allocated sparsely, which means that disk blocks are
6422 not assigned to the file until they are needed. Sparse disk files
6423 only use space when written to, but they are slower and there is a
6424 danger you could run out of real disk space during a write operation.
6426 For more advanced image creation, see L<qemu-img(1)> utility.
6428 Size can be specified using standard suffixes, eg. C<1M>.");
6430 ("supported", (RErr,[], []), -1, [], [],
6431 "list supported groups of commands",
6434 This command returns a list of the optional groups
6435 known to the daemon, and indicates which ones are
6436 supported by this build of the libguestfs appliance.
6438 See also L<guestfs(3)/AVAILABILITY>.");
6440 ("time", (RErr,[], []), -1, [], [],
6441 "print elapsed time taken to run a command",
6442 " time command args...
6444 Run the command as usual, but print the elapsed time afterwards. This
6445 can be useful for benchmarking operations.");
6447 ("unsetenv", (RErr,[], []), -1, [], [],
6448 "unset an environment variable",
6451 Remove C<VAR> from the environment.");