2 * Copyright (C) 2009-2011 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
21 (* Note about long descriptions: When referring to another
22 * action, use the format C<guestfs_other> (ie. the full name of
23 * the C function). This will be replaced as appropriate in other
26 * Apart from that, long descriptions are just perldoc paragraphs.
32 (* These test functions are used in the language binding tests. *)
47 (* except for RErr, which is tested thoroughly elsewhere *)
48 "test0rint", RInt "valout";
49 "test0rint64", RInt64 "valout";
50 "test0rbool", RBool "valout";
51 "test0rconststring", RConstString "valout";
52 "test0rconstoptstring", RConstOptString "valout";
53 "test0rstring", RString "valout";
54 "test0rstringlist", RStringList "valout";
55 "test0rstruct", RStruct ("valout", "lvm_pv");
56 "test0rstructlist", RStructList ("valout", "lvm_pv");
57 "test0rhashtable", RHashtable "valout";
60 let test_functions = [
61 ("test0", (RErr, test_all_args, []), -1, [NotInFish; NotInDocs],
63 "internal test function - do not use",
65 This is an internal test function which is used to test whether
66 the automatically generated bindings can handle every possible
67 parameter type correctly.
69 It echos the contents of each parameter to stdout.
71 You probably don't want to call this function.");
75 [(name, (ret, [String "val"], []), -1, [NotInFish; NotInDocs],
77 "internal test function - do not use",
79 This is an internal test function which is used to test whether
80 the automatically generated bindings can handle every possible
81 return type correctly.
83 It converts string C<val> to the return type.
85 You probably don't want to call this function.");
86 (name ^ "err", (ret, [], []), -1, [NotInFish; NotInDocs],
88 "internal test function - do not use",
90 This is an internal test function which is used to test whether
91 the automatically generated bindings can handle every possible
92 return type correctly.
94 This function always returns an error.
96 You probably don't want to call this function.")]
100 (* non_daemon_functions are any functions which don't get processed
101 * in the daemon, eg. functions for setting and getting local
102 * configuration values.
105 let non_daemon_functions = test_functions @ [
106 ("launch", (RErr, [], []), -1, [FishAlias "run"; Progress],
108 "launch the qemu subprocess",
110 Internally libguestfs is implemented by running a virtual machine
113 You should call this after configuring the handle
114 (eg. adding drives) but before performing any actions.");
116 ("wait_ready", (RErr, [], []), -1, [NotInFish; DeprecatedBy "launch"],
118 "wait until the qemu subprocess launches (no op)",
120 This function is a no op.
122 In versions of the API E<lt> 1.0.71 you had to call this function
123 just after calling C<guestfs_launch> to wait for the launch
124 to complete. However this is no longer necessary because
125 C<guestfs_launch> now does the waiting.
127 If you see any calls to this function in code then you can just
128 remove them, unless you want to retain compatibility with older
129 versions of the API.");
131 ("kill_subprocess", (RErr, [], []), -1, [],
133 "kill the qemu subprocess",
135 This kills the qemu subprocess. You should never need to call this.");
137 ("add_drive", (RErr, [String "filename"], []), -1, [],
139 "add an image to examine or modify",
141 This function is the equivalent of calling C<guestfs_add_drive_opts>
142 with no optional parameters, so the disk is added writable, with
143 the format being detected automatically.
145 Automatic detection of the format opens you up to a potential
146 security hole when dealing with untrusted raw-format images.
147 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
148 this security hole. Therefore you should think about replacing
149 calls to this function with calls to C<guestfs_add_drive_opts>,
150 and specifying the format.");
152 ("add_cdrom", (RErr, [String "filename"], []), -1, [DeprecatedBy "add_drive_opts"],
154 "add a CD-ROM disk image to examine",
156 This function adds a virtual CD-ROM disk image to the guest.
158 This is equivalent to the qemu parameter I<-cdrom filename>.
166 This call checks for the existence of C<filename>. This
167 stops you from specifying other types of drive which are supported
168 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
169 the general C<guestfs_config> call instead.
173 If you just want to add an ISO file (often you use this as an
174 efficient way to transfer large files into the guest), then you
175 should probably use C<guestfs_add_drive_ro> instead.
179 ("add_drive_ro", (RErr, [String "filename"], []), -1, [FishAlias "add-ro"],
181 "add a drive in snapshot mode (read-only)",
183 This function is the equivalent of calling C<guestfs_add_drive_opts>
184 with the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1,
185 so the disk is added read-only, with the format being detected
188 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"], []), -1, [],
190 "add qemu parameters",
192 This can be used to add arbitrary qemu command line parameters
193 of the form I<-param value>. Actually it's not quite arbitrary - we
194 prevent you from setting some parameters which would interfere with
195 parameters that we use.
197 The first character of C<param> string must be a C<-> (dash).
199 C<value> can be NULL.");
201 ("set_qemu", (RErr, [OptString "qemu"], []), -1, [FishAlias "qemu"],
203 "set the qemu binary",
205 Set the qemu binary that we will use.
207 The default is chosen when the library was compiled by the
210 You can also override this by setting the C<LIBGUESTFS_QEMU>
211 environment variable.
213 Setting C<qemu> to C<NULL> restores the default qemu binary.
215 Note that you should call this function as early as possible
216 after creating the handle. This is because some pre-launch
217 operations depend on testing qemu features (by running C<qemu -help>).
218 If the qemu binary changes, we don't retest features, and
219 so you might see inconsistent results. Using the environment
220 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
221 the qemu binary at the same time as the handle is created.");
223 ("get_qemu", (RConstString "qemu", [], []), -1, [],
224 [InitNone, Always, TestRun (
226 "get the qemu binary",
228 Return the current qemu binary.
230 This is always non-NULL. If it wasn't set already, then this will
231 return the default qemu binary name.");
233 ("set_path", (RErr, [OptString "searchpath"], []), -1, [FishAlias "path"],
235 "set the search path",
237 Set the path that libguestfs searches for kernel and initrd.img.
239 The default is C<$libdir/guestfs> unless overridden by setting
240 C<LIBGUESTFS_PATH> environment variable.
242 Setting C<path> to C<NULL> restores the default path.");
244 ("get_path", (RConstString "path", [], []), -1, [],
245 [InitNone, Always, TestRun (
247 "get the search path",
249 Return the current search path.
251 This is always non-NULL. If it wasn't set already, then this will
252 return the default path.");
254 ("set_append", (RErr, [OptString "append"], []), -1, [FishAlias "append"],
256 "add options to kernel command line",
258 This function is used to add additional options to the
259 guest kernel command line.
261 The default is C<NULL> unless overridden by setting
262 C<LIBGUESTFS_APPEND> environment variable.
264 Setting C<append> to C<NULL> means I<no> additional options
265 are passed (libguestfs always adds a few of its own).");
267 ("get_append", (RConstOptString "append", [], []), -1, [],
268 (* This cannot be tested with the current framework. The
269 * function can return NULL in normal operations, which the
270 * test framework interprets as an error.
273 "get the additional kernel options",
275 Return the additional kernel options which are added to the
276 guest kernel command line.
278 If C<NULL> then no options are added.");
280 ("set_autosync", (RErr, [Bool "autosync"], []), -1, [FishAlias "autosync"],
284 If C<autosync> is true, this enables autosync. Libguestfs will make a
285 best effort attempt to make filesystems consistent and synchronized
286 when the handle is closed
287 (also if the program exits without closing handles).
289 This is enabled by default (since libguestfs 1.5.24, previously it was
290 disabled by default).");
292 ("get_autosync", (RBool "autosync", [], []), -1, [],
293 [InitNone, Always, TestOutputTrue (
294 [["get_autosync"]])],
297 Get the autosync flag.");
299 ("set_verbose", (RErr, [Bool "verbose"], []), -1, [FishAlias "verbose"],
303 If C<verbose> is true, this turns on verbose messages.
305 Verbose messages are disabled unless the environment variable
306 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
308 Verbose messages are normally sent to C<stderr>, unless you
309 register a callback to send them somewhere else (see
310 C<guestfs_set_event_callback>).");
312 ("get_verbose", (RBool "verbose", [], []), -1, [],
316 This returns the verbose messages flag.");
318 ("is_ready", (RBool "ready", [], []), -1, [],
319 [InitNone, Always, TestOutputTrue (
321 "is ready to accept commands",
323 This returns true iff this handle is ready to accept commands
324 (in the C<READY> state).
326 For more information on states, see L<guestfs(3)>.");
328 ("is_config", (RBool "config", [], []), -1, [],
329 [InitNone, Always, TestOutputFalse (
331 "is in configuration state",
333 This returns true iff this handle is being configured
334 (in the C<CONFIG> state).
336 For more information on states, see L<guestfs(3)>.");
338 ("is_launching", (RBool "launching", [], []), -1, [],
339 [InitNone, Always, TestOutputFalse (
340 [["is_launching"]])],
341 "is launching subprocess",
343 This returns true iff this handle is launching the subprocess
344 (in the C<LAUNCHING> state).
346 For more information on states, see L<guestfs(3)>.");
348 ("is_busy", (RBool "busy", [], []), -1, [],
349 [InitNone, Always, TestOutputFalse (
351 "is busy processing a command",
353 This returns true iff this handle is busy processing a command
354 (in the C<BUSY> state).
356 For more information on states, see L<guestfs(3)>.");
358 ("get_state", (RInt "state", [], []), -1, [],
360 "get the current state",
362 This returns the current state as an opaque integer. This is
363 only useful for printing debug and internal error messages.
365 For more information on states, see L<guestfs(3)>.");
367 ("set_memsize", (RErr, [Int "memsize"], []), -1, [FishAlias "memsize"],
368 [InitNone, Always, TestOutputInt (
369 [["set_memsize"; "500"];
370 ["get_memsize"]], 500)],
371 "set memory allocated to the qemu subprocess",
373 This sets the memory size in megabytes allocated to the
374 qemu subprocess. This only has any effect if called before
377 You can also change this by setting the environment
378 variable C<LIBGUESTFS_MEMSIZE> before the handle is
381 For more information on the architecture of libguestfs,
382 see L<guestfs(3)>.");
384 ("get_memsize", (RInt "memsize", [], []), -1, [],
385 [InitNone, Always, TestOutputIntOp (
386 [["get_memsize"]], ">=", 256)],
387 "get memory allocated to the qemu subprocess",
389 This gets the memory size in megabytes allocated to the
392 If C<guestfs_set_memsize> was not called
393 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
394 then this returns the compiled-in default value for memsize.
396 For more information on the architecture of libguestfs,
397 see L<guestfs(3)>.");
399 ("get_pid", (RInt "pid", [], []), -1, [FishAlias "pid"],
400 [InitNone, Always, TestOutputIntOp (
401 [["get_pid"]], ">=", 1)],
402 "get PID of qemu subprocess",
404 Return the process ID of the qemu subprocess. If there is no
405 qemu subprocess, then this will return an error.
407 This is an internal call used for debugging and testing.");
409 ("version", (RStruct ("version", "version"), [], []), -1, [],
410 [InitNone, Always, TestOutputStruct (
411 [["version"]], [CompareWithInt ("major", 1)])],
412 "get the library version number",
414 Return the libguestfs version number that the program is linked
417 Note that because of dynamic linking this is not necessarily
418 the version of libguestfs that you compiled against. You can
419 compile the program, and then at runtime dynamically link
420 against a completely different C<libguestfs.so> library.
422 This call was added in version C<1.0.58>. In previous
423 versions of libguestfs there was no way to get the version
424 number. From C code you can use dynamic linker functions
425 to find out if this symbol exists (if it doesn't, then
426 it's an earlier version).
428 The call returns a structure with four elements. The first
429 three (C<major>, C<minor> and C<release>) are numbers and
430 correspond to the usual version triplet. The fourth element
431 (C<extra>) is a string and is normally empty, but may be
432 used for distro-specific information.
434 To construct the original version string:
435 C<$major.$minor.$release$extra>
437 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
439 I<Note:> Don't use this call to test for availability
440 of features. In enterprise distributions we backport
441 features from later versions into earlier versions,
442 making this an unreliable way to test for features.
443 Use C<guestfs_available> instead.");
445 ("set_selinux", (RErr, [Bool "selinux"], []), -1, [FishAlias "selinux"],
446 [InitNone, Always, TestOutputTrue (
447 [["set_selinux"; "true"];
449 "set SELinux enabled or disabled at appliance boot",
451 This sets the selinux flag that is passed to the appliance
452 at boot time. The default is C<selinux=0> (disabled).
454 Note that if SELinux is enabled, it is always in
455 Permissive mode (C<enforcing=0>).
457 For more information on the architecture of libguestfs,
458 see L<guestfs(3)>.");
460 ("get_selinux", (RBool "selinux", [], []), -1, [],
462 "get SELinux enabled flag",
464 This returns the current setting of the selinux flag which
465 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
467 For more information on the architecture of libguestfs,
468 see L<guestfs(3)>.");
470 ("set_trace", (RErr, [Bool "trace"], []), -1, [FishAlias "trace"],
471 [InitNone, Always, TestOutputFalse (
472 [["set_trace"; "false"];
474 "enable or disable command traces",
476 If the command trace flag is set to 1, then libguestfs
477 calls, parameters and return values are traced.
479 If you want to trace C API calls into libguestfs (and
480 other libraries) then possibly a better way is to use
481 the external ltrace(1) command.
483 Command traces are disabled unless the environment variable
484 C<LIBGUESTFS_TRACE> is defined and set to C<1>.
486 Trace messages are normally sent to C<stderr>, unless you
487 register a callback to send them somewhere else (see
488 C<guestfs_set_event_callback>).");
490 ("get_trace", (RBool "trace", [], []), -1, [],
492 "get command trace enabled flag",
494 Return the command trace flag.");
496 ("set_direct", (RErr, [Bool "direct"], []), -1, [FishAlias "direct"],
497 [InitNone, Always, TestOutputFalse (
498 [["set_direct"; "false"];
500 "enable or disable direct appliance mode",
502 If the direct appliance mode flag is enabled, then stdin and
503 stdout are passed directly through to the appliance once it
506 One consequence of this is that log messages aren't caught
507 by the library and handled by C<guestfs_set_log_message_callback>,
508 but go straight to stdout.
510 You probably don't want to use this unless you know what you
513 The default is disabled.");
515 ("get_direct", (RBool "direct", [], []), -1, [],
517 "get direct appliance mode flag",
519 Return the direct appliance mode flag.");
521 ("set_recovery_proc", (RErr, [Bool "recoveryproc"], []), -1, [FishAlias "recovery-proc"],
522 [InitNone, Always, TestOutputTrue (
523 [["set_recovery_proc"; "true"];
524 ["get_recovery_proc"]])],
525 "enable or disable the recovery process",
527 If this is called with the parameter C<false> then
528 C<guestfs_launch> does not create a recovery process. The
529 purpose of the recovery process is to stop runaway qemu
530 processes in the case where the main program aborts abruptly.
532 This only has any effect if called before C<guestfs_launch>,
533 and the default is true.
535 About the only time when you would want to disable this is
536 if the main process will fork itself into the background
537 (\"daemonize\" itself). In this case the recovery process
538 thinks that the main program has disappeared and so kills
539 qemu, which is not very helpful.");
541 ("get_recovery_proc", (RBool "recoveryproc", [], []), -1, [],
543 "get recovery process enabled flag",
545 Return the recovery process enabled flag.");
547 ("add_drive_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
549 "add a drive specifying the QEMU block emulation to use",
551 This is the same as C<guestfs_add_drive> but it allows you
552 to specify the QEMU interface emulation to use at run time.");
554 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"], []), -1, [DeprecatedBy "add_drive_opts"],
556 "add a drive read-only specifying the QEMU block emulation to use",
558 This is the same as C<guestfs_add_drive_ro> but it allows you
559 to specify the QEMU interface emulation to use at run time.");
561 ("file_architecture", (RString "arch", [Pathname "filename"], []), -1, [],
562 [InitISOFS, Always, TestOutput (
563 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
564 InitISOFS, Always, TestOutput (
565 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
566 InitISOFS, Always, TestOutput (
567 [["file_architecture"; "/bin-win32.exe"]], "i386");
568 InitISOFS, Always, TestOutput (
569 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
570 InitISOFS, Always, TestOutput (
571 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
572 InitISOFS, Always, TestOutput (
573 [["file_architecture"; "/lib-i586.so"]], "i386");
574 InitISOFS, Always, TestOutput (
575 [["file_architecture"; "/lib-sparc.so"]], "sparc");
576 InitISOFS, Always, TestOutput (
577 [["file_architecture"; "/lib-win32.dll"]], "i386");
578 InitISOFS, Always, TestOutput (
579 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
580 InitISOFS, Always, TestOutput (
581 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
582 InitISOFS, Always, TestOutput (
583 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
584 InitISOFS, Always, TestOutput (
585 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
586 "detect the architecture of a binary file",
588 This detects the architecture of the binary C<filename>,
589 and returns it if known.
591 Currently defined architectures are:
597 This string is returned for all 32 bit i386, i486, i586, i686 binaries
598 irrespective of the precise processor requirements of the binary.
610 64 bit SPARC V9 and above.
626 Libguestfs may return other architecture strings in future.
628 The function works on at least the following types of files:
634 many types of Un*x and Linux binary
638 many types of Un*x and Linux shared library
642 Windows Win32 and Win64 binaries
646 Windows Win32 and Win64 DLLs
648 Win32 binaries and DLLs return C<i386>.
650 Win64 binaries and DLLs return C<x86_64>.
658 Linux new-style initrd images
662 some non-x86 Linux vmlinuz kernels
666 What it can't do currently:
672 static libraries (libfoo.a)
676 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
680 x86 Linux vmlinuz kernels
682 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
683 compressed code, and are horribly hard to unpack. If you want to find
684 the architecture of a kernel, use the architecture of the associated
685 initrd or kernel module(s) instead.
689 ("inspect_os", (RStringList "roots", [], []), -1, [],
691 "inspect disk and return list of operating systems found",
693 This function uses other libguestfs functions and certain
694 heuristics to inspect the disk(s) (usually disks belonging to
695 a virtual machine), looking for operating systems.
697 The list returned is empty if no operating systems were found.
699 If one operating system was found, then this returns a list with
700 a single element, which is the name of the root filesystem of
701 this operating system. It is also possible for this function
702 to return a list containing more than one element, indicating
703 a dual-boot or multi-boot virtual machine, with each element being
704 the root filesystem of one of the operating systems.
706 You can pass the root string(s) returned to other
707 C<guestfs_inspect_get_*> functions in order to query further
708 information about each operating system, such as the name
711 This function uses other libguestfs features such as
712 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
713 and unmount filesystems and look at the contents. This should
714 be called with no disks currently mounted. The function may also
715 use Augeas, so any existing Augeas handle will be closed.
717 This function cannot decrypt encrypted disks. The caller
718 must do that first (supplying the necessary keys) if the
721 Please read L<guestfs(3)/INSPECTION> for more details.
723 See also C<guestfs_list_filesystems>.");
725 ("inspect_get_type", (RString "name", [Device "root"], []), -1, [],
727 "get type of inspected operating system",
729 This returns the type of the inspected operating system.
730 Currently defined types are:
736 Any Linux-based operating system.
740 Any Microsoft Windows operating system.
752 The operating system type could not be determined.
756 Future versions of libguestfs may return other strings here.
757 The caller should be prepared to handle any string.
759 Please read L<guestfs(3)/INSPECTION> for more details.");
761 ("inspect_get_arch", (RString "arch", [Device "root"], []), -1, [],
763 "get architecture of inspected operating system",
765 This returns the architecture of the inspected operating system.
766 The possible return values are listed under
767 C<guestfs_file_architecture>.
769 If the architecture could not be determined, then the
770 string C<unknown> is returned.
772 Please read L<guestfs(3)/INSPECTION> for more details.");
774 ("inspect_get_distro", (RString "distro", [Device "root"], []), -1, [],
776 "get distro of inspected operating system",
778 This returns the distro (distribution) of the inspected operating
781 Currently defined distros are:
829 =item \"redhat-based\"
831 Some Red Hat-derived distro.
835 Red Hat Enterprise Linux.
837 =item \"scientificlinux\"
855 The distro could not be determined.
859 Windows does not have distributions. This string is
860 returned if the OS type is Windows.
864 Future versions of libguestfs may return other strings here.
865 The caller should be prepared to handle any string.
867 Please read L<guestfs(3)/INSPECTION> for more details.");
869 ("inspect_get_major_version", (RInt "major", [Device "root"], []), -1, [],
871 "get major version of inspected operating system",
873 This returns the major version number of the inspected operating
876 Windows uses a consistent versioning scheme which is I<not>
877 reflected in the popular public names used by the operating system.
878 Notably the operating system known as \"Windows 7\" is really
879 version 6.1 (ie. major = 6, minor = 1). You can find out the
880 real versions corresponding to releases of Windows by consulting
883 If the version could not be determined, then C<0> is returned.
885 Please read L<guestfs(3)/INSPECTION> for more details.");
887 ("inspect_get_minor_version", (RInt "minor", [Device "root"], []), -1, [],
889 "get minor version of inspected operating system",
891 This returns the minor version number of the inspected operating
894 If the version could not be determined, then C<0> is returned.
896 Please read L<guestfs(3)/INSPECTION> for more details.
897 See also C<guestfs_inspect_get_major_version>.");
899 ("inspect_get_product_name", (RString "product", [Device "root"], []), -1, [],
901 "get product name of inspected operating system",
903 This returns the product name of the inspected operating
904 system. The product name is generally some freeform string
905 which can be displayed to the user, but should not be
908 If the product name could not be determined, then the
909 string C<unknown> is returned.
911 Please read L<guestfs(3)/INSPECTION> for more details.");
913 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"], []), -1, [],
915 "get mountpoints of inspected operating system",
917 This returns a hash of where we think the filesystems
918 associated with this operating system should be mounted.
919 Callers should note that this is at best an educated guess
920 made by reading configuration files such as C</etc/fstab>.
921 I<In particular note> that this may return filesystems
922 which are non-existent or not mountable and callers should
923 be prepared to handle or ignore failures if they try to
926 Each element in the returned hashtable has a key which
927 is the path of the mountpoint (eg. C</boot>) and a value
928 which is the filesystem that would be mounted there
931 Non-mounted devices such as swap devices are I<not>
932 returned in this list.
934 For operating systems like Windows which still use drive
935 letters, this call will only return an entry for the first
936 drive \"mounted on\" C</>. For information about the
937 mapping of drive letters to partitions, see
938 C<guestfs_inspect_get_drive_mappings>.
940 Please read L<guestfs(3)/INSPECTION> for more details.
941 See also C<guestfs_inspect_get_filesystems>.");
943 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"], []), -1, [],
945 "get filesystems associated with inspected operating system",
947 This returns a list of all the filesystems that we think
948 are associated with this operating system. This includes
949 the root filesystem, other ordinary filesystems, and
950 non-mounted devices like swap partitions.
952 In the case of a multi-boot virtual machine, it is possible
953 for a filesystem to be shared between operating systems.
955 Please read L<guestfs(3)/INSPECTION> for more details.
956 See also C<guestfs_inspect_get_mountpoints>.");
958 ("set_network", (RErr, [Bool "network"], []), -1, [FishAlias "network"],
960 "set enable network flag",
962 If C<network> is true, then the network is enabled in the
963 libguestfs appliance. The default is false.
965 This affects whether commands are able to access the network
966 (see L<guestfs(3)/RUNNING COMMANDS>).
968 You must call this before calling C<guestfs_launch>, otherwise
971 ("get_network", (RBool "network", [], []), -1, [],
973 "get enable network flag",
975 This returns the enable network flag.");
977 ("list_filesystems", (RHashtable "fses", [], []), -1, [],
981 This inspection command looks for filesystems on partitions,
982 block devices and logical volumes, returning a list of devices
983 containing filesystems and their type.
985 The return value is a hash, where the keys are the devices
986 containing filesystems, and the values are the filesystem types.
989 \"/dev/sda1\" => \"ntfs\"
990 \"/dev/sda2\" => \"ext2\"
991 \"/dev/vg_guest/lv_root\" => \"ext4\"
992 \"/dev/vg_guest/lv_swap\" => \"swap\"
994 The value can have the special value \"unknown\", meaning the
995 content of the device is undetermined or empty.
996 \"swap\" means a Linux swap partition.
998 This command runs other libguestfs commands, which might include
999 C<guestfs_mount> and C<guestfs_umount>, and therefore you should
1000 use this soon after launch and only when nothing is mounted.
1002 Not all of the filesystems returned will be mountable. In
1003 particular, swap partitions are returned in the list. Also
1004 this command does not check that each filesystem
1005 found is valid and mountable, and some filesystems might
1006 be mountable but require special options. Filesystems may
1007 not all belong to a single logical operating system
1008 (use C<guestfs_inspect_os> to look for OSes).");
1010 ("add_drive_opts", (RErr, [String "filename"], [Bool "readonly"; String "format"; String "iface"; String "name"]), -1, [FishAlias "add"],
1012 "add an image to examine or modify",
1014 This function adds a virtual machine disk image C<filename> to
1015 libguestfs. The first time you call this function, the disk
1016 appears as C</dev/sda>, the second time as C</dev/sdb>, and
1019 You don't necessarily need to be root when using libguestfs. However
1020 you obviously do need sufficient permissions to access the filename
1021 for whatever operations you want to perform (ie. read access if you
1022 just want to read the image or write access if you want to modify the
1025 This call checks that C<filename> exists.
1027 The optional arguments are:
1033 If true then the image is treated as read-only. Writes are still
1034 allowed, but they are stored in a temporary snapshot overlay which
1035 is discarded at the end. The disk that you add is not modified.
1039 This forces the image format. If you omit this (or use C<guestfs_add_drive>
1040 or C<guestfs_add_drive_ro>) then the format is automatically detected.
1041 Possible formats include C<raw> and C<qcow2>.
1043 Automatic detection of the format opens you up to a potential
1044 security hole when dealing with untrusted raw-format images.
1045 See CVE-2010-3851 and RHBZ#642934. Specifying the format closes
1050 This rarely-used option lets you emulate the behaviour of the
1051 deprecated C<guestfs_add_drive_with_if> call (q.v.)
1055 The name the drive had in the original guest, e.g. /dev/sdb. This is used as a
1056 hint to the guest inspection process if it is available.
1060 ("inspect_get_windows_systemroot", (RString "systemroot", [Device "root"], []), -1, [],
1062 "get Windows systemroot of inspected operating system",
1064 This returns the Windows systemroot of the inspected guest.
1065 The systemroot is a directory path such as C</WINDOWS>.
1067 This call assumes that the guest is Windows and that the
1068 systemroot could be determined by inspection. If this is not
1069 the case then an error is returned.
1071 Please read L<guestfs(3)/INSPECTION> for more details.");
1073 ("inspect_get_roots", (RStringList "roots", [], []), -1, [],
1075 "return list of operating systems found by last inspection",
1077 This function is a convenient way to get the list of root
1078 devices, as returned from a previous call to C<guestfs_inspect_os>,
1079 but without redoing the whole inspection process.
1081 This returns an empty list if either no root devices were
1082 found or the caller has not called C<guestfs_inspect_os>.
1084 Please read L<guestfs(3)/INSPECTION> for more details.");
1086 ("debug_cmdline", (RStringList "cmdline", [], []), -1, [NotInDocs],
1088 "debug the QEMU command line (internal use only)",
1090 This returns the internal QEMU command line. 'debug' commands are
1091 not part of the formal API and can be removed or changed at any time.");
1093 ("debug_drives", (RStringList "cmdline", [], []), -1, [NotInDocs],
1095 "debug the drives (internal use only)",
1097 This returns the internal list of drives. 'debug' commands are
1098 not part of the formal API and can be removed or changed at any time.");
1100 ("add_domain", (RInt "nrdisks", [String "dom"], [String "libvirturi"; Bool "readonly"; String "iface"; Bool "live"; Bool "allowuuid"; String "readonlydisk"]), -1, [FishAlias "domain"],
1102 "add the disk(s) from a named libvirt domain",
1104 This function adds the disk(s) attached to the named libvirt
1105 domain C<dom>. It works by connecting to libvirt, requesting
1106 the domain and domain XML from libvirt, parsing it for disks,
1107 and calling C<guestfs_add_drive_opts> on each one.
1109 The number of disks added is returned. This operation is atomic:
1110 if an error is returned, then no disks are added.
1112 This function does some minimal checks to make sure the libvirt
1113 domain is not running (unless C<readonly> is true). In a future
1114 version we will try to acquire the libvirt lock on each disk.
1116 Disks must be accessible locally. This often means that adding disks
1117 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1118 will fail unless those disks are accessible via the same device path
1121 The optional C<libvirturi> parameter sets the libvirt URI
1122 (see L<http://libvirt.org/uri.html>). If this is not set then
1123 we connect to the default libvirt URI (or one set through an
1124 environment variable, see the libvirt documentation for full
1127 The optional C<live> flag controls whether this call will try
1128 to connect to a running virtual machine C<guestfsd> process if
1129 it sees a suitable E<lt>channelE<gt> element in the libvirt
1130 XML definition. The default (if the flag is omitted) is never
1131 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1134 If the C<allowuuid> flag is true (default is false) then a UUID
1135 I<may> be passed instead of the domain name. The C<dom> string is
1136 treated as a UUID first and looked up, and if that lookup fails
1137 then we treat C<dom> as a name as usual.
1139 The optional C<readonlydisk> parameter controls what we do for
1140 disks which are marked E<lt>readonly/E<gt> in the libvirt XML.
1141 Possible values are:
1145 =item readonlydisk = \"error\"
1147 If C<readonly> is false:
1149 The whole call is aborted with an error if any disk with
1150 the E<lt>readonly/E<gt> flag is found.
1152 If C<readonly> is true:
1154 Disks with the E<lt>readonly/E<gt> flag are added read-only.
1156 =item readonlydisk = \"read\"
1158 If C<readonly> is false:
1160 Disks with the E<lt>readonly/E<gt> flag are added read-only.
1161 Other disks are added read/write.
1163 If C<readonly> is true:
1165 Disks with the E<lt>readonly/E<gt> flag are added read-only.
1167 =item readonlydisk = \"write\" (default)
1169 If C<readonly> is false:
1171 Disks with the E<lt>readonly/E<gt> flag are added read/write.
1173 If C<readonly> is true:
1175 Disks with the E<lt>readonly/E<gt> flag are added read-only.
1177 =item readonlydisk = \"ignore\"
1179 If C<readonly> is true or false:
1181 Disks with the E<lt>readonly/E<gt> flag are skipped.
1185 The other optional parameters are passed directly through to
1186 C<guestfs_add_drive_opts>.");
1189 This interface is not quite baked yet. -- RWMJ 2010-11-11
1190 ("add_libvirt_dom", (RInt "nrdisks", [Pointer ("virDomainPtr", "dom")], [Bool "readonly"; String "iface"; Bool "live"; String "readonlydisk"]), -1, [NotInFish],
1192 "add the disk(s) from a libvirt domain",
1194 This function adds the disk(s) attached to the libvirt domain C<dom>.
1195 It works by requesting the domain XML from libvirt, parsing it for
1196 disks, and calling C<guestfs_add_drive_opts> on each one.
1198 In the C API we declare C<void *dom>, but really it has type
1199 C<virDomainPtr dom>. This is so we don't need E<lt>libvirt.hE<gt>.
1201 The number of disks added is returned. This operation is atomic:
1202 if an error is returned, then no disks are added.
1204 This function does some minimal checks to make sure the libvirt
1205 domain is not running (unless C<readonly> is true). In a future
1206 version we will try to acquire the libvirt lock on each disk.
1208 Disks must be accessible locally. This often means that adding disks
1209 from a remote libvirt connection (see L<http://libvirt.org/remote.html>)
1210 will fail unless those disks are accessible via the same device path
1213 The optional C<live> flag controls whether this call will try
1214 to connect to a running virtual machine C<guestfsd> process if
1215 it sees a suitable E<lt>channelE<gt> element in the libvirt
1216 XML definition. The default (if the flag is omitted) is never
1217 to try. See L<guestfs(3)/ATTACHING TO RUNNING DAEMONS> for more
1220 The optional C<readonlydisk> parameter controls what we do for
1221 disks which are marked E<lt>readonly/E<gt> in the libvirt XML.
1222 See C<guestfs_add_domain> for possible values.
1224 The other optional parameters are passed directly through to
1225 C<guestfs_add_drive_opts>.");
1228 ("inspect_get_package_format", (RString "packageformat", [Device "root"], []), -1, [],
1230 "get package format used by the operating system",
1232 This function and C<guestfs_inspect_get_package_management> return
1233 the package format and package management tool used by the
1234 inspected operating system. For example for Fedora these
1235 functions would return C<rpm> (package format) and
1236 C<yum> (package management).
1238 This returns the string C<unknown> if we could not determine the
1239 package format I<or> if the operating system does not have
1240 a real packaging system (eg. Windows).
1242 Possible strings include:
1243 C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>, C<pkgsrc>.
1244 Future versions of libguestfs may return other strings.
1246 Please read L<guestfs(3)/INSPECTION> for more details.");
1248 ("inspect_get_package_management", (RString "packagemanagement", [Device "root"], []), -1, [],
1250 "get package management tool used by the operating system",
1252 C<guestfs_inspect_get_package_format> and this function return
1253 the package format and package management tool used by the
1254 inspected operating system. For example for Fedora these
1255 functions would return C<rpm> (package format) and
1256 C<yum> (package management).
1258 This returns the string C<unknown> if we could not determine the
1259 package management tool I<or> if the operating system does not have
1260 a real packaging system (eg. Windows).
1262 Possible strings include: C<yum>, C<up2date>,
1263 C<apt> (for all Debian derivatives),
1264 C<portage>, C<pisi>, C<pacman>, C<urpmi>, C<zypper>.
1265 Future versions of libguestfs may return other strings.
1267 Please read L<guestfs(3)/INSPECTION> for more details.");
1269 ("inspect_list_applications", (RStructList ("applications", "application"), [Device "root"], []), -1, [],
1271 "get list of applications installed in the operating system",
1273 Return the list of applications installed in the operating system.
1275 I<Note:> This call works differently from other parts of the
1276 inspection API. You have to call C<guestfs_inspect_os>, then
1277 C<guestfs_inspect_get_mountpoints>, then mount up the disks,
1278 before calling this. Listing applications is a significantly
1279 more difficult operation which requires access to the full
1280 filesystem. Also note that unlike the other
1281 C<guestfs_inspect_get_*> calls which are just returning
1282 data cached in the libguestfs handle, this call actually reads
1283 parts of the mounted filesystems during the call.
1285 This returns an empty list if the inspection code was not able
1286 to determine the list of applications.
1288 The application structure contains the following fields:
1294 The name of the application. For Red Hat-derived and Debian-derived
1295 Linux guests, this is the package name.
1297 =item C<app_display_name>
1299 The display name of the application, sometimes localized to the
1300 install language of the guest operating system.
1302 If unavailable this is returned as an empty string C<\"\">.
1303 Callers needing to display something can use C<app_name> instead.
1307 For package managers which use epochs, this contains the epoch of
1308 the package (an integer). If unavailable, this is returned as C<0>.
1310 =item C<app_version>
1312 The version string of the application or package. If unavailable
1313 this is returned as an empty string C<\"\">.
1315 =item C<app_release>
1317 The release string of the application or package, for package
1318 managers that use this. If unavailable this is returned as an
1319 empty string C<\"\">.
1321 =item C<app_install_path>
1323 The installation path of the application (on operating systems
1324 such as Windows which use installation paths). This path is
1325 in the format used by the guest operating system, it is not
1328 If unavailable this is returned as an empty string C<\"\">.
1330 =item C<app_trans_path>
1332 The install path translated into a libguestfs path.
1333 If unavailable this is returned as an empty string C<\"\">.
1335 =item C<app_publisher>
1337 The name of the publisher of the application, for package
1338 managers that use this. If unavailable this is returned
1339 as an empty string C<\"\">.
1343 The URL (eg. upstream URL) of the application.
1344 If unavailable this is returned as an empty string C<\"\">.
1346 =item C<app_source_package>
1348 For packaging systems which support this, the name of the source
1349 package. If unavailable this is returned as an empty string C<\"\">.
1351 =item C<app_summary>
1353 A short (usually one line) description of the application or package.
1354 If unavailable this is returned as an empty string C<\"\">.
1356 =item C<app_description>
1358 A longer description of the application or package.
1359 If unavailable this is returned as an empty string C<\"\">.
1363 Please read L<guestfs(3)/INSPECTION> for more details.");
1365 ("inspect_get_hostname", (RString "hostname", [Device "root"], []), -1, [],
1367 "get hostname of the operating system",
1369 This function returns the hostname of the operating system
1370 as found by inspection of the guest's configuration files.
1372 If the hostname could not be determined, then the
1373 string C<unknown> is returned.
1375 Please read L<guestfs(3)/INSPECTION> for more details.");
1377 ("inspect_get_format", (RString "format", [Device "root"], []), -1, [],
1379 "get format of inspected operating system",
1381 This returns the format of the inspected operating system. You
1382 can use it to detect install images, live CDs and similar.
1384 Currently defined formats are:
1390 This is an installed operating system.
1394 The disk image being inspected is not an installed operating system,
1395 but a I<bootable> install disk, live CD, or similar.
1399 The format of this disk image is not known.
1403 Future versions of libguestfs may return other strings here.
1404 The caller should be prepared to handle any string.
1406 Please read L<guestfs(3)/INSPECTION> for more details.");
1408 ("inspect_is_live", (RBool "live", [Device "root"], []), -1, [],
1410 "get live flag for install disk",
1412 If C<guestfs_inspect_get_format> returns C<installer> (this
1413 is an install disk), then this returns true if a live image
1414 was detected on the disk.
1416 Please read L<guestfs(3)/INSPECTION> for more details.");
1418 ("inspect_is_netinst", (RBool "netinst", [Device "root"], []), -1, [],
1420 "get netinst (network installer) flag for install disk",
1422 If C<guestfs_inspect_get_format> returns C<installer> (this
1423 is an install disk), then this returns true if the disk is
1424 a network installer, ie. not a self-contained install CD but
1425 one which is likely to require network access to complete
1428 Please read L<guestfs(3)/INSPECTION> for more details.");
1430 ("inspect_is_multipart", (RBool "multipart", [Device "root"], []), -1, [],
1432 "get multipart flag for install disk",
1434 If C<guestfs_inspect_get_format> returns C<installer> (this
1435 is an install disk), then this returns true if the disk is
1438 Please read L<guestfs(3)/INSPECTION> for more details.");
1440 ("set_attach_method", (RErr, [String "attachmethod"], []), -1, [FishAlias "attach-method"],
1442 "set the attach method",
1444 Set the method that libguestfs uses to connect to the back end
1445 guestfsd daemon. Possible methods are:
1451 Launch an appliance and connect to it. This is the ordinary method
1454 =item C<unix:I<path>>
1456 Connect to the Unix domain socket I<path>.
1458 This method lets you connect to an existing daemon or (using
1459 virtio-serial) to a live guest. For more information, see
1460 L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>.
1464 ("get_attach_method", (RString "attachmethod", [], []), -1, [],
1465 [InitNone, Always, TestOutput (
1466 [["get_attach_method"]], "appliance")],
1467 "get the attach method",
1469 Return the current attach method. See C<guestfs_set_attach_method>.");
1471 ("inspect_get_product_variant", (RString "variant", [Device "root"], []), -1, [],
1473 "get product variant of inspected operating system",
1475 This returns the product variant of the inspected operating
1478 For Windows guests, this returns the contents of the Registry key
1479 C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion>
1480 C<InstallationType> which is usually a string such as
1481 C<Client> or C<Server> (other values are possible). This
1482 can be used to distinguish consumer and enterprise versions
1483 of Windows that have the same version number (for example,
1484 Windows 7 and Windows 2008 Server are both version 6.1,
1485 but the former is C<Client> and the latter is C<Server>).
1487 For enterprise Linux guests, in future we intend this to return
1488 the product variant such as C<Desktop>, C<Server> and so on. But
1489 this is not implemented at present.
1491 If the product variant could not be determined, then the
1492 string C<unknown> is returned.
1494 Please read L<guestfs(3)/INSPECTION> for more details.
1495 See also C<guestfs_inspect_get_product_name>,
1496 C<guestfs_inspect_get_major_version>.");
1498 ("inspect_get_windows_current_control_set", (RString "controlset", [Device "root"], []), -1, [],
1500 "get Windows CurrentControlSet of inspected operating system",
1502 This returns the Windows CurrentControlSet of the inspected guest.
1503 The CurrentControlSet is a registry key name such as C<ControlSet001>.
1505 This call assumes that the guest is Windows and that the
1506 Registry could be examined by inspection. If this is not
1507 the case then an error is returned.
1509 Please read L<guestfs(3)/INSPECTION> for more details.");
1511 ("inspect_get_drive_mappings", (RHashtable "drives", [Device "root"], []), -1, [],
1513 "get drive letter mappings",
1515 This call is useful for Windows which uses a primitive system
1516 of assigning drive letters (like \"C:\") to partitions.
1517 This inspection API examines the Windows Registry to find out
1518 how disks/partitions are mapped to drive letters, and returns
1519 a hash table as in the example below:
1525 Note that keys are drive letters. For Windows, the key is
1526 case insensitive and just contains the drive letter, without
1527 the customary colon separator character.
1529 In future we may support other operating systems that also used drive
1530 letters, but the keys for those might not be case insensitive
1531 and might be longer than 1 character. For example in OS-9,
1532 hard drives were named C<h0>, C<h1> etc.
1534 For Windows guests, currently only hard drive mappings are
1535 returned. Removable disks (eg. DVD-ROMs) are ignored.
1537 For guests that do not use drive mappings, or if the drive mappings
1538 could not be determined, this returns an empty hash table.
1540 Please read L<guestfs(3)/INSPECTION> for more details.
1541 See also C<guestfs_inspect_get_mountpoints>,
1542 C<guestfs_inspect_get_filesystems>.");
1544 ("inspect_get_icon", (RBufferOut "icon", [Device "root"], [Bool "favicon"; Bool "highquality"]), -1, [],
1546 "get the icon corresponding to this operating system",
1548 This function returns an icon corresponding to the inspected
1549 operating system. The icon is returned as a buffer containing a
1550 PNG image (re-encoded to PNG if necessary).
1552 If it was not possible to get an icon this function returns a
1553 zero-length (non-NULL) buffer. I<Callers must check for this case>.
1555 Libguestfs will start by looking for a file called
1556 C</etc/favicon.png> or C<C:\\etc\\favicon.png>
1557 and if it has the correct format, the contents of this file will
1558 be returned. You can disable favicons by passing the
1559 optional C<favicon> boolean as false (default is true).
1561 If finding the favicon fails, then we look in other places in the
1562 guest for a suitable icon.
1564 If the optional C<highquality> boolean is true then
1565 only high quality icons are returned, which means only icons of
1566 high resolution with an alpha channel. The default (false) is
1567 to return any icon we can, even if it is of substandard quality.
1575 Unlike most other inspection API calls, the guest's disks must be
1576 mounted up before you call this, since it needs to read information
1577 from the guest filesystem during the call.
1581 B<Security:> The icon data comes from the untrusted guest,
1582 and should be treated with caution. PNG files have been
1583 known to contain exploits. Ensure that libpng (or other relevant
1584 libraries) are fully up to date before trying to process or
1589 The PNG image returned can be any size. It might not be square.
1590 Libguestfs tries to return the largest, highest quality
1591 icon available. The application must scale the icon to the
1596 Extracting icons from Windows guests requires the external
1597 C<wrestool> program from the C<icoutils> package, and
1598 several programs (C<bmptopnm>, C<pnmtopng>, C<pamcut>)
1599 from the C<netpbm> package. These must be installed separately.
1603 Operating system icons are usually trademarks. Seek legal
1604 advice before using trademarks in applications.
1608 ("set_pgroup", (RErr, [Bool "pgroup"], []), -1, [FishAlias "pgroup"],
1610 "set process group flag",
1612 If C<pgroup> is true, child processes are placed into
1613 their own process group.
1615 The practical upshot of this is that signals like C<SIGINT> (from
1616 users pressing C<^C>) won't be received by the child process.
1618 The default for this flag is false, because usually you want
1619 C<^C> to kill the subprocess.");
1621 ("get_pgroup", (RBool "pgroup", [], []), -1, [],
1623 "get process group flag",
1625 This returns the process group flag.");
1627 ("set_smp", (RErr, [Int "smp"], []), -1, [FishAlias "smp"],
1629 "set number of virtual CPUs in appliance",
1631 Change the number of virtual CPUs assigned to the appliance. The
1632 default is C<1>. Increasing this may improve performance, though
1633 often it has no effect.
1635 This function must be called before C<guestfs_launch>.");
1637 ("get_smp", (RInt "smp", [], []), -1, [],
1639 "get number of virtual CPUs in appliance",
1641 This returns the number of virtual CPUs assigned to the appliance.");
1645 (* daemon_functions are any functions which cause some action
1646 * to take place in the daemon.
1649 let daemon_functions = [
1650 ("mount", (RErr, [Device "device"; String "mountpoint"], []), 1, [],
1651 [InitEmpty, Always, TestOutput (
1652 [["part_disk"; "/dev/sda"; "mbr"];
1653 ["mkfs"; "ext2"; "/dev/sda1"];
1654 ["mount"; "/dev/sda1"; "/"];
1655 ["write"; "/new"; "new file contents"];
1656 ["cat"; "/new"]], "new file contents")],
1657 "mount a guest disk at a position in the filesystem",
1659 Mount a guest disk at a position in the filesystem. Block devices
1660 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1661 the guest. If those block devices contain partitions, they will have
1662 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1665 The rules are the same as for L<mount(2)>: A filesystem must
1666 first be mounted on C</> before others can be mounted. Other
1667 filesystems can only be mounted on directories which already
1670 The mounted filesystem is writable, if we have sufficient permissions
1671 on the underlying device.
1673 Before libguestfs 1.13.16, this call implicitly added the options
1674 C<sync> and C<noatime>. The C<sync> option greatly slowed
1675 writes and caused many problems for users. If your program
1676 might need to work with older versions of libguestfs, use
1677 C<guestfs_mount_options> instead (using an empty string for the
1678 first parameter if you don't want any options).");
1680 ("sync", (RErr, [], []), 2, [],
1681 [ InitEmpty, Always, TestRun [["sync"]]],
1682 "sync disks, writes are flushed through to the disk image",
1684 This syncs the disk, so that any writes are flushed through to the
1685 underlying disk image.
1687 You should always call this if you have modified a disk image, before
1688 closing the handle.");
1690 ("touch", (RErr, [Pathname "path"], []), 3, [],
1691 [InitScratchFS, Always, TestOutputTrue (
1692 [["touch"; "/touch"];
1693 ["exists"; "/touch"]])],
1694 "update file timestamps or create a new file",
1696 Touch acts like the L<touch(1)> command. It can be used to
1697 update the timestamps on a file, or, if the file does not exist,
1698 to create a new zero-length file.
1700 This command only works on regular files, and will fail on other
1701 file types such as directories, symbolic links, block special etc.");
1703 ("cat", (RString "content", [Pathname "path"], []), 4, [ProtocolLimitWarning],
1704 [InitISOFS, Always, TestOutput (
1705 [["cat"; "/known-2"]], "abcdef\n")],
1706 "list the contents of a file",
1708 Return the contents of the file named C<path>.
1710 Note that this function cannot correctly handle binary files
1711 (specifically, files containing C<\\0> character which is treated
1712 as end of string). For those you need to use the C<guestfs_read_file>
1713 or C<guestfs_download> functions which have a more complex interface.");
1715 ("ll", (RString "listing", [Pathname "directory"], []), 5, [],
1716 [], (* XXX Tricky to test because it depends on the exact format
1717 * of the 'ls -l' command, which changes between F10 and F11.
1719 "list the files in a directory (long format)",
1721 List the files in C<directory> (relative to the root directory,
1722 there is no cwd) in the format of 'ls -la'.
1724 This command is mostly useful for interactive sessions. It
1725 is I<not> intended that you try to parse the output string.");
1727 ("ls", (RStringList "listing", [Pathname "directory"], []), 6, [],
1728 [InitScratchFS, Always, TestOutputList (
1730 ["touch"; "/ls/new"];
1731 ["touch"; "/ls/newer"];
1732 ["touch"; "/ls/newest"];
1733 ["ls"; "/ls"]], ["new"; "newer"; "newest"])],
1734 "list the files in a directory",
1736 List the files in C<directory> (relative to the root directory,
1737 there is no cwd). The '.' and '..' entries are not returned, but
1738 hidden files are shown.
1740 This command is mostly useful for interactive sessions. Programs
1741 should probably use C<guestfs_readdir> instead.");
1743 ("list_devices", (RStringList "devices", [], []), 7, [],
1744 [InitEmpty, Always, TestOutputListOfDevices (
1745 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1746 "list the block devices",
1748 List all the block devices.
1750 The full block device names are returned, eg. C</dev/sda>.
1752 See also C<guestfs_list_filesystems>.");
1754 ("list_partitions", (RStringList "partitions", [], []), 8, [],
1755 [InitBasicFS, Always, TestOutputListOfDevices (
1756 [["list_partitions"]], ["/dev/sda1"; "/dev/sdb1"]);
1757 InitEmpty, Always, TestOutputListOfDevices (
1758 [["part_init"; "/dev/sda"; "mbr"];
1759 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1760 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1761 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1762 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"; "/dev/sdb1"])],
1763 "list the partitions",
1765 List all the partitions detected on all block devices.
1767 The full partition device names are returned, eg. C</dev/sda1>
1769 This does not return logical volumes. For that you will need to
1770 call C<guestfs_lvs>.
1772 See also C<guestfs_list_filesystems>.");
1774 ("pvs", (RStringList "physvols", [], []), 9, [Optional "lvm2"],
1775 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1776 [["pvs"]], ["/dev/sda1"]);
1777 InitEmpty, Always, TestOutputListOfDevices (
1778 [["part_init"; "/dev/sda"; "mbr"];
1779 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1780 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1781 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1782 ["pvcreate"; "/dev/sda1"];
1783 ["pvcreate"; "/dev/sda2"];
1784 ["pvcreate"; "/dev/sda3"];
1785 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1786 "list the LVM physical volumes (PVs)",
1788 List all the physical volumes detected. This is the equivalent
1789 of the L<pvs(8)> command.
1791 This returns a list of just the device names that contain
1792 PVs (eg. C</dev/sda2>).
1794 See also C<guestfs_pvs_full>.");
1796 ("vgs", (RStringList "volgroups", [], []), 10, [Optional "lvm2"],
1797 [InitBasicFSonLVM, Always, TestOutputList (
1799 InitEmpty, Always, TestOutputList (
1800 [["part_init"; "/dev/sda"; "mbr"];
1801 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1802 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1803 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1804 ["pvcreate"; "/dev/sda1"];
1805 ["pvcreate"; "/dev/sda2"];
1806 ["pvcreate"; "/dev/sda3"];
1807 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1808 ["vgcreate"; "VG2"; "/dev/sda3"];
1809 ["vgs"]], ["VG1"; "VG2"])],
1810 "list the LVM volume groups (VGs)",
1812 List all the volumes groups detected. This is the equivalent
1813 of the L<vgs(8)> command.
1815 This returns a list of just the volume group names that were
1816 detected (eg. C<VolGroup00>).
1818 See also C<guestfs_vgs_full>.");
1820 ("lvs", (RStringList "logvols", [], []), 11, [Optional "lvm2"],
1821 [InitBasicFSonLVM, Always, TestOutputList (
1822 [["lvs"]], ["/dev/VG/LV"]);
1823 InitEmpty, Always, TestOutputList (
1824 [["part_init"; "/dev/sda"; "mbr"];
1825 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
1826 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
1827 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
1828 ["pvcreate"; "/dev/sda1"];
1829 ["pvcreate"; "/dev/sda2"];
1830 ["pvcreate"; "/dev/sda3"];
1831 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1832 ["vgcreate"; "VG2"; "/dev/sda3"];
1833 ["lvcreate"; "LV1"; "VG1"; "50"];
1834 ["lvcreate"; "LV2"; "VG1"; "50"];
1835 ["lvcreate"; "LV3"; "VG2"; "50"];
1836 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1837 "list the LVM logical volumes (LVs)",
1839 List all the logical volumes detected. This is the equivalent
1840 of the L<lvs(8)> command.
1842 This returns a list of the logical volume device names
1843 (eg. C</dev/VolGroup00/LogVol00>).
1845 See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>.");
1847 ("pvs_full", (RStructList ("physvols", "lvm_pv"), [], []), 12, [Optional "lvm2"],
1848 [], (* XXX how to test? *)
1849 "list the LVM physical volumes (PVs)",
1851 List all the physical volumes detected. This is the equivalent
1852 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1854 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), [], []), 13, [Optional "lvm2"],
1855 [], (* XXX how to test? *)
1856 "list the LVM volume groups (VGs)",
1858 List all the volumes groups detected. This is the equivalent
1859 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1861 ("lvs_full", (RStructList ("logvols", "lvm_lv"), [], []), 14, [Optional "lvm2"],
1862 [], (* XXX how to test? *)
1863 "list the LVM logical volumes (LVs)",
1865 List all the logical volumes detected. This is the equivalent
1866 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1868 ("read_lines", (RStringList "lines", [Pathname "path"], []), 15, [],
1869 [InitISOFS, Always, TestOutputList (
1870 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1871 InitISOFS, Always, TestOutputList (
1872 [["read_lines"; "/empty"]], [])],
1873 "read file as lines",
1875 Return the contents of the file named C<path>.
1877 The file contents are returned as a list of lines. Trailing
1878 C<LF> and C<CRLF> character sequences are I<not> returned.
1880 Note that this function cannot correctly handle binary files
1881 (specifically, files containing C<\\0> character which is treated
1882 as end of line). For those you need to use the C<guestfs_read_file>
1883 function which has a more complex interface.");
1885 ("aug_init", (RErr, [Pathname "root"; Int "flags"], []), 16, [Optional "augeas"],
1886 [], (* XXX Augeas code needs tests. *)
1887 "create a new Augeas handle",
1889 Create a new Augeas handle for editing configuration files.
1890 If there was any previous Augeas handle associated with this
1891 guestfs session, then it is closed.
1893 You must call this before using any other C<guestfs_aug_*>
1896 C<root> is the filesystem root. C<root> must not be NULL,
1899 The flags are the same as the flags defined in
1900 E<lt>augeas.hE<gt>, the logical I<or> of the following
1905 =item C<AUG_SAVE_BACKUP> = 1
1907 Keep the original file with a C<.augsave> extension.
1909 =item C<AUG_SAVE_NEWFILE> = 2
1911 Save changes into a file with extension C<.augnew>, and
1912 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1914 =item C<AUG_TYPE_CHECK> = 4
1918 This option is only useful when debugging Augeas lenses. Use
1919 of this option may require additional memory for the libguestfs
1920 appliance. You may need to set the C<LIBGUESTFS_MEMSIZE>
1921 environment variable or call C<guestfs_set_memsize>.
1923 =item C<AUG_NO_STDINC> = 8
1925 Do not use standard load path for modules.
1927 =item C<AUG_SAVE_NOOP> = 16
1929 Make save a no-op, just record what would have been changed.
1931 =item C<AUG_NO_LOAD> = 32
1933 Do not load the tree in C<guestfs_aug_init>.
1937 To close the handle, you can call C<guestfs_aug_close>.
1939 To find out more about Augeas, see L<http://augeas.net/>.");
1941 ("aug_close", (RErr, [], []), 26, [Optional "augeas"],
1942 [], (* XXX Augeas code needs tests. *)
1943 "close the current Augeas handle",
1945 Close the current Augeas handle and free up any resources
1946 used by it. After calling this, you have to call
1947 C<guestfs_aug_init> again before you can use any other
1948 Augeas functions.");
1950 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"], []), 17, [Optional "augeas"],
1951 [], (* XXX Augeas code needs tests. *)
1952 "define an Augeas variable",
1954 Defines an Augeas variable C<name> whose value is the result
1955 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1958 On success this returns the number of nodes in C<expr>, or
1959 C<0> if C<expr> evaluates to something which is not a nodeset.");
1961 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"], []), 18, [Optional "augeas"],
1962 [], (* XXX Augeas code needs tests. *)
1963 "define an Augeas node",
1965 Defines a variable C<name> whose value is the result of
1968 If C<expr> evaluates to an empty nodeset, a node is created,
1969 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1970 C<name> will be the nodeset containing that single node.
1972 On success this returns a pair containing the
1973 number of nodes in the nodeset, and a boolean flag
1974 if a node was created.");
1976 ("aug_get", (RString "val", [String "augpath"], []), 19, [Optional "augeas"],
1977 [], (* XXX Augeas code needs tests. *)
1978 "look up the value of an Augeas path",
1980 Look up the value associated with C<path>. If C<path>
1981 matches exactly one node, the C<value> is returned.");
1983 ("aug_set", (RErr, [String "augpath"; String "val"], []), 20, [Optional "augeas"],
1984 [], (* XXX Augeas code needs tests. *)
1985 "set Augeas path to value",
1987 Set the value associated with C<path> to C<val>.
1989 In the Augeas API, it is possible to clear a node by setting
1990 the value to NULL. Due to an oversight in the libguestfs API
1991 you cannot do that with this call. Instead you must use the
1992 C<guestfs_aug_clear> call.");
1994 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"], []), 21, [Optional "augeas"],
1995 [], (* XXX Augeas code needs tests. *)
1996 "insert a sibling Augeas node",
1998 Create a new sibling C<label> for C<path>, inserting it into
1999 the tree before or after C<path> (depending on the boolean
2002 C<path> must match exactly one existing node in the tree, and
2003 C<label> must be a label, ie. not contain C</>, C<*> or end
2004 with a bracketed index C<[N]>.");
2006 ("aug_rm", (RInt "nrnodes", [String "augpath"], []), 22, [Optional "augeas"],
2007 [], (* XXX Augeas code needs tests. *)
2008 "remove an Augeas path",
2010 Remove C<path> and all of its children.
2012 On success this returns the number of entries which were removed.");
2014 ("aug_mv", (RErr, [String "src"; String "dest"], []), 23, [Optional "augeas"],
2015 [], (* XXX Augeas code needs tests. *)
2018 Move the node C<src> to C<dest>. C<src> must match exactly
2019 one node. C<dest> is overwritten if it exists.");
2021 ("aug_match", (RStringList "matches", [String "augpath"], []), 24, [Optional "augeas"],
2022 [], (* XXX Augeas code needs tests. *)
2023 "return Augeas nodes which match augpath",
2025 Returns a list of paths which match the path expression C<path>.
2026 The returned paths are sufficiently qualified so that they match
2027 exactly one node in the current tree.");
2029 ("aug_save", (RErr, [], []), 25, [Optional "augeas"],
2030 [], (* XXX Augeas code needs tests. *)
2031 "write all pending Augeas changes to disk",
2033 This writes all pending changes to disk.
2035 The flags which were passed to C<guestfs_aug_init> affect exactly
2036 how files are saved.");
2038 ("aug_load", (RErr, [], []), 27, [Optional "augeas"],
2039 [], (* XXX Augeas code needs tests. *)
2040 "load files into the tree",
2042 Load files into the tree.
2044 See C<aug_load> in the Augeas documentation for the full gory
2047 ("aug_ls", (RStringList "matches", [String "augpath"], []), 28, [Optional "augeas"],
2048 [], (* XXX Augeas code needs tests. *)
2049 "list Augeas nodes under augpath",
2051 This is just a shortcut for listing C<guestfs_aug_match>
2052 C<path/*> and sorting the resulting nodes into alphabetical order.");
2054 ("rm", (RErr, [Pathname "path"], []), 29, [],
2055 [InitScratchFS, Always, TestRun
2057 ["touch"; "/rm/new"];
2059 InitScratchFS, Always, TestLastFail
2060 [["rm"; "/nosuchfile"]];
2061 InitScratchFS, Always, TestLastFail
2066 Remove the single file C<path>.");
2068 ("rmdir", (RErr, [Pathname "path"], []), 30, [],
2069 [InitScratchFS, Always, TestRun
2070 [["mkdir"; "/rmdir"];
2071 ["rmdir"; "/rmdir"]];
2072 InitScratchFS, Always, TestLastFail
2073 [["rmdir"; "/rmdir2"]];
2074 InitScratchFS, Always, TestLastFail
2075 [["mkdir"; "/rmdir3"];
2076 ["touch"; "/rmdir3/new"];
2077 ["rmdir"; "/rmdir3/new"]]],
2078 "remove a directory",
2080 Remove the single directory C<path>.");
2082 ("rm_rf", (RErr, [Pathname "path"], []), 31, [],
2083 [InitScratchFS, Always, TestOutputFalse
2084 [["mkdir"; "/rm_rf"];
2085 ["mkdir"; "/rm_rf/foo"];
2086 ["touch"; "/rm_rf/foo/bar"];
2087 ["rm_rf"; "/rm_rf"];
2088 ["exists"; "/rm_rf"]]],
2089 "remove a file or directory recursively",
2091 Remove the file or directory C<path>, recursively removing the
2092 contents if its a directory. This is like the C<rm -rf> shell
2095 ("mkdir", (RErr, [Pathname "path"], []), 32, [],
2096 [InitScratchFS, Always, TestOutputTrue
2097 [["mkdir"; "/mkdir"];
2098 ["is_dir"; "/mkdir"]];
2099 InitScratchFS, Always, TestLastFail
2100 [["mkdir"; "/mkdir2/foo/bar"]]],
2101 "create a directory",
2103 Create a directory named C<path>.");
2105 ("mkdir_p", (RErr, [Pathname "path"], []), 33, [],
2106 [InitScratchFS, Always, TestOutputTrue
2107 [["mkdir_p"; "/mkdir_p/foo/bar"];
2108 ["is_dir"; "/mkdir_p/foo/bar"]];
2109 InitScratchFS, Always, TestOutputTrue
2110 [["mkdir_p"; "/mkdir_p2/foo/bar"];
2111 ["is_dir"; "/mkdir_p2/foo"]];
2112 InitScratchFS, Always, TestOutputTrue
2113 [["mkdir_p"; "/mkdir_p3/foo/bar"];
2114 ["is_dir"; "/mkdir_p3"]];
2115 (* Regression tests for RHBZ#503133: *)
2116 InitScratchFS, Always, TestRun
2117 [["mkdir"; "/mkdir_p4"];
2118 ["mkdir_p"; "/mkdir_p4"]];
2119 InitScratchFS, Always, TestLastFail
2120 [["touch"; "/mkdir_p5"];
2121 ["mkdir_p"; "/mkdir_p5"]]],
2122 "create a directory and parents",
2124 Create a directory named C<path>, creating any parent directories
2125 as necessary. This is like the C<mkdir -p> shell command.");
2127 ("chmod", (RErr, [Int "mode"; Pathname "path"], []), 34, [],
2128 [], (* XXX Need stat command to test *)
2131 Change the mode (permissions) of C<path> to C<mode>. Only
2132 numeric modes are supported.
2134 I<Note>: When using this command from guestfish, C<mode>
2135 by default would be decimal, unless you prefix it with
2136 C<0> to get octal, ie. use C<0700> not C<700>.
2138 The mode actually set is affected by the umask.");
2140 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 35, [],
2141 [], (* XXX Need stat command to test *)
2142 "change file owner and group",
2144 Change the file owner to C<owner> and group to C<group>.
2146 Only numeric uid and gid are supported. If you want to use
2147 names, you will need to locate and parse the password file
2148 yourself (Augeas support makes this relatively easy).");
2150 ("exists", (RBool "existsflag", [Pathname "path"], []), 36, [],
2151 [InitISOFS, Always, TestOutputTrue (
2152 [["exists"; "/empty"]]);
2153 InitISOFS, Always, TestOutputTrue (
2154 [["exists"; "/directory"]])],
2155 "test if file or directory exists",
2157 This returns C<true> if and only if there is a file, directory
2158 (or anything) with the given C<path> name.
2160 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
2162 ("is_file", (RBool "fileflag", [Pathname "path"], []), 37, [],
2163 [InitISOFS, Always, TestOutputTrue (
2164 [["is_file"; "/known-1"]]);
2165 InitISOFS, Always, TestOutputFalse (
2166 [["is_file"; "/directory"]])],
2167 "test if a regular file",
2169 This returns C<true> if and only if there is a regular file
2170 with the given C<path> name. Note that it returns false for
2171 other objects like directories.
2173 See also C<guestfs_stat>.");
2175 ("is_dir", (RBool "dirflag", [Pathname "path"], []), 38, [],
2176 [InitISOFS, Always, TestOutputFalse (
2177 [["is_dir"; "/known-3"]]);
2178 InitISOFS, Always, TestOutputTrue (
2179 [["is_dir"; "/directory"]])],
2180 "test if a directory",
2182 This returns C<true> if and only if there is a directory
2183 with the given C<path> name. Note that it returns false for
2184 other objects like files.
2186 See also C<guestfs_stat>.");
2188 ("pvcreate", (RErr, [Device "device"], []), 39, [Optional "lvm2"],
2189 [InitEmpty, Always, TestOutputListOfDevices (
2190 [["part_init"; "/dev/sda"; "mbr"];
2191 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2192 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2193 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2194 ["pvcreate"; "/dev/sda1"];
2195 ["pvcreate"; "/dev/sda2"];
2196 ["pvcreate"; "/dev/sda3"];
2197 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
2198 "create an LVM physical volume",
2200 This creates an LVM physical volume on the named C<device>,
2201 where C<device> should usually be a partition name such
2204 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"], []), 40, [Optional "lvm2"],
2205 [InitEmpty, Always, TestOutputList (
2206 [["part_init"; "/dev/sda"; "mbr"];
2207 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2208 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2209 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2210 ["pvcreate"; "/dev/sda1"];
2211 ["pvcreate"; "/dev/sda2"];
2212 ["pvcreate"; "/dev/sda3"];
2213 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2214 ["vgcreate"; "VG2"; "/dev/sda3"];
2215 ["vgs"]], ["VG1"; "VG2"])],
2216 "create an LVM volume group",
2218 This creates an LVM volume group called C<volgroup>
2219 from the non-empty list of physical volumes C<physvols>.");
2221 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"], []), 41, [Optional "lvm2"],
2222 [InitEmpty, Always, TestOutputList (
2223 [["part_init"; "/dev/sda"; "mbr"];
2224 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2225 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2226 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2227 ["pvcreate"; "/dev/sda1"];
2228 ["pvcreate"; "/dev/sda2"];
2229 ["pvcreate"; "/dev/sda3"];
2230 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
2231 ["vgcreate"; "VG2"; "/dev/sda3"];
2232 ["lvcreate"; "LV1"; "VG1"; "50"];
2233 ["lvcreate"; "LV2"; "VG1"; "50"];
2234 ["lvcreate"; "LV3"; "VG2"; "50"];
2235 ["lvcreate"; "LV4"; "VG2"; "50"];
2236 ["lvcreate"; "LV5"; "VG2"; "50"];
2238 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
2239 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
2240 "create an LVM logical volume",
2242 This creates an LVM logical volume called C<logvol>
2243 on the volume group C<volgroup>, with C<size> megabytes.");
2245 ("mkfs", (RErr, [String "fstype"; Device "device"], []), 42, [],
2246 [InitEmpty, Always, TestOutput (
2247 [["part_disk"; "/dev/sda"; "mbr"];
2248 ["mkfs"; "ext2"; "/dev/sda1"];
2249 ["mount_options"; ""; "/dev/sda1"; "/"];
2250 ["write"; "/new"; "new file contents"];
2251 ["cat"; "/new"]], "new file contents")],
2252 "make a filesystem",
2254 This creates a filesystem on C<device> (usually a partition
2255 or LVM logical volume). The filesystem type is C<fstype>, for
2258 ("sfdisk", (RErr, [Device "device";
2259 Int "cyls"; Int "heads"; Int "sectors";
2260 StringList "lines"], []), 43, [DeprecatedBy "part_add"],
2262 "create partitions on a block device",
2264 This is a direct interface to the L<sfdisk(8)> program for creating
2265 partitions on block devices.
2267 C<device> should be a block device, for example C</dev/sda>.
2269 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
2270 and sectors on the device, which are passed directly to sfdisk as
2271 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
2272 of these, then the corresponding parameter is omitted. Usually for
2273 'large' disks, you can just pass C<0> for these, but for small
2274 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
2275 out the right geometry and you will need to tell it.
2277 C<lines> is a list of lines that we feed to C<sfdisk>. For more
2278 information refer to the L<sfdisk(8)> manpage.
2280 To create a single partition occupying the whole disk, you would
2281 pass C<lines> as a single element list, when the single element being
2282 the string C<,> (comma).
2284 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
2285 C<guestfs_part_init>");
2287 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"], []), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
2288 (* Regression test for RHBZ#597135. *)
2289 [InitScratchFS, Always, TestLastFail
2290 [["write_file"; "/write_file"; "abc"; "10000"]]],
2293 This call creates a file called C<path>. The contents of the
2294 file is the string C<content> (which can contain any 8 bit data),
2295 with length C<size>.
2297 As a special case, if C<size> is C<0>
2298 then the length is calculated using C<strlen> (so in this case
2299 the content cannot contain embedded ASCII NULs).
2301 I<NB.> Owing to a bug, writing content containing ASCII NUL
2302 characters does I<not> work, even if the length is specified.");
2304 ("umount", (RErr, [String "pathordevice"], []), 45, [FishAlias "unmount"],
2305 [InitEmpty, Always, TestOutputListOfDevices (
2306 [["part_disk"; "/dev/sda"; "mbr"];
2307 ["mkfs"; "ext2"; "/dev/sda1"];
2308 ["mount_options"; ""; "/dev/sda1"; "/"];
2309 ["mounts"]], ["/dev/sda1"]);
2310 InitEmpty, Always, TestOutputList (
2311 [["part_disk"; "/dev/sda"; "mbr"];
2312 ["mkfs"; "ext2"; "/dev/sda1"];
2313 ["mount_options"; ""; "/dev/sda1"; "/"];
2316 "unmount a filesystem",
2318 This unmounts the given filesystem. The filesystem may be
2319 specified either by its mountpoint (path) or the device which
2320 contains the filesystem.");
2322 ("mounts", (RStringList "devices", [], []), 46, [],
2323 [InitScratchFS, Always, TestOutputListOfDevices (
2324 [["mounts"]], ["/dev/sdb1"])],
2325 "show mounted filesystems",
2327 This returns the list of currently mounted filesystems. It returns
2328 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
2330 Some internal mounts are not shown.
2332 See also: C<guestfs_mountpoints>");
2334 ("umount_all", (RErr, [], []), 47, [FishAlias "unmount-all"],
2335 [InitScratchFS, Always, TestOutputList (
2338 (* check that umount_all can unmount nested mounts correctly: *)
2339 InitEmpty, Always, TestOutputList (
2340 [["part_init"; "/dev/sda"; "mbr"];
2341 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
2342 ["part_add"; "/dev/sda"; "p"; "204800"; "409599"];
2343 ["part_add"; "/dev/sda"; "p"; "409600"; "-64"];
2344 ["mkfs"; "ext2"; "/dev/sda1"];
2345 ["mkfs"; "ext2"; "/dev/sda2"];
2346 ["mkfs"; "ext2"; "/dev/sda3"];
2347 ["mount_options"; ""; "/dev/sda1"; "/"];
2349 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
2350 ["mkdir"; "/mp1/mp2"];
2351 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
2352 ["mkdir"; "/mp1/mp2/mp3"];
2355 "unmount all filesystems",
2357 This unmounts all mounted filesystems.
2359 Some internal mounts are not unmounted by this call.");
2361 ("lvm_remove_all", (RErr, [], []), 48, [Optional "lvm2"],
2363 "remove all LVM LVs, VGs and PVs",
2365 This command removes all LVM logical volumes, volume groups
2366 and physical volumes.");
2368 ("file", (RString "description", [Dev_or_Path "path"], []), 49, [],
2369 [InitISOFS, Always, TestOutput (
2370 [["file"; "/empty"]], "empty");
2371 InitISOFS, Always, TestOutput (
2372 [["file"; "/known-1"]], "ASCII text");
2373 InitISOFS, Always, TestLastFail (
2374 [["file"; "/notexists"]]);
2375 InitISOFS, Always, TestOutput (
2376 [["file"; "/abssymlink"]], "symbolic link");
2377 InitISOFS, Always, TestOutput (
2378 [["file"; "/directory"]], "directory")],
2379 "determine file type",
2381 This call uses the standard L<file(1)> command to determine
2382 the type or contents of the file.
2384 This call will also transparently look inside various types
2387 The exact command which runs is C<file -zb path>. Note in
2388 particular that the filename is not prepended to the output
2391 The output depends on the output of the underlying L<file(1)>
2392 command and it can change in future in ways beyond our control.
2393 In other words, the output is not guaranteed by the ABI.
2395 See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>,
2396 C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>.");
2398 ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning],
2399 [InitScratchFS, Always, TestOutput (
2400 [["mkdir"; "/command"];
2401 ["upload"; "test-command"; "/command/test-command"];
2402 ["chmod"; "0o755"; "/command/test-command"];
2403 ["command"; "/command/test-command 1"]], "Result1");
2404 InitScratchFS, Always, TestOutput (
2405 [["mkdir"; "/command2"];
2406 ["upload"; "test-command"; "/command2/test-command"];
2407 ["chmod"; "0o755"; "/command2/test-command"];
2408 ["command"; "/command2/test-command 2"]], "Result2\n");
2409 InitScratchFS, Always, TestOutput (
2410 [["mkdir"; "/command3"];
2411 ["upload"; "test-command"; "/command3/test-command"];
2412 ["chmod"; "0o755"; "/command3/test-command"];
2413 ["command"; "/command3/test-command 3"]], "\nResult3");
2414 InitScratchFS, Always, TestOutput (
2415 [["mkdir"; "/command4"];
2416 ["upload"; "test-command"; "/command4/test-command"];
2417 ["chmod"; "0o755"; "/command4/test-command"];
2418 ["command"; "/command4/test-command 4"]], "\nResult4\n");
2419 InitScratchFS, Always, TestOutput (
2420 [["mkdir"; "/command5"];
2421 ["upload"; "test-command"; "/command5/test-command"];
2422 ["chmod"; "0o755"; "/command5/test-command"];
2423 ["command"; "/command5/test-command 5"]], "\nResult5\n\n");
2424 InitScratchFS, Always, TestOutput (
2425 [["mkdir"; "/command6"];
2426 ["upload"; "test-command"; "/command6/test-command"];
2427 ["chmod"; "0o755"; "/command6/test-command"];
2428 ["command"; "/command6/test-command 6"]], "\n\nResult6\n\n");
2429 InitScratchFS, Always, TestOutput (
2430 [["mkdir"; "/command7"];
2431 ["upload"; "test-command"; "/command7/test-command"];
2432 ["chmod"; "0o755"; "/command7/test-command"];
2433 ["command"; "/command7/test-command 7"]], "");
2434 InitScratchFS, Always, TestOutput (
2435 [["mkdir"; "/command8"];
2436 ["upload"; "test-command"; "/command8/test-command"];
2437 ["chmod"; "0o755"; "/command8/test-command"];
2438 ["command"; "/command8/test-command 8"]], "\n");
2439 InitScratchFS, Always, TestOutput (
2440 [["mkdir"; "/command9"];
2441 ["upload"; "test-command"; "/command9/test-command"];
2442 ["chmod"; "0o755"; "/command9/test-command"];
2443 ["command"; "/command9/test-command 9"]], "\n\n");
2444 InitScratchFS, Always, TestOutput (
2445 [["mkdir"; "/command10"];
2446 ["upload"; "test-command"; "/command10/test-command"];
2447 ["chmod"; "0o755"; "/command10/test-command"];
2448 ["command"; "/command10/test-command 10"]], "Result10-1\nResult10-2\n");
2449 InitScratchFS, Always, TestOutput (
2450 [["mkdir"; "/command11"];
2451 ["upload"; "test-command"; "/command11/test-command"];
2452 ["chmod"; "0o755"; "/command11/test-command"];
2453 ["command"; "/command11/test-command 11"]], "Result11-1\nResult11-2");
2454 InitScratchFS, Always, TestLastFail (
2455 [["mkdir"; "/command12"];
2456 ["upload"; "test-command"; "/command12/test-command"];
2457 ["chmod"; "0o755"; "/command12/test-command"];
2458 ["command"; "/command12/test-command"]])],
2459 "run a command from the guest filesystem",
2461 This call runs a command from the guest filesystem. The
2462 filesystem must be mounted, and must contain a compatible
2463 operating system (ie. something Linux, with the same
2464 or compatible processor architecture).
2466 The single parameter is an argv-style list of arguments.
2467 The first element is the name of the program to run.
2468 Subsequent elements are parameters. The list must be
2469 non-empty (ie. must contain a program name). Note that
2470 the command runs directly, and is I<not> invoked via
2471 the shell (see C<guestfs_sh>).
2473 The return value is anything printed to I<stdout> by
2476 If the command returns a non-zero exit status, then
2477 this function returns an error message. The error message
2478 string is the content of I<stderr> from the command.
2480 The C<$PATH> environment variable will contain at least
2481 C</usr/bin> and C</bin>. If you require a program from
2482 another location, you should provide the full path in the
2485 Shared libraries and data files required by the program
2486 must be available on filesystems which are mounted in the
2487 correct places. It is the caller's responsibility to ensure
2488 all filesystems that are needed are mounted at the right
2491 ("command_lines", (RStringList "lines", [StringList "arguments"], []), 51, [ProtocolLimitWarning],
2492 [InitScratchFS, Always, TestOutputList (
2493 [["mkdir"; "/command_lines"];
2494 ["upload"; "test-command"; "/command_lines/test-command"];
2495 ["chmod"; "0o755"; "/command_lines/test-command"];
2496 ["command_lines"; "/command_lines/test-command 1"]], ["Result1"]);
2497 InitScratchFS, Always, TestOutputList (
2498 [["mkdir"; "/command_lines2"];
2499 ["upload"; "test-command"; "/command_lines2/test-command"];
2500 ["chmod"; "0o755"; "/command_lines2/test-command"];
2501 ["command_lines"; "/command_lines2/test-command 2"]], ["Result2"]);
2502 InitScratchFS, Always, TestOutputList (
2503 [["mkdir"; "/command_lines3"];
2504 ["upload"; "test-command"; "/command_lines3/test-command"];
2505 ["chmod"; "0o755"; "/command_lines3/test-command"];
2506 ["command_lines"; "/command_lines3/test-command 3"]], ["";"Result3"]);
2507 InitScratchFS, Always, TestOutputList (
2508 [["mkdir"; "/command_lines4"];
2509 ["upload"; "test-command"; "/command_lines4/test-command"];
2510 ["chmod"; "0o755"; "/command_lines4/test-command"];
2511 ["command_lines"; "/command_lines4/test-command 4"]], ["";"Result4"]);
2512 InitScratchFS, Always, TestOutputList (
2513 [["mkdir"; "/command_lines5"];
2514 ["upload"; "test-command"; "/command_lines5/test-command"];
2515 ["chmod"; "0o755"; "/command_lines5/test-command"];
2516 ["command_lines"; "/command_lines5/test-command 5"]], ["";"Result5";""]);
2517 InitScratchFS, Always, TestOutputList (
2518 [["mkdir"; "/command_lines6"];
2519 ["upload"; "test-command"; "/command_lines6/test-command"];
2520 ["chmod"; "0o755"; "/command_lines6/test-command"];
2521 ["command_lines"; "/command_lines6/test-command 6"]], ["";"";"Result6";""]);
2522 InitScratchFS, Always, TestOutputList (
2523 [["mkdir"; "/command_lines7"];
2524 ["upload"; "test-command"; "/command_lines7/test-command"];
2525 ["chmod"; "0o755"; "/command_lines7/test-command"];
2526 ["command_lines"; "/command_lines7/test-command 7"]], []);
2527 InitScratchFS, Always, TestOutputList (
2528 [["mkdir"; "/command_lines8"];
2529 ["upload"; "test-command"; "/command_lines8/test-command"];
2530 ["chmod"; "0o755"; "/command_lines8/test-command"];
2531 ["command_lines"; "/command_lines8/test-command 8"]], [""]);
2532 InitScratchFS, Always, TestOutputList (
2533 [["mkdir"; "/command_lines9"];
2534 ["upload"; "test-command"; "/command_lines9/test-command"];
2535 ["chmod"; "0o755"; "/command_lines9/test-command"];
2536 ["command_lines"; "/command_lines9/test-command 9"]], ["";""]);
2537 InitScratchFS, Always, TestOutputList (
2538 [["mkdir"; "/command_lines10"];
2539 ["upload"; "test-command"; "/command_lines10/test-command"];
2540 ["chmod"; "0o755"; "/command_lines10/test-command"];
2541 ["command_lines"; "/command_lines10/test-command 10"]], ["Result10-1";"Result10-2"]);
2542 InitScratchFS, Always, TestOutputList (
2543 [["mkdir"; "/command_lines11"];
2544 ["upload"; "test-command"; "/command_lines11/test-command"];
2545 ["chmod"; "0o755"; "/command_lines11/test-command"];
2546 ["command_lines"; "/command_lines11/test-command 11"]], ["Result11-1";"Result11-2"])],
2547 "run a command, returning lines",
2549 This is the same as C<guestfs_command>, but splits the
2550 result into a list of lines.
2552 See also: C<guestfs_sh_lines>");
2554 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 52, [],
2555 [InitISOFS, Always, TestOutputStruct (
2556 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2557 "get file information",
2559 Returns file information for the given C<path>.
2561 This is the same as the C<stat(2)> system call.");
2563 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"], []), 53, [],
2564 [InitISOFS, Always, TestOutputStruct (
2565 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2566 "get file information for a symbolic link",
2568 Returns file information for the given C<path>.
2570 This is the same as C<guestfs_stat> except that if C<path>
2571 is a symbolic link, then the link is stat-ed, not the file it
2574 This is the same as the C<lstat(2)> system call.");
2576 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"], []), 54, [],
2577 [InitISOFS, Always, TestOutputStruct (
2578 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2579 "get file system statistics",
2581 Returns file system statistics for any mounted file system.
2582 C<path> should be a file or directory in the mounted file system
2583 (typically it is the mount point itself, but it doesn't need to be).
2585 This is the same as the C<statvfs(2)> system call.");
2587 ("tune2fs_l", (RHashtable "superblock", [Device "device"], []), 55, [],
2589 "get ext2/ext3/ext4 superblock details",
2591 This returns the contents of the ext2, ext3 or ext4 filesystem
2592 superblock on C<device>.
2594 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2595 manpage for more details. The list of fields returned isn't
2596 clearly defined, and depends on both the version of C<tune2fs>
2597 that libguestfs was built against, and the filesystem itself.");
2599 ("blockdev_setro", (RErr, [Device "device"], []), 56, [],
2600 [InitEmpty, Always, TestOutputTrue (
2601 [["blockdev_setro"; "/dev/sda"];
2602 ["blockdev_getro"; "/dev/sda"]])],
2603 "set block device to read-only",
2605 Sets the block device named C<device> to read-only.
2607 This uses the L<blockdev(8)> command.");
2609 ("blockdev_setrw", (RErr, [Device "device"], []), 57, [],
2610 [InitEmpty, Always, TestOutputFalse (
2611 [["blockdev_setrw"; "/dev/sda"];
2612 ["blockdev_getro"; "/dev/sda"]])],
2613 "set block device to read-write",
2615 Sets the block device named C<device> to read-write.
2617 This uses the L<blockdev(8)> command.");
2619 ("blockdev_getro", (RBool "ro", [Device "device"], []), 58, [],
2620 [InitEmpty, Always, TestOutputTrue (
2621 [["blockdev_setro"; "/dev/sda"];
2622 ["blockdev_getro"; "/dev/sda"]])],
2623 "is block device set to read-only",
2625 Returns a boolean indicating if the block device is read-only
2626 (true if read-only, false if not).
2628 This uses the L<blockdev(8)> command.");
2630 ("blockdev_getss", (RInt "sectorsize", [Device "device"], []), 59, [],
2631 [InitEmpty, Always, TestOutputInt (
2632 [["blockdev_getss"; "/dev/sda"]], 512)],
2633 "get sectorsize of block device",
2635 This returns the size of sectors on a block device.
2636 Usually 512, but can be larger for modern devices.
2638 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2641 This uses the L<blockdev(8)> command.");
2643 ("blockdev_getbsz", (RInt "blocksize", [Device "device"], []), 60, [],
2644 [InitEmpty, Always, TestOutputInt (
2645 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2646 "get blocksize of block device",
2648 This returns the block size of a device.
2650 (Note this is different from both I<size in blocks> and
2651 I<filesystem block size>).
2653 This uses the L<blockdev(8)> command.");
2655 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"], []), 61, [],
2657 "set blocksize of block device",
2659 This sets the block size of a device.
2661 (Note this is different from both I<size in blocks> and
2662 I<filesystem block size>).
2664 This uses the L<blockdev(8)> command.");
2666 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"], []), 62, [],
2667 [InitEmpty, Always, TestOutputInt (
2668 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2669 "get total size of device in 512-byte sectors",
2671 This returns the size of the device in units of 512-byte sectors
2672 (even if the sectorsize isn't 512 bytes ... weird).
2674 See also C<guestfs_blockdev_getss> for the real sector size of
2675 the device, and C<guestfs_blockdev_getsize64> for the more
2676 useful I<size in bytes>.
2678 This uses the L<blockdev(8)> command.");
2680 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"], []), 63, [],
2681 [InitEmpty, Always, TestOutputInt (
2682 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2683 "get total size of device in bytes",
2685 This returns the size of the device in bytes.
2687 See also C<guestfs_blockdev_getsz>.
2689 This uses the L<blockdev(8)> command.");
2691 ("blockdev_flushbufs", (RErr, [Device "device"], []), 64, [],
2692 [InitEmpty, Always, TestRun
2693 [["blockdev_flushbufs"; "/dev/sda"]]],
2694 "flush device buffers",
2696 This tells the kernel to flush internal buffers associated
2699 This uses the L<blockdev(8)> command.");
2701 ("blockdev_rereadpt", (RErr, [Device "device"], []), 65, [],
2702 [InitEmpty, Always, TestRun
2703 [["blockdev_rereadpt"; "/dev/sda"]]],
2704 "reread partition table",
2706 Reread the partition table on C<device>.
2708 This uses the L<blockdev(8)> command.");
2710 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"], []), 66, [Progress],
2711 [InitScratchFS, Always, TestOutput (
2712 (* Pick a file from cwd which isn't likely to change. *)
2713 [["mkdir"; "/upload"];
2714 ["upload"; "../COPYING.LIB"; "/upload/COPYING.LIB"];
2715 ["checksum"; "md5"; "/upload/COPYING.LIB"]],
2716 Digest.to_hex (Digest.file "COPYING.LIB"))],
2717 "upload a file from the local machine",
2719 Upload local file C<filename> to C<remotefilename> on the
2722 C<filename> can also be a named pipe.
2724 See also C<guestfs_download>.");
2726 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"], []), 67, [Progress],
2727 [InitScratchFS, Always, TestOutput (
2728 (* Pick a file from cwd which isn't likely to change. *)
2729 [["mkdir"; "/download"];
2730 ["upload"; "../COPYING.LIB"; "/download/COPYING.LIB"];
2731 ["download"; "/download/COPYING.LIB"; "testdownload.tmp"];
2732 ["upload"; "testdownload.tmp"; "/download/upload"];
2733 ["checksum"; "md5"; "/download/upload"]],
2734 Digest.to_hex (Digest.file "COPYING.LIB"))],
2735 "download a file to the local machine",
2737 Download file C<remotefilename> and save it as C<filename>
2738 on the local machine.
2740 C<filename> can also be a named pipe.
2742 See also C<guestfs_upload>, C<guestfs_cat>.");
2744 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"], []), 68, [],
2745 [InitISOFS, Always, TestOutput (
2746 [["checksum"; "crc"; "/known-3"]], "2891671662");
2747 InitISOFS, Always, TestLastFail (
2748 [["checksum"; "crc"; "/notexists"]]);
2749 InitISOFS, Always, TestOutput (
2750 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2751 InitISOFS, Always, TestOutput (
2752 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2753 InitISOFS, Always, TestOutput (
2754 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2755 InitISOFS, Always, TestOutput (
2756 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2757 InitISOFS, Always, TestOutput (
2758 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2759 InitISOFS, Always, TestOutput (
2760 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2761 (* Test for RHBZ#579608, absolute symbolic links. *)
2762 InitISOFS, Always, TestOutput (
2763 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2764 "compute MD5, SHAx or CRC checksum of file",
2766 This call computes the MD5, SHAx or CRC checksum of the
2769 The type of checksum to compute is given by the C<csumtype>
2770 parameter which must have one of the following values:
2776 Compute the cyclic redundancy check (CRC) specified by POSIX
2777 for the C<cksum> command.
2781 Compute the MD5 hash (using the C<md5sum> program).
2785 Compute the SHA1 hash (using the C<sha1sum> program).
2789 Compute the SHA224 hash (using the C<sha224sum> program).
2793 Compute the SHA256 hash (using the C<sha256sum> program).
2797 Compute the SHA384 hash (using the C<sha384sum> program).
2801 Compute the SHA512 hash (using the C<sha512sum> program).
2805 The checksum is returned as a printable string.
2807 To get the checksum for a device, use C<guestfs_checksum_device>.
2809 To get the checksums for many files, use C<guestfs_checksums_out>.");
2811 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"], []), 69, [],
2812 [InitScratchFS, Always, TestOutput (
2813 [["mkdir"; "/tar_in"];
2814 ["tar_in"; "../images/helloworld.tar"; "/tar_in"];
2815 ["cat"; "/tar_in/hello"]], "hello\n")],
2816 "unpack tarfile to directory",
2818 This command uploads and unpacks local file C<tarfile> (an
2819 I<uncompressed> tar file) into C<directory>.
2821 To upload a compressed tarball, use C<guestfs_tgz_in>
2822 or C<guestfs_txz_in>.");
2824 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"], []), 70, [],
2826 "pack directory into tarfile",
2828 This command packs the contents of C<directory> and downloads
2829 it to local file C<tarfile>.
2831 To download a compressed tarball, use C<guestfs_tgz_out>
2832 or C<guestfs_txz_out>.");
2834 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 71, [],
2835 [InitScratchFS, Always, TestOutput (
2836 [["mkdir"; "/tgz_in"];
2837 ["tgz_in"; "../images/helloworld.tar.gz"; "/tgz_in"];
2838 ["cat"; "/tgz_in/hello"]], "hello\n")],
2839 "unpack compressed tarball to directory",
2841 This command uploads and unpacks local file C<tarball> (a
2842 I<gzip compressed> tar file) into C<directory>.
2844 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2846 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 72, [],
2848 "pack directory into compressed tarball",
2850 This command packs the contents of C<directory> and downloads
2851 it to local file C<tarball>.
2853 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2855 ("mount_ro", (RErr, [Device "device"; String "mountpoint"], []), 73, [],
2856 [InitBasicFS, Always, TestLastFail (
2858 ["mount_ro"; "/dev/sda1"; "/"];
2859 ["touch"; "/new"]]);
2860 InitBasicFS, Always, TestOutput (
2861 [["write"; "/new"; "data"];
2863 ["mount_ro"; "/dev/sda1"; "/"];
2864 ["cat"; "/new"]], "data")],
2865 "mount a guest disk, read-only",
2867 This is the same as the C<guestfs_mount> command, but it
2868 mounts the filesystem with the read-only (I<-o ro>) flag.");
2870 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"], []), 74, [],
2872 "mount a guest disk with mount options",
2874 This is the same as the C<guestfs_mount> command, but it
2875 allows you to set the mount options as for the
2876 L<mount(8)> I<-o> flag.
2878 If the C<options> parameter is an empty string, then
2879 no options are passed (all options default to whatever
2880 the filesystem uses).");
2882 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"], []), 75, [],
2884 "mount a guest disk with mount options and vfstype",
2886 This is the same as the C<guestfs_mount> command, but it
2887 allows you to set both the mount options and the vfstype
2888 as for the L<mount(8)> I<-o> and I<-t> flags.");
2890 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"], []), 76, [NotInDocs],
2892 "debugging and internals",
2894 The C<guestfs_debug> command exposes some internals of
2895 C<guestfsd> (the guestfs daemon) that runs inside the
2898 There is no comprehensive help for this command. You have
2899 to look at the file C<daemon/debug.c> in the libguestfs source
2900 to find out what you can do.");
2902 ("lvremove", (RErr, [Device "device"], []), 77, [Optional "lvm2"],
2903 [InitEmpty, Always, TestOutputList (
2904 [["part_disk"; "/dev/sda"; "mbr"];
2905 ["pvcreate"; "/dev/sda1"];
2906 ["vgcreate"; "VG"; "/dev/sda1"];
2907 ["lvcreate"; "LV1"; "VG"; "50"];
2908 ["lvcreate"; "LV2"; "VG"; "50"];
2909 ["lvremove"; "/dev/VG/LV1"];
2910 ["lvs"]], ["/dev/VG/LV2"]);
2911 InitEmpty, Always, TestOutputList (
2912 [["part_disk"; "/dev/sda"; "mbr"];
2913 ["pvcreate"; "/dev/sda1"];
2914 ["vgcreate"; "VG"; "/dev/sda1"];
2915 ["lvcreate"; "LV1"; "VG"; "50"];
2916 ["lvcreate"; "LV2"; "VG"; "50"];
2917 ["lvremove"; "/dev/VG"];
2919 InitEmpty, Always, TestOutputList (
2920 [["part_disk"; "/dev/sda"; "mbr"];
2921 ["pvcreate"; "/dev/sda1"];
2922 ["vgcreate"; "VG"; "/dev/sda1"];
2923 ["lvcreate"; "LV1"; "VG"; "50"];
2924 ["lvcreate"; "LV2"; "VG"; "50"];
2925 ["lvremove"; "/dev/VG"];
2927 "remove an LVM logical volume",
2929 Remove an LVM logical volume C<device>, where C<device> is
2930 the path to the LV, such as C</dev/VG/LV>.
2932 You can also remove all LVs in a volume group by specifying
2933 the VG name, C</dev/VG>.");
2935 ("vgremove", (RErr, [String "vgname"], []), 78, [Optional "lvm2"],
2936 [InitEmpty, Always, TestOutputList (
2937 [["part_disk"; "/dev/sda"; "mbr"];
2938 ["pvcreate"; "/dev/sda1"];
2939 ["vgcreate"; "VG"; "/dev/sda1"];
2940 ["lvcreate"; "LV1"; "VG"; "50"];
2941 ["lvcreate"; "LV2"; "VG"; "50"];
2944 InitEmpty, Always, TestOutputList (
2945 [["part_disk"; "/dev/sda"; "mbr"];
2946 ["pvcreate"; "/dev/sda1"];
2947 ["vgcreate"; "VG"; "/dev/sda1"];
2948 ["lvcreate"; "LV1"; "VG"; "50"];
2949 ["lvcreate"; "LV2"; "VG"; "50"];
2952 "remove an LVM volume group",
2954 Remove an LVM volume group C<vgname>, (for example C<VG>).
2956 This also forcibly removes all logical volumes in the volume
2959 ("pvremove", (RErr, [Device "device"], []), 79, [Optional "lvm2"],
2960 [InitEmpty, Always, TestOutputListOfDevices (
2961 [["part_disk"; "/dev/sda"; "mbr"];
2962 ["pvcreate"; "/dev/sda1"];
2963 ["vgcreate"; "VG"; "/dev/sda1"];
2964 ["lvcreate"; "LV1"; "VG"; "50"];
2965 ["lvcreate"; "LV2"; "VG"; "50"];
2967 ["pvremove"; "/dev/sda1"];
2969 InitEmpty, Always, TestOutputListOfDevices (
2970 [["part_disk"; "/dev/sda"; "mbr"];
2971 ["pvcreate"; "/dev/sda1"];
2972 ["vgcreate"; "VG"; "/dev/sda1"];
2973 ["lvcreate"; "LV1"; "VG"; "50"];
2974 ["lvcreate"; "LV2"; "VG"; "50"];
2976 ["pvremove"; "/dev/sda1"];
2978 InitEmpty, Always, TestOutputListOfDevices (
2979 [["part_disk"; "/dev/sda"; "mbr"];
2980 ["pvcreate"; "/dev/sda1"];
2981 ["vgcreate"; "VG"; "/dev/sda1"];
2982 ["lvcreate"; "LV1"; "VG"; "50"];
2983 ["lvcreate"; "LV2"; "VG"; "50"];
2985 ["pvremove"; "/dev/sda1"];
2987 "remove an LVM physical volume",
2989 This wipes a physical volume C<device> so that LVM will no longer
2992 The implementation uses the C<pvremove> command which refuses to
2993 wipe physical volumes that contain any volume groups, so you have
2994 to remove those first.");
2996 ("set_e2label", (RErr, [Device "device"; String "label"], []), 80, [],
2997 [InitBasicFS, Always, TestOutput (
2998 [["set_e2label"; "/dev/sda1"; "testlabel"];
2999 ["get_e2label"; "/dev/sda1"]], "testlabel")],
3000 "set the ext2/3/4 filesystem label",
3002 This sets the ext2/3/4 filesystem label of the filesystem on
3003 C<device> to C<label>. Filesystem labels are limited to
3006 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
3007 to return the existing label on a filesystem.");
3009 ("get_e2label", (RString "label", [Device "device"], []), 81, [DeprecatedBy "vfs_label"],
3011 "get the ext2/3/4 filesystem label",
3013 This returns the ext2/3/4 filesystem label of the filesystem on
3016 ("set_e2uuid", (RErr, [Device "device"; String "uuid"], []), 82, [],
3017 (let uuid = uuidgen () in
3018 [InitBasicFS, Always, TestOutput (
3019 [["set_e2uuid"; "/dev/sda1"; uuid];
3020 ["get_e2uuid"; "/dev/sda1"]], uuid);
3021 InitBasicFS, Always, TestOutput (
3022 [["set_e2uuid"; "/dev/sda1"; "clear"];
3023 ["get_e2uuid"; "/dev/sda1"]], "");
3024 (* We can't predict what UUIDs will be, so just check the commands run. *)
3025 InitBasicFS, Always, TestRun (
3026 [["set_e2uuid"; "/dev/sda1"; "random"]]);
3027 InitBasicFS, Always, TestRun (
3028 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
3029 "set the ext2/3/4 filesystem UUID",
3031 This sets the ext2/3/4 filesystem UUID of the filesystem on
3032 C<device> to C<uuid>. The format of the UUID and alternatives
3033 such as C<clear>, C<random> and C<time> are described in the
3034 L<tune2fs(8)> manpage.
3036 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
3037 to return the existing UUID of a filesystem.");
3039 ("get_e2uuid", (RString "uuid", [Device "device"], []), 83, [DeprecatedBy "vfs_uuid"],
3040 (* Regression test for RHBZ#597112. *)
3041 (let uuid = uuidgen () in
3042 [InitNone, Always, TestOutput (
3043 [["mke2journal"; "1024"; "/dev/sdc"];
3044 ["set_e2uuid"; "/dev/sdc"; uuid];
3045 ["get_e2uuid"; "/dev/sdc"]], uuid)]),
3046 "get the ext2/3/4 filesystem UUID",
3048 This returns the ext2/3/4 filesystem UUID of the filesystem on
3051 ("fsck", (RInt "status", [String "fstype"; Device "device"], []), 84, [FishOutput FishOutputHexadecimal],
3052 [InitBasicFS, Always, TestOutputInt (
3053 [["umount"; "/dev/sda1"];
3054 ["fsck"; "ext2"; "/dev/sda1"]], 0);
3055 InitBasicFS, Always, TestOutputInt (
3056 [["umount"; "/dev/sda1"];
3057 ["zero"; "/dev/sda1"];
3058 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
3059 "run the filesystem checker",
3061 This runs the filesystem checker (fsck) on C<device> which
3062 should have filesystem type C<fstype>.
3064 The returned integer is the status. See L<fsck(8)> for the
3065 list of status codes from C<fsck>.
3073 Multiple status codes can be summed together.
3077 A non-zero return code can mean \"success\", for example if
3078 errors have been corrected on the filesystem.
3082 Checking or repairing NTFS volumes is not supported
3087 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
3089 ("zero", (RErr, [Device "device"], []), 85, [Progress],
3090 [InitBasicFS, Always, TestRun (
3091 [["umount"; "/dev/sda1"];
3092 ["zero"; "/dev/sda1"]])],
3093 "write zeroes to the device",
3095 This command writes zeroes over the first few blocks of C<device>.
3097 How many blocks are zeroed isn't specified (but it's I<not> enough
3098 to securely wipe the device). It should be sufficient to remove
3099 any partition tables, filesystem superblocks and so on.
3101 If blocks are already zero, then this command avoids writing
3102 zeroes. This prevents the underlying device from becoming non-sparse
3103 or growing unnecessarily.
3105 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>,
3106 C<guestfs_is_zero_device>");
3108 ("grub_install", (RErr, [Pathname "root"; Device "device"], []), 86, [Optional "grub"],
3110 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
3111 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
3113 [InitBasicFS, Always, TestOutputTrue (
3114 [["mkdir_p"; "/boot/grub"];
3115 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
3116 ["grub_install"; "/"; "/dev/vda"];
3117 ["is_dir"; "/boot"]])],
3120 This command installs GRUB 1 (the Grand Unified Bootloader) on
3121 C<device>, with the root directory being C<root>.
3129 There is currently no way in the API to install grub2, which
3130 is used by most modern Linux guests. It is possible to run
3131 the grub2 command from the guest, although see the
3132 caveats in L<guestfs(3)/RUNNING COMMANDS>.
3136 This uses C<grub-install> from the host. Unfortunately grub is
3137 not always compatible with itself, so this only works in rather
3138 narrow circumstances. Careful testing with each guest version
3143 If grub-install reports the error
3144 \"No suitable drive was found in the generated device map.\"
3145 it may be that you need to create a C</boot/grub/device.map>
3146 file first that contains the mapping between grub device names
3147 and Linux device names. It is usually sufficient to create
3152 replacing C</dev/vda> with the name of the installation device.
3156 ("cp", (RErr, [Pathname "src"; Pathname "dest"], []), 87, [],
3157 [InitScratchFS, Always, TestOutput (
3159 ["write"; "/cp/old"; "file content"];
3160 ["cp"; "/cp/old"; "/cp/new"];
3161 ["cat"; "/cp/new"]], "file content");
3162 InitScratchFS, Always, TestOutputTrue (
3164 ["write"; "/cp2/old"; "file content"];
3165 ["cp"; "/cp2/old"; "/cp2/new"];
3166 ["is_file"; "/cp2/old"]]);
3167 InitScratchFS, Always, TestOutput (
3169 ["write"; "/cp3/old"; "file content"];
3170 ["mkdir"; "/cp3/dir"];
3171 ["cp"; "/cp3/old"; "/cp3/dir/new"];
3172 ["cat"; "/cp3/dir/new"]], "file content")],
3175 This copies a file from C<src> to C<dest> where C<dest> is
3176 either a destination filename or destination directory.");
3178 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"], []), 88, [],
3179 [InitScratchFS, Always, TestOutput (
3180 [["mkdir"; "/cp_a1"];
3181 ["mkdir"; "/cp_a2"];
3182 ["write"; "/cp_a1/file"; "file content"];
3183 ["cp_a"; "/cp_a1"; "/cp_a2"];
3184 ["cat"; "/cp_a2/cp_a1/file"]], "file content")],
3185 "copy a file or directory recursively",
3187 This copies a file or directory from C<src> to C<dest>
3188 recursively using the C<cp -a> command.");
3190 ("mv", (RErr, [Pathname "src"; Pathname "dest"], []), 89, [],
3191 [InitScratchFS, Always, TestOutput (
3193 ["write"; "/mv/old"; "file content"];
3194 ["mv"; "/mv/old"; "/mv/new"];
3195 ["cat"; "/mv/new"]], "file content");
3196 InitScratchFS, Always, TestOutputFalse (
3198 ["write"; "/mv2/old"; "file content"];
3199 ["mv"; "/mv2/old"; "/mv2/new"];
3200 ["is_file"; "/mv2/old"]])],
3203 This moves a file from C<src> to C<dest> where C<dest> is
3204 either a destination filename or destination directory.");
3206 ("drop_caches", (RErr, [Int "whattodrop"], []), 90, [],
3207 [InitEmpty, Always, TestRun (
3208 [["drop_caches"; "3"]])],
3209 "drop kernel page cache, dentries and inodes",
3211 This instructs the guest kernel to drop its page cache,
3212 and/or dentries and inode caches. The parameter C<whattodrop>
3213 tells the kernel what precisely to drop, see
3214 L<http://linux-mm.org/Drop_Caches>
3216 Setting C<whattodrop> to 3 should drop everything.
3218 This automatically calls L<sync(2)> before the operation,
3219 so that the maximum guest memory is freed.");
3221 ("dmesg", (RString "kmsgs", [], []), 91, [],
3222 [InitEmpty, Always, TestRun (
3224 "return kernel messages",
3226 This returns the kernel messages (C<dmesg> output) from
3227 the guest kernel. This is sometimes useful for extended
3228 debugging of problems.
3230 Another way to get the same information is to enable
3231 verbose messages with C<guestfs_set_verbose> or by setting
3232 the environment variable C<LIBGUESTFS_DEBUG=1> before
3233 running the program.");
3235 ("ping_daemon", (RErr, [], []), 92, [],
3236 [InitEmpty, Always, TestRun (
3237 [["ping_daemon"]])],
3238 "ping the guest daemon",
3240 This is a test probe into the guestfs daemon running inside
3241 the qemu subprocess. Calling this function checks that the
3242 daemon responds to the ping message, without affecting the daemon
3243 or attached block device(s) in any other way.");
3245 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"], []), 93, [],
3246 [InitScratchFS, Always, TestOutputTrue (
3247 [["mkdir"; "/equal"];
3248 ["write"; "/equal/file1"; "contents of a file"];
3249 ["cp"; "/equal/file1"; "/equal/file2"];
3250 ["equal"; "/equal/file1"; "/equal/file2"]]);
3251 InitScratchFS, Always, TestOutputFalse (
3252 [["mkdir"; "/equal2"];
3253 ["write"; "/equal2/file1"; "contents of a file"];
3254 ["write"; "/equal2/file2"; "contents of another file"];
3255 ["equal"; "/equal2/file1"; "/equal2/file2"]]);
3256 InitScratchFS, Always, TestLastFail (
3257 [["mkdir"; "/equal3"];
3258 ["equal"; "/equal3/file1"; "/equal3/file2"]])],
3259 "test if two files have equal contents",
3261 This compares the two files C<file1> and C<file2> and returns
3262 true if their content is exactly equal, or false otherwise.
3264 The external L<cmp(1)> program is used for the comparison.");
3266 ("strings", (RStringList "stringsout", [Pathname "path"], []), 94, [ProtocolLimitWarning],
3267 [InitISOFS, Always, TestOutputList (
3268 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
3269 InitISOFS, Always, TestOutputList (
3270 [["strings"; "/empty"]], []);
3271 (* Test for RHBZ#579608, absolute symbolic links. *)
3272 InitISOFS, Always, TestRun (
3273 [["strings"; "/abssymlink"]])],
3274 "print the printable strings in a file",
3276 This runs the L<strings(1)> command on a file and returns
3277 the list of printable strings found.");
3279 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"], []), 95, [ProtocolLimitWarning],
3280 [InitISOFS, Always, TestOutputList (
3281 [["strings_e"; "b"; "/known-5"]], []);
3282 InitScratchFS, Always, TestOutputList (
3283 [["write"; "/strings_e"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
3284 ["strings_e"; "b"; "/strings_e"]], ["hello"; "world"])],
3285 "print the printable strings in a file",
3287 This is like the C<guestfs_strings> command, but allows you to
3288 specify the encoding of strings that are looked for in
3289 the source file C<path>.
3291 Allowed encodings are:
3297 Single 7-bit-byte characters like ASCII and the ASCII-compatible
3298 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
3302 Single 8-bit-byte characters.
3306 16-bit big endian strings such as those encoded in
3307 UTF-16BE or UCS-2BE.
3309 =item l (lower case letter L)
3311 16-bit little endian such as UTF-16LE and UCS-2LE.
3312 This is useful for examining binaries in Windows guests.
3316 32-bit big endian such as UCS-4BE.
3320 32-bit little endian such as UCS-4LE.
3324 The returned strings are transcoded to UTF-8.");
3326 ("hexdump", (RString "dump", [Pathname "path"], []), 96, [ProtocolLimitWarning],
3327 [InitISOFS, Always, TestOutput (
3328 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
3329 (* Test for RHBZ#501888c2 regression which caused large hexdump
3330 * commands to segfault.
3332 InitISOFS, Always, TestRun (
3333 [["hexdump"; "/100krandom"]]);
3334 (* Test for RHBZ#579608, absolute symbolic links. *)
3335 InitISOFS, Always, TestRun (
3336 [["hexdump"; "/abssymlink"]])],
3337 "dump a file in hexadecimal",
3339 This runs C<hexdump -C> on the given C<path>. The result is
3340 the human-readable, canonical hex dump of the file.");
3342 ("zerofree", (RErr, [Device "device"], []), 97, [Optional "zerofree"],
3343 [InitNone, Always, TestOutput (
3344 [["part_disk"; "/dev/sda"; "mbr"];
3345 ["mkfs"; "ext3"; "/dev/sda1"];
3346 ["mount_options"; ""; "/dev/sda1"; "/"];
3347 ["write"; "/new"; "test file"];
3348 ["umount"; "/dev/sda1"];
3349 ["zerofree"; "/dev/sda1"];
3350 ["mount_options"; ""; "/dev/sda1"; "/"];
3351 ["cat"; "/new"]], "test file")],
3352 "zero unused inodes and disk blocks on ext2/3 filesystem",
3354 This runs the I<zerofree> program on C<device>. This program
3355 claims to zero unused inodes and disk blocks on an ext2/3
3356 filesystem, thus making it possible to compress the filesystem
3359 You should B<not> run this program if the filesystem is
3362 It is possible that using this program can damage the filesystem
3363 or data on the filesystem.");
3365 ("pvresize", (RErr, [Device "device"], []), 98, [Optional "lvm2"],
3367 "resize an LVM physical volume",
3369 This resizes (expands or shrinks) an existing LVM physical
3370 volume to match the new size of the underlying device.");
3372 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
3373 Int "cyls"; Int "heads"; Int "sectors";
3374 String "line"], []), 99, [DeprecatedBy "part_add"],
3376 "modify a single partition on a block device",
3378 This runs L<sfdisk(8)> option to modify just the single
3379 partition C<n> (note: C<n> counts from 1).
3381 For other parameters, see C<guestfs_sfdisk>. You should usually
3382 pass C<0> for the cyls/heads/sectors parameters.
3384 See also: C<guestfs_part_add>");
3386 ("sfdisk_l", (RString "partitions", [Device "device"], []), 100, [DeprecatedBy "part_list"],
3388 "display the partition table",
3390 This displays the partition table on C<device>, in the
3391 human-readable output of the L<sfdisk(8)> command. It is
3392 not intended to be parsed.
3394 See also: C<guestfs_part_list>");
3396 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"], []), 101, [],
3398 "display the kernel geometry",
3400 This displays the kernel's idea of the geometry of C<device>.
3402 The result is in human-readable format, and not designed to
3405 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"], []), 102, [],
3407 "display the disk geometry from the partition table",
3409 This displays the disk geometry of C<device> read from the
3410 partition table. Especially in the case where the underlying
3411 block device has been resized, this can be different from the
3412 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
3414 The result is in human-readable format, and not designed to
3417 ("vg_activate_all", (RErr, [Bool "activate"], []), 103, [Optional "lvm2"],
3419 "activate or deactivate all volume groups",
3421 This command activates or (if C<activate> is false) deactivates
3422 all logical volumes in all volume groups.
3424 This command is the same as running C<vgchange -a y|n>");
3426 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"], []), 104, [Optional "lvm2"],
3428 "activate or deactivate some volume groups",
3430 This command activates or (if C<activate> is false) deactivates
3431 all logical volumes in the listed volume groups C<volgroups>.
3433 This command is the same as running C<vgchange -a y|n volgroups...>
3435 Note that if C<volgroups> is an empty list then B<all> volume groups
3436 are activated or deactivated.");
3438 ("lvresize", (RErr, [Device "device"; Int "mbytes"], []), 105, [Optional "lvm2"],
3439 [InitNone, Always, TestOutput (
3440 [["part_disk"; "/dev/sda"; "mbr"];
3441 ["pvcreate"; "/dev/sda1"];
3442 ["vgcreate"; "VG"; "/dev/sda1"];
3443 ["lvcreate"; "LV"; "VG"; "10"];
3444 ["mkfs"; "ext2"; "/dev/VG/LV"];
3445 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3446 ["write"; "/new"; "test content"];
3448 ["lvresize"; "/dev/VG/LV"; "20"];
3449 ["e2fsck_f"; "/dev/VG/LV"];
3450 ["resize2fs"; "/dev/VG/LV"];
3451 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3452 ["cat"; "/new"]], "test content");
3453 InitNone, Always, TestRun (
3454 (* Make an LV smaller to test RHBZ#587484. *)
3455 [["part_disk"; "/dev/sda"; "mbr"];
3456 ["pvcreate"; "/dev/sda1"];
3457 ["vgcreate"; "VG"; "/dev/sda1"];
3458 ["lvcreate"; "LV"; "VG"; "20"];
3459 ["lvresize"; "/dev/VG/LV"; "10"]])],
3460 "resize an LVM logical volume",
3462 This resizes (expands or shrinks) an existing LVM logical
3463 volume to C<mbytes>. When reducing, data in the reduced part
3466 ("resize2fs", (RErr, [Device "device"], []), 106, [],
3467 [], (* lvresize tests this *)
3468 "resize an ext2, ext3 or ext4 filesystem",
3470 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3471 the underlying device.
3473 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3474 on the C<device> before calling this command. For unknown reasons
3475 C<resize2fs> sometimes gives an error about this and sometimes not.
3476 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3477 calling this function.");
3479 ("find", (RStringList "names", [Pathname "directory"], []), 107, [ProtocolLimitWarning],
3480 [InitBasicFS, Always, TestOutputList (
3481 [["find"; "/"]], ["lost+found"]);
3482 InitBasicFS, Always, TestOutputList (
3486 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3487 InitScratchFS, Always, TestOutputList (
3488 [["mkdir_p"; "/find/b/c"];
3489 ["touch"; "/find/b/c/d"];
3490 ["find"; "/find/b/"]], ["c"; "c/d"])],
3491 "find all files and directories",
3493 This command lists out all files and directories, recursively,
3494 starting at C<directory>. It is essentially equivalent to
3495 running the shell command C<find directory -print> but some
3496 post-processing happens on the output, described below.
3498 This returns a list of strings I<without any prefix>. Thus
3499 if the directory structure was:
3505 then the returned list from C<guestfs_find> C</tmp> would be
3513 If C<directory> is not a directory, then this command returns
3516 The returned list is sorted.
3518 See also C<guestfs_find0>.");
3520 ("e2fsck_f", (RErr, [Device "device"], []), 108, [],
3521 [], (* lvresize tests this *)
3522 "check an ext2/ext3 filesystem",
3524 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3525 filesystem checker on C<device>, noninteractively (I<-p>),
3526 even if the filesystem appears to be clean (I<-f>).
3528 This command is only needed because of C<guestfs_resize2fs>
3529 (q.v.). Normally you should use C<guestfs_fsck>.");
3531 ("sleep", (RErr, [Int "secs"], []), 109, [],
3532 [InitNone, Always, TestRun (
3534 "sleep for some seconds",
3536 Sleep for C<secs> seconds.");
3538 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"], []), 110, [Optional "ntfs3g"],
3539 [InitNone, Always, TestOutputInt (
3540 [["part_disk"; "/dev/sda"; "mbr"];
3541 ["mkfs"; "ntfs"; "/dev/sda1"];
3542 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3543 InitNone, Always, TestOutputInt (
3544 [["part_disk"; "/dev/sda"; "mbr"];
3545 ["mkfs"; "ext2"; "/dev/sda1"];
3546 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3547 "probe NTFS volume",
3549 This command runs the L<ntfs-3g.probe(8)> command which probes
3550 an NTFS C<device> for mountability. (Not all NTFS volumes can
3551 be mounted read-write, and some cannot be mounted at all).
3553 C<rw> is a boolean flag. Set it to true if you want to test
3554 if the volume can be mounted read-write. Set it to false if
3555 you want to test if the volume can be mounted read-only.
3557 The return value is an integer which C<0> if the operation
3558 would succeed, or some non-zero value documented in the
3559 L<ntfs-3g.probe(8)> manual page.");
3561 ("sh", (RString "output", [String "command"], []), 111, [],
3562 [], (* XXX needs tests *)
3563 "run a command via the shell",
3565 This call runs a command from the guest filesystem via the
3568 This is like C<guestfs_command>, but passes the command to:
3570 /bin/sh -c \"command\"
3572 Depending on the guest's shell, this usually results in
3573 wildcards being expanded, shell expressions being interpolated
3576 All the provisos about C<guestfs_command> apply to this call.");
3578 ("sh_lines", (RStringList "lines", [String "command"], []), 112, [],
3579 [], (* XXX needs tests *)
3580 "run a command via the shell returning lines",
3582 This is the same as C<guestfs_sh>, but splits the result
3583 into a list of lines.
3585 See also: C<guestfs_command_lines>");
3587 ("glob_expand", (RStringList "paths", [Pathname "pattern"], []), 113, [],
3588 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3589 * code in stubs.c, since all valid glob patterns must start with "/".
3590 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3592 [InitScratchFS, Always, TestOutputList (
3593 [["mkdir_p"; "/glob_expand/b/c"];
3594 ["touch"; "/glob_expand/b/c/d"];
3595 ["touch"; "/glob_expand/b/c/e"];
3596 ["glob_expand"; "/glob_expand/b/c/*"]], ["/glob_expand/b/c/d"; "/glob_expand/b/c/e"]);
3597 InitScratchFS, Always, TestOutputList (
3598 [["mkdir_p"; "/glob_expand2/b/c"];
3599 ["touch"; "/glob_expand2/b/c/d"];
3600 ["touch"; "/glob_expand2/b/c/e"];
3601 ["glob_expand"; "/glob_expand2/*/c/*"]], ["/glob_expand2/b/c/d"; "/glob_expand2/b/c/e"]);
3602 InitScratchFS, Always, TestOutputList (
3603 [["mkdir_p"; "/glob_expand3/b/c"];
3604 ["touch"; "/glob_expand3/b/c/d"];
3605 ["touch"; "/glob_expand3/b/c/e"];
3606 ["glob_expand"; "/glob_expand3/*/x/*"]], [])],
3607 "expand a wildcard path",
3609 This command searches for all the pathnames matching
3610 C<pattern> according to the wildcard expansion rules
3613 If no paths match, then this returns an empty list
3614 (note: not an error).
3616 It is just a wrapper around the C L<glob(3)> function
3617 with flags C<GLOB_MARK|GLOB_BRACE>.
3618 See that manual page for more details.");
3620 ("scrub_device", (RErr, [Device "device"], []), 114, [Optional "scrub"],
3621 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3622 [["scrub_device"; "/dev/sdc"]])],
3623 "scrub (securely wipe) a device",
3625 This command writes patterns over C<device> to make data retrieval
3628 It is an interface to the L<scrub(1)> program. See that
3629 manual page for more details.");
3631 ("scrub_file", (RErr, [Pathname "file"], []), 115, [Optional "scrub"],
3632 [InitScratchFS, Always, TestRun (
3633 [["write"; "/scrub_file"; "content"];
3634 ["scrub_file"; "/scrub_file"]])],
3635 "scrub (securely wipe) a file",
3637 This command writes patterns over a file to make data retrieval
3640 The file is I<removed> after scrubbing.
3642 It is an interface to the L<scrub(1)> program. See that
3643 manual page for more details.");
3645 ("scrub_freespace", (RErr, [Pathname "dir"], []), 116, [Optional "scrub"],
3646 [], (* XXX needs testing *)
3647 "scrub (securely wipe) free space",
3649 This command creates the directory C<dir> and then fills it
3650 with files until the filesystem is full, and scrubs the files
3651 as for C<guestfs_scrub_file>, and deletes them.
3652 The intention is to scrub any free space on the partition
3655 It is an interface to the L<scrub(1)> program. See that
3656 manual page for more details.");
3658 ("mkdtemp", (RString "dir", [Pathname "template"], []), 117, [],
3659 [InitScratchFS, Always, TestRun (
3660 [["mkdir"; "/mkdtemp"];
3661 ["mkdtemp"; "/mkdtemp/tmpXXXXXX"]])],
3662 "create a temporary directory",
3664 This command creates a temporary directory. The
3665 C<template> parameter should be a full pathname for the
3666 temporary directory name with the final six characters being
3669 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3670 the second one being suitable for Windows filesystems.
3672 The name of the temporary directory that was created
3675 The temporary directory is created with mode 0700
3676 and is owned by root.
3678 The caller is responsible for deleting the temporary
3679 directory and its contents after use.
3681 See also: L<mkdtemp(3)>");
3683 ("wc_l", (RInt "lines", [Pathname "path"], []), 118, [],
3684 [InitISOFS, Always, TestOutputInt (
3685 [["wc_l"; "/10klines"]], 10000);
3686 (* Test for RHBZ#579608, absolute symbolic links. *)
3687 InitISOFS, Always, TestOutputInt (
3688 [["wc_l"; "/abssymlink"]], 10000)],
3689 "count lines in a file",
3691 This command counts the lines in a file, using the
3692 C<wc -l> external command.");
3694 ("wc_w", (RInt "words", [Pathname "path"], []), 119, [],
3695 [InitISOFS, Always, TestOutputInt (
3696 [["wc_w"; "/10klines"]], 10000)],
3697 "count words in a file",
3699 This command counts the words in a file, using the
3700 C<wc -w> external command.");
3702 ("wc_c", (RInt "chars", [Pathname "path"], []), 120, [],
3703 [InitISOFS, Always, TestOutputInt (
3704 [["wc_c"; "/100kallspaces"]], 102400)],
3705 "count characters in a file",
3707 This command counts the characters in a file, using the
3708 C<wc -c> external command.");
3710 ("head", (RStringList "lines", [Pathname "path"], []), 121, [ProtocolLimitWarning],
3711 [InitISOFS, Always, TestOutputList (
3712 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3713 (* Test for RHBZ#579608, absolute symbolic links. *)
3714 InitISOFS, Always, TestOutputList (
3715 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3716 "return first 10 lines of a file",
3718 This command returns up to the first 10 lines of a file as
3719 a list of strings.");
3721 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 122, [ProtocolLimitWarning],
3722 [InitISOFS, Always, TestOutputList (
3723 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3724 InitISOFS, Always, TestOutputList (
3725 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3726 InitISOFS, Always, TestOutputList (
3727 [["head_n"; "0"; "/10klines"]], [])],
3728 "return first N lines of a file",
3730 If the parameter C<nrlines> is a positive number, this returns the first
3731 C<nrlines> lines of the file C<path>.
3733 If the parameter C<nrlines> is a negative number, this returns lines
3734 from the file C<path>, excluding the last C<nrlines> lines.
3736 If the parameter C<nrlines> is zero, this returns an empty list.");
3738 ("tail", (RStringList "lines", [Pathname "path"], []), 123, [ProtocolLimitWarning],
3739 [InitISOFS, Always, TestOutputList (
3740 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3741 "return last 10 lines of a file",
3743 This command returns up to the last 10 lines of a file as
3744 a list of strings.");
3746 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"], []), 124, [ProtocolLimitWarning],
3747 [InitISOFS, Always, TestOutputList (
3748 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3749 InitISOFS, Always, TestOutputList (
3750 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3751 InitISOFS, Always, TestOutputList (
3752 [["tail_n"; "0"; "/10klines"]], [])],
3753 "return last N lines of a file",
3755 If the parameter C<nrlines> is a positive number, this returns the last
3756 C<nrlines> lines of the file C<path>.
3758 If the parameter C<nrlines> is a negative number, this returns lines
3759 from the file C<path>, starting with the C<-nrlines>th line.
3761 If the parameter C<nrlines> is zero, this returns an empty list.");
3763 ("df", (RString "output", [], []), 125, [],
3764 [], (* XXX Tricky to test because it depends on the exact format
3765 * of the 'df' command and other imponderables.
3767 "report file system disk space usage",
3769 This command runs the C<df> command to report disk space used.
3771 This command is mostly useful for interactive sessions. It
3772 is I<not> intended that you try to parse the output string.
3773 Use C<guestfs_statvfs> from programs.");
3775 ("df_h", (RString "output", [], []), 126, [],
3776 [], (* XXX Tricky to test because it depends on the exact format
3777 * of the 'df' command and other imponderables.
3779 "report file system disk space usage (human readable)",
3781 This command runs the C<df -h> command to report disk space used
3782 in human-readable format.
3784 This command is mostly useful for interactive sessions. It
3785 is I<not> intended that you try to parse the output string.
3786 Use C<guestfs_statvfs> from programs.");
3788 ("du", (RInt64 "sizekb", [Pathname "path"], []), 127, [Progress],
3789 [InitISOFS, Always, TestOutputInt (
3790 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3791 "estimate file space usage",
3793 This command runs the C<du -s> command to estimate file space
3796 C<path> can be a file or a directory. If C<path> is a directory
3797 then the estimate includes the contents of the directory and all
3798 subdirectories (recursively).
3800 The result is the estimated size in I<kilobytes>
3801 (ie. units of 1024 bytes).");
3803 ("initrd_list", (RStringList "filenames", [Pathname "path"], []), 128, [],
3804 [InitISOFS, Always, TestOutputList (
3805 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3806 "list files in an initrd",
3808 This command lists out files contained in an initrd.
3810 The files are listed without any initial C</> character. The
3811 files are listed in the order they appear (not necessarily
3812 alphabetical). Directory names are listed as separate items.
3814 Old Linux kernels (2.4 and earlier) used a compressed ext2
3815 filesystem as initrd. We I<only> support the newer initramfs
3816 format (compressed cpio files).");
3818 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"], []), 129, [],
3820 "mount a file using the loop device",
3822 This command lets you mount C<file> (a filesystem image
3823 in a file) on a mount point. It is entirely equivalent to
3824 the command C<mount -o loop file mountpoint>.");
3826 ("mkswap", (RErr, [Device "device"], []), 130, [],
3827 [InitEmpty, Always, TestRun (
3828 [["part_disk"; "/dev/sda"; "mbr"];
3829 ["mkswap"; "/dev/sda1"]])],
3830 "create a swap partition",
3832 Create a swap partition on C<device>.");
3834 ("mkswap_L", (RErr, [String "label"; Device "device"], []), 131, [],
3835 [InitEmpty, Always, TestRun (
3836 [["part_disk"; "/dev/sda"; "mbr"];
3837 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3838 "create a swap partition with a label",
3840 Create a swap partition on C<device> with label C<label>.
3842 Note that you cannot attach a swap label to a block device
3843 (eg. C</dev/sda>), just to a partition. This appears to be
3844 a limitation of the kernel or swap tools.");
3846 ("mkswap_U", (RErr, [String "uuid"; Device "device"], []), 132, [Optional "linuxfsuuid"],
3847 (let uuid = uuidgen () in
3848 [InitEmpty, Always, TestRun (
3849 [["part_disk"; "/dev/sda"; "mbr"];
3850 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3851 "create a swap partition with an explicit UUID",
3853 Create a swap partition on C<device> with UUID C<uuid>.");
3855 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 133, [Optional "mknod"],
3856 [InitScratchFS, Always, TestOutputStruct (
3857 [["mknod"; "0o10777"; "0"; "0"; "/mknod"];
3858 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3859 ["stat"; "/mknod"]], [CompareWithInt ("mode", 0o10755)]);
3860 InitScratchFS, Always, TestOutputStruct (
3861 [["mknod"; "0o60777"; "66"; "99"; "/mknod2"];
3862 ["stat"; "/mknod2"]], [CompareWithInt ("mode", 0o60755)])],
3863 "make block, character or FIFO devices",
3865 This call creates block or character special devices, or
3866 named pipes (FIFOs).
3868 The C<mode> parameter should be the mode, using the standard
3869 constants. C<devmajor> and C<devminor> are the
3870 device major and minor numbers, only used when creating block
3871 and character special devices.
3873 Note that, just like L<mknod(2)>, the mode must be bitwise
3874 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3875 just creates a regular file). These constants are
3876 available in the standard Linux header files, or you can use
3877 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3878 which are wrappers around this command which bitwise OR
3879 in the appropriate constant for you.
3881 The mode actually set is affected by the umask.");
3883 ("mkfifo", (RErr, [Int "mode"; Pathname "path"], []), 134, [Optional "mknod"],
3884 [InitScratchFS, Always, TestOutputStruct (
3885 [["mkfifo"; "0o777"; "/mkfifo"];
3886 ["stat"; "/mkfifo"]], [CompareWithInt ("mode", 0o10755)])],
3887 "make FIFO (named pipe)",
3889 This call creates a FIFO (named pipe) called C<path> with
3890 mode C<mode>. It is just a convenient wrapper around
3893 The mode actually set is affected by the umask.");
3895 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 135, [Optional "mknod"],
3896 [InitScratchFS, Always, TestOutputStruct (
3897 [["mknod_b"; "0o777"; "99"; "66"; "/mknod_b"];
3898 ["stat"; "/mknod_b"]], [CompareWithInt ("mode", 0o60755)])],
3899 "make block device node",
3901 This call creates a block device node called C<path> with
3902 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3903 It is just a convenient wrapper around C<guestfs_mknod>.
3905 The mode actually set is affected by the umask.");
3907 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"], []), 136, [Optional "mknod"],
3908 [InitScratchFS, Always, TestOutputStruct (
3909 [["mknod_c"; "0o777"; "99"; "66"; "/mknod_c"];
3910 ["stat"; "/mknod_c"]], [CompareWithInt ("mode", 0o20755)])],
3911 "make char device node",
3913 This call creates a char device node called C<path> with
3914 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3915 It is just a convenient wrapper around C<guestfs_mknod>.
3917 The mode actually set is affected by the umask.");
3919 ("umask", (RInt "oldmask", [Int "mask"], []), 137, [FishOutput FishOutputOctal],
3920 [InitEmpty, Always, TestOutputInt (
3921 [["umask"; "0o22"]], 0o22)],
3922 "set file mode creation mask (umask)",
3924 This function sets the mask used for creating new files and
3925 device nodes to C<mask & 0777>.
3927 Typical umask values would be C<022> which creates new files
3928 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3929 C<002> which creates new files with permissions like
3930 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3932 The default umask is C<022>. This is important because it
3933 means that directories and device nodes will be created with
3934 C<0644> or C<0755> mode even if you specify C<0777>.
3936 See also C<guestfs_get_umask>,
3937 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3939 This call returns the previous umask.");
3941 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"], []), 138, [],
3943 "read directories entries",
3945 This returns the list of directory entries in directory C<dir>.
3947 All entries in the directory are returned, including C<.> and
3948 C<..>. The entries are I<not> sorted, but returned in the same
3949 order as the underlying filesystem.
3951 Also this call returns basic file type information about each
3952 file. The C<ftyp> field will contain one of the following characters:
3990 The L<readdir(3)> call returned a C<d_type> field with an
3995 This function is primarily intended for use by programs. To
3996 get a simple list of names, use C<guestfs_ls>. To get a printable
3997 directory for human consumption, use C<guestfs_ll>.");
3999 ("sfdiskM", (RErr, [Device "device"; StringList "lines"], []), 139, [DeprecatedBy "part_add"],
4001 "create partitions on a block device",
4003 This is a simplified interface to the C<guestfs_sfdisk>
4004 command, where partition sizes are specified in megabytes
4005 only (rounded to the nearest cylinder) and you don't need
4006 to specify the cyls, heads and sectors parameters which
4007 were rarely if ever used anyway.
4009 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
4010 and C<guestfs_part_disk>");
4012 ("zfile", (RString "description", [String "meth"; Pathname "path"], []), 140, [DeprecatedBy "file"],
4014 "determine file type inside a compressed file",
4016 This command runs C<file> after first decompressing C<path>
4019 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
4021 Since 1.0.63, use C<guestfs_file> instead which can now
4022 process compressed files.");
4024 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 141, [Optional "linuxxattrs"],
4026 "list extended attributes of a file or directory",
4028 This call lists the extended attributes of the file or directory
4031 At the system call level, this is a combination of the
4032 L<listxattr(2)> and L<getxattr(2)> calls.
4034 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
4036 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"], []), 142, [Optional "linuxxattrs"],
4038 "list extended attributes of a file or directory",
4040 This is the same as C<guestfs_getxattrs>, but if C<path>
4041 is a symbolic link, then it returns the extended attributes
4042 of the link itself.");
4044 ("setxattr", (RErr, [String "xattr";
4045 String "val"; Int "vallen"; (* will be BufferIn *)
4046 Pathname "path"], []), 143, [Optional "linuxxattrs"],
4048 "set extended attribute of a file or directory",
4050 This call sets the extended attribute named C<xattr>
4051 of the file C<path> to the value C<val> (of length C<vallen>).
4052 The value is arbitrary 8 bit data.
4054 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
4056 ("lsetxattr", (RErr, [String "xattr";
4057 String "val"; Int "vallen"; (* will be BufferIn *)
4058 Pathname "path"], []), 144, [Optional "linuxxattrs"],
4060 "set extended attribute of a file or directory",
4062 This is the same as C<guestfs_setxattr>, but if C<path>
4063 is a symbolic link, then it sets an extended attribute
4064 of the link itself.");
4066 ("removexattr", (RErr, [String "xattr"; Pathname "path"], []), 145, [Optional "linuxxattrs"],
4068 "remove extended attribute of a file or directory",
4070 This call removes the extended attribute named C<xattr>
4071 of the file C<path>.
4073 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
4075 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"], []), 146, [Optional "linuxxattrs"],
4077 "remove extended attribute of a file or directory",
4079 This is the same as C<guestfs_removexattr>, but if C<path>
4080 is a symbolic link, then it removes an extended attribute
4081 of the link itself.");
4083 ("mountpoints", (RHashtable "mps", [], []), 147, [],
4087 This call is similar to C<guestfs_mounts>. That call returns
4088 a list of devices. This one returns a hash table (map) of
4089 device name to directory where the device is mounted.");
4091 ("mkmountpoint", (RErr, [String "exemptpath"], []), 148, [],
4092 (* This is a special case: while you would expect a parameter
4093 * of type "Pathname", that doesn't work, because it implies
4094 * NEED_ROOT in the generated calling code in stubs.c, and
4095 * this function cannot use NEED_ROOT.
4098 "create a mountpoint",
4100 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
4101 specialized calls that can be used to create extra mountpoints
4102 before mounting the first filesystem.
4104 These calls are I<only> necessary in some very limited circumstances,
4105 mainly the case where you want to mount a mix of unrelated and/or
4106 read-only filesystems together.
4108 For example, live CDs often contain a \"Russian doll\" nest of
4109 filesystems, an ISO outer layer, with a squashfs image inside, with
4110 an ext2/3 image inside that. You can unpack this as follows
4113 add-ro Fedora-11-i686-Live.iso
4117 mkmountpoint /ext3fs
4119 mount-loop /cd/LiveOS/squashfs.img /sqsh
4120 mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs
4122 The inner filesystem is now unpacked under the /ext3fs mountpoint.
4124 C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.
4125 You may get unexpected errors if you try to mix these calls. It is
4126 safest to manually unmount filesystems and remove mountpoints after use.
4128 C<guestfs_umount_all> unmounts filesystems by sorting the paths
4129 longest first, so for this to work for manual mountpoints, you
4130 must ensure that the innermost mountpoints have the longest
4131 pathnames, as in the example code above.
4133 For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>
4135 Autosync [see C<guestfs_set_autosync>, this is set by default on
4136 handles] can cause C<guestfs_umount_all> to be called when the handle
4137 is closed which can also trigger these issues.");
4139 ("rmmountpoint", (RErr, [String "exemptpath"], []), 149, [],
4141 "remove a mountpoint",
4143 This calls removes a mountpoint that was previously created
4144 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
4145 for full details.");
4147 ("read_file", (RBufferOut "content", [Pathname "path"], []), 150, [ProtocolLimitWarning],
4148 [InitISOFS, Always, TestOutputBuffer (
4149 [["read_file"; "/known-4"]], "abc\ndef\nghi");
4150 (* Test various near large, large and too large files (RHBZ#589039). *)
4151 InitScratchFS, Always, TestLastFail (
4152 [["touch"; "/read_file"];
4153 ["truncate_size"; "/read_file"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
4154 ["read_file"; "/read_file"]]);
4155 InitScratchFS, Always, TestLastFail (
4156 [["touch"; "/read_file2"];
4157 ["truncate_size"; "/read_file2"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
4158 ["read_file"; "/read_file2"]]);
4159 InitScratchFS, Always, TestLastFail (
4160 [["touch"; "/read_file3"];
4161 ["truncate_size"; "/read_file3"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
4162 ["read_file"; "/read_file3"]])],
4165 This calls returns the contents of the file C<path> as a
4168 Unlike C<guestfs_cat>, this function can correctly
4169 handle files that contain embedded ASCII NUL characters.
4170 However unlike C<guestfs_download>, this function is limited
4171 in the total size of file that can be handled.");
4173 ("grep", (RStringList "lines", [String "regex"; Pathname "path"], []), 151, [ProtocolLimitWarning],
4174 [InitISOFS, Always, TestOutputList (
4175 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
4176 InitISOFS, Always, TestOutputList (
4177 [["grep"; "nomatch"; "/test-grep.txt"]], []);
4178 (* Test for RHBZ#579608, absolute symbolic links. *)
4179 InitISOFS, Always, TestOutputList (
4180 [["grep"; "nomatch"; "/abssymlink"]], [])],
4181 "return lines matching a pattern",
4183 This calls the external C<grep> program and returns the
4186 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 152, [ProtocolLimitWarning],
4187 [InitISOFS, Always, TestOutputList (
4188 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4189 "return lines matching a pattern",
4191 This calls the external C<egrep> program and returns the
4194 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 153, [ProtocolLimitWarning],
4195 [InitISOFS, Always, TestOutputList (
4196 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
4197 "return lines matching a pattern",
4199 This calls the external C<fgrep> program and returns the
4202 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 154, [ProtocolLimitWarning],
4203 [InitISOFS, Always, TestOutputList (
4204 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4205 "return lines matching a pattern",
4207 This calls the external C<grep -i> program and returns the
4210 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 155, [ProtocolLimitWarning],
4211 [InitISOFS, Always, TestOutputList (
4212 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4213 "return lines matching a pattern",
4215 This calls the external C<egrep -i> program and returns the
4218 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 156, [ProtocolLimitWarning],
4219 [InitISOFS, Always, TestOutputList (
4220 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
4221 "return lines matching a pattern",
4223 This calls the external C<fgrep -i> program and returns the
4226 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 157, [ProtocolLimitWarning],
4227 [InitISOFS, Always, TestOutputList (
4228 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4229 "return lines matching a pattern",
4231 This calls the external C<zgrep> program and returns the
4234 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"], []), 158, [ProtocolLimitWarning],
4235 [InitISOFS, Always, TestOutputList (
4236 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4237 "return lines matching a pattern",
4239 This calls the external C<zegrep> program and returns the
4242 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"], []), 159, [ProtocolLimitWarning],
4243 [InitISOFS, Always, TestOutputList (
4244 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
4245 "return lines matching a pattern",
4247 This calls the external C<zfgrep> program and returns the
4250 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 160, [ProtocolLimitWarning],
4251 [InitISOFS, Always, TestOutputList (
4252 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4253 "return lines matching a pattern",
4255 This calls the external C<zgrep -i> program and returns the
4258 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"], []), 161, [ProtocolLimitWarning],
4259 [InitISOFS, Always, TestOutputList (
4260 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4261 "return lines matching a pattern",
4263 This calls the external C<zegrep -i> program and returns the
4266 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"], []), 162, [ProtocolLimitWarning],
4267 [InitISOFS, Always, TestOutputList (
4268 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
4269 "return lines matching a pattern",
4271 This calls the external C<zfgrep -i> program and returns the
4274 ("realpath", (RString "rpath", [Pathname "path"], []), 163, [Optional "realpath"],
4275 [InitISOFS, Always, TestOutput (
4276 [["realpath"; "/../directory"]], "/directory")],
4277 "canonicalized absolute pathname",
4279 Return the canonicalized absolute pathname of C<path>. The
4280 returned path has no C<.>, C<..> or symbolic link path elements.");
4282 ("ln", (RErr, [String "target"; Pathname "linkname"], []), 164, [],
4283 [InitScratchFS, Always, TestOutputStruct (
4286 ["ln"; "/ln/a"; "/ln/b"];
4287 ["stat"; "/ln/b"]], [CompareWithInt ("nlink", 2)])],
4288 "create a hard link",
4290 This command creates a hard link using the C<ln> command.");
4292 ("ln_f", (RErr, [String "target"; Pathname "linkname"], []), 165, [],
4293 [InitScratchFS, Always, TestOutputStruct (
4294 [["mkdir"; "/ln_f"];
4295 ["touch"; "/ln_f/a"];
4296 ["touch"; "/ln_f/b"];
4297 ["ln_f"; "/ln_f/a"; "/ln_f/b"];
4298 ["stat"; "/ln_f/b"]], [CompareWithInt ("nlink", 2)])],
4299 "create a hard link",
4301 This command creates a hard link using the C<ln -f> command.
4302 The I<-f> option removes the link (C<linkname>) if it exists already.");
4304 ("ln_s", (RErr, [String "target"; Pathname "linkname"], []), 166, [],
4305 [InitScratchFS, Always, TestOutputStruct (
4306 [["mkdir"; "/ln_s"];
4307 ["touch"; "/ln_s/a"];
4308 ["ln_s"; "a"; "/ln_s/b"];
4309 ["lstat"; "/ln_s/b"]], [CompareWithInt ("mode", 0o120777)])],
4310 "create a symbolic link",
4312 This command creates a symbolic link using the C<ln -s> command.");
4314 ("ln_sf", (RErr, [String "target"; Pathname "linkname"], []), 167, [],
4315 [InitScratchFS, Always, TestOutput (
4316 [["mkdir_p"; "/ln_sf/b"];
4317 ["touch"; "/ln_sf/b/c"];
4318 ["ln_sf"; "../d"; "/ln_sf/b/c"];
4319 ["readlink"; "/ln_sf/b/c"]], "../d")],
4320 "create a symbolic link",
4322 This command creates a symbolic link using the C<ln -sf> command,
4323 The I<-f> option removes the link (C<linkname>) if it exists already.");
4325 ("readlink", (RString "link", [Pathname "path"], []), 168, [],
4326 [] (* XXX tested above *),
4327 "read the target of a symbolic link",
4329 This command reads the target of a symbolic link.");
4331 ("fallocate", (RErr, [Pathname "path"; Int "len"], []), 169, [DeprecatedBy "fallocate64"],
4332 [InitScratchFS, Always, TestOutputStruct (
4333 [["fallocate"; "/fallocate"; "1000000"];
4334 ["stat"; "/fallocate"]], [CompareWithInt ("size", 1_000_000)])],
4335 "preallocate a file in the guest filesystem",
4337 This command preallocates a file (containing zero bytes) named
4338 C<path> of size C<len> bytes. If the file exists already, it
4341 Do not confuse this with the guestfish-specific
4342 C<alloc> command which allocates a file in the host and
4343 attaches it as a device.");
4345 ("swapon_device", (RErr, [Device "device"], []), 170, [],
4346 [InitPartition, Always, TestRun (
4347 [["mkswap"; "/dev/sda1"];
4348 ["swapon_device"; "/dev/sda1"];
4349 ["swapoff_device"; "/dev/sda1"]])],
4350 "enable swap on device",
4352 This command enables the libguestfs appliance to use the
4353 swap device or partition named C<device>. The increased
4354 memory is made available for all commands, for example
4355 those run using C<guestfs_command> or C<guestfs_sh>.
4357 Note that you should not swap to existing guest swap
4358 partitions unless you know what you are doing. They may
4359 contain hibernation information, or other information that
4360 the guest doesn't want you to trash. You also risk leaking
4361 information about the host to the guest this way. Instead,
4362 attach a new host device to the guest and swap on that.");
4364 ("swapoff_device", (RErr, [Device "device"], []), 171, [],
4365 [], (* XXX tested by swapon_device *)
4366 "disable swap on device",
4368 This command disables the libguestfs appliance swap
4369 device or partition named C<device>.
4370 See C<guestfs_swapon_device>.");
4372 ("swapon_file", (RErr, [Pathname "file"], []), 172, [],
4373 [InitScratchFS, Always, TestRun (
4374 [["fallocate"; "/swapon_file"; "8388608"];
4375 ["mkswap_file"; "/swapon_file"];
4376 ["swapon_file"; "/swapon_file"];
4377 ["swapoff_file"; "/swapon_file"];
4378 ["rm"; "/swapon_file"]])],
4379 "enable swap on file",
4381 This command enables swap to a file.
4382 See C<guestfs_swapon_device> for other notes.");
4384 ("swapoff_file", (RErr, [Pathname "file"], []), 173, [],
4385 [], (* XXX tested by swapon_file *)
4386 "disable swap on file",
4388 This command disables the libguestfs appliance swap on file.");
4390 ("swapon_label", (RErr, [String "label"], []), 174, [],
4391 [InitEmpty, Always, TestRun (
4392 [["part_disk"; "/dev/sda"; "mbr"];
4393 ["mkswap_L"; "swapit"; "/dev/sda1"];
4394 ["swapon_label"; "swapit"];
4395 ["swapoff_label"; "swapit"];
4396 ["zero"; "/dev/sda"];
4397 ["blockdev_rereadpt"; "/dev/sda"]])],
4398 "enable swap on labeled swap partition",
4400 This command enables swap to a labeled swap partition.
4401 See C<guestfs_swapon_device> for other notes.");
4403 ("swapoff_label", (RErr, [String "label"], []), 175, [],
4404 [], (* XXX tested by swapon_label *)
4405 "disable swap on labeled swap partition",
4407 This command disables the libguestfs appliance swap on
4408 labeled swap partition.");
4410 ("swapon_uuid", (RErr, [String "uuid"], []), 176, [Optional "linuxfsuuid"],
4411 (let uuid = uuidgen () in
4412 [InitEmpty, Always, TestRun (
4413 [["mkswap_U"; uuid; "/dev/sdc"];
4414 ["swapon_uuid"; uuid];
4415 ["swapoff_uuid"; uuid]])]),
4416 "enable swap on swap partition by UUID",
4418 This command enables swap to a swap partition with the given UUID.
4419 See C<guestfs_swapon_device> for other notes.");
4421 ("swapoff_uuid", (RErr, [String "uuid"], []), 177, [Optional "linuxfsuuid"],
4422 [], (* XXX tested by swapon_uuid *)
4423 "disable swap on swap partition by UUID",
4425 This command disables the libguestfs appliance swap partition
4426 with the given UUID.");
4428 ("mkswap_file", (RErr, [Pathname "path"], []), 178, [],
4429 [InitScratchFS, Always, TestRun (
4430 [["fallocate"; "/mkswap_file"; "8388608"];
4431 ["mkswap_file"; "/mkswap_file"];
4432 ["rm"; "/mkswap_file"]])],
4433 "create a swap file",
4437 This command just writes a swap file signature to an existing
4438 file. To create the file itself, use something like C<guestfs_fallocate>.");
4440 ("inotify_init", (RErr, [Int "maxevents"], []), 179, [Optional "inotify"],
4441 [InitISOFS, Always, TestRun (
4442 [["inotify_init"; "0"]])],
4443 "create an inotify handle",
4445 This command creates a new inotify handle.
4446 The inotify subsystem can be used to notify events which happen to
4447 objects in the guest filesystem.
4449 C<maxevents> is the maximum number of events which will be
4450 queued up between calls to C<guestfs_inotify_read> or
4451 C<guestfs_inotify_files>.
4452 If this is passed as C<0>, then the kernel (or previously set)
4453 default is used. For Linux 2.6.29 the default was 16384 events.
4454 Beyond this limit, the kernel throws away events, but records
4455 the fact that it threw them away by setting a flag
4456 C<IN_Q_OVERFLOW> in the returned structure list (see
4457 C<guestfs_inotify_read>).
4459 Before any events are generated, you have to add some
4460 watches to the internal watch list. See:
4461 C<guestfs_inotify_add_watch>,
4462 C<guestfs_inotify_rm_watch> and
4463 C<guestfs_inotify_watch_all>.
4465 Queued up events should be read periodically by calling
4466 C<guestfs_inotify_read>
4467 (or C<guestfs_inotify_files> which is just a helpful
4468 wrapper around C<guestfs_inotify_read>). If you don't
4469 read the events out often enough then you risk the internal
4472 The handle should be closed after use by calling
4473 C<guestfs_inotify_close>. This also removes any
4474 watches automatically.
4476 See also L<inotify(7)> for an overview of the inotify interface
4477 as exposed by the Linux kernel, which is roughly what we expose
4478 via libguestfs. Note that there is one global inotify handle
4479 per libguestfs instance.");
4481 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"], []), 180, [Optional "inotify"],
4482 [InitScratchFS, Always, TestOutputList (
4483 [["mkdir"; "/inotify_add_watch"];
4484 ["inotify_init"; "0"];
4485 ["inotify_add_watch"; "/inotify_add_watch"; "1073741823"];
4486 ["touch"; "/inotify_add_watch/a"];
4487 ["touch"; "/inotify_add_watch/b"];
4488 ["inotify_files"]], ["a"; "b"])],
4489 "add an inotify watch",
4491 Watch C<path> for the events listed in C<mask>.
4493 Note that if C<path> is a directory then events within that
4494 directory are watched, but this does I<not> happen recursively
4495 (in subdirectories).
4497 Note for non-C or non-Linux callers: the inotify events are
4498 defined by the Linux kernel ABI and are listed in
4499 C</usr/include/sys/inotify.h>.");
4501 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"], []), 181, [Optional "inotify"],
4503 "remove an inotify watch",
4505 Remove a previously defined inotify watch.
4506 See C<guestfs_inotify_add_watch>.");
4508 ("inotify_read", (RStructList ("events", "inotify_event"), [], []), 182, [Optional "inotify"],
4510 "return list of inotify events",
4512 Return the complete queue of events that have happened
4513 since the previous read call.
4515 If no events have happened, this returns an empty list.
4517 I<Note>: In order to make sure that all events have been
4518 read, you must call this function repeatedly until it
4519 returns an empty list. The reason is that the call will
4520 read events up to the maximum appliance-to-host message
4521 size and leave remaining events in the queue.");
4523 ("inotify_files", (RStringList "paths", [], []), 183, [Optional "inotify"],
4525 "return list of watched files that had events",
4527 This function is a helpful wrapper around C<guestfs_inotify_read>
4528 which just returns a list of pathnames of objects that were
4529 touched. The returned pathnames are sorted and deduplicated.");
4531 ("inotify_close", (RErr, [], []), 184, [Optional "inotify"],
4533 "close the inotify handle",
4535 This closes the inotify handle which was previously
4536 opened by inotify_init. It removes all watches, throws
4537 away any pending events, and deallocates all resources.");
4539 ("setcon", (RErr, [String "context"], []), 185, [Optional "selinux"],
4541 "set SELinux security context",
4543 This sets the SELinux security context of the daemon
4544 to the string C<context>.
4546 See the documentation about SELINUX in L<guestfs(3)>.");
4548 ("getcon", (RString "context", [], []), 186, [Optional "selinux"],
4550 "get SELinux security context",
4552 This gets the SELinux security context of the daemon.
4554 See the documentation about SELINUX in L<guestfs(3)>,
4555 and C<guestfs_setcon>");
4557 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"], []), 187, [DeprecatedBy "mkfs_opts"],
4558 [InitEmpty, Always, TestOutput (
4559 [["part_disk"; "/dev/sda"; "mbr"];
4560 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4561 ["mount_options"; ""; "/dev/sda1"; "/"];
4562 ["write"; "/new"; "new file contents"];
4563 ["cat"; "/new"]], "new file contents");
4564 InitEmpty, Always, TestRun (
4565 [["part_disk"; "/dev/sda"; "mbr"];
4566 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4567 InitEmpty, Always, TestLastFail (
4568 [["part_disk"; "/dev/sda"; "mbr"];
4569 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4570 InitEmpty, Always, TestLastFail (
4571 [["part_disk"; "/dev/sda"; "mbr"];
4572 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4573 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4574 [["part_disk"; "/dev/sda"; "mbr"];
4575 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4576 "make a filesystem with block size",
4578 This call is similar to C<guestfs_mkfs>, but it allows you to
4579 control the block size of the resulting filesystem. Supported
4580 block sizes depend on the filesystem type, but typically they
4581 are C<1024>, C<2048> or C<4096> only.
4583 For VFAT and NTFS the C<blocksize> parameter is treated as
4584 the requested cluster size.");
4586 ("mke2journal", (RErr, [Int "blocksize"; Device "device"], []), 188, [],
4587 [InitEmpty, Always, TestOutput (
4588 [["part_init"; "/dev/sda"; "mbr"];
4589 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4590 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4591 ["mke2journal"; "4096"; "/dev/sda1"];
4592 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4593 ["mount_options"; ""; "/dev/sda2"; "/"];
4594 ["write"; "/new"; "new file contents"];
4595 ["cat"; "/new"]], "new file contents")],
4596 "make ext2/3/4 external journal",
4598 This creates an ext2 external journal on C<device>. It is equivalent
4601 mke2fs -O journal_dev -b blocksize device");
4603 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"], []), 189, [],
4604 [InitEmpty, Always, TestOutput (
4605 [["part_init"; "/dev/sda"; "mbr"];
4606 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4607 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4608 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4609 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4610 ["mount_options"; ""; "/dev/sda2"; "/"];
4611 ["write"; "/new"; "new file contents"];
4612 ["cat"; "/new"]], "new file contents")],
4613 "make ext2/3/4 external journal with label",
4615 This creates an ext2 external journal on C<device> with label C<label>.");
4617 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"], []), 190, [Optional "linuxfsuuid"],
4618 (let uuid = uuidgen () in
4619 [InitEmpty, Always, TestOutput (
4620 [["part_init"; "/dev/sda"; "mbr"];
4621 ["part_add"; "/dev/sda"; "p"; "64"; "204799"];
4622 ["part_add"; "/dev/sda"; "p"; "204800"; "-64"];
4623 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4624 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4625 ["mount_options"; ""; "/dev/sda2"; "/"];
4626 ["write"; "/new"; "new file contents"];
4627 ["cat"; "/new"]], "new file contents")]),
4628 "make ext2/3/4 external journal with UUID",
4630 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4632 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"], []), 191, [],
4634 "make ext2/3/4 filesystem with external journal",
4636 This creates an ext2/3/4 filesystem on C<device> with
4637 an external journal on C<journal>. It is equivalent
4640 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4642 See also C<guestfs_mke2journal>.");
4644 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"], []), 192, [],
4646 "make ext2/3/4 filesystem with external journal",
4648 This creates an ext2/3/4 filesystem on C<device> with
4649 an external journal on the journal labeled C<label>.
4651 See also C<guestfs_mke2journal_L>.");
4653 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"], []), 193, [Optional "linuxfsuuid"],
4655 "make ext2/3/4 filesystem with external journal",
4657 This creates an ext2/3/4 filesystem on C<device> with
4658 an external journal on the journal with UUID C<uuid>.
4660 See also C<guestfs_mke2journal_U>.");
4662 ("modprobe", (RErr, [String "modulename"], []), 194, [Optional "linuxmodules"],
4663 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4664 "load a kernel module",
4666 This loads a kernel module in the appliance.
4668 The kernel module must have been whitelisted when libguestfs
4669 was built (see C<appliance/kmod.whitelist.in> in the source).");
4671 ("echo_daemon", (RString "output", [StringList "words"], []), 195, [],
4672 [InitNone, Always, TestOutput (
4673 [["echo_daemon"; "This is a test"]], "This is a test"
4675 "echo arguments back to the client",
4677 This command concatenates the list of C<words> passed with single spaces
4678 between them and returns the resulting string.
4680 You can use this command to test the connection through to the daemon.
4682 See also C<guestfs_ping_daemon>.");
4684 ("find0", (RErr, [Pathname "directory"; FileOut "files"], []), 196, [],
4685 [], (* There is a regression test for this. *)
4686 "find all files and directories, returning NUL-separated list",
4688 This command lists out all files and directories, recursively,
4689 starting at C<directory>, placing the resulting list in the
4690 external file called C<files>.
4692 This command works the same way as C<guestfs_find> with the
4693 following exceptions:
4699 The resulting list is written to an external file.
4703 Items (filenames) in the result are separated
4704 by C<\\0> characters. See L<find(1)> option I<-print0>.
4708 This command is not limited in the number of names that it
4713 The result list is not sorted.
4717 ("case_sensitive_path", (RString "rpath", [Pathname "path"], []), 197, [],
4718 [InitISOFS, Always, TestOutput (
4719 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4720 InitISOFS, Always, TestOutput (
4721 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4722 InitISOFS, Always, TestOutput (
4723 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4724 InitISOFS, Always, TestLastFail (
4725 [["case_sensitive_path"; "/Known-1/"]]);
4726 InitScratchFS, Always, TestOutput (
4727 [["mkdir"; "/case_sensitive_path"];
4728 ["mkdir"; "/case_sensitive_path/bbb"];
4729 ["touch"; "/case_sensitive_path/bbb/c"];
4730 ["case_sensitive_path"; "/CASE_SENSITIVE_path/bbB/C"]], "/case_sensitive_path/bbb/c");
4731 InitScratchFS, Always, TestOutput (
4732 [["mkdir"; "/case_sensitive_path2"];
4733 ["mkdir"; "/case_sensitive_path2/bbb"];
4734 ["touch"; "/case_sensitive_path2/bbb/c"];
4735 ["case_sensitive_path"; "/case_sensitive_PATH2////bbB/C"]], "/case_sensitive_path2/bbb/c");
4736 InitScratchFS, Always, TestLastFail (
4737 [["mkdir"; "/case_sensitive_path3"];
4738 ["mkdir"; "/case_sensitive_path3/bbb"];
4739 ["touch"; "/case_sensitive_path3/bbb/c"];
4740 ["case_sensitive_path"; "/case_SENSITIVE_path3/bbb/../bbb/C"]])],
4741 "return true path on case-insensitive filesystem",
4743 This can be used to resolve case insensitive paths on
4744 a filesystem which is case sensitive. The use case is
4745 to resolve paths which you have read from Windows configuration
4746 files or the Windows Registry, to the true path.
4748 The command handles a peculiarity of the Linux ntfs-3g
4749 filesystem driver (and probably others), which is that although
4750 the underlying filesystem is case-insensitive, the driver
4751 exports the filesystem to Linux as case-sensitive.
4753 One consequence of this is that special directories such
4754 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4755 (or other things) depending on the precise details of how
4756 they were created. In Windows itself this would not be
4759 Bug or feature? You decide:
4760 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4762 This function resolves the true case of each element in the
4763 path and returns the case-sensitive path.
4765 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4766 might return C<\"/WINDOWS/system32\"> (the exact return value
4767 would depend on details of how the directories were originally
4768 created under Windows).
4771 This function does not handle drive names, backslashes etc.
4773 See also C<guestfs_realpath>.");
4775 ("vfs_type", (RString "fstype", [Device "device"], []), 198, [],
4776 [InitScratchFS, Always, TestOutput (
4777 [["vfs_type"; "/dev/sdb1"]], "ext2")],
4778 "get the Linux VFS type corresponding to a mounted device",
4780 This command gets the filesystem type corresponding to
4781 the filesystem on C<device>.
4783 For most filesystems, the result is the name of the Linux
4784 VFS module which would be used to mount this filesystem
4785 if you mounted it without specifying the filesystem type.
4786 For example a string such as C<ext3> or C<ntfs>.");
4788 ("truncate", (RErr, [Pathname "path"], []), 199, [],
4789 [InitScratchFS, Always, TestOutputStruct (
4790 [["write"; "/truncate"; "some stuff so size is not zero"];
4791 ["truncate"; "/truncate"];
4792 ["stat"; "/truncate"]], [CompareWithInt ("size", 0)])],
4793 "truncate a file to zero size",
4795 This command truncates C<path> to a zero-length file. The
4796 file must exist already.");
4798 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"], []), 200, [],
4799 [InitScratchFS, Always, TestOutputStruct (
4800 [["touch"; "/truncate_size"];
4801 ["truncate_size"; "/truncate_size"; "1000"];
4802 ["stat"; "/truncate_size"]], [CompareWithInt ("size", 1000)])],
4803 "truncate a file to a particular size",
4805 This command truncates C<path> to size C<size> bytes. The file
4808 If the current file size is less than C<size> then
4809 the file is extended to the required size with zero bytes.
4810 This creates a sparse file (ie. disk blocks are not allocated
4811 for the file until you write to it). To create a non-sparse
4812 file of zeroes, use C<guestfs_fallocate64> instead.");
4814 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"], []), 201, [],
4815 [InitScratchFS, Always, TestOutputStruct (
4816 [["touch"; "/utimens"];
4817 ["utimens"; "/utimens"; "12345"; "67890"; "9876"; "5432"];
4818 ["stat"; "/utimens"]], [CompareWithInt ("mtime", 9876)])],
4819 "set timestamp of a file with nanosecond precision",
4821 This command sets the timestamps of a file with nanosecond
4824 C<atsecs, atnsecs> are the last access time (atime) in secs and
4825 nanoseconds from the epoch.
4827 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4828 secs and nanoseconds from the epoch.
4830 If the C<*nsecs> field contains the special value C<-1> then
4831 the corresponding timestamp is set to the current time. (The
4832 C<*secs> field is ignored in this case).
4834 If the C<*nsecs> field contains the special value C<-2> then
4835 the corresponding timestamp is left unchanged. (The
4836 C<*secs> field is ignored in this case).");
4838 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"], []), 202, [],
4839 [InitScratchFS, Always, TestOutputStruct (
4840 [["mkdir_mode"; "/mkdir_mode"; "0o111"];
4841 ["stat"; "/mkdir_mode"]], [CompareWithInt ("mode", 0o40111)])],
4842 "create a directory with a particular mode",
4844 This command creates a directory, setting the initial permissions
4845 of the directory to C<mode>.
4847 For common Linux filesystems, the actual mode which is set will
4848 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4849 interpret the mode in other ways.
4851 See also C<guestfs_mkdir>, C<guestfs_umask>");
4853 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"], []), 203, [],
4855 "change file owner and group",
4857 Change the file owner to C<owner> and group to C<group>.
4858 This is like C<guestfs_chown> but if C<path> is a symlink then
4859 the link itself is changed, not the target.
4861 Only numeric uid and gid are supported. If you want to use
4862 names, you will need to locate and parse the password file
4863 yourself (Augeas support makes this relatively easy).");
4865 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"], []), 204, [],
4867 "lstat on multiple files",
4869 This call allows you to perform the C<guestfs_lstat> operation
4870 on multiple files, where all files are in the directory C<path>.
4871 C<names> is the list of files from this directory.
4873 On return you get a list of stat structs, with a one-to-one
4874 correspondence to the C<names> list. If any name did not exist
4875 or could not be lstat'd, then the C<ino> field of that structure
4878 This call is intended for programs that want to efficiently
4879 list a directory contents without making many round-trips.
4880 See also C<guestfs_lxattrlist> for a similarly efficient call
4881 for getting extended attributes. Very long directory listings
4882 might cause the protocol message size to be exceeded, causing
4883 this call to fail. The caller must split up such requests
4884 into smaller groups of names.");
4886 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"], []), 205, [Optional "linuxxattrs"],
4888 "lgetxattr on multiple files",
4890 This call allows you to get the extended attributes
4891 of multiple files, where all files are in the directory C<path>.
4892 C<names> is the list of files from this directory.
4894 On return you get a flat list of xattr structs which must be
4895 interpreted sequentially. The first xattr struct always has a zero-length
4896 C<attrname>. C<attrval> in this struct is zero-length
4897 to indicate there was an error doing C<lgetxattr> for this
4898 file, I<or> is a C string which is a decimal number
4899 (the number of following attributes for this file, which could
4900 be C<\"0\">). Then after the first xattr struct are the
4901 zero or more attributes for the first named file.
4902 This repeats for the second and subsequent files.
4904 This call is intended for programs that want to efficiently
4905 list a directory contents without making many round-trips.
4906 See also C<guestfs_lstatlist> for a similarly efficient call
4907 for getting standard stats. Very long directory listings
4908 might cause the protocol message size to be exceeded, causing
4909 this call to fail. The caller must split up such requests
4910 into smaller groups of names.");
4912 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"], []), 206, [],
4914 "readlink on multiple files",
4916 This call allows you to do a C<readlink> operation
4917 on multiple files, where all files are in the directory C<path>.
4918 C<names> is the list of files from this directory.
4920 On return you get a list of strings, with a one-to-one
4921 correspondence to the C<names> list. Each string is the
4922 value of the symbolic link.
4924 If the C<readlink(2)> operation fails on any name, then
4925 the corresponding result string is the empty string C<\"\">.
4926 However the whole operation is completed even if there
4927 were C<readlink(2)> errors, and so you can call this
4928 function with names where you don't know if they are
4929 symbolic links already (albeit slightly less efficient).
4931 This call is intended for programs that want to efficiently
4932 list a directory contents without making many round-trips.
4933 Very long directory listings might cause the protocol
4934 message size to be exceeded, causing
4935 this call to fail. The caller must split up such requests
4936 into smaller groups of names.");
4938 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"], []), 207, [ProtocolLimitWarning],
4939 [InitISOFS, Always, TestOutputBuffer (
4940 [["pread"; "/known-4"; "1"; "3"]], "\n");
4941 InitISOFS, Always, TestOutputBuffer (
4942 [["pread"; "/empty"; "0"; "100"]], "")],
4943 "read part of a file",
4945 This command lets you read part of a file. It reads C<count>
4946 bytes of the file, starting at C<offset>, from file C<path>.
4948 This may read fewer bytes than requested. For further details
4949 see the L<pread(2)> system call.
4951 See also C<guestfs_pwrite>, C<guestfs_pread_device>.");
4953 ("part_init", (RErr, [Device "device"; String "parttype"], []), 208, [],
4954 [InitEmpty, Always, TestRun (
4955 [["part_init"; "/dev/sda"; "gpt"]])],
4956 "create an empty partition table",
4958 This creates an empty partition table on C<device> of one of the
4959 partition types listed below. Usually C<parttype> should be
4960 either C<msdos> or C<gpt> (for large disks).
4962 Initially there are no partitions. Following this, you should
4963 call C<guestfs_part_add> for each partition required.
4965 Possible values for C<parttype> are:
4973 Intel EFI / GPT partition table.
4975 This is recommended for >= 2 TB partitions that will be accessed
4976 from Linux and Intel-based Mac OS X. It also has limited backwards
4977 compatibility with the C<mbr> format.
4983 The standard PC \"Master Boot Record\" (MBR) format used
4984 by MS-DOS and Windows. This partition type will B<only> work
4985 for device sizes up to 2 TB. For large disks we recommend
4990 Other partition table types that may work but are not
5003 Amiga \"Rigid Disk Block\" format.
5011 DASD, used on IBM mainframes.
5019 Old Mac partition format. Modern Macs use C<gpt>.
5023 NEC PC-98 format, common in Japan apparently.
5031 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"], []), 209, [],
5032 [InitEmpty, Always, TestRun (
5033 [["part_init"; "/dev/sda"; "mbr"];
5034 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
5035 InitEmpty, Always, TestRun (
5036 [["part_init"; "/dev/sda"; "gpt"];
5037 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
5038 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
5039 InitEmpty, Always, TestRun (
5040 [["part_init"; "/dev/sda"; "mbr"];
5041 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
5042 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
5043 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
5044 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
5045 "add a partition to the device",
5047 This command adds a partition to C<device>. If there is no partition
5048 table on the device, call C<guestfs_part_init> first.
5050 The C<prlogex> parameter is the type of partition. Normally you
5051 should pass C<p> or C<primary> here, but MBR partition tables also
5052 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
5055 C<startsect> and C<endsect> are the start and end of the partition
5056 in I<sectors>. C<endsect> may be negative, which means it counts
5057 backwards from the end of the disk (C<-1> is the last sector).
5059 Creating a partition which covers the whole disk is not so easy.
5060 Use C<guestfs_part_disk> to do that.");
5062 ("part_disk", (RErr, [Device "device"; String "parttype"], []), 210, [],
5063 [InitEmpty, Always, TestRun (
5064 [["part_disk"; "/dev/sda"; "mbr"]]);
5065 InitEmpty, Always, TestRun (
5066 [["part_disk"; "/dev/sda"; "gpt"]])],
5067 "partition whole disk with a single primary partition",
5069 This command is simply a combination of C<guestfs_part_init>
5070 followed by C<guestfs_part_add> to create a single primary partition
5071 covering the whole disk.
5073 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
5074 but other possible values are described in C<guestfs_part_init>.");
5076 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"], []), 211, [],
5077 [InitEmpty, Always, TestRun (
5078 [["part_disk"; "/dev/sda"; "mbr"];
5079 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
5080 "make a partition bootable",
5082 This sets the bootable flag on partition numbered C<partnum> on
5083 device C<device>. Note that partitions are numbered from 1.
5085 The bootable flag is used by some operating systems (notably
5086 Windows) to determine which partition to boot from. It is by
5087 no means universally recognized.");
5089 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"], []), 212, [],
5090 [InitEmpty, Always, TestRun (
5091 [["part_disk"; "/dev/sda"; "gpt"];
5092 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
5093 "set partition name",
5095 This sets the partition name on partition numbered C<partnum> on
5096 device C<device>. Note that partitions are numbered from 1.
5098 The partition name can only be set on certain types of partition
5099 table. This works on C<gpt> but not on C<mbr> partitions.");
5101 ("part_list", (RStructList ("partitions", "partition"), [Device "device"], []), 213, [],
5102 [], (* XXX Add a regression test for this. *)
5103 "list partitions on a device",
5105 This command parses the partition table on C<device> and
5106 returns the list of partitions found.
5108 The fields in the returned structure are:
5114 Partition number, counting from 1.
5118 Start of the partition I<in bytes>. To get sectors you have to
5119 divide by the device's sector size, see C<guestfs_blockdev_getss>.
5123 End of the partition in bytes.
5127 Size of the partition in bytes.
5131 ("part_get_parttype", (RString "parttype", [Device "device"], []), 214, [],
5132 [InitEmpty, Always, TestOutput (
5133 [["part_disk"; "/dev/sda"; "gpt"];
5134 ["part_get_parttype"; "/dev/sda"]], "gpt")],
5135 "get the partition table type",
5137 This command examines the partition table on C<device> and
5138 returns the partition table type (format) being used.
5140 Common return values include: C<msdos> (a DOS/Windows style MBR
5141 partition table), C<gpt> (a GPT/EFI-style partition table). Other
5142 values are possible, although unusual. See C<guestfs_part_init>
5145 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"], []), 215, [Progress],
5146 [InitScratchFS, Always, TestOutputBuffer (
5147 [["fill"; "0x63"; "10"; "/fill"];
5148 ["read_file"; "/fill"]], "cccccccccc")],
5149 "fill a file with octets",
5151 This command creates a new file called C<path>. The initial
5152 content of the file is C<len> octets of C<c>, where C<c>
5153 must be a number in the range C<[0..255]>.
5155 To fill a file with zero bytes (sparsely), it is
5156 much more efficient to use C<guestfs_truncate_size>.
5157 To create a file with a pattern of repeating bytes
5158 use C<guestfs_fill_pattern>.");
5160 ("available", (RErr, [StringList "groups"], []), 216, [],
5161 [InitNone, Always, TestRun [["available"; ""]]],
5162 "test availability of some parts of the API",
5164 This command is used to check the availability of some
5165 groups of functionality in the appliance, which not all builds of
5166 the libguestfs appliance will be able to provide.
5168 The libguestfs groups, and the functions that those
5169 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
5170 You can also fetch this list at runtime by calling
5171 C<guestfs_available_all_groups>.
5173 The argument C<groups> is a list of group names, eg:
5174 C<[\"inotify\", \"augeas\"]> would check for the availability of
5175 the Linux inotify functions and Augeas (configuration file
5178 The command returns no error if I<all> requested groups are available.
5180 It fails with an error if one or more of the requested
5181 groups is unavailable in the appliance.
5183 If an unknown group name is included in the
5184 list of groups then an error is always returned.
5192 You must call C<guestfs_launch> before calling this function.
5194 The reason is because we don't know what groups are
5195 supported by the appliance/daemon until it is running and can
5200 If a group of functions is available, this does not necessarily
5201 mean that they will work. You still have to check for errors
5202 when calling individual API functions even if they are
5207 It is usually the job of distro packagers to build
5208 complete functionality into the libguestfs appliance.
5209 Upstream libguestfs, if built from source with all
5210 requirements satisfied, will support everything.
5214 This call was added in version C<1.0.80>. In previous
5215 versions of libguestfs all you could do would be to speculatively
5216 execute a command to find out if the daemon implemented it.
5217 See also C<guestfs_version>.
5221 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"], []), 217, [DeprecatedBy "copy_device_to_device"],
5222 [InitScratchFS, Always, TestOutputBuffer (
5224 ["write"; "/dd/src"; "hello, world"];
5225 ["dd"; "/dd/src"; "/dd/dest"];
5226 ["read_file"; "/dd/dest"]], "hello, world")],
5227 "copy from source to destination using dd",
5229 This command copies from one source device or file C<src>
5230 to another destination device or file C<dest>. Normally you
5231 would use this to copy to or from a device or partition, for
5232 example to duplicate a filesystem.
5234 If the destination is a device, it must be as large or larger
5235 than the source file or device, otherwise the copy will fail.
5236 This command cannot do partial copies
5237 (see C<guestfs_copy_device_to_device>).");
5239 ("filesize", (RInt64 "size", [Pathname "file"], []), 218, [],
5240 [InitScratchFS, Always, TestOutputInt (
5241 [["write"; "/filesize"; "hello, world"];
5242 ["filesize"; "/filesize"]], 12)],
5243 "return the size of the file in bytes",
5245 This command returns the size of C<file> in bytes.
5247 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
5248 C<guestfs_is_dir>, C<guestfs_is_file> etc.
5249 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
5251 ("lvrename", (RErr, [String "logvol"; String "newlogvol"], []), 219, [],
5252 [InitBasicFSonLVM, Always, TestOutputList (
5253 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
5254 ["lvs"]], ["/dev/VG/LV2"])],
5255 "rename an LVM logical volume",
5257 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
5259 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"], []), 220, [],
5260 [InitBasicFSonLVM, Always, TestOutputList (
5262 ["vg_activate"; "false"; "VG"];
5263 ["vgrename"; "VG"; "VG2"];
5264 ["vg_activate"; "true"; "VG2"];
5265 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
5266 ["vgs"]], ["VG2"])],
5267 "rename an LVM volume group",
5269 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
5271 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"], []), 221, [ProtocolLimitWarning],
5272 [InitISOFS, Always, TestOutputBuffer (
5273 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
5274 "list the contents of a single file in an initrd",
5276 This command unpacks the file C<filename> from the initrd file
5277 called C<initrdpath>. The filename must be given I<without> the
5278 initial C</> character.
5280 For example, in guestfish you could use the following command
5281 to examine the boot script (usually called C</init>)
5282 contained in a Linux initrd or initramfs image:
5284 initrd-cat /boot/initrd-<version>.img init
5286 See also C<guestfs_initrd_list>.");
5288 ("pvuuid", (RString "uuid", [Device "device"], []), 222, [],
5290 "get the UUID of a physical volume",
5292 This command returns the UUID of the LVM PV C<device>.");
5294 ("vguuid", (RString "uuid", [String "vgname"], []), 223, [],
5296 "get the UUID of a volume group",
5298 This command returns the UUID of the LVM VG named C<vgname>.");
5300 ("lvuuid", (RString "uuid", [Device "device"], []), 224, [],
5302 "get the UUID of a logical volume",
5304 This command returns the UUID of the LVM LV C<device>.");
5306 ("vgpvuuids", (RStringList "uuids", [String "vgname"], []), 225, [],
5308 "get the PV UUIDs containing the volume group",
5310 Given a VG called C<vgname>, this returns the UUIDs of all
5311 the physical volumes that this volume group resides on.
5313 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
5314 calls to associate physical volumes and volume groups.
5316 See also C<guestfs_vglvuuids>.");
5318 ("vglvuuids", (RStringList "uuids", [String "vgname"], []), 226, [],
5320 "get the LV UUIDs of all LVs in the volume group",
5322 Given a VG called C<vgname>, this returns the UUIDs of all
5323 the logical volumes created in this volume group.
5325 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
5326 calls to associate logical volumes and volume groups.
5328 See also C<guestfs_vgpvuuids>.");
5330 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"], []), 227, [Progress; DeprecatedBy "copy_device_to_device"],
5331 [InitScratchFS, Always, TestOutputBuffer (
5332 [["mkdir"; "/copy_size"];
5333 ["write"; "/copy_size/src"; "hello, world"];
5334 ["copy_size"; "/copy_size/src"; "/copy_size/dest"; "5"];
5335 ["read_file"; "/copy_size/dest"]], "hello")],
5336 "copy size bytes from source to destination using dd",
5338 This command copies exactly C<size> bytes from one source device
5339 or file C<src> to another destination device or file C<dest>.
5341 Note this will fail if the source is too short or if the destination
5342 is not large enough.");
5344 ("zero_device", (RErr, [Device "device"], []), 228, [Progress],
5345 [InitBasicFSonLVM, Always, TestRun (
5346 [["zero_device"; "/dev/VG/LV"]])],
5347 "write zeroes to an entire device",
5349 This command writes zeroes over the entire C<device>. Compare
5350 with C<guestfs_zero> which just zeroes the first few blocks of
5353 If blocks are already zero, then this command avoids writing
5354 zeroes. This prevents the underlying device from becoming non-sparse
5355 or growing unnecessarily.");
5357 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"], []), 229, [Optional "xz"],
5358 [InitScratchFS, Always, TestOutput (
5359 [["mkdir"; "/txz_in"];
5360 ["txz_in"; "../images/helloworld.tar.xz"; "/txz_in"];
5361 ["cat"; "/txz_in/hello"]], "hello\n")],
5362 "unpack compressed tarball to directory",
5364 This command uploads and unpacks local file C<tarball> (an
5365 I<xz compressed> tar file) into C<directory>.");
5367 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"], []), 230, [Optional "xz"],
5369 "pack directory into compressed tarball",
5371 This command packs the contents of C<directory> and downloads
5372 it to local file C<tarball> (as an xz compressed tar archive).");
5374 ("ntfsresize", (RErr, [Device "device"], []), 231, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5376 "resize an NTFS filesystem",
5378 This command resizes an NTFS filesystem, expanding or
5379 shrinking it to the size of the underlying device.
5381 I<Note:> After the resize operation, the filesystem is marked
5382 as requiring a consistency check (for safety). You have to boot
5383 into Windows to perform this check and clear this condition.
5384 Furthermore, ntfsresize refuses to resize filesystems
5385 which have been marked in this way. So in effect it is
5386 not possible to call ntfsresize multiple times on a single
5387 filesystem without booting into Windows between each resize.
5389 See also L<ntfsresize(8)>.");
5391 ("vgscan", (RErr, [], []), 232, [],
5392 [InitEmpty, Always, TestRun (
5394 "rescan for LVM physical volumes, volume groups and logical volumes",
5396 This rescans all block devices and rebuilds the list of LVM
5397 physical volumes, volume groups and logical volumes.");
5399 ("part_del", (RErr, [Device "device"; Int "partnum"], []), 233, [],
5400 [InitEmpty, Always, TestRun (
5401 [["part_init"; "/dev/sda"; "mbr"];
5402 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5403 ["part_del"; "/dev/sda"; "1"]])],
5404 "delete a partition",
5406 This command deletes the partition numbered C<partnum> on C<device>.
5408 Note that in the case of MBR partitioning, deleting an
5409 extended partition also deletes any logical partitions
5412 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"], []), 234, [],
5413 [InitEmpty, Always, TestOutputTrue (
5414 [["part_init"; "/dev/sda"; "mbr"];
5415 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5416 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
5417 ["part_get_bootable"; "/dev/sda"; "1"]])],
5418 "return true if a partition is bootable",
5420 This command returns true if the partition C<partnum> on
5421 C<device> has the bootable flag set.
5423 See also C<guestfs_part_set_bootable>.");
5425 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"], []), 235, [FishOutput FishOutputHexadecimal],
5426 [InitEmpty, Always, TestOutputInt (
5427 [["part_init"; "/dev/sda"; "mbr"];
5428 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
5429 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
5430 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
5431 "get the MBR type byte (ID byte) from a partition",
5433 Returns the MBR type byte (also known as the ID byte) from
5434 the numbered partition C<partnum>.
5436 Note that only MBR (old DOS-style) partitions have type bytes.
5437 You will get undefined results for other partition table
5438 types (see C<guestfs_part_get_parttype>).");
5440 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"], []), 236, [],
5441 [], (* tested by part_get_mbr_id *)
5442 "set the MBR type byte (ID byte) of a partition",
5444 Sets the MBR type byte (also known as the ID byte) of
5445 the numbered partition C<partnum> to C<idbyte>. Note
5446 that the type bytes quoted in most documentation are
5447 in fact hexadecimal numbers, but usually documented
5448 without any leading \"0x\" which might be confusing.
5450 Note that only MBR (old DOS-style) partitions have type bytes.
5451 You will get undefined results for other partition table
5452 types (see C<guestfs_part_get_parttype>).");
5454 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"], []), 237, [],
5455 [InitISOFS, Always, TestOutputFileMD5 (
5456 [["checksum_device"; "md5"; "/dev/sdd"]],
5457 "../images/test.iso")],
5458 "compute MD5, SHAx or CRC checksum of the contents of a device",
5460 This call computes the MD5, SHAx or CRC checksum of the
5461 contents of the device named C<device>. For the types of
5462 checksums supported see the C<guestfs_checksum> command.");
5464 ("lvresize_free", (RErr, [Device "lv"; Int "percent"], []), 238, [Optional "lvm2"],
5465 [InitNone, Always, TestRun (
5466 [["part_disk"; "/dev/sda"; "mbr"];
5467 ["pvcreate"; "/dev/sda1"];
5468 ["vgcreate"; "VG"; "/dev/sda1"];
5469 ["lvcreate"; "LV"; "VG"; "10"];
5470 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
5471 "expand an LV to fill free space",
5473 This expands an existing logical volume C<lv> so that it fills
5474 C<pc>% of the remaining free space in the volume group. Commonly
5475 you would call this with pc = 100 which expands the logical volume
5476 as much as possible, using all remaining free space in the volume
5479 ("aug_clear", (RErr, [String "augpath"], []), 239, [Optional "augeas"],
5480 [], (* XXX Augeas code needs tests. *)
5481 "clear Augeas path",
5483 Set the value associated with C<path> to C<NULL>. This
5484 is the same as the L<augtool(1)> C<clear> command.");
5486 ("get_umask", (RInt "mask", [], []), 240, [FishOutput FishOutputOctal],
5487 [InitEmpty, Always, TestOutputInt (
5488 [["get_umask"]], 0o22)],
5489 "get the current umask",
5491 Return the current umask. By default the umask is C<022>
5492 unless it has been set by calling C<guestfs_umask>.");
5494 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"], []), 241, [NotInDocs],
5496 "upload a file to the appliance (internal use only)",
5498 The C<guestfs_debug_upload> command uploads a file to
5499 the libguestfs appliance.
5501 There is no comprehensive help for this command. You have
5502 to look at the file C<daemon/debug.c> in the libguestfs source
5503 to find out what it is for.");
5505 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"], []), 242, [],
5506 [InitScratchFS, Always, TestOutput (
5507 [["base64_in"; "../images/hello.b64"; "/base64_in"];
5508 ["cat"; "/base64_in"]], "hello\n")],
5509 "upload base64-encoded data to file",
5511 This command uploads base64-encoded data from C<base64file>
5514 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"], []), 243, [],
5516 "download file and encode as base64",
5518 This command downloads the contents of C<filename>, writing
5519 it out to local file C<base64file> encoded as base64.");
5521 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"], []), 244, [],
5523 "compute MD5, SHAx or CRC checksum of files in a directory",
5525 This command computes the checksums of all regular files in
5526 C<directory> and then emits a list of those checksums to
5527 the local output file C<sumsfile>.
5529 This can be used for verifying the integrity of a virtual
5530 machine. However to be properly secure you should pay
5531 attention to the output of the checksum command (it uses
5532 the ones from GNU coreutils). In particular when the
5533 filename is not printable, coreutils uses a special
5534 backslash syntax. For more information, see the GNU
5535 coreutils info file.");
5537 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"], []), 245, [Progress],
5538 [InitScratchFS, Always, TestOutputBuffer (
5539 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/fill_pattern"];
5540 ["read_file"; "/fill_pattern"]], "abcdefghijklmnopqrstuvwxyzab")],
5541 "fill a file with a repeating pattern of bytes",
5543 This function is like C<guestfs_fill> except that it creates
5544 a new file of length C<len> containing the repeating pattern
5545 of bytes in C<pattern>. The pattern is truncated if necessary
5546 to ensure the length of the file is exactly C<len> bytes.");
5548 ("write", (RErr, [Pathname "path"; BufferIn "content"], []), 246, [ProtocolLimitWarning],
5549 [InitScratchFS, Always, TestOutput (
5550 [["write"; "/write"; "new file contents"];
5551 ["cat"; "/write"]], "new file contents");
5552 InitScratchFS, Always, TestOutput (
5553 [["write"; "/write2"; "\nnew file contents\n"];
5554 ["cat"; "/write2"]], "\nnew file contents\n");
5555 InitScratchFS, Always, TestOutput (
5556 [["write"; "/write3"; "\n\n"];
5557 ["cat"; "/write3"]], "\n\n");
5558 InitScratchFS, Always, TestOutput (
5559 [["write"; "/write4"; ""];
5560 ["cat"; "/write4"]], "");
5561 InitScratchFS, Always, TestOutput (
5562 [["write"; "/write5"; "\n\n\n"];
5563 ["cat"; "/write5"]], "\n\n\n");
5564 InitScratchFS, Always, TestOutput (
5565 [["write"; "/write6"; "\n"];
5566 ["cat"; "/write6"]], "\n")],
5567 "create a new file",
5569 This call creates a file called C<path>. The content of the
5570 file is the string C<content> (which can contain any 8 bit data).
5572 See also C<guestfs_write_append>.");
5574 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"], []), 247, [ProtocolLimitWarning],
5575 [InitScratchFS, Always, TestOutput (
5576 [["write"; "/pwrite"; "new file contents"];
5577 ["pwrite"; "/pwrite"; "data"; "4"];
5578 ["cat"; "/pwrite"]], "new data contents");
5579 InitScratchFS, Always, TestOutput (
5580 [["write"; "/pwrite2"; "new file contents"];
5581 ["pwrite"; "/pwrite2"; "is extended"; "9"];
5582 ["cat"; "/pwrite2"]], "new file is extended");
5583 InitScratchFS, Always, TestOutput (
5584 [["write"; "/pwrite3"; "new file contents"];
5585 ["pwrite"; "/pwrite3"; ""; "4"];
5586 ["cat"; "/pwrite3"]], "new file contents")],
5587 "write to part of a file",
5589 This command writes to part of a file. It writes the data
5590 buffer C<content> to the file C<path> starting at offset C<offset>.
5592 This command implements the L<pwrite(2)> system call, and like
5593 that system call it may not write the full data requested. The
5594 return value is the number of bytes that were actually written
5595 to the file. This could even be 0, although short writes are
5596 unlikely for regular files in ordinary circumstances.
5598 See also C<guestfs_pread>, C<guestfs_pwrite_device>.");
5600 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"], []), 248, [],
5602 "resize an ext2, ext3 or ext4 filesystem (with size)",
5604 This command is the same as C<guestfs_resize2fs> except that it
5605 allows you to specify the new size (in bytes) explicitly.");
5607 ("pvresize_size", (RErr, [Device "device"; Int64 "size"], []), 249, [Optional "lvm2"],
5609 "resize an LVM physical volume (with size)",
5611 This command is the same as C<guestfs_pvresize> except that it
5612 allows you to specify the new size (in bytes) explicitly.");
5614 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"], []), 250, [Optional "ntfsprogs"; DeprecatedBy "ntfsresize_opts"],
5616 "resize an NTFS filesystem (with size)",
5618 This command is the same as C<guestfs_ntfsresize> except that it
5619 allows you to specify the new size (in bytes) explicitly.");
5621 ("available_all_groups", (RStringList "groups", [], []), 251, [],
5622 [InitNone, Always, TestRun [["available_all_groups"]]],
5623 "return a list of all optional groups",
5625 This command returns a list of all optional groups that this
5626 daemon knows about. Note this returns both supported and unsupported
5627 groups. To find out which ones the daemon can actually support
5628 you have to call C<guestfs_available> on each member of the
5631 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
5633 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"], []), 252, [],
5634 [InitScratchFS, Always, TestOutputStruct (
5635 [["fallocate64"; "/fallocate64"; "1000000"];
5636 ["stat"; "/fallocate64"]], [CompareWithInt ("size", 1_000_000)])],
5637 "preallocate a file in the guest filesystem",
5639 This command preallocates a file (containing zero bytes) named
5640 C<path> of size C<len> bytes. If the file exists already, it
5643 Note that this call allocates disk blocks for the file.
5644 To create a sparse file use C<guestfs_truncate_size> instead.
5646 The deprecated call C<guestfs_fallocate> does the same,
5647 but owing to an oversight it only allowed 30 bit lengths
5648 to be specified, effectively limiting the maximum size
5649 of files created through that call to 1GB.
5651 Do not confuse this with the guestfish-specific
5652 C<alloc> and C<sparse> commands which create
5653 a file in the host and attach it as a device.");
5655 ("vfs_label", (RString "label", [Device "device"], []), 253, [],
5656 [InitBasicFS, Always, TestOutput (
5657 [["set_e2label"; "/dev/sda1"; "LTEST"];
5658 ["vfs_label"; "/dev/sda1"]], "LTEST")],
5659 "get the filesystem label",
5661 This returns the filesystem label of the filesystem on
5664 If the filesystem is unlabeled, this returns the empty string.
5666 To find a filesystem from the label, use C<guestfs_findfs_label>.");
5668 ("vfs_uuid", (RString "uuid", [Device "device"], []), 254, [],
5669 (let uuid = uuidgen () in
5670 [InitBasicFS, Always, TestOutput (
5671 [["set_e2uuid"; "/dev/sda1"; uuid];
5672 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
5673 "get the filesystem UUID",
5675 This returns the filesystem UUID of the filesystem on
5678 If the filesystem does not have a UUID, this returns the empty string.
5680 To find a filesystem from the UUID, use C<guestfs_findfs_uuid>.");
5682 ("lvm_set_filter", (RErr, [DeviceList "devices"], []), 255, [Optional "lvm2"],
5683 (* Can't be tested with the current framework because
5684 * the VG is being used by the mounted filesystem, so
5685 * the vgchange -an command we do first will fail.
5688 "set LVM device filter",
5690 This sets the LVM device filter so that LVM will only be
5691 able to \"see\" the block devices in the list C<devices>,
5692 and will ignore all other attached block devices.
5694 Where disk image(s) contain duplicate PVs or VGs, this
5695 command is useful to get LVM to ignore the duplicates, otherwise
5696 LVM can get confused. Note also there are two types
5697 of duplication possible: either cloned PVs/VGs which have
5698 identical UUIDs; or VGs that are not cloned but just happen
5699 to have the same name. In normal operation you cannot
5700 create this situation, but you can do it outside LVM, eg.
5701 by cloning disk images or by bit twiddling inside the LVM
5704 This command also clears the LVM cache and performs a volume
5707 You can filter whole block devices or individual partitions.
5709 You cannot use this if any VG is currently in use (eg.
5710 contains a mounted filesystem), even if you are not
5711 filtering out that VG.");
5713 ("lvm_clear_filter", (RErr, [], []), 256, [],
5714 [], (* see note on lvm_set_filter *)
5715 "clear LVM device filter",
5717 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
5718 will be able to see every block device.
5720 This command also clears the LVM cache and performs a volume
5723 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"], []), 257, [Optional "luks"],
5725 "open a LUKS-encrypted block device",
5727 This command opens a block device which has been encrypted
5728 according to the Linux Unified Key Setup (LUKS) standard.
5730 C<device> is the encrypted block device or partition.
5732 The caller must supply one of the keys associated with the
5733 LUKS block device, in the C<key> parameter.
5735 This creates a new block device called C</dev/mapper/mapname>.
5736 Reads and writes to this block device are decrypted from and
5737 encrypted to the underlying C<device> respectively.
5739 If this block device contains LVM volume groups, then
5740 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
5741 will make them visible.
5743 Use C<guestfs_list_dm_devices> to list all device mapper
5746 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"], []), 258, [Optional "luks"],
5748 "open a LUKS-encrypted block device read-only",
5750 This is the same as C<guestfs_luks_open> except that a read-only
5751 mapping is created.");
5753 ("luks_close", (RErr, [Device "device"], []), 259, [Optional "luks"],
5755 "close a LUKS device",
5757 This closes a LUKS device that was created earlier by
5758 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
5759 C<device> parameter must be the name of the LUKS mapping
5760 device (ie. C</dev/mapper/mapname>) and I<not> the name
5761 of the underlying block device.");
5763 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 260, [Optional "luks"],
5765 "format a block device as a LUKS encrypted device",
5767 This command erases existing data on C<device> and formats
5768 the device as a LUKS encrypted device. C<key> is the
5769 initial key, which is added to key slot C<slot>. (LUKS
5770 supports 8 key slots, numbered 0-7).");
5772 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"], []), 261, [Optional "luks"],
5774 "format a block device as a LUKS encrypted device",
5776 This command is the same as C<guestfs_luks_format> but
5777 it also allows you to set the C<cipher> used.");
5779 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"], []), 262, [Optional "luks"],
5781 "add a key on a LUKS encrypted device",
5783 This command adds a new key on LUKS device C<device>.
5784 C<key> is any existing key, and is used to access the device.
5785 C<newkey> is the new key to add. C<keyslot> is the key slot
5786 that will be replaced.
5788 Note that if C<keyslot> already contains a key, then this
5789 command will fail. You have to use C<guestfs_luks_kill_slot>
5790 first to remove that key.");
5792 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"], []), 263, [Optional "luks"],
5794 "remove a key from a LUKS encrypted device",
5796 This command deletes the key in key slot C<keyslot> from the
5797 encrypted LUKS device C<device>. C<key> must be one of the
5800 ("is_lv", (RBool "lvflag", [Device "device"], []), 264, [Optional "lvm2"],
5801 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
5802 [["is_lv"; "/dev/VG/LV"]]);
5803 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
5804 [["is_lv"; "/dev/sda1"]])],
5805 "test if device is a logical volume",
5807 This command tests whether C<device> is a logical volume, and
5808 returns true iff this is the case.");
5810 ("findfs_uuid", (RString "device", [String "uuid"], []), 265, [],
5812 "find a filesystem by UUID",
5814 This command searches the filesystems and returns the one
5815 which has the given UUID. An error is returned if no such
5816 filesystem can be found.
5818 To find the UUID of a filesystem, use C<guestfs_vfs_uuid>.");
5820 ("findfs_label", (RString "device", [String "label"], []), 266, [],
5822 "find a filesystem by label",
5824 This command searches the filesystems and returns the one
5825 which has the given label. An error is returned if no such
5826 filesystem can be found.
5828 To find the label of a filesystem, use C<guestfs_vfs_label>.");
5830 ("is_chardev", (RBool "flag", [Pathname "path"], []), 267, [],
5831 [InitISOFS, Always, TestOutputFalse (
5832 [["is_chardev"; "/directory"]]);
5833 InitScratchFS, Always, TestOutputTrue (
5834 [["mknod_c"; "0o777"; "99"; "66"; "/is_chardev"];
5835 ["is_chardev"; "/is_chardev"]])],
5836 "test if character device",
5838 This returns C<true> if and only if there is a character device
5839 with the given C<path> name.
5841 See also C<guestfs_stat>.");
5843 ("is_blockdev", (RBool "flag", [Pathname "path"], []), 268, [],
5844 [InitISOFS, Always, TestOutputFalse (
5845 [["is_blockdev"; "/directory"]]);
5846 InitScratchFS, Always, TestOutputTrue (
5847 [["mknod_b"; "0o777"; "99"; "66"; "/is_blockdev"];
5848 ["is_blockdev"; "/is_blockdev"]])],
5849 "test if block device",
5851 This returns C<true> if and only if there is a block device
5852 with the given C<path> name.
5854 See also C<guestfs_stat>.");
5856 ("is_fifo", (RBool "flag", [Pathname "path"], []), 269, [],
5857 [InitISOFS, Always, TestOutputFalse (
5858 [["is_fifo"; "/directory"]]);
5859 InitScratchFS, Always, TestOutputTrue (
5860 [["mkfifo"; "0o777"; "/is_fifo"];
5861 ["is_fifo"; "/is_fifo"]])],
5862 "test if FIFO (named pipe)",
5864 This returns C<true> if and only if there is a FIFO (named pipe)
5865 with the given C<path> name.
5867 See also C<guestfs_stat>.");
5869 ("is_symlink", (RBool "flag", [Pathname "path"], []), 270, [],
5870 [InitISOFS, Always, TestOutputFalse (
5871 [["is_symlink"; "/directory"]]);
5872 InitISOFS, Always, TestOutputTrue (
5873 [["is_symlink"; "/abssymlink"]])],
5874 "test if symbolic link",
5876 This returns C<true> if and only if there is a symbolic link
5877 with the given C<path> name.
5879 See also C<guestfs_stat>.");
5881 ("is_socket", (RBool "flag", [Pathname "path"], []), 271, [],
5882 (* XXX Need a positive test for sockets. *)
5883 [InitISOFS, Always, TestOutputFalse (
5884 [["is_socket"; "/directory"]])],
5887 This returns C<true> if and only if there is a Unix domain socket
5888 with the given C<path> name.
5890 See also C<guestfs_stat>.");
5892 ("part_to_dev", (RString "device", [Device "partition"], []), 272, [],
5893 [InitPartition, Always, TestOutputDevice (
5894 [["part_to_dev"; "/dev/sda1"]], "/dev/sda");
5895 InitEmpty, Always, TestLastFail (
5896 [["part_to_dev"; "/dev/sda"]])],
5897 "convert partition name to device name",
5899 This function takes a partition name (eg. \"/dev/sdb1\") and
5900 removes the partition number, returning the device name
5903 The named partition must exist, for example as a string returned
5904 from C<guestfs_list_partitions>.
5906 See also C<guestfs_part_to_partnum>.");
5908 ("upload_offset", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"; Int64 "offset"], []), 273, [Progress],
5909 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5910 [InitScratchFS, Always, TestOutput (
5911 [["upload_offset"; "../COPYING.LIB"; "/upload_offset"; "0"];
5912 ["checksum"; "md5"; "/upload_offset"]], md5)]),
5913 "upload a file from the local machine with offset",
5915 Upload local file C<filename> to C<remotefilename> on the
5918 C<remotefilename> is overwritten starting at the byte C<offset>
5919 specified. The intention is to overwrite parts of existing
5920 files or devices, although if a non-existant file is specified
5921 then it is created with a \"hole\" before C<offset>. The
5922 size of the data written is implicit in the size of the
5925 Note that there is no limit on the amount of data that
5926 can be uploaded with this call, unlike with C<guestfs_pwrite>,
5927 and this call always writes the full amount unless an
5930 See also C<guestfs_upload>, C<guestfs_pwrite>.");
5932 ("download_offset", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"; Int64 "offset"; Int64 "size"], []), 274, [Progress],
5933 (let md5 = Digest.to_hex (Digest.file "COPYING.LIB") in
5934 let offset = string_of_int 100 in
5935 let size = string_of_int ((Unix.stat "COPYING.LIB").Unix.st_size - 100) in
5936 [InitScratchFS, Always, TestOutput (
5937 (* Pick a file from cwd which isn't likely to change. *)
5938 [["mkdir"; "/download_offset"];
5939 ["upload"; "../COPYING.LIB"; "/download_offset/COPYING.LIB"];
5940 ["download_offset"; "/download_offset/COPYING.LIB"; "testdownload.tmp"; offset; size];
5941 ["upload_offset"; "testdownload.tmp"; "/download_offset/COPYING.LIB"; offset];
5942 ["checksum"; "md5"; "/download_offset/COPYING.LIB"]], md5)]),
5943 "download a file to the local machine with offset and size",
5945 Download file C<remotefilename> and save it as C<filename>
5946 on the local machine.
5948 C<remotefilename> is read for C<size> bytes starting at C<offset>
5949 (this region must be within the file or device).
5951 Note that there is no limit on the amount of data that
5952 can be downloaded with this call, unlike with C<guestfs_pread>,
5953 and this call always reads the full amount unless an
5956 See also C<guestfs_download>, C<guestfs_pread>.");
5958 ("pwrite_device", (RInt "nbytes", [Device "device"; BufferIn "content"; Int64 "offset"], []), 275, [ProtocolLimitWarning],
5959 [InitPartition, Always, TestOutputListOfDevices (
5960 [["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"];
5961 ["blockdev_rereadpt"; "/dev/sda"];
5962 ["list_partitions"]], ["/dev/sdb1"])],
5963 "write to part of a device",
5965 This command writes to part of a device. It writes the data
5966 buffer C<content> to C<device> starting at offset C<offset>.
5968 This command implements the L<pwrite(2)> system call, and like
5969 that system call it may not write the full data requested
5970 (although short writes to disk devices and partitions are
5971 probably impossible with standard Linux kernels).
5973 See also C<guestfs_pwrite>.");
5975 ("pread_device", (RBufferOut "content", [Device "device"; Int "count"; Int64 "offset"], []), 276, [ProtocolLimitWarning],
5976 [InitEmpty, Always, TestOutputBuffer (
5977 [["pread_device"; "/dev/sdd"; "8"; "32768"]], "\001CD001\001\000")],
5978 "read part of a device",
5980 This command lets you read part of a file. It reads C<count>
5981 bytes of C<device>, starting at C<offset>.
5983 This may read fewer bytes than requested. For further details
5984 see the L<pread(2)> system call.
5986 See also C<guestfs_pread>.");
5988 ("lvm_canonical_lv_name", (RString "lv", [Device "lvname"], []), 277, [],
5989 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5990 [["lvm_canonical_lv_name"; "/dev/mapper/VG-LV"]], "/dev/VG/LV");
5991 InitBasicFSonLVM, IfAvailable "lvm2", TestOutput (
5992 [["lvm_canonical_lv_name"; "/dev/VG/LV"]], "/dev/VG/LV")],
5993 "get canonical name of an LV",
5995 This converts alternative naming schemes for LVs that you
5996 might find to the canonical name. For example, C</dev/mapper/VG-LV>
5997 is converted to C</dev/VG/LV>.
5999 This command returns an error if the C<lvname> parameter does
6000 not refer to a logical volume.
6002 See also C<guestfs_is_lv>.");
6004 ("mkfs_opts", (RErr, [String "fstype"; Device "device"], [Int "blocksize"; String "features"; Int "inode"; Int "sectorsize"]), 278, [],
6005 [InitEmpty, Always, TestOutput (
6006 [["part_disk"; "/dev/sda"; "mbr"];
6007 ["mkfs_opts"; "ext2"; "/dev/sda1"; ""; "NOARG"; ""; ""];
6008 ["mount_options"; ""; "/dev/sda1"; "/"];
6009 ["write"; "/new"; "new file contents"];
6010 ["cat"; "/new"]], "new file contents")],
6011 "make a filesystem",
6013 This function creates a filesystem on C<device>. The filesystem
6014 type is C<fstype>, for example C<ext3>.
6016 The optional arguments are:
6022 The filesystem block size. Supported block sizes depend on the
6023 filesystem type, but typically they are C<1024>, C<2048> or C<4096>
6024 for Linux ext2/3 filesystems.
6026 For VFAT and NTFS the C<blocksize> parameter is treated as
6027 the requested cluster size.
6029 For UFS block sizes, please see L<mkfs.ufs(8)>.
6033 This passes the I<-O> parameter to the external mkfs program.
6035 For certain filesystem types, this allows extra filesystem
6036 features to be selected. See L<mke2fs(8)> and L<mkfs.ufs(8)>
6039 You cannot use this optional parameter with the C<gfs> or
6040 C<gfs2> filesystem type.
6044 This passes the I<-I> parameter to the external L<mke2fs(8)> program
6045 which sets the inode size (only for ext2/3/4 filesystems at present).
6049 This passes the I<-S> parameter to external L<mkfs.ufs(8)> program,
6050 which sets sector size for ufs filesystem.
6054 ("getxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 279, [Optional "linuxxattrs"],
6056 "get a single extended attribute",
6058 Get a single extended attribute from file C<path> named C<name>.
6059 This call follows symlinks. If you want to lookup an extended
6060 attribute for the symlink itself, use C<guestfs_lgetxattr>.
6062 Normally it is better to get all extended attributes from a file
6063 in one go by calling C<guestfs_getxattrs>. However some Linux
6064 filesystem implementations are buggy and do not provide a way to
6065 list out attributes. For these filesystems (notably ntfs-3g)
6066 you have to know the names of the extended attributes you want
6067 in advance and call this function.
6069 Extended attribute values are blobs of binary data. If there
6070 is no extended attribute named C<name>, this returns an error.
6072 See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>.");
6074 ("lgetxattr", (RBufferOut "xattr", [Pathname "path"; String "name"], []), 280, [Optional "linuxxattrs"],
6076 "get a single extended attribute",
6078 Get a single extended attribute from file C<path> named C<name>.
6079 If C<path> is a symlink, then this call returns an extended
6080 attribute from the symlink.
6082 Normally it is better to get all extended attributes from a file
6083 in one go by calling C<guestfs_getxattrs>. However some Linux
6084 filesystem implementations are buggy and do not provide a way to
6085 list out attributes. For these filesystems (notably ntfs-3g)
6086 you have to know the names of the extended attributes you want
6087 in advance and call this function.
6089 Extended attribute values are blobs of binary data. If there
6090 is no extended attribute named C<name>, this returns an error.
6092 See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>.");
6094 ("resize2fs_M", (RErr, [Device "device"], []), 281, [],
6096 "resize an ext2, ext3 or ext4 filesystem to the minimum size",
6098 This command is the same as C<guestfs_resize2fs>, but the filesystem
6099 is resized to its minimum size. This works like the I<-M> option
6100 to the C<resize2fs> command.
6102 To get the resulting size of the filesystem you should call
6103 C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count>
6104 values. These two numbers, multiplied together, give the
6105 resulting size of the minimal filesystem in bytes.");
6107 ("internal_autosync", (RErr, [], []), 282, [NotInFish; NotInDocs],
6109 "internal autosync operation",
6111 This command performs the autosync operation just before the
6112 handle is closed. You should not call this command directly.
6113 Instead, use the autosync flag (C<guestfs_set_autosync>) to
6114 control whether or not this operation is performed when the
6115 handle is closed.");
6117 ("is_zero", (RBool "zeroflag", [Pathname "path"], []), 283, [],
6118 [InitISOFS, Always, TestOutputTrue (
6119 [["is_zero"; "/100kallzeroes"]]);
6120 InitISOFS, Always, TestOutputFalse (
6121 [["is_zero"; "/100kallspaces"]])],
6122 "test if a file contains all zero bytes",
6124 This returns true iff the file exists and the file is empty or
6125 it contains all zero bytes.");
6127 ("is_zero_device", (RBool "zeroflag", [Device "device"], []), 284, [],
6128 [InitBasicFS, Always, TestOutputTrue (
6129 [["umount"; "/dev/sda1"];
6130 ["zero_device"; "/dev/sda1"];
6131 ["is_zero_device"; "/dev/sda1"]]);
6132 InitBasicFS, Always, TestOutputFalse (
6133 [["is_zero_device"; "/dev/sda1"]])],
6134 "test if a device contains all zero bytes",
6136 This returns true iff the device exists and contains all zero bytes.
6138 Note that for large devices this can take a long time to run.");
6140 ("list_9p", (RStringList "mounttags", [], []), 285, [],
6142 "list 9p filesystems",
6144 List all 9p filesystems attached to the guest. A list of
6145 mount tags is returned.");
6147 ("mount_9p", (RErr, [String "mounttag"; String "mountpoint"], [String "options"]), 286, [],
6149 "mount 9p filesystem",
6151 Mount the virtio-9p filesystem with the tag C<mounttag> on the
6152 directory C<mountpoint>.
6154 If required, C<trans=virtio> will be automatically added to the options.
6155 Any other options required can be passed in the optional C<options>
6158 ("list_dm_devices", (RStringList "devices", [], []), 287, [],
6160 "list device mapper devices",
6162 List all device mapper devices.
6164 The returned list contains C</dev/mapper/*> devices, eg. ones created
6165 by a previous call to C<guestfs_luks_open>.
6167 Device mapper devices which correspond to logical volumes are I<not>
6168 returned in this list. Call C<guestfs_lvs> if you want to list logical
6171 ("ntfsresize_opts", (RErr, [Device "device"], [Int64 "size"; Bool "force"]), 288, [Optional "ntfsprogs"],
6173 "resize an NTFS filesystem",
6175 This command resizes an NTFS filesystem, expanding or
6176 shrinking it to the size of the underlying device.
6178 The optional parameters are:
6184 The new size (in bytes) of the filesystem. If omitted, the filesystem
6185 is resized to fit the container (eg. partition).
6189 If this option is true, then force the resize of the filesystem
6190 even if the filesystem is marked as requiring a consistency check.
6192 After the resize operation, the filesystem is always marked
6193 as requiring a consistency check (for safety). You have to boot
6194 into Windows to perform this check and clear this condition.
6195 If you I<don't> set the C<force> option then it is not
6196 possible to call C<guestfs_ntfsresize_opts> multiple times on a
6197 single filesystem without booting into Windows between each resize.
6201 See also L<ntfsresize(8)>.");
6203 ("btrfs_filesystem_resize", (RErr, [Pathname "mountpoint"], [Int64 "size"]), 289, [Optional "btrfs"],
6205 "resize a btrfs filesystem",
6207 This command resizes a btrfs filesystem.
6209 Note that unlike other resize calls, the filesystem has to be
6210 mounted and the parameter is the mountpoint not the device
6211 (this is a requirement of btrfs itself).
6213 The optional parameters are:
6219 The new size (in bytes) of the filesystem. If omitted, the filesystem
6220 is resized to the maximum size.
6224 See also L<btrfs(8)>.");
6226 ("write_append", (RErr, [Pathname "path"; BufferIn "content"], []), 290, [ProtocolLimitWarning],
6227 [InitScratchFS, Always, TestOutput (
6228 [["write"; "/write_append"; "line1\n"];
6229 ["write_append"; "/write_append"; "line2\n"];
6230 ["write_append"; "/write_append"; "line3a"];
6231 ["write_append"; "/write_append"; "line3b\n"];
6232 ["cat"; "/write_append"]], "line1\nline2\nline3aline3b\n")],
6233 "append content to end of file",
6235 This call appends C<content> to the end of file C<path>. If
6236 C<path> does not exist, then a new file is created.
6238 See also C<guestfs_write>.");
6240 ("compress_out", (RErr, [String "ctype"; Pathname "file"; FileOut "zfile"], [Int "level"]), 291, [],
6242 "output compressed file",
6244 This command compresses C<file> and writes it out to the local
6247 The compression program used is controlled by the C<ctype> parameter.
6248 Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.
6249 Some compression types may not be supported by particular builds of
6250 libguestfs, in which case you will get an error containing the
6251 substring \"not supported\".
6253 The optional C<level> parameter controls compression level. The
6254 meaning and default for this parameter depends on the compression
6255 program being used.");
6257 ("compress_device_out", (RErr, [String "ctype"; Device "device"; FileOut "zdevice"], [Int "level"]), 292, [],
6259 "output compressed device",
6261 This command compresses C<device> and writes it out to the local
6264 The C<ctype> and optional C<level> parameters have the same meaning
6265 as in C<guestfs_compress_out>.");
6267 ("part_to_partnum", (RInt "partnum", [Device "partition"], []), 293, [],
6268 [InitPartition, Always, TestOutputInt (
6269 [["part_to_partnum"; "/dev/sda1"]], 1);
6270 InitEmpty, Always, TestLastFail (
6271 [["part_to_partnum"; "/dev/sda"]])],
6272 "convert partition name to partition number",
6274 This function takes a partition name (eg. \"/dev/sdb1\") and
6275 returns the partition number (eg. C<1>).
6277 The named partition must exist, for example as a string returned
6278 from C<guestfs_list_partitions>.
6280 See also C<guestfs_part_to_dev>.");
6282 ("copy_device_to_device", (RErr, [Device "src"; Device "dest"], [Int64 "srcoffset"; Int64 "destoffset"; Int64 "size"]), 294, [Progress],
6284 "copy from source device to destination device",
6286 The four calls C<guestfs_copy_device_to_device>,
6287 C<guestfs_copy_device_to_file>,
6288 C<guestfs_copy_file_to_device>, and
6289 C<guestfs_copy_file_to_file>
6290 let you copy from a source (device|file) to a destination
6293 Partial copies can be made since you can specify optionally
6294 the source offset, destination offset and size to copy. These
6295 values are all specified in bytes. If not given, the offsets
6296 both default to zero, and the size defaults to copying as much
6297 as possible until we hit the end of the source.
6299 The source and destination may be the same object. However
6300 overlapping regions may not be copied correctly.
6302 If the destination is a file, it is created if required. If
6303 the destination file is not large enough, it is extended.");
6305 ("copy_device_to_file", (RErr, [Device "src"; Pathname "dest"], [Int64 "srcoffset"; Int64 "destoffset"; Int64 "size"]), 295, [Progress],
6307 "copy from source device to destination file",
6309 See C<guestfs_copy_device_to_device> for a general overview
6312 ("copy_file_to_device", (RErr, [Pathname "src"; Device "dest"], [Int64 "srcoffset"; Int64 "destoffset"; Int64 "size"]), 296, [Progress],
6314 "copy from source file to destination device",
6316 See C<guestfs_copy_device_to_device> for a general overview
6319 ("copy_file_to_file", (RErr, [Pathname "src"; Pathname "dest"], [Int64 "srcoffset"; Int64 "destoffset"; Int64 "size"]), 297, [Progress],
6320 [InitScratchFS, Always, TestOutputBuffer (
6321 [["mkdir"; "/copyff"];
6322 ["write"; "/copyff/src"; "hello, world"];
6323 ["copy_file_to_file"; "/copyff/src"; "/copyff/dest"; ""; ""; ""];
6324 ["read_file"; "/copyff/dest"]], "hello, world")],
6325 "copy from source file to destination file",
6327 See C<guestfs_copy_device_to_device> for a general overview
6330 This is B<not> the function you want for copying files. This
6331 is for copying blocks within existing files. See C<guestfs_cp>,
6332 C<guestfs_cp_a> and C<guestfs_mv> for general file copying and
6333 moving functions.");
6337 let all_functions = non_daemon_functions @ daemon_functions
6339 (* In some places we want the functions to be displayed sorted
6340 * alphabetically, so this is useful:
6342 let all_functions_sorted = List.sort action_compare all_functions
6344 (* This is used to generate the src/MAX_PROC_NR file which
6345 * contains the maximum procedure number, a surrogate for the
6346 * ABI version number. See src/Makefile.am for the details.
6349 let proc_nrs = List.map (
6350 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
6351 ) daemon_functions in
6352 List.fold_left max 0 proc_nrs
6354 (* Non-API meta-commands available only in guestfish.
6356 * Note (1): style, proc_nr and tests fields are all meaningless.
6357 * The only fields which are actually used are the shortname,
6358 * FishAlias flags, shortdesc and longdesc.
6360 * Note (2): to refer to other commands, use L</shortname>.
6362 * Note (3): keep this list sorted by shortname.
6364 let fish_commands = [
6365 ("alloc", (RErr,[], []), -1, [FishAlias "allocate"], [],
6366 "allocate and add a disk file",
6367 " alloc filename size
6369 This creates an empty (zeroed) file of the given size, and then adds
6370 so it can be further examined.
6372 For more advanced image creation, see L<qemu-img(1)> utility.
6374 Size can be specified using standard suffixes, eg. C<1M>.
6376 To create a sparse file, use L</sparse> instead. To create a
6377 prepared disk image, see L</PREPARED DISK IMAGES>.");
6379 ("copy_in", (RErr,[], []), -1, [], [],
6380 "copy local files or directories into an image",
6381 " copy-in local [local ...] /remotedir
6383 C<copy-in> copies local files or directories recursively into the disk
6384 image, placing them in the directory called C</remotedir> (which must
6385 exist). This guestfish meta-command turns into a sequence of
6386 L</tar-in> and other commands as necessary.
6388 Multiple local files and directories can be specified, but the last
6389 parameter must always be a remote directory. Wildcards cannot be
6392 ("copy_out", (RErr,[], []), -1, [], [],
6393 "copy remote files or directories out of an image",
6394 " copy-out remote [remote ...] localdir
6396 C<copy-out> copies remote files or directories recursively out of the
6397 disk image, placing them on the host disk in a local directory called
6398 C<localdir> (which must exist). This guestfish meta-command turns
6399 into a sequence of L</download>, L</tar-out> and other commands as
6402 Multiple remote files and directories can be specified, but the last
6403 parameter must always be a local directory. To download to the
6404 current directory, use C<.> as in:
6408 Wildcards cannot be used in the ordinary command, but you can use
6409 them with the help of L</glob> like this:
6411 glob copy-out /home/* .");
6413 ("display", (RErr,[], []), -1, [], [],
6417 Use C<display> (a graphical display program) to display an image
6418 file. It downloads the file, and runs C<display> on it.
6420 To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE>
6421 environment variable. For example to use the GNOME display program:
6423 export GUESTFISH_DISPLAY_IMAGE=eog
6425 See also L<display(1)>.");
6427 ("echo", (RErr,[], []), -1, [], [],
6428 "display a line of text",
6431 This echos the parameters to the terminal.");
6433 ("edit", (RErr,[], []), -1, [FishAlias "vi"; FishAlias "emacs"], [],
6437 This is used to edit a file. It downloads the file, edits it
6438 locally using your editor, then uploads the result.
6440 The editor is C<$EDITOR>. However if you use the alternate
6441 commands C<vi> or C<emacs> you will get those corresponding
6444 ("glob", (RErr,[], []), -1, [], [],
6445 "expand wildcards in command",
6446 " glob command args...
6448 Expand wildcards in any paths in the args list, and run C<command>
6449 repeatedly on each matching path.
6451 See L</WILDCARDS AND GLOBBING>.");
6453 ("hexedit", (RErr,[], []), -1, [], [],
6454 "edit with a hex editor",
6455 " hexedit <filename|device>
6456 hexedit <filename|device> <max>
6457 hexedit <filename|device> <start> <max>
6459 Use hexedit (a hex editor) to edit all or part of a binary file
6462 This command works by downloading potentially the whole file or
6463 device, editing it locally, then uploading it. If the file or
6464 device is large, you have to specify which part you wish to edit
6465 by using C<max> and/or C<start> C<max> parameters.
6466 C<start> and C<max> are specified in bytes, with the usual
6467 modifiers allowed such as C<1M> (1 megabyte).
6469 For example to edit the first few sectors of a disk you
6474 which would allow you to edit anywhere within the first megabyte
6477 To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:
6479 hexedit /dev/sda1 0x400 0x400
6481 (assuming the superblock is in the standard location).
6483 This command requires the external L<hexedit(1)> program. You
6484 can specify another program to use by setting the C<HEXEDITOR>
6485 environment variable.
6487 See also L</hexdump>.");
6489 ("lcd", (RErr,[], []), -1, [], [],
6490 "change working directory",
6493 Change the local directory, ie. the current directory of guestfish
6496 Note that C<!cd> won't do what you might expect.");
6498 ("man", (RErr,[], []), -1, [FishAlias "manual"], [],
6502 Opens the manual page for guestfish.");
6504 ("more", (RErr,[], []), -1, [FishAlias "less"], [],
6510 This is used to view a file.
6512 The default viewer is C<$PAGER>. However if you use the alternate
6513 command C<less> you will get the C<less> command specifically.");
6515 ("reopen", (RErr,[], []), -1, [], [],
6516 "close and reopen libguestfs handle",
6519 Close and reopen the libguestfs handle. It is not necessary to use
6520 this normally, because the handle is closed properly when guestfish
6521 exits. However this is occasionally useful for testing.");
6523 ("setenv", (RErr,[], []), -1, [], [],
6524 "set an environment variable",
6527 Set the environment variable C<VAR> to the string C<value>.
6529 To print the value of an environment variable use a shell command
6534 ("sparse", (RErr,[], []), -1, [], [],
6535 "create a sparse disk image and add",
6536 " sparse filename size
6538 This creates an empty sparse file of the given size, and then adds
6539 so it can be further examined.
6541 In all respects it works the same as the L</alloc> command, except that
6542 the image file is allocated sparsely, which means that disk blocks are
6543 not assigned to the file until they are needed. Sparse disk files
6544 only use space when written to, but they are slower and there is a
6545 danger you could run out of real disk space during a write operation.
6547 For more advanced image creation, see L<qemu-img(1)> utility.
6549 Size can be specified using standard suffixes, eg. C<1M>.");
6551 ("supported", (RErr,[], []), -1, [], [],
6552 "list supported groups of commands",
6555 This command returns a list of the optional groups
6556 known to the daemon, and indicates which ones are
6557 supported by this build of the libguestfs appliance.
6559 See also L<guestfs(3)/AVAILABILITY>.");
6561 ("time", (RErr,[], []), -1, [], [],
6562 "print elapsed time taken to run a command",
6563 " time command args...
6565 Run the command as usual, but print the elapsed time afterwards. This
6566 can be useful for benchmarking operations.");
6568 ("unsetenv", (RErr,[], []), -1, [], [],
6569 "unset an environment variable",
6572 Remove C<VAR> from the environment.");