2 * Copyright (C) 2009-2011 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"; Progress],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish; DeprecatedBy "launch"],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter I<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form I<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to make filesystems consistent and synchronized
286 when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages.
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
308 Verbose messages are normally sent to C<stderr>, unless you
309 register a callback to send them somewhere else (see
310 C<guestfs_set_event_callback>).");
312 ("get_verbose", (RBool "verbose", [], []), -1, [],
316 This returns the verbose messages flag.");
318 ("is_ready", (RBool "ready", [], []), -1, [],
319 [InitNone, Always, TestOutputTrue (
321 "is ready to accept commands",
323 This returns true iff this handle is ready to accept commands
324 (in the C<READY> state).
326 For more information on states, see L<guestfs(3)>.");
328 ("is_config", (RBool "config", [], []), -1, [],
329 [InitNone, Always, TestOutputFalse (
331 "is in configuration state",
333 This returns true iff this handle is being configured
334 (in the C<CONFIG> state).
336 For more information on states, see L<guestfs(3)>.");
338 ("is_launching", (RBool "launching", [], []), -1, [],
339 [InitNone, Always, TestOutputFalse (
340 [["is_launching"]])],
341 "is launching subprocess",
343 This returns true iff this handle is launching the subprocess
344 (in the C<LAUNCHING> state).
346 For more information on states, see L<guestfs(3)>.");
348 ("is_busy", (RBool "busy", [], []), -1, [],
349 [InitNone, Always, TestOutputFalse (
351 "is busy processing a command",
353 This returns true iff this handle is busy processing a command
354 (in the C<BUSY> state).
356 For more information on states, see L<guestfs(3)>.");
358 ("get_state", (RInt "state", [], []), -1, [],
360 "get the current state",
362 This returns the current state as an opaque integer. This is
363 only useful for printing debug and internal error messages.
365 For more information on states, see L<guestfs(3)>.");
367 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
368 [InitNone, Always, TestOutputInt (
369 [["set_memsize"; "500"];
370 ["get_memsize"]], 500)],
371 "set memory allocated to the qemu subprocess",
373 This sets the memory size in megabytes allocated to the
374 qemu subprocess. This only has any effect if called before
377 You can also change this by setting the environment
378 variable C<LIBGUESTFS_MEMSIZE> before the handle is
381 For more information on the architecture of libguestfs,
382 see L<guestfs(3)>.");
384 ("get_memsize", (RInt "memsize", [], []), -1, [],
385 [InitNone, Always, TestOutputIntOp (
386 [["get_memsize"]], ">=", 256)],
387 "get memory allocated to the qemu subprocess",
389 This gets the memory size in megabytes allocated to the
392 If C<guestfs_set_memsize> was not called
393 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
394 then this returns the compiled-in default value for memsize.
396 For more information on the architecture of libguestfs,
397 see L<guestfs(3)>.");
399 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
400 [InitNone, Always, TestOutputIntOp (
401 [["get_pid"]], ">=", 1)],
402 "get PID of qemu subprocess",
404 Return the process ID of the qemu subprocess. If there is no
405 qemu subprocess, then this will return an error.
407 This is an internal call used for debugging and testing.");
409 ("version", (RStruct ("version", "version"), [], []), -1, [],
410 [InitNone, Always, TestOutputStruct (
411 [["version"]], [CompareWithInt ("major", 1)])],
412 "get the library version number",
414 Return the libguestfs version number that the program is linked
417 Note that because of dynamic linking this is not necessarily
418 the version of libguestfs that you compiled against. You can
419 compile the program, and then at runtime dynamically link
420 against a completely different C<libguestfs.so> library.
422 This call was added in version C<1.0.58>. In previous
423 versions of libguestfs there was no way to get the version
424 number. From C code you can use dynamic linker functions
425 to find out if this symbol exists (if it doesn't, then
426 it's an earlier version).
428 The call returns a structure with four elements. The first
429 three (C<major>, C<minor> and C<release>) are numbers and
430 correspond to the usual version triplet. The fourth element
431 (C<extra>) is a string and is normally empty, but may be
432 used for distro-specific information.
434 To construct the original version string:
435 C<$major.$minor.$release$extra>
437 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
439 I<Note:> Don't use this call to test for availability
440 of features. In enterprise distributions we backport
441 features from later versions into earlier versions,
442 making this an unreliable way to test for features.
443 Use C<guestfs_available> instead.");
445 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
446 [InitNone, Always, TestOutputTrue (
447 [["set_selinux"; "true"];
449 "set SELinux enabled or disabled at appliance boot",
451 This sets the selinux flag that is passed to the appliance
452 at boot time. The default is C<selinux=0> (disabled).
454 Note that if SELinux is enabled, it is always in
455 Permissive mode (C<enforcing=0>).
457 For more information on the architecture of libguestfs,
458 see L<guestfs(3)>.");
460 ("get_selinux", (RBool "selinux", [], []), -1, [],
462 "get SELinux enabled flag",
464 This returns the current setting of the selinux flag which
465 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
467 For more information on the architecture of libguestfs,
468 see L<guestfs(3)>.");
470 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
471 [InitNone, Always, TestOutputFalse (
472 [["set_trace"; "false"];
474 "enable or disable command traces",
476 If the command trace flag is set to 1, then libguestfs
477 calls, parameters and return values are traced.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.
486 Trace messages are normally sent to C<stderr>, unless you
487 register a callback to send them somewhere else (see
488 C<guestfs_set_event_callback>).");
490 ("get_trace", (RBool "trace", [], []), -1, [],
492 "get command trace enabled flag",
494 Return the command trace flag.");
496 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
497 [InitNone, Always, TestOutputFalse (
498 [["set_direct"; "false"];
500 "enable or disable direct appliance mode",
502 If the direct appliance mode flag is enabled, then stdin and
503 stdout are passed directly through to the appliance once it
506 One consequence of this is that log messages aren't caught
507 by the library and handled by C<guestfs_set_log_message_callback>,
508 but go straight to stdout.
510 You probably don't want to use this unless you know what you
513 The default is disabled.");
515 ("get_direct", (RBool "direct", [], []), -1, [],
517 "get direct appliance mode flag",
519 Return the direct appliance mode flag.");
521 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
522 [InitNone, Always, TestOutputTrue (
523 [["set_recovery_proc"; "true"];
524 ["get_recovery_proc"]])],
525 "enable or disable the recovery process",
527 If this is called with the parameter C<false> then
528 C<guestfs_launch> does not create a recovery process. The
529 purpose of the recovery process is to stop runaway qemu
530 processes in the case where the main program aborts abruptly.
532 This only has any effect if called before C<guestfs_launch>,
533 and the default is true.
535 About the only time when you would want to disable this is
536 if the main process will fork itself into the background
537 (\"daemonize\" itself). In this case the recovery process
538 thinks that the main program has disappeared and so kills
539 qemu, which is not very helpful.");
541 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
543 "get recovery process enabled flag",
545 Return the recovery process enabled flag.");
547 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
549 "add a drive specifying the QEMU block emulation to use",
551 This is the same as C<guestfs_add_drive> but it allows you
552 to specify the QEMU interface emulation to use at run time.");
554 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
556 "add a drive read-only specifying the QEMU block emulation to use",
558 This is the same as C<guestfs_add_drive_ro> but it allows you
559 to specify the QEMU interface emulation to use at run time.");
561 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
562 [InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-win32.exe"]], "i386");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-i586.so"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-sparc.so"]], "sparc");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-win32.dll"]], "i386");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
582 InitISOFS, Always, TestOutput (
583 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
584 InitISOFS, Always, TestOutput (
585 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
586 "detect the architecture of a binary file",
588 This detects the architecture of the binary C<filename>,
589 and returns it if known.
591 Currently defined architectures are:
597 This string is returned for all 32 bit i386, i486, i586, i686 binaries
598 irrespective of the precise processor requirements of the binary.
610 64 bit SPARC V9 and above.
626 Libguestfs may return other architecture strings in future.
628 The function works on at least the following types of files:
634 many types of Un*x and Linux binary
638 many types of Un*x and Linux shared library
642 Windows Win32 and Win64 binaries
646 Windows Win32 and Win64 DLLs
648 Win32 binaries and DLLs return C<i386>.
650 Win64 binaries and DLLs return C<x86_64>.
658 Linux new-style initrd images
662 some non-x86 Linux vmlinuz kernels
666 What it can't do currently:
672 static libraries (libfoo.a)
676 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
680 x86 Linux vmlinuz kernels
682 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
683 compressed code, and are horribly hard to unpack. If you want to find
684 the architecture of a kernel, use the architecture of the associated
685 initrd or kernel module(s) instead.
689 ("inspect_os", (RStringList "roots", [], []), -1, [],
691 "inspect disk and return list of operating systems found",
693 This function uses other libguestfs functions and certain
694 heuristics to inspect the disk(s) (usually disks belonging to
695 a virtual machine), looking for operating systems.
697 The list returned is empty if no operating systems were found.
699 If one operating system was found, then this returns a list with
700 a single element, which is the name of the root filesystem of
701 this operating system. It is also possible for this function
702 to return a list containing more than one element, indicating
703 a dual-boot or multi-boot virtual machine, with each element being
704 the root filesystem of one of the operating systems.
706 You can pass the root string(s) returned to other
707 C<guestfs_inspect_get_*> functions in order to query further
708 information about each operating system, such as the name
711 This function uses other libguestfs features such as
712 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
713 and unmount filesystems and look at the contents. This should
714 be called with no disks currently mounted. The function may also
715 use Augeas, so any existing Augeas handle will be closed.
717 This function cannot decrypt encrypted disks. The caller
718 must do that first (supplying the necessary keys) if the
721 Please read L<guestfs(3)/INSPECTION> for more details.
723 See also C<guestfs_list_filesystems>.");
725 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
727 "get type of inspected operating system",
729 This returns the type of the inspected operating system.
730 Currently defined types are:
736 Any Linux-based operating system.
740 Any Microsoft Windows operating system.
748 The operating system type could not be determined.
752 Future versions of libguestfs may return other strings here.
753 The caller should be prepared to handle any string.
755 Please read L<guestfs(3)/INSPECTION> for more details.");
757 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
759 "get architecture of inspected operating system",
761 This returns the architecture of the inspected operating system.
762 The possible return values are listed under
763 C<guestfs_file_architecture>.
765 If the architecture could not be determined, then the
766 string C<unknown> is returned.
768 Please read L<guestfs(3)/INSPECTION> for more details.");
770 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
772 "get distro of inspected operating system",
774 This returns the distro (distribution) of the inspected operating
777 Currently defined distros are:
817 =item \"redhat-based\"
819 Some Red Hat-derived distro.
823 Red Hat Enterprise Linux.
825 =item \"scientificlinux\"
839 The distro could not be determined.
843 Windows does not have distributions. This string is
844 returned if the OS type is Windows.
848 Future versions of libguestfs may return other strings here.
849 The caller should be prepared to handle any string.
851 Please read L<guestfs(3)/INSPECTION> for more details.");
853 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
855 "get major version of inspected operating system",
857 This returns the major version number of the inspected operating
860 Windows uses a consistent versioning scheme which is I<not>
861 reflected in the popular public names used by the operating system.
862 Notably the operating system known as \"Windows 7\" is really
863 version 6.1 (ie. major = 6, minor = 1). You can find out the
864 real versions corresponding to releases of Windows by consulting
867 If the version could not be determined, then C<0> is returned.
869 Please read L<guestfs(3)/INSPECTION> for more details.");
871 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
873 "get minor version of inspected operating system",
875 This returns the minor version number of the inspected operating
878 If the version could not be determined, then C<0> is returned.
880 Please read L<guestfs(3)/INSPECTION> for more details.
881 See also C<guestfs_inspect_get_major_version>.");
883 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
885 "get product name of inspected operating system",
887 This returns the product name of the inspected operating
888 system. The product name is generally some freeform string
889 which can be displayed to the user, but should not be
892 If the product name could not be determined, then the
893 string C<unknown> is returned.
895 Please read L<guestfs(3)/INSPECTION> for more details.");
897 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
899 "get mountpoints of inspected operating system",
901 This returns a hash of where we think the filesystems
902 associated with this operating system should be mounted.
903 Callers should note that this is at best an educated guess
904 made by reading configuration files such as C</etc/fstab>.
905 I<In particular note> that this may return filesystems
906 which are non-existent or not mountable and callers should
907 be prepared to handle or ignore failures if they try to
910 Each element in the returned hashtable has a key which
911 is the path of the mountpoint (eg. C</boot>) and a value
912 which is the filesystem that would be mounted there
915 Non-mounted devices such as swap devices are I<not>
916 returned in this list.
918 For operating systems like Windows which still use drive
919 letters, this call will only return an entry for the first
920 drive \"mounted on\" C</>. For information about the
921 mapping of drive letters to partitions, see
922 C<guestfs_inspect_get_drive_mappings>.
924 Please read L<guestfs(3)/INSPECTION> for more details.
925 See also C<guestfs_inspect_get_filesystems>.");
927 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
929 "get filesystems associated with inspected operating system",
931 This returns a list of all the filesystems that we think
932 are associated with this operating system. This includes
933 the root filesystem, other ordinary filesystems, and
934 non-mounted devices like swap partitions.
936 In the case of a multi-boot virtual machine, it is possible
937 for a filesystem to be shared between operating systems.
939 Please read L<guestfs(3)/INSPECTION> for more details.
940 See also C<guestfs_inspect_get_mountpoints>.");
942 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
944 "set enable network flag",
946 If C<network> is true, then the network is enabled in the
947 libguestfs appliance. The default is false.
949 This affects whether commands are able to access the network
950 (see L<guestfs(3)/RUNNING COMMANDS>).
952 You must call this before calling C<guestfs_launch>, otherwise
955 ("get_network", (RBool "network", [], []), -1, [],
957 "get enable network flag",
959 This returns the enable network flag.");
961 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
965 This inspection command looks for filesystems on partitions,
966 block devices and logical volumes, returning a list of devices
967 containing filesystems and their type.
969 The return value is a hash, where the keys are the devices
970 containing filesystems, and the values are the filesystem types.
973 \"/dev/sda1\" => \"ntfs\"
974 \"/dev/sda2\" => \"ext2\"
975 \"/dev/vg_guest/lv_root\" => \"ext4\"
976 \"/dev/vg_guest/lv_swap\" => \"swap\"
978 The value can have the special value \"unknown\", meaning the
979 content of the device is undetermined or empty.
980 \"swap\" means a Linux swap partition.
982 This command runs other libguestfs commands, which might include
983 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
984 use this soon after launch and only when nothing is mounted.
986 Not all of the filesystems returned will be mountable. In
987 particular, swap partitions are returned in the list. Also
988 this command does not check that each filesystem
989 found is valid and mountable, and some filesystems might
990 be mountable but require special options. Filesystems may
991 not all belong to a single logical operating system
992 (use C<guestfs_inspect_os> to look for OSes).");
994 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"]), -1, [FishAlias "add"],
996 "add an image to examine or modify",
998 This function adds a virtual machine disk image C<filename> to
999 libguestfs. The first time you call this function, the disk
1000 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1003 You don't necessarily need to be root when using libguestfs. However
1004 you obviously do need sufficient permissions to access the filename
1005 for whatever operations you want to perform (ie. read access if you
1006 just want to read the image or write access if you want to modify the
1009 This call checks that C<filename> exists.
1011 The optional arguments are:
1017 If true then the image is treated as read-only. Writes are still
1018 allowed, but they are stored in a temporary snapshot overlay which
1019 is discarded at the end. The disk that you add is not modified.
1023 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1024 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1025 Possible formats include C<raw> and C<qcow2>.
1027 Automatic detection of the format opens you up to a potential
1028 security hole when dealing with untrusted raw-format images.
1029 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1034 This rarely-used option lets you emulate the behaviour of the
1035 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1039 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1041 "get Windows systemroot of inspected operating system",
1043 This returns the Windows systemroot of the inspected guest.
1044 The systemroot is a directory path such as C</WINDOWS>.
1046 This call assumes that the guest is Windows and that the
1047 systemroot could be determined by inspection. If this is not
1048 the case then an error is returned.
1050 Please read L<guestfs(3)/INSPECTION> for more details.");
1052 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1054 "return list of operating systems found by last inspection",
1056 This function is a convenient way to get the list of root
1057 devices, as returned from a previous call to C<guestfs_inspect_os>,
1058 but without redoing the whole inspection process.
1060 This returns an empty list if either no root devices were
1061 found or the caller has not called C<guestfs_inspect_os>.
1063 Please read L<guestfs(3)/INSPECTION> for more details.");
1065 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1067 "debug the QEMU command line (internal use only)",
1069 This returns the internal QEMU command line. 'debug' commands are
1070 not part of the formal API and can be removed or changed at any time.");
1072 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"]), -1, [FishAlias "domain"],
1074 "add the disk(s) from a named libvirt domain",
1076 This function adds the disk(s) attached to the named libvirt
1077 domain C<dom>. It works by connecting to libvirt, requesting
1078 the domain and domain XML from libvirt, parsing it for disks,
1079 and calling C<guestfs_add_drive_opts> on each one.
1081 The number of disks added is returned. This operation is atomic:
1082 if an error is returned, then no disks are added.
1084 This function does some minimal checks to make sure the libvirt
1085 domain is not running (unless C<readonly> is true). In a future
1086 version we will try to acquire the libvirt lock on each disk.
1088 Disks must be accessible locally. This often means that adding disks
1089 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1090 will fail unless those disks are accessible via the same device path
1093 The optional C<libvirturi> parameter sets the libvirt URI
1094 (see L<http://libvirt.org/uri.html>). If this is not set then
1095 we connect to the default libvirt URI (or one set through an
1096 environment variable, see the libvirt documentation for full
1099 The optional C<live> flag controls whether this call will try
1100 to connect to a running virtual machine C<guestfsd> process if
1101 it sees a suitable E<lt>channelE<gt> element in the libvirt
1102 XML definition. The default (if the flag is omitted) is never
1103 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1106 If the C<allowuuid> flag is true (default is false) then a UUID
1107 I<may> be passed instead of the domain name. The C<dom> string is
1108 treated as a UUID first and looked up, and if that lookup fails
1109 then we treat C<dom> as a name as usual.
1111 The other optional parameters are passed directly through to
1112 C<guestfs_add_drive_opts>.");
1115 This interface is not quite baked yet. -- RWMJ 2010-11-11
1116 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"]), -1, [NotInFish],
1118 "add the disk(s) from a libvirt domain",
1120 This function adds the disk(s) attached to the libvirt domain C<dom>.
1121 It works by requesting the domain XML from libvirt, parsing it for
1122 disks, and calling C<guestfs_add_drive_opts> on each one.
1124 In the C API we declare C<void *dom>, but really it has type
1125 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1127 The number of disks added is returned. This operation is atomic:
1128 if an error is returned, then no disks are added.
1130 This function does some minimal checks to make sure the libvirt
1131 domain is not running (unless C<readonly> is true). In a future
1132 version we will try to acquire the libvirt lock on each disk.
1134 Disks must be accessible locally. This often means that adding disks
1135 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1136 will fail unless those disks are accessible via the same device path
1139 The optional C<live> flag controls whether this call will try
1140 to connect to a running virtual machine C<guestfsd> process if
1141 it sees a suitable E<lt>channelE<gt> element in the libvirt
1142 XML definition. The default (if the flag is omitted) is never
1143 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1146 The other optional parameters are passed directly through to
1147 C<guestfs_add_drive_opts>.");
1150 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1152 "get package format used by the operating system",
1154 This function and C<guestfs_inspect_get_package_management> return
1155 the package format and package management tool used by the
1156 inspected operating system. For example for Fedora these
1157 functions would return C<rpm> (package format) and
1158 C<yum> (package management).
1160 This returns the string C<unknown> if we could not determine the
1161 package format I<or> if the operating system does not have
1162 a real packaging system (eg. Windows).
1164 Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.
1165 Future versions of libguestfs may return other strings.
1167 Please read L<guestfs(3)/INSPECTION> for more details.");
1169 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1171 "get package management tool used by the operating system",
1173 C<guestfs_inspect_get_package_format> and this function return
1174 the package format and package management tool used by the
1175 inspected operating system. For example for Fedora these
1176 functions would return C<rpm> (package format) and
1177 C<yum> (package management).
1179 This returns the string C<unknown> if we could not determine the
1180 package management tool I<or> if the operating system does not have
1181 a real packaging system (eg. Windows).
1183 Possible strings include: C<yum>, C<up2date>,
1184 C<apt> (for all Debian derivatives),
1185 C<portage>, C<pisi>, C<pacman>, C<urpmi>.
1186 Future versions of libguestfs may return other strings.
1188 Please read L<guestfs(3)/INSPECTION> for more details.");
1190 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1192 "get list of applications installed in the operating system",
1194 Return the list of applications installed in the operating system.
1196 I<Note:> This call works differently from other parts of the
1197 inspection API. You have to call C<guestfs_inspect_os>, then
1198 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1199 before calling this. Listing applications is a significantly
1200 more difficult operation which requires access to the full
1201 filesystem. Also note that unlike the other
1202 C<guestfs_inspect_get_*> calls which are just returning
1203 data cached in the libguestfs handle, this call actually reads
1204 parts of the mounted filesystems during the call.
1206 This returns an empty list if the inspection code was not able
1207 to determine the list of applications.
1209 The application structure contains the following fields:
1215 The name of the application. For Red Hat-derived and Debian-derived
1216 Linux guests, this is the package name.
1218 =item C<app_display_name>
1220 The display name of the application, sometimes localized to the
1221 install language of the guest operating system.
1223 If unavailable this is returned as an empty string C<\"\">.
1224 Callers needing to display something can use C<app_name> instead.
1228 For package managers which use epochs, this contains the epoch of
1229 the package (an integer). If unavailable, this is returned as C<0>.
1231 =item C<app_version>
1233 The version string of the application or package. If unavailable
1234 this is returned as an empty string C<\"\">.
1236 =item C<app_release>
1238 The release string of the application or package, for package
1239 managers that use this. If unavailable this is returned as an
1240 empty string C<\"\">.
1242 =item C<app_install_path>
1244 The installation path of the application (on operating systems
1245 such as Windows which use installation paths). This path is
1246 in the format used by the guest operating system, it is not
1249 If unavailable this is returned as an empty string C<\"\">.
1251 =item C<app_trans_path>
1253 The install path translated into a libguestfs path.
1254 If unavailable this is returned as an empty string C<\"\">.
1256 =item C<app_publisher>
1258 The name of the publisher of the application, for package
1259 managers that use this. If unavailable this is returned
1260 as an empty string C<\"\">.
1264 The URL (eg. upstream URL) of the application.
1265 If unavailable this is returned as an empty string C<\"\">.
1267 =item C<app_source_package>
1269 For packaging systems which support this, the name of the source
1270 package. If unavailable this is returned as an empty string C<\"\">.
1272 =item C<app_summary>
1274 A short (usually one line) description of the application or package.
1275 If unavailable this is returned as an empty string C<\"\">.
1277 =item C<app_description>
1279 A longer description of the application or package.
1280 If unavailable this is returned as an empty string C<\"\">.
1284 Please read L<guestfs(3)/INSPECTION> for more details.");
1286 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1288 "get hostname of the operating system",
1290 This function returns the hostname of the operating system
1291 as found by inspection of the guest's configuration files.
1293 If the hostname could not be determined, then the
1294 string C<unknown> is returned.
1296 Please read L<guestfs(3)/INSPECTION> for more details.");
1298 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1300 "get format of inspected operating system",
1302 This returns the format of the inspected operating system. You
1303 can use it to detect install images, live CDs and similar.
1305 Currently defined formats are:
1311 This is an installed operating system.
1315 The disk image being inspected is not an installed operating system,
1316 but a I<bootable> install disk, live CD, or similar.
1320 The format of this disk image is not known.
1324 Future versions of libguestfs may return other strings here.
1325 The caller should be prepared to handle any string.
1327 Please read L<guestfs(3)/INSPECTION> for more details.");
1329 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1331 "get live flag for install disk",
1333 If C<guestfs_inspect_get_format> returns C<installer> (this
1334 is an install disk), then this returns true if a live image
1335 was detected on the disk.
1337 Please read L<guestfs(3)/INSPECTION> for more details.");
1339 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1341 "get netinst (network installer) flag for install disk",
1343 If C<guestfs_inspect_get_format> returns C<installer> (this
1344 is an install disk), then this returns true if the disk is
1345 a network installer, ie. not a self-contained install CD but
1346 one which is likely to require network access to complete
1349 Please read L<guestfs(3)/INSPECTION> for more details.");
1351 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1353 "get multipart flag for install disk",
1355 If C<guestfs_inspect_get_format> returns C<installer> (this
1356 is an install disk), then this returns true if the disk is
1359 Please read L<guestfs(3)/INSPECTION> for more details.");
1361 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1363 "set the attach method",
1365 Set the method that libguestfs uses to connect to the back end
1366 guestfsd daemon. Possible methods are:
1372 Launch an appliance and connect to it. This is the ordinary method
1375 =item C<unix:I<path>>
1377 Connect to the Unix domain socket I<path>.
1379 This method lets you connect to an existing daemon or (using
1380 virtio-serial) to a live guest. For more information, see
1381 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1385 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1386 [InitNone, Always, TestOutput (
1387 [["get_attach_method"]], "appliance")],
1388 "get the attach method",
1390 Return the current attach method. See C<guestfs_set_attach_method>.");
1392 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1394 "get product variant of inspected operating system",
1396 This returns the product variant of the inspected operating
1399 For Windows guests, this returns the contents of the Registry key
1400 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1401 C<InstallationType> which is usually a string such as
1402 C<Client> or C<Server> (other values are possible). This
1403 can be used to distinguish consumer and enterprise versions
1404 of Windows that have the same version number (for example,
1405 Windows 7 and Windows 2008 Server are both version 6.1,
1406 but the former is C<Client> and the latter is C<Server>).
1408 For enterprise Linux guests, in future we intend this to return
1409 the product variant such as C<Desktop>, C<Server> and so on. But
1410 this is not implemented at present.
1412 If the product variant could not be determined, then the
1413 string C<unknown> is returned.
1415 Please read L<guestfs(3)/INSPECTION> for more details.
1416 See also C<guestfs_inspect_get_product_name>,
1417 C<guestfs_inspect_get_major_version>.");
1419 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1421 "get Windows CurrentControlSet of inspected operating system",
1423 This returns the Windows CurrentControlSet of the inspected guest.
1424 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1426 This call assumes that the guest is Windows and that the
1427 Registry could be examined by inspection. If this is not
1428 the case then an error is returned.
1430 Please read L<guestfs(3)/INSPECTION> for more details.");
1432 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1434 "get drive letter mappings",
1436 This call is useful for Windows which uses a primitive system
1437 of assigning drive letters (like \"C:\") to partitions.
1438 This inspection API examines the Windows Registry to find out
1439 how disks/partitions are mapped to drive letters, and returns
1440 a hash table as in the example below:
1446 Note that keys are drive letters. For Windows, the key is
1447 case insensitive and just contains the drive letter, without
1448 the customary colon separator character.
1450 In future we may support other operating systems that also used drive
1451 letters, but the keys for those might not be case insensitive
1452 and might be longer than 1 character. For example in OS-9,
1453 hard drives were named C<h0>, C<h1> etc.
1455 For Windows guests, currently only hard drive mappings are
1456 returned. Removable disks (eg. DVD-ROMs) are ignored.
1458 For guests that do not use drive mappings, or if the drive mappings
1459 could not be determined, this returns an empty hash table.
1461 Please read L<guestfs(3)/INSPECTION> for more details.
1462 See also C<guestfs_inspect_get_mountpoints>,
1463 C<guestfs_inspect_get_filesystems>.");
1465 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1467 "get the icon corresponding to this operating system",
1469 This function returns an icon corresponding to the inspected
1470 operating system. The icon is returned as a buffer containing a
1471 PNG image (re-encoded to PNG if necessary).
1473 If it was not possible to get an icon this function returns a
1474 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1476 Libguestfs will start by looking for a file called
1477 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1478 and if it has the correct format, the contents of this file will
1479 be returned. You can disable favicons by passing the
1480 optional C<favicon> boolean as false (default is true).
1482 If finding the favicon fails, then we look in other places in the
1483 guest for a suitable icon.
1485 If the optional C<highquality> boolean is true then
1486 only high quality icons are returned, which means only icons of
1487 high resolution with an alpha channel. The default (false) is
1488 to return any icon we can, even if it is of substandard quality.
1496 Unlike most other inspection API calls, the guest's disks must be
1497 mounted up before you call this, since it needs to read information
1498 from the guest filesystem during the call.
1502 B<Security:> The icon data comes from the untrusted guest,
1503 and should be treated with caution. PNG files have been
1504 known to contain exploits. Ensure that libpng (or other relevant
1505 libraries) are fully up to date before trying to process or
1510 The PNG image returned can be any size. It might not be square.
1511 Libguestfs tries to return the largest, highest quality
1512 icon available. The application must scale the icon to the
1517 Extracting icons from Windows guests requires the external
1518 C<wrestool> program from the C<icoutils> package, and
1519 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1520 from the C<netpbm> package. These must be installed separately.
1524 Operating system icons are usually trademarks. Seek legal
1525 advice before using trademarks in applications.
1531 (* daemon_functions are any functions which cause some action
1532 * to take place in the daemon.
1535 let daemon_functions = [
1536 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [DeprecatedBy "mount_options"],
1537 [InitEmpty, Always, TestOutput (
1538 [["part_disk"; "/dev/sda"; "mbr"];
1539 ["mkfs"; "ext2"; "/dev/sda1"];
1540 ["mount"; "/dev/sda1"; "/"];
1541 ["write"; "/new"; "new file contents"];
1542 ["cat"; "/new"]], "new file contents")],
1543 "mount a guest disk at a position in the filesystem",
1545 Mount a guest disk at a position in the filesystem. Block devices
1546 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1547 the guest. If those block devices contain partitions, they will have
1548 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1551 The rules are the same as for L<mount(2)>: A filesystem must
1552 first be mounted on C</> before others can be mounted. Other
1553 filesystems can only be mounted on directories which already
1556 The mounted filesystem is writable, if we have sufficient permissions
1557 on the underlying device.
1560 When you use this call, the filesystem options C<sync> and C<noatime>
1561 are set implicitly. This was originally done because we thought it
1562 would improve reliability, but it turns out that I<-o sync> has a
1563 very large negative performance impact and negligible effect on
1564 reliability. Therefore we recommend that you avoid using
1565 C<guestfs_mount> in any code that needs performance, and instead
1566 use C<guestfs_mount_options> (use an empty string for the first
1567 parameter if you don't want any options).");
1569 ("sync", (RErr, [], []), 2, [],
1570 [ InitEmpty, Always, TestRun [["sync"]]],
1571 "sync disks, writes are flushed through to the disk image",
1573 This syncs the disk, so that any writes are flushed through to the
1574 underlying disk image.
1576 You should always call this if you have modified a disk image, before
1577 closing the handle.");
1579 ("touch", (RErr, [Pathname "path"], []), 3, [],
1580 [InitScratchFS, Always, TestOutputTrue (
1581 [["touch"; "/touch"];
1582 ["exists"; "/touch"]])],
1583 "update file timestamps or create a new file",
1585 Touch acts like the L<touch(1)> command. It can be used to
1586 update the timestamps on a file, or, if the file does not exist,
1587 to create a new zero-length file.
1589 This command only works on regular files, and will fail on other
1590 file types such as directories, symbolic links, block special etc.");
1592 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1593 [InitISOFS, Always, TestOutput (
1594 [["cat"; "/known-2"]], "abcdef\n")],
1595 "list the contents of a file",
1597 Return the contents of the file named C<path>.
1599 Note that this function cannot correctly handle binary files
1600 (specifically, files containing C<\\0> character which is treated
1601 as end of string). For those you need to use the C<guestfs_read_file>
1602 or C<guestfs_download> functions which have a more complex interface.");
1604 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1605 [], (* XXX Tricky to test because it depends on the exact format
1606 * of the 'ls -l' command, which changes between F10 and F11.
1608 "list the files in a directory (long format)",
1610 List the files in C<directory> (relative to the root directory,
1611 there is no cwd) in the format of 'ls -la'.
1613 This command is mostly useful for interactive sessions. It
1614 is I<not> intended that you try to parse the output string.");
1616 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1617 [InitScratchFS, Always, TestOutputList (
1619 ["touch"; "/ls/new"];
1620 ["touch"; "/ls/newer"];
1621 ["touch"; "/ls/newest"];
1622 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1623 "list the files in a directory",
1625 List the files in C<directory> (relative to the root directory,
1626 there is no cwd). The '.' and '..' entries are not returned, but
1627 hidden files are shown.
1629 This command is mostly useful for interactive sessions. Programs
1630 should probably use C<guestfs_readdir> instead.");
1632 ("list_devices", (RStringList "devices", [], []), 7, [],
1633 [InitEmpty, Always, TestOutputListOfDevices (
1634 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1635 "list the block devices",
1637 List all the block devices.
1639 The full block device names are returned, eg. C</dev/sda>.
1641 See also C<guestfs_list_filesystems>.");
1643 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1644 [InitBasicFS, Always, TestOutputListOfDevices (
1645 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1646 InitEmpty, Always, TestOutputListOfDevices (
1647 [["part_init"; "/dev/sda"; "mbr"];
1648 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1649 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1650 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1651 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1652 "list the partitions",
1654 List all the partitions detected on all block devices.
1656 The full partition device names are returned, eg. C</dev/sda1>
1658 This does not return logical volumes. For that you will need to
1659 call C<guestfs_lvs>.
1661 See also C<guestfs_list_filesystems>.");
1663 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1664 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1665 [["pvs"]], ["/dev/sda1"]);
1666 InitEmpty, Always, TestOutputListOfDevices (
1667 [["part_init"; "/dev/sda"; "mbr"];
1668 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1669 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1670 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1671 ["pvcreate"; "/dev/sda1"];
1672 ["pvcreate"; "/dev/sda2"];
1673 ["pvcreate"; "/dev/sda3"];
1674 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1675 "list the LVM physical volumes (PVs)",
1677 List all the physical volumes detected. This is the equivalent
1678 of the L<pvs(8)> command.
1680 This returns a list of just the device names that contain
1681 PVs (eg. C</dev/sda2>).
1683 See also C<guestfs_pvs_full>.");
1685 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1686 [InitBasicFSonLVM, Always, TestOutputList (
1688 InitEmpty, Always, TestOutputList (
1689 [["part_init"; "/dev/sda"; "mbr"];
1690 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1691 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1692 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1693 ["pvcreate"; "/dev/sda1"];
1694 ["pvcreate"; "/dev/sda2"];
1695 ["pvcreate"; "/dev/sda3"];
1696 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1697 ["vgcreate"; "VG2"; "/dev/sda3"];
1698 ["vgs"]], ["VG1"; "VG2"])],
1699 "list the LVM volume groups (VGs)",
1701 List all the volumes groups detected. This is the equivalent
1702 of the L<vgs(8)> command.
1704 This returns a list of just the volume group names that were
1705 detected (eg. C<VolGroup00>).
1707 See also C<guestfs_vgs_full>.");
1709 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1710 [InitBasicFSonLVM, Always, TestOutputList (
1711 [["lvs"]], ["/dev/VG/LV"]);
1712 InitEmpty, Always, TestOutputList (
1713 [["part_init"; "/dev/sda"; "mbr"];
1714 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1715 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1716 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1717 ["pvcreate"; "/dev/sda1"];
1718 ["pvcreate"; "/dev/sda2"];
1719 ["pvcreate"; "/dev/sda3"];
1720 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1721 ["vgcreate"; "VG2"; "/dev/sda3"];
1722 ["lvcreate"; "LV1"; "VG1"; "50"];
1723 ["lvcreate"; "LV2"; "VG1"; "50"];
1724 ["lvcreate"; "LV3"; "VG2"; "50"];
1725 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1726 "list the LVM logical volumes (LVs)",
1728 List all the logical volumes detected. This is the equivalent
1729 of the L<lvs(8)> command.
1731 This returns a list of the logical volume device names
1732 (eg. C</dev/VolGroup00/LogVol00>).
1734 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1736 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1737 [], (* XXX how to test? *)
1738 "list the LVM physical volumes (PVs)",
1740 List all the physical volumes detected. This is the equivalent
1741 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1743 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1744 [], (* XXX how to test? *)
1745 "list the LVM volume groups (VGs)",
1747 List all the volumes groups detected. This is the equivalent
1748 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1750 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1751 [], (* XXX how to test? *)
1752 "list the LVM logical volumes (LVs)",
1754 List all the logical volumes detected. This is the equivalent
1755 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1757 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1758 [InitISOFS, Always, TestOutputList (
1759 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1760 InitISOFS, Always, TestOutputList (
1761 [["read_lines"; "/empty"]], [])],
1762 "read file as lines",
1764 Return the contents of the file named C<path>.
1766 The file contents are returned as a list of lines. Trailing
1767 C<LF> and C<CRLF> character sequences are I<not> returned.
1769 Note that this function cannot correctly handle binary files
1770 (specifically, files containing C<\\0> character which is treated
1771 as end of line). For those you need to use the C<guestfs_read_file>
1772 function which has a more complex interface.");
1774 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1775 [], (* XXX Augeas code needs tests. *)
1776 "create a new Augeas handle",
1778 Create a new Augeas handle for editing configuration files.
1779 If there was any previous Augeas handle associated with this
1780 guestfs session, then it is closed.
1782 You must call this before using any other C<guestfs_aug_*>
1785 C<root> is the filesystem root. C<root> must not be NULL,
1788 The flags are the same as the flags defined in
1789 E<lt>augeas.hE<gt>, the logical I<or> of the following
1794 =item C<AUG_SAVE_BACKUP> = 1
1796 Keep the original file with a C<.augsave> extension.
1798 =item C<AUG_SAVE_NEWFILE> = 2
1800 Save changes into a file with extension C<.augnew>, and
1801 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1803 =item C<AUG_TYPE_CHECK> = 4
1805 Typecheck lenses (can be expensive).
1807 =item C<AUG_NO_STDINC> = 8
1809 Do not use standard load path for modules.
1811 =item C<AUG_SAVE_NOOP> = 16
1813 Make save a no-op, just record what would have been changed.
1815 =item C<AUG_NO_LOAD> = 32
1817 Do not load the tree in C<guestfs_aug_init>.
1821 To close the handle, you can call C<guestfs_aug_close>.
1823 To find out more about Augeas, see L<http://augeas.net/>.");
1825 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1826 [], (* XXX Augeas code needs tests. *)
1827 "close the current Augeas handle",
1829 Close the current Augeas handle and free up any resources
1830 used by it. After calling this, you have to call
1831 C<guestfs_aug_init> again before you can use any other
1832 Augeas functions.");
1834 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1835 [], (* XXX Augeas code needs tests. *)
1836 "define an Augeas variable",
1838 Defines an Augeas variable C<name> whose value is the result
1839 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1842 On success this returns the number of nodes in C<expr>, or
1843 C<0> if C<expr> evaluates to something which is not a nodeset.");
1845 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1846 [], (* XXX Augeas code needs tests. *)
1847 "define an Augeas node",
1849 Defines a variable C<name> whose value is the result of
1852 If C<expr> evaluates to an empty nodeset, a node is created,
1853 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1854 C<name> will be the nodeset containing that single node.
1856 On success this returns a pair containing the
1857 number of nodes in the nodeset, and a boolean flag
1858 if a node was created.");
1860 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1861 [], (* XXX Augeas code needs tests. *)
1862 "look up the value of an Augeas path",
1864 Look up the value associated with C<path>. If C<path>
1865 matches exactly one node, the C<value> is returned.");
1867 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1868 [], (* XXX Augeas code needs tests. *)
1869 "set Augeas path to value",
1871 Set the value associated with C<path> to C<val>.
1873 In the Augeas API, it is possible to clear a node by setting
1874 the value to NULL. Due to an oversight in the libguestfs API
1875 you cannot do that with this call. Instead you must use the
1876 C<guestfs_aug_clear> call.");
1878 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1879 [], (* XXX Augeas code needs tests. *)
1880 "insert a sibling Augeas node",
1882 Create a new sibling C<label> for C<path>, inserting it into
1883 the tree before or after C<path> (depending on the boolean
1886 C<path> must match exactly one existing node in the tree, and
1887 C<label> must be a label, ie. not contain C</>, C<*> or end
1888 with a bracketed index C<[N]>.");
1890 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
1891 [], (* XXX Augeas code needs tests. *)
1892 "remove an Augeas path",
1894 Remove C<path> and all of its children.
1896 On success this returns the number of entries which were removed.");
1898 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
1899 [], (* XXX Augeas code needs tests. *)
1902 Move the node C<src> to C<dest>. C<src> must match exactly
1903 one node. C<dest> is overwritten if it exists.");
1905 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
1906 [], (* XXX Augeas code needs tests. *)
1907 "return Augeas nodes which match augpath",
1909 Returns a list of paths which match the path expression C<path>.
1910 The returned paths are sufficiently qualified so that they match
1911 exactly one node in the current tree.");
1913 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
1914 [], (* XXX Augeas code needs tests. *)
1915 "write all pending Augeas changes to disk",
1917 This writes all pending changes to disk.
1919 The flags which were passed to C<guestfs_aug_init> affect exactly
1920 how files are saved.");
1922 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
1923 [], (* XXX Augeas code needs tests. *)
1924 "load files into the tree",
1926 Load files into the tree.
1928 See C<aug_load> in the Augeas documentation for the full gory
1931 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
1932 [], (* XXX Augeas code needs tests. *)
1933 "list Augeas nodes under augpath",
1935 This is just a shortcut for listing C<guestfs_aug_match>
1936 C<path/*> and sorting the resulting nodes into alphabetical order.");
1938 ("rm", (RErr, [Pathname "path"], []), 29, [],
1939 [InitScratchFS, Always, TestRun
1941 ["touch"; "/rm/new"];
1943 InitScratchFS, Always, TestLastFail
1944 [["rm"; "/nosuchfile"]];
1945 InitScratchFS, Always, TestLastFail
1950 Remove the single file C<path>.");
1952 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
1953 [InitScratchFS, Always, TestRun
1954 [["mkdir"; "/rmdir"];
1955 ["rmdir"; "/rmdir"]];
1956 InitScratchFS, Always, TestLastFail
1957 [["rmdir"; "/rmdir2"]];
1958 InitScratchFS, Always, TestLastFail
1959 [["mkdir"; "/rmdir3"];
1960 ["touch"; "/rmdir3/new"];
1961 ["rmdir"; "/rmdir3/new"]]],
1962 "remove a directory",
1964 Remove the single directory C<path>.");
1966 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
1967 [InitScratchFS, Always, TestOutputFalse
1968 [["mkdir"; "/rm_rf"];
1969 ["mkdir"; "/rm_rf/foo"];
1970 ["touch"; "/rm_rf/foo/bar"];
1971 ["rm_rf"; "/rm_rf"];
1972 ["exists"; "/rm_rf"]]],
1973 "remove a file or directory recursively",
1975 Remove the file or directory C<path>, recursively removing the
1976 contents if its a directory. This is like the C<rm -rf> shell
1979 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
1980 [InitScratchFS, Always, TestOutputTrue
1981 [["mkdir"; "/mkdir"];
1982 ["is_dir"; "/mkdir"]];
1983 InitScratchFS, Always, TestLastFail
1984 [["mkdir"; "/mkdir2/foo/bar"]]],
1985 "create a directory",
1987 Create a directory named C<path>.");
1989 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
1990 [InitScratchFS, Always, TestOutputTrue
1991 [["mkdir_p"; "/mkdir_p/foo/bar"];
1992 ["is_dir"; "/mkdir_p/foo/bar"]];
1993 InitScratchFS, Always, TestOutputTrue
1994 [["mkdir_p"; "/mkdir_p2/foo/bar"];
1995 ["is_dir"; "/mkdir_p2/foo"]];
1996 InitScratchFS, Always, TestOutputTrue
1997 [["mkdir_p"; "/mkdir_p3/foo/bar"];
1998 ["is_dir"; "/mkdir_p3"]];
1999 (* Regression tests for RHBZ#503133: *)
2000 InitScratchFS, Always, TestRun
2001 [["mkdir"; "/mkdir_p4"];
2002 ["mkdir_p"; "/mkdir_p4"]];
2003 InitScratchFS, Always, TestLastFail
2004 [["touch"; "/mkdir_p5"];
2005 ["mkdir_p"; "/mkdir_p5"]]],
2006 "create a directory and parents",
2008 Create a directory named C<path>, creating any parent directories
2009 as necessary. This is like the C<mkdir -p> shell command.");
2011 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2012 [], (* XXX Need stat command to test *)
2015 Change the mode (permissions) of C<path> to C<mode>. Only
2016 numeric modes are supported.
2018 I<Note>: When using this command from guestfish, C<mode>
2019 by default would be decimal, unless you prefix it with
2020 C<0> to get octal, ie. use C<0700> not C<700>.
2022 The mode actually set is affected by the umask.");
2024 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2025 [], (* XXX Need stat command to test *)
2026 "change file owner and group",
2028 Change the file owner to C<owner> and group to C<group>.
2030 Only numeric uid and gid are supported. If you want to use
2031 names, you will need to locate and parse the password file
2032 yourself (Augeas support makes this relatively easy).");
2034 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2035 [InitISOFS, Always, TestOutputTrue (
2036 [["exists"; "/empty"]]);
2037 InitISOFS, Always, TestOutputTrue (
2038 [["exists"; "/directory"]])],
2039 "test if file or directory exists",
2041 This returns C<true> if and only if there is a file, directory
2042 (or anything) with the given C<path> name.
2044 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2046 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2047 [InitISOFS, Always, TestOutputTrue (
2048 [["is_file"; "/known-1"]]);
2049 InitISOFS, Always, TestOutputFalse (
2050 [["is_file"; "/directory"]])],
2051 "test if a regular file",
2053 This returns C<true> if and only if there is a regular file
2054 with the given C<path> name. Note that it returns false for
2055 other objects like directories.
2057 See also C<guestfs_stat>.");
2059 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2060 [InitISOFS, Always, TestOutputFalse (
2061 [["is_dir"; "/known-3"]]);
2062 InitISOFS, Always, TestOutputTrue (
2063 [["is_dir"; "/directory"]])],
2064 "test if a directory",
2066 This returns C<true> if and only if there is a directory
2067 with the given C<path> name. Note that it returns false for
2068 other objects like files.
2070 See also C<guestfs_stat>.");
2072 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2073 [InitEmpty, Always, TestOutputListOfDevices (
2074 [["part_init"; "/dev/sda"; "mbr"];
2075 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2076 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2077 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2078 ["pvcreate"; "/dev/sda1"];
2079 ["pvcreate"; "/dev/sda2"];
2080 ["pvcreate"; "/dev/sda3"];
2081 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2082 "create an LVM physical volume",
2084 This creates an LVM physical volume on the named C<device>,
2085 where C<device> should usually be a partition name such
2088 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2089 [InitEmpty, Always, TestOutputList (
2090 [["part_init"; "/dev/sda"; "mbr"];
2091 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2092 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2093 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2094 ["pvcreate"; "/dev/sda1"];
2095 ["pvcreate"; "/dev/sda2"];
2096 ["pvcreate"; "/dev/sda3"];
2097 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2098 ["vgcreate"; "VG2"; "/dev/sda3"];
2099 ["vgs"]], ["VG1"; "VG2"])],
2100 "create an LVM volume group",
2102 This creates an LVM volume group called C<volgroup>
2103 from the non-empty list of physical volumes C<physvols>.");
2105 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2106 [InitEmpty, Always, TestOutputList (
2107 [["part_init"; "/dev/sda"; "mbr"];
2108 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2109 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2110 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2111 ["pvcreate"; "/dev/sda1"];
2112 ["pvcreate"; "/dev/sda2"];
2113 ["pvcreate"; "/dev/sda3"];
2114 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2115 ["vgcreate"; "VG2"; "/dev/sda3"];
2116 ["lvcreate"; "LV1"; "VG1"; "50"];
2117 ["lvcreate"; "LV2"; "VG1"; "50"];
2118 ["lvcreate"; "LV3"; "VG2"; "50"];
2119 ["lvcreate"; "LV4"; "VG2"; "50"];
2120 ["lvcreate"; "LV5"; "VG2"; "50"];
2122 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2123 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2124 "create an LVM logical volume",
2126 This creates an LVM logical volume called C<logvol>
2127 on the volume group C<volgroup>, with C<size> megabytes.");
2129 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2130 [InitEmpty, Always, TestOutput (
2131 [["part_disk"; "/dev/sda"; "mbr"];
2132 ["mkfs"; "ext2"; "/dev/sda1"];
2133 ["mount_options"; ""; "/dev/sda1"; "/"];
2134 ["write"; "/new"; "new file contents"];
2135 ["cat"; "/new"]], "new file contents")],
2136 "make a filesystem",
2138 This creates a filesystem on C<device> (usually a partition
2139 or LVM logical volume). The filesystem type is C<fstype>, for
2142 ("sfdisk", (RErr, [Device "device";
2143 Int "cyls"; Int "heads"; Int "sectors";
2144 StringList "lines"], []), 43, [DangerWillRobinson; DeprecatedBy "part_add"],
2146 "create partitions on a block device",
2148 This is a direct interface to the L<sfdisk(8)> program for creating
2149 partitions on block devices.
2151 C<device> should be a block device, for example C</dev/sda>.
2153 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2154 and sectors on the device, which are passed directly to sfdisk as
2155 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2156 of these, then the corresponding parameter is omitted. Usually for
2157 'large' disks, you can just pass C<0> for these, but for small
2158 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2159 out the right geometry and you will need to tell it.
2161 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2162 information refer to the L<sfdisk(8)> manpage.
2164 To create a single partition occupying the whole disk, you would
2165 pass C<lines> as a single element list, when the single element being
2166 the string C<,> (comma).
2168 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2169 C<guestfs_part_init>");
2171 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2172 (* Regression test for RHBZ#597135. *)
2173 [InitScratchFS, Always, TestLastFail
2174 [["write_file"; "/write_file"; "abc"; "10000"]]],
2177 This call creates a file called C<path>. The contents of the
2178 file is the string C<content> (which can contain any 8 bit data),
2179 with length C<size>.
2181 As a special case, if C<size> is C<0>
2182 then the length is calculated using C<strlen> (so in this case
2183 the content cannot contain embedded ASCII NULs).
2185 I<NB.> Owing to a bug, writing content containing ASCII NUL
2186 characters does I<not> work, even if the length is specified.");
2188 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2189 [InitEmpty, Always, TestOutputListOfDevices (
2190 [["part_disk"; "/dev/sda"; "mbr"];
2191 ["mkfs"; "ext2"; "/dev/sda1"];
2192 ["mount_options"; ""; "/dev/sda1"; "/"];
2193 ["mounts"]], ["/dev/sda1"]);
2194 InitEmpty, Always, TestOutputList (
2195 [["part_disk"; "/dev/sda"; "mbr"];
2196 ["mkfs"; "ext2"; "/dev/sda1"];
2197 ["mount_options"; ""; "/dev/sda1"; "/"];
2200 "unmount a filesystem",
2202 This unmounts the given filesystem. The filesystem may be
2203 specified either by its mountpoint (path) or the device which
2204 contains the filesystem.");
2206 ("mounts", (RStringList "devices", [], []), 46, [],
2207 [InitScratchFS, Always, TestOutputListOfDevices (
2208 [["mounts"]], ["/dev/sdb1"])],
2209 "show mounted filesystems",
2211 This returns the list of currently mounted filesystems. It returns
2212 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2214 Some internal mounts are not shown.
2216 See also: C<guestfs_mountpoints>");
2218 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2219 [InitScratchFS, Always, TestOutputList (
2222 (* check that umount_all can unmount nested mounts correctly: *)
2223 InitEmpty, Always, TestOutputList (
2224 [["part_init"; "/dev/sda"; "mbr"];
2225 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2226 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2227 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2228 ["mkfs"; "ext2"; "/dev/sda1"];
2229 ["mkfs"; "ext2"; "/dev/sda2"];
2230 ["mkfs"; "ext2"; "/dev/sda3"];
2231 ["mount_options"; ""; "/dev/sda1"; "/"];
2233 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2234 ["mkdir"; "/mp1/mp2"];
2235 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2236 ["mkdir"; "/mp1/mp2/mp3"];
2239 "unmount all filesystems",
2241 This unmounts all mounted filesystems.
2243 Some internal mounts are not unmounted by this call.");
2245 ("lvm_remove_all", (RErr, [], []), 48, [DangerWillRobinson; Optional "lvm2"],
2247 "remove all LVM LVs, VGs and PVs",
2249 This command removes all LVM logical volumes, volume groups
2250 and physical volumes.");
2252 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2253 [InitISOFS, Always, TestOutput (
2254 [["file"; "/empty"]], "empty");
2255 InitISOFS, Always, TestOutput (
2256 [["file"; "/known-1"]], "ASCII text");
2257 InitISOFS, Always, TestLastFail (
2258 [["file"; "/notexists"]]);
2259 InitISOFS, Always, TestOutput (
2260 [["file"; "/abssymlink"]], "symbolic link");
2261 InitISOFS, Always, TestOutput (
2262 [["file"; "/directory"]], "directory")],
2263 "determine file type",
2265 This call uses the standard L<file(1)> command to determine
2266 the type or contents of the file.
2268 This call will also transparently look inside various types
2271 The exact command which runs is C<file -zb path>. Note in
2272 particular that the filename is not prepended to the output
2275 The output depends on the output of the underlying L<file(1)>
2276 command and it can change in future in ways beyond our control.
2277 In other words, the output is not guaranteed by the ABI.
2279 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2280 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2282 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2283 [InitScratchFS, Always, TestOutput (
2284 [["mkdir"; "/command"];
2285 ["upload"; "test-command"; "/command/test-command"];
2286 ["chmod"; "0o755"; "/command/test-command"];
2287 ["command"; "/command/test-command 1"]], "Result1");
2288 InitScratchFS, Always, TestOutput (
2289 [["mkdir"; "/command2"];
2290 ["upload"; "test-command"; "/command2/test-command"];
2291 ["chmod"; "0o755"; "/command2/test-command"];
2292 ["command"; "/command2/test-command 2"]], "Result2\n");
2293 InitScratchFS, Always, TestOutput (
2294 [["mkdir"; "/command3"];
2295 ["upload"; "test-command"; "/command3/test-command"];
2296 ["chmod"; "0o755"; "/command3/test-command"];
2297 ["command"; "/command3/test-command 3"]], "\nResult3");
2298 InitScratchFS, Always, TestOutput (
2299 [["mkdir"; "/command4"];
2300 ["upload"; "test-command"; "/command4/test-command"];
2301 ["chmod"; "0o755"; "/command4/test-command"];
2302 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2303 InitScratchFS, Always, TestOutput (
2304 [["mkdir"; "/command5"];
2305 ["upload"; "test-command"; "/command5/test-command"];
2306 ["chmod"; "0o755"; "/command5/test-command"];
2307 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2308 InitScratchFS, Always, TestOutput (
2309 [["mkdir"; "/command6"];
2310 ["upload"; "test-command"; "/command6/test-command"];
2311 ["chmod"; "0o755"; "/command6/test-command"];
2312 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2313 InitScratchFS, Always, TestOutput (
2314 [["mkdir"; "/command7"];
2315 ["upload"; "test-command"; "/command7/test-command"];
2316 ["chmod"; "0o755"; "/command7/test-command"];
2317 ["command"; "/command7/test-command 7"]], "");
2318 InitScratchFS, Always, TestOutput (
2319 [["mkdir"; "/command8"];
2320 ["upload"; "test-command"; "/command8/test-command"];
2321 ["chmod"; "0o755"; "/command8/test-command"];
2322 ["command"; "/command8/test-command 8"]], "\n");
2323 InitScratchFS, Always, TestOutput (
2324 [["mkdir"; "/command9"];
2325 ["upload"; "test-command"; "/command9/test-command"];
2326 ["chmod"; "0o755"; "/command9/test-command"];
2327 ["command"; "/command9/test-command 9"]], "\n\n");
2328 InitScratchFS, Always, TestOutput (
2329 [["mkdir"; "/command10"];
2330 ["upload"; "test-command"; "/command10/test-command"];
2331 ["chmod"; "0o755"; "/command10/test-command"];
2332 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2333 InitScratchFS, Always, TestOutput (
2334 [["mkdir"; "/command11"];
2335 ["upload"; "test-command"; "/command11/test-command"];
2336 ["chmod"; "0o755"; "/command11/test-command"];
2337 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2338 InitScratchFS, Always, TestLastFail (
2339 [["mkdir"; "/command12"];
2340 ["upload"; "test-command"; "/command12/test-command"];
2341 ["chmod"; "0o755"; "/command12/test-command"];
2342 ["command"; "/command12/test-command"]])],
2343 "run a command from the guest filesystem",
2345 This call runs a command from the guest filesystem. The
2346 filesystem must be mounted, and must contain a compatible
2347 operating system (ie. something Linux, with the same
2348 or compatible processor architecture).
2350 The single parameter is an argv-style list of arguments.
2351 The first element is the name of the program to run.
2352 Subsequent elements are parameters. The list must be
2353 non-empty (ie. must contain a program name). Note that
2354 the command runs directly, and is I<not> invoked via
2355 the shell (see C<guestfs_sh>).
2357 The return value is anything printed to I<stdout> by
2360 If the command returns a non-zero exit status, then
2361 this function returns an error message. The error message
2362 string is the content of I<stderr> from the command.
2364 The C<$PATH> environment variable will contain at least
2365 C</usr/bin> and C</bin>. If you require a program from
2366 another location, you should provide the full path in the
2369 Shared libraries and data files required by the program
2370 must be available on filesystems which are mounted in the
2371 correct places. It is the caller's responsibility to ensure
2372 all filesystems that are needed are mounted at the right
2375 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2376 [InitScratchFS, Always, TestOutputList (
2377 [["mkdir"; "/command_lines"];
2378 ["upload"; "test-command"; "/command_lines/test-command"];
2379 ["chmod"; "0o755"; "/command_lines/test-command"];
2380 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2381 InitScratchFS, Always, TestOutputList (
2382 [["mkdir"; "/command_lines2"];
2383 ["upload"; "test-command"; "/command_lines2/test-command"];
2384 ["chmod"; "0o755"; "/command_lines2/test-command"];
2385 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2386 InitScratchFS, Always, TestOutputList (
2387 [["mkdir"; "/command_lines3"];
2388 ["upload"; "test-command"; "/command_lines3/test-command"];
2389 ["chmod"; "0o755"; "/command_lines3/test-command"];
2390 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2391 InitScratchFS, Always, TestOutputList (
2392 [["mkdir"; "/command_lines4"];
2393 ["upload"; "test-command"; "/command_lines4/test-command"];
2394 ["chmod"; "0o755"; "/command_lines4/test-command"];
2395 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2396 InitScratchFS, Always, TestOutputList (
2397 [["mkdir"; "/command_lines5"];
2398 ["upload"; "test-command"; "/command_lines5/test-command"];
2399 ["chmod"; "0o755"; "/command_lines5/test-command"];
2400 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2401 InitScratchFS, Always, TestOutputList (
2402 [["mkdir"; "/command_lines6"];
2403 ["upload"; "test-command"; "/command_lines6/test-command"];
2404 ["chmod"; "0o755"; "/command_lines6/test-command"];
2405 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2406 InitScratchFS, Always, TestOutputList (
2407 [["mkdir"; "/command_lines7"];
2408 ["upload"; "test-command"; "/command_lines7/test-command"];
2409 ["chmod"; "0o755"; "/command_lines7/test-command"];
2410 ["command_lines"; "/command_lines7/test-command 7"]], []);
2411 InitScratchFS, Always, TestOutputList (
2412 [["mkdir"; "/command_lines8"];
2413 ["upload"; "test-command"; "/command_lines8/test-command"];
2414 ["chmod"; "0o755"; "/command_lines8/test-command"];
2415 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2416 InitScratchFS, Always, TestOutputList (
2417 [["mkdir"; "/command_lines9"];
2418 ["upload"; "test-command"; "/command_lines9/test-command"];
2419 ["chmod"; "0o755"; "/command_lines9/test-command"];
2420 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2421 InitScratchFS, Always, TestOutputList (
2422 [["mkdir"; "/command_lines10"];
2423 ["upload"; "test-command"; "/command_lines10/test-command"];
2424 ["chmod"; "0o755"; "/command_lines10/test-command"];
2425 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2426 InitScratchFS, Always, TestOutputList (
2427 [["mkdir"; "/command_lines11"];
2428 ["upload"; "test-command"; "/command_lines11/test-command"];
2429 ["chmod"; "0o755"; "/command_lines11/test-command"];
2430 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2431 "run a command, returning lines",
2433 This is the same as C<guestfs_command>, but splits the
2434 result into a list of lines.
2436 See also: C<guestfs_sh_lines>");
2438 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2439 [InitISOFS, Always, TestOutputStruct (
2440 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2441 "get file information",
2443 Returns file information for the given C<path>.
2445 This is the same as the C<stat(2)> system call.");
2447 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2448 [InitISOFS, Always, TestOutputStruct (
2449 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2450 "get file information for a symbolic link",
2452 Returns file information for the given C<path>.
2454 This is the same as C<guestfs_stat> except that if C<path>
2455 is a symbolic link, then the link is stat-ed, not the file it
2458 This is the same as the C<lstat(2)> system call.");
2460 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2461 [InitISOFS, Always, TestOutputStruct (
2462 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2463 "get file system statistics",
2465 Returns file system statistics for any mounted file system.
2466 C<path> should be a file or directory in the mounted file system
2467 (typically it is the mount point itself, but it doesn't need to be).
2469 This is the same as the C<statvfs(2)> system call.");
2471 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2473 "get ext2/ext3/ext4 superblock details",
2475 This returns the contents of the ext2, ext3 or ext4 filesystem
2476 superblock on C<device>.
2478 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2479 manpage for more details. The list of fields returned isn't
2480 clearly defined, and depends on both the version of C<tune2fs>
2481 that libguestfs was built against, and the filesystem itself.");
2483 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2484 [InitEmpty, Always, TestOutputTrue (
2485 [["blockdev_setro"; "/dev/sda"];
2486 ["blockdev_getro"; "/dev/sda"]])],
2487 "set block device to read-only",
2489 Sets the block device named C<device> to read-only.
2491 This uses the L<blockdev(8)> command.");
2493 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2494 [InitEmpty, Always, TestOutputFalse (
2495 [["blockdev_setrw"; "/dev/sda"];
2496 ["blockdev_getro"; "/dev/sda"]])],
2497 "set block device to read-write",
2499 Sets the block device named C<device> to read-write.
2501 This uses the L<blockdev(8)> command.");
2503 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2504 [InitEmpty, Always, TestOutputTrue (
2505 [["blockdev_setro"; "/dev/sda"];
2506 ["blockdev_getro"; "/dev/sda"]])],
2507 "is block device set to read-only",
2509 Returns a boolean indicating if the block device is read-only
2510 (true if read-only, false if not).
2512 This uses the L<blockdev(8)> command.");
2514 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2515 [InitEmpty, Always, TestOutputInt (
2516 [["blockdev_getss"; "/dev/sda"]], 512)],
2517 "get sectorsize of block device",
2519 This returns the size of sectors on a block device.
2520 Usually 512, but can be larger for modern devices.
2522 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2525 This uses the L<blockdev(8)> command.");
2527 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2528 [InitEmpty, Always, TestOutputInt (
2529 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2530 "get blocksize of block device",
2532 This returns the block size of a device.
2534 (Note this is different from both I<size in blocks> and
2535 I<filesystem block size>).
2537 This uses the L<blockdev(8)> command.");
2539 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2541 "set blocksize of block device",
2543 This sets the block size of a device.
2545 (Note this is different from both I<size in blocks> and
2546 I<filesystem block size>).
2548 This uses the L<blockdev(8)> command.");
2550 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2551 [InitEmpty, Always, TestOutputInt (
2552 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2553 "get total size of device in 512-byte sectors",
2555 This returns the size of the device in units of 512-byte sectors
2556 (even if the sectorsize isn't 512 bytes ... weird).
2558 See also C<guestfs_blockdev_getss> for the real sector size of
2559 the device, and C<guestfs_blockdev_getsize64> for the more
2560 useful I<size in bytes>.
2562 This uses the L<blockdev(8)> command.");
2564 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2565 [InitEmpty, Always, TestOutputInt (
2566 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2567 "get total size of device in bytes",
2569 This returns the size of the device in bytes.
2571 See also C<guestfs_blockdev_getsz>.
2573 This uses the L<blockdev(8)> command.");
2575 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2576 [InitEmpty, Always, TestRun
2577 [["blockdev_flushbufs"; "/dev/sda"]]],
2578 "flush device buffers",
2580 This tells the kernel to flush internal buffers associated
2583 This uses the L<blockdev(8)> command.");
2585 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2586 [InitEmpty, Always, TestRun
2587 [["blockdev_rereadpt"; "/dev/sda"]]],
2588 "reread partition table",
2590 Reread the partition table on C<device>.
2592 This uses the L<blockdev(8)> command.");
2594 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2595 [InitScratchFS, Always, TestOutput (
2596 (* Pick a file from cwd which isn't likely to change. *)
2597 [["mkdir"; "/upload"];
2598 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2599 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2600 Digest.to_hex (Digest.file "COPYING.LIB"))],
2601 "upload a file from the local machine",
2603 Upload local file C<filename> to C<remotefilename> on the
2606 C<filename> can also be a named pipe.
2608 See also C<guestfs_download>.");
2610 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2611 [InitScratchFS, Always, TestOutput (
2612 (* Pick a file from cwd which isn't likely to change. *)
2613 [["mkdir"; "/download"];
2614 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2615 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2616 ["upload"; "testdownload.tmp"; "/download/upload"];
2617 ["checksum"; "md5"; "/download/upload"]],
2618 Digest.to_hex (Digest.file "COPYING.LIB"))],
2619 "download a file to the local machine",
2621 Download file C<remotefilename> and save it as C<filename>
2622 on the local machine.
2624 C<filename> can also be a named pipe.
2626 See also C<guestfs_upload>, C<guestfs_cat>.");
2628 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2629 [InitISOFS, Always, TestOutput (
2630 [["checksum"; "crc"; "/known-3"]], "2891671662");
2631 InitISOFS, Always, TestLastFail (
2632 [["checksum"; "crc"; "/notexists"]]);
2633 InitISOFS, Always, TestOutput (
2634 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2635 InitISOFS, Always, TestOutput (
2636 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2637 InitISOFS, Always, TestOutput (
2638 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2639 InitISOFS, Always, TestOutput (
2640 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2641 InitISOFS, Always, TestOutput (
2642 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2643 InitISOFS, Always, TestOutput (
2644 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2645 (* Test for RHBZ#579608, absolute symbolic links. *)
2646 InitISOFS, Always, TestOutput (
2647 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2648 "compute MD5, SHAx or CRC checksum of file",
2650 This call computes the MD5, SHAx or CRC checksum of the
2653 The type of checksum to compute is given by the C<csumtype>
2654 parameter which must have one of the following values:
2660 Compute the cyclic redundancy check (CRC) specified by POSIX
2661 for the C<cksum> command.
2665 Compute the MD5 hash (using the C<md5sum> program).
2669 Compute the SHA1 hash (using the C<sha1sum> program).
2673 Compute the SHA224 hash (using the C<sha224sum> program).
2677 Compute the SHA256 hash (using the C<sha256sum> program).
2681 Compute the SHA384 hash (using the C<sha384sum> program).
2685 Compute the SHA512 hash (using the C<sha512sum> program).
2689 The checksum is returned as a printable string.
2691 To get the checksum for a device, use C<guestfs_checksum_device>.
2693 To get the checksums for many files, use C<guestfs_checksums_out>.");
2695 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2696 [InitScratchFS, Always, TestOutput (
2697 [["mkdir"; "/tar_in"];
2698 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2699 ["cat"; "/tar_in/hello"]], "hello\n")],
2700 "unpack tarfile to directory",
2702 This command uploads and unpacks local file C<tarfile> (an
2703 I<uncompressed> tar file) into C<directory>.
2705 To upload a compressed tarball, use C<guestfs_tgz_in>
2706 or C<guestfs_txz_in>.");
2708 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2710 "pack directory into tarfile",
2712 This command packs the contents of C<directory> and downloads
2713 it to local file C<tarfile>.
2715 To download a compressed tarball, use C<guestfs_tgz_out>
2716 or C<guestfs_txz_out>.");
2718 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2719 [InitScratchFS, Always, TestOutput (
2720 [["mkdir"; "/tgz_in"];
2721 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2722 ["cat"; "/tgz_in/hello"]], "hello\n")],
2723 "unpack compressed tarball to directory",
2725 This command uploads and unpacks local file C<tarball> (a
2726 I<gzip compressed> tar file) into C<directory>.
2728 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2730 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2732 "pack directory into compressed tarball",
2734 This command packs the contents of C<directory> and downloads
2735 it to local file C<tarball>.
2737 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2739 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2740 [InitBasicFS, Always, TestLastFail (
2742 ["mount_ro"; "/dev/sda1"; "/"];
2743 ["touch"; "/new"]]);
2744 InitBasicFS, Always, TestOutput (
2745 [["write"; "/new"; "data"];
2747 ["mount_ro"; "/dev/sda1"; "/"];
2748 ["cat"; "/new"]], "data")],
2749 "mount a guest disk, read-only",
2751 This is the same as the C<guestfs_mount> command, but it
2752 mounts the filesystem with the read-only (I<-o ro>) flag.");
2754 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2756 "mount a guest disk with mount options",
2758 This is the same as the C<guestfs_mount> command, but it
2759 allows you to set the mount options as for the
2760 L<mount(8)> I<-o> flag.
2762 If the C<options> parameter is an empty string, then
2763 no options are passed (all options default to whatever
2764 the filesystem uses).");
2766 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2768 "mount a guest disk with mount options and vfstype",
2770 This is the same as the C<guestfs_mount> command, but it
2771 allows you to set both the mount options and the vfstype
2772 as for the L<mount(8)> I<-o> and I<-t> flags.");
2774 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2776 "debugging and internals",
2778 The C<guestfs_debug> command exposes some internals of
2779 C<guestfsd> (the guestfs daemon) that runs inside the
2782 There is no comprehensive help for this command. You have
2783 to look at the file C<daemon/debug.c> in the libguestfs source
2784 to find out what you can do.");
2786 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2787 [InitEmpty, Always, TestOutputList (
2788 [["part_disk"; "/dev/sda"; "mbr"];
2789 ["pvcreate"; "/dev/sda1"];
2790 ["vgcreate"; "VG"; "/dev/sda1"];
2791 ["lvcreate"; "LV1"; "VG"; "50"];
2792 ["lvcreate"; "LV2"; "VG"; "50"];
2793 ["lvremove"; "/dev/VG/LV1"];
2794 ["lvs"]], ["/dev/VG/LV2"]);
2795 InitEmpty, Always, TestOutputList (
2796 [["part_disk"; "/dev/sda"; "mbr"];
2797 ["pvcreate"; "/dev/sda1"];
2798 ["vgcreate"; "VG"; "/dev/sda1"];
2799 ["lvcreate"; "LV1"; "VG"; "50"];
2800 ["lvcreate"; "LV2"; "VG"; "50"];
2801 ["lvremove"; "/dev/VG"];
2803 InitEmpty, Always, TestOutputList (
2804 [["part_disk"; "/dev/sda"; "mbr"];
2805 ["pvcreate"; "/dev/sda1"];
2806 ["vgcreate"; "VG"; "/dev/sda1"];
2807 ["lvcreate"; "LV1"; "VG"; "50"];
2808 ["lvcreate"; "LV2"; "VG"; "50"];
2809 ["lvremove"; "/dev/VG"];
2811 "remove an LVM logical volume",
2813 Remove an LVM logical volume C<device>, where C<device> is
2814 the path to the LV, such as C</dev/VG/LV>.
2816 You can also remove all LVs in a volume group by specifying
2817 the VG name, C</dev/VG>.");
2819 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2820 [InitEmpty, Always, TestOutputList (
2821 [["part_disk"; "/dev/sda"; "mbr"];
2822 ["pvcreate"; "/dev/sda1"];
2823 ["vgcreate"; "VG"; "/dev/sda1"];
2824 ["lvcreate"; "LV1"; "VG"; "50"];
2825 ["lvcreate"; "LV2"; "VG"; "50"];
2828 InitEmpty, Always, TestOutputList (
2829 [["part_disk"; "/dev/sda"; "mbr"];
2830 ["pvcreate"; "/dev/sda1"];
2831 ["vgcreate"; "VG"; "/dev/sda1"];
2832 ["lvcreate"; "LV1"; "VG"; "50"];
2833 ["lvcreate"; "LV2"; "VG"; "50"];
2836 "remove an LVM volume group",
2838 Remove an LVM volume group C<vgname>, (for example C<VG>).
2840 This also forcibly removes all logical volumes in the volume
2843 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
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 InitEmpty, Always, TestOutputListOfDevices (
2863 [["part_disk"; "/dev/sda"; "mbr"];
2864 ["pvcreate"; "/dev/sda1"];
2865 ["vgcreate"; "VG"; "/dev/sda1"];
2866 ["lvcreate"; "LV1"; "VG"; "50"];
2867 ["lvcreate"; "LV2"; "VG"; "50"];
2869 ["pvremove"; "/dev/sda1"];
2871 "remove an LVM physical volume",
2873 This wipes a physical volume C<device> so that LVM will no longer
2876 The implementation uses the C<pvremove> command which refuses to
2877 wipe physical volumes that contain any volume groups, so you have
2878 to remove those first.");
2880 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2881 [InitBasicFS, Always, TestOutput (
2882 [["set_e2label"; "/dev/sda1"; "testlabel"];
2883 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2884 "set the ext2/3/4 filesystem label",
2886 This sets the ext2/3/4 filesystem label of the filesystem on
2887 C<device> to C<label>. Filesystem labels are limited to
2890 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2891 to return the existing label on a filesystem.");
2893 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
2895 "get the ext2/3/4 filesystem label",
2897 This returns the ext2/3/4 filesystem label of the filesystem on
2900 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
2901 (let uuid = uuidgen () in
2902 [InitBasicFS, Always, TestOutput (
2903 [["set_e2uuid"; "/dev/sda1"; uuid];
2904 ["get_e2uuid"; "/dev/sda1"]], uuid);
2905 InitBasicFS, Always, TestOutput (
2906 [["set_e2uuid"; "/dev/sda1"; "clear"];
2907 ["get_e2uuid"; "/dev/sda1"]], "");
2908 (* We can't predict what UUIDs will be, so just check the commands run. *)
2909 InitBasicFS, Always, TestRun (
2910 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2911 InitBasicFS, Always, TestRun (
2912 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2913 "set the ext2/3/4 filesystem UUID",
2915 This sets the ext2/3/4 filesystem UUID of the filesystem on
2916 C<device> to C<uuid>. The format of the UUID and alternatives
2917 such as C<clear>, C<random> and C<time> are described in the
2918 L<tune2fs(8)> manpage.
2920 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2921 to return the existing UUID of a filesystem.");
2923 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
2924 (* Regression test for RHBZ#597112. *)
2925 (let uuid = uuidgen () in
2926 [InitNone, Always, TestOutput (
2927 [["mke2journal"; "1024"; "/dev/sdc"];
2928 ["set_e2uuid"; "/dev/sdc"; uuid];
2929 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
2930 "get the ext2/3/4 filesystem UUID",
2932 This returns the ext2/3/4 filesystem UUID of the filesystem on
2935 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
2936 [InitBasicFS, Always, TestOutputInt (
2937 [["umount"; "/dev/sda1"];
2938 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2939 InitBasicFS, Always, TestOutputInt (
2940 [["umount"; "/dev/sda1"];
2941 ["zero"; "/dev/sda1"];
2942 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2943 "run the filesystem checker",
2945 This runs the filesystem checker (fsck) on C<device> which
2946 should have filesystem type C<fstype>.
2948 The returned integer is the status. See L<fsck(8)> for the
2949 list of status codes from C<fsck>.
2957 Multiple status codes can be summed together.
2961 A non-zero return code can mean \"success\", for example if
2962 errors have been corrected on the filesystem.
2966 Checking or repairing NTFS volumes is not supported
2971 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2973 ("zero", (RErr, [Device "device"], []), 85, [Progress],
2974 [InitBasicFS, Always, TestRun (
2975 [["umount"; "/dev/sda1"];
2976 ["zero"; "/dev/sda1"]])],
2977 "write zeroes to the device",
2979 This command writes zeroes over the first few blocks of C<device>.
2981 How many blocks are zeroed isn't specified (but it's I<not> enough
2982 to securely wipe the device). It should be sufficient to remove
2983 any partition tables, filesystem superblocks and so on.
2985 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
2986 C<guestfs_is_zero_device>");
2988 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [],
2990 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2991 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2993 [InitBasicFS, Always, TestOutputTrue (
2994 [["mkdir_p"; "/boot/grub"];
2995 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2996 ["grub_install"; "/"; "/dev/vda"];
2997 ["is_dir"; "/boot"]])],
3000 This command installs GRUB (the Grand Unified Bootloader) on
3001 C<device>, with the root directory being C<root>.
3003 Note: If grub-install reports the error
3004 \"No suitable drive was found in the generated device map.\"
3005 it may be that you need to create a C</boot/grub/device.map>
3006 file first that contains the mapping between grub device names
3007 and Linux device names. It is usually sufficient to create
3012 replacing C</dev/vda> with the name of the installation device.");
3014 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3015 [InitScratchFS, Always, TestOutput (
3017 ["write"; "/cp/old"; "file content"];
3018 ["cp"; "/cp/old"; "/cp/new"];
3019 ["cat"; "/cp/new"]], "file content");
3020 InitScratchFS, Always, TestOutputTrue (
3022 ["write"; "/cp2/old"; "file content"];
3023 ["cp"; "/cp2/old"; "/cp2/new"];
3024 ["is_file"; "/cp2/old"]]);
3025 InitScratchFS, Always, TestOutput (
3027 ["write"; "/cp3/old"; "file content"];
3028 ["mkdir"; "/cp3/dir"];
3029 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3030 ["cat"; "/cp3/dir/new"]], "file content")],
3033 This copies a file from C<src> to C<dest> where C<dest> is
3034 either a destination filename or destination directory.");
3036 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3037 [InitScratchFS, Always, TestOutput (
3038 [["mkdir"; "/cp_a1"];
3039 ["mkdir"; "/cp_a2"];
3040 ["write"; "/cp_a1/file"; "file content"];
3041 ["cp_a"; "/cp_a1"; "/cp_a2"];
3042 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3043 "copy a file or directory recursively",
3045 This copies a file or directory from C<src> to C<dest>
3046 recursively using the C<cp -a> command.");
3048 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3049 [InitScratchFS, Always, TestOutput (
3051 ["write"; "/mv/old"; "file content"];
3052 ["mv"; "/mv/old"; "/mv/new"];
3053 ["cat"; "/mv/new"]], "file content");
3054 InitScratchFS, Always, TestOutputFalse (
3056 ["write"; "/mv2/old"; "file content"];
3057 ["mv"; "/mv2/old"; "/mv2/new"];
3058 ["is_file"; "/mv2/old"]])],
3061 This moves a file from C<src> to C<dest> where C<dest> is
3062 either a destination filename or destination directory.");
3064 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3065 [InitEmpty, Always, TestRun (
3066 [["drop_caches"; "3"]])],
3067 "drop kernel page cache, dentries and inodes",
3069 This instructs the guest kernel to drop its page cache,
3070 and/or dentries and inode caches. The parameter C<whattodrop>
3071 tells the kernel what precisely to drop, see
3072 L<http://linux-mm.org/Drop_Caches>
3074 Setting C<whattodrop> to 3 should drop everything.
3076 This automatically calls L<sync(2)> before the operation,
3077 so that the maximum guest memory is freed.");
3079 ("dmesg", (RString "kmsgs", [], []), 91, [],
3080 [InitEmpty, Always, TestRun (
3082 "return kernel messages",
3084 This returns the kernel messages (C<dmesg> output) from
3085 the guest kernel. This is sometimes useful for extended
3086 debugging of problems.
3088 Another way to get the same information is to enable
3089 verbose messages with C<guestfs_set_verbose> or by setting
3090 the environment variable C<LIBGUESTFS_DEBUG=1> before
3091 running the program.");
3093 ("ping_daemon", (RErr, [], []), 92, [],
3094 [InitEmpty, Always, TestRun (
3095 [["ping_daemon"]])],
3096 "ping the guest daemon",
3098 This is a test probe into the guestfs daemon running inside
3099 the qemu subprocess. Calling this function checks that the
3100 daemon responds to the ping message, without affecting the daemon
3101 or attached block device(s) in any other way.");
3103 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3104 [InitScratchFS, Always, TestOutputTrue (
3105 [["mkdir"; "/equal"];
3106 ["write"; "/equal/file1"; "contents of a file"];
3107 ["cp"; "/equal/file1"; "/equal/file2"];
3108 ["equal"; "/equal/file1"; "/equal/file2"]]);
3109 InitScratchFS, Always, TestOutputFalse (
3110 [["mkdir"; "/equal2"];
3111 ["write"; "/equal2/file1"; "contents of a file"];
3112 ["write"; "/equal2/file2"; "contents of another file"];
3113 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3114 InitScratchFS, Always, TestLastFail (
3115 [["mkdir"; "/equal3"];
3116 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3117 "test if two files have equal contents",
3119 This compares the two files C<file1> and C<file2> and returns
3120 true if their content is exactly equal, or false otherwise.
3122 The external L<cmp(1)> program is used for the comparison.");
3124 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3125 [InitISOFS, Always, TestOutputList (
3126 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3127 InitISOFS, Always, TestOutputList (
3128 [["strings"; "/empty"]], []);
3129 (* Test for RHBZ#579608, absolute symbolic links. *)
3130 InitISOFS, Always, TestRun (
3131 [["strings"; "/abssymlink"]])],
3132 "print the printable strings in a file",
3134 This runs the L<strings(1)> command on a file and returns
3135 the list of printable strings found.");
3137 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3138 [InitISOFS, Always, TestOutputList (
3139 [["strings_e"; "b"; "/known-5"]], []);
3140 InitScratchFS, Always, TestOutputList (
3141 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3142 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3143 "print the printable strings in a file",
3145 This is like the C<guestfs_strings> command, but allows you to
3146 specify the encoding of strings that are looked for in
3147 the source file C<path>.
3149 Allowed encodings are:
3155 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3156 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3160 Single 8-bit-byte characters.
3164 16-bit big endian strings such as those encoded in
3165 UTF-16BE or UCS-2BE.
3167 =item l (lower case letter L)
3169 16-bit little endian such as UTF-16LE and UCS-2LE.
3170 This is useful for examining binaries in Windows guests.
3174 32-bit big endian such as UCS-4BE.
3178 32-bit little endian such as UCS-4LE.
3182 The returned strings are transcoded to UTF-8.");
3184 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3185 [InitISOFS, Always, TestOutput (
3186 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3187 (* Test for RHBZ#501888c2 regression which caused large hexdump
3188 * commands to segfault.
3190 InitISOFS, Always, TestRun (
3191 [["hexdump"; "/100krandom"]]);
3192 (* Test for RHBZ#579608, absolute symbolic links. *)
3193 InitISOFS, Always, TestRun (
3194 [["hexdump"; "/abssymlink"]])],
3195 "dump a file in hexadecimal",
3197 This runs C<hexdump -C> on the given C<path>. The result is
3198 the human-readable, canonical hex dump of the file.");
3200 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3201 [InitNone, Always, TestOutput (
3202 [["part_disk"; "/dev/sda"; "mbr"];
3203 ["mkfs"; "ext3"; "/dev/sda1"];
3204 ["mount_options"; ""; "/dev/sda1"; "/"];
3205 ["write"; "/new"; "test file"];
3206 ["umount"; "/dev/sda1"];
3207 ["zerofree"; "/dev/sda1"];
3208 ["mount_options"; ""; "/dev/sda1"; "/"];
3209 ["cat"; "/new"]], "test file")],
3210 "zero unused inodes and disk blocks on ext2/3 filesystem",
3212 This runs the I<zerofree> program on C<device>. This program
3213 claims to zero unused inodes and disk blocks on an ext2/3
3214 filesystem, thus making it possible to compress the filesystem
3217 You should B<not> run this program if the filesystem is
3220 It is possible that using this program can damage the filesystem
3221 or data on the filesystem.");
3223 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3225 "resize an LVM physical volume",
3227 This resizes (expands or shrinks) an existing LVM physical
3228 volume to match the new size of the underlying device.");
3230 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3231 Int "cyls"; Int "heads"; Int "sectors";
3232 String "line"], []), 99, [DangerWillRobinson; DeprecatedBy "part_add"],
3234 "modify a single partition on a block device",
3236 This runs L<sfdisk(8)> option to modify just the single
3237 partition C<n> (note: C<n> counts from 1).
3239 For other parameters, see C<guestfs_sfdisk>. You should usually
3240 pass C<0> for the cyls/heads/sectors parameters.
3242 See also: C<guestfs_part_add>");
3244 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3246 "display the partition table",
3248 This displays the partition table on C<device>, in the
3249 human-readable output of the L<sfdisk(8)> command. It is
3250 not intended to be parsed.
3252 See also: C<guestfs_part_list>");
3254 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3256 "display the kernel geometry",
3258 This displays the kernel's idea of the geometry of C<device>.
3260 The result is in human-readable format, and not designed to
3263 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3265 "display the disk geometry from the partition table",
3267 This displays the disk geometry of C<device> read from the
3268 partition table. Especially in the case where the underlying
3269 block device has been resized, this can be different from the
3270 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3272 The result is in human-readable format, and not designed to
3275 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3277 "activate or deactivate all volume groups",
3279 This command activates or (if C<activate> is false) deactivates
3280 all logical volumes in all volume groups.
3281 If activated, then they are made known to the
3282 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3283 then those devices disappear.
3285 This command is the same as running C<vgchange -a y|n>");
3287 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3289 "activate or deactivate some volume groups",
3291 This command activates or (if C<activate> is false) deactivates
3292 all logical volumes in the listed volume groups C<volgroups>.
3293 If activated, then they are made known to the
3294 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
3295 then those devices disappear.
3297 This command is the same as running C<vgchange -a y|n volgroups...>
3299 Note that if C<volgroups> is an empty list then B<all> volume groups
3300 are activated or deactivated.");
3302 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3303 [InitNone, Always, TestOutput (
3304 [["part_disk"; "/dev/sda"; "mbr"];
3305 ["pvcreate"; "/dev/sda1"];
3306 ["vgcreate"; "VG"; "/dev/sda1"];
3307 ["lvcreate"; "LV"; "VG"; "10"];
3308 ["mkfs"; "ext2"; "/dev/VG/LV"];
3309 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3310 ["write"; "/new"; "test content"];
3312 ["lvresize"; "/dev/VG/LV"; "20"];
3313 ["e2fsck_f"; "/dev/VG/LV"];
3314 ["resize2fs"; "/dev/VG/LV"];
3315 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3316 ["cat"; "/new"]], "test content");
3317 InitNone, Always, TestRun (
3318 (* Make an LV smaller to test RHBZ#587484. *)
3319 [["part_disk"; "/dev/sda"; "mbr"];
3320 ["pvcreate"; "/dev/sda1"];
3321 ["vgcreate"; "VG"; "/dev/sda1"];
3322 ["lvcreate"; "LV"; "VG"; "20"];
3323 ["lvresize"; "/dev/VG/LV"; "10"]])],
3324 "resize an LVM logical volume",
3326 This resizes (expands or shrinks) an existing LVM logical
3327 volume to C<mbytes>. When reducing, data in the reduced part
3330 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3331 [], (* lvresize tests this *)
3332 "resize an ext2, ext3 or ext4 filesystem",
3334 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3335 the underlying device.
3337 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3338 on the C<device> before calling this command. For unknown reasons
3339 C<resize2fs> sometimes gives an error about this and sometimes not.
3340 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3341 calling this function.");
3343 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3344 [InitBasicFS, Always, TestOutputList (
3345 [["find"; "/"]], ["lost+found"]);
3346 InitBasicFS, Always, TestOutputList (
3350 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3351 InitScratchFS, Always, TestOutputList (
3352 [["mkdir_p"; "/find/b/c"];
3353 ["touch"; "/find/b/c/d"];
3354 ["find"; "/find/b/"]], ["c"; "c/d"])],
3355 "find all files and directories",
3357 This command lists out all files and directories, recursively,
3358 starting at C<directory>. It is essentially equivalent to
3359 running the shell command C<find directory -print> but some
3360 post-processing happens on the output, described below.
3362 This returns a list of strings I<without any prefix>. Thus
3363 if the directory structure was:
3369 then the returned list from C<guestfs_find> C</tmp> would be
3377 If C<directory> is not a directory, then this command returns
3380 The returned list is sorted.
3382 See also C<guestfs_find0>.");
3384 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3385 [], (* lvresize tests this *)
3386 "check an ext2/ext3 filesystem",
3388 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3389 filesystem checker on C<device>, noninteractively (I<-p>),
3390 even if the filesystem appears to be clean (I<-f>).
3392 This command is only needed because of C<guestfs_resize2fs>
3393 (q.v.). Normally you should use C<guestfs_fsck>.");
3395 ("sleep", (RErr, [Int "secs"], []), 109, [],
3396 [InitNone, Always, TestRun (
3398 "sleep for some seconds",
3400 Sleep for C<secs> seconds.");
3402 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3403 [InitNone, Always, TestOutputInt (
3404 [["part_disk"; "/dev/sda"; "mbr"];
3405 ["mkfs"; "ntfs"; "/dev/sda1"];
3406 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3407 InitNone, Always, TestOutputInt (
3408 [["part_disk"; "/dev/sda"; "mbr"];
3409 ["mkfs"; "ext2"; "/dev/sda1"];
3410 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3411 "probe NTFS volume",
3413 This command runs the L<ntfs-3g.probe(8)> command which probes
3414 an NTFS C<device> for mountability. (Not all NTFS volumes can
3415 be mounted read-write, and some cannot be mounted at all).
3417 C<rw> is a boolean flag. Set it to true if you want to test
3418 if the volume can be mounted read-write. Set it to false if
3419 you want to test if the volume can be mounted read-only.
3421 The return value is an integer which C<0> if the operation
3422 would succeed, or some non-zero value documented in the
3423 L<ntfs-3g.probe(8)> manual page.");
3425 ("sh", (RString "output", [String "command"], []), 111, [],
3426 [], (* XXX needs tests *)
3427 "run a command via the shell",
3429 This call runs a command from the guest filesystem via the
3432 This is like C<guestfs_command>, but passes the command to:
3434 /bin/sh -c \"command\"
3436 Depending on the guest's shell, this usually results in
3437 wildcards being expanded, shell expressions being interpolated
3440 All the provisos about C<guestfs_command> apply to this call.");
3442 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3443 [], (* XXX needs tests *)
3444 "run a command via the shell returning lines",
3446 This is the same as C<guestfs_sh>, but splits the result
3447 into a list of lines.
3449 See also: C<guestfs_command_lines>");
3451 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3452 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3453 * code in stubs.c, since all valid glob patterns must start with "/".
3454 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3456 [InitScratchFS, Always, TestOutputList (
3457 [["mkdir_p"; "/glob_expand/b/c"];
3458 ["touch"; "/glob_expand/b/c/d"];
3459 ["touch"; "/glob_expand/b/c/e"];
3460 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3461 InitScratchFS, Always, TestOutputList (
3462 [["mkdir_p"; "/glob_expand2/b/c"];
3463 ["touch"; "/glob_expand2/b/c/d"];
3464 ["touch"; "/glob_expand2/b/c/e"];
3465 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3466 InitScratchFS, Always, TestOutputList (
3467 [["mkdir_p"; "/glob_expand3/b/c"];
3468 ["touch"; "/glob_expand3/b/c/d"];
3469 ["touch"; "/glob_expand3/b/c/e"];
3470 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3471 "expand a wildcard path",
3473 This command searches for all the pathnames matching
3474 C<pattern> according to the wildcard expansion rules
3477 If no paths match, then this returns an empty list
3478 (note: not an error).
3480 It is just a wrapper around the C L<glob(3)> function
3481 with flags C<GLOB_MARK|GLOB_BRACE>.
3482 See that manual page for more details.");
3484 ("scrub_device", (RErr, [Device "device"], []), 114, [DangerWillRobinson; Optional "scrub"],
3485 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3486 [["scrub_device"; "/dev/sdc"]])],
3487 "scrub (securely wipe) a device",
3489 This command writes patterns over C<device> to make data retrieval
3492 It is an interface to the L<scrub(1)> program. See that
3493 manual page for more details.");
3495 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3496 [InitScratchFS, Always, TestRun (
3497 [["write"; "/scrub_file"; "content"];
3498 ["scrub_file"; "/scrub_file"]])],
3499 "scrub (securely wipe) a file",
3501 This command writes patterns over a file to make data retrieval
3504 The file is I<removed> after scrubbing.
3506 It is an interface to the L<scrub(1)> program. See that
3507 manual page for more details.");
3509 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3510 [], (* XXX needs testing *)
3511 "scrub (securely wipe) free space",
3513 This command creates the directory C<dir> and then fills it
3514 with files until the filesystem is full, and scrubs the files
3515 as for C<guestfs_scrub_file>, and deletes them.
3516 The intention is to scrub any free space on the partition
3519 It is an interface to the L<scrub(1)> program. See that
3520 manual page for more details.");
3522 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3523 [InitScratchFS, Always, TestRun (
3524 [["mkdir"; "/mkdtemp"];
3525 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3526 "create a temporary directory",
3528 This command creates a temporary directory. The
3529 C<template> parameter should be a full pathname for the
3530 temporary directory name with the final six characters being
3533 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3534 the second one being suitable for Windows filesystems.
3536 The name of the temporary directory that was created
3539 The temporary directory is created with mode 0700
3540 and is owned by root.
3542 The caller is responsible for deleting the temporary
3543 directory and its contents after use.
3545 See also: L<mkdtemp(3)>");
3547 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3548 [InitISOFS, Always, TestOutputInt (
3549 [["wc_l"; "/10klines"]], 10000);
3550 (* Test for RHBZ#579608, absolute symbolic links. *)
3551 InitISOFS, Always, TestOutputInt (
3552 [["wc_l"; "/abssymlink"]], 10000)],
3553 "count lines in a file",
3555 This command counts the lines in a file, using the
3556 C<wc -l> external command.");
3558 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3559 [InitISOFS, Always, TestOutputInt (
3560 [["wc_w"; "/10klines"]], 10000)],
3561 "count words in a file",
3563 This command counts the words in a file, using the
3564 C<wc -w> external command.");
3566 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3567 [InitISOFS, Always, TestOutputInt (
3568 [["wc_c"; "/100kallspaces"]], 102400)],
3569 "count characters in a file",
3571 This command counts the characters in a file, using the
3572 C<wc -c> external command.");
3574 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3575 [InitISOFS, Always, TestOutputList (
3576 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3577 (* Test for RHBZ#579608, absolute symbolic links. *)
3578 InitISOFS, Always, TestOutputList (
3579 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3580 "return first 10 lines of a file",
3582 This command returns up to the first 10 lines of a file as
3583 a list of strings.");
3585 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3586 [InitISOFS, Always, TestOutputList (
3587 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3588 InitISOFS, Always, TestOutputList (
3589 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3590 InitISOFS, Always, TestOutputList (
3591 [["head_n"; "0"; "/10klines"]], [])],
3592 "return first N lines of a file",
3594 If the parameter C<nrlines> is a positive number, this returns the first
3595 C<nrlines> lines of the file C<path>.
3597 If the parameter C<nrlines> is a negative number, this returns lines
3598 from the file C<path>, excluding the last C<nrlines> lines.
3600 If the parameter C<nrlines> is zero, this returns an empty list.");
3602 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3603 [InitISOFS, Always, TestOutputList (
3604 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3605 "return last 10 lines of a file",
3607 This command returns up to the last 10 lines of a file as
3608 a list of strings.");
3610 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3611 [InitISOFS, Always, TestOutputList (
3612 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3613 InitISOFS, Always, TestOutputList (
3614 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3615 InitISOFS, Always, TestOutputList (
3616 [["tail_n"; "0"; "/10klines"]], [])],
3617 "return last N lines of a file",
3619 If the parameter C<nrlines> is a positive number, this returns the last
3620 C<nrlines> lines of the file C<path>.
3622 If the parameter C<nrlines> is a negative number, this returns lines
3623 from the file C<path>, starting with the C<-nrlines>th line.
3625 If the parameter C<nrlines> is zero, this returns an empty list.");
3627 ("df", (RString "output", [], []), 125, [],
3628 [], (* XXX Tricky to test because it depends on the exact format
3629 * of the 'df' command and other imponderables.
3631 "report file system disk space usage",
3633 This command runs the C<df> command to report disk space used.
3635 This command is mostly useful for interactive sessions. It
3636 is I<not> intended that you try to parse the output string.
3637 Use C<guestfs_statvfs> from programs.");
3639 ("df_h", (RString "output", [], []), 126, [],
3640 [], (* XXX Tricky to test because it depends on the exact format
3641 * of the 'df' command and other imponderables.
3643 "report file system disk space usage (human readable)",
3645 This command runs the C<df -h> command to report disk space used
3646 in human-readable format.
3648 This command is mostly useful for interactive sessions. It
3649 is I<not> intended that you try to parse the output string.
3650 Use C<guestfs_statvfs> from programs.");
3652 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3653 [InitISOFS, Always, TestOutputInt (
3654 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3655 "estimate file space usage",
3657 This command runs the C<du -s> command to estimate file space
3660 C<path> can be a file or a directory. If C<path> is a directory
3661 then the estimate includes the contents of the directory and all
3662 subdirectories (recursively).
3664 The result is the estimated size in I<kilobytes>
3665 (ie. units of 1024 bytes).");
3667 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3668 [InitISOFS, Always, TestOutputList (
3669 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3670 "list files in an initrd",
3672 This command lists out files contained in an initrd.
3674 The files are listed without any initial C</> character. The
3675 files are listed in the order they appear (not necessarily
3676 alphabetical). Directory names are listed as separate items.
3678 Old Linux kernels (2.4 and earlier) used a compressed ext2
3679 filesystem as initrd. We I<only> support the newer initramfs
3680 format (compressed cpio files).");
3682 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3684 "mount a file using the loop device",
3686 This command lets you mount C<file> (a filesystem image
3687 in a file) on a mount point. It is entirely equivalent to
3688 the command C<mount -o loop file mountpoint>.");
3690 ("mkswap", (RErr, [Device "device"], []), 130, [],
3691 [InitEmpty, Always, TestRun (
3692 [["part_disk"; "/dev/sda"; "mbr"];
3693 ["mkswap"; "/dev/sda1"]])],
3694 "create a swap partition",
3696 Create a swap partition on C<device>.");
3698 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3699 [InitEmpty, Always, TestRun (
3700 [["part_disk"; "/dev/sda"; "mbr"];
3701 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3702 "create a swap partition with a label",
3704 Create a swap partition on C<device> with label C<label>.
3706 Note that you cannot attach a swap label to a block device
3707 (eg. C</dev/sda>), just to a partition. This appears to be
3708 a limitation of the kernel or swap tools.");
3710 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3711 (let uuid = uuidgen () in
3712 [InitEmpty, Always, TestRun (
3713 [["part_disk"; "/dev/sda"; "mbr"];
3714 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3715 "create a swap partition with an explicit UUID",
3717 Create a swap partition on C<device> with UUID C<uuid>.");
3719 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3720 [InitScratchFS, Always, TestOutputStruct (
3721 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3722 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3723 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3724 InitScratchFS, Always, TestOutputStruct (
3725 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3726 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3727 "make block, character or FIFO devices",
3729 This call creates block or character special devices, or
3730 named pipes (FIFOs).
3732 The C<mode> parameter should be the mode, using the standard
3733 constants. C<devmajor> and C<devminor> are the
3734 device major and minor numbers, only used when creating block
3735 and character special devices.
3737 Note that, just like L<mknod(2)>, the mode must be bitwise
3738 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3739 just creates a regular file). These constants are
3740 available in the standard Linux header files, or you can use
3741 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3742 which are wrappers around this command which bitwise OR
3743 in the appropriate constant for you.
3745 The mode actually set is affected by the umask.");
3747 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3748 [InitScratchFS, Always, TestOutputStruct (
3749 [["mkfifo"; "0o777"; "/mkfifo"];
3750 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3751 "make FIFO (named pipe)",
3753 This call creates a FIFO (named pipe) called C<path> with
3754 mode C<mode>. It is just a convenient wrapper around
3757 The mode actually set is affected by the umask.");
3759 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3760 [InitScratchFS, Always, TestOutputStruct (
3761 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3762 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3763 "make block device node",
3765 This call creates a block device node called C<path> with
3766 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3767 It is just a convenient wrapper around C<guestfs_mknod>.
3769 The mode actually set is affected by the umask.");
3771 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3772 [InitScratchFS, Always, TestOutputStruct (
3773 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3774 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3775 "make char device node",
3777 This call creates a char device node called C<path> with
3778 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3779 It is just a convenient wrapper around C<guestfs_mknod>.
3781 The mode actually set is affected by the umask.");
3783 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3784 [InitEmpty, Always, TestOutputInt (
3785 [["umask"; "0o22"]], 0o22)],
3786 "set file mode creation mask (umask)",
3788 This function sets the mask used for creating new files and
3789 device nodes to C<mask & 0777>.
3791 Typical umask values would be C<022> which creates new files
3792 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3793 C<002> which creates new files with permissions like
3794 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3796 The default umask is C<022>. This is important because it
3797 means that directories and device nodes will be created with
3798 C<0644> or C<0755> mode even if you specify C<0777>.
3800 See also C<guestfs_get_umask>,
3801 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3803 This call returns the previous umask.");
3805 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3807 "read directories entries",
3809 This returns the list of directory entries in directory C<dir>.
3811 All entries in the directory are returned, including C<.> and
3812 C<..>. The entries are I<not> sorted, but returned in the same
3813 order as the underlying filesystem.
3815 Also this call returns basic file type information about each
3816 file. The C<ftyp> field will contain one of the following characters:
3854 The L<readdir(3)> call returned a C<d_type> field with an
3859 This function is primarily intended for use by programs. To
3860 get a simple list of names, use C<guestfs_ls>. To get a printable
3861 directory for human consumption, use C<guestfs_ll>.");
3863 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DangerWillRobinson; DeprecatedBy "part_add"],
3865 "create partitions on a block device",
3867 This is a simplified interface to the C<guestfs_sfdisk>
3868 command, where partition sizes are specified in megabytes
3869 only (rounded to the nearest cylinder) and you don't need
3870 to specify the cyls, heads and sectors parameters which
3871 were rarely if ever used anyway.
3873 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3874 and C<guestfs_part_disk>");
3876 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
3878 "determine file type inside a compressed file",
3880 This command runs C<file> after first decompressing C<path>
3883 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3885 Since 1.0.63, use C<guestfs_file> instead which can now
3886 process compressed files.");
3888 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
3890 "list extended attributes of a file or directory",
3892 This call lists the extended attributes of the file or directory
3895 At the system call level, this is a combination of the
3896 L<listxattr(2)> and L<getxattr(2)> calls.
3898 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3900 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
3902 "list extended attributes of a file or directory",
3904 This is the same as C<guestfs_getxattrs>, but if C<path>
3905 is a symbolic link, then it returns the extended attributes
3906 of the link itself.");
3908 ("setxattr", (RErr, [String "xattr";
3909 String "val"; Int "vallen"; (* will be BufferIn *)
3910 Pathname "path"], []), 143, [Optional "linuxxattrs"],
3912 "set extended attribute of a file or directory",
3914 This call sets the extended attribute named C<xattr>
3915 of the file C<path> to the value C<val> (of length C<vallen>).
3916 The value is arbitrary 8 bit data.
3918 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3920 ("lsetxattr", (RErr, [String "xattr";
3921 String "val"; Int "vallen"; (* will be BufferIn *)
3922 Pathname "path"], []), 144, [Optional "linuxxattrs"],
3924 "set extended attribute of a file or directory",
3926 This is the same as C<guestfs_setxattr>, but if C<path>
3927 is a symbolic link, then it sets an extended attribute
3928 of the link itself.");
3930 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
3932 "remove extended attribute of a file or directory",
3934 This call removes the extended attribute named C<xattr>
3935 of the file C<path>.
3937 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3939 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
3941 "remove extended attribute of a file or directory",
3943 This is the same as C<guestfs_removexattr>, but if C<path>
3944 is a symbolic link, then it removes an extended attribute
3945 of the link itself.");
3947 ("mountpoints", (RHashtable "mps", [], []), 147, [],
3951 This call is similar to C<guestfs_mounts>. That call returns
3952 a list of devices. This one returns a hash table (map) of
3953 device name to directory where the device is mounted.");
3955 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
3956 (* This is a special case: while you would expect a parameter
3957 * of type "Pathname", that doesn't work, because it implies
3958 * NEED_ROOT in the generated calling code in stubs.c, and
3959 * this function cannot use NEED_ROOT.
3962 "create a mountpoint",
3964 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3965 specialized calls that can be used to create extra mountpoints
3966 before mounting the first filesystem.
3968 These calls are I<only> necessary in some very limited circumstances,
3969 mainly the case where you want to mount a mix of unrelated and/or
3970 read-only filesystems together.
3972 For example, live CDs often contain a \"Russian doll\" nest of
3973 filesystems, an ISO outer layer, with a squashfs image inside, with
3974 an ext2/3 image inside that. You can unpack this as follows
3977 add-ro Fedora-11-i686-Live.iso
3981 mkmountpoint /ext3fs
3983 mount-loop /cd/LiveOS/squashfs.img /sqsh
3984 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
3986 The inner filesystem is now unpacked under the /ext3fs mountpoint.
3988 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
3989 You may get unexpected errors if you try to mix these calls. It is
3990 safest to manually unmount filesystems and remove mountpoints after use.
3992 C<guestfs_umount_all> unmounts filesystems by sorting the paths
3993 longest first, so for this to work for manual mountpoints, you
3994 must ensure that the innermost mountpoints have the longest
3995 pathnames, as in the example code above.
3997 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
3999 Autosync [see C<guestfs_set_autosync>, this is set by default on
4000 handles] can cause C<guestfs_umount_all> to be called when the handle
4001 is closed which can also trigger these issues.");
4003 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4005 "remove a mountpoint",
4007 This calls removes a mountpoint that was previously created
4008 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4009 for full details.");
4011 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4012 [InitISOFS, Always, TestOutputBuffer (
4013 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4014 (* Test various near large, large and too large files (RHBZ#589039). *)
4015 InitScratchFS, Always, TestLastFail (
4016 [["touch"; "/read_file"];
4017 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4018 ["read_file"; "/read_file"]]);
4019 InitScratchFS, Always, TestLastFail (
4020 [["touch"; "/read_file2"];
4021 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4022 ["read_file"; "/read_file2"]]);
4023 InitScratchFS, Always, TestLastFail (
4024 [["touch"; "/read_file3"];
4025 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4026 ["read_file"; "/read_file3"]])],
4029 This calls returns the contents of the file C<path> as a
4032 Unlike C<guestfs_cat>, this function can correctly
4033 handle files that contain embedded ASCII NUL characters.
4034 However unlike C<guestfs_download>, this function is limited
4035 in the total size of file that can be handled.");
4037 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4038 [InitISOFS, Always, TestOutputList (
4039 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4040 InitISOFS, Always, TestOutputList (
4041 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4042 (* Test for RHBZ#579608, absolute symbolic links. *)
4043 InitISOFS, Always, TestOutputList (
4044 [["grep"; "nomatch"; "/abssymlink"]], [])],
4045 "return lines matching a pattern",
4047 This calls the external C<grep> program and returns the
4050 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4051 [InitISOFS, Always, TestOutputList (
4052 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4053 "return lines matching a pattern",
4055 This calls the external C<egrep> program and returns the
4058 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4059 [InitISOFS, Always, TestOutputList (
4060 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4061 "return lines matching a pattern",
4063 This calls the external C<fgrep> program and returns the
4066 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4067 [InitISOFS, Always, TestOutputList (
4068 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4069 "return lines matching a pattern",
4071 This calls the external C<grep -i> program and returns the
4074 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4075 [InitISOFS, Always, TestOutputList (
4076 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4077 "return lines matching a pattern",
4079 This calls the external C<egrep -i> program and returns the
4082 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4083 [InitISOFS, Always, TestOutputList (
4084 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4085 "return lines matching a pattern",
4087 This calls the external C<fgrep -i> program and returns the
4090 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4091 [InitISOFS, Always, TestOutputList (
4092 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4093 "return lines matching a pattern",
4095 This calls the external C<zgrep> program and returns the
4098 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4099 [InitISOFS, Always, TestOutputList (
4100 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4101 "return lines matching a pattern",
4103 This calls the external C<zegrep> program and returns the
4106 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4107 [InitISOFS, Always, TestOutputList (
4108 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4109 "return lines matching a pattern",
4111 This calls the external C<zfgrep> program and returns the
4114 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4115 [InitISOFS, Always, TestOutputList (
4116 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4117 "return lines matching a pattern",
4119 This calls the external C<zgrep -i> program and returns the
4122 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4123 [InitISOFS, Always, TestOutputList (
4124 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4125 "return lines matching a pattern",
4127 This calls the external C<zegrep -i> program and returns the
4130 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4131 [InitISOFS, Always, TestOutputList (
4132 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4133 "return lines matching a pattern",
4135 This calls the external C<zfgrep -i> program and returns the
4138 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4139 [InitISOFS, Always, TestOutput (
4140 [["realpath"; "/../directory"]], "/directory")],
4141 "canonicalized absolute pathname",
4143 Return the canonicalized absolute pathname of C<path>. The
4144 returned path has no C<.>, C<..> or symbolic link path elements.");
4146 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4147 [InitScratchFS, Always, TestOutputStruct (
4150 ["ln"; "/ln/a"; "/ln/b"];
4151 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4152 "create a hard link",
4154 This command creates a hard link using the C<ln> command.");
4156 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4157 [InitScratchFS, Always, TestOutputStruct (
4158 [["mkdir"; "/ln_f"];
4159 ["touch"; "/ln_f/a"];
4160 ["touch"; "/ln_f/b"];
4161 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4162 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4163 "create a hard link",
4165 This command creates a hard link using the C<ln -f> command.
4166 The I<-f> option removes the link (C<linkname>) if it exists already.");
4168 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4169 [InitScratchFS, Always, TestOutputStruct (
4170 [["mkdir"; "/ln_s"];
4171 ["touch"; "/ln_s/a"];
4172 ["ln_s"; "a"; "/ln_s/b"];
4173 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4174 "create a symbolic link",
4176 This command creates a symbolic link using the C<ln -s> command.");
4178 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4179 [InitScratchFS, Always, TestOutput (
4180 [["mkdir_p"; "/ln_sf/b"];
4181 ["touch"; "/ln_sf/b/c"];
4182 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4183 ["readlink"; "/ln_sf/b/c"]], "../d")],
4184 "create a symbolic link",
4186 This command creates a symbolic link using the C<ln -sf> command,
4187 The I<-f> option removes the link (C<linkname>) if it exists already.");
4189 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4190 [] (* XXX tested above *),
4191 "read the target of a symbolic link",
4193 This command reads the target of a symbolic link.");
4195 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4196 [InitScratchFS, Always, TestOutputStruct (
4197 [["fallocate"; "/fallocate"; "1000000"];
4198 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4199 "preallocate a file in the guest filesystem",
4201 This command preallocates a file (containing zero bytes) named
4202 C<path> of size C<len> bytes. If the file exists already, it
4205 Do not confuse this with the guestfish-specific
4206 C<alloc> command which allocates a file in the host and
4207 attaches it as a device.");
4209 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4210 [InitPartition, Always, TestRun (
4211 [["mkswap"; "/dev/sda1"];
4212 ["swapon_device"; "/dev/sda1"];
4213 ["swapoff_device"; "/dev/sda1"]])],
4214 "enable swap on device",
4216 This command enables the libguestfs appliance to use the
4217 swap device or partition named C<device>. The increased
4218 memory is made available for all commands, for example
4219 those run using C<guestfs_command> or C<guestfs_sh>.
4221 Note that you should not swap to existing guest swap
4222 partitions unless you know what you are doing. They may
4223 contain hibernation information, or other information that
4224 the guest doesn't want you to trash. You also risk leaking
4225 information about the host to the guest this way. Instead,
4226 attach a new host device to the guest and swap on that.");
4228 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4229 [], (* XXX tested by swapon_device *)
4230 "disable swap on device",
4232 This command disables the libguestfs appliance swap
4233 device or partition named C<device>.
4234 See C<guestfs_swapon_device>.");
4236 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4237 [InitScratchFS, Always, TestRun (
4238 [["fallocate"; "/swapon_file"; "8388608"];
4239 ["mkswap_file"; "/swapon_file"];
4240 ["swapon_file"; "/swapon_file"];
4241 ["swapoff_file"; "/swapon_file"];
4242 ["rm"; "/swapon_file"]])],
4243 "enable swap on file",
4245 This command enables swap to a file.
4246 See C<guestfs_swapon_device> for other notes.");
4248 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4249 [], (* XXX tested by swapon_file *)
4250 "disable swap on file",
4252 This command disables the libguestfs appliance swap on file.");
4254 ("swapon_label", (RErr, [String "label"], []), 174, [],
4255 [InitEmpty, Always, TestRun (
4256 [["part_disk"; "/dev/sda"; "mbr"];
4257 ["mkswap_L"; "swapit"; "/dev/sda1"];
4258 ["swapon_label"; "swapit"];
4259 ["swapoff_label"; "swapit"];
4260 ["zero"; "/dev/sda"];
4261 ["blockdev_rereadpt"; "/dev/sda"]])],
4262 "enable swap on labeled swap partition",
4264 This command enables swap to a labeled swap partition.
4265 See C<guestfs_swapon_device> for other notes.");
4267 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4268 [], (* XXX tested by swapon_label *)
4269 "disable swap on labeled swap partition",
4271 This command disables the libguestfs appliance swap on
4272 labeled swap partition.");
4274 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4275 (let uuid = uuidgen () in
4276 [InitEmpty, Always, TestRun (
4277 [["mkswap_U"; uuid; "/dev/sdc"];
4278 ["swapon_uuid"; uuid];
4279 ["swapoff_uuid"; uuid]])]),
4280 "enable swap on swap partition by UUID",
4282 This command enables swap to a swap partition with the given UUID.
4283 See C<guestfs_swapon_device> for other notes.");
4285 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4286 [], (* XXX tested by swapon_uuid *)
4287 "disable swap on swap partition by UUID",
4289 This command disables the libguestfs appliance swap partition
4290 with the given UUID.");
4292 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4293 [InitScratchFS, Always, TestRun (
4294 [["fallocate"; "/mkswap_file"; "8388608"];
4295 ["mkswap_file"; "/mkswap_file"];
4296 ["rm"; "/mkswap_file"]])],
4297 "create a swap file",
4301 This command just writes a swap file signature to an existing
4302 file. To create the file itself, use something like C<guestfs_fallocate>.");
4304 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4305 [InitISOFS, Always, TestRun (
4306 [["inotify_init"; "0"]])],
4307 "create an inotify handle",
4309 This command creates a new inotify handle.
4310 The inotify subsystem can be used to notify events which happen to
4311 objects in the guest filesystem.
4313 C<maxevents> is the maximum number of events which will be
4314 queued up between calls to C<guestfs_inotify_read> or
4315 C<guestfs_inotify_files>.
4316 If this is passed as C<0>, then the kernel (or previously set)
4317 default is used. For Linux 2.6.29 the default was 16384 events.
4318 Beyond this limit, the kernel throws away events, but records
4319 the fact that it threw them away by setting a flag
4320 C<IN_Q_OVERFLOW> in the returned structure list (see
4321 C<guestfs_inotify_read>).
4323 Before any events are generated, you have to add some
4324 watches to the internal watch list. See:
4325 C<guestfs_inotify_add_watch>,
4326 C<guestfs_inotify_rm_watch> and
4327 C<guestfs_inotify_watch_all>.
4329 Queued up events should be read periodically by calling
4330 C<guestfs_inotify_read>
4331 (or C<guestfs_inotify_files> which is just a helpful
4332 wrapper around C<guestfs_inotify_read>). If you don't
4333 read the events out often enough then you risk the internal
4336 The handle should be closed after use by calling
4337 C<guestfs_inotify_close>. This also removes any
4338 watches automatically.
4340 See also L<inotify(7)> for an overview of the inotify interface
4341 as exposed by the Linux kernel, which is roughly what we expose
4342 via libguestfs. Note that there is one global inotify handle
4343 per libguestfs instance.");
4345 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4346 [InitScratchFS, Always, TestOutputList (
4347 [["mkdir"; "/inotify_add_watch"];
4348 ["inotify_init"; "0"];
4349 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4350 ["touch"; "/inotify_add_watch/a"];
4351 ["touch"; "/inotify_add_watch/b"];
4352 ["inotify_files"]], ["a"; "b"])],
4353 "add an inotify watch",
4355 Watch C<path> for the events listed in C<mask>.
4357 Note that if C<path> is a directory then events within that
4358 directory are watched, but this does I<not> happen recursively
4359 (in subdirectories).
4361 Note for non-C or non-Linux callers: the inotify events are
4362 defined by the Linux kernel ABI and are listed in
4363 C</usr/include/sys/inotify.h>.");
4365 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4367 "remove an inotify watch",
4369 Remove a previously defined inotify watch.
4370 See C<guestfs_inotify_add_watch>.");
4372 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4374 "return list of inotify events",
4376 Return the complete queue of events that have happened
4377 since the previous read call.
4379 If no events have happened, this returns an empty list.
4381 I<Note>: In order to make sure that all events have been
4382 read, you must call this function repeatedly until it
4383 returns an empty list. The reason is that the call will
4384 read events up to the maximum appliance-to-host message
4385 size and leave remaining events in the queue.");
4387 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4389 "return list of watched files that had events",
4391 This function is a helpful wrapper around C<guestfs_inotify_read>
4392 which just returns a list of pathnames of objects that were
4393 touched. The returned pathnames are sorted and deduplicated.");
4395 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4397 "close the inotify handle",
4399 This closes the inotify handle which was previously
4400 opened by inotify_init. It removes all watches, throws
4401 away any pending events, and deallocates all resources.");
4403 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4405 "set SELinux security context",
4407 This sets the SELinux security context of the daemon
4408 to the string C<context>.
4410 See the documentation about SELINUX in L<guestfs(3)>.");
4412 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4414 "get SELinux security context",
4416 This gets the SELinux security context of the daemon.
4418 See the documentation about SELINUX in L<guestfs(3)>,
4419 and C<guestfs_setcon>");
4421 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4422 [InitEmpty, Always, TestOutput (
4423 [["part_disk"; "/dev/sda"; "mbr"];
4424 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4425 ["mount_options"; ""; "/dev/sda1"; "/"];
4426 ["write"; "/new"; "new file contents"];
4427 ["cat"; "/new"]], "new file contents");
4428 InitEmpty, Always, TestRun (
4429 [["part_disk"; "/dev/sda"; "mbr"];
4430 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4431 InitEmpty, Always, TestLastFail (
4432 [["part_disk"; "/dev/sda"; "mbr"];
4433 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4434 InitEmpty, Always, TestLastFail (
4435 [["part_disk"; "/dev/sda"; "mbr"];
4436 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4437 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4438 [["part_disk"; "/dev/sda"; "mbr"];
4439 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4440 "make a filesystem with block size",
4442 This call is similar to C<guestfs_mkfs>, but it allows you to
4443 control the block size of the resulting filesystem. Supported
4444 block sizes depend on the filesystem type, but typically they
4445 are C<1024>, C<2048> or C<4096> only.
4447 For VFAT and NTFS the C<blocksize> parameter is treated as
4448 the requested cluster size.");
4450 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4451 [InitEmpty, Always, TestOutput (
4452 [["part_init"; "/dev/sda"; "mbr"];
4453 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4454 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4455 ["mke2journal"; "4096"; "/dev/sda1"];
4456 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4457 ["mount_options"; ""; "/dev/sda2"; "/"];
4458 ["write"; "/new"; "new file contents"];
4459 ["cat"; "/new"]], "new file contents")],
4460 "make ext2/3/4 external journal",
4462 This creates an ext2 external journal on C<device>. It is equivalent
4465 mke2fs -O journal_dev -b blocksize device");
4467 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4468 [InitEmpty, Always, TestOutput (
4469 [["part_init"; "/dev/sda"; "mbr"];
4470 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4471 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4472 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4473 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4474 ["mount_options"; ""; "/dev/sda2"; "/"];
4475 ["write"; "/new"; "new file contents"];
4476 ["cat"; "/new"]], "new file contents")],
4477 "make ext2/3/4 external journal with label",
4479 This creates an ext2 external journal on C<device> with label C<label>.");
4481 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4482 (let uuid = uuidgen () in
4483 [InitEmpty, Always, TestOutput (
4484 [["part_init"; "/dev/sda"; "mbr"];
4485 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4486 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4487 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4488 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4489 ["mount_options"; ""; "/dev/sda2"; "/"];
4490 ["write"; "/new"; "new file contents"];
4491 ["cat"; "/new"]], "new file contents")]),
4492 "make ext2/3/4 external journal with UUID",
4494 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4496 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4498 "make ext2/3/4 filesystem with external journal",
4500 This creates an ext2/3/4 filesystem on C<device> with
4501 an external journal on C<journal>. It is equivalent
4504 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4506 See also C<guestfs_mke2journal>.");
4508 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4510 "make ext2/3/4 filesystem with external journal",
4512 This creates an ext2/3/4 filesystem on C<device> with
4513 an external journal on the journal labeled C<label>.
4515 See also C<guestfs_mke2journal_L>.");
4517 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4519 "make ext2/3/4 filesystem with external journal",
4521 This creates an ext2/3/4 filesystem on C<device> with
4522 an external journal on the journal with UUID C<uuid>.
4524 See also C<guestfs_mke2journal_U>.");
4526 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4527 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4528 "load a kernel module",
4530 This loads a kernel module in the appliance.
4532 The kernel module must have been whitelisted when libguestfs
4533 was built (see C<appliance/kmod.whitelist.in> in the source).");
4535 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4536 [InitNone, Always, TestOutput (
4537 [["echo_daemon"; "This is a test"]], "This is a test"
4539 "echo arguments back to the client",
4541 This command concatenates the list of C<words> passed with single spaces
4542 between them and returns the resulting string.
4544 You can use this command to test the connection through to the daemon.
4546 See also C<guestfs_ping_daemon>.");
4548 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4549 [], (* There is a regression test for this. *)
4550 "find all files and directories, returning NUL-separated list",
4552 This command lists out all files and directories, recursively,
4553 starting at C<directory>, placing the resulting list in the
4554 external file called C<files>.
4556 This command works the same way as C<guestfs_find> with the
4557 following exceptions:
4563 The resulting list is written to an external file.
4567 Items (filenames) in the result are separated
4568 by C<\\0> characters. See L<find(1)> option I<-print0>.
4572 This command is not limited in the number of names that it
4577 The result list is not sorted.
4581 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4582 [InitISOFS, Always, TestOutput (
4583 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4584 InitISOFS, Always, TestOutput (
4585 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4586 InitISOFS, Always, TestOutput (
4587 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4588 InitISOFS, Always, TestLastFail (
4589 [["case_sensitive_path"; "/Known-1/"]]);
4590 InitScratchFS, Always, TestOutput (
4591 [["mkdir"; "/case_sensitive_path"];
4592 ["mkdir"; "/case_sensitive_path/bbb"];
4593 ["touch"; "/case_sensitive_path/bbb/c"];
4594 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4595 InitScratchFS, Always, TestOutput (
4596 [["mkdir"; "/case_sensitive_path2"];
4597 ["mkdir"; "/case_sensitive_path2/bbb"];
4598 ["touch"; "/case_sensitive_path2/bbb/c"];
4599 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4600 InitScratchFS, Always, TestLastFail (
4601 [["mkdir"; "/case_sensitive_path3"];
4602 ["mkdir"; "/case_sensitive_path3/bbb"];
4603 ["touch"; "/case_sensitive_path3/bbb/c"];
4604 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4605 "return true path on case-insensitive filesystem",
4607 This can be used to resolve case insensitive paths on
4608 a filesystem which is case sensitive. The use case is
4609 to resolve paths which you have read from Windows configuration
4610 files or the Windows Registry, to the true path.
4612 The command handles a peculiarity of the Linux ntfs-3g
4613 filesystem driver (and probably others), which is that although
4614 the underlying filesystem is case-insensitive, the driver
4615 exports the filesystem to Linux as case-sensitive.
4617 One consequence of this is that special directories such
4618 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4619 (or other things) depending on the precise details of how
4620 they were created. In Windows itself this would not be
4623 Bug or feature? You decide:
4624 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4626 This function resolves the true case of each element in the
4627 path and returns the case-sensitive path.
4629 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4630 might return C<\"/WINDOWS/system32\"> (the exact return value
4631 would depend on details of how the directories were originally
4632 created under Windows).
4635 This function does not handle drive names, backslashes etc.
4637 See also C<guestfs_realpath>.");
4639 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4640 [InitScratchFS, Always, TestOutput (
4641 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4642 "get the Linux VFS type corresponding to a mounted device",
4644 This command gets the filesystem type corresponding to
4645 the filesystem on C<device>.
4647 For most filesystems, the result is the name of the Linux
4648 VFS module which would be used to mount this filesystem
4649 if you mounted it without specifying the filesystem type.
4650 For example a string such as C<ext3> or C<ntfs>.");
4652 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4653 [InitScratchFS, Always, TestOutputStruct (
4654 [["write"; "/truncate"; "some stuff so size is not zero"];
4655 ["truncate"; "/truncate"];
4656 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4657 "truncate a file to zero size",
4659 This command truncates C<path> to a zero-length file. The
4660 file must exist already.");
4662 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4663 [InitScratchFS, Always, TestOutputStruct (
4664 [["touch"; "/truncate_size"];
4665 ["truncate_size"; "/truncate_size"; "1000"];
4666 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4667 "truncate a file to a particular size",
4669 This command truncates C<path> to size C<size> bytes. The file
4672 If the current file size is less than C<size> then
4673 the file is extended to the required size with zero bytes.
4674 This creates a sparse file (ie. disk blocks are not allocated
4675 for the file until you write to it). To create a non-sparse
4676 file of zeroes, use C<guestfs_fallocate64> instead.");
4678 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4679 [InitScratchFS, Always, TestOutputStruct (
4680 [["touch"; "/utimens"];
4681 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4682 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4683 "set timestamp of a file with nanosecond precision",
4685 This command sets the timestamps of a file with nanosecond
4688 C<atsecs, atnsecs> are the last access time (atime) in secs and
4689 nanoseconds from the epoch.
4691 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4692 secs and nanoseconds from the epoch.
4694 If the C<*nsecs> field contains the special value C<-1> then
4695 the corresponding timestamp is set to the current time. (The
4696 C<*secs> field is ignored in this case).
4698 If the C<*nsecs> field contains the special value C<-2> then
4699 the corresponding timestamp is left unchanged. (The
4700 C<*secs> field is ignored in this case).");
4702 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4703 [InitScratchFS, Always, TestOutputStruct (
4704 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4705 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4706 "create a directory with a particular mode",
4708 This command creates a directory, setting the initial permissions
4709 of the directory to C<mode>.
4711 For common Linux filesystems, the actual mode which is set will
4712 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4713 interpret the mode in other ways.
4715 See also C<guestfs_mkdir>, C<guestfs_umask>");
4717 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4719 "change file owner and group",
4721 Change the file owner to C<owner> and group to C<group>.
4722 This is like C<guestfs_chown> but if C<path> is a symlink then
4723 the link itself is changed, not the target.
4725 Only numeric uid and gid are supported. If you want to use
4726 names, you will need to locate and parse the password file
4727 yourself (Augeas support makes this relatively easy).");
4729 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4731 "lstat on multiple files",
4733 This call allows you to perform the C<guestfs_lstat> operation
4734 on multiple files, where all files are in the directory C<path>.
4735 C<names> is the list of files from this directory.
4737 On return you get a list of stat structs, with a one-to-one
4738 correspondence to the C<names> list. If any name did not exist
4739 or could not be lstat'd, then the C<ino> field of that structure
4742 This call is intended for programs that want to efficiently
4743 list a directory contents without making many round-trips.
4744 See also C<guestfs_lxattrlist> for a similarly efficient call
4745 for getting extended attributes. Very long directory listings
4746 might cause the protocol message size to be exceeded, causing
4747 this call to fail. The caller must split up such requests
4748 into smaller groups of names.");
4750 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4752 "lgetxattr on multiple files",
4754 This call allows you to get the extended attributes
4755 of multiple files, where all files are in the directory C<path>.
4756 C<names> is the list of files from this directory.
4758 On return you get a flat list of xattr structs which must be
4759 interpreted sequentially. The first xattr struct always has a zero-length
4760 C<attrname>. C<attrval> in this struct is zero-length
4761 to indicate there was an error doing C<lgetxattr> for this
4762 file, I<or> is a C string which is a decimal number
4763 (the number of following attributes for this file, which could
4764 be C<\"0\">). Then after the first xattr struct are the
4765 zero or more attributes for the first named file.
4766 This repeats for the second and subsequent files.
4768 This call is intended for programs that want to efficiently
4769 list a directory contents without making many round-trips.
4770 See also C<guestfs_lstatlist> for a similarly efficient call
4771 for getting standard stats. Very long directory listings
4772 might cause the protocol message size to be exceeded, causing
4773 this call to fail. The caller must split up such requests
4774 into smaller groups of names.");
4776 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4778 "readlink on multiple files",
4780 This call allows you to do a C<readlink> operation
4781 on multiple files, where all files are in the directory C<path>.
4782 C<names> is the list of files from this directory.
4784 On return you get a list of strings, with a one-to-one
4785 correspondence to the C<names> list. Each string is the
4786 value of the symbolic link.
4788 If the C<readlink(2)> operation fails on any name, then
4789 the corresponding result string is the empty string C<\"\">.
4790 However the whole operation is completed even if there
4791 were C<readlink(2)> errors, and so you can call this
4792 function with names where you don't know if they are
4793 symbolic links already (albeit slightly less efficient).
4795 This call is intended for programs that want to efficiently
4796 list a directory contents without making many round-trips.
4797 Very long directory listings might cause the protocol
4798 message size to be exceeded, causing
4799 this call to fail. The caller must split up such requests
4800 into smaller groups of names.");
4802 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4803 [InitISOFS, Always, TestOutputBuffer (
4804 [["pread"; "/known-4"; "1"; "3"]], "\n");
4805 InitISOFS, Always, TestOutputBuffer (
4806 [["pread"; "/empty"; "0"; "100"]], "")],
4807 "read part of a file",
4809 This command lets you read part of a file. It reads C<count>
4810 bytes of the file, starting at C<offset>, from file C<path>.
4812 This may read fewer bytes than requested. For further details
4813 see the L<pread(2)> system call.
4815 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4817 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4818 [InitEmpty, Always, TestRun (
4819 [["part_init"; "/dev/sda"; "gpt"]])],
4820 "create an empty partition table",
4822 This creates an empty partition table on C<device> of one of the
4823 partition types listed below. Usually C<parttype> should be
4824 either C<msdos> or C<gpt> (for large disks).
4826 Initially there are no partitions. Following this, you should
4827 call C<guestfs_part_add> for each partition required.
4829 Possible values for C<parttype> are:
4833 =item B<efi> | B<gpt>
4835 Intel EFI / GPT partition table.
4837 This is recommended for >= 2 TB partitions that will be accessed
4838 from Linux and Intel-based Mac OS X. It also has limited backwards
4839 compatibility with the C<mbr> format.
4841 =item B<mbr> | B<msdos>
4843 The standard PC \"Master Boot Record\" (MBR) format used
4844 by MS-DOS and Windows. This partition type will B<only> work
4845 for device sizes up to 2 TB. For large disks we recommend
4850 Other partition table types that may work but are not
4859 =item B<amiga> | B<rdb>
4861 Amiga \"Rigid Disk Block\" format.
4869 DASD, used on IBM mainframes.
4877 Old Mac partition format. Modern Macs use C<gpt>.
4881 NEC PC-98 format, common in Japan apparently.
4889 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
4890 [InitEmpty, Always, TestRun (
4891 [["part_init"; "/dev/sda"; "mbr"];
4892 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4893 InitEmpty, Always, TestRun (
4894 [["part_init"; "/dev/sda"; "gpt"];
4895 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4896 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4897 InitEmpty, Always, TestRun (
4898 [["part_init"; "/dev/sda"; "mbr"];
4899 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4900 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4901 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4902 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4903 "add a partition to the device",
4905 This command adds a partition to C<device>. If there is no partition
4906 table on the device, call C<guestfs_part_init> first.
4908 The C<prlogex> parameter is the type of partition. Normally you
4909 should pass C<p> or C<primary> here, but MBR partition tables also
4910 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4913 C<startsect> and C<endsect> are the start and end of the partition
4914 in I<sectors>. C<endsect> may be negative, which means it counts
4915 backwards from the end of the disk (C<-1> is the last sector).
4917 Creating a partition which covers the whole disk is not so easy.
4918 Use C<guestfs_part_disk> to do that.");
4920 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [DangerWillRobinson],
4921 [InitEmpty, Always, TestRun (
4922 [["part_disk"; "/dev/sda"; "mbr"]]);
4923 InitEmpty, Always, TestRun (
4924 [["part_disk"; "/dev/sda"; "gpt"]])],
4925 "partition whole disk with a single primary partition",
4927 This command is simply a combination of C<guestfs_part_init>
4928 followed by C<guestfs_part_add> to create a single primary partition
4929 covering the whole disk.
4931 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4932 but other possible values are described in C<guestfs_part_init>.");
4934 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
4935 [InitEmpty, Always, TestRun (
4936 [["part_disk"; "/dev/sda"; "mbr"];
4937 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4938 "make a partition bootable",
4940 This sets the bootable flag on partition numbered C<partnum> on
4941 device C<device>. Note that partitions are numbered from 1.
4943 The bootable flag is used by some operating systems (notably
4944 Windows) to determine which partition to boot from. It is by
4945 no means universally recognized.");
4947 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
4948 [InitEmpty, Always, TestRun (
4949 [["part_disk"; "/dev/sda"; "gpt"];
4950 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4951 "set partition name",
4953 This sets the partition name on partition numbered C<partnum> on
4954 device C<device>. Note that partitions are numbered from 1.
4956 The partition name can only be set on certain types of partition
4957 table. This works on C<gpt> but not on C<mbr> partitions.");
4959 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
4960 [], (* XXX Add a regression test for this. *)
4961 "list partitions on a device",
4963 This command parses the partition table on C<device> and
4964 returns the list of partitions found.
4966 The fields in the returned structure are:
4972 Partition number, counting from 1.
4976 Start of the partition I<in bytes>. To get sectors you have to
4977 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4981 End of the partition in bytes.
4985 Size of the partition in bytes.
4989 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
4990 [InitEmpty, Always, TestOutput (
4991 [["part_disk"; "/dev/sda"; "gpt"];
4992 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4993 "get the partition table type",
4995 This command examines the partition table on C<device> and
4996 returns the partition table type (format) being used.
4998 Common return values include: C<msdos> (a DOS/Windows style MBR
4999 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5000 values are possible, although unusual. See C<guestfs_part_init>
5003 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5004 [InitScratchFS, Always, TestOutputBuffer (
5005 [["fill"; "0x63"; "10"; "/fill"];
5006 ["read_file"; "/fill"]], "cccccccccc")],
5007 "fill a file with octets",
5009 This command creates a new file called C<path>. The initial
5010 content of the file is C<len> octets of C<c>, where C<c>
5011 must be a number in the range C<[0..255]>.
5013 To fill a file with zero bytes (sparsely), it is
5014 much more efficient to use C<guestfs_truncate_size>.
5015 To create a file with a pattern of repeating bytes
5016 use C<guestfs_fill_pattern>.");
5018 ("available", (RErr, [StringList "groups"], []), 216, [],
5019 [InitNone, Always, TestRun [["available"; ""]]],
5020 "test availability of some parts of the API",
5022 This command is used to check the availability of some
5023 groups of functionality in the appliance, which not all builds of
5024 the libguestfs appliance will be able to provide.
5026 The libguestfs groups, and the functions that those
5027 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5028 You can also fetch this list at runtime by calling
5029 C<guestfs_available_all_groups>.
5031 The argument C<groups> is a list of group names, eg:
5032 C<[\"inotify\", \"augeas\"]> would check for the availability of
5033 the Linux inotify functions and Augeas (configuration file
5036 The command returns no error if I<all> requested groups are available.
5038 It fails with an error if one or more of the requested
5039 groups is unavailable in the appliance.
5041 If an unknown group name is included in the
5042 list of groups then an error is always returned.
5050 You must call C<guestfs_launch> before calling this function.
5052 The reason is because we don't know what groups are
5053 supported by the appliance/daemon until it is running and can
5058 If a group of functions is available, this does not necessarily
5059 mean that they will work. You still have to check for errors
5060 when calling individual API functions even if they are
5065 It is usually the job of distro packagers to build
5066 complete functionality into the libguestfs appliance.
5067 Upstream libguestfs, if built from source with all
5068 requirements satisfied, will support everything.
5072 This call was added in version C<1.0.80>. In previous
5073 versions of libguestfs all you could do would be to speculatively
5074 execute a command to find out if the daemon implemented it.
5075 See also C<guestfs_version>.
5079 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [],
5080 [InitScratchFS, Always, TestOutputBuffer (
5082 ["write"; "/dd/src"; "hello, world"];
5083 ["dd"; "/dd/src"; "/dd/dest"];
5084 ["read_file"; "/dd/dest"]], "hello, world")],
5085 "copy from source to destination using dd",
5087 This command copies from one source device or file C<src>
5088 to another destination device or file C<dest>. Normally you
5089 would use this to copy to or from a device or partition, for
5090 example to duplicate a filesystem.
5092 If the destination is a device, it must be as large or larger
5093 than the source file or device, otherwise the copy will fail.
5094 This command cannot do partial copies (see C<guestfs_copy_size>).");
5096 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5097 [InitScratchFS, Always, TestOutputInt (
5098 [["write"; "/filesize"; "hello, world"];
5099 ["filesize"; "/filesize"]], 12)],
5100 "return the size of the file in bytes",
5102 This command returns the size of C<file> in bytes.
5104 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5105 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5106 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5108 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5109 [InitBasicFSonLVM, Always, TestOutputList (
5110 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5111 ["lvs"]], ["/dev/VG/LV2"])],
5112 "rename an LVM logical volume",
5114 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5116 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5117 [InitBasicFSonLVM, Always, TestOutputList (
5119 ["vg_activate"; "false"; "VG"];
5120 ["vgrename"; "VG"; "VG2"];
5121 ["vg_activate"; "true"; "VG2"];
5122 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5123 ["vgs"]], ["VG2"])],
5124 "rename an LVM volume group",
5126 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5128 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5129 [InitISOFS, Always, TestOutputBuffer (
5130 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5131 "list the contents of a single file in an initrd",
5133 This command unpacks the file C<filename> from the initrd file
5134 called C<initrdpath>. The filename must be given I<without> the
5135 initial C</> character.
5137 For example, in guestfish you could use the following command
5138 to examine the boot script (usually called C</init>)
5139 contained in a Linux initrd or initramfs image:
5141 initrd-cat /boot/initrd-<version>.img init
5143 See also C<guestfs_initrd_list>.");
5145 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5147 "get the UUID of a physical volume",
5149 This command returns the UUID of the LVM PV C<device>.");
5151 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5153 "get the UUID of a volume group",
5155 This command returns the UUID of the LVM VG named C<vgname>.");
5157 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5159 "get the UUID of a logical volume",
5161 This command returns the UUID of the LVM LV C<device>.");
5163 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5165 "get the PV UUIDs containing the volume group",
5167 Given a VG called C<vgname>, this returns the UUIDs of all
5168 the physical volumes that this volume group resides on.
5170 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5171 calls to associate physical volumes and volume groups.
5173 See also C<guestfs_vglvuuids>.");
5175 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5177 "get the LV UUIDs of all LVs in the volume group",
5179 Given a VG called C<vgname>, this returns the UUIDs of all
5180 the logical volumes created in this volume group.
5182 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5183 calls to associate logical volumes and volume groups.
5185 See also C<guestfs_vgpvuuids>.");
5187 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress],
5188 [InitScratchFS, Always, TestOutputBuffer (
5189 [["mkdir"; "/copy_size"];
5190 ["write"; "/copy_size/src"; "hello, world"];
5191 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5192 ["read_file"; "/copy_size/dest"]], "hello")],
5193 "copy size bytes from source to destination using dd",
5195 This command copies exactly C<size> bytes from one source device
5196 or file C<src> to another destination device or file C<dest>.
5198 Note this will fail if the source is too short or if the destination
5199 is not large enough.");
5201 ("zero_device", (RErr, [Device "device"], []), 228, [DangerWillRobinson; Progress],
5202 [InitBasicFSonLVM, Always, TestRun (
5203 [["zero_device"; "/dev/VG/LV"]])],
5204 "write zeroes to an entire device",
5206 This command writes zeroes over the entire C<device>. Compare
5207 with C<guestfs_zero> which just zeroes the first few blocks of
5210 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5211 [InitScratchFS, Always, TestOutput (
5212 [["mkdir"; "/txz_in"];
5213 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5214 ["cat"; "/txz_in/hello"]], "hello\n")],
5215 "unpack compressed tarball to directory",
5217 This command uploads and unpacks local file C<tarball> (an
5218 I<xz compressed> tar file) into C<directory>.");
5220 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5222 "pack directory into compressed tarball",
5224 This command packs the contents of C<directory> and downloads
5225 it to local file C<tarball> (as an xz compressed tar archive).");
5227 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"],
5229 "resize an NTFS filesystem",
5231 This command resizes an NTFS filesystem, expanding or
5232 shrinking it to the size of the underlying device.
5233 See also L<ntfsresize(8)>.");
5235 ("vgscan", (RErr, [], []), 232, [],
5236 [InitEmpty, Always, TestRun (
5238 "rescan for LVM physical volumes, volume groups and logical volumes",
5240 This rescans all block devices and rebuilds the list of LVM
5241 physical volumes, volume groups and logical volumes.");
5243 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5244 [InitEmpty, Always, TestRun (
5245 [["part_init"; "/dev/sda"; "mbr"];
5246 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5247 ["part_del"; "/dev/sda"; "1"]])],
5248 "delete a partition",
5250 This command deletes the partition numbered C<partnum> on C<device>.
5252 Note that in the case of MBR partitioning, deleting an
5253 extended partition also deletes any logical partitions
5256 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5257 [InitEmpty, Always, TestOutputTrue (
5258 [["part_init"; "/dev/sda"; "mbr"];
5259 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5260 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5261 ["part_get_bootable"; "/dev/sda"; "1"]])],
5262 "return true if a partition is bootable",
5264 This command returns true if the partition C<partnum> on
5265 C<device> has the bootable flag set.
5267 See also C<guestfs_part_set_bootable>.");
5269 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5270 [InitEmpty, Always, TestOutputInt (
5271 [["part_init"; "/dev/sda"; "mbr"];
5272 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5273 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5274 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5275 "get the MBR type byte (ID byte) from a partition",
5277 Returns the MBR type byte (also known as the ID byte) from
5278 the numbered partition C<partnum>.
5280 Note that only MBR (old DOS-style) partitions have type bytes.
5281 You will get undefined results for other partition table
5282 types (see C<guestfs_part_get_parttype>).");
5284 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5285 [], (* tested by part_get_mbr_id *)
5286 "set the MBR type byte (ID byte) of a partition",
5288 Sets the MBR type byte (also known as the ID byte) of
5289 the numbered partition C<partnum> to C<idbyte>. Note
5290 that the type bytes quoted in most documentation are
5291 in fact hexadecimal numbers, but usually documented
5292 without any leading \"0x\" which might be confusing.
5294 Note that only MBR (old DOS-style) partitions have type bytes.
5295 You will get undefined results for other partition table
5296 types (see C<guestfs_part_get_parttype>).");
5298 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5299 [InitISOFS, Always, TestOutputFileMD5 (
5300 [["checksum_device"; "md5"; "/dev/sdd"]],
5301 "../images/test.iso")],
5302 "compute MD5, SHAx or CRC checksum of the contents of a device",
5304 This call computes the MD5, SHAx or CRC checksum of the
5305 contents of the device named C<device>. For the types of
5306 checksums supported see the C<guestfs_checksum> command.");
5308 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5309 [InitNone, Always, TestRun (
5310 [["part_disk"; "/dev/sda"; "mbr"];
5311 ["pvcreate"; "/dev/sda1"];
5312 ["vgcreate"; "VG"; "/dev/sda1"];
5313 ["lvcreate"; "LV"; "VG"; "10"];
5314 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5315 "expand an LV to fill free space",
5317 This expands an existing logical volume C<lv> so that it fills
5318 C<pc>% of the remaining free space in the volume group. Commonly
5319 you would call this with pc = 100 which expands the logical volume
5320 as much as possible, using all remaining free space in the volume
5323 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5324 [], (* XXX Augeas code needs tests. *)
5325 "clear Augeas path",
5327 Set the value associated with C<path> to C<NULL>. This
5328 is the same as the L<augtool(1)> C<clear> command.");
5330 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5331 [InitEmpty, Always, TestOutputInt (
5332 [["get_umask"]], 0o22)],
5333 "get the current umask",
5335 Return the current umask. By default the umask is C<022>
5336 unless it has been set by calling C<guestfs_umask>.");
5338 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5340 "upload a file to the appliance (internal use only)",
5342 The C<guestfs_debug_upload> command uploads a file to
5343 the libguestfs appliance.
5345 There is no comprehensive help for this command. You have
5346 to look at the file C<daemon/debug.c> in the libguestfs source
5347 to find out what it is for.");
5349 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5350 [InitScratchFS, Always, TestOutput (
5351 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5352 ["cat"; "/base64_in"]], "hello\n")],
5353 "upload base64-encoded data to file",
5355 This command uploads base64-encoded data from C<base64file>
5358 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5360 "download file and encode as base64",
5362 This command downloads the contents of C<filename>, writing
5363 it out to local file C<base64file> encoded as base64.");
5365 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5367 "compute MD5, SHAx or CRC checksum of files in a directory",
5369 This command computes the checksums of all regular files in
5370 C<directory> and then emits a list of those checksums to
5371 the local output file C<sumsfile>.
5373 This can be used for verifying the integrity of a virtual
5374 machine. However to be properly secure you should pay
5375 attention to the output of the checksum command (it uses
5376 the ones from GNU coreutils). In particular when the
5377 filename is not printable, coreutils uses a special
5378 backslash syntax. For more information, see the GNU
5379 coreutils info file.");
5381 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5382 [InitScratchFS, Always, TestOutputBuffer (
5383 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5384 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5385 "fill a file with a repeating pattern of bytes",
5387 This function is like C<guestfs_fill> except that it creates
5388 a new file of length C<len> containing the repeating pattern
5389 of bytes in C<pattern>. The pattern is truncated if necessary
5390 to ensure the length of the file is exactly C<len> bytes.");
5392 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5393 [InitScratchFS, Always, TestOutput (
5394 [["write"; "/write"; "new file contents"];
5395 ["cat"; "/write"]], "new file contents");
5396 InitScratchFS, Always, TestOutput (
5397 [["write"; "/write2"; "\nnew file contents\n"];
5398 ["cat"; "/write2"]], "\nnew file contents\n");
5399 InitScratchFS, Always, TestOutput (
5400 [["write"; "/write3"; "\n\n"];
5401 ["cat"; "/write3"]], "\n\n");
5402 InitScratchFS, Always, TestOutput (
5403 [["write"; "/write4"; ""];
5404 ["cat"; "/write4"]], "");
5405 InitScratchFS, Always, TestOutput (
5406 [["write"; "/write5"; "\n\n\n"];
5407 ["cat"; "/write5"]], "\n\n\n");
5408 InitScratchFS, Always, TestOutput (
5409 [["write"; "/write6"; "\n"];
5410 ["cat"; "/write6"]], "\n")],
5411 "create a new file",
5413 This call creates a file called C<path>. The content of the
5414 file is the string C<content> (which can contain any 8 bit data).");
5416 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5417 [InitScratchFS, Always, TestOutput (
5418 [["write"; "/pwrite"; "new file contents"];
5419 ["pwrite"; "/pwrite"; "data"; "4"];
5420 ["cat"; "/pwrite"]], "new data contents");
5421 InitScratchFS, Always, TestOutput (
5422 [["write"; "/pwrite2"; "new file contents"];
5423 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5424 ["cat"; "/pwrite2"]], "new file is extended");
5425 InitScratchFS, Always, TestOutput (
5426 [["write"; "/pwrite3"; "new file contents"];
5427 ["pwrite"; "/pwrite3"; ""; "4"];
5428 ["cat"; "/pwrite3"]], "new file contents")],
5429 "write to part of a file",
5431 This command writes to part of a file. It writes the data
5432 buffer C<content> to the file C<path> starting at offset C<offset>.
5434 This command implements the L<pwrite(2)> system call, and like
5435 that system call it may not write the full data requested. The
5436 return value is the number of bytes that were actually written
5437 to the file. This could even be 0, although short writes are
5438 unlikely for regular files in ordinary circumstances.
5440 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5442 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5444 "resize an ext2, ext3 or ext4 filesystem (with size)",
5446 This command is the same as C<guestfs_resize2fs> except that it
5447 allows you to specify the new size (in bytes) explicitly.");
5449 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5451 "resize an LVM physical volume (with size)",
5453 This command is the same as C<guestfs_pvresize> except that it
5454 allows you to specify the new size (in bytes) explicitly.");
5456 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"],
5458 "resize an NTFS filesystem (with size)",
5460 This command is the same as C<guestfs_ntfsresize> except that it
5461 allows you to specify the new size (in bytes) explicitly.");
5463 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5464 [InitNone, Always, TestRun [["available_all_groups"]]],
5465 "return a list of all optional groups",
5467 This command returns a list of all optional groups that this
5468 daemon knows about. Note this returns both supported and unsupported
5469 groups. To find out which ones the daemon can actually support
5470 you have to call C<guestfs_available> on each member of the
5473 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5475 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5476 [InitScratchFS, Always, TestOutputStruct (
5477 [["fallocate64"; "/fallocate64"; "1000000"];
5478 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5479 "preallocate a file in the guest filesystem",
5481 This command preallocates a file (containing zero bytes) named
5482 C<path> of size C<len> bytes. If the file exists already, it
5485 Note that this call allocates disk blocks for the file.
5486 To create a sparse file use C<guestfs_truncate_size> instead.
5488 The deprecated call C<guestfs_fallocate> does the same,
5489 but owing to an oversight it only allowed 30 bit lengths
5490 to be specified, effectively limiting the maximum size
5491 of files created through that call to 1GB.
5493 Do not confuse this with the guestfish-specific
5494 C<alloc> and C<sparse> commands which create
5495 a file in the host and attach it as a device.");
5497 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5498 [InitBasicFS, Always, TestOutput (
5499 [["set_e2label"; "/dev/sda1"; "LTEST"];
5500 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5501 "get the filesystem label",
5503 This returns the filesystem label of the filesystem on
5506 If the filesystem is unlabeled, this returns the empty string.
5508 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5510 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5511 (let uuid = uuidgen () in
5512 [InitBasicFS, Always, TestOutput (
5513 [["set_e2uuid"; "/dev/sda1"; uuid];
5514 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5515 "get the filesystem UUID",
5517 This returns the filesystem UUID of the filesystem on
5520 If the filesystem does not have a UUID, this returns the empty string.
5522 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5524 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5525 (* Can't be tested with the current framework because
5526 * the VG is being used by the mounted filesystem, so
5527 * the vgchange -an command we do first will fail.
5530 "set LVM device filter",
5532 This sets the LVM device filter so that LVM will only be
5533 able to \"see\" the block devices in the list C<devices>,
5534 and will ignore all other attached block devices.
5536 Where disk image(s) contain duplicate PVs or VGs, this
5537 command is useful to get LVM to ignore the duplicates, otherwise
5538 LVM can get confused. Note also there are two types
5539 of duplication possible: either cloned PVs/VGs which have
5540 identical UUIDs; or VGs that are not cloned but just happen
5541 to have the same name. In normal operation you cannot
5542 create this situation, but you can do it outside LVM, eg.
5543 by cloning disk images or by bit twiddling inside the LVM
5546 This command also clears the LVM cache and performs a volume
5549 You can filter whole block devices or individual partitions.
5551 You cannot use this if any VG is currently in use (eg.
5552 contains a mounted filesystem), even if you are not
5553 filtering out that VG.");
5555 ("lvm_clear_filter", (RErr, [], []), 256, [],
5556 [], (* see note on lvm_set_filter *)
5557 "clear LVM device filter",
5559 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5560 will be able to see every block device.
5562 This command also clears the LVM cache and performs a volume
5565 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5567 "open a LUKS-encrypted block device",
5569 This command opens a block device which has been encrypted
5570 according to the Linux Unified Key Setup (LUKS) standard.
5572 C<device> is the encrypted block device or partition.
5574 The caller must supply one of the keys associated with the
5575 LUKS block device, in the C<key> parameter.
5577 This creates a new block device called C</dev/mapper/mapname>.
5578 Reads and writes to this block device are decrypted from and
5579 encrypted to the underlying C<device> respectively.
5581 If this block device contains LVM volume groups, then
5582 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5583 will make them visible.");
5585 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5587 "open a LUKS-encrypted block device read-only",
5589 This is the same as C<guestfs_luks_open> except that a read-only
5590 mapping is created.");
5592 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5594 "close a LUKS device",
5596 This closes a LUKS device that was created earlier by
5597 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5598 C<device> parameter must be the name of the LUKS mapping
5599 device (ie. C</dev/mapper/mapname>) and I<not> the name
5600 of the underlying block device.");
5602 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"; DangerWillRobinson],
5604 "format a block device as a LUKS encrypted device",
5606 This command erases existing data on C<device> and formats
5607 the device as a LUKS encrypted device. C<key> is the
5608 initial key, which is added to key slot C<slot>. (LUKS
5609 supports 8 key slots, numbered 0-7).");
5611 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"; DangerWillRobinson],
5613 "format a block device as a LUKS encrypted device",
5615 This command is the same as C<guestfs_luks_format> but
5616 it also allows you to set the C<cipher> used.");
5618 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5620 "add a key on a LUKS encrypted device",
5622 This command adds a new key on LUKS device C<device>.
5623 C<key> is any existing key, and is used to access the device.
5624 C<newkey> is the new key to add. C<keyslot> is the key slot
5625 that will be replaced.
5627 Note that if C<keyslot> already contains a key, then this
5628 command will fail. You have to use C<guestfs_luks_kill_slot>
5629 first to remove that key.");
5631 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5633 "remove a key from a LUKS encrypted device",
5635 This command deletes the key in key slot C<keyslot> from the
5636 encrypted LUKS device C<device>. C<key> must be one of the
5639 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5640 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5641 [["is_lv"; "/dev/VG/LV"]]);
5642 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5643 [["is_lv"; "/dev/sda1"]])],
5644 "test if device is a logical volume",
5646 This command tests whether C<device> is a logical volume, and
5647 returns true iff this is the case.");
5649 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5651 "find a filesystem by UUID",
5653 This command searches the filesystems and returns the one
5654 which has the given UUID. An error is returned if no such
5655 filesystem can be found.
5657 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5659 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5661 "find a filesystem by label",
5663 This command searches the filesystems and returns the one
5664 which has the given label. An error is returned if no such
5665 filesystem can be found.
5667 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5669 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5670 [InitISOFS, Always, TestOutputFalse (
5671 [["is_chardev"; "/directory"]]);
5672 InitScratchFS, Always, TestOutputTrue (
5673 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5674 ["is_chardev"; "/is_chardev"]])],
5675 "test if character device",
5677 This returns C<true> if and only if there is a character device
5678 with the given C<path> name.
5680 See also C<guestfs_stat>.");
5682 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5683 [InitISOFS, Always, TestOutputFalse (
5684 [["is_blockdev"; "/directory"]]);
5685 InitScratchFS, Always, TestOutputTrue (
5686 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5687 ["is_blockdev"; "/is_blockdev"]])],
5688 "test if block device",
5690 This returns C<true> if and only if there is a block device
5691 with the given C<path> name.
5693 See also C<guestfs_stat>.");
5695 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5696 [InitISOFS, Always, TestOutputFalse (
5697 [["is_fifo"; "/directory"]]);
5698 InitScratchFS, Always, TestOutputTrue (
5699 [["mkfifo"; "0o777"; "/is_fifo"];
5700 ["is_fifo"; "/is_fifo"]])],
5701 "test if FIFO (named pipe)",
5703 This returns C<true> if and only if there is a FIFO (named pipe)
5704 with the given C<path> name.
5706 See also C<guestfs_stat>.");
5708 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5709 [InitISOFS, Always, TestOutputFalse (
5710 [["is_symlink"; "/directory"]]);
5711 InitISOFS, Always, TestOutputTrue (
5712 [["is_symlink"; "/abssymlink"]])],
5713 "test if symbolic link",
5715 This returns C<true> if and only if there is a symbolic link
5716 with the given C<path> name.
5718 See also C<guestfs_stat>.");
5720 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5721 (* XXX Need a positive test for sockets. *)
5722 [InitISOFS, Always, TestOutputFalse (
5723 [["is_socket"; "/directory"]])],
5726 This returns C<true> if and only if there is a Unix domain socket
5727 with the given C<path> name.
5729 See also C<guestfs_stat>.");
5731 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5732 [InitPartition, Always, TestOutputDevice (
5733 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5734 InitEmpty, Always, TestLastFail (
5735 [["part_to_dev"; "/dev/sda"]])],
5736 "convert partition name to device name",
5738 This function takes a partition name (eg. \"/dev/sdb1\") and
5739 removes the partition number, returning the device name
5742 The named partition must exist, for example as a string returned
5743 from C<guestfs_list_partitions>.");
5745 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5746 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5747 [InitScratchFS, Always, TestOutput (
5748 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5749 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5750 "upload a file from the local machine with offset",
5752 Upload local file C<filename> to C<remotefilename> on the
5755 C<remotefilename> is overwritten starting at the byte C<offset>
5756 specified. The intention is to overwrite parts of existing
5757 files or devices, although if a non-existant file is specified
5758 then it is created with a \"hole\" before C<offset>. The
5759 size of the data written is implicit in the size of the
5762 Note that there is no limit on the amount of data that
5763 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5764 and this call always writes the full amount unless an
5767 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5769 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5770 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5771 let offset = string_of_int 100 in
5772 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5773 [InitScratchFS, Always, TestOutput (
5774 (* Pick a file from cwd which isn't likely to change. *)
5775 [["mkdir"; "/download_offset"];
5776 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5777 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5778 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5779 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5780 "download a file to the local machine with offset and size",
5782 Download file C<remotefilename> and save it as C<filename>
5783 on the local machine.
5785 C<remotefilename> is read for C<size> bytes starting at C<offset>
5786 (this region must be within the file or device).
5788 Note that there is no limit on the amount of data that
5789 can be downloaded with this call, unlike with C<guestfs_pread>,
5790 and this call always reads the full amount unless an
5793 See also C<guestfs_download>, C<guestfs_pread>.");
5795 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5796 [InitPartition, Always, TestOutputListOfDevices (
5797 [["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"];
5798 ["blockdev_rereadpt"; "/dev/sda"];
5799 ["list_partitions"]], ["/dev/sdb1"])],
5800 "write to part of a device",
5802 This command writes to part of a device. It writes the data
5803 buffer C<content> to C<device> starting at offset C<offset>.
5805 This command implements the L<pwrite(2)> system call, and like
5806 that system call it may not write the full data requested
5807 (although short writes to disk devices and partitions are
5808 probably impossible with standard Linux kernels).
5810 See also C<guestfs_pwrite>.");
5812 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5813 [InitEmpty, Always, TestOutputBuffer (
5814 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5815 "read part of a device",
5817 This command lets you read part of a file. It reads C<count>
5818 bytes of C<device>, starting at C<offset>.
5820 This may read fewer bytes than requested. For further details
5821 see the L<pread(2)> system call.
5823 See also C<guestfs_pread>.");
5825 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5826 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5827 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5828 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5829 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5830 "get canonical name of an LV",
5832 This converts alternative naming schemes for LVs that you
5833 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5834 is converted to C</dev/VG/LV>.
5836 This command returns an error if the C<lvname> parameter does
5837 not refer to a logical volume.
5839 See also C<guestfs_is_lv>.");
5841 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"]), 278, [],
5842 [InitEmpty, Always, TestOutput (
5843 [["part_disk"; "/dev/sda"; "mbr"];
5844 ["mkfs_opts"; "ext2"; "/dev/sda1"; "4096"; ""];
5845 ["mount_options"; ""; "/dev/sda1"; "/"];
5846 ["write"; "/new"; "new file contents"];
5847 ["cat"; "/new"]], "new file contents")],
5848 "make a filesystem",
5850 This function creates a filesystem on C<device>. The filesystem
5851 type is C<fstype>, for example C<ext3>.
5853 The optional arguments are:
5859 The filesystem block size. Supported block sizes depend on the
5860 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
5861 for Linux ext2/3 filesystems.
5863 For VFAT and NTFS the C<blocksize> parameter is treated as
5864 the requested cluster size.
5866 For UFS block sizes, please see L<mkfs.ufs(8)>.
5870 This passes the I<-O> parameter to the external mkfs program.
5872 For certain filesystem types, this allows extra filesystem
5873 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
5876 You cannot use this optional parameter with the C<gfs> or
5877 C<gfs2> filesystem type.
5881 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
5883 "get a single extended attribute",
5885 Get a single extended attribute from file C<path> named C<name>.
5886 This call follows symlinks. If you want to lookup an extended
5887 attribute for the symlink itself, use C<guestfs_lgetxattr>.
5889 Normally it is better to get all extended attributes from a file
5890 in one go by calling C<guestfs_getxattrs>. However some Linux
5891 filesystem implementations are buggy and do not provide a way to
5892 list out attributes. For these filesystems (notably ntfs-3g)
5893 you have to know the names of the extended attributes you want
5894 in advance and call this function.
5896 Extended attribute values are blobs of binary data. If there
5897 is no extended attribute named C<name>, this returns an error.
5899 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
5901 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
5903 "get a single extended attribute",
5905 Get a single extended attribute from file C<path> named C<name>.
5906 If C<path> is a symlink, then this call returns an extended
5907 attribute from the symlink.
5909 Normally it is better to get all extended attributes from a file
5910 in one go by calling C<guestfs_getxattrs>. However some Linux
5911 filesystem implementations are buggy and do not provide a way to
5912 list out attributes. For these filesystems (notably ntfs-3g)
5913 you have to know the names of the extended attributes you want
5914 in advance and call this function.
5916 Extended attribute values are blobs of binary data. If there
5917 is no extended attribute named C<name>, this returns an error.
5919 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
5921 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
5923 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
5925 This command is the same as C<guestfs_resize2fs>, but the filesystem
5926 is resized to its minimum size. This works like the I<-M> option
5927 to the C<resize2fs> command.
5929 To get the resulting size of the filesystem you should call
5930 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
5931 values. These two numbers, multiplied together, give the
5932 resulting size of the minimal filesystem in bytes.");
5934 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
5936 "internal autosync operation",
5938 This command performs the autosync operation just before the
5939 handle is closed. You should not call this command directly.
5940 Instead, use the autosync flag (C<guestfs_set_autosync>) to
5941 control whether or not this operation is performed when the
5942 handle is closed.");
5944 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
5945 [InitISOFS, Always, TestOutputTrue (
5946 [["is_zero"; "/100kallzeroes"]]);
5947 InitISOFS, Always, TestOutputFalse (
5948 [["is_zero"; "/100kallspaces"]])],
5949 "test if a file contains all zero bytes",
5951 This returns true iff the file exists and the file is empty or
5952 it contains all zero bytes.");
5954 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
5955 [InitBasicFS, Always, TestOutputTrue (
5956 [["umount"; "/dev/sda1"];
5957 ["zero_device"; "/dev/sda1"];
5958 ["is_zero_device"; "/dev/sda1"]]);
5959 InitBasicFS, Always, TestOutputFalse (
5960 [["is_zero_device"; "/dev/sda1"]])],
5961 "test if a device contains all zero bytes",
5963 This returns true iff the device exists and contains all zero bytes.
5965 Note that for large devices this can take a long time to run.");
5967 ("list_9p", (RStringList "mounttags", [], []), 285, [],
5969 "list 9p filesystems",
5971 List all 9p filesystems attached to the guest. A list of
5972 mount tags is returned.");
5974 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
5976 "mount 9p filesystem",
5978 Mount the virtio-9p filesystem with the tag C<mounttag> on the
5979 directory C<mountpoint>.
5981 If required, C<trans=virtio> will be automatically added to the options.
5982 Any other options required can be passed in the optional C<options>
5987 let all_functions = non_daemon_functions @ daemon_functions
5989 (* In some places we want the functions to be displayed sorted
5990 * alphabetically, so this is useful:
5992 let all_functions_sorted = List.sort action_compare all_functions
5994 (* This is used to generate the src/MAX_PROC_NR file which
5995 * contains the maximum procedure number, a surrogate for the
5996 * ABI version number. See src/Makefile.am for the details.
5999 let proc_nrs = List.map (
6000 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6001 ) daemon_functions in
6002 List.fold_left max 0 proc_nrs
6004 (* Non-API meta-commands available only in guestfish.
6006 * Note (1): style, proc_nr and tests fields are all meaningless.
6007 * The only fields which are actually used are the shortname,
6008 * FishAlias flags, shortdesc and longdesc.
6010 * Note (2): to refer to other commands, use L</shortname>.
6012 * Note (3): keep this list sorted by shortname.
6014 let fish_commands = [
6015 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6016 "allocate and add a disk file",
6017 " alloc filename size
6019 This creates an empty (zeroed) file of the given size, and then adds
6020 so it can be further examined.
6022 For more advanced image creation, see L<qemu-img(1)> utility.
6024 Size can be specified using standard suffixes, eg. C<1M>.
6026 To create a sparse file, use L</sparse> instead. To create a
6027 prepared disk image, see L</PREPARED DISK IMAGES>.");
6029 ("copy_in", (RErr,[], []), -1, [], [],
6030 "copy local files or directories into an image",
6031 " copy-in local [local ...] /remotedir
6033 C<copy-in> copies local files or directories recursively into the disk
6034 image, placing them in the directory called C</remotedir> (which must
6035 exist). This guestfish meta-command turns into a sequence of
6036 L</tar-in> and other commands as necessary.
6038 Multiple local files and directories can be specified, but the last
6039 parameter must always be a remote directory. Wildcards cannot be
6042 ("copy_out", (RErr,[], []), -1, [], [],
6043 "copy remote files or directories out of an image",
6044 " copy-out remote [remote ...] localdir
6046 C<copy-out> copies remote files or directories recursively out of the
6047 disk image, placing them on the host disk in a local directory called
6048 C<localdir> (which must exist). This guestfish meta-command turns
6049 into a sequence of L</download>, L</tar-out> and other commands as
6052 Multiple remote files and directories can be specified, but the last
6053 parameter must always be a local directory. To download to the
6054 current directory, use C<.> as in:
6058 Wildcards cannot be used in the ordinary command, but you can use
6059 them with the help of L</glob> like this:
6061 glob copy-out /home/* .");
6063 ("echo", (RErr,[], []), -1, [], [],
6064 "display a line of text",
6067 This echos the parameters to the terminal.");
6069 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6073 This is used to edit a file. It downloads the file, edits it
6074 locally using your editor, then uploads the result.
6076 The editor is C<$EDITOR>. However if you use the alternate
6077 commands C<vi> or C<emacs> you will get those corresponding
6080 ("glob", (RErr,[], []), -1, [], [],
6081 "expand wildcards in command",
6082 " glob command args...
6084 Expand wildcards in any paths in the args list, and run C<command>
6085 repeatedly on each matching path.
6087 See L</WILDCARDS AND GLOBBING>.");
6089 ("hexedit", (RErr,[], []), -1, [], [],
6090 "edit with a hex editor",
6091 " hexedit <filename|device>
6092 hexedit <filename|device> <max>
6093 hexedit <filename|device> <start> <max>
6095 Use hexedit (a hex editor) to edit all or part of a binary file
6098 This command works by downloading potentially the whole file or
6099 device, editing it locally, then uploading it. If the file or
6100 device is large, you have to specify which part you wish to edit
6101 by using C<max> and/or C<start> C<max> parameters.
6102 C<start> and C<max> are specified in bytes, with the usual
6103 modifiers allowed such as C<1M> (1 megabyte).
6105 For example to edit the first few sectors of a disk you
6110 which would allow you to edit anywhere within the first megabyte
6113 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6115 hexedit /dev/sda1 0x400 0x400
6117 (assuming the superblock is in the standard location).
6119 This command requires the external L<hexedit(1)> program. You
6120 can specify another program to use by setting the C<HEXEDITOR>
6121 environment variable.
6123 See also L</hexdump>.");
6125 ("lcd", (RErr,[], []), -1, [], [],
6126 "change working directory",
6129 Change the local directory, ie. the current directory of guestfish
6132 Note that C<!cd> won't do what you might expect.");
6134 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6138 Opens the manual page for guestfish.");
6140 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6146 This is used to view a file.
6148 The default viewer is C<$PAGER>. However if you use the alternate
6149 command C<less> you will get the C<less> command specifically.");
6151 ("reopen", (RErr,[], []), -1, [], [],
6152 "close and reopen libguestfs handle",
6155 Close and reopen the libguestfs handle. It is not necessary to use
6156 this normally, because the handle is closed properly when guestfish
6157 exits. However this is occasionally useful for testing.");
6159 ("sparse", (RErr,[], []), -1, [], [],
6160 "create a sparse disk image and add",
6161 " sparse filename size
6163 This creates an empty sparse file of the given size, and then adds
6164 so it can be further examined.
6166 In all respects it works the same as the L</alloc> command, except that
6167 the image file is allocated sparsely, which means that disk blocks are
6168 not assigned to the file until they are needed. Sparse disk files
6169 only use space when written to, but they are slower and there is a
6170 danger you could run out of real disk space during a write operation.
6172 For more advanced image creation, see L<qemu-img(1)> utility.
6174 Size can be specified using standard suffixes, eg. C<1M>.");
6176 ("supported", (RErr,[], []), -1, [], [],
6177 "list supported groups of commands",
6180 This command returns a list of the optional groups
6181 known to the daemon, and indicates which ones are
6182 supported by this build of the libguestfs appliance.
6184 See also L<guestfs(3)/AVAILABILITY>.");
6186 ("time", (RErr,[], []), -1, [], [],
6187 "print elapsed time taken to run a command",
6188 " time command args...
6190 Run the command as usual, but print the elapsed time afterwards. This
6191 can be useful for benchmarking operations.");