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.
177 (* Key material / passphrase. Eventually we should treat this
178 * as sensitive and mlock it into physical RAM. However this
179 * is highly complex because of all the places that XDR-encoded
180 * strings can end up. So currently the only difference from
181 * 'String' is the way that guestfish requests these parameters
187 | ProtocolLimitWarning (* display warning about protocol size limits *)
188 | DangerWillRobinson (* flags particularly dangerous commands *)
189 | FishAlias of string (* provide an alias for this cmd in guestfish *)
190 | FishOutput of fish_output_t (* how to display output in guestfish *)
191 | NotInFish (* do not export via guestfish *)
192 | NotInDocs (* do not add this function to documentation *)
193 | DeprecatedBy of string (* function is deprecated, use .. instead *)
194 | Optional of string (* function is part of an optional group *)
197 | FishOutputOctal (* for int return, print in octal *)
198 | FishOutputHexadecimal (* for int return, print in hex *)
200 (* You can supply zero or as many tests as you want per API call.
202 * Note that the test environment has 3 block devices, of size 500MB,
203 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
204 * a fourth ISO block device with some known files on it (/dev/sdd).
206 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
207 * Number of cylinders was 63 for IDE emulated disks with precisely
208 * the same size. How exactly this is calculated is a mystery.
210 * The ISO block device (/dev/sdd) comes from images/test.iso.
212 * To be able to run the tests in a reasonable amount of time,
213 * the virtual machine and block devices are reused between tests.
214 * So don't try testing kill_subprocess :-x
216 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
218 * Don't assume anything about the previous contents of the block
219 * devices. Use 'Init*' to create some initial scenarios.
221 * You can add a prerequisite clause to any individual test. This
222 * is a run-time check, which, if it fails, causes the test to be
223 * skipped. Useful if testing a command which might not work on
224 * all variations of libguestfs builds. A test that has prerequisite
225 * of 'Always' is run unconditionally.
227 * In addition, packagers can skip individual tests by setting the
228 * environment variables: eg:
229 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
230 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
232 type tests = (test_init * test_prereq * test) list
234 (* Run the command sequence and just expect nothing to fail. *)
237 (* Run the command sequence and expect the output of the final
238 * command to be the string.
240 | TestOutput of seq * string
242 (* Run the command sequence and expect the output of the final
243 * command to be the list of strings.
245 | TestOutputList of seq * string list
247 (* Run the command sequence and expect the output of the final
248 * command to be the list of block devices (could be either
249 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
250 * character of each string).
252 | TestOutputListOfDevices of seq * string list
254 (* Run the command sequence and expect the output of the final
255 * command to be the integer.
257 | TestOutputInt of seq * int
259 (* Run the command sequence and expect the output of the final
260 * command to be <op> <int>, eg. ">=", "1".
262 | TestOutputIntOp of seq * string * int
264 (* Run the command sequence and expect the output of the final
265 * command to be a true value (!= 0 or != NULL).
267 | TestOutputTrue of seq
269 (* Run the command sequence and expect the output of the final
270 * command to be a false value (== 0 or == NULL, but not an error).
272 | TestOutputFalse of seq
274 (* Run the command sequence and expect the output of the final
275 * command to be a list of the given length (but don't care about
278 | TestOutputLength of seq * int
280 (* Run the command sequence and expect the output of the final
281 * command to be a buffer (RBufferOut), ie. string + size.
283 | TestOutputBuffer of seq * string
285 (* Run the command sequence and expect the output of the final
286 * command to be a structure.
288 | TestOutputStruct of seq * test_field_compare list
290 (* Run the command sequence and expect the final command (only)
293 | TestLastFail of seq
295 and test_field_compare =
296 | CompareWithInt of string * int
297 | CompareWithIntOp of string * string * int
298 | CompareWithString of string * string
299 | CompareFieldsIntEq of string * string
300 | CompareFieldsStrEq of string * string
302 (* Test prerequisites. *)
304 (* Test always runs. *)
307 (* Test is currently disabled - eg. it fails, or it tests some
308 * unimplemented feature.
312 (* 'string' is some C code (a function body) that should return
313 * true or false. The test will run if the code returns true.
317 (* As for 'If' but the test runs _unless_ the code returns true. *)
320 (* Run the test only if 'string' is available in the daemon. *)
321 | IfAvailable of string
323 (* Some initial scenarios for testing. *)
325 (* Do nothing, block devices could contain random stuff including
326 * LVM PVs, and some filesystems might be mounted. This is usually
331 (* Block devices are empty and no filesystems are mounted. *)
334 (* /dev/sda contains a single partition /dev/sda1, with random
335 * content. /dev/sdb and /dev/sdc may have random content.
340 (* /dev/sda contains a single partition /dev/sda1, which is formatted
341 * as ext2, empty [except for lost+found] and mounted on /.
342 * /dev/sdb and /dev/sdc may have random content.
348 * /dev/sda1 (is a PV):
349 * /dev/VG/LV (size 8MB):
350 * formatted as ext2, empty [except for lost+found], mounted on /
351 * /dev/sdb and /dev/sdc may have random content.
355 (* /dev/sdd (the ISO, see images/ directory in source)
360 (* Sequence of commands for testing. *)
362 and cmd = string list
364 (* Note about long descriptions: When referring to another
365 * action, use the format C<guestfs_other> (ie. the full name of
366 * the C function). This will be replaced as appropriate in other
369 * Apart from that, long descriptions are just perldoc paragraphs.
372 (* Generate a random UUID (used in tests). *)
374 let chan = open_process_in "uuidgen" in
375 let uuid = input_line chan in
376 (match close_process_in chan with
379 failwith "uuidgen: process exited with non-zero status"
380 | WSIGNALED _ | WSTOPPED _ ->
381 failwith "uuidgen: process signalled or stopped by signal"
385 (* These test functions are used in the language binding tests. *)
387 let test_all_args = [
390 StringList "strlist";
399 let test_all_rets = [
400 (* except for RErr, which is tested thoroughly elsewhere *)
401 "test0rint", RInt "valout";
402 "test0rint64", RInt64 "valout";
403 "test0rbool", RBool "valout";
404 "test0rconststring", RConstString "valout";
405 "test0rconstoptstring", RConstOptString "valout";
406 "test0rstring", RString "valout";
407 "test0rstringlist", RStringList "valout";
408 "test0rstruct", RStruct ("valout", "lvm_pv");
409 "test0rstructlist", RStructList ("valout", "lvm_pv");
410 "test0rhashtable", RHashtable "valout";
413 let test_functions = [
414 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
416 "internal test function - do not use",
418 This is an internal test function which is used to test whether
419 the automatically generated bindings can handle every possible
420 parameter type correctly.
422 It echos the contents of each parameter to stdout.
424 You probably don't want to call this function.");
428 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
430 "internal test function - do not use",
432 This is an internal test function which is used to test whether
433 the automatically generated bindings can handle every possible
434 return type correctly.
436 It converts string C<val> to the return type.
438 You probably don't want to call this function.");
439 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
441 "internal test function - do not use",
443 This is an internal test function which is used to test whether
444 the automatically generated bindings can handle every possible
445 return type correctly.
447 This function always returns an error.
449 You probably don't want to call this function.")]
453 (* non_daemon_functions are any functions which don't get processed
454 * in the daemon, eg. functions for setting and getting local
455 * configuration values.
458 let non_daemon_functions = test_functions @ [
459 ("launch", (RErr, []), -1, [FishAlias "run"],
461 "launch the qemu subprocess",
463 Internally libguestfs is implemented by running a virtual machine
466 You should call this after configuring the handle
467 (eg. adding drives) but before performing any actions.");
469 ("wait_ready", (RErr, []), -1, [NotInFish],
471 "wait until the qemu subprocess launches (no op)",
473 This function is a no op.
475 In versions of the API E<lt> 1.0.71 you had to call this function
476 just after calling C<guestfs_launch> to wait for the launch
477 to complete. However this is no longer necessary because
478 C<guestfs_launch> now does the waiting.
480 If you see any calls to this function in code then you can just
481 remove them, unless you want to retain compatibility with older
482 versions of the API.");
484 ("kill_subprocess", (RErr, []), -1, [],
486 "kill the qemu subprocess",
488 This kills the qemu subprocess. You should never need to call this.");
490 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
492 "add an image to examine or modify",
494 This function adds a virtual machine disk image C<filename> to the
495 guest. The first time you call this function, the disk appears as IDE
496 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
499 You don't necessarily need to be root when using libguestfs. However
500 you obviously do need sufficient permissions to access the filename
501 for whatever operations you want to perform (ie. read access if you
502 just want to read the image or write access if you want to modify the
505 This is equivalent to the qemu parameter
506 C<-drive file=filename,cache=off,if=...>.
508 C<cache=off> is omitted in cases where it is not supported by
509 the underlying filesystem.
511 C<if=...> is set at compile time by the configuration option
512 C<./configure --with-drive-if=...>. In the rare case where you
513 might need to change this at run time, use C<guestfs_add_drive_with_if>
514 or C<guestfs_add_drive_ro_with_if>.
516 Note that this call checks for the existence of C<filename>. This
517 stops you from specifying other types of drive which are supported
518 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
519 the general C<guestfs_config> call instead.");
521 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
523 "add a CD-ROM disk image to examine",
525 This function adds a virtual CD-ROM disk image to the guest.
527 This is equivalent to the qemu parameter C<-cdrom filename>.
535 This call checks for the existence of C<filename>. This
536 stops you from specifying other types of drive which are supported
537 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
538 the general C<guestfs_config> call instead.
542 If you just want to add an ISO file (often you use this as an
543 efficient way to transfer large files into the guest), then you
544 should probably use C<guestfs_add_drive_ro> instead.
548 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
550 "add a drive in snapshot mode (read-only)",
552 This adds a drive in snapshot mode, making it effectively
555 Note that writes to the device are allowed, and will be seen for
556 the duration of the guestfs handle, but they are written
557 to a temporary file which is discarded as soon as the guestfs
558 handle is closed. We don't currently have any method to enable
559 changes to be committed, although qemu can support this.
561 This is equivalent to the qemu parameter
562 C<-drive file=filename,snapshot=on,if=...>.
564 C<if=...> is set at compile time by the configuration option
565 C<./configure --with-drive-if=...>. In the rare case where you
566 might need to change this at run time, use C<guestfs_add_drive_with_if>
567 or C<guestfs_add_drive_ro_with_if>.
569 Note that this call checks for the existence of C<filename>. This
570 stops you from specifying other types of drive which are supported
571 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
572 the general C<guestfs_config> call instead.");
574 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
576 "add qemu parameters",
578 This can be used to add arbitrary qemu command line parameters
579 of the form C<-param value>. Actually it's not quite arbitrary - we
580 prevent you from setting some parameters which would interfere with
581 parameters that we use.
583 The first character of C<param> string must be a C<-> (dash).
585 C<value> can be NULL.");
587 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
589 "set the qemu binary",
591 Set the qemu binary that we will use.
593 The default is chosen when the library was compiled by the
596 You can also override this by setting the C<LIBGUESTFS_QEMU>
597 environment variable.
599 Setting C<qemu> to C<NULL> restores the default qemu binary.
601 Note that you should call this function as early as possible
602 after creating the handle. This is because some pre-launch
603 operations depend on testing qemu features (by running C<qemu -help>).
604 If the qemu binary changes, we don't retest features, and
605 so you might see inconsistent results. Using the environment
606 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
607 the qemu binary at the same time as the handle is created.");
609 ("get_qemu", (RConstString "qemu", []), -1, [],
610 [InitNone, Always, TestRun (
612 "get the qemu binary",
614 Return the current qemu binary.
616 This is always non-NULL. If it wasn't set already, then this will
617 return the default qemu binary name.");
619 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
621 "set the search path",
623 Set the path that libguestfs searches for kernel and initrd.img.
625 The default is C<$libdir/guestfs> unless overridden by setting
626 C<LIBGUESTFS_PATH> environment variable.
628 Setting C<path> to C<NULL> restores the default path.");
630 ("get_path", (RConstString "path", []), -1, [],
631 [InitNone, Always, TestRun (
633 "get the search path",
635 Return the current search path.
637 This is always non-NULL. If it wasn't set already, then this will
638 return the default path.");
640 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
642 "add options to kernel command line",
644 This function is used to add additional options to the
645 guest kernel command line.
647 The default is C<NULL> unless overridden by setting
648 C<LIBGUESTFS_APPEND> environment variable.
650 Setting C<append> to C<NULL> means I<no> additional options
651 are passed (libguestfs always adds a few of its own).");
653 ("get_append", (RConstOptString "append", []), -1, [],
654 (* This cannot be tested with the current framework. The
655 * function can return NULL in normal operations, which the
656 * test framework interprets as an error.
659 "get the additional kernel options",
661 Return the additional kernel options which are added to the
662 guest kernel command line.
664 If C<NULL> then no options are added.");
666 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
670 If C<autosync> is true, this enables autosync. Libguestfs will make a
671 best effort attempt to run C<guestfs_umount_all> followed by
672 C<guestfs_sync> when the handle is closed
673 (also if the program exits without closing handles).
675 This is disabled by default (except in guestfish where it is
676 enabled by default).");
678 ("get_autosync", (RBool "autosync", []), -1, [],
679 [InitNone, Always, TestRun (
680 [["get_autosync"]])],
683 Get the autosync flag.");
685 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
689 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
691 Verbose messages are disabled unless the environment variable
692 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
694 ("get_verbose", (RBool "verbose", []), -1, [],
698 This returns the verbose messages flag.");
700 ("is_ready", (RBool "ready", []), -1, [],
701 [InitNone, Always, TestOutputTrue (
703 "is ready to accept commands",
705 This returns true iff this handle is ready to accept commands
706 (in the C<READY> state).
708 For more information on states, see L<guestfs(3)>.");
710 ("is_config", (RBool "config", []), -1, [],
711 [InitNone, Always, TestOutputFalse (
713 "is in configuration state",
715 This returns true iff this handle is being configured
716 (in the C<CONFIG> state).
718 For more information on states, see L<guestfs(3)>.");
720 ("is_launching", (RBool "launching", []), -1, [],
721 [InitNone, Always, TestOutputFalse (
722 [["is_launching"]])],
723 "is launching subprocess",
725 This returns true iff this handle is launching the subprocess
726 (in the C<LAUNCHING> state).
728 For more information on states, see L<guestfs(3)>.");
730 ("is_busy", (RBool "busy", []), -1, [],
731 [InitNone, Always, TestOutputFalse (
733 "is busy processing a command",
735 This returns true iff this handle is busy processing a command
736 (in the C<BUSY> state).
738 For more information on states, see L<guestfs(3)>.");
740 ("get_state", (RInt "state", []), -1, [],
742 "get the current state",
744 This returns the current state as an opaque integer. This is
745 only useful for printing debug and internal error messages.
747 For more information on states, see L<guestfs(3)>.");
749 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
750 [InitNone, Always, TestOutputInt (
751 [["set_memsize"; "500"];
752 ["get_memsize"]], 500)],
753 "set memory allocated to the qemu subprocess",
755 This sets the memory size in megabytes allocated to the
756 qemu subprocess. This only has any effect if called before
759 You can also change this by setting the environment
760 variable C<LIBGUESTFS_MEMSIZE> before the handle is
763 For more information on the architecture of libguestfs,
764 see L<guestfs(3)>.");
766 ("get_memsize", (RInt "memsize", []), -1, [],
767 [InitNone, Always, TestOutputIntOp (
768 [["get_memsize"]], ">=", 256)],
769 "get memory allocated to the qemu subprocess",
771 This gets the memory size in megabytes allocated to the
774 If C<guestfs_set_memsize> was not called
775 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
776 then this returns the compiled-in default value for memsize.
778 For more information on the architecture of libguestfs,
779 see L<guestfs(3)>.");
781 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
782 [InitNone, Always, TestOutputIntOp (
783 [["get_pid"]], ">=", 1)],
784 "get PID of qemu subprocess",
786 Return the process ID of the qemu subprocess. If there is no
787 qemu subprocess, then this will return an error.
789 This is an internal call used for debugging and testing.");
791 ("version", (RStruct ("version", "version"), []), -1, [],
792 [InitNone, Always, TestOutputStruct (
793 [["version"]], [CompareWithInt ("major", 1)])],
794 "get the library version number",
796 Return the libguestfs version number that the program is linked
799 Note that because of dynamic linking this is not necessarily
800 the version of libguestfs that you compiled against. You can
801 compile the program, and then at runtime dynamically link
802 against a completely different C<libguestfs.so> library.
804 This call was added in version C<1.0.58>. In previous
805 versions of libguestfs there was no way to get the version
806 number. From C code you can use dynamic linker functions
807 to find out if this symbol exists (if it doesn't, then
808 it's an earlier version).
810 The call returns a structure with four elements. The first
811 three (C<major>, C<minor> and C<release>) are numbers and
812 correspond to the usual version triplet. The fourth element
813 (C<extra>) is a string and is normally empty, but may be
814 used for distro-specific information.
816 To construct the original version string:
817 C<$major.$minor.$release$extra>
819 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
821 I<Note:> Don't use this call to test for availability
822 of features. In enterprise distributions we backport
823 features from later versions into earlier versions,
824 making this an unreliable way to test for features.
825 Use C<guestfs_available> instead.");
827 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
828 [InitNone, Always, TestOutputTrue (
829 [["set_selinux"; "true"];
831 "set SELinux enabled or disabled at appliance boot",
833 This sets the selinux flag that is passed to the appliance
834 at boot time. The default is C<selinux=0> (disabled).
836 Note that if SELinux is enabled, it is always in
837 Permissive mode (C<enforcing=0>).
839 For more information on the architecture of libguestfs,
840 see L<guestfs(3)>.");
842 ("get_selinux", (RBool "selinux", []), -1, [],
844 "get SELinux enabled flag",
846 This returns the current setting of the selinux flag which
847 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
849 For more information on the architecture of libguestfs,
850 see L<guestfs(3)>.");
852 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
853 [InitNone, Always, TestOutputFalse (
854 [["set_trace"; "false"];
856 "enable or disable command traces",
858 If the command trace flag is set to 1, then commands are
859 printed on stderr before they are executed in a format
860 which is very similar to the one used by guestfish. In
861 other words, you can run a program with this enabled, and
862 you will get out a script which you can feed to guestfish
863 to perform the same set of actions.
865 If you want to trace C API calls into libguestfs (and
866 other libraries) then possibly a better way is to use
867 the external ltrace(1) command.
869 Command traces are disabled unless the environment variable
870 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
872 ("get_trace", (RBool "trace", []), -1, [],
874 "get command trace enabled flag",
876 Return the command trace flag.");
878 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
879 [InitNone, Always, TestOutputFalse (
880 [["set_direct"; "false"];
882 "enable or disable direct appliance mode",
884 If the direct appliance mode flag is enabled, then stdin and
885 stdout are passed directly through to the appliance once it
888 One consequence of this is that log messages aren't caught
889 by the library and handled by C<guestfs_set_log_message_callback>,
890 but go straight to stdout.
892 You probably don't want to use this unless you know what you
895 The default is disabled.");
897 ("get_direct", (RBool "direct", []), -1, [],
899 "get direct appliance mode flag",
901 Return the direct appliance mode flag.");
903 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
904 [InitNone, Always, TestOutputTrue (
905 [["set_recovery_proc"; "true"];
906 ["get_recovery_proc"]])],
907 "enable or disable the recovery process",
909 If this is called with the parameter C<false> then
910 C<guestfs_launch> does not create a recovery process. The
911 purpose of the recovery process is to stop runaway qemu
912 processes in the case where the main program aborts abruptly.
914 This only has any effect if called before C<guestfs_launch>,
915 and the default is true.
917 About the only time when you would want to disable this is
918 if the main process will fork itself into the background
919 (\"daemonize\" itself). In this case the recovery process
920 thinks that the main program has disappeared and so kills
921 qemu, which is not very helpful.");
923 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
925 "get recovery process enabled flag",
927 Return the recovery process enabled flag.");
929 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
931 "add a drive specifying the QEMU block emulation to use",
933 This is the same as C<guestfs_add_drive> but it allows you
934 to specify the QEMU interface emulation to use at run time.");
936 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
938 "add a drive read-only specifying the QEMU block emulation to use",
940 This is the same as C<guestfs_add_drive_ro> but it allows you
941 to specify the QEMU interface emulation to use at run time.");
943 ("file_architecture", (RString "arch", [Pathname "filename"]), -1, [],
944 [InitISOFS, Always, TestOutput (
945 [["file_architecture"; "/bin-i586-dynamic"]], "i386");
946 InitISOFS, Always, TestOutput (
947 [["file_architecture"; "/bin-sparc-dynamic"]], "sparc");
948 InitISOFS, Always, TestOutput (
949 [["file_architecture"; "/bin-win32.exe"]], "i386");
950 InitISOFS, Always, TestOutput (
951 [["file_architecture"; "/bin-win64.exe"]], "x86_64");
952 InitISOFS, Always, TestOutput (
953 [["file_architecture"; "/bin-x86_64-dynamic"]], "x86_64");
954 InitISOFS, Always, TestOutput (
955 [["file_architecture"; "/lib-i586.so"]], "i386");
956 InitISOFS, Always, TestOutput (
957 [["file_architecture"; "/lib-sparc.so"]], "sparc");
958 InitISOFS, Always, TestOutput (
959 [["file_architecture"; "/lib-win32.dll"]], "i386");
960 InitISOFS, Always, TestOutput (
961 [["file_architecture"; "/lib-win64.dll"]], "x86_64");
962 InitISOFS, Always, TestOutput (
963 [["file_architecture"; "/lib-x86_64.so"]], "x86_64");
964 InitISOFS, Always, TestOutput (
965 [["file_architecture"; "/initrd-x86_64.img"]], "x86_64");
966 InitISOFS, Always, TestOutput (
967 [["file_architecture"; "/initrd-x86_64.img.gz"]], "x86_64");],
968 "detect the architecture of a binary file",
970 This detects the architecture of the binary C<filename>,
971 and returns it if known.
973 Currently defined architectures are:
979 This string is returned for all 32 bit i386, i486, i586, i686 binaries
980 irrespective of the precise processor requirements of the binary.
992 64 bit SPARC V9 and above.
1008 Libguestfs may return other architecture strings in future.
1010 The function works on at least the following types of files:
1016 many types of Un*x and Linux binary
1020 many types of Un*x and Linux shared library
1024 Windows Win32 and Win64 binaries
1028 Windows Win32 and Win64 DLLs
1030 Win32 binaries and DLLs return C<i386>.
1032 Win64 binaries and DLLs return C<x86_64>.
1036 Linux kernel modules
1040 Linux new-style initrd images
1044 some non-x86 Linux vmlinuz kernels
1048 What it can't do currently:
1054 static libraries (libfoo.a)
1058 Linux old-style initrd as compressed ext2 filesystem (RHEL 3)
1062 x86 Linux vmlinuz kernels
1064 x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and
1065 compressed code, and are horribly hard to unpack. If you want to find
1066 the architecture of a kernel, use the architecture of the associated
1067 initrd or kernel module(s) instead.
1071 ("inspect_os", (RStringList "roots", []), -1, [],
1073 "inspect disk and return list of operating systems found",
1075 This function uses other libguestfs functions and certain
1076 heuristics to inspect the disk(s) (usually disks belonging to
1077 a virtual machine), looking for operating systems.
1079 The list returned is empty if no operating systems were found.
1081 If one operating system was found, then this returns a list with
1082 a single element, which is the name of the root filesystem of
1083 this operating system. It is also possible for this function
1084 to return a list containing more than one element, indicating
1085 a dual-boot or multi-boot virtual machine, with each element being
1086 the root filesystem of one of the operating systems.
1088 You can pass the root string(s) returned to other
1089 C<guestfs_inspect_get_*> functions in order to query further
1090 information about each operating system, such as the name
1093 This function uses other libguestfs features such as
1094 C<guestfs_mount_ro> and C<guestfs_umount_all> in order to mount
1095 and unmount filesystems and look at the contents. This should
1096 be called with no disks currently mounted. The function may also
1097 use Augeas, so any existing Augeas handle will be closed.
1099 This function cannot decrypt encrypted disks. The caller
1100 must do that first (supplying the necessary keys) if the
1103 Please read L<guestfs(3)/INSPECTION> for more details.");
1105 ("inspect_get_type", (RString "name", [Device "root"]), -1, [],
1107 "get type of inspected operating system",
1109 This function should only be called with a root device string
1110 as returned by C<guestfs_inspect_os>.
1112 This returns the type of the inspected operating system.
1113 Currently defined types are:
1119 Any Linux-based operating system.
1123 Any Microsoft Windows operating system.
1127 The operating system type could not be determined.
1131 Future versions of libguestfs may return other strings here.
1132 The caller should be prepared to handle any string.
1134 Please read L<guestfs(3)/INSPECTION> for more details.");
1136 ("inspect_get_arch", (RString "arch", [Device "root"]), -1, [],
1138 "get architecture of inspected operating system",
1140 This function should only be called with a root device string
1141 as returned by C<guestfs_inspect_os>.
1143 This returns the architecture of the inspected operating system.
1144 The possible return values are listed under
1145 C<guestfs_file_architecture>.
1147 If the architecture could not be determined, then the
1148 string C<unknown> is returned.
1150 Please read L<guestfs(3)/INSPECTION> for more details.");
1152 ("inspect_get_distro", (RString "distro", [Device "root"]), -1, [],
1154 "get distro of inspected operating system",
1156 This function should only be called with a root device string
1157 as returned by C<guestfs_inspect_os>.
1159 This returns the distro (distribution) of the inspected operating
1162 Currently defined distros are:
1168 Debian or a Debian-derived distro such as Ubuntu.
1174 =item \"redhat-based\"
1176 Some Red Hat-derived distro.
1180 Red Hat Enterprise Linux and some derivatives.
1184 Windows does not have distributions. This string is
1185 returned if the OS type is Windows.
1189 The distro could not be determined.
1193 Future versions of libguestfs may return other strings here.
1194 The caller should be prepared to handle any string.
1196 Please read L<guestfs(3)/INSPECTION> for more details.");
1198 ("inspect_get_major_version", (RInt "major", [Device "root"]), -1, [],
1200 "get major version of inspected operating system",
1202 This function should only be called with a root device string
1203 as returned by C<guestfs_inspect_os>.
1205 This returns the major version number of the inspected operating
1208 Windows uses a consistent versioning scheme which is I<not>
1209 reflected in the popular public names used by the operating system.
1210 Notably the operating system known as \"Windows 7\" is really
1211 version 6.1 (ie. major = 6, minor = 1). You can find out the
1212 real versions corresponding to releases of Windows by consulting
1215 If the version could not be determined, then C<0> is returned.
1217 Please read L<guestfs(3)/INSPECTION> for more details.");
1219 ("inspect_get_minor_version", (RInt "minor", [Device "root"]), -1, [],
1221 "get minor version of inspected operating system",
1223 This function should only be called with a root device string
1224 as returned by C<guestfs_inspect_os>.
1226 This returns the minor version number of the inspected operating
1229 If the version could not be determined, then C<0> is returned.
1231 Please read L<guestfs(3)/INSPECTION> for more details.
1232 See also C<guestfs_inspect_get_major_version>.");
1234 ("inspect_get_product_name", (RString "product", [Device "root"]), -1, [],
1236 "get product name of inspected operating system",
1238 This function should only be called with a root device string
1239 as returned by C<guestfs_inspect_os>.
1241 This returns the product name of the inspected operating
1242 system. The product name is generally some freeform string
1243 which can be displayed to the user, but should not be
1246 If the product name could not be determined, then the
1247 string C<unknown> is returned.
1249 Please read L<guestfs(3)/INSPECTION> for more details.");
1251 ("inspect_get_mountpoints", (RHashtable "mountpoints", [Device "root"]), -1, [],
1253 "get mountpoints of inspected operating system",
1255 This function should only be called with a root device string
1256 as returned by C<guestfs_inspect_os>.
1258 This returns a hash of where we think the filesystems
1259 associated with this operating system should be mounted.
1260 Callers should note that this is at best an educated guess
1261 made by reading configuration files such as C</etc/fstab>.
1263 Each element in the returned hashtable has a key which
1264 is the path of the mountpoint (eg. C</boot>) and a value
1265 which is the filesystem that would be mounted there
1268 Non-mounted devices such as swap devices are I<not>
1269 returned in this list.
1271 Please read L<guestfs(3)/INSPECTION> for more details.
1272 See also C<guestfs_inspect_get_filesystems>.");
1274 ("inspect_get_filesystems", (RStringList "filesystems", [Device "root"]), -1, [],
1276 "get filesystems associated with inspected operating system",
1278 This function should only be called with a root device string
1279 as returned by C<guestfs_inspect_os>.
1281 This returns a list of all the filesystems that we think
1282 are associated with this operating system. This includes
1283 the root filesystem, other ordinary filesystems, and
1284 non-mounted devices like swap partitions.
1286 In the case of a multi-boot virtual machine, it is possible
1287 for a filesystem to be shared between operating systems.
1289 Please read L<guestfs(3)/INSPECTION> for more details.
1290 See also C<guestfs_inspect_get_mountpoints>.");
1294 (* daemon_functions are any functions which cause some action
1295 * to take place in the daemon.
1298 let daemon_functions = [
1299 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
1300 [InitEmpty, Always, TestOutput (
1301 [["part_disk"; "/dev/sda"; "mbr"];
1302 ["mkfs"; "ext2"; "/dev/sda1"];
1303 ["mount"; "/dev/sda1"; "/"];
1304 ["write"; "/new"; "new file contents"];
1305 ["cat"; "/new"]], "new file contents")],
1306 "mount a guest disk at a position in the filesystem",
1308 Mount a guest disk at a position in the filesystem. Block devices
1309 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1310 the guest. If those block devices contain partitions, they will have
1311 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1314 The rules are the same as for L<mount(2)>: A filesystem must
1315 first be mounted on C</> before others can be mounted. Other
1316 filesystems can only be mounted on directories which already
1319 The mounted filesystem is writable, if we have sufficient permissions
1320 on the underlying device.
1323 When you use this call, the filesystem options C<sync> and C<noatime>
1324 are set implicitly. This was originally done because we thought it
1325 would improve reliability, but it turns out that I<-o sync> has a
1326 very large negative performance impact and negligible effect on
1327 reliability. Therefore we recommend that you avoid using
1328 C<guestfs_mount> in any code that needs performance, and instead
1329 use C<guestfs_mount_options> (use an empty string for the first
1330 parameter if you don't want any options).");
1332 ("sync", (RErr, []), 2, [],
1333 [ InitEmpty, Always, TestRun [["sync"]]],
1334 "sync disks, writes are flushed through to the disk image",
1336 This syncs the disk, so that any writes are flushed through to the
1337 underlying disk image.
1339 You should always call this if you have modified a disk image, before
1340 closing the handle.");
1342 ("touch", (RErr, [Pathname "path"]), 3, [],
1343 [InitBasicFS, Always, TestOutputTrue (
1345 ["exists"; "/new"]])],
1346 "update file timestamps or create a new file",
1348 Touch acts like the L<touch(1)> command. It can be used to
1349 update the timestamps on a file, or, if the file does not exist,
1350 to create a new zero-length file.
1352 This command only works on regular files, and will fail on other
1353 file types such as directories, symbolic links, block special etc.");
1355 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
1356 [InitISOFS, Always, TestOutput (
1357 [["cat"; "/known-2"]], "abcdef\n")],
1358 "list the contents of a file",
1360 Return the contents of the file named C<path>.
1362 Note that this function cannot correctly handle binary files
1363 (specifically, files containing C<\\0> character which is treated
1364 as end of string). For those you need to use the C<guestfs_read_file>
1365 or C<guestfs_download> functions which have a more complex interface.");
1367 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1368 [], (* XXX Tricky to test because it depends on the exact format
1369 * of the 'ls -l' command, which changes between F10 and F11.
1371 "list the files in a directory (long format)",
1373 List the files in C<directory> (relative to the root directory,
1374 there is no cwd) in the format of 'ls -la'.
1376 This command is mostly useful for interactive sessions. It
1377 is I<not> intended that you try to parse the output string.");
1379 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1380 [InitBasicFS, Always, TestOutputList (
1382 ["touch"; "/newer"];
1383 ["touch"; "/newest"];
1384 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1385 "list the files in a directory",
1387 List the files in C<directory> (relative to the root directory,
1388 there is no cwd). The '.' and '..' entries are not returned, but
1389 hidden files are shown.
1391 This command is mostly useful for interactive sessions. Programs
1392 should probably use C<guestfs_readdir> instead.");
1394 ("list_devices", (RStringList "devices", []), 7, [],
1395 [InitEmpty, Always, TestOutputListOfDevices (
1396 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1397 "list the block devices",
1399 List all the block devices.
1401 The full block device names are returned, eg. C</dev/sda>");
1403 ("list_partitions", (RStringList "partitions", []), 8, [],
1404 [InitBasicFS, Always, TestOutputListOfDevices (
1405 [["list_partitions"]], ["/dev/sda1"]);
1406 InitEmpty, Always, TestOutputListOfDevices (
1407 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1408 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1409 "list the partitions",
1411 List all the partitions detected on all block devices.
1413 The full partition device names are returned, eg. C</dev/sda1>
1415 This does not return logical volumes. For that you will need to
1416 call C<guestfs_lvs>.");
1418 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1419 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1420 [["pvs"]], ["/dev/sda1"]);
1421 InitEmpty, Always, TestOutputListOfDevices (
1422 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1423 ["pvcreate"; "/dev/sda1"];
1424 ["pvcreate"; "/dev/sda2"];
1425 ["pvcreate"; "/dev/sda3"];
1426 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1427 "list the LVM physical volumes (PVs)",
1429 List all the physical volumes detected. This is the equivalent
1430 of the L<pvs(8)> command.
1432 This returns a list of just the device names that contain
1433 PVs (eg. C</dev/sda2>).
1435 See also C<guestfs_pvs_full>.");
1437 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1438 [InitBasicFSonLVM, Always, TestOutputList (
1440 InitEmpty, Always, TestOutputList (
1441 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1442 ["pvcreate"; "/dev/sda1"];
1443 ["pvcreate"; "/dev/sda2"];
1444 ["pvcreate"; "/dev/sda3"];
1445 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1446 ["vgcreate"; "VG2"; "/dev/sda3"];
1447 ["vgs"]], ["VG1"; "VG2"])],
1448 "list the LVM volume groups (VGs)",
1450 List all the volumes groups detected. This is the equivalent
1451 of the L<vgs(8)> command.
1453 This returns a list of just the volume group names that were
1454 detected (eg. C<VolGroup00>).
1456 See also C<guestfs_vgs_full>.");
1458 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1459 [InitBasicFSonLVM, Always, TestOutputList (
1460 [["lvs"]], ["/dev/VG/LV"]);
1461 InitEmpty, Always, TestOutputList (
1462 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1463 ["pvcreate"; "/dev/sda1"];
1464 ["pvcreate"; "/dev/sda2"];
1465 ["pvcreate"; "/dev/sda3"];
1466 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1467 ["vgcreate"; "VG2"; "/dev/sda3"];
1468 ["lvcreate"; "LV1"; "VG1"; "50"];
1469 ["lvcreate"; "LV2"; "VG1"; "50"];
1470 ["lvcreate"; "LV3"; "VG2"; "50"];
1471 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1472 "list the LVM logical volumes (LVs)",
1474 List all the logical volumes detected. This is the equivalent
1475 of the L<lvs(8)> command.
1477 This returns a list of the logical volume device names
1478 (eg. C</dev/VolGroup00/LogVol00>).
1480 See also C<guestfs_lvs_full>.");
1482 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1483 [], (* XXX how to test? *)
1484 "list the LVM physical volumes (PVs)",
1486 List all the physical volumes detected. This is the equivalent
1487 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1489 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1490 [], (* XXX how to test? *)
1491 "list the LVM volume groups (VGs)",
1493 List all the volumes groups detected. This is the equivalent
1494 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1496 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1497 [], (* XXX how to test? *)
1498 "list the LVM logical volumes (LVs)",
1500 List all the logical volumes detected. This is the equivalent
1501 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1503 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1504 [InitISOFS, Always, TestOutputList (
1505 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1506 InitISOFS, Always, TestOutputList (
1507 [["read_lines"; "/empty"]], [])],
1508 "read file as lines",
1510 Return the contents of the file named C<path>.
1512 The file contents are returned as a list of lines. Trailing
1513 C<LF> and C<CRLF> character sequences are I<not> returned.
1515 Note that this function cannot correctly handle binary files
1516 (specifically, files containing C<\\0> character which is treated
1517 as end of line). For those you need to use the C<guestfs_read_file>
1518 function which has a more complex interface.");
1520 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1521 [], (* XXX Augeas code needs tests. *)
1522 "create a new Augeas handle",
1524 Create a new Augeas handle for editing configuration files.
1525 If there was any previous Augeas handle associated with this
1526 guestfs session, then it is closed.
1528 You must call this before using any other C<guestfs_aug_*>
1531 C<root> is the filesystem root. C<root> must not be NULL,
1534 The flags are the same as the flags defined in
1535 E<lt>augeas.hE<gt>, the logical I<or> of the following
1540 =item C<AUG_SAVE_BACKUP> = 1
1542 Keep the original file with a C<.augsave> extension.
1544 =item C<AUG_SAVE_NEWFILE> = 2
1546 Save changes into a file with extension C<.augnew>, and
1547 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1549 =item C<AUG_TYPE_CHECK> = 4
1551 Typecheck lenses (can be expensive).
1553 =item C<AUG_NO_STDINC> = 8
1555 Do not use standard load path for modules.
1557 =item C<AUG_SAVE_NOOP> = 16
1559 Make save a no-op, just record what would have been changed.
1561 =item C<AUG_NO_LOAD> = 32
1563 Do not load the tree in C<guestfs_aug_init>.
1567 To close the handle, you can call C<guestfs_aug_close>.
1569 To find out more about Augeas, see L<http://augeas.net/>.");
1571 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1572 [], (* XXX Augeas code needs tests. *)
1573 "close the current Augeas handle",
1575 Close the current Augeas handle and free up any resources
1576 used by it. After calling this, you have to call
1577 C<guestfs_aug_init> again before you can use any other
1578 Augeas functions.");
1580 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1581 [], (* XXX Augeas code needs tests. *)
1582 "define an Augeas variable",
1584 Defines an Augeas variable C<name> whose value is the result
1585 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1588 On success this returns the number of nodes in C<expr>, or
1589 C<0> if C<expr> evaluates to something which is not a nodeset.");
1591 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1592 [], (* XXX Augeas code needs tests. *)
1593 "define an Augeas node",
1595 Defines a variable C<name> whose value is the result of
1598 If C<expr> evaluates to an empty nodeset, a node is created,
1599 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1600 C<name> will be the nodeset containing that single node.
1602 On success this returns a pair containing the
1603 number of nodes in the nodeset, and a boolean flag
1604 if a node was created.");
1606 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1607 [], (* XXX Augeas code needs tests. *)
1608 "look up the value of an Augeas path",
1610 Look up the value associated with C<path>. If C<path>
1611 matches exactly one node, the C<value> is returned.");
1613 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1614 [], (* XXX Augeas code needs tests. *)
1615 "set Augeas path to value",
1617 Set the value associated with C<path> to C<val>.
1619 In the Augeas API, it is possible to clear a node by setting
1620 the value to NULL. Due to an oversight in the libguestfs API
1621 you cannot do that with this call. Instead you must use the
1622 C<guestfs_aug_clear> call.");
1624 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1625 [], (* XXX Augeas code needs tests. *)
1626 "insert a sibling Augeas node",
1628 Create a new sibling C<label> for C<path>, inserting it into
1629 the tree before or after C<path> (depending on the boolean
1632 C<path> must match exactly one existing node in the tree, and
1633 C<label> must be a label, ie. not contain C</>, C<*> or end
1634 with a bracketed index C<[N]>.");
1636 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1637 [], (* XXX Augeas code needs tests. *)
1638 "remove an Augeas path",
1640 Remove C<path> and all of its children.
1642 On success this returns the number of entries which were removed.");
1644 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1645 [], (* XXX Augeas code needs tests. *)
1648 Move the node C<src> to C<dest>. C<src> must match exactly
1649 one node. C<dest> is overwritten if it exists.");
1651 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1652 [], (* XXX Augeas code needs tests. *)
1653 "return Augeas nodes which match augpath",
1655 Returns a list of paths which match the path expression C<path>.
1656 The returned paths are sufficiently qualified so that they match
1657 exactly one node in the current tree.");
1659 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1660 [], (* XXX Augeas code needs tests. *)
1661 "write all pending Augeas changes to disk",
1663 This writes all pending changes to disk.
1665 The flags which were passed to C<guestfs_aug_init> affect exactly
1666 how files are saved.");
1668 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1669 [], (* XXX Augeas code needs tests. *)
1670 "load files into the tree",
1672 Load files into the tree.
1674 See C<aug_load> in the Augeas documentation for the full gory
1677 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1678 [], (* XXX Augeas code needs tests. *)
1679 "list Augeas nodes under augpath",
1681 This is just a shortcut for listing C<guestfs_aug_match>
1682 C<path/*> and sorting the resulting nodes into alphabetical order.");
1684 ("rm", (RErr, [Pathname "path"]), 29, [],
1685 [InitBasicFS, Always, TestRun
1688 InitBasicFS, Always, TestLastFail
1690 InitBasicFS, Always, TestLastFail
1695 Remove the single file C<path>.");
1697 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1698 [InitBasicFS, Always, TestRun
1701 InitBasicFS, Always, TestLastFail
1702 [["rmdir"; "/new"]];
1703 InitBasicFS, Always, TestLastFail
1705 ["rmdir"; "/new"]]],
1706 "remove a directory",
1708 Remove the single directory C<path>.");
1710 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1711 [InitBasicFS, Always, TestOutputFalse
1713 ["mkdir"; "/new/foo"];
1714 ["touch"; "/new/foo/bar"];
1716 ["exists"; "/new"]]],
1717 "remove a file or directory recursively",
1719 Remove the file or directory C<path>, recursively removing the
1720 contents if its a directory. This is like the C<rm -rf> shell
1723 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1724 [InitBasicFS, Always, TestOutputTrue
1726 ["is_dir"; "/new"]];
1727 InitBasicFS, Always, TestLastFail
1728 [["mkdir"; "/new/foo/bar"]]],
1729 "create a directory",
1731 Create a directory named C<path>.");
1733 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1734 [InitBasicFS, Always, TestOutputTrue
1735 [["mkdir_p"; "/new/foo/bar"];
1736 ["is_dir"; "/new/foo/bar"]];
1737 InitBasicFS, Always, TestOutputTrue
1738 [["mkdir_p"; "/new/foo/bar"];
1739 ["is_dir"; "/new/foo"]];
1740 InitBasicFS, Always, TestOutputTrue
1741 [["mkdir_p"; "/new/foo/bar"];
1742 ["is_dir"; "/new"]];
1743 (* Regression tests for RHBZ#503133: *)
1744 InitBasicFS, Always, TestRun
1746 ["mkdir_p"; "/new"]];
1747 InitBasicFS, Always, TestLastFail
1749 ["mkdir_p"; "/new"]]],
1750 "create a directory and parents",
1752 Create a directory named C<path>, creating any parent directories
1753 as necessary. This is like the C<mkdir -p> shell command.");
1755 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1756 [], (* XXX Need stat command to test *)
1759 Change the mode (permissions) of C<path> to C<mode>. Only
1760 numeric modes are supported.
1762 I<Note>: When using this command from guestfish, C<mode>
1763 by default would be decimal, unless you prefix it with
1764 C<0> to get octal, ie. use C<0700> not C<700>.
1766 The mode actually set is affected by the umask.");
1768 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1769 [], (* XXX Need stat command to test *)
1770 "change file owner and group",
1772 Change the file owner to C<owner> and group to C<group>.
1774 Only numeric uid and gid are supported. If you want to use
1775 names, you will need to locate and parse the password file
1776 yourself (Augeas support makes this relatively easy).");
1778 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1779 [InitISOFS, Always, TestOutputTrue (
1780 [["exists"; "/empty"]]);
1781 InitISOFS, Always, TestOutputTrue (
1782 [["exists"; "/directory"]])],
1783 "test if file or directory exists",
1785 This returns C<true> if and only if there is a file, directory
1786 (or anything) with the given C<path> name.
1788 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1790 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1791 [InitISOFS, Always, TestOutputTrue (
1792 [["is_file"; "/known-1"]]);
1793 InitISOFS, Always, TestOutputFalse (
1794 [["is_file"; "/directory"]])],
1795 "test if file exists",
1797 This returns C<true> if and only if there is a file
1798 with the given C<path> name. Note that it returns false for
1799 other objects like directories.
1801 See also C<guestfs_stat>.");
1803 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1804 [InitISOFS, Always, TestOutputFalse (
1805 [["is_dir"; "/known-3"]]);
1806 InitISOFS, Always, TestOutputTrue (
1807 [["is_dir"; "/directory"]])],
1808 "test if file exists",
1810 This returns C<true> if and only if there is a directory
1811 with the given C<path> name. Note that it returns false for
1812 other objects like files.
1814 See also C<guestfs_stat>.");
1816 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1817 [InitEmpty, Always, TestOutputListOfDevices (
1818 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1819 ["pvcreate"; "/dev/sda1"];
1820 ["pvcreate"; "/dev/sda2"];
1821 ["pvcreate"; "/dev/sda3"];
1822 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1823 "create an LVM physical volume",
1825 This creates an LVM physical volume on the named C<device>,
1826 where C<device> should usually be a partition name such
1829 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1830 [InitEmpty, Always, TestOutputList (
1831 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1832 ["pvcreate"; "/dev/sda1"];
1833 ["pvcreate"; "/dev/sda2"];
1834 ["pvcreate"; "/dev/sda3"];
1835 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1836 ["vgcreate"; "VG2"; "/dev/sda3"];
1837 ["vgs"]], ["VG1"; "VG2"])],
1838 "create an LVM volume group",
1840 This creates an LVM volume group called C<volgroup>
1841 from the non-empty list of physical volumes C<physvols>.");
1843 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1844 [InitEmpty, Always, TestOutputList (
1845 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1846 ["pvcreate"; "/dev/sda1"];
1847 ["pvcreate"; "/dev/sda2"];
1848 ["pvcreate"; "/dev/sda3"];
1849 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1850 ["vgcreate"; "VG2"; "/dev/sda3"];
1851 ["lvcreate"; "LV1"; "VG1"; "50"];
1852 ["lvcreate"; "LV2"; "VG1"; "50"];
1853 ["lvcreate"; "LV3"; "VG2"; "50"];
1854 ["lvcreate"; "LV4"; "VG2"; "50"];
1855 ["lvcreate"; "LV5"; "VG2"; "50"];
1857 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1858 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1859 "create an LVM logical volume",
1861 This creates an LVM logical volume called C<logvol>
1862 on the volume group C<volgroup>, with C<size> megabytes.");
1864 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1865 [InitEmpty, Always, TestOutput (
1866 [["part_disk"; "/dev/sda"; "mbr"];
1867 ["mkfs"; "ext2"; "/dev/sda1"];
1868 ["mount_options"; ""; "/dev/sda1"; "/"];
1869 ["write"; "/new"; "new file contents"];
1870 ["cat"; "/new"]], "new file contents")],
1871 "make a filesystem",
1873 This creates a filesystem on C<device> (usually a partition
1874 or LVM logical volume). The filesystem type is C<fstype>, for
1877 ("sfdisk", (RErr, [Device "device";
1878 Int "cyls"; Int "heads"; Int "sectors";
1879 StringList "lines"]), 43, [DangerWillRobinson],
1881 "create partitions on a block device",
1883 This is a direct interface to the L<sfdisk(8)> program for creating
1884 partitions on block devices.
1886 C<device> should be a block device, for example C</dev/sda>.
1888 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1889 and sectors on the device, which are passed directly to sfdisk as
1890 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1891 of these, then the corresponding parameter is omitted. Usually for
1892 'large' disks, you can just pass C<0> for these, but for small
1893 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1894 out the right geometry and you will need to tell it.
1896 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1897 information refer to the L<sfdisk(8)> manpage.
1899 To create a single partition occupying the whole disk, you would
1900 pass C<lines> as a single element list, when the single element being
1901 the string C<,> (comma).
1903 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1904 C<guestfs_part_init>");
1906 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1907 (* Regression test for RHBZ#597135. *)
1908 [InitBasicFS, Always, TestLastFail
1909 [["write_file"; "/new"; "abc"; "10000"]]],
1912 This call creates a file called C<path>. The contents of the
1913 file is the string C<content> (which can contain any 8 bit data),
1914 with length C<size>.
1916 As a special case, if C<size> is C<0>
1917 then the length is calculated using C<strlen> (so in this case
1918 the content cannot contain embedded ASCII NULs).
1920 I<NB.> Owing to a bug, writing content containing ASCII NUL
1921 characters does I<not> work, even if the length is specified.");
1923 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1924 [InitEmpty, Always, TestOutputListOfDevices (
1925 [["part_disk"; "/dev/sda"; "mbr"];
1926 ["mkfs"; "ext2"; "/dev/sda1"];
1927 ["mount_options"; ""; "/dev/sda1"; "/"];
1928 ["mounts"]], ["/dev/sda1"]);
1929 InitEmpty, Always, TestOutputList (
1930 [["part_disk"; "/dev/sda"; "mbr"];
1931 ["mkfs"; "ext2"; "/dev/sda1"];
1932 ["mount_options"; ""; "/dev/sda1"; "/"];
1935 "unmount a filesystem",
1937 This unmounts the given filesystem. The filesystem may be
1938 specified either by its mountpoint (path) or the device which
1939 contains the filesystem.");
1941 ("mounts", (RStringList "devices", []), 46, [],
1942 [InitBasicFS, Always, TestOutputListOfDevices (
1943 [["mounts"]], ["/dev/sda1"])],
1944 "show mounted filesystems",
1946 This returns the list of currently mounted filesystems. It returns
1947 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1949 Some internal mounts are not shown.
1951 See also: C<guestfs_mountpoints>");
1953 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1954 [InitBasicFS, Always, TestOutputList (
1957 (* check that umount_all can unmount nested mounts correctly: *)
1958 InitEmpty, Always, TestOutputList (
1959 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1960 ["mkfs"; "ext2"; "/dev/sda1"];
1961 ["mkfs"; "ext2"; "/dev/sda2"];
1962 ["mkfs"; "ext2"; "/dev/sda3"];
1963 ["mount_options"; ""; "/dev/sda1"; "/"];
1965 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1966 ["mkdir"; "/mp1/mp2"];
1967 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1968 ["mkdir"; "/mp1/mp2/mp3"];
1971 "unmount all filesystems",
1973 This unmounts all mounted filesystems.
1975 Some internal mounts are not unmounted by this call.");
1977 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1979 "remove all LVM LVs, VGs and PVs",
1981 This command removes all LVM logical volumes, volume groups
1982 and physical volumes.");
1984 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1985 [InitISOFS, Always, TestOutput (
1986 [["file"; "/empty"]], "empty");
1987 InitISOFS, Always, TestOutput (
1988 [["file"; "/known-1"]], "ASCII text");
1989 InitISOFS, Always, TestLastFail (
1990 [["file"; "/notexists"]]);
1991 InitISOFS, Always, TestOutput (
1992 [["file"; "/abssymlink"]], "symbolic link");
1993 InitISOFS, Always, TestOutput (
1994 [["file"; "/directory"]], "directory")],
1995 "determine file type",
1997 This call uses the standard L<file(1)> command to determine
1998 the type or contents of the file.
2000 This call will also transparently look inside various types
2003 The exact command which runs is C<file -zb path>. Note in
2004 particular that the filename is not prepended to the output
2007 This command can also be used on C</dev/> devices
2008 (and partitions, LV names). You can for example use this
2009 to determine if a device contains a filesystem, although
2010 it's usually better to use C<guestfs_vfs_type>.
2012 If the C<path> does not begin with C</dev/> then
2013 this command only works for the content of regular files.
2014 For other file types (directory, symbolic link etc) it
2015 will just return the string C<directory> etc.");
2017 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
2018 [InitBasicFS, Always, TestOutput (
2019 [["upload"; "test-command"; "/test-command"];
2020 ["chmod"; "0o755"; "/test-command"];
2021 ["command"; "/test-command 1"]], "Result1");
2022 InitBasicFS, Always, TestOutput (
2023 [["upload"; "test-command"; "/test-command"];
2024 ["chmod"; "0o755"; "/test-command"];
2025 ["command"; "/test-command 2"]], "Result2\n");
2026 InitBasicFS, Always, TestOutput (
2027 [["upload"; "test-command"; "/test-command"];
2028 ["chmod"; "0o755"; "/test-command"];
2029 ["command"; "/test-command 3"]], "\nResult3");
2030 InitBasicFS, Always, TestOutput (
2031 [["upload"; "test-command"; "/test-command"];
2032 ["chmod"; "0o755"; "/test-command"];
2033 ["command"; "/test-command 4"]], "\nResult4\n");
2034 InitBasicFS, Always, TestOutput (
2035 [["upload"; "test-command"; "/test-command"];
2036 ["chmod"; "0o755"; "/test-command"];
2037 ["command"; "/test-command 5"]], "\nResult5\n\n");
2038 InitBasicFS, Always, TestOutput (
2039 [["upload"; "test-command"; "/test-command"];
2040 ["chmod"; "0o755"; "/test-command"];
2041 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
2042 InitBasicFS, Always, TestOutput (
2043 [["upload"; "test-command"; "/test-command"];
2044 ["chmod"; "0o755"; "/test-command"];
2045 ["command"; "/test-command 7"]], "");
2046 InitBasicFS, Always, TestOutput (
2047 [["upload"; "test-command"; "/test-command"];
2048 ["chmod"; "0o755"; "/test-command"];
2049 ["command"; "/test-command 8"]], "\n");
2050 InitBasicFS, Always, TestOutput (
2051 [["upload"; "test-command"; "/test-command"];
2052 ["chmod"; "0o755"; "/test-command"];
2053 ["command"; "/test-command 9"]], "\n\n");
2054 InitBasicFS, Always, TestOutput (
2055 [["upload"; "test-command"; "/test-command"];
2056 ["chmod"; "0o755"; "/test-command"];
2057 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
2058 InitBasicFS, Always, TestOutput (
2059 [["upload"; "test-command"; "/test-command"];
2060 ["chmod"; "0o755"; "/test-command"];
2061 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
2062 InitBasicFS, Always, TestLastFail (
2063 [["upload"; "test-command"; "/test-command"];
2064 ["chmod"; "0o755"; "/test-command"];
2065 ["command"; "/test-command"]])],
2066 "run a command from the guest filesystem",
2068 This call runs a command from the guest filesystem. The
2069 filesystem must be mounted, and must contain a compatible
2070 operating system (ie. something Linux, with the same
2071 or compatible processor architecture).
2073 The single parameter is an argv-style list of arguments.
2074 The first element is the name of the program to run.
2075 Subsequent elements are parameters. The list must be
2076 non-empty (ie. must contain a program name). Note that
2077 the command runs directly, and is I<not> invoked via
2078 the shell (see C<guestfs_sh>).
2080 The return value is anything printed to I<stdout> by
2083 If the command returns a non-zero exit status, then
2084 this function returns an error message. The error message
2085 string is the content of I<stderr> from the command.
2087 The C<$PATH> environment variable will contain at least
2088 C</usr/bin> and C</bin>. If you require a program from
2089 another location, you should provide the full path in the
2092 Shared libraries and data files required by the program
2093 must be available on filesystems which are mounted in the
2094 correct places. It is the caller's responsibility to ensure
2095 all filesystems that are needed are mounted at the right
2098 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
2099 [InitBasicFS, Always, TestOutputList (
2100 [["upload"; "test-command"; "/test-command"];
2101 ["chmod"; "0o755"; "/test-command"];
2102 ["command_lines"; "/test-command 1"]], ["Result1"]);
2103 InitBasicFS, Always, TestOutputList (
2104 [["upload"; "test-command"; "/test-command"];
2105 ["chmod"; "0o755"; "/test-command"];
2106 ["command_lines"; "/test-command 2"]], ["Result2"]);
2107 InitBasicFS, Always, TestOutputList (
2108 [["upload"; "test-command"; "/test-command"];
2109 ["chmod"; "0o755"; "/test-command"];
2110 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
2111 InitBasicFS, Always, TestOutputList (
2112 [["upload"; "test-command"; "/test-command"];
2113 ["chmod"; "0o755"; "/test-command"];
2114 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
2115 InitBasicFS, Always, TestOutputList (
2116 [["upload"; "test-command"; "/test-command"];
2117 ["chmod"; "0o755"; "/test-command"];
2118 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
2119 InitBasicFS, Always, TestOutputList (
2120 [["upload"; "test-command"; "/test-command"];
2121 ["chmod"; "0o755"; "/test-command"];
2122 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
2123 InitBasicFS, Always, TestOutputList (
2124 [["upload"; "test-command"; "/test-command"];
2125 ["chmod"; "0o755"; "/test-command"];
2126 ["command_lines"; "/test-command 7"]], []);
2127 InitBasicFS, Always, TestOutputList (
2128 [["upload"; "test-command"; "/test-command"];
2129 ["chmod"; "0o755"; "/test-command"];
2130 ["command_lines"; "/test-command 8"]], [""]);
2131 InitBasicFS, Always, TestOutputList (
2132 [["upload"; "test-command"; "/test-command"];
2133 ["chmod"; "0o755"; "/test-command"];
2134 ["command_lines"; "/test-command 9"]], ["";""]);
2135 InitBasicFS, Always, TestOutputList (
2136 [["upload"; "test-command"; "/test-command"];
2137 ["chmod"; "0o755"; "/test-command"];
2138 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
2139 InitBasicFS, Always, TestOutputList (
2140 [["upload"; "test-command"; "/test-command"];
2141 ["chmod"; "0o755"; "/test-command"];
2142 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
2143 "run a command, returning lines",
2145 This is the same as C<guestfs_command>, but splits the
2146 result into a list of lines.
2148 See also: C<guestfs_sh_lines>");
2150 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
2151 [InitISOFS, Always, TestOutputStruct (
2152 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
2153 "get file information",
2155 Returns file information for the given C<path>.
2157 This is the same as the C<stat(2)> system call.");
2159 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
2160 [InitISOFS, Always, TestOutputStruct (
2161 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
2162 "get file information for a symbolic link",
2164 Returns file information for the given C<path>.
2166 This is the same as C<guestfs_stat> except that if C<path>
2167 is a symbolic link, then the link is stat-ed, not the file it
2170 This is the same as the C<lstat(2)> system call.");
2172 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
2173 [InitISOFS, Always, TestOutputStruct (
2174 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
2175 "get file system statistics",
2177 Returns file system statistics for any mounted file system.
2178 C<path> should be a file or directory in the mounted file system
2179 (typically it is the mount point itself, but it doesn't need to be).
2181 This is the same as the C<statvfs(2)> system call.");
2183 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
2185 "get ext2/ext3/ext4 superblock details",
2187 This returns the contents of the ext2, ext3 or ext4 filesystem
2188 superblock on C<device>.
2190 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
2191 manpage for more details. The list of fields returned isn't
2192 clearly defined, and depends on both the version of C<tune2fs>
2193 that libguestfs was built against, and the filesystem itself.");
2195 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
2196 [InitEmpty, Always, TestOutputTrue (
2197 [["blockdev_setro"; "/dev/sda"];
2198 ["blockdev_getro"; "/dev/sda"]])],
2199 "set block device to read-only",
2201 Sets the block device named C<device> to read-only.
2203 This uses the L<blockdev(8)> command.");
2205 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
2206 [InitEmpty, Always, TestOutputFalse (
2207 [["blockdev_setrw"; "/dev/sda"];
2208 ["blockdev_getro"; "/dev/sda"]])],
2209 "set block device to read-write",
2211 Sets the block device named C<device> to read-write.
2213 This uses the L<blockdev(8)> command.");
2215 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
2216 [InitEmpty, Always, TestOutputTrue (
2217 [["blockdev_setro"; "/dev/sda"];
2218 ["blockdev_getro"; "/dev/sda"]])],
2219 "is block device set to read-only",
2221 Returns a boolean indicating if the block device is read-only
2222 (true if read-only, false if not).
2224 This uses the L<blockdev(8)> command.");
2226 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
2227 [InitEmpty, Always, TestOutputInt (
2228 [["blockdev_getss"; "/dev/sda"]], 512)],
2229 "get sectorsize of block device",
2231 This returns the size of sectors on a block device.
2232 Usually 512, but can be larger for modern devices.
2234 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
2237 This uses the L<blockdev(8)> command.");
2239 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
2240 [InitEmpty, Always, TestOutputInt (
2241 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
2242 "get blocksize of block device",
2244 This returns the block size of a device.
2246 (Note this is different from both I<size in blocks> and
2247 I<filesystem block size>).
2249 This uses the L<blockdev(8)> command.");
2251 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
2253 "set blocksize of block device",
2255 This sets the block size of a device.
2257 (Note this is different from both I<size in blocks> and
2258 I<filesystem block size>).
2260 This uses the L<blockdev(8)> command.");
2262 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
2263 [InitEmpty, Always, TestOutputInt (
2264 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
2265 "get total size of device in 512-byte sectors",
2267 This returns the size of the device in units of 512-byte sectors
2268 (even if the sectorsize isn't 512 bytes ... weird).
2270 See also C<guestfs_blockdev_getss> for the real sector size of
2271 the device, and C<guestfs_blockdev_getsize64> for the more
2272 useful I<size in bytes>.
2274 This uses the L<blockdev(8)> command.");
2276 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
2277 [InitEmpty, Always, TestOutputInt (
2278 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
2279 "get total size of device in bytes",
2281 This returns the size of the device in bytes.
2283 See also C<guestfs_blockdev_getsz>.
2285 This uses the L<blockdev(8)> command.");
2287 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
2288 [InitEmpty, Always, TestRun
2289 [["blockdev_flushbufs"; "/dev/sda"]]],
2290 "flush device buffers",
2292 This tells the kernel to flush internal buffers associated
2295 This uses the L<blockdev(8)> command.");
2297 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
2298 [InitEmpty, Always, TestRun
2299 [["blockdev_rereadpt"; "/dev/sda"]]],
2300 "reread partition table",
2302 Reread the partition table on C<device>.
2304 This uses the L<blockdev(8)> command.");
2306 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
2307 [InitBasicFS, Always, TestOutput (
2308 (* Pick a file from cwd which isn't likely to change. *)
2309 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2310 ["checksum"; "md5"; "/COPYING.LIB"]],
2311 Digest.to_hex (Digest.file "COPYING.LIB"))],
2312 "upload a file from the local machine",
2314 Upload local file C<filename> to C<remotefilename> on the
2317 C<filename> can also be a named pipe.
2319 See also C<guestfs_download>.");
2321 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
2322 [InitBasicFS, Always, TestOutput (
2323 (* Pick a file from cwd which isn't likely to change. *)
2324 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
2325 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
2326 ["upload"; "testdownload.tmp"; "/upload"];
2327 ["checksum"; "md5"; "/upload"]],
2328 Digest.to_hex (Digest.file "COPYING.LIB"))],
2329 "download a file to the local machine",
2331 Download file C<remotefilename> and save it as C<filename>
2332 on the local machine.
2334 C<filename> can also be a named pipe.
2336 See also C<guestfs_upload>, C<guestfs_cat>.");
2338 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
2339 [InitISOFS, Always, TestOutput (
2340 [["checksum"; "crc"; "/known-3"]], "2891671662");
2341 InitISOFS, Always, TestLastFail (
2342 [["checksum"; "crc"; "/notexists"]]);
2343 InitISOFS, Always, TestOutput (
2344 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
2345 InitISOFS, Always, TestOutput (
2346 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2347 InitISOFS, Always, TestOutput (
2348 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2349 InitISOFS, Always, TestOutput (
2350 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2351 InitISOFS, Always, TestOutput (
2352 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2353 InitISOFS, Always, TestOutput (
2354 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2355 (* Test for RHBZ#579608, absolute symbolic links. *)
2356 InitISOFS, Always, TestOutput (
2357 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2358 "compute MD5, SHAx or CRC checksum of file",
2360 This call computes the MD5, SHAx or CRC checksum of the
2363 The type of checksum to compute is given by the C<csumtype>
2364 parameter which must have one of the following values:
2370 Compute the cyclic redundancy check (CRC) specified by POSIX
2371 for the C<cksum> command.
2375 Compute the MD5 hash (using the C<md5sum> program).
2379 Compute the SHA1 hash (using the C<sha1sum> program).
2383 Compute the SHA224 hash (using the C<sha224sum> program).
2387 Compute the SHA256 hash (using the C<sha256sum> program).
2391 Compute the SHA384 hash (using the C<sha384sum> program).
2395 Compute the SHA512 hash (using the C<sha512sum> program).
2399 The checksum is returned as a printable string.
2401 To get the checksum for a device, use C<guestfs_checksum_device>.
2403 To get the checksums for many files, use C<guestfs_checksums_out>.");
2405 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2406 [InitBasicFS, Always, TestOutput (
2407 [["tar_in"; "../images/helloworld.tar"; "/"];
2408 ["cat"; "/hello"]], "hello\n")],
2409 "unpack tarfile to directory",
2411 This command uploads and unpacks local file C<tarfile> (an
2412 I<uncompressed> tar file) into C<directory>.
2414 To upload a compressed tarball, use C<guestfs_tgz_in>
2415 or C<guestfs_txz_in>.");
2417 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2419 "pack directory into tarfile",
2421 This command packs the contents of C<directory> and downloads
2422 it to local file C<tarfile>.
2424 To download a compressed tarball, use C<guestfs_tgz_out>
2425 or C<guestfs_txz_out>.");
2427 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2428 [InitBasicFS, Always, TestOutput (
2429 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2430 ["cat"; "/hello"]], "hello\n")],
2431 "unpack compressed tarball to directory",
2433 This command uploads and unpacks local file C<tarball> (a
2434 I<gzip compressed> tar file) into C<directory>.
2436 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2438 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2440 "pack directory into compressed tarball",
2442 This command packs the contents of C<directory> and downloads
2443 it to local file C<tarball>.
2445 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2447 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2448 [InitBasicFS, Always, TestLastFail (
2450 ["mount_ro"; "/dev/sda1"; "/"];
2451 ["touch"; "/new"]]);
2452 InitBasicFS, Always, TestOutput (
2453 [["write"; "/new"; "data"];
2455 ["mount_ro"; "/dev/sda1"; "/"];
2456 ["cat"; "/new"]], "data")],
2457 "mount a guest disk, read-only",
2459 This is the same as the C<guestfs_mount> command, but it
2460 mounts the filesystem with the read-only (I<-o ro>) flag.");
2462 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2464 "mount a guest disk with mount options",
2466 This is the same as the C<guestfs_mount> command, but it
2467 allows you to set the mount options as for the
2468 L<mount(8)> I<-o> flag.
2470 If the C<options> parameter is an empty string, then
2471 no options are passed (all options default to whatever
2472 the filesystem uses).");
2474 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2476 "mount a guest disk with mount options and vfstype",
2478 This is the same as the C<guestfs_mount> command, but it
2479 allows you to set both the mount options and the vfstype
2480 as for the L<mount(8)> I<-o> and I<-t> flags.");
2482 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2484 "debugging and internals",
2486 The C<guestfs_debug> command exposes some internals of
2487 C<guestfsd> (the guestfs daemon) that runs inside the
2490 There is no comprehensive help for this command. You have
2491 to look at the file C<daemon/debug.c> in the libguestfs source
2492 to find out what you can do.");
2494 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2495 [InitEmpty, Always, TestOutputList (
2496 [["part_disk"; "/dev/sda"; "mbr"];
2497 ["pvcreate"; "/dev/sda1"];
2498 ["vgcreate"; "VG"; "/dev/sda1"];
2499 ["lvcreate"; "LV1"; "VG"; "50"];
2500 ["lvcreate"; "LV2"; "VG"; "50"];
2501 ["lvremove"; "/dev/VG/LV1"];
2502 ["lvs"]], ["/dev/VG/LV2"]);
2503 InitEmpty, Always, TestOutputList (
2504 [["part_disk"; "/dev/sda"; "mbr"];
2505 ["pvcreate"; "/dev/sda1"];
2506 ["vgcreate"; "VG"; "/dev/sda1"];
2507 ["lvcreate"; "LV1"; "VG"; "50"];
2508 ["lvcreate"; "LV2"; "VG"; "50"];
2509 ["lvremove"; "/dev/VG"];
2511 InitEmpty, Always, TestOutputList (
2512 [["part_disk"; "/dev/sda"; "mbr"];
2513 ["pvcreate"; "/dev/sda1"];
2514 ["vgcreate"; "VG"; "/dev/sda1"];
2515 ["lvcreate"; "LV1"; "VG"; "50"];
2516 ["lvcreate"; "LV2"; "VG"; "50"];
2517 ["lvremove"; "/dev/VG"];
2519 "remove an LVM logical volume",
2521 Remove an LVM logical volume C<device>, where C<device> is
2522 the path to the LV, such as C</dev/VG/LV>.
2524 You can also remove all LVs in a volume group by specifying
2525 the VG name, C</dev/VG>.");
2527 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2528 [InitEmpty, Always, TestOutputList (
2529 [["part_disk"; "/dev/sda"; "mbr"];
2530 ["pvcreate"; "/dev/sda1"];
2531 ["vgcreate"; "VG"; "/dev/sda1"];
2532 ["lvcreate"; "LV1"; "VG"; "50"];
2533 ["lvcreate"; "LV2"; "VG"; "50"];
2536 InitEmpty, Always, TestOutputList (
2537 [["part_disk"; "/dev/sda"; "mbr"];
2538 ["pvcreate"; "/dev/sda1"];
2539 ["vgcreate"; "VG"; "/dev/sda1"];
2540 ["lvcreate"; "LV1"; "VG"; "50"];
2541 ["lvcreate"; "LV2"; "VG"; "50"];
2544 "remove an LVM volume group",
2546 Remove an LVM volume group C<vgname>, (for example C<VG>).
2548 This also forcibly removes all logical volumes in the volume
2551 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2552 [InitEmpty, Always, TestOutputListOfDevices (
2553 [["part_disk"; "/dev/sda"; "mbr"];
2554 ["pvcreate"; "/dev/sda1"];
2555 ["vgcreate"; "VG"; "/dev/sda1"];
2556 ["lvcreate"; "LV1"; "VG"; "50"];
2557 ["lvcreate"; "LV2"; "VG"; "50"];
2559 ["pvremove"; "/dev/sda1"];
2561 InitEmpty, Always, TestOutputListOfDevices (
2562 [["part_disk"; "/dev/sda"; "mbr"];
2563 ["pvcreate"; "/dev/sda1"];
2564 ["vgcreate"; "VG"; "/dev/sda1"];
2565 ["lvcreate"; "LV1"; "VG"; "50"];
2566 ["lvcreate"; "LV2"; "VG"; "50"];
2568 ["pvremove"; "/dev/sda1"];
2570 InitEmpty, Always, TestOutputListOfDevices (
2571 [["part_disk"; "/dev/sda"; "mbr"];
2572 ["pvcreate"; "/dev/sda1"];
2573 ["vgcreate"; "VG"; "/dev/sda1"];
2574 ["lvcreate"; "LV1"; "VG"; "50"];
2575 ["lvcreate"; "LV2"; "VG"; "50"];
2577 ["pvremove"; "/dev/sda1"];
2579 "remove an LVM physical volume",
2581 This wipes a physical volume C<device> so that LVM will no longer
2584 The implementation uses the C<pvremove> command which refuses to
2585 wipe physical volumes that contain any volume groups, so you have
2586 to remove those first.");
2588 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2589 [InitBasicFS, Always, TestOutput (
2590 [["set_e2label"; "/dev/sda1"; "testlabel"];
2591 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2592 "set the ext2/3/4 filesystem label",
2594 This sets the ext2/3/4 filesystem label of the filesystem on
2595 C<device> to C<label>. Filesystem labels are limited to
2598 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2599 to return the existing label on a filesystem.");
2601 ("get_e2label", (RString "label", [Device "device"]), 81, [DeprecatedBy "vfs_label"],
2603 "get the ext2/3/4 filesystem label",
2605 This returns the ext2/3/4 filesystem label of the filesystem on
2608 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2609 (let uuid = uuidgen () in
2610 [InitBasicFS, Always, TestOutput (
2611 [["set_e2uuid"; "/dev/sda1"; uuid];
2612 ["get_e2uuid"; "/dev/sda1"]], uuid);
2613 InitBasicFS, Always, TestOutput (
2614 [["set_e2uuid"; "/dev/sda1"; "clear"];
2615 ["get_e2uuid"; "/dev/sda1"]], "");
2616 (* We can't predict what UUIDs will be, so just check the commands run. *)
2617 InitBasicFS, Always, TestRun (
2618 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2619 InitBasicFS, Always, TestRun (
2620 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2621 "set the ext2/3/4 filesystem UUID",
2623 This sets the ext2/3/4 filesystem UUID of the filesystem on
2624 C<device> to C<uuid>. The format of the UUID and alternatives
2625 such as C<clear>, C<random> and C<time> are described in the
2626 L<tune2fs(8)> manpage.
2628 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2629 to return the existing UUID of a filesystem.");
2631 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [DeprecatedBy "vfs_uuid"],
2632 (* Regression test for RHBZ#597112. *)
2633 (let uuid = uuidgen () in
2634 [InitBasicFS, Always, TestOutput (
2635 [["mke2journal"; "1024"; "/dev/sdb"];
2636 ["set_e2uuid"; "/dev/sdb"; uuid];
2637 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2638 "get the ext2/3/4 filesystem UUID",
2640 This returns the ext2/3/4 filesystem UUID of the filesystem on
2643 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2644 [InitBasicFS, Always, TestOutputInt (
2645 [["umount"; "/dev/sda1"];
2646 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2647 InitBasicFS, Always, TestOutputInt (
2648 [["umount"; "/dev/sda1"];
2649 ["zero"; "/dev/sda1"];
2650 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2651 "run the filesystem checker",
2653 This runs the filesystem checker (fsck) on C<device> which
2654 should have filesystem type C<fstype>.
2656 The returned integer is the status. See L<fsck(8)> for the
2657 list of status codes from C<fsck>.
2665 Multiple status codes can be summed together.
2669 A non-zero return code can mean \"success\", for example if
2670 errors have been corrected on the filesystem.
2674 Checking or repairing NTFS volumes is not supported
2679 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2681 ("zero", (RErr, [Device "device"]), 85, [],
2682 [InitBasicFS, Always, TestOutput (
2683 [["umount"; "/dev/sda1"];
2684 ["zero"; "/dev/sda1"];
2685 ["file"; "/dev/sda1"]], "data")],
2686 "write zeroes to the device",
2688 This command writes zeroes over the first few blocks of C<device>.
2690 How many blocks are zeroed isn't specified (but it's I<not> enough
2691 to securely wipe the device). It should be sufficient to remove
2692 any partition tables, filesystem superblocks and so on.
2694 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2696 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2698 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2699 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2701 [InitBasicFS, Always, TestOutputTrue (
2702 [["mkdir_p"; "/boot/grub"];
2703 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2704 ["grub_install"; "/"; "/dev/vda"];
2705 ["is_dir"; "/boot"]])],
2708 This command installs GRUB (the Grand Unified Bootloader) on
2709 C<device>, with the root directory being C<root>.
2711 Note: If grub-install reports the error
2712 \"No suitable drive was found in the generated device map.\"
2713 it may be that you need to create a C</boot/grub/device.map>
2714 file first that contains the mapping between grub device names
2715 and Linux device names. It is usually sufficient to create
2720 replacing C</dev/vda> with the name of the installation device.");
2722 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2723 [InitBasicFS, Always, TestOutput (
2724 [["write"; "/old"; "file content"];
2725 ["cp"; "/old"; "/new"];
2726 ["cat"; "/new"]], "file content");
2727 InitBasicFS, Always, TestOutputTrue (
2728 [["write"; "/old"; "file content"];
2729 ["cp"; "/old"; "/new"];
2730 ["is_file"; "/old"]]);
2731 InitBasicFS, Always, TestOutput (
2732 [["write"; "/old"; "file content"];
2734 ["cp"; "/old"; "/dir/new"];
2735 ["cat"; "/dir/new"]], "file content")],
2738 This copies a file from C<src> to C<dest> where C<dest> is
2739 either a destination filename or destination directory.");
2741 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2742 [InitBasicFS, Always, TestOutput (
2743 [["mkdir"; "/olddir"];
2744 ["mkdir"; "/newdir"];
2745 ["write"; "/olddir/file"; "file content"];
2746 ["cp_a"; "/olddir"; "/newdir"];
2747 ["cat"; "/newdir/olddir/file"]], "file content")],
2748 "copy a file or directory recursively",
2750 This copies a file or directory from C<src> to C<dest>
2751 recursively using the C<cp -a> command.");
2753 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2754 [InitBasicFS, Always, TestOutput (
2755 [["write"; "/old"; "file content"];
2756 ["mv"; "/old"; "/new"];
2757 ["cat"; "/new"]], "file content");
2758 InitBasicFS, Always, TestOutputFalse (
2759 [["write"; "/old"; "file content"];
2760 ["mv"; "/old"; "/new"];
2761 ["is_file"; "/old"]])],
2764 This moves a file from C<src> to C<dest> where C<dest> is
2765 either a destination filename or destination directory.");
2767 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2768 [InitEmpty, Always, TestRun (
2769 [["drop_caches"; "3"]])],
2770 "drop kernel page cache, dentries and inodes",
2772 This instructs the guest kernel to drop its page cache,
2773 and/or dentries and inode caches. The parameter C<whattodrop>
2774 tells the kernel what precisely to drop, see
2775 L<http://linux-mm.org/Drop_Caches>
2777 Setting C<whattodrop> to 3 should drop everything.
2779 This automatically calls L<sync(2)> before the operation,
2780 so that the maximum guest memory is freed.");
2782 ("dmesg", (RString "kmsgs", []), 91, [],
2783 [InitEmpty, Always, TestRun (
2785 "return kernel messages",
2787 This returns the kernel messages (C<dmesg> output) from
2788 the guest kernel. This is sometimes useful for extended
2789 debugging of problems.
2791 Another way to get the same information is to enable
2792 verbose messages with C<guestfs_set_verbose> or by setting
2793 the environment variable C<LIBGUESTFS_DEBUG=1> before
2794 running the program.");
2796 ("ping_daemon", (RErr, []), 92, [],
2797 [InitEmpty, Always, TestRun (
2798 [["ping_daemon"]])],
2799 "ping the guest daemon",
2801 This is a test probe into the guestfs daemon running inside
2802 the qemu subprocess. Calling this function checks that the
2803 daemon responds to the ping message, without affecting the daemon
2804 or attached block device(s) in any other way.");
2806 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2807 [InitBasicFS, Always, TestOutputTrue (
2808 [["write"; "/file1"; "contents of a file"];
2809 ["cp"; "/file1"; "/file2"];
2810 ["equal"; "/file1"; "/file2"]]);
2811 InitBasicFS, Always, TestOutputFalse (
2812 [["write"; "/file1"; "contents of a file"];
2813 ["write"; "/file2"; "contents of another file"];
2814 ["equal"; "/file1"; "/file2"]]);
2815 InitBasicFS, Always, TestLastFail (
2816 [["equal"; "/file1"; "/file2"]])],
2817 "test if two files have equal contents",
2819 This compares the two files C<file1> and C<file2> and returns
2820 true if their content is exactly equal, or false otherwise.
2822 The external L<cmp(1)> program is used for the comparison.");
2824 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2825 [InitISOFS, Always, TestOutputList (
2826 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2827 InitISOFS, Always, TestOutputList (
2828 [["strings"; "/empty"]], []);
2829 (* Test for RHBZ#579608, absolute symbolic links. *)
2830 InitISOFS, Always, TestRun (
2831 [["strings"; "/abssymlink"]])],
2832 "print the printable strings in a file",
2834 This runs the L<strings(1)> command on a file and returns
2835 the list of printable strings found.");
2837 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2838 [InitISOFS, Always, TestOutputList (
2839 [["strings_e"; "b"; "/known-5"]], []);
2840 InitBasicFS, Always, TestOutputList (
2841 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2842 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2843 "print the printable strings in a file",
2845 This is like the C<guestfs_strings> command, but allows you to
2846 specify the encoding of strings that are looked for in
2847 the source file C<path>.
2849 Allowed encodings are:
2855 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2856 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2860 Single 8-bit-byte characters.
2864 16-bit big endian strings such as those encoded in
2865 UTF-16BE or UCS-2BE.
2867 =item l (lower case letter L)
2869 16-bit little endian such as UTF-16LE and UCS-2LE.
2870 This is useful for examining binaries in Windows guests.
2874 32-bit big endian such as UCS-4BE.
2878 32-bit little endian such as UCS-4LE.
2882 The returned strings are transcoded to UTF-8.");
2884 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2885 [InitISOFS, Always, TestOutput (
2886 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2887 (* Test for RHBZ#501888c2 regression which caused large hexdump
2888 * commands to segfault.
2890 InitISOFS, Always, TestRun (
2891 [["hexdump"; "/100krandom"]]);
2892 (* Test for RHBZ#579608, absolute symbolic links. *)
2893 InitISOFS, Always, TestRun (
2894 [["hexdump"; "/abssymlink"]])],
2895 "dump a file in hexadecimal",
2897 This runs C<hexdump -C> on the given C<path>. The result is
2898 the human-readable, canonical hex dump of the file.");
2900 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2901 [InitNone, Always, TestOutput (
2902 [["part_disk"; "/dev/sda"; "mbr"];
2903 ["mkfs"; "ext3"; "/dev/sda1"];
2904 ["mount_options"; ""; "/dev/sda1"; "/"];
2905 ["write"; "/new"; "test file"];
2906 ["umount"; "/dev/sda1"];
2907 ["zerofree"; "/dev/sda1"];
2908 ["mount_options"; ""; "/dev/sda1"; "/"];
2909 ["cat"; "/new"]], "test file")],
2910 "zero unused inodes and disk blocks on ext2/3 filesystem",
2912 This runs the I<zerofree> program on C<device>. This program
2913 claims to zero unused inodes and disk blocks on an ext2/3
2914 filesystem, thus making it possible to compress the filesystem
2917 You should B<not> run this program if the filesystem is
2920 It is possible that using this program can damage the filesystem
2921 or data on the filesystem.");
2923 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2925 "resize an LVM physical volume",
2927 This resizes (expands or shrinks) an existing LVM physical
2928 volume to match the new size of the underlying device.");
2930 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2931 Int "cyls"; Int "heads"; Int "sectors";
2932 String "line"]), 99, [DangerWillRobinson],
2934 "modify a single partition on a block device",
2936 This runs L<sfdisk(8)> option to modify just the single
2937 partition C<n> (note: C<n> counts from 1).
2939 For other parameters, see C<guestfs_sfdisk>. You should usually
2940 pass C<0> for the cyls/heads/sectors parameters.
2942 See also: C<guestfs_part_add>");
2944 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2946 "display the partition table",
2948 This displays the partition table on C<device>, in the
2949 human-readable output of the L<sfdisk(8)> command. It is
2950 not intended to be parsed.
2952 See also: C<guestfs_part_list>");
2954 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2956 "display the kernel geometry",
2958 This displays the kernel's idea of the geometry of C<device>.
2960 The result is in human-readable format, and not designed to
2963 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2965 "display the disk geometry from the partition table",
2967 This displays the disk geometry of C<device> read from the
2968 partition table. Especially in the case where the underlying
2969 block device has been resized, this can be different from the
2970 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2972 The result is in human-readable format, and not designed to
2975 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2977 "activate or deactivate all volume groups",
2979 This command activates or (if C<activate> is false) deactivates
2980 all logical volumes in all volume groups.
2981 If activated, then they are made known to the
2982 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2983 then those devices disappear.
2985 This command is the same as running C<vgchange -a y|n>");
2987 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2989 "activate or deactivate some volume groups",
2991 This command activates or (if C<activate> is false) deactivates
2992 all logical volumes in the listed volume groups C<volgroups>.
2993 If activated, then they are made known to the
2994 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2995 then those devices disappear.
2997 This command is the same as running C<vgchange -a y|n volgroups...>
2999 Note that if C<volgroups> is an empty list then B<all> volume groups
3000 are activated or deactivated.");
3002 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
3003 [InitNone, Always, TestOutput (
3004 [["part_disk"; "/dev/sda"; "mbr"];
3005 ["pvcreate"; "/dev/sda1"];
3006 ["vgcreate"; "VG"; "/dev/sda1"];
3007 ["lvcreate"; "LV"; "VG"; "10"];
3008 ["mkfs"; "ext2"; "/dev/VG/LV"];
3009 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3010 ["write"; "/new"; "test content"];
3012 ["lvresize"; "/dev/VG/LV"; "20"];
3013 ["e2fsck_f"; "/dev/VG/LV"];
3014 ["resize2fs"; "/dev/VG/LV"];
3015 ["mount_options"; ""; "/dev/VG/LV"; "/"];
3016 ["cat"; "/new"]], "test content");
3017 InitNone, Always, TestRun (
3018 (* Make an LV smaller to test RHBZ#587484. *)
3019 [["part_disk"; "/dev/sda"; "mbr"];
3020 ["pvcreate"; "/dev/sda1"];
3021 ["vgcreate"; "VG"; "/dev/sda1"];
3022 ["lvcreate"; "LV"; "VG"; "20"];
3023 ["lvresize"; "/dev/VG/LV"; "10"]])],
3024 "resize an LVM logical volume",
3026 This resizes (expands or shrinks) an existing LVM logical
3027 volume to C<mbytes>. When reducing, data in the reduced part
3030 ("resize2fs", (RErr, [Device "device"]), 106, [],
3031 [], (* lvresize tests this *)
3032 "resize an ext2, ext3 or ext4 filesystem",
3034 This resizes an ext2, ext3 or ext4 filesystem to match the size of
3035 the underlying device.
3037 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
3038 on the C<device> before calling this command. For unknown reasons
3039 C<resize2fs> sometimes gives an error about this and sometimes not.
3040 In any case, it is always safe to call C<guestfs_e2fsck_f> before
3041 calling this function.");
3043 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
3044 [InitBasicFS, Always, TestOutputList (
3045 [["find"; "/"]], ["lost+found"]);
3046 InitBasicFS, Always, TestOutputList (
3050 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
3051 InitBasicFS, Always, TestOutputList (
3052 [["mkdir_p"; "/a/b/c"];
3053 ["touch"; "/a/b/c/d"];
3054 ["find"; "/a/b/"]], ["c"; "c/d"])],
3055 "find all files and directories",
3057 This command lists out all files and directories, recursively,
3058 starting at C<directory>. It is essentially equivalent to
3059 running the shell command C<find directory -print> but some
3060 post-processing happens on the output, described below.
3062 This returns a list of strings I<without any prefix>. Thus
3063 if the directory structure was:
3069 then the returned list from C<guestfs_find> C</tmp> would be
3077 If C<directory> is not a directory, then this command returns
3080 The returned list is sorted.
3082 See also C<guestfs_find0>.");
3084 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
3085 [], (* lvresize tests this *)
3086 "check an ext2/ext3 filesystem",
3088 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
3089 filesystem checker on C<device>, noninteractively (C<-p>),
3090 even if the filesystem appears to be clean (C<-f>).
3092 This command is only needed because of C<guestfs_resize2fs>
3093 (q.v.). Normally you should use C<guestfs_fsck>.");
3095 ("sleep", (RErr, [Int "secs"]), 109, [],
3096 [InitNone, Always, TestRun (
3098 "sleep for some seconds",
3100 Sleep for C<secs> seconds.");
3102 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
3103 [InitNone, Always, TestOutputInt (
3104 [["part_disk"; "/dev/sda"; "mbr"];
3105 ["mkfs"; "ntfs"; "/dev/sda1"];
3106 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
3107 InitNone, Always, TestOutputInt (
3108 [["part_disk"; "/dev/sda"; "mbr"];
3109 ["mkfs"; "ext2"; "/dev/sda1"];
3110 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
3111 "probe NTFS volume",
3113 This command runs the L<ntfs-3g.probe(8)> command which probes
3114 an NTFS C<device> for mountability. (Not all NTFS volumes can
3115 be mounted read-write, and some cannot be mounted at all).
3117 C<rw> is a boolean flag. Set it to true if you want to test
3118 if the volume can be mounted read-write. Set it to false if
3119 you want to test if the volume can be mounted read-only.
3121 The return value is an integer which C<0> if the operation
3122 would succeed, or some non-zero value documented in the
3123 L<ntfs-3g.probe(8)> manual page.");
3125 ("sh", (RString "output", [String "command"]), 111, [],
3126 [], (* XXX needs tests *)
3127 "run a command via the shell",
3129 This call runs a command from the guest filesystem via the
3132 This is like C<guestfs_command>, but passes the command to:
3134 /bin/sh -c \"command\"
3136 Depending on the guest's shell, this usually results in
3137 wildcards being expanded, shell expressions being interpolated
3140 All the provisos about C<guestfs_command> apply to this call.");
3142 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
3143 [], (* XXX needs tests *)
3144 "run a command via the shell returning lines",
3146 This is the same as C<guestfs_sh>, but splits the result
3147 into a list of lines.
3149 See also: C<guestfs_command_lines>");
3151 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
3152 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
3153 * code in stubs.c, since all valid glob patterns must start with "/".
3154 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
3156 [InitBasicFS, Always, TestOutputList (
3157 [["mkdir_p"; "/a/b/c"];
3158 ["touch"; "/a/b/c/d"];
3159 ["touch"; "/a/b/c/e"];
3160 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3161 InitBasicFS, Always, TestOutputList (
3162 [["mkdir_p"; "/a/b/c"];
3163 ["touch"; "/a/b/c/d"];
3164 ["touch"; "/a/b/c/e"];
3165 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
3166 InitBasicFS, Always, TestOutputList (
3167 [["mkdir_p"; "/a/b/c"];
3168 ["touch"; "/a/b/c/d"];
3169 ["touch"; "/a/b/c/e"];
3170 ["glob_expand"; "/a/*/x/*"]], [])],
3171 "expand a wildcard path",
3173 This command searches for all the pathnames matching
3174 C<pattern> according to the wildcard expansion rules
3177 If no paths match, then this returns an empty list
3178 (note: not an error).
3180 It is just a wrapper around the C L<glob(3)> function
3181 with flags C<GLOB_MARK|GLOB_BRACE>.
3182 See that manual page for more details.");
3184 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
3185 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
3186 [["scrub_device"; "/dev/sdc"]])],
3187 "scrub (securely wipe) a device",
3189 This command writes patterns over C<device> to make data retrieval
3192 It is an interface to the L<scrub(1)> program. See that
3193 manual page for more details.");
3195 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
3196 [InitBasicFS, Always, TestRun (
3197 [["write"; "/file"; "content"];
3198 ["scrub_file"; "/file"]])],
3199 "scrub (securely wipe) a file",
3201 This command writes patterns over a file to make data retrieval
3204 The file is I<removed> after scrubbing.
3206 It is an interface to the L<scrub(1)> program. See that
3207 manual page for more details.");
3209 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
3210 [], (* XXX needs testing *)
3211 "scrub (securely wipe) free space",
3213 This command creates the directory C<dir> and then fills it
3214 with files until the filesystem is full, and scrubs the files
3215 as for C<guestfs_scrub_file>, and deletes them.
3216 The intention is to scrub any free space on the partition
3219 It is an interface to the L<scrub(1)> program. See that
3220 manual page for more details.");
3222 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
3223 [InitBasicFS, Always, TestRun (
3225 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
3226 "create a temporary directory",
3228 This command creates a temporary directory. The
3229 C<template> parameter should be a full pathname for the
3230 temporary directory name with the final six characters being
3233 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
3234 the second one being suitable for Windows filesystems.
3236 The name of the temporary directory that was created
3239 The temporary directory is created with mode 0700
3240 and is owned by root.
3242 The caller is responsible for deleting the temporary
3243 directory and its contents after use.
3245 See also: L<mkdtemp(3)>");
3247 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
3248 [InitISOFS, Always, TestOutputInt (
3249 [["wc_l"; "/10klines"]], 10000);
3250 (* Test for RHBZ#579608, absolute symbolic links. *)
3251 InitISOFS, Always, TestOutputInt (
3252 [["wc_l"; "/abssymlink"]], 10000)],
3253 "count lines in a file",
3255 This command counts the lines in a file, using the
3256 C<wc -l> external command.");
3258 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
3259 [InitISOFS, Always, TestOutputInt (
3260 [["wc_w"; "/10klines"]], 10000)],
3261 "count words in a file",
3263 This command counts the words in a file, using the
3264 C<wc -w> external command.");
3266 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
3267 [InitISOFS, Always, TestOutputInt (
3268 [["wc_c"; "/100kallspaces"]], 102400)],
3269 "count characters in a file",
3271 This command counts the characters in a file, using the
3272 C<wc -c> external command.");
3274 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
3275 [InitISOFS, Always, TestOutputList (
3276 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
3277 (* Test for RHBZ#579608, absolute symbolic links. *)
3278 InitISOFS, Always, TestOutputList (
3279 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
3280 "return first 10 lines of a file",
3282 This command returns up to the first 10 lines of a file as
3283 a list of strings.");
3285 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
3286 [InitISOFS, Always, TestOutputList (
3287 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3288 InitISOFS, Always, TestOutputList (
3289 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
3290 InitISOFS, Always, TestOutputList (
3291 [["head_n"; "0"; "/10klines"]], [])],
3292 "return first N lines of a file",
3294 If the parameter C<nrlines> is a positive number, this returns the first
3295 C<nrlines> lines of the file C<path>.
3297 If the parameter C<nrlines> is a negative number, this returns lines
3298 from the file C<path>, excluding the last C<nrlines> lines.
3300 If the parameter C<nrlines> is zero, this returns an empty list.");
3302 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
3303 [InitISOFS, Always, TestOutputList (
3304 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
3305 "return last 10 lines of a file",
3307 This command returns up to the last 10 lines of a file as
3308 a list of strings.");
3310 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
3311 [InitISOFS, Always, TestOutputList (
3312 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3313 InitISOFS, Always, TestOutputList (
3314 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
3315 InitISOFS, Always, TestOutputList (
3316 [["tail_n"; "0"; "/10klines"]], [])],
3317 "return last N lines of a file",
3319 If the parameter C<nrlines> is a positive number, this returns the last
3320 C<nrlines> lines of the file C<path>.
3322 If the parameter C<nrlines> is a negative number, this returns lines
3323 from the file C<path>, starting with the C<-nrlines>th line.
3325 If the parameter C<nrlines> is zero, this returns an empty list.");
3327 ("df", (RString "output", []), 125, [],
3328 [], (* XXX Tricky to test because it depends on the exact format
3329 * of the 'df' command and other imponderables.
3331 "report file system disk space usage",
3333 This command runs the C<df> command to report disk space used.
3335 This command is mostly useful for interactive sessions. It
3336 is I<not> intended that you try to parse the output string.
3337 Use C<statvfs> from programs.");
3339 ("df_h", (RString "output", []), 126, [],
3340 [], (* XXX Tricky to test because it depends on the exact format
3341 * of the 'df' command and other imponderables.
3343 "report file system disk space usage (human readable)",
3345 This command runs the C<df -h> command to report disk space used
3346 in human-readable format.
3348 This command is mostly useful for interactive sessions. It
3349 is I<not> intended that you try to parse the output string.
3350 Use C<statvfs> from programs.");
3352 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
3353 [InitISOFS, Always, TestOutputInt (
3354 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3355 "estimate file space usage",
3357 This command runs the C<du -s> command to estimate file space
3360 C<path> can be a file or a directory. If C<path> is a directory
3361 then the estimate includes the contents of the directory and all
3362 subdirectories (recursively).
3364 The result is the estimated size in I<kilobytes>
3365 (ie. units of 1024 bytes).");
3367 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
3368 [InitISOFS, Always, TestOutputList (
3369 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3370 "list files in an initrd",
3372 This command lists out files contained in an initrd.
3374 The files are listed without any initial C</> character. The
3375 files are listed in the order they appear (not necessarily
3376 alphabetical). Directory names are listed as separate items.
3378 Old Linux kernels (2.4 and earlier) used a compressed ext2
3379 filesystem as initrd. We I<only> support the newer initramfs
3380 format (compressed cpio files).");
3382 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
3384 "mount a file using the loop device",
3386 This command lets you mount C<file> (a filesystem image
3387 in a file) on a mount point. It is entirely equivalent to
3388 the command C<mount -o loop file mountpoint>.");
3390 ("mkswap", (RErr, [Device "device"]), 130, [],
3391 [InitEmpty, Always, TestRun (
3392 [["part_disk"; "/dev/sda"; "mbr"];
3393 ["mkswap"; "/dev/sda1"]])],
3394 "create a swap partition",
3396 Create a swap partition on C<device>.");
3398 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3399 [InitEmpty, Always, TestRun (
3400 [["part_disk"; "/dev/sda"; "mbr"];
3401 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3402 "create a swap partition with a label",
3404 Create a swap partition on C<device> with label C<label>.
3406 Note that you cannot attach a swap label to a block device
3407 (eg. C</dev/sda>), just to a partition. This appears to be
3408 a limitation of the kernel or swap tools.");
3410 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3411 (let uuid = uuidgen () in
3412 [InitEmpty, Always, TestRun (
3413 [["part_disk"; "/dev/sda"; "mbr"];
3414 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3415 "create a swap partition with an explicit UUID",
3417 Create a swap partition on C<device> with UUID C<uuid>.");
3419 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3420 [InitBasicFS, Always, TestOutputStruct (
3421 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3422 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3423 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3424 InitBasicFS, Always, TestOutputStruct (
3425 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3426 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3427 "make block, character or FIFO devices",
3429 This call creates block or character special devices, or
3430 named pipes (FIFOs).
3432 The C<mode> parameter should be the mode, using the standard
3433 constants. C<devmajor> and C<devminor> are the
3434 device major and minor numbers, only used when creating block
3435 and character special devices.
3437 Note that, just like L<mknod(2)>, the mode must be bitwise
3438 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3439 just creates a regular file). These constants are
3440 available in the standard Linux header files, or you can use
3441 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3442 which are wrappers around this command which bitwise OR
3443 in the appropriate constant for you.
3445 The mode actually set is affected by the umask.");
3447 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3448 [InitBasicFS, Always, TestOutputStruct (
3449 [["mkfifo"; "0o777"; "/node"];
3450 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3451 "make FIFO (named pipe)",
3453 This call creates a FIFO (named pipe) called C<path> with
3454 mode C<mode>. It is just a convenient wrapper around
3457 The mode actually set is affected by the umask.");
3459 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3460 [InitBasicFS, Always, TestOutputStruct (
3461 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3462 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3463 "make block device node",
3465 This call creates a block device node called C<path> with
3466 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3467 It is just a convenient wrapper around C<guestfs_mknod>.
3469 The mode actually set is affected by the umask.");
3471 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3472 [InitBasicFS, Always, TestOutputStruct (
3473 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3474 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3475 "make char device node",
3477 This call creates a char device node called C<path> with
3478 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3479 It is just a convenient wrapper around C<guestfs_mknod>.
3481 The mode actually set is affected by the umask.");
3483 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3484 [InitEmpty, Always, TestOutputInt (
3485 [["umask"; "0o22"]], 0o22)],
3486 "set file mode creation mask (umask)",
3488 This function sets the mask used for creating new files and
3489 device nodes to C<mask & 0777>.
3491 Typical umask values would be C<022> which creates new files
3492 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3493 C<002> which creates new files with permissions like
3494 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3496 The default umask is C<022>. This is important because it
3497 means that directories and device nodes will be created with
3498 C<0644> or C<0755> mode even if you specify C<0777>.
3500 See also C<guestfs_get_umask>,
3501 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3503 This call returns the previous umask.");
3505 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3507 "read directories entries",
3509 This returns the list of directory entries in directory C<dir>.
3511 All entries in the directory are returned, including C<.> and
3512 C<..>. The entries are I<not> sorted, but returned in the same
3513 order as the underlying filesystem.
3515 Also this call returns basic file type information about each
3516 file. The C<ftyp> field will contain one of the following characters:
3554 The L<readdir(3)> call returned a C<d_type> field with an
3559 This function is primarily intended for use by programs. To
3560 get a simple list of names, use C<guestfs_ls>. To get a printable
3561 directory for human consumption, use C<guestfs_ll>.");
3563 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3565 "create partitions on a block device",
3567 This is a simplified interface to the C<guestfs_sfdisk>
3568 command, where partition sizes are specified in megabytes
3569 only (rounded to the nearest cylinder) and you don't need
3570 to specify the cyls, heads and sectors parameters which
3571 were rarely if ever used anyway.
3573 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3574 and C<guestfs_part_disk>");
3576 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3578 "determine file type inside a compressed file",
3580 This command runs C<file> after first decompressing C<path>
3583 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3585 Since 1.0.63, use C<guestfs_file> instead which can now
3586 process compressed files.");
3588 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3590 "list extended attributes of a file or directory",
3592 This call lists the extended attributes of the file or directory
3595 At the system call level, this is a combination of the
3596 L<listxattr(2)> and L<getxattr(2)> calls.
3598 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3600 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3602 "list extended attributes of a file or directory",
3604 This is the same as C<guestfs_getxattrs>, but if C<path>
3605 is a symbolic link, then it returns the extended attributes
3606 of the link itself.");
3608 ("setxattr", (RErr, [String "xattr";
3609 String "val"; Int "vallen"; (* will be BufferIn *)
3610 Pathname "path"]), 143, [Optional "linuxxattrs"],
3612 "set extended attribute of a file or directory",
3614 This call sets the extended attribute named C<xattr>
3615 of the file C<path> to the value C<val> (of length C<vallen>).
3616 The value is arbitrary 8 bit data.
3618 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3620 ("lsetxattr", (RErr, [String "xattr";
3621 String "val"; Int "vallen"; (* will be BufferIn *)
3622 Pathname "path"]), 144, [Optional "linuxxattrs"],
3624 "set extended attribute of a file or directory",
3626 This is the same as C<guestfs_setxattr>, but if C<path>
3627 is a symbolic link, then it sets an extended attribute
3628 of the link itself.");
3630 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3632 "remove extended attribute of a file or directory",
3634 This call removes the extended attribute named C<xattr>
3635 of the file C<path>.
3637 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3639 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3641 "remove extended attribute of a file or directory",
3643 This is the same as C<guestfs_removexattr>, but if C<path>
3644 is a symbolic link, then it removes an extended attribute
3645 of the link itself.");
3647 ("mountpoints", (RHashtable "mps", []), 147, [],
3651 This call is similar to C<guestfs_mounts>. That call returns
3652 a list of devices. This one returns a hash table (map) of
3653 device name to directory where the device is mounted.");
3655 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3656 (* This is a special case: while you would expect a parameter
3657 * of type "Pathname", that doesn't work, because it implies
3658 * NEED_ROOT in the generated calling code in stubs.c, and
3659 * this function cannot use NEED_ROOT.
3662 "create a mountpoint",
3664 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3665 specialized calls that can be used to create extra mountpoints
3666 before mounting the first filesystem.
3668 These calls are I<only> necessary in some very limited circumstances,
3669 mainly the case where you want to mount a mix of unrelated and/or
3670 read-only filesystems together.
3672 For example, live CDs often contain a \"Russian doll\" nest of
3673 filesystems, an ISO outer layer, with a squashfs image inside, with
3674 an ext2/3 image inside that. You can unpack this as follows
3677 add-ro Fedora-11-i686-Live.iso
3680 mkmountpoint /squash
3683 mount-loop /cd/LiveOS/squashfs.img /squash
3684 mount-loop /squash/LiveOS/ext3fs.img /ext3
3686 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3688 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3690 "remove a mountpoint",
3692 This calls removes a mountpoint that was previously created
3693 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3694 for full details.");
3696 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3697 [InitISOFS, Always, TestOutputBuffer (
3698 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3699 (* Test various near large, large and too large files (RHBZ#589039). *)
3700 InitBasicFS, Always, TestLastFail (
3702 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3703 ["read_file"; "/a"]]);
3704 InitBasicFS, Always, TestLastFail (
3706 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3707 ["read_file"; "/a"]]);
3708 InitBasicFS, Always, TestLastFail (
3710 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3711 ["read_file"; "/a"]])],
3714 This calls returns the contents of the file C<path> as a
3717 Unlike C<guestfs_cat>, this function can correctly
3718 handle files that contain embedded ASCII NUL characters.
3719 However unlike C<guestfs_download>, this function is limited
3720 in the total size of file that can be handled.");
3722 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3723 [InitISOFS, Always, TestOutputList (
3724 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3725 InitISOFS, Always, TestOutputList (
3726 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3727 (* Test for RHBZ#579608, absolute symbolic links. *)
3728 InitISOFS, Always, TestOutputList (
3729 [["grep"; "nomatch"; "/abssymlink"]], [])],
3730 "return lines matching a pattern",
3732 This calls the external C<grep> program and returns the
3735 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3736 [InitISOFS, Always, TestOutputList (
3737 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3738 "return lines matching a pattern",
3740 This calls the external C<egrep> program and returns the
3743 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3744 [InitISOFS, Always, TestOutputList (
3745 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3746 "return lines matching a pattern",
3748 This calls the external C<fgrep> program and returns the
3751 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3752 [InitISOFS, Always, TestOutputList (
3753 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3754 "return lines matching a pattern",
3756 This calls the external C<grep -i> program and returns the
3759 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3760 [InitISOFS, Always, TestOutputList (
3761 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3762 "return lines matching a pattern",
3764 This calls the external C<egrep -i> program and returns the
3767 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3768 [InitISOFS, Always, TestOutputList (
3769 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3770 "return lines matching a pattern",
3772 This calls the external C<fgrep -i> program and returns the
3775 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3776 [InitISOFS, Always, TestOutputList (
3777 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3778 "return lines matching a pattern",
3780 This calls the external C<zgrep> program and returns the
3783 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3784 [InitISOFS, Always, TestOutputList (
3785 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3786 "return lines matching a pattern",
3788 This calls the external C<zegrep> program and returns the
3791 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3792 [InitISOFS, Always, TestOutputList (
3793 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3794 "return lines matching a pattern",
3796 This calls the external C<zfgrep> program and returns the
3799 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3800 [InitISOFS, Always, TestOutputList (
3801 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3802 "return lines matching a pattern",
3804 This calls the external C<zgrep -i> program and returns the
3807 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3808 [InitISOFS, Always, TestOutputList (
3809 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3810 "return lines matching a pattern",
3812 This calls the external C<zegrep -i> program and returns the
3815 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3816 [InitISOFS, Always, TestOutputList (
3817 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3818 "return lines matching a pattern",
3820 This calls the external C<zfgrep -i> program and returns the
3823 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3824 [InitISOFS, Always, TestOutput (
3825 [["realpath"; "/../directory"]], "/directory")],
3826 "canonicalized absolute pathname",
3828 Return the canonicalized absolute pathname of C<path>. The
3829 returned path has no C<.>, C<..> or symbolic link path elements.");
3831 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3832 [InitBasicFS, Always, TestOutputStruct (
3835 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3836 "create a hard link",
3838 This command creates a hard link using the C<ln> command.");
3840 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3841 [InitBasicFS, Always, TestOutputStruct (
3844 ["ln_f"; "/a"; "/b"];
3845 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3846 "create a hard link",
3848 This command creates a hard link using the C<ln -f> command.
3849 The C<-f> option removes the link (C<linkname>) if it exists already.");
3851 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3852 [InitBasicFS, Always, TestOutputStruct (
3854 ["ln_s"; "a"; "/b"];
3855 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3856 "create a symbolic link",
3858 This command creates a symbolic link using the C<ln -s> command.");
3860 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3861 [InitBasicFS, Always, TestOutput (
3862 [["mkdir_p"; "/a/b"];
3863 ["touch"; "/a/b/c"];
3864 ["ln_sf"; "../d"; "/a/b/c"];
3865 ["readlink"; "/a/b/c"]], "../d")],
3866 "create a symbolic link",
3868 This command creates a symbolic link using the C<ln -sf> command,
3869 The C<-f> option removes the link (C<linkname>) if it exists already.");
3871 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3872 [] (* XXX tested above *),
3873 "read the target of a symbolic link",
3875 This command reads the target of a symbolic link.");
3877 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [DeprecatedBy "fallocate64"],
3878 [InitBasicFS, Always, TestOutputStruct (
3879 [["fallocate"; "/a"; "1000000"];
3880 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3881 "preallocate a file in the guest filesystem",
3883 This command preallocates a file (containing zero bytes) named
3884 C<path> of size C<len> bytes. If the file exists already, it
3887 Do not confuse this with the guestfish-specific
3888 C<alloc> command which allocates a file in the host and
3889 attaches it as a device.");
3891 ("swapon_device", (RErr, [Device "device"]), 170, [],
3892 [InitPartition, Always, TestRun (
3893 [["mkswap"; "/dev/sda1"];
3894 ["swapon_device"; "/dev/sda1"];
3895 ["swapoff_device"; "/dev/sda1"]])],
3896 "enable swap on device",
3898 This command enables the libguestfs appliance to use the
3899 swap device or partition named C<device>. The increased
3900 memory is made available for all commands, for example
3901 those run using C<guestfs_command> or C<guestfs_sh>.
3903 Note that you should not swap to existing guest swap
3904 partitions unless you know what you are doing. They may
3905 contain hibernation information, or other information that
3906 the guest doesn't want you to trash. You also risk leaking
3907 information about the host to the guest this way. Instead,
3908 attach a new host device to the guest and swap on that.");
3910 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3911 [], (* XXX tested by swapon_device *)
3912 "disable swap on device",
3914 This command disables the libguestfs appliance swap
3915 device or partition named C<device>.
3916 See C<guestfs_swapon_device>.");
3918 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3919 [InitBasicFS, Always, TestRun (
3920 [["fallocate"; "/swap"; "8388608"];
3921 ["mkswap_file"; "/swap"];
3922 ["swapon_file"; "/swap"];
3923 ["swapoff_file"; "/swap"]])],
3924 "enable swap on file",
3926 This command enables swap to a file.
3927 See C<guestfs_swapon_device> for other notes.");
3929 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3930 [], (* XXX tested by swapon_file *)
3931 "disable swap on file",
3933 This command disables the libguestfs appliance swap on file.");
3935 ("swapon_label", (RErr, [String "label"]), 174, [],
3936 [InitEmpty, Always, TestRun (
3937 [["part_disk"; "/dev/sdb"; "mbr"];
3938 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3939 ["swapon_label"; "swapit"];
3940 ["swapoff_label"; "swapit"];
3941 ["zero"; "/dev/sdb"];
3942 ["blockdev_rereadpt"; "/dev/sdb"]])],
3943 "enable swap on labeled swap partition",
3945 This command enables swap to a labeled swap partition.
3946 See C<guestfs_swapon_device> for other notes.");
3948 ("swapoff_label", (RErr, [String "label"]), 175, [],
3949 [], (* XXX tested by swapon_label *)
3950 "disable swap on labeled swap partition",
3952 This command disables the libguestfs appliance swap on
3953 labeled swap partition.");
3955 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3956 (let uuid = uuidgen () in
3957 [InitEmpty, Always, TestRun (
3958 [["mkswap_U"; uuid; "/dev/sdb"];
3959 ["swapon_uuid"; uuid];
3960 ["swapoff_uuid"; uuid]])]),
3961 "enable swap on swap partition by UUID",
3963 This command enables swap to a swap partition with the given UUID.
3964 See C<guestfs_swapon_device> for other notes.");
3966 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3967 [], (* XXX tested by swapon_uuid *)
3968 "disable swap on swap partition by UUID",
3970 This command disables the libguestfs appliance swap partition
3971 with the given UUID.");
3973 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3974 [InitBasicFS, Always, TestRun (
3975 [["fallocate"; "/swap"; "8388608"];
3976 ["mkswap_file"; "/swap"]])],
3977 "create a swap file",
3981 This command just writes a swap file signature to an existing
3982 file. To create the file itself, use something like C<guestfs_fallocate>.");
3984 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3985 [InitISOFS, Always, TestRun (
3986 [["inotify_init"; "0"]])],
3987 "create an inotify handle",
3989 This command creates a new inotify handle.
3990 The inotify subsystem can be used to notify events which happen to
3991 objects in the guest filesystem.
3993 C<maxevents> is the maximum number of events which will be
3994 queued up between calls to C<guestfs_inotify_read> or
3995 C<guestfs_inotify_files>.
3996 If this is passed as C<0>, then the kernel (or previously set)
3997 default is used. For Linux 2.6.29 the default was 16384 events.
3998 Beyond this limit, the kernel throws away events, but records
3999 the fact that it threw them away by setting a flag
4000 C<IN_Q_OVERFLOW> in the returned structure list (see
4001 C<guestfs_inotify_read>).
4003 Before any events are generated, you have to add some
4004 watches to the internal watch list. See:
4005 C<guestfs_inotify_add_watch>,
4006 C<guestfs_inotify_rm_watch> and
4007 C<guestfs_inotify_watch_all>.
4009 Queued up events should be read periodically by calling
4010 C<guestfs_inotify_read>
4011 (or C<guestfs_inotify_files> which is just a helpful
4012 wrapper around C<guestfs_inotify_read>). If you don't
4013 read the events out often enough then you risk the internal
4016 The handle should be closed after use by calling
4017 C<guestfs_inotify_close>. This also removes any
4018 watches automatically.
4020 See also L<inotify(7)> for an overview of the inotify interface
4021 as exposed by the Linux kernel, which is roughly what we expose
4022 via libguestfs. Note that there is one global inotify handle
4023 per libguestfs instance.");
4025 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
4026 [InitBasicFS, Always, TestOutputList (
4027 [["inotify_init"; "0"];
4028 ["inotify_add_watch"; "/"; "1073741823"];
4031 ["inotify_files"]], ["a"; "b"])],
4032 "add an inotify watch",
4034 Watch C<path> for the events listed in C<mask>.
4036 Note that if C<path> is a directory then events within that
4037 directory are watched, but this does I<not> happen recursively
4038 (in subdirectories).
4040 Note for non-C or non-Linux callers: the inotify events are
4041 defined by the Linux kernel ABI and are listed in
4042 C</usr/include/sys/inotify.h>.");
4044 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
4046 "remove an inotify watch",
4048 Remove a previously defined inotify watch.
4049 See C<guestfs_inotify_add_watch>.");
4051 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
4053 "return list of inotify events",
4055 Return the complete queue of events that have happened
4056 since the previous read call.
4058 If no events have happened, this returns an empty list.
4060 I<Note>: In order to make sure that all events have been
4061 read, you must call this function repeatedly until it
4062 returns an empty list. The reason is that the call will
4063 read events up to the maximum appliance-to-host message
4064 size and leave remaining events in the queue.");
4066 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
4068 "return list of watched files that had events",
4070 This function is a helpful wrapper around C<guestfs_inotify_read>
4071 which just returns a list of pathnames of objects that were
4072 touched. The returned pathnames are sorted and deduplicated.");
4074 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
4076 "close the inotify handle",
4078 This closes the inotify handle which was previously
4079 opened by inotify_init. It removes all watches, throws
4080 away any pending events, and deallocates all resources.");
4082 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
4084 "set SELinux security context",
4086 This sets the SELinux security context of the daemon
4087 to the string C<context>.
4089 See the documentation about SELINUX in L<guestfs(3)>.");
4091 ("getcon", (RString "context", []), 186, [Optional "selinux"],
4093 "get SELinux security context",
4095 This gets the SELinux security context of the daemon.
4097 See the documentation about SELINUX in L<guestfs(3)>,
4098 and C<guestfs_setcon>");
4100 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
4101 [InitEmpty, Always, TestOutput (
4102 [["part_disk"; "/dev/sda"; "mbr"];
4103 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
4104 ["mount_options"; ""; "/dev/sda1"; "/"];
4105 ["write"; "/new"; "new file contents"];
4106 ["cat"; "/new"]], "new file contents");
4107 InitEmpty, Always, TestRun (
4108 [["part_disk"; "/dev/sda"; "mbr"];
4109 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
4110 InitEmpty, Always, TestLastFail (
4111 [["part_disk"; "/dev/sda"; "mbr"];
4112 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
4113 InitEmpty, Always, TestLastFail (
4114 [["part_disk"; "/dev/sda"; "mbr"];
4115 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
4116 InitEmpty, IfAvailable "ntfsprogs", TestRun (
4117 [["part_disk"; "/dev/sda"; "mbr"];
4118 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
4119 "make a filesystem with block size",
4121 This call is similar to C<guestfs_mkfs>, but it allows you to
4122 control the block size of the resulting filesystem. Supported
4123 block sizes depend on the filesystem type, but typically they
4124 are C<1024>, C<2048> or C<4096> only.
4126 For VFAT and NTFS the C<blocksize> parameter is treated as
4127 the requested cluster size.");
4129 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
4130 [InitEmpty, Always, TestOutput (
4131 [["sfdiskM"; "/dev/sda"; ",100 ,"];
4132 ["mke2journal"; "4096"; "/dev/sda1"];
4133 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
4134 ["mount_options"; ""; "/dev/sda2"; "/"];
4135 ["write"; "/new"; "new file contents"];
4136 ["cat"; "/new"]], "new file contents")],
4137 "make ext2/3/4 external journal",
4139 This creates an ext2 external journal on C<device>. It is equivalent
4142 mke2fs -O journal_dev -b blocksize device");
4144 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
4145 [InitEmpty, Always, TestOutput (
4146 [["sfdiskM"; "/dev/sda"; ",100 ,"];
4147 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
4148 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
4149 ["mount_options"; ""; "/dev/sda2"; "/"];
4150 ["write"; "/new"; "new file contents"];
4151 ["cat"; "/new"]], "new file contents")],
4152 "make ext2/3/4 external journal with label",
4154 This creates an ext2 external journal on C<device> with label C<label>.");
4156 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
4157 (let uuid = uuidgen () in
4158 [InitEmpty, Always, TestOutput (
4159 [["sfdiskM"; "/dev/sda"; ",100 ,"];
4160 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
4161 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
4162 ["mount_options"; ""; "/dev/sda2"; "/"];
4163 ["write"; "/new"; "new file contents"];
4164 ["cat"; "/new"]], "new file contents")]),
4165 "make ext2/3/4 external journal with UUID",
4167 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
4169 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
4171 "make ext2/3/4 filesystem with external journal",
4173 This creates an ext2/3/4 filesystem on C<device> with
4174 an external journal on C<journal>. It is equivalent
4177 mke2fs -t fstype -b blocksize -J device=<journal> <device>
4179 See also C<guestfs_mke2journal>.");
4181 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
4183 "make ext2/3/4 filesystem with external journal",
4185 This creates an ext2/3/4 filesystem on C<device> with
4186 an external journal on the journal labeled C<label>.
4188 See also C<guestfs_mke2journal_L>.");
4190 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
4192 "make ext2/3/4 filesystem with external journal",
4194 This creates an ext2/3/4 filesystem on C<device> with
4195 an external journal on the journal with UUID C<uuid>.
4197 See also C<guestfs_mke2journal_U>.");
4199 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
4200 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
4201 "load a kernel module",
4203 This loads a kernel module in the appliance.
4205 The kernel module must have been whitelisted when libguestfs
4206 was built (see C<appliance/kmod.whitelist.in> in the source).");
4208 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
4209 [InitNone, Always, TestOutput (
4210 [["echo_daemon"; "This is a test"]], "This is a test"
4212 "echo arguments back to the client",
4214 This command concatenates the list of C<words> passed with single spaces
4215 between them and returns the resulting string.
4217 You can use this command to test the connection through to the daemon.
4219 See also C<guestfs_ping_daemon>.");
4221 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
4222 [], (* There is a regression test for this. *)
4223 "find all files and directories, returning NUL-separated list",
4225 This command lists out all files and directories, recursively,
4226 starting at C<directory>, placing the resulting list in the
4227 external file called C<files>.
4229 This command works the same way as C<guestfs_find> with the
4230 following exceptions:
4236 The resulting list is written to an external file.
4240 Items (filenames) in the result are separated
4241 by C<\\0> characters. See L<find(1)> option I<-print0>.
4245 This command is not limited in the number of names that it
4250 The result list is not sorted.
4254 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
4255 [InitISOFS, Always, TestOutput (
4256 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
4257 InitISOFS, Always, TestOutput (
4258 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
4259 InitISOFS, Always, TestOutput (
4260 [["case_sensitive_path"; "/Known-1"]], "/known-1");
4261 InitISOFS, Always, TestLastFail (
4262 [["case_sensitive_path"; "/Known-1/"]]);
4263 InitBasicFS, Always, TestOutput (
4265 ["mkdir"; "/a/bbb"];
4266 ["touch"; "/a/bbb/c"];
4267 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
4268 InitBasicFS, Always, TestOutput (
4270 ["mkdir"; "/a/bbb"];
4271 ["touch"; "/a/bbb/c"];
4272 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
4273 InitBasicFS, Always, TestLastFail (
4275 ["mkdir"; "/a/bbb"];
4276 ["touch"; "/a/bbb/c"];
4277 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
4278 "return true path on case-insensitive filesystem",
4280 This can be used to resolve case insensitive paths on
4281 a filesystem which is case sensitive. The use case is
4282 to resolve paths which you have read from Windows configuration
4283 files or the Windows Registry, to the true path.
4285 The command handles a peculiarity of the Linux ntfs-3g
4286 filesystem driver (and probably others), which is that although
4287 the underlying filesystem is case-insensitive, the driver
4288 exports the filesystem to Linux as case-sensitive.
4290 One consequence of this is that special directories such
4291 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
4292 (or other things) depending on the precise details of how
4293 they were created. In Windows itself this would not be
4296 Bug or feature? You decide:
4297 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
4299 This function resolves the true case of each element in the
4300 path and returns the case-sensitive path.
4302 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
4303 might return C<\"/WINDOWS/system32\"> (the exact return value
4304 would depend on details of how the directories were originally
4305 created under Windows).
4308 This function does not handle drive names, backslashes etc.
4310 See also C<guestfs_realpath>.");
4312 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
4313 [InitBasicFS, Always, TestOutput (
4314 [["vfs_type"; "/dev/sda1"]], "ext2")],
4315 "get the Linux VFS type corresponding to a mounted device",
4317 This command gets the filesystem type corresponding to
4318 the filesystem on C<device>.
4320 For most filesystems, the result is the name of the Linux
4321 VFS module which would be used to mount this filesystem
4322 if you mounted it without specifying the filesystem type.
4323 For example a string such as C<ext3> or C<ntfs>.");
4325 ("truncate", (RErr, [Pathname "path"]), 199, [],
4326 [InitBasicFS, Always, TestOutputStruct (
4327 [["write"; "/test"; "some stuff so size is not zero"];
4328 ["truncate"; "/test"];
4329 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
4330 "truncate a file to zero size",
4332 This command truncates C<path> to a zero-length file. The
4333 file must exist already.");
4335 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
4336 [InitBasicFS, Always, TestOutputStruct (
4337 [["touch"; "/test"];
4338 ["truncate_size"; "/test"; "1000"];
4339 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
4340 "truncate a file to a particular size",
4342 This command truncates C<path> to size C<size> bytes. The file
4345 If the current file size is less than C<size> then
4346 the file is extended to the required size with zero bytes.
4347 This creates a sparse file (ie. disk blocks are not allocated
4348 for the file until you write to it). To create a non-sparse
4349 file of zeroes, use C<guestfs_fallocate64> instead.");
4351 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
4352 [InitBasicFS, Always, TestOutputStruct (
4353 [["touch"; "/test"];
4354 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4355 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4356 "set timestamp of a file with nanosecond precision",
4358 This command sets the timestamps of a file with nanosecond
4361 C<atsecs, atnsecs> are the last access time (atime) in secs and
4362 nanoseconds from the epoch.
4364 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4365 secs and nanoseconds from the epoch.
4367 If the C<*nsecs> field contains the special value C<-1> then
4368 the corresponding timestamp is set to the current time. (The
4369 C<*secs> field is ignored in this case).
4371 If the C<*nsecs> field contains the special value C<-2> then
4372 the corresponding timestamp is left unchanged. (The
4373 C<*secs> field is ignored in this case).");
4375 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
4376 [InitBasicFS, Always, TestOutputStruct (
4377 [["mkdir_mode"; "/test"; "0o111"];
4378 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4379 "create a directory with a particular mode",
4381 This command creates a directory, setting the initial permissions
4382 of the directory to C<mode>.
4384 For common Linux filesystems, the actual mode which is set will
4385 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4386 interpret the mode in other ways.
4388 See also C<guestfs_mkdir>, C<guestfs_umask>");
4390 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
4392 "change file owner and group",
4394 Change the file owner to C<owner> and group to C<group>.
4395 This is like C<guestfs_chown> but if C<path> is a symlink then
4396 the link itself is changed, not the target.
4398 Only numeric uid and gid are supported. If you want to use
4399 names, you will need to locate and parse the password file
4400 yourself (Augeas support makes this relatively easy).");
4402 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
4404 "lstat on multiple files",
4406 This call allows you to perform the C<guestfs_lstat> operation
4407 on multiple files, where all files are in the directory C<path>.
4408 C<names> is the list of files from this directory.
4410 On return you get a list of stat structs, with a one-to-one
4411 correspondence to the C<names> list. If any name did not exist
4412 or could not be lstat'd, then the C<ino> field of that structure
4415 This call is intended for programs that want to efficiently
4416 list a directory contents without making many round-trips.
4417 See also C<guestfs_lxattrlist> for a similarly efficient call
4418 for getting extended attributes. Very long directory listings
4419 might cause the protocol message size to be exceeded, causing
4420 this call to fail. The caller must split up such requests
4421 into smaller groups of names.");
4423 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4425 "lgetxattr on multiple files",
4427 This call allows you to get the extended attributes
4428 of multiple files, where all files are in the directory C<path>.
4429 C<names> is the list of files from this directory.
4431 On return you get a flat list of xattr structs which must be
4432 interpreted sequentially. The first xattr struct always has a zero-length
4433 C<attrname>. C<attrval> in this struct is zero-length
4434 to indicate there was an error doing C<lgetxattr> for this
4435 file, I<or> is a C string which is a decimal number
4436 (the number of following attributes for this file, which could
4437 be C<\"0\">). Then after the first xattr struct are the
4438 zero or more attributes for the first named file.
4439 This repeats for the second and subsequent files.
4441 This call is intended for programs that want to efficiently
4442 list a directory contents without making many round-trips.
4443 See also C<guestfs_lstatlist> for a similarly efficient call
4444 for getting standard stats. Very long directory listings
4445 might cause the protocol message size to be exceeded, causing
4446 this call to fail. The caller must split up such requests
4447 into smaller groups of names.");
4449 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4451 "readlink on multiple files",