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.
167 (* Opaque buffer which can contain arbitrary 8 bit data.
168 * In the C API, this is expressed as <const char *, size_t> pair.
169 * Most other languages have a string type which can contain
170 * ASCII NUL. We use whatever type is appropriate for each
172 * Buffers are limited by the total message size. To transfer
173 * large blocks of data, use FileIn/FileOut parameters instead.
174 * To return an arbitrary buffer, use RBufferOut.
179 | ProtocolLimitWarning (* display warning about protocol size limits *)
180 | DangerWillRobinson (* flags particularly dangerous commands *)
181 | FishAlias of string (* provide an alias for this cmd in guestfish *)
182 | FishOutput of fish_output_t (* how to display output in guestfish *)
183 | NotInFish (* do not export via guestfish *)
184 | NotInDocs (* do not add this function to documentation *)
185 | DeprecatedBy of string (* function is deprecated, use .. instead *)
186 | Optional of string (* function is part of an optional group *)
189 | FishOutputOctal (* for int return, print in octal *)
190 | FishOutputHexadecimal (* for int return, print in hex *)
192 (* You can supply zero or as many tests as you want per API call.
194 * Note that the test environment has 3 block devices, of size 500MB,
195 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
196 * a fourth ISO block device with some known files on it (/dev/sdd).
198 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
199 * Number of cylinders was 63 for IDE emulated disks with precisely
200 * the same size. How exactly this is calculated is a mystery.
202 * The ISO block device (/dev/sdd) comes from images/test.iso.
204 * To be able to run the tests in a reasonable amount of time,
205 * the virtual machine and block devices are reused between tests.
206 * So don't try testing kill_subprocess :-x
208 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
210 * Don't assume anything about the previous contents of the block
211 * devices. Use 'Init*' to create some initial scenarios.
213 * You can add a prerequisite clause to any individual test. This
214 * is a run-time check, which, if it fails, causes the test to be
215 * skipped. Useful if testing a command which might not work on
216 * all variations of libguestfs builds. A test that has prerequisite
217 * of 'Always' is run unconditionally.
219 * In addition, packagers can skip individual tests by setting the
220 * environment variables: eg:
221 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
222 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
224 type tests = (test_init * test_prereq * test) list
226 (* Run the command sequence and just expect nothing to fail. *)
229 (* Run the command sequence and expect the output of the final
230 * command to be the string.
232 | TestOutput of seq * string
234 (* Run the command sequence and expect the output of the final
235 * command to be the list of strings.
237 | TestOutputList of seq * string list
239 (* Run the command sequence and expect the output of the final
240 * command to be the list of block devices (could be either
241 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
242 * character of each string).
244 | TestOutputListOfDevices of seq * string list
246 (* Run the command sequence and expect the output of the final
247 * command to be the integer.
249 | TestOutputInt of seq * int
251 (* Run the command sequence and expect the output of the final
252 * command to be <op> <int>, eg. ">=", "1".
254 | TestOutputIntOp of seq * string * int
256 (* Run the command sequence and expect the output of the final
257 * command to be a true value (!= 0 or != NULL).
259 | TestOutputTrue of seq
261 (* Run the command sequence and expect the output of the final
262 * command to be a false value (== 0 or == NULL, but not an error).
264 | TestOutputFalse of seq
266 (* Run the command sequence and expect the output of the final
267 * command to be a list of the given length (but don't care about
270 | TestOutputLength of seq * int
272 (* Run the command sequence and expect the output of the final
273 * command to be a buffer (RBufferOut), ie. string + size.
275 | TestOutputBuffer of seq * string
277 (* Run the command sequence and expect the output of the final
278 * command to be a structure.
280 | TestOutputStruct of seq * test_field_compare list
282 (* Run the command sequence and expect the final command (only)
285 | TestLastFail of seq
287 and test_field_compare =
288 | CompareWithInt of string * int
289 | CompareWithIntOp of string * string * int
290 | CompareWithString of string * string
291 | CompareFieldsIntEq of string * string
292 | CompareFieldsStrEq of string * string
294 (* Test prerequisites. *)
296 (* Test always runs. *)
299 (* Test is currently disabled - eg. it fails, or it tests some
300 * unimplemented feature.
304 (* 'string' is some C code (a function body) that should return
305 * true or false. The test will run if the code returns true.
309 (* As for 'If' but the test runs _unless_ the code returns true. *)
312 (* Run the test only if 'string' is available in the daemon. *)
313 | IfAvailable of string
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";
391 let test_all_rets = [
392 (* except for RErr, which is tested thoroughly elsewhere *)
393 "test0rint", RInt "valout";
394 "test0rint64", RInt64 "valout";
395 "test0rbool", RBool "valout";
396 "test0rconststring", RConstString "valout";
397 "test0rconstoptstring", RConstOptString "valout";
398 "test0rstring", RString "valout";
399 "test0rstringlist", RStringList "valout";
400 "test0rstruct", RStruct ("valout", "lvm_pv");
401 "test0rstructlist", RStructList ("valout", "lvm_pv");
402 "test0rhashtable", RHashtable "valout";
405 let test_functions = [
406 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
408 "internal test function - do not use",
410 This is an internal test function which is used to test whether
411 the automatically generated bindings can handle every possible
412 parameter type correctly.
414 It echos the contents of each parameter to stdout.
416 You probably don't want to call this function.");
420 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
422 "internal test function - do not use",
424 This is an internal test function which is used to test whether
425 the automatically generated bindings can handle every possible
426 return type correctly.
428 It converts string C<val> to the return type.
430 You probably don't want to call this function.");
431 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
433 "internal test function - do not use",
435 This is an internal test function which is used to test whether
436 the automatically generated bindings can handle every possible
437 return type correctly.
439 This function always returns an error.
441 You probably don't want to call this function.")]
445 (* non_daemon_functions are any functions which don't get processed
446 * in the daemon, eg. functions for setting and getting local
447 * configuration values.
450 let non_daemon_functions = test_functions @ [
451 ("launch", (RErr, []), -1, [FishAlias "run"],
453 "launch the qemu subprocess",
455 Internally libguestfs is implemented by running a virtual machine
458 You should call this after configuring the handle
459 (eg. adding drives) but before performing any actions.");
461 ("wait_ready", (RErr, []), -1, [NotInFish],
463 "wait until the qemu subprocess launches (no op)",
465 This function is a no op.
467 In versions of the API E<lt> 1.0.71 you had to call this function
468 just after calling C<guestfs_launch> to wait for the launch
469 to complete. However this is no longer necessary because
470 C<guestfs_launch> now does the waiting.
472 If you see any calls to this function in code then you can just
473 remove them, unless you want to retain compatibility with older
474 versions of the API.");
476 ("kill_subprocess", (RErr, []), -1, [],
478 "kill the qemu subprocess",
480 This kills the qemu subprocess. You should never need to call this.");
482 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
484 "add an image to examine or modify",
486 This function adds a virtual machine disk image C<filename> to the
487 guest. The first time you call this function, the disk appears as IDE
488 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
491 You don't necessarily need to be root when using libguestfs. However
492 you obviously do need sufficient permissions to access the filename
493 for whatever operations you want to perform (ie. read access if you
494 just want to read the image or write access if you want to modify the
497 This is equivalent to the qemu parameter
498 C<-drive file=filename,cache=off,if=...>.
500 C<cache=off> is omitted in cases where it is not supported by
501 the underlying filesystem.
503 C<if=...> is set at compile time by the configuration option
504 C<./configure --with-drive-if=...>. In the rare case where you
505 might need to change this at run time, use C<guestfs_add_drive_with_if>
506 or C<guestfs_add_drive_ro_with_if>.
508 Note that this call checks for the existence of C<filename>. This
509 stops you from specifying other types of drive which are supported
510 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
511 the general C<guestfs_config> call instead.");
513 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
515 "add a CD-ROM disk image to examine",
517 This function adds a virtual CD-ROM disk image to the guest.
519 This is equivalent to the qemu parameter C<-cdrom filename>.
527 This call checks for the existence of C<filename>. This
528 stops you from specifying other types of drive which are supported
529 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
530 the general C<guestfs_config> call instead.
534 If you just want to add an ISO file (often you use this as an
535 efficient way to transfer large files into the guest), then you
536 should probably use C<guestfs_add_drive_ro> instead.
540 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
542 "add a drive in snapshot mode (read-only)",
544 This adds a drive in snapshot mode, making it effectively
547 Note that writes to the device are allowed, and will be seen for
548 the duration of the guestfs handle, but they are written
549 to a temporary file which is discarded as soon as the guestfs
550 handle is closed. We don't currently have any method to enable
551 changes to be committed, although qemu can support this.
553 This is equivalent to the qemu parameter
554 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
556 C<if=...> is set at compile time by the configuration option
557 C<./configure --with-drive-if=...>. In the rare case where you
558 might need to change this at run time, use C<guestfs_add_drive_with_if>
559 or C<guestfs_add_drive_ro_with_if>.
561 C<readonly=on> is only added where qemu supports this option.
563 Note that this call checks for the existence of C<filename>. This
564 stops you from specifying other types of drive which are supported
565 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
566 the general C<guestfs_config> call instead.");
568 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
570 "add qemu parameters",
572 This can be used to add arbitrary qemu command line parameters
573 of the form C<-param value>. Actually it's not quite arbitrary - we
574 prevent you from setting some parameters which would interfere with
575 parameters that we use.
577 The first character of C<param> string must be a C<-> (dash).
579 C<value> can be NULL.");
581 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
583 "set the qemu binary",
585 Set the qemu binary that we will use.
587 The default is chosen when the library was compiled by the
590 You can also override this by setting the C<LIBGUESTFS_QEMU>
591 environment variable.
593 Setting C<qemu> to C<NULL> restores the default qemu binary.
595 Note that you should call this function as early as possible
596 after creating the handle. This is because some pre-launch
597 operations depend on testing qemu features (by running C<qemu -help>).
598 If the qemu binary changes, we don't retest features, and
599 so you might see inconsistent results. Using the environment
600 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
601 the qemu binary at the same time as the handle is created.");
603 ("get_qemu", (RConstString "qemu", []), -1, [],
604 [InitNone, Always, TestRun (
606 "get the qemu binary",
608 Return the current qemu binary.
610 This is always non-NULL. If it wasn't set already, then this will
611 return the default qemu binary name.");
613 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
615 "set the search path",
617 Set the path that libguestfs searches for kernel and initrd.img.
619 The default is C<$libdir/guestfs> unless overridden by setting
620 C<LIBGUESTFS_PATH> environment variable.
622 Setting C<path> to C<NULL> restores the default path.");
624 ("get_path", (RConstString "path", []), -1, [],
625 [InitNone, Always, TestRun (
627 "get the search path",
629 Return the current search path.
631 This is always non-NULL. If it wasn't set already, then this will
632 return the default path.");
634 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
636 "add options to kernel command line",
638 This function is used to add additional options to the
639 guest kernel command line.
641 The default is C<NULL> unless overridden by setting
642 C<LIBGUESTFS_APPEND> environment variable.
644 Setting C<append> to C<NULL> means I<no> additional options
645 are passed (libguestfs always adds a few of its own).");
647 ("get_append", (RConstOptString "append", []), -1, [],
648 (* This cannot be tested with the current framework. The
649 * function can return NULL in normal operations, which the
650 * test framework interprets as an error.
653 "get the additional kernel options",
655 Return the additional kernel options which are added to the
656 guest kernel command line.
658 If C<NULL> then no options are added.");
660 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
664 If C<autosync> is true, this enables autosync. Libguestfs will make a
665 best effort attempt to run C<guestfs_umount_all> followed by
666 C<guestfs_sync> when the handle is closed
667 (also if the program exits without closing handles).
669 This is disabled by default (except in guestfish where it is
670 enabled by default).");
672 ("get_autosync", (RBool "autosync", []), -1, [],
673 [InitNone, Always, TestRun (
674 [["get_autosync"]])],
677 Get the autosync flag.");
679 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
683 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
685 Verbose messages are disabled unless the environment variable
686 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
688 ("get_verbose", (RBool "verbose", []), -1, [],
692 This returns the verbose messages flag.");
694 ("is_ready", (RBool "ready", []), -1, [],
695 [InitNone, Always, TestOutputTrue (
697 "is ready to accept commands",
699 This returns true iff this handle is ready to accept commands
700 (in the C<READY> state).
702 For more information on states, see L<guestfs(3)>.");
704 ("is_config", (RBool "config", []), -1, [],
705 [InitNone, Always, TestOutputFalse (
707 "is in configuration state",
709 This returns true iff this handle is being configured
710 (in the C<CONFIG> state).
712 For more information on states, see L<guestfs(3)>.");
714 ("is_launching", (RBool "launching", []), -1, [],
715 [InitNone, Always, TestOutputFalse (
716 [["is_launching"]])],
717 "is launching subprocess",
719 This returns true iff this handle is launching the subprocess
720 (in the C<LAUNCHING> state).
722 For more information on states, see L<guestfs(3)>.");
724 ("is_busy", (RBool "busy", []), -1, [],
725 [InitNone, Always, TestOutputFalse (
727 "is busy processing a command",
729 This returns true iff this handle is busy processing a command
730 (in the C<BUSY> state).
732 For more information on states, see L<guestfs(3)>.");
734 ("get_state", (RInt "state", []), -1, [],
736 "get the current state",
738 This returns the current state as an opaque integer. This is
739 only useful for printing debug and internal error messages.
741 For more information on states, see L<guestfs(3)>.");
743 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
744 [InitNone, Always, TestOutputInt (
745 [["set_memsize"; "500"];
746 ["get_memsize"]], 500)],
747 "set memory allocated to the qemu subprocess",
749 This sets the memory size in megabytes allocated to the
750 qemu subprocess. This only has any effect if called before
753 You can also change this by setting the environment
754 variable C<LIBGUESTFS_MEMSIZE> before the handle is
757 For more information on the architecture of libguestfs,
758 see L<guestfs(3)>.");
760 ("get_memsize", (RInt "memsize", []), -1, [],
761 [InitNone, Always, TestOutputIntOp (
762 [["get_memsize"]], ">=", 256)],
763 "get memory allocated to the qemu subprocess",
765 This gets the memory size in megabytes allocated to the
768 If C<guestfs_set_memsize> was not called
769 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
770 then this returns the compiled-in default value for memsize.
772 For more information on the architecture of libguestfs,
773 see L<guestfs(3)>.");
775 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
776 [InitNone, Always, TestOutputIntOp (
777 [["get_pid"]], ">=", 1)],
778 "get PID of qemu subprocess",
780 Return the process ID of the qemu subprocess. If there is no
781 qemu subprocess, then this will return an error.
783 This is an internal call used for debugging and testing.");
785 ("version", (RStruct ("version", "version"), []), -1, [],
786 [InitNone, Always, TestOutputStruct (
787 [["version"]], [CompareWithInt ("major", 1)])],
788 "get the library version number",
790 Return the libguestfs version number that the program is linked
793 Note that because of dynamic linking this is not necessarily
794 the version of libguestfs that you compiled against. You can
795 compile the program, and then at runtime dynamically link
796 against a completely different C<libguestfs.so> library.
798 This call was added in version C<1.0.58>. In previous
799 versions of libguestfs there was no way to get the version
800 number. From C code you can use dynamic linker functions
801 to find out if this symbol exists (if it doesn't, then
802 it's an earlier version).
804 The call returns a structure with four elements. The first
805 three (C<major>, C<minor> and C<release>) are numbers and
806 correspond to the usual version triplet. The fourth element
807 (C<extra>) is a string and is normally empty, but may be
808 used for distro-specific information.
810 To construct the original version string:
811 C<$major.$minor.$release$extra>
813 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
815 I<Note:> Don't use this call to test for availability
816 of features. In enterprise distributions we backport
817 features from later versions into earlier versions,
818 making this an unreliable way to test for features.
819 Use C<guestfs_available> instead.");
821 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
822 [InitNone, Always, TestOutputTrue (
823 [["set_selinux"; "true"];
825 "set SELinux enabled or disabled at appliance boot",
827 This sets the selinux flag that is passed to the appliance
828 at boot time. The default is C<selinux=0> (disabled).
830 Note that if SELinux is enabled, it is always in
831 Permissive mode (C<enforcing=0>).
833 For more information on the architecture of libguestfs,
834 see L<guestfs(3)>.");
836 ("get_selinux", (RBool "selinux", []), -1, [],
838 "get SELinux enabled flag",
840 This returns the current setting of the selinux flag which
841 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
843 For more information on the architecture of libguestfs,
844 see L<guestfs(3)>.");
846 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
847 [InitNone, Always, TestOutputFalse (
848 [["set_trace"; "false"];
850 "enable or disable command traces",
852 If the command trace flag is set to 1, then commands are
853 printed on stdout before they are executed in a format
854 which is very similar to the one used by guestfish. In
855 other words, you can run a program with this enabled, and
856 you will get out a script which you can feed to guestfish
857 to perform the same set of actions.
859 If you want to trace C API calls into libguestfs (and
860 other libraries) then possibly a better way is to use
861 the external ltrace(1) command.
863 Command traces are disabled unless the environment variable
864 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
866 ("get_trace", (RBool "trace", []), -1, [],
868 "get command trace enabled flag",
870 Return the command trace flag.");
872 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
873 [InitNone, Always, TestOutputFalse (
874 [["set_direct"; "false"];
876 "enable or disable direct appliance mode",
878 If the direct appliance mode flag is enabled, then stdin and
879 stdout are passed directly through to the appliance once it
882 One consequence of this is that log messages aren't caught
883 by the library and handled by C<guestfs_set_log_message_callback>,
884 but go straight to stdout.
886 You probably don't want to use this unless you know what you
889 The default is disabled.");
891 ("get_direct", (RBool "direct", []), -1, [],
893 "get direct appliance mode flag",
895 Return the direct appliance mode flag.");
897 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
898 [InitNone, Always, TestOutputTrue (
899 [["set_recovery_proc"; "true"];
900 ["get_recovery_proc"]])],
901 "enable or disable the recovery process",
903 If this is called with the parameter C<false> then
904 C<guestfs_launch> does not create a recovery process. The
905 purpose of the recovery process is to stop runaway qemu
906 processes in the case where the main program aborts abruptly.
908 This only has any effect if called before C<guestfs_launch>,
909 and the default is true.
911 About the only time when you would want to disable this is
912 if the main process will fork itself into the background
913 (\"daemonize\" itself). In this case the recovery process
914 thinks that the main program has disappeared and so kills
915 qemu, which is not very helpful.");
917 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
919 "get recovery process enabled flag",
921 Return the recovery process enabled flag.");
923 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
925 "add a drive specifying the QEMU block emulation to use",
927 This is the same as C<guestfs_add_drive> but it allows you
928 to specify the QEMU interface emulation to use at run time.");
930 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
932 "add a drive read-only specifying the QEMU block emulation to use",
934 This is the same as C<guestfs_add_drive_ro> but it allows you
935 to specify the QEMU interface emulation to use at run time.");
939 (* daemon_functions are any functions which cause some action
940 * to take place in the daemon.
943 let daemon_functions = [
944 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
945 [InitEmpty, Always, TestOutput (
946 [["part_disk"; "/dev/sda"; "mbr"];
947 ["mkfs"; "ext2"; "/dev/sda1"];
948 ["mount"; "/dev/sda1"; "/"];
949 ["write"; "/new"; "new file contents"];
950 ["cat"; "/new"]], "new file contents")],
951 "mount a guest disk at a position in the filesystem",
953 Mount a guest disk at a position in the filesystem. Block devices
954 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
955 the guest. If those block devices contain partitions, they will have
956 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
959 The rules are the same as for L<mount(2)>: A filesystem must
960 first be mounted on C</> before others can be mounted. Other
961 filesystems can only be mounted on directories which already
964 The mounted filesystem is writable, if we have sufficient permissions
965 on the underlying device.
968 When you use this call, the filesystem options C<sync> and C<noatime>
969 are set implicitly. This was originally done because we thought it
970 would improve reliability, but it turns out that I<-o sync> has a
971 very large negative performance impact and negligible effect on
972 reliability. Therefore we recommend that you avoid using
973 C<guestfs_mount> in any code that needs performance, and instead
974 use C<guestfs_mount_options> (use an empty string for the first
975 parameter if you don't want any options).");
977 ("sync", (RErr, []), 2, [],
978 [ InitEmpty, Always, TestRun [["sync"]]],
979 "sync disks, writes are flushed through to the disk image",
981 This syncs the disk, so that any writes are flushed through to the
982 underlying disk image.
984 You should always call this if you have modified a disk image, before
985 closing the handle.");
987 ("touch", (RErr, [Pathname "path"]), 3, [],
988 [InitBasicFS, Always, TestOutputTrue (
990 ["exists"; "/new"]])],
991 "update file timestamps or create a new file",
993 Touch acts like the L<touch(1)> command. It can be used to
994 update the timestamps on a file, or, if the file does not exist,
995 to create a new zero-length file.
997 This command only works on regular files, and will fail on other
998 file types such as directories, symbolic links, block special etc.");
1000 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
1001 [InitISOFS, Always, TestOutput (
1002 [["cat"; "/known-2"]], "abcdef\n")],
1003 "list the contents of a file",
1005 Return the contents of the file named C<path>.
1007 Note that this function cannot correctly handle binary files
1008 (specifically, files containing C<\\0> character which is treated
1009 as end of string). For those you need to use the C<guestfs_read_file>
1010 or C<guestfs_download> functions which have a more complex interface.");
1012 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1013 [], (* XXX Tricky to test because it depends on the exact format
1014 * of the 'ls -l' command, which changes between F10 and F11.
1016 "list the files in a directory (long format)",
1018 List the files in C<directory> (relative to the root directory,
1019 there is no cwd) in the format of 'ls -la'.
1021 This command is mostly useful for interactive sessions. It
1022 is I<not> intended that you try to parse the output string.");
1024 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1025 [InitBasicFS, Always, TestOutputList (
1027 ["touch"; "/newer"];
1028 ["touch"; "/newest"];
1029 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1030 "list the files in a directory",
1032 List the files in C<directory> (relative to the root directory,
1033 there is no cwd). The '.' and '..' entries are not returned, but
1034 hidden files are shown.
1036 This command is mostly useful for interactive sessions. Programs
1037 should probably use C<guestfs_readdir> instead.");
1039 ("list_devices", (RStringList "devices", []), 7, [],
1040 [InitEmpty, Always, TestOutputListOfDevices (
1041 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1042 "list the block devices",
1044 List all the block devices.
1046 The full block device names are returned, eg. C</dev/sda>");
1048 ("list_partitions", (RStringList "partitions", []), 8, [],
1049 [InitBasicFS, Always, TestOutputListOfDevices (
1050 [["list_partitions"]], ["/dev/sda1"]);
1051 InitEmpty, Always, TestOutputListOfDevices (
1052 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1053 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1054 "list the partitions",
1056 List all the partitions detected on all block devices.
1058 The full partition device names are returned, eg. C</dev/sda1>
1060 This does not return logical volumes. For that you will need to
1061 call C<guestfs_lvs>.");
1063 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1064 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1065 [["pvs"]], ["/dev/sda1"]);
1066 InitEmpty, Always, TestOutputListOfDevices (
1067 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1068 ["pvcreate"; "/dev/sda1"];
1069 ["pvcreate"; "/dev/sda2"];
1070 ["pvcreate"; "/dev/sda3"];
1071 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1072 "list the LVM physical volumes (PVs)",
1074 List all the physical volumes detected. This is the equivalent
1075 of the L<pvs(8)> command.
1077 This returns a list of just the device names that contain
1078 PVs (eg. C</dev/sda2>).
1080 See also C<guestfs_pvs_full>.");
1082 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1083 [InitBasicFSonLVM, Always, TestOutputList (
1085 InitEmpty, Always, TestOutputList (
1086 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1087 ["pvcreate"; "/dev/sda1"];
1088 ["pvcreate"; "/dev/sda2"];
1089 ["pvcreate"; "/dev/sda3"];
1090 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1091 ["vgcreate"; "VG2"; "/dev/sda3"];
1092 ["vgs"]], ["VG1"; "VG2"])],
1093 "list the LVM volume groups (VGs)",
1095 List all the volumes groups detected. This is the equivalent
1096 of the L<vgs(8)> command.
1098 This returns a list of just the volume group names that were
1099 detected (eg. C<VolGroup00>).
1101 See also C<guestfs_vgs_full>.");
1103 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1104 [InitBasicFSonLVM, Always, TestOutputList (
1105 [["lvs"]], ["/dev/VG/LV"]);
1106 InitEmpty, Always, TestOutputList (
1107 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1108 ["pvcreate"; "/dev/sda1"];
1109 ["pvcreate"; "/dev/sda2"];
1110 ["pvcreate"; "/dev/sda3"];
1111 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1112 ["vgcreate"; "VG2"; "/dev/sda3"];
1113 ["lvcreate"; "LV1"; "VG1"; "50"];
1114 ["lvcreate"; "LV2"; "VG1"; "50"];
1115 ["lvcreate"; "LV3"; "VG2"; "50"];
1116 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1117 "list the LVM logical volumes (LVs)",
1119 List all the logical volumes detected. This is the equivalent
1120 of the L<lvs(8)> command.
1122 This returns a list of the logical volume device names
1123 (eg. C</dev/VolGroup00/LogVol00>).
1125 See also C<guestfs_lvs_full>.");
1127 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1128 [], (* XXX how to test? *)
1129 "list the LVM physical volumes (PVs)",
1131 List all the physical volumes detected. This is the equivalent
1132 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1134 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1135 [], (* XXX how to test? *)
1136 "list the LVM volume groups (VGs)",
1138 List all the volumes groups detected. This is the equivalent
1139 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1141 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1142 [], (* XXX how to test? *)
1143 "list the LVM logical volumes (LVs)",
1145 List all the logical volumes detected. This is the equivalent
1146 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1148 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1149 [InitISOFS, Always, TestOutputList (
1150 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1151 InitISOFS, Always, TestOutputList (
1152 [["read_lines"; "/empty"]], [])],
1153 "read file as lines",
1155 Return the contents of the file named C<path>.
1157 The file contents are returned as a list of lines. Trailing
1158 C<LF> and C<CRLF> character sequences are I<not> returned.
1160 Note that this function cannot correctly handle binary files
1161 (specifically, files containing C<\\0> character which is treated
1162 as end of line). For those you need to use the C<guestfs_read_file>
1163 function which has a more complex interface.");
1165 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1166 [], (* XXX Augeas code needs tests. *)
1167 "create a new Augeas handle",
1169 Create a new Augeas handle for editing configuration files.
1170 If there was any previous Augeas handle associated with this
1171 guestfs session, then it is closed.
1173 You must call this before using any other C<guestfs_aug_*>
1176 C<root> is the filesystem root. C<root> must not be NULL,
1179 The flags are the same as the flags defined in
1180 E<lt>augeas.hE<gt>, the logical I<or> of the following
1185 =item C<AUG_SAVE_BACKUP> = 1
1187 Keep the original file with a C<.augsave> extension.
1189 =item C<AUG_SAVE_NEWFILE> = 2
1191 Save changes into a file with extension C<.augnew>, and
1192 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1194 =item C<AUG_TYPE_CHECK> = 4
1196 Typecheck lenses (can be expensive).
1198 =item C<AUG_NO_STDINC> = 8
1200 Do not use standard load path for modules.
1202 =item C<AUG_SAVE_NOOP> = 16
1204 Make save a no-op, just record what would have been changed.
1206 =item C<AUG_NO_LOAD> = 32
1208 Do not load the tree in C<guestfs_aug_init>.
1212 To close the handle, you can call C<guestfs_aug_close>.
1214 To find out more about Augeas, see L<http://augeas.net/>.");
1216 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1217 [], (* XXX Augeas code needs tests. *)
1218 "close the current Augeas handle",
1220 Close the current Augeas handle and free up any resources
1221 used by it. After calling this, you have to call
1222 C<guestfs_aug_init> again before you can use any other
1223 Augeas functions.");
1225 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1226 [], (* XXX Augeas code needs tests. *)
1227 "define an Augeas variable",
1229 Defines an Augeas variable C<name> whose value is the result
1230 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1233 On success this returns the number of nodes in C<expr>, or
1234 C<0> if C<expr> evaluates to something which is not a nodeset.");
1236 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1237 [], (* XXX Augeas code needs tests. *)
1238 "define an Augeas node",
1240 Defines a variable C<name> whose value is the result of
1243 If C<expr> evaluates to an empty nodeset, a node is created,
1244 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1245 C<name> will be the nodeset containing that single node.
1247 On success this returns a pair containing the
1248 number of nodes in the nodeset, and a boolean flag
1249 if a node was created.");
1251 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1252 [], (* XXX Augeas code needs tests. *)
1253 "look up the value of an Augeas path",
1255 Look up the value associated with C<path>. If C<path>
1256 matches exactly one node, the C<value> is returned.");
1258 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1259 [], (* XXX Augeas code needs tests. *)
1260 "set Augeas path to value",
1262 Set the value associated with C<path> to C<val>.
1264 In the Augeas API, it is possible to clear a node by setting
1265 the value to NULL. Due to an oversight in the libguestfs API
1266 you cannot do that with this call. Instead you must use the
1267 C<guestfs_aug_clear> call.");
1269 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1270 [], (* XXX Augeas code needs tests. *)
1271 "insert a sibling Augeas node",
1273 Create a new sibling C<label> for C<path>, inserting it into
1274 the tree before or after C<path> (depending on the boolean
1277 C<path> must match exactly one existing node in the tree, and
1278 C<label> must be a label, ie. not contain C</>, C<*> or end
1279 with a bracketed index C<[N]>.");
1281 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1282 [], (* XXX Augeas code needs tests. *)
1283 "remove an Augeas path",
1285 Remove C<path> and all of its children.
1287 On success this returns the number of entries which were removed.");
1289 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1290 [], (* XXX Augeas code needs tests. *)
1293 Move the node C<src> to C<dest>. C<src> must match exactly
1294 one node. C<dest> is overwritten if it exists.");
1296 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1297 [], (* XXX Augeas code needs tests. *)
1298 "return Augeas nodes which match augpath",
1300 Returns a list of paths which match the path expression C<path>.
1301 The returned paths are sufficiently qualified so that they match
1302 exactly one node in the current tree.");
1304 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1305 [], (* XXX Augeas code needs tests. *)
1306 "write all pending Augeas changes to disk",
1308 This writes all pending changes to disk.
1310 The flags which were passed to C<guestfs_aug_init> affect exactly
1311 how files are saved.");
1313 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1314 [], (* XXX Augeas code needs tests. *)
1315 "load files into the tree",
1317 Load files into the tree.
1319 See C<aug_load> in the Augeas documentation for the full gory
1322 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1323 [], (* XXX Augeas code needs tests. *)
1324 "list Augeas nodes under augpath",
1326 This is just a shortcut for listing C<guestfs_aug_match>
1327 C<path/*> and sorting the resulting nodes into alphabetical order.");
1329 ("rm", (RErr, [Pathname "path"]), 29, [],
1330 [InitBasicFS, Always, TestRun
1333 InitBasicFS, Always, TestLastFail
1335 InitBasicFS, Always, TestLastFail
1340 Remove the single file C<path>.");
1342 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1343 [InitBasicFS, Always, TestRun
1346 InitBasicFS, Always, TestLastFail
1347 [["rmdir"; "/new"]];
1348 InitBasicFS, Always, TestLastFail
1350 ["rmdir"; "/new"]]],
1351 "remove a directory",
1353 Remove the single directory C<path>.");
1355 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1356 [InitBasicFS, Always, TestOutputFalse
1358 ["mkdir"; "/new/foo"];
1359 ["touch"; "/new/foo/bar"];
1361 ["exists"; "/new"]]],
1362 "remove a file or directory recursively",
1364 Remove the file or directory C<path>, recursively removing the
1365 contents if its a directory. This is like the C<rm -rf> shell
1368 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1369 [InitBasicFS, Always, TestOutputTrue
1371 ["is_dir"; "/new"]];
1372 InitBasicFS, Always, TestLastFail
1373 [["mkdir"; "/new/foo/bar"]]],
1374 "create a directory",
1376 Create a directory named C<path>.");
1378 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1379 [InitBasicFS, Always, TestOutputTrue
1380 [["mkdir_p"; "/new/foo/bar"];
1381 ["is_dir"; "/new/foo/bar"]];
1382 InitBasicFS, Always, TestOutputTrue
1383 [["mkdir_p"; "/new/foo/bar"];
1384 ["is_dir"; "/new/foo"]];
1385 InitBasicFS, Always, TestOutputTrue
1386 [["mkdir_p"; "/new/foo/bar"];
1387 ["is_dir"; "/new"]];
1388 (* Regression tests for RHBZ#503133: *)
1389 InitBasicFS, Always, TestRun
1391 ["mkdir_p"; "/new"]];
1392 InitBasicFS, Always, TestLastFail
1394 ["mkdir_p"; "/new"]]],
1395 "create a directory and parents",
1397 Create a directory named C<path>, creating any parent directories
1398 as necessary. This is like the C<mkdir -p> shell command.");
1400 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1401 [], (* XXX Need stat command to test *)
1404 Change the mode (permissions) of C<path> to C<mode>. Only
1405 numeric modes are supported.
1407 I<Note>: When using this command from guestfish, C<mode>
1408 by default would be decimal, unless you prefix it with
1409 C<0> to get octal, ie. use C<0700> not C<700>.
1411 The mode actually set is affected by the umask.");
1413 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1414 [], (* XXX Need stat command to test *)
1415 "change file owner and group",
1417 Change the file owner to C<owner> and group to C<group>.
1419 Only numeric uid and gid are supported. If you want to use
1420 names, you will need to locate and parse the password file
1421 yourself (Augeas support makes this relatively easy).");
1423 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1424 [InitISOFS, Always, TestOutputTrue (
1425 [["exists"; "/empty"]]);
1426 InitISOFS, Always, TestOutputTrue (
1427 [["exists"; "/directory"]])],
1428 "test if file or directory exists",
1430 This returns C<true> if and only if there is a file, directory
1431 (or anything) with the given C<path> name.
1433 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1435 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1436 [InitISOFS, Always, TestOutputTrue (
1437 [["is_file"; "/known-1"]]);
1438 InitISOFS, Always, TestOutputFalse (
1439 [["is_file"; "/directory"]])],
1440 "test if file exists",
1442 This returns C<true> if and only if there is a file
1443 with the given C<path> name. Note that it returns false for
1444 other objects like directories.
1446 See also C<guestfs_stat>.");
1448 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1449 [InitISOFS, Always, TestOutputFalse (
1450 [["is_dir"; "/known-3"]]);
1451 InitISOFS, Always, TestOutputTrue (
1452 [["is_dir"; "/directory"]])],
1453 "test if file exists",
1455 This returns C<true> if and only if there is a directory
1456 with the given C<path> name. Note that it returns false for
1457 other objects like files.
1459 See also C<guestfs_stat>.");
1461 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1462 [InitEmpty, Always, TestOutputListOfDevices (
1463 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1464 ["pvcreate"; "/dev/sda1"];
1465 ["pvcreate"; "/dev/sda2"];
1466 ["pvcreate"; "/dev/sda3"];
1467 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1468 "create an LVM physical volume",
1470 This creates an LVM physical volume on the named C<device>,
1471 where C<device> should usually be a partition name such
1474 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1475 [InitEmpty, Always, TestOutputList (
1476 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1477 ["pvcreate"; "/dev/sda1"];
1478 ["pvcreate"; "/dev/sda2"];
1479 ["pvcreate"; "/dev/sda3"];
1480 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1481 ["vgcreate"; "VG2"; "/dev/sda3"];
1482 ["vgs"]], ["VG1"; "VG2"])],
1483 "create an LVM volume group",
1485 This creates an LVM volume group called C<volgroup>
1486 from the non-empty list of physical volumes C<physvols>.");
1488 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1489 [InitEmpty, Always, TestOutputList (
1490 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1491 ["pvcreate"; "/dev/sda1"];
1492 ["pvcreate"; "/dev/sda2"];
1493 ["pvcreate"; "/dev/sda3"];
1494 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1495 ["vgcreate"; "VG2"; "/dev/sda3"];
1496 ["lvcreate"; "LV1"; "VG1"; "50"];
1497 ["lvcreate"; "LV2"; "VG1"; "50"];
1498 ["lvcreate"; "LV3"; "VG2"; "50"];
1499 ["lvcreate"; "LV4"; "VG2"; "50"];
1500 ["lvcreate"; "LV5"; "VG2"; "50"];
1502 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1503 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1504 "create an LVM logical volume",
1506 This creates an LVM logical volume called C<logvol>
1507 on the volume group C<volgroup>, with C<size> megabytes.");
1509 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1510 [InitEmpty, Always, TestOutput (
1511 [["part_disk"; "/dev/sda"; "mbr"];
1512 ["mkfs"; "ext2"; "/dev/sda1"];
1513 ["mount_options"; ""; "/dev/sda1"; "/"];
1514 ["write"; "/new"; "new file contents"];
1515 ["cat"; "/new"]], "new file contents")],
1516 "make a filesystem",
1518 This creates a filesystem on C<device> (usually a partition
1519 or LVM logical volume). The filesystem type is C<fstype>, for
1522 ("sfdisk", (RErr, [Device "device";
1523 Int "cyls"; Int "heads"; Int "sectors";
1524 StringList "lines"]), 43, [DangerWillRobinson],
1526 "create partitions on a block device",
1528 This is a direct interface to the L<sfdisk(8)> program for creating
1529 partitions on block devices.
1531 C<device> should be a block device, for example C</dev/sda>.
1533 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1534 and sectors on the device, which are passed directly to sfdisk as
1535 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1536 of these, then the corresponding parameter is omitted. Usually for
1537 'large' disks, you can just pass C<0> for these, but for small
1538 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1539 out the right geometry and you will need to tell it.
1541 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1542 information refer to the L<sfdisk(8)> manpage.
1544 To create a single partition occupying the whole disk, you would
1545 pass C<lines> as a single element list, when the single element being
1546 the string C<,> (comma).
1548 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1549 C<guestfs_part_init>");
1551 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1552 (* Regression test for RHBZ#597135. *)
1553 [InitBasicFS, Always, TestLastFail
1554 [["write_file"; "/new"; "abc"; "10000"]]],
1557 This call creates a file called C<path>. The contents of the
1558 file is the string C<content> (which can contain any 8 bit data),
1559 with length C<size>.
1561 As a special case, if C<size> is C<0>
1562 then the length is calculated using C<strlen> (so in this case
1563 the content cannot contain embedded ASCII NULs).
1565 I<NB.> Owing to a bug, writing content containing ASCII NUL
1566 characters does I<not> work, even if the length is specified.");
1568 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1569 [InitEmpty, Always, TestOutputListOfDevices (
1570 [["part_disk"; "/dev/sda"; "mbr"];
1571 ["mkfs"; "ext2"; "/dev/sda1"];
1572 ["mount_options"; ""; "/dev/sda1"; "/"];
1573 ["mounts"]], ["/dev/sda1"]);
1574 InitEmpty, Always, TestOutputList (
1575 [["part_disk"; "/dev/sda"; "mbr"];
1576 ["mkfs"; "ext2"; "/dev/sda1"];
1577 ["mount_options"; ""; "/dev/sda1"; "/"];
1580 "unmount a filesystem",
1582 This unmounts the given filesystem. The filesystem may be
1583 specified either by its mountpoint (path) or the device which
1584 contains the filesystem.");
1586 ("mounts", (RStringList "devices", []), 46, [],
1587 [InitBasicFS, Always, TestOutputListOfDevices (
1588 [["mounts"]], ["/dev/sda1"])],
1589 "show mounted filesystems",
1591 This returns the list of currently mounted filesystems. It returns
1592 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1594 Some internal mounts are not shown.
1596 See also: C<guestfs_mountpoints>");
1598 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1599 [InitBasicFS, Always, TestOutputList (
1602 (* check that umount_all can unmount nested mounts correctly: *)
1603 InitEmpty, Always, TestOutputList (
1604 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1605 ["mkfs"; "ext2"; "/dev/sda1"];
1606 ["mkfs"; "ext2"; "/dev/sda2"];
1607 ["mkfs"; "ext2"; "/dev/sda3"];
1608 ["mount_options"; ""; "/dev/sda1"; "/"];
1610 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1611 ["mkdir"; "/mp1/mp2"];
1612 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1613 ["mkdir"; "/mp1/mp2/mp3"];
1616 "unmount all filesystems",
1618 This unmounts all mounted filesystems.
1620 Some internal mounts are not unmounted by this call.");
1622 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1624 "remove all LVM LVs, VGs and PVs",
1626 This command removes all LVM logical volumes, volume groups
1627 and physical volumes.");
1629 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1630 [InitISOFS, Always, TestOutput (
1631 [["file"; "/empty"]], "empty");
1632 InitISOFS, Always, TestOutput (
1633 [["file"; "/known-1"]], "ASCII text");
1634 InitISOFS, Always, TestLastFail (
1635 [["file"; "/notexists"]]);
1636 InitISOFS, Always, TestOutput (
1637 [["file"; "/abssymlink"]], "symbolic link");
1638 InitISOFS, Always, TestOutput (
1639 [["file"; "/directory"]], "directory")],
1640 "determine file type",
1642 This call uses the standard L<file(1)> command to determine
1643 the type or contents of the file.
1645 This call will also transparently look inside various types
1648 The exact command which runs is C<file -zb path>. Note in
1649 particular that the filename is not prepended to the output
1652 This command can also be used on C</dev/> devices
1653 (and partitions, LV names). You can for example use this
1654 to determine if a device contains a filesystem, although
1655 it's usually better to use C<guestfs_vfs_type>.
1657 If the C<path> does not begin with C</dev/> then
1658 this command only works for the content of regular files.
1659 For other file types (directory, symbolic link etc) it
1660 will just return the string C<directory> etc.");
1662 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1663 [InitBasicFS, Always, TestOutput (
1664 [["upload"; "test-command"; "/test-command"];
1665 ["chmod"; "0o755"; "/test-command"];
1666 ["command"; "/test-command 1"]], "Result1");
1667 InitBasicFS, Always, TestOutput (
1668 [["upload"; "test-command"; "/test-command"];
1669 ["chmod"; "0o755"; "/test-command"];
1670 ["command"; "/test-command 2"]], "Result2\n");
1671 InitBasicFS, Always, TestOutput (
1672 [["upload"; "test-command"; "/test-command"];
1673 ["chmod"; "0o755"; "/test-command"];
1674 ["command"; "/test-command 3"]], "\nResult3");
1675 InitBasicFS, Always, TestOutput (
1676 [["upload"; "test-command"; "/test-command"];
1677 ["chmod"; "0o755"; "/test-command"];
1678 ["command"; "/test-command 4"]], "\nResult4\n");
1679 InitBasicFS, Always, TestOutput (
1680 [["upload"; "test-command"; "/test-command"];
1681 ["chmod"; "0o755"; "/test-command"];
1682 ["command"; "/test-command 5"]], "\nResult5\n\n");
1683 InitBasicFS, Always, TestOutput (
1684 [["upload"; "test-command"; "/test-command"];
1685 ["chmod"; "0o755"; "/test-command"];
1686 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1687 InitBasicFS, Always, TestOutput (
1688 [["upload"; "test-command"; "/test-command"];
1689 ["chmod"; "0o755"; "/test-command"];
1690 ["command"; "/test-command 7"]], "");
1691 InitBasicFS, Always, TestOutput (
1692 [["upload"; "test-command"; "/test-command"];
1693 ["chmod"; "0o755"; "/test-command"];
1694 ["command"; "/test-command 8"]], "\n");
1695 InitBasicFS, Always, TestOutput (
1696 [["upload"; "test-command"; "/test-command"];
1697 ["chmod"; "0o755"; "/test-command"];
1698 ["command"; "/test-command 9"]], "\n\n");
1699 InitBasicFS, Always, TestOutput (
1700 [["upload"; "test-command"; "/test-command"];
1701 ["chmod"; "0o755"; "/test-command"];
1702 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1703 InitBasicFS, Always, TestOutput (
1704 [["upload"; "test-command"; "/test-command"];
1705 ["chmod"; "0o755"; "/test-command"];
1706 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1707 InitBasicFS, Always, TestLastFail (
1708 [["upload"; "test-command"; "/test-command"];
1709 ["chmod"; "0o755"; "/test-command"];
1710 ["command"; "/test-command"]])],
1711 "run a command from the guest filesystem",
1713 This call runs a command from the guest filesystem. The
1714 filesystem must be mounted, and must contain a compatible
1715 operating system (ie. something Linux, with the same
1716 or compatible processor architecture).
1718 The single parameter is an argv-style list of arguments.
1719 The first element is the name of the program to run.
1720 Subsequent elements are parameters. The list must be
1721 non-empty (ie. must contain a program name). Note that
1722 the command runs directly, and is I<not> invoked via
1723 the shell (see C<guestfs_sh>).
1725 The return value is anything printed to I<stdout> by
1728 If the command returns a non-zero exit status, then
1729 this function returns an error message. The error message
1730 string is the content of I<stderr> from the command.
1732 The C<$PATH> environment variable will contain at least
1733 C</usr/bin> and C</bin>. If you require a program from
1734 another location, you should provide the full path in the
1737 Shared libraries and data files required by the program
1738 must be available on filesystems which are mounted in the
1739 correct places. It is the caller's responsibility to ensure
1740 all filesystems that are needed are mounted at the right
1743 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1744 [InitBasicFS, Always, TestOutputList (
1745 [["upload"; "test-command"; "/test-command"];
1746 ["chmod"; "0o755"; "/test-command"];
1747 ["command_lines"; "/test-command 1"]], ["Result1"]);
1748 InitBasicFS, Always, TestOutputList (
1749 [["upload"; "test-command"; "/test-command"];
1750 ["chmod"; "0o755"; "/test-command"];
1751 ["command_lines"; "/test-command 2"]], ["Result2"]);
1752 InitBasicFS, Always, TestOutputList (
1753 [["upload"; "test-command"; "/test-command"];
1754 ["chmod"; "0o755"; "/test-command"];
1755 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1756 InitBasicFS, Always, TestOutputList (
1757 [["upload"; "test-command"; "/test-command"];
1758 ["chmod"; "0o755"; "/test-command"];
1759 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1760 InitBasicFS, Always, TestOutputList (
1761 [["upload"; "test-command"; "/test-command"];
1762 ["chmod"; "0o755"; "/test-command"];
1763 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1764 InitBasicFS, Always, TestOutputList (
1765 [["upload"; "test-command"; "/test-command"];
1766 ["chmod"; "0o755"; "/test-command"];
1767 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1768 InitBasicFS, Always, TestOutputList (
1769 [["upload"; "test-command"; "/test-command"];
1770 ["chmod"; "0o755"; "/test-command"];
1771 ["command_lines"; "/test-command 7"]], []);
1772 InitBasicFS, Always, TestOutputList (
1773 [["upload"; "test-command"; "/test-command"];
1774 ["chmod"; "0o755"; "/test-command"];
1775 ["command_lines"; "/test-command 8"]], [""]);
1776 InitBasicFS, Always, TestOutputList (
1777 [["upload"; "test-command"; "/test-command"];
1778 ["chmod"; "0o755"; "/test-command"];
1779 ["command_lines"; "/test-command 9"]], ["";""]);
1780 InitBasicFS, Always, TestOutputList (
1781 [["upload"; "test-command"; "/test-command"];
1782 ["chmod"; "0o755"; "/test-command"];
1783 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1784 InitBasicFS, Always, TestOutputList (
1785 [["upload"; "test-command"; "/test-command"];
1786 ["chmod"; "0o755"; "/test-command"];
1787 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1788 "run a command, returning lines",
1790 This is the same as C<guestfs_command>, but splits the
1791 result into a list of lines.
1793 See also: C<guestfs_sh_lines>");
1795 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1796 [InitISOFS, Always, TestOutputStruct (
1797 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1798 "get file information",
1800 Returns file information for the given C<path>.
1802 This is the same as the C<stat(2)> system call.");
1804 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1805 [InitISOFS, Always, TestOutputStruct (
1806 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1807 "get file information for a symbolic link",
1809 Returns file information for the given C<path>.
1811 This is the same as C<guestfs_stat> except that if C<path>
1812 is a symbolic link, then the link is stat-ed, not the file it
1815 This is the same as the C<lstat(2)> system call.");
1817 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1818 [InitISOFS, Always, TestOutputStruct (
1819 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1820 "get file system statistics",
1822 Returns file system statistics for any mounted file system.
1823 C<path> should be a file or directory in the mounted file system
1824 (typically it is the mount point itself, but it doesn't need to be).
1826 This is the same as the C<statvfs(2)> system call.");
1828 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1830 "get ext2/ext3/ext4 superblock details",
1832 This returns the contents of the ext2, ext3 or ext4 filesystem
1833 superblock on C<device>.
1835 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1836 manpage for more details. The list of fields returned isn't
1837 clearly defined, and depends on both the version of C<tune2fs>
1838 that libguestfs was built against, and the filesystem itself.");
1840 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1841 [InitEmpty, Always, TestOutputTrue (
1842 [["blockdev_setro"; "/dev/sda"];
1843 ["blockdev_getro"; "/dev/sda"]])],
1844 "set block device to read-only",
1846 Sets the block device named C<device> to read-only.
1848 This uses the L<blockdev(8)> command.");
1850 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1851 [InitEmpty, Always, TestOutputFalse (
1852 [["blockdev_setrw"; "/dev/sda"];
1853 ["blockdev_getro"; "/dev/sda"]])],
1854 "set block device to read-write",
1856 Sets the block device named C<device> to read-write.
1858 This uses the L<blockdev(8)> command.");
1860 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1861 [InitEmpty, Always, TestOutputTrue (
1862 [["blockdev_setro"; "/dev/sda"];
1863 ["blockdev_getro"; "/dev/sda"]])],
1864 "is block device set to read-only",
1866 Returns a boolean indicating if the block device is read-only
1867 (true if read-only, false if not).
1869 This uses the L<blockdev(8)> command.");
1871 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1872 [InitEmpty, Always, TestOutputInt (
1873 [["blockdev_getss"; "/dev/sda"]], 512)],
1874 "get sectorsize of block device",
1876 This returns the size of sectors on a block device.
1877 Usually 512, but can be larger for modern devices.
1879 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1882 This uses the L<blockdev(8)> command.");
1884 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1885 [InitEmpty, Always, TestOutputInt (
1886 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1887 "get blocksize of block device",
1889 This returns the block size of a device.
1891 (Note this is different from both I<size in blocks> and
1892 I<filesystem block size>).
1894 This uses the L<blockdev(8)> command.");
1896 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1898 "set blocksize of block device",
1900 This sets the block size of a device.
1902 (Note this is different from both I<size in blocks> and
1903 I<filesystem block size>).
1905 This uses the L<blockdev(8)> command.");
1907 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1908 [InitEmpty, Always, TestOutputInt (
1909 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1910 "get total size of device in 512-byte sectors",
1912 This returns the size of the device in units of 512-byte sectors
1913 (even if the sectorsize isn't 512 bytes ... weird).
1915 See also C<guestfs_blockdev_getss> for the real sector size of
1916 the device, and C<guestfs_blockdev_getsize64> for the more
1917 useful I<size in bytes>.
1919 This uses the L<blockdev(8)> command.");
1921 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1922 [InitEmpty, Always, TestOutputInt (
1923 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1924 "get total size of device in bytes",
1926 This returns the size of the device in bytes.
1928 See also C<guestfs_blockdev_getsz>.
1930 This uses the L<blockdev(8)> command.");
1932 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1933 [InitEmpty, Always, TestRun
1934 [["blockdev_flushbufs"; "/dev/sda"]]],
1935 "flush device buffers",
1937 This tells the kernel to flush internal buffers associated
1940 This uses the L<blockdev(8)> command.");
1942 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1943 [InitEmpty, Always, TestRun
1944 [["blockdev_rereadpt"; "/dev/sda"]]],
1945 "reread partition table",
1947 Reread the partition table on C<device>.
1949 This uses the L<blockdev(8)> command.");
1951 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1952 [InitBasicFS, Always, TestOutput (
1953 (* Pick a file from cwd which isn't likely to change. *)
1954 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1955 ["checksum"; "md5"; "/COPYING.LIB"]],
1956 Digest.to_hex (Digest.file "COPYING.LIB"))],
1957 "upload a file from the local machine",
1959 Upload local file C<filename> to C<remotefilename> on the
1962 C<filename> can also be a named pipe.
1964 See also C<guestfs_download>.");
1966 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1967 [InitBasicFS, Always, TestOutput (
1968 (* Pick a file from cwd which isn't likely to change. *)
1969 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1970 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1971 ["upload"; "testdownload.tmp"; "/upload"];
1972 ["checksum"; "md5"; "/upload"]],
1973 Digest.to_hex (Digest.file "COPYING.LIB"))],
1974 "download a file to the local machine",
1976 Download file C<remotefilename> and save it as C<filename>
1977 on the local machine.
1979 C<filename> can also be a named pipe.
1981 See also C<guestfs_upload>, C<guestfs_cat>.");
1983 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1984 [InitISOFS, Always, TestOutput (
1985 [["checksum"; "crc"; "/known-3"]], "2891671662");
1986 InitISOFS, Always, TestLastFail (
1987 [["checksum"; "crc"; "/notexists"]]);
1988 InitISOFS, Always, TestOutput (
1989 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1990 InitISOFS, Always, TestOutput (
1991 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1992 InitISOFS, Always, TestOutput (
1993 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1994 InitISOFS, Always, TestOutput (
1995 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1996 InitISOFS, Always, TestOutput (
1997 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1998 InitISOFS, Always, TestOutput (
1999 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2000 (* Test for RHBZ#579608, absolute symbolic links. *)
2001 InitISOFS, Always, TestOutput (
2002 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2003 "compute MD5, SHAx or CRC checksum of file",
2005 This call computes the MD5, SHAx or CRC checksum of the
2008 The type of checksum to compute is given by the C<csumtype>
2009 parameter which must have one of the following values:
2015 Compute the cyclic redundancy check (CRC) specified by POSIX
2016 for the C<cksum> command.
2020 Compute the MD5 hash (using the C<md5sum> program).
2024 Compute the SHA1 hash (using the C<sha1sum> program).
2028 Compute the SHA224 hash (using the C<sha224sum> program).
2032 Compute the SHA256 hash (using the C<sha256sum> program).
2036 Compute the SHA384 hash (using the C<sha384sum> program).
2040 Compute the SHA512 hash (using the C<sha512sum> program).
2044 The checksum is returned as a printable string.
2046 To get the checksum for a device, use C<guestfs_checksum_device>.
2048 To get the checksums for many files, use C<guestfs_checksums_out>.");
2050 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2051 [InitBasicFS, Always, TestOutput (
2052 [["tar_in"; "../images/helloworld.tar"; "/"];
2053 ["cat"; "/hello"]], "hello\n")],
2054 "unpack tarfile to directory",
2056 This command uploads and unpacks local file C<tarfile> (an
2057 I<uncompressed> tar file) into C<directory>.
2059 To upload a compressed tarball, use C<guestfs_tgz_in>
2060 or C<guestfs_txz_in>.");
2062 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2064 "pack directory into tarfile",
2066 This command packs the contents of C<directory> and downloads
2067 it to local file C<tarfile>.
2069 To download a compressed tarball, use C<guestfs_tgz_out>
2070 or C<guestfs_txz_out>.");
2072 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2073 [InitBasicFS, Always, TestOutput (
2074 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2075 ["cat"; "/hello"]], "hello\n")],
2076 "unpack compressed tarball to directory",
2078 This command uploads and unpacks local file C<tarball> (a
2079 I<gzip compressed> tar file) into C<directory>.
2081 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2083 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2085 "pack directory into compressed tarball",
2087 This command packs the contents of C<directory> and downloads
2088 it to local file C<tarball>.
2090 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2092 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2093 [InitBasicFS, Always, TestLastFail (
2095 ["mount_ro"; "/dev/sda1"; "/"];
2096 ["touch"; "/new"]]);
2097 InitBasicFS, Always, TestOutput (
2098 [["write"; "/new"; "data"];
2100 ["mount_ro"; "/dev/sda1"; "/"];
2101 ["cat"; "/new"]], "data")],
2102 "mount a guest disk, read-only",
2104 This is the same as the C<guestfs_mount> command, but it
2105 mounts the filesystem with the read-only (I<-o ro>) flag.");
2107 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2109 "mount a guest disk with mount options",
2111 This is the same as the C<guestfs_mount> command, but it
2112 allows you to set the mount options as for the
2113 L<mount(8)> I<-o> flag.
2115 If the C<options> parameter is an empty string, then
2116 no options are passed (all options default to whatever
2117 the filesystem uses).");
2119 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2121 "mount a guest disk with mount options and vfstype",
2123 This is the same as the C<guestfs_mount> command, but it
2124 allows you to set both the mount options and the vfstype
2125 as for the L<mount(8)> I<-o> and I<-t> flags.");
2127 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2129 "debugging and internals",
2131 The C<guestfs_debug> command exposes some internals of
2132 C<guestfsd> (the guestfs daemon) that runs inside the
2135 There is no comprehensive help for this command. You have
2136 to look at the file C<daemon/debug.c> in the libguestfs source
2137 to find out what you can do.");
2139 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2140 [InitEmpty, Always, TestOutputList (
2141 [["part_disk"; "/dev/sda"; "mbr"];
2142 ["pvcreate"; "/dev/sda1"];
2143 ["vgcreate"; "VG"; "/dev/sda1"];
2144 ["lvcreate"; "LV1"; "VG"; "50"];
2145 ["lvcreate"; "LV2"; "VG"; "50"];
2146 ["lvremove"; "/dev/VG/LV1"];
2147 ["lvs"]], ["/dev/VG/LV2"]);
2148 InitEmpty, Always, TestOutputList (
2149 [["part_disk"; "/dev/sda"; "mbr"];
2150 ["pvcreate"; "/dev/sda1"];
2151 ["vgcreate"; "VG"; "/dev/sda1"];
2152 ["lvcreate"; "LV1"; "VG"; "50"];
2153 ["lvcreate"; "LV2"; "VG"; "50"];
2154 ["lvremove"; "/dev/VG"];
2156 InitEmpty, Always, TestOutputList (
2157 [["part_disk"; "/dev/sda"; "mbr"];
2158 ["pvcreate"; "/dev/sda1"];
2159 ["vgcreate"; "VG"; "/dev/sda1"];
2160 ["lvcreate"; "LV1"; "VG"; "50"];
2161 ["lvcreate"; "LV2"; "VG"; "50"];
2162 ["lvremove"; "/dev/VG"];
2164 "remove an LVM logical volume",
2166 Remove an LVM logical volume C<device>, where C<device> is
2167 the path to the LV, such as C</dev/VG/LV>.
2169 You can also remove all LVs in a volume group by specifying
2170 the VG name, C</dev/VG>.");
2172 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2173 [InitEmpty, Always, TestOutputList (
2174 [["part_disk"; "/dev/sda"; "mbr"];
2175 ["pvcreate"; "/dev/sda1"];
2176 ["vgcreate"; "VG"; "/dev/sda1"];
2177 ["lvcreate"; "LV1"; "VG"; "50"];
2178 ["lvcreate"; "LV2"; "VG"; "50"];
2181 InitEmpty, Always, TestOutputList (
2182 [["part_disk"; "/dev/sda"; "mbr"];
2183 ["pvcreate"; "/dev/sda1"];
2184 ["vgcreate"; "VG"; "/dev/sda1"];
2185 ["lvcreate"; "LV1"; "VG"; "50"];
2186 ["lvcreate"; "LV2"; "VG"; "50"];
2189 "remove an LVM volume group",
2191 Remove an LVM volume group C<vgname>, (for example C<VG>).
2193 This also forcibly removes all logical volumes in the volume
2196 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2197 [InitEmpty, Always, TestOutputListOfDevices (
2198 [["part_disk"; "/dev/sda"; "mbr"];
2199 ["pvcreate"; "/dev/sda1"];
2200 ["vgcreate"; "VG"; "/dev/sda1"];
2201 ["lvcreate"; "LV1"; "VG"; "50"];
2202 ["lvcreate"; "LV2"; "VG"; "50"];
2204 ["pvremove"; "/dev/sda1"];
2206 InitEmpty, Always, TestOutputListOfDevices (
2207 [["part_disk"; "/dev/sda"; "mbr"];
2208 ["pvcreate"; "/dev/sda1"];
2209 ["vgcreate"; "VG"; "/dev/sda1"];
2210 ["lvcreate"; "LV1"; "VG"; "50"];
2211 ["lvcreate"; "LV2"; "VG"; "50"];
2213 ["pvremove"; "/dev/sda1"];
2215 InitEmpty, Always, TestOutputListOfDevices (
2216 [["part_disk"; "/dev/sda"; "mbr"];
2217 ["pvcreate"; "/dev/sda1"];
2218 ["vgcreate"; "VG"; "/dev/sda1"];
2219 ["lvcreate"; "LV1"; "VG"; "50"];
2220 ["lvcreate"; "LV2"; "VG"; "50"];
2222 ["pvremove"; "/dev/sda1"];
2224 "remove an LVM physical volume",
2226 This wipes a physical volume C<device> so that LVM will no longer
2229 The implementation uses the C<pvremove> command which refuses to
2230 wipe physical volumes that contain any volume groups, so you have
2231 to remove those first.");
2233 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2234 [InitBasicFS, Always, TestOutput (
2235 [["set_e2label"; "/dev/sda1"; "testlabel"];
2236 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2237 "set the ext2/3/4 filesystem label",
2239 This sets the ext2/3/4 filesystem label of the filesystem on
2240 C<device> to C<label>. Filesystem labels are limited to
2243 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2244 to return the existing label on a filesystem.");
2246 ("get_e2label", (RString "label", [Device "device"]), 81, [DeprecatedBy "vfs_label"],
2248 "get the ext2/3/4 filesystem label",
2250 This returns the ext2/3/4 filesystem label of the filesystem on
2253 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2254 (let uuid = uuidgen () in
2255 [InitBasicFS, Always, TestOutput (
2256 [["set_e2uuid"; "/dev/sda1"; uuid];
2257 ["get_e2uuid"; "/dev/sda1"]], uuid);
2258 InitBasicFS, Always, TestOutput (
2259 [["set_e2uuid"; "/dev/sda1"; "clear"];
2260 ["get_e2uuid"; "/dev/sda1"]], "");
2261 (* We can't predict what UUIDs will be, so just check the commands run. *)
2262 InitBasicFS, Always, TestRun (
2263 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2264 InitBasicFS, Always, TestRun (
2265 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2266 "set the ext2/3/4 filesystem UUID",
2268 This sets the ext2/3/4 filesystem UUID of the filesystem on
2269 C<device> to C<uuid>. The format of the UUID and alternatives
2270 such as C<clear>, C<random> and C<time> are described in the
2271 L<tune2fs(8)> manpage.
2273 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2274 to return the existing UUID of a filesystem.");
2276 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [DeprecatedBy "vfs_uuid"],
2277 (* Regression test for RHBZ#597112. *)
2278 (let uuid = uuidgen () in
2279 [InitBasicFS, Always, TestOutput (
2280 [["mke2journal"; "1024"; "/dev/sdb"];
2281 ["set_e2uuid"; "/dev/sdb"; uuid];
2282 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2283 "get the ext2/3/4 filesystem UUID",
2285 This returns the ext2/3/4 filesystem UUID of the filesystem on
2288 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2289 [InitBasicFS, Always, TestOutputInt (
2290 [["umount"; "/dev/sda1"];
2291 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2292 InitBasicFS, Always, TestOutputInt (
2293 [["umount"; "/dev/sda1"];
2294 ["zero"; "/dev/sda1"];
2295 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2296 "run the filesystem checker",
2298 This runs the filesystem checker (fsck) on C<device> which
2299 should have filesystem type C<fstype>.
2301 The returned integer is the status. See L<fsck(8)> for the
2302 list of status codes from C<fsck>.
2310 Multiple status codes can be summed together.
2314 A non-zero return code can mean \"success\", for example if
2315 errors have been corrected on the filesystem.
2319 Checking or repairing NTFS volumes is not supported
2324 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2326 ("zero", (RErr, [Device "device"]), 85, [],
2327 [InitBasicFS, Always, TestOutput (
2328 [["umount"; "/dev/sda1"];
2329 ["zero"; "/dev/sda1"];
2330 ["file"; "/dev/sda1"]], "data")],
2331 "write zeroes to the device",
2333 This command writes zeroes over the first few blocks of C<device>.
2335 How many blocks are zeroed isn't specified (but it's I<not> enough
2336 to securely wipe the device). It should be sufficient to remove
2337 any partition tables, filesystem superblocks and so on.
2339 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2341 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2343 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2344 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2346 [InitBasicFS, Always, TestOutputTrue (
2347 [["mkdir_p"; "/boot/grub"];
2348 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2349 ["grub_install"; "/"; "/dev/vda"];
2350 ["is_dir"; "/boot"]])],
2353 This command installs GRUB (the Grand Unified Bootloader) on
2354 C<device>, with the root directory being C<root>.
2356 Note: If grub-install reports the error
2357 \"No suitable drive was found in the generated device map.\"
2358 it may be that you need to create a C</boot/grub/device.map>
2359 file first that contains the mapping between grub device names
2360 and Linux device names. It is usually sufficient to create
2365 replacing C</dev/vda> with the name of the installation device.");
2367 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2368 [InitBasicFS, Always, TestOutput (
2369 [["write"; "/old"; "file content"];
2370 ["cp"; "/old"; "/new"];
2371 ["cat"; "/new"]], "file content");
2372 InitBasicFS, Always, TestOutputTrue (
2373 [["write"; "/old"; "file content"];
2374 ["cp"; "/old"; "/new"];
2375 ["is_file"; "/old"]]);
2376 InitBasicFS, Always, TestOutput (
2377 [["write"; "/old"; "file content"];
2379 ["cp"; "/old"; "/dir/new"];
2380 ["cat"; "/dir/new"]], "file content")],
2383 This copies a file from C<src> to C<dest> where C<dest> is
2384 either a destination filename or destination directory.");
2386 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2387 [InitBasicFS, Always, TestOutput (
2388 [["mkdir"; "/olddir"];
2389 ["mkdir"; "/newdir"];
2390 ["write"; "/olddir/file"; "file content"];
2391 ["cp_a"; "/olddir"; "/newdir"];
2392 ["cat"; "/newdir/olddir/file"]], "file content")],
2393 "copy a file or directory recursively",
2395 This copies a file or directory from C<src> to C<dest>
2396 recursively using the C<cp -a> command.");
2398 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2399 [InitBasicFS, Always, TestOutput (
2400 [["write"; "/old"; "file content"];
2401 ["mv"; "/old"; "/new"];
2402 ["cat"; "/new"]], "file content");
2403 InitBasicFS, Always, TestOutputFalse (
2404 [["write"; "/old"; "file content"];
2405 ["mv"; "/old"; "/new"];
2406 ["is_file"; "/old"]])],
2409 This moves a file from C<src> to C<dest> where C<dest> is
2410 either a destination filename or destination directory.");
2412 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2413 [InitEmpty, Always, TestRun (
2414 [["drop_caches"; "3"]])],
2415 "drop kernel page cache, dentries and inodes",
2417 This instructs the guest kernel to drop its page cache,
2418 and/or dentries and inode caches. The parameter C<whattodrop>
2419 tells the kernel what precisely to drop, see
2420 L<http://linux-mm.org/Drop_Caches>
2422 Setting C<whattodrop> to 3 should drop everything.
2424 This automatically calls L<sync(2)> before the operation,
2425 so that the maximum guest memory is freed.");
2427 ("dmesg", (RString "kmsgs", []), 91, [],
2428 [InitEmpty, Always, TestRun (
2430 "return kernel messages",
2432 This returns the kernel messages (C<dmesg> output) from
2433 the guest kernel. This is sometimes useful for extended
2434 debugging of problems.
2436 Another way to get the same information is to enable
2437 verbose messages with C<guestfs_set_verbose> or by setting
2438 the environment variable C<LIBGUESTFS_DEBUG=1> before
2439 running the program.");
2441 ("ping_daemon", (RErr, []), 92, [],
2442 [InitEmpty, Always, TestRun (
2443 [["ping_daemon"]])],
2444 "ping the guest daemon",
2446 This is a test probe into the guestfs daemon running inside
2447 the qemu subprocess. Calling this function checks that the
2448 daemon responds to the ping message, without affecting the daemon
2449 or attached block device(s) in any other way.");
2451 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2452 [InitBasicFS, Always, TestOutputTrue (
2453 [["write"; "/file1"; "contents of a file"];
2454 ["cp"; "/file1"; "/file2"];
2455 ["equal"; "/file1"; "/file2"]]);
2456 InitBasicFS, Always, TestOutputFalse (
2457 [["write"; "/file1"; "contents of a file"];
2458 ["write"; "/file2"; "contents of another file"];
2459 ["equal"; "/file1"; "/file2"]]);
2460 InitBasicFS, Always, TestLastFail (
2461 [["equal"; "/file1"; "/file2"]])],
2462 "test if two files have equal contents",
2464 This compares the two files C<file1> and C<file2> and returns
2465 true if their content is exactly equal, or false otherwise.
2467 The external L<cmp(1)> program is used for the comparison.");
2469 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2470 [InitISOFS, Always, TestOutputList (
2471 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2472 InitISOFS, Always, TestOutputList (
2473 [["strings"; "/empty"]], []);
2474 (* Test for RHBZ#579608, absolute symbolic links. *)
2475 InitISOFS, Always, TestRun (
2476 [["strings"; "/abssymlink"]])],
2477 "print the printable strings in a file",
2479 This runs the L<strings(1)> command on a file and returns
2480 the list of printable strings found.");
2482 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2483 [InitISOFS, Always, TestOutputList (
2484 [["strings_e"; "b"; "/known-5"]], []);
2485 InitBasicFS, Always, TestOutputList (
2486 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2487 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2488 "print the printable strings in a file",
2490 This is like the C<guestfs_strings> command, but allows you to
2491 specify the encoding of strings that are looked for in
2492 the source file C<path>.
2494 Allowed encodings are:
2500 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2501 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2505 Single 8-bit-byte characters.
2509 16-bit big endian strings such as those encoded in
2510 UTF-16BE or UCS-2BE.
2512 =item l (lower case letter L)
2514 16-bit little endian such as UTF-16LE and UCS-2LE.
2515 This is useful for examining binaries in Windows guests.
2519 32-bit big endian such as UCS-4BE.
2523 32-bit little endian such as UCS-4LE.
2527 The returned strings are transcoded to UTF-8.");
2529 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2530 [InitISOFS, Always, TestOutput (
2531 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2532 (* Test for RHBZ#501888c2 regression which caused large hexdump
2533 * commands to segfault.
2535 InitISOFS, Always, TestRun (
2536 [["hexdump"; "/100krandom"]]);
2537 (* Test for RHBZ#579608, absolute symbolic links. *)
2538 InitISOFS, Always, TestRun (
2539 [["hexdump"; "/abssymlink"]])],
2540 "dump a file in hexadecimal",
2542 This runs C<hexdump -C> on the given C<path>. The result is
2543 the human-readable, canonical hex dump of the file.");
2545 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2546 [InitNone, Always, TestOutput (
2547 [["part_disk"; "/dev/sda"; "mbr"];
2548 ["mkfs"; "ext3"; "/dev/sda1"];
2549 ["mount_options"; ""; "/dev/sda1"; "/"];
2550 ["write"; "/new"; "test file"];
2551 ["umount"; "/dev/sda1"];
2552 ["zerofree"; "/dev/sda1"];
2553 ["mount_options"; ""; "/dev/sda1"; "/"];
2554 ["cat"; "/new"]], "test file")],
2555 "zero unused inodes and disk blocks on ext2/3 filesystem",
2557 This runs the I<zerofree> program on C<device>. This program
2558 claims to zero unused inodes and disk blocks on an ext2/3
2559 filesystem, thus making it possible to compress the filesystem
2562 You should B<not> run this program if the filesystem is
2565 It is possible that using this program can damage the filesystem
2566 or data on the filesystem.");
2568 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2570 "resize an LVM physical volume",
2572 This resizes (expands or shrinks) an existing LVM physical
2573 volume to match the new size of the underlying device.");
2575 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2576 Int "cyls"; Int "heads"; Int "sectors";
2577 String "line"]), 99, [DangerWillRobinson],
2579 "modify a single partition on a block device",
2581 This runs L<sfdisk(8)> option to modify just the single
2582 partition C<n> (note: C<n> counts from 1).
2584 For other parameters, see C<guestfs_sfdisk>. You should usually
2585 pass C<0> for the cyls/heads/sectors parameters.
2587 See also: C<guestfs_part_add>");
2589 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2591 "display the partition table",
2593 This displays the partition table on C<device>, in the
2594 human-readable output of the L<sfdisk(8)> command. It is
2595 not intended to be parsed.
2597 See also: C<guestfs_part_list>");
2599 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2601 "display the kernel geometry",
2603 This displays the kernel's idea of the geometry of C<device>.
2605 The result is in human-readable format, and not designed to
2608 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2610 "display the disk geometry from the partition table",
2612 This displays the disk geometry of C<device> read from the
2613 partition table. Especially in the case where the underlying
2614 block device has been resized, this can be different from the
2615 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2617 The result is in human-readable format, and not designed to
2620 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2622 "activate or deactivate all volume groups",
2624 This command activates or (if C<activate> is false) deactivates
2625 all logical volumes in all volume groups.
2626 If activated, then they are made known to the
2627 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2628 then those devices disappear.
2630 This command is the same as running C<vgchange -a y|n>");
2632 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2634 "activate or deactivate some volume groups",
2636 This command activates or (if C<activate> is false) deactivates
2637 all logical volumes in the listed volume groups C<volgroups>.
2638 If activated, then they are made known to the
2639 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2640 then those devices disappear.
2642 This command is the same as running C<vgchange -a y|n volgroups...>
2644 Note that if C<volgroups> is an empty list then B<all> volume groups
2645 are activated or deactivated.");
2647 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2648 [InitNone, Always, TestOutput (
2649 [["part_disk"; "/dev/sda"; "mbr"];
2650 ["pvcreate"; "/dev/sda1"];
2651 ["vgcreate"; "VG"; "/dev/sda1"];
2652 ["lvcreate"; "LV"; "VG"; "10"];
2653 ["mkfs"; "ext2"; "/dev/VG/LV"];
2654 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2655 ["write"; "/new"; "test content"];
2657 ["lvresize"; "/dev/VG/LV"; "20"];
2658 ["e2fsck_f"; "/dev/VG/LV"];
2659 ["resize2fs"; "/dev/VG/LV"];
2660 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2661 ["cat"; "/new"]], "test content");
2662 InitNone, Always, TestRun (
2663 (* Make an LV smaller to test RHBZ#587484. *)
2664 [["part_disk"; "/dev/sda"; "mbr"];
2665 ["pvcreate"; "/dev/sda1"];
2666 ["vgcreate"; "VG"; "/dev/sda1"];
2667 ["lvcreate"; "LV"; "VG"; "20"];
2668 ["lvresize"; "/dev/VG/LV"; "10"]])],
2669 "resize an LVM logical volume",
2671 This resizes (expands or shrinks) an existing LVM logical
2672 volume to C<mbytes>. When reducing, data in the reduced part
2675 ("resize2fs", (RErr, [Device "device"]), 106, [],
2676 [], (* lvresize tests this *)
2677 "resize an ext2, ext3 or ext4 filesystem",
2679 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2680 the underlying device.
2682 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2683 on the C<device> before calling this command. For unknown reasons
2684 C<resize2fs> sometimes gives an error about this and sometimes not.
2685 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2686 calling this function.");
2688 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2689 [InitBasicFS, Always, TestOutputList (
2690 [["find"; "/"]], ["lost+found"]);
2691 InitBasicFS, Always, TestOutputList (
2695 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2696 InitBasicFS, Always, TestOutputList (
2697 [["mkdir_p"; "/a/b/c"];
2698 ["touch"; "/a/b/c/d"];
2699 ["find"; "/a/b/"]], ["c"; "c/d"])],
2700 "find all files and directories",
2702 This command lists out all files and directories, recursively,
2703 starting at C<directory>. It is essentially equivalent to
2704 running the shell command C<find directory -print> but some
2705 post-processing happens on the output, described below.
2707 This returns a list of strings I<without any prefix>. Thus
2708 if the directory structure was:
2714 then the returned list from C<guestfs_find> C</tmp> would be
2722 If C<directory> is not a directory, then this command returns
2725 The returned list is sorted.
2727 See also C<guestfs_find0>.");
2729 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2730 [], (* lvresize tests this *)
2731 "check an ext2/ext3 filesystem",
2733 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2734 filesystem checker on C<device>, noninteractively (C<-p>),
2735 even if the filesystem appears to be clean (C<-f>).
2737 This command is only needed because of C<guestfs_resize2fs>
2738 (q.v.). Normally you should use C<guestfs_fsck>.");
2740 ("sleep", (RErr, [Int "secs"]), 109, [],
2741 [InitNone, Always, TestRun (
2743 "sleep for some seconds",
2745 Sleep for C<secs> seconds.");
2747 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2748 [InitNone, Always, TestOutputInt (
2749 [["part_disk"; "/dev/sda"; "mbr"];
2750 ["mkfs"; "ntfs"; "/dev/sda1"];
2751 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2752 InitNone, Always, TestOutputInt (
2753 [["part_disk"; "/dev/sda"; "mbr"];
2754 ["mkfs"; "ext2"; "/dev/sda1"];
2755 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2756 "probe NTFS volume",
2758 This command runs the L<ntfs-3g.probe(8)> command which probes
2759 an NTFS C<device> for mountability. (Not all NTFS volumes can
2760 be mounted read-write, and some cannot be mounted at all).
2762 C<rw> is a boolean flag. Set it to true if you want to test
2763 if the volume can be mounted read-write. Set it to false if
2764 you want to test if the volume can be mounted read-only.
2766 The return value is an integer which C<0> if the operation
2767 would succeed, or some non-zero value documented in the
2768 L<ntfs-3g.probe(8)> manual page.");
2770 ("sh", (RString "output", [String "command"]), 111, [],
2771 [], (* XXX needs tests *)
2772 "run a command via the shell",
2774 This call runs a command from the guest filesystem via the
2777 This is like C<guestfs_command>, but passes the command to:
2779 /bin/sh -c \"command\"
2781 Depending on the guest's shell, this usually results in
2782 wildcards being expanded, shell expressions being interpolated
2785 All the provisos about C<guestfs_command> apply to this call.");
2787 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2788 [], (* XXX needs tests *)
2789 "run a command via the shell returning lines",
2791 This is the same as C<guestfs_sh>, but splits the result
2792 into a list of lines.
2794 See also: C<guestfs_command_lines>");
2796 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2797 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2798 * code in stubs.c, since all valid glob patterns must start with "/".
2799 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2801 [InitBasicFS, Always, TestOutputList (
2802 [["mkdir_p"; "/a/b/c"];
2803 ["touch"; "/a/b/c/d"];
2804 ["touch"; "/a/b/c/e"];
2805 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2806 InitBasicFS, Always, TestOutputList (
2807 [["mkdir_p"; "/a/b/c"];
2808 ["touch"; "/a/b/c/d"];
2809 ["touch"; "/a/b/c/e"];
2810 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2811 InitBasicFS, Always, TestOutputList (
2812 [["mkdir_p"; "/a/b/c"];
2813 ["touch"; "/a/b/c/d"];
2814 ["touch"; "/a/b/c/e"];
2815 ["glob_expand"; "/a/*/x/*"]], [])],
2816 "expand a wildcard path",
2818 This command searches for all the pathnames matching
2819 C<pattern> according to the wildcard expansion rules
2822 If no paths match, then this returns an empty list
2823 (note: not an error).
2825 It is just a wrapper around the C L<glob(3)> function
2826 with flags C<GLOB_MARK|GLOB_BRACE>.
2827 See that manual page for more details.");
2829 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2830 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2831 [["scrub_device"; "/dev/sdc"]])],
2832 "scrub (securely wipe) a device",
2834 This command writes patterns over C<device> to make data retrieval
2837 It is an interface to the L<scrub(1)> program. See that
2838 manual page for more details.");
2840 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2841 [InitBasicFS, Always, TestRun (
2842 [["write"; "/file"; "content"];
2843 ["scrub_file"; "/file"]])],
2844 "scrub (securely wipe) a file",
2846 This command writes patterns over a file to make data retrieval
2849 The file is I<removed> after scrubbing.
2851 It is an interface to the L<scrub(1)> program. See that
2852 manual page for more details.");
2854 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2855 [], (* XXX needs testing *)
2856 "scrub (securely wipe) free space",
2858 This command creates the directory C<dir> and then fills it
2859 with files until the filesystem is full, and scrubs the files
2860 as for C<guestfs_scrub_file>, and deletes them.
2861 The intention is to scrub any free space on the partition
2864 It is an interface to the L<scrub(1)> program. See that
2865 manual page for more details.");
2867 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2868 [InitBasicFS, Always, TestRun (
2870 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2871 "create a temporary directory",
2873 This command creates a temporary directory. The
2874 C<template> parameter should be a full pathname for the
2875 temporary directory name with the final six characters being
2878 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2879 the second one being suitable for Windows filesystems.
2881 The name of the temporary directory that was created
2884 The temporary directory is created with mode 0700
2885 and is owned by root.
2887 The caller is responsible for deleting the temporary
2888 directory and its contents after use.
2890 See also: L<mkdtemp(3)>");
2892 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2893 [InitISOFS, Always, TestOutputInt (
2894 [["wc_l"; "/10klines"]], 10000);
2895 (* Test for RHBZ#579608, absolute symbolic links. *)
2896 InitISOFS, Always, TestOutputInt (
2897 [["wc_l"; "/abssymlink"]], 10000)],
2898 "count lines in a file",
2900 This command counts the lines in a file, using the
2901 C<wc -l> external command.");
2903 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2904 [InitISOFS, Always, TestOutputInt (
2905 [["wc_w"; "/10klines"]], 10000)],
2906 "count words in a file",
2908 This command counts the words in a file, using the
2909 C<wc -w> external command.");
2911 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2912 [InitISOFS, Always, TestOutputInt (
2913 [["wc_c"; "/100kallspaces"]], 102400)],
2914 "count characters in a file",
2916 This command counts the characters in a file, using the
2917 C<wc -c> external command.");
2919 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2920 [InitISOFS, Always, TestOutputList (
2921 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
2922 (* Test for RHBZ#579608, absolute symbolic links. *)
2923 InitISOFS, Always, TestOutputList (
2924 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2925 "return first 10 lines of a file",
2927 This command returns up to the first 10 lines of a file as
2928 a list of strings.");
2930 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2931 [InitISOFS, Always, TestOutputList (
2932 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2933 InitISOFS, Always, TestOutputList (
2934 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2935 InitISOFS, Always, TestOutputList (
2936 [["head_n"; "0"; "/10klines"]], [])],
2937 "return first N lines of a file",
2939 If the parameter C<nrlines> is a positive number, this returns the first
2940 C<nrlines> lines of the file C<path>.
2942 If the parameter C<nrlines> is a negative number, this returns lines
2943 from the file C<path>, excluding the last C<nrlines> lines.
2945 If the parameter C<nrlines> is zero, this returns an empty list.");
2947 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2948 [InitISOFS, Always, TestOutputList (
2949 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2950 "return last 10 lines of a file",
2952 This command returns up to the last 10 lines of a file as
2953 a list of strings.");
2955 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2956 [InitISOFS, Always, TestOutputList (
2957 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2958 InitISOFS, Always, TestOutputList (
2959 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2960 InitISOFS, Always, TestOutputList (
2961 [["tail_n"; "0"; "/10klines"]], [])],
2962 "return last N lines of a file",
2964 If the parameter C<nrlines> is a positive number, this returns the last
2965 C<nrlines> lines of the file C<path>.
2967 If the parameter C<nrlines> is a negative number, this returns lines
2968 from the file C<path>, starting with the C<-nrlines>th line.
2970 If the parameter C<nrlines> is zero, this returns an empty list.");
2972 ("df", (RString "output", []), 125, [],
2973 [], (* XXX Tricky to test because it depends on the exact format
2974 * of the 'df' command and other imponderables.
2976 "report file system disk space usage",
2978 This command runs the C<df> command to report disk space used.
2980 This command is mostly useful for interactive sessions. It
2981 is I<not> intended that you try to parse the output string.
2982 Use C<statvfs> from programs.");
2984 ("df_h", (RString "output", []), 126, [],
2985 [], (* XXX Tricky to test because it depends on the exact format
2986 * of the 'df' command and other imponderables.
2988 "report file system disk space usage (human readable)",
2990 This command runs the C<df -h> command to report disk space used
2991 in human-readable format.
2993 This command is mostly useful for interactive sessions. It
2994 is I<not> intended that you try to parse the output string.
2995 Use C<statvfs> from programs.");
2997 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2998 [InitISOFS, Always, TestOutputInt (
2999 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3000 "estimate file space usage",
3002 This command runs the C<du -s> command to estimate file space
3005 C<path> can be a file or a directory. If C<path> is a directory
3006 then the estimate includes the contents of the directory and all
3007 subdirectories (recursively).
3009 The result is the estimated size in I<kilobytes>
3010 (ie. units of 1024 bytes).");
3012 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
3013 [InitISOFS, Always, TestOutputList (
3014 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3015 "list files in an initrd",
3017 This command lists out files contained in an initrd.
3019 The files are listed without any initial C</> character. The
3020 files are listed in the order they appear (not necessarily
3021 alphabetical). Directory names are listed as separate items.
3023 Old Linux kernels (2.4 and earlier) used a compressed ext2
3024 filesystem as initrd. We I<only> support the newer initramfs
3025 format (compressed cpio files).");
3027 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
3029 "mount a file using the loop device",
3031 This command lets you mount C<file> (a filesystem image
3032 in a file) on a mount point. It is entirely equivalent to
3033 the command C<mount -o loop file mountpoint>.");
3035 ("mkswap", (RErr, [Device "device"]), 130, [],
3036 [InitEmpty, Always, TestRun (
3037 [["part_disk"; "/dev/sda"; "mbr"];
3038 ["mkswap"; "/dev/sda1"]])],
3039 "create a swap partition",
3041 Create a swap partition on C<device>.");
3043 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3044 [InitEmpty, Always, TestRun (
3045 [["part_disk"; "/dev/sda"; "mbr"];
3046 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3047 "create a swap partition with a label",
3049 Create a swap partition on C<device> with label C<label>.
3051 Note that you cannot attach a swap label to a block device
3052 (eg. C</dev/sda>), just to a partition. This appears to be
3053 a limitation of the kernel or swap tools.");
3055 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3056 (let uuid = uuidgen () in
3057 [InitEmpty, Always, TestRun (
3058 [["part_disk"; "/dev/sda"; "mbr"];
3059 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3060 "create a swap partition with an explicit UUID",
3062 Create a swap partition on C<device> with UUID C<uuid>.");
3064 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3065 [InitBasicFS, Always, TestOutputStruct (
3066 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3067 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3068 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3069 InitBasicFS, Always, TestOutputStruct (
3070 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3071 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3072 "make block, character or FIFO devices",
3074 This call creates block or character special devices, or
3075 named pipes (FIFOs).
3077 The C<mode> parameter should be the mode, using the standard
3078 constants. C<devmajor> and C<devminor> are the
3079 device major and minor numbers, only used when creating block
3080 and character special devices.
3082 Note that, just like L<mknod(2)>, the mode must be bitwise
3083 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3084 just creates a regular file). These constants are
3085 available in the standard Linux header files, or you can use
3086 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3087 which are wrappers around this command which bitwise OR
3088 in the appropriate constant for you.
3090 The mode actually set is affected by the umask.");
3092 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3093 [InitBasicFS, Always, TestOutputStruct (
3094 [["mkfifo"; "0o777"; "/node"];
3095 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3096 "make FIFO (named pipe)",
3098 This call creates a FIFO (named pipe) called C<path> with
3099 mode C<mode>. It is just a convenient wrapper around
3102 The mode actually set is affected by the umask.");
3104 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3105 [InitBasicFS, Always, TestOutputStruct (
3106 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3107 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3108 "make block device node",
3110 This call creates a block device node called C<path> with
3111 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3112 It is just a convenient wrapper around C<guestfs_mknod>.
3114 The mode actually set is affected by the umask.");
3116 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3117 [InitBasicFS, Always, TestOutputStruct (
3118 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3119 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3120 "make char device node",
3122 This call creates a char device node called C<path> with
3123 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3124 It is just a convenient wrapper around C<guestfs_mknod>.
3126 The mode actually set is affected by the umask.");
3128 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3129 [InitEmpty, Always, TestOutputInt (
3130 [["umask"; "0o22"]], 0o22)],
3131 "set file mode creation mask (umask)",
3133 This function sets the mask used for creating new files and
3134 device nodes to C<mask & 0777>.
3136 Typical umask values would be C<022> which creates new files
3137 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3138 C<002> which creates new files with permissions like
3139 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3141 The default umask is C<022>. This is important because it
3142 means that directories and device nodes will be created with
3143 C<0644> or C<0755> mode even if you specify C<0777>.
3145 See also C<guestfs_get_umask>,
3146 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3148 This call returns the previous umask.");
3150 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3152 "read directories entries",
3154 This returns the list of directory entries in directory C<dir>.
3156 All entries in the directory are returned, including C<.> and
3157 C<..>. The entries are I<not> sorted, but returned in the same
3158 order as the underlying filesystem.
3160 Also this call returns basic file type information about each
3161 file. The C<ftyp> field will contain one of the following characters:
3199 The L<readdir(3)> call returned a C<d_type> field with an
3204 This function is primarily intended for use by programs. To
3205 get a simple list of names, use C<guestfs_ls>. To get a printable
3206 directory for human consumption, use C<guestfs_ll>.");
3208 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3210 "create partitions on a block device",
3212 This is a simplified interface to the C<guestfs_sfdisk>
3213 command, where partition sizes are specified in megabytes
3214 only (rounded to the nearest cylinder) and you don't need
3215 to specify the cyls, heads and sectors parameters which
3216 were rarely if ever used anyway.
3218 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3219 and C<guestfs_part_disk>");
3221 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3223 "determine file type inside a compressed file",
3225 This command runs C<file> after first decompressing C<path>
3228 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3230 Since 1.0.63, use C<guestfs_file> instead which can now
3231 process compressed files.");
3233 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3235 "list extended attributes of a file or directory",
3237 This call lists the extended attributes of the file or directory
3240 At the system call level, this is a combination of the
3241 L<listxattr(2)> and L<getxattr(2)> calls.
3243 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3245 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3247 "list extended attributes of a file or directory",
3249 This is the same as C<guestfs_getxattrs>, but if C<path>
3250 is a symbolic link, then it returns the extended attributes
3251 of the link itself.");
3253 ("setxattr", (RErr, [String "xattr";
3254 String "val"; Int "vallen"; (* will be BufferIn *)
3255 Pathname "path"]), 143, [Optional "linuxxattrs"],
3257 "set extended attribute of a file or directory",
3259 This call sets the extended attribute named C<xattr>
3260 of the file C<path> to the value C<val> (of length C<vallen>).
3261 The value is arbitrary 8 bit data.
3263 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3265 ("lsetxattr", (RErr, [String "xattr";
3266 String "val"; Int "vallen"; (* will be BufferIn *)
3267 Pathname "path"]), 144, [Optional "linuxxattrs"],
3269 "set extended attribute of a file or directory",
3271 This is the same as C<guestfs_setxattr>, but if C<path>
3272 is a symbolic link, then it sets an extended attribute
3273 of the link itself.");
3275 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3277 "remove extended attribute of a file or directory",
3279 This call removes the extended attribute named C<xattr>
3280 of the file C<path>.
3282 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3284 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3286 "remove extended attribute of a file or directory",
3288 This is the same as C<guestfs_removexattr>, but if C<path>
3289 is a symbolic link, then it removes an extended attribute
3290 of the link itself.");
3292 ("mountpoints", (RHashtable "mps", []), 147, [],
3296 This call is similar to C<guestfs_mounts>. That call returns
3297 a list of devices. This one returns a hash table (map) of
3298 device name to directory where the device is mounted.");
3300 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3301 (* This is a special case: while you would expect a parameter
3302 * of type "Pathname", that doesn't work, because it implies
3303 * NEED_ROOT in the generated calling code in stubs.c, and
3304 * this function cannot use NEED_ROOT.
3307 "create a mountpoint",
3309 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3310 specialized calls that can be used to create extra mountpoints
3311 before mounting the first filesystem.
3313 These calls are I<only> necessary in some very limited circumstances,
3314 mainly the case where you want to mount a mix of unrelated and/or
3315 read-only filesystems together.
3317 For example, live CDs often contain a \"Russian doll\" nest of
3318 filesystems, an ISO outer layer, with a squashfs image inside, with
3319 an ext2/3 image inside that. You can unpack this as follows
3322 add-ro Fedora-11-i686-Live.iso
3325 mkmountpoint /squash
3328 mount-loop /cd/LiveOS/squashfs.img /squash
3329 mount-loop /squash/LiveOS/ext3fs.img /ext3
3331 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3333 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3335 "remove a mountpoint",
3337 This calls removes a mountpoint that was previously created
3338 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3339 for full details.");
3341 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3342 [InitISOFS, Always, TestOutputBuffer (
3343 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3344 (* Test various near large, large and too large files (RHBZ#589039). *)
3345 InitBasicFS, Always, TestLastFail (
3347 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3348 ["read_file"; "/a"]]);
3349 InitBasicFS, Always, TestLastFail (
3351 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3352 ["read_file"; "/a"]]);
3353 InitBasicFS, Always, TestLastFail (
3355 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3356 ["read_file"; "/a"]])],
3359 This calls returns the contents of the file C<path> as a
3362 Unlike C<guestfs_cat>, this function can correctly
3363 handle files that contain embedded ASCII NUL characters.
3364 However unlike C<guestfs_download>, this function is limited
3365 in the total size of file that can be handled.");
3367 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3368 [InitISOFS, Always, TestOutputList (
3369 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3370 InitISOFS, Always, TestOutputList (
3371 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3372 (* Test for RHBZ#579608, absolute symbolic links. *)
3373 InitISOFS, Always, TestOutputList (
3374 [["grep"; "nomatch"; "/abssymlink"]], [])],
3375 "return lines matching a pattern",
3377 This calls the external C<grep> program and returns the
3380 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3381 [InitISOFS, Always, TestOutputList (
3382 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3383 "return lines matching a pattern",
3385 This calls the external C<egrep> program and returns the
3388 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3389 [InitISOFS, Always, TestOutputList (
3390 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3391 "return lines matching a pattern",
3393 This calls the external C<fgrep> program and returns the
3396 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3397 [InitISOFS, Always, TestOutputList (
3398 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3399 "return lines matching a pattern",
3401 This calls the external C<grep -i> program and returns the
3404 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3405 [InitISOFS, Always, TestOutputList (
3406 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3407 "return lines matching a pattern",
3409 This calls the external C<egrep -i> program and returns the
3412 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3413 [InitISOFS, Always, TestOutputList (
3414 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3415 "return lines matching a pattern",
3417 This calls the external C<fgrep -i> program and returns the
3420 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3421 [InitISOFS, Always, TestOutputList (
3422 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3423 "return lines matching a pattern",
3425 This calls the external C<zgrep> program and returns the
3428 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3429 [InitISOFS, Always, TestOutputList (
3430 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3431 "return lines matching a pattern",
3433 This calls the external C<zegrep> program and returns the
3436 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3437 [InitISOFS, Always, TestOutputList (
3438 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3439 "return lines matching a pattern",
3441 This calls the external C<zfgrep> program and returns the
3444 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3445 [InitISOFS, Always, TestOutputList (
3446 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3447 "return lines matching a pattern",
3449 This calls the external C<zgrep -i> program and returns the
3452 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3453 [InitISOFS, Always, TestOutputList (
3454 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3455 "return lines matching a pattern",
3457 This calls the external C<zegrep -i> program and returns the
3460 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3461 [InitISOFS, Always, TestOutputList (
3462 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3463 "return lines matching a pattern",
3465 This calls the external C<zfgrep -i> program and returns the
3468 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3469 [InitISOFS, Always, TestOutput (
3470 [["realpath"; "/../directory"]], "/directory")],
3471 "canonicalized absolute pathname",
3473 Return the canonicalized absolute pathname of C<path>. The
3474 returned path has no C<.>, C<..> or symbolic link path elements.");
3476 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3477 [InitBasicFS, Always, TestOutputStruct (
3480 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3481 "create a hard link",
3483 This command creates a hard link using the C<ln> command.");
3485 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3486 [InitBasicFS, Always, TestOutputStruct (
3489 ["ln_f"; "/a"; "/b"];
3490 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3491 "create a hard link",
3493 This command creates a hard link using the C<ln -f> command.
3494 The C<-f> option removes the link (C<linkname>) if it exists already.");
3496 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3497 [InitBasicFS, Always, TestOutputStruct (
3499 ["ln_s"; "a"; "/b"];
3500 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3501 "create a symbolic link",
3503 This command creates a symbolic link using the C<ln -s> command.");
3505 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3506 [InitBasicFS, Always, TestOutput (
3507 [["mkdir_p"; "/a/b"];
3508 ["touch"; "/a/b/c"];
3509 ["ln_sf"; "../d"; "/a/b/c"];
3510 ["readlink"; "/a/b/c"]], "../d")],
3511 "create a symbolic link",
3513 This command creates a symbolic link using the C<ln -sf> command,
3514 The C<-f> option removes the link (C<linkname>) if it exists already.");
3516 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3517 [] (* XXX tested above *),
3518 "read the target of a symbolic link",
3520 This command reads the target of a symbolic link.");
3522 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [DeprecatedBy "fallocate64"],
3523 [InitBasicFS, Always, TestOutputStruct (
3524 [["fallocate"; "/a"; "1000000"];
3525 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3526 "preallocate a file in the guest filesystem",
3528 This command preallocates a file (containing zero bytes) named
3529 C<path> of size C<len> bytes. If the file exists already, it
3532 Do not confuse this with the guestfish-specific
3533 C<alloc> command which allocates a file in the host and
3534 attaches it as a device.");
3536 ("swapon_device", (RErr, [Device "device"]), 170, [],
3537 [InitPartition, Always, TestRun (
3538 [["mkswap"; "/dev/sda1"];
3539 ["swapon_device"; "/dev/sda1"];
3540 ["swapoff_device"; "/dev/sda1"]])],
3541 "enable swap on device",
3543 This command enables the libguestfs appliance to use the
3544 swap device or partition named C<device>. The increased
3545 memory is made available for all commands, for example
3546 those run using C<guestfs_command> or C<guestfs_sh>.
3548 Note that you should not swap to existing guest swap
3549 partitions unless you know what you are doing. They may
3550 contain hibernation information, or other information that
3551 the guest doesn't want you to trash. You also risk leaking
3552 information about the host to the guest this way. Instead,
3553 attach a new host device to the guest and swap on that.");
3555 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3556 [], (* XXX tested by swapon_device *)
3557 "disable swap on device",
3559 This command disables the libguestfs appliance swap
3560 device or partition named C<device>.
3561 See C<guestfs_swapon_device>.");
3563 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3564 [InitBasicFS, Always, TestRun (
3565 [["fallocate"; "/swap"; "8388608"];
3566 ["mkswap_file"; "/swap"];
3567 ["swapon_file"; "/swap"];
3568 ["swapoff_file"; "/swap"]])],
3569 "enable swap on file",
3571 This command enables swap to a file.
3572 See C<guestfs_swapon_device> for other notes.");
3574 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3575 [], (* XXX tested by swapon_file *)
3576 "disable swap on file",
3578 This command disables the libguestfs appliance swap on file.");
3580 ("swapon_label", (RErr, [String "label"]), 174, [],
3581 [InitEmpty, Always, TestRun (
3582 [["part_disk"; "/dev/sdb"; "mbr"];
3583 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3584 ["swapon_label"; "swapit"];
3585 ["swapoff_label"; "swapit"];
3586 ["zero"; "/dev/sdb"];
3587 ["blockdev_rereadpt"; "/dev/sdb"]])],
3588 "enable swap on labeled swap partition",
3590 This command enables swap to a labeled swap partition.
3591 See C<guestfs_swapon_device> for other notes.");
3593 ("swapoff_label", (RErr, [String "label"]), 175, [],
3594 [], (* XXX tested by swapon_label *)
3595 "disable swap on labeled swap partition",
3597 This command disables the libguestfs appliance swap on
3598 labeled swap partition.");
3600 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3601 (let uuid = uuidgen () in
3602 [InitEmpty, Always, TestRun (
3603 [["mkswap_U"; uuid; "/dev/sdb"];
3604 ["swapon_uuid"; uuid];
3605 ["swapoff_uuid"; uuid]])]),
3606 "enable swap on swap partition by UUID",
3608 This command enables swap to a swap partition with the given UUID.
3609 See C<guestfs_swapon_device> for other notes.");
3611 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3612 [], (* XXX tested by swapon_uuid *)
3613 "disable swap on swap partition by UUID",
3615 This command disables the libguestfs appliance swap partition
3616 with the given UUID.");
3618 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3619 [InitBasicFS, Always, TestRun (
3620 [["fallocate"; "/swap"; "8388608"];
3621 ["mkswap_file"; "/swap"]])],
3622 "create a swap file",
3626 This command just writes a swap file signature to an existing
3627 file. To create the file itself, use something like C<guestfs_fallocate>.");
3629 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3630 [InitISOFS, Always, TestRun (
3631 [["inotify_init"; "0"]])],
3632 "create an inotify handle",
3634 This command creates a new inotify handle.
3635 The inotify subsystem can be used to notify events which happen to
3636 objects in the guest filesystem.
3638 C<maxevents> is the maximum number of events which will be
3639 queued up between calls to C<guestfs_inotify_read> or
3640 C<guestfs_inotify_files>.
3641 If this is passed as C<0>, then the kernel (or previously set)
3642 default is used. For Linux 2.6.29 the default was 16384 events.
3643 Beyond this limit, the kernel throws away events, but records
3644 the fact that it threw them away by setting a flag
3645 C<IN_Q_OVERFLOW> in the returned structure list (see
3646 C<guestfs_inotify_read>).
3648 Before any events are generated, you have to add some
3649 watches to the internal watch list. See:
3650 C<guestfs_inotify_add_watch>,
3651 C<guestfs_inotify_rm_watch> and
3652 C<guestfs_inotify_watch_all>.
3654 Queued up events should be read periodically by calling
3655 C<guestfs_inotify_read>
3656 (or C<guestfs_inotify_files> which is just a helpful
3657 wrapper around C<guestfs_inotify_read>). If you don't
3658 read the events out often enough then you risk the internal
3661 The handle should be closed after use by calling
3662 C<guestfs_inotify_close>. This also removes any
3663 watches automatically.
3665 See also L<inotify(7)> for an overview of the inotify interface
3666 as exposed by the Linux kernel, which is roughly what we expose
3667 via libguestfs. Note that there is one global inotify handle
3668 per libguestfs instance.");
3670 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3671 [InitBasicFS, Always, TestOutputList (
3672 [["inotify_init"; "0"];
3673 ["inotify_add_watch"; "/"; "1073741823"];
3676 ["inotify_files"]], ["a"; "b"])],
3677 "add an inotify watch",
3679 Watch C<path> for the events listed in C<mask>.
3681 Note that if C<path> is a directory then events within that
3682 directory are watched, but this does I<not> happen recursively
3683 (in subdirectories).
3685 Note for non-C or non-Linux callers: the inotify events are
3686 defined by the Linux kernel ABI and are listed in
3687 C</usr/include/sys/inotify.h>.");
3689 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3691 "remove an inotify watch",
3693 Remove a previously defined inotify watch.
3694 See C<guestfs_inotify_add_watch>.");
3696 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3698 "return list of inotify events",
3700 Return the complete queue of events that have happened
3701 since the previous read call.
3703 If no events have happened, this returns an empty list.
3705 I<Note>: In order to make sure that all events have been
3706 read, you must call this function repeatedly until it
3707 returns an empty list. The reason is that the call will
3708 read events up to the maximum appliance-to-host message
3709 size and leave remaining events in the queue.");
3711 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3713 "return list of watched files that had events",
3715 This function is a helpful wrapper around C<guestfs_inotify_read>
3716 which just returns a list of pathnames of objects that were
3717 touched. The returned pathnames are sorted and deduplicated.");
3719 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3721 "close the inotify handle",
3723 This closes the inotify handle which was previously
3724 opened by inotify_init. It removes all watches, throws
3725 away any pending events, and deallocates all resources.");
3727 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3729 "set SELinux security context",
3731 This sets the SELinux security context of the daemon
3732 to the string C<context>.
3734 See the documentation about SELINUX in L<guestfs(3)>.");
3736 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3738 "get SELinux security context",
3740 This gets the SELinux security context of the daemon.
3742 See the documentation about SELINUX in L<guestfs(3)>,
3743 and C<guestfs_setcon>");
3745 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3746 [InitEmpty, Always, TestOutput (
3747 [["part_disk"; "/dev/sda"; "mbr"];
3748 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3749 ["mount_options"; ""; "/dev/sda1"; "/"];
3750 ["write"; "/new"; "new file contents"];
3751 ["cat"; "/new"]], "new file contents");
3752 InitEmpty, Always, TestRun (
3753 [["part_disk"; "/dev/sda"; "mbr"];
3754 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3755 InitEmpty, Always, TestLastFail (
3756 [["part_disk"; "/dev/sda"; "mbr"];
3757 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3758 InitEmpty, Always, TestLastFail (
3759 [["part_disk"; "/dev/sda"; "mbr"];
3760 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3761 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3762 [["part_disk"; "/dev/sda"; "mbr"];
3763 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3764 "make a filesystem with block size",
3766 This call is similar to C<guestfs_mkfs>, but it allows you to
3767 control the block size of the resulting filesystem. Supported
3768 block sizes depend on the filesystem type, but typically they
3769 are C<1024>, C<2048> or C<4096> only.
3771 For VFAT and NTFS the C<blocksize> parameter is treated as
3772 the requested cluster size.");
3774 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3775 [InitEmpty, Always, TestOutput (
3776 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3777 ["mke2journal"; "4096"; "/dev/sda1"];
3778 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3779 ["mount_options"; ""; "/dev/sda2"; "/"];
3780 ["write"; "/new"; "new file contents"];
3781 ["cat"; "/new"]], "new file contents")],
3782 "make ext2/3/4 external journal",
3784 This creates an ext2 external journal on C<device>. It is equivalent
3787 mke2fs -O journal_dev -b blocksize device");
3789 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3790 [InitEmpty, Always, TestOutput (
3791 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3792 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3793 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3794 ["mount_options"; ""; "/dev/sda2"; "/"];
3795 ["write"; "/new"; "new file contents"];
3796 ["cat"; "/new"]], "new file contents")],
3797 "make ext2/3/4 external journal with label",
3799 This creates an ext2 external journal on C<device> with label C<label>.");
3801 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3802 (let uuid = uuidgen () in
3803 [InitEmpty, Always, TestOutput (
3804 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3805 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3806 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3807 ["mount_options"; ""; "/dev/sda2"; "/"];
3808 ["write"; "/new"; "new file contents"];
3809 ["cat"; "/new"]], "new file contents")]),
3810 "make ext2/3/4 external journal with UUID",
3812 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3814 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3816 "make ext2/3/4 filesystem with external journal",
3818 This creates an ext2/3/4 filesystem on C<device> with
3819 an external journal on C<journal>. It is equivalent
3822 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3824 See also C<guestfs_mke2journal>.");
3826 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3828 "make ext2/3/4 filesystem with external journal",
3830 This creates an ext2/3/4 filesystem on C<device> with
3831 an external journal on the journal labeled C<label>.
3833 See also C<guestfs_mke2journal_L>.");
3835 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3837 "make ext2/3/4 filesystem with external journal",
3839 This creates an ext2/3/4 filesystem on C<device> with
3840 an external journal on the journal with UUID C<uuid>.
3842 See also C<guestfs_mke2journal_U>.");
3844 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3845 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3846 "load a kernel module",
3848 This loads a kernel module in the appliance.
3850 The kernel module must have been whitelisted when libguestfs
3851 was built (see C<appliance/kmod.whitelist.in> in the source).");
3853 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3854 [InitNone, Always, TestOutput (
3855 [["echo_daemon"; "This is a test"]], "This is a test"
3857 "echo arguments back to the client",
3859 This command concatenates the list of C<words> passed with single spaces
3860 between them and returns the resulting string.
3862 You can use this command to test the connection through to the daemon.
3864 See also C<guestfs_ping_daemon>.");
3866 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3867 [], (* There is a regression test for this. *)
3868 "find all files and directories, returning NUL-separated list",
3870 This command lists out all files and directories, recursively,
3871 starting at C<directory>, placing the resulting list in the
3872 external file called C<files>.
3874 This command works the same way as C<guestfs_find> with the
3875 following exceptions:
3881 The resulting list is written to an external file.
3885 Items (filenames) in the result are separated
3886 by C<\\0> characters. See L<find(1)> option I<-print0>.
3890 This command is not limited in the number of names that it
3895 The result list is not sorted.
3899 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3900 [InitISOFS, Always, TestOutput (
3901 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3902 InitISOFS, Always, TestOutput (
3903 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3904 InitISOFS, Always, TestOutput (
3905 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3906 InitISOFS, Always, TestLastFail (
3907 [["case_sensitive_path"; "/Known-1/"]]);
3908 InitBasicFS, Always, TestOutput (
3910 ["mkdir"; "/a/bbb"];
3911 ["touch"; "/a/bbb/c"];
3912 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3913 InitBasicFS, Always, TestOutput (
3915 ["mkdir"; "/a/bbb"];
3916 ["touch"; "/a/bbb/c"];
3917 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3918 InitBasicFS, Always, TestLastFail (
3920 ["mkdir"; "/a/bbb"];
3921 ["touch"; "/a/bbb/c"];
3922 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3923 "return true path on case-insensitive filesystem",
3925 This can be used to resolve case insensitive paths on
3926 a filesystem which is case sensitive. The use case is
3927 to resolve paths which you have read from Windows configuration
3928 files or the Windows Registry, to the true path.
3930 The command handles a peculiarity of the Linux ntfs-3g
3931 filesystem driver (and probably others), which is that although
3932 the underlying filesystem is case-insensitive, the driver
3933 exports the filesystem to Linux as case-sensitive.
3935 One consequence of this is that special directories such
3936 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3937 (or other things) depending on the precise details of how
3938 they were created. In Windows itself this would not be
3941 Bug or feature? You decide:
3942 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3944 This function resolves the true case of each element in the
3945 path and returns the case-sensitive path.
3947 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3948 might return C<\"/WINDOWS/system32\"> (the exact return value
3949 would depend on details of how the directories were originally
3950 created under Windows).
3953 This function does not handle drive names, backslashes etc.
3955 See also C<guestfs_realpath>.");
3957 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3958 [InitBasicFS, Always, TestOutput (
3959 [["vfs_type"; "/dev/sda1"]], "ext2")],
3960 "get the Linux VFS type corresponding to a mounted device",
3962 This command gets the filesystem type corresponding to
3963 the filesystem on C<device>.
3965 For most filesystems, the result is the name of the Linux
3966 VFS module which would be used to mount this filesystem
3967 if you mounted it without specifying the filesystem type.
3968 For example a string such as C<ext3> or C<ntfs>.");
3970 ("truncate", (RErr, [Pathname "path"]), 199, [],
3971 [InitBasicFS, Always, TestOutputStruct (
3972 [["write"; "/test"; "some stuff so size is not zero"];
3973 ["truncate"; "/test"];
3974 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3975 "truncate a file to zero size",
3977 This command truncates C<path> to a zero-length file. The
3978 file must exist already.");
3980 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3981 [InitBasicFS, Always, TestOutputStruct (
3982 [["touch"; "/test"];
3983 ["truncate_size"; "/test"; "1000"];
3984 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3985 "truncate a file to a particular size",
3987 This command truncates C<path> to size C<size> bytes. The file
3990 If the current file size is less than C<size> then
3991 the file is extended to the required size with zero bytes.
3992 This creates a sparse file (ie. disk blocks are not allocated
3993 for the file until you write to it). To create a non-sparse
3994 file of zeroes, use C<guestfs_fallocate64> instead.");
3996 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3997 [InitBasicFS, Always, TestOutputStruct (
3998 [["touch"; "/test"];
3999 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4000 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4001 "set timestamp of a file with nanosecond precision",
4003 This command sets the timestamps of a file with nanosecond
4006 C<atsecs, atnsecs> are the last access time (atime) in secs and
4007 nanoseconds from the epoch.
4009 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4010 secs and nanoseconds from the epoch.
4012 If the C<*nsecs> field contains the special value C<-1> then
4013 the corresponding timestamp is set to the current time. (The
4014 C<*secs> field is ignored in this case).
4016 If the C<*nsecs> field contains the special value C<-2> then
4017 the corresponding timestamp is left unchanged. (The
4018 C<*secs> field is ignored in this case).");
4020 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
4021 [InitBasicFS, Always, TestOutputStruct (
4022 [["mkdir_mode"; "/test"; "0o111"];
4023 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4024 "create a directory with a particular mode",
4026 This command creates a directory, setting the initial permissions
4027 of the directory to C<mode>.
4029 For common Linux filesystems, the actual mode which is set will
4030 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4031 interpret the mode in other ways.
4033 See also C<guestfs_mkdir>, C<guestfs_umask>");
4035 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
4037 "change file owner and group",
4039 Change the file owner to C<owner> and group to C<group>.
4040 This is like C<guestfs_chown> but if C<path> is a symlink then
4041 the link itself is changed, not the target.
4043 Only numeric uid and gid are supported. If you want to use
4044 names, you will need to locate and parse the password file
4045 yourself (Augeas support makes this relatively easy).");
4047 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
4049 "lstat on multiple files",
4051 This call allows you to perform the C<guestfs_lstat> operation
4052 on multiple files, where all files are in the directory C<path>.
4053 C<names> is the list of files from this directory.
4055 On return you get a list of stat structs, with a one-to-one
4056 correspondence to the C<names> list. If any name did not exist
4057 or could not be lstat'd, then the C<ino> field of that structure
4060 This call is intended for programs that want to efficiently
4061 list a directory contents without making many round-trips.
4062 See also C<guestfs_lxattrlist> for a similarly efficient call
4063 for getting extended attributes. Very long directory listings
4064 might cause the protocol message size to be exceeded, causing
4065 this call to fail. The caller must split up such requests
4066 into smaller groups of names.");
4068 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4070 "lgetxattr on multiple files",
4072 This call allows you to get the extended attributes
4073 of multiple files, where all files are in the directory C<path>.
4074 C<names> is the list of files from this directory.
4076 On return you get a flat list of xattr structs which must be
4077 interpreted sequentially. The first xattr struct always has a zero-length
4078 C<attrname>. C<attrval> in this struct is zero-length
4079 to indicate there was an error doing C<lgetxattr> for this
4080 file, I<or> is a C string which is a decimal number
4081 (the number of following attributes for this file, which could
4082 be C<\"0\">). Then after the first xattr struct are the
4083 zero or more attributes for the first named file.
4084 This repeats for the second and subsequent files.
4086 This call is intended for programs that want to efficiently
4087 list a directory contents without making many round-trips.
4088 See also C<guestfs_lstatlist> for a similarly efficient call
4089 for getting standard stats. Very long directory listings
4090 might cause the protocol message size to be exceeded, causing
4091 this call to fail. The caller must split up such requests
4092 into smaller groups of names.");
4094 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4096 "readlink on multiple files",
4098 This call allows you to do a C<readlink> operation
4099 on multiple files, where all files are in the directory C<path>.
4100 C<names> is the list of files from this directory.
4102 On return you get a list of strings, with a one-to-one
4103 correspondence to the C<names> list. Each string is the
4104 value of the symbolic link.
4106 If the C<readlink(2)> operation fails on any name, then
4107 the corresponding result string is the empty string C<\"\">.
4108 However the whole operation is completed even if there
4109 were C<readlink(2)> errors, and so you can call this
4110 function with names where you don't know if they are
4111 symbolic links already (albeit slightly less efficient).
4113 This call is intended for programs that want to efficiently
4114 list a directory contents without making many round-trips.
4115 Very long directory listings might cause the protocol
4116 message size to be exceeded, causing
4117 this call to fail. The caller must split up such requests
4118 into smaller groups of names.");
4120 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4121 [InitISOFS, Always, TestOutputBuffer (
4122 [["pread"; "/known-4"; "1"; "3"]], "\n");
4123 InitISOFS, Always, TestOutputBuffer (
4124 [["pread"; "/empty"; "0"; "100"]], "")],
4125 "read part of a file",
4127 This command lets you read part of a file. It reads C<count>
4128 bytes of the file, starting at C<offset>, from file C<path>.
4130 This may read fewer bytes than requested. For further details
4131 see the L<pread(2)> system call.
4133 See also C<guestfs_pwrite>.");
4135 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4136 [InitEmpty, Always, TestRun (
4137 [["part_init"; "/dev/sda"; "gpt"]])],
4138 "create an empty partition table",
4140 This creates an empty partition table on C<device> of one of the
4141 partition types listed below. Usually C<parttype> should be
4142 either C<msdos> or C<gpt> (for large disks).
4144 Initially there are no partitions. Following this, you should
4145 call C<guestfs_part_add> for each partition required.
4147 Possible values for C<parttype> are:
4151 =item B<efi> | B<gpt>
4153 Intel EFI / GPT partition table.
4155 This is recommended for >= 2 TB partitions that will be accessed
4156 from Linux and Intel-based Mac OS X. It also has limited backwards
4157 compatibility with the C<mbr> format.
4159 =item B<mbr> | B<msdos>
4161 The standard PC \"Master Boot Record\" (MBR) format used
4162 by MS-DOS and Windows. This partition type will B<only> work
4163 for device sizes up to 2 TB. For large disks we recommend
4168 Other partition table types that may work but are not
4177 =item B<amiga> | B<rdb>
4179 Amiga \"Rigid Disk Block\" format.
4187 DASD, used on IBM mainframes.
4195 Old Mac partition format. Modern Macs use C<gpt>.
4199 NEC PC-98 format, common in Japan apparently.
4207 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4208 [InitEmpty, Always, TestRun (
4209 [["part_init"; "/dev/sda"; "mbr"];
4210 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4211 InitEmpty, Always, TestRun (
4212 [["part_init"; "/dev/sda"; "gpt"];
4213 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4214 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4215 InitEmpty, Always, TestRun (
4216 [["part_init"; "/dev/sda"; "mbr"];
4217 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4218 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4219 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4220 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4221 "add a partition to the device",
4223 This command adds a partition to C<device>. If there is no partition
4224 table on the device, call C<guestfs_part_init> first.
4226 The C<prlogex> parameter is the type of partition. Normally you
4227 should pass C<p> or C<primary> here, but MBR partition tables also
4228 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4231 C<startsect> and C<endsect> are the start and end of the partition
4232 in I<sectors>. C<endsect> may be negative, which means it counts
4233 backwards from the end of the disk (C<-1> is the last sector).
4235 Creating a partition which covers the whole disk is not so easy.
4236 Use C<guestfs_part_disk> to do that.");
4238 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4239 [InitEmpty, Always, TestRun (
4240 [["part_disk"; "/dev/sda"; "mbr"]]);
4241 InitEmpty, Always, TestRun (
4242 [["part_disk"; "/dev/sda"; "gpt"]])],
4243 "partition whole disk with a single primary partition",
4245 This command is simply a combination of C<guestfs_part_init>
4246 followed by C<guestfs_part_add> to create a single primary partition
4247 covering the whole disk.
4249 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4250 but other possible values are described in C<guestfs_part_init>.");
4252 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4253 [InitEmpty, Always, TestRun (
4254 [["part_disk"; "/dev/sda"; "mbr"];
4255 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4256 "make a partition bootable",
4258 This sets the bootable flag on partition numbered C<partnum> on
4259 device C<device>. Note that partitions are numbered from 1.
4261 The bootable flag is used by some operating systems (notably
4262 Windows) to determine which partition to boot from. It is by
4263 no means universally recognized.");
4265 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4266 [InitEmpty, Always, TestRun (
4267 [["part_disk"; "/dev/sda"; "gpt"];
4268 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4269 "set partition name",
4271 This sets the partition name on partition numbered C<partnum> on
4272 device C<device>. Note that partitions are numbered from 1.
4274 The partition name can only be set on certain types of partition
4275 table. This works on C<gpt> but not on C<mbr> partitions.");
4277 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4278 [], (* XXX Add a regression test for this. *)
4279 "list partitions on a device",
4281 This command parses the partition table on C<device> and
4282 returns the list of partitions found.
4284 The fields in the returned structure are:
4290 Partition number, counting from 1.
4294 Start of the partition I<in bytes>. To get sectors you have to
4295 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4299 End of the partition in bytes.
4303 Size of the partition in bytes.
4307 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4308 [InitEmpty, Always, TestOutput (
4309 [["part_disk"; "/dev/sda"; "gpt"];
4310 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4311 "get the partition table type",
4313 This command examines the partition table on C<device> and
4314 returns the partition table type (format) being used.
4316 Common return values include: C<msdos> (a DOS/Windows style MBR
4317 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4318 values are possible, although unusual. See C<guestfs_part_init>
4321 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4322 [InitBasicFS, Always, TestOutputBuffer (
4323 [["fill"; "0x63"; "10"; "/test"];
4324 ["read_file"; "/test"]], "cccccccccc")],
4325 "fill a file with octets",
4327 This command creates a new file called C<path>. The initial
4328 content of the file is C<len> octets of C<c>, where C<c>
4329 must be a number in the range C<[0..255]>.
4331 To fill a file with zero bytes (sparsely), it is
4332 much more efficient to use C<guestfs_truncate_size>.
4333 To create a file with a pattern of repeating bytes
4334 use C<guestfs_fill_pattern>.");
4336 ("available", (RErr, [StringList "groups"]), 216, [],
4337 [InitNone, Always, TestRun [["available"; ""]]],
4338 "test availability of some parts of the API",
4340 This command is used to check the availability of some
4341 groups of functionality in the appliance, which not all builds of
4342 the libguestfs appliance will be able to provide.
4344 The libguestfs groups, and the functions that those
4345 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4346 You can also fetch this list at runtime by calling
4347 C<guestfs_available_all_groups>.
4349 The argument C<groups> is a list of group names, eg:
4350 C<[\"inotify\", \"augeas\"]> would check for the availability of
4351 the Linux inotify functions and Augeas (configuration file
4354 The command returns no error if I<all> requested groups are available.
4356 It fails with an error if one or more of the requested
4357 groups is unavailable in the appliance.
4359 If an unknown group name is included in the
4360 list of groups then an error is always returned.
4368 You must call C<guestfs_launch> before calling this function.
4370 The reason is because we don't know what groups are
4371 supported by the appliance/daemon until it is running and can
4376 If a group of functions is available, this does not necessarily
4377 mean that they will work. You still have to check for errors
4378 when calling individual API functions even if they are
4383 It is usually the job of distro packagers to build
4384 complete functionality into the libguestfs appliance.
4385 Upstream libguestfs, if built from source with all
4386 requirements satisfied, will support everything.
4390 This call was added in version C<1.0.80>. In previous
4391 versions of libguestfs all you could do would be to speculatively
4392 execute a command to find out if the daemon implemented it.
4393 See also C<guestfs_version>.
4397 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4398 [InitBasicFS, Always, TestOutputBuffer (
4399 [["write"; "/src"; "hello, world"];
4400 ["dd"; "/src"; "/dest"];
4401 ["read_file"; "/dest"]], "hello, world")],
4402 "copy from source to destination using dd",
4404 This command copies from one source device or file C<src>
4405 to another destination device or file C<dest>. Normally you
4406 would use this to copy to or from a device or partition, for
4407 example to duplicate a filesystem.
4409 If the destination is a device, it must be as large or larger
4410 than the source file or device, otherwise the copy will fail.
4411 This command cannot do partial copies (see C<guestfs_copy_size>).");
4413 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4414 [InitBasicFS, Always, TestOutputInt (
4415 [["write"; "/file"; "hello, world"];
4416 ["filesize"; "/file"]], 12)],
4417 "return the size of the file in bytes",
4419 This command returns the size of C<file> in bytes.
4421 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4422 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4423 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4425 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4426 [InitBasicFSonLVM, Always, TestOutputList (
4427 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4428 ["lvs"]], ["/dev/VG/LV2"])],
4429 "rename an LVM logical volume",