3 * Copyright (C) 2009-2010 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
168 (* Opaque buffer which can contain arbitrary 8 bit data.
169 * In the C API, this is expressed as <char *, int> pair.
170 * Most other languages have a string type which can contain
171 * ASCII NUL. We use whatever type is appropriate for each
173 * Buffers are limited by the total message size. To transfer
174 * large blocks of data, use FileIn/FileOut parameters instead.
175 * To return an arbitrary buffer, use RBufferOut.
181 | ProtocolLimitWarning (* display warning about protocol size limits *)
182 | DangerWillRobinson (* flags particularly dangerous commands *)
183 | FishAlias of string (* provide an alias for this cmd in guestfish *)
184 | FishAction of string (* call this function in guestfish *)
185 | FishOutput of fish_output_t (* how to display output in guestfish *)
186 | NotInFish (* do not export via guestfish *)
187 | NotInDocs (* do not add this function to documentation *)
188 | DeprecatedBy of string (* function is deprecated, use .. instead *)
189 | Optional of string (* function is part of an optional group *)
192 | FishOutputOctal (* for int return, print in octal *)
193 | FishOutputHexadecimal (* for int return, print in hex *)
195 (* You can supply zero or as many tests as you want per API call.
197 * Note that the test environment has 3 block devices, of size 500MB,
198 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
199 * a fourth ISO block device with some known files on it (/dev/sdd).
201 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
202 * Number of cylinders was 63 for IDE emulated disks with precisely
203 * the same size. How exactly this is calculated is a mystery.
205 * The ISO block device (/dev/sdd) comes from images/test.iso.
207 * To be able to run the tests in a reasonable amount of time,
208 * the virtual machine and block devices are reused between tests.
209 * So don't try testing kill_subprocess :-x
211 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
213 * Don't assume anything about the previous contents of the block
214 * devices. Use 'Init*' to create some initial scenarios.
216 * You can add a prerequisite clause to any individual test. This
217 * is a run-time check, which, if it fails, causes the test to be
218 * skipped. Useful if testing a command which might not work on
219 * all variations of libguestfs builds. A test that has prerequisite
220 * of 'Always' is run unconditionally.
222 * In addition, packagers can skip individual tests by setting the
223 * environment variables: eg:
224 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
225 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
227 type tests = (test_init * test_prereq * test) list
229 (* Run the command sequence and just expect nothing to fail. *)
232 (* Run the command sequence and expect the output of the final
233 * command to be the string.
235 | TestOutput of seq * string
237 (* Run the command sequence and expect the output of the final
238 * command to be the list of strings.
240 | TestOutputList of seq * string list
242 (* Run the command sequence and expect the output of the final
243 * command to be the list of block devices (could be either
244 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
245 * character of each string).
247 | TestOutputListOfDevices of seq * string list
249 (* Run the command sequence and expect the output of the final
250 * command to be the integer.
252 | TestOutputInt of seq * int
254 (* Run the command sequence and expect the output of the final
255 * command to be <op> <int>, eg. ">=", "1".
257 | TestOutputIntOp of seq * string * int
259 (* Run the command sequence and expect the output of the final
260 * command to be a true value (!= 0 or != NULL).
262 | TestOutputTrue of seq
264 (* Run the command sequence and expect the output of the final
265 * command to be a false value (== 0 or == NULL, but not an error).
267 | TestOutputFalse of seq
269 (* Run the command sequence and expect the output of the final
270 * command to be a list of the given length (but don't care about
273 | TestOutputLength of seq * int
275 (* Run the command sequence and expect the output of the final
276 * command to be a buffer (RBufferOut), ie. string + size.
278 | TestOutputBuffer of seq * string
280 (* Run the command sequence and expect the output of the final
281 * command to be a structure.
283 | TestOutputStruct of seq * test_field_compare list
285 (* Run the command sequence and expect the final command (only)
288 | TestLastFail of seq
290 and test_field_compare =
291 | CompareWithInt of string * int
292 | CompareWithIntOp of string * string * int
293 | CompareWithString of string * string
294 | CompareFieldsIntEq of string * string
295 | CompareFieldsStrEq of string * string
297 (* Test prerequisites. *)
299 (* Test always runs. *)
302 (* Test is currently disabled - eg. it fails, or it tests some
303 * unimplemented feature.
307 (* 'string' is some C code (a function body) that should return
308 * true or false. The test will run if the code returns true.
312 (* As for 'If' but the test runs _unless_ the code returns true. *)
315 (* Some initial scenarios for testing. *)
317 (* Do nothing, block devices could contain random stuff including
318 * LVM PVs, and some filesystems might be mounted. This is usually
323 (* Block devices are empty and no filesystems are mounted. *)
326 (* /dev/sda contains a single partition /dev/sda1, with random
327 * content. /dev/sdb and /dev/sdc may have random content.
332 (* /dev/sda contains a single partition /dev/sda1, which is formatted
333 * as ext2, empty [except for lost+found] and mounted on /.
334 * /dev/sdb and /dev/sdc may have random content.
340 * /dev/sda1 (is a PV):
341 * /dev/VG/LV (size 8MB):
342 * formatted as ext2, empty [except for lost+found], mounted on /
343 * /dev/sdb and /dev/sdc may have random content.
347 (* /dev/sdd (the ISO, see images/ directory in source)
352 (* Sequence of commands for testing. *)
354 and cmd = string list
356 (* Note about long descriptions: When referring to another
357 * action, use the format C<guestfs_other> (ie. the full name of
358 * the C function). This will be replaced as appropriate in other
361 * Apart from that, long descriptions are just perldoc paragraphs.
364 (* Generate a random UUID (used in tests). *)
366 let chan = open_process_in "uuidgen" in
367 let uuid = input_line chan in
368 (match close_process_in chan with
371 failwith "uuidgen: process exited with non-zero status"
372 | WSIGNALED _ | WSTOPPED _ ->
373 failwith "uuidgen: process signalled or stopped by signal"
377 (* These test functions are used in the language binding tests. *)
379 let test_all_args = [
382 StringList "strlist";
390 let test_all_rets = [
391 (* except for RErr, which is tested thoroughly elsewhere *)
392 "test0rint", RInt "valout";
393 "test0rint64", RInt64 "valout";
394 "test0rbool", RBool "valout";
395 "test0rconststring", RConstString "valout";
396 "test0rconstoptstring", RConstOptString "valout";
397 "test0rstring", RString "valout";
398 "test0rstringlist", RStringList "valout";
399 "test0rstruct", RStruct ("valout", "lvm_pv");
400 "test0rstructlist", RStructList ("valout", "lvm_pv");
401 "test0rhashtable", RHashtable "valout";
404 let test_functions = [
405 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
407 "internal test function - do not use",
409 This is an internal test function which is used to test whether
410 the automatically generated bindings can handle every possible
411 parameter type correctly.
413 It echos the contents of each parameter to stdout.
415 You probably don't want to call this function.");
419 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
421 "internal test function - do not use",
423 This is an internal test function which is used to test whether
424 the automatically generated bindings can handle every possible
425 return type correctly.
427 It converts string C<val> to the return type.
429 You probably don't want to call this function.");
430 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
432 "internal test function - do not use",
434 This is an internal test function which is used to test whether
435 the automatically generated bindings can handle every possible
436 return type correctly.
438 This function always returns an error.
440 You probably don't want to call this function.")]
444 (* non_daemon_functions are any functions which don't get processed
445 * in the daemon, eg. functions for setting and getting local
446 * configuration values.
449 let non_daemon_functions = test_functions @ [
450 ("launch", (RErr, []), -1, [FishAlias "run"; FishAction "launch"],
452 "launch the qemu subprocess",
454 Internally libguestfs is implemented by running a virtual machine
457 You should call this after configuring the handle
458 (eg. adding drives) but before performing any actions.");
460 ("wait_ready", (RErr, []), -1, [NotInFish],
462 "wait until the qemu subprocess launches (no op)",
464 This function is a no op.
466 In versions of the API E<lt> 1.0.71 you had to call this function
467 just after calling C<guestfs_launch> to wait for the launch
468 to complete. However this is no longer necessary because
469 C<guestfs_launch> now does the waiting.
471 If you see any calls to this function in code then you can just
472 remove them, unless you want to retain compatibility with older
473 versions of the API.");
475 ("kill_subprocess", (RErr, []), -1, [],
477 "kill the qemu subprocess",
479 This kills the qemu subprocess. You should never need to call this.");
481 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
483 "add an image to examine or modify",
485 This function adds a virtual machine disk image C<filename> to the
486 guest. The first time you call this function, the disk appears as IDE
487 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
490 You don't necessarily need to be root when using libguestfs. However
491 you obviously do need sufficient permissions to access the filename
492 for whatever operations you want to perform (ie. read access if you
493 just want to read the image or write access if you want to modify the
496 This is equivalent to the qemu parameter
497 C<-drive file=filename,cache=off,if=...>.
499 C<cache=off> is omitted in cases where it is not supported by
500 the underlying filesystem.
502 C<if=...> is set at compile time by the configuration option
503 C<./configure --with-drive-if=...>. In the rare case where you
504 might need to change this at run time, use C<guestfs_add_drive_with_if>
505 or C<guestfs_add_drive_ro_with_if>.
507 Note that this call checks for the existence of C<filename>. This
508 stops you from specifying other types of drive which are supported
509 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
510 the general C<guestfs_config> call instead.");
512 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
514 "add a CD-ROM disk image to examine",
516 This function adds a virtual CD-ROM disk image to the guest.
518 This is equivalent to the qemu parameter C<-cdrom filename>.
526 This call checks for the existence of C<filename>. This
527 stops you from specifying other types of drive which are supported
528 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
529 the general C<guestfs_config> call instead.
533 If you just want to add an ISO file (often you use this as an
534 efficient way to transfer large files into the guest), then you
535 should probably use C<guestfs_add_drive_ro> instead.
539 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
541 "add a drive in snapshot mode (read-only)",
543 This adds a drive in snapshot mode, making it effectively
546 Note that writes to the device are allowed, and will be seen for
547 the duration of the guestfs handle, but they are written
548 to a temporary file which is discarded as soon as the guestfs
549 handle is closed. We don't currently have any method to enable
550 changes to be committed, although qemu can support this.
552 This is equivalent to the qemu parameter
553 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
555 C<if=...> is set at compile time by the configuration option
556 C<./configure --with-drive-if=...>. In the rare case where you
557 might need to change this at run time, use C<guestfs_add_drive_with_if>
558 or C<guestfs_add_drive_ro_with_if>.
560 C<readonly=on> is only added where qemu supports this option.
562 Note that this call checks for the existence of C<filename>. This
563 stops you from specifying other types of drive which are supported
564 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
565 the general C<guestfs_config> call instead.");
567 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
569 "add qemu parameters",
571 This can be used to add arbitrary qemu command line parameters
572 of the form C<-param value>. Actually it's not quite arbitrary - we
573 prevent you from setting some parameters which would interfere with
574 parameters that we use.
576 The first character of C<param> string must be a C<-> (dash).
578 C<value> can be NULL.");
580 ("set_qemu", (RErr, [String "qemu"]), -1, [FishAlias "qemu"],
582 "set the qemu binary",
584 Set the qemu binary that we will use.
586 The default is chosen when the library was compiled by the
589 You can also override this by setting the C<LIBGUESTFS_QEMU>
590 environment variable.
592 Setting C<qemu> to C<NULL> restores the default qemu binary.
594 Note that you should call this function as early as possible
595 after creating the handle. This is because some pre-launch
596 operations depend on testing qemu features (by running C<qemu -help>).
597 If the qemu binary changes, we don't retest features, and
598 so you might see inconsistent results. Using the environment
599 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
600 the qemu binary at the same time as the handle is created.");
602 ("get_qemu", (RConstString "qemu", []), -1, [],
603 [InitNone, Always, TestRun (
605 "get the qemu binary",
607 Return the current qemu binary.
609 This is always non-NULL. If it wasn't set already, then this will
610 return the default qemu binary name.");
612 ("set_path", (RErr, [String "searchpath"]), -1, [FishAlias "path"],
614 "set the search path",
616 Set the path that libguestfs searches for kernel and initrd.img.
618 The default is C<$libdir/guestfs> unless overridden by setting
619 C<LIBGUESTFS_PATH> environment variable.
621 Setting C<path> to C<NULL> restores the default path.");
623 ("get_path", (RConstString "path", []), -1, [],
624 [InitNone, Always, TestRun (
626 "get the search path",
628 Return the current search path.
630 This is always non-NULL. If it wasn't set already, then this will
631 return the default path.");
633 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
635 "add options to kernel command line",
637 This function is used to add additional options to the
638 guest kernel command line.
640 The default is C<NULL> unless overridden by setting
641 C<LIBGUESTFS_APPEND> environment variable.
643 Setting C<append> to C<NULL> means I<no> additional options
644 are passed (libguestfs always adds a few of its own).");
646 ("get_append", (RConstOptString "append", []), -1, [],
647 (* This cannot be tested with the current framework. The
648 * function can return NULL in normal operations, which the
649 * test framework interprets as an error.
652 "get the additional kernel options",
654 Return the additional kernel options which are added to the
655 guest kernel command line.
657 If C<NULL> then no options are added.");
659 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
663 If C<autosync> is true, this enables autosync. Libguestfs will make a
664 best effort attempt to run C<guestfs_umount_all> followed by
665 C<guestfs_sync> when the handle is closed
666 (also if the program exits without closing handles).
668 This is disabled by default (except in guestfish where it is
669 enabled by default).");
671 ("get_autosync", (RBool "autosync", []), -1, [],
672 [InitNone, Always, TestRun (
673 [["get_autosync"]])],
676 Get the autosync flag.");
678 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
682 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
684 Verbose messages are disabled unless the environment variable
685 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
687 ("get_verbose", (RBool "verbose", []), -1, [],
691 This returns the verbose messages flag.");
693 ("is_ready", (RBool "ready", []), -1, [],
694 [InitNone, Always, TestOutputTrue (
696 "is ready to accept commands",
698 This returns true iff this handle is ready to accept commands
699 (in the C<READY> state).
701 For more information on states, see L<guestfs(3)>.");
703 ("is_config", (RBool "config", []), -1, [],
704 [InitNone, Always, TestOutputFalse (
706 "is in configuration state",
708 This returns true iff this handle is being configured
709 (in the C<CONFIG> state).
711 For more information on states, see L<guestfs(3)>.");
713 ("is_launching", (RBool "launching", []), -1, [],
714 [InitNone, Always, TestOutputFalse (
715 [["is_launching"]])],
716 "is launching subprocess",
718 This returns true iff this handle is launching the subprocess
719 (in the C<LAUNCHING> state).
721 For more information on states, see L<guestfs(3)>.");
723 ("is_busy", (RBool "busy", []), -1, [],
724 [InitNone, Always, TestOutputFalse (
726 "is busy processing a command",
728 This returns true iff this handle is busy processing a command
729 (in the C<BUSY> state).
731 For more information on states, see L<guestfs(3)>.");
733 ("get_state", (RInt "state", []), -1, [],
735 "get the current state",
737 This returns the current state as an opaque integer. This is
738 only useful for printing debug and internal error messages.
740 For more information on states, see L<guestfs(3)>.");
742 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
743 [InitNone, Always, TestOutputInt (
744 [["set_memsize"; "500"];
745 ["get_memsize"]], 500)],
746 "set memory allocated to the qemu subprocess",
748 This sets the memory size in megabytes allocated to the
749 qemu subprocess. This only has any effect if called before
752 You can also change this by setting the environment
753 variable C<LIBGUESTFS_MEMSIZE> before the handle is
756 For more information on the architecture of libguestfs,
757 see L<guestfs(3)>.");
759 ("get_memsize", (RInt "memsize", []), -1, [],
760 [InitNone, Always, TestOutputIntOp (
761 [["get_memsize"]], ">=", 256)],
762 "get memory allocated to the qemu subprocess",
764 This gets the memory size in megabytes allocated to the
767 If C<guestfs_set_memsize> was not called
768 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
769 then this returns the compiled-in default value for memsize.
771 For more information on the architecture of libguestfs,
772 see L<guestfs(3)>.");
774 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
775 [InitNone, Always, TestOutputIntOp (
776 [["get_pid"]], ">=", 1)],
777 "get PID of qemu subprocess",
779 Return the process ID of the qemu subprocess. If there is no
780 qemu subprocess, then this will return an error.
782 This is an internal call used for debugging and testing.");
784 ("version", (RStruct ("version", "version"), []), -1, [],
785 [InitNone, Always, TestOutputStruct (
786 [["version"]], [CompareWithInt ("major", 1)])],
787 "get the library version number",
789 Return the libguestfs version number that the program is linked
792 Note that because of dynamic linking this is not necessarily
793 the version of libguestfs that you compiled against. You can
794 compile the program, and then at runtime dynamically link
795 against a completely different C<libguestfs.so> library.
797 This call was added in version C<1.0.58>. In previous
798 versions of libguestfs there was no way to get the version
799 number. From C code you can use ELF weak linking tricks to find out if
800 this symbol exists (if it doesn't, then it's an earlier version).
802 The call returns a structure with four elements. The first
803 three (C<major>, C<minor> and C<release>) are numbers and
804 correspond to the usual version triplet. The fourth element
805 (C<extra>) is a string and is normally empty, but may be
806 used for distro-specific information.
808 To construct the original version string:
809 C<$major.$minor.$release$extra>
811 I<Note:> Don't use this call to test for availability
812 of features. Distro backports makes this unreliable. Use
813 C<guestfs_available> instead.");
815 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
816 [InitNone, Always, TestOutputTrue (
817 [["set_selinux"; "true"];
819 "set SELinux enabled or disabled at appliance boot",
821 This sets the selinux flag that is passed to the appliance
822 at boot time. The default is C<selinux=0> (disabled).
824 Note that if SELinux is enabled, it is always in
825 Permissive mode (C<enforcing=0>).
827 For more information on the architecture of libguestfs,
828 see L<guestfs(3)>.");
830 ("get_selinux", (RBool "selinux", []), -1, [],
832 "get SELinux enabled flag",
834 This returns the current setting of the selinux flag which
835 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
837 For more information on the architecture of libguestfs,
838 see L<guestfs(3)>.");
840 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
841 [InitNone, Always, TestOutputFalse (
842 [["set_trace"; "false"];
844 "enable or disable command traces",
846 If the command trace flag is set to 1, then commands are
847 printed on stdout before they are executed in a format
848 which is very similar to the one used by guestfish. In
849 other words, you can run a program with this enabled, and
850 you will get out a script which you can feed to guestfish
851 to perform the same set of actions.
853 If you want to trace C API calls into libguestfs (and
854 other libraries) then possibly a better way is to use
855 the external ltrace(1) command.
857 Command traces are disabled unless the environment variable
858 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
860 ("get_trace", (RBool "trace", []), -1, [],
862 "get command trace enabled flag",
864 Return the command trace flag.");
866 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
867 [InitNone, Always, TestOutputFalse (
868 [["set_direct"; "false"];
870 "enable or disable direct appliance mode",
872 If the direct appliance mode flag is enabled, then stdin and
873 stdout are passed directly through to the appliance once it
876 One consequence of this is that log messages aren't caught
877 by the library and handled by C<guestfs_set_log_message_callback>,
878 but go straight to stdout.
880 You probably don't want to use this unless you know what you
883 The default is disabled.");
885 ("get_direct", (RBool "direct", []), -1, [],
887 "get direct appliance mode flag",
889 Return the direct appliance mode flag.");
891 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
892 [InitNone, Always, TestOutputTrue (
893 [["set_recovery_proc"; "true"];
894 ["get_recovery_proc"]])],
895 "enable or disable the recovery process",
897 If this is called with the parameter C<false> then
898 C<guestfs_launch> does not create a recovery process. The
899 purpose of the recovery process is to stop runaway qemu
900 processes in the case where the main program aborts abruptly.
902 This only has any effect if called before C<guestfs_launch>,
903 and the default is true.
905 About the only time when you would want to disable this is
906 if the main process will fork itself into the background
907 (\"daemonize\" itself). In this case the recovery process
908 thinks that the main program has disappeared and so kills
909 qemu, which is not very helpful.");
911 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
913 "get recovery process enabled flag",
915 Return the recovery process enabled flag.");
917 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
919 "add a drive specifying the QEMU block emulation to use",
921 This is the same as C<guestfs_add_drive> but it allows you
922 to specify the QEMU interface emulation to use at run time.");
924 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
926 "add a drive read-only specifying the QEMU block emulation to use",
928 This is the same as C<guestfs_add_drive_ro> but it allows you
929 to specify the QEMU interface emulation to use at run time.");
933 (* daemon_functions are any functions which cause some action
934 * to take place in the daemon.
937 let daemon_functions = [
938 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
939 [InitEmpty, Always, TestOutput (
940 [["part_disk"; "/dev/sda"; "mbr"];
941 ["mkfs"; "ext2"; "/dev/sda1"];
942 ["mount"; "/dev/sda1"; "/"];
943 ["write_file"; "/new"; "new file contents"; "0"];
944 ["cat"; "/new"]], "new file contents")],
945 "mount a guest disk at a position in the filesystem",
947 Mount a guest disk at a position in the filesystem. Block devices
948 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
949 the guest. If those block devices contain partitions, they will have
950 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
953 The rules are the same as for L<mount(2)>: A filesystem must
954 first be mounted on C</> before others can be mounted. Other
955 filesystems can only be mounted on directories which already
958 The mounted filesystem is writable, if we have sufficient permissions
959 on the underlying device.
961 The filesystem options C<sync> and C<noatime> are set with this
962 call, in order to improve reliability.");
964 ("sync", (RErr, []), 2, [],
965 [ InitEmpty, Always, TestRun [["sync"]]],
966 "sync disks, writes are flushed through to the disk image",
968 This syncs the disk, so that any writes are flushed through to the
969 underlying disk image.
971 You should always call this if you have modified a disk image, before
972 closing the handle.");
974 ("touch", (RErr, [Pathname "path"]), 3, [],
975 [InitBasicFS, Always, TestOutputTrue (
977 ["exists"; "/new"]])],
978 "update file timestamps or create a new file",
980 Touch acts like the L<touch(1)> command. It can be used to
981 update the timestamps on a file, or, if the file does not exist,
982 to create a new zero-length file.");
984 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
985 [InitISOFS, Always, TestOutput (
986 [["cat"; "/known-2"]], "abcdef\n")],
987 "list the contents of a file",
989 Return the contents of the file named C<path>.
991 Note that this function cannot correctly handle binary files
992 (specifically, files containing C<\\0> character which is treated
993 as end of string). For those you need to use the C<guestfs_read_file>
994 or C<guestfs_download> functions which have a more complex interface.");
996 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
997 [], (* XXX Tricky to test because it depends on the exact format
998 * of the 'ls -l' command, which changes between F10 and F11.
1000 "list the files in a directory (long format)",
1002 List the files in C<directory> (relative to the root directory,
1003 there is no cwd) in the format of 'ls -la'.
1005 This command is mostly useful for interactive sessions. It
1006 is I<not> intended that you try to parse the output string.");
1008 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1009 [InitBasicFS, Always, TestOutputList (
1011 ["touch"; "/newer"];
1012 ["touch"; "/newest"];
1013 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1014 "list the files in a directory",
1016 List the files in C<directory> (relative to the root directory,
1017 there is no cwd). The '.' and '..' entries are not returned, but
1018 hidden files are shown.
1020 This command is mostly useful for interactive sessions. Programs
1021 should probably use C<guestfs_readdir> instead.");
1023 ("list_devices", (RStringList "devices", []), 7, [],
1024 [InitEmpty, Always, TestOutputListOfDevices (
1025 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1026 "list the block devices",
1028 List all the block devices.
1030 The full block device names are returned, eg. C</dev/sda>");
1032 ("list_partitions", (RStringList "partitions", []), 8, [],
1033 [InitBasicFS, Always, TestOutputListOfDevices (
1034 [["list_partitions"]], ["/dev/sda1"]);
1035 InitEmpty, Always, TestOutputListOfDevices (
1036 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1037 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1038 "list the partitions",
1040 List all the partitions detected on all block devices.
1042 The full partition device names are returned, eg. C</dev/sda1>
1044 This does not return logical volumes. For that you will need to
1045 call C<guestfs_lvs>.");
1047 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1048 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1049 [["pvs"]], ["/dev/sda1"]);
1050 InitEmpty, Always, TestOutputListOfDevices (
1051 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1052 ["pvcreate"; "/dev/sda1"];
1053 ["pvcreate"; "/dev/sda2"];
1054 ["pvcreate"; "/dev/sda3"];
1055 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1056 "list the LVM physical volumes (PVs)",
1058 List all the physical volumes detected. This is the equivalent
1059 of the L<pvs(8)> command.
1061 This returns a list of just the device names that contain
1062 PVs (eg. C</dev/sda2>).
1064 See also C<guestfs_pvs_full>.");
1066 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1067 [InitBasicFSonLVM, Always, TestOutputList (
1069 InitEmpty, Always, TestOutputList (
1070 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1071 ["pvcreate"; "/dev/sda1"];
1072 ["pvcreate"; "/dev/sda2"];
1073 ["pvcreate"; "/dev/sda3"];
1074 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1075 ["vgcreate"; "VG2"; "/dev/sda3"];
1076 ["vgs"]], ["VG1"; "VG2"])],
1077 "list the LVM volume groups (VGs)",
1079 List all the volumes groups detected. This is the equivalent
1080 of the L<vgs(8)> command.
1082 This returns a list of just the volume group names that were
1083 detected (eg. C<VolGroup00>).
1085 See also C<guestfs_vgs_full>.");
1087 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1088 [InitBasicFSonLVM, Always, TestOutputList (
1089 [["lvs"]], ["/dev/VG/LV"]);
1090 InitEmpty, Always, TestOutputList (
1091 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1092 ["pvcreate"; "/dev/sda1"];
1093 ["pvcreate"; "/dev/sda2"];
1094 ["pvcreate"; "/dev/sda3"];
1095 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1096 ["vgcreate"; "VG2"; "/dev/sda3"];
1097 ["lvcreate"; "LV1"; "VG1"; "50"];
1098 ["lvcreate"; "LV2"; "VG1"; "50"];
1099 ["lvcreate"; "LV3"; "VG2"; "50"];
1100 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1101 "list the LVM logical volumes (LVs)",
1103 List all the logical volumes detected. This is the equivalent
1104 of the L<lvs(8)> command.
1106 This returns a list of the logical volume device names
1107 (eg. C</dev/VolGroup00/LogVol00>).
1109 See also C<guestfs_lvs_full>.");
1111 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1112 [], (* XXX how to test? *)
1113 "list the LVM physical volumes (PVs)",
1115 List all the physical volumes detected. This is the equivalent
1116 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1118 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1119 [], (* XXX how to test? *)
1120 "list the LVM volume groups (VGs)",
1122 List all the volumes groups detected. This is the equivalent
1123 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1125 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1126 [], (* XXX how to test? *)
1127 "list the LVM logical volumes (LVs)",
1129 List all the logical volumes detected. This is the equivalent
1130 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1132 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1133 [InitISOFS, Always, TestOutputList (
1134 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1135 InitISOFS, Always, TestOutputList (
1136 [["read_lines"; "/empty"]], [])],
1137 "read file as lines",
1139 Return the contents of the file named C<path>.
1141 The file contents are returned as a list of lines. Trailing
1142 C<LF> and C<CRLF> character sequences are I<not> returned.
1144 Note that this function cannot correctly handle binary files
1145 (specifically, files containing C<\\0> character which is treated
1146 as end of line). For those you need to use the C<guestfs_read_file>
1147 function which has a more complex interface.");
1149 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1150 [], (* XXX Augeas code needs tests. *)
1151 "create a new Augeas handle",
1153 Create a new Augeas handle for editing configuration files.
1154 If there was any previous Augeas handle associated with this
1155 guestfs session, then it is closed.
1157 You must call this before using any other C<guestfs_aug_*>
1160 C<root> is the filesystem root. C<root> must not be NULL,
1163 The flags are the same as the flags defined in
1164 E<lt>augeas.hE<gt>, the logical I<or> of the following
1169 =item C<AUG_SAVE_BACKUP> = 1
1171 Keep the original file with a C<.augsave> extension.
1173 =item C<AUG_SAVE_NEWFILE> = 2
1175 Save changes into a file with extension C<.augnew>, and
1176 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1178 =item C<AUG_TYPE_CHECK> = 4
1180 Typecheck lenses (can be expensive).
1182 =item C<AUG_NO_STDINC> = 8
1184 Do not use standard load path for modules.
1186 =item C<AUG_SAVE_NOOP> = 16
1188 Make save a no-op, just record what would have been changed.
1190 =item C<AUG_NO_LOAD> = 32
1192 Do not load the tree in C<guestfs_aug_init>.
1196 To close the handle, you can call C<guestfs_aug_close>.
1198 To find out more about Augeas, see L<http://augeas.net/>.");
1200 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1201 [], (* XXX Augeas code needs tests. *)
1202 "close the current Augeas handle",
1204 Close the current Augeas handle and free up any resources
1205 used by it. After calling this, you have to call
1206 C<guestfs_aug_init> again before you can use any other
1207 Augeas functions.");
1209 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1210 [], (* XXX Augeas code needs tests. *)
1211 "define an Augeas variable",
1213 Defines an Augeas variable C<name> whose value is the result
1214 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1217 On success this returns the number of nodes in C<expr>, or
1218 C<0> if C<expr> evaluates to something which is not a nodeset.");
1220 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1221 [], (* XXX Augeas code needs tests. *)
1222 "define an Augeas node",
1224 Defines a variable C<name> whose value is the result of
1227 If C<expr> evaluates to an empty nodeset, a node is created,
1228 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1229 C<name> will be the nodeset containing that single node.
1231 On success this returns a pair containing the
1232 number of nodes in the nodeset, and a boolean flag
1233 if a node was created.");
1235 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1236 [], (* XXX Augeas code needs tests. *)
1237 "look up the value of an Augeas path",
1239 Look up the value associated with C<path>. If C<path>
1240 matches exactly one node, the C<value> is returned.");
1242 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1243 [], (* XXX Augeas code needs tests. *)
1244 "set Augeas path to value",
1246 Set the value associated with C<path> to C<val>.
1248 In the Augeas API, it is possible to clear a node by setting
1249 the value to NULL. Due to an oversight in the libguestfs API
1250 you cannot do that with this call. Instead you must use the
1251 C<guestfs_aug_clear> call.");
1253 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1254 [], (* XXX Augeas code needs tests. *)
1255 "insert a sibling Augeas node",
1257 Create a new sibling C<label> for C<path>, inserting it into
1258 the tree before or after C<path> (depending on the boolean
1261 C<path> must match exactly one existing node in the tree, and
1262 C<label> must be a label, ie. not contain C</>, C<*> or end
1263 with a bracketed index C<[N]>.");
1265 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1266 [], (* XXX Augeas code needs tests. *)
1267 "remove an Augeas path",
1269 Remove C<path> and all of its children.
1271 On success this returns the number of entries which were removed.");
1273 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1274 [], (* XXX Augeas code needs tests. *)
1277 Move the node C<src> to C<dest>. C<src> must match exactly
1278 one node. C<dest> is overwritten if it exists.");
1280 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1281 [], (* XXX Augeas code needs tests. *)
1282 "return Augeas nodes which match augpath",
1284 Returns a list of paths which match the path expression C<path>.
1285 The returned paths are sufficiently qualified so that they match
1286 exactly one node in the current tree.");
1288 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1289 [], (* XXX Augeas code needs tests. *)
1290 "write all pending Augeas changes to disk",
1292 This writes all pending changes to disk.
1294 The flags which were passed to C<guestfs_aug_init> affect exactly
1295 how files are saved.");
1297 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1298 [], (* XXX Augeas code needs tests. *)
1299 "load files into the tree",
1301 Load files into the tree.
1303 See C<aug_load> in the Augeas documentation for the full gory
1306 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1307 [], (* XXX Augeas code needs tests. *)
1308 "list Augeas nodes under augpath",
1310 This is just a shortcut for listing C<guestfs_aug_match>
1311 C<path/*> and sorting the resulting nodes into alphabetical order.");
1313 ("rm", (RErr, [Pathname "path"]), 29, [],
1314 [InitBasicFS, Always, TestRun
1317 InitBasicFS, Always, TestLastFail
1319 InitBasicFS, Always, TestLastFail
1324 Remove the single file C<path>.");
1326 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1327 [InitBasicFS, Always, TestRun
1330 InitBasicFS, Always, TestLastFail
1331 [["rmdir"; "/new"]];
1332 InitBasicFS, Always, TestLastFail
1334 ["rmdir"; "/new"]]],
1335 "remove a directory",
1337 Remove the single directory C<path>.");
1339 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1340 [InitBasicFS, Always, TestOutputFalse
1342 ["mkdir"; "/new/foo"];
1343 ["touch"; "/new/foo/bar"];
1345 ["exists"; "/new"]]],
1346 "remove a file or directory recursively",
1348 Remove the file or directory C<path>, recursively removing the
1349 contents if its a directory. This is like the C<rm -rf> shell
1352 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1353 [InitBasicFS, Always, TestOutputTrue
1355 ["is_dir"; "/new"]];
1356 InitBasicFS, Always, TestLastFail
1357 [["mkdir"; "/new/foo/bar"]]],
1358 "create a directory",
1360 Create a directory named C<path>.");
1362 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1363 [InitBasicFS, Always, TestOutputTrue
1364 [["mkdir_p"; "/new/foo/bar"];
1365 ["is_dir"; "/new/foo/bar"]];
1366 InitBasicFS, Always, TestOutputTrue
1367 [["mkdir_p"; "/new/foo/bar"];
1368 ["is_dir"; "/new/foo"]];
1369 InitBasicFS, Always, TestOutputTrue
1370 [["mkdir_p"; "/new/foo/bar"];
1371 ["is_dir"; "/new"]];
1372 (* Regression tests for RHBZ#503133: *)
1373 InitBasicFS, Always, TestRun
1375 ["mkdir_p"; "/new"]];
1376 InitBasicFS, Always, TestLastFail
1378 ["mkdir_p"; "/new"]]],
1379 "create a directory and parents",
1381 Create a directory named C<path>, creating any parent directories
1382 as necessary. This is like the C<mkdir -p> shell command.");
1384 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1385 [], (* XXX Need stat command to test *)
1388 Change the mode (permissions) of C<path> to C<mode>. Only
1389 numeric modes are supported.
1391 I<Note>: When using this command from guestfish, C<mode>
1392 by default would be decimal, unless you prefix it with
1393 C<0> to get octal, ie. use C<0700> not C<700>.
1395 The mode actually set is affected by the umask.");
1397 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1398 [], (* XXX Need stat command to test *)
1399 "change file owner and group",
1401 Change the file owner to C<owner> and group to C<group>.
1403 Only numeric uid and gid are supported. If you want to use
1404 names, you will need to locate and parse the password file
1405 yourself (Augeas support makes this relatively easy).");
1407 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1408 [InitISOFS, Always, TestOutputTrue (
1409 [["exists"; "/empty"]]);
1410 InitISOFS, Always, TestOutputTrue (
1411 [["exists"; "/directory"]])],
1412 "test if file or directory exists",
1414 This returns C<true> if and only if there is a file, directory
1415 (or anything) with the given C<path> name.
1417 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1419 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1420 [InitISOFS, Always, TestOutputTrue (
1421 [["is_file"; "/known-1"]]);
1422 InitISOFS, Always, TestOutputFalse (
1423 [["is_file"; "/directory"]])],
1424 "test if file exists",
1426 This returns C<true> if and only if there is a file
1427 with the given C<path> name. Note that it returns false for
1428 other objects like directories.
1430 See also C<guestfs_stat>.");
1432 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1433 [InitISOFS, Always, TestOutputFalse (
1434 [["is_dir"; "/known-3"]]);
1435 InitISOFS, Always, TestOutputTrue (
1436 [["is_dir"; "/directory"]])],
1437 "test if file exists",
1439 This returns C<true> if and only if there is a directory
1440 with the given C<path> name. Note that it returns false for
1441 other objects like files.
1443 See also C<guestfs_stat>.");
1445 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1446 [InitEmpty, Always, TestOutputListOfDevices (
1447 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1448 ["pvcreate"; "/dev/sda1"];
1449 ["pvcreate"; "/dev/sda2"];
1450 ["pvcreate"; "/dev/sda3"];
1451 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1452 "create an LVM physical volume",
1454 This creates an LVM physical volume on the named C<device>,
1455 where C<device> should usually be a partition name such
1458 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1459 [InitEmpty, Always, TestOutputList (
1460 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1461 ["pvcreate"; "/dev/sda1"];
1462 ["pvcreate"; "/dev/sda2"];
1463 ["pvcreate"; "/dev/sda3"];
1464 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1465 ["vgcreate"; "VG2"; "/dev/sda3"];
1466 ["vgs"]], ["VG1"; "VG2"])],
1467 "create an LVM volume group",
1469 This creates an LVM volume group called C<volgroup>
1470 from the non-empty list of physical volumes C<physvols>.");
1472 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1473 [InitEmpty, Always, TestOutputList (
1474 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1475 ["pvcreate"; "/dev/sda1"];
1476 ["pvcreate"; "/dev/sda2"];
1477 ["pvcreate"; "/dev/sda3"];
1478 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1479 ["vgcreate"; "VG2"; "/dev/sda3"];
1480 ["lvcreate"; "LV1"; "VG1"; "50"];
1481 ["lvcreate"; "LV2"; "VG1"; "50"];
1482 ["lvcreate"; "LV3"; "VG2"; "50"];
1483 ["lvcreate"; "LV4"; "VG2"; "50"];
1484 ["lvcreate"; "LV5"; "VG2"; "50"];
1486 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1487 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1488 "create an LVM logical volume",
1490 This creates an LVM logical volume called C<logvol>
1491 on the volume group C<volgroup>, with C<size> megabytes.");
1493 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1494 [InitEmpty, Always, TestOutput (
1495 [["part_disk"; "/dev/sda"; "mbr"];
1496 ["mkfs"; "ext2"; "/dev/sda1"];
1497 ["mount_options"; ""; "/dev/sda1"; "/"];
1498 ["write_file"; "/new"; "new file contents"; "0"];
1499 ["cat"; "/new"]], "new file contents")],
1500 "make a filesystem",
1502 This creates a filesystem on C<device> (usually a partition
1503 or LVM logical volume). The filesystem type is C<fstype>, for
1506 ("sfdisk", (RErr, [Device "device";
1507 Int "cyls"; Int "heads"; Int "sectors";
1508 StringList "lines"]), 43, [DangerWillRobinson],
1510 "create partitions on a block device",
1512 This is a direct interface to the L<sfdisk(8)> program for creating
1513 partitions on block devices.
1515 C<device> should be a block device, for example C</dev/sda>.
1517 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1518 and sectors on the device, which are passed directly to sfdisk as
1519 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1520 of these, then the corresponding parameter is omitted. Usually for
1521 'large' disks, you can just pass C<0> for these, but for small
1522 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1523 out the right geometry and you will need to tell it.
1525 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1526 information refer to the L<sfdisk(8)> manpage.
1528 To create a single partition occupying the whole disk, you would
1529 pass C<lines> as a single element list, when the single element being
1530 the string C<,> (comma).
1532 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1533 C<guestfs_part_init>");
1535 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning],
1536 [InitBasicFS, Always, TestOutput (
1537 [["write_file"; "/new"; "new file contents"; "0"];
1538 ["cat"; "/new"]], "new file contents");
1539 InitBasicFS, Always, TestOutput (
1540 [["write_file"; "/new"; "\nnew file contents\n"; "0"];
1541 ["cat"; "/new"]], "\nnew file contents\n");
1542 InitBasicFS, Always, TestOutput (
1543 [["write_file"; "/new"; "\n\n"; "0"];
1544 ["cat"; "/new"]], "\n\n");
1545 InitBasicFS, Always, TestOutput (
1546 [["write_file"; "/new"; ""; "0"];
1547 ["cat"; "/new"]], "");
1548 InitBasicFS, Always, TestOutput (
1549 [["write_file"; "/new"; "\n\n\n"; "0"];
1550 ["cat"; "/new"]], "\n\n\n");
1551 InitBasicFS, Always, TestOutput (
1552 [["write_file"; "/new"; "\n"; "0"];
1553 ["cat"; "/new"]], "\n")],
1556 This call creates a file called C<path>. The contents of the
1557 file is the string C<content> (which can contain any 8 bit data),
1558 with length C<size>.
1560 As a special case, if C<size> is C<0>
1561 then the length is calculated using C<strlen> (so in this case
1562 the content cannot contain embedded ASCII NULs).
1564 I<NB.> Owing to a bug, writing content containing ASCII NUL
1565 characters does I<not> work, even if the length is specified.
1566 We hope to resolve this bug in a future version. In the meantime
1567 use C<guestfs_upload>.");
1569 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1570 [InitEmpty, Always, TestOutputListOfDevices (
1571 [["part_disk"; "/dev/sda"; "mbr"];
1572 ["mkfs"; "ext2"; "/dev/sda1"];
1573 ["mount_options"; ""; "/dev/sda1"; "/"];
1574 ["mounts"]], ["/dev/sda1"]);
1575 InitEmpty, Always, TestOutputList (
1576 [["part_disk"; "/dev/sda"; "mbr"];
1577 ["mkfs"; "ext2"; "/dev/sda1"];
1578 ["mount_options"; ""; "/dev/sda1"; "/"];
1581 "unmount a filesystem",
1583 This unmounts the given filesystem. The filesystem may be
1584 specified either by its mountpoint (path) or the device which
1585 contains the filesystem.");
1587 ("mounts", (RStringList "devices", []), 46, [],
1588 [InitBasicFS, Always, TestOutputListOfDevices (
1589 [["mounts"]], ["/dev/sda1"])],
1590 "show mounted filesystems",
1592 This returns the list of currently mounted filesystems. It returns
1593 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1595 Some internal mounts are not shown.
1597 See also: C<guestfs_mountpoints>");
1599 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1600 [InitBasicFS, Always, TestOutputList (
1603 (* check that umount_all can unmount nested mounts correctly: *)
1604 InitEmpty, Always, TestOutputList (
1605 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1606 ["mkfs"; "ext2"; "/dev/sda1"];
1607 ["mkfs"; "ext2"; "/dev/sda2"];
1608 ["mkfs"; "ext2"; "/dev/sda3"];
1609 ["mount_options"; ""; "/dev/sda1"; "/"];
1611 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1612 ["mkdir"; "/mp1/mp2"];
1613 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1614 ["mkdir"; "/mp1/mp2/mp3"];
1617 "unmount all filesystems",
1619 This unmounts all mounted filesystems.
1621 Some internal mounts are not unmounted by this call.");
1623 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1625 "remove all LVM LVs, VGs and PVs",
1627 This command removes all LVM logical volumes, volume groups
1628 and physical volumes.");
1630 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1631 [InitISOFS, Always, TestOutput (
1632 [["file"; "/empty"]], "empty");
1633 InitISOFS, Always, TestOutput (
1634 [["file"; "/known-1"]], "ASCII text");
1635 InitISOFS, Always, TestLastFail (
1636 [["file"; "/notexists"]])],
1637 "determine file type",
1639 This call uses the standard L<file(1)> command to determine
1640 the type or contents of the file. This also works on devices,
1641 for example to find out whether a partition contains a filesystem.
1643 This call will also transparently look inside various types
1646 The exact command which runs is C<file -zbsL path>. Note in
1647 particular that the filename is not prepended to the output
1648 (the C<-b> option).");
1650 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1651 [InitBasicFS, Always, TestOutput (
1652 [["upload"; "test-command"; "/test-command"];
1653 ["chmod"; "0o755"; "/test-command"];
1654 ["command"; "/test-command 1"]], "Result1");
1655 InitBasicFS, Always, TestOutput (
1656 [["upload"; "test-command"; "/test-command"];
1657 ["chmod"; "0o755"; "/test-command"];
1658 ["command"; "/test-command 2"]], "Result2\n");
1659 InitBasicFS, Always, TestOutput (
1660 [["upload"; "test-command"; "/test-command"];
1661 ["chmod"; "0o755"; "/test-command"];
1662 ["command"; "/test-command 3"]], "\nResult3");
1663 InitBasicFS, Always, TestOutput (
1664 [["upload"; "test-command"; "/test-command"];
1665 ["chmod"; "0o755"; "/test-command"];
1666 ["command"; "/test-command 4"]], "\nResult4\n");
1667 InitBasicFS, Always, TestOutput (
1668 [["upload"; "test-command"; "/test-command"];
1669 ["chmod"; "0o755"; "/test-command"];
1670 ["command"; "/test-command 5"]], "\nResult5\n\n");
1671 InitBasicFS, Always, TestOutput (
1672 [["upload"; "test-command"; "/test-command"];
1673 ["chmod"; "0o755"; "/test-command"];
1674 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1675 InitBasicFS, Always, TestOutput (
1676 [["upload"; "test-command"; "/test-command"];
1677 ["chmod"; "0o755"; "/test-command"];
1678 ["command"; "/test-command 7"]], "");
1679 InitBasicFS, Always, TestOutput (
1680 [["upload"; "test-command"; "/test-command"];
1681 ["chmod"; "0o755"; "/test-command"];
1682 ["command"; "/test-command 8"]], "\n");
1683 InitBasicFS, Always, TestOutput (
1684 [["upload"; "test-command"; "/test-command"];
1685 ["chmod"; "0o755"; "/test-command"];
1686 ["command"; "/test-command 9"]], "\n\n");
1687 InitBasicFS, Always, TestOutput (
1688 [["upload"; "test-command"; "/test-command"];
1689 ["chmod"; "0o755"; "/test-command"];
1690 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1691 InitBasicFS, Always, TestOutput (
1692 [["upload"; "test-command"; "/test-command"];
1693 ["chmod"; "0o755"; "/test-command"];
1694 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1695 InitBasicFS, Always, TestLastFail (
1696 [["upload"; "test-command"; "/test-command"];
1697 ["chmod"; "0o755"; "/test-command"];
1698 ["command"; "/test-command"]])],
1699 "run a command from the guest filesystem",
1701 This call runs a command from the guest filesystem. The
1702 filesystem must be mounted, and must contain a compatible
1703 operating system (ie. something Linux, with the same
1704 or compatible processor architecture).
1706 The single parameter is an argv-style list of arguments.
1707 The first element is the name of the program to run.
1708 Subsequent elements are parameters. The list must be
1709 non-empty (ie. must contain a program name). Note that
1710 the command runs directly, and is I<not> invoked via
1711 the shell (see C<guestfs_sh>).
1713 The return value is anything printed to I<stdout> by
1716 If the command returns a non-zero exit status, then
1717 this function returns an error message. The error message
1718 string is the content of I<stderr> from the command.
1720 The C<$PATH> environment variable will contain at least
1721 C</usr/bin> and C</bin>. If you require a program from
1722 another location, you should provide the full path in the
1725 Shared libraries and data files required by the program
1726 must be available on filesystems which are mounted in the
1727 correct places. It is the caller's responsibility to ensure
1728 all filesystems that are needed are mounted at the right
1731 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1732 [InitBasicFS, Always, TestOutputList (
1733 [["upload"; "test-command"; "/test-command"];
1734 ["chmod"; "0o755"; "/test-command"];
1735 ["command_lines"; "/test-command 1"]], ["Result1"]);
1736 InitBasicFS, Always, TestOutputList (
1737 [["upload"; "test-command"; "/test-command"];
1738 ["chmod"; "0o755"; "/test-command"];
1739 ["command_lines"; "/test-command 2"]], ["Result2"]);
1740 InitBasicFS, Always, TestOutputList (
1741 [["upload"; "test-command"; "/test-command"];
1742 ["chmod"; "0o755"; "/test-command"];
1743 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1744 InitBasicFS, Always, TestOutputList (
1745 [["upload"; "test-command"; "/test-command"];
1746 ["chmod"; "0o755"; "/test-command"];
1747 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1748 InitBasicFS, Always, TestOutputList (
1749 [["upload"; "test-command"; "/test-command"];
1750 ["chmod"; "0o755"; "/test-command"];
1751 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1752 InitBasicFS, Always, TestOutputList (
1753 [["upload"; "test-command"; "/test-command"];
1754 ["chmod"; "0o755"; "/test-command"];
1755 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1756 InitBasicFS, Always, TestOutputList (
1757 [["upload"; "test-command"; "/test-command"];
1758 ["chmod"; "0o755"; "/test-command"];
1759 ["command_lines"; "/test-command 7"]], []);
1760 InitBasicFS, Always, TestOutputList (
1761 [["upload"; "test-command"; "/test-command"];
1762 ["chmod"; "0o755"; "/test-command"];
1763 ["command_lines"; "/test-command 8"]], [""]);
1764 InitBasicFS, Always, TestOutputList (
1765 [["upload"; "test-command"; "/test-command"];
1766 ["chmod"; "0o755"; "/test-command"];
1767 ["command_lines"; "/test-command 9"]], ["";""]);
1768 InitBasicFS, Always, TestOutputList (
1769 [["upload"; "test-command"; "/test-command"];
1770 ["chmod"; "0o755"; "/test-command"];
1771 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1772 InitBasicFS, Always, TestOutputList (
1773 [["upload"; "test-command"; "/test-command"];
1774 ["chmod"; "0o755"; "/test-command"];
1775 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1776 "run a command, returning lines",
1778 This is the same as C<guestfs_command>, but splits the
1779 result into a list of lines.
1781 See also: C<guestfs_sh_lines>");
1783 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1784 [InitISOFS, Always, TestOutputStruct (
1785 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1786 "get file information",
1788 Returns file information for the given C<path>.
1790 This is the same as the C<stat(2)> system call.");
1792 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1793 [InitISOFS, Always, TestOutputStruct (
1794 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1795 "get file information for a symbolic link",
1797 Returns file information for the given C<path>.
1799 This is the same as C<guestfs_stat> except that if C<path>
1800 is a symbolic link, then the link is stat-ed, not the file it
1803 This is the same as the C<lstat(2)> system call.");
1805 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1806 [InitISOFS, Always, TestOutputStruct (
1807 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1808 "get file system statistics",
1810 Returns file system statistics for any mounted file system.
1811 C<path> should be a file or directory in the mounted file system
1812 (typically it is the mount point itself, but it doesn't need to be).
1814 This is the same as the C<statvfs(2)> system call.");
1816 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1818 "get ext2/ext3/ext4 superblock details",
1820 This returns the contents of the ext2, ext3 or ext4 filesystem
1821 superblock on C<device>.
1823 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1824 manpage for more details. The list of fields returned isn't
1825 clearly defined, and depends on both the version of C<tune2fs>
1826 that libguestfs was built against, and the filesystem itself.");
1828 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1829 [InitEmpty, Always, TestOutputTrue (
1830 [["blockdev_setro"; "/dev/sda"];
1831 ["blockdev_getro"; "/dev/sda"]])],
1832 "set block device to read-only",
1834 Sets the block device named C<device> to read-only.
1836 This uses the L<blockdev(8)> command.");
1838 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1839 [InitEmpty, Always, TestOutputFalse (
1840 [["blockdev_setrw"; "/dev/sda"];
1841 ["blockdev_getro"; "/dev/sda"]])],
1842 "set block device to read-write",
1844 Sets the block device named C<device> to read-write.
1846 This uses the L<blockdev(8)> command.");
1848 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1849 [InitEmpty, Always, TestOutputTrue (
1850 [["blockdev_setro"; "/dev/sda"];
1851 ["blockdev_getro"; "/dev/sda"]])],
1852 "is block device set to read-only",
1854 Returns a boolean indicating if the block device is read-only
1855 (true if read-only, false if not).
1857 This uses the L<blockdev(8)> command.");
1859 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1860 [InitEmpty, Always, TestOutputInt (
1861 [["blockdev_getss"; "/dev/sda"]], 512)],
1862 "get sectorsize of block device",
1864 This returns the size of sectors on a block device.
1865 Usually 512, but can be larger for modern devices.
1867 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1870 This uses the L<blockdev(8)> command.");
1872 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1873 [InitEmpty, Always, TestOutputInt (
1874 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1875 "get blocksize of block device",
1877 This returns the block size of a device.
1879 (Note this is different from both I<size in blocks> and
1880 I<filesystem block size>).
1882 This uses the L<blockdev(8)> command.");
1884 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1886 "set blocksize of block device",
1888 This sets the block size of a device.
1890 (Note this is different from both I<size in blocks> and
1891 I<filesystem block size>).
1893 This uses the L<blockdev(8)> command.");
1895 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1896 [InitEmpty, Always, TestOutputInt (
1897 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1898 "get total size of device in 512-byte sectors",
1900 This returns the size of the device in units of 512-byte sectors
1901 (even if the sectorsize isn't 512 bytes ... weird).
1903 See also C<guestfs_blockdev_getss> for the real sector size of
1904 the device, and C<guestfs_blockdev_getsize64> for the more
1905 useful I<size in bytes>.
1907 This uses the L<blockdev(8)> command.");
1909 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1910 [InitEmpty, Always, TestOutputInt (
1911 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1912 "get total size of device in bytes",
1914 This returns the size of the device in bytes.
1916 See also C<guestfs_blockdev_getsz>.
1918 This uses the L<blockdev(8)> command.");
1920 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1921 [InitEmpty, Always, TestRun
1922 [["blockdev_flushbufs"; "/dev/sda"]]],
1923 "flush device buffers",
1925 This tells the kernel to flush internal buffers associated
1928 This uses the L<blockdev(8)> command.");
1930 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1931 [InitEmpty, Always, TestRun
1932 [["blockdev_rereadpt"; "/dev/sda"]]],
1933 "reread partition table",
1935 Reread the partition table on C<device>.
1937 This uses the L<blockdev(8)> command.");
1939 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1940 [InitBasicFS, Always, TestOutput (
1941 (* Pick a file from cwd which isn't likely to change. *)
1942 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1943 ["checksum"; "md5"; "/COPYING.LIB"]],
1944 Digest.to_hex (Digest.file "COPYING.LIB"))],
1945 "upload a file from the local machine",
1947 Upload local file C<filename> to C<remotefilename> on the
1950 C<filename> can also be a named pipe.
1952 See also C<guestfs_download>.");
1954 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1955 [InitBasicFS, Always, TestOutput (
1956 (* Pick a file from cwd which isn't likely to change. *)
1957 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1958 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1959 ["upload"; "testdownload.tmp"; "/upload"];
1960 ["checksum"; "md5"; "/upload"]],
1961 Digest.to_hex (Digest.file "COPYING.LIB"))],
1962 "download a file to the local machine",
1964 Download file C<remotefilename> and save it as C<filename>
1965 on the local machine.
1967 C<filename> can also be a named pipe.
1969 See also C<guestfs_upload>, C<guestfs_cat>.");
1971 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1972 [InitISOFS, Always, TestOutput (
1973 [["checksum"; "crc"; "/known-3"]], "2891671662");
1974 InitISOFS, Always, TestLastFail (
1975 [["checksum"; "crc"; "/notexists"]]);
1976 InitISOFS, Always, TestOutput (
1977 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1978 InitISOFS, Always, TestOutput (
1979 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1980 InitISOFS, Always, TestOutput (
1981 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1982 InitISOFS, Always, TestOutput (
1983 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1984 InitISOFS, Always, TestOutput (
1985 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1986 InitISOFS, Always, TestOutput (
1987 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6")],
1988 "compute MD5, SHAx or CRC checksum of file",
1990 This call computes the MD5, SHAx or CRC checksum of the
1993 The type of checksum to compute is given by the C<csumtype>
1994 parameter which must have one of the following values:
2000 Compute the cyclic redundancy check (CRC) specified by POSIX
2001 for the C<cksum> command.
2005 Compute the MD5 hash (using the C<md5sum> program).
2009 Compute the SHA1 hash (using the C<sha1sum> program).
2013 Compute the SHA224 hash (using the C<sha224sum> program).
2017 Compute the SHA256 hash (using the C<sha256sum> program).
2021 Compute the SHA384 hash (using the C<sha384sum> program).
2025 Compute the SHA512 hash (using the C<sha512sum> program).
2029 The checksum is returned as a printable string.
2031 To get the checksum for a device, use C<guestfs_checksum_device>.
2033 To get the checksums for many files, use C<guestfs_checksums_out>.");
2035 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2036 [InitBasicFS, Always, TestOutput (
2037 [["tar_in"; "../images/helloworld.tar"; "/"];
2038 ["cat"; "/hello"]], "hello\n")],
2039 "unpack tarfile to directory",
2041 This command uploads and unpacks local file C<tarfile> (an
2042 I<uncompressed> tar file) into C<directory>.
2044 To upload a compressed tarball, use C<guestfs_tgz_in>
2045 or C<guestfs_txz_in>.");
2047 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2049 "pack directory into tarfile",
2051 This command packs the contents of C<directory> and downloads
2052 it to local file C<tarfile>.
2054 To download a compressed tarball, use C<guestfs_tgz_out>
2055 or C<guestfs_txz_out>.");
2057 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2058 [InitBasicFS, Always, TestOutput (
2059 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2060 ["cat"; "/hello"]], "hello\n")],
2061 "unpack compressed tarball to directory",
2063 This command uploads and unpacks local file C<tarball> (a
2064 I<gzip compressed> tar file) into C<directory>.
2066 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2068 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2070 "pack directory into compressed tarball",
2072 This command packs the contents of C<directory> and downloads
2073 it to local file C<tarball>.
2075 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2077 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2078 [InitBasicFS, Always, TestLastFail (
2080 ["mount_ro"; "/dev/sda1"; "/"];
2081 ["touch"; "/new"]]);
2082 InitBasicFS, Always, TestOutput (
2083 [["write_file"; "/new"; "data"; "0"];
2085 ["mount_ro"; "/dev/sda1"; "/"];
2086 ["cat"; "/new"]], "data")],
2087 "mount a guest disk, read-only",
2089 This is the same as the C<guestfs_mount> command, but it
2090 mounts the filesystem with the read-only (I<-o ro>) flag.");
2092 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2094 "mount a guest disk with mount options",
2096 This is the same as the C<guestfs_mount> command, but it
2097 allows you to set the mount options as for the
2098 L<mount(8)> I<-o> flag.");
2100 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2102 "mount a guest disk with mount options and vfstype",
2104 This is the same as the C<guestfs_mount> command, but it
2105 allows you to set both the mount options and the vfstype
2106 as for the L<mount(8)> I<-o> and I<-t> flags.");
2108 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2110 "debugging and internals",
2112 The C<guestfs_debug> command exposes some internals of
2113 C<guestfsd> (the guestfs daemon) that runs inside the
2116 There is no comprehensive help for this command. You have
2117 to look at the file C<daemon/debug.c> in the libguestfs source
2118 to find out what you can do.");
2120 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2121 [InitEmpty, Always, TestOutputList (
2122 [["part_disk"; "/dev/sda"; "mbr"];
2123 ["pvcreate"; "/dev/sda1"];
2124 ["vgcreate"; "VG"; "/dev/sda1"];
2125 ["lvcreate"; "LV1"; "VG"; "50"];
2126 ["lvcreate"; "LV2"; "VG"; "50"];
2127 ["lvremove"; "/dev/VG/LV1"];
2128 ["lvs"]], ["/dev/VG/LV2"]);
2129 InitEmpty, Always, TestOutputList (
2130 [["part_disk"; "/dev/sda"; "mbr"];
2131 ["pvcreate"; "/dev/sda1"];
2132 ["vgcreate"; "VG"; "/dev/sda1"];
2133 ["lvcreate"; "LV1"; "VG"; "50"];
2134 ["lvcreate"; "LV2"; "VG"; "50"];
2135 ["lvremove"; "/dev/VG"];
2137 InitEmpty, Always, TestOutputList (
2138 [["part_disk"; "/dev/sda"; "mbr"];
2139 ["pvcreate"; "/dev/sda1"];
2140 ["vgcreate"; "VG"; "/dev/sda1"];
2141 ["lvcreate"; "LV1"; "VG"; "50"];
2142 ["lvcreate"; "LV2"; "VG"; "50"];
2143 ["lvremove"; "/dev/VG"];
2145 "remove an LVM logical volume",
2147 Remove an LVM logical volume C<device>, where C<device> is
2148 the path to the LV, such as C</dev/VG/LV>.
2150 You can also remove all LVs in a volume group by specifying
2151 the VG name, C</dev/VG>.");
2153 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2154 [InitEmpty, Always, TestOutputList (
2155 [["part_disk"; "/dev/sda"; "mbr"];
2156 ["pvcreate"; "/dev/sda1"];
2157 ["vgcreate"; "VG"; "/dev/sda1"];
2158 ["lvcreate"; "LV1"; "VG"; "50"];
2159 ["lvcreate"; "LV2"; "VG"; "50"];
2162 InitEmpty, Always, TestOutputList (
2163 [["part_disk"; "/dev/sda"; "mbr"];
2164 ["pvcreate"; "/dev/sda1"];
2165 ["vgcreate"; "VG"; "/dev/sda1"];
2166 ["lvcreate"; "LV1"; "VG"; "50"];
2167 ["lvcreate"; "LV2"; "VG"; "50"];
2170 "remove an LVM volume group",
2172 Remove an LVM volume group C<vgname>, (for example C<VG>).
2174 This also forcibly removes all logical volumes in the volume
2177 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2178 [InitEmpty, Always, TestOutputListOfDevices (
2179 [["part_disk"; "/dev/sda"; "mbr"];
2180 ["pvcreate"; "/dev/sda1"];
2181 ["vgcreate"; "VG"; "/dev/sda1"];
2182 ["lvcreate"; "LV1"; "VG"; "50"];
2183 ["lvcreate"; "LV2"; "VG"; "50"];
2185 ["pvremove"; "/dev/sda1"];
2187 InitEmpty, Always, TestOutputListOfDevices (
2188 [["part_disk"; "/dev/sda"; "mbr"];
2189 ["pvcreate"; "/dev/sda1"];
2190 ["vgcreate"; "VG"; "/dev/sda1"];
2191 ["lvcreate"; "LV1"; "VG"; "50"];
2192 ["lvcreate"; "LV2"; "VG"; "50"];
2194 ["pvremove"; "/dev/sda1"];
2196 InitEmpty, Always, TestOutputListOfDevices (
2197 [["part_disk"; "/dev/sda"; "mbr"];
2198 ["pvcreate"; "/dev/sda1"];
2199 ["vgcreate"; "VG"; "/dev/sda1"];
2200 ["lvcreate"; "LV1"; "VG"; "50"];
2201 ["lvcreate"; "LV2"; "VG"; "50"];
2203 ["pvremove"; "/dev/sda1"];
2205 "remove an LVM physical volume",
2207 This wipes a physical volume C<device> so that LVM will no longer
2210 The implementation uses the C<pvremove> command which refuses to
2211 wipe physical volumes that contain any volume groups, so you have
2212 to remove those first.");
2214 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2215 [InitBasicFS, Always, TestOutput (
2216 [["set_e2label"; "/dev/sda1"; "testlabel"];
2217 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2218 "set the ext2/3/4 filesystem label",
2220 This sets the ext2/3/4 filesystem label of the filesystem on
2221 C<device> to C<label>. Filesystem labels are limited to
2224 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2225 to return the existing label on a filesystem.");
2227 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2229 "get the ext2/3/4 filesystem label",
2231 This returns the ext2/3/4 filesystem label of the filesystem on
2234 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2235 (let uuid = uuidgen () in
2236 [InitBasicFS, Always, TestOutput (
2237 [["set_e2uuid"; "/dev/sda1"; uuid];
2238 ["get_e2uuid"; "/dev/sda1"]], uuid);
2239 InitBasicFS, Always, TestOutput (
2240 [["set_e2uuid"; "/dev/sda1"; "clear"];
2241 ["get_e2uuid"; "/dev/sda1"]], "");
2242 (* We can't predict what UUIDs will be, so just check the commands run. *)
2243 InitBasicFS, Always, TestRun (
2244 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2245 InitBasicFS, Always, TestRun (
2246 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2247 "set the ext2/3/4 filesystem UUID",
2249 This sets the ext2/3/4 filesystem UUID of the filesystem on
2250 C<device> to C<uuid>. The format of the UUID and alternatives
2251 such as C<clear>, C<random> and C<time> are described in the
2252 L<tune2fs(8)> manpage.
2254 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2255 to return the existing UUID of a filesystem.");
2257 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2259 "get the ext2/3/4 filesystem UUID",
2261 This returns the ext2/3/4 filesystem UUID of the filesystem on
2264 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2265 [InitBasicFS, Always, TestOutputInt (
2266 [["umount"; "/dev/sda1"];
2267 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2268 InitBasicFS, Always, TestOutputInt (
2269 [["umount"; "/dev/sda1"];
2270 ["zero"; "/dev/sda1"];
2271 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2272 "run the filesystem checker",
2274 This runs the filesystem checker (fsck) on C<device> which
2275 should have filesystem type C<fstype>.
2277 The returned integer is the status. See L<fsck(8)> for the
2278 list of status codes from C<fsck>.
2286 Multiple status codes can be summed together.
2290 A non-zero return code can mean \"success\", for example if
2291 errors have been corrected on the filesystem.
2295 Checking or repairing NTFS volumes is not supported
2300 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2302 ("zero", (RErr, [Device "device"]), 85, [],
2303 [InitBasicFS, Always, TestOutput (
2304 [["umount"; "/dev/sda1"];
2305 ["zero"; "/dev/sda1"];
2306 ["file"; "/dev/sda1"]], "data")],
2307 "write zeroes to the device",
2309 This command writes zeroes over the first few blocks of C<device>.
2311 How many blocks are zeroed isn't specified (but it's I<not> enough
2312 to securely wipe the device). It should be sufficient to remove
2313 any partition tables, filesystem superblocks and so on.
2315 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2317 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2318 (* Test disabled because grub-install incompatible with virtio-blk driver.
2319 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2321 [InitBasicFS, Disabled, TestOutputTrue (
2322 [["grub_install"; "/"; "/dev/sda1"];
2323 ["is_dir"; "/boot"]])],
2326 This command installs GRUB (the Grand Unified Bootloader) on
2327 C<device>, with the root directory being C<root>.");
2329 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2330 [InitBasicFS, Always, TestOutput (
2331 [["write_file"; "/old"; "file content"; "0"];
2332 ["cp"; "/old"; "/new"];
2333 ["cat"; "/new"]], "file content");
2334 InitBasicFS, Always, TestOutputTrue (
2335 [["write_file"; "/old"; "file content"; "0"];
2336 ["cp"; "/old"; "/new"];
2337 ["is_file"; "/old"]]);
2338 InitBasicFS, Always, TestOutput (
2339 [["write_file"; "/old"; "file content"; "0"];
2341 ["cp"; "/old"; "/dir/new"];
2342 ["cat"; "/dir/new"]], "file content")],
2345 This copies a file from C<src> to C<dest> where C<dest> is
2346 either a destination filename or destination directory.");
2348 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2349 [InitBasicFS, Always, TestOutput (
2350 [["mkdir"; "/olddir"];
2351 ["mkdir"; "/newdir"];
2352 ["write_file"; "/olddir/file"; "file content"; "0"];
2353 ["cp_a"; "/olddir"; "/newdir"];
2354 ["cat"; "/newdir/olddir/file"]], "file content")],
2355 "copy a file or directory recursively",
2357 This copies a file or directory from C<src> to C<dest>
2358 recursively using the C<cp -a> command.");
2360 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2361 [InitBasicFS, Always, TestOutput (
2362 [["write_file"; "/old"; "file content"; "0"];
2363 ["mv"; "/old"; "/new"];
2364 ["cat"; "/new"]], "file content");
2365 InitBasicFS, Always, TestOutputFalse (
2366 [["write_file"; "/old"; "file content"; "0"];
2367 ["mv"; "/old"; "/new"];
2368 ["is_file"; "/old"]])],
2371 This moves a file from C<src> to C<dest> where C<dest> is
2372 either a destination filename or destination directory.");
2374 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2375 [InitEmpty, Always, TestRun (
2376 [["drop_caches"; "3"]])],
2377 "drop kernel page cache, dentries and inodes",
2379 This instructs the guest kernel to drop its page cache,
2380 and/or dentries and inode caches. The parameter C<whattodrop>
2381 tells the kernel what precisely to drop, see
2382 L<http://linux-mm.org/Drop_Caches>
2384 Setting C<whattodrop> to 3 should drop everything.
2386 This automatically calls L<sync(2)> before the operation,
2387 so that the maximum guest memory is freed.");
2389 ("dmesg", (RString "kmsgs", []), 91, [],
2390 [InitEmpty, Always, TestRun (
2392 "return kernel messages",
2394 This returns the kernel messages (C<dmesg> output) from
2395 the guest kernel. This is sometimes useful for extended
2396 debugging of problems.
2398 Another way to get the same information is to enable
2399 verbose messages with C<guestfs_set_verbose> or by setting
2400 the environment variable C<LIBGUESTFS_DEBUG=1> before
2401 running the program.");
2403 ("ping_daemon", (RErr, []), 92, [],
2404 [InitEmpty, Always, TestRun (
2405 [["ping_daemon"]])],
2406 "ping the guest daemon",
2408 This is a test probe into the guestfs daemon running inside
2409 the qemu subprocess. Calling this function checks that the
2410 daemon responds to the ping message, without affecting the daemon
2411 or attached block device(s) in any other way.");
2413 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2414 [InitBasicFS, Always, TestOutputTrue (
2415 [["write_file"; "/file1"; "contents of a file"; "0"];
2416 ["cp"; "/file1"; "/file2"];
2417 ["equal"; "/file1"; "/file2"]]);
2418 InitBasicFS, Always, TestOutputFalse (
2419 [["write_file"; "/file1"; "contents of a file"; "0"];
2420 ["write_file"; "/file2"; "contents of another file"; "0"];
2421 ["equal"; "/file1"; "/file2"]]);
2422 InitBasicFS, Always, TestLastFail (
2423 [["equal"; "/file1"; "/file2"]])],
2424 "test if two files have equal contents",
2426 This compares the two files C<file1> and C<file2> and returns
2427 true if their content is exactly equal, or false otherwise.
2429 The external L<cmp(1)> program is used for the comparison.");
2431 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2432 [InitISOFS, Always, TestOutputList (
2433 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2434 InitISOFS, Always, TestOutputList (
2435 [["strings"; "/empty"]], [])],
2436 "print the printable strings in a file",
2438 This runs the L<strings(1)> command on a file and returns
2439 the list of printable strings found.");
2441 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2442 [InitISOFS, Always, TestOutputList (
2443 [["strings_e"; "b"; "/known-5"]], []);
2444 InitBasicFS, Disabled, TestOutputList (
2445 [["write_file"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"; "24"];
2446 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2447 "print the printable strings in a file",
2449 This is like the C<guestfs_strings> command, but allows you to
2450 specify the encoding.
2452 See the L<strings(1)> manpage for the full list of encodings.
2454 Commonly useful encodings are C<l> (lower case L) which will
2455 show strings inside Windows/x86 files.
2457 The returned strings are transcoded to UTF-8.");
2459 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2460 [InitISOFS, Always, TestOutput (
2461 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2462 (* Test for RHBZ#501888c2 regression which caused large hexdump
2463 * commands to segfault.
2465 InitISOFS, Always, TestRun (
2466 [["hexdump"; "/100krandom"]])],
2467 "dump a file in hexadecimal",
2469 This runs C<hexdump -C> on the given C<path>. The result is
2470 the human-readable, canonical hex dump of the file.");
2472 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2473 [InitNone, Always, TestOutput (
2474 [["part_disk"; "/dev/sda"; "mbr"];
2475 ["mkfs"; "ext3"; "/dev/sda1"];
2476 ["mount_options"; ""; "/dev/sda1"; "/"];
2477 ["write_file"; "/new"; "test file"; "0"];
2478 ["umount"; "/dev/sda1"];
2479 ["zerofree"; "/dev/sda1"];
2480 ["mount_options"; ""; "/dev/sda1"; "/"];
2481 ["cat"; "/new"]], "test file")],
2482 "zero unused inodes and disk blocks on ext2/3 filesystem",
2484 This runs the I<zerofree> program on C<device>. This program
2485 claims to zero unused inodes and disk blocks on an ext2/3
2486 filesystem, thus making it possible to compress the filesystem
2489 You should B<not> run this program if the filesystem is
2492 It is possible that using this program can damage the filesystem
2493 or data on the filesystem.");
2495 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2497 "resize an LVM physical volume",
2499 This resizes (expands or shrinks) an existing LVM physical
2500 volume to match the new size of the underlying device.");
2502 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2503 Int "cyls"; Int "heads"; Int "sectors";
2504 String "line"]), 99, [DangerWillRobinson],
2506 "modify a single partition on a block device",
2508 This runs L<sfdisk(8)> option to modify just the single
2509 partition C<n> (note: C<n> counts from 1).
2511 For other parameters, see C<guestfs_sfdisk>. You should usually
2512 pass C<0> for the cyls/heads/sectors parameters.
2514 See also: C<guestfs_part_add>");
2516 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2518 "display the partition table",
2520 This displays the partition table on C<device>, in the
2521 human-readable output of the L<sfdisk(8)> command. It is
2522 not intended to be parsed.
2524 See also: C<guestfs_part_list>");
2526 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2528 "display the kernel geometry",
2530 This displays the kernel's idea of the geometry of C<device>.
2532 The result is in human-readable format, and not designed to
2535 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2537 "display the disk geometry from the partition table",
2539 This displays the disk geometry of C<device> read from the
2540 partition table. Especially in the case where the underlying
2541 block device has been resized, this can be different from the
2542 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2544 The result is in human-readable format, and not designed to
2547 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2549 "activate or deactivate all volume groups",
2551 This command activates or (if C<activate> is false) deactivates
2552 all logical volumes in all volume groups.
2553 If activated, then they are made known to the
2554 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2555 then those devices disappear.
2557 This command is the same as running C<vgchange -a y|n>");
2559 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2561 "activate or deactivate some volume groups",
2563 This command activates or (if C<activate> is false) deactivates
2564 all logical volumes in the listed volume groups C<volgroups>.
2565 If activated, then they are made known to the
2566 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2567 then those devices disappear.
2569 This command is the same as running C<vgchange -a y|n volgroups...>
2571 Note that if C<volgroups> is an empty list then B<all> volume groups
2572 are activated or deactivated.");
2574 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2575 [InitNone, Always, TestOutput (
2576 [["part_disk"; "/dev/sda"; "mbr"];
2577 ["pvcreate"; "/dev/sda1"];
2578 ["vgcreate"; "VG"; "/dev/sda1"];
2579 ["lvcreate"; "LV"; "VG"; "10"];
2580 ["mkfs"; "ext2"; "/dev/VG/LV"];
2581 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2582 ["write_file"; "/new"; "test content"; "0"];
2584 ["lvresize"; "/dev/VG/LV"; "20"];
2585 ["e2fsck_f"; "/dev/VG/LV"];
2586 ["resize2fs"; "/dev/VG/LV"];
2587 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2588 ["cat"; "/new"]], "test content")],
2589 "resize an LVM logical volume",
2591 This resizes (expands or shrinks) an existing LVM logical
2592 volume to C<mbytes>. When reducing, data in the reduced part
2595 ("resize2fs", (RErr, [Device "device"]), 106, [],
2596 [], (* lvresize tests this *)
2597 "resize an ext2/ext3 filesystem",
2599 This resizes an ext2 or ext3 filesystem to match the size of
2600 the underlying device.
2602 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2603 on the C<device> before calling this command. For unknown reasons
2604 C<resize2fs> sometimes gives an error about this and sometimes not.
2605 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2606 calling this function.");
2608 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2609 [InitBasicFS, Always, TestOutputList (
2610 [["find"; "/"]], ["lost+found"]);
2611 InitBasicFS, Always, TestOutputList (
2615 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2616 InitBasicFS, Always, TestOutputList (
2617 [["mkdir_p"; "/a/b/c"];
2618 ["touch"; "/a/b/c/d"];
2619 ["find"; "/a/b/"]], ["c"; "c/d"])],
2620 "find all files and directories",
2622 This command lists out all files and directories, recursively,
2623 starting at C<directory>. It is essentially equivalent to
2624 running the shell command C<find directory -print> but some
2625 post-processing happens on the output, described below.
2627 This returns a list of strings I<without any prefix>. Thus
2628 if the directory structure was:
2634 then the returned list from C<guestfs_find> C</tmp> would be
2642 If C<directory> is not a directory, then this command returns
2645 The returned list is sorted.
2647 See also C<guestfs_find0>.");
2649 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2650 [], (* lvresize tests this *)
2651 "check an ext2/ext3 filesystem",
2653 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2654 filesystem checker on C<device>, noninteractively (C<-p>),
2655 even if the filesystem appears to be clean (C<-f>).
2657 This command is only needed because of C<guestfs_resize2fs>
2658 (q.v.). Normally you should use C<guestfs_fsck>.");
2660 ("sleep", (RErr, [Int "secs"]), 109, [],
2661 [InitNone, Always, TestRun (
2663 "sleep for some seconds",
2665 Sleep for C<secs> seconds.");
2667 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2668 [InitNone, Always, TestOutputInt (
2669 [["part_disk"; "/dev/sda"; "mbr"];
2670 ["mkfs"; "ntfs"; "/dev/sda1"];
2671 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2672 InitNone, Always, TestOutputInt (
2673 [["part_disk"; "/dev/sda"; "mbr"];
2674 ["mkfs"; "ext2"; "/dev/sda1"];
2675 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2676 "probe NTFS volume",
2678 This command runs the L<ntfs-3g.probe(8)> command which probes
2679 an NTFS C<device> for mountability. (Not all NTFS volumes can
2680 be mounted read-write, and some cannot be mounted at all).
2682 C<rw> is a boolean flag. Set it to true if you want to test
2683 if the volume can be mounted read-write. Set it to false if
2684 you want to test if the volume can be mounted read-only.
2686 The return value is an integer which C<0> if the operation
2687 would succeed, or some non-zero value documented in the
2688 L<ntfs-3g.probe(8)> manual page.");
2690 ("sh", (RString "output", [String "command"]), 111, [],
2691 [], (* XXX needs tests *)
2692 "run a command via the shell",
2694 This call runs a command from the guest filesystem via the
2697 This is like C<guestfs_command>, but passes the command to:
2699 /bin/sh -c \"command\"
2701 Depending on the guest's shell, this usually results in
2702 wildcards being expanded, shell expressions being interpolated
2705 All the provisos about C<guestfs_command> apply to this call.");
2707 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2708 [], (* XXX needs tests *)
2709 "run a command via the shell returning lines",
2711 This is the same as C<guestfs_sh>, but splits the result
2712 into a list of lines.
2714 See also: C<guestfs_command_lines>");
2716 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2717 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2718 * code in stubs.c, since all valid glob patterns must start with "/".
2719 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2721 [InitBasicFS, Always, TestOutputList (
2722 [["mkdir_p"; "/a/b/c"];
2723 ["touch"; "/a/b/c/d"];
2724 ["touch"; "/a/b/c/e"];
2725 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2726 InitBasicFS, Always, TestOutputList (
2727 [["mkdir_p"; "/a/b/c"];
2728 ["touch"; "/a/b/c/d"];
2729 ["touch"; "/a/b/c/e"];
2730 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2731 InitBasicFS, Always, TestOutputList (
2732 [["mkdir_p"; "/a/b/c"];
2733 ["touch"; "/a/b/c/d"];
2734 ["touch"; "/a/b/c/e"];
2735 ["glob_expand"; "/a/*/x/*"]], [])],
2736 "expand a wildcard path",
2738 This command searches for all the pathnames matching
2739 C<pattern> according to the wildcard expansion rules
2742 If no paths match, then this returns an empty list
2743 (note: not an error).
2745 It is just a wrapper around the C L<glob(3)> function
2746 with flags C<GLOB_MARK|GLOB_BRACE>.
2747 See that manual page for more details.");
2749 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2750 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2751 [["scrub_device"; "/dev/sdc"]])],
2752 "scrub (securely wipe) a device",
2754 This command writes patterns over C<device> to make data retrieval
2757 It is an interface to the L<scrub(1)> program. See that
2758 manual page for more details.");
2760 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2761 [InitBasicFS, Always, TestRun (
2762 [["write_file"; "/file"; "content"; "0"];
2763 ["scrub_file"; "/file"]])],
2764 "scrub (securely wipe) a file",
2766 This command writes patterns over a file to make data retrieval
2769 The file is I<removed> after scrubbing.
2771 It is an interface to the L<scrub(1)> program. See that
2772 manual page for more details.");
2774 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2775 [], (* XXX needs testing *)
2776 "scrub (securely wipe) free space",
2778 This command creates the directory C<dir> and then fills it
2779 with files until the filesystem is full, and scrubs the files
2780 as for C<guestfs_scrub_file>, and deletes them.
2781 The intention is to scrub any free space on the partition
2784 It is an interface to the L<scrub(1)> program. See that
2785 manual page for more details.");
2787 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2788 [InitBasicFS, Always, TestRun (
2790 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2791 "create a temporary directory",
2793 This command creates a temporary directory. The
2794 C<template> parameter should be a full pathname for the
2795 temporary directory name with the final six characters being
2798 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2799 the second one being suitable for Windows filesystems.
2801 The name of the temporary directory that was created
2804 The temporary directory is created with mode 0700
2805 and is owned by root.
2807 The caller is responsible for deleting the temporary
2808 directory and its contents after use.
2810 See also: L<mkdtemp(3)>");
2812 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2813 [InitISOFS, Always, TestOutputInt (
2814 [["wc_l"; "/10klines"]], 10000)],
2815 "count lines in a file",
2817 This command counts the lines in a file, using the
2818 C<wc -l> external command.");
2820 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2821 [InitISOFS, Always, TestOutputInt (
2822 [["wc_w"; "/10klines"]], 10000)],
2823 "count words in a file",
2825 This command counts the words in a file, using the
2826 C<wc -w> external command.");
2828 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2829 [InitISOFS, Always, TestOutputInt (
2830 [["wc_c"; "/100kallspaces"]], 102400)],
2831 "count characters in a file",
2833 This command counts the characters in a file, using the
2834 C<wc -c> external command.");
2836 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2837 [InitISOFS, Always, TestOutputList (
2838 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2839 "return first 10 lines of a file",
2841 This command returns up to the first 10 lines of a file as
2842 a list of strings.");
2844 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2845 [InitISOFS, Always, TestOutputList (
2846 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2847 InitISOFS, Always, TestOutputList (
2848 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2849 InitISOFS, Always, TestOutputList (
2850 [["head_n"; "0"; "/10klines"]], [])],
2851 "return first N lines of a file",
2853 If the parameter C<nrlines> is a positive number, this returns the first
2854 C<nrlines> lines of the file C<path>.
2856 If the parameter C<nrlines> is a negative number, this returns lines
2857 from the file C<path>, excluding the last C<nrlines> lines.
2859 If the parameter C<nrlines> is zero, this returns an empty list.");
2861 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2862 [InitISOFS, Always, TestOutputList (
2863 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2864 "return last 10 lines of a file",
2866 This command returns up to the last 10 lines of a file as
2867 a list of strings.");
2869 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2870 [InitISOFS, Always, TestOutputList (
2871 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2872 InitISOFS, Always, TestOutputList (
2873 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2874 InitISOFS, Always, TestOutputList (
2875 [["tail_n"; "0"; "/10klines"]], [])],
2876 "return last N lines of a file",
2878 If the parameter C<nrlines> is a positive number, this returns the last
2879 C<nrlines> lines of the file C<path>.
2881 If the parameter C<nrlines> is a negative number, this returns lines
2882 from the file C<path>, starting with the C<-nrlines>th line.
2884 If the parameter C<nrlines> is zero, this returns an empty list.");
2886 ("df", (RString "output", []), 125, [],
2887 [], (* XXX Tricky to test because it depends on the exact format
2888 * of the 'df' command and other imponderables.
2890 "report file system disk space usage",
2892 This command runs the C<df> command to report disk space used.
2894 This command is mostly useful for interactive sessions. It
2895 is I<not> intended that you try to parse the output string.
2896 Use C<statvfs> from programs.");
2898 ("df_h", (RString "output", []), 126, [],
2899 [], (* XXX Tricky to test because it depends on the exact format
2900 * of the 'df' command and other imponderables.
2902 "report file system disk space usage (human readable)",
2904 This command runs the C<df -h> command to report disk space used
2905 in human-readable format.
2907 This command is mostly useful for interactive sessions. It
2908 is I<not> intended that you try to parse the output string.
2909 Use C<statvfs> from programs.");
2911 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2912 [InitISOFS, Always, TestOutputInt (
2913 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2914 "estimate file space usage",
2916 This command runs the C<du -s> command to estimate file space
2919 C<path> can be a file or a directory. If C<path> is a directory
2920 then the estimate includes the contents of the directory and all
2921 subdirectories (recursively).
2923 The result is the estimated size in I<kilobytes>
2924 (ie. units of 1024 bytes).");
2926 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2927 [InitISOFS, Always, TestOutputList (
2928 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2929 "list files in an initrd",
2931 This command lists out files contained in an initrd.
2933 The files are listed without any initial C</> character. The
2934 files are listed in the order they appear (not necessarily
2935 alphabetical). Directory names are listed as separate items.
2937 Old Linux kernels (2.4 and earlier) used a compressed ext2
2938 filesystem as initrd. We I<only> support the newer initramfs
2939 format (compressed cpio files).");
2941 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2943 "mount a file using the loop device",
2945 This command lets you mount C<file> (a filesystem image
2946 in a file) on a mount point. It is entirely equivalent to
2947 the command C<mount -o loop file mountpoint>.");
2949 ("mkswap", (RErr, [Device "device"]), 130, [],
2950 [InitEmpty, Always, TestRun (
2951 [["part_disk"; "/dev/sda"; "mbr"];
2952 ["mkswap"; "/dev/sda1"]])],
2953 "create a swap partition",
2955 Create a swap partition on C<device>.");
2957 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2958 [InitEmpty, Always, TestRun (
2959 [["part_disk"; "/dev/sda"; "mbr"];
2960 ["mkswap_L"; "hello"; "/dev/sda1"]])],
2961 "create a swap partition with a label",
2963 Create a swap partition on C<device> with label C<label>.
2965 Note that you cannot attach a swap label to a block device
2966 (eg. C</dev/sda>), just to a partition. This appears to be
2967 a limitation of the kernel or swap tools.");
2969 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
2970 (let uuid = uuidgen () in
2971 [InitEmpty, Always, TestRun (
2972 [["part_disk"; "/dev/sda"; "mbr"];
2973 ["mkswap_U"; uuid; "/dev/sda1"]])]),
2974 "create a swap partition with an explicit UUID",
2976 Create a swap partition on C<device> with UUID C<uuid>.");
2978 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
2979 [InitBasicFS, Always, TestOutputStruct (
2980 [["mknod"; "0o10777"; "0"; "0"; "/node"];
2981 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
2982 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
2983 InitBasicFS, Always, TestOutputStruct (
2984 [["mknod"; "0o60777"; "66"; "99"; "/node"];
2985 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
2986 "make block, character or FIFO devices",
2988 This call creates block or character special devices, or
2989 named pipes (FIFOs).
2991 The C<mode> parameter should be the mode, using the standard
2992 constants. C<devmajor> and C<devminor> are the
2993 device major and minor numbers, only used when creating block
2994 and character special devices.
2996 Note that, just like L<mknod(2)>, the mode must be bitwise
2997 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
2998 just creates a regular file). These constants are
2999 available in the standard Linux header files, or you can use
3000 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3001 which are wrappers around this command which bitwise OR
3002 in the appropriate constant for you.
3004 The mode actually set is affected by the umask.");
3006 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3007 [InitBasicFS, Always, TestOutputStruct (
3008 [["mkfifo"; "0o777"; "/node"];
3009 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3010 "make FIFO (named pipe)",
3012 This call creates a FIFO (named pipe) called C<path> with
3013 mode C<mode>. It is just a convenient wrapper around
3016 The mode actually set is affected by the umask.");
3018 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3019 [InitBasicFS, Always, TestOutputStruct (
3020 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3021 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3022 "make block device node",
3024 This call creates a block device node called C<path> with
3025 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3026 It is just a convenient wrapper around C<guestfs_mknod>.
3028 The mode actually set is affected by the umask.");
3030 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3031 [InitBasicFS, Always, TestOutputStruct (
3032 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3033 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3034 "make char device node",
3036 This call creates a char device node called C<path> with
3037 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3038 It is just a convenient wrapper around C<guestfs_mknod>.
3040 The mode actually set is affected by the umask.");
3042 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3043 [InitEmpty, Always, TestOutputInt (
3044 [["umask"; "0o22"]], 0o22)],
3045 "set file mode creation mask (umask)",
3047 This function sets the mask used for creating new files and
3048 device nodes to C<mask & 0777>.
3050 Typical umask values would be C<022> which creates new files
3051 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3052 C<002> which creates new files with permissions like
3053 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3055 The default umask is C<022>. This is important because it
3056 means that directories and device nodes will be created with
3057 C<0644> or C<0755> mode even if you specify C<0777>.
3059 See also C<guestfs_get_umask>,
3060 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3062 This call returns the previous umask.");
3064 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3066 "read directories entries",
3068 This returns the list of directory entries in directory C<dir>.
3070 All entries in the directory are returned, including C<.> and
3071 C<..>. The entries are I<not> sorted, but returned in the same
3072 order as the underlying filesystem.
3074 Also this call returns basic file type information about each
3075 file. The C<ftyp> field will contain one of the following characters:
3113 The L<readdir(3)> returned a C<d_type> field with an
3118 This function is primarily intended for use by programs. To
3119 get a simple list of names, use C<guestfs_ls>. To get a printable
3120 directory for human consumption, use C<guestfs_ll>.");
3122 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3124 "create partitions on a block device",
3126 This is a simplified interface to the C<guestfs_sfdisk>
3127 command, where partition sizes are specified in megabytes
3128 only (rounded to the nearest cylinder) and you don't need
3129 to specify the cyls, heads and sectors parameters which
3130 were rarely if ever used anyway.
3132 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3133 and C<guestfs_part_disk>");
3135 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3137 "determine file type inside a compressed file",
3139 This command runs C<file> after first decompressing C<path>
3142 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3144 Since 1.0.63, use C<guestfs_file> instead which can now
3145 process compressed files.");
3147 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3149 "list extended attributes of a file or directory",
3151 This call lists the extended attributes of the file or directory
3154 At the system call level, this is a combination of the
3155 L<listxattr(2)> and L<getxattr(2)> calls.
3157 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3159 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3161 "list extended attributes of a file or directory",
3163 This is the same as C<guestfs_getxattrs>, but if C<path>
3164 is a symbolic link, then it returns the extended attributes
3165 of the link itself.");
3167 ("setxattr", (RErr, [String "xattr";
3168 String "val"; Int "vallen"; (* will be BufferIn *)
3169 Pathname "path"]), 143, [Optional "linuxxattrs"],
3171 "set extended attribute of a file or directory",
3173 This call sets the extended attribute named C<xattr>
3174 of the file C<path> to the value C<val> (of length C<vallen>).
3175 The value is arbitrary 8 bit data.
3177 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3179 ("lsetxattr", (RErr, [String "xattr";
3180 String "val"; Int "vallen"; (* will be BufferIn *)
3181 Pathname "path"]), 144, [Optional "linuxxattrs"],
3183 "set extended attribute of a file or directory",
3185 This is the same as C<guestfs_setxattr>, but if C<path>
3186 is a symbolic link, then it sets an extended attribute
3187 of the link itself.");
3189 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3191 "remove extended attribute of a file or directory",
3193 This call removes the extended attribute named C<xattr>
3194 of the file C<path>.
3196 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3198 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3200 "remove extended attribute of a file or directory",
3202 This is the same as C<guestfs_removexattr>, but if C<path>
3203 is a symbolic link, then it removes an extended attribute
3204 of the link itself.");
3206 ("mountpoints", (RHashtable "mps", []), 147, [],
3210 This call is similar to C<guestfs_mounts>. That call returns
3211 a list of devices. This one returns a hash table (map) of
3212 device name to directory where the device is mounted.");
3214 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3215 (* This is a special case: while you would expect a parameter
3216 * of type "Pathname", that doesn't work, because it implies
3217 * NEED_ROOT in the generated calling code in stubs.c, and
3218 * this function cannot use NEED_ROOT.
3221 "create a mountpoint",
3223 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3224 specialized calls that can be used to create extra mountpoints
3225 before mounting the first filesystem.
3227 These calls are I<only> necessary in some very limited circumstances,
3228 mainly the case where you want to mount a mix of unrelated and/or
3229 read-only filesystems together.
3231 For example, live CDs often contain a \"Russian doll\" nest of
3232 filesystems, an ISO outer layer, with a squashfs image inside, with
3233 an ext2/3 image inside that. You can unpack this as follows
3236 add-ro Fedora-11-i686-Live.iso
3239 mkmountpoint /squash
3242 mount-loop /cd/LiveOS/squashfs.img /squash
3243 mount-loop /squash/LiveOS/ext3fs.img /ext3
3245 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3247 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3249 "remove a mountpoint",
3251 This calls removes a mountpoint that was previously created
3252 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3253 for full details.");
3255 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3256 [InitISOFS, Always, TestOutputBuffer (
3257 [["read_file"; "/known-4"]], "abc\ndef\nghi")],
3260 This calls returns the contents of the file C<path> as a
3263 Unlike C<guestfs_cat>, this function can correctly
3264 handle files that contain embedded ASCII NUL characters.
3265 However unlike C<guestfs_download>, this function is limited
3266 in the total size of file that can be handled.");
3268 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3269 [InitISOFS, Always, TestOutputList (
3270 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3271 InitISOFS, Always, TestOutputList (
3272 [["grep"; "nomatch"; "/test-grep.txt"]], [])],
3273 "return lines matching a pattern",
3275 This calls the external C<grep> program and returns the
3278 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3279 [InitISOFS, Always, TestOutputList (
3280 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3281 "return lines matching a pattern",
3283 This calls the external C<egrep> program and returns the
3286 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3287 [InitISOFS, Always, TestOutputList (
3288 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3289 "return lines matching a pattern",
3291 This calls the external C<fgrep> program and returns the
3294 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3295 [InitISOFS, Always, TestOutputList (
3296 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3297 "return lines matching a pattern",
3299 This calls the external C<grep -i> program and returns the
3302 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3303 [InitISOFS, Always, TestOutputList (
3304 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3305 "return lines matching a pattern",
3307 This calls the external C<egrep -i> program and returns the
3310 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3311 [InitISOFS, Always, TestOutputList (
3312 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3313 "return lines matching a pattern",
3315 This calls the external C<fgrep -i> program and returns the
3318 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3319 [InitISOFS, Always, TestOutputList (
3320 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3321 "return lines matching a pattern",
3323 This calls the external C<zgrep> program and returns the
3326 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3327 [InitISOFS, Always, TestOutputList (
3328 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3329 "return lines matching a pattern",
3331 This calls the external C<zegrep> program and returns the
3334 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3335 [InitISOFS, Always, TestOutputList (
3336 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3337 "return lines matching a pattern",
3339 This calls the external C<zfgrep> program and returns the
3342 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3343 [InitISOFS, Always, TestOutputList (
3344 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3345 "return lines matching a pattern",
3347 This calls the external C<zgrep -i> program and returns the
3350 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3351 [InitISOFS, Always, TestOutputList (
3352 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3353 "return lines matching a pattern",
3355 This calls the external C<zegrep -i> program and returns the
3358 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3359 [InitISOFS, Always, TestOutputList (
3360 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3361 "return lines matching a pattern",
3363 This calls the external C<zfgrep -i> program and returns the
3366 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3367 [InitISOFS, Always, TestOutput (
3368 [["realpath"; "/../directory"]], "/directory")],
3369 "canonicalized absolute pathname",
3371 Return the canonicalized absolute pathname of C<path>. The
3372 returned path has no C<.>, C<..> or symbolic link path elements.");
3374 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3375 [InitBasicFS, Always, TestOutputStruct (
3378 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3379 "create a hard link",
3381 This command creates a hard link using the C<ln> command.");
3383 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3384 [InitBasicFS, Always, TestOutputStruct (
3387 ["ln_f"; "/a"; "/b"];
3388 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3389 "create a hard link",
3391 This command creates a hard link using the C<ln -f> command.
3392 The C<-f> option removes the link (C<linkname>) if it exists already.");
3394 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3395 [InitBasicFS, Always, TestOutputStruct (
3397 ["ln_s"; "a"; "/b"];
3398 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3399 "create a symbolic link",
3401 This command creates a symbolic link using the C<ln -s> command.");
3403 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3404 [InitBasicFS, Always, TestOutput (
3405 [["mkdir_p"; "/a/b"];
3406 ["touch"; "/a/b/c"];
3407 ["ln_sf"; "../d"; "/a/b/c"];
3408 ["readlink"; "/a/b/c"]], "../d")],
3409 "create a symbolic link",
3411 This command creates a symbolic link using the C<ln -sf> command,
3412 The C<-f> option removes the link (C<linkname>) if it exists already.");
3414 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3415 [] (* XXX tested above *),
3416 "read the target of a symbolic link",
3418 This command reads the target of a symbolic link.");
3420 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3421 [InitBasicFS, Always, TestOutputStruct (
3422 [["fallocate"; "/a"; "1000000"];
3423 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3424 "preallocate a file in the guest filesystem",
3426 This command preallocates a file (containing zero bytes) named
3427 C<path> of size C<len> bytes. If the file exists already, it
3430 Do not confuse this with the guestfish-specific
3431 C<alloc> command which allocates a file in the host and
3432 attaches it as a device.");
3434 ("swapon_device", (RErr, [Device "device"]), 170, [],
3435 [InitPartition, Always, TestRun (
3436 [["mkswap"; "/dev/sda1"];
3437 ["swapon_device"; "/dev/sda1"];
3438 ["swapoff_device"; "/dev/sda1"]])],
3439 "enable swap on device",
3441 This command enables the libguestfs appliance to use the
3442 swap device or partition named C<device>. The increased
3443 memory is made available for all commands, for example
3444 those run using C<guestfs_command> or C<guestfs_sh>.
3446 Note that you should not swap to existing guest swap
3447 partitions unless you know what you are doing. They may
3448 contain hibernation information, or other information that
3449 the guest doesn't want you to trash. You also risk leaking
3450 information about the host to the guest this way. Instead,
3451 attach a new host device to the guest and swap on that.");
3453 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3454 [], (* XXX tested by swapon_device *)
3455 "disable swap on device",
3457 This command disables the libguestfs appliance swap
3458 device or partition named C<device>.
3459 See C<guestfs_swapon_device>.");
3461 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3462 [InitBasicFS, Always, TestRun (
3463 [["fallocate"; "/swap"; "8388608"];
3464 ["mkswap_file"; "/swap"];
3465 ["swapon_file"; "/swap"];
3466 ["swapoff_file"; "/swap"]])],
3467 "enable swap on file",
3469 This command enables swap to a file.
3470 See C<guestfs_swapon_device> for other notes.");
3472 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3473 [], (* XXX tested by swapon_file *)
3474 "disable swap on file",
3476 This command disables the libguestfs appliance swap on file.");
3478 ("swapon_label", (RErr, [String "label"]), 174, [],
3479 [InitEmpty, Always, TestRun (
3480 [["part_disk"; "/dev/sdb"; "mbr"];
3481 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3482 ["swapon_label"; "swapit"];
3483 ["swapoff_label"; "swapit"];
3484 ["zero"; "/dev/sdb"];
3485 ["blockdev_rereadpt"; "/dev/sdb"]])],
3486 "enable swap on labeled swap partition",
3488 This command enables swap to a labeled swap partition.
3489 See C<guestfs_swapon_device> for other notes.");
3491 ("swapoff_label", (RErr, [String "label"]), 175, [],
3492 [], (* XXX tested by swapon_label *)
3493 "disable swap on labeled swap partition",
3495 This command disables the libguestfs appliance swap on
3496 labeled swap partition.");
3498 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3499 (let uuid = uuidgen () in
3500 [InitEmpty, Always, TestRun (
3501 [["mkswap_U"; uuid; "/dev/sdb"];
3502 ["swapon_uuid"; uuid];
3503 ["swapoff_uuid"; uuid]])]),
3504 "enable swap on swap partition by UUID",
3506 This command enables swap to a swap partition with the given UUID.
3507 See C<guestfs_swapon_device> for other notes.");
3509 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3510 [], (* XXX tested by swapon_uuid *)
3511 "disable swap on swap partition by UUID",
3513 This command disables the libguestfs appliance swap partition
3514 with the given UUID.");
3516 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3517 [InitBasicFS, Always, TestRun (
3518 [["fallocate"; "/swap"; "8388608"];
3519 ["mkswap_file"; "/swap"]])],
3520 "create a swap file",
3524 This command just writes a swap file signature to an existing
3525 file. To create the file itself, use something like C<guestfs_fallocate>.");
3527 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3528 [InitISOFS, Always, TestRun (
3529 [["inotify_init"; "0"]])],
3530 "create an inotify handle",
3532 This command creates a new inotify handle.
3533 The inotify subsystem can be used to notify events which happen to
3534 objects in the guest filesystem.
3536 C<maxevents> is the maximum number of events which will be
3537 queued up between calls to C<guestfs_inotify_read> or
3538 C<guestfs_inotify_files>.
3539 If this is passed as C<0>, then the kernel (or previously set)
3540 default is used. For Linux 2.6.29 the default was 16384 events.
3541 Beyond this limit, the kernel throws away events, but records
3542 the fact that it threw them away by setting a flag
3543 C<IN_Q_OVERFLOW> in the returned structure list (see
3544 C<guestfs_inotify_read>).
3546 Before any events are generated, you have to add some
3547 watches to the internal watch list. See:
3548 C<guestfs_inotify_add_watch>,
3549 C<guestfs_inotify_rm_watch> and
3550 C<guestfs_inotify_watch_all>.
3552 Queued up events should be read periodically by calling
3553 C<guestfs_inotify_read>
3554 (or C<guestfs_inotify_files> which is just a helpful
3555 wrapper around C<guestfs_inotify_read>). If you don't
3556 read the events out often enough then you risk the internal
3559 The handle should be closed after use by calling
3560 C<guestfs_inotify_close>. This also removes any
3561 watches automatically.
3563 See also L<inotify(7)> for an overview of the inotify interface
3564 as exposed by the Linux kernel, which is roughly what we expose
3565 via libguestfs. Note that there is one global inotify handle
3566 per libguestfs instance.");
3568 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3569 [InitBasicFS, Always, TestOutputList (
3570 [["inotify_init"; "0"];
3571 ["inotify_add_watch"; "/"; "1073741823"];
3574 ["inotify_files"]], ["a"; "b"])],
3575 "add an inotify watch",
3577 Watch C<path> for the events listed in C<mask>.
3579 Note that if C<path> is a directory then events within that
3580 directory are watched, but this does I<not> happen recursively
3581 (in subdirectories).
3583 Note for non-C or non-Linux callers: the inotify events are
3584 defined by the Linux kernel ABI and are listed in
3585 C</usr/include/sys/inotify.h>.");
3587 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3589 "remove an inotify watch",
3591 Remove a previously defined inotify watch.
3592 See C<guestfs_inotify_add_watch>.");
3594 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3596 "return list of inotify events",
3598 Return the complete queue of events that have happened
3599 since the previous read call.
3601 If no events have happened, this returns an empty list.
3603 I<Note>: In order to make sure that all events have been
3604 read, you must call this function repeatedly until it
3605 returns an empty list. The reason is that the call will
3606 read events up to the maximum appliance-to-host message
3607 size and leave remaining events in the queue.");
3609 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3611 "return list of watched files that had events",
3613 This function is a helpful wrapper around C<guestfs_inotify_read>
3614 which just returns a list of pathnames of objects that were
3615 touched. The returned pathnames are sorted and deduplicated.");
3617 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3619 "close the inotify handle",
3621 This closes the inotify handle which was previously
3622 opened by inotify_init. It removes all watches, throws
3623 away any pending events, and deallocates all resources.");
3625 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3627 "set SELinux security context",
3629 This sets the SELinux security context of the daemon
3630 to the string C<context>.
3632 See the documentation about SELINUX in L<guestfs(3)>.");
3634 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3636 "get SELinux security context",
3638 This gets the SELinux security context of the daemon.
3640 See the documentation about SELINUX in L<guestfs(3)>,
3641 and C<guestfs_setcon>");
3643 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3644 [InitEmpty, Always, TestOutput (
3645 [["part_disk"; "/dev/sda"; "mbr"];
3646 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3647 ["mount_options"; ""; "/dev/sda1"; "/"];
3648 ["write_file"; "/new"; "new file contents"; "0"];
3649 ["cat"; "/new"]], "new file contents")],
3650 "make a filesystem with block size",
3652 This call is similar to C<guestfs_mkfs>, but it allows you to
3653 control the block size of the resulting filesystem. Supported
3654 block sizes depend on the filesystem type, but typically they
3655 are C<1024>, C<2048> or C<4096> only.");
3657 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3658 [InitEmpty, Always, TestOutput (
3659 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3660 ["mke2journal"; "4096"; "/dev/sda1"];
3661 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3662 ["mount_options"; ""; "/dev/sda2"; "/"];
3663 ["write_file"; "/new"; "new file contents"; "0"];
3664 ["cat"; "/new"]], "new file contents")],
3665 "make ext2/3/4 external journal",
3667 This creates an ext2 external journal on C<device>. It is equivalent
3670 mke2fs -O journal_dev -b blocksize device");
3672 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3673 [InitEmpty, Always, TestOutput (
3674 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3675 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3676 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3677 ["mount_options"; ""; "/dev/sda2"; "/"];
3678 ["write_file"; "/new"; "new file contents"; "0"];
3679 ["cat"; "/new"]], "new file contents")],
3680 "make ext2/3/4 external journal with label",
3682 This creates an ext2 external journal on C<device> with label C<label>.");
3684 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3685 (let uuid = uuidgen () in
3686 [InitEmpty, Always, TestOutput (
3687 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3688 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3689 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3690 ["mount_options"; ""; "/dev/sda2"; "/"];
3691 ["write_file"; "/new"; "new file contents"; "0"];
3692 ["cat"; "/new"]], "new file contents")]),
3693 "make ext2/3/4 external journal with UUID",
3695 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3697 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3699 "make ext2/3/4 filesystem with external journal",
3701 This creates an ext2/3/4 filesystem on C<device> with
3702 an external journal on C<journal>. It is equivalent
3705 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3707 See also C<guestfs_mke2journal>.");
3709 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3711 "make ext2/3/4 filesystem with external journal",
3713 This creates an ext2/3/4 filesystem on C<device> with
3714 an external journal on the journal labeled C<label>.
3716 See also C<guestfs_mke2journal_L>.");
3718 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],