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 function should only be called with a root device string
730 as returned by C<guestfs_inspect_os>.
732 This returns the type of the inspected operating system.
733 Currently defined types are:
739 Any Linux-based operating system.
743 Any Microsoft Windows operating system.
751 The operating system type could not be determined.
755 Future versions of libguestfs may return other strings here.
756 The caller should be prepared to handle any string.
758 Please read L<guestfs(3)/INSPECTION> for more details.");
760 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
762 "get architecture of inspected operating system",
764 This function should only be called with a root device string
765 as returned by C<guestfs_inspect_os>.
767 This returns the architecture of the inspected operating system.
768 The possible return values are listed under
769 C<guestfs_file_architecture>.
771 If the architecture could not be determined, then the
772 string C<unknown> is returned.
774 Please read L<guestfs(3)/INSPECTION> for more details.");
776 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
778 "get distro of inspected operating system",
780 This function should only be called with a root device string
781 as returned by C<guestfs_inspect_os>.
783 This returns the distro (distribution) of the inspected operating
786 Currently defined distros are:
826 =item \"redhat-based\"
828 Some Red Hat-derived distro.
832 Red Hat Enterprise Linux.
834 =item \"scientificlinux\"
848 The distro could not be determined.
852 Windows does not have distributions. This string is
853 returned if the OS type is Windows.
857 Future versions of libguestfs may return other strings here.
858 The caller should be prepared to handle any string.
860 Please read L<guestfs(3)/INSPECTION> for more details.");
862 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
864 "get major version of inspected operating system",
866 This function should only be called with a root device string
867 as returned by C<guestfs_inspect_os>.
869 This returns the major version number of the inspected operating
872 Windows uses a consistent versioning scheme which is I<not>
873 reflected in the popular public names used by the operating system.
874 Notably the operating system known as \"Windows 7\" is really
875 version 6.1 (ie. major = 6, minor = 1). You can find out the
876 real versions corresponding to releases of Windows by consulting
879 If the version could not be determined, then C<0> is returned.
881 Please read L<guestfs(3)/INSPECTION> for more details.");
883 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
885 "get minor version of inspected operating system",
887 This function should only be called with a root device string
888 as returned by C<guestfs_inspect_os>.
890 This returns the minor version number of the inspected operating
893 If the version could not be determined, then C<0> is returned.
895 Please read L<guestfs(3)/INSPECTION> for more details.
896 See also C<guestfs_inspect_get_major_version>.");
898 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
900 "get product name of inspected operating system",
902 This function should only be called with a root device string
903 as returned by C<guestfs_inspect_os>.
905 This returns the product name of the inspected operating
906 system. The product name is generally some freeform string
907 which can be displayed to the user, but should not be
910 If the product name could not be determined, then the
911 string C<unknown> is returned.
913 Please read L<guestfs(3)/INSPECTION> for more details.");
915 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
917 "get mountpoints of inspected operating system",
919 This function should only be called with a root device string
920 as returned by C<guestfs_inspect_os>.
922 This returns a hash of where we think the filesystems
923 associated with this operating system should be mounted.
924 Callers should note that this is at best an educated guess
925 made by reading configuration files such as C</etc/fstab>.
926 I<In particular note> that this may return filesystems
927 which are non-existent or not mountable and callers should
928 be prepared to handle or ignore failures if they try to
931 Each element in the returned hashtable has a key which
932 is the path of the mountpoint (eg. C</boot>) and a value
933 which is the filesystem that would be mounted there
936 Non-mounted devices such as swap devices are I<not>
937 returned in this list.
939 For operating systems like Windows which still use drive
940 letters, this call will only return an entry for the first
941 drive \"mounted on\" C</>. For information about the
942 mapping of drive letters to partitions, see
943 C<guestfs_inspect_get_drive_mappings>.
945 Please read L<guestfs(3)/INSPECTION> for more details.
946 See also C<guestfs_inspect_get_filesystems>.");
948 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
950 "get filesystems associated with inspected operating system",
952 This function should only be called with a root device string
953 as returned by C<guestfs_inspect_os>.
955 This returns a list of all the filesystems that we think
956 are associated with this operating system. This includes
957 the root filesystem, other ordinary filesystems, and
958 non-mounted devices like swap partitions.
960 In the case of a multi-boot virtual machine, it is possible
961 for a filesystem to be shared between operating systems.
963 Please read L<guestfs(3)/INSPECTION> for more details.
964 See also C<guestfs_inspect_get_mountpoints>.");
966 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
968 "set enable network flag",
970 If C<network> is true, then the network is enabled in the
971 libguestfs appliance. The default is false.
973 This affects whether commands are able to access the network
974 (see L<guestfs(3)/RUNNING COMMANDS>).
976 You must call this before calling C<guestfs_launch>, otherwise
979 ("get_network", (RBool "network", [], []), -1, [],
981 "get enable network flag",
983 This returns the enable network flag.");
985 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
989 This inspection command looks for filesystems on partitions,
990 block devices and logical volumes, returning a list of devices
991 containing filesystems and their type.
993 The return value is a hash, where the keys are the devices
994 containing filesystems, and the values are the filesystem types.
997 \"/dev/sda1\" => \"ntfs\"
998 \"/dev/sda2\" => \"ext2\"
999 \"/dev/vg_guest/lv_root\" => \"ext4\"
1000 \"/dev/vg_guest/lv_swap\" => \"swap\"
1002 The value can have the special value \"unknown\", meaning the
1003 content of the device is undetermined or empty.
1004 \"swap\" means a Linux swap partition.
1006 This command runs other libguestfs commands, which might include
1007 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
1008 use this soon after launch and only when nothing is mounted.
1010 Not all of the filesystems returned will be mountable. In
1011 particular, swap partitions are returned in the list. Also
1012 this command does not check that each filesystem
1013 found is valid and mountable, and some filesystems might
1014 be mountable but require special options. Filesystems may
1015 not all belong to a single logical operating system
1016 (use C<guestfs_inspect_os> to look for OSes).");
1018 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
1020 "add an image to examine or modify",
1022 This function adds a virtual machine disk image C<filename> to
1023 libguestfs. The first time you call this function, the disk
1024 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1027 You don't necessarily need to be root when using libguestfs. However
1028 you obviously do need sufficient permissions to access the filename
1029 for whatever operations you want to perform (ie. read access if you
1030 just want to read the image or write access if you want to modify the
1033 This call checks that C<filename> exists.
1035 The optional arguments are:
1041 If true then the image is treated as read-only. Writes are still
1042 allowed, but they are stored in a temporary snapshot overlay which
1043 is discarded at the end. The disk that you add is not modified.
1047 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1048 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1049 Possible formats include C<raw> and C<qcow2>.
1051 Automatic detection of the format opens you up to a potential
1052 security hole when dealing with untrusted raw-format images.
1053 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1058 This rarely-used option lets you emulate the behaviour of the
1059 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1063 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1065 "get Windows systemroot of inspected operating system",
1067 This function should only be called with a root device string
1068 as returned by C<guestfs_inspect_os>.
1070 This returns the Windows systemroot of the inspected guest.
1071 The systemroot is a directory path such as C</WINDOWS>.
1073 This call assumes that the guest is Windows and that the
1074 systemroot could be determined by inspection. If this is not
1075 the case then an error is returned.
1077 Please read L<guestfs(3)/INSPECTION> for more details.");
1079 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1081 "return list of operating systems found by last inspection",
1083 This function is a convenient way to get the list of root
1084 devices, as returned from a previous call to C<guestfs_inspect_os>,
1085 but without redoing the whole inspection process.
1087 This returns an empty list if either no root devices were
1088 found or the caller has not called C<guestfs_inspect_os>.
1090 Please read L<guestfs(3)/INSPECTION> for more details.");
1092 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1094 "debug the QEMU command line (internal use only)",
1096 This returns the internal QEMU command line. 'debug' commands are
1097 not part of the formal API and can be removed or changed at any time.");
1099 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"]), -1, [FishAlias "domain"],
1101 "add the disk(s) from a named libvirt domain",
1103 This function adds the disk(s) attached to the named libvirt
1104 domain C<dom>. It works by connecting to libvirt, requesting
1105 the domain and domain XML from libvirt, parsing it for disks,
1106 and calling C<guestfs_add_drive_opts> on each one.
1108 The number of disks added is returned. This operation is atomic:
1109 if an error is returned, then no disks are added.
1111 This function does some minimal checks to make sure the libvirt
1112 domain is not running (unless C<readonly> is true). In a future
1113 version we will try to acquire the libvirt lock on each disk.
1115 Disks must be accessible locally. This often means that adding disks
1116 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1117 will fail unless those disks are accessible via the same device path
1120 The optional C<libvirturi> parameter sets the libvirt URI
1121 (see L<http://libvirt.org/uri.html>). If this is not set then
1122 we connect to the default libvirt URI (or one set through an
1123 environment variable, see the libvirt documentation for full
1126 The optional C<live> flag controls whether this call will try
1127 to connect to a running virtual machine C<guestfsd> process if
1128 it sees a suitable E<lt>channelE<gt> element in the libvirt
1129 XML definition. The default (if the flag is omitted) is never
1130 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1133 The other optional parameters are passed directly through to
1134 C<guestfs_add_drive_opts>.");
1137 This interface is not quite baked yet. -- RWMJ 2010-11-11
1138 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1140 "add the disk(s) from a libvirt domain",
1142 This function adds the disk(s) attached to the libvirt domain C<dom>.
1143 It works by requesting the domain XML from libvirt, parsing it for
1144 disks, and calling C<guestfs_add_drive_opts> on each one.
1146 In the C API we declare C<void *dom>, but really it has type
1147 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1149 The number of disks added is returned. This operation is atomic:
1150 if an error is returned, then no disks are added.
1152 This function does some minimal checks to make sure the libvirt
1153 domain is not running (unless C<readonly> is true). In a future
1154 version we will try to acquire the libvirt lock on each disk.
1156 Disks must be accessible locally. This often means that adding disks
1157 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1158 will fail unless those disks are accessible via the same device path
1161 The optional C<live> flag controls whether this call will try
1162 to connect to a running virtual machine C<guestfsd> process if
1163 it sees a suitable E<lt>channelE<gt> element in the libvirt
1164 XML definition. The default (if the flag is omitted) is never
1165 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1168 The other optional parameters are passed directly through to
1169 C<guestfs_add_drive_opts>.");
1172 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1174 "get package format used by the operating system",
1176 This function should only be called with a root device string
1177 as returned by C<guestfs_inspect_os>.
1179 This function and C<guestfs_inspect_get_package_management> return
1180 the package format and package management tool used by the
1181 inspected operating system. For example for Fedora these
1182 functions would return C<rpm> (package format) and
1183 C<yum> (package management).
1185 This returns the string C<unknown> if we could not determine the
1186 package format I<or> if the operating system does not have
1187 a real packaging system (eg. Windows).
1189 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1190 Future versions of libguestfs may return other strings.
1192 Please read L<guestfs(3)/INSPECTION> for more details.");
1194 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1196 "get package management tool used by the operating system",
1198 This function should only be called with a root device string
1199 as returned by C<guestfs_inspect_os>.
1201 C<guestfs_inspect_get_package_format> and this function return
1202 the package format and package management tool used by the
1203 inspected operating system. For example for Fedora these
1204 functions would return C<rpm> (package format) and
1205 C<yum> (package management).
1207 This returns the string C<unknown> if we could not determine the
1208 package management tool I<or> if the operating system does not have
1209 a real packaging system (eg. Windows).
1211 Possible strings include: C<yum>, C<up2date>,
1212 C<apt> (for all Debian derivatives),
1213 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1214 Future versions of libguestfs may return other strings.
1216 Please read L<guestfs(3)/INSPECTION> for more details.");
1218 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1220 "get list of applications installed in the operating system",
1222 This function should only be called with a root device string
1223 as returned by C<guestfs_inspect_os>.
1225 Return the list of applications installed in the operating system.
1227 I<Note:> This call works differently from other parts of the
1228 inspection API. You have to call C<guestfs_inspect_os>, then
1229 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1230 before calling this. Listing applications is a significantly
1231 more difficult operation which requires access to the full
1232 filesystem. Also note that unlike the other
1233 C<guestfs_inspect_get_*> calls which are just returning
1234 data cached in the libguestfs handle, this call actually reads
1235 parts of the mounted filesystems during the call.
1237 This returns an empty list if the inspection code was not able
1238 to determine the list of applications.
1240 The application structure contains the following fields:
1246 The name of the application. For Red Hat-derived and Debian-derived
1247 Linux guests, this is the package name.
1249 =item C<app_display_name>
1251 The display name of the application, sometimes localized to the
1252 install language of the guest operating system.
1254 If unavailable this is returned as an empty string C<\"\">.
1255 Callers needing to display something can use C<app_name> instead.
1259 For package managers which use epochs, this contains the epoch of
1260 the package (an integer). If unavailable, this is returned as C<0>.
1262 =item C<app_version>
1264 The version string of the application or package. If unavailable
1265 this is returned as an empty string C<\"\">.
1267 =item C<app_release>
1269 The release string of the application or package, for package
1270 managers that use this. If unavailable this is returned as an
1271 empty string C<\"\">.
1273 =item C<app_install_path>
1275 The installation path of the application (on operating systems
1276 such as Windows which use installation paths). This path is
1277 in the format used by the guest operating system, it is not
1280 If unavailable this is returned as an empty string C<\"\">.
1282 =item C<app_trans_path>
1284 The install path translated into a libguestfs path.
1285 If unavailable this is returned as an empty string C<\"\">.
1287 =item C<app_publisher>
1289 The name of the publisher of the application, for package
1290 managers that use this. If unavailable this is returned
1291 as an empty string C<\"\">.
1295 The URL (eg. upstream URL) of the application.
1296 If unavailable this is returned as an empty string C<\"\">.
1298 =item C<app_source_package>
1300 For packaging systems which support this, the name of the source
1301 package. If unavailable this is returned as an empty string C<\"\">.
1303 =item C<app_summary>
1305 A short (usually one line) description of the application or package.
1306 If unavailable this is returned as an empty string C<\"\">.
1308 =item C<app_description>
1310 A longer description of the application or package.
1311 If unavailable this is returned as an empty string C<\"\">.
1315 Please read L<guestfs(3)/INSPECTION> for more details.");
1317 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1319 "get hostname of the operating system",
1321 This function should only be called with a root device string
1322 as returned by C<guestfs_inspect_os>.
1324 This function returns the hostname of the operating system
1325 as found by inspection of the guest's configuration files.
1327 If the hostname could not be determined, then the
1328 string C<unknown> is returned.
1330 Please read L<guestfs(3)/INSPECTION> for more details.");
1332 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1334 "get format of inspected operating system",
1336 This function should only be called with a root device string
1337 as returned by C<guestfs_inspect_os>.
1339 This returns the format of the inspected operating system. You
1340 can use it to detect install images, live CDs and similar.
1342 Currently defined formats are:
1348 This is an installed operating system.
1352 The disk image being inspected is not an installed operating system,
1353 but a I<bootable> install disk, live CD, or similar.
1357 The format of this disk image is not known.
1361 Future versions of libguestfs may return other strings here.
1362 The caller should be prepared to handle any string.
1364 Please read L<guestfs(3)/INSPECTION> for more details.");
1366 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1368 "get live flag for install disk",
1370 This function should only be called with a root device string
1371 as returned by C<guestfs_inspect_os>.
1373 If C<guestfs_inspect_get_format> returns C<installer> (this
1374 is an install disk), then this returns true if a live image
1375 was detected on the disk.
1377 Please read L<guestfs(3)/INSPECTION> for more details.");
1379 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1381 "get netinst (network installer) flag for install disk",
1383 This function should only be called with a root device string
1384 as returned by C<guestfs_inspect_os>.
1386 If C<guestfs_inspect_get_format> returns C<installer> (this
1387 is an install disk), then this returns true if the disk is
1388 a network installer, ie. not a self-contained install CD but
1389 one which is likely to require network access to complete
1392 Please read L<guestfs(3)/INSPECTION> for more details.");
1394 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1396 "get multipart flag for install disk",
1398 This function should only be called with a root device string
1399 as returned by C<guestfs_inspect_os>.
1401 If C<guestfs_inspect_get_format> returns C<installer> (this
1402 is an install disk), then this returns true if the disk is
1405 Please read L<guestfs(3)/INSPECTION> for more details.");
1407 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1409 "set the attach method",
1411 Set the method that libguestfs uses to connect to the back end
1412 guestfsd daemon. Possible methods are:
1418 Launch an appliance and connect to it. This is the ordinary method
1421 =item C<unix:I<path>>
1423 Connect to the Unix domain socket I<path>.
1425 This method lets you connect to an existing daemon or (using
1426 virtio-serial) to a live guest. For more information, see
1427 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1431 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1432 [InitNone, Always, TestOutput (
1433 [["get_attach_method"]], "appliance")],
1434 "get the attach method",
1436 Return the current attach method. See C<guestfs_set_attach_method>.");
1438 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1440 "get product variant of inspected operating system",
1442 This function should only be called with a root device string
1443 as returned by C<guestfs_inspect_os>.
1445 This returns the product variant of the inspected operating
1448 For Windows guests, this returns the contents of the Registry key
1449 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1450 C<InstallationType> which is usually a string such as
1451 C<Client> or C<Server> (other values are possible). This
1452 can be used to distinguish consumer and enterprise versions
1453 of Windows that have the same version number (for example,
1454 Windows 7 and Windows 2008 Server are both version 6.1,
1455 but the former is C<Client> and the latter is C<Server>).
1457 For enterprise Linux guests, in future we intend this to return
1458 the product variant such as C<Desktop>, C<Server> and so on. But
1459 this is not implemented at present.
1461 If the product variant could not be determined, then the
1462 string C<unknown> is returned.
1464 Please read L<guestfs(3)/INSPECTION> for more details.
1465 See also C<guestfs_inspect_get_product_name>,
1466 C<guestfs_inspect_get_major_version>.");
1468 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1470 "get Windows CurrentControlSet of inspected operating system",
1472 This function should only be called with a root device string
1473 as returned by C<guestfs_inspect_os>.
1475 This returns the Windows CurrentControlSet of the inspected guest.
1476 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1478 This call assumes that the guest is Windows and that the
1479 Registry could be examined by inspection. If this is not
1480 the case then an error is returned.
1482 Please read L<guestfs(3)/INSPECTION> for more details.");
1484 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1486 "get drive letter mappings",
1488 This function should only be called with a root device string
1489 as returned by C<guestfs_inspect_os>.
1491 This call is useful for Windows which uses a primitive system
1492 of assigning drive letters (like \"C:\") to partitions.
1493 This inspection API examines the Windows Registry to find out
1494 how disks/partitions are mapped to drive letters, and returns
1495 a hash table as in the example below:
1501 Note that keys are drive letters. For Windows, the key is
1502 case insensitive and just contains the drive letter, without
1503 the customary colon separator character.
1505 In future we may support other operating systems that also used drive
1506 letters, but the keys for those might not be case insensitive
1507 and might be longer than 1 character. For example in OS-9,
1508 hard drives were named C<h0>, C<h1> etc.
1510 For Windows guests, currently only hard drive mappings are
1511 returned. Removable disks (eg. DVD-ROMs) are ignored.
1513 For guests that do not use drive mappings, or if the drive mappings
1514 could not be determined, this returns an empty hash table.
1516 Please read L<guestfs(3)/INSPECTION> for more details.
1517 See also C<guestfs_inspect_get_mountpoints>,
1518 C<guestfs_inspect_get_filesystems>.");
1522 (* daemon_functions are any functions which cause some action
1523 * to take place in the daemon.
1526 let daemon_functions = [
1527 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [DeprecatedBy "mount_options"],
1528 [InitEmpty, Always, TestOutput (
1529 [["part_disk"; "/dev/sda"; "mbr"];
1530 ["mkfs"; "ext2"; "/dev/sda1"];
1531 ["mount"; "/dev/sda1"; "/"];
1532 ["write"; "/new"; "new file contents"];
1533 ["cat"; "/new"]], "new file contents")],
1534 "mount a guest disk at a position in the filesystem",
1536 Mount a guest disk at a position in the filesystem. Block devices
1537 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1538 the guest. If those block devices contain partitions, they will have
1539 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1542 The rules are the same as for L<mount(2)>: A filesystem must
1543 first be mounted on C</> before others can be mounted. Other
1544 filesystems can only be mounted on directories which already
1547 The mounted filesystem is writable, if we have sufficient permissions
1548 on the underlying device.
1551 When you use this call, the filesystem options C<sync> and C<noatime>
1552 are set implicitly. This was originally done because we thought it
1553 would improve reliability, but it turns out that I<-o sync> has a
1554 very large negative performance impact and negligible effect on
1555 reliability. Therefore we recommend that you avoid using
1556 C<guestfs_mount> in any code that needs performance, and instead
1557 use C<guestfs_mount_options> (use an empty string for the first
1558 parameter if you don't want any options).");
1560 ("sync", (RErr, [], []), 2, [],
1561 [ InitEmpty, Always, TestRun [["sync"]]],
1562 "sync disks, writes are flushed through to the disk image",
1564 This syncs the disk, so that any writes are flushed through to the
1565 underlying disk image.
1567 You should always call this if you have modified a disk image, before
1568 closing the handle.");
1570 ("touch", (RErr, [Pathname "path"], []), 3, [],
1571 [InitScratchFS, Always, TestOutputTrue (
1572 [["touch"; "/touch"];
1573 ["exists"; "/touch"]])],
1574 "update file timestamps or create a new file",
1576 Touch acts like the L<touch(1)> command. It can be used to
1577 update the timestamps on a file, or, if the file does not exist,
1578 to create a new zero-length file.
1580 This command only works on regular files, and will fail on other
1581 file types such as directories, symbolic links, block special etc.");
1583 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1584 [InitISOFS, Always, TestOutput (
1585 [["cat"; "/known-2"]], "abcdef\n")],
1586 "list the contents of a file",
1588 Return the contents of the file named C<path>.
1590 Note that this function cannot correctly handle binary files
1591 (specifically, files containing C<\\0> character which is treated
1592 as end of string). For those you need to use the C<guestfs_read_file>
1593 or C<guestfs_download> functions which have a more complex interface.");
1595 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1596 [], (* XXX Tricky to test because it depends on the exact format
1597 * of the 'ls -l' command, which changes between F10 and F11.
1599 "list the files in a directory (long format)",
1601 List the files in C<directory> (relative to the root directory,
1602 there is no cwd) in the format of 'ls -la'.
1604 This command is mostly useful for interactive sessions. It
1605 is I<not> intended that you try to parse the output string.");
1607 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1608 [InitScratchFS, Always, TestOutputList (
1610 ["touch"; "/ls/new"];
1611 ["touch"; "/ls/newer"];
1612 ["touch"; "/ls/newest"];
1613 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1614 "list the files in a directory",
1616 List the files in C<directory> (relative to the root directory,
1617 there is no cwd). The '.' and '..' entries are not returned, but
1618 hidden files are shown.
1620 This command is mostly useful for interactive sessions. Programs
1621 should probably use C<guestfs_readdir> instead.");
1623 ("list_devices", (RStringList "devices", [], []), 7, [],
1624 [InitEmpty, Always, TestOutputListOfDevices (
1625 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1626 "list the block devices",
1628 List all the block devices.
1630 The full block device names are returned, eg. C</dev/sda>.
1632 See also C<guestfs_list_filesystems>.");
1634 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1635 [InitBasicFS, Always, TestOutputListOfDevices (
1636 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1637 InitEmpty, Always, TestOutputListOfDevices (
1638 [["part_init"; "/dev/sda"; "mbr"];
1639 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1640 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1641 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1642 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1643 "list the partitions",
1645 List all the partitions detected on all block devices.
1647 The full partition device names are returned, eg. C</dev/sda1>
1649 This does not return logical volumes. For that you will need to
1650 call C<guestfs_lvs>.
1652 See also C<guestfs_list_filesystems>.");
1654 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1655 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1656 [["pvs"]], ["/dev/sda1"]);
1657 InitEmpty, Always, TestOutputListOfDevices (
1658 [["part_init"; "/dev/sda"; "mbr"];
1659 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1660 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1661 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1662 ["pvcreate"; "/dev/sda1"];
1663 ["pvcreate"; "/dev/sda2"];
1664 ["pvcreate"; "/dev/sda3"];
1665 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1666 "list the LVM physical volumes (PVs)",
1668 List all the physical volumes detected. This is the equivalent
1669 of the L<pvs(8)> command.
1671 This returns a list of just the device names that contain
1672 PVs (eg. C</dev/sda2>).
1674 See also C<guestfs_pvs_full>.");
1676 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1677 [InitBasicFSonLVM, Always, TestOutputList (
1679 InitEmpty, Always, TestOutputList (
1680 [["part_init"; "/dev/sda"; "mbr"];
1681 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1682 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1683 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1684 ["pvcreate"; "/dev/sda1"];
1685 ["pvcreate"; "/dev/sda2"];
1686 ["pvcreate"; "/dev/sda3"];
1687 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1688 ["vgcreate"; "VG2"; "/dev/sda3"];
1689 ["vgs"]], ["VG1"; "VG2"])],
1690 "list the LVM volume groups (VGs)",
1692 List all the volumes groups detected. This is the equivalent
1693 of the L<vgs(8)> command.
1695 This returns a list of just the volume group names that were
1696 detected (eg. C<VolGroup00>).
1698 See also C<guestfs_vgs_full>.");
1700 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1701 [InitBasicFSonLVM, Always, TestOutputList (
1702 [["lvs"]], ["/dev/VG/LV"]);
1703 InitEmpty, Always, TestOutputList (
1704 [["part_init"; "/dev/sda"; "mbr"];
1705 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1706 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1707 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1708 ["pvcreate"; "/dev/sda1"];
1709 ["pvcreate"; "/dev/sda2"];
1710 ["pvcreate"; "/dev/sda3"];
1711 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1712 ["vgcreate"; "VG2"; "/dev/sda3"];
1713 ["lvcreate"; "LV1"; "VG1"; "50"];
1714 ["lvcreate"; "LV2"; "VG1"; "50"];
1715 ["lvcreate"; "LV3"; "VG2"; "50"];
1716 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1717 "list the LVM logical volumes (LVs)",
1719 List all the logical volumes detected. This is the equivalent
1720 of the L<lvs(8)> command.
1722 This returns a list of the logical volume device names
1723 (eg. C</dev/VolGroup00/LogVol00>).
1725 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1727 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1728 [], (* XXX how to test? *)
1729 "list the LVM physical volumes (PVs)",
1731 List all the physical volumes detected. This is the equivalent
1732 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1734 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1735 [], (* XXX how to test? *)
1736 "list the LVM volume groups (VGs)",
1738 List all the volumes groups detected. This is the equivalent
1739 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1741 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1742 [], (* XXX how to test? *)
1743 "list the LVM logical volumes (LVs)",
1745 List all the logical volumes detected. This is the equivalent
1746 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1748 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1749 [InitISOFS, Always, TestOutputList (
1750 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1751 InitISOFS, Always, TestOutputList (
1752 [["read_lines"; "/empty"]], [])],
1753 "read file as lines",
1755 Return the contents of the file named C<path>.
1757 The file contents are returned as a list of lines. Trailing
1758 C<LF> and C<CRLF> character sequences are I<not> returned.
1760 Note that this function cannot correctly handle binary files
1761 (specifically, files containing C<\\0> character which is treated
1762 as end of line). For those you need to use the C<guestfs_read_file>
1763 function which has a more complex interface.");
1765 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1766 [], (* XXX Augeas code needs tests. *)
1767 "create a new Augeas handle",
1769 Create a new Augeas handle for editing configuration files.
1770 If there was any previous Augeas handle associated with this
1771 guestfs session, then it is closed.
1773 You must call this before using any other C<guestfs_aug_*>
1776 C<root> is the filesystem root. C<root> must not be NULL,
1779 The flags are the same as the flags defined in
1780 E<lt>augeas.hE<gt>, the logical I<or> of the following
1785 =item C<AUG_SAVE_BACKUP> = 1
1787 Keep the original file with a C<.augsave> extension.
1789 =item C<AUG_SAVE_NEWFILE> = 2
1791 Save changes into a file with extension C<.augnew>, and
1792 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1794 =item C<AUG_TYPE_CHECK> = 4
1796 Typecheck lenses (can be expensive).
1798 =item C<AUG_NO_STDINC> = 8
1800 Do not use standard load path for modules.
1802 =item C<AUG_SAVE_NOOP> = 16
1804 Make save a no-op, just record what would have been changed.
1806 =item C<AUG_NO_LOAD> = 32
1808 Do not load the tree in C<guestfs_aug_init>.
1812 To close the handle, you can call C<guestfs_aug_close>.
1814 To find out more about Augeas, see L<http://augeas.net/>.");
1816 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1817 [], (* XXX Augeas code needs tests. *)
1818 "close the current Augeas handle",
1820 Close the current Augeas handle and free up any resources
1821 used by it. After calling this, you have to call
1822 C<guestfs_aug_init> again before you can use any other
1823 Augeas functions.");
1825 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1826 [], (* XXX Augeas code needs tests. *)
1827 "define an Augeas variable",
1829 Defines an Augeas variable C<name> whose value is the result
1830 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1833 On success this returns the number of nodes in C<expr>, or
1834 C<0> if C<expr> evaluates to something which is not a nodeset.");
1836 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1837 [], (* XXX Augeas code needs tests. *)
1838 "define an Augeas node",
1840 Defines a variable C<name> whose value is the result of
1843 If C<expr> evaluates to an empty nodeset, a node is created,
1844 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1845 C<name> will be the nodeset containing that single node.
1847 On success this returns a pair containing the
1848 number of nodes in the nodeset, and a boolean flag
1849 if a node was created.");
1851 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1852 [], (* XXX Augeas code needs tests. *)
1853 "look up the value of an Augeas path",
1855 Look up the value associated with C<path>. If C<path>
1856 matches exactly one node, the C<value> is returned.");
1858 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1859 [], (* XXX Augeas code needs tests. *)
1860 "set Augeas path to value",
1862 Set the value associated with C<path> to C<val>.
1864 In the Augeas API, it is possible to clear a node by setting
1865 the value to NULL. Due to an oversight in the libguestfs API
1866 you cannot do that with this call. Instead you must use the
1867 C<guestfs_aug_clear> call.");
1869 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1870 [], (* XXX Augeas code needs tests. *)
1871 "insert a sibling Augeas node",
1873 Create a new sibling C<label> for C<path>, inserting it into
1874 the tree before or after C<path> (depending on the boolean
1877 C<path> must match exactly one existing node in the tree, and
1878 C<label> must be a label, ie. not contain C</>, C<*> or end
1879 with a bracketed index C<[N]>.");
1881 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1882 [], (* XXX Augeas code needs tests. *)
1883 "remove an Augeas path",
1885 Remove C<path> and all of its children.
1887 On success this returns the number of entries which were removed.");
1889 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1890 [], (* XXX Augeas code needs tests. *)
1893 Move the node C<src> to C<dest>. C<src> must match exactly
1894 one node. C<dest> is overwritten if it exists.");
1896 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1897 [], (* XXX Augeas code needs tests. *)
1898 "return Augeas nodes which match augpath",
1900 Returns a list of paths which match the path expression C<path>.
1901 The returned paths are sufficiently qualified so that they match
1902 exactly one node in the current tree.");
1904 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1905 [], (* XXX Augeas code needs tests. *)
1906 "write all pending Augeas changes to disk",
1908 This writes all pending changes to disk.
1910 The flags which were passed to C<guestfs_aug_init> affect exactly
1911 how files are saved.");
1913 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1914 [], (* XXX Augeas code needs tests. *)
1915 "load files into the tree",
1917 Load files into the tree.
1919 See C<aug_load> in the Augeas documentation for the full gory
1922 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1923 [], (* XXX Augeas code needs tests. *)
1924 "list Augeas nodes under augpath",
1926 This is just a shortcut for listing C<guestfs_aug_match>
1927 C<path/*> and sorting the resulting nodes into alphabetical order.");
1929 ("rm", (RErr, [Pathname "path"], []), 29, [],
1930 [InitScratchFS, Always, TestRun
1932 ["touch"; "/rm/new"];
1934 InitScratchFS, Always, TestLastFail
1935 [["rm"; "/nosuchfile"]];
1936 InitScratchFS, Always, TestLastFail
1941 Remove the single file C<path>.");
1943 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1944 [InitScratchFS, Always, TestRun
1945 [["mkdir"; "/rmdir"];
1946 ["rmdir"; "/rmdir"]];
1947 InitScratchFS, Always, TestLastFail
1948 [["rmdir"; "/rmdir2"]];
1949 InitScratchFS, Always, TestLastFail
1950 [["mkdir"; "/rmdir3"];
1951 ["touch"; "/rmdir3/new"];
1952 ["rmdir"; "/rmdir3/new"]]],
1953 "remove a directory",
1955 Remove the single directory C<path>.");
1957 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1958 [InitScratchFS, Always, TestOutputFalse
1959 [["mkdir"; "/rm_rf"];
1960 ["mkdir"; "/rm_rf/foo"];
1961 ["touch"; "/rm_rf/foo/bar"];
1962 ["rm_rf"; "/rm_rf"];
1963 ["exists"; "/rm_rf"]]],
1964 "remove a file or directory recursively",
1966 Remove the file or directory C<path>, recursively removing the
1967 contents if its a directory. This is like the C<rm -rf> shell
1970 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1971 [InitScratchFS, Always, TestOutputTrue
1972 [["mkdir"; "/mkdir"];
1973 ["is_dir"; "/mkdir"]];
1974 InitScratchFS, Always, TestLastFail
1975 [["mkdir"; "/mkdir2/foo/bar"]]],
1976 "create a directory",
1978 Create a directory named C<path>.");
1980 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1981 [InitScratchFS, Always, TestOutputTrue
1982 [["mkdir_p"; "/mkdir_p/foo/bar"];
1983 ["is_dir"; "/mkdir_p/foo/bar"]];
1984 InitScratchFS, Always, TestOutputTrue
1985 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1986 ["is_dir"; "/mkdir_p2/foo"]];
1987 InitScratchFS, Always, TestOutputTrue
1988 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1989 ["is_dir"; "/mkdir_p3"]];
1990 (* Regression tests for RHBZ#503133: *)
1991 InitScratchFS, Always, TestRun
1992 [["mkdir"; "/mkdir_p4"];
1993 ["mkdir_p"; "/mkdir_p4"]];
1994 InitScratchFS, Always, TestLastFail
1995 [["touch"; "/mkdir_p5"];
1996 ["mkdir_p"; "/mkdir_p5"]]],
1997 "create a directory and parents",
1999 Create a directory named C<path>, creating any parent directories
2000 as necessary. This is like the C<mkdir -p> shell command.");
2002 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2003 [], (* XXX Need stat command to test *)
2006 Change the mode (permissions) of C<path> to C<mode>. Only
2007 numeric modes are supported.
2009 I<Note>: When using this command from guestfish, C<mode>
2010 by default would be decimal, unless you prefix it with
2011 C<0> to get octal, ie. use C<0700> not C<700>.
2013 The mode actually set is affected by the umask.");
2015 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2016 [], (* XXX Need stat command to test *)
2017 "change file owner and group",
2019 Change the file owner to C<owner> and group to C<group>.
2021 Only numeric uid and gid are supported. If you want to use
2022 names, you will need to locate and parse the password file
2023 yourself (Augeas support makes this relatively easy).");
2025 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2026 [InitISOFS, Always, TestOutputTrue (
2027 [["exists"; "/empty"]]);
2028 InitISOFS, Always, TestOutputTrue (
2029 [["exists"; "/directory"]])],
2030 "test if file or directory exists",
2032 This returns C<true> if and only if there is a file, directory
2033 (or anything) with the given C<path> name.
2035 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2037 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2038 [InitISOFS, Always, TestOutputTrue (
2039 [["is_file"; "/known-1"]]);
2040 InitISOFS, Always, TestOutputFalse (
2041 [["is_file"; "/directory"]])],
2042 "test if a regular file",
2044 This returns C<true> if and only if there is a regular file
2045 with the given C<path> name. Note that it returns false for
2046 other objects like directories.
2048 See also C<guestfs_stat>.");
2050 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2051 [InitISOFS, Always, TestOutputFalse (
2052 [["is_dir"; "/known-3"]]);
2053 InitISOFS, Always, TestOutputTrue (
2054 [["is_dir"; "/directory"]])],
2055 "test if a directory",
2057 This returns C<true> if and only if there is a directory
2058 with the given C<path> name. Note that it returns false for
2059 other objects like files.
2061 See also C<guestfs_stat>.");
2063 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2064 [InitEmpty, Always, TestOutputListOfDevices (
2065 [["part_init"; "/dev/sda"; "mbr"];
2066 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2067 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2068 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2069 ["pvcreate"; "/dev/sda1"];
2070 ["pvcreate"; "/dev/sda2"];
2071 ["pvcreate"; "/dev/sda3"];
2072 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2073 "create an LVM physical volume",
2075 This creates an LVM physical volume on the named C<device>,
2076 where C<device> should usually be a partition name such
2079 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2080 [InitEmpty, Always, TestOutputList (
2081 [["part_init"; "/dev/sda"; "mbr"];
2082 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2083 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2084 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2085 ["pvcreate"; "/dev/sda1"];
2086 ["pvcreate"; "/dev/sda2"];
2087 ["pvcreate"; "/dev/sda3"];
2088 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2089 ["vgcreate"; "VG2"; "/dev/sda3"];
2090 ["vgs"]], ["VG1"; "VG2"])],
2091 "create an LVM volume group",
2093 This creates an LVM volume group called C<volgroup>
2094 from the non-empty list of physical volumes C<physvols>.");
2096 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2097 [InitEmpty, Always, TestOutputList (
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 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2106 ["vgcreate"; "VG2"; "/dev/sda3"];
2107 ["lvcreate"; "LV1"; "VG1"; "50"];
2108 ["lvcreate"; "LV2"; "VG1"; "50"];
2109 ["lvcreate"; "LV3"; "VG2"; "50"];
2110 ["lvcreate"; "LV4"; "VG2"; "50"];
2111 ["lvcreate"; "LV5"; "VG2"; "50"];
2113 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2114 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2115 "create an LVM logical volume",
2117 This creates an LVM logical volume called C<logvol>
2118 on the volume group C<volgroup>, with C<size> megabytes.");
2120 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2121 [InitEmpty, Always, TestOutput (
2122 [["part_disk"; "/dev/sda"; "mbr"];
2123 ["mkfs"; "ext2"; "/dev/sda1"];
2124 ["mount_options"; ""; "/dev/sda1"; "/"];
2125 ["write"; "/new"; "new file contents"];
2126 ["cat"; "/new"]], "new file contents")],
2127 "make a filesystem",
2129 This creates a filesystem on C<device> (usually a partition
2130 or LVM logical volume). The filesystem type is C<fstype>, for
2133 ("sfdisk", (RErr, [Device "device";
2134 Int "cyls"; Int "heads"; Int "sectors";
2135 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2137 "create partitions on a block device",
2139 This is a direct interface to the L<sfdisk(8)> program for creating
2140 partitions on block devices.
2142 C<device> should be a block device, for example C</dev/sda>.
2144 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2145 and sectors on the device, which are passed directly to sfdisk as
2146 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2147 of these, then the corresponding parameter is omitted. Usually for
2148 'large' disks, you can just pass C<0> for these, but for small
2149 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2150 out the right geometry and you will need to tell it.
2152 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2153 information refer to the L<sfdisk(8)> manpage.
2155 To create a single partition occupying the whole disk, you would
2156 pass C<lines> as a single element list, when the single element being
2157 the string C<,> (comma).
2159 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2160 C<guestfs_part_init>");
2162 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2163 (* Regression test for RHBZ#597135. *)
2164 [InitScratchFS, Always, TestLastFail
2165 [["write_file"; "/write_file"; "abc"; "10000"]]],
2168 This call creates a file called C<path>. The contents of the
2169 file is the string C<content> (which can contain any 8 bit data),
2170 with length C<size>.
2172 As a special case, if C<size> is C<0>
2173 then the length is calculated using C<strlen> (so in this case
2174 the content cannot contain embedded ASCII NULs).
2176 I<NB.> Owing to a bug, writing content containing ASCII NUL
2177 characters does I<not> work, even if the length is specified.");
2179 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2180 [InitEmpty, Always, TestOutputListOfDevices (
2181 [["part_disk"; "/dev/sda"; "mbr"];
2182 ["mkfs"; "ext2"; "/dev/sda1"];
2183 ["mount_options"; ""; "/dev/sda1"; "/"];
2184 ["mounts"]], ["/dev/sda1"]);
2185 InitEmpty, Always, TestOutputList (
2186 [["part_disk"; "/dev/sda"; "mbr"];
2187 ["mkfs"; "ext2"; "/dev/sda1"];
2188 ["mount_options"; ""; "/dev/sda1"; "/"];
2191 "unmount a filesystem",
2193 This unmounts the given filesystem. The filesystem may be
2194 specified either by its mountpoint (path) or the device which
2195 contains the filesystem.");
2197 ("mounts", (RStringList "devices", [], []), 46, [],
2198 [InitScratchFS, Always, TestOutputListOfDevices (
2199 [["mounts"]], ["/dev/sdb1"])],
2200 "show mounted filesystems",
2202 This returns the list of currently mounted filesystems. It returns
2203 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2205 Some internal mounts are not shown.
2207 See also: C<guestfs_mountpoints>");
2209 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2210 [InitScratchFS, Always, TestOutputList (
2213 (* check that umount_all can unmount nested mounts correctly: *)
2214 InitEmpty, Always, TestOutputList (
2215 [["part_init"; "/dev/sda"; "mbr"];
2216 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2217 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2218 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2219 ["mkfs"; "ext2"; "/dev/sda1"];
2220 ["mkfs"; "ext2"; "/dev/sda2"];
2221 ["mkfs"; "ext2"; "/dev/sda3"];
2222 ["mount_options"; ""; "/dev/sda1"; "/"];
2224 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2225 ["mkdir"; "/mp1/mp2"];
2226 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2227 ["mkdir"; "/mp1/mp2/mp3"];
2230 "unmount all filesystems",
2232 This unmounts all mounted filesystems.
2234 Some internal mounts are not unmounted by this call.");
2236 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2238 "remove all LVM LVs, VGs and PVs",
2240 This command removes all LVM logical volumes, volume groups
2241 and physical volumes.");
2243 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2244 [InitISOFS, Always, TestOutput (
2245 [["file"; "/empty"]], "empty");
2246 InitISOFS, Always, TestOutput (
2247 [["file"; "/known-1"]], "ASCII text");
2248 InitISOFS, Always, TestLastFail (
2249 [["file"; "/notexists"]]);
2250 InitISOFS, Always, TestOutput (
2251 [["file"; "/abssymlink"]], "symbolic link");
2252 InitISOFS, Always, TestOutput (
2253 [["file"; "/directory"]], "directory")],
2254 "determine file type",
2256 This call uses the standard L<file(1)> command to determine
2257 the type or contents of the file.
2259 This call will also transparently look inside various types
2262 The exact command which runs is C<file -zb path>. Note in
2263 particular that the filename is not prepended to the output
2266 The output depends on the output of the underlying L<file(1)>
2267 command and it can change in future in ways beyond our control.
2268 In other words, the output is not guaranteed by the ABI.
2270 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2271 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc).");
2273 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2274 [InitScratchFS, Always, TestOutput (
2275 [["mkdir"; "/command"];
2276 ["upload"; "test-command"; "/command/test-command"];
2277 ["chmod"; "0o755"; "/command/test-command"];
2278 ["command"; "/command/test-command 1"]], "Result1");
2279 InitScratchFS, Always, TestOutput (
2280 [["mkdir"; "/command2"];
2281 ["upload"; "test-command"; "/command2/test-command"];
2282 ["chmod"; "0o755"; "/command2/test-command"];
2283 ["command"; "/command2/test-command 2"]], "Result2\n");
2284 InitScratchFS, Always, TestOutput (
2285 [["mkdir"; "/command3"];
2286 ["upload"; "test-command"; "/command3/test-command"];
2287 ["chmod"; "0o755"; "/command3/test-command"];
2288 ["command"; "/command3/test-command 3"]], "\nResult3");
2289 InitScratchFS, Always, TestOutput (
2290 [["mkdir"; "/command4"];
2291 ["upload"; "test-command"; "/command4/test-command"];
2292 ["chmod"; "0o755"; "/command4/test-command"];
2293 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2294 InitScratchFS, Always, TestOutput (
2295 [["mkdir"; "/command5"];
2296 ["upload"; "test-command"; "/command5/test-command"];
2297 ["chmod"; "0o755"; "/command5/test-command"];
2298 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2299 InitScratchFS, Always, TestOutput (
2300 [["mkdir"; "/command6"];
2301 ["upload"; "test-command"; "/command6/test-command"];
2302 ["chmod"; "0o755"; "/command6/test-command"];
2303 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2304 InitScratchFS, Always, TestOutput (
2305 [["mkdir"; "/command7"];
2306 ["upload"; "test-command"; "/command7/test-command"];
2307 ["chmod"; "0o755"; "/command7/test-command"];
2308 ["command"; "/command7/test-command 7"]], "");
2309 InitScratchFS, Always, TestOutput (
2310 [["mkdir"; "/command8"];
2311 ["upload"; "test-command"; "/command8/test-command"];
2312 ["chmod"; "0o755"; "/command8/test-command"];
2313 ["command"; "/command8/test-command 8"]], "\n");
2314 InitScratchFS, Always, TestOutput (
2315 [["mkdir"; "/command9"];
2316 ["upload"; "test-command"; "/command9/test-command"];
2317 ["chmod"; "0o755"; "/command9/test-command"];
2318 ["command"; "/command9/test-command 9"]], "\n\n");
2319 InitScratchFS, Always, TestOutput (
2320 [["mkdir"; "/command10"];
2321 ["upload"; "test-command"; "/command10/test-command"];
2322 ["chmod"; "0o755"; "/command10/test-command"];
2323 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2324 InitScratchFS, Always, TestOutput (
2325 [["mkdir"; "/command11"];
2326 ["upload"; "test-command"; "/command11/test-command"];
2327 ["chmod"; "0o755"; "/command11/test-command"];
2328 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2329 InitScratchFS, Always, TestLastFail (
2330 [["mkdir"; "/command12"];
2331 ["upload"; "test-command"; "/command12/test-command"];
2332 ["chmod"; "0o755"; "/command12/test-command"];
2333 ["command"; "/command12/test-command"]])],
2334 "run a command from the guest filesystem",
2336 This call runs a command from the guest filesystem. The
2337 filesystem must be mounted, and must contain a compatible
2338 operating system (ie. something Linux, with the same
2339 or compatible processor architecture).
2341 The single parameter is an argv-style list of arguments.
2342 The first element is the name of the program to run.
2343 Subsequent elements are parameters. The list must be
2344 non-empty (ie. must contain a program name). Note that
2345 the command runs directly, and is I<not> invoked via
2346 the shell (see C<guestfs_sh>).
2348 The return value is anything printed to I<stdout> by
2351 If the command returns a non-zero exit status, then
2352 this function returns an error message. The error message
2353 string is the content of I<stderr> from the command.
2355 The C<$PATH> environment variable will contain at least
2356 C</usr/bin> and C</bin>. If you require a program from
2357 another location, you should provide the full path in the
2360 Shared libraries and data files required by the program
2361 must be available on filesystems which are mounted in the
2362 correct places. It is the caller's responsibility to ensure
2363 all filesystems that are needed are mounted at the right
2366 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2367 [InitScratchFS, Always, TestOutputList (
2368 [["mkdir"; "/command_lines"];
2369 ["upload"; "test-command"; "/command_lines/test-command"];
2370 ["chmod"; "0o755"; "/command_lines/test-command"];
2371 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2372 InitScratchFS, Always, TestOutputList (
2373 [["mkdir"; "/command_lines2"];
2374 ["upload"; "test-command"; "/command_lines2/test-command"];
2375 ["chmod"; "0o755"; "/command_lines2/test-command"];
2376 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2377 InitScratchFS, Always, TestOutputList (
2378 [["mkdir"; "/command_lines3"];
2379 ["upload"; "test-command"; "/command_lines3/test-command"];
2380 ["chmod"; "0o755"; "/command_lines3/test-command"];
2381 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2382 InitScratchFS, Always, TestOutputList (
2383 [["mkdir"; "/command_lines4"];
2384 ["upload"; "test-command"; "/command_lines4/test-command"];
2385 ["chmod"; "0o755"; "/command_lines4/test-command"];
2386 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2387 InitScratchFS, Always, TestOutputList (
2388 [["mkdir"; "/command_lines5"];
2389 ["upload"; "test-command"; "/command_lines5/test-command"];
2390 ["chmod"; "0o755"; "/command_lines5/test-command"];
2391 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2392 InitScratchFS, Always, TestOutputList (
2393 [["mkdir"; "/command_lines6"];
2394 ["upload"; "test-command"; "/command_lines6/test-command"];
2395 ["chmod"; "0o755"; "/command_lines6/test-command"];
2396 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2397 InitScratchFS, Always, TestOutputList (
2398 [["mkdir"; "/command_lines7"];
2399 ["upload"; "test-command"; "/command_lines7/test-command"];
2400 ["chmod"; "0o755"; "/command_lines7/test-command"];
2401 ["command_lines"; "/command_lines7/test-command 7"]], []);
2402 InitScratchFS, Always, TestOutputList (
2403 [["mkdir"; "/command_lines8"];
2404 ["upload"; "test-command"; "/command_lines8/test-command"];
2405 ["chmod"; "0o755"; "/command_lines8/test-command"];
2406 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2407 InitScratchFS, Always, TestOutputList (
2408 [["mkdir"; "/command_lines9"];
2409 ["upload"; "test-command"; "/command_lines9/test-command"];
2410 ["chmod"; "0o755"; "/command_lines9/test-command"];
2411 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2412 InitScratchFS, Always, TestOutputList (
2413 [["mkdir"; "/command_lines10"];
2414 ["upload"; "test-command"; "/command_lines10/test-command"];
2415 ["chmod"; "0o755"; "/command_lines10/test-command"];
2416 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2417 InitScratchFS, Always, TestOutputList (
2418 [["mkdir"; "/command_lines11"];
2419 ["upload"; "test-command"; "/command_lines11/test-command"];
2420 ["chmod"; "0o755"; "/command_lines11/test-command"];
2421 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2422 "run a command, returning lines",
2424 This is the same as C<guestfs_command>, but splits the
2425 result into a list of lines.
2427 See also: C<guestfs_sh_lines>");
2429 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2430 [InitISOFS, Always, TestOutputStruct (
2431 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2432 "get file information",
2434 Returns file information for the given C<path>.
2436 This is the same as the C<stat(2)> system call.");
2438 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2439 [InitISOFS, Always, TestOutputStruct (
2440 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2441 "get file information for a symbolic link",
2443 Returns file information for the given C<path>.
2445 This is the same as C<guestfs_stat> except that if C<path>
2446 is a symbolic link, then the link is stat-ed, not the file it
2449 This is the same as the C<lstat(2)> system call.");
2451 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2452 [InitISOFS, Always, TestOutputStruct (
2453 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2454 "get file system statistics",
2456 Returns file system statistics for any mounted file system.
2457 C<path> should be a file or directory in the mounted file system
2458 (typically it is the mount point itself, but it doesn't need to be).
2460 This is the same as the C<statvfs(2)> system call.");
2462 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2464 "get ext2/ext3/ext4 superblock details",
2466 This returns the contents of the ext2, ext3 or ext4 filesystem
2467 superblock on C<device>.
2469 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2470 manpage for more details. The list of fields returned isn't
2471 clearly defined, and depends on both the version of C<tune2fs>
2472 that libguestfs was built against, and the filesystem itself.");
2474 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2475 [InitEmpty, Always, TestOutputTrue (
2476 [["blockdev_setro"; "/dev/sda"];
2477 ["blockdev_getro"; "/dev/sda"]])],
2478 "set block device to read-only",
2480 Sets the block device named C<device> to read-only.
2482 This uses the L<blockdev(8)> command.");
2484 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2485 [InitEmpty, Always, TestOutputFalse (
2486 [["blockdev_setrw"; "/dev/sda"];
2487 ["blockdev_getro"; "/dev/sda"]])],
2488 "set block device to read-write",
2490 Sets the block device named C<device> to read-write.
2492 This uses the L<blockdev(8)> command.");
2494 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2495 [InitEmpty, Always, TestOutputTrue (
2496 [["blockdev_setro"; "/dev/sda"];
2497 ["blockdev_getro"; "/dev/sda"]])],
2498 "is block device set to read-only",
2500 Returns a boolean indicating if the block device is read-only
2501 (true if read-only, false if not).
2503 This uses the L<blockdev(8)> command.");
2505 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2506 [InitEmpty, Always, TestOutputInt (
2507 [["blockdev_getss"; "/dev/sda"]], 512)],
2508 "get sectorsize of block device",
2510 This returns the size of sectors on a block device.
2511 Usually 512, but can be larger for modern devices.
2513 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2516 This uses the L<blockdev(8)> command.");
2518 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2519 [InitEmpty, Always, TestOutputInt (
2520 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2521 "get blocksize of block device",
2523 This returns the block size of a device.
2525 (Note this is different from both I<size in blocks> and
2526 I<filesystem block size>).
2528 This uses the L<blockdev(8)> command.");
2530 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2532 "set blocksize of block device",
2534 This sets the block size of a device.
2536 (Note this is different from both I<size in blocks> and
2537 I<filesystem block size>).
2539 This uses the L<blockdev(8)> command.");
2541 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2542 [InitEmpty, Always, TestOutputInt (
2543 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2544 "get total size of device in 512-byte sectors",
2546 This returns the size of the device in units of 512-byte sectors
2547 (even if the sectorsize isn't 512 bytes ... weird).
2549 See also C<guestfs_blockdev_getss> for the real sector size of
2550 the device, and C<guestfs_blockdev_getsize64> for the more
2551 useful I<size in bytes>.
2553 This uses the L<blockdev(8)> command.");
2555 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2556 [InitEmpty, Always, TestOutputInt (
2557 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2558 "get total size of device in bytes",
2560 This returns the size of the device in bytes.
2562 See also C<guestfs_blockdev_getsz>.
2564 This uses the L<blockdev(8)> command.");
2566 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2567 [InitEmpty, Always, TestRun
2568 [["blockdev_flushbufs"; "/dev/sda"]]],
2569 "flush device buffers",
2571 This tells the kernel to flush internal buffers associated
2574 This uses the L<blockdev(8)> command.");
2576 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2577 [InitEmpty, Always, TestRun
2578 [["blockdev_rereadpt"; "/dev/sda"]]],
2579 "reread partition table",
2581 Reread the partition table on C<device>.
2583 This uses the L<blockdev(8)> command.");
2585 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2586 [InitScratchFS, Always, TestOutput (
2587 (* Pick a file from cwd which isn't likely to change. *)
2588 [["mkdir"; "/upload"];
2589 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2590 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2591 Digest.to_hex (Digest.file "COPYING.LIB"))],
2592 "upload a file from the local machine",
2594 Upload local file C<filename> to C<remotefilename> on the
2597 C<filename> can also be a named pipe.
2599 See also C<guestfs_download>.");
2601 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2602 [InitScratchFS, Always, TestOutput (
2603 (* Pick a file from cwd which isn't likely to change. *)
2604 [["mkdir"; "/download"];
2605 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2606 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2607 ["upload"; "testdownload.tmp"; "/download/upload"];
2608 ["checksum"; "md5"; "/download/upload"]],
2609 Digest.to_hex (Digest.file "COPYING.LIB"))],
2610 "download a file to the local machine",
2612 Download file C<remotefilename> and save it as C<filename>
2613 on the local machine.
2615 C<filename> can also be a named pipe.
2617 See also C<guestfs_upload>, C<guestfs_cat>.");
2619 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2620 [InitISOFS, Always, TestOutput (
2621 [["checksum"; "crc"; "/known-3"]], "2891671662");
2622 InitISOFS, Always, TestLastFail (
2623 [["checksum"; "crc"; "/notexists"]]);
2624 InitISOFS, Always, TestOutput (
2625 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2626 InitISOFS, Always, TestOutput (
2627 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2628 InitISOFS, Always, TestOutput (
2629 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2630 InitISOFS, Always, TestOutput (
2631 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2632 InitISOFS, Always, TestOutput (
2633 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2634 InitISOFS, Always, TestOutput (
2635 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2636 (* Test for RHBZ#579608, absolute symbolic links. *)
2637 InitISOFS, Always, TestOutput (
2638 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2639 "compute MD5, SHAx or CRC checksum of file",
2641 This call computes the MD5, SHAx or CRC checksum of the
2644 The type of checksum to compute is given by the C<csumtype>
2645 parameter which must have one of the following values:
2651 Compute the cyclic redundancy check (CRC) specified by POSIX
2652 for the C<cksum> command.
2656 Compute the MD5 hash (using the C<md5sum> program).
2660 Compute the SHA1 hash (using the C<sha1sum> program).
2664 Compute the SHA224 hash (using the C<sha224sum> program).
2668 Compute the SHA256 hash (using the C<sha256sum> program).
2672 Compute the SHA384 hash (using the C<sha384sum> program).
2676 Compute the SHA512 hash (using the C<sha512sum> program).
2680 The checksum is returned as a printable string.
2682 To get the checksum for a device, use C<guestfs_checksum_device>.
2684 To get the checksums for many files, use C<guestfs_checksums_out>.");
2686 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2687 [InitScratchFS, Always, TestOutput (
2688 [["mkdir"; "/tar_in"];
2689 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2690 ["cat"; "/tar_in/hello"]], "hello\n")],
2691 "unpack tarfile to directory",
2693 This command uploads and unpacks local file C<tarfile> (an
2694 I<uncompressed> tar file) into C<directory>.
2696 To upload a compressed tarball, use C<guestfs_tgz_in>
2697 or C<guestfs_txz_in>.");
2699 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2701 "pack directory into tarfile",
2703 This command packs the contents of C<directory> and downloads
2704 it to local file C<tarfile>.
2706 To download a compressed tarball, use C<guestfs_tgz_out>
2707 or C<guestfs_txz_out>.");
2709 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2710 [InitScratchFS, Always, TestOutput (
2711 [["mkdir"; "/tgz_in"];
2712 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2713 ["cat"; "/tgz_in/hello"]], "hello\n")],
2714 "unpack compressed tarball to directory",
2716 This command uploads and unpacks local file C<tarball> (a
2717 I<gzip compressed> tar file) into C<directory>.
2719 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2721 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2723 "pack directory into compressed tarball",
2725 This command packs the contents of C<directory> and downloads
2726 it to local file C<tarball>.
2728 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2730 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2731 [InitBasicFS, Always, TestLastFail (
2733 ["mount_ro"; "/dev/sda1"; "/"];
2734 ["touch"; "/new"]]);
2735 InitBasicFS, Always, TestOutput (
2736 [["write"; "/new"; "data"];
2738 ["mount_ro"; "/dev/sda1"; "/"];
2739 ["cat"; "/new"]], "data")],
2740 "mount a guest disk, read-only",
2742 This is the same as the C<guestfs_mount> command, but it
2743 mounts the filesystem with the read-only (I<-o ro>) flag.");
2745 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2747 "mount a guest disk with mount options",
2749 This is the same as the C<guestfs_mount> command, but it
2750 allows you to set the mount options as for the
2751 L<mount(8)> I<-o> flag.
2753 If the C<options> parameter is an empty string, then
2754 no options are passed (all options default to whatever
2755 the filesystem uses).");
2757 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2759 "mount a guest disk with mount options and vfstype",
2761 This is the same as the C<guestfs_mount> command, but it
2762 allows you to set both the mount options and the vfstype
2763 as for the L<mount(8)> I<-o> and I<-t> flags.");
2765 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2767 "debugging and internals",
2769 The C<guestfs_debug> command exposes some internals of
2770 C<guestfsd> (the guestfs daemon) that runs inside the
2773 There is no comprehensive help for this command. You have
2774 to look at the file C<daemon/debug.c> in the libguestfs source
2775 to find out what you can do.");
2777 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2778 [InitEmpty, Always, TestOutputList (
2779 [["part_disk"; "/dev/sda"; "mbr"];
2780 ["pvcreate"; "/dev/sda1"];
2781 ["vgcreate"; "VG"; "/dev/sda1"];
2782 ["lvcreate"; "LV1"; "VG"; "50"];
2783 ["lvcreate"; "LV2"; "VG"; "50"];
2784 ["lvremove"; "/dev/VG/LV1"];
2785 ["lvs"]], ["/dev/VG/LV2"]);
2786 InitEmpty, Always, TestOutputList (
2787 [["part_disk"; "/dev/sda"; "mbr"];
2788 ["pvcreate"; "/dev/sda1"];
2789 ["vgcreate"; "VG"; "/dev/sda1"];
2790 ["lvcreate"; "LV1"; "VG"; "50"];
2791 ["lvcreate"; "LV2"; "VG"; "50"];
2792 ["lvremove"; "/dev/VG"];
2794 InitEmpty, Always, TestOutputList (
2795 [["part_disk"; "/dev/sda"; "mbr"];
2796 ["pvcreate"; "/dev/sda1"];
2797 ["vgcreate"; "VG"; "/dev/sda1"];
2798 ["lvcreate"; "LV1"; "VG"; "50"];
2799 ["lvcreate"; "LV2"; "VG"; "50"];
2800 ["lvremove"; "/dev/VG"];
2802 "remove an LVM logical volume",
2804 Remove an LVM logical volume C<device>, where C<device> is
2805 the path to the LV, such as C</dev/VG/LV>.
2807 You can also remove all LVs in a volume group by specifying
2808 the VG name, C</dev/VG>.");
2810 ("vgremove", (RErr, [String "vgname"], []), 78, [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"];
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"];
2827 "remove an LVM volume group",
2829 Remove an LVM volume group C<vgname>, (for example C<VG>).
2831 This also forcibly removes all logical volumes in the volume
2834 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2835 [InitEmpty, Always, TestOutputListOfDevices (
2836 [["part_disk"; "/dev/sda"; "mbr"];
2837 ["pvcreate"; "/dev/sda1"];
2838 ["vgcreate"; "VG"; "/dev/sda1"];
2839 ["lvcreate"; "LV1"; "VG"; "50"];
2840 ["lvcreate"; "LV2"; "VG"; "50"];
2842 ["pvremove"; "/dev/sda1"];
2844 InitEmpty, Always, TestOutputListOfDevices (
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"];
2851 ["pvremove"; "/dev/sda1"];
2853 InitEmpty, Always, TestOutputListOfDevices (
2854 [["part_disk"; "/dev/sda"; "mbr"];
2855 ["pvcreate"; "/dev/sda1"];
2856 ["vgcreate"; "VG"; "/dev/sda1"];
2857 ["lvcreate"; "LV1"; "VG"; "50"];
2858 ["lvcreate"; "LV2"; "VG"; "50"];
2860 ["pvremove"; "/dev/sda1"];
2862 "remove an LVM physical volume",
2864 This wipes a physical volume C<device> so that LVM will no longer
2867 The implementation uses the C<pvremove> command which refuses to
2868 wipe physical volumes that contain any volume groups, so you have
2869 to remove those first.");
2871 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2872 [InitBasicFS, Always, TestOutput (
2873 [["set_e2label"; "/dev/sda1"; "testlabel"];
2874 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2875 "set the ext2/3/4 filesystem label",
2877 This sets the ext2/3/4 filesystem label of the filesystem on
2878 C<device> to C<label>. Filesystem labels are limited to
2881 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2882 to return the existing label on a filesystem.");
2884 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2886 "get the ext2/3/4 filesystem label",
2888 This returns the ext2/3/4 filesystem label of the filesystem on
2891 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2892 (let uuid = uuidgen () in
2893 [InitBasicFS, Always, TestOutput (
2894 [["set_e2uuid"; "/dev/sda1"; uuid];
2895 ["get_e2uuid"; "/dev/sda1"]], uuid);
2896 InitBasicFS, Always, TestOutput (
2897 [["set_e2uuid"; "/dev/sda1"; "clear"];
2898 ["get_e2uuid"; "/dev/sda1"]], "");
2899 (* We can't predict what UUIDs will be, so just check the commands run. *)
2900 InitBasicFS, Always, TestRun (
2901 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2902 InitBasicFS, Always, TestRun (
2903 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2904 "set the ext2/3/4 filesystem UUID",
2906 This sets the ext2/3/4 filesystem UUID of the filesystem on
2907 C<device> to C<uuid>. The format of the UUID and alternatives
2908 such as C<clear>, C<random> and C<time> are described in the
2909 L<tune2fs(8)> manpage.
2911 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2912 to return the existing UUID of a filesystem.");
2914 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2915 (* Regression test for RHBZ#597112. *)
2916 (let uuid = uuidgen () in
2917 [InitNone, Always, TestOutput (
2918 [["mke2journal"; "1024"; "/dev/sdc"];
2919 ["set_e2uuid"; "/dev/sdc"; uuid];
2920 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2921 "get the ext2/3/4 filesystem UUID",
2923 This returns the ext2/3/4 filesystem UUID of the filesystem on
2926 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2927 [InitBasicFS, Always, TestOutputInt (
2928 [["umount"; "/dev/sda1"];
2929 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2930 InitBasicFS, Always, TestOutputInt (
2931 [["umount"; "/dev/sda1"];
2932 ["zero"; "/dev/sda1"];
2933 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2934 "run the filesystem checker",
2936 This runs the filesystem checker (fsck) on C<device> which
2937 should have filesystem type C<fstype>.
2939 The returned integer is the status. See L<fsck(8)> for the
2940 list of status codes from C<fsck>.
2948 Multiple status codes can be summed together.
2952 A non-zero return code can mean \"success\", for example if
2953 errors have been corrected on the filesystem.
2957 Checking or repairing NTFS volumes is not supported
2962 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2964 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2965 [InitBasicFS, Always, TestRun (
2966 [["umount"; "/dev/sda1"];
2967 ["zero"; "/dev/sda1"]])],
2968 "write zeroes to the device",
2970 This command writes zeroes over the first few blocks of C<device>.
2972 How many blocks are zeroed isn't specified (but it's I<not> enough
2973 to securely wipe the device). It should be sufficient to remove
2974 any partition tables, filesystem superblocks and so on.
2976 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2978 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2980 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2981 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2983 [InitBasicFS, Always, TestOutputTrue (
2984 [["mkdir_p"; "/boot/grub"];
2985 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2986 ["grub_install"; "/"; "/dev/vda"];
2987 ["is_dir"; "/boot"]])],
2990 This command installs GRUB (the Grand Unified Bootloader) on
2991 C<device>, with the root directory being C<root>.
2993 Note: If grub-install reports the error
2994 \"No suitable drive was found in the generated device map.\"
2995 it may be that you need to create a C</boot/grub/device.map>
2996 file first that contains the mapping between grub device names
2997 and Linux device names. It is usually sufficient to create
3002 replacing C</dev/vda> with the name of the installation device.");
3004 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3005 [InitScratchFS, Always, TestOutput (
3007 ["write"; "/cp/old"; "file content"];
3008 ["cp"; "/cp/old"; "/cp/new"];
3009 ["cat"; "/cp/new"]], "file content");
3010 InitScratchFS, Always, TestOutputTrue (
3012 ["write"; "/cp2/old"; "file content"];
3013 ["cp"; "/cp2/old"; "/cp2/new"];
3014 ["is_file"; "/cp2/old"]]);
3015 InitScratchFS, Always, TestOutput (
3017 ["write"; "/cp3/old"; "file content"];
3018 ["mkdir"; "/cp3/dir"];
3019 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3020 ["cat"; "/cp3/dir/new"]], "file content")],
3023 This copies a file from C<src> to C<dest> where C<dest> is
3024 either a destination filename or destination directory.");
3026 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3027 [InitScratchFS, Always, TestOutput (
3028 [["mkdir"; "/cp_a1"];
3029 ["mkdir"; "/cp_a2"];
3030 ["write"; "/cp_a1/file"; "file content"];
3031 ["cp_a"; "/cp_a1"; "/cp_a2"];
3032 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3033 "copy a file or directory recursively",
3035 This copies a file or directory from C<src> to C<dest>
3036 recursively using the C<cp -a> command.");
3038 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3039 [InitScratchFS, Always, TestOutput (
3041 ["write"; "/mv/old"; "file content"];
3042 ["mv"; "/mv/old"; "/mv/new"];
3043 ["cat"; "/mv/new"]], "file content");
3044 InitScratchFS, Always, TestOutputFalse (
3046 ["write"; "/mv2/old"; "file content"];
3047 ["mv"; "/mv2/old"; "/mv2/new"];
3048 ["is_file"; "/mv2/old"]])],
3051 This moves a file from C<src> to C<dest> where C<dest> is
3052 either a destination filename or destination directory.");
3054 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3055 [InitEmpty, Always, TestRun (
3056 [["drop_caches"; "3"]])],
3057 "drop kernel page cache, dentries and inodes",
3059 This instructs the guest kernel to drop its page cache,
3060 and/or dentries and inode caches. The parameter C<whattodrop>
3061 tells the kernel what precisely to drop, see
3062 L<http://linux-mm.org/Drop_Caches>
3064 Setting C<whattodrop> to 3 should drop everything.
3066 This automatically calls L<sync(2)> before the operation,
3067 so that the maximum guest memory is freed.");
3069 ("dmesg", (RString "kmsgs", [], []), 91, [],
3070 [InitEmpty, Always, TestRun (
3072 "return kernel messages",
3074 This returns the kernel messages (C<dmesg> output) from
3075 the guest kernel. This is sometimes useful for extended
3076 debugging of problems.
3078 Another way to get the same information is to enable
3079 verbose messages with C<guestfs_set_verbose> or by setting
3080 the environment variable C<LIBGUESTFS_DEBUG=1> before
3081 running the program.");
3083 ("ping_daemon", (RErr, [], []), 92, [],
3084 [InitEmpty, Always, TestRun (
3085 [["ping_daemon"]])],
3086 "ping the guest daemon",
3088 This is a test probe into the guestfs daemon running inside
3089 the qemu subprocess. Calling this function checks that the
3090 daemon responds to the ping message, without affecting the daemon
3091 or attached block device(s) in any other way.");
3093 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3094 [InitScratchFS, Always, TestOutputTrue (
3095 [["mkdir"; "/equal"];
3096 ["write"; "/equal/file1"; "contents of a file"];
3097 ["cp"; "/equal/file1"; "/equal/file2"];
3098 ["equal"; "/equal/file1"; "/equal/file2"]]);
3099 InitScratchFS, Always, TestOutputFalse (
3100 [["mkdir"; "/equal2"];
3101 ["write"; "/equal2/file1"; "contents of a file"];
3102 ["write"; "/equal2/file2"; "contents of another file"];
3103 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3104 InitScratchFS, Always, TestLastFail (
3105 [["mkdir"; "/equal3"];
3106 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3107 "test if two files have equal contents",
3109 This compares the two files C<file1> and C<file2> and returns
3110 true if their content is exactly equal, or false otherwise.
3112 The external L<cmp(1)> program is used for the comparison.");
3114 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3115 [InitISOFS, Always, TestOutputList (
3116 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3117 InitISOFS, Always, TestOutputList (
3118 [["strings"; "/empty"]], []);
3119 (* Test for RHBZ#579608, absolute symbolic links. *)
3120 InitISOFS, Always, TestRun (
3121 [["strings"; "/abssymlink"]])],
3122 "print the printable strings in a file",
3124 This runs the L<strings(1)> command on a file and returns
3125 the list of printable strings found.");
3127 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3128 [InitISOFS, Always, TestOutputList (
3129 [["strings_e"; "b"; "/known-5"]], []);
3130 InitScratchFS, Always, TestOutputList (
3131 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3132 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3133 "print the printable strings in a file",
3135 This is like the C<guestfs_strings> command, but allows you to
3136 specify the encoding of strings that are looked for in
3137 the source file C<path>.
3139 Allowed encodings are:
3145 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3146 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3150 Single 8-bit-byte characters.
3154 16-bit big endian strings such as those encoded in
3155 UTF-16BE or UCS-2BE.
3157 =item l (lower case letter L)
3159 16-bit little endian such as UTF-16LE and UCS-2LE.
3160 This is useful for examining binaries in Windows guests.
3164 32-bit big endian such as UCS-4BE.
3168 32-bit little endian such as UCS-4LE.
3172 The returned strings are transcoded to UTF-8.");
3174 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3175 [InitISOFS, Always, TestOutput (
3176 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3177 (* Test for RHBZ#501888c2 regression which caused large hexdump
3178 * commands to segfault.
3180 InitISOFS, Always, TestRun (
3181 [["hexdump"; "/100krandom"]]);
3182 (* Test for RHBZ#579608, absolute symbolic links. *)
3183 InitISOFS, Always, TestRun (
3184 [["hexdump"; "/abssymlink"]])],
3185 "dump a file in hexadecimal",
3187 This runs C<hexdump -C> on the given C<path>. The result is
3188 the human-readable, canonical hex dump of the file.");
3190 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3191 [InitNone, Always, TestOutput (
3192 [["part_disk"; "/dev/sda"; "mbr"];
3193 ["mkfs"; "ext3"; "/dev/sda1"];
3194 ["mount_options"; ""; "/dev/sda1"; "/"];
3195 ["write"; "/new"; "test file"];
3196 ["umount"; "/dev/sda1"];
3197 ["zerofree"; "/dev/sda1"];
3198 ["mount_options"; ""; "/dev/sda1"; "/"];
3199 ["cat"; "/new"]], "test file")],
3200 "zero unused inodes and disk blocks on ext2/3 filesystem",
3202 This runs the I<zerofree> program on C<device>. This program
3203 claims to zero unused inodes and disk blocks on an ext2/3
3204 filesystem, thus making it possible to compress the filesystem
3207 You should B<not> run this program if the filesystem is
3210 It is possible that using this program can damage the filesystem
3211 or data on the filesystem.");
3213 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3215 "resize an LVM physical volume",
3217 This resizes (expands or shrinks) an existing LVM physical
3218 volume to match the new size of the underlying device.");
3220 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3221 Int "cyls"; Int "heads"; Int "sectors";
3222 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3224 "modify a single partition on a block device",
3226 This runs L<sfdisk(8)> option to modify just the single
3227 partition C<n> (note: C<n> counts from 1).
3229 For other parameters, see C<guestfs_sfdisk>. You should usually
3230 pass C<0> for the cyls/heads/sectors parameters.
3232 See also: C<guestfs_part_add>");
3234 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3236 "display the partition table",
3238 This displays the partition table on C<device>, in the
3239 human-readable output of the L<sfdisk(8)> command. It is
3240 not intended to be parsed.
3242 See also: C<guestfs_part_list>");
3244 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3246 "display the kernel geometry",
3248 This displays the kernel's idea of the geometry of C<device>.
3250 The result is in human-readable format, and not designed to
3253 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3255 "display the disk geometry from the partition table",
3257 This displays the disk geometry of C<device> read from the
3258 partition table. Especially in the case where the underlying
3259 block device has been resized, this can be different from the
3260 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3262 The result is in human-readable format, and not designed to
3265 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3267 "activate or deactivate all volume groups",
3269 This command activates or (if C<activate> is false) deactivates
3270 all logical volumes in all volume groups.
3271 If activated, then they are made known to the
3272 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3273 then those devices disappear.
3275 This command is the same as running C<vgchange -a y|n>");
3277 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3279 "activate or deactivate some volume groups",
3281 This command activates or (if C<activate> is false) deactivates
3282 all logical volumes in the listed volume groups C<volgroups>.
3283 If activated, then they are made known to the
3284 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3285 then those devices disappear.
3287 This command is the same as running C<vgchange -a y|n volgroups...>
3289 Note that if C<volgroups> is an empty list then B<all> volume groups
3290 are activated or deactivated.");
3292 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3293 [InitNone, Always, TestOutput (
3294 [["part_disk"; "/dev/sda"; "mbr"];
3295 ["pvcreate"; "/dev/sda1"];
3296 ["vgcreate"; "VG"; "/dev/sda1"];
3297 ["lvcreate"; "LV"; "VG"; "10"];
3298 ["mkfs"; "ext2"; "/dev/VG/LV"];
3299 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3300 ["write"; "/new"; "test content"];
3302 ["lvresize"; "/dev/VG/LV"; "20"];
3303 ["e2fsck_f"; "/dev/VG/LV"];
3304 ["resize2fs"; "/dev/VG/LV"];
3305 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3306 ["cat"; "/new"]], "test content");
3307 InitNone, Always, TestRun (
3308 (* Make an LV smaller to test RHBZ#587484. *)
3309 [["part_disk"; "/dev/sda"; "mbr"];
3310 ["pvcreate"; "/dev/sda1"];
3311 ["vgcreate"; "VG"; "/dev/sda1"];
3312 ["lvcreate"; "LV"; "VG"; "20"];
3313 ["lvresize"; "/dev/VG/LV"; "10"]])],
3314 "resize an LVM logical volume",
3316 This resizes (expands or shrinks) an existing LVM logical
3317 volume to C<mbytes>. When reducing, data in the reduced part
3320 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3321 [], (* lvresize tests this *)
3322 "resize an ext2, ext3 or ext4 filesystem",
3324 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3325 the underlying device.
3327 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3328 on the C<device> before calling this command. For unknown reasons
3329 C<resize2fs> sometimes gives an error about this and sometimes not.
3330 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3331 calling this function.");
3333 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3334 [InitBasicFS, Always, TestOutputList (
3335 [["find"; "/"]], ["lost+found"]);
3336 InitBasicFS, Always, TestOutputList (
3340 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3341 InitScratchFS, Always, TestOutputList (
3342 [["mkdir_p"; "/find/b/c"];
3343 ["touch"; "/find/b/c/d"];
3344 ["find"; "/find/b/"]], ["c"; "c/d"])],
3345 "find all files and directories",
3347 This command lists out all files and directories, recursively,
3348 starting at C<directory>. It is essentially equivalent to
3349 running the shell command C<find directory -print> but some
3350 post-processing happens on the output, described below.
3352 This returns a list of strings I<without any prefix>. Thus
3353 if the directory structure was:
3359 then the returned list from C<guestfs_find> C</tmp> would be
3367 If C<directory> is not a directory, then this command returns
3370 The returned list is sorted.
3372 See also C<guestfs_find0>.");
3374 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3375 [], (* lvresize tests this *)
3376 "check an ext2/ext3 filesystem",
3378 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3379 filesystem checker on C<device>, noninteractively (I<-p>),
3380 even if the filesystem appears to be clean (I<-f>).
3382 This command is only needed because of C<guestfs_resize2fs>
3383 (q.v.). Normally you should use C<guestfs_fsck>.");
3385 ("sleep", (RErr, [Int "secs"], []), 109, [],
3386 [InitNone, Always, TestRun (
3388 "sleep for some seconds",
3390 Sleep for C<secs> seconds.");
3392 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3393 [InitNone, Always, TestOutputInt (
3394 [["part_disk"; "/dev/sda"; "mbr"];
3395 ["mkfs"; "ntfs"; "/dev/sda1"];
3396 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3397 InitNone, Always, TestOutputInt (
3398 [["part_disk"; "/dev/sda"; "mbr"];
3399 ["mkfs"; "ext2"; "/dev/sda1"];
3400 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3401 "probe NTFS volume",
3403 This command runs the L<ntfs-3g.probe(8)> command which probes
3404 an NTFS C<device> for mountability. (Not all NTFS volumes can
3405 be mounted read-write, and some cannot be mounted at all).
3407 C<rw> is a boolean flag. Set it to true if you want to test
3408 if the volume can be mounted read-write. Set it to false if
3409 you want to test if the volume can be mounted read-only.
3411 The return value is an integer which C<0> if the operation
3412 would succeed, or some non-zero value documented in the
3413 L<ntfs-3g.probe(8)> manual page.");
3415 ("sh", (RString "output", [String "command"], []), 111, [],
3416 [], (* XXX needs tests *)
3417 "run a command via the shell",
3419 This call runs a command from the guest filesystem via the
3422 This is like C<guestfs_command>, but passes the command to:
3424 /bin/sh -c \"command\"
3426 Depending on the guest's shell, this usually results in
3427 wildcards being expanded, shell expressions being interpolated
3430 All the provisos about C<guestfs_command> apply to this call.");
3432 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3433 [], (* XXX needs tests *)
3434 "run a command via the shell returning lines",
3436 This is the same as C<guestfs_sh>, but splits the result
3437 into a list of lines.
3439 See also: C<guestfs_command_lines>");
3441 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3442 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3443 * code in stubs.c, since all valid glob patterns must start with "/".
3444 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3446 [InitScratchFS, Always, TestOutputList (
3447 [["mkdir_p"; "/glob_expand/b/c"];
3448 ["touch"; "/glob_expand/b/c/d"];
3449 ["touch"; "/glob_expand/b/c/e"];
3450 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3451 InitScratchFS, Always, TestOutputList (
3452 [["mkdir_p"; "/glob_expand2/b/c"];
3453 ["touch"; "/glob_expand2/b/c/d"];
3454 ["touch"; "/glob_expand2/b/c/e"];
3455 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3456 InitScratchFS, Always, TestOutputList (
3457 [["mkdir_p"; "/glob_expand3/b/c"];
3458 ["touch"; "/glob_expand3/b/c/d"];
3459 ["touch"; "/glob_expand3/b/c/e"];
3460 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3461 "expand a wildcard path",
3463 This command searches for all the pathnames matching
3464 C<pattern> according to the wildcard expansion rules
3467 If no paths match, then this returns an empty list
3468 (note: not an error).
3470 It is just a wrapper around the C L<glob(3)> function
3471 with flags C<GLOB_MARK|GLOB_BRACE>.
3472 See that manual page for more details.");
3474 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3475 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3476 [["scrub_device"; "/dev/sdc"]])],
3477 "scrub (securely wipe) a device",
3479 This command writes patterns over C<device> to make data retrieval
3482 It is an interface to the L<scrub(1)> program. See that
3483 manual page for more details.");
3485 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3486 [InitScratchFS, Always, TestRun (
3487 [["write"; "/scrub_file"; "content"];
3488 ["scrub_file"; "/scrub_file"]])],
3489 "scrub (securely wipe) a file",
3491 This command writes patterns over a file to make data retrieval
3494 The file is I<removed> after scrubbing.
3496 It is an interface to the L<scrub(1)> program. See that
3497 manual page for more details.");
3499 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3500 [], (* XXX needs testing *)
3501 "scrub (securely wipe) free space",
3503 This command creates the directory C<dir> and then fills it
3504 with files until the filesystem is full, and scrubs the files
3505 as for C<guestfs_scrub_file>, and deletes them.
3506 The intention is to scrub any free space on the partition
3509 It is an interface to the L<scrub(1)> program. See that
3510 manual page for more details.");
3512 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3513 [InitScratchFS, Always, TestRun (
3514 [["mkdir"; "/mkdtemp"];
3515 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3516 "create a temporary directory",
3518 This command creates a temporary directory. The
3519 C<template> parameter should be a full pathname for the
3520 temporary directory name with the final six characters being
3523 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3524 the second one being suitable for Windows filesystems.
3526 The name of the temporary directory that was created
3529 The temporary directory is created with mode 0700
3530 and is owned by root.
3532 The caller is responsible for deleting the temporary
3533 directory and its contents after use.
3535 See also: L<mkdtemp(3)>");
3537 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3538 [InitISOFS, Always, TestOutputInt (
3539 [["wc_l"; "/10klines"]], 10000);
3540 (* Test for RHBZ#579608, absolute symbolic links. *)
3541 InitISOFS, Always, TestOutputInt (
3542 [["wc_l"; "/abssymlink"]], 10000)],
3543 "count lines in a file",
3545 This command counts the lines in a file, using the
3546 C<wc -l> external command.");
3548 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3549 [InitISOFS, Always, TestOutputInt (
3550 [["wc_w"; "/10klines"]], 10000)],
3551 "count words in a file",
3553 This command counts the words in a file, using the
3554 C<wc -w> external command.");
3556 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3557 [InitISOFS, Always, TestOutputInt (
3558 [["wc_c"; "/100kallspaces"]], 102400)],
3559 "count characters in a file",
3561 This command counts the characters in a file, using the
3562 C<wc -c> external command.");
3564 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3565 [InitISOFS, Always, TestOutputList (
3566 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3567 (* Test for RHBZ#579608, absolute symbolic links. *)
3568 InitISOFS, Always, TestOutputList (
3569 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3570 "return first 10 lines of a file",
3572 This command returns up to the first 10 lines of a file as
3573 a list of strings.");
3575 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3576 [InitISOFS, Always, TestOutputList (
3577 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3578 InitISOFS, Always, TestOutputList (
3579 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3580 InitISOFS, Always, TestOutputList (
3581 [["head_n"; "0"; "/10klines"]], [])],
3582 "return first N lines of a file",
3584 If the parameter C<nrlines> is a positive number, this returns the first
3585 C<nrlines> lines of the file C<path>.
3587 If the parameter C<nrlines> is a negative number, this returns lines
3588 from the file C<path>, excluding the last C<nrlines> lines.
3590 If the parameter C<nrlines> is zero, this returns an empty list.");
3592 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3593 [InitISOFS, Always, TestOutputList (
3594 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3595 "return last 10 lines of a file",
3597 This command returns up to the last 10 lines of a file as
3598 a list of strings.");
3600 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3601 [InitISOFS, Always, TestOutputList (
3602 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3603 InitISOFS, Always, TestOutputList (
3604 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3605 InitISOFS, Always, TestOutputList (
3606 [["tail_n"; "0"; "/10klines"]], [])],
3607 "return last N lines of a file",
3609 If the parameter C<nrlines> is a positive number, this returns the last
3610 C<nrlines> lines of the file C<path>.
3612 If the parameter C<nrlines> is a negative number, this returns lines
3613 from the file C<path>, starting with the C<-nrlines>th line.
3615 If the parameter C<nrlines> is zero, this returns an empty list.");
3617 ("df", (RString "output", [], []), 125, [],
3618 [], (* XXX Tricky to test because it depends on the exact format
3619 * of the 'df' command and other imponderables.
3621 "report file system disk space usage",
3623 This command runs the C<df> command to report disk space used.
3625 This command is mostly useful for interactive sessions. It
3626 is I<not> intended that you try to parse the output string.
3627 Use C<guestfs_statvfs> from programs.");
3629 ("df_h", (RString "output", [], []), 126, [],
3630 [], (* XXX Tricky to test because it depends on the exact format
3631 * of the 'df' command and other imponderables.
3633 "report file system disk space usage (human readable)",
3635 This command runs the C<df -h> command to report disk space used
3636 in human-readable format.
3638 This command is mostly useful for interactive sessions. It
3639 is I<not> intended that you try to parse the output string.
3640 Use C<guestfs_statvfs> from programs.");
3642 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3643 [InitISOFS, Always, TestOutputInt (
3644 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3645 "estimate file space usage",
3647 This command runs the C<du -s> command to estimate file space
3650 C<path> can be a file or a directory. If C<path> is a directory
3651 then the estimate includes the contents of the directory and all
3652 subdirectories (recursively).
3654 The result is the estimated size in I<kilobytes>
3655 (ie. units of 1024 bytes).");
3657 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3658 [InitISOFS, Always, TestOutputList (
3659 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3660 "list files in an initrd",
3662 This command lists out files contained in an initrd.
3664 The files are listed without any initial C</> character. The
3665 files are listed in the order they appear (not necessarily
3666 alphabetical). Directory names are listed as separate items.
3668 Old Linux kernels (2.4 and earlier) used a compressed ext2
3669 filesystem as initrd. We I<only> support the newer initramfs
3670 format (compressed cpio files).");
3672 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3674 "mount a file using the loop device",
3676 This command lets you mount C<file> (a filesystem image
3677 in a file) on a mount point. It is entirely equivalent to
3678 the command C<mount -o loop file mountpoint>.");
3680 ("mkswap", (RErr, [Device "device"], []), 130, [],
3681 [InitEmpty, Always, TestRun (
3682 [["part_disk"; "/dev/sda"; "mbr"];
3683 ["mkswap"; "/dev/sda1"]])],
3684 "create a swap partition",
3686 Create a swap partition on C<device>.");
3688 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3689 [InitEmpty, Always, TestRun (
3690 [["part_disk"; "/dev/sda"; "mbr"];
3691 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3692 "create a swap partition with a label",
3694 Create a swap partition on C<device> with label C<label>.
3696 Note that you cannot attach a swap label to a block device
3697 (eg. C</dev/sda>), just to a partition. This appears to be
3698 a limitation of the kernel or swap tools.");
3700 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3701 (let uuid = uuidgen () in
3702 [InitEmpty, Always, TestRun (
3703 [["part_disk"; "/dev/sda"; "mbr"];
3704 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3705 "create a swap partition with an explicit UUID",
3707 Create a swap partition on C<device> with UUID C<uuid>.");
3709 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3710 [InitScratchFS, Always, TestOutputStruct (
3711 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3712 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3713 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3714 InitScratchFS, Always, TestOutputStruct (
3715 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3716 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3717 "make block, character or FIFO devices",
3719 This call creates block or character special devices, or
3720 named pipes (FIFOs).
3722 The C<mode> parameter should be the mode, using the standard
3723 constants. C<devmajor> and C<devminor> are the
3724 device major and minor numbers, only used when creating block
3725 and character special devices.
3727 Note that, just like L<mknod(2)>, the mode must be bitwise
3728 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3729 just creates a regular file). These constants are
3730 available in the standard Linux header files, or you can use
3731 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3732 which are wrappers around this command which bitwise OR
3733 in the appropriate constant for you.
3735 The mode actually set is affected by the umask.");
3737 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3738 [InitScratchFS, Always, TestOutputStruct (
3739 [["mkfifo"; "0o777"; "/mkfifo"];
3740 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3741 "make FIFO (named pipe)",
3743 This call creates a FIFO (named pipe) called C<path> with
3744 mode C<mode>. It is just a convenient wrapper around
3747 The mode actually set is affected by the umask.");
3749 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3750 [InitScratchFS, Always, TestOutputStruct (
3751 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3752 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3753 "make block device node",
3755 This call creates a block device node called C<path> with
3756 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3757 It is just a convenient wrapper around C<guestfs_mknod>.
3759 The mode actually set is affected by the umask.");
3761 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3762 [InitScratchFS, Always, TestOutputStruct (
3763 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3764 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3765 "make char device node",
3767 This call creates a char device node called C<path> with
3768 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3769 It is just a convenient wrapper around C<guestfs_mknod>.
3771 The mode actually set is affected by the umask.");
3773 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3774 [InitEmpty, Always, TestOutputInt (
3775 [["umask"; "0o22"]], 0o22)],
3776 "set file mode creation mask (umask)",
3778 This function sets the mask used for creating new files and
3779 device nodes to C<mask & 0777>.
3781 Typical umask values would be C<022> which creates new files
3782 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3783 C<002> which creates new files with permissions like
3784 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3786 The default umask is C<022>. This is important because it
3787 means that directories and device nodes will be created with
3788 C<0644> or C<0755> mode even if you specify C<0777>.
3790 See also C<guestfs_get_umask>,
3791 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3793 This call returns the previous umask.");
3795 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3797 "read directories entries",
3799 This returns the list of directory entries in directory C<dir>.
3801 All entries in the directory are returned, including C<.> and
3802 C<..>. The entries are I<not> sorted, but returned in the same
3803 order as the underlying filesystem.
3805 Also this call returns basic file type information about each
3806 file. The C<ftyp> field will contain one of the following characters:
3844 The L<readdir(3)> call returned a C<d_type> field with an
3849 This function is primarily intended for use by programs. To
3850 get a simple list of names, use C<guestfs_ls>. To get a printable
3851 directory for human consumption, use C<guestfs_ll>.");
3853 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3855 "create partitions on a block device",
3857 This is a simplified interface to the C<guestfs_sfdisk>
3858 command, where partition sizes are specified in megabytes
3859 only (rounded to the nearest cylinder) and you don't need
3860 to specify the cyls, heads and sectors parameters which
3861 were rarely if ever used anyway.
3863 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3864 and C<guestfs_part_disk>");
3866 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3868 "determine file type inside a compressed file",
3870 This command runs C<file> after first decompressing C<path>
3873 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3875 Since 1.0.63, use C<guestfs_file> instead which can now
3876 process compressed files.");
3878 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3880 "list extended attributes of a file or directory",
3882 This call lists the extended attributes of the file or directory
3885 At the system call level, this is a combination of the
3886 L<listxattr(2)> and L<getxattr(2)> calls.
3888 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3890 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3892 "list extended attributes of a file or directory",
3894 This is the same as C<guestfs_getxattrs>, but if C<path>
3895 is a symbolic link, then it returns the extended attributes
3896 of the link itself.");
3898 ("setxattr", (RErr, [String "xattr";
3899 String "val"; Int "vallen"; (* will be BufferIn *)
3900 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3902 "set extended attribute of a file or directory",
3904 This call sets the extended attribute named C<xattr>
3905 of the file C<path> to the value C<val> (of length C<vallen>).
3906 The value is arbitrary 8 bit data.
3908 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3910 ("lsetxattr", (RErr, [String "xattr";
3911 String "val"; Int "vallen"; (* will be BufferIn *)
3912 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3914 "set extended attribute of a file or directory",
3916 This is the same as C<guestfs_setxattr>, but if C<path>
3917 is a symbolic link, then it sets an extended attribute
3918 of the link itself.");
3920 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3922 "remove extended attribute of a file or directory",
3924 This call removes the extended attribute named C<xattr>
3925 of the file C<path>.
3927 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3929 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3931 "remove extended attribute of a file or directory",
3933 This is the same as C<guestfs_removexattr>, but if C<path>
3934 is a symbolic link, then it removes an extended attribute
3935 of the link itself.");
3937 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3941 This call is similar to C<guestfs_mounts>. That call returns
3942 a list of devices. This one returns a hash table (map) of
3943 device name to directory where the device is mounted.");
3945 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3946 (* This is a special case: while you would expect a parameter
3947 * of type "Pathname", that doesn't work, because it implies
3948 * NEED_ROOT in the generated calling code in stubs.c, and
3949 * this function cannot use NEED_ROOT.
3952 "create a mountpoint",
3954 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3955 specialized calls that can be used to create extra mountpoints
3956 before mounting the first filesystem.
3958 These calls are I<only> necessary in some very limited circumstances,
3959 mainly the case where you want to mount a mix of unrelated and/or
3960 read-only filesystems together.
3962 For example, live CDs often contain a \"Russian doll\" nest of
3963 filesystems, an ISO outer layer, with a squashfs image inside, with
3964 an ext2/3 image inside that. You can unpack this as follows
3967 add-ro Fedora-11-i686-Live.iso
3971 mkmountpoint /ext3fs
3973 mount-loop /cd/LiveOS/squashfs.img /sqsh
3974 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3976 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3978 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3979 You may get unexpected errors if you try to mix these calls. It is
3980 safest to manually unmount filesystems and remove mountpoints after use.
3982 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3983 longest first, so for this to work for manual mountpoints, you
3984 must ensure that the innermost mountpoints have the longest
3985 pathnames, as in the example code above.
3987 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3989 Autosync [see C<guestfs_set_autosync>, this is set by default on
3990 handles] can cause C<guestfs_umount_all> to be called when the handle
3991 is closed which can also trigger these issues.");
3993 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
3995 "remove a mountpoint",
3997 This calls removes a mountpoint that was previously created
3998 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3999 for full details.");
4001 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4002 [InitISOFS, Always, TestOutputBuffer (
4003 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4004 (* Test various near large, large and too large files (RHBZ#589039). *)
4005 InitScratchFS, Always, TestLastFail (
4006 [["touch"; "/read_file"];
4007 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4008 ["read_file"; "/read_file"]]);
4009 InitScratchFS, Always, TestLastFail (
4010 [["touch"; "/read_file2"];
4011 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4012 ["read_file"; "/read_file2"]]);
4013 InitScratchFS, Always, TestLastFail (
4014 [["touch"; "/read_file3"];
4015 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4016 ["read_file"; "/read_file3"]])],
4019 This calls returns the contents of the file C<path> as a
4022 Unlike C<guestfs_cat>, this function can correctly
4023 handle files that contain embedded ASCII NUL characters.
4024 However unlike C<guestfs_download>, this function is limited
4025 in the total size of file that can be handled.");
4027 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4028 [InitISOFS, Always, TestOutputList (
4029 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4030 InitISOFS, Always, TestOutputList (
4031 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4032 (* Test for RHBZ#579608, absolute symbolic links. *)
4033 InitISOFS, Always, TestOutputList (
4034 [["grep"; "nomatch"; "/abssymlink"]], [])],
4035 "return lines matching a pattern",
4037 This calls the external C<grep> program and returns the
4040 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4041 [InitISOFS, Always, TestOutputList (
4042 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4043 "return lines matching a pattern",
4045 This calls the external C<egrep> program and returns the
4048 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4049 [InitISOFS, Always, TestOutputList (
4050 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4051 "return lines matching a pattern",
4053 This calls the external C<fgrep> program and returns the
4056 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4057 [InitISOFS, Always, TestOutputList (
4058 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4059 "return lines matching a pattern",
4061 This calls the external C<grep -i> program and returns the
4064 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4065 [InitISOFS, Always, TestOutputList (
4066 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4067 "return lines matching a pattern",
4069 This calls the external C<egrep -i> program and returns the
4072 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4073 [InitISOFS, Always, TestOutputList (
4074 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4075 "return lines matching a pattern",
4077 This calls the external C<fgrep -i> program and returns the
4080 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4081 [InitISOFS, Always, TestOutputList (
4082 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4083 "return lines matching a pattern",
4085 This calls the external C<zgrep> program and returns the
4088 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4089 [InitISOFS, Always, TestOutputList (
4090 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4091 "return lines matching a pattern",
4093 This calls the external C<zegrep> program and returns the
4096 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4097 [InitISOFS, Always, TestOutputList (
4098 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4099 "return lines matching a pattern",
4101 This calls the external C<zfgrep> program and returns the
4104 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4105 [InitISOFS, Always, TestOutputList (
4106 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4107 "return lines matching a pattern",
4109 This calls the external C<zgrep -i> program and returns the
4112 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4113 [InitISOFS, Always, TestOutputList (
4114 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4115 "return lines matching a pattern",
4117 This calls the external C<zegrep -i> program and returns the
4120 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4121 [InitISOFS, Always, TestOutputList (
4122 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4123 "return lines matching a pattern",
4125 This calls the external C<zfgrep -i> program and returns the
4128 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4129 [InitISOFS, Always, TestOutput (
4130 [["realpath"; "/../directory"]], "/directory")],
4131 "canonicalized absolute pathname",
4133 Return the canonicalized absolute pathname of C<path>. The
4134 returned path has no C<.>, C<..> or symbolic link path elements.");
4136 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4137 [InitScratchFS, Always, TestOutputStruct (
4140 ["ln"; "/ln/a"; "/ln/b"];
4141 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4142 "create a hard link",
4144 This command creates a hard link using the C<ln> command.");
4146 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4147 [InitScratchFS, Always, TestOutputStruct (
4148 [["mkdir"; "/ln_f"];
4149 ["touch"; "/ln_f/a"];
4150 ["touch"; "/ln_f/b"];
4151 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4152 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4153 "create a hard link",
4155 This command creates a hard link using the C<ln -f> command.
4156 The I<-f> option removes the link (C<linkname>) if it exists already.");
4158 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4159 [InitScratchFS, Always, TestOutputStruct (
4160 [["mkdir"; "/ln_s"];
4161 ["touch"; "/ln_s/a"];
4162 ["ln_s"; "a"; "/ln_s/b"];
4163 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4164 "create a symbolic link",
4166 This command creates a symbolic link using the C<ln -s> command.");
4168 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4169 [InitScratchFS, Always, TestOutput (
4170 [["mkdir_p"; "/ln_sf/b"];
4171 ["touch"; "/ln_sf/b/c"];
4172 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4173 ["readlink"; "/ln_sf/b/c"]], "../d")],
4174 "create a symbolic link",
4176 This command creates a symbolic link using the C<ln -sf> command,
4177 The I<-f> option removes the link (C<linkname>) if it exists already.");
4179 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4180 [] (* XXX tested above *),
4181 "read the target of a symbolic link",
4183 This command reads the target of a symbolic link.");
4185 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4186 [InitScratchFS, Always, TestOutputStruct (
4187 [["fallocate"; "/fallocate"; "1000000"];
4188 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4189 "preallocate a file in the guest filesystem",
4191 This command preallocates a file (containing zero bytes) named
4192 C<path> of size C<len> bytes. If the file exists already, it
4195 Do not confuse this with the guestfish-specific
4196 C<alloc> command which allocates a file in the host and
4197 attaches it as a device.");
4199 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4200 [InitPartition, Always, TestRun (
4201 [["mkswap"; "/dev/sda1"];
4202 ["swapon_device"; "/dev/sda1"];
4203 ["swapoff_device"; "/dev/sda1"]])],
4204 "enable swap on device",
4206 This command enables the libguestfs appliance to use the
4207 swap device or partition named C<device>. The increased
4208 memory is made available for all commands, for example
4209 those run using C<guestfs_command> or C<guestfs_sh>.
4211 Note that you should not swap to existing guest swap
4212 partitions unless you know what you are doing. They may
4213 contain hibernation information, or other information that
4214 the guest doesn't want you to trash. You also risk leaking
4215 information about the host to the guest this way. Instead,
4216 attach a new host device to the guest and swap on that.");
4218 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4219 [], (* XXX tested by swapon_device *)
4220 "disable swap on device",
4222 This command disables the libguestfs appliance swap
4223 device or partition named C<device>.
4224 See C<guestfs_swapon_device>.");
4226 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4227 [InitScratchFS, Always, TestRun (
4228 [["fallocate"; "/swapon_file"; "8388608"];
4229 ["mkswap_file"; "/swapon_file"];
4230 ["swapon_file"; "/swapon_file"];
4231 ["swapoff_file"; "/swapon_file"];
4232 ["rm"; "/swapon_file"]])],
4233 "enable swap on file",
4235 This command enables swap to a file.
4236 See C<guestfs_swapon_device> for other notes.");
4238 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4239 [], (* XXX tested by swapon_file *)
4240 "disable swap on file",
4242 This command disables the libguestfs appliance swap on file.");
4244 ("swapon_label", (RErr, [String "label"], []), 174, [],
4245 [InitEmpty, Always, TestRun (
4246 [["part_disk"; "/dev/sda"; "mbr"];
4247 ["mkswap_L"; "swapit"; "/dev/sda1"];
4248 ["swapon_label"; "swapit"];
4249 ["swapoff_label"; "swapit"];
4250 ["zero"; "/dev/sda"];
4251 ["blockdev_rereadpt"; "/dev/sda"]])],
4252 "enable swap on labeled swap partition",
4254 This command enables swap to a labeled swap partition.
4255 See C<guestfs_swapon_device> for other notes.");
4257 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4258 [], (* XXX tested by swapon_label *)
4259 "disable swap on labeled swap partition",
4261 This command disables the libguestfs appliance swap on
4262 labeled swap partition.");
4264 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4265 (let uuid = uuidgen () in
4266 [InitEmpty, Always, TestRun (
4267 [["mkswap_U"; uuid; "/dev/sdc"];
4268 ["swapon_uuid"; uuid];
4269 ["swapoff_uuid"; uuid]])]),
4270 "enable swap on swap partition by UUID",
4272 This command enables swap to a swap partition with the given UUID.
4273 See C<guestfs_swapon_device> for other notes.");
4275 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4276 [], (* XXX tested by swapon_uuid *)
4277 "disable swap on swap partition by UUID",
4279 This command disables the libguestfs appliance swap partition
4280 with the given UUID.");
4282 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4283 [InitScratchFS, Always, TestRun (
4284 [["fallocate"; "/mkswap_file"; "8388608"];
4285 ["mkswap_file"; "/mkswap_file"];
4286 ["rm"; "/mkswap_file"]])],
4287 "create a swap file",
4291 This command just writes a swap file signature to an existing
4292 file. To create the file itself, use something like C<guestfs_fallocate>.");
4294 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4295 [InitISOFS, Always, TestRun (
4296 [["inotify_init"; "0"]])],
4297 "create an inotify handle",
4299 This command creates a new inotify handle.
4300 The inotify subsystem can be used to notify events which happen to
4301 objects in the guest filesystem.
4303 C<maxevents> is the maximum number of events which will be
4304 queued up between calls to C<guestfs_inotify_read> or
4305 C<guestfs_inotify_files>.
4306 If this is passed as C<0>, then the kernel (or previously set)
4307 default is used. For Linux 2.6.29 the default was 16384 events.
4308 Beyond this limit, the kernel throws away events, but records
4309 the fact that it threw them away by setting a flag
4310 C<IN_Q_OVERFLOW> in the returned structure list (see
4311 C<guestfs_inotify_read>).
4313 Before any events are generated, you have to add some
4314 watches to the internal watch list. See:
4315 C<guestfs_inotify_add_watch>,
4316 C<guestfs_inotify_rm_watch> and
4317 C<guestfs_inotify_watch_all>.
4319 Queued up events should be read periodically by calling
4320 C<guestfs_inotify_read>
4321 (or C<guestfs_inotify_files> which is just a helpful
4322 wrapper around C<guestfs_inotify_read>). If you don't
4323 read the events out often enough then you risk the internal
4326 The handle should be closed after use by calling
4327 C<guestfs_inotify_close>. This also removes any
4328 watches automatically.
4330 See also L<inotify(7)> for an overview of the inotify interface
4331 as exposed by the Linux kernel, which is roughly what we expose
4332 via libguestfs. Note that there is one global inotify handle
4333 per libguestfs instance.");
4335 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4336 [InitScratchFS, Always, TestOutputList (
4337 [["mkdir"; "/inotify_add_watch"];
4338 ["inotify_init"; "0"];
4339 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4340 ["touch"; "/inotify_add_watch/a"];
4341 ["touch"; "/inotify_add_watch/b"];
4342 ["inotify_files"]], ["a"; "b"])],
4343 "add an inotify watch",
4345 Watch C<path> for the events listed in C<mask>.
4347 Note that if C<path> is a directory then events within that
4348 directory are watched, but this does I<not> happen recursively
4349 (in subdirectories).
4351 Note for non-C or non-Linux callers: the inotify events are
4352 defined by the Linux kernel ABI and are listed in
4353 C</usr/include/sys/inotify.h>.");
4355 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4357 "remove an inotify watch",
4359 Remove a previously defined inotify watch.
4360 See C<guestfs_inotify_add_watch>.");
4362 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4364 "return list of inotify events",
4366 Return the complete queue of events that have happened
4367 since the previous read call.
4369 If no events have happened, this returns an empty list.
4371 I<Note>: In order to make sure that all events have been
4372 read, you must call this function repeatedly until it
4373 returns an empty list. The reason is that the call will
4374 read events up to the maximum appliance-to-host message
4375 size and leave remaining events in the queue.");
4377 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4379 "return list of watched files that had events",
4381 This function is a helpful wrapper around C<guestfs_inotify_read>
4382 which just returns a list of pathnames of objects that were
4383 touched. The returned pathnames are sorted and deduplicated.");
4385 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4387 "close the inotify handle",
4389 This closes the inotify handle which was previously
4390 opened by inotify_init. It removes all watches, throws
4391 away any pending events, and deallocates all resources.");
4393 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4395 "set SELinux security context",
4397 This sets the SELinux security context of the daemon
4398 to the string C<context>.
4400 See the documentation about SELINUX in L<guestfs(3)>.");
4402 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4404 "get SELinux security context",
4406 This gets the SELinux security context of the daemon.
4408 See the documentation about SELINUX in L<guestfs(3)>,
4409 and C<guestfs_setcon>");
4411 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4412 [InitEmpty, Always, TestOutput (
4413 [["part_disk"; "/dev/sda"; "mbr"];
4414 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4415 ["mount_options"; ""; "/dev/sda1"; "/"];
4416 ["write"; "/new"; "new file contents"];
4417 ["cat"; "/new"]], "new file contents");
4418 InitEmpty, Always, TestRun (
4419 [["part_disk"; "/dev/sda"; "mbr"];
4420 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4421 InitEmpty, Always, TestLastFail (
4422 [["part_disk"; "/dev/sda"; "mbr"];
4423 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4424 InitEmpty, Always, TestLastFail (
4425 [["part_disk"; "/dev/sda"; "mbr"];
4426 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4427 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4428 [["part_disk"; "/dev/sda"; "mbr"];
4429 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4430 "make a filesystem with block size",
4432 This call is similar to C<guestfs_mkfs>, but it allows you to
4433 control the block size of the resulting filesystem. Supported
4434 block sizes depend on the filesystem type, but typically they
4435 are C<1024>, C<2048> or C<4096> only.
4437 For VFAT and NTFS the C<blocksize> parameter is treated as
4438 the requested cluster size.");
4440 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4441 [InitEmpty, Always, TestOutput (
4442 [["part_init"; "/dev/sda"; "mbr"];
4443 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4444 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4445 ["mke2journal"; "4096"; "/dev/sda1"];
4446 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4447 ["mount_options"; ""; "/dev/sda2"; "/"];
4448 ["write"; "/new"; "new file contents"];
4449 ["cat"; "/new"]], "new file contents")],
4450 "make ext2/3/4 external journal",
4452 This creates an ext2 external journal on C<device>. It is equivalent
4455 mke2fs -O journal_dev -b blocksize device");
4457 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4458 [InitEmpty, Always, TestOutput (
4459 [["part_init"; "/dev/sda"; "mbr"];
4460 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4461 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4462 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4463 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4464 ["mount_options"; ""; "/dev/sda2"; "/"];
4465 ["write"; "/new"; "new file contents"];
4466 ["cat"; "/new"]], "new file contents")],
4467 "make ext2/3/4 external journal with label",
4469 This creates an ext2 external journal on C<device> with label C<label>.");
4471 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4472 (let uuid = uuidgen () in
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_U"; "4096"; uuid; "/dev/sda1"];
4478 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4479 ["mount_options"; ""; "/dev/sda2"; "/"];
4480 ["write"; "/new"; "new file contents"];
4481 ["cat"; "/new"]], "new file contents")]),
4482 "make ext2/3/4 external journal with UUID",
4484 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4486 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4488 "make ext2/3/4 filesystem with external journal",
4490 This creates an ext2/3/4 filesystem on C<device> with
4491 an external journal on C<journal>. It is equivalent
4494 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4496 See also C<guestfs_mke2journal>.");
4498 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4500 "make ext2/3/4 filesystem with external journal",
4502 This creates an ext2/3/4 filesystem on C<device> with
4503 an external journal on the journal labeled C<label>.
4505 See also C<guestfs_mke2journal_L>.");
4507 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4509 "make ext2/3/4 filesystem with external journal",
4511 This creates an ext2/3/4 filesystem on C<device> with
4512 an external journal on the journal with UUID C<uuid>.
4514 See also C<guestfs_mke2journal_U>.");
4516 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4517 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4518 "load a kernel module",
4520 This loads a kernel module in the appliance.
4522 The kernel module must have been whitelisted when libguestfs
4523 was built (see C<appliance/kmod.whitelist.in> in the source).");
4525 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4526 [InitNone, Always, TestOutput (
4527 [["echo_daemon"; "This is a test"]], "This is a test"
4529 "echo arguments back to the client",
4531 This command concatenates the list of C<words> passed with single spaces
4532 between them and returns the resulting string.
4534 You can use this command to test the connection through to the daemon.
4536 See also C<guestfs_ping_daemon>.");
4538 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4539 [], (* There is a regression test for this. *)
4540 "find all files and directories, returning NUL-separated list",
4542 This command lists out all files and directories, recursively,
4543 starting at C<directory>, placing the resulting list in the
4544 external file called C<files>.
4546 This command works the same way as C<guestfs_find> with the
4547 following exceptions:
4553 The resulting list is written to an external file.
4557 Items (filenames) in the result are separated
4558 by C<\\0> characters. See L<find(1)> option I<-print0>.
4562 This command is not limited in the number of names that it
4567 The result list is not sorted.
4571 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4572 [InitISOFS, Always, TestOutput (
4573 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4574 InitISOFS, Always, TestOutput (
4575 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4576 InitISOFS, Always, TestOutput (
4577 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4578 InitISOFS, Always, TestLastFail (
4579 [["case_sensitive_path"; "/Known-1/"]]);
4580 InitScratchFS, Always, TestOutput (
4581 [["mkdir"; "/case_sensitive_path"];
4582 ["mkdir"; "/case_sensitive_path/bbb"];
4583 ["touch"; "/case_sensitive_path/bbb/c"];
4584 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4585 InitScratchFS, Always, TestOutput (
4586 [["mkdir"; "/case_sensitive_path2"];
4587 ["mkdir"; "/case_sensitive_path2/bbb"];
4588 ["touch"; "/case_sensitive_path2/bbb/c"];
4589 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4590 InitScratchFS, Always, TestLastFail (
4591 [["mkdir"; "/case_sensitive_path3"];
4592 ["mkdir"; "/case_sensitive_path3/bbb"];
4593 ["touch"; "/case_sensitive_path3/bbb/c"];
4594 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4595 "return true path on case-insensitive filesystem",
4597 This can be used to resolve case insensitive paths on
4598 a filesystem which is case sensitive. The use case is
4599 to resolve paths which you have read from Windows configuration
4600 files or the Windows Registry, to the true path.
4602 The command handles a peculiarity of the Linux ntfs-3g
4603 filesystem driver (and probably others), which is that although
4604 the underlying filesystem is case-insensitive, the driver
4605 exports the filesystem to Linux as case-sensitive.
4607 One consequence of this is that special directories such
4608 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4609 (or other things) depending on the precise details of how
4610 they were created. In Windows itself this would not be
4613 Bug or feature? You decide:
4614 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4616 This function resolves the true case of each element in the
4617 path and returns the case-sensitive path.
4619 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4620 might return C<\"/WINDOWS/system32\"> (the exact return value
4621 would depend on details of how the directories were originally
4622 created under Windows).
4625 This function does not handle drive names, backslashes etc.
4627 See also C<guestfs_realpath>.");
4629 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4630 [InitScratchFS, Always, TestOutput (
4631 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4632 "get the Linux VFS type corresponding to a mounted device",
4634 This command gets the filesystem type corresponding to
4635 the filesystem on C<device>.
4637 For most filesystems, the result is the name of the Linux
4638 VFS module which would be used to mount this filesystem
4639 if you mounted it without specifying the filesystem type.
4640 For example a string such as C<ext3> or C<ntfs>.");
4642 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4643 [InitScratchFS, Always, TestOutputStruct (
4644 [["write"; "/truncate"; "some stuff so size is not zero"];
4645 ["truncate"; "/truncate"];
4646 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4647 "truncate a file to zero size",
4649 This command truncates C<path> to a zero-length file. The
4650 file must exist already.");
4652 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4653 [InitScratchFS, Always, TestOutputStruct (
4654 [["touch"; "/truncate_size"];
4655 ["truncate_size"; "/truncate_size"; "1000"];
4656 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4657 "truncate a file to a particular size",
4659 This command truncates C<path> to size C<size> bytes. The file
4662 If the current file size is less than C<size> then
4663 the file is extended to the required size with zero bytes.
4664 This creates a sparse file (ie. disk blocks are not allocated
4665 for the file until you write to it). To create a non-sparse
4666 file of zeroes, use C<guestfs_fallocate64> instead.");
4668 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4669 [InitScratchFS, Always, TestOutputStruct (
4670 [["touch"; "/utimens"];
4671 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4672 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4673 "set timestamp of a file with nanosecond precision",
4675 This command sets the timestamps of a file with nanosecond
4678 C<atsecs, atnsecs> are the last access time (atime) in secs and
4679 nanoseconds from the epoch.
4681 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4682 secs and nanoseconds from the epoch.
4684 If the C<*nsecs> field contains the special value C<-1> then
4685 the corresponding timestamp is set to the current time. (The
4686 C<*secs> field is ignored in this case).
4688 If the C<*nsecs> field contains the special value C<-2> then
4689 the corresponding timestamp is left unchanged. (The
4690 C<*secs> field is ignored in this case).");
4692 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4693 [InitScratchFS, Always, TestOutputStruct (
4694 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4695 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4696 "create a directory with a particular mode",
4698 This command creates a directory, setting the initial permissions
4699 of the directory to C<mode>.
4701 For common Linux filesystems, the actual mode which is set will
4702 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4703 interpret the mode in other ways.
4705 See also C<guestfs_mkdir>, C<guestfs_umask>");
4707 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4709 "change file owner and group",
4711 Change the file owner to C<owner> and group to C<group>.
4712 This is like C<guestfs_chown> but if C<path> is a symlink then
4713 the link itself is changed, not the target.
4715 Only numeric uid and gid are supported. If you want to use
4716 names, you will need to locate and parse the password file
4717 yourself (Augeas support makes this relatively easy).");
4719 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4721 "lstat on multiple files",
4723 This call allows you to perform the C<guestfs_lstat> operation
4724 on multiple files, where all files are in the directory C<path>.
4725 C<names> is the list of files from this directory.
4727 On return you get a list of stat structs, with a one-to-one
4728 correspondence to the C<names> list. If any name did not exist
4729 or could not be lstat'd, then the C<ino> field of that structure
4732 This call is intended for programs that want to efficiently
4733 list a directory contents without making many round-trips.
4734 See also C<guestfs_lxattrlist> for a similarly efficient call
4735 for getting extended attributes. Very long directory listings
4736 might cause the protocol message size to be exceeded, causing
4737 this call to fail. The caller must split up such requests
4738 into smaller groups of names.");
4740 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4742 "lgetxattr on multiple files",
4744 This call allows you to get the extended attributes
4745 of multiple files, where all files are in the directory C<path>.
4746 C<names> is the list of files from this directory.
4748 On return you get a flat list of xattr structs which must be
4749 interpreted sequentially. The first xattr struct always has a zero-length
4750 C<attrname>. C<attrval> in this struct is zero-length
4751 to indicate there was an error doing C<lgetxattr> for this
4752 file, I<or> is a C string which is a decimal number
4753 (the number of following attributes for this file, which could
4754 be C<\"0\">). Then after the first xattr struct are the
4755 zero or more attributes for the first named file.
4756 This repeats for the second and subsequent files.
4758 This call is intended for programs that want to efficiently
4759 list a directory contents without making many round-trips.
4760 See also C<guestfs_lstatlist> for a similarly efficient call
4761 for getting standard stats. Very long directory listings
4762 might cause the protocol message size to be exceeded, causing
4763 this call to fail. The caller must split up such requests
4764 into smaller groups of names.");
4766 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4768 "readlink on multiple files",
4770 This call allows you to do a C<readlink> operation
4771 on multiple files, where all files are in the directory C<path>.
4772 C<names> is the list of files from this directory.
4774 On return you get a list of strings, with a one-to-one
4775 correspondence to the C<names> list. Each string is the
4776 value of the symbolic link.
4778 If the C<readlink(2)> operation fails on any name, then
4779 the corresponding result string is the empty string C<\"\">.
4780 However the whole operation is completed even if there
4781 were C<readlink(2)> errors, and so you can call this
4782 function with names where you don't know if they are
4783 symbolic links already (albeit slightly less efficient).
4785 This call is intended for programs that want to efficiently
4786 list a directory contents without making many round-trips.
4787 Very long directory listings might cause the protocol
4788 message size to be exceeded, causing
4789 this call to fail. The caller must split up such requests
4790 into smaller groups of names.");
4792 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4793 [InitISOFS, Always, TestOutputBuffer (
4794 [["pread"; "/known-4"; "1"; "3"]], "\n");
4795 InitISOFS, Always, TestOutputBuffer (
4796 [["pread"; "/empty"; "0"; "100"]], "")],
4797 "read part of a file",
4799 This command lets you read part of a file. It reads C<count>
4800 bytes of the file, starting at C<offset>, from file C<path>.
4802 This may read fewer bytes than requested. For further details
4803 see the L<pread(2)> system call.
4805 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4807 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4808 [InitEmpty, Always, TestRun (
4809 [["part_init"; "/dev/sda"; "gpt"]])],
4810 "create an empty partition table",
4812 This creates an empty partition table on C<device> of one of the
4813 partition types listed below. Usually C<parttype> should be
4814 either C<msdos> or C<gpt> (for large disks).
4816 Initially there are no partitions. Following this, you should
4817 call C<guestfs_part_add> for each partition required.
4819 Possible values for C<parttype> are:
4823 =item B<efi> | B<gpt>
4825 Intel EFI / GPT partition table.
4827 This is recommended for >= 2 TB partitions that will be accessed
4828 from Linux and Intel-based Mac OS X. It also has limited backwards
4829 compatibility with the C<mbr> format.
4831 =item B<mbr> | B<msdos>
4833 The standard PC \"Master Boot Record\" (MBR) format used
4834 by MS-DOS and Windows. This partition type will B<only> work
4835 for device sizes up to 2 TB. For large disks we recommend
4840 Other partition table types that may work but are not
4849 =item B<amiga> | B<rdb>
4851 Amiga \"Rigid Disk Block\" format.
4859 DASD, used on IBM mainframes.
4867 Old Mac partition format. Modern Macs use C<gpt>.
4871 NEC PC-98 format, common in Japan apparently.
4879 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4880 [InitEmpty, Always, TestRun (
4881 [["part_init"; "/dev/sda"; "mbr"];
4882 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4883 InitEmpty, Always, TestRun (
4884 [["part_init"; "/dev/sda"; "gpt"];
4885 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4886 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4887 InitEmpty, Always, TestRun (
4888 [["part_init"; "/dev/sda"; "mbr"];
4889 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4890 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4891 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4892 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4893 "add a partition to the device",
4895 This command adds a partition to C<device>. If there is no partition
4896 table on the device, call C<guestfs_part_init> first.
4898 The C<prlogex> parameter is the type of partition. Normally you
4899 should pass C<p> or C<primary> here, but MBR partition tables also
4900 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4903 C<startsect> and C<endsect> are the start and end of the partition
4904 in I<sectors>. C<endsect> may be negative, which means it counts
4905 backwards from the end of the disk (C<-1> is the last sector).
4907 Creating a partition which covers the whole disk is not so easy.
4908 Use C<guestfs_part_disk> to do that.");
4910 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4911 [InitEmpty, Always, TestRun (
4912 [["part_disk"; "/dev/sda"; "mbr"]]);
4913 InitEmpty, Always, TestRun (
4914 [["part_disk"; "/dev/sda"; "gpt"]])],
4915 "partition whole disk with a single primary partition",
4917 This command is simply a combination of C<guestfs_part_init>
4918 followed by C<guestfs_part_add> to create a single primary partition
4919 covering the whole disk.
4921 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4922 but other possible values are described in C<guestfs_part_init>.");
4924 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4925 [InitEmpty, Always, TestRun (
4926 [["part_disk"; "/dev/sda"; "mbr"];
4927 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4928 "make a partition bootable",
4930 This sets the bootable flag on partition numbered C<partnum> on
4931 device C<device>. Note that partitions are numbered from 1.
4933 The bootable flag is used by some operating systems (notably
4934 Windows) to determine which partition to boot from. It is by
4935 no means universally recognized.");
4937 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4938 [InitEmpty, Always, TestRun (
4939 [["part_disk"; "/dev/sda"; "gpt"];
4940 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4941 "set partition name",
4943 This sets the partition name on partition numbered C<partnum> on
4944 device C<device>. Note that partitions are numbered from 1.
4946 The partition name can only be set on certain types of partition
4947 table. This works on C<gpt> but not on C<mbr> partitions.");
4949 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4950 [], (* XXX Add a regression test for this. *)
4951 "list partitions on a device",
4953 This command parses the partition table on C<device> and
4954 returns the list of partitions found.
4956 The fields in the returned structure are:
4962 Partition number, counting from 1.
4966 Start of the partition I<in bytes>. To get sectors you have to
4967 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4971 End of the partition in bytes.
4975 Size of the partition in bytes.
4979 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4980 [InitEmpty, Always, TestOutput (
4981 [["part_disk"; "/dev/sda"; "gpt"];
4982 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4983 "get the partition table type",
4985 This command examines the partition table on C<device> and
4986 returns the partition table type (format) being used.
4988 Common return values include: C<msdos> (a DOS/Windows style MBR
4989 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4990 values are possible, although unusual. See C<guestfs_part_init>
4993 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
4994 [InitScratchFS, Always, TestOutputBuffer (
4995 [["fill"; "0x63"; "10"; "/fill"];
4996 ["read_file"; "/fill"]], "cccccccccc")],
4997 "fill a file with octets",
4999 This command creates a new file called C<path>. The initial
5000 content of the file is C<len> octets of C<c>, where C<c>
5001 must be a number in the range C<[0..255]>.
5003 To fill a file with zero bytes (sparsely), it is
5004 much more efficient to use C<guestfs_truncate_size>.
5005 To create a file with a pattern of repeating bytes
5006 use C<guestfs_fill_pattern>.");
5008 ("available", (RErr, [StringList "groups"], []), 216, [],
5009 [InitNone, Always, TestRun [["available"; ""]]],
5010 "test availability of some parts of the API",
5012 This command is used to check the availability of some
5013 groups of functionality in the appliance, which not all builds of
5014 the libguestfs appliance will be able to provide.
5016 The libguestfs groups, and the functions that those
5017 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5018 You can also fetch this list at runtime by calling
5019 C<guestfs_available_all_groups>.
5021 The argument C<groups> is a list of group names, eg:
5022 C<[\"inotify\", \"augeas\"]> would check for the availability of
5023 the Linux inotify functions and Augeas (configuration file
5026 The command returns no error if I<all> requested groups are available.
5028 It fails with an error if one or more of the requested
5029 groups is unavailable in the appliance.
5031 If an unknown group name is included in the
5032 list of groups then an error is always returned.
5040 You must call C<guestfs_launch> before calling this function.
5042 The reason is because we don't know what groups are
5043 supported by the appliance/daemon until it is running and can
5048 If a group of functions is available, this does not necessarily
5049 mean that they will work. You still have to check for errors
5050 when calling individual API functions even if they are
5055 It is usually the job of distro packagers to build
5056 complete functionality into the libguestfs appliance.
5057 Upstream libguestfs, if built from source with all
5058 requirements satisfied, will support everything.
5062 This call was added in version C<1.0.80>. In previous
5063 versions of libguestfs all you could do would be to speculatively
5064 execute a command to find out if the daemon implemented it.
5065 See also C<guestfs_version>.
5069 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5070 [InitScratchFS, Always, TestOutputBuffer (
5072 ["write"; "/dd/src"; "hello, world"];
5073 ["dd"; "/dd/src"; "/dd/dest"];
5074 ["read_file"; "/dd/dest"]], "hello, world")],
5075 "copy from source to destination using dd",
5077 This command copies from one source device or file C<src>
5078 to another destination device or file C<dest>. Normally you
5079 would use this to copy to or from a device or partition, for
5080 example to duplicate a filesystem.
5082 If the destination is a device, it must be as large or larger
5083 than the source file or device, otherwise the copy will fail.
5084 This command cannot do partial copies (see C<guestfs_copy_size>).");
5086 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5087 [InitScratchFS, Always, TestOutputInt (
5088 [["write"; "/filesize"; "hello, world"];
5089 ["filesize"; "/filesize"]], 12)],
5090 "return the size of the file in bytes",
5092 This command returns the size of C<file> in bytes.
5094 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5095 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5096 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5098 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5099 [InitBasicFSonLVM, Always, TestOutputList (
5100 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5101 ["lvs"]], ["/dev/VG/LV2"])],
5102 "rename an LVM logical volume",
5104 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5106 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5107 [InitBasicFSonLVM, Always, TestOutputList (
5109 ["vg_activate"; "false"; "VG"];
5110 ["vgrename"; "VG"; "VG2"];
5111 ["vg_activate"; "true"; "VG2"];
5112 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5113 ["vgs"]], ["VG2"])],
5114 "rename an LVM volume group",
5116 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5118 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5119 [InitISOFS, Always, TestOutputBuffer (
5120 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5121 "list the contents of a single file in an initrd",
5123 This command unpacks the file C<filename> from the initrd file
5124 called C<initrdpath>. The filename must be given I<without> the
5125 initial C</> character.
5127 For example, in guestfish you could use the following command
5128 to examine the boot script (usually called C</init>)
5129 contained in a Linux initrd or initramfs image:
5131 initrd-cat /boot/initrd-<version>.img init
5133 See also C<guestfs_initrd_list>.");
5135 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5137 "get the UUID of a physical volume",
5139 This command returns the UUID of the LVM PV C<device>.");
5141 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5143 "get the UUID of a volume group",
5145 This command returns the UUID of the LVM VG named C<vgname>.");
5147 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5149 "get the UUID of a logical volume",
5151 This command returns the UUID of the LVM LV C<device>.");
5153 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5155 "get the PV UUIDs containing the volume group",
5157 Given a VG called C<vgname>, this returns the UUIDs of all
5158 the physical volumes that this volume group resides on.
5160 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5161 calls to associate physical volumes and volume groups.
5163 See also C<guestfs_vglvuuids>.");
5165 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5167 "get the LV UUIDs of all LVs in the volume group",
5169 Given a VG called C<vgname>, this returns the UUIDs of all
5170 the logical volumes created in this volume group.
5172 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5173 calls to associate logical volumes and volume groups.
5175 See also C<guestfs_vgpvuuids>.");
5177 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5178 [InitScratchFS, Always, TestOutputBuffer (
5179 [["mkdir"; "/copy_size"];
5180 ["write"; "/copy_size/src"; "hello, world"];
5181 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5182 ["read_file"; "/copy_size/dest"]], "hello")],
5183 "copy size bytes from source to destination using dd",
5185 This command copies exactly C<size> bytes from one source device
5186 or file C<src> to another destination device or file C<dest>.
5188 Note this will fail if the source is too short or if the destination
5189 is not large enough.");
5191 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5192 [InitBasicFSonLVM, Always, TestRun (
5193 [["zero_device"; "/dev/VG/LV"]])],
5194 "write zeroes to an entire device",
5196 This command writes zeroes over the entire C<device>. Compare
5197 with C<guestfs_zero> which just zeroes the first few blocks of
5200 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5201 [InitScratchFS, Always, TestOutput (
5202 [["mkdir"; "/txz_in"];
5203 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5204 ["cat"; "/txz_in/hello"]], "hello\n")],
5205 "unpack compressed tarball to directory",
5207 This command uploads and unpacks local file C<tarball> (an
5208 I<xz compressed> tar file) into C<directory>.");
5210 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5212 "pack directory into compressed tarball",
5214 This command packs the contents of C<directory> and downloads
5215 it to local file C<tarball> (as an xz compressed tar archive).");
5217 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5219 "resize an NTFS filesystem",
5221 This command resizes an NTFS filesystem, expanding or
5222 shrinking it to the size of the underlying device.
5223 See also L<ntfsresize(8)>.");
5225 ("vgscan", (RErr, [], []), 232, [],
5226 [InitEmpty, Always, TestRun (
5228 "rescan for LVM physical volumes, volume groups and logical volumes",
5230 This rescans all block devices and rebuilds the list of LVM
5231 physical volumes, volume groups and logical volumes.");
5233 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5234 [InitEmpty, Always, TestRun (
5235 [["part_init"; "/dev/sda"; "mbr"];
5236 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5237 ["part_del"; "/dev/sda"; "1"]])],
5238 "delete a partition",
5240 This command deletes the partition numbered C<partnum> on C<device>.
5242 Note that in the case of MBR partitioning, deleting an
5243 extended partition also deletes any logical partitions
5246 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5247 [InitEmpty, Always, TestOutputTrue (
5248 [["part_init"; "/dev/sda"; "mbr"];
5249 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5250 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5251 ["part_get_bootable"; "/dev/sda"; "1"]])],
5252 "return true if a partition is bootable",
5254 This command returns true if the partition C<partnum> on
5255 C<device> has the bootable flag set.
5257 See also C<guestfs_part_set_bootable>.");
5259 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5260 [InitEmpty, Always, TestOutputInt (
5261 [["part_init"; "/dev/sda"; "mbr"];
5262 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5263 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5264 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5265 "get the MBR type byte (ID byte) from a partition",
5267 Returns the MBR type byte (also known as the ID byte) from
5268 the numbered partition C<partnum>.
5270 Note that only MBR (old DOS-style) partitions have type bytes.
5271 You will get undefined results for other partition table
5272 types (see C<guestfs_part_get_parttype>).");
5274 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5275 [], (* tested by part_get_mbr_id *)
5276 "set the MBR type byte (ID byte) of a partition",
5278 Sets the MBR type byte (also known as the ID byte) of
5279 the numbered partition C<partnum> to C<idbyte>. Note
5280 that the type bytes quoted in most documentation are
5281 in fact hexadecimal numbers, but usually documented
5282 without any leading \"0x\" which might be confusing.
5284 Note that only MBR (old DOS-style) partitions have type bytes.
5285 You will get undefined results for other partition table
5286 types (see C<guestfs_part_get_parttype>).");
5288 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5289 [InitISOFS, Always, TestOutputFileMD5 (
5290 [["checksum_device"; "md5"; "/dev/sdd"]],
5291 "../images/test.iso")],
5292 "compute MD5, SHAx or CRC checksum of the contents of a device",
5294 This call computes the MD5, SHAx or CRC checksum of the
5295 contents of the device named C<device>. For the types of
5296 checksums supported see the C<guestfs_checksum> command.");
5298 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5299 [InitNone, Always, TestRun (
5300 [["part_disk"; "/dev/sda"; "mbr"];
5301 ["pvcreate"; "/dev/sda1"];
5302 ["vgcreate"; "VG"; "/dev/sda1"];
5303 ["lvcreate"; "LV"; "VG"; "10"];
5304 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5305 "expand an LV to fill free space",
5307 This expands an existing logical volume C<lv> so that it fills
5308 C<pc>% of the remaining free space in the volume group. Commonly
5309 you would call this with pc = 100 which expands the logical volume
5310 as much as possible, using all remaining free space in the volume
5313 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5314 [], (* XXX Augeas code needs tests. *)
5315 "clear Augeas path",
5317 Set the value associated with C<path> to C<NULL>. This
5318 is the same as the L<augtool(1)> C<clear> command.");
5320 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5321 [InitEmpty, Always, TestOutputInt (
5322 [["get_umask"]], 0o22)],
5323 "get the current umask",
5325 Return the current umask. By default the umask is C<022>
5326 unless it has been set by calling C<guestfs_umask>.");
5328 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5330 "upload a file to the appliance (internal use only)",
5332 The C<guestfs_debug_upload> command uploads a file to
5333 the libguestfs appliance.
5335 There is no comprehensive help for this command. You have
5336 to look at the file C<daemon/debug.c> in the libguestfs source
5337 to find out what it is for.");
5339 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5340 [InitScratchFS, Always, TestOutput (
5341 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5342 ["cat"; "/base64_in"]], "hello\n")],
5343 "upload base64-encoded data to file",
5345 This command uploads base64-encoded data from C<base64file>
5348 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5350 "download file and encode as base64",
5352 This command downloads the contents of C<filename>, writing
5353 it out to local file C<base64file> encoded as base64.");
5355 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5357 "compute MD5, SHAx or CRC checksum of files in a directory",
5359 This command computes the checksums of all regular files in
5360 C<directory> and then emits a list of those checksums to
5361 the local output file C<sumsfile>.
5363 This can be used for verifying the integrity of a virtual
5364 machine. However to be properly secure you should pay
5365 attention to the output of the checksum command (it uses
5366 the ones from GNU coreutils). In particular when the
5367 filename is not printable, coreutils uses a special
5368 backslash syntax. For more information, see the GNU
5369 coreutils info file.");
5371 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5372 [InitScratchFS, Always, TestOutputBuffer (
5373 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5374 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5375 "fill a file with a repeating pattern of bytes",
5377 This function is like C<guestfs_fill> except that it creates
5378 a new file of length C<len> containing the repeating pattern
5379 of bytes in C<pattern>. The pattern is truncated if necessary
5380 to ensure the length of the file is exactly C<len> bytes.");
5382 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5383 [InitScratchFS, Always, TestOutput (
5384 [["write"; "/write"; "new file contents"];
5385 ["cat"; "/write"]], "new file contents");
5386 InitScratchFS, Always, TestOutput (
5387 [["write"; "/write2"; "\nnew file contents\n"];
5388 ["cat"; "/write2"]], "\nnew file contents\n");
5389 InitScratchFS, Always, TestOutput (
5390 [["write"; "/write3"; "\n\n"];
5391 ["cat"; "/write3"]], "\n\n");
5392 InitScratchFS, Always, TestOutput (
5393 [["write"; "/write4"; ""];
5394 ["cat"; "/write4"]], "");
5395 InitScratchFS, Always, TestOutput (
5396 [["write"; "/write5"; "\n\n\n"];
5397 ["cat"; "/write5"]], "\n\n\n");
5398 InitScratchFS, Always, TestOutput (
5399 [["write"; "/write6"; "\n"];
5400 ["cat"; "/write6"]], "\n")],
5401 "create a new file",
5403 This call creates a file called C<path>. The content of the
5404 file is the string C<content> (which can contain any 8 bit data).");
5406 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5407 [InitScratchFS, Always, TestOutput (
5408 [["write"; "/pwrite"; "new file contents"];
5409 ["pwrite"; "/pwrite"; "data"; "4"];
5410 ["cat"; "/pwrite"]], "new data contents");
5411 InitScratchFS, Always, TestOutput (
5412 [["write"; "/pwrite2"; "new file contents"];
5413 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5414 ["cat"; "/pwrite2"]], "new file is extended");
5415 InitScratchFS, Always, TestOutput (
5416 [["write"; "/pwrite3"; "new file contents"];
5417 ["pwrite"; "/pwrite3"; ""; "4"];
5418 ["cat"; "/pwrite3"]], "new file contents")],
5419 "write to part of a file",
5421 This command writes to part of a file. It writes the data
5422 buffer C<content> to the file C<path> starting at offset C<offset>.
5424 This command implements the L<pwrite(2)> system call, and like
5425 that system call it may not write the full data requested. The
5426 return value is the number of bytes that were actually written
5427 to the file. This could even be 0, although short writes are
5428 unlikely for regular files in ordinary circumstances.
5430 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5432 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5434 "resize an ext2, ext3 or ext4 filesystem (with size)",
5436 This command is the same as C<guestfs_resize2fs> except that it
5437 allows you to specify the new size (in bytes) explicitly.");
5439 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5441 "resize an LVM physical volume (with size)",
5443 This command is the same as C<guestfs_pvresize> except that it
5444 allows you to specify the new size (in bytes) explicitly.");
5446 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5448 "resize an NTFS filesystem (with size)",
5450 This command is the same as C<guestfs_ntfsresize> except that it
5451 allows you to specify the new size (in bytes) explicitly.");
5453 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5454 [InitNone, Always, TestRun [["available_all_groups"]]],
5455 "return a list of all optional groups",
5457 This command returns a list of all optional groups that this
5458 daemon knows about. Note this returns both supported and unsupported
5459 groups. To find out which ones the daemon can actually support
5460 you have to call C<guestfs_available> on each member of the
5463 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5465 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5466 [InitScratchFS, Always, TestOutputStruct (
5467 [["fallocate64"; "/fallocate64"; "1000000"];
5468 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5469 "preallocate a file in the guest filesystem",
5471 This command preallocates a file (containing zero bytes) named
5472 C<path> of size C<len> bytes. If the file exists already, it
5475 Note that this call allocates disk blocks for the file.
5476 To create a sparse file use C<guestfs_truncate_size> instead.
5478 The deprecated call C<guestfs_fallocate> does the same,
5479 but owing to an oversight it only allowed 30 bit lengths
5480 to be specified, effectively limiting the maximum size
5481 of files created through that call to 1GB.
5483 Do not confuse this with the guestfish-specific
5484 C<alloc> and C<sparse> commands which create
5485 a file in the host and attach it as a device.");
5487 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5488 [InitBasicFS, Always, TestOutput (
5489 [["set_e2label"; "/dev/sda1"; "LTEST"];
5490 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5491 "get the filesystem label",
5493 This returns the filesystem label of the filesystem on
5496 If the filesystem is unlabeled, this returns the empty string.
5498 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5500 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5501 (let uuid = uuidgen () in
5502 [InitBasicFS, Always, TestOutput (
5503 [["set_e2uuid"; "/dev/sda1"; uuid];
5504 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5505 "get the filesystem UUID",
5507 This returns the filesystem UUID of the filesystem on
5510 If the filesystem does not have a UUID, this returns the empty string.
5512 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5514 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5515 (* Can't be tested with the current framework because
5516 * the VG is being used by the mounted filesystem, so
5517 * the vgchange -an command we do first will fail.
5520 "set LVM device filter",
5522 This sets the LVM device filter so that LVM will only be
5523 able to \"see\" the block devices in the list C<devices>,
5524 and will ignore all other attached block devices.
5526 Where disk image(s) contain duplicate PVs or VGs, this
5527 command is useful to get LVM to ignore the duplicates, otherwise
5528 LVM can get confused. Note also there are two types
5529 of duplication possible: either cloned PVs/VGs which have
5530 identical UUIDs; or VGs that are not cloned but just happen
5531 to have the same name. In normal operation you cannot
5532 create this situation, but you can do it outside LVM, eg.
5533 by cloning disk images or by bit twiddling inside the LVM
5536 This command also clears the LVM cache and performs a volume
5539 You can filter whole block devices or individual partitions.
5541 You cannot use this if any VG is currently in use (eg.
5542 contains a mounted filesystem), even if you are not
5543 filtering out that VG.");
5545 ("lvm_clear_filter", (RErr, [], []), 256, [],
5546 [], (* see note on lvm_set_filter *)
5547 "clear LVM device filter",
5549 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5550 will be able to see every block device.
5552 This command also clears the LVM cache and performs a volume
5555 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5557 "open a LUKS-encrypted block device",
5559 This command opens a block device which has been encrypted
5560 according to the Linux Unified Key Setup (LUKS) standard.
5562 C<device> is the encrypted block device or partition.
5564 The caller must supply one of the keys associated with the
5565 LUKS block device, in the C<key> parameter.
5567 This creates a new block device called C</dev/mapper/mapname>.
5568 Reads and writes to this block device are decrypted from and
5569 encrypted to the underlying C<device> respectively.
5571 If this block device contains LVM volume groups, then
5572 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5573 will make them visible.");
5575 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5577 "open a LUKS-encrypted block device read-only",
5579 This is the same as C<guestfs_luks_open> except that a read-only
5580 mapping is created.");
5582 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5584 "close a LUKS device",
5586 This closes a LUKS device that was created earlier by
5587 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5588 C<device> parameter must be the name of the LUKS mapping
5589 device (ie. C</dev/mapper/mapname>) and I<not> the name
5590 of the underlying block device.");
5592 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5594 "format a block device as a LUKS encrypted device",
5596 This command erases existing data on C<device> and formats
5597 the device as a LUKS encrypted device. C<key> is the
5598 initial key, which is added to key slot C<slot>. (LUKS
5599 supports 8 key slots, numbered 0-7).");
5601 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5603 "format a block device as a LUKS encrypted device",
5605 This command is the same as C<guestfs_luks_format> but
5606 it also allows you to set the C<cipher> used.");
5608 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5610 "add a key on a LUKS encrypted device",
5612 This command adds a new key on LUKS device C<device>.
5613 C<key> is any existing key, and is used to access the device.
5614 C<newkey> is the new key to add. C<keyslot> is the key slot
5615 that will be replaced.
5617 Note that if C<keyslot> already contains a key, then this
5618 command will fail. You have to use C<guestfs_luks_kill_slot>
5619 first to remove that key.");
5621 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5623 "remove a key from a LUKS encrypted device",
5625 This command deletes the key in key slot C<keyslot> from the
5626 encrypted LUKS device C<device>. C<key> must be one of the
5629 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5630 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5631 [["is_lv"; "/dev/VG/LV"]]);
5632 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5633 [["is_lv"; "/dev/sda1"]])],
5634 "test if device is a logical volume",
5636 This command tests whether C<device> is a logical volume, and
5637 returns true iff this is the case.");
5639 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5641 "find a filesystem by UUID",
5643 This command searches the filesystems and returns the one
5644 which has the given UUID. An error is returned if no such
5645 filesystem can be found.
5647 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5649 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5651 "find a filesystem by label",
5653 This command searches the filesystems and returns the one
5654 which has the given label. An error is returned if no such
5655 filesystem can be found.
5657 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5659 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5660 [InitISOFS, Always, TestOutputFalse (
5661 [["is_chardev"; "/directory"]]);
5662 InitScratchFS, Always, TestOutputTrue (
5663 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5664 ["is_chardev"; "/is_chardev"]])],
5665 "test if character device",
5667 This returns C<true> if and only if there is a character device
5668 with the given C<path> name.
5670 See also C<guestfs_stat>.");
5672 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5673 [InitISOFS, Always, TestOutputFalse (
5674 [["is_blockdev"; "/directory"]]);
5675 InitScratchFS, Always, TestOutputTrue (
5676 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5677 ["is_blockdev"; "/is_blockdev"]])],
5678 "test if block device",
5680 This returns C<true> if and only if there is a block device
5681 with the given C<path> name.
5683 See also C<guestfs_stat>.");
5685 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5686 [InitISOFS, Always, TestOutputFalse (
5687 [["is_fifo"; "/directory"]]);
5688 InitScratchFS, Always, TestOutputTrue (
5689 [["mkfifo"; "0o777"; "/is_fifo"];
5690 ["is_fifo"; "/is_fifo"]])],
5691 "test if FIFO (named pipe)",
5693 This returns C<true> if and only if there is a FIFO (named pipe)
5694 with the given C<path> name.
5696 See also C<guestfs_stat>.");
5698 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5699 [InitISOFS, Always, TestOutputFalse (
5700 [["is_symlink"; "/directory"]]);
5701 InitISOFS, Always, TestOutputTrue (
5702 [["is_symlink"; "/abssymlink"]])],
5703 "test if symbolic link",
5705 This returns C<true> if and only if there is a symbolic link
5706 with the given C<path> name.
5708 See also C<guestfs_stat>.");
5710 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5711 (* XXX Need a positive test for sockets. *)
5712 [InitISOFS, Always, TestOutputFalse (
5713 [["is_socket"; "/directory"]])],
5716 This returns C<true> if and only if there is a Unix domain socket
5717 with the given C<path> name.
5719 See also C<guestfs_stat>.");
5721 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5722 [InitPartition, Always, TestOutputDevice (
5723 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5724 InitEmpty, Always, TestLastFail (
5725 [["part_to_dev"; "/dev/sda"]])],
5726 "convert partition name to device name",
5728 This function takes a partition name (eg. \"/dev/sdb1\") and
5729 removes the partition number, returning the device name
5732 The named partition must exist, for example as a string returned
5733 from C<guestfs_list_partitions>.");
5735 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5736 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5737 [InitScratchFS, Always, TestOutput (
5738 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5739 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5740 "upload a file from the local machine with offset",
5742 Upload local file C<filename> to C<remotefilename> on the
5745 C<remotefilename> is overwritten starting at the byte C<offset>
5746 specified. The intention is to overwrite parts of existing
5747 files or devices, although if a non-existant file is specified
5748 then it is created with a \"hole\" before C<offset>. The
5749 size of the data written is implicit in the size of the
5752 Note that there is no limit on the amount of data that
5753 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5754 and this call always writes the full amount unless an
5757 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5759 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5760 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5761 let offset = string_of_int 100 in
5762 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5763 [InitScratchFS, Always, TestOutput (
5764 (* Pick a file from cwd which isn't likely to change. *)
5765 [["mkdir"; "/download_offset"];
5766 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5767 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5768 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5769 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5770 "download a file to the local machine with offset and size",
5772 Download file C<remotefilename> and save it as C<filename>
5773 on the local machine.
5775 C<remotefilename> is read for C<size> bytes starting at C<offset>
5776 (this region must be within the file or device).
5778 Note that there is no limit on the amount of data that
5779 can be downloaded with this call, unlike with C<guestfs_pread>,
5780 and this call always reads the full amount unless an
5783 See also C<guestfs_download>, C<guestfs_pread>.");
5785 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5786 [InitPartition, Always, TestOutputListOfDevices (
5787 [["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"];
5788 ["blockdev_rereadpt"; "/dev/sda"];
5789 ["list_partitions"]], ["/dev/sdb1"])],
5790 "write to part of a device",
5792 This command writes to part of a device. It writes the data
5793 buffer C<content> to C<device> starting at offset C<offset>.
5795 This command implements the L<pwrite(2)> system call, and like
5796 that system call it may not write the full data requested
5797 (although short writes to disk devices and partitions are
5798 probably impossible with standard Linux kernels).
5800 See also C<guestfs_pwrite>.");
5802 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5803 [InitEmpty, Always, TestOutputBuffer (
5804 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5805 "read part of a device",
5807 This command lets you read part of a file. It reads C<count>
5808 bytes of C<device>, starting at C<offset>.
5810 This may read fewer bytes than requested. For further details
5811 see the L<pread(2)> system call.
5813 See also C<guestfs_pread>.");
5815 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5816 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5817 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5818 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5819 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5820 "get canonical name of an LV",
5822 This converts alternative naming schemes for LVs that you
5823 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5824 is converted to C</dev/VG/LV>.
5826 This command returns an error if the C<lvname> parameter does
5827 not refer to a logical volume.
5829 See also C<guestfs_is_lv>.");
5831 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5832 [InitEmpty, Always, TestOutput (
5833 [["part_disk"; "/dev/sda"; "mbr"];
5834 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5835 ["mount_options"; ""; "/dev/sda1"; "/"];
5836 ["write"; "/new"; "new file contents"];
5837 ["cat"; "/new"]], "new file contents")],
5838 "make a filesystem",
5840 This function creates a filesystem on C<device>. The filesystem
5841 type is C<fstype>, for example C<ext3>.
5843 The optional arguments are:
5849 The filesystem block size. Supported block sizes depend on the
5850 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5851 for Linux ext2/3 filesystems.
5853 For VFAT and NTFS the C<blocksize> parameter is treated as
5854 the requested cluster size.
5856 For UFS block sizes, please see L<mkfs.ufs(8)>.
5860 This passes the I<-O> parameter to the external mkfs program.
5862 For certain filesystem types, this allows extra filesystem
5863 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5866 You cannot use this optional parameter with the C<gfs> or
5867 C<gfs2> filesystem type.
5871 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5873 "get a single extended attribute",
5875 Get a single extended attribute from file C<path> named C<name>.
5876 This call follows symlinks. If you want to lookup an extended
5877 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5879 Normally it is better to get all extended attributes from a file
5880 in one go by calling C<guestfs_getxattrs>. However some Linux
5881 filesystem implementations are buggy and do not provide a way to
5882 list out attributes. For these filesystems (notably ntfs-3g)
5883 you have to know the names of the extended attributes you want
5884 in advance and call this function.
5886 Extended attribute values are blobs of binary data. If there
5887 is no extended attribute named C<name>, this returns an error.
5889 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5891 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5893 "get a single extended attribute",
5895 Get a single extended attribute from file C<path> named C<name>.
5896 If C<path> is a symlink, then this call returns an extended
5897 attribute from the symlink.
5899 Normally it is better to get all extended attributes from a file
5900 in one go by calling C<guestfs_getxattrs>. However some Linux
5901 filesystem implementations are buggy and do not provide a way to
5902 list out attributes. For these filesystems (notably ntfs-3g)
5903 you have to know the names of the extended attributes you want
5904 in advance and call this function.
5906 Extended attribute values are blobs of binary data. If there
5907 is no extended attribute named C<name>, this returns an error.
5909 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5911 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5913 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5915 This command is the same as C<guestfs_resize2fs>, but the filesystem
5916 is resized to its minimum size. This works like the I<-M> option
5917 to the C<resize2fs> command.
5919 To get the resulting size of the filesystem you should call
5920 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5921 values. These two numbers, multiplied together, give the
5922 resulting size of the minimal filesystem in bytes.");
5924 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5926 "internal autosync operation",
5928 This command performs the autosync operation just before the
5929 handle is closed. You should not call this command directly.
5930 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5931 control whether or not this operation is performed when the
5932 handle is closed.");
5936 let all_functions = non_daemon_functions @ daemon_functions
5938 (* In some places we want the functions to be displayed sorted
5939 * alphabetically, so this is useful:
5941 let all_functions_sorted = List.sort action_compare all_functions
5943 (* This is used to generate the src/MAX_PROC_NR file which
5944 * contains the maximum procedure number, a surrogate for the
5945 * ABI version number. See src/Makefile.am for the details.
5948 let proc_nrs = List.map (
5949 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
5950 ) daemon_functions in
5951 List.fold_left max 0 proc_nrs
5953 (* Non-API meta-commands available only in guestfish.
5955 * Note (1): style, proc_nr and tests fields are all meaningless.
5956 * The only fields which are actually used are the shortname,
5957 * FishAlias flags, shortdesc and longdesc.
5959 * Note (2): to refer to other commands, use L</shortname>.
5961 * Note (3): keep this list sorted by shortname.
5963 let fish_commands = [
5964 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
5965 "allocate and add a disk file",
5966 " alloc filename size
5968 This creates an empty (zeroed) file of the given size, and then adds
5969 so it can be further examined.
5971 For more advanced image creation, see L<qemu-img(1)> utility.
5973 Size can be specified using standard suffixes, eg. C<1M>.
5975 To create a sparse file, use L</sparse> instead. To create a
5976 prepared disk image, see L</PREPARED DISK IMAGES>.");
5978 ("copy_in", (RErr,[], []), -1, [], [],
5979 "copy local files or directories into an image",
5980 " copy-in local [local ...] /remotedir
5982 C<copy-in> copies local files or directories recursively into the disk
5983 image, placing them in the directory called C</remotedir> (which must
5984 exist). This guestfish meta-command turns into a sequence of
5985 L</tar-in> and other commands as necessary.
5987 Multiple local files and directories can be specified, but the last
5988 parameter must always be a remote directory. Wildcards cannot be
5991 ("copy_out", (RErr,[], []), -1, [], [],
5992 "copy remote files or directories out of an image",
5993 " copy-out remote [remote ...] localdir
5995 C<copy-out> copies remote files or directories recursively out of the
5996 disk image, placing them on the host disk in a local directory called
5997 C<localdir> (which must exist). This guestfish meta-command turns
5998 into a sequence of L</download>, L</tar-out> and other commands as
6001 Multiple remote files and directories can be specified, but the last
6002 parameter must always be a local directory. To download to the
6003 current directory, use C<.> as in:
6007 Wildcards cannot be used in the ordinary command, but you can use
6008 them with the help of L</glob> like this:
6010 glob copy-out /home/* .");
6012 ("echo", (RErr,[], []), -1, [], [],
6013 "display a line of text",
6016 This echos the parameters to the terminal.");
6018 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6022 This is used to edit a file. It downloads the file, edits it
6023 locally using your editor, then uploads the result.
6025 The editor is C<$EDITOR>. However if you use the alternate
6026 commands C<vi> or C<emacs> you will get those corresponding
6029 ("glob", (RErr,[], []), -1, [], [],
6030 "expand wildcards in command",
6031 " glob command args...
6033 Expand wildcards in any paths in the args list, and run C<command>
6034 repeatedly on each matching path.
6036 See L</WILDCARDS AND GLOBBING>.");
6038 ("hexedit", (RErr,[], []), -1, [], [],
6039 "edit with a hex editor",
6040 " hexedit <filename|device>
6041 hexedit <filename|device> <max>
6042 hexedit <filename|device> <start> <max>
6044 Use hexedit (a hex editor) to edit all or part of a binary file
6047 This command works by downloading potentially the whole file or
6048 device, editing it locally, then uploading it. If the file or
6049 device is large, you have to specify which part you wish to edit
6050 by using C<max> and/or C<start> C<max> parameters.
6051 C<start> and C<max> are specified in bytes, with the usual
6052 modifiers allowed such as C<1M> (1 megabyte).
6054 For example to edit the first few sectors of a disk you
6059 which would allow you to edit anywhere within the first megabyte
6062 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6064 hexedit /dev/sda1 0x400 0x400
6066 (assuming the superblock is in the standard location).
6068 This command requires the external L<hexedit(1)> program. You
6069 can specify another program to use by setting the C<HEXEDITOR>
6070 environment variable.
6072 See also L</hexdump>.");
6074 ("lcd", (RErr,[], []), -1, [], [],
6075 "change working directory",
6078 Change the local directory, ie. the current directory of guestfish
6081 Note that C<!cd> won't do what you might expect.");
6083 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6087 Opens the manual page for guestfish.");
6089 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6095 This is used to view a file.
6097 The default viewer is C<$PAGER>. However if you use the alternate
6098 command C<less> you will get the C<less> command specifically.");
6100 ("reopen", (RErr,[], []), -1, [], [],
6101 "close and reopen libguestfs handle",
6104 Close and reopen the libguestfs handle. It is not necessary to use
6105 this normally, because the handle is closed properly when guestfish
6106 exits. However this is occasionally useful for testing.");
6108 ("sparse", (RErr,[], []), -1, [], [],
6109 "create a sparse disk image and add",
6110 " sparse filename size
6112 This creates an empty sparse file of the given size, and then adds
6113 so it can be further examined.
6115 In all respects it works the same as the L</alloc> command, except that
6116 the image file is allocated sparsely, which means that disk blocks are
6117 not assigned to the file until they are needed. Sparse disk files
6118 only use space when written to, but they are slower and there is a
6119 danger you could run out of real disk space during a write operation.
6121 For more advanced image creation, see L<qemu-img(1)> utility.
6123 Size can be specified using standard suffixes, eg. C<1M>.");
6125 ("supported", (RErr,[], []), -1, [], [],
6126 "list supported groups of commands",
6129 This command returns a list of the optional groups
6130 known to the daemon, and indicates which ones are
6131 supported by this build of the libguestfs appliance.
6133 See also L<guestfs(3)/AVAILABILITY>.");
6135 ("time", (RErr,[], []), -1, [], [],
6136 "print elapsed time taken to run a command",
6137 " time command args...
6139 Run the command as usual, but print the elapsed time afterwards. This
6140 can be useful for benchmarking operations.");