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\"
839 The distro could not be determined.
843 Windows does not have distributions. This string is
844 returned if the OS type is Windows.
848 Future versions of libguestfs may return other strings here.
849 The caller should be prepared to handle any string.
851 Please read L<guestfs(3)/INSPECTION> for more details.");
853 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
855 "get major version of inspected operating system",
857 This returns the major version number of the inspected operating
860 Windows uses a consistent versioning scheme which is I<not>
861 reflected in the popular public names used by the operating system.
862 Notably the operating system known as \"Windows 7\" is really
863 version 6.1 (ie. major = 6, minor = 1). You can find out the
864 real versions corresponding to releases of Windows by consulting
867 If the version could not be determined, then C<0> is returned.
869 Please read L<guestfs(3)/INSPECTION> for more details.");
871 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
873 "get minor version of inspected operating system",
875 This returns the minor version number of the inspected operating
878 If the version could not be determined, then C<0> is returned.
880 Please read L<guestfs(3)/INSPECTION> for more details.
881 See also C<guestfs_inspect_get_major_version>.");
883 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
885 "get product name of inspected operating system",
887 This returns the product name of the inspected operating
888 system. The product name is generally some freeform string
889 which can be displayed to the user, but should not be
892 If the product name could not be determined, then the
893 string C<unknown> is returned.
895 Please read L<guestfs(3)/INSPECTION> for more details.");
897 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
899 "get mountpoints of inspected operating system",
901 This returns a hash of where we think the filesystems
902 associated with this operating system should be mounted.
903 Callers should note that this is at best an educated guess
904 made by reading configuration files such as C</etc/fstab>.
905 I<In particular note> that this may return filesystems
906 which are non-existent or not mountable and callers should
907 be prepared to handle or ignore failures if they try to
910 Each element in the returned hashtable has a key which
911 is the path of the mountpoint (eg. C</boot>) and a value
912 which is the filesystem that would be mounted there
915 Non-mounted devices such as swap devices are I<not>
916 returned in this list.
918 For operating systems like Windows which still use drive
919 letters, this call will only return an entry for the first
920 drive \"mounted on\" C</>. For information about the
921 mapping of drive letters to partitions, see
922 C<guestfs_inspect_get_drive_mappings>.
924 Please read L<guestfs(3)/INSPECTION> for more details.
925 See also C<guestfs_inspect_get_filesystems>.");
927 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
929 "get filesystems associated with inspected operating system",
931 This returns a list of all the filesystems that we think
932 are associated with this operating system. This includes
933 the root filesystem, other ordinary filesystems, and
934 non-mounted devices like swap partitions.
936 In the case of a multi-boot virtual machine, it is possible
937 for a filesystem to be shared between operating systems.
939 Please read L<guestfs(3)/INSPECTION> for more details.
940 See also C<guestfs_inspect_get_mountpoints>.");
942 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
944 "set enable network flag",
946 If C<network> is true, then the network is enabled in the
947 libguestfs appliance. The default is false.
949 This affects whether commands are able to access the network
950 (see L<guestfs(3)/RUNNING COMMANDS>).
952 You must call this before calling C<guestfs_launch>, otherwise
955 ("get_network", (RBool "network", [], []), -1, [],
957 "get enable network flag",
959 This returns the enable network flag.");
961 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
965 This inspection command looks for filesystems on partitions,
966 block devices and logical volumes, returning a list of devices
967 containing filesystems and their type.
969 The return value is a hash, where the keys are the devices
970 containing filesystems, and the values are the filesystem types.
973 \"/dev/sda1\" => \"ntfs\"
974 \"/dev/sda2\" => \"ext2\"
975 \"/dev/vg_guest/lv_root\" => \"ext4\"
976 \"/dev/vg_guest/lv_swap\" => \"swap\"
978 The value can have the special value \"unknown\", meaning the
979 content of the device is undetermined or empty.
980 \"swap\" means a Linux swap partition.
982 This command runs other libguestfs commands, which might include
983 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
984 use this soon after launch and only when nothing is mounted.
986 Not all of the filesystems returned will be mountable. In
987 particular, swap partitions are returned in the list. Also
988 this command does not check that each filesystem
989 found is valid and mountable, and some filesystems might
990 be mountable but require special options. Filesystems may
991 not all belong to a single logical operating system
992 (use C<guestfs_inspect_os> to look for OSes).");
994 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
996 "add an image to examine or modify",
998 This function adds a virtual machine disk image C<filename> to
999 libguestfs. The first time you call this function, the disk
1000 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1003 You don't necessarily need to be root when using libguestfs. However
1004 you obviously do need sufficient permissions to access the filename
1005 for whatever operations you want to perform (ie. read access if you
1006 just want to read the image or write access if you want to modify the
1009 This call checks that C<filename> exists.
1011 The optional arguments are:
1017 If true then the image is treated as read-only. Writes are still
1018 allowed, but they are stored in a temporary snapshot overlay which
1019 is discarded at the end. The disk that you add is not modified.
1023 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1024 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1025 Possible formats include C<raw> and C<qcow2>.
1027 Automatic detection of the format opens you up to a potential
1028 security hole when dealing with untrusted raw-format images.
1029 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1034 This rarely-used option lets you emulate the behaviour of the
1035 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1039 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1041 "get Windows systemroot of inspected operating system",
1043 This returns the Windows systemroot of the inspected guest.
1044 The systemroot is a directory path such as C</WINDOWS>.
1046 This call assumes that the guest is Windows and that the
1047 systemroot could be determined by inspection. If this is not
1048 the case then an error is returned.
1050 Please read L<guestfs(3)/INSPECTION> for more details.");
1052 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1054 "return list of operating systems found by last inspection",
1056 This function is a convenient way to get the list of root
1057 devices, as returned from a previous call to C<guestfs_inspect_os>,
1058 but without redoing the whole inspection process.
1060 This returns an empty list if either no root devices were
1061 found or the caller has not called C<guestfs_inspect_os>.
1063 Please read L<guestfs(3)/INSPECTION> for more details.");
1065 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1067 "debug the QEMU command line (internal use only)",
1069 This returns the internal QEMU command line. 'debug' commands are
1070 not part of the formal API and can be removed or changed at any time.");
1072 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1074 "add the disk(s) from a named libvirt domain",
1076 This function adds the disk(s) attached to the named libvirt
1077 domain C<dom>. It works by connecting to libvirt, requesting
1078 the domain and domain XML from libvirt, parsing it for disks,
1079 and calling C<guestfs_add_drive_opts> on each one.
1081 The number of disks added is returned. This operation is atomic:
1082 if an error is returned, then no disks are added.
1084 This function does some minimal checks to make sure the libvirt
1085 domain is not running (unless C<readonly> is true). In a future
1086 version we will try to acquire the libvirt lock on each disk.
1088 Disks must be accessible locally. This often means that adding disks
1089 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1090 will fail unless those disks are accessible via the same device path
1093 The optional C<libvirturi> parameter sets the libvirt URI
1094 (see L<http://libvirt.org/uri.html>). If this is not set then
1095 we connect to the default libvirt URI (or one set through an
1096 environment variable, see the libvirt documentation for full
1099 The optional C<live> flag controls whether this call will try
1100 to connect to a running virtual machine C<guestfsd> process if
1101 it sees a suitable E<lt>channelE<gt> element in the libvirt
1102 XML definition. The default (if the flag is omitted) is never
1103 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1106 If the C<allowuuid> flag is true (default is false) then a UUID
1107 I<may> be passed instead of the domain name. The C<dom> string is
1108 treated as a UUID first and looked up, and if that lookup fails
1109 then we treat C<dom> as a name as usual.
1111 The other optional parameters are passed directly through to
1112 C<guestfs_add_drive_opts>.");
1115 This interface is not quite baked yet. -- RWMJ 2010-11-11
1116 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1118 "add the disk(s) from a libvirt domain",
1120 This function adds the disk(s) attached to the libvirt domain C<dom>.
1121 It works by requesting the domain XML from libvirt, parsing it for
1122 disks, and calling C<guestfs_add_drive_opts> on each one.
1124 In the C API we declare C<void *dom>, but really it has type
1125 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1127 The number of disks added is returned. This operation is atomic:
1128 if an error is returned, then no disks are added.
1130 This function does some minimal checks to make sure the libvirt
1131 domain is not running (unless C<readonly> is true). In a future
1132 version we will try to acquire the libvirt lock on each disk.
1134 Disks must be accessible locally. This often means that adding disks
1135 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1136 will fail unless those disks are accessible via the same device path
1139 The optional C<live> flag controls whether this call will try
1140 to connect to a running virtual machine C<guestfsd> process if
1141 it sees a suitable E<lt>channelE<gt> element in the libvirt
1142 XML definition. The default (if the flag is omitted) is never
1143 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1146 The other optional parameters are passed directly through to
1147 C<guestfs_add_drive_opts>.");
1150 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1152 "get package format used by the operating system",
1154 This function and C<guestfs_inspect_get_package_management> return
1155 the package format and package management tool used by the
1156 inspected operating system. For example for Fedora these
1157 functions would return C<rpm> (package format) and
1158 C<yum> (package management).
1160 This returns the string C<unknown> if we could not determine the
1161 package format I<or> if the operating system does not have
1162 a real packaging system (eg. Windows).
1164 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1165 Future versions of libguestfs may return other strings.
1167 Please read L<guestfs(3)/INSPECTION> for more details.");
1169 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1171 "get package management tool used by the operating system",
1173 C<guestfs_inspect_get_package_format> and this function return
1174 the package format and package management tool used by the
1175 inspected operating system. For example for Fedora these
1176 functions would return C<rpm> (package format) and
1177 C<yum> (package management).
1179 This returns the string C<unknown> if we could not determine the
1180 package management tool I<or> if the operating system does not have
1181 a real packaging system (eg. Windows).
1183 Possible strings include: C<yum>, C<up2date>,
1184 C<apt> (for all Debian derivatives),
1185 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1186 Future versions of libguestfs may return other strings.
1188 Please read L<guestfs(3)/INSPECTION> for more details.");
1190 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1192 "get list of applications installed in the operating system",
1194 Return the list of applications installed in the operating system.
1196 I<Note:> This call works differently from other parts of the
1197 inspection API. You have to call C<guestfs_inspect_os>, then
1198 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1199 before calling this. Listing applications is a significantly
1200 more difficult operation which requires access to the full
1201 filesystem. Also note that unlike the other
1202 C<guestfs_inspect_get_*> calls which are just returning
1203 data cached in the libguestfs handle, this call actually reads
1204 parts of the mounted filesystems during the call.
1206 This returns an empty list if the inspection code was not able
1207 to determine the list of applications.
1209 The application structure contains the following fields:
1215 The name of the application. For Red Hat-derived and Debian-derived
1216 Linux guests, this is the package name.
1218 =item C<app_display_name>
1220 The display name of the application, sometimes localized to the
1221 install language of the guest operating system.
1223 If unavailable this is returned as an empty string C<\"\">.
1224 Callers needing to display something can use C<app_name> instead.
1228 For package managers which use epochs, this contains the epoch of
1229 the package (an integer). If unavailable, this is returned as C<0>.
1231 =item C<app_version>
1233 The version string of the application or package. If unavailable
1234 this is returned as an empty string C<\"\">.
1236 =item C<app_release>
1238 The release string of the application or package, for package
1239 managers that use this. If unavailable this is returned as an
1240 empty string C<\"\">.
1242 =item C<app_install_path>
1244 The installation path of the application (on operating systems
1245 such as Windows which use installation paths). This path is
1246 in the format used by the guest operating system, it is not
1249 If unavailable this is returned as an empty string C<\"\">.
1251 =item C<app_trans_path>
1253 The install path translated into a libguestfs path.
1254 If unavailable this is returned as an empty string C<\"\">.
1256 =item C<app_publisher>
1258 The name of the publisher of the application, for package
1259 managers that use this. If unavailable this is returned
1260 as an empty string C<\"\">.
1264 The URL (eg. upstream URL) of the application.
1265 If unavailable this is returned as an empty string C<\"\">.
1267 =item C<app_source_package>
1269 For packaging systems which support this, the name of the source
1270 package. If unavailable this is returned as an empty string C<\"\">.
1272 =item C<app_summary>
1274 A short (usually one line) description of the application or package.
1275 If unavailable this is returned as an empty string C<\"\">.
1277 =item C<app_description>
1279 A longer description of the application or package.
1280 If unavailable this is returned as an empty string C<\"\">.
1284 Please read L<guestfs(3)/INSPECTION> for more details.");
1286 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1288 "get hostname of the operating system",
1290 This function returns the hostname of the operating system
1291 as found by inspection of the guest's configuration files.
1293 If the hostname could not be determined, then the
1294 string C<unknown> is returned.
1296 Please read L<guestfs(3)/INSPECTION> for more details.");
1298 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1300 "get format of inspected operating system",
1302 This returns the format of the inspected operating system. You
1303 can use it to detect install images, live CDs and similar.
1305 Currently defined formats are:
1311 This is an installed operating system.
1315 The disk image being inspected is not an installed operating system,
1316 but a I<bootable> install disk, live CD, or similar.
1320 The format of this disk image is not known.
1324 Future versions of libguestfs may return other strings here.
1325 The caller should be prepared to handle any string.
1327 Please read L<guestfs(3)/INSPECTION> for more details.");
1329 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1331 "get live flag for install disk",
1333 If C<guestfs_inspect_get_format> returns C<installer> (this
1334 is an install disk), then this returns true if a live image
1335 was detected on the disk.
1337 Please read L<guestfs(3)/INSPECTION> for more details.");
1339 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1341 "get netinst (network installer) flag for install disk",
1343 If C<guestfs_inspect_get_format> returns C<installer> (this
1344 is an install disk), then this returns true if the disk is
1345 a network installer, ie. not a self-contained install CD but
1346 one which is likely to require network access to complete
1349 Please read L<guestfs(3)/INSPECTION> for more details.");
1351 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1353 "get multipart flag for install disk",
1355 If C<guestfs_inspect_get_format> returns C<installer> (this
1356 is an install disk), then this returns true if the disk is
1359 Please read L<guestfs(3)/INSPECTION> for more details.");
1361 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1363 "set the attach method",
1365 Set the method that libguestfs uses to connect to the back end
1366 guestfsd daemon. Possible methods are:
1372 Launch an appliance and connect to it. This is the ordinary method
1375 =item C<unix:I<path>>
1377 Connect to the Unix domain socket I<path>.
1379 This method lets you connect to an existing daemon or (using
1380 virtio-serial) to a live guest. For more information, see
1381 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1385 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1386 [InitNone, Always, TestOutput (
1387 [["get_attach_method"]], "appliance")],
1388 "get the attach method",
1390 Return the current attach method. See C<guestfs_set_attach_method>.");
1392 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1394 "get product variant of inspected operating system",
1396 This returns the product variant of the inspected operating
1399 For Windows guests, this returns the contents of the Registry key
1400 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1401 C<InstallationType> which is usually a string such as
1402 C<Client> or C<Server> (other values are possible). This
1403 can be used to distinguish consumer and enterprise versions
1404 of Windows that have the same version number (for example,
1405 Windows 7 and Windows 2008 Server are both version 6.1,
1406 but the former is C<Client> and the latter is C<Server>).
1408 For enterprise Linux guests, in future we intend this to return
1409 the product variant such as C<Desktop>, C<Server> and so on. But
1410 this is not implemented at present.
1412 If the product variant could not be determined, then the
1413 string C<unknown> is returned.
1415 Please read L<guestfs(3)/INSPECTION> for more details.
1416 See also C<guestfs_inspect_get_product_name>,
1417 C<guestfs_inspect_get_major_version>.");
1419 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1421 "get Windows CurrentControlSet of inspected operating system",
1423 This returns the Windows CurrentControlSet of the inspected guest.
1424 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1426 This call assumes that the guest is Windows and that the
1427 Registry could be examined by inspection. If this is not
1428 the case then an error is returned.
1430 Please read L<guestfs(3)/INSPECTION> for more details.");
1432 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1434 "get drive letter mappings",
1436 This call is useful for Windows which uses a primitive system
1437 of assigning drive letters (like \"C:\") to partitions.
1438 This inspection API examines the Windows Registry to find out
1439 how disks/partitions are mapped to drive letters, and returns
1440 a hash table as in the example below:
1446 Note that keys are drive letters. For Windows, the key is
1447 case insensitive and just contains the drive letter, without
1448 the customary colon separator character.
1450 In future we may support other operating systems that also used drive
1451 letters, but the keys for those might not be case insensitive
1452 and might be longer than 1 character. For example in OS-9,
1453 hard drives were named C<h0>, C<h1> etc.
1455 For Windows guests, currently only hard drive mappings are
1456 returned. Removable disks (eg. DVD-ROMs) are ignored.
1458 For guests that do not use drive mappings, or if the drive mappings
1459 could not be determined, this returns an empty hash table.
1461 Please read L<guestfs(3)/INSPECTION> for more details.
1462 See also C<guestfs_inspect_get_mountpoints>,
1463 C<guestfs_inspect_get_filesystems>.");
1465 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1467 "get the icon corresponding to this operating system",
1469 This function returns an icon corresponding to the inspected
1470 operating system. The icon is returned as a buffer containing a
1471 PNG image (re-encoded to PNG if necessary).
1473 If it was not possible to get an icon this function returns a
1474 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1476 Libguestfs will start by looking for a file called
1477 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1478 and if it has the correct format, the contents of this file will
1479 be returned. You can disable favicons by passing the
1480 optional C<favicon> boolean as false (default is true).
1482 If finding the favicon fails, then we look in other places in the
1483 guest for a suitable icon.
1485 If the optional C<highquality> boolean is true then
1486 only high quality icons are returned, which means only icons of
1487 high resolution with an alpha channel. The default (false) is
1488 to return any icon we can, even if it is of substandard quality.
1496 Unlike most other inspection API calls, the guest's disks must be
1497 mounted up before you call this, since it needs to read information
1498 from the guest filesystem during the call.
1502 B<Security:> The icon data comes from the untrusted guest,
1503 and should be treated with caution. PNG files have been
1504 known to contain exploits. Ensure that libpng (or other relevant
1505 libraries) are fully up to date before trying to process or
1510 The PNG image returned can be any size. It might not be square.
1511 Libguestfs tries to return the largest, highest quality
1512 icon available. The application must scale the icon to the
1517 Extracting icons from Windows guests requires the external
1518 C<wrestool> program from the C<icoutils> package, and
1519 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1520 from the C<netpbm> package. These must be installed separately.
1524 Operating system icons are usually trademarks. Seek legal
1525 advice before using trademarks in applications.
1529 ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1531 "set process group flag",
1533 If C<pgroup> is true, child processes are placed into
1534 their own process group.
1536 The practical upshot of this is that signals like C<SIGINT> (from
1537 users pressing C<^C>) won't be received by the child process.
1539 The default for this flag is false, because usually you want
1540 C<^C> to kill the subprocess.");
1542 ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1544 "get process group flag",
1546 This returns the process group flag.");
1550 (* daemon_functions are any functions which cause some action
1551 * to take place in the daemon.
1554 let daemon_functions = [
1555 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [DeprecatedBy "mount_options"],
1556 [InitEmpty, Always, TestOutput (
1557 [["part_disk"; "/dev/sda"; "mbr"];
1558 ["mkfs"; "ext2"; "/dev/sda1"];
1559 ["mount"; "/dev/sda1"; "/"];
1560 ["write"; "/new"; "new file contents"];
1561 ["cat"; "/new"]], "new file contents")],
1562 "mount a guest disk at a position in the filesystem",
1564 Mount a guest disk at a position in the filesystem. Block devices
1565 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1566 the guest. If those block devices contain partitions, they will have
1567 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1570 The rules are the same as for L<mount(2)>: A filesystem must
1571 first be mounted on C</> before others can be mounted. Other
1572 filesystems can only be mounted on directories which already
1575 The mounted filesystem is writable, if we have sufficient permissions
1576 on the underlying device.
1579 When you use this call, the filesystem options C<sync> and C<noatime>
1580 are set implicitly. This was originally done because we thought it
1581 would improve reliability, but it turns out that I<-o sync> has a
1582 very large negative performance impact and negligible effect on
1583 reliability. Therefore we recommend that you avoid using
1584 C<guestfs_mount> in any code that needs performance, and instead
1585 use C<guestfs_mount_options> (use an empty string for the first
1586 parameter if you don't want any options).");
1588 ("sync", (RErr, [], []), 2, [],
1589 [ InitEmpty, Always, TestRun [["sync"]]],
1590 "sync disks, writes are flushed through to the disk image",
1592 This syncs the disk, so that any writes are flushed through to the
1593 underlying disk image.
1595 You should always call this if you have modified a disk image, before
1596 closing the handle.");
1598 ("touch", (RErr, [Pathname "path"], []), 3, [],
1599 [InitScratchFS, Always, TestOutputTrue (
1600 [["touch"; "/touch"];
1601 ["exists"; "/touch"]])],
1602 "update file timestamps or create a new file",
1604 Touch acts like the L<touch(1)> command. It can be used to
1605 update the timestamps on a file, or, if the file does not exist,
1606 to create a new zero-length file.
1608 This command only works on regular files, and will fail on other
1609 file types such as directories, symbolic links, block special etc.");
1611 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1612 [InitISOFS, Always, TestOutput (
1613 [["cat"; "/known-2"]], "abcdef\n")],
1614 "list the contents of a file",
1616 Return the contents of the file named C<path>.
1618 Note that this function cannot correctly handle binary files
1619 (specifically, files containing C<\\0> character which is treated
1620 as end of string). For those you need to use the C<guestfs_read_file>
1621 or C<guestfs_download> functions which have a more complex interface.");
1623 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1624 [], (* XXX Tricky to test because it depends on the exact format
1625 * of the 'ls -l' command, which changes between F10 and F11.
1627 "list the files in a directory (long format)",
1629 List the files in C<directory> (relative to the root directory,
1630 there is no cwd) in the format of 'ls -la'.
1632 This command is mostly useful for interactive sessions. It
1633 is I<not> intended that you try to parse the output string.");
1635 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1636 [InitScratchFS, Always, TestOutputList (
1638 ["touch"; "/ls/new"];
1639 ["touch"; "/ls/newer"];
1640 ["touch"; "/ls/newest"];
1641 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1642 "list the files in a directory",
1644 List the files in C<directory> (relative to the root directory,
1645 there is no cwd). The '.' and '..' entries are not returned, but
1646 hidden files are shown.
1648 This command is mostly useful for interactive sessions. Programs
1649 should probably use C<guestfs_readdir> instead.");
1651 ("list_devices", (RStringList "devices", [], []), 7, [],
1652 [InitEmpty, Always, TestOutputListOfDevices (
1653 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1654 "list the block devices",
1656 List all the block devices.
1658 The full block device names are returned, eg. C</dev/sda>.
1660 See also C<guestfs_list_filesystems>.");
1662 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1663 [InitBasicFS, Always, TestOutputListOfDevices (
1664 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1665 InitEmpty, Always, TestOutputListOfDevices (
1666 [["part_init"; "/dev/sda"; "mbr"];
1667 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1668 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1669 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1670 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1671 "list the partitions",
1673 List all the partitions detected on all block devices.
1675 The full partition device names are returned, eg. C</dev/sda1>
1677 This does not return logical volumes. For that you will need to
1678 call C<guestfs_lvs>.
1680 See also C<guestfs_list_filesystems>.");
1682 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1683 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1684 [["pvs"]], ["/dev/sda1"]);
1685 InitEmpty, Always, TestOutputListOfDevices (
1686 [["part_init"; "/dev/sda"; "mbr"];
1687 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1688 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1689 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1690 ["pvcreate"; "/dev/sda1"];
1691 ["pvcreate"; "/dev/sda2"];
1692 ["pvcreate"; "/dev/sda3"];
1693 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1694 "list the LVM physical volumes (PVs)",
1696 List all the physical volumes detected. This is the equivalent
1697 of the L<pvs(8)> command.
1699 This returns a list of just the device names that contain
1700 PVs (eg. C</dev/sda2>).
1702 See also C<guestfs_pvs_full>.");
1704 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1705 [InitBasicFSonLVM, Always, TestOutputList (
1707 InitEmpty, Always, TestOutputList (
1708 [["part_init"; "/dev/sda"; "mbr"];
1709 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1710 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1711 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1712 ["pvcreate"; "/dev/sda1"];
1713 ["pvcreate"; "/dev/sda2"];
1714 ["pvcreate"; "/dev/sda3"];
1715 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1716 ["vgcreate"; "VG2"; "/dev/sda3"];
1717 ["vgs"]], ["VG1"; "VG2"])],
1718 "list the LVM volume groups (VGs)",
1720 List all the volumes groups detected. This is the equivalent
1721 of the L<vgs(8)> command.
1723 This returns a list of just the volume group names that were
1724 detected (eg. C<VolGroup00>).
1726 See also C<guestfs_vgs_full>.");
1728 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1729 [InitBasicFSonLVM, Always, TestOutputList (
1730 [["lvs"]], ["/dev/VG/LV"]);
1731 InitEmpty, Always, TestOutputList (
1732 [["part_init"; "/dev/sda"; "mbr"];
1733 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1734 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1735 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1736 ["pvcreate"; "/dev/sda1"];
1737 ["pvcreate"; "/dev/sda2"];
1738 ["pvcreate"; "/dev/sda3"];
1739 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1740 ["vgcreate"; "VG2"; "/dev/sda3"];
1741 ["lvcreate"; "LV1"; "VG1"; "50"];
1742 ["lvcreate"; "LV2"; "VG1"; "50"];
1743 ["lvcreate"; "LV3"; "VG2"; "50"];
1744 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1745 "list the LVM logical volumes (LVs)",
1747 List all the logical volumes detected. This is the equivalent
1748 of the L<lvs(8)> command.
1750 This returns a list of the logical volume device names
1751 (eg. C</dev/VolGroup00/LogVol00>).
1753 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1755 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1756 [], (* XXX how to test? *)
1757 "list the LVM physical volumes (PVs)",
1759 List all the physical volumes detected. This is the equivalent
1760 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1762 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1763 [], (* XXX how to test? *)
1764 "list the LVM volume groups (VGs)",
1766 List all the volumes groups detected. This is the equivalent
1767 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1769 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1770 [], (* XXX how to test? *)
1771 "list the LVM logical volumes (LVs)",
1773 List all the logical volumes detected. This is the equivalent
1774 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1776 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1777 [InitISOFS, Always, TestOutputList (
1778 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1779 InitISOFS, Always, TestOutputList (
1780 [["read_lines"; "/empty"]], [])],
1781 "read file as lines",
1783 Return the contents of the file named C<path>.
1785 The file contents are returned as a list of lines. Trailing
1786 C<LF> and C<CRLF> character sequences are I<not> returned.
1788 Note that this function cannot correctly handle binary files
1789 (specifically, files containing C<\\0> character which is treated
1790 as end of line). For those you need to use the C<guestfs_read_file>
1791 function which has a more complex interface.");
1793 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1794 [], (* XXX Augeas code needs tests. *)
1795 "create a new Augeas handle",
1797 Create a new Augeas handle for editing configuration files.
1798 If there was any previous Augeas handle associated with this
1799 guestfs session, then it is closed.
1801 You must call this before using any other C<guestfs_aug_*>
1804 C<root> is the filesystem root. C<root> must not be NULL,
1807 The flags are the same as the flags defined in
1808 E<lt>augeas.hE<gt>, the logical I<or> of the following
1813 =item C<AUG_SAVE_BACKUP> = 1
1815 Keep the original file with a C<.augsave> extension.
1817 =item C<AUG_SAVE_NEWFILE> = 2
1819 Save changes into a file with extension C<.augnew>, and
1820 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1822 =item C<AUG_TYPE_CHECK> = 4
1826 This option is only useful when debugging Augeas lenses. Use
1827 of this option may require additional memory for the libguestfs
1828 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1829 environment variable or call C<guestfs_set_memsize>.
1831 =item C<AUG_NO_STDINC> = 8
1833 Do not use standard load path for modules.
1835 =item C<AUG_SAVE_NOOP> = 16
1837 Make save a no-op, just record what would have been changed.
1839 =item C<AUG_NO_LOAD> = 32
1841 Do not load the tree in C<guestfs_aug_init>.
1845 To close the handle, you can call C<guestfs_aug_close>.
1847 To find out more about Augeas, see L<http://augeas.net/>.");
1849 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1850 [], (* XXX Augeas code needs tests. *)
1851 "close the current Augeas handle",
1853 Close the current Augeas handle and free up any resources
1854 used by it. After calling this, you have to call
1855 C<guestfs_aug_init> again before you can use any other
1856 Augeas functions.");
1858 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1859 [], (* XXX Augeas code needs tests. *)
1860 "define an Augeas variable",
1862 Defines an Augeas variable C<name> whose value is the result
1863 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1866 On success this returns the number of nodes in C<expr>, or
1867 C<0> if C<expr> evaluates to something which is not a nodeset.");
1869 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1870 [], (* XXX Augeas code needs tests. *)
1871 "define an Augeas node",
1873 Defines a variable C<name> whose value is the result of
1876 If C<expr> evaluates to an empty nodeset, a node is created,
1877 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1878 C<name> will be the nodeset containing that single node.
1880 On success this returns a pair containing the
1881 number of nodes in the nodeset, and a boolean flag
1882 if a node was created.");
1884 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1885 [], (* XXX Augeas code needs tests. *)
1886 "look up the value of an Augeas path",
1888 Look up the value associated with C<path>. If C<path>
1889 matches exactly one node, the C<value> is returned.");
1891 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1892 [], (* XXX Augeas code needs tests. *)
1893 "set Augeas path to value",
1895 Set the value associated with C<path> to C<val>.
1897 In the Augeas API, it is possible to clear a node by setting
1898 the value to NULL. Due to an oversight in the libguestfs API
1899 you cannot do that with this call. Instead you must use the
1900 C<guestfs_aug_clear> call.");
1902 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1903 [], (* XXX Augeas code needs tests. *)
1904 "insert a sibling Augeas node",
1906 Create a new sibling C<label> for C<path>, inserting it into
1907 the tree before or after C<path> (depending on the boolean
1910 C<path> must match exactly one existing node in the tree, and
1911 C<label> must be a label, ie. not contain C</>, C<*> or end
1912 with a bracketed index C<[N]>.");
1914 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1915 [], (* XXX Augeas code needs tests. *)
1916 "remove an Augeas path",
1918 Remove C<path> and all of its children.
1920 On success this returns the number of entries which were removed.");
1922 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1923 [], (* XXX Augeas code needs tests. *)
1926 Move the node C<src> to C<dest>. C<src> must match exactly
1927 one node. C<dest> is overwritten if it exists.");
1929 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1930 [], (* XXX Augeas code needs tests. *)
1931 "return Augeas nodes which match augpath",
1933 Returns a list of paths which match the path expression C<path>.
1934 The returned paths are sufficiently qualified so that they match
1935 exactly one node in the current tree.");
1937 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1938 [], (* XXX Augeas code needs tests. *)
1939 "write all pending Augeas changes to disk",
1941 This writes all pending changes to disk.
1943 The flags which were passed to C<guestfs_aug_init> affect exactly
1944 how files are saved.");
1946 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1947 [], (* XXX Augeas code needs tests. *)
1948 "load files into the tree",
1950 Load files into the tree.
1952 See C<aug_load> in the Augeas documentation for the full gory
1955 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1956 [], (* XXX Augeas code needs tests. *)
1957 "list Augeas nodes under augpath",
1959 This is just a shortcut for listing C<guestfs_aug_match>
1960 C<path/*> and sorting the resulting nodes into alphabetical order.");
1962 ("rm", (RErr, [Pathname "path"], []), 29, [],
1963 [InitScratchFS, Always, TestRun
1965 ["touch"; "/rm/new"];
1967 InitScratchFS, Always, TestLastFail
1968 [["rm"; "/nosuchfile"]];
1969 InitScratchFS, Always, TestLastFail
1974 Remove the single file C<path>.");
1976 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1977 [InitScratchFS, Always, TestRun
1978 [["mkdir"; "/rmdir"];
1979 ["rmdir"; "/rmdir"]];
1980 InitScratchFS, Always, TestLastFail
1981 [["rmdir"; "/rmdir2"]];
1982 InitScratchFS, Always, TestLastFail
1983 [["mkdir"; "/rmdir3"];
1984 ["touch"; "/rmdir3/new"];
1985 ["rmdir"; "/rmdir3/new"]]],
1986 "remove a directory",
1988 Remove the single directory C<path>.");
1990 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1991 [InitScratchFS, Always, TestOutputFalse
1992 [["mkdir"; "/rm_rf"];
1993 ["mkdir"; "/rm_rf/foo"];
1994 ["touch"; "/rm_rf/foo/bar"];
1995 ["rm_rf"; "/rm_rf"];
1996 ["exists"; "/rm_rf"]]],
1997 "remove a file or directory recursively",
1999 Remove the file or directory C<path>, recursively removing the
2000 contents if its a directory. This is like the C<rm -rf> shell
2003 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2004 [InitScratchFS, Always, TestOutputTrue
2005 [["mkdir"; "/mkdir"];
2006 ["is_dir"; "/mkdir"]];
2007 InitScratchFS, Always, TestLastFail
2008 [["mkdir"; "/mkdir2/foo/bar"]]],
2009 "create a directory",
2011 Create a directory named C<path>.");
2013 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2014 [InitScratchFS, Always, TestOutputTrue
2015 [["mkdir_p"; "/mkdir_p/foo/bar"];
2016 ["is_dir"; "/mkdir_p/foo/bar"]];
2017 InitScratchFS, Always, TestOutputTrue
2018 [["mkdir_p"; "/mkdir_p2/foo/bar"];
2019 ["is_dir"; "/mkdir_p2/foo"]];
2020 InitScratchFS, Always, TestOutputTrue
2021 [["mkdir_p"; "/mkdir_p3/foo/bar"];
2022 ["is_dir"; "/mkdir_p3"]];
2023 (* Regression tests for RHBZ#503133: *)
2024 InitScratchFS, Always, TestRun
2025 [["mkdir"; "/mkdir_p4"];
2026 ["mkdir_p"; "/mkdir_p4"]];
2027 InitScratchFS, Always, TestLastFail
2028 [["touch"; "/mkdir_p5"];
2029 ["mkdir_p"; "/mkdir_p5"]]],
2030 "create a directory and parents",
2032 Create a directory named C<path>, creating any parent directories
2033 as necessary. This is like the C<mkdir -p> shell command.");
2035 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2036 [], (* XXX Need stat command to test *)
2039 Change the mode (permissions) of C<path> to C<mode>. Only
2040 numeric modes are supported.
2042 I<Note>: When using this command from guestfish, C<mode>
2043 by default would be decimal, unless you prefix it with
2044 C<0> to get octal, ie. use C<0700> not C<700>.
2046 The mode actually set is affected by the umask.");
2048 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2049 [], (* XXX Need stat command to test *)
2050 "change file owner and group",
2052 Change the file owner to C<owner> and group to C<group>.
2054 Only numeric uid and gid are supported. If you want to use
2055 names, you will need to locate and parse the password file
2056 yourself (Augeas support makes this relatively easy).");
2058 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2059 [InitISOFS, Always, TestOutputTrue (
2060 [["exists"; "/empty"]]);
2061 InitISOFS, Always, TestOutputTrue (
2062 [["exists"; "/directory"]])],
2063 "test if file or directory exists",
2065 This returns C<true> if and only if there is a file, directory
2066 (or anything) with the given C<path> name.
2068 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2070 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2071 [InitISOFS, Always, TestOutputTrue (
2072 [["is_file"; "/known-1"]]);
2073 InitISOFS, Always, TestOutputFalse (
2074 [["is_file"; "/directory"]])],
2075 "test if a regular file",
2077 This returns C<true> if and only if there is a regular file
2078 with the given C<path> name. Note that it returns false for
2079 other objects like directories.
2081 See also C<guestfs_stat>.");
2083 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2084 [InitISOFS, Always, TestOutputFalse (
2085 [["is_dir"; "/known-3"]]);
2086 InitISOFS, Always, TestOutputTrue (
2087 [["is_dir"; "/directory"]])],
2088 "test if a directory",
2090 This returns C<true> if and only if there is a directory
2091 with the given C<path> name. Note that it returns false for
2092 other objects like files.
2094 See also C<guestfs_stat>.");
2096 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2097 [InitEmpty, Always, TestOutputListOfDevices (
2098 [["part_init"; "/dev/sda"; "mbr"];
2099 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2100 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2101 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2102 ["pvcreate"; "/dev/sda1"];
2103 ["pvcreate"; "/dev/sda2"];
2104 ["pvcreate"; "/dev/sda3"];
2105 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2106 "create an LVM physical volume",
2108 This creates an LVM physical volume on the named C<device>,
2109 where C<device> should usually be a partition name such
2112 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2113 [InitEmpty, Always, TestOutputList (
2114 [["part_init"; "/dev/sda"; "mbr"];
2115 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2116 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2117 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2118 ["pvcreate"; "/dev/sda1"];
2119 ["pvcreate"; "/dev/sda2"];
2120 ["pvcreate"; "/dev/sda3"];
2121 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2122 ["vgcreate"; "VG2"; "/dev/sda3"];
2123 ["vgs"]], ["VG1"; "VG2"])],
2124 "create an LVM volume group",
2126 This creates an LVM volume group called C<volgroup>
2127 from the non-empty list of physical volumes C<physvols>.");
2129 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [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 ["lvcreate"; "LV1"; "VG1"; "50"];
2141 ["lvcreate"; "LV2"; "VG1"; "50"];
2142 ["lvcreate"; "LV3"; "VG2"; "50"];
2143 ["lvcreate"; "LV4"; "VG2"; "50"];
2144 ["lvcreate"; "LV5"; "VG2"; "50"];
2146 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2147 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2148 "create an LVM logical volume",
2150 This creates an LVM logical volume called C<logvol>
2151 on the volume group C<volgroup>, with C<size> megabytes.");
2153 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2154 [InitEmpty, Always, TestOutput (
2155 [["part_disk"; "/dev/sda"; "mbr"];
2156 ["mkfs"; "ext2"; "/dev/sda1"];
2157 ["mount_options"; ""; "/dev/sda1"; "/"];
2158 ["write"; "/new"; "new file contents"];
2159 ["cat"; "/new"]], "new file contents")],
2160 "make a filesystem",
2162 This creates a filesystem on C<device> (usually a partition
2163 or LVM logical volume). The filesystem type is C<fstype>, for
2166 ("sfdisk", (RErr, [Device "device";
2167 Int "cyls"; Int "heads"; Int "sectors";
2168 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2170 "create partitions on a block device",
2172 This is a direct interface to the L<sfdisk(8)> program for creating
2173 partitions on block devices.
2175 C<device> should be a block device, for example C</dev/sda>.
2177 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2178 and sectors on the device, which are passed directly to sfdisk as
2179 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2180 of these, then the corresponding parameter is omitted. Usually for
2181 'large' disks, you can just pass C<0> for these, but for small
2182 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2183 out the right geometry and you will need to tell it.
2185 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2186 information refer to the L<sfdisk(8)> manpage.
2188 To create a single partition occupying the whole disk, you would
2189 pass C<lines> as a single element list, when the single element being
2190 the string C<,> (comma).
2192 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2193 C<guestfs_part_init>");
2195 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2196 (* Regression test for RHBZ#597135. *)
2197 [InitScratchFS, Always, TestLastFail
2198 [["write_file"; "/write_file"; "abc"; "10000"]]],
2201 This call creates a file called C<path>. The contents of the
2202 file is the string C<content> (which can contain any 8 bit data),
2203 with length C<size>.
2205 As a special case, if C<size> is C<0>
2206 then the length is calculated using C<strlen> (so in this case
2207 the content cannot contain embedded ASCII NULs).
2209 I<NB.> Owing to a bug, writing content containing ASCII NUL
2210 characters does I<not> work, even if the length is specified.");
2212 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2213 [InitEmpty, Always, TestOutputListOfDevices (
2214 [["part_disk"; "/dev/sda"; "mbr"];
2215 ["mkfs"; "ext2"; "/dev/sda1"];
2216 ["mount_options"; ""; "/dev/sda1"; "/"];
2217 ["mounts"]], ["/dev/sda1"]);
2218 InitEmpty, Always, TestOutputList (
2219 [["part_disk"; "/dev/sda"; "mbr"];
2220 ["mkfs"; "ext2"; "/dev/sda1"];
2221 ["mount_options"; ""; "/dev/sda1"; "/"];
2224 "unmount a filesystem",
2226 This unmounts the given filesystem. The filesystem may be
2227 specified either by its mountpoint (path) or the device which
2228 contains the filesystem.");
2230 ("mounts", (RStringList "devices", [], []), 46, [],
2231 [InitScratchFS, Always, TestOutputListOfDevices (
2232 [["mounts"]], ["/dev/sdb1"])],
2233 "show mounted filesystems",
2235 This returns the list of currently mounted filesystems. It returns
2236 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2238 Some internal mounts are not shown.
2240 See also: C<guestfs_mountpoints>");
2242 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2243 [InitScratchFS, Always, TestOutputList (
2246 (* check that umount_all can unmount nested mounts correctly: *)
2247 InitEmpty, Always, TestOutputList (
2248 [["part_init"; "/dev/sda"; "mbr"];
2249 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2250 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2251 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2252 ["mkfs"; "ext2"; "/dev/sda1"];
2253 ["mkfs"; "ext2"; "/dev/sda2"];
2254 ["mkfs"; "ext2"; "/dev/sda3"];
2255 ["mount_options"; ""; "/dev/sda1"; "/"];
2257 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2258 ["mkdir"; "/mp1/mp2"];
2259 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2260 ["mkdir"; "/mp1/mp2/mp3"];
2263 "unmount all filesystems",
2265 This unmounts all mounted filesystems.
2267 Some internal mounts are not unmounted by this call.");
2269 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2271 "remove all LVM LVs, VGs and PVs",
2273 This command removes all LVM logical volumes, volume groups
2274 and physical volumes.");
2276 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2277 [InitISOFS, Always, TestOutput (
2278 [["file"; "/empty"]], "empty");
2279 InitISOFS, Always, TestOutput (
2280 [["file"; "/known-1"]], "ASCII text");
2281 InitISOFS, Always, TestLastFail (
2282 [["file"; "/notexists"]]);
2283 InitISOFS, Always, TestOutput (
2284 [["file"; "/abssymlink"]], "symbolic link");
2285 InitISOFS, Always, TestOutput (
2286 [["file"; "/directory"]], "directory")],
2287 "determine file type",
2289 This call uses the standard L<file(1)> command to determine
2290 the type or contents of the file.
2292 This call will also transparently look inside various types
2295 The exact command which runs is C<file -zb path>. Note in
2296 particular that the filename is not prepended to the output
2299 The output depends on the output of the underlying L<file(1)>
2300 command and it can change in future in ways beyond our control.
2301 In other words, the output is not guaranteed by the ABI.
2303 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2304 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2306 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2307 [InitScratchFS, Always, TestOutput (
2308 [["mkdir"; "/command"];
2309 ["upload"; "test-command"; "/command/test-command"];
2310 ["chmod"; "0o755"; "/command/test-command"];
2311 ["command"; "/command/test-command 1"]], "Result1");
2312 InitScratchFS, Always, TestOutput (
2313 [["mkdir"; "/command2"];
2314 ["upload"; "test-command"; "/command2/test-command"];
2315 ["chmod"; "0o755"; "/command2/test-command"];
2316 ["command"; "/command2/test-command 2"]], "Result2\n");
2317 InitScratchFS, Always, TestOutput (
2318 [["mkdir"; "/command3"];
2319 ["upload"; "test-command"; "/command3/test-command"];
2320 ["chmod"; "0o755"; "/command3/test-command"];
2321 ["command"; "/command3/test-command 3"]], "\nResult3");
2322 InitScratchFS, Always, TestOutput (
2323 [["mkdir"; "/command4"];
2324 ["upload"; "test-command"; "/command4/test-command"];
2325 ["chmod"; "0o755"; "/command4/test-command"];
2326 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2327 InitScratchFS, Always, TestOutput (
2328 [["mkdir"; "/command5"];
2329 ["upload"; "test-command"; "/command5/test-command"];
2330 ["chmod"; "0o755"; "/command5/test-command"];
2331 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2332 InitScratchFS, Always, TestOutput (
2333 [["mkdir"; "/command6"];
2334 ["upload"; "test-command"; "/command6/test-command"];
2335 ["chmod"; "0o755"; "/command6/test-command"];
2336 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2337 InitScratchFS, Always, TestOutput (
2338 [["mkdir"; "/command7"];
2339 ["upload"; "test-command"; "/command7/test-command"];
2340 ["chmod"; "0o755"; "/command7/test-command"];
2341 ["command"; "/command7/test-command 7"]], "");
2342 InitScratchFS, Always, TestOutput (
2343 [["mkdir"; "/command8"];
2344 ["upload"; "test-command"; "/command8/test-command"];
2345 ["chmod"; "0o755"; "/command8/test-command"];
2346 ["command"; "/command8/test-command 8"]], "\n");
2347 InitScratchFS, Always, TestOutput (
2348 [["mkdir"; "/command9"];
2349 ["upload"; "test-command"; "/command9/test-command"];
2350 ["chmod"; "0o755"; "/command9/test-command"];
2351 ["command"; "/command9/test-command 9"]], "\n\n");
2352 InitScratchFS, Always, TestOutput (
2353 [["mkdir"; "/command10"];
2354 ["upload"; "test-command"; "/command10/test-command"];
2355 ["chmod"; "0o755"; "/command10/test-command"];
2356 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2357 InitScratchFS, Always, TestOutput (
2358 [["mkdir"; "/command11"];
2359 ["upload"; "test-command"; "/command11/test-command"];
2360 ["chmod"; "0o755"; "/command11/test-command"];
2361 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2362 InitScratchFS, Always, TestLastFail (
2363 [["mkdir"; "/command12"];
2364 ["upload"; "test-command"; "/command12/test-command"];
2365 ["chmod"; "0o755"; "/command12/test-command"];
2366 ["command"; "/command12/test-command"]])],
2367 "run a command from the guest filesystem",
2369 This call runs a command from the guest filesystem. The
2370 filesystem must be mounted, and must contain a compatible
2371 operating system (ie. something Linux, with the same
2372 or compatible processor architecture).
2374 The single parameter is an argv-style list of arguments.
2375 The first element is the name of the program to run.
2376 Subsequent elements are parameters. The list must be
2377 non-empty (ie. must contain a program name). Note that
2378 the command runs directly, and is I<not> invoked via
2379 the shell (see C<guestfs_sh>).
2381 The return value is anything printed to I<stdout> by
2384 If the command returns a non-zero exit status, then
2385 this function returns an error message. The error message
2386 string is the content of I<stderr> from the command.
2388 The C<$PATH> environment variable will contain at least
2389 C</usr/bin> and C</bin>. If you require a program from
2390 another location, you should provide the full path in the
2393 Shared libraries and data files required by the program
2394 must be available on filesystems which are mounted in the
2395 correct places. It is the caller's responsibility to ensure
2396 all filesystems that are needed are mounted at the right
2399 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2400 [InitScratchFS, Always, TestOutputList (
2401 [["mkdir"; "/command_lines"];
2402 ["upload"; "test-command"; "/command_lines/test-command"];
2403 ["chmod"; "0o755"; "/command_lines/test-command"];
2404 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2405 InitScratchFS, Always, TestOutputList (
2406 [["mkdir"; "/command_lines2"];
2407 ["upload"; "test-command"; "/command_lines2/test-command"];
2408 ["chmod"; "0o755"; "/command_lines2/test-command"];
2409 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2410 InitScratchFS, Always, TestOutputList (
2411 [["mkdir"; "/command_lines3"];
2412 ["upload"; "test-command"; "/command_lines3/test-command"];
2413 ["chmod"; "0o755"; "/command_lines3/test-command"];
2414 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2415 InitScratchFS, Always, TestOutputList (
2416 [["mkdir"; "/command_lines4"];
2417 ["upload"; "test-command"; "/command_lines4/test-command"];
2418 ["chmod"; "0o755"; "/command_lines4/test-command"];
2419 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2420 InitScratchFS, Always, TestOutputList (
2421 [["mkdir"; "/command_lines5"];
2422 ["upload"; "test-command"; "/command_lines5/test-command"];
2423 ["chmod"; "0o755"; "/command_lines5/test-command"];
2424 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2425 InitScratchFS, Always, TestOutputList (
2426 [["mkdir"; "/command_lines6"];
2427 ["upload"; "test-command"; "/command_lines6/test-command"];
2428 ["chmod"; "0o755"; "/command_lines6/test-command"];
2429 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2430 InitScratchFS, Always, TestOutputList (
2431 [["mkdir"; "/command_lines7"];
2432 ["upload"; "test-command"; "/command_lines7/test-command"];
2433 ["chmod"; "0o755"; "/command_lines7/test-command"];
2434 ["command_lines"; "/command_lines7/test-command 7"]], []);
2435 InitScratchFS, Always, TestOutputList (
2436 [["mkdir"; "/command_lines8"];
2437 ["upload"; "test-command"; "/command_lines8/test-command"];
2438 ["chmod"; "0o755"; "/command_lines8/test-command"];
2439 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2440 InitScratchFS, Always, TestOutputList (
2441 [["mkdir"; "/command_lines9"];
2442 ["upload"; "test-command"; "/command_lines9/test-command"];
2443 ["chmod"; "0o755"; "/command_lines9/test-command"];
2444 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2445 InitScratchFS, Always, TestOutputList (
2446 [["mkdir"; "/command_lines10"];
2447 ["upload"; "test-command"; "/command_lines10/test-command"];
2448 ["chmod"; "0o755"; "/command_lines10/test-command"];
2449 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2450 InitScratchFS, Always, TestOutputList (
2451 [["mkdir"; "/command_lines11"];
2452 ["upload"; "test-command"; "/command_lines11/test-command"];
2453 ["chmod"; "0o755"; "/command_lines11/test-command"];
2454 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2455 "run a command, returning lines",
2457 This is the same as C<guestfs_command>, but splits the
2458 result into a list of lines.
2460 See also: C<guestfs_sh_lines>");
2462 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2463 [InitISOFS, Always, TestOutputStruct (
2464 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2465 "get file information",
2467 Returns file information for the given C<path>.
2469 This is the same as the C<stat(2)> system call.");
2471 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2472 [InitISOFS, Always, TestOutputStruct (
2473 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2474 "get file information for a symbolic link",
2476 Returns file information for the given C<path>.
2478 This is the same as C<guestfs_stat> except that if C<path>
2479 is a symbolic link, then the link is stat-ed, not the file it
2482 This is the same as the C<lstat(2)> system call.");
2484 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2485 [InitISOFS, Always, TestOutputStruct (
2486 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2487 "get file system statistics",
2489 Returns file system statistics for any mounted file system.
2490 C<path> should be a file or directory in the mounted file system
2491 (typically it is the mount point itself, but it doesn't need to be).
2493 This is the same as the C<statvfs(2)> system call.");
2495 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2497 "get ext2/ext3/ext4 superblock details",
2499 This returns the contents of the ext2, ext3 or ext4 filesystem
2500 superblock on C<device>.
2502 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2503 manpage for more details. The list of fields returned isn't
2504 clearly defined, and depends on both the version of C<tune2fs>
2505 that libguestfs was built against, and the filesystem itself.");
2507 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2508 [InitEmpty, Always, TestOutputTrue (
2509 [["blockdev_setro"; "/dev/sda"];
2510 ["blockdev_getro"; "/dev/sda"]])],
2511 "set block device to read-only",
2513 Sets the block device named C<device> to read-only.
2515 This uses the L<blockdev(8)> command.");
2517 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2518 [InitEmpty, Always, TestOutputFalse (
2519 [["blockdev_setrw"; "/dev/sda"];
2520 ["blockdev_getro"; "/dev/sda"]])],
2521 "set block device to read-write",
2523 Sets the block device named C<device> to read-write.
2525 This uses the L<blockdev(8)> command.");
2527 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2528 [InitEmpty, Always, TestOutputTrue (
2529 [["blockdev_setro"; "/dev/sda"];
2530 ["blockdev_getro"; "/dev/sda"]])],
2531 "is block device set to read-only",
2533 Returns a boolean indicating if the block device is read-only
2534 (true if read-only, false if not).
2536 This uses the L<blockdev(8)> command.");
2538 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2539 [InitEmpty, Always, TestOutputInt (
2540 [["blockdev_getss"; "/dev/sda"]], 512)],
2541 "get sectorsize of block device",
2543 This returns the size of sectors on a block device.
2544 Usually 512, but can be larger for modern devices.
2546 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2549 This uses the L<blockdev(8)> command.");
2551 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2552 [InitEmpty, Always, TestOutputInt (
2553 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2554 "get blocksize of block device",
2556 This returns the block size of a device.
2558 (Note this is different from both I<size in blocks> and
2559 I<filesystem block size>).
2561 This uses the L<blockdev(8)> command.");
2563 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2565 "set blocksize of block device",
2567 This sets the block size of a device.
2569 (Note this is different from both I<size in blocks> and
2570 I<filesystem block size>).
2572 This uses the L<blockdev(8)> command.");
2574 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2575 [InitEmpty, Always, TestOutputInt (
2576 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2577 "get total size of device in 512-byte sectors",
2579 This returns the size of the device in units of 512-byte sectors
2580 (even if the sectorsize isn't 512 bytes ... weird).
2582 See also C<guestfs_blockdev_getss> for the real sector size of
2583 the device, and C<guestfs_blockdev_getsize64> for the more
2584 useful I<size in bytes>.
2586 This uses the L<blockdev(8)> command.");
2588 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2589 [InitEmpty, Always, TestOutputInt (
2590 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2591 "get total size of device in bytes",
2593 This returns the size of the device in bytes.
2595 See also C<guestfs_blockdev_getsz>.
2597 This uses the L<blockdev(8)> command.");
2599 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2600 [InitEmpty, Always, TestRun
2601 [["blockdev_flushbufs"; "/dev/sda"]]],
2602 "flush device buffers",
2604 This tells the kernel to flush internal buffers associated
2607 This uses the L<blockdev(8)> command.");
2609 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2610 [InitEmpty, Always, TestRun
2611 [["blockdev_rereadpt"; "/dev/sda"]]],
2612 "reread partition table",
2614 Reread the partition table on C<device>.
2616 This uses the L<blockdev(8)> command.");
2618 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2619 [InitScratchFS, Always, TestOutput (
2620 (* Pick a file from cwd which isn't likely to change. *)
2621 [["mkdir"; "/upload"];
2622 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2623 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2624 Digest.to_hex (Digest.file "COPYING.LIB"))],
2625 "upload a file from the local machine",
2627 Upload local file C<filename> to C<remotefilename> on the
2630 C<filename> can also be a named pipe.
2632 See also C<guestfs_download>.");
2634 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2635 [InitScratchFS, Always, TestOutput (
2636 (* Pick a file from cwd which isn't likely to change. *)
2637 [["mkdir"; "/download"];
2638 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2639 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2640 ["upload"; "testdownload.tmp"; "/download/upload"];
2641 ["checksum"; "md5"; "/download/upload"]],
2642 Digest.to_hex (Digest.file "COPYING.LIB"))],
2643 "download a file to the local machine",
2645 Download file C<remotefilename> and save it as C<filename>
2646 on the local machine.
2648 C<filename> can also be a named pipe.
2650 See also C<guestfs_upload>, C<guestfs_cat>.");
2652 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2653 [InitISOFS, Always, TestOutput (
2654 [["checksum"; "crc"; "/known-3"]], "2891671662");
2655 InitISOFS, Always, TestLastFail (
2656 [["checksum"; "crc"; "/notexists"]]);
2657 InitISOFS, Always, TestOutput (
2658 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2659 InitISOFS, Always, TestOutput (
2660 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2661 InitISOFS, Always, TestOutput (
2662 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2663 InitISOFS, Always, TestOutput (
2664 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2665 InitISOFS, Always, TestOutput (
2666 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2667 InitISOFS, Always, TestOutput (
2668 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2669 (* Test for RHBZ#579608, absolute symbolic links. *)
2670 InitISOFS, Always, TestOutput (
2671 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2672 "compute MD5, SHAx or CRC checksum of file",
2674 This call computes the MD5, SHAx or CRC checksum of the
2677 The type of checksum to compute is given by the C<csumtype>
2678 parameter which must have one of the following values:
2684 Compute the cyclic redundancy check (CRC) specified by POSIX
2685 for the C<cksum> command.
2689 Compute the MD5 hash (using the C<md5sum> program).
2693 Compute the SHA1 hash (using the C<sha1sum> program).
2697 Compute the SHA224 hash (using the C<sha224sum> program).
2701 Compute the SHA256 hash (using the C<sha256sum> program).
2705 Compute the SHA384 hash (using the C<sha384sum> program).
2709 Compute the SHA512 hash (using the C<sha512sum> program).
2713 The checksum is returned as a printable string.
2715 To get the checksum for a device, use C<guestfs_checksum_device>.
2717 To get the checksums for many files, use C<guestfs_checksums_out>.");
2719 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2720 [InitScratchFS, Always, TestOutput (
2721 [["mkdir"; "/tar_in"];
2722 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2723 ["cat"; "/tar_in/hello"]], "hello\n")],
2724 "unpack tarfile to directory",
2726 This command uploads and unpacks local file C<tarfile> (an
2727 I<uncompressed> tar file) into C<directory>.
2729 To upload a compressed tarball, use C<guestfs_tgz_in>
2730 or C<guestfs_txz_in>.");
2732 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2734 "pack directory into tarfile",
2736 This command packs the contents of C<directory> and downloads
2737 it to local file C<tarfile>.
2739 To download a compressed tarball, use C<guestfs_tgz_out>
2740 or C<guestfs_txz_out>.");
2742 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2743 [InitScratchFS, Always, TestOutput (
2744 [["mkdir"; "/tgz_in"];
2745 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2746 ["cat"; "/tgz_in/hello"]], "hello\n")],
2747 "unpack compressed tarball to directory",
2749 This command uploads and unpacks local file C<tarball> (a
2750 I<gzip compressed> tar file) into C<directory>.
2752 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2754 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2756 "pack directory into compressed tarball",
2758 This command packs the contents of C<directory> and downloads
2759 it to local file C<tarball>.
2761 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2763 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2764 [InitBasicFS, Always, TestLastFail (
2766 ["mount_ro"; "/dev/sda1"; "/"];
2767 ["touch"; "/new"]]);
2768 InitBasicFS, Always, TestOutput (
2769 [["write"; "/new"; "data"];
2771 ["mount_ro"; "/dev/sda1"; "/"];
2772 ["cat"; "/new"]], "data")],
2773 "mount a guest disk, read-only",
2775 This is the same as the C<guestfs_mount> command, but it
2776 mounts the filesystem with the read-only (I<-o ro>) flag.");
2778 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2780 "mount a guest disk with mount options",
2782 This is the same as the C<guestfs_mount> command, but it
2783 allows you to set the mount options as for the
2784 L<mount(8)> I<-o> flag.
2786 If the C<options> parameter is an empty string, then
2787 no options are passed (all options default to whatever
2788 the filesystem uses).");
2790 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2792 "mount a guest disk with mount options and vfstype",
2794 This is the same as the C<guestfs_mount> command, but it
2795 allows you to set both the mount options and the vfstype
2796 as for the L<mount(8)> I<-o> and I<-t> flags.");
2798 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2800 "debugging and internals",
2802 The C<guestfs_debug> command exposes some internals of
2803 C<guestfsd> (the guestfs daemon) that runs inside the
2806 There is no comprehensive help for this command. You have
2807 to look at the file C<daemon/debug.c> in the libguestfs source
2808 to find out what you can do.");
2810 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2811 [InitEmpty, Always, TestOutputList (
2812 [["part_disk"; "/dev/sda"; "mbr"];
2813 ["pvcreate"; "/dev/sda1"];
2814 ["vgcreate"; "VG"; "/dev/sda1"];
2815 ["lvcreate"; "LV1"; "VG"; "50"];
2816 ["lvcreate"; "LV2"; "VG"; "50"];
2817 ["lvremove"; "/dev/VG/LV1"];
2818 ["lvs"]], ["/dev/VG/LV2"]);
2819 InitEmpty, Always, TestOutputList (
2820 [["part_disk"; "/dev/sda"; "mbr"];
2821 ["pvcreate"; "/dev/sda1"];
2822 ["vgcreate"; "VG"; "/dev/sda1"];
2823 ["lvcreate"; "LV1"; "VG"; "50"];
2824 ["lvcreate"; "LV2"; "VG"; "50"];
2825 ["lvremove"; "/dev/VG"];
2827 InitEmpty, Always, TestOutputList (
2828 [["part_disk"; "/dev/sda"; "mbr"];
2829 ["pvcreate"; "/dev/sda1"];
2830 ["vgcreate"; "VG"; "/dev/sda1"];
2831 ["lvcreate"; "LV1"; "VG"; "50"];
2832 ["lvcreate"; "LV2"; "VG"; "50"];
2833 ["lvremove"; "/dev/VG"];
2835 "remove an LVM logical volume",
2837 Remove an LVM logical volume C<device>, where C<device> is
2838 the path to the LV, such as C</dev/VG/LV>.
2840 You can also remove all LVs in a volume group by specifying
2841 the VG name, C</dev/VG>.");
2843 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
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"];
2852 InitEmpty, Always, TestOutputList (
2853 [["part_disk"; "/dev/sda"; "mbr"];
2854 ["pvcreate"; "/dev/sda1"];
2855 ["vgcreate"; "VG"; "/dev/sda1"];
2856 ["lvcreate"; "LV1"; "VG"; "50"];
2857 ["lvcreate"; "LV2"; "VG"; "50"];
2860 "remove an LVM volume group",
2862 Remove an LVM volume group C<vgname>, (for example C<VG>).
2864 This also forcibly removes all logical volumes in the volume
2867 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2868 [InitEmpty, Always, TestOutputListOfDevices (
2869 [["part_disk"; "/dev/sda"; "mbr"];
2870 ["pvcreate"; "/dev/sda1"];
2871 ["vgcreate"; "VG"; "/dev/sda1"];
2872 ["lvcreate"; "LV1"; "VG"; "50"];
2873 ["lvcreate"; "LV2"; "VG"; "50"];
2875 ["pvremove"; "/dev/sda1"];
2877 InitEmpty, Always, TestOutputListOfDevices (
2878 [["part_disk"; "/dev/sda"; "mbr"];
2879 ["pvcreate"; "/dev/sda1"];
2880 ["vgcreate"; "VG"; "/dev/sda1"];
2881 ["lvcreate"; "LV1"; "VG"; "50"];
2882 ["lvcreate"; "LV2"; "VG"; "50"];
2884 ["pvremove"; "/dev/sda1"];
2886 InitEmpty, Always, TestOutputListOfDevices (
2887 [["part_disk"; "/dev/sda"; "mbr"];
2888 ["pvcreate"; "/dev/sda1"];
2889 ["vgcreate"; "VG"; "/dev/sda1"];
2890 ["lvcreate"; "LV1"; "VG"; "50"];
2891 ["lvcreate"; "LV2"; "VG"; "50"];
2893 ["pvremove"; "/dev/sda1"];
2895 "remove an LVM physical volume",
2897 This wipes a physical volume C<device> so that LVM will no longer
2900 The implementation uses the C<pvremove> command which refuses to
2901 wipe physical volumes that contain any volume groups, so you have
2902 to remove those first.");
2904 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2905 [InitBasicFS, Always, TestOutput (
2906 [["set_e2label"; "/dev/sda1"; "testlabel"];
2907 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2908 "set the ext2/3/4 filesystem label",
2910 This sets the ext2/3/4 filesystem label of the filesystem on
2911 C<device> to C<label>. Filesystem labels are limited to
2914 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2915 to return the existing label on a filesystem.");
2917 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2919 "get the ext2/3/4 filesystem label",
2921 This returns the ext2/3/4 filesystem label of the filesystem on
2924 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2925 (let uuid = uuidgen () in
2926 [InitBasicFS, Always, TestOutput (
2927 [["set_e2uuid"; "/dev/sda1"; uuid];
2928 ["get_e2uuid"; "/dev/sda1"]], uuid);
2929 InitBasicFS, Always, TestOutput (
2930 [["set_e2uuid"; "/dev/sda1"; "clear"];
2931 ["get_e2uuid"; "/dev/sda1"]], "");
2932 (* We can't predict what UUIDs will be, so just check the commands run. *)
2933 InitBasicFS, Always, TestRun (
2934 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2935 InitBasicFS, Always, TestRun (
2936 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2937 "set the ext2/3/4 filesystem UUID",
2939 This sets the ext2/3/4 filesystem UUID of the filesystem on
2940 C<device> to C<uuid>. The format of the UUID and alternatives
2941 such as C<clear>, C<random> and C<time> are described in the
2942 L<tune2fs(8)> manpage.
2944 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2945 to return the existing UUID of a filesystem.");
2947 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2948 (* Regression test for RHBZ#597112. *)
2949 (let uuid = uuidgen () in
2950 [InitNone, Always, TestOutput (
2951 [["mke2journal"; "1024"; "/dev/sdc"];
2952 ["set_e2uuid"; "/dev/sdc"; uuid];
2953 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2954 "get the ext2/3/4 filesystem UUID",
2956 This returns the ext2/3/4 filesystem UUID of the filesystem on
2959 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2960 [InitBasicFS, Always, TestOutputInt (
2961 [["umount"; "/dev/sda1"];
2962 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2963 InitBasicFS, Always, TestOutputInt (
2964 [["umount"; "/dev/sda1"];
2965 ["zero"; "/dev/sda1"];
2966 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2967 "run the filesystem checker",
2969 This runs the filesystem checker (fsck) on C<device> which
2970 should have filesystem type C<fstype>.
2972 The returned integer is the status. See L<fsck(8)> for the
2973 list of status codes from C<fsck>.
2981 Multiple status codes can be summed together.
2985 A non-zero return code can mean \"success\", for example if
2986 errors have been corrected on the filesystem.
2990 Checking or repairing NTFS volumes is not supported
2995 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2997 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2998 [InitBasicFS, Always, TestRun (
2999 [["umount"; "/dev/sda1"];
3000 ["zero"; "/dev/sda1"]])],
3001 "write zeroes to the device",
3003 This command writes zeroes over the first few blocks of C<device>.
3005 How many blocks are zeroed isn't specified (but it's I<not> enough
3006 to securely wipe the device). It should be sufficient to remove
3007 any partition tables, filesystem superblocks and so on.
3009 If blocks are already zero, then this command avoids writing
3010 zeroes. This prevents the underlying device from becoming non-sparse
3011 or growing unnecessarily.
3013 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3014 C<guestfs_is_zero_device>");
3016 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
3018 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3019 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3021 [InitBasicFS, Always, TestOutputTrue (
3022 [["mkdir_p"; "/boot/grub"];
3023 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3024 ["grub_install"; "/"; "/dev/vda"];
3025 ["is_dir"; "/boot"]])],
3028 This command installs GRUB (the Grand Unified Bootloader) on
3029 C<device>, with the root directory being C<root>.
3031 Note: If grub-install reports the error
3032 \"No suitable drive was found in the generated device map.\"
3033 it may be that you need to create a C</boot/grub/device.map>
3034 file first that contains the mapping between grub device names
3035 and Linux device names. It is usually sufficient to create
3040 replacing C</dev/vda> with the name of the installation device.");
3042 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3043 [InitScratchFS, Always, TestOutput (
3045 ["write"; "/cp/old"; "file content"];
3046 ["cp"; "/cp/old"; "/cp/new"];
3047 ["cat"; "/cp/new"]], "file content");
3048 InitScratchFS, Always, TestOutputTrue (
3050 ["write"; "/cp2/old"; "file content"];
3051 ["cp"; "/cp2/old"; "/cp2/new"];
3052 ["is_file"; "/cp2/old"]]);
3053 InitScratchFS, Always, TestOutput (
3055 ["write"; "/cp3/old"; "file content"];
3056 ["mkdir"; "/cp3/dir"];
3057 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3058 ["cat"; "/cp3/dir/new"]], "file content")],
3061 This copies a file from C<src> to C<dest> where C<dest> is
3062 either a destination filename or destination directory.");
3064 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3065 [InitScratchFS, Always, TestOutput (
3066 [["mkdir"; "/cp_a1"];
3067 ["mkdir"; "/cp_a2"];
3068 ["write"; "/cp_a1/file"; "file content"];
3069 ["cp_a"; "/cp_a1"; "/cp_a2"];
3070 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3071 "copy a file or directory recursively",
3073 This copies a file or directory from C<src> to C<dest>
3074 recursively using the C<cp -a> command.");
3076 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3077 [InitScratchFS, Always, TestOutput (
3079 ["write"; "/mv/old"; "file content"];
3080 ["mv"; "/mv/old"; "/mv/new"];
3081 ["cat"; "/mv/new"]], "file content");
3082 InitScratchFS, Always, TestOutputFalse (
3084 ["write"; "/mv2/old"; "file content"];
3085 ["mv"; "/mv2/old"; "/mv2/new"];
3086 ["is_file"; "/mv2/old"]])],
3089 This moves a file from C<src> to C<dest> where C<dest> is
3090 either a destination filename or destination directory.");
3092 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3093 [InitEmpty, Always, TestRun (
3094 [["drop_caches"; "3"]])],
3095 "drop kernel page cache, dentries and inodes",
3097 This instructs the guest kernel to drop its page cache,
3098 and/or dentries and inode caches. The parameter C<whattodrop>
3099 tells the kernel what precisely to drop, see
3100 L<http://linux-mm.org/Drop_Caches>
3102 Setting C<whattodrop> to 3 should drop everything.
3104 This automatically calls L<sync(2)> before the operation,
3105 so that the maximum guest memory is freed.");
3107 ("dmesg", (RString "kmsgs", [], []), 91, [],
3108 [InitEmpty, Always, TestRun (
3110 "return kernel messages",
3112 This returns the kernel messages (C<dmesg> output) from
3113 the guest kernel. This is sometimes useful for extended
3114 debugging of problems.
3116 Another way to get the same information is to enable
3117 verbose messages with C<guestfs_set_verbose> or by setting
3118 the environment variable C<LIBGUESTFS_DEBUG=1> before
3119 running the program.");
3121 ("ping_daemon", (RErr, [], []), 92, [],
3122 [InitEmpty, Always, TestRun (
3123 [["ping_daemon"]])],
3124 "ping the guest daemon",
3126 This is a test probe into the guestfs daemon running inside
3127 the qemu subprocess. Calling this function checks that the
3128 daemon responds to the ping message, without affecting the daemon
3129 or attached block device(s) in any other way.");
3131 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3132 [InitScratchFS, Always, TestOutputTrue (
3133 [["mkdir"; "/equal"];
3134 ["write"; "/equal/file1"; "contents of a file"];
3135 ["cp"; "/equal/file1"; "/equal/file2"];
3136 ["equal"; "/equal/file1"; "/equal/file2"]]);
3137 InitScratchFS, Always, TestOutputFalse (
3138 [["mkdir"; "/equal2"];
3139 ["write"; "/equal2/file1"; "contents of a file"];
3140 ["write"; "/equal2/file2"; "contents of another file"];
3141 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3142 InitScratchFS, Always, TestLastFail (
3143 [["mkdir"; "/equal3"];
3144 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3145 "test if two files have equal contents",
3147 This compares the two files C<file1> and C<file2> and returns
3148 true if their content is exactly equal, or false otherwise.
3150 The external L<cmp(1)> program is used for the comparison.");
3152 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3153 [InitISOFS, Always, TestOutputList (
3154 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3155 InitISOFS, Always, TestOutputList (
3156 [["strings"; "/empty"]], []);
3157 (* Test for RHBZ#579608, absolute symbolic links. *)
3158 InitISOFS, Always, TestRun (
3159 [["strings"; "/abssymlink"]])],
3160 "print the printable strings in a file",
3162 This runs the L<strings(1)> command on a file and returns
3163 the list of printable strings found.");
3165 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3166 [InitISOFS, Always, TestOutputList (
3167 [["strings_e"; "b"; "/known-5"]], []);
3168 InitScratchFS, Always, TestOutputList (
3169 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3170 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3171 "print the printable strings in a file",
3173 This is like the C<guestfs_strings> command, but allows you to
3174 specify the encoding of strings that are looked for in
3175 the source file C<path>.
3177 Allowed encodings are:
3183 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3184 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3188 Single 8-bit-byte characters.
3192 16-bit big endian strings such as those encoded in
3193 UTF-16BE or UCS-2BE.
3195 =item l (lower case letter L)
3197 16-bit little endian such as UTF-16LE and UCS-2LE.
3198 This is useful for examining binaries in Windows guests.
3202 32-bit big endian such as UCS-4BE.
3206 32-bit little endian such as UCS-4LE.
3210 The returned strings are transcoded to UTF-8.");
3212 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3213 [InitISOFS, Always, TestOutput (
3214 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3215 (* Test for RHBZ#501888c2 regression which caused large hexdump
3216 * commands to segfault.
3218 InitISOFS, Always, TestRun (
3219 [["hexdump"; "/100krandom"]]);
3220 (* Test for RHBZ#579608, absolute symbolic links. *)
3221 InitISOFS, Always, TestRun (
3222 [["hexdump"; "/abssymlink"]])],
3223 "dump a file in hexadecimal",
3225 This runs C<hexdump -C> on the given C<path>. The result is
3226 the human-readable, canonical hex dump of the file.");
3228 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3229 [InitNone, Always, TestOutput (
3230 [["part_disk"; "/dev/sda"; "mbr"];
3231 ["mkfs"; "ext3"; "/dev/sda1"];
3232 ["mount_options"; ""; "/dev/sda1"; "/"];
3233 ["write"; "/new"; "test file"];
3234 ["umount"; "/dev/sda1"];
3235 ["zerofree"; "/dev/sda1"];
3236 ["mount_options"; ""; "/dev/sda1"; "/"];
3237 ["cat"; "/new"]], "test file")],
3238 "zero unused inodes and disk blocks on ext2/3 filesystem",
3240 This runs the I<zerofree> program on C<device>. This program
3241 claims to zero unused inodes and disk blocks on an ext2/3
3242 filesystem, thus making it possible to compress the filesystem
3245 You should B<not> run this program if the filesystem is
3248 It is possible that using this program can damage the filesystem
3249 or data on the filesystem.");
3251 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3253 "resize an LVM physical volume",
3255 This resizes (expands or shrinks) an existing LVM physical
3256 volume to match the new size of the underlying device.");
3258 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3259 Int "cyls"; Int "heads"; Int "sectors";
3260 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3262 "modify a single partition on a block device",
3264 This runs L<sfdisk(8)> option to modify just the single
3265 partition C<n> (note: C<n> counts from 1).
3267 For other parameters, see C<guestfs_sfdisk>. You should usually
3268 pass C<0> for the cyls/heads/sectors parameters.
3270 See also: C<guestfs_part_add>");
3272 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3274 "display the partition table",
3276 This displays the partition table on C<device>, in the
3277 human-readable output of the L<sfdisk(8)> command. It is
3278 not intended to be parsed.
3280 See also: C<guestfs_part_list>");
3282 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3284 "display the kernel geometry",
3286 This displays the kernel's idea of the geometry of C<device>.
3288 The result is in human-readable format, and not designed to
3291 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3293 "display the disk geometry from the partition table",
3295 This displays the disk geometry of C<device> read from the
3296 partition table. Especially in the case where the underlying
3297 block device has been resized, this can be different from the
3298 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3300 The result is in human-readable format, and not designed to
3303 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3305 "activate or deactivate all volume groups",
3307 This command activates or (if C<activate> is false) deactivates
3308 all logical volumes in all volume groups.
3310 This command is the same as running C<vgchange -a y|n>");
3312 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3314 "activate or deactivate some volume groups",
3316 This command activates or (if C<activate> is false) deactivates
3317 all logical volumes in the listed volume groups C<volgroups>.
3319 This command is the same as running C<vgchange -a y|n volgroups...>
3321 Note that if C<volgroups> is an empty list then B<all> volume groups
3322 are activated or deactivated.");
3324 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3325 [InitNone, Always, TestOutput (
3326 [["part_disk"; "/dev/sda"; "mbr"];
3327 ["pvcreate"; "/dev/sda1"];
3328 ["vgcreate"; "VG"; "/dev/sda1"];
3329 ["lvcreate"; "LV"; "VG"; "10"];
3330 ["mkfs"; "ext2"; "/dev/VG/LV"];
3331 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3332 ["write"; "/new"; "test content"];
3334 ["lvresize"; "/dev/VG/LV"; "20"];
3335 ["e2fsck_f"; "/dev/VG/LV"];
3336 ["resize2fs"; "/dev/VG/LV"];
3337 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3338 ["cat"; "/new"]], "test content");
3339 InitNone, Always, TestRun (
3340 (* Make an LV smaller to test RHBZ#587484. *)
3341 [["part_disk"; "/dev/sda"; "mbr"];
3342 ["pvcreate"; "/dev/sda1"];
3343 ["vgcreate"; "VG"; "/dev/sda1"];
3344 ["lvcreate"; "LV"; "VG"; "20"];
3345 ["lvresize"; "/dev/VG/LV"; "10"]])],
3346 "resize an LVM logical volume",
3348 This resizes (expands or shrinks) an existing LVM logical
3349 volume to C<mbytes>. When reducing, data in the reduced part
3352 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3353 [], (* lvresize tests this *)
3354 "resize an ext2, ext3 or ext4 filesystem",
3356 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3357 the underlying device.
3359 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3360 on the C<device> before calling this command. For unknown reasons
3361 C<resize2fs> sometimes gives an error about this and sometimes not.
3362 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3363 calling this function.");
3365 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3366 [InitBasicFS, Always, TestOutputList (
3367 [["find"; "/"]], ["lost+found"]);
3368 InitBasicFS, Always, TestOutputList (
3372 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3373 InitScratchFS, Always, TestOutputList (
3374 [["mkdir_p"; "/find/b/c"];
3375 ["touch"; "/find/b/c/d"];
3376 ["find"; "/find/b/"]], ["c"; "c/d"])],
3377 "find all files and directories",
3379 This command lists out all files and directories, recursively,
3380 starting at C<directory>. It is essentially equivalent to
3381 running the shell command C<find directory -print> but some
3382 post-processing happens on the output, described below.
3384 This returns a list of strings I<without any prefix>. Thus
3385 if the directory structure was:
3391 then the returned list from C<guestfs_find> C</tmp> would be
3399 If C<directory> is not a directory, then this command returns
3402 The returned list is sorted.
3404 See also C<guestfs_find0>.");
3406 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3407 [], (* lvresize tests this *)
3408 "check an ext2/ext3 filesystem",
3410 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3411 filesystem checker on C<device>, noninteractively (I<-p>),
3412 even if the filesystem appears to be clean (I<-f>).
3414 This command is only needed because of C<guestfs_resize2fs>
3415 (q.v.). Normally you should use C<guestfs_fsck>.");
3417 ("sleep", (RErr, [Int "secs"], []), 109, [],
3418 [InitNone, Always, TestRun (
3420 "sleep for some seconds",
3422 Sleep for C<secs> seconds.");
3424 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3425 [InitNone, Always, TestOutputInt (
3426 [["part_disk"; "/dev/sda"; "mbr"];
3427 ["mkfs"; "ntfs"; "/dev/sda1"];
3428 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3429 InitNone, Always, TestOutputInt (
3430 [["part_disk"; "/dev/sda"; "mbr"];
3431 ["mkfs"; "ext2"; "/dev/sda1"];
3432 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3433 "probe NTFS volume",
3435 This command runs the L<ntfs-3g.probe(8)> command which probes
3436 an NTFS C<device> for mountability. (Not all NTFS volumes can
3437 be mounted read-write, and some cannot be mounted at all).
3439 C<rw> is a boolean flag. Set it to true if you want to test
3440 if the volume can be mounted read-write. Set it to false if
3441 you want to test if the volume can be mounted read-only.
3443 The return value is an integer which C<0> if the operation
3444 would succeed, or some non-zero value documented in the
3445 L<ntfs-3g.probe(8)> manual page.");
3447 ("sh", (RString "output", [String "command"], []), 111, [],
3448 [], (* XXX needs tests *)
3449 "run a command via the shell",
3451 This call runs a command from the guest filesystem via the
3454 This is like C<guestfs_command>, but passes the command to:
3456 /bin/sh -c \"command\"
3458 Depending on the guest's shell, this usually results in
3459 wildcards being expanded, shell expressions being interpolated
3462 All the provisos about C<guestfs_command> apply to this call.");
3464 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3465 [], (* XXX needs tests *)
3466 "run a command via the shell returning lines",
3468 This is the same as C<guestfs_sh>, but splits the result
3469 into a list of lines.
3471 See also: C<guestfs_command_lines>");
3473 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3474 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3475 * code in stubs.c, since all valid glob patterns must start with "/".
3476 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3478 [InitScratchFS, Always, TestOutputList (
3479 [["mkdir_p"; "/glob_expand/b/c"];
3480 ["touch"; "/glob_expand/b/c/d"];
3481 ["touch"; "/glob_expand/b/c/e"];
3482 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3483 InitScratchFS, Always, TestOutputList (
3484 [["mkdir_p"; "/glob_expand2/b/c"];
3485 ["touch"; "/glob_expand2/b/c/d"];
3486 ["touch"; "/glob_expand2/b/c/e"];
3487 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3488 InitScratchFS, Always, TestOutputList (
3489 [["mkdir_p"; "/glob_expand3/b/c"];
3490 ["touch"; "/glob_expand3/b/c/d"];
3491 ["touch"; "/glob_expand3/b/c/e"];
3492 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3493 "expand a wildcard path",
3495 This command searches for all the pathnames matching
3496 C<pattern> according to the wildcard expansion rules
3499 If no paths match, then this returns an empty list
3500 (note: not an error).
3502 It is just a wrapper around the C L<glob(3)> function
3503 with flags C<GLOB_MARK|GLOB_BRACE>.
3504 See that manual page for more details.");
3506 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3507 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3508 [["scrub_device"; "/dev/sdc"]])],
3509 "scrub (securely wipe) a device",
3511 This command writes patterns over C<device> to make data retrieval
3514 It is an interface to the L<scrub(1)> program. See that
3515 manual page for more details.");
3517 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3518 [InitScratchFS, Always, TestRun (
3519 [["write"; "/scrub_file"; "content"];
3520 ["scrub_file"; "/scrub_file"]])],
3521 "scrub (securely wipe) a file",
3523 This command writes patterns over a file to make data retrieval
3526 The file is I<removed> after scrubbing.
3528 It is an interface to the L<scrub(1)> program. See that
3529 manual page for more details.");
3531 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3532 [], (* XXX needs testing *)
3533 "scrub (securely wipe) free space",
3535 This command creates the directory C<dir> and then fills it
3536 with files until the filesystem is full, and scrubs the files
3537 as for C<guestfs_scrub_file>, and deletes them.
3538 The intention is to scrub any free space on the partition
3541 It is an interface to the L<scrub(1)> program. See that
3542 manual page for more details.");
3544 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3545 [InitScratchFS, Always, TestRun (
3546 [["mkdir"; "/mkdtemp"];
3547 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3548 "create a temporary directory",
3550 This command creates a temporary directory. The
3551 C<template> parameter should be a full pathname for the
3552 temporary directory name with the final six characters being
3555 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3556 the second one being suitable for Windows filesystems.
3558 The name of the temporary directory that was created
3561 The temporary directory is created with mode 0700
3562 and is owned by root.
3564 The caller is responsible for deleting the temporary
3565 directory and its contents after use.
3567 See also: L<mkdtemp(3)>");
3569 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3570 [InitISOFS, Always, TestOutputInt (
3571 [["wc_l"; "/10klines"]], 10000);
3572 (* Test for RHBZ#579608, absolute symbolic links. *)
3573 InitISOFS, Always, TestOutputInt (
3574 [["wc_l"; "/abssymlink"]], 10000)],
3575 "count lines in a file",
3577 This command counts the lines in a file, using the
3578 C<wc -l> external command.");
3580 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3581 [InitISOFS, Always, TestOutputInt (
3582 [["wc_w"; "/10klines"]], 10000)],
3583 "count words in a file",
3585 This command counts the words in a file, using the
3586 C<wc -w> external command.");
3588 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3589 [InitISOFS, Always, TestOutputInt (
3590 [["wc_c"; "/100kallspaces"]], 102400)],
3591 "count characters in a file",
3593 This command counts the characters in a file, using the
3594 C<wc -c> external command.");
3596 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3597 [InitISOFS, Always, TestOutputList (
3598 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3599 (* Test for RHBZ#579608, absolute symbolic links. *)
3600 InitISOFS, Always, TestOutputList (
3601 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3602 "return first 10 lines of a file",
3604 This command returns up to the first 10 lines of a file as
3605 a list of strings.");
3607 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3608 [InitISOFS, Always, TestOutputList (
3609 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3610 InitISOFS, Always, TestOutputList (
3611 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3612 InitISOFS, Always, TestOutputList (
3613 [["head_n"; "0"; "/10klines"]], [])],
3614 "return first N lines of a file",
3616 If the parameter C<nrlines> is a positive number, this returns the first
3617 C<nrlines> lines of the file C<path>.
3619 If the parameter C<nrlines> is a negative number, this returns lines
3620 from the file C<path>, excluding the last C<nrlines> lines.
3622 If the parameter C<nrlines> is zero, this returns an empty list.");
3624 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3625 [InitISOFS, Always, TestOutputList (
3626 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3627 "return last 10 lines of a file",
3629 This command returns up to the last 10 lines of a file as
3630 a list of strings.");
3632 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3633 [InitISOFS, Always, TestOutputList (
3634 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3635 InitISOFS, Always, TestOutputList (
3636 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3637 InitISOFS, Always, TestOutputList (
3638 [["tail_n"; "0"; "/10klines"]], [])],
3639 "return last N lines of a file",
3641 If the parameter C<nrlines> is a positive number, this returns the last
3642 C<nrlines> lines of the file C<path>.
3644 If the parameter C<nrlines> is a negative number, this returns lines
3645 from the file C<path>, starting with the C<-nrlines>th line.
3647 If the parameter C<nrlines> is zero, this returns an empty list.");
3649 ("df", (RString "output", [], []), 125, [],
3650 [], (* XXX Tricky to test because it depends on the exact format
3651 * of the 'df' command and other imponderables.
3653 "report file system disk space usage",
3655 This command runs the C<df> command to report disk space used.
3657 This command is mostly useful for interactive sessions. It
3658 is I<not> intended that you try to parse the output string.
3659 Use C<guestfs_statvfs> from programs.");
3661 ("df_h", (RString "output", [], []), 126, [],
3662 [], (* XXX Tricky to test because it depends on the exact format
3663 * of the 'df' command and other imponderables.
3665 "report file system disk space usage (human readable)",
3667 This command runs the C<df -h> command to report disk space used
3668 in human-readable format.
3670 This command is mostly useful for interactive sessions. It
3671 is I<not> intended that you try to parse the output string.
3672 Use C<guestfs_statvfs> from programs.");
3674 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3675 [InitISOFS, Always, TestOutputInt (
3676 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3677 "estimate file space usage",
3679 This command runs the C<du -s> command to estimate file space
3682 C<path> can be a file or a directory. If C<path> is a directory
3683 then the estimate includes the contents of the directory and all
3684 subdirectories (recursively).
3686 The result is the estimated size in I<kilobytes>
3687 (ie. units of 1024 bytes).");
3689 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3690 [InitISOFS, Always, TestOutputList (
3691 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3692 "list files in an initrd",
3694 This command lists out files contained in an initrd.
3696 The files are listed without any initial C</> character. The
3697 files are listed in the order they appear (not necessarily
3698 alphabetical). Directory names are listed as separate items.
3700 Old Linux kernels (2.4 and earlier) used a compressed ext2
3701 filesystem as initrd. We I<only> support the newer initramfs
3702 format (compressed cpio files).");
3704 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3706 "mount a file using the loop device",
3708 This command lets you mount C<file> (a filesystem image
3709 in a file) on a mount point. It is entirely equivalent to
3710 the command C<mount -o loop file mountpoint>.");
3712 ("mkswap", (RErr, [Device "device"], []), 130, [],
3713 [InitEmpty, Always, TestRun (
3714 [["part_disk"; "/dev/sda"; "mbr"];
3715 ["mkswap"; "/dev/sda1"]])],
3716 "create a swap partition",
3718 Create a swap partition on C<device>.");
3720 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3721 [InitEmpty, Always, TestRun (
3722 [["part_disk"; "/dev/sda"; "mbr"];
3723 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3724 "create a swap partition with a label",
3726 Create a swap partition on C<device> with label C<label>.
3728 Note that you cannot attach a swap label to a block device
3729 (eg. C</dev/sda>), just to a partition. This appears to be
3730 a limitation of the kernel or swap tools.");
3732 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3733 (let uuid = uuidgen () in
3734 [InitEmpty, Always, TestRun (
3735 [["part_disk"; "/dev/sda"; "mbr"];
3736 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3737 "create a swap partition with an explicit UUID",
3739 Create a swap partition on C<device> with UUID C<uuid>.");
3741 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3742 [InitScratchFS, Always, TestOutputStruct (
3743 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3744 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3745 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3746 InitScratchFS, Always, TestOutputStruct (
3747 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3748 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3749 "make block, character or FIFO devices",
3751 This call creates block or character special devices, or
3752 named pipes (FIFOs).
3754 The C<mode> parameter should be the mode, using the standard
3755 constants. C<devmajor> and C<devminor> are the
3756 device major and minor numbers, only used when creating block
3757 and character special devices.
3759 Note that, just like L<mknod(2)>, the mode must be bitwise
3760 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3761 just creates a regular file). These constants are
3762 available in the standard Linux header files, or you can use
3763 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3764 which are wrappers around this command which bitwise OR
3765 in the appropriate constant for you.
3767 The mode actually set is affected by the umask.");
3769 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3770 [InitScratchFS, Always, TestOutputStruct (
3771 [["mkfifo"; "0o777"; "/mkfifo"];
3772 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3773 "make FIFO (named pipe)",
3775 This call creates a FIFO (named pipe) called C<path> with
3776 mode C<mode>. It is just a convenient wrapper around
3779 The mode actually set is affected by the umask.");
3781 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3782 [InitScratchFS, Always, TestOutputStruct (
3783 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3784 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3785 "make block device node",
3787 This call creates a block device node called C<path> with
3788 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3789 It is just a convenient wrapper around C<guestfs_mknod>.
3791 The mode actually set is affected by the umask.");
3793 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3794 [InitScratchFS, Always, TestOutputStruct (
3795 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3796 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3797 "make char device node",
3799 This call creates a char device node called C<path> with
3800 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3801 It is just a convenient wrapper around C<guestfs_mknod>.
3803 The mode actually set is affected by the umask.");
3805 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3806 [InitEmpty, Always, TestOutputInt (
3807 [["umask"; "0o22"]], 0o22)],
3808 "set file mode creation mask (umask)",
3810 This function sets the mask used for creating new files and
3811 device nodes to C<mask & 0777>.
3813 Typical umask values would be C<022> which creates new files
3814 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3815 C<002> which creates new files with permissions like
3816 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3818 The default umask is C<022>. This is important because it
3819 means that directories and device nodes will be created with
3820 C<0644> or C<0755> mode even if you specify C<0777>.
3822 See also C<guestfs_get_umask>,
3823 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3825 This call returns the previous umask.");
3827 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3829 "read directories entries",
3831 This returns the list of directory entries in directory C<dir>.
3833 All entries in the directory are returned, including C<.> and
3834 C<..>. The entries are I<not> sorted, but returned in the same
3835 order as the underlying filesystem.
3837 Also this call returns basic file type information about each
3838 file. The C<ftyp> field will contain one of the following characters:
3876 The L<readdir(3)> call returned a C<d_type> field with an
3881 This function is primarily intended for use by programs. To
3882 get a simple list of names, use C<guestfs_ls>. To get a printable
3883 directory for human consumption, use C<guestfs_ll>.");
3885 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3887 "create partitions on a block device",
3889 This is a simplified interface to the C<guestfs_sfdisk>
3890 command, where partition sizes are specified in megabytes
3891 only (rounded to the nearest cylinder) and you don't need
3892 to specify the cyls, heads and sectors parameters which
3893 were rarely if ever used anyway.
3895 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3896 and C<guestfs_part_disk>");
3898 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3900 "determine file type inside a compressed file",
3902 This command runs C<file> after first decompressing C<path>
3905 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3907 Since 1.0.63, use C<guestfs_file> instead which can now
3908 process compressed files.");
3910 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3912 "list extended attributes of a file or directory",
3914 This call lists the extended attributes of the file or directory
3917 At the system call level, this is a combination of the
3918 L<listxattr(2)> and L<getxattr(2)> calls.
3920 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3922 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3924 "list extended attributes of a file or directory",
3926 This is the same as C<guestfs_getxattrs>, but if C<path>
3927 is a symbolic link, then it returns the extended attributes
3928 of the link itself.");
3930 ("setxattr", (RErr, [String "xattr";
3931 String "val"; Int "vallen"; (* will be BufferIn *)
3932 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3934 "set extended attribute of a file or directory",
3936 This call sets the extended attribute named C<xattr>
3937 of the file C<path> to the value C<val> (of length C<vallen>).
3938 The value is arbitrary 8 bit data.
3940 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3942 ("lsetxattr", (RErr, [String "xattr";
3943 String "val"; Int "vallen"; (* will be BufferIn *)
3944 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3946 "set extended attribute of a file or directory",
3948 This is the same as C<guestfs_setxattr>, but if C<path>
3949 is a symbolic link, then it sets an extended attribute
3950 of the link itself.");
3952 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3954 "remove extended attribute of a file or directory",
3956 This call removes the extended attribute named C<xattr>
3957 of the file C<path>.
3959 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3961 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3963 "remove extended attribute of a file or directory",
3965 This is the same as C<guestfs_removexattr>, but if C<path>
3966 is a symbolic link, then it removes an extended attribute
3967 of the link itself.");
3969 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3973 This call is similar to C<guestfs_mounts>. That call returns
3974 a list of devices. This one returns a hash table (map) of
3975 device name to directory where the device is mounted.");
3977 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3978 (* This is a special case: while you would expect a parameter
3979 * of type "Pathname", that doesn't work, because it implies
3980 * NEED_ROOT in the generated calling code in stubs.c, and
3981 * this function cannot use NEED_ROOT.
3984 "create a mountpoint",
3986 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3987 specialized calls that can be used to create extra mountpoints
3988 before mounting the first filesystem.
3990 These calls are I<only> necessary in some very limited circumstances,
3991 mainly the case where you want to mount a mix of unrelated and/or
3992 read-only filesystems together.
3994 For example, live CDs often contain a \"Russian doll\" nest of
3995 filesystems, an ISO outer layer, with a squashfs image inside, with
3996 an ext2/3 image inside that. You can unpack this as follows
3999 add-ro Fedora-11-i686-Live.iso
4003 mkmountpoint /ext3fs
4005 mount-loop /cd/LiveOS/squashfs.img /sqsh
4006 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4008 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4010 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4011 You may get unexpected errors if you try to mix these calls. It is
4012 safest to manually unmount filesystems and remove mountpoints after use.
4014 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4015 longest first, so for this to work for manual mountpoints, you
4016 must ensure that the innermost mountpoints have the longest
4017 pathnames, as in the example code above.
4019 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4021 Autosync [see C<guestfs_set_autosync>, this is set by default on
4022 handles] can cause C<guestfs_umount_all> to be called when the handle
4023 is closed which can also trigger these issues.");
4025 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4027 "remove a mountpoint",
4029 This calls removes a mountpoint that was previously created
4030 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4031 for full details.");
4033 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4034 [InitISOFS, Always, TestOutputBuffer (
4035 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4036 (* Test various near large, large and too large files (RHBZ#589039). *)
4037 InitScratchFS, Always, TestLastFail (
4038 [["touch"; "/read_file"];
4039 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4040 ["read_file"; "/read_file"]]);
4041 InitScratchFS, Always, TestLastFail (
4042 [["touch"; "/read_file2"];
4043 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4044 ["read_file"; "/read_file2"]]);
4045 InitScratchFS, Always, TestLastFail (
4046 [["touch"; "/read_file3"];
4047 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4048 ["read_file"; "/read_file3"]])],
4051 This calls returns the contents of the file C<path> as a
4054 Unlike C<guestfs_cat>, this function can correctly
4055 handle files that contain embedded ASCII NUL characters.
4056 However unlike C<guestfs_download>, this function is limited
4057 in the total size of file that can be handled.");
4059 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4060 [InitISOFS, Always, TestOutputList (
4061 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4062 InitISOFS, Always, TestOutputList (
4063 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4064 (* Test for RHBZ#579608, absolute symbolic links. *)
4065 InitISOFS, Always, TestOutputList (
4066 [["grep"; "nomatch"; "/abssymlink"]], [])],
4067 "return lines matching a pattern",
4069 This calls the external C<grep> program and returns the
4072 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4073 [InitISOFS, Always, TestOutputList (
4074 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4075 "return lines matching a pattern",
4077 This calls the external C<egrep> program and returns the
4080 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4081 [InitISOFS, Always, TestOutputList (
4082 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4083 "return lines matching a pattern",
4085 This calls the external C<fgrep> program and returns the
4088 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4089 [InitISOFS, Always, TestOutputList (
4090 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4091 "return lines matching a pattern",
4093 This calls the external C<grep -i> program and returns the
4096 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4097 [InitISOFS, Always, TestOutputList (
4098 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4099 "return lines matching a pattern",
4101 This calls the external C<egrep -i> program and returns the
4104 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4105 [InitISOFS, Always, TestOutputList (
4106 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4107 "return lines matching a pattern",
4109 This calls the external C<fgrep -i> program and returns the
4112 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4113 [InitISOFS, Always, TestOutputList (
4114 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4115 "return lines matching a pattern",
4117 This calls the external C<zgrep> program and returns the
4120 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4121 [InitISOFS, Always, TestOutputList (
4122 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4123 "return lines matching a pattern",
4125 This calls the external C<zegrep> program and returns the
4128 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4129 [InitISOFS, Always, TestOutputList (
4130 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4131 "return lines matching a pattern",
4133 This calls the external C<zfgrep> program and returns the
4136 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4137 [InitISOFS, Always, TestOutputList (
4138 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4139 "return lines matching a pattern",
4141 This calls the external C<zgrep -i> program and returns the
4144 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4145 [InitISOFS, Always, TestOutputList (
4146 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4147 "return lines matching a pattern",
4149 This calls the external C<zegrep -i> program and returns the
4152 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4153 [InitISOFS, Always, TestOutputList (
4154 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4155 "return lines matching a pattern",
4157 This calls the external C<zfgrep -i> program and returns the
4160 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4161 [InitISOFS, Always, TestOutput (
4162 [["realpath"; "/../directory"]], "/directory")],
4163 "canonicalized absolute pathname",
4165 Return the canonicalized absolute pathname of C<path>. The
4166 returned path has no C<.>, C<..> or symbolic link path elements.");
4168 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4169 [InitScratchFS, Always, TestOutputStruct (
4172 ["ln"; "/ln/a"; "/ln/b"];
4173 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4174 "create a hard link",
4176 This command creates a hard link using the C<ln> command.");
4178 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4179 [InitScratchFS, Always, TestOutputStruct (
4180 [["mkdir"; "/ln_f"];
4181 ["touch"; "/ln_f/a"];
4182 ["touch"; "/ln_f/b"];
4183 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4184 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4185 "create a hard link",
4187 This command creates a hard link using the C<ln -f> command.
4188 The I<-f> option removes the link (C<linkname>) if it exists already.");
4190 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4191 [InitScratchFS, Always, TestOutputStruct (
4192 [["mkdir"; "/ln_s"];
4193 ["touch"; "/ln_s/a"];
4194 ["ln_s"; "a"; "/ln_s/b"];
4195 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4196 "create a symbolic link",
4198 This command creates a symbolic link using the C<ln -s> command.");
4200 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4201 [InitScratchFS, Always, TestOutput (
4202 [["mkdir_p"; "/ln_sf/b"];
4203 ["touch"; "/ln_sf/b/c"];
4204 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4205 ["readlink"; "/ln_sf/b/c"]], "../d")],
4206 "create a symbolic link",
4208 This command creates a symbolic link using the C<ln -sf> command,
4209 The I<-f> option removes the link (C<linkname>) if it exists already.");
4211 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4212 [] (* XXX tested above *),
4213 "read the target of a symbolic link",
4215 This command reads the target of a symbolic link.");
4217 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4218 [InitScratchFS, Always, TestOutputStruct (
4219 [["fallocate"; "/fallocate"; "1000000"];
4220 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4221 "preallocate a file in the guest filesystem",
4223 This command preallocates a file (containing zero bytes) named
4224 C<path> of size C<len> bytes. If the file exists already, it
4227 Do not confuse this with the guestfish-specific
4228 C<alloc> command which allocates a file in the host and
4229 attaches it as a device.");
4231 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4232 [InitPartition, Always, TestRun (
4233 [["mkswap"; "/dev/sda1"];
4234 ["swapon_device"; "/dev/sda1"];
4235 ["swapoff_device"; "/dev/sda1"]])],
4236 "enable swap on device",
4238 This command enables the libguestfs appliance to use the
4239 swap device or partition named C<device>. The increased
4240 memory is made available for all commands, for example
4241 those run using C<guestfs_command> or C<guestfs_sh>.
4243 Note that you should not swap to existing guest swap
4244 partitions unless you know what you are doing. They may
4245 contain hibernation information, or other information that
4246 the guest doesn't want you to trash. You also risk leaking
4247 information about the host to the guest this way. Instead,
4248 attach a new host device to the guest and swap on that.");
4250 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4251 [], (* XXX tested by swapon_device *)
4252 "disable swap on device",
4254 This command disables the libguestfs appliance swap
4255 device or partition named C<device>.
4256 See C<guestfs_swapon_device>.");
4258 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4259 [InitScratchFS, Always, TestRun (
4260 [["fallocate"; "/swapon_file"; "8388608"];
4261 ["mkswap_file"; "/swapon_file"];
4262 ["swapon_file"; "/swapon_file"];
4263 ["swapoff_file"; "/swapon_file"];
4264 ["rm"; "/swapon_file"]])],
4265 "enable swap on file",
4267 This command enables swap to a file.
4268 See C<guestfs_swapon_device> for other notes.");
4270 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4271 [], (* XXX tested by swapon_file *)
4272 "disable swap on file",
4274 This command disables the libguestfs appliance swap on file.");
4276 ("swapon_label", (RErr, [String "label"], []), 174, [],
4277 [InitEmpty, Always, TestRun (
4278 [["part_disk"; "/dev/sda"; "mbr"];
4279 ["mkswap_L"; "swapit"; "/dev/sda1"];
4280 ["swapon_label"; "swapit"];
4281 ["swapoff_label"; "swapit"];
4282 ["zero"; "/dev/sda"];
4283 ["blockdev_rereadpt"; "/dev/sda"]])],
4284 "enable swap on labeled swap partition",
4286 This command enables swap to a labeled swap partition.
4287 See C<guestfs_swapon_device> for other notes.");
4289 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4290 [], (* XXX tested by swapon_label *)
4291 "disable swap on labeled swap partition",
4293 This command disables the libguestfs appliance swap on
4294 labeled swap partition.");
4296 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4297 (let uuid = uuidgen () in
4298 [InitEmpty, Always, TestRun (
4299 [["mkswap_U"; uuid; "/dev/sdc"];
4300 ["swapon_uuid"; uuid];
4301 ["swapoff_uuid"; uuid]])]),
4302 "enable swap on swap partition by UUID",
4304 This command enables swap to a swap partition with the given UUID.
4305 See C<guestfs_swapon_device> for other notes.");
4307 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4308 [], (* XXX tested by swapon_uuid *)
4309 "disable swap on swap partition by UUID",
4311 This command disables the libguestfs appliance swap partition
4312 with the given UUID.");
4314 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4315 [InitScratchFS, Always, TestRun (
4316 [["fallocate"; "/mkswap_file"; "8388608"];
4317 ["mkswap_file"; "/mkswap_file"];
4318 ["rm"; "/mkswap_file"]])],
4319 "create a swap file",
4323 This command just writes a swap file signature to an existing
4324 file. To create the file itself, use something like C<guestfs_fallocate>.");
4326 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4327 [InitISOFS, Always, TestRun (
4328 [["inotify_init"; "0"]])],
4329 "create an inotify handle",
4331 This command creates a new inotify handle.
4332 The inotify subsystem can be used to notify events which happen to
4333 objects in the guest filesystem.
4335 C<maxevents> is the maximum number of events which will be
4336 queued up between calls to C<guestfs_inotify_read> or
4337 C<guestfs_inotify_files>.
4338 If this is passed as C<0>, then the kernel (or previously set)
4339 default is used. For Linux 2.6.29 the default was 16384 events.
4340 Beyond this limit, the kernel throws away events, but records
4341 the fact that it threw them away by setting a flag
4342 C<IN_Q_OVERFLOW> in the returned structure list (see
4343 C<guestfs_inotify_read>).
4345 Before any events are generated, you have to add some
4346 watches to the internal watch list. See:
4347 C<guestfs_inotify_add_watch>,
4348 C<guestfs_inotify_rm_watch> and
4349 C<guestfs_inotify_watch_all>.
4351 Queued up events should be read periodically by calling
4352 C<guestfs_inotify_read>
4353 (or C<guestfs_inotify_files> which is just a helpful
4354 wrapper around C<guestfs_inotify_read>). If you don't
4355 read the events out often enough then you risk the internal
4358 The handle should be closed after use by calling
4359 C<guestfs_inotify_close>. This also removes any
4360 watches automatically.
4362 See also L<inotify(7)> for an overview of the inotify interface
4363 as exposed by the Linux kernel, which is roughly what we expose
4364 via libguestfs. Note that there is one global inotify handle
4365 per libguestfs instance.");
4367 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4368 [InitScratchFS, Always, TestOutputList (
4369 [["mkdir"; "/inotify_add_watch"];
4370 ["inotify_init"; "0"];
4371 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4372 ["touch"; "/inotify_add_watch/a"];
4373 ["touch"; "/inotify_add_watch/b"];
4374 ["inotify_files"]], ["a"; "b"])],
4375 "add an inotify watch",
4377 Watch C<path> for the events listed in C<mask>.
4379 Note that if C<path> is a directory then events within that
4380 directory are watched, but this does I<not> happen recursively
4381 (in subdirectories).
4383 Note for non-C or non-Linux callers: the inotify events are
4384 defined by the Linux kernel ABI and are listed in
4385 C</usr/include/sys/inotify.h>.");
4387 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4389 "remove an inotify watch",
4391 Remove a previously defined inotify watch.
4392 See C<guestfs_inotify_add_watch>.");
4394 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4396 "return list of inotify events",
4398 Return the complete queue of events that have happened
4399 since the previous read call.
4401 If no events have happened, this returns an empty list.
4403 I<Note>: In order to make sure that all events have been
4404 read, you must call this function repeatedly until it
4405 returns an empty list. The reason is that the call will
4406 read events up to the maximum appliance-to-host message
4407 size and leave remaining events in the queue.");
4409 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4411 "return list of watched files that had events",
4413 This function is a helpful wrapper around C<guestfs_inotify_read>
4414 which just returns a list of pathnames of objects that were
4415 touched. The returned pathnames are sorted and deduplicated.");
4417 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4419 "close the inotify handle",
4421 This closes the inotify handle which was previously
4422 opened by inotify_init. It removes all watches, throws
4423 away any pending events, and deallocates all resources.");
4425 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4427 "set SELinux security context",
4429 This sets the SELinux security context of the daemon
4430 to the string C<context>.
4432 See the documentation about SELINUX in L<guestfs(3)>.");
4434 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4436 "get SELinux security context",
4438 This gets the SELinux security context of the daemon.
4440 See the documentation about SELINUX in L<guestfs(3)>,
4441 and C<guestfs_setcon>");
4443 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4444 [InitEmpty, Always, TestOutput (
4445 [["part_disk"; "/dev/sda"; "mbr"];
4446 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4447 ["mount_options"; ""; "/dev/sda1"; "/"];
4448 ["write"; "/new"; "new file contents"];
4449 ["cat"; "/new"]], "new file contents");
4450 InitEmpty, Always, TestRun (
4451 [["part_disk"; "/dev/sda"; "mbr"];
4452 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4453 InitEmpty, Always, TestLastFail (
4454 [["part_disk"; "/dev/sda"; "mbr"];
4455 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4456 InitEmpty, Always, TestLastFail (
4457 [["part_disk"; "/dev/sda"; "mbr"];
4458 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4459 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4460 [["part_disk"; "/dev/sda"; "mbr"];
4461 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4462 "make a filesystem with block size",
4464 This call is similar to C<guestfs_mkfs>, but it allows you to
4465 control the block size of the resulting filesystem. Supported
4466 block sizes depend on the filesystem type, but typically they
4467 are C<1024>, C<2048> or C<4096> only.
4469 For VFAT and NTFS the C<blocksize> parameter is treated as
4470 the requested cluster size.");
4472 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4473 [InitEmpty, Always, TestOutput (
4474 [["part_init"; "/dev/sda"; "mbr"];
4475 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4476 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4477 ["mke2journal"; "4096"; "/dev/sda1"];
4478 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4479 ["mount_options"; ""; "/dev/sda2"; "/"];
4480 ["write"; "/new"; "new file contents"];
4481 ["cat"; "/new"]], "new file contents")],
4482 "make ext2/3/4 external journal",
4484 This creates an ext2 external journal on C<device>. It is equivalent
4487 mke2fs -O journal_dev -b blocksize device");
4489 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4490 [InitEmpty, Always, TestOutput (
4491 [["part_init"; "/dev/sda"; "mbr"];
4492 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4493 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4494 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4495 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4496 ["mount_options"; ""; "/dev/sda2"; "/"];
4497 ["write"; "/new"; "new file contents"];
4498 ["cat"; "/new"]], "new file contents")],
4499 "make ext2/3/4 external journal with label",
4501 This creates an ext2 external journal on C<device> with label C<label>.");
4503 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4504 (let uuid = uuidgen () in
4505 [InitEmpty, Always, TestOutput (
4506 [["part_init"; "/dev/sda"; "mbr"];
4507 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4508 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4509 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4510 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4511 ["mount_options"; ""; "/dev/sda2"; "/"];
4512 ["write"; "/new"; "new file contents"];
4513 ["cat"; "/new"]], "new file contents")]),
4514 "make ext2/3/4 external journal with UUID",
4516 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4518 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4520 "make ext2/3/4 filesystem with external journal",
4522 This creates an ext2/3/4 filesystem on C<device> with
4523 an external journal on C<journal>. It is equivalent
4526 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4528 See also C<guestfs_mke2journal>.");
4530 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4532 "make ext2/3/4 filesystem with external journal",
4534 This creates an ext2/3/4 filesystem on C<device> with
4535 an external journal on the journal labeled C<label>.
4537 See also C<guestfs_mke2journal_L>.");
4539 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4541 "make ext2/3/4 filesystem with external journal",
4543 This creates an ext2/3/4 filesystem on C<device> with
4544 an external journal on the journal with UUID C<uuid>.
4546 See also C<guestfs_mke2journal_U>.");
4548 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4549 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4550 "load a kernel module",
4552 This loads a kernel module in the appliance.
4554 The kernel module must have been whitelisted when libguestfs
4555 was built (see C<appliance/kmod.whitelist.in> in the source).");
4557 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4558 [InitNone, Always, TestOutput (
4559 [["echo_daemon"; "This is a test"]], "This is a test"
4561 "echo arguments back to the client",
4563 This command concatenates the list of C<words> passed with single spaces
4564 between them and returns the resulting string.
4566 You can use this command to test the connection through to the daemon.
4568 See also C<guestfs_ping_daemon>.");
4570 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4571 [], (* There is a regression test for this. *)
4572 "find all files and directories, returning NUL-separated list",
4574 This command lists out all files and directories, recursively,
4575 starting at C<directory>, placing the resulting list in the
4576 external file called C<files>.
4578 This command works the same way as C<guestfs_find> with the
4579 following exceptions:
4585 The resulting list is written to an external file.
4589 Items (filenames) in the result are separated
4590 by C<\\0> characters. See L<find(1)> option I<-print0>.
4594 This command is not limited in the number of names that it
4599 The result list is not sorted.
4603 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4604 [InitISOFS, Always, TestOutput (
4605 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4606 InitISOFS, Always, TestOutput (
4607 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4608 InitISOFS, Always, TestOutput (
4609 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4610 InitISOFS, Always, TestLastFail (
4611 [["case_sensitive_path"; "/Known-1/"]]);
4612 InitScratchFS, Always, TestOutput (
4613 [["mkdir"; "/case_sensitive_path"];
4614 ["mkdir"; "/case_sensitive_path/bbb"];
4615 ["touch"; "/case_sensitive_path/bbb/c"];
4616 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4617 InitScratchFS, Always, TestOutput (
4618 [["mkdir"; "/case_sensitive_path2"];
4619 ["mkdir"; "/case_sensitive_path2/bbb"];
4620 ["touch"; "/case_sensitive_path2/bbb/c"];
4621 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4622 InitScratchFS, Always, TestLastFail (
4623 [["mkdir"; "/case_sensitive_path3"];
4624 ["mkdir"; "/case_sensitive_path3/bbb"];
4625 ["touch"; "/case_sensitive_path3/bbb/c"];
4626 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4627 "return true path on case-insensitive filesystem",
4629 This can be used to resolve case insensitive paths on
4630 a filesystem which is case sensitive. The use case is
4631 to resolve paths which you have read from Windows configuration
4632 files or the Windows Registry, to the true path.
4634 The command handles a peculiarity of the Linux ntfs-3g
4635 filesystem driver (and probably others), which is that although
4636 the underlying filesystem is case-insensitive, the driver
4637 exports the filesystem to Linux as case-sensitive.
4639 One consequence of this is that special directories such
4640 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4641 (or other things) depending on the precise details of how
4642 they were created. In Windows itself this would not be
4645 Bug or feature? You decide:
4646 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4648 This function resolves the true case of each element in the
4649 path and returns the case-sensitive path.
4651 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4652 might return C<\"/WINDOWS/system32\"> (the exact return value
4653 would depend on details of how the directories were originally
4654 created under Windows).
4657 This function does not handle drive names, backslashes etc.
4659 See also C<guestfs_realpath>.");
4661 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4662 [InitScratchFS, Always, TestOutput (
4663 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4664 "get the Linux VFS type corresponding to a mounted device",
4666 This command gets the filesystem type corresponding to
4667 the filesystem on C<device>.
4669 For most filesystems, the result is the name of the Linux
4670 VFS module which would be used to mount this filesystem
4671 if you mounted it without specifying the filesystem type.
4672 For example a string such as C<ext3> or C<ntfs>.");
4674 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4675 [InitScratchFS, Always, TestOutputStruct (
4676 [["write"; "/truncate"; "some stuff so size is not zero"];
4677 ["truncate"; "/truncate"];
4678 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4679 "truncate a file to zero size",
4681 This command truncates C<path> to a zero-length file. The
4682 file must exist already.");
4684 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4685 [InitScratchFS, Always, TestOutputStruct (
4686 [["touch"; "/truncate_size"];
4687 ["truncate_size"; "/truncate_size"; "1000"];
4688 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4689 "truncate a file to a particular size",
4691 This command truncates C<path> to size C<size> bytes. The file
4694 If the current file size is less than C<size> then
4695 the file is extended to the required size with zero bytes.
4696 This creates a sparse file (ie. disk blocks are not allocated
4697 for the file until you write to it). To create a non-sparse
4698 file of zeroes, use C<guestfs_fallocate64> instead.");
4700 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4701 [InitScratchFS, Always, TestOutputStruct (
4702 [["touch"; "/utimens"];
4703 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4704 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4705 "set timestamp of a file with nanosecond precision",
4707 This command sets the timestamps of a file with nanosecond
4710 C<atsecs, atnsecs> are the last access time (atime) in secs and
4711 nanoseconds from the epoch.
4713 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4714 secs and nanoseconds from the epoch.
4716 If the C<*nsecs> field contains the special value C<-1> then
4717 the corresponding timestamp is set to the current time. (The
4718 C<*secs> field is ignored in this case).
4720 If the C<*nsecs> field contains the special value C<-2> then
4721 the corresponding timestamp is left unchanged. (The
4722 C<*secs> field is ignored in this case).");
4724 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4725 [InitScratchFS, Always, TestOutputStruct (
4726 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4727 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4728 "create a directory with a particular mode",
4730 This command creates a directory, setting the initial permissions
4731 of the directory to C<mode>.
4733 For common Linux filesystems, the actual mode which is set will
4734 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4735 interpret the mode in other ways.
4737 See also C<guestfs_mkdir>, C<guestfs_umask>");
4739 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4741 "change file owner and group",
4743 Change the file owner to C<owner> and group to C<group>.
4744 This is like C<guestfs_chown> but if C<path> is a symlink then
4745 the link itself is changed, not the target.
4747 Only numeric uid and gid are supported. If you want to use
4748 names, you will need to locate and parse the password file
4749 yourself (Augeas support makes this relatively easy).");
4751 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4753 "lstat on multiple files",
4755 This call allows you to perform the C<guestfs_lstat> operation
4756 on multiple files, where all files are in the directory C<path>.
4757 C<names> is the list of files from this directory.
4759 On return you get a list of stat structs, with a one-to-one
4760 correspondence to the C<names> list. If any name did not exist
4761 or could not be lstat'd, then the C<ino> field of that structure
4764 This call is intended for programs that want to efficiently
4765 list a directory contents without making many round-trips.
4766 See also C<guestfs_lxattrlist> for a similarly efficient call
4767 for getting extended attributes. Very long directory listings
4768 might cause the protocol message size to be exceeded, causing
4769 this call to fail. The caller must split up such requests
4770 into smaller groups of names.");
4772 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4774 "lgetxattr on multiple files",
4776 This call allows you to get the extended attributes
4777 of multiple files, where all files are in the directory C<path>.
4778 C<names> is the list of files from this directory.
4780 On return you get a flat list of xattr structs which must be
4781 interpreted sequentially. The first xattr struct always has a zero-length
4782 C<attrname>. C<attrval> in this struct is zero-length
4783 to indicate there was an error doing C<lgetxattr> for this
4784 file, I<or> is a C string which is a decimal number
4785 (the number of following attributes for this file, which could
4786 be C<\"0\">). Then after the first xattr struct are the
4787 zero or more attributes for the first named file.
4788 This repeats for the second and subsequent files.
4790 This call is intended for programs that want to efficiently
4791 list a directory contents without making many round-trips.
4792 See also C<guestfs_lstatlist> for a similarly efficient call
4793 for getting standard stats. Very long directory listings
4794 might cause the protocol message size to be exceeded, causing
4795 this call to fail. The caller must split up such requests
4796 into smaller groups of names.");
4798 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4800 "readlink on multiple files",
4802 This call allows you to do a C<readlink> operation
4803 on multiple files, where all files are in the directory C<path>.
4804 C<names> is the list of files from this directory.
4806 On return you get a list of strings, with a one-to-one
4807 correspondence to the C<names> list. Each string is the
4808 value of the symbolic link.
4810 If the C<readlink(2)> operation fails on any name, then
4811 the corresponding result string is the empty string C<\"\">.
4812 However the whole operation is completed even if there
4813 were C<readlink(2)> errors, and so you can call this
4814 function with names where you don't know if they are
4815 symbolic links already (albeit slightly less efficient).
4817 This call is intended for programs that want to efficiently
4818 list a directory contents without making many round-trips.
4819 Very long directory listings might cause the protocol
4820 message size to be exceeded, causing
4821 this call to fail. The caller must split up such requests
4822 into smaller groups of names.");
4824 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4825 [InitISOFS, Always, TestOutputBuffer (
4826 [["pread"; "/known-4"; "1"; "3"]], "\n");
4827 InitISOFS, Always, TestOutputBuffer (
4828 [["pread"; "/empty"; "0"; "100"]], "")],
4829 "read part of a file",
4831 This command lets you read part of a file. It reads C<count>
4832 bytes of the file, starting at C<offset>, from file C<path>.
4834 This may read fewer bytes than requested. For further details
4835 see the L<pread(2)> system call.
4837 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4839 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4840 [InitEmpty, Always, TestRun (
4841 [["part_init"; "/dev/sda"; "gpt"]])],
4842 "create an empty partition table",
4844 This creates an empty partition table on C<device> of one of the
4845 partition types listed below. Usually C<parttype> should be
4846 either C<msdos> or C<gpt> (for large disks).
4848 Initially there are no partitions. Following this, you should
4849 call C<guestfs_part_add> for each partition required.
4851 Possible values for C<parttype> are:
4859 Intel EFI / GPT partition table.
4861 This is recommended for >= 2 TB partitions that will be accessed
4862 from Linux and Intel-based Mac OS X. It also has limited backwards
4863 compatibility with the C<mbr> format.
4869 The standard PC \"Master Boot Record\" (MBR) format used
4870 by MS-DOS and Windows. This partition type will B<only> work
4871 for device sizes up to 2 TB. For large disks we recommend
4876 Other partition table types that may work but are not
4889 Amiga \"Rigid Disk Block\" format.
4897 DASD, used on IBM mainframes.
4905 Old Mac partition format. Modern Macs use C<gpt>.
4909 NEC PC-98 format, common in Japan apparently.
4917 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4918 [InitEmpty, Always, TestRun (
4919 [["part_init"; "/dev/sda"; "mbr"];
4920 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4921 InitEmpty, Always, TestRun (
4922 [["part_init"; "/dev/sda"; "gpt"];
4923 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4924 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4925 InitEmpty, Always, TestRun (
4926 [["part_init"; "/dev/sda"; "mbr"];
4927 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4928 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4929 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4930 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4931 "add a partition to the device",
4933 This command adds a partition to C<device>. If there is no partition
4934 table on the device, call C<guestfs_part_init> first.
4936 The C<prlogex> parameter is the type of partition. Normally you
4937 should pass C<p> or C<primary> here, but MBR partition tables also
4938 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4941 C<startsect> and C<endsect> are the start and end of the partition
4942 in I<sectors>. C<endsect> may be negative, which means it counts
4943 backwards from the end of the disk (C<-1> is the last sector).
4945 Creating a partition which covers the whole disk is not so easy.
4946 Use C<guestfs_part_disk> to do that.");
4948 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4949 [InitEmpty, Always, TestRun (
4950 [["part_disk"; "/dev/sda"; "mbr"]]);
4951 InitEmpty, Always, TestRun (
4952 [["part_disk"; "/dev/sda"; "gpt"]])],
4953 "partition whole disk with a single primary partition",
4955 This command is simply a combination of C<guestfs_part_init>
4956 followed by C<guestfs_part_add> to create a single primary partition
4957 covering the whole disk.
4959 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4960 but other possible values are described in C<guestfs_part_init>.");
4962 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4963 [InitEmpty, Always, TestRun (
4964 [["part_disk"; "/dev/sda"; "mbr"];
4965 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4966 "make a partition bootable",
4968 This sets the bootable flag on partition numbered C<partnum> on
4969 device C<device>. Note that partitions are numbered from 1.
4971 The bootable flag is used by some operating systems (notably
4972 Windows) to determine which partition to boot from. It is by
4973 no means universally recognized.");
4975 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4976 [InitEmpty, Always, TestRun (
4977 [["part_disk"; "/dev/sda"; "gpt"];
4978 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4979 "set partition name",
4981 This sets the partition name on partition numbered C<partnum> on
4982 device C<device>. Note that partitions are numbered from 1.
4984 The partition name can only be set on certain types of partition
4985 table. This works on C<gpt> but not on C<mbr> partitions.");
4987 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4988 [], (* XXX Add a regression test for this. *)
4989 "list partitions on a device",
4991 This command parses the partition table on C<device> and
4992 returns the list of partitions found.
4994 The fields in the returned structure are:
5000 Partition number, counting from 1.
5004 Start of the partition I<in bytes>. To get sectors you have to
5005 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5009 End of the partition in bytes.
5013 Size of the partition in bytes.
5017 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5018 [InitEmpty, Always, TestOutput (
5019 [["part_disk"; "/dev/sda"; "gpt"];
5020 ["part_get_parttype"; "/dev/sda"]], "gpt")],
5021 "get the partition table type",
5023 This command examines the partition table on C<device> and
5024 returns the partition table type (format) being used.
5026 Common return values include: C<msdos> (a DOS/Windows style MBR
5027 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5028 values are possible, although unusual. See C<guestfs_part_init>
5031 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5032 [InitScratchFS, Always, TestOutputBuffer (
5033 [["fill"; "0x63"; "10"; "/fill"];
5034 ["read_file"; "/fill"]], "cccccccccc")],
5035 "fill a file with octets",
5037 This command creates a new file called C<path>. The initial
5038 content of the file is C<len> octets of C<c>, where C<c>
5039 must be a number in the range C<[0..255]>.
5041 To fill a file with zero bytes (sparsely), it is
5042 much more efficient to use C<guestfs_truncate_size>.
5043 To create a file with a pattern of repeating bytes
5044 use C<guestfs_fill_pattern>.");
5046 ("available", (RErr, [StringList "groups"], []), 216, [],
5047 [InitNone, Always, TestRun [["available"; ""]]],
5048 "test availability of some parts of the API",
5050 This command is used to check the availability of some
5051 groups of functionality in the appliance, which not all builds of
5052 the libguestfs appliance will be able to provide.
5054 The libguestfs groups, and the functions that those
5055 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5056 You can also fetch this list at runtime by calling
5057 C<guestfs_available_all_groups>.
5059 The argument C<groups> is a list of group names, eg:
5060 C<[\"inotify\", \"augeas\"]> would check for the availability of
5061 the Linux inotify functions and Augeas (configuration file
5064 The command returns no error if I<all> requested groups are available.
5066 It fails with an error if one or more of the requested
5067 groups is unavailable in the appliance.
5069 If an unknown group name is included in the
5070 list of groups then an error is always returned.
5078 You must call C<guestfs_launch> before calling this function.
5080 The reason is because we don't know what groups are
5081 supported by the appliance/daemon until it is running and can
5086 If a group of functions is available, this does not necessarily
5087 mean that they will work. You still have to check for errors
5088 when calling individual API functions even if they are
5093 It is usually the job of distro packagers to build
5094 complete functionality into the libguestfs appliance.
5095 Upstream libguestfs, if built from source with all
5096 requirements satisfied, will support everything.
5100 This call was added in version C<1.0.80>. In previous
5101 versions of libguestfs all you could do would be to speculatively
5102 execute a command to find out if the daemon implemented it.
5103 See also C<guestfs_version>.
5107 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5108 [InitScratchFS, Always, TestOutputBuffer (
5110 ["write"; "/dd/src"; "hello, world"];
5111 ["dd"; "/dd/src"; "/dd/dest"];
5112 ["read_file"; "/dd/dest"]], "hello, world")],
5113 "copy from source to destination using dd",
5115 This command copies from one source device or file C<src>
5116 to another destination device or file C<dest>. Normally you
5117 would use this to copy to or from a device or partition, for
5118 example to duplicate a filesystem.
5120 If the destination is a device, it must be as large or larger
5121 than the source file or device, otherwise the copy will fail.
5122 This command cannot do partial copies (see C<guestfs_copy_size>).");
5124 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5125 [InitScratchFS, Always, TestOutputInt (
5126 [["write"; "/filesize"; "hello, world"];
5127 ["filesize"; "/filesize"]], 12)],
5128 "return the size of the file in bytes",
5130 This command returns the size of C<file> in bytes.
5132 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5133 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5134 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5136 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5137 [InitBasicFSonLVM, Always, TestOutputList (
5138 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5139 ["lvs"]], ["/dev/VG/LV2"])],
5140 "rename an LVM logical volume",
5142 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5144 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5145 [InitBasicFSonLVM, Always, TestOutputList (
5147 ["vg_activate"; "false"; "VG"];
5148 ["vgrename"; "VG"; "VG2"];
5149 ["vg_activate"; "true"; "VG2"];
5150 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5151 ["vgs"]], ["VG2"])],
5152 "rename an LVM volume group",
5154 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5156 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5157 [InitISOFS, Always, TestOutputBuffer (
5158 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5159 "list the contents of a single file in an initrd",
5161 This command unpacks the file C<filename> from the initrd file
5162 called C<initrdpath>. The filename must be given I<without> the
5163 initial C</> character.
5165 For example, in guestfish you could use the following command
5166 to examine the boot script (usually called C</init>)
5167 contained in a Linux initrd or initramfs image:
5169 initrd-cat /boot/initrd-<version>.img init
5171 See also C<guestfs_initrd_list>.");
5173 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5175 "get the UUID of a physical volume",
5177 This command returns the UUID of the LVM PV C<device>.");
5179 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5181 "get the UUID of a volume group",
5183 This command returns the UUID of the LVM VG named C<vgname>.");
5185 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5187 "get the UUID of a logical volume",
5189 This command returns the UUID of the LVM LV C<device>.");
5191 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5193 "get the PV UUIDs containing the volume group",
5195 Given a VG called C<vgname>, this returns the UUIDs of all
5196 the physical volumes that this volume group resides on.
5198 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5199 calls to associate physical volumes and volume groups.
5201 See also C<guestfs_vglvuuids>.");
5203 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5205 "get the LV UUIDs of all LVs in the volume group",
5207 Given a VG called C<vgname>, this returns the UUIDs of all
5208 the logical volumes created in this volume group.
5210 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5211 calls to associate logical volumes and volume groups.
5213 See also C<guestfs_vgpvuuids>.");
5215 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5216 [InitScratchFS, Always, TestOutputBuffer (
5217 [["mkdir"; "/copy_size"];
5218 ["write"; "/copy_size/src"; "hello, world"];
5219 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5220 ["read_file"; "/copy_size/dest"]], "hello")],
5221 "copy size bytes from source to destination using dd",
5223 This command copies exactly C<size> bytes from one source device
5224 or file C<src> to another destination device or file C<dest>.
5226 Note this will fail if the source is too short or if the destination
5227 is not large enough.");
5229 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5230 [InitBasicFSonLVM, Always, TestRun (
5231 [["zero_device"; "/dev/VG/LV"]])],
5232 "write zeroes to an entire device",
5234 This command writes zeroes over the entire C<device>. Compare
5235 with C<guestfs_zero> which just zeroes the first few blocks of
5238 If blocks are already zero, then this command avoids writing
5239 zeroes. This prevents the underlying device from becoming non-sparse
5240 or growing unnecessarily.");
5242 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5243 [InitScratchFS, Always, TestOutput (
5244 [["mkdir"; "/txz_in"];
5245 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5246 ["cat"; "/txz_in/hello"]], "hello\n")],
5247 "unpack compressed tarball to directory",
5249 This command uploads and unpacks local file C<tarball> (an
5250 I<xz compressed> tar file) into C<directory>.");
5252 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5254 "pack directory into compressed tarball",
5256 This command packs the contents of C<directory> and downloads
5257 it to local file C<tarball> (as an xz compressed tar archive).");
5259 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5261 "resize an NTFS filesystem",
5263 This command resizes an NTFS filesystem, expanding or
5264 shrinking it to the size of the underlying device.
5266 I<Note:> After the resize operation, the filesystem is marked
5267 as requiring a consistency check (for safety). You have to boot
5268 into Windows to perform this check and clear this condition.
5269 Furthermore, ntfsresize refuses to resize filesystems
5270 which have been marked in this way. So in effect it is
5271 not possible to call ntfsresize multiple times on a single
5272 filesystem without booting into Windows between each resize.
5274 See also L<ntfsresize(8)>.");
5276 ("vgscan", (RErr, [], []), 232, [],
5277 [InitEmpty, Always, TestRun (
5279 "rescan for LVM physical volumes, volume groups and logical volumes",
5281 This rescans all block devices and rebuilds the list of LVM
5282 physical volumes, volume groups and logical volumes.");
5284 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5285 [InitEmpty, Always, TestRun (
5286 [["part_init"; "/dev/sda"; "mbr"];
5287 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5288 ["part_del"; "/dev/sda"; "1"]])],
5289 "delete a partition",
5291 This command deletes the partition numbered C<partnum> on C<device>.
5293 Note that in the case of MBR partitioning, deleting an
5294 extended partition also deletes any logical partitions
5297 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5298 [InitEmpty, Always, TestOutputTrue (
5299 [["part_init"; "/dev/sda"; "mbr"];
5300 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5301 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5302 ["part_get_bootable"; "/dev/sda"; "1"]])],
5303 "return true if a partition is bootable",
5305 This command returns true if the partition C<partnum> on
5306 C<device> has the bootable flag set.
5308 See also C<guestfs_part_set_bootable>.");
5310 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5311 [InitEmpty, Always, TestOutputInt (
5312 [["part_init"; "/dev/sda"; "mbr"];
5313 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5314 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5315 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5316 "get the MBR type byte (ID byte) from a partition",
5318 Returns the MBR type byte (also known as the ID byte) from
5319 the numbered partition C<partnum>.
5321 Note that only MBR (old DOS-style) partitions have type bytes.
5322 You will get undefined results for other partition table
5323 types (see C<guestfs_part_get_parttype>).");
5325 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5326 [], (* tested by part_get_mbr_id *)
5327 "set the MBR type byte (ID byte) of a partition",
5329 Sets the MBR type byte (also known as the ID byte) of
5330 the numbered partition C<partnum> to C<idbyte>. Note
5331 that the type bytes quoted in most documentation are
5332 in fact hexadecimal numbers, but usually documented
5333 without any leading \"0x\" which might be confusing.
5335 Note that only MBR (old DOS-style) partitions have type bytes.
5336 You will get undefined results for other partition table
5337 types (see C<guestfs_part_get_parttype>).");
5339 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5340 [InitISOFS, Always, TestOutputFileMD5 (
5341 [["checksum_device"; "md5"; "/dev/sdd"]],
5342 "../images/test.iso")],
5343 "compute MD5, SHAx or CRC checksum of the contents of a device",
5345 This call computes the MD5, SHAx or CRC checksum of the
5346 contents of the device named C<device>. For the types of
5347 checksums supported see the C<guestfs_checksum> command.");
5349 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5350 [InitNone, Always, TestRun (
5351 [["part_disk"; "/dev/sda"; "mbr"];
5352 ["pvcreate"; "/dev/sda1"];
5353 ["vgcreate"; "VG"; "/dev/sda1"];
5354 ["lvcreate"; "LV"; "VG"; "10"];
5355 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5356 "expand an LV to fill free space",
5358 This expands an existing logical volume C<lv> so that it fills
5359 C<pc>% of the remaining free space in the volume group. Commonly
5360 you would call this with pc = 100 which expands the logical volume
5361 as much as possible, using all remaining free space in the volume
5364 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5365 [], (* XXX Augeas code needs tests. *)
5366 "clear Augeas path",
5368 Set the value associated with C<path> to C<NULL>. This
5369 is the same as the L<augtool(1)> C<clear> command.");
5371 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5372 [InitEmpty, Always, TestOutputInt (
5373 [["get_umask"]], 0o22)],
5374 "get the current umask",
5376 Return the current umask. By default the umask is C<022>
5377 unless it has been set by calling C<guestfs_umask>.");
5379 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5381 "upload a file to the appliance (internal use only)",
5383 The C<guestfs_debug_upload> command uploads a file to
5384 the libguestfs appliance.
5386 There is no comprehensive help for this command. You have
5387 to look at the file C<daemon/debug.c> in the libguestfs source
5388 to find out what it is for.");
5390 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5391 [InitScratchFS, Always, TestOutput (
5392 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5393 ["cat"; "/base64_in"]], "hello\n")],
5394 "upload base64-encoded data to file",
5396 This command uploads base64-encoded data from C<base64file>
5399 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5401 "download file and encode as base64",
5403 This command downloads the contents of C<filename>, writing
5404 it out to local file C<base64file> encoded as base64.");
5406 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5408 "compute MD5, SHAx or CRC checksum of files in a directory",
5410 This command computes the checksums of all regular files in
5411 C<directory> and then emits a list of those checksums to
5412 the local output file C<sumsfile>.
5414 This can be used for verifying the integrity of a virtual
5415 machine. However to be properly secure you should pay
5416 attention to the output of the checksum command (it uses
5417 the ones from GNU coreutils). In particular when the
5418 filename is not printable, coreutils uses a special
5419 backslash syntax. For more information, see the GNU
5420 coreutils info file.");
5422 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5423 [InitScratchFS, Always, TestOutputBuffer (
5424 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5425 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5426 "fill a file with a repeating pattern of bytes",
5428 This function is like C<guestfs_fill> except that it creates
5429 a new file of length C<len> containing the repeating pattern
5430 of bytes in C<pattern>. The pattern is truncated if necessary
5431 to ensure the length of the file is exactly C<len> bytes.");
5433 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5434 [InitScratchFS, Always, TestOutput (
5435 [["write"; "/write"; "new file contents"];
5436 ["cat"; "/write"]], "new file contents");
5437 InitScratchFS, Always, TestOutput (
5438 [["write"; "/write2"; "\nnew file contents\n"];
5439 ["cat"; "/write2"]], "\nnew file contents\n");
5440 InitScratchFS, Always, TestOutput (
5441 [["write"; "/write3"; "\n\n"];
5442 ["cat"; "/write3"]], "\n\n");
5443 InitScratchFS, Always, TestOutput (
5444 [["write"; "/write4"; ""];
5445 ["cat"; "/write4"]], "");
5446 InitScratchFS, Always, TestOutput (
5447 [["write"; "/write5"; "\n\n\n"];
5448 ["cat"; "/write5"]], "\n\n\n");
5449 InitScratchFS, Always, TestOutput (
5450 [["write"; "/write6"; "\n"];
5451 ["cat"; "/write6"]], "\n")],
5452 "create a new file",
5454 This call creates a file called C<path>. The content of the
5455 file is the string C<content> (which can contain any 8 bit data).
5457 See also C<guestfs_write_append>.");
5459 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5460 [InitScratchFS, Always, TestOutput (
5461 [["write"; "/pwrite"; "new file contents"];
5462 ["pwrite"; "/pwrite"; "data"; "4"];
5463 ["cat"; "/pwrite"]], "new data contents");
5464 InitScratchFS, Always, TestOutput (
5465 [["write"; "/pwrite2"; "new file contents"];
5466 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5467 ["cat"; "/pwrite2"]], "new file is extended");
5468 InitScratchFS, Always, TestOutput (
5469 [["write"; "/pwrite3"; "new file contents"];
5470 ["pwrite"; "/pwrite3"; ""; "4"];
5471 ["cat"; "/pwrite3"]], "new file contents")],
5472 "write to part of a file",
5474 This command writes to part of a file. It writes the data
5475 buffer C<content> to the file C<path> starting at offset C<offset>.
5477 This command implements the L<pwrite(2)> system call, and like
5478 that system call it may not write the full data requested. The
5479 return value is the number of bytes that were actually written
5480 to the file. This could even be 0, although short writes are
5481 unlikely for regular files in ordinary circumstances.
5483 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5485 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5487 "resize an ext2, ext3 or ext4 filesystem (with size)",
5489 This command is the same as C<guestfs_resize2fs> except that it
5490 allows you to specify the new size (in bytes) explicitly.");
5492 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5494 "resize an LVM physical volume (with size)",
5496 This command is the same as C<guestfs_pvresize> except that it
5497 allows you to specify the new size (in bytes) explicitly.");
5499 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5501 "resize an NTFS filesystem (with size)",
5503 This command is the same as C<guestfs_ntfsresize> except that it
5504 allows you to specify the new size (in bytes) explicitly.");
5506 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5507 [InitNone, Always, TestRun [["available_all_groups"]]],
5508 "return a list of all optional groups",
5510 This command returns a list of all optional groups that this
5511 daemon knows about. Note this returns both supported and unsupported
5512 groups. To find out which ones the daemon can actually support
5513 you have to call C<guestfs_available> on each member of the
5516 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5518 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5519 [InitScratchFS, Always, TestOutputStruct (
5520 [["fallocate64"; "/fallocate64"; "1000000"];
5521 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5522 "preallocate a file in the guest filesystem",
5524 This command preallocates a file (containing zero bytes) named
5525 C<path> of size C<len> bytes. If the file exists already, it
5528 Note that this call allocates disk blocks for the file.
5529 To create a sparse file use C<guestfs_truncate_size> instead.
5531 The deprecated call C<guestfs_fallocate> does the same,
5532 but owing to an oversight it only allowed 30 bit lengths
5533 to be specified, effectively limiting the maximum size
5534 of files created through that call to 1GB.
5536 Do not confuse this with the guestfish-specific
5537 C<alloc> and C<sparse> commands which create
5538 a file in the host and attach it as a device.");
5540 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5541 [InitBasicFS, Always, TestOutput (
5542 [["set_e2label"; "/dev/sda1"; "LTEST"];
5543 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5544 "get the filesystem label",
5546 This returns the filesystem label of the filesystem on
5549 If the filesystem is unlabeled, this returns the empty string.
5551 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5553 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5554 (let uuid = uuidgen () in
5555 [InitBasicFS, Always, TestOutput (
5556 [["set_e2uuid"; "/dev/sda1"; uuid];
5557 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5558 "get the filesystem UUID",
5560 This returns the filesystem UUID of the filesystem on
5563 If the filesystem does not have a UUID, this returns the empty string.
5565 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5567 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5568 (* Can't be tested with the current framework because
5569 * the VG is being used by the mounted filesystem, so
5570 * the vgchange -an command we do first will fail.
5573 "set LVM device filter",
5575 This sets the LVM device filter so that LVM will only be
5576 able to \"see\" the block devices in the list C<devices>,
5577 and will ignore all other attached block devices.
5579 Where disk image(s) contain duplicate PVs or VGs, this
5580 command is useful to get LVM to ignore the duplicates, otherwise
5581 LVM can get confused. Note also there are two types
5582 of duplication possible: either cloned PVs/VGs which have
5583 identical UUIDs; or VGs that are not cloned but just happen
5584 to have the same name. In normal operation you cannot
5585 create this situation, but you can do it outside LVM, eg.
5586 by cloning disk images or by bit twiddling inside the LVM
5589 This command also clears the LVM cache and performs a volume
5592 You can filter whole block devices or individual partitions.
5594 You cannot use this if any VG is currently in use (eg.
5595 contains a mounted filesystem), even if you are not
5596 filtering out that VG.");
5598 ("lvm_clear_filter", (RErr, [], []), 256, [],
5599 [], (* see note on lvm_set_filter *)
5600 "clear LVM device filter",
5602 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5603 will be able to see every block device.
5605 This command also clears the LVM cache and performs a volume
5608 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5610 "open a LUKS-encrypted block device",
5612 This command opens a block device which has been encrypted
5613 according to the Linux Unified Key Setup (LUKS) standard.
5615 C<device> is the encrypted block device or partition.
5617 The caller must supply one of the keys associated with the
5618 LUKS block device, in the C<key> parameter.
5620 This creates a new block device called C</dev/mapper/mapname>.
5621 Reads and writes to this block device are decrypted from and
5622 encrypted to the underlying C<device> respectively.
5624 If this block device contains LVM volume groups, then
5625 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5626 will make them visible.
5628 Use C<guestfs_list_dm_devices> to list all device mapper
5631 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5633 "open a LUKS-encrypted block device read-only",
5635 This is the same as C<guestfs_luks_open> except that a read-only
5636 mapping is created.");
5638 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5640 "close a LUKS device",
5642 This closes a LUKS device that was created earlier by
5643 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5644 C<device> parameter must be the name of the LUKS mapping
5645 device (ie. C</dev/mapper/mapname>) and I<not> the name
5646 of the underlying block device.");
5648 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5650 "format a block device as a LUKS encrypted device",
5652 This command erases existing data on C<device> and formats
5653 the device as a LUKS encrypted device. C<key> is the
5654 initial key, which is added to key slot C<slot>. (LUKS
5655 supports 8 key slots, numbered 0-7).");
5657 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5659 "format a block device as a LUKS encrypted device",
5661 This command is the same as C<guestfs_luks_format> but
5662 it also allows you to set the C<cipher> used.");
5664 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5666 "add a key on a LUKS encrypted device",
5668 This command adds a new key on LUKS device C<device>.
5669 C<key> is any existing key, and is used to access the device.
5670 C<newkey> is the new key to add. C<keyslot> is the key slot
5671 that will be replaced.
5673 Note that if C<keyslot> already contains a key, then this
5674 command will fail. You have to use C<guestfs_luks_kill_slot>
5675 first to remove that key.");
5677 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5679 "remove a key from a LUKS encrypted device",
5681 This command deletes the key in key slot C<keyslot> from the
5682 encrypted LUKS device C<device>. C<key> must be one of the
5685 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5686 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5687 [["is_lv"; "/dev/VG/LV"]]);
5688 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5689 [["is_lv"; "/dev/sda1"]])],
5690 "test if device is a logical volume",
5692 This command tests whether C<device> is a logical volume, and
5693 returns true iff this is the case.");
5695 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5697 "find a filesystem by UUID",
5699 This command searches the filesystems and returns the one
5700 which has the given UUID. An error is returned if no such
5701 filesystem can be found.
5703 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5705 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5707 "find a filesystem by label",
5709 This command searches the filesystems and returns the one
5710 which has the given label. An error is returned if no such
5711 filesystem can be found.
5713 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5715 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5716 [InitISOFS, Always, TestOutputFalse (
5717 [["is_chardev"; "/directory"]]);
5718 InitScratchFS, Always, TestOutputTrue (
5719 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5720 ["is_chardev"; "/is_chardev"]])],
5721 "test if character device",
5723 This returns C<true> if and only if there is a character device
5724 with the given C<path> name.
5726 See also C<guestfs_stat>.");
5728 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5729 [InitISOFS, Always, TestOutputFalse (
5730 [["is_blockdev"; "/directory"]]);
5731 InitScratchFS, Always, TestOutputTrue (
5732 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5733 ["is_blockdev"; "/is_blockdev"]])],
5734 "test if block device",
5736 This returns C<true> if and only if there is a block device
5737 with the given C<path> name.
5739 See also C<guestfs_stat>.");
5741 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5742 [InitISOFS, Always, TestOutputFalse (
5743 [["is_fifo"; "/directory"]]);
5744 InitScratchFS, Always, TestOutputTrue (
5745 [["mkfifo"; "0o777"; "/is_fifo"];
5746 ["is_fifo"; "/is_fifo"]])],
5747 "test if FIFO (named pipe)",
5749 This returns C<true> if and only if there is a FIFO (named pipe)
5750 with the given C<path> name.
5752 See also C<guestfs_stat>.");
5754 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5755 [InitISOFS, Always, TestOutputFalse (
5756 [["is_symlink"; "/directory"]]);
5757 InitISOFS, Always, TestOutputTrue (
5758 [["is_symlink"; "/abssymlink"]])],
5759 "test if symbolic link",
5761 This returns C<true> if and only if there is a symbolic link
5762 with the given C<path> name.
5764 See also C<guestfs_stat>.");
5766 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5767 (* XXX Need a positive test for sockets. *)
5768 [InitISOFS, Always, TestOutputFalse (
5769 [["is_socket"; "/directory"]])],
5772 This returns C<true> if and only if there is a Unix domain socket
5773 with the given C<path> name.
5775 See also C<guestfs_stat>.");
5777 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5778 [InitPartition, Always, TestOutputDevice (
5779 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5780 InitEmpty, Always, TestLastFail (
5781 [["part_to_dev"; "/dev/sda"]])],
5782 "convert partition name to device name",
5784 This function takes a partition name (eg. \"/dev/sdb1\") and
5785 removes the partition number, returning the device name
5788 The named partition must exist, for example as a string returned
5789 from C<guestfs_list_partitions>.");
5791 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5792 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5793 [InitScratchFS, Always, TestOutput (
5794 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5795 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5796 "upload a file from the local machine with offset",
5798 Upload local file C<filename> to C<remotefilename> on the
5801 C<remotefilename> is overwritten starting at the byte C<offset>
5802 specified. The intention is to overwrite parts of existing
5803 files or devices, although if a non-existant file is specified
5804 then it is created with a \"hole\" before C<offset>. The
5805 size of the data written is implicit in the size of the
5808 Note that there is no limit on the amount of data that
5809 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5810 and this call always writes the full amount unless an
5813 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5815 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5816 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5817 let offset = string_of_int 100 in
5818 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5819 [InitScratchFS, Always, TestOutput (
5820 (* Pick a file from cwd which isn't likely to change. *)
5821 [["mkdir"; "/download_offset"];
5822 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5823 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5824 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5825 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5826 "download a file to the local machine with offset and size",
5828 Download file C<remotefilename> and save it as C<filename>
5829 on the local machine.
5831 C<remotefilename> is read for C<size> bytes starting at C<offset>
5832 (this region must be within the file or device).
5834 Note that there is no limit on the amount of data that
5835 can be downloaded with this call, unlike with C<guestfs_pread>,
5836 and this call always reads the full amount unless an
5839 See also C<guestfs_download>, C<guestfs_pread>.");
5841 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5842 [InitPartition, Always, TestOutputListOfDevices (
5843 [["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"];
5844 ["blockdev_rereadpt"; "/dev/sda"];
5845 ["list_partitions"]], ["/dev/sdb1"])],
5846 "write to part of a device",
5848 This command writes to part of a device. It writes the data
5849 buffer C<content> to C<device> starting at offset C<offset>.
5851 This command implements the L<pwrite(2)> system call, and like
5852 that system call it may not write the full data requested
5853 (although short writes to disk devices and partitions are
5854 probably impossible with standard Linux kernels).
5856 See also C<guestfs_pwrite>.");
5858 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5859 [InitEmpty, Always, TestOutputBuffer (
5860 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5861 "read part of a device",
5863 This command lets you read part of a file. It reads C<count>
5864 bytes of C<device>, starting at C<offset>.
5866 This may read fewer bytes than requested. For further details
5867 see the L<pread(2)> system call.
5869 See also C<guestfs_pread>.");
5871 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5872 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5873 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5874 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5875 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5876 "get canonical name of an LV",
5878 This converts alternative naming schemes for LVs that you
5879 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5880 is converted to C</dev/VG/LV>.
5882 This command returns an error if the C<lvname> parameter does
5883 not refer to a logical volume.
5885 See also C<guestfs_is_lv>.");
5887 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
5888 [InitEmpty, Always, TestOutput (
5889 [["part_disk"; "/dev/sda"; "mbr"];
5890 ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
5891 ["mount_options"; ""; "/dev/sda1"; "/"];
5892 ["write"; "/new"; "new file contents"];
5893 ["cat"; "/new"]], "new file contents")],
5894 "make a filesystem",
5896 This function creates a filesystem on C<device>. The filesystem
5897 type is C<fstype>, for example C<ext3>.
5899 The optional arguments are:
5905 The filesystem block size. Supported block sizes depend on the
5906 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5907 for Linux ext2/3 filesystems.
5909 For VFAT and NTFS the C<blocksize> parameter is treated as
5910 the requested cluster size.
5912 For UFS block sizes, please see L<mkfs.ufs(8)>.
5916 This passes the I<-O> parameter to the external mkfs program.
5918 For certain filesystem types, this allows extra filesystem
5919 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5922 You cannot use this optional parameter with the C<gfs> or
5923 C<gfs2> filesystem type.
5927 This passes the I<-I> parameter to the external L<mke2fs(8)> program
5928 which sets the inode size (only for ext2/3/4 filesystems at present).
5932 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
5933 which sets sector size for ufs filesystem.
5937 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5939 "get a single extended attribute",
5941 Get a single extended attribute from file C<path> named C<name>.
5942 This call follows symlinks. If you want to lookup an extended
5943 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5945 Normally it is better to get all extended attributes from a file
5946 in one go by calling C<guestfs_getxattrs>. However some Linux
5947 filesystem implementations are buggy and do not provide a way to
5948 list out attributes. For these filesystems (notably ntfs-3g)
5949 you have to know the names of the extended attributes you want
5950 in advance and call this function.
5952 Extended attribute values are blobs of binary data. If there
5953 is no extended attribute named C<name>, this returns an error.
5955 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5957 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5959 "get a single extended attribute",
5961 Get a single extended attribute from file C<path> named C<name>.
5962 If C<path> is a symlink, then this call returns an extended
5963 attribute from the symlink.
5965 Normally it is better to get all extended attributes from a file
5966 in one go by calling C<guestfs_getxattrs>. However some Linux
5967 filesystem implementations are buggy and do not provide a way to
5968 list out attributes. For these filesystems (notably ntfs-3g)
5969 you have to know the names of the extended attributes you want
5970 in advance and call this function.
5972 Extended attribute values are blobs of binary data. If there
5973 is no extended attribute named C<name>, this returns an error.
5975 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5977 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5979 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5981 This command is the same as C<guestfs_resize2fs>, but the filesystem
5982 is resized to its minimum size. This works like the I<-M> option
5983 to the C<resize2fs> command.
5985 To get the resulting size of the filesystem you should call
5986 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5987 values. These two numbers, multiplied together, give the
5988 resulting size of the minimal filesystem in bytes.");
5990 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5992 "internal autosync operation",
5994 This command performs the autosync operation just before the
5995 handle is closed. You should not call this command directly.
5996 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5997 control whether or not this operation is performed when the
5998 handle is closed.");
6000 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6001 [InitISOFS, Always, TestOutputTrue (
6002 [["is_zero"; "/100kallzeroes"]]);
6003 InitISOFS, Always, TestOutputFalse (
6004 [["is_zero"; "/100kallspaces"]])],
6005 "test if a file contains all zero bytes",
6007 This returns true iff the file exists and the file is empty or
6008 it contains all zero bytes.");
6010 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6011 [InitBasicFS, Always, TestOutputTrue (
6012 [["umount"; "/dev/sda1"];
6013 ["zero_device"; "/dev/sda1"];
6014 ["is_zero_device"; "/dev/sda1"]]);
6015 InitBasicFS, Always, TestOutputFalse (
6016 [["is_zero_device"; "/dev/sda1"]])],
6017 "test if a device contains all zero bytes",
6019 This returns true iff the device exists and contains all zero bytes.
6021 Note that for large devices this can take a long time to run.");
6023 ("list_9p", (RStringList "mounttags", [], []), 285, [],
6025 "list 9p filesystems",
6027 List all 9p filesystems attached to the guest. A list of
6028 mount tags is returned.");
6030 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6032 "mount 9p filesystem",
6034 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6035 directory C<mountpoint>.
6037 If required, C<trans=virtio> will be automatically added to the options.
6038 Any other options required can be passed in the optional C<options>
6041 ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6043 "list device mapper devices",
6045 List all device mapper devices.
6047 The returned list contains C</dev/mapper/*> devices, eg. ones created
6048 by a previous call to C<guestfs_luks_open>.
6050 Device mapper devices which correspond to logical volumes are I<not>
6051 returned in this list. Call C<guestfs_lvs> if you want to list logical
6054 ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6056 "resize an NTFS filesystem",
6058 This command resizes an NTFS filesystem, expanding or
6059 shrinking it to the size of the underlying device.
6061 The optional parameters are:
6067 The new size (in bytes) of the filesystem. If omitted, the filesystem
6068 is resized to fit the container (eg. partition).
6072 If this option is true, then force the resize of the filesystem
6073 even if the filesystem is marked as requiring a consistency check.
6075 After the resize operation, the filesystem is always marked
6076 as requiring a consistency check (for safety). You have to boot
6077 into Windows to perform this check and clear this condition.
6078 If you I<don't> set the C<force> option then it is not
6079 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6080 single filesystem without booting into Windows between each resize.
6084 See also L<ntfsresize(8)>.");
6086 ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6088 "resize a btrfs filesystem",
6090 This command resizes a btrfs filesystem.
6092 Note that unlike other resize calls, the filesystem has to be
6093 mounted and the parameter is the mountpoint not the device
6094 (this is a requirement of btrfs itself).
6096 The optional parameters are:
6102 The new size (in bytes) of the filesystem. If omitted, the filesystem
6103 is resized to the maximum size.
6107 See also L<btrfs(8)>.");
6109 ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6110 [InitScratchFS, Always, TestOutput (
6111 [["write"; "/write_append"; "line1\n"];
6112 ["write_append"; "/write_append"; "line2\n"];
6113 ["write_append"; "/write_append"; "line3a"];
6114 ["write_append"; "/write_append"; "line3b\n"];
6115 ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6116 "append content to end of file",
6118 This call appends C<content> to the end of file C<path>. If
6119 C<path> does not exist, then a new file is created.
6121 See also C<guestfs_write>.");
6125 let all_functions = non_daemon_functions @ daemon_functions
6127 (* In some places we want the functions to be displayed sorted
6128 * alphabetically, so this is useful:
6130 let all_functions_sorted = List.sort action_compare all_functions
6132 (* This is used to generate the src/MAX_PROC_NR file which
6133 * contains the maximum procedure number, a surrogate for the
6134 * ABI version number. See src/Makefile.am for the details.
6137 let proc_nrs = List.map (
6138 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6139 ) daemon_functions in
6140 List.fold_left max 0 proc_nrs
6142 (* Non-API meta-commands available only in guestfish.
6144 * Note (1): style, proc_nr and tests fields are all meaningless.
6145 * The only fields which are actually used are the shortname,
6146 * FishAlias flags, shortdesc and longdesc.
6148 * Note (2): to refer to other commands, use L</shortname>.
6150 * Note (3): keep this list sorted by shortname.
6152 let fish_commands = [
6153 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6154 "allocate and add a disk file",
6155 " alloc filename size
6157 This creates an empty (zeroed) file of the given size, and then adds
6158 so it can be further examined.
6160 For more advanced image creation, see L<qemu-img(1)> utility.
6162 Size can be specified using standard suffixes, eg. C<1M>.
6164 To create a sparse file, use L</sparse> instead. To create a
6165 prepared disk image, see L</PREPARED DISK IMAGES>.");
6167 ("copy_in", (RErr,[], []), -1, [], [],
6168 "copy local files or directories into an image",
6169 " copy-in local [local ...] /remotedir
6171 C<copy-in> copies local files or directories recursively into the disk
6172 image, placing them in the directory called C</remotedir> (which must
6173 exist). This guestfish meta-command turns into a sequence of
6174 L</tar-in> and other commands as necessary.
6176 Multiple local files and directories can be specified, but the last
6177 parameter must always be a remote directory. Wildcards cannot be
6180 ("copy_out", (RErr,[], []), -1, [], [],
6181 "copy remote files or directories out of an image",
6182 " copy-out remote [remote ...] localdir
6184 C<copy-out> copies remote files or directories recursively out of the
6185 disk image, placing them on the host disk in a local directory called
6186 C<localdir> (which must exist). This guestfish meta-command turns
6187 into a sequence of L</download>, L</tar-out> and other commands as
6190 Multiple remote files and directories can be specified, but the last
6191 parameter must always be a local directory. To download to the
6192 current directory, use C<.> as in:
6196 Wildcards cannot be used in the ordinary command, but you can use
6197 them with the help of L</glob> like this:
6199 glob copy-out /home/* .");
6201 ("display", (RErr,[], []), -1, [], [],
6205 Use C<display> (a graphical display program) to display an image
6206 file. It downloads the file, and runs C<display> on it.
6208 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6209 environment variable. For example to use the GNOME display program:
6211 export GUESTFISH_DISPLAY_IMAGE=eog
6213 See also L<display(1)>.");
6215 ("echo", (RErr,[], []), -1, [], [],
6216 "display a line of text",
6219 This echos the parameters to the terminal.");
6221 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6225 This is used to edit a file. It downloads the file, edits it
6226 locally using your editor, then uploads the result.
6228 The editor is C<$EDITOR>. However if you use the alternate
6229 commands C<vi> or C<emacs> you will get those corresponding
6232 ("glob", (RErr,[], []), -1, [], [],
6233 "expand wildcards in command",
6234 " glob command args...
6236 Expand wildcards in any paths in the args list, and run C<command>
6237 repeatedly on each matching path.
6239 See L</WILDCARDS AND GLOBBING>.");
6241 ("hexedit", (RErr,[], []), -1, [], [],
6242 "edit with a hex editor",
6243 " hexedit <filename|device>
6244 hexedit <filename|device> <max>
6245 hexedit <filename|device> <start> <max>
6247 Use hexedit (a hex editor) to edit all or part of a binary file
6250 This command works by downloading potentially the whole file or
6251 device, editing it locally, then uploading it. If the file or
6252 device is large, you have to specify which part you wish to edit
6253 by using C<max> and/or C<start> C<max> parameters.
6254 C<start> and C<max> are specified in bytes, with the usual
6255 modifiers allowed such as C<1M> (1 megabyte).
6257 For example to edit the first few sectors of a disk you
6262 which would allow you to edit anywhere within the first megabyte
6265 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6267 hexedit /dev/sda1 0x400 0x400
6269 (assuming the superblock is in the standard location).
6271 This command requires the external L<hexedit(1)> program. You
6272 can specify another program to use by setting the C<HEXEDITOR>
6273 environment variable.
6275 See also L</hexdump>.");
6277 ("lcd", (RErr,[], []), -1, [], [],
6278 "change working directory",
6281 Change the local directory, ie. the current directory of guestfish
6284 Note that C<!cd> won't do what you might expect.");
6286 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6290 Opens the manual page for guestfish.");
6292 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6298 This is used to view a file.
6300 The default viewer is C<$PAGER>. However if you use the alternate
6301 command C<less> you will get the C<less> command specifically.");
6303 ("reopen", (RErr,[], []), -1, [], [],
6304 "close and reopen libguestfs handle",
6307 Close and reopen the libguestfs handle. It is not necessary to use
6308 this normally, because the handle is closed properly when guestfish
6309 exits. However this is occasionally useful for testing.");
6311 ("sparse", (RErr,[], []), -1, [], [],
6312 "create a sparse disk image and add",
6313 " sparse filename size
6315 This creates an empty sparse file of the given size, and then adds
6316 so it can be further examined.
6318 In all respects it works the same as the L</alloc> command, except that
6319 the image file is allocated sparsely, which means that disk blocks are
6320 not assigned to the file until they are needed. Sparse disk files
6321 only use space when written to, but they are slower and there is a
6322 danger you could run out of real disk space during a write operation.
6324 For more advanced image creation, see L<qemu-img(1)> utility.
6326 Size can be specified using standard suffixes, eg. C<1M>.");
6328 ("supported", (RErr,[], []), -1, [], [],
6329 "list supported groups of commands",
6332 This command returns a list of the optional groups
6333 known to the daemon, and indicates which ones are
6334 supported by this build of the libguestfs appliance.
6336 See also L<guestfs(3)/AVAILABILITY>.");
6338 ("time", (RErr,[], []), -1, [], [],
6339 "print elapsed time taken to run a command",
6340 " time command args...
6342 Run the command as usual, but print the elapsed time afterwards. This
6343 can be useful for benchmarking operations.");