2 * Copyright (C) 2009-2011 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"; Progress],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish; DeprecatedBy "launch"],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter I<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form I<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to make filesystems consistent and synchronized
286 when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages.
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
308 Verbose messages are normally sent to C<stderr>, unless you
309 register a callback to send them somewhere else (see
310 C<guestfs_set_event_callback>).");
312 ("get_verbose", (RBool "verbose", [], []), -1, [],
316 This returns the verbose messages flag.");
318 ("is_ready", (RBool "ready", [], []), -1, [],
319 [InitNone, Always, TestOutputTrue (
321 "is ready to accept commands",
323 This returns true iff this handle is ready to accept commands
324 (in the C<READY> state).
326 For more information on states, see L<guestfs(3)>.");
328 ("is_config", (RBool "config", [], []), -1, [],
329 [InitNone, Always, TestOutputFalse (
331 "is in configuration state",
333 This returns true iff this handle is being configured
334 (in the C<CONFIG> state).
336 For more information on states, see L<guestfs(3)>.");
338 ("is_launching", (RBool "launching", [], []), -1, [],
339 [InitNone, Always, TestOutputFalse (
340 [["is_launching"]])],
341 "is launching subprocess",
343 This returns true iff this handle is launching the subprocess
344 (in the C<LAUNCHING> state).
346 For more information on states, see L<guestfs(3)>.");
348 ("is_busy", (RBool "busy", [], []), -1, [],
349 [InitNone, Always, TestOutputFalse (
351 "is busy processing a command",
353 This returns true iff this handle is busy processing a command
354 (in the C<BUSY> state).
356 For more information on states, see L<guestfs(3)>.");
358 ("get_state", (RInt "state", [], []), -1, [],
360 "get the current state",
362 This returns the current state as an opaque integer. This is
363 only useful for printing debug and internal error messages.
365 For more information on states, see L<guestfs(3)>.");
367 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
368 [InitNone, Always, TestOutputInt (
369 [["set_memsize"; "500"];
370 ["get_memsize"]], 500)],
371 "set memory allocated to the qemu subprocess",
373 This sets the memory size in megabytes allocated to the
374 qemu subprocess. This only has any effect if called before
377 You can also change this by setting the environment
378 variable C<LIBGUESTFS_MEMSIZE> before the handle is
381 For more information on the architecture of libguestfs,
382 see L<guestfs(3)>.");
384 ("get_memsize", (RInt "memsize", [], []), -1, [],
385 [InitNone, Always, TestOutputIntOp (
386 [["get_memsize"]], ">=", 256)],
387 "get memory allocated to the qemu subprocess",
389 This gets the memory size in megabytes allocated to the
392 If C<guestfs_set_memsize> was not called
393 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
394 then this returns the compiled-in default value for memsize.
396 For more information on the architecture of libguestfs,
397 see L<guestfs(3)>.");
399 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
400 [InitNone, Always, TestOutputIntOp (
401 [["get_pid"]], ">=", 1)],
402 "get PID of qemu subprocess",
404 Return the process ID of the qemu subprocess. If there is no
405 qemu subprocess, then this will return an error.
407 This is an internal call used for debugging and testing.");
409 ("version", (RStruct ("version", "version"), [], []), -1, [],
410 [InitNone, Always, TestOutputStruct (
411 [["version"]], [CompareWithInt ("major", 1)])],
412 "get the library version number",
414 Return the libguestfs version number that the program is linked
417 Note that because of dynamic linking this is not necessarily
418 the version of libguestfs that you compiled against. You can
419 compile the program, and then at runtime dynamically link
420 against a completely different C<libguestfs.so> library.
422 This call was added in version C<1.0.58>. In previous
423 versions of libguestfs there was no way to get the version
424 number. From C code you can use dynamic linker functions
425 to find out if this symbol exists (if it doesn't, then
426 it's an earlier version).
428 The call returns a structure with four elements. The first
429 three (C<major>, C<minor> and C<release>) are numbers and
430 correspond to the usual version triplet. The fourth element
431 (C<extra>) is a string and is normally empty, but may be
432 used for distro-specific information.
434 To construct the original version string:
435 C<$major.$minor.$release$extra>
437 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
439 I<Note:> Don't use this call to test for availability
440 of features. In enterprise distributions we backport
441 features from later versions into earlier versions,
442 making this an unreliable way to test for features.
443 Use C<guestfs_available> instead.");
445 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
446 [InitNone, Always, TestOutputTrue (
447 [["set_selinux"; "true"];
449 "set SELinux enabled or disabled at appliance boot",
451 This sets the selinux flag that is passed to the appliance
452 at boot time. The default is C<selinux=0> (disabled).
454 Note that if SELinux is enabled, it is always in
455 Permissive mode (C<enforcing=0>).
457 For more information on the architecture of libguestfs,
458 see L<guestfs(3)>.");
460 ("get_selinux", (RBool "selinux", [], []), -1, [],
462 "get SELinux enabled flag",
464 This returns the current setting of the selinux flag which
465 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
467 For more information on the architecture of libguestfs,
468 see L<guestfs(3)>.");
470 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
471 [InitNone, Always, TestOutputFalse (
472 [["set_trace"; "false"];
474 "enable or disable command traces",
476 If the command trace flag is set to 1, then libguestfs
477 calls, parameters and return values are traced.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.
486 Trace messages are normally sent to C<stderr>, unless you
487 register a callback to send them somewhere else (see
488 C<guestfs_set_event_callback>).");
490 ("get_trace", (RBool "trace", [], []), -1, [],
492 "get command trace enabled flag",
494 Return the command trace flag.");
496 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
497 [InitNone, Always, TestOutputFalse (
498 [["set_direct"; "false"];
500 "enable or disable direct appliance mode",
502 If the direct appliance mode flag is enabled, then stdin and
503 stdout are passed directly through to the appliance once it
506 One consequence of this is that log messages aren't caught
507 by the library and handled by C<guestfs_set_log_message_callback>,
508 but go straight to stdout.
510 You probably don't want to use this unless you know what you
513 The default is disabled.");
515 ("get_direct", (RBool "direct", [], []), -1, [],
517 "get direct appliance mode flag",
519 Return the direct appliance mode flag.");
521 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
522 [InitNone, Always, TestOutputTrue (
523 [["set_recovery_proc"; "true"];
524 ["get_recovery_proc"]])],
525 "enable or disable the recovery process",
527 If this is called with the parameter C<false> then
528 C<guestfs_launch> does not create a recovery process. The
529 purpose of the recovery process is to stop runaway qemu
530 processes in the case where the main program aborts abruptly.
532 This only has any effect if called before C<guestfs_launch>,
533 and the default is true.
535 About the only time when you would want to disable this is
536 if the main process will fork itself into the background
537 (\"daemonize\" itself). In this case the recovery process
538 thinks that the main program has disappeared and so kills
539 qemu, which is not very helpful.");
541 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
543 "get recovery process enabled flag",
545 Return the recovery process enabled flag.");
547 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
549 "add a drive specifying the QEMU block emulation to use",
551 This is the same as C<guestfs_add_drive> but it allows you
552 to specify the QEMU interface emulation to use at run time.");
554 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
556 "add a drive read-only specifying the QEMU block emulation to use",
558 This is the same as C<guestfs_add_drive_ro> but it allows you
559 to specify the QEMU interface emulation to use at run time.");
561 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
562 [InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-win32.exe"]], "i386");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-i586.so"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-sparc.so"]], "sparc");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-win32.dll"]], "i386");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
582 InitISOFS, Always, TestOutput (
583 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
584 InitISOFS, Always, TestOutput (
585 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
586 "detect the architecture of a binary file",
588 This detects the architecture of the binary C<filename>,
589 and returns it if known.
591 Currently defined architectures are:
597 This string is returned for all 32 bit i386, i486, i586, i686 binaries
598 irrespective of the precise processor requirements of the binary.
610 64 bit SPARC V9 and above.
626 Libguestfs may return other architecture strings in future.
628 The function works on at least the following types of files:
634 many types of Un*x and Linux binary
638 many types of Un*x and Linux shared library
642 Windows Win32 and Win64 binaries
646 Windows Win32 and Win64 DLLs
648 Win32 binaries and DLLs return C<i386>.
650 Win64 binaries and DLLs return C<x86_64>.
658 Linux new-style initrd images
662 some non-x86 Linux vmlinuz kernels
666 What it can't do currently:
672 static libraries (libfoo.a)
676 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
680 x86 Linux vmlinuz kernels
682 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
683 compressed code, and are horribly hard to unpack. If you want to find
684 the architecture of a kernel, use the architecture of the associated
685 initrd or kernel module(s) instead.
689 ("inspect_os", (RStringList "roots", [], []), -1, [],
691 "inspect disk and return list of operating systems found",
693 This function uses other libguestfs functions and certain
694 heuristics to inspect the disk(s) (usually disks belonging to
695 a virtual machine), looking for operating systems.
697 The list returned is empty if no operating systems were found.
699 If one operating system was found, then this returns a list with
700 a single element, which is the name of the root filesystem of
701 this operating system. It is also possible for this function
702 to return a list containing more than one element, indicating
703 a dual-boot or multi-boot virtual machine, with each element being
704 the root filesystem of one of the operating systems.
706 You can pass the root string(s) returned to other
707 C<guestfs_inspect_get_*> functions in order to query further
708 information about each operating system, such as the name
711 This function uses other libguestfs features such as
712 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
713 and unmount filesystems and look at the contents. This should
714 be called with no disks currently mounted. The function may also
715 use Augeas, so any existing Augeas handle will be closed.
717 This function cannot decrypt encrypted disks. The caller
718 must do that first (supplying the necessary keys) if the
721 Please read L<guestfs(3)/INSPECTION> for more details.
723 See also C<guestfs_list_filesystems>.");
725 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
727 "get type of inspected operating system",
729 This returns the type of the inspected operating system.
730 Currently defined types are:
736 Any Linux-based operating system.
740 Any Microsoft Windows operating system.
748 The operating system type could not be determined.
752 Future versions of libguestfs may return other strings here.
753 The caller should be prepared to handle any string.
755 Please read L<guestfs(3)/INSPECTION> for more details.");
757 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
759 "get architecture of inspected operating system",
761 This returns the architecture of the inspected operating system.
762 The possible return values are listed under
763 C<guestfs_file_architecture>.
765 If the architecture could not be determined, then the
766 string C<unknown> is returned.
768 Please read L<guestfs(3)/INSPECTION> for more details.");
770 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
772 "get distro of inspected operating system",
774 This returns the distro (distribution) of the inspected operating
777 Currently defined distros are:
817 =item \"redhat-based\"
819 Some Red Hat-derived distro.
823 Red Hat Enterprise Linux.
825 =item \"scientificlinux\"
843 The distro could not be determined.
847 Windows does not have distributions. This string is
848 returned if the OS type is Windows.
852 Future versions of libguestfs may return other strings here.
853 The caller should be prepared to handle any string.
855 Please read L<guestfs(3)/INSPECTION> for more details.");
857 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
859 "get major version of inspected operating system",
861 This returns the major version number of the inspected operating
864 Windows uses a consistent versioning scheme which is I<not>
865 reflected in the popular public names used by the operating system.
866 Notably the operating system known as \"Windows 7\" is really
867 version 6.1 (ie. major = 6, minor = 1). You can find out the
868 real versions corresponding to releases of Windows by consulting
871 If the version could not be determined, then C<0> is returned.
873 Please read L<guestfs(3)/INSPECTION> for more details.");
875 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
877 "get minor version of inspected operating system",
879 This returns the minor version number of the inspected operating
882 If the version could not be determined, then C<0> is returned.
884 Please read L<guestfs(3)/INSPECTION> for more details.
885 See also C<guestfs_inspect_get_major_version>.");
887 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
889 "get product name of inspected operating system",
891 This returns the product name of the inspected operating
892 system. The product name is generally some freeform string
893 which can be displayed to the user, but should not be
896 If the product name could not be determined, then the
897 string C<unknown> is returned.
899 Please read L<guestfs(3)/INSPECTION> for more details.");
901 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
903 "get mountpoints of inspected operating system",
905 This returns a hash of where we think the filesystems
906 associated with this operating system should be mounted.
907 Callers should note that this is at best an educated guess
908 made by reading configuration files such as C</etc/fstab>.
909 I<In particular note> that this may return filesystems
910 which are non-existent or not mountable and callers should
911 be prepared to handle or ignore failures if they try to
914 Each element in the returned hashtable has a key which
915 is the path of the mountpoint (eg. C</boot>) and a value
916 which is the filesystem that would be mounted there
919 Non-mounted devices such as swap devices are I<not>
920 returned in this list.
922 For operating systems like Windows which still use drive
923 letters, this call will only return an entry for the first
924 drive \"mounted on\" C</>. For information about the
925 mapping of drive letters to partitions, see
926 C<guestfs_inspect_get_drive_mappings>.
928 Please read L<guestfs(3)/INSPECTION> for more details.
929 See also C<guestfs_inspect_get_filesystems>.");
931 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
933 "get filesystems associated with inspected operating system",
935 This returns a list of all the filesystems that we think
936 are associated with this operating system. This includes
937 the root filesystem, other ordinary filesystems, and
938 non-mounted devices like swap partitions.
940 In the case of a multi-boot virtual machine, it is possible
941 for a filesystem to be shared between operating systems.
943 Please read L<guestfs(3)/INSPECTION> for more details.
944 See also C<guestfs_inspect_get_mountpoints>.");
946 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
948 "set enable network flag",
950 If C<network> is true, then the network is enabled in the
951 libguestfs appliance. The default is false.
953 This affects whether commands are able to access the network
954 (see L<guestfs(3)/RUNNING COMMANDS>).
956 You must call this before calling C<guestfs_launch>, otherwise
959 ("get_network", (RBool "network", [], []), -1, [],
961 "get enable network flag",
963 This returns the enable network flag.");
965 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
969 This inspection command looks for filesystems on partitions,
970 block devices and logical volumes, returning a list of devices
971 containing filesystems and their type.
973 The return value is a hash, where the keys are the devices
974 containing filesystems, and the values are the filesystem types.
977 \"/dev/sda1\" => \"ntfs\"
978 \"/dev/sda2\" => \"ext2\"
979 \"/dev/vg_guest/lv_root\" => \"ext4\"
980 \"/dev/vg_guest/lv_swap\" => \"swap\"
982 The value can have the special value \"unknown\", meaning the
983 content of the device is undetermined or empty.
984 \"swap\" means a Linux swap partition.
986 This command runs other libguestfs commands, which might include
987 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
988 use this soon after launch and only when nothing is mounted.
990 Not all of the filesystems returned will be mountable. In
991 particular, swap partitions are returned in the list. Also
992 this command does not check that each filesystem
993 found is valid and mountable, and some filesystems might
994 be mountable but require special options. Filesystems may
995 not all belong to a single logical operating system
996 (use C<guestfs_inspect_os> to look for OSes).");
998 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
1000 "add an image to examine or modify",
1002 This function adds a virtual machine disk image C<filename> to
1003 libguestfs. The first time you call this function, the disk
1004 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1007 You don't necessarily need to be root when using libguestfs. However
1008 you obviously do need sufficient permissions to access the filename
1009 for whatever operations you want to perform (ie. read access if you
1010 just want to read the image or write access if you want to modify the
1013 This call checks that C<filename> exists.
1015 The optional arguments are:
1021 If true then the image is treated as read-only. Writes are still
1022 allowed, but they are stored in a temporary snapshot overlay which
1023 is discarded at the end. The disk that you add is not modified.
1027 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1028 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1029 Possible formats include C<raw> and C<qcow2>.
1031 Automatic detection of the format opens you up to a potential
1032 security hole when dealing with untrusted raw-format images.
1033 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1038 This rarely-used option lets you emulate the behaviour of the
1039 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1043 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1045 "get Windows systemroot of inspected operating system",
1047 This returns the Windows systemroot of the inspected guest.
1048 The systemroot is a directory path such as C</WINDOWS>.
1050 This call assumes that the guest is Windows and that the
1051 systemroot could be determined by inspection. If this is not
1052 the case then an error is returned.
1054 Please read L<guestfs(3)/INSPECTION> for more details.");
1056 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1058 "return list of operating systems found by last inspection",
1060 This function is a convenient way to get the list of root
1061 devices, as returned from a previous call to C<guestfs_inspect_os>,
1062 but without redoing the whole inspection process.
1064 This returns an empty list if either no root devices were
1065 found or the caller has not called C<guestfs_inspect_os>.
1067 Please read L<guestfs(3)/INSPECTION> for more details.");
1069 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1071 "debug the QEMU command line (internal use only)",
1073 This returns the internal QEMU command line. 'debug' commands are
1074 not part of the formal API and can be removed or changed at any time.");
1076 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1078 "add the disk(s) from a named libvirt domain",
1080 This function adds the disk(s) attached to the named libvirt
1081 domain C<dom>. It works by connecting to libvirt, requesting
1082 the domain and domain XML from libvirt, parsing it for disks,
1083 and calling C<guestfs_add_drive_opts> on each one.
1085 The number of disks added is returned. This operation is atomic:
1086 if an error is returned, then no disks are added.
1088 This function does some minimal checks to make sure the libvirt
1089 domain is not running (unless C<readonly> is true). In a future
1090 version we will try to acquire the libvirt lock on each disk.
1092 Disks must be accessible locally. This often means that adding disks
1093 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1094 will fail unless those disks are accessible via the same device path
1097 The optional C<libvirturi> parameter sets the libvirt URI
1098 (see L<http://libvirt.org/uri.html>). If this is not set then
1099 we connect to the default libvirt URI (or one set through an
1100 environment variable, see the libvirt documentation for full
1103 The optional C<live> flag controls whether this call will try
1104 to connect to a running virtual machine C<guestfsd> process if
1105 it sees a suitable E<lt>channelE<gt> element in the libvirt
1106 XML definition. The default (if the flag is omitted) is never
1107 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1110 If the C<allowuuid> flag is true (default is false) then a UUID
1111 I<may> be passed instead of the domain name. The C<dom> string is
1112 treated as a UUID first and looked up, and if that lookup fails
1113 then we treat C<dom> as a name as usual.
1115 The other optional parameters are passed directly through to
1116 C<guestfs_add_drive_opts>.");
1119 This interface is not quite baked yet. -- RWMJ 2010-11-11
1120 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1122 "add the disk(s) from a libvirt domain",
1124 This function adds the disk(s) attached to the libvirt domain C<dom>.
1125 It works by requesting the domain XML from libvirt, parsing it for
1126 disks, and calling C<guestfs_add_drive_opts> on each one.
1128 In the C API we declare C<void *dom>, but really it has type
1129 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1131 The number of disks added is returned. This operation is atomic:
1132 if an error is returned, then no disks are added.
1134 This function does some minimal checks to make sure the libvirt
1135 domain is not running (unless C<readonly> is true). In a future
1136 version we will try to acquire the libvirt lock on each disk.
1138 Disks must be accessible locally. This often means that adding disks
1139 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1140 will fail unless those disks are accessible via the same device path
1143 The optional C<live> flag controls whether this call will try
1144 to connect to a running virtual machine C<guestfsd> process if
1145 it sees a suitable E<lt>channelE<gt> element in the libvirt
1146 XML definition. The default (if the flag is omitted) is never
1147 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1150 The other optional parameters are passed directly through to
1151 C<guestfs_add_drive_opts>.");
1154 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1156 "get package format used by the operating system",
1158 This function and C<guestfs_inspect_get_package_management> return
1159 the package format and package management tool used by the
1160 inspected operating system. For example for Fedora these
1161 functions would return C<rpm> (package format) and
1162 C<yum> (package management).
1164 This returns the string C<unknown> if we could not determine the
1165 package format I<or> if the operating system does not have
1166 a real packaging system (eg. Windows).
1168 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1169 Future versions of libguestfs may return other strings.
1171 Please read L<guestfs(3)/INSPECTION> for more details.");
1173 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1175 "get package management tool used by the operating system",
1177 C<guestfs_inspect_get_package_format> and this function return
1178 the package format and package management tool used by the
1179 inspected operating system. For example for Fedora these
1180 functions would return C<rpm> (package format) and
1181 C<yum> (package management).
1183 This returns the string C<unknown> if we could not determine the
1184 package management tool I<or> if the operating system does not have
1185 a real packaging system (eg. Windows).
1187 Possible strings include: C<yum>, C<up2date>,
1188 C<apt> (for all Debian derivatives),
1189 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1190 Future versions of libguestfs may return other strings.
1192 Please read L<guestfs(3)/INSPECTION> for more details.");
1194 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1196 "get list of applications installed in the operating system",
1198 Return the list of applications installed in the operating system.
1200 I<Note:> This call works differently from other parts of the
1201 inspection API. You have to call C<guestfs_inspect_os>, then
1202 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1203 before calling this. Listing applications is a significantly
1204 more difficult operation which requires access to the full
1205 filesystem. Also note that unlike the other
1206 C<guestfs_inspect_get_*> calls which are just returning
1207 data cached in the libguestfs handle, this call actually reads
1208 parts of the mounted filesystems during the call.
1210 This returns an empty list if the inspection code was not able
1211 to determine the list of applications.
1213 The application structure contains the following fields:
1219 The name of the application. For Red Hat-derived and Debian-derived
1220 Linux guests, this is the package name.
1222 =item C<app_display_name>
1224 The display name of the application, sometimes localized to the
1225 install language of the guest operating system.
1227 If unavailable this is returned as an empty string C<\"\">.
1228 Callers needing to display something can use C<app_name> instead.
1232 For package managers which use epochs, this contains the epoch of
1233 the package (an integer). If unavailable, this is returned as C<0>.
1235 =item C<app_version>
1237 The version string of the application or package. If unavailable
1238 this is returned as an empty string C<\"\">.
1240 =item C<app_release>
1242 The release string of the application or package, for package
1243 managers that use this. If unavailable this is returned as an
1244 empty string C<\"\">.
1246 =item C<app_install_path>
1248 The installation path of the application (on operating systems
1249 such as Windows which use installation paths). This path is
1250 in the format used by the guest operating system, it is not
1253 If unavailable this is returned as an empty string C<\"\">.
1255 =item C<app_trans_path>
1257 The install path translated into a libguestfs path.
1258 If unavailable this is returned as an empty string C<\"\">.
1260 =item C<app_publisher>
1262 The name of the publisher of the application, for package
1263 managers that use this. If unavailable this is returned
1264 as an empty string C<\"\">.
1268 The URL (eg. upstream URL) of the application.
1269 If unavailable this is returned as an empty string C<\"\">.
1271 =item C<app_source_package>
1273 For packaging systems which support this, the name of the source
1274 package. If unavailable this is returned as an empty string C<\"\">.
1276 =item C<app_summary>
1278 A short (usually one line) description of the application or package.
1279 If unavailable this is returned as an empty string C<\"\">.
1281 =item C<app_description>
1283 A longer description of the application or package.
1284 If unavailable this is returned as an empty string C<\"\">.
1288 Please read L<guestfs(3)/INSPECTION> for more details.");
1290 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1292 "get hostname of the operating system",
1294 This function returns the hostname of the operating system
1295 as found by inspection of the guest's configuration files.
1297 If the hostname could not be determined, then the
1298 string C<unknown> is returned.
1300 Please read L<guestfs(3)/INSPECTION> for more details.");
1302 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1304 "get format of inspected operating system",
1306 This returns the format of the inspected operating system. You
1307 can use it to detect install images, live CDs and similar.
1309 Currently defined formats are:
1315 This is an installed operating system.
1319 The disk image being inspected is not an installed operating system,
1320 but a I<bootable> install disk, live CD, or similar.
1324 The format of this disk image is not known.
1328 Future versions of libguestfs may return other strings here.
1329 The caller should be prepared to handle any string.
1331 Please read L<guestfs(3)/INSPECTION> for more details.");
1333 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1335 "get live flag for install disk",
1337 If C<guestfs_inspect_get_format> returns C<installer> (this
1338 is an install disk), then this returns true if a live image
1339 was detected on the disk.
1341 Please read L<guestfs(3)/INSPECTION> for more details.");
1343 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1345 "get netinst (network installer) flag for install disk",
1347 If C<guestfs_inspect_get_format> returns C<installer> (this
1348 is an install disk), then this returns true if the disk is
1349 a network installer, ie. not a self-contained install CD but
1350 one which is likely to require network access to complete
1353 Please read L<guestfs(3)/INSPECTION> for more details.");
1355 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1357 "get multipart flag for install disk",
1359 If C<guestfs_inspect_get_format> returns C<installer> (this
1360 is an install disk), then this returns true if the disk is
1363 Please read L<guestfs(3)/INSPECTION> for more details.");
1365 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1367 "set the attach method",
1369 Set the method that libguestfs uses to connect to the back end
1370 guestfsd daemon. Possible methods are:
1376 Launch an appliance and connect to it. This is the ordinary method
1379 =item C<unix:I<path>>
1381 Connect to the Unix domain socket I<path>.
1383 This method lets you connect to an existing daemon or (using
1384 virtio-serial) to a live guest. For more information, see
1385 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1389 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1390 [InitNone, Always, TestOutput (
1391 [["get_attach_method"]], "appliance")],
1392 "get the attach method",
1394 Return the current attach method. See C<guestfs_set_attach_method>.");
1396 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1398 "get product variant of inspected operating system",
1400 This returns the product variant of the inspected operating
1403 For Windows guests, this returns the contents of the Registry key
1404 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1405 C<InstallationType> which is usually a string such as
1406 C<Client> or C<Server> (other values are possible). This
1407 can be used to distinguish consumer and enterprise versions
1408 of Windows that have the same version number (for example,
1409 Windows 7 and Windows 2008 Server are both version 6.1,
1410 but the former is C<Client> and the latter is C<Server>).
1412 For enterprise Linux guests, in future we intend this to return
1413 the product variant such as C<Desktop>, C<Server> and so on. But
1414 this is not implemented at present.
1416 If the product variant could not be determined, then the
1417 string C<unknown> is returned.
1419 Please read L<guestfs(3)/INSPECTION> for more details.
1420 See also C<guestfs_inspect_get_product_name>,
1421 C<guestfs_inspect_get_major_version>.");
1423 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1425 "get Windows CurrentControlSet of inspected operating system",
1427 This returns the Windows CurrentControlSet of the inspected guest.
1428 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1430 This call assumes that the guest is Windows and that the
1431 Registry could be examined by inspection. If this is not
1432 the case then an error is returned.
1434 Please read L<guestfs(3)/INSPECTION> for more details.");
1436 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1438 "get drive letter mappings",
1440 This call is useful for Windows which uses a primitive system
1441 of assigning drive letters (like \"C:\") to partitions.
1442 This inspection API examines the Windows Registry to find out
1443 how disks/partitions are mapped to drive letters, and returns
1444 a hash table as in the example below:
1450 Note that keys are drive letters. For Windows, the key is
1451 case insensitive and just contains the drive letter, without
1452 the customary colon separator character.
1454 In future we may support other operating systems that also used drive
1455 letters, but the keys for those might not be case insensitive
1456 and might be longer than 1 character. For example in OS-9,
1457 hard drives were named C<h0>, C<h1> etc.
1459 For Windows guests, currently only hard drive mappings are
1460 returned. Removable disks (eg. DVD-ROMs) are ignored.
1462 For guests that do not use drive mappings, or if the drive mappings
1463 could not be determined, this returns an empty hash table.
1465 Please read L<guestfs(3)/INSPECTION> for more details.
1466 See also C<guestfs_inspect_get_mountpoints>,
1467 C<guestfs_inspect_get_filesystems>.");
1469 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1471 "get the icon corresponding to this operating system",
1473 This function returns an icon corresponding to the inspected
1474 operating system. The icon is returned as a buffer containing a
1475 PNG image (re-encoded to PNG if necessary).
1477 If it was not possible to get an icon this function returns a
1478 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1480 Libguestfs will start by looking for a file called
1481 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1482 and if it has the correct format, the contents of this file will
1483 be returned. You can disable favicons by passing the
1484 optional C<favicon> boolean as false (default is true).
1486 If finding the favicon fails, then we look in other places in the
1487 guest for a suitable icon.
1489 If the optional C<highquality> boolean is true then
1490 only high quality icons are returned, which means only icons of
1491 high resolution with an alpha channel. The default (false) is
1492 to return any icon we can, even if it is of substandard quality.
1500 Unlike most other inspection API calls, the guest's disks must be
1501 mounted up before you call this, since it needs to read information
1502 from the guest filesystem during the call.
1506 B<Security:> The icon data comes from the untrusted guest,
1507 and should be treated with caution. PNG files have been
1508 known to contain exploits. Ensure that libpng (or other relevant
1509 libraries) are fully up to date before trying to process or
1514 The PNG image returned can be any size. It might not be square.
1515 Libguestfs tries to return the largest, highest quality
1516 icon available. The application must scale the icon to the
1521 Extracting icons from Windows guests requires the external
1522 C<wrestool> program from the C<icoutils> package, and
1523 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1524 from the C<netpbm> package. These must be installed separately.
1528 Operating system icons are usually trademarks. Seek legal
1529 advice before using trademarks in applications.
1533 ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1535 "set process group flag",
1537 If C<pgroup> is true, child processes are placed into
1538 their own process group.
1540 The practical upshot of this is that signals like C<SIGINT> (from
1541 users pressing C<^C>) won't be received by the child process.
1543 The default for this flag is false, because usually you want
1544 C<^C> to kill the subprocess.");
1546 ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1548 "get process group flag",
1550 This returns the process group flag.");
1552 ("set_smp", (RErr, [Int "smp"], []), -1, [FishAlias "smp"],
1554 "set number of virtual CPUs in appliance",
1556 Change the number of virtual CPUs assigned to the appliance. The
1557 default is C<1>. Increasing this may improve performance, though
1558 often it has no effect.
1560 This function must be called before C<guestfs_launch>.");
1562 ("get_smp", (RInt "smp", [], []), -1, [],
1564 "get number of virtual CPUs in appliance",
1566 This returns the number of virtual CPUs assigned to the appliance.");
1570 (* daemon_functions are any functions which cause some action
1571 * to take place in the daemon.
1574 let daemon_functions = [
1575 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1576 [InitEmpty, Always, TestOutput (
1577 [["part_disk"; "/dev/sda"; "mbr"];
1578 ["mkfs"; "ext2"; "/dev/sda1"];
1579 ["mount"; "/dev/sda1"; "/"];
1580 ["write"; "/new"; "new file contents"];
1581 ["cat"; "/new"]], "new file contents")],
1582 "mount a guest disk at a position in the filesystem",
1584 Mount a guest disk at a position in the filesystem. Block devices
1585 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1586 the guest. If those block devices contain partitions, they will have
1587 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1590 The rules are the same as for L<mount(2)>: A filesystem must
1591 first be mounted on C</> before others can be mounted. Other
1592 filesystems can only be mounted on directories which already
1595 The mounted filesystem is writable, if we have sufficient permissions
1596 on the underlying device.
1598 Before libguestfs 1.13.16, this call implicitly added the options
1599 C<sync> and C<noatime>. The C<sync> option greatly slowed
1600 writes and caused many problems for users. If your program
1601 might need to work with older versions of libguestfs, use
1602 C<guestfs_mount_options> instead (using an empty string for the
1603 first parameter if you don't want any options).");
1605 ("sync", (RErr, [], []), 2, [],
1606 [ InitEmpty, Always, TestRun [["sync"]]],
1607 "sync disks, writes are flushed through to the disk image",
1609 This syncs the disk, so that any writes are flushed through to the
1610 underlying disk image.
1612 You should always call this if you have modified a disk image, before
1613 closing the handle.");
1615 ("touch", (RErr, [Pathname "path"], []), 3, [],
1616 [InitScratchFS, Always, TestOutputTrue (
1617 [["touch"; "/touch"];
1618 ["exists"; "/touch"]])],
1619 "update file timestamps or create a new file",
1621 Touch acts like the L<touch(1)> command. It can be used to
1622 update the timestamps on a file, or, if the file does not exist,
1623 to create a new zero-length file.
1625 This command only works on regular files, and will fail on other
1626 file types such as directories, symbolic links, block special etc.");
1628 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1629 [InitISOFS, Always, TestOutput (
1630 [["cat"; "/known-2"]], "abcdef\n")],
1631 "list the contents of a file",
1633 Return the contents of the file named C<path>.
1635 Note that this function cannot correctly handle binary files
1636 (specifically, files containing C<\\0> character which is treated
1637 as end of string). For those you need to use the C<guestfs_read_file>
1638 or C<guestfs_download> functions which have a more complex interface.");
1640 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1641 [], (* XXX Tricky to test because it depends on the exact format
1642 * of the 'ls -l' command, which changes between F10 and F11.
1644 "list the files in a directory (long format)",
1646 List the files in C<directory> (relative to the root directory,
1647 there is no cwd) in the format of 'ls -la'.
1649 This command is mostly useful for interactive sessions. It
1650 is I<not> intended that you try to parse the output string.");
1652 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1653 [InitScratchFS, Always, TestOutputList (
1655 ["touch"; "/ls/new"];
1656 ["touch"; "/ls/newer"];
1657 ["touch"; "/ls/newest"];
1658 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1659 "list the files in a directory",
1661 List the files in C<directory> (relative to the root directory,
1662 there is no cwd). The '.' and '..' entries are not returned, but
1663 hidden files are shown.
1665 This command is mostly useful for interactive sessions. Programs
1666 should probably use C<guestfs_readdir> instead.");
1668 ("list_devices", (RStringList "devices", [], []), 7, [],
1669 [InitEmpty, Always, TestOutputListOfDevices (
1670 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1671 "list the block devices",
1673 List all the block devices.
1675 The full block device names are returned, eg. C</dev/sda>.
1677 See also C<guestfs_list_filesystems>.");
1679 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1680 [InitBasicFS, Always, TestOutputListOfDevices (
1681 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1682 InitEmpty, Always, TestOutputListOfDevices (
1683 [["part_init"; "/dev/sda"; "mbr"];
1684 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1685 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1686 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1687 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1688 "list the partitions",
1690 List all the partitions detected on all block devices.
1692 The full partition device names are returned, eg. C</dev/sda1>
1694 This does not return logical volumes. For that you will need to
1695 call C<guestfs_lvs>.
1697 See also C<guestfs_list_filesystems>.");
1699 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1700 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1701 [["pvs"]], ["/dev/sda1"]);
1702 InitEmpty, Always, TestOutputListOfDevices (
1703 [["part_init"; "/dev/sda"; "mbr"];
1704 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1705 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1706 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1707 ["pvcreate"; "/dev/sda1"];
1708 ["pvcreate"; "/dev/sda2"];
1709 ["pvcreate"; "/dev/sda3"];
1710 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1711 "list the LVM physical volumes (PVs)",
1713 List all the physical volumes detected. This is the equivalent
1714 of the L<pvs(8)> command.
1716 This returns a list of just the device names that contain
1717 PVs (eg. C</dev/sda2>).
1719 See also C<guestfs_pvs_full>.");
1721 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1722 [InitBasicFSonLVM, Always, TestOutputList (
1724 InitEmpty, Always, TestOutputList (
1725 [["part_init"; "/dev/sda"; "mbr"];
1726 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1727 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1728 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1729 ["pvcreate"; "/dev/sda1"];
1730 ["pvcreate"; "/dev/sda2"];
1731 ["pvcreate"; "/dev/sda3"];
1732 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1733 ["vgcreate"; "VG2"; "/dev/sda3"];
1734 ["vgs"]], ["VG1"; "VG2"])],
1735 "list the LVM volume groups (VGs)",
1737 List all the volumes groups detected. This is the equivalent
1738 of the L<vgs(8)> command.
1740 This returns a list of just the volume group names that were
1741 detected (eg. C<VolGroup00>).
1743 See also C<guestfs_vgs_full>.");
1745 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1746 [InitBasicFSonLVM, Always, TestOutputList (
1747 [["lvs"]], ["/dev/VG/LV"]);
1748 InitEmpty, Always, TestOutputList (
1749 [["part_init"; "/dev/sda"; "mbr"];
1750 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1751 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1752 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1753 ["pvcreate"; "/dev/sda1"];
1754 ["pvcreate"; "/dev/sda2"];
1755 ["pvcreate"; "/dev/sda3"];
1756 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1757 ["vgcreate"; "VG2"; "/dev/sda3"];
1758 ["lvcreate"; "LV1"; "VG1"; "50"];
1759 ["lvcreate"; "LV2"; "VG1"; "50"];
1760 ["lvcreate"; "LV3"; "VG2"; "50"];
1761 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1762 "list the LVM logical volumes (LVs)",
1764 List all the logical volumes detected. This is the equivalent
1765 of the L<lvs(8)> command.
1767 This returns a list of the logical volume device names
1768 (eg. C</dev/VolGroup00/LogVol00>).
1770 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1772 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1773 [], (* XXX how to test? *)
1774 "list the LVM physical volumes (PVs)",
1776 List all the physical volumes detected. This is the equivalent
1777 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1779 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1780 [], (* XXX how to test? *)
1781 "list the LVM volume groups (VGs)",
1783 List all the volumes groups detected. This is the equivalent
1784 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1786 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1787 [], (* XXX how to test? *)
1788 "list the LVM logical volumes (LVs)",
1790 List all the logical volumes detected. This is the equivalent
1791 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1793 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1794 [InitISOFS, Always, TestOutputList (
1795 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1796 InitISOFS, Always, TestOutputList (
1797 [["read_lines"; "/empty"]], [])],
1798 "read file as lines",
1800 Return the contents of the file named C<path>.
1802 The file contents are returned as a list of lines. Trailing
1803 C<LF> and C<CRLF> character sequences are I<not> returned.
1805 Note that this function cannot correctly handle binary files
1806 (specifically, files containing C<\\0> character which is treated
1807 as end of line). For those you need to use the C<guestfs_read_file>
1808 function which has a more complex interface.");
1810 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1811 [], (* XXX Augeas code needs tests. *)
1812 "create a new Augeas handle",
1814 Create a new Augeas handle for editing configuration files.
1815 If there was any previous Augeas handle associated with this
1816 guestfs session, then it is closed.
1818 You must call this before using any other C<guestfs_aug_*>
1821 C<root> is the filesystem root. C<root> must not be NULL,
1824 The flags are the same as the flags defined in
1825 E<lt>augeas.hE<gt>, the logical I<or> of the following
1830 =item C<AUG_SAVE_BACKUP> = 1
1832 Keep the original file with a C<.augsave> extension.
1834 =item C<AUG_SAVE_NEWFILE> = 2
1836 Save changes into a file with extension C<.augnew>, and
1837 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1839 =item C<AUG_TYPE_CHECK> = 4
1843 This option is only useful when debugging Augeas lenses. Use
1844 of this option may require additional memory for the libguestfs
1845 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1846 environment variable or call C<guestfs_set_memsize>.
1848 =item C<AUG_NO_STDINC> = 8
1850 Do not use standard load path for modules.
1852 =item C<AUG_SAVE_NOOP> = 16
1854 Make save a no-op, just record what would have been changed.
1856 =item C<AUG_NO_LOAD> = 32
1858 Do not load the tree in C<guestfs_aug_init>.
1862 To close the handle, you can call C<guestfs_aug_close>.
1864 To find out more about Augeas, see L<http://augeas.net/>.");
1866 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1867 [], (* XXX Augeas code needs tests. *)
1868 "close the current Augeas handle",
1870 Close the current Augeas handle and free up any resources
1871 used by it. After calling this, you have to call
1872 C<guestfs_aug_init> again before you can use any other
1873 Augeas functions.");
1875 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1876 [], (* XXX Augeas code needs tests. *)
1877 "define an Augeas variable",
1879 Defines an Augeas variable C<name> whose value is the result
1880 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1883 On success this returns the number of nodes in C<expr>, or
1884 C<0> if C<expr> evaluates to something which is not a nodeset.");
1886 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1887 [], (* XXX Augeas code needs tests. *)
1888 "define an Augeas node",
1890 Defines a variable C<name> whose value is the result of
1893 If C<expr> evaluates to an empty nodeset, a node is created,
1894 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1895 C<name> will be the nodeset containing that single node.
1897 On success this returns a pair containing the
1898 number of nodes in the nodeset, and a boolean flag
1899 if a node was created.");
1901 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1902 [], (* XXX Augeas code needs tests. *)
1903 "look up the value of an Augeas path",
1905 Look up the value associated with C<path>. If C<path>
1906 matches exactly one node, the C<value> is returned.");
1908 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1909 [], (* XXX Augeas code needs tests. *)
1910 "set Augeas path to value",
1912 Set the value associated with C<path> to C<val>.
1914 In the Augeas API, it is possible to clear a node by setting
1915 the value to NULL. Due to an oversight in the libguestfs API
1916 you cannot do that with this call. Instead you must use the
1917 C<guestfs_aug_clear> call.");
1919 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1920 [], (* XXX Augeas code needs tests. *)
1921 "insert a sibling Augeas node",
1923 Create a new sibling C<label> for C<path>, inserting it into
1924 the tree before or after C<path> (depending on the boolean
1927 C<path> must match exactly one existing node in the tree, and
1928 C<label> must be a label, ie. not contain C</>, C<*> or end
1929 with a bracketed index C<[N]>.");
1931 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1932 [], (* XXX Augeas code needs tests. *)
1933 "remove an Augeas path",
1935 Remove C<path> and all of its children.
1937 On success this returns the number of entries which were removed.");
1939 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1940 [], (* XXX Augeas code needs tests. *)
1943 Move the node C<src> to C<dest>. C<src> must match exactly
1944 one node. C<dest> is overwritten if it exists.");
1946 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1947 [], (* XXX Augeas code needs tests. *)
1948 "return Augeas nodes which match augpath",
1950 Returns a list of paths which match the path expression C<path>.
1951 The returned paths are sufficiently qualified so that they match
1952 exactly one node in the current tree.");
1954 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1955 [], (* XXX Augeas code needs tests. *)
1956 "write all pending Augeas changes to disk",
1958 This writes all pending changes to disk.
1960 The flags which were passed to C<guestfs_aug_init> affect exactly
1961 how files are saved.");
1963 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1964 [], (* XXX Augeas code needs tests. *)
1965 "load files into the tree",
1967 Load files into the tree.
1969 See C<aug_load> in the Augeas documentation for the full gory
1972 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1973 [], (* XXX Augeas code needs tests. *)
1974 "list Augeas nodes under augpath",
1976 This is just a shortcut for listing C<guestfs_aug_match>
1977 C<path/*> and sorting the resulting nodes into alphabetical order.");
1979 ("rm", (RErr, [Pathname "path"], []), 29, [],
1980 [InitScratchFS, Always, TestRun
1982 ["touch"; "/rm/new"];
1984 InitScratchFS, Always, TestLastFail
1985 [["rm"; "/nosuchfile"]];
1986 InitScratchFS, Always, TestLastFail
1991 Remove the single file C<path>.");
1993 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1994 [InitScratchFS, Always, TestRun
1995 [["mkdir"; "/rmdir"];
1996 ["rmdir"; "/rmdir"]];
1997 InitScratchFS, Always, TestLastFail
1998 [["rmdir"; "/rmdir2"]];
1999 InitScratchFS, Always, TestLastFail
2000 [["mkdir"; "/rmdir3"];
2001 ["touch"; "/rmdir3/new"];
2002 ["rmdir"; "/rmdir3/new"]]],
2003 "remove a directory",
2005 Remove the single directory C<path>.");
2007 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
2008 [InitScratchFS, Always, TestOutputFalse
2009 [["mkdir"; "/rm_rf"];
2010 ["mkdir"; "/rm_rf/foo"];
2011 ["touch"; "/rm_rf/foo/bar"];
2012 ["rm_rf"; "/rm_rf"];
2013 ["exists"; "/rm_rf"]]],
2014 "remove a file or directory recursively",
2016 Remove the file or directory C<path>, recursively removing the
2017 contents if its a directory. This is like the C<rm -rf> shell
2020 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2021 [InitScratchFS, Always, TestOutputTrue
2022 [["mkdir"; "/mkdir"];
2023 ["is_dir"; "/mkdir"]];
2024 InitScratchFS, Always, TestLastFail
2025 [["mkdir"; "/mkdir2/foo/bar"]]],
2026 "create a directory",
2028 Create a directory named C<path>.");
2030 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2031 [InitScratchFS, Always, TestOutputTrue
2032 [["mkdir_p"; "/mkdir_p/foo/bar"];
2033 ["is_dir"; "/mkdir_p/foo/bar"]];
2034 InitScratchFS, Always, TestOutputTrue
2035 [["mkdir_p"; "/mkdir_p2/foo/bar"];
2036 ["is_dir"; "/mkdir_p2/foo"]];
2037 InitScratchFS, Always, TestOutputTrue
2038 [["mkdir_p"; "/mkdir_p3/foo/bar"];
2039 ["is_dir"; "/mkdir_p3"]];
2040 (* Regression tests for RHBZ#503133: *)
2041 InitScratchFS, Always, TestRun
2042 [["mkdir"; "/mkdir_p4"];
2043 ["mkdir_p"; "/mkdir_p4"]];
2044 InitScratchFS, Always, TestLastFail
2045 [["touch"; "/mkdir_p5"];
2046 ["mkdir_p"; "/mkdir_p5"]]],
2047 "create a directory and parents",
2049 Create a directory named C<path>, creating any parent directories
2050 as necessary. This is like the C<mkdir -p> shell command.");
2052 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2053 [], (* XXX Need stat command to test *)
2056 Change the mode (permissions) of C<path> to C<mode>. Only
2057 numeric modes are supported.
2059 I<Note>: When using this command from guestfish, C<mode>
2060 by default would be decimal, unless you prefix it with
2061 C<0> to get octal, ie. use C<0700> not C<700>.
2063 The mode actually set is affected by the umask.");
2065 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2066 [], (* XXX Need stat command to test *)
2067 "change file owner and group",
2069 Change the file owner to C<owner> and group to C<group>.
2071 Only numeric uid and gid are supported. If you want to use
2072 names, you will need to locate and parse the password file
2073 yourself (Augeas support makes this relatively easy).");
2075 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2076 [InitISOFS, Always, TestOutputTrue (
2077 [["exists"; "/empty"]]);
2078 InitISOFS, Always, TestOutputTrue (
2079 [["exists"; "/directory"]])],
2080 "test if file or directory exists",
2082 This returns C<true> if and only if there is a file, directory
2083 (or anything) with the given C<path> name.
2085 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2087 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2088 [InitISOFS, Always, TestOutputTrue (
2089 [["is_file"; "/known-1"]]);
2090 InitISOFS, Always, TestOutputFalse (
2091 [["is_file"; "/directory"]])],
2092 "test if a regular file",
2094 This returns C<true> if and only if there is a regular file
2095 with the given C<path> name. Note that it returns false for
2096 other objects like directories.
2098 See also C<guestfs_stat>.");
2100 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2101 [InitISOFS, Always, TestOutputFalse (
2102 [["is_dir"; "/known-3"]]);
2103 InitISOFS, Always, TestOutputTrue (
2104 [["is_dir"; "/directory"]])],
2105 "test if a directory",
2107 This returns C<true> if and only if there is a directory
2108 with the given C<path> name. Note that it returns false for
2109 other objects like files.
2111 See also C<guestfs_stat>.");
2113 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2114 [InitEmpty, Always, TestOutputListOfDevices (
2115 [["part_init"; "/dev/sda"; "mbr"];
2116 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2117 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2118 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2119 ["pvcreate"; "/dev/sda1"];
2120 ["pvcreate"; "/dev/sda2"];
2121 ["pvcreate"; "/dev/sda3"];
2122 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2123 "create an LVM physical volume",
2125 This creates an LVM physical volume on the named C<device>,
2126 where C<device> should usually be a partition name such
2129 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2130 [InitEmpty, Always, TestOutputList (
2131 [["part_init"; "/dev/sda"; "mbr"];
2132 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2133 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2134 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2135 ["pvcreate"; "/dev/sda1"];
2136 ["pvcreate"; "/dev/sda2"];
2137 ["pvcreate"; "/dev/sda3"];
2138 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2139 ["vgcreate"; "VG2"; "/dev/sda3"];
2140 ["vgs"]], ["VG1"; "VG2"])],
2141 "create an LVM volume group",
2143 This creates an LVM volume group called C<volgroup>
2144 from the non-empty list of physical volumes C<physvols>.");
2146 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2147 [InitEmpty, Always, TestOutputList (
2148 [["part_init"; "/dev/sda"; "mbr"];
2149 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2150 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2151 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2152 ["pvcreate"; "/dev/sda1"];
2153 ["pvcreate"; "/dev/sda2"];
2154 ["pvcreate"; "/dev/sda3"];
2155 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2156 ["vgcreate"; "VG2"; "/dev/sda3"];
2157 ["lvcreate"; "LV1"; "VG1"; "50"];
2158 ["lvcreate"; "LV2"; "VG1"; "50"];
2159 ["lvcreate"; "LV3"; "VG2"; "50"];
2160 ["lvcreate"; "LV4"; "VG2"; "50"];
2161 ["lvcreate"; "LV5"; "VG2"; "50"];
2163 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2164 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2165 "create an LVM logical volume",
2167 This creates an LVM logical volume called C<logvol>
2168 on the volume group C<volgroup>, with C<size> megabytes.");
2170 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2171 [InitEmpty, Always, TestOutput (
2172 [["part_disk"; "/dev/sda"; "mbr"];
2173 ["mkfs"; "ext2"; "/dev/sda1"];
2174 ["mount_options"; ""; "/dev/sda1"; "/"];
2175 ["write"; "/new"; "new file contents"];
2176 ["cat"; "/new"]], "new file contents")],
2177 "make a filesystem",
2179 This creates a filesystem on C<device> (usually a partition
2180 or LVM logical volume). The filesystem type is C<fstype>, for
2183 ("sfdisk", (RErr, [Device "device";
2184 Int "cyls"; Int "heads"; Int "sectors";
2185 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2187 "create partitions on a block device",
2189 This is a direct interface to the L<sfdisk(8)> program for creating
2190 partitions on block devices.
2192 C<device> should be a block device, for example C</dev/sda>.
2194 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2195 and sectors on the device, which are passed directly to sfdisk as
2196 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2197 of these, then the corresponding parameter is omitted. Usually for
2198 'large' disks, you can just pass C<0> for these, but for small
2199 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2200 out the right geometry and you will need to tell it.
2202 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2203 information refer to the L<sfdisk(8)> manpage.
2205 To create a single partition occupying the whole disk, you would
2206 pass C<lines> as a single element list, when the single element being
2207 the string C<,> (comma).
2209 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2210 C<guestfs_part_init>");
2212 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2213 (* Regression test for RHBZ#597135. *)
2214 [InitScratchFS, Always, TestLastFail
2215 [["write_file"; "/write_file"; "abc"; "10000"]]],
2218 This call creates a file called C<path>. The contents of the
2219 file is the string C<content> (which can contain any 8 bit data),
2220 with length C<size>.
2222 As a special case, if C<size> is C<0>
2223 then the length is calculated using C<strlen> (so in this case
2224 the content cannot contain embedded ASCII NULs).
2226 I<NB.> Owing to a bug, writing content containing ASCII NUL
2227 characters does I<not> work, even if the length is specified.");
2229 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2230 [InitEmpty, Always, TestOutputListOfDevices (
2231 [["part_disk"; "/dev/sda"; "mbr"];
2232 ["mkfs"; "ext2"; "/dev/sda1"];
2233 ["mount_options"; ""; "/dev/sda1"; "/"];
2234 ["mounts"]], ["/dev/sda1"]);
2235 InitEmpty, Always, TestOutputList (
2236 [["part_disk"; "/dev/sda"; "mbr"];
2237 ["mkfs"; "ext2"; "/dev/sda1"];
2238 ["mount_options"; ""; "/dev/sda1"; "/"];
2241 "unmount a filesystem",
2243 This unmounts the given filesystem. The filesystem may be
2244 specified either by its mountpoint (path) or the device which
2245 contains the filesystem.");
2247 ("mounts", (RStringList "devices", [], []), 46, [],
2248 [InitScratchFS, Always, TestOutputListOfDevices (
2249 [["mounts"]], ["/dev/sdb1"])],
2250 "show mounted filesystems",
2252 This returns the list of currently mounted filesystems. It returns
2253 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2255 Some internal mounts are not shown.
2257 See also: C<guestfs_mountpoints>");
2259 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2260 [InitScratchFS, Always, TestOutputList (
2263 (* check that umount_all can unmount nested mounts correctly: *)
2264 InitEmpty, Always, TestOutputList (
2265 [["part_init"; "/dev/sda"; "mbr"];
2266 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2267 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2268 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2269 ["mkfs"; "ext2"; "/dev/sda1"];
2270 ["mkfs"; "ext2"; "/dev/sda2"];
2271 ["mkfs"; "ext2"; "/dev/sda3"];
2272 ["mount_options"; ""; "/dev/sda1"; "/"];
2274 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2275 ["mkdir"; "/mp1/mp2"];
2276 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2277 ["mkdir"; "/mp1/mp2/mp3"];
2280 "unmount all filesystems",
2282 This unmounts all mounted filesystems.
2284 Some internal mounts are not unmounted by this call.");
2286 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2288 "remove all LVM LVs, VGs and PVs",
2290 This command removes all LVM logical volumes, volume groups
2291 and physical volumes.");
2293 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2294 [InitISOFS, Always, TestOutput (
2295 [["file"; "/empty"]], "empty");
2296 InitISOFS, Always, TestOutput (
2297 [["file"; "/known-1"]], "ASCII text");
2298 InitISOFS, Always, TestLastFail (
2299 [["file"; "/notexists"]]);
2300 InitISOFS, Always, TestOutput (
2301 [["file"; "/abssymlink"]], "symbolic link");
2302 InitISOFS, Always, TestOutput (
2303 [["file"; "/directory"]], "directory")],
2304 "determine file type",
2306 This call uses the standard L<file(1)> command to determine
2307 the type or contents of the file.
2309 This call will also transparently look inside various types
2312 The exact command which runs is C<file -zb path>. Note in
2313 particular that the filename is not prepended to the output
2316 The output depends on the output of the underlying L<file(1)>
2317 command and it can change in future in ways beyond our control.
2318 In other words, the output is not guaranteed by the ABI.
2320 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2321 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2323 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2324 [InitScratchFS, Always, TestOutput (
2325 [["mkdir"; "/command"];
2326 ["upload"; "test-command"; "/command/test-command"];
2327 ["chmod"; "0o755"; "/command/test-command"];
2328 ["command"; "/command/test-command 1"]], "Result1");
2329 InitScratchFS, Always, TestOutput (
2330 [["mkdir"; "/command2"];
2331 ["upload"; "test-command"; "/command2/test-command"];
2332 ["chmod"; "0o755"; "/command2/test-command"];
2333 ["command"; "/command2/test-command 2"]], "Result2\n");
2334 InitScratchFS, Always, TestOutput (
2335 [["mkdir"; "/command3"];
2336 ["upload"; "test-command"; "/command3/test-command"];
2337 ["chmod"; "0o755"; "/command3/test-command"];
2338 ["command"; "/command3/test-command 3"]], "\nResult3");
2339 InitScratchFS, Always, TestOutput (
2340 [["mkdir"; "/command4"];
2341 ["upload"; "test-command"; "/command4/test-command"];
2342 ["chmod"; "0o755"; "/command4/test-command"];
2343 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2344 InitScratchFS, Always, TestOutput (
2345 [["mkdir"; "/command5"];
2346 ["upload"; "test-command"; "/command5/test-command"];
2347 ["chmod"; "0o755"; "/command5/test-command"];
2348 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2349 InitScratchFS, Always, TestOutput (
2350 [["mkdir"; "/command6"];
2351 ["upload"; "test-command"; "/command6/test-command"];
2352 ["chmod"; "0o755"; "/command6/test-command"];
2353 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2354 InitScratchFS, Always, TestOutput (
2355 [["mkdir"; "/command7"];
2356 ["upload"; "test-command"; "/command7/test-command"];
2357 ["chmod"; "0o755"; "/command7/test-command"];
2358 ["command"; "/command7/test-command 7"]], "");
2359 InitScratchFS, Always, TestOutput (
2360 [["mkdir"; "/command8"];
2361 ["upload"; "test-command"; "/command8/test-command"];
2362 ["chmod"; "0o755"; "/command8/test-command"];
2363 ["command"; "/command8/test-command 8"]], "\n");
2364 InitScratchFS, Always, TestOutput (
2365 [["mkdir"; "/command9"];
2366 ["upload"; "test-command"; "/command9/test-command"];
2367 ["chmod"; "0o755"; "/command9/test-command"];
2368 ["command"; "/command9/test-command 9"]], "\n\n");
2369 InitScratchFS, Always, TestOutput (
2370 [["mkdir"; "/command10"];
2371 ["upload"; "test-command"; "/command10/test-command"];
2372 ["chmod"; "0o755"; "/command10/test-command"];
2373 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2374 InitScratchFS, Always, TestOutput (
2375 [["mkdir"; "/command11"];
2376 ["upload"; "test-command"; "/command11/test-command"];
2377 ["chmod"; "0o755"; "/command11/test-command"];
2378 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2379 InitScratchFS, Always, TestLastFail (
2380 [["mkdir"; "/command12"];
2381 ["upload"; "test-command"; "/command12/test-command"];
2382 ["chmod"; "0o755"; "/command12/test-command"];
2383 ["command"; "/command12/test-command"]])],
2384 "run a command from the guest filesystem",
2386 This call runs a command from the guest filesystem. The
2387 filesystem must be mounted, and must contain a compatible
2388 operating system (ie. something Linux, with the same
2389 or compatible processor architecture).
2391 The single parameter is an argv-style list of arguments.
2392 The first element is the name of the program to run.
2393 Subsequent elements are parameters. The list must be
2394 non-empty (ie. must contain a program name). Note that
2395 the command runs directly, and is I<not> invoked via
2396 the shell (see C<guestfs_sh>).
2398 The return value is anything printed to I<stdout> by
2401 If the command returns a non-zero exit status, then
2402 this function returns an error message. The error message
2403 string is the content of I<stderr> from the command.
2405 The C<$PATH> environment variable will contain at least
2406 C</usr/bin> and C</bin>. If you require a program from
2407 another location, you should provide the full path in the
2410 Shared libraries and data files required by the program
2411 must be available on filesystems which are mounted in the
2412 correct places. It is the caller's responsibility to ensure
2413 all filesystems that are needed are mounted at the right
2416 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2417 [InitScratchFS, Always, TestOutputList (
2418 [["mkdir"; "/command_lines"];
2419 ["upload"; "test-command"; "/command_lines/test-command"];
2420 ["chmod"; "0o755"; "/command_lines/test-command"];
2421 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2422 InitScratchFS, Always, TestOutputList (
2423 [["mkdir"; "/command_lines2"];
2424 ["upload"; "test-command"; "/command_lines2/test-command"];
2425 ["chmod"; "0o755"; "/command_lines2/test-command"];
2426 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2427 InitScratchFS, Always, TestOutputList (
2428 [["mkdir"; "/command_lines3"];
2429 ["upload"; "test-command"; "/command_lines3/test-command"];
2430 ["chmod"; "0o755"; "/command_lines3/test-command"];
2431 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2432 InitScratchFS, Always, TestOutputList (
2433 [["mkdir"; "/command_lines4"];
2434 ["upload"; "test-command"; "/command_lines4/test-command"];
2435 ["chmod"; "0o755"; "/command_lines4/test-command"];
2436 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2437 InitScratchFS, Always, TestOutputList (
2438 [["mkdir"; "/command_lines5"];
2439 ["upload"; "test-command"; "/command_lines5/test-command"];
2440 ["chmod"; "0o755"; "/command_lines5/test-command"];
2441 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2442 InitScratchFS, Always, TestOutputList (
2443 [["mkdir"; "/command_lines6"];
2444 ["upload"; "test-command"; "/command_lines6/test-command"];
2445 ["chmod"; "0o755"; "/command_lines6/test-command"];
2446 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2447 InitScratchFS, Always, TestOutputList (
2448 [["mkdir"; "/command_lines7"];
2449 ["upload"; "test-command"; "/command_lines7/test-command"];
2450 ["chmod"; "0o755"; "/command_lines7/test-command"];
2451 ["command_lines"; "/command_lines7/test-command 7"]], []);
2452 InitScratchFS, Always, TestOutputList (
2453 [["mkdir"; "/command_lines8"];
2454 ["upload"; "test-command"; "/command_lines8/test-command"];
2455 ["chmod"; "0o755"; "/command_lines8/test-command"];
2456 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2457 InitScratchFS, Always, TestOutputList (
2458 [["mkdir"; "/command_lines9"];
2459 ["upload"; "test-command"; "/command_lines9/test-command"];
2460 ["chmod"; "0o755"; "/command_lines9/test-command"];
2461 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2462 InitScratchFS, Always, TestOutputList (
2463 [["mkdir"; "/command_lines10"];
2464 ["upload"; "test-command"; "/command_lines10/test-command"];
2465 ["chmod"; "0o755"; "/command_lines10/test-command"];
2466 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2467 InitScratchFS, Always, TestOutputList (
2468 [["mkdir"; "/command_lines11"];
2469 ["upload"; "test-command"; "/command_lines11/test-command"];
2470 ["chmod"; "0o755"; "/command_lines11/test-command"];
2471 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2472 "run a command, returning lines",
2474 This is the same as C<guestfs_command>, but splits the
2475 result into a list of lines.
2477 See also: C<guestfs_sh_lines>");
2479 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2480 [InitISOFS, Always, TestOutputStruct (
2481 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2482 "get file information",
2484 Returns file information for the given C<path>.
2486 This is the same as the C<stat(2)> system call.");
2488 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2489 [InitISOFS, Always, TestOutputStruct (
2490 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2491 "get file information for a symbolic link",
2493 Returns file information for the given C<path>.
2495 This is the same as C<guestfs_stat> except that if C<path>
2496 is a symbolic link, then the link is stat-ed, not the file it
2499 This is the same as the C<lstat(2)> system call.");
2501 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2502 [InitISOFS, Always, TestOutputStruct (
2503 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2504 "get file system statistics",
2506 Returns file system statistics for any mounted file system.
2507 C<path> should be a file or directory in the mounted file system
2508 (typically it is the mount point itself, but it doesn't need to be).
2510 This is the same as the C<statvfs(2)> system call.");
2512 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2514 "get ext2/ext3/ext4 superblock details",
2516 This returns the contents of the ext2, ext3 or ext4 filesystem
2517 superblock on C<device>.
2519 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2520 manpage for more details. The list of fields returned isn't
2521 clearly defined, and depends on both the version of C<tune2fs>
2522 that libguestfs was built against, and the filesystem itself.");
2524 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2525 [InitEmpty, Always, TestOutputTrue (
2526 [["blockdev_setro"; "/dev/sda"];
2527 ["blockdev_getro"; "/dev/sda"]])],
2528 "set block device to read-only",
2530 Sets the block device named C<device> to read-only.
2532 This uses the L<blockdev(8)> command.");
2534 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2535 [InitEmpty, Always, TestOutputFalse (
2536 [["blockdev_setrw"; "/dev/sda"];
2537 ["blockdev_getro"; "/dev/sda"]])],
2538 "set block device to read-write",
2540 Sets the block device named C<device> to read-write.
2542 This uses the L<blockdev(8)> command.");
2544 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2545 [InitEmpty, Always, TestOutputTrue (
2546 [["blockdev_setro"; "/dev/sda"];
2547 ["blockdev_getro"; "/dev/sda"]])],
2548 "is block device set to read-only",
2550 Returns a boolean indicating if the block device is read-only
2551 (true if read-only, false if not).
2553 This uses the L<blockdev(8)> command.");
2555 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2556 [InitEmpty, Always, TestOutputInt (
2557 [["blockdev_getss"; "/dev/sda"]], 512)],
2558 "get sectorsize of block device",
2560 This returns the size of sectors on a block device.
2561 Usually 512, but can be larger for modern devices.
2563 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2566 This uses the L<blockdev(8)> command.");
2568 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2569 [InitEmpty, Always, TestOutputInt (
2570 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2571 "get blocksize of block device",
2573 This returns the block size of a device.
2575 (Note this is different from both I<size in blocks> and
2576 I<filesystem block size>).
2578 This uses the L<blockdev(8)> command.");
2580 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2582 "set blocksize of block device",
2584 This sets the block size of a device.
2586 (Note this is different from both I<size in blocks> and
2587 I<filesystem block size>).
2589 This uses the L<blockdev(8)> command.");
2591 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2592 [InitEmpty, Always, TestOutputInt (
2593 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2594 "get total size of device in 512-byte sectors",
2596 This returns the size of the device in units of 512-byte sectors
2597 (even if the sectorsize isn't 512 bytes ... weird).
2599 See also C<guestfs_blockdev_getss> for the real sector size of
2600 the device, and C<guestfs_blockdev_getsize64> for the more
2601 useful I<size in bytes>.
2603 This uses the L<blockdev(8)> command.");
2605 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2606 [InitEmpty, Always, TestOutputInt (
2607 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2608 "get total size of device in bytes",
2610 This returns the size of the device in bytes.
2612 See also C<guestfs_blockdev_getsz>.
2614 This uses the L<blockdev(8)> command.");
2616 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2617 [InitEmpty, Always, TestRun
2618 [["blockdev_flushbufs"; "/dev/sda"]]],
2619 "flush device buffers",
2621 This tells the kernel to flush internal buffers associated
2624 This uses the L<blockdev(8)> command.");
2626 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2627 [InitEmpty, Always, TestRun
2628 [["blockdev_rereadpt"; "/dev/sda"]]],
2629 "reread partition table",
2631 Reread the partition table on C<device>.
2633 This uses the L<blockdev(8)> command.");
2635 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2636 [InitScratchFS, Always, TestOutput (
2637 (* Pick a file from cwd which isn't likely to change. *)
2638 [["mkdir"; "/upload"];
2639 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2640 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2641 Digest.to_hex (Digest.file "COPYING.LIB"))],
2642 "upload a file from the local machine",
2644 Upload local file C<filename> to C<remotefilename> on the
2647 C<filename> can also be a named pipe.
2649 See also C<guestfs_download>.");
2651 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2652 [InitScratchFS, Always, TestOutput (
2653 (* Pick a file from cwd which isn't likely to change. *)
2654 [["mkdir"; "/download"];
2655 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2656 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2657 ["upload"; "testdownload.tmp"; "/download/upload"];
2658 ["checksum"; "md5"; "/download/upload"]],
2659 Digest.to_hex (Digest.file "COPYING.LIB"))],
2660 "download a file to the local machine",
2662 Download file C<remotefilename> and save it as C<filename>
2663 on the local machine.
2665 C<filename> can also be a named pipe.
2667 See also C<guestfs_upload>, C<guestfs_cat>.");
2669 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2670 [InitISOFS, Always, TestOutput (
2671 [["checksum"; "crc"; "/known-3"]], "2891671662");
2672 InitISOFS, Always, TestLastFail (
2673 [["checksum"; "crc"; "/notexists"]]);
2674 InitISOFS, Always, TestOutput (
2675 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2676 InitISOFS, Always, TestOutput (
2677 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2678 InitISOFS, Always, TestOutput (
2679 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2680 InitISOFS, Always, TestOutput (
2681 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2682 InitISOFS, Always, TestOutput (
2683 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2684 InitISOFS, Always, TestOutput (
2685 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2686 (* Test for RHBZ#579608, absolute symbolic links. *)
2687 InitISOFS, Always, TestOutput (
2688 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2689 "compute MD5, SHAx or CRC checksum of file",
2691 This call computes the MD5, SHAx or CRC checksum of the
2694 The type of checksum to compute is given by the C<csumtype>
2695 parameter which must have one of the following values:
2701 Compute the cyclic redundancy check (CRC) specified by POSIX
2702 for the C<cksum> command.
2706 Compute the MD5 hash (using the C<md5sum> program).
2710 Compute the SHA1 hash (using the C<sha1sum> program).
2714 Compute the SHA224 hash (using the C<sha224sum> program).
2718 Compute the SHA256 hash (using the C<sha256sum> program).
2722 Compute the SHA384 hash (using the C<sha384sum> program).
2726 Compute the SHA512 hash (using the C<sha512sum> program).
2730 The checksum is returned as a printable string.
2732 To get the checksum for a device, use C<guestfs_checksum_device>.
2734 To get the checksums for many files, use C<guestfs_checksums_out>.");
2736 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2737 [InitScratchFS, Always, TestOutput (
2738 [["mkdir"; "/tar_in"];
2739 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2740 ["cat"; "/tar_in/hello"]], "hello\n")],
2741 "unpack tarfile to directory",
2743 This command uploads and unpacks local file C<tarfile> (an
2744 I<uncompressed> tar file) into C<directory>.
2746 To upload a compressed tarball, use C<guestfs_tgz_in>
2747 or C<guestfs_txz_in>.");
2749 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2751 "pack directory into tarfile",
2753 This command packs the contents of C<directory> and downloads
2754 it to local file C<tarfile>.
2756 To download a compressed tarball, use C<guestfs_tgz_out>
2757 or C<guestfs_txz_out>.");
2759 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2760 [InitScratchFS, Always, TestOutput (
2761 [["mkdir"; "/tgz_in"];
2762 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2763 ["cat"; "/tgz_in/hello"]], "hello\n")],
2764 "unpack compressed tarball to directory",
2766 This command uploads and unpacks local file C<tarball> (a
2767 I<gzip compressed> tar file) into C<directory>.
2769 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2771 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2773 "pack directory into compressed tarball",
2775 This command packs the contents of C<directory> and downloads
2776 it to local file C<tarball>.
2778 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2780 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2781 [InitBasicFS, Always, TestLastFail (
2783 ["mount_ro"; "/dev/sda1"; "/"];
2784 ["touch"; "/new"]]);
2785 InitBasicFS, Always, TestOutput (
2786 [["write"; "/new"; "data"];
2788 ["mount_ro"; "/dev/sda1"; "/"];
2789 ["cat"; "/new"]], "data")],
2790 "mount a guest disk, read-only",
2792 This is the same as the C<guestfs_mount> command, but it
2793 mounts the filesystem with the read-only (I<-o ro>) flag.");
2795 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2797 "mount a guest disk with mount options",
2799 This is the same as the C<guestfs_mount> command, but it
2800 allows you to set the mount options as for the
2801 L<mount(8)> I<-o> flag.
2803 If the C<options> parameter is an empty string, then
2804 no options are passed (all options default to whatever
2805 the filesystem uses).");
2807 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2809 "mount a guest disk with mount options and vfstype",
2811 This is the same as the C<guestfs_mount> command, but it
2812 allows you to set both the mount options and the vfstype
2813 as for the L<mount(8)> I<-o> and I<-t> flags.");
2815 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2817 "debugging and internals",
2819 The C<guestfs_debug> command exposes some internals of
2820 C<guestfsd> (the guestfs daemon) that runs inside the
2823 There is no comprehensive help for this command. You have
2824 to look at the file C<daemon/debug.c> in the libguestfs source
2825 to find out what you can do.");
2827 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2828 [InitEmpty, Always, TestOutputList (
2829 [["part_disk"; "/dev/sda"; "mbr"];
2830 ["pvcreate"; "/dev/sda1"];
2831 ["vgcreate"; "VG"; "/dev/sda1"];
2832 ["lvcreate"; "LV1"; "VG"; "50"];
2833 ["lvcreate"; "LV2"; "VG"; "50"];
2834 ["lvremove"; "/dev/VG/LV1"];
2835 ["lvs"]], ["/dev/VG/LV2"]);
2836 InitEmpty, Always, TestOutputList (
2837 [["part_disk"; "/dev/sda"; "mbr"];
2838 ["pvcreate"; "/dev/sda1"];
2839 ["vgcreate"; "VG"; "/dev/sda1"];
2840 ["lvcreate"; "LV1"; "VG"; "50"];
2841 ["lvcreate"; "LV2"; "VG"; "50"];
2842 ["lvremove"; "/dev/VG"];
2844 InitEmpty, Always, TestOutputList (
2845 [["part_disk"; "/dev/sda"; "mbr"];
2846 ["pvcreate"; "/dev/sda1"];
2847 ["vgcreate"; "VG"; "/dev/sda1"];
2848 ["lvcreate"; "LV1"; "VG"; "50"];
2849 ["lvcreate"; "LV2"; "VG"; "50"];
2850 ["lvremove"; "/dev/VG"];
2852 "remove an LVM logical volume",
2854 Remove an LVM logical volume C<device>, where C<device> is
2855 the path to the LV, such as C</dev/VG/LV>.
2857 You can also remove all LVs in a volume group by specifying
2858 the VG name, C</dev/VG>.");
2860 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
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"];
2869 InitEmpty, Always, TestOutputList (
2870 [["part_disk"; "/dev/sda"; "mbr"];
2871 ["pvcreate"; "/dev/sda1"];
2872 ["vgcreate"; "VG"; "/dev/sda1"];
2873 ["lvcreate"; "LV1"; "VG"; "50"];
2874 ["lvcreate"; "LV2"; "VG"; "50"];
2877 "remove an LVM volume group",
2879 Remove an LVM volume group C<vgname>, (for example C<VG>).
2881 This also forcibly removes all logical volumes in the volume
2884 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2885 [InitEmpty, Always, TestOutputListOfDevices (
2886 [["part_disk"; "/dev/sda"; "mbr"];
2887 ["pvcreate"; "/dev/sda1"];
2888 ["vgcreate"; "VG"; "/dev/sda1"];
2889 ["lvcreate"; "LV1"; "VG"; "50"];
2890 ["lvcreate"; "LV2"; "VG"; "50"];
2892 ["pvremove"; "/dev/sda1"];
2894 InitEmpty, Always, TestOutputListOfDevices (
2895 [["part_disk"; "/dev/sda"; "mbr"];
2896 ["pvcreate"; "/dev/sda1"];
2897 ["vgcreate"; "VG"; "/dev/sda1"];
2898 ["lvcreate"; "LV1"; "VG"; "50"];
2899 ["lvcreate"; "LV2"; "VG"; "50"];
2901 ["pvremove"; "/dev/sda1"];
2903 InitEmpty, Always, TestOutputListOfDevices (
2904 [["part_disk"; "/dev/sda"; "mbr"];
2905 ["pvcreate"; "/dev/sda1"];
2906 ["vgcreate"; "VG"; "/dev/sda1"];
2907 ["lvcreate"; "LV1"; "VG"; "50"];
2908 ["lvcreate"; "LV2"; "VG"; "50"];
2910 ["pvremove"; "/dev/sda1"];
2912 "remove an LVM physical volume",
2914 This wipes a physical volume C<device> so that LVM will no longer
2917 The implementation uses the C<pvremove> command which refuses to
2918 wipe physical volumes that contain any volume groups, so you have
2919 to remove those first.");
2921 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2922 [InitBasicFS, Always, TestOutput (
2923 [["set_e2label"; "/dev/sda1"; "testlabel"];
2924 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2925 "set the ext2/3/4 filesystem label",
2927 This sets the ext2/3/4 filesystem label of the filesystem on
2928 C<device> to C<label>. Filesystem labels are limited to
2931 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2932 to return the existing label on a filesystem.");
2934 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2936 "get the ext2/3/4 filesystem label",
2938 This returns the ext2/3/4 filesystem label of the filesystem on
2941 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2942 (let uuid = uuidgen () in
2943 [InitBasicFS, Always, TestOutput (
2944 [["set_e2uuid"; "/dev/sda1"; uuid];
2945 ["get_e2uuid"; "/dev/sda1"]], uuid);
2946 InitBasicFS, Always, TestOutput (
2947 [["set_e2uuid"; "/dev/sda1"; "clear"];
2948 ["get_e2uuid"; "/dev/sda1"]], "");
2949 (* We can't predict what UUIDs will be, so just check the commands run. *)
2950 InitBasicFS, Always, TestRun (
2951 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2952 InitBasicFS, Always, TestRun (
2953 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2954 "set the ext2/3/4 filesystem UUID",
2956 This sets the ext2/3/4 filesystem UUID of the filesystem on
2957 C<device> to C<uuid>. The format of the UUID and alternatives
2958 such as C<clear>, C<random> and C<time> are described in the
2959 L<tune2fs(8)> manpage.
2961 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2962 to return the existing UUID of a filesystem.");
2964 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2965 (* Regression test for RHBZ#597112. *)
2966 (let uuid = uuidgen () in
2967 [InitNone, Always, TestOutput (
2968 [["mke2journal"; "1024"; "/dev/sdc"];
2969 ["set_e2uuid"; "/dev/sdc"; uuid];
2970 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2971 "get the ext2/3/4 filesystem UUID",
2973 This returns the ext2/3/4 filesystem UUID of the filesystem on
2976 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2977 [InitBasicFS, Always, TestOutputInt (
2978 [["umount"; "/dev/sda1"];
2979 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2980 InitBasicFS, Always, TestOutputInt (
2981 [["umount"; "/dev/sda1"];
2982 ["zero"; "/dev/sda1"];
2983 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2984 "run the filesystem checker",
2986 This runs the filesystem checker (fsck) on C<device> which
2987 should have filesystem type C<fstype>.
2989 The returned integer is the status. See L<fsck(8)> for the
2990 list of status codes from C<fsck>.
2998 Multiple status codes can be summed together.
3002 A non-zero return code can mean \"success\", for example if
3003 errors have been corrected on the filesystem.
3007 Checking or repairing NTFS volumes is not supported
3012 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3014 ("zero", (RErr, [Device "device"], []), 85, [Progress],
3015 [InitBasicFS, Always, TestRun (
3016 [["umount"; "/dev/sda1"];
3017 ["zero"; "/dev/sda1"]])],
3018 "write zeroes to the device",
3020 This command writes zeroes over the first few blocks of C<device>.
3022 How many blocks are zeroed isn't specified (but it's I<not> enough
3023 to securely wipe the device). It should be sufficient to remove
3024 any partition tables, filesystem superblocks and so on.
3026 If blocks are already zero, then this command avoids writing
3027 zeroes. This prevents the underlying device from becoming non-sparse
3028 or growing unnecessarily.
3030 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3031 C<guestfs_is_zero_device>");
3033 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3035 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3036 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3038 [InitBasicFS, Always, TestOutputTrue (
3039 [["mkdir_p"; "/boot/grub"];
3040 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3041 ["grub_install"; "/"; "/dev/vda"];
3042 ["is_dir"; "/boot"]])],
3045 This command installs GRUB 1 (the Grand Unified Bootloader) on
3046 C<device>, with the root directory being C<root>.
3054 There is currently no way in the API to install grub2, which
3055 is used by most modern Linux guests. It is possible to run
3056 the grub2 command from the guest, although see the
3057 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3061 This uses C<grub-install> from the host. Unfortunately grub is
3062 not always compatible with itself, so this only works in rather
3063 narrow circumstances. Careful testing with each guest version
3068 If grub-install reports the error
3069 \"No suitable drive was found in the generated device map.\"
3070 it may be that you need to create a C</boot/grub/device.map>
3071 file first that contains the mapping between grub device names
3072 and Linux device names. It is usually sufficient to create
3077 replacing C</dev/vda> with the name of the installation device.
3081 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3082 [InitScratchFS, Always, TestOutput (
3084 ["write"; "/cp/old"; "file content"];
3085 ["cp"; "/cp/old"; "/cp/new"];
3086 ["cat"; "/cp/new"]], "file content");
3087 InitScratchFS, Always, TestOutputTrue (
3089 ["write"; "/cp2/old"; "file content"];
3090 ["cp"; "/cp2/old"; "/cp2/new"];
3091 ["is_file"; "/cp2/old"]]);
3092 InitScratchFS, Always, TestOutput (
3094 ["write"; "/cp3/old"; "file content"];
3095 ["mkdir"; "/cp3/dir"];
3096 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3097 ["cat"; "/cp3/dir/new"]], "file content")],
3100 This copies a file from C<src> to C<dest> where C<dest> is
3101 either a destination filename or destination directory.");
3103 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3104 [InitScratchFS, Always, TestOutput (
3105 [["mkdir"; "/cp_a1"];
3106 ["mkdir"; "/cp_a2"];
3107 ["write"; "/cp_a1/file"; "file content"];
3108 ["cp_a"; "/cp_a1"; "/cp_a2"];
3109 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3110 "copy a file or directory recursively",
3112 This copies a file or directory from C<src> to C<dest>
3113 recursively using the C<cp -a> command.");
3115 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3116 [InitScratchFS, Always, TestOutput (
3118 ["write"; "/mv/old"; "file content"];
3119 ["mv"; "/mv/old"; "/mv/new"];
3120 ["cat"; "/mv/new"]], "file content");
3121 InitScratchFS, Always, TestOutputFalse (
3123 ["write"; "/mv2/old"; "file content"];
3124 ["mv"; "/mv2/old"; "/mv2/new"];
3125 ["is_file"; "/mv2/old"]])],
3128 This moves a file from C<src> to C<dest> where C<dest> is
3129 either a destination filename or destination directory.");
3131 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3132 [InitEmpty, Always, TestRun (
3133 [["drop_caches"; "3"]])],
3134 "drop kernel page cache, dentries and inodes",
3136 This instructs the guest kernel to drop its page cache,
3137 and/or dentries and inode caches. The parameter C<whattodrop>
3138 tells the kernel what precisely to drop, see
3139 L<http://linux-mm.org/Drop_Caches>
3141 Setting C<whattodrop> to 3 should drop everything.
3143 This automatically calls L<sync(2)> before the operation,
3144 so that the maximum guest memory is freed.");
3146 ("dmesg", (RString "kmsgs", [], []), 91, [],
3147 [InitEmpty, Always, TestRun (
3149 "return kernel messages",
3151 This returns the kernel messages (C<dmesg> output) from
3152 the guest kernel. This is sometimes useful for extended
3153 debugging of problems.
3155 Another way to get the same information is to enable
3156 verbose messages with C<guestfs_set_verbose> or by setting
3157 the environment variable C<LIBGUESTFS_DEBUG=1> before
3158 running the program.");
3160 ("ping_daemon", (RErr, [], []), 92, [],
3161 [InitEmpty, Always, TestRun (
3162 [["ping_daemon"]])],
3163 "ping the guest daemon",
3165 This is a test probe into the guestfs daemon running inside
3166 the qemu subprocess. Calling this function checks that the
3167 daemon responds to the ping message, without affecting the daemon
3168 or attached block device(s) in any other way.");
3170 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3171 [InitScratchFS, Always, TestOutputTrue (
3172 [["mkdir"; "/equal"];
3173 ["write"; "/equal/file1"; "contents of a file"];
3174 ["cp"; "/equal/file1"; "/equal/file2"];
3175 ["equal"; "/equal/file1"; "/equal/file2"]]);
3176 InitScratchFS, Always, TestOutputFalse (
3177 [["mkdir"; "/equal2"];
3178 ["write"; "/equal2/file1"; "contents of a file"];
3179 ["write"; "/equal2/file2"; "contents of another file"];
3180 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3181 InitScratchFS, Always, TestLastFail (
3182 [["mkdir"; "/equal3"];
3183 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3184 "test if two files have equal contents",
3186 This compares the two files C<file1> and C<file2> and returns
3187 true if their content is exactly equal, or false otherwise.
3189 The external L<cmp(1)> program is used for the comparison.");
3191 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3192 [InitISOFS, Always, TestOutputList (
3193 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3194 InitISOFS, Always, TestOutputList (
3195 [["strings"; "/empty"]], []);
3196 (* Test for RHBZ#579608, absolute symbolic links. *)
3197 InitISOFS, Always, TestRun (
3198 [["strings"; "/abssymlink"]])],
3199 "print the printable strings in a file",
3201 This runs the L<strings(1)> command on a file and returns
3202 the list of printable strings found.");
3204 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3205 [InitISOFS, Always, TestOutputList (
3206 [["strings_e"; "b"; "/known-5"]], []);
3207 InitScratchFS, Always, TestOutputList (
3208 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3209 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3210 "print the printable strings in a file",
3212 This is like the C<guestfs_strings> command, but allows you to
3213 specify the encoding of strings that are looked for in
3214 the source file C<path>.
3216 Allowed encodings are:
3222 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3223 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3227 Single 8-bit-byte characters.
3231 16-bit big endian strings such as those encoded in
3232 UTF-16BE or UCS-2BE.
3234 =item l (lower case letter L)
3236 16-bit little endian such as UTF-16LE and UCS-2LE.
3237 This is useful for examining binaries in Windows guests.
3241 32-bit big endian such as UCS-4BE.
3245 32-bit little endian such as UCS-4LE.
3249 The returned strings are transcoded to UTF-8.");
3251 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3252 [InitISOFS, Always, TestOutput (
3253 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3254 (* Test for RHBZ#501888c2 regression which caused large hexdump
3255 * commands to segfault.
3257 InitISOFS, Always, TestRun (
3258 [["hexdump"; "/100krandom"]]);
3259 (* Test for RHBZ#579608, absolute symbolic links. *)
3260 InitISOFS, Always, TestRun (
3261 [["hexdump"; "/abssymlink"]])],
3262 "dump a file in hexadecimal",
3264 This runs C<hexdump -C> on the given C<path>. The result is
3265 the human-readable, canonical hex dump of the file.");
3267 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3268 [InitNone, Always, TestOutput (
3269 [["part_disk"; "/dev/sda"; "mbr"];
3270 ["mkfs"; "ext3"; "/dev/sda1"];
3271 ["mount_options"; ""; "/dev/sda1"; "/"];
3272 ["write"; "/new"; "test file"];
3273 ["umount"; "/dev/sda1"];
3274 ["zerofree"; "/dev/sda1"];
3275 ["mount_options"; ""; "/dev/sda1"; "/"];
3276 ["cat"; "/new"]], "test file")],
3277 "zero unused inodes and disk blocks on ext2/3 filesystem",
3279 This runs the I<zerofree> program on C<device>. This program
3280 claims to zero unused inodes and disk blocks on an ext2/3
3281 filesystem, thus making it possible to compress the filesystem
3284 You should B<not> run this program if the filesystem is
3287 It is possible that using this program can damage the filesystem
3288 or data on the filesystem.");
3290 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3292 "resize an LVM physical volume",
3294 This resizes (expands or shrinks) an existing LVM physical
3295 volume to match the new size of the underlying device.");
3297 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3298 Int "cyls"; Int "heads"; Int "sectors";
3299 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3301 "modify a single partition on a block device",
3303 This runs L<sfdisk(8)> option to modify just the single
3304 partition C<n> (note: C<n> counts from 1).
3306 For other parameters, see C<guestfs_sfdisk>. You should usually
3307 pass C<0> for the cyls/heads/sectors parameters.
3309 See also: C<guestfs_part_add>");
3311 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3313 "display the partition table",
3315 This displays the partition table on C<device>, in the
3316 human-readable output of the L<sfdisk(8)> command. It is
3317 not intended to be parsed.
3319 See also: C<guestfs_part_list>");
3321 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3323 "display the kernel geometry",
3325 This displays the kernel's idea of the geometry of C<device>.
3327 The result is in human-readable format, and not designed to
3330 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3332 "display the disk geometry from the partition table",
3334 This displays the disk geometry of C<device> read from the
3335 partition table. Especially in the case where the underlying
3336 block device has been resized, this can be different from the
3337 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3339 The result is in human-readable format, and not designed to
3342 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3344 "activate or deactivate all volume groups",
3346 This command activates or (if C<activate> is false) deactivates
3347 all logical volumes in all volume groups.
3349 This command is the same as running C<vgchange -a y|n>");
3351 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3353 "activate or deactivate some volume groups",
3355 This command activates or (if C<activate> is false) deactivates
3356 all logical volumes in the listed volume groups C<volgroups>.
3358 This command is the same as running C<vgchange -a y|n volgroups...>
3360 Note that if C<volgroups> is an empty list then B<all> volume groups
3361 are activated or deactivated.");
3363 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3364 [InitNone, Always, TestOutput (
3365 [["part_disk"; "/dev/sda"; "mbr"];
3366 ["pvcreate"; "/dev/sda1"];
3367 ["vgcreate"; "VG"; "/dev/sda1"];
3368 ["lvcreate"; "LV"; "VG"; "10"];
3369 ["mkfs"; "ext2"; "/dev/VG/LV"];
3370 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3371 ["write"; "/new"; "test content"];
3373 ["lvresize"; "/dev/VG/LV"; "20"];
3374 ["e2fsck_f"; "/dev/VG/LV"];
3375 ["resize2fs"; "/dev/VG/LV"];
3376 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3377 ["cat"; "/new"]], "test content");
3378 InitNone, Always, TestRun (
3379 (* Make an LV smaller to test RHBZ#587484. *)
3380 [["part_disk"; "/dev/sda"; "mbr"];
3381 ["pvcreate"; "/dev/sda1"];
3382 ["vgcreate"; "VG"; "/dev/sda1"];
3383 ["lvcreate"; "LV"; "VG"; "20"];
3384 ["lvresize"; "/dev/VG/LV"; "10"]])],
3385 "resize an LVM logical volume",
3387 This resizes (expands or shrinks) an existing LVM logical
3388 volume to C<mbytes>. When reducing, data in the reduced part
3391 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3392 [], (* lvresize tests this *)
3393 "resize an ext2, ext3 or ext4 filesystem",
3395 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3396 the underlying device.
3398 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3399 on the C<device> before calling this command. For unknown reasons
3400 C<resize2fs> sometimes gives an error about this and sometimes not.
3401 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3402 calling this function.");
3404 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3405 [InitBasicFS, Always, TestOutputList (
3406 [["find"; "/"]], ["lost+found"]);
3407 InitBasicFS, Always, TestOutputList (
3411 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3412 InitScratchFS, Always, TestOutputList (
3413 [["mkdir_p"; "/find/b/c"];
3414 ["touch"; "/find/b/c/d"];
3415 ["find"; "/find/b/"]], ["c"; "c/d"])],
3416 "find all files and directories",
3418 This command lists out all files and directories, recursively,
3419 starting at C<directory>. It is essentially equivalent to
3420 running the shell command C<find directory -print> but some
3421 post-processing happens on the output, described below.
3423 This returns a list of strings I<without any prefix>. Thus
3424 if the directory structure was:
3430 then the returned list from C<guestfs_find> C</tmp> would be
3438 If C<directory> is not a directory, then this command returns
3441 The returned list is sorted.
3443 See also C<guestfs_find0>.");
3445 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3446 [], (* lvresize tests this *)
3447 "check an ext2/ext3 filesystem",
3449 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3450 filesystem checker on C<device>, noninteractively (I<-p>),
3451 even if the filesystem appears to be clean (I<-f>).
3453 This command is only needed because of C<guestfs_resize2fs>
3454 (q.v.). Normally you should use C<guestfs_fsck>.");
3456 ("sleep", (RErr, [Int "secs"], []), 109, [],
3457 [InitNone, Always, TestRun (
3459 "sleep for some seconds",
3461 Sleep for C<secs> seconds.");
3463 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3464 [InitNone, Always, TestOutputInt (
3465 [["part_disk"; "/dev/sda"; "mbr"];
3466 ["mkfs"; "ntfs"; "/dev/sda1"];
3467 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3468 InitNone, Always, TestOutputInt (
3469 [["part_disk"; "/dev/sda"; "mbr"];
3470 ["mkfs"; "ext2"; "/dev/sda1"];
3471 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3472 "probe NTFS volume",
3474 This command runs the L<ntfs-3g.probe(8)> command which probes
3475 an NTFS C<device> for mountability. (Not all NTFS volumes can
3476 be mounted read-write, and some cannot be mounted at all).
3478 C<rw> is a boolean flag. Set it to true if you want to test
3479 if the volume can be mounted read-write. Set it to false if
3480 you want to test if the volume can be mounted read-only.
3482 The return value is an integer which C<0> if the operation
3483 would succeed, or some non-zero value documented in the
3484 L<ntfs-3g.probe(8)> manual page.");
3486 ("sh", (RString "output", [String "command"], []), 111, [],
3487 [], (* XXX needs tests *)
3488 "run a command via the shell",
3490 This call runs a command from the guest filesystem via the
3493 This is like C<guestfs_command>, but passes the command to:
3495 /bin/sh -c \"command\"
3497 Depending on the guest's shell, this usually results in
3498 wildcards being expanded, shell expressions being interpolated
3501 All the provisos about C<guestfs_command> apply to this call.");
3503 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3504 [], (* XXX needs tests *)
3505 "run a command via the shell returning lines",
3507 This is the same as C<guestfs_sh>, but splits the result
3508 into a list of lines.
3510 See also: C<guestfs_command_lines>");
3512 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3513 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3514 * code in stubs.c, since all valid glob patterns must start with "/".
3515 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3517 [InitScratchFS, Always, TestOutputList (
3518 [["mkdir_p"; "/glob_expand/b/c"];
3519 ["touch"; "/glob_expand/b/c/d"];
3520 ["touch"; "/glob_expand/b/c/e"];
3521 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3522 InitScratchFS, Always, TestOutputList (
3523 [["mkdir_p"; "/glob_expand2/b/c"];
3524 ["touch"; "/glob_expand2/b/c/d"];
3525 ["touch"; "/glob_expand2/b/c/e"];
3526 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3527 InitScratchFS, Always, TestOutputList (
3528 [["mkdir_p"; "/glob_expand3/b/c"];
3529 ["touch"; "/glob_expand3/b/c/d"];
3530 ["touch"; "/glob_expand3/b/c/e"];
3531 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3532 "expand a wildcard path",
3534 This command searches for all the pathnames matching
3535 C<pattern> according to the wildcard expansion rules
3538 If no paths match, then this returns an empty list
3539 (note: not an error).
3541 It is just a wrapper around the C L<glob(3)> function
3542 with flags C<GLOB_MARK|GLOB_BRACE>.
3543 See that manual page for more details.");
3545 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3546 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3547 [["scrub_device"; "/dev/sdc"]])],
3548 "scrub (securely wipe) a device",
3550 This command writes patterns over C<device> to make data retrieval
3553 It is an interface to the L<scrub(1)> program. See that
3554 manual page for more details.");
3556 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3557 [InitScratchFS, Always, TestRun (
3558 [["write"; "/scrub_file"; "content"];
3559 ["scrub_file"; "/scrub_file"]])],
3560 "scrub (securely wipe) a file",
3562 This command writes patterns over a file to make data retrieval
3565 The file is I<removed> after scrubbing.
3567 It is an interface to the L<scrub(1)> program. See that
3568 manual page for more details.");
3570 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3571 [], (* XXX needs testing *)
3572 "scrub (securely wipe) free space",
3574 This command creates the directory C<dir> and then fills it
3575 with files until the filesystem is full, and scrubs the files
3576 as for C<guestfs_scrub_file>, and deletes them.
3577 The intention is to scrub any free space on the partition
3580 It is an interface to the L<scrub(1)> program. See that
3581 manual page for more details.");
3583 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3584 [InitScratchFS, Always, TestRun (
3585 [["mkdir"; "/mkdtemp"];
3586 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3587 "create a temporary directory",
3589 This command creates a temporary directory. The
3590 C<template> parameter should be a full pathname for the
3591 temporary directory name with the final six characters being
3594 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3595 the second one being suitable for Windows filesystems.
3597 The name of the temporary directory that was created
3600 The temporary directory is created with mode 0700
3601 and is owned by root.
3603 The caller is responsible for deleting the temporary
3604 directory and its contents after use.
3606 See also: L<mkdtemp(3)>");
3608 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3609 [InitISOFS, Always, TestOutputInt (
3610 [["wc_l"; "/10klines"]], 10000);
3611 (* Test for RHBZ#579608, absolute symbolic links. *)
3612 InitISOFS, Always, TestOutputInt (
3613 [["wc_l"; "/abssymlink"]], 10000)],
3614 "count lines in a file",
3616 This command counts the lines in a file, using the
3617 C<wc -l> external command.");
3619 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3620 [InitISOFS, Always, TestOutputInt (
3621 [["wc_w"; "/10klines"]], 10000)],
3622 "count words in a file",
3624 This command counts the words in a file, using the
3625 C<wc -w> external command.");
3627 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3628 [InitISOFS, Always, TestOutputInt (
3629 [["wc_c"; "/100kallspaces"]], 102400)],
3630 "count characters in a file",
3632 This command counts the characters in a file, using the
3633 C<wc -c> external command.");
3635 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3636 [InitISOFS, Always, TestOutputList (
3637 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3638 (* Test for RHBZ#579608, absolute symbolic links. *)
3639 InitISOFS, Always, TestOutputList (
3640 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3641 "return first 10 lines of a file",
3643 This command returns up to the first 10 lines of a file as
3644 a list of strings.");
3646 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3647 [InitISOFS, Always, TestOutputList (
3648 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3649 InitISOFS, Always, TestOutputList (
3650 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3651 InitISOFS, Always, TestOutputList (
3652 [["head_n"; "0"; "/10klines"]], [])],
3653 "return first N lines of a file",
3655 If the parameter C<nrlines> is a positive number, this returns the first
3656 C<nrlines> lines of the file C<path>.
3658 If the parameter C<nrlines> is a negative number, this returns lines
3659 from the file C<path>, excluding the last C<nrlines> lines.
3661 If the parameter C<nrlines> is zero, this returns an empty list.");
3663 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3664 [InitISOFS, Always, TestOutputList (
3665 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3666 "return last 10 lines of a file",
3668 This command returns up to the last 10 lines of a file as
3669 a list of strings.");
3671 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3672 [InitISOFS, Always, TestOutputList (
3673 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3674 InitISOFS, Always, TestOutputList (
3675 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3676 InitISOFS, Always, TestOutputList (
3677 [["tail_n"; "0"; "/10klines"]], [])],
3678 "return last N lines of a file",
3680 If the parameter C<nrlines> is a positive number, this returns the last
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>, starting with the C<-nrlines>th line.
3686 If the parameter C<nrlines> is zero, this returns an empty list.");
3688 ("df", (RString "output", [], []), 125, [],
3689 [], (* XXX Tricky to test because it depends on the exact format
3690 * of the 'df' command and other imponderables.
3692 "report file system disk space usage",
3694 This command runs the C<df> command to report disk space used.
3696 This command is mostly useful for interactive sessions. It
3697 is I<not> intended that you try to parse the output string.
3698 Use C<guestfs_statvfs> from programs.");
3700 ("df_h", (RString "output", [], []), 126, [],
3701 [], (* XXX Tricky to test because it depends on the exact format
3702 * of the 'df' command and other imponderables.
3704 "report file system disk space usage (human readable)",
3706 This command runs the C<df -h> command to report disk space used
3707 in human-readable format.
3709 This command is mostly useful for interactive sessions. It
3710 is I<not> intended that you try to parse the output string.
3711 Use C<guestfs_statvfs> from programs.");
3713 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3714 [InitISOFS, Always, TestOutputInt (
3715 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3716 "estimate file space usage",
3718 This command runs the C<du -s> command to estimate file space
3721 C<path> can be a file or a directory. If C<path> is a directory
3722 then the estimate includes the contents of the directory and all
3723 subdirectories (recursively).
3725 The result is the estimated size in I<kilobytes>
3726 (ie. units of 1024 bytes).");
3728 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3729 [InitISOFS, Always, TestOutputList (
3730 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3731 "list files in an initrd",
3733 This command lists out files contained in an initrd.
3735 The files are listed without any initial C</> character. The
3736 files are listed in the order they appear (not necessarily
3737 alphabetical). Directory names are listed as separate items.
3739 Old Linux kernels (2.4 and earlier) used a compressed ext2
3740 filesystem as initrd. We I<only> support the newer initramfs
3741 format (compressed cpio files).");
3743 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3745 "mount a file using the loop device",
3747 This command lets you mount C<file> (a filesystem image
3748 in a file) on a mount point. It is entirely equivalent to
3749 the command C<mount -o loop file mountpoint>.");
3751 ("mkswap", (RErr, [Device "device"], []), 130, [],
3752 [InitEmpty, Always, TestRun (
3753 [["part_disk"; "/dev/sda"; "mbr"];
3754 ["mkswap"; "/dev/sda1"]])],
3755 "create a swap partition",
3757 Create a swap partition on C<device>.");
3759 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3760 [InitEmpty, Always, TestRun (
3761 [["part_disk"; "/dev/sda"; "mbr"];
3762 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3763 "create a swap partition with a label",
3765 Create a swap partition on C<device> with label C<label>.
3767 Note that you cannot attach a swap label to a block device
3768 (eg. C</dev/sda>), just to a partition. This appears to be
3769 a limitation of the kernel or swap tools.");
3771 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3772 (let uuid = uuidgen () in
3773 [InitEmpty, Always, TestRun (
3774 [["part_disk"; "/dev/sda"; "mbr"];
3775 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3776 "create a swap partition with an explicit UUID",
3778 Create a swap partition on C<device> with UUID C<uuid>.");
3780 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3781 [InitScratchFS, Always, TestOutputStruct (
3782 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3783 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3784 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3785 InitScratchFS, Always, TestOutputStruct (
3786 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3787 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3788 "make block, character or FIFO devices",
3790 This call creates block or character special devices, or
3791 named pipes (FIFOs).
3793 The C<mode> parameter should be the mode, using the standard
3794 constants. C<devmajor> and C<devminor> are the
3795 device major and minor numbers, only used when creating block
3796 and character special devices.
3798 Note that, just like L<mknod(2)>, the mode must be bitwise
3799 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3800 just creates a regular file). These constants are
3801 available in the standard Linux header files, or you can use
3802 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3803 which are wrappers around this command which bitwise OR
3804 in the appropriate constant for you.
3806 The mode actually set is affected by the umask.");
3808 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3809 [InitScratchFS, Always, TestOutputStruct (
3810 [["mkfifo"; "0o777"; "/mkfifo"];
3811 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3812 "make FIFO (named pipe)",
3814 This call creates a FIFO (named pipe) called C<path> with
3815 mode C<mode>. It is just a convenient wrapper around
3818 The mode actually set is affected by the umask.");
3820 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3821 [InitScratchFS, Always, TestOutputStruct (
3822 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3823 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3824 "make block device node",
3826 This call creates a block device node called C<path> with
3827 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3828 It is just a convenient wrapper around C<guestfs_mknod>.
3830 The mode actually set is affected by the umask.");
3832 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3833 [InitScratchFS, Always, TestOutputStruct (
3834 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3835 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3836 "make char device node",
3838 This call creates a char device node called C<path> with
3839 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3840 It is just a convenient wrapper around C<guestfs_mknod>.
3842 The mode actually set is affected by the umask.");
3844 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3845 [InitEmpty, Always, TestOutputInt (
3846 [["umask"; "0o22"]], 0o22)],
3847 "set file mode creation mask (umask)",
3849 This function sets the mask used for creating new files and
3850 device nodes to C<mask & 0777>.
3852 Typical umask values would be C<022> which creates new files
3853 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3854 C<002> which creates new files with permissions like
3855 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3857 The default umask is C<022>. This is important because it
3858 means that directories and device nodes will be created with
3859 C<0644> or C<0755> mode even if you specify C<0777>.
3861 See also C<guestfs_get_umask>,
3862 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3864 This call returns the previous umask.");
3866 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3868 "read directories entries",
3870 This returns the list of directory entries in directory C<dir>.
3872 All entries in the directory are returned, including C<.> and
3873 C<..>. The entries are I<not> sorted, but returned in the same
3874 order as the underlying filesystem.
3876 Also this call returns basic file type information about each
3877 file. The C<ftyp> field will contain one of the following characters:
3915 The L<readdir(3)> call returned a C<d_type> field with an
3920 This function is primarily intended for use by programs. To
3921 get a simple list of names, use C<guestfs_ls>. To get a printable
3922 directory for human consumption, use C<guestfs_ll>.");
3924 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3926 "create partitions on a block device",
3928 This is a simplified interface to the C<guestfs_sfdisk>
3929 command, where partition sizes are specified in megabytes
3930 only (rounded to the nearest cylinder) and you don't need
3931 to specify the cyls, heads and sectors parameters which
3932 were rarely if ever used anyway.
3934 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3935 and C<guestfs_part_disk>");
3937 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3939 "determine file type inside a compressed file",
3941 This command runs C<file> after first decompressing C<path>
3944 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3946 Since 1.0.63, use C<guestfs_file> instead which can now
3947 process compressed files.");
3949 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3951 "list extended attributes of a file or directory",
3953 This call lists the extended attributes of the file or directory
3956 At the system call level, this is a combination of the
3957 L<listxattr(2)> and L<getxattr(2)> calls.
3959 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3961 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3963 "list extended attributes of a file or directory",
3965 This is the same as C<guestfs_getxattrs>, but if C<path>
3966 is a symbolic link, then it returns the extended attributes
3967 of the link itself.");
3969 ("setxattr", (RErr, [String "xattr";
3970 String "val"; Int "vallen"; (* will be BufferIn *)
3971 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3973 "set extended attribute of a file or directory",
3975 This call sets the extended attribute named C<xattr>
3976 of the file C<path> to the value C<val> (of length C<vallen>).
3977 The value is arbitrary 8 bit data.
3979 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3981 ("lsetxattr", (RErr, [String "xattr";
3982 String "val"; Int "vallen"; (* will be BufferIn *)
3983 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3985 "set extended attribute of a file or directory",
3987 This is the same as C<guestfs_setxattr>, but if C<path>
3988 is a symbolic link, then it sets an extended attribute
3989 of the link itself.");
3991 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3993 "remove extended attribute of a file or directory",
3995 This call removes the extended attribute named C<xattr>
3996 of the file C<path>.
3998 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
4000 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
4002 "remove extended attribute of a file or directory",
4004 This is the same as C<guestfs_removexattr>, but if C<path>
4005 is a symbolic link, then it removes an extended attribute
4006 of the link itself.");
4008 ("mountpoints", (RHashtable "mps", [], []), 147, [],
4012 This call is similar to C<guestfs_mounts>. That call returns
4013 a list of devices. This one returns a hash table (map) of
4014 device name to directory where the device is mounted.");
4016 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
4017 (* This is a special case: while you would expect a parameter
4018 * of type "Pathname", that doesn't work, because it implies
4019 * NEED_ROOT in the generated calling code in stubs.c, and
4020 * this function cannot use NEED_ROOT.
4023 "create a mountpoint",
4025 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
4026 specialized calls that can be used to create extra mountpoints
4027 before mounting the first filesystem.
4029 These calls are I<only> necessary in some very limited circumstances,
4030 mainly the case where you want to mount a mix of unrelated and/or
4031 read-only filesystems together.
4033 For example, live CDs often contain a \"Russian doll\" nest of
4034 filesystems, an ISO outer layer, with a squashfs image inside, with
4035 an ext2/3 image inside that. You can unpack this as follows
4038 add-ro Fedora-11-i686-Live.iso
4042 mkmountpoint /ext3fs
4044 mount-loop /cd/LiveOS/squashfs.img /sqsh
4045 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4047 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4049 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4050 You may get unexpected errors if you try to mix these calls. It is
4051 safest to manually unmount filesystems and remove mountpoints after use.
4053 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4054 longest first, so for this to work for manual mountpoints, you
4055 must ensure that the innermost mountpoints have the longest
4056 pathnames, as in the example code above.
4058 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4060 Autosync [see C<guestfs_set_autosync>, this is set by default on
4061 handles] can cause C<guestfs_umount_all> to be called when the handle
4062 is closed which can also trigger these issues.");
4064 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4066 "remove a mountpoint",
4068 This calls removes a mountpoint that was previously created
4069 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4070 for full details.");
4072 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4073 [InitISOFS, Always, TestOutputBuffer (
4074 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4075 (* Test various near large, large and too large files (RHBZ#589039). *)
4076 InitScratchFS, Always, TestLastFail (
4077 [["touch"; "/read_file"];
4078 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4079 ["read_file"; "/read_file"]]);
4080 InitScratchFS, Always, TestLastFail (
4081 [["touch"; "/read_file2"];
4082 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4083 ["read_file"; "/read_file2"]]);
4084 InitScratchFS, Always, TestLastFail (
4085 [["touch"; "/read_file3"];
4086 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4087 ["read_file"; "/read_file3"]])],
4090 This calls returns the contents of the file C<path> as a
4093 Unlike C<guestfs_cat>, this function can correctly
4094 handle files that contain embedded ASCII NUL characters.
4095 However unlike C<guestfs_download>, this function is limited
4096 in the total size of file that can be handled.");
4098 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4099 [InitISOFS, Always, TestOutputList (
4100 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4101 InitISOFS, Always, TestOutputList (
4102 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4103 (* Test for RHBZ#579608, absolute symbolic links. *)
4104 InitISOFS, Always, TestOutputList (
4105 [["grep"; "nomatch"; "/abssymlink"]], [])],
4106 "return lines matching a pattern",
4108 This calls the external C<grep> program and returns the
4111 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4112 [InitISOFS, Always, TestOutputList (
4113 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4114 "return lines matching a pattern",
4116 This calls the external C<egrep> program and returns the
4119 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4120 [InitISOFS, Always, TestOutputList (
4121 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4122 "return lines matching a pattern",
4124 This calls the external C<fgrep> program and returns the
4127 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4128 [InitISOFS, Always, TestOutputList (
4129 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4130 "return lines matching a pattern",
4132 This calls the external C<grep -i> program and returns the
4135 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4136 [InitISOFS, Always, TestOutputList (
4137 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4138 "return lines matching a pattern",
4140 This calls the external C<egrep -i> program and returns the
4143 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4144 [InitISOFS, Always, TestOutputList (
4145 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4146 "return lines matching a pattern",
4148 This calls the external C<fgrep -i> program and returns the
4151 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4152 [InitISOFS, Always, TestOutputList (
4153 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4154 "return lines matching a pattern",
4156 This calls the external C<zgrep> program and returns the
4159 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4160 [InitISOFS, Always, TestOutputList (
4161 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4162 "return lines matching a pattern",
4164 This calls the external C<zegrep> program and returns the
4167 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4168 [InitISOFS, Always, TestOutputList (
4169 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4170 "return lines matching a pattern",
4172 This calls the external C<zfgrep> program and returns the
4175 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4176 [InitISOFS, Always, TestOutputList (
4177 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4178 "return lines matching a pattern",
4180 This calls the external C<zgrep -i> program and returns the
4183 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4184 [InitISOFS, Always, TestOutputList (
4185 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4186 "return lines matching a pattern",
4188 This calls the external C<zegrep -i> program and returns the
4191 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4192 [InitISOFS, Always, TestOutputList (
4193 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4194 "return lines matching a pattern",
4196 This calls the external C<zfgrep -i> program and returns the
4199 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4200 [InitISOFS, Always, TestOutput (
4201 [["realpath"; "/../directory"]], "/directory")],
4202 "canonicalized absolute pathname",
4204 Return the canonicalized absolute pathname of C<path>. The
4205 returned path has no C<.>, C<..> or symbolic link path elements.");
4207 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4208 [InitScratchFS, Always, TestOutputStruct (
4211 ["ln"; "/ln/a"; "/ln/b"];
4212 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4213 "create a hard link",
4215 This command creates a hard link using the C<ln> command.");
4217 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4218 [InitScratchFS, Always, TestOutputStruct (
4219 [["mkdir"; "/ln_f"];
4220 ["touch"; "/ln_f/a"];
4221 ["touch"; "/ln_f/b"];
4222 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4223 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4224 "create a hard link",
4226 This command creates a hard link using the C<ln -f> command.
4227 The I<-f> option removes the link (C<linkname>) if it exists already.");
4229 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4230 [InitScratchFS, Always, TestOutputStruct (
4231 [["mkdir"; "/ln_s"];
4232 ["touch"; "/ln_s/a"];
4233 ["ln_s"; "a"; "/ln_s/b"];
4234 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4235 "create a symbolic link",
4237 This command creates a symbolic link using the C<ln -s> command.");
4239 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4240 [InitScratchFS, Always, TestOutput (
4241 [["mkdir_p"; "/ln_sf/b"];
4242 ["touch"; "/ln_sf/b/c"];
4243 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4244 ["readlink"; "/ln_sf/b/c"]], "../d")],
4245 "create a symbolic link",
4247 This command creates a symbolic link using the C<ln -sf> command,
4248 The I<-f> option removes the link (C<linkname>) if it exists already.");
4250 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4251 [] (* XXX tested above *),
4252 "read the target of a symbolic link",
4254 This command reads the target of a symbolic link.");
4256 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4257 [InitScratchFS, Always, TestOutputStruct (
4258 [["fallocate"; "/fallocate"; "1000000"];
4259 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4260 "preallocate a file in the guest filesystem",
4262 This command preallocates a file (containing zero bytes) named
4263 C<path> of size C<len> bytes. If the file exists already, it
4266 Do not confuse this with the guestfish-specific
4267 C<alloc> command which allocates a file in the host and
4268 attaches it as a device.");
4270 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4271 [InitPartition, Always, TestRun (
4272 [["mkswap"; "/dev/sda1"];
4273 ["swapon_device"; "/dev/sda1"];
4274 ["swapoff_device"; "/dev/sda1"]])],
4275 "enable swap on device",
4277 This command enables the libguestfs appliance to use the
4278 swap device or partition named C<device>. The increased
4279 memory is made available for all commands, for example
4280 those run using C<guestfs_command> or C<guestfs_sh>.
4282 Note that you should not swap to existing guest swap
4283 partitions unless you know what you are doing. They may
4284 contain hibernation information, or other information that
4285 the guest doesn't want you to trash. You also risk leaking
4286 information about the host to the guest this way. Instead,
4287 attach a new host device to the guest and swap on that.");
4289 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4290 [], (* XXX tested by swapon_device *)
4291 "disable swap on device",
4293 This command disables the libguestfs appliance swap
4294 device or partition named C<device>.
4295 See C<guestfs_swapon_device>.");
4297 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4298 [InitScratchFS, Always, TestRun (
4299 [["fallocate"; "/swapon_file"; "8388608"];
4300 ["mkswap_file"; "/swapon_file"];
4301 ["swapon_file"; "/swapon_file"];
4302 ["swapoff_file"; "/swapon_file"];
4303 ["rm"; "/swapon_file"]])],
4304 "enable swap on file",
4306 This command enables swap to a file.
4307 See C<guestfs_swapon_device> for other notes.");
4309 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4310 [], (* XXX tested by swapon_file *)
4311 "disable swap on file",
4313 This command disables the libguestfs appliance swap on file.");
4315 ("swapon_label", (RErr, [String "label"], []), 174, [],
4316 [InitEmpty, Always, TestRun (
4317 [["part_disk"; "/dev/sda"; "mbr"];
4318 ["mkswap_L"; "swapit"; "/dev/sda1"];
4319 ["swapon_label"; "swapit"];
4320 ["swapoff_label"; "swapit"];
4321 ["zero"; "/dev/sda"];
4322 ["blockdev_rereadpt"; "/dev/sda"]])],
4323 "enable swap on labeled swap partition",
4325 This command enables swap to a labeled swap partition.
4326 See C<guestfs_swapon_device> for other notes.");
4328 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4329 [], (* XXX tested by swapon_label *)
4330 "disable swap on labeled swap partition",
4332 This command disables the libguestfs appliance swap on
4333 labeled swap partition.");
4335 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4336 (let uuid = uuidgen () in
4337 [InitEmpty, Always, TestRun (
4338 [["mkswap_U"; uuid; "/dev/sdc"];
4339 ["swapon_uuid"; uuid];
4340 ["swapoff_uuid"; uuid]])]),
4341 "enable swap on swap partition by UUID",
4343 This command enables swap to a swap partition with the given UUID.
4344 See C<guestfs_swapon_device> for other notes.");
4346 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4347 [], (* XXX tested by swapon_uuid *)
4348 "disable swap on swap partition by UUID",
4350 This command disables the libguestfs appliance swap partition
4351 with the given UUID.");
4353 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4354 [InitScratchFS, Always, TestRun (
4355 [["fallocate"; "/mkswap_file"; "8388608"];
4356 ["mkswap_file"; "/mkswap_file"];
4357 ["rm"; "/mkswap_file"]])],
4358 "create a swap file",
4362 This command just writes a swap file signature to an existing
4363 file. To create the file itself, use something like C<guestfs_fallocate>.");
4365 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4366 [InitISOFS, Always, TestRun (
4367 [["inotify_init"; "0"]])],
4368 "create an inotify handle",
4370 This command creates a new inotify handle.
4371 The inotify subsystem can be used to notify events which happen to
4372 objects in the guest filesystem.
4374 C<maxevents> is the maximum number of events which will be
4375 queued up between calls to C<guestfs_inotify_read> or
4376 C<guestfs_inotify_files>.
4377 If this is passed as C<0>, then the kernel (or previously set)
4378 default is used. For Linux 2.6.29 the default was 16384 events.
4379 Beyond this limit, the kernel throws away events, but records
4380 the fact that it threw them away by setting a flag
4381 C<IN_Q_OVERFLOW> in the returned structure list (see
4382 C<guestfs_inotify_read>).
4384 Before any events are generated, you have to add some
4385 watches to the internal watch list. See:
4386 C<guestfs_inotify_add_watch>,
4387 C<guestfs_inotify_rm_watch> and
4388 C<guestfs_inotify_watch_all>.
4390 Queued up events should be read periodically by calling
4391 C<guestfs_inotify_read>
4392 (or C<guestfs_inotify_files> which is just a helpful
4393 wrapper around C<guestfs_inotify_read>). If you don't
4394 read the events out often enough then you risk the internal
4397 The handle should be closed after use by calling
4398 C<guestfs_inotify_close>. This also removes any
4399 watches automatically.
4401 See also L<inotify(7)> for an overview of the inotify interface
4402 as exposed by the Linux kernel, which is roughly what we expose
4403 via libguestfs. Note that there is one global inotify handle
4404 per libguestfs instance.");
4406 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4407 [InitScratchFS, Always, TestOutputList (
4408 [["mkdir"; "/inotify_add_watch"];
4409 ["inotify_init"; "0"];
4410 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4411 ["touch"; "/inotify_add_watch/a"];
4412 ["touch"; "/inotify_add_watch/b"];
4413 ["inotify_files"]], ["a"; "b"])],
4414 "add an inotify watch",
4416 Watch C<path> for the events listed in C<mask>.
4418 Note that if C<path> is a directory then events within that
4419 directory are watched, but this does I<not> happen recursively
4420 (in subdirectories).
4422 Note for non-C or non-Linux callers: the inotify events are
4423 defined by the Linux kernel ABI and are listed in
4424 C</usr/include/sys/inotify.h>.");
4426 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4428 "remove an inotify watch",
4430 Remove a previously defined inotify watch.
4431 See C<guestfs_inotify_add_watch>.");
4433 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4435 "return list of inotify events",
4437 Return the complete queue of events that have happened
4438 since the previous read call.
4440 If no events have happened, this returns an empty list.
4442 I<Note>: In order to make sure that all events have been
4443 read, you must call this function repeatedly until it
4444 returns an empty list. The reason is that the call will
4445 read events up to the maximum appliance-to-host message
4446 size and leave remaining events in the queue.");
4448 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4450 "return list of watched files that had events",
4452 This function is a helpful wrapper around C<guestfs_inotify_read>
4453 which just returns a list of pathnames of objects that were
4454 touched. The returned pathnames are sorted and deduplicated.");
4456 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4458 "close the inotify handle",
4460 This closes the inotify handle which was previously
4461 opened by inotify_init. It removes all watches, throws
4462 away any pending events, and deallocates all resources.");
4464 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4466 "set SELinux security context",
4468 This sets the SELinux security context of the daemon
4469 to the string C<context>.
4471 See the documentation about SELINUX in L<guestfs(3)>.");
4473 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4475 "get SELinux security context",
4477 This gets the SELinux security context of the daemon.
4479 See the documentation about SELINUX in L<guestfs(3)>,
4480 and C<guestfs_setcon>");
4482 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4483 [InitEmpty, Always, TestOutput (
4484 [["part_disk"; "/dev/sda"; "mbr"];
4485 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4486 ["mount_options"; ""; "/dev/sda1"; "/"];
4487 ["write"; "/new"; "new file contents"];
4488 ["cat"; "/new"]], "new file contents");
4489 InitEmpty, Always, TestRun (
4490 [["part_disk"; "/dev/sda"; "mbr"];
4491 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4492 InitEmpty, Always, TestLastFail (
4493 [["part_disk"; "/dev/sda"; "mbr"];
4494 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4495 InitEmpty, Always, TestLastFail (
4496 [["part_disk"; "/dev/sda"; "mbr"];
4497 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4498 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4499 [["part_disk"; "/dev/sda"; "mbr"];
4500 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4501 "make a filesystem with block size",
4503 This call is similar to C<guestfs_mkfs>, but it allows you to
4504 control the block size of the resulting filesystem. Supported
4505 block sizes depend on the filesystem type, but typically they
4506 are C<1024>, C<2048> or C<4096> only.
4508 For VFAT and NTFS the C<blocksize> parameter is treated as
4509 the requested cluster size.");
4511 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4512 [InitEmpty, Always, TestOutput (
4513 [["part_init"; "/dev/sda"; "mbr"];
4514 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4515 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4516 ["mke2journal"; "4096"; "/dev/sda1"];
4517 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4518 ["mount_options"; ""; "/dev/sda2"; "/"];
4519 ["write"; "/new"; "new file contents"];
4520 ["cat"; "/new"]], "new file contents")],
4521 "make ext2/3/4 external journal",
4523 This creates an ext2 external journal on C<device>. It is equivalent
4526 mke2fs -O journal_dev -b blocksize device");
4528 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4529 [InitEmpty, Always, TestOutput (
4530 [["part_init"; "/dev/sda"; "mbr"];
4531 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4532 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4533 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4534 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4535 ["mount_options"; ""; "/dev/sda2"; "/"];
4536 ["write"; "/new"; "new file contents"];
4537 ["cat"; "/new"]], "new file contents")],
4538 "make ext2/3/4 external journal with label",
4540 This creates an ext2 external journal on C<device> with label C<label>.");
4542 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4543 (let uuid = uuidgen () in
4544 [InitEmpty, Always, TestOutput (
4545 [["part_init"; "/dev/sda"; "mbr"];
4546 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4547 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4548 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4549 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4550 ["mount_options"; ""; "/dev/sda2"; "/"];
4551 ["write"; "/new"; "new file contents"];
4552 ["cat"; "/new"]], "new file contents")]),
4553 "make ext2/3/4 external journal with UUID",
4555 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4557 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4559 "make ext2/3/4 filesystem with external journal",
4561 This creates an ext2/3/4 filesystem on C<device> with
4562 an external journal on C<journal>. It is equivalent
4565 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4567 See also C<guestfs_mke2journal>.");
4569 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4571 "make ext2/3/4 filesystem with external journal",
4573 This creates an ext2/3/4 filesystem on C<device> with
4574 an external journal on the journal labeled C<label>.
4576 See also C<guestfs_mke2journal_L>.");
4578 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4580 "make ext2/3/4 filesystem with external journal",
4582 This creates an ext2/3/4 filesystem on C<device> with
4583 an external journal on the journal with UUID C<uuid>.
4585 See also C<guestfs_mke2journal_U>.");
4587 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4588 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4589 "load a kernel module",
4591 This loads a kernel module in the appliance.
4593 The kernel module must have been whitelisted when libguestfs
4594 was built (see C<appliance/kmod.whitelist.in> in the source).");
4596 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4597 [InitNone, Always, TestOutput (
4598 [["echo_daemon"; "This is a test"]], "This is a test"
4600 "echo arguments back to the client",
4602 This command concatenates the list of C<words> passed with single spaces
4603 between them and returns the resulting string.
4605 You can use this command to test the connection through to the daemon.
4607 See also C<guestfs_ping_daemon>.");
4609 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4610 [], (* There is a regression test for this. *)
4611 "find all files and directories, returning NUL-separated list",
4613 This command lists out all files and directories, recursively,
4614 starting at C<directory>, placing the resulting list in the
4615 external file called C<files>.
4617 This command works the same way as C<guestfs_find> with the
4618 following exceptions:
4624 The resulting list is written to an external file.
4628 Items (filenames) in the result are separated
4629 by C<\\0> characters. See L<find(1)> option I<-print0>.
4633 This command is not limited in the number of names that it
4638 The result list is not sorted.
4642 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4643 [InitISOFS, Always, TestOutput (
4644 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4645 InitISOFS, Always, TestOutput (
4646 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4647 InitISOFS, Always, TestOutput (
4648 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4649 InitISOFS, Always, TestLastFail (
4650 [["case_sensitive_path"; "/Known-1/"]]);
4651 InitScratchFS, Always, TestOutput (
4652 [["mkdir"; "/case_sensitive_path"];
4653 ["mkdir"; "/case_sensitive_path/bbb"];
4654 ["touch"; "/case_sensitive_path/bbb/c"];
4655 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4656 InitScratchFS, Always, TestOutput (
4657 [["mkdir"; "/case_sensitive_path2"];
4658 ["mkdir"; "/case_sensitive_path2/bbb"];
4659 ["touch"; "/case_sensitive_path2/bbb/c"];
4660 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4661 InitScratchFS, Always, TestLastFail (
4662 [["mkdir"; "/case_sensitive_path3"];
4663 ["mkdir"; "/case_sensitive_path3/bbb"];
4664 ["touch"; "/case_sensitive_path3/bbb/c"];
4665 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4666 "return true path on case-insensitive filesystem",
4668 This can be used to resolve case insensitive paths on
4669 a filesystem which is case sensitive. The use case is
4670 to resolve paths which you have read from Windows configuration
4671 files or the Windows Registry, to the true path.
4673 The command handles a peculiarity of the Linux ntfs-3g
4674 filesystem driver (and probably others), which is that although
4675 the underlying filesystem is case-insensitive, the driver
4676 exports the filesystem to Linux as case-sensitive.
4678 One consequence of this is that special directories such
4679 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4680 (or other things) depending on the precise details of how
4681 they were created. In Windows itself this would not be
4684 Bug or feature? You decide:
4685 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4687 This function resolves the true case of each element in the
4688 path and returns the case-sensitive path.
4690 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4691 might return C<\"/WINDOWS/system32\"> (the exact return value
4692 would depend on details of how the directories were originally
4693 created under Windows).
4696 This function does not handle drive names, backslashes etc.
4698 See also C<guestfs_realpath>.");
4700 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4701 [InitScratchFS, Always, TestOutput (
4702 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4703 "get the Linux VFS type corresponding to a mounted device",
4705 This command gets the filesystem type corresponding to
4706 the filesystem on C<device>.
4708 For most filesystems, the result is the name of the Linux
4709 VFS module which would be used to mount this filesystem
4710 if you mounted it without specifying the filesystem type.
4711 For example a string such as C<ext3> or C<ntfs>.");
4713 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4714 [InitScratchFS, Always, TestOutputStruct (
4715 [["write"; "/truncate"; "some stuff so size is not zero"];
4716 ["truncate"; "/truncate"];
4717 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4718 "truncate a file to zero size",
4720 This command truncates C<path> to a zero-length file. The
4721 file must exist already.");
4723 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4724 [InitScratchFS, Always, TestOutputStruct (
4725 [["touch"; "/truncate_size"];
4726 ["truncate_size"; "/truncate_size"; "1000"];
4727 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4728 "truncate a file to a particular size",
4730 This command truncates C<path> to size C<size> bytes. The file
4733 If the current file size is less than C<size> then
4734 the file is extended to the required size with zero bytes.
4735 This creates a sparse file (ie. disk blocks are not allocated
4736 for the file until you write to it). To create a non-sparse
4737 file of zeroes, use C<guestfs_fallocate64> instead.");
4739 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4740 [InitScratchFS, Always, TestOutputStruct (
4741 [["touch"; "/utimens"];
4742 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4743 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4744 "set timestamp of a file with nanosecond precision",
4746 This command sets the timestamps of a file with nanosecond
4749 C<atsecs, atnsecs> are the last access time (atime) in secs and
4750 nanoseconds from the epoch.
4752 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4753 secs and nanoseconds from the epoch.
4755 If the C<*nsecs> field contains the special value C<-1> then
4756 the corresponding timestamp is set to the current time. (The
4757 C<*secs> field is ignored in this case).
4759 If the C<*nsecs> field contains the special value C<-2> then
4760 the corresponding timestamp is left unchanged. (The
4761 C<*secs> field is ignored in this case).");
4763 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4764 [InitScratchFS, Always, TestOutputStruct (
4765 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4766 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4767 "create a directory with a particular mode",
4769 This command creates a directory, setting the initial permissions
4770 of the directory to C<mode>.
4772 For common Linux filesystems, the actual mode which is set will
4773 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4774 interpret the mode in other ways.
4776 See also C<guestfs_mkdir>, C<guestfs_umask>");
4778 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4780 "change file owner and group",
4782 Change the file owner to C<owner> and group to C<group>.
4783 This is like C<guestfs_chown> but if C<path> is a symlink then
4784 the link itself is changed, not the target.
4786 Only numeric uid and gid are supported. If you want to use
4787 names, you will need to locate and parse the password file
4788 yourself (Augeas support makes this relatively easy).");
4790 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4792 "lstat on multiple files",
4794 This call allows you to perform the C<guestfs_lstat> operation
4795 on multiple files, where all files are in the directory C<path>.
4796 C<names> is the list of files from this directory.
4798 On return you get a list of stat structs, with a one-to-one
4799 correspondence to the C<names> list. If any name did not exist
4800 or could not be lstat'd, then the C<ino> field of that structure
4803 This call is intended for programs that want to efficiently
4804 list a directory contents without making many round-trips.
4805 See also C<guestfs_lxattrlist> for a similarly efficient call
4806 for getting extended attributes. Very long directory listings
4807 might cause the protocol message size to be exceeded, causing
4808 this call to fail. The caller must split up such requests
4809 into smaller groups of names.");
4811 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4813 "lgetxattr on multiple files",
4815 This call allows you to get the extended attributes
4816 of multiple files, where all files are in the directory C<path>.
4817 C<names> is the list of files from this directory.
4819 On return you get a flat list of xattr structs which must be
4820 interpreted sequentially. The first xattr struct always has a zero-length
4821 C<attrname>. C<attrval> in this struct is zero-length
4822 to indicate there was an error doing C<lgetxattr> for this
4823 file, I<or> is a C string which is a decimal number
4824 (the number of following attributes for this file, which could
4825 be C<\"0\">). Then after the first xattr struct are the
4826 zero or more attributes for the first named file.
4827 This repeats for the second and subsequent files.
4829 This call is intended for programs that want to efficiently
4830 list a directory contents without making many round-trips.
4831 See also C<guestfs_lstatlist> for a similarly efficient call
4832 for getting standard stats. Very long directory listings
4833 might cause the protocol message size to be exceeded, causing
4834 this call to fail. The caller must split up such requests
4835 into smaller groups of names.");
4837 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4839 "readlink on multiple files",
4841 This call allows you to do a C<readlink> operation
4842 on multiple files, where all files are in the directory C<path>.
4843 C<names> is the list of files from this directory.
4845 On return you get a list of strings, with a one-to-one
4846 correspondence to the C<names> list. Each string is the
4847 value of the symbolic link.
4849 If the C<readlink(2)> operation fails on any name, then
4850 the corresponding result string is the empty string C<\"\">.
4851 However the whole operation is completed even if there
4852 were C<readlink(2)> errors, and so you can call this
4853 function with names where you don't know if they are
4854 symbolic links already (albeit slightly less efficient).
4856 This call is intended for programs that want to efficiently
4857 list a directory contents without making many round-trips.
4858 Very long directory listings might cause the protocol
4859 message size to be exceeded, causing
4860 this call to fail. The caller must split up such requests
4861 into smaller groups of names.");
4863 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4864 [InitISOFS, Always, TestOutputBuffer (
4865 [["pread"; "/known-4"; "1"; "3"]], "\n");
4866 InitISOFS, Always, TestOutputBuffer (
4867 [["pread"; "/empty"; "0"; "100"]], "")],
4868 "read part of a file",
4870 This command lets you read part of a file. It reads C<count>
4871 bytes of the file, starting at C<offset>, from file C<path>.
4873 This may read fewer bytes than requested. For further details
4874 see the L<pread(2)> system call.
4876 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4878 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4879 [InitEmpty, Always, TestRun (
4880 [["part_init"; "/dev/sda"; "gpt"]])],
4881 "create an empty partition table",
4883 This creates an empty partition table on C<device> of one of the
4884 partition types listed below. Usually C<parttype> should be
4885 either C<msdos> or C<gpt> (for large disks).
4887 Initially there are no partitions. Following this, you should
4888 call C<guestfs_part_add> for each partition required.
4890 Possible values for C<parttype> are:
4898 Intel EFI / GPT partition table.
4900 This is recommended for >= 2 TB partitions that will be accessed
4901 from Linux and Intel-based Mac OS X. It also has limited backwards
4902 compatibility with the C<mbr> format.
4908 The standard PC \"Master Boot Record\" (MBR) format used
4909 by MS-DOS and Windows. This partition type will B<only> work
4910 for device sizes up to 2 TB. For large disks we recommend
4915 Other partition table types that may work but are not
4928 Amiga \"Rigid Disk Block\" format.
4936 DASD, used on IBM mainframes.
4944 Old Mac partition format. Modern Macs use C<gpt>.
4948 NEC PC-98 format, common in Japan apparently.
4956 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4957 [InitEmpty, Always, TestRun (
4958 [["part_init"; "/dev/sda"; "mbr"];
4959 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4960 InitEmpty, Always, TestRun (
4961 [["part_init"; "/dev/sda"; "gpt"];
4962 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4963 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4964 InitEmpty, Always, TestRun (
4965 [["part_init"; "/dev/sda"; "mbr"];
4966 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4967 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4968 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4969 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4970 "add a partition to the device",
4972 This command adds a partition to C<device>. If there is no partition
4973 table on the device, call C<guestfs_part_init> first.
4975 The C<prlogex> parameter is the type of partition. Normally you
4976 should pass C<p> or C<primary> here, but MBR partition tables also
4977 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4980 C<startsect> and C<endsect> are the start and end of the partition
4981 in I<sectors>. C<endsect> may be negative, which means it counts
4982 backwards from the end of the disk (C<-1> is the last sector).
4984 Creating a partition which covers the whole disk is not so easy.
4985 Use C<guestfs_part_disk> to do that.");
4987 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4988 [InitEmpty, Always, TestRun (
4989 [["part_disk"; "/dev/sda"; "mbr"]]);
4990 InitEmpty, Always, TestRun (
4991 [["part_disk"; "/dev/sda"; "gpt"]])],
4992 "partition whole disk with a single primary partition",
4994 This command is simply a combination of C<guestfs_part_init>
4995 followed by C<guestfs_part_add> to create a single primary partition
4996 covering the whole disk.
4998 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4999 but other possible values are described in C<guestfs_part_init>.");
5001 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
5002 [InitEmpty, Always, TestRun (
5003 [["part_disk"; "/dev/sda"; "mbr"];
5004 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
5005 "make a partition bootable",
5007 This sets the bootable flag on partition numbered C<partnum> on
5008 device C<device>. Note that partitions are numbered from 1.
5010 The bootable flag is used by some operating systems (notably
5011 Windows) to determine which partition to boot from. It is by
5012 no means universally recognized.");
5014 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
5015 [InitEmpty, Always, TestRun (
5016 [["part_disk"; "/dev/sda"; "gpt"];
5017 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
5018 "set partition name",
5020 This sets the partition name on partition numbered C<partnum> on
5021 device C<device>. Note that partitions are numbered from 1.
5023 The partition name can only be set on certain types of partition
5024 table. This works on C<gpt> but not on C<mbr> partitions.");
5026 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
5027 [], (* XXX Add a regression test for this. *)
5028 "list partitions on a device",
5030 This command parses the partition table on C<device> and
5031 returns the list of partitions found.
5033 The fields in the returned structure are:
5039 Partition number, counting from 1.
5043 Start of the partition I<in bytes>. To get sectors you have to
5044 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5048 End of the partition in bytes.
5052 Size of the partition in bytes.
5056 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5057 [InitEmpty, Always, TestOutput (
5058 [["part_disk"; "/dev/sda"; "gpt"];
5059 ["part_get_parttype"; "/dev/sda"]], "gpt")],
5060 "get the partition table type",
5062 This command examines the partition table on C<device> and
5063 returns the partition table type (format) being used.
5065 Common return values include: C<msdos> (a DOS/Windows style MBR
5066 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5067 values are possible, although unusual. See C<guestfs_part_init>
5070 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5071 [InitScratchFS, Always, TestOutputBuffer (
5072 [["fill"; "0x63"; "10"; "/fill"];
5073 ["read_file"; "/fill"]], "cccccccccc")],
5074 "fill a file with octets",
5076 This command creates a new file called C<path>. The initial
5077 content of the file is C<len> octets of C<c>, where C<c>
5078 must be a number in the range C<[0..255]>.
5080 To fill a file with zero bytes (sparsely), it is
5081 much more efficient to use C<guestfs_truncate_size>.
5082 To create a file with a pattern of repeating bytes
5083 use C<guestfs_fill_pattern>.");
5085 ("available", (RErr, [StringList "groups"], []), 216, [],
5086 [InitNone, Always, TestRun [["available"; ""]]],
5087 "test availability of some parts of the API",
5089 This command is used to check the availability of some
5090 groups of functionality in the appliance, which not all builds of
5091 the libguestfs appliance will be able to provide.
5093 The libguestfs groups, and the functions that those
5094 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5095 You can also fetch this list at runtime by calling
5096 C<guestfs_available_all_groups>.
5098 The argument C<groups> is a list of group names, eg:
5099 C<[\"inotify\", \"augeas\"]> would check for the availability of
5100 the Linux inotify functions and Augeas (configuration file
5103 The command returns no error if I<all> requested groups are available.
5105 It fails with an error if one or more of the requested
5106 groups is unavailable in the appliance.
5108 If an unknown group name is included in the
5109 list of groups then an error is always returned.
5117 You must call C<guestfs_launch> before calling this function.
5119 The reason is because we don't know what groups are
5120 supported by the appliance/daemon until it is running and can
5125 If a group of functions is available, this does not necessarily
5126 mean that they will work. You still have to check for errors
5127 when calling individual API functions even if they are
5132 It is usually the job of distro packagers to build
5133 complete functionality into the libguestfs appliance.
5134 Upstream libguestfs, if built from source with all
5135 requirements satisfied, will support everything.
5139 This call was added in version C<1.0.80>. In previous
5140 versions of libguestfs all you could do would be to speculatively
5141 execute a command to find out if the daemon implemented it.
5142 See also C<guestfs_version>.
5146 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5147 [InitScratchFS, Always, TestOutputBuffer (
5149 ["write"; "/dd/src"; "hello, world"];
5150 ["dd"; "/dd/src"; "/dd/dest"];
5151 ["read_file"; "/dd/dest"]], "hello, world")],
5152 "copy from source to destination using dd",
5154 This command copies from one source device or file C<src>
5155 to another destination device or file C<dest>. Normally you
5156 would use this to copy to or from a device or partition, for
5157 example to duplicate a filesystem.
5159 If the destination is a device, it must be as large or larger
5160 than the source file or device, otherwise the copy will fail.
5161 This command cannot do partial copies (see C<guestfs_copy_size>).");
5163 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5164 [InitScratchFS, Always, TestOutputInt (
5165 [["write"; "/filesize"; "hello, world"];
5166 ["filesize"; "/filesize"]], 12)],
5167 "return the size of the file in bytes",
5169 This command returns the size of C<file> in bytes.
5171 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5172 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5173 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5175 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5176 [InitBasicFSonLVM, Always, TestOutputList (
5177 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5178 ["lvs"]], ["/dev/VG/LV2"])],
5179 "rename an LVM logical volume",
5181 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5183 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5184 [InitBasicFSonLVM, Always, TestOutputList (
5186 ["vg_activate"; "false"; "VG"];
5187 ["vgrename"; "VG"; "VG2"];
5188 ["vg_activate"; "true"; "VG2"];
5189 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5190 ["vgs"]], ["VG2"])],
5191 "rename an LVM volume group",
5193 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5195 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5196 [InitISOFS, Always, TestOutputBuffer (
5197 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5198 "list the contents of a single file in an initrd",
5200 This command unpacks the file C<filename> from the initrd file
5201 called C<initrdpath>. The filename must be given I<without> the
5202 initial C</> character.
5204 For example, in guestfish you could use the following command
5205 to examine the boot script (usually called C</init>)
5206 contained in a Linux initrd or initramfs image:
5208 initrd-cat /boot/initrd-<version>.img init
5210 See also C<guestfs_initrd_list>.");
5212 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5214 "get the UUID of a physical volume",
5216 This command returns the UUID of the LVM PV C<device>.");
5218 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5220 "get the UUID of a volume group",
5222 This command returns the UUID of the LVM VG named C<vgname>.");
5224 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5226 "get the UUID of a logical volume",
5228 This command returns the UUID of the LVM LV C<device>.");
5230 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5232 "get the PV UUIDs containing the volume group",
5234 Given a VG called C<vgname>, this returns the UUIDs of all
5235 the physical volumes that this volume group resides on.
5237 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5238 calls to associate physical volumes and volume groups.
5240 See also C<guestfs_vglvuuids>.");
5242 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5244 "get the LV UUIDs of all LVs in the volume group",
5246 Given a VG called C<vgname>, this returns the UUIDs of all
5247 the logical volumes created in this volume group.
5249 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5250 calls to associate logical volumes and volume groups.
5252 See also C<guestfs_vgpvuuids>.");
5254 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5255 [InitScratchFS, Always, TestOutputBuffer (
5256 [["mkdir"; "/copy_size"];
5257 ["write"; "/copy_size/src"; "hello, world"];
5258 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5259 ["read_file"; "/copy_size/dest"]], "hello")],
5260 "copy size bytes from source to destination using dd",
5262 This command copies exactly C<size> bytes from one source device
5263 or file C<src> to another destination device or file C<dest>.
5265 Note this will fail if the source is too short or if the destination
5266 is not large enough.");
5268 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5269 [InitBasicFSonLVM, Always, TestRun (
5270 [["zero_device"; "/dev/VG/LV"]])],
5271 "write zeroes to an entire device",
5273 This command writes zeroes over the entire C<device>. Compare
5274 with C<guestfs_zero> which just zeroes the first few blocks of
5277 If blocks are already zero, then this command avoids writing
5278 zeroes. This prevents the underlying device from becoming non-sparse
5279 or growing unnecessarily.");
5281 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5282 [InitScratchFS, Always, TestOutput (
5283 [["mkdir"; "/txz_in"];
5284 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5285 ["cat"; "/txz_in/hello"]], "hello\n")],
5286 "unpack compressed tarball to directory",
5288 This command uploads and unpacks local file C<tarball> (an
5289 I<xz compressed> tar file) into C<directory>.");
5291 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5293 "pack directory into compressed tarball",
5295 This command packs the contents of C<directory> and downloads
5296 it to local file C<tarball> (as an xz compressed tar archive).");
5298 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5300 "resize an NTFS filesystem",
5302 This command resizes an NTFS filesystem, expanding or
5303 shrinking it to the size of the underlying device.
5305 I<Note:> After the resize operation, the filesystem is marked
5306 as requiring a consistency check (for safety). You have to boot
5307 into Windows to perform this check and clear this condition.
5308 Furthermore, ntfsresize refuses to resize filesystems
5309 which have been marked in this way. So in effect it is
5310 not possible to call ntfsresize multiple times on a single
5311 filesystem without booting into Windows between each resize.
5313 See also L<ntfsresize(8)>.");
5315 ("vgscan", (RErr, [], []), 232, [],
5316 [InitEmpty, Always, TestRun (
5318 "rescan for LVM physical volumes, volume groups and logical volumes",
5320 This rescans all block devices and rebuilds the list of LVM
5321 physical volumes, volume groups and logical volumes.");
5323 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5324 [InitEmpty, Always, TestRun (
5325 [["part_init"; "/dev/sda"; "mbr"];
5326 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5327 ["part_del"; "/dev/sda"; "1"]])],
5328 "delete a partition",
5330 This command deletes the partition numbered C<partnum> on C<device>.
5332 Note that in the case of MBR partitioning, deleting an
5333 extended partition also deletes any logical partitions
5336 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5337 [InitEmpty, Always, TestOutputTrue (
5338 [["part_init"; "/dev/sda"; "mbr"];
5339 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5340 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5341 ["part_get_bootable"; "/dev/sda"; "1"]])],
5342 "return true if a partition is bootable",
5344 This command returns true if the partition C<partnum> on
5345 C<device> has the bootable flag set.
5347 See also C<guestfs_part_set_bootable>.");
5349 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5350 [InitEmpty, Always, TestOutputInt (
5351 [["part_init"; "/dev/sda"; "mbr"];
5352 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5353 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5354 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5355 "get the MBR type byte (ID byte) from a partition",
5357 Returns the MBR type byte (also known as the ID byte) from
5358 the numbered partition C<partnum>.
5360 Note that only MBR (old DOS-style) partitions have type bytes.
5361 You will get undefined results for other partition table
5362 types (see C<guestfs_part_get_parttype>).");
5364 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5365 [], (* tested by part_get_mbr_id *)
5366 "set the MBR type byte (ID byte) of a partition",
5368 Sets the MBR type byte (also known as the ID byte) of
5369 the numbered partition C<partnum> to C<idbyte>. Note
5370 that the type bytes quoted in most documentation are
5371 in fact hexadecimal numbers, but usually documented
5372 without any leading \"0x\" which might be confusing.
5374 Note that only MBR (old DOS-style) partitions have type bytes.
5375 You will get undefined results for other partition table
5376 types (see C<guestfs_part_get_parttype>).");
5378 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5379 [InitISOFS, Always, TestOutputFileMD5 (
5380 [["checksum_device"; "md5"; "/dev/sdd"]],
5381 "../images/test.iso")],
5382 "compute MD5, SHAx or CRC checksum of the contents of a device",
5384 This call computes the MD5, SHAx or CRC checksum of the
5385 contents of the device named C<device>. For the types of
5386 checksums supported see the C<guestfs_checksum> command.");
5388 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5389 [InitNone, Always, TestRun (
5390 [["part_disk"; "/dev/sda"; "mbr"];
5391 ["pvcreate"; "/dev/sda1"];
5392 ["vgcreate"; "VG"; "/dev/sda1"];
5393 ["lvcreate"; "LV"; "VG"; "10"];
5394 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5395 "expand an LV to fill free space",
5397 This expands an existing logical volume C<lv> so that it fills
5398 C<pc>% of the remaining free space in the volume group. Commonly
5399 you would call this with pc = 100 which expands the logical volume
5400 as much as possible, using all remaining free space in the volume
5403 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5404 [], (* XXX Augeas code needs tests. *)
5405 "clear Augeas path",
5407 Set the value associated with C<path> to C<NULL>. This
5408 is the same as the L<augtool(1)> C<clear> command.");
5410 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5411 [InitEmpty, Always, TestOutputInt (
5412 [["get_umask"]], 0o22)],
5413 "get the current umask",
5415 Return the current umask. By default the umask is C<022>
5416 unless it has been set by calling C<guestfs_umask>.");
5418 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5420 "upload a file to the appliance (internal use only)",
5422 The C<guestfs_debug_upload> command uploads a file to
5423 the libguestfs appliance.
5425 There is no comprehensive help for this command. You have
5426 to look at the file C<daemon/debug.c> in the libguestfs source
5427 to find out what it is for.");
5429 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5430 [InitScratchFS, Always, TestOutput (
5431 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5432 ["cat"; "/base64_in"]], "hello\n")],
5433 "upload base64-encoded data to file",
5435 This command uploads base64-encoded data from C<base64file>
5438 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5440 "download file and encode as base64",
5442 This command downloads the contents of C<filename>, writing
5443 it out to local file C<base64file> encoded as base64.");
5445 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5447 "compute MD5, SHAx or CRC checksum of files in a directory",
5449 This command computes the checksums of all regular files in
5450 C<directory> and then emits a list of those checksums to
5451 the local output file C<sumsfile>.
5453 This can be used for verifying the integrity of a virtual
5454 machine. However to be properly secure you should pay
5455 attention to the output of the checksum command (it uses
5456 the ones from GNU coreutils). In particular when the
5457 filename is not printable, coreutils uses a special
5458 backslash syntax. For more information, see the GNU
5459 coreutils info file.");
5461 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5462 [InitScratchFS, Always, TestOutputBuffer (
5463 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5464 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5465 "fill a file with a repeating pattern of bytes",
5467 This function is like C<guestfs_fill> except that it creates
5468 a new file of length C<len> containing the repeating pattern
5469 of bytes in C<pattern>. The pattern is truncated if necessary
5470 to ensure the length of the file is exactly C<len> bytes.");
5472 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5473 [InitScratchFS, Always, TestOutput (
5474 [["write"; "/write"; "new file contents"];
5475 ["cat"; "/write"]], "new file contents");
5476 InitScratchFS, Always, TestOutput (
5477 [["write"; "/write2"; "\nnew file contents\n"];
5478 ["cat"; "/write2"]], "\nnew file contents\n");
5479 InitScratchFS, Always, TestOutput (
5480 [["write"; "/write3"; "\n\n"];
5481 ["cat"; "/write3"]], "\n\n");
5482 InitScratchFS, Always, TestOutput (
5483 [["write"; "/write4"; ""];
5484 ["cat"; "/write4"]], "");
5485 InitScratchFS, Always, TestOutput (
5486 [["write"; "/write5"; "\n\n\n"];
5487 ["cat"; "/write5"]], "\n\n\n");
5488 InitScratchFS, Always, TestOutput (
5489 [["write"; "/write6"; "\n"];
5490 ["cat"; "/write6"]], "\n")],
5491 "create a new file",
5493 This call creates a file called C<path>. The content of the
5494 file is the string C<content> (which can contain any 8 bit data).
5496 See also C<guestfs_write_append>.");
5498 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5499 [InitScratchFS, Always, TestOutput (
5500 [["write"; "/pwrite"; "new file contents"];
5501 ["pwrite"; "/pwrite"; "data"; "4"];
5502 ["cat"; "/pwrite"]], "new data contents");
5503 InitScratchFS, Always, TestOutput (
5504 [["write"; "/pwrite2"; "new file contents"];
5505 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5506 ["cat"; "/pwrite2"]], "new file is extended");
5507 InitScratchFS, Always, TestOutput (
5508 [["write"; "/pwrite3"; "new file contents"];
5509 ["pwrite"; "/pwrite3"; ""; "4"];
5510 ["cat"; "/pwrite3"]], "new file contents")],
5511 "write to part of a file",
5513 This command writes to part of a file. It writes the data
5514 buffer C<content> to the file C<path> starting at offset C<offset>.
5516 This command implements the L<pwrite(2)> system call, and like
5517 that system call it may not write the full data requested. The
5518 return value is the number of bytes that were actually written
5519 to the file. This could even be 0, although short writes are
5520 unlikely for regular files in ordinary circumstances.
5522 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5524 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5526 "resize an ext2, ext3 or ext4 filesystem (with size)",
5528 This command is the same as C<guestfs_resize2fs> except that it
5529 allows you to specify the new size (in bytes) explicitly.");
5531 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5533 "resize an LVM physical volume (with size)",
5535 This command is the same as C<guestfs_pvresize> except that it
5536 allows you to specify the new size (in bytes) explicitly.");
5538 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5540 "resize an NTFS filesystem (with size)",
5542 This command is the same as C<guestfs_ntfsresize> except that it
5543 allows you to specify the new size (in bytes) explicitly.");
5545 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5546 [InitNone, Always, TestRun [["available_all_groups"]]],
5547 "return a list of all optional groups",
5549 This command returns a list of all optional groups that this
5550 daemon knows about. Note this returns both supported and unsupported
5551 groups. To find out which ones the daemon can actually support
5552 you have to call C<guestfs_available> on each member of the
5555 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5557 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5558 [InitScratchFS, Always, TestOutputStruct (
5559 [["fallocate64"; "/fallocate64"; "1000000"];
5560 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5561 "preallocate a file in the guest filesystem",
5563 This command preallocates a file (containing zero bytes) named
5564 C<path> of size C<len> bytes. If the file exists already, it
5567 Note that this call allocates disk blocks for the file.
5568 To create a sparse file use C<guestfs_truncate_size> instead.
5570 The deprecated call C<guestfs_fallocate> does the same,
5571 but owing to an oversight it only allowed 30 bit lengths
5572 to be specified, effectively limiting the maximum size
5573 of files created through that call to 1GB.
5575 Do not confuse this with the guestfish-specific
5576 C<alloc> and C<sparse> commands which create
5577 a file in the host and attach it as a device.");
5579 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5580 [InitBasicFS, Always, TestOutput (
5581 [["set_e2label"; "/dev/sda1"; "LTEST"];
5582 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5583 "get the filesystem label",
5585 This returns the filesystem label of the filesystem on
5588 If the filesystem is unlabeled, this returns the empty string.
5590 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5592 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5593 (let uuid = uuidgen () in
5594 [InitBasicFS, Always, TestOutput (
5595 [["set_e2uuid"; "/dev/sda1"; uuid];
5596 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5597 "get the filesystem UUID",
5599 This returns the filesystem UUID of the filesystem on
5602 If the filesystem does not have a UUID, this returns the empty string.
5604 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5606 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5607 (* Can't be tested with the current framework because
5608 * the VG is being used by the mounted filesystem, so
5609 * the vgchange -an command we do first will fail.
5612 "set LVM device filter",
5614 This sets the LVM device filter so that LVM will only be
5615 able to \"see\" the block devices in the list C<devices>,
5616 and will ignore all other attached block devices.
5618 Where disk image(s) contain duplicate PVs or VGs, this
5619 command is useful to get LVM to ignore the duplicates, otherwise
5620 LVM can get confused. Note also there are two types
5621 of duplication possible: either cloned PVs/VGs which have
5622 identical UUIDs; or VGs that are not cloned but just happen
5623 to have the same name. In normal operation you cannot
5624 create this situation, but you can do it outside LVM, eg.
5625 by cloning disk images or by bit twiddling inside the LVM
5628 This command also clears the LVM cache and performs a volume
5631 You can filter whole block devices or individual partitions.
5633 You cannot use this if any VG is currently in use (eg.
5634 contains a mounted filesystem), even if you are not
5635 filtering out that VG.");
5637 ("lvm_clear_filter", (RErr, [], []), 256, [],
5638 [], (* see note on lvm_set_filter *)
5639 "clear LVM device filter",
5641 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5642 will be able to see every block device.
5644 This command also clears the LVM cache and performs a volume
5647 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5649 "open a LUKS-encrypted block device",
5651 This command opens a block device which has been encrypted
5652 according to the Linux Unified Key Setup (LUKS) standard.
5654 C<device> is the encrypted block device or partition.
5656 The caller must supply one of the keys associated with the
5657 LUKS block device, in the C<key> parameter.
5659 This creates a new block device called C</dev/mapper/mapname>.
5660 Reads and writes to this block device are decrypted from and
5661 encrypted to the underlying C<device> respectively.
5663 If this block device contains LVM volume groups, then
5664 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5665 will make them visible.
5667 Use C<guestfs_list_dm_devices> to list all device mapper
5670 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5672 "open a LUKS-encrypted block device read-only",
5674 This is the same as C<guestfs_luks_open> except that a read-only
5675 mapping is created.");
5677 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5679 "close a LUKS device",
5681 This closes a LUKS device that was created earlier by
5682 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5683 C<device> parameter must be the name of the LUKS mapping
5684 device (ie. C</dev/mapper/mapname>) and I<not> the name
5685 of the underlying block device.");
5687 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5689 "format a block device as a LUKS encrypted device",
5691 This command erases existing data on C<device> and formats
5692 the device as a LUKS encrypted device. C<key> is the
5693 initial key, which is added to key slot C<slot>. (LUKS
5694 supports 8 key slots, numbered 0-7).");
5696 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5698 "format a block device as a LUKS encrypted device",
5700 This command is the same as C<guestfs_luks_format> but
5701 it also allows you to set the C<cipher> used.");
5703 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5705 "add a key on a LUKS encrypted device",
5707 This command adds a new key on LUKS device C<device>.
5708 C<key> is any existing key, and is used to access the device.
5709 C<newkey> is the new key to add. C<keyslot> is the key slot
5710 that will be replaced.
5712 Note that if C<keyslot> already contains a key, then this
5713 command will fail. You have to use C<guestfs_luks_kill_slot>
5714 first to remove that key.");
5716 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5718 "remove a key from a LUKS encrypted device",
5720 This command deletes the key in key slot C<keyslot> from the
5721 encrypted LUKS device C<device>. C<key> must be one of the
5724 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5725 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5726 [["is_lv"; "/dev/VG/LV"]]);
5727 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5728 [["is_lv"; "/dev/sda1"]])],
5729 "test if device is a logical volume",
5731 This command tests whether C<device> is a logical volume, and
5732 returns true iff this is the case.");
5734 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5736 "find a filesystem by UUID",
5738 This command searches the filesystems and returns the one
5739 which has the given UUID. An error is returned if no such
5740 filesystem can be found.
5742 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5744 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5746 "find a filesystem by label",
5748 This command searches the filesystems and returns the one
5749 which has the given label. An error is returned if no such
5750 filesystem can be found.
5752 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5754 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5755 [InitISOFS, Always, TestOutputFalse (
5756 [["is_chardev"; "/directory"]]);
5757 InitScratchFS, Always, TestOutputTrue (
5758 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5759 ["is_chardev"; "/is_chardev"]])],
5760 "test if character device",
5762 This returns C<true> if and only if there is a character device
5763 with the given C<path> name.
5765 See also C<guestfs_stat>.");
5767 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5768 [InitISOFS, Always, TestOutputFalse (
5769 [["is_blockdev"; "/directory"]]);
5770 InitScratchFS, Always, TestOutputTrue (
5771 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5772 ["is_blockdev"; "/is_blockdev"]])],
5773 "test if block device",
5775 This returns C<true> if and only if there is a block device
5776 with the given C<path> name.
5778 See also C<guestfs_stat>.");
5780 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5781 [InitISOFS, Always, TestOutputFalse (
5782 [["is_fifo"; "/directory"]]);
5783 InitScratchFS, Always, TestOutputTrue (
5784 [["mkfifo"; "0o777"; "/is_fifo"];
5785 ["is_fifo"; "/is_fifo"]])],
5786 "test if FIFO (named pipe)",
5788 This returns C<true> if and only if there is a FIFO (named pipe)
5789 with the given C<path> name.
5791 See also C<guestfs_stat>.");
5793 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5794 [InitISOFS, Always, TestOutputFalse (
5795 [["is_symlink"; "/directory"]]);
5796 InitISOFS, Always, TestOutputTrue (
5797 [["is_symlink"; "/abssymlink"]])],
5798 "test if symbolic link",
5800 This returns C<true> if and only if there is a symbolic link
5801 with the given C<path> name.
5803 See also C<guestfs_stat>.");
5805 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5806 (* XXX Need a positive test for sockets. *)
5807 [InitISOFS, Always, TestOutputFalse (
5808 [["is_socket"; "/directory"]])],
5811 This returns C<true> if and only if there is a Unix domain socket
5812 with the given C<path> name.
5814 See also C<guestfs_stat>.");
5816 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5817 [InitPartition, Always, TestOutputDevice (
5818 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5819 InitEmpty, Always, TestLastFail (
5820 [["part_to_dev"; "/dev/sda"]])],
5821 "convert partition name to device name",
5823 This function takes a partition name (eg. \"/dev/sdb1\") and
5824 removes the partition number, returning the device name
5827 The named partition must exist, for example as a string returned
5828 from C<guestfs_list_partitions>.");
5830 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5831 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5832 [InitScratchFS, Always, TestOutput (
5833 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5834 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5835 "upload a file from the local machine with offset",
5837 Upload local file C<filename> to C<remotefilename> on the
5840 C<remotefilename> is overwritten starting at the byte C<offset>
5841 specified. The intention is to overwrite parts of existing
5842 files or devices, although if a non-existant file is specified
5843 then it is created with a \"hole\" before C<offset>. The
5844 size of the data written is implicit in the size of the
5847 Note that there is no limit on the amount of data that
5848 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5849 and this call always writes the full amount unless an
5852 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5854 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5855 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5856 let offset = string_of_int 100 in
5857 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5858 [InitScratchFS, Always, TestOutput (
5859 (* Pick a file from cwd which isn't likely to change. *)
5860 [["mkdir"; "/download_offset"];
5861 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5862 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5863 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5864 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5865 "download a file to the local machine with offset and size",
5867 Download file C<remotefilename> and save it as C<filename>
5868 on the local machine.
5870 C<remotefilename> is read for C<size> bytes starting at C<offset>
5871 (this region must be within the file or device).
5873 Note that there is no limit on the amount of data that
5874 can be downloaded with this call, unlike with C<guestfs_pread>,
5875 and this call always reads the full amount unless an
5878 See also C<guestfs_download>, C<guestfs_pread>.");
5880 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5881 [InitPartition, Always, TestOutputListOfDevices (
5882 [["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"];
5883 ["blockdev_rereadpt"; "/dev/sda"];
5884 ["list_partitions"]], ["/dev/sdb1"])],
5885 "write to part of a device",
5887 This command writes to part of a device. It writes the data
5888 buffer C<content> to C<device> starting at offset C<offset>.
5890 This command implements the L<pwrite(2)> system call, and like
5891 that system call it may not write the full data requested
5892 (although short writes to disk devices and partitions are
5893 probably impossible with standard Linux kernels).
5895 See also C<guestfs_pwrite>.");
5897 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5898 [InitEmpty, Always, TestOutputBuffer (
5899 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5900 "read part of a device",
5902 This command lets you read part of a file. It reads C<count>
5903 bytes of C<device>, starting at C<offset>.
5905 This may read fewer bytes than requested. For further details
5906 see the L<pread(2)> system call.
5908 See also C<guestfs_pread>.");
5910 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5911 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5912 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5913 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5914 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5915 "get canonical name of an LV",
5917 This converts alternative naming schemes for LVs that you
5918 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5919 is converted to C</dev/VG/LV>.
5921 This command returns an error if the C<lvname> parameter does
5922 not refer to a logical volume.
5924 See also C<guestfs_is_lv>.");
5926 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
5927 [InitEmpty, Always, TestOutput (
5928 [["part_disk"; "/dev/sda"; "mbr"];
5929 ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
5930 ["mount_options"; ""; "/dev/sda1"; "/"];
5931 ["write"; "/new"; "new file contents"];
5932 ["cat"; "/new"]], "new file contents")],
5933 "make a filesystem",
5935 This function creates a filesystem on C<device>. The filesystem
5936 type is C<fstype>, for example C<ext3>.
5938 The optional arguments are:
5944 The filesystem block size. Supported block sizes depend on the
5945 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5946 for Linux ext2/3 filesystems.
5948 For VFAT and NTFS the C<blocksize> parameter is treated as
5949 the requested cluster size.
5951 For UFS block sizes, please see L<mkfs.ufs(8)>.
5955 This passes the I<-O> parameter to the external mkfs program.
5957 For certain filesystem types, this allows extra filesystem
5958 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5961 You cannot use this optional parameter with the C<gfs> or
5962 C<gfs2> filesystem type.
5966 This passes the I<-I> parameter to the external L<mke2fs(8)> program
5967 which sets the inode size (only for ext2/3/4 filesystems at present).
5971 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
5972 which sets sector size for ufs filesystem.
5976 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5978 "get a single extended attribute",
5980 Get a single extended attribute from file C<path> named C<name>.
5981 This call follows symlinks. If you want to lookup an extended
5982 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5984 Normally it is better to get all extended attributes from a file
5985 in one go by calling C<guestfs_getxattrs>. However some Linux
5986 filesystem implementations are buggy and do not provide a way to
5987 list out attributes. For these filesystems (notably ntfs-3g)
5988 you have to know the names of the extended attributes you want
5989 in advance and call this function.
5991 Extended attribute values are blobs of binary data. If there
5992 is no extended attribute named C<name>, this returns an error.
5994 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5996 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5998 "get a single extended attribute",
6000 Get a single extended attribute from file C<path> named C<name>.
6001 If C<path> is a symlink, then this call returns an extended
6002 attribute from the symlink.
6004 Normally it is better to get all extended attributes from a file
6005 in one go by calling C<guestfs_getxattrs>. However some Linux
6006 filesystem implementations are buggy and do not provide a way to
6007 list out attributes. For these filesystems (notably ntfs-3g)
6008 you have to know the names of the extended attributes you want
6009 in advance and call this function.
6011 Extended attribute values are blobs of binary data. If there
6012 is no extended attribute named C<name>, this returns an error.
6014 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
6016 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
6018 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
6020 This command is the same as C<guestfs_resize2fs>, but the filesystem
6021 is resized to its minimum size. This works like the I<-M> option
6022 to the C<resize2fs> command.
6024 To get the resulting size of the filesystem you should call
6025 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
6026 values. These two numbers, multiplied together, give the
6027 resulting size of the minimal filesystem in bytes.");
6029 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
6031 "internal autosync operation",
6033 This command performs the autosync operation just before the
6034 handle is closed. You should not call this command directly.
6035 Instead, use the autosync flag (C<guestfs_set_autosync>) to
6036 control whether or not this operation is performed when the
6037 handle is closed.");
6039 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6040 [InitISOFS, Always, TestOutputTrue (
6041 [["is_zero"; "/100kallzeroes"]]);
6042 InitISOFS, Always, TestOutputFalse (
6043 [["is_zero"; "/100kallspaces"]])],
6044 "test if a file contains all zero bytes",
6046 This returns true iff the file exists and the file is empty or
6047 it contains all zero bytes.");
6049 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6050 [InitBasicFS, Always, TestOutputTrue (
6051 [["umount"; "/dev/sda1"];
6052 ["zero_device"; "/dev/sda1"];
6053 ["is_zero_device"; "/dev/sda1"]]);
6054 InitBasicFS, Always, TestOutputFalse (
6055 [["is_zero_device"; "/dev/sda1"]])],
6056 "test if a device contains all zero bytes",
6058 This returns true iff the device exists and contains all zero bytes.
6060 Note that for large devices this can take a long time to run.");
6062 ("list_9p", (RStringList "mounttags", [], []), 285, [],
6064 "list 9p filesystems",
6066 List all 9p filesystems attached to the guest. A list of
6067 mount tags is returned.");
6069 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6071 "mount 9p filesystem",
6073 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6074 directory C<mountpoint>.
6076 If required, C<trans=virtio> will be automatically added to the options.
6077 Any other options required can be passed in the optional C<options>
6080 ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6082 "list device mapper devices",
6084 List all device mapper devices.
6086 The returned list contains C</dev/mapper/*> devices, eg. ones created
6087 by a previous call to C<guestfs_luks_open>.
6089 Device mapper devices which correspond to logical volumes are I<not>
6090 returned in this list. Call C<guestfs_lvs> if you want to list logical
6093 ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6095 "resize an NTFS filesystem",
6097 This command resizes an NTFS filesystem, expanding or
6098 shrinking it to the size of the underlying device.
6100 The optional parameters are:
6106 The new size (in bytes) of the filesystem. If omitted, the filesystem
6107 is resized to fit the container (eg. partition).
6111 If this option is true, then force the resize of the filesystem
6112 even if the filesystem is marked as requiring a consistency check.
6114 After the resize operation, the filesystem is always marked
6115 as requiring a consistency check (for safety). You have to boot
6116 into Windows to perform this check and clear this condition.
6117 If you I<don't> set the C<force> option then it is not
6118 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6119 single filesystem without booting into Windows between each resize.
6123 See also L<ntfsresize(8)>.");
6125 ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6127 "resize a btrfs filesystem",
6129 This command resizes a btrfs filesystem.
6131 Note that unlike other resize calls, the filesystem has to be
6132 mounted and the parameter is the mountpoint not the device
6133 (this is a requirement of btrfs itself).
6135 The optional parameters are:
6141 The new size (in bytes) of the filesystem. If omitted, the filesystem
6142 is resized to the maximum size.
6146 See also L<btrfs(8)>.");
6148 ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6149 [InitScratchFS, Always, TestOutput (
6150 [["write"; "/write_append"; "line1\n"];
6151 ["write_append"; "/write_append"; "line2\n"];
6152 ["write_append"; "/write_append"; "line3a"];
6153 ["write_append"; "/write_append"; "line3b\n"];
6154 ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6155 "append content to end of file",
6157 This call appends C<content> to the end of file C<path>. If
6158 C<path> does not exist, then a new file is created.
6160 See also C<guestfs_write>.");
6162 ("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [Int "level"]), 291, [],
6164 "output compressed file",
6166 This command compresses C<file> and writes it out to the local
6169 The compression program used is controlled by the C<ctype> parameter.
6170 Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.
6171 Some compression types may not be supported by particular builds of
6172 libguestfs, in which case you will get an error containing the
6173 substring \"not supported\".
6175 The optional C<level> parameter controls compression level. The
6176 meaning and default for this parameter depends on the compression
6177 program being used.");
6179 ("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [Int "level"]), 292, [],
6181 "output compressed device",
6183 This command compresses C<device> and writes it out to the local
6186 The C<ctype> and optional C<level> parameters have the same meaning
6187 as in C<guestfs_compress_out>.");
6191 let all_functions = non_daemon_functions @ daemon_functions
6193 (* In some places we want the functions to be displayed sorted
6194 * alphabetically, so this is useful:
6196 let all_functions_sorted = List.sort action_compare all_functions
6198 (* This is used to generate the src/MAX_PROC_NR file which
6199 * contains the maximum procedure number, a surrogate for the
6200 * ABI version number. See src/Makefile.am for the details.
6203 let proc_nrs = List.map (
6204 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6205 ) daemon_functions in
6206 List.fold_left max 0 proc_nrs
6208 (* Non-API meta-commands available only in guestfish.
6210 * Note (1): style, proc_nr and tests fields are all meaningless.
6211 * The only fields which are actually used are the shortname,
6212 * FishAlias flags, shortdesc and longdesc.
6214 * Note (2): to refer to other commands, use L</shortname>.
6216 * Note (3): keep this list sorted by shortname.
6218 let fish_commands = [
6219 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6220 "allocate and add a disk file",
6221 " alloc filename size
6223 This creates an empty (zeroed) file of the given size, and then adds
6224 so it can be further examined.
6226 For more advanced image creation, see L<qemu-img(1)> utility.
6228 Size can be specified using standard suffixes, eg. C<1M>.
6230 To create a sparse file, use L</sparse> instead. To create a
6231 prepared disk image, see L</PREPARED DISK IMAGES>.");
6233 ("copy_in", (RErr,[], []), -1, [], [],
6234 "copy local files or directories into an image",
6235 " copy-in local [local ...] /remotedir
6237 C<copy-in> copies local files or directories recursively into the disk
6238 image, placing them in the directory called C</remotedir> (which must
6239 exist). This guestfish meta-command turns into a sequence of
6240 L</tar-in> and other commands as necessary.
6242 Multiple local files and directories can be specified, but the last
6243 parameter must always be a remote directory. Wildcards cannot be
6246 ("copy_out", (RErr,[], []), -1, [], [],
6247 "copy remote files or directories out of an image",
6248 " copy-out remote [remote ...] localdir
6250 C<copy-out> copies remote files or directories recursively out of the
6251 disk image, placing them on the host disk in a local directory called
6252 C<localdir> (which must exist). This guestfish meta-command turns
6253 into a sequence of L</download>, L</tar-out> and other commands as
6256 Multiple remote files and directories can be specified, but the last
6257 parameter must always be a local directory. To download to the
6258 current directory, use C<.> as in:
6262 Wildcards cannot be used in the ordinary command, but you can use
6263 them with the help of L</glob> like this:
6265 glob copy-out /home/* .");
6267 ("display", (RErr,[], []), -1, [], [],
6271 Use C<display> (a graphical display program) to display an image
6272 file. It downloads the file, and runs C<display> on it.
6274 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6275 environment variable. For example to use the GNOME display program:
6277 export GUESTFISH_DISPLAY_IMAGE=eog
6279 See also L<display(1)>.");
6281 ("echo", (RErr,[], []), -1, [], [],
6282 "display a line of text",
6285 This echos the parameters to the terminal.");
6287 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6291 This is used to edit a file. It downloads the file, edits it
6292 locally using your editor, then uploads the result.
6294 The editor is C<$EDITOR>. However if you use the alternate
6295 commands C<vi> or C<emacs> you will get those corresponding
6298 ("glob", (RErr,[], []), -1, [], [],
6299 "expand wildcards in command",
6300 " glob command args...
6302 Expand wildcards in any paths in the args list, and run C<command>
6303 repeatedly on each matching path.
6305 See L</WILDCARDS AND GLOBBING>.");
6307 ("hexedit", (RErr,[], []), -1, [], [],
6308 "edit with a hex editor",
6309 " hexedit <filename|device>
6310 hexedit <filename|device> <max>
6311 hexedit <filename|device> <start> <max>
6313 Use hexedit (a hex editor) to edit all or part of a binary file
6316 This command works by downloading potentially the whole file or
6317 device, editing it locally, then uploading it. If the file or
6318 device is large, you have to specify which part you wish to edit
6319 by using C<max> and/or C<start> C<max> parameters.
6320 C<start> and C<max> are specified in bytes, with the usual
6321 modifiers allowed such as C<1M> (1 megabyte).
6323 For example to edit the first few sectors of a disk you
6328 which would allow you to edit anywhere within the first megabyte
6331 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6333 hexedit /dev/sda1 0x400 0x400
6335 (assuming the superblock is in the standard location).
6337 This command requires the external L<hexedit(1)> program. You
6338 can specify another program to use by setting the C<HEXEDITOR>
6339 environment variable.
6341 See also L</hexdump>.");
6343 ("lcd", (RErr,[], []), -1, [], [],
6344 "change working directory",
6347 Change the local directory, ie. the current directory of guestfish
6350 Note that C<!cd> won't do what you might expect.");
6352 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6356 Opens the manual page for guestfish.");
6358 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6364 This is used to view a file.
6366 The default viewer is C<$PAGER>. However if you use the alternate
6367 command C<less> you will get the C<less> command specifically.");
6369 ("reopen", (RErr,[], []), -1, [], [],
6370 "close and reopen libguestfs handle",
6373 Close and reopen the libguestfs handle. It is not necessary to use
6374 this normally, because the handle is closed properly when guestfish
6375 exits. However this is occasionally useful for testing.");
6377 ("setenv", (RErr,[], []), -1, [], [],
6378 "set an environment variable",
6381 Set the environment variable C<VAR> to the string C<value>.
6383 To print the value of an environment variable use a shell command
6388 ("sparse", (RErr,[], []), -1, [], [],
6389 "create a sparse disk image and add",
6390 " sparse filename size
6392 This creates an empty sparse file of the given size, and then adds
6393 so it can be further examined.
6395 In all respects it works the same as the L</alloc> command, except that
6396 the image file is allocated sparsely, which means that disk blocks are
6397 not assigned to the file until they are needed. Sparse disk files
6398 only use space when written to, but they are slower and there is a
6399 danger you could run out of real disk space during a write operation.
6401 For more advanced image creation, see L<qemu-img(1)> utility.
6403 Size can be specified using standard suffixes, eg. C<1M>.");
6405 ("supported", (RErr,[], []), -1, [], [],
6406 "list supported groups of commands",
6409 This command returns a list of the optional groups
6410 known to the daemon, and indicates which ones are
6411 supported by this build of the libguestfs appliance.
6413 See also L<guestfs(3)/AVAILABILITY>.");
6415 ("time", (RErr,[], []), -1, [], [],
6416 "print elapsed time taken to run a command",
6417 " time command args...
6419 Run the command as usual, but print the elapsed time afterwards. This
6420 can be useful for benchmarking operations.");
6422 ("unsetenv", (RErr,[], []), -1, [], [],
6423 "unset an environment variable",
6426 Remove C<VAR> from the environment.");