1 =head2 guestfs_add_cdrom
3 int guestfs_add_cdrom (guestfs_h *handle,
6 This function adds a virtual CD-ROM disk image to the guest.
8 This is equivalent to the qemu parameter C<-cdrom filename>.
10 This function returns 0 on success or -1 on error.
12 =head2 guestfs_add_drive
14 int guestfs_add_drive (guestfs_h *handle,
15 const char *filename);
17 This function adds a virtual machine disk image C<filename> to the
18 guest. The first time you call this function, the disk appears as IDE
19 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
22 You don't necessarily need to be root when using libguestfs. However
23 you obviously do need sufficient permissions to access the filename
24 for whatever operations you want to perform (ie. read access if you
25 just want to read the image or write access if you want to modify the
28 This is equivalent to the qemu parameter C<-drive file=filename>.
30 This function returns 0 on success or -1 on error.
32 =head2 guestfs_aug_close
34 int guestfs_aug_close (guestfs_h *handle);
36 Close the current Augeas handle and free up any resources
37 used by it. After calling this, you have to call
38 C<guestfs_aug_init> again before you can use any other
41 This function returns 0 on success or -1 on error.
43 =head2 guestfs_aug_defnode
45 struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *handle,
50 Defines a variable C<name> whose value is the result of
53 If C<expr> evaluates to an empty nodeset, a node is created,
54 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
55 C<name> will be the nodeset containing that single node.
57 On success this returns a pair containing the
58 number of nodes in the nodeset, and a boolean flag
59 if a node was created.
61 This function returns a C<struct guestfs_int_bool *>,
62 or NULL if there was an error.
63 I<The caller must call C<guestfs_free_int_bool> after use>.
65 =head2 guestfs_aug_defvar
67 int guestfs_aug_defvar (guestfs_h *handle,
71 Defines an Augeas variable C<name> whose value is the result
72 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
75 On success this returns the number of nodes in C<expr>, or
76 C<0> if C<expr> evaluates to something which is not a nodeset.
78 On error this function returns -1.
80 =head2 guestfs_aug_get
82 char *guestfs_aug_get (guestfs_h *handle,
85 Look up the value associated with C<path>. If C<path>
86 matches exactly one node, the C<value> is returned.
88 This function returns a string, or NULL on error.
89 I<The caller must free the returned string after use>.
91 =head2 guestfs_aug_init
93 int guestfs_aug_init (guestfs_h *handle,
97 Create a new Augeas handle for editing configuration files.
98 If there was any previous Augeas handle associated with this
99 guestfs session, then it is closed.
101 You must call this before using any other C<guestfs_aug_*>
104 C<root> is the filesystem root. C<root> must not be NULL,
107 The flags are the same as the flags defined in
108 E<lt>augeas.hE<gt>, the logical I<or> of the following
113 =item C<AUG_SAVE_BACKUP> = 1
115 Keep the original file with a C<.augsave> extension.
117 =item C<AUG_SAVE_NEWFILE> = 2
119 Save changes into a file with extension C<.augnew>, and
120 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
122 =item C<AUG_TYPE_CHECK> = 4
124 Typecheck lenses (can be expensive).
126 =item C<AUG_NO_STDINC> = 8
128 Do not use standard load path for modules.
130 =item C<AUG_SAVE_NOOP> = 16
132 Make save a no-op, just record what would have been changed.
134 =item C<AUG_NO_LOAD> = 32
136 Do not load the tree in C<guestfs_aug_init>.
140 To close the handle, you can call C<guestfs_aug_close>.
142 To find out more about Augeas, see L<http://augeas.net/>.
144 This function returns 0 on success or -1 on error.
146 =head2 guestfs_aug_insert
148 int guestfs_aug_insert (guestfs_h *handle,
153 Create a new sibling C<label> for C<path>, inserting it into
154 the tree before or after C<path> (depending on the boolean
157 C<path> must match exactly one existing node in the tree, and
158 C<label> must be a label, ie. not contain C</>, C<*> or end
159 with a bracketed index C<[N]>.
161 This function returns 0 on success or -1 on error.
163 =head2 guestfs_aug_load
165 int guestfs_aug_load (guestfs_h *handle);
167 Load files into the tree.
169 See C<aug_load> in the Augeas documentation for the full gory
172 This function returns 0 on success or -1 on error.
174 =head2 guestfs_aug_ls
176 char **guestfs_aug_ls (guestfs_h *handle,
179 This is just a shortcut for listing C<guestfs_aug_match>
180 C<path/*> and sorting the resulting nodes into alphabetical order.
182 This function returns a NULL-terminated array of strings
183 (like L<environ(3)>), or NULL if there was an error.
184 I<The caller must free the strings and the array after use>.
186 =head2 guestfs_aug_match
188 char **guestfs_aug_match (guestfs_h *handle,
191 Returns a list of paths which match the path expression C<path>.
192 The returned paths are sufficiently qualified so that they match
193 exactly one node in the current tree.
195 This function returns a NULL-terminated array of strings
196 (like L<environ(3)>), or NULL if there was an error.
197 I<The caller must free the strings and the array after use>.
199 =head2 guestfs_aug_mv
201 int guestfs_aug_mv (guestfs_h *handle,
205 Move the node C<src> to C<dest>. C<src> must match exactly
206 one node. C<dest> is overwritten if it exists.
208 This function returns 0 on success or -1 on error.
210 =head2 guestfs_aug_rm
212 int guestfs_aug_rm (guestfs_h *handle,
215 Remove C<path> and all of its children.
217 On success this returns the number of entries which were removed.
219 On error this function returns -1.
221 =head2 guestfs_aug_save
223 int guestfs_aug_save (guestfs_h *handle);
225 This writes all pending changes to disk.
227 The flags which were passed to C<guestfs_aug_init> affect exactly
230 This function returns 0 on success or -1 on error.
232 =head2 guestfs_aug_set
234 int guestfs_aug_set (guestfs_h *handle,
238 Set the value associated with C<path> to C<value>.
240 This function returns 0 on success or -1 on error.
242 =head2 guestfs_blockdev_flushbufs
244 int guestfs_blockdev_flushbufs (guestfs_h *handle,
247 This tells the kernel to flush internal buffers associated
250 This uses the L<blockdev(8)> command.
252 This function returns 0 on success or -1 on error.
254 =head2 guestfs_blockdev_getbsz
256 int guestfs_blockdev_getbsz (guestfs_h *handle,
259 This returns the block size of a device.
261 (Note this is different from both I<size in blocks> and
262 I<filesystem block size>).
264 This uses the L<blockdev(8)> command.
266 On error this function returns -1.
268 =head2 guestfs_blockdev_getro
270 int guestfs_blockdev_getro (guestfs_h *handle,
273 Returns a boolean indicating if the block device is read-only
274 (true if read-only, false if not).
276 This uses the L<blockdev(8)> command.
278 This function returns a C truth value on success or -1 on error.
280 =head2 guestfs_blockdev_getsize64
282 int64_t guestfs_blockdev_getsize64 (guestfs_h *handle,
285 This returns the size of the device in bytes.
287 See also C<guestfs_blockdev_getsz>.
289 This uses the L<blockdev(8)> command.
291 On error this function returns -1.
293 =head2 guestfs_blockdev_getss
295 int guestfs_blockdev_getss (guestfs_h *handle,
298 This returns the size of sectors on a block device.
299 Usually 512, but can be larger for modern devices.
301 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
304 This uses the L<blockdev(8)> command.
306 On error this function returns -1.
308 =head2 guestfs_blockdev_getsz
310 int64_t guestfs_blockdev_getsz (guestfs_h *handle,
313 This returns the size of the device in units of 512-byte sectors
314 (even if the sectorsize isn't 512 bytes ... weird).
316 See also C<guestfs_blockdev_getss> for the real sector size of
317 the device, and C<guestfs_blockdev_getsize64> for the more
318 useful I<size in bytes>.
320 This uses the L<blockdev(8)> command.
322 On error this function returns -1.
324 =head2 guestfs_blockdev_rereadpt
326 int guestfs_blockdev_rereadpt (guestfs_h *handle,
329 Reread the partition table on C<device>.
331 This uses the L<blockdev(8)> command.
333 This function returns 0 on success or -1 on error.
335 =head2 guestfs_blockdev_setbsz
337 int guestfs_blockdev_setbsz (guestfs_h *handle,
341 This sets the block size of a device.
343 (Note this is different from both I<size in blocks> and
344 I<filesystem block size>).
346 This uses the L<blockdev(8)> command.
348 This function returns 0 on success or -1 on error.
350 =head2 guestfs_blockdev_setro
352 int guestfs_blockdev_setro (guestfs_h *handle,
355 Sets the block device named C<device> to read-only.
357 This uses the L<blockdev(8)> command.
359 This function returns 0 on success or -1 on error.
361 =head2 guestfs_blockdev_setrw
363 int guestfs_blockdev_setrw (guestfs_h *handle,
366 Sets the block device named C<device> to read-write.
368 This uses the L<blockdev(8)> command.
370 This function returns 0 on success or -1 on error.
374 char *guestfs_cat (guestfs_h *handle,
377 Return the contents of the file named C<path>.
379 Note that this function cannot correctly handle binary files
380 (specifically, files containing C<\0> character which is treated
381 as end of string). For those you need to use the C<guestfs_download>
382 function which has a more complex interface.
384 This function returns a string, or NULL on error.
385 I<The caller must free the returned string after use>.
387 Because of the message protocol, there is a transfer limit
388 of somewhere between 2MB and 4MB. To transfer large files you should use
391 =head2 guestfs_checksum
393 char *guestfs_checksum (guestfs_h *handle,
394 const char *csumtype,
397 This call computes the MD5, SHAx or CRC checksum of the
400 The type of checksum to compute is given by the C<csumtype>
401 parameter which must have one of the following values:
407 Compute the cyclic redundancy check (CRC) specified by POSIX
408 for the C<cksum> command.
412 Compute the MD5 hash (using the C<md5sum> program).
416 Compute the SHA1 hash (using the C<sha1sum> program).
420 Compute the SHA224 hash (using the C<sha224sum> program).
424 Compute the SHA256 hash (using the C<sha256sum> program).
428 Compute the SHA384 hash (using the C<sha384sum> program).
432 Compute the SHA512 hash (using the C<sha512sum> program).
436 The checksum is returned as a printable string.
438 This function returns a string, or NULL on error.
439 I<The caller must free the returned string after use>.
443 int guestfs_chmod (guestfs_h *handle,
447 Change the mode (permissions) of C<path> to C<mode>. Only
448 numeric modes are supported.
450 This function returns 0 on success or -1 on error.
454 int guestfs_chown (guestfs_h *handle,
459 Change the file owner to C<owner> and group to C<group>.
461 Only numeric uid and gid are supported. If you want to use
462 names, you will need to locate and parse the password file
463 yourself (Augeas support makes this relatively easy).
465 This function returns 0 on success or -1 on error.
467 =head2 guestfs_command
469 char *guestfs_command (guestfs_h *handle,
470 char * const* const arguments);
472 This call runs a command from the guest filesystem. The
473 filesystem must be mounted, and must contain a compatible
474 operating system (ie. something Linux, with the same
475 or compatible processor architecture).
477 The single parameter is an argv-style list of arguments.
478 The first element is the name of the program to run.
479 Subsequent elements are parameters. The list must be
480 non-empty (ie. must contain a program name).
482 The return value is anything printed to I<stdout> by
485 If the command returns a non-zero exit status, then
486 this function returns an error message. The error message
487 string is the content of I<stderr> from the command.
489 The C<$PATH> environment variable will contain at least
490 C</usr/bin> and C</bin>. If you require a program from
491 another location, you should provide the full path in the
494 Shared libraries and data files required by the program
495 must be available on filesystems which are mounted in the
496 correct places. It is the caller's responsibility to ensure
497 all filesystems that are needed are mounted at the right
500 This function returns a string, or NULL on error.
501 I<The caller must free the returned string after use>.
503 Because of the message protocol, there is a transfer limit
504 of somewhere between 2MB and 4MB. To transfer large files you should use
507 =head2 guestfs_command_lines
509 char **guestfs_command_lines (guestfs_h *handle,
510 char * const* const arguments);
512 This is the same as C<guestfs_command>, but splits the
513 result into a list of lines.
515 This function returns a NULL-terminated array of strings
516 (like L<environ(3)>), or NULL if there was an error.
517 I<The caller must free the strings and the array after use>.
519 Because of the message protocol, there is a transfer limit
520 of somewhere between 2MB and 4MB. To transfer large files you should use
523 =head2 guestfs_config
525 int guestfs_config (guestfs_h *handle,
526 const char *qemuparam,
527 const char *qemuvalue);
529 This can be used to add arbitrary qemu command line parameters
530 of the form C<-param value>. Actually it's not quite arbitrary - we
531 prevent you from setting some parameters which would interfere with
532 parameters that we use.
534 The first character of C<param> string must be a C<-> (dash).
536 C<value> can be NULL.
538 This function returns 0 on success or -1 on error.
542 int guestfs_cp (guestfs_h *handle,
546 This copies a file from C<src> to C<dest> where C<dest> is
547 either a destination filename or destination directory.
549 This function returns 0 on success or -1 on error.
553 int guestfs_cp_a (guestfs_h *handle,
557 This copies a file or directory from C<src> to C<dest>
558 recursively using the C<cp -a> command.
560 This function returns 0 on success or -1 on error.
564 char *guestfs_debug (guestfs_h *handle,
566 char * const* const extraargs);
568 The C<guestfs_debug> command exposes some internals of
569 C<guestfsd> (the guestfs daemon) that runs inside the
572 There is no comprehensive help for this command. You have
573 to look at the file C<daemon/debug.c> in the libguestfs source
574 to find out what you can do.
576 This function returns a string, or NULL on error.
577 I<The caller must free the returned string after use>.
581 char *guestfs_dmesg (guestfs_h *handle);
583 This returns the kernel messages (C<dmesg> output) from
584 the guest kernel. This is sometimes useful for extended
585 debugging of problems.
587 Another way to get the same information is to enable
588 verbose messages with C<guestfs_set_verbose> or by setting
589 the environment variable C<LIBGUESTFS_DEBUG=1> before
592 This function returns a string, or NULL on error.
593 I<The caller must free the returned string after use>.
595 =head2 guestfs_download
597 int guestfs_download (guestfs_h *handle,
598 const char *remotefilename,
599 const char *filename);
601 Download file C<remotefilename> and save it as C<filename>
602 on the local machine.
604 C<filename> can also be a named pipe.
606 See also C<guestfs_upload>, C<guestfs_cat>.
608 This function returns 0 on success or -1 on error.
610 =head2 guestfs_drop_caches
612 int guestfs_drop_caches (guestfs_h *handle,
615 This instructs the guest kernel to drop its page cache,
616 and/or dentries and inode caches. The parameter C<whattodrop>
617 tells the kernel what precisely to drop, see
618 L<http://linux-mm.org/Drop_Caches>
620 Setting C<whattodrop> to 3 should drop everything.
622 This automatically calls L<sync(2)> before the operation,
623 so that the maximum guest memory is freed.
625 This function returns 0 on success or -1 on error.
627 =head2 guestfs_e2fsck_f
629 int guestfs_e2fsck_f (guestfs_h *handle,
632 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
633 filesystem checker on C<device>, noninteractively (C<-p>),
634 even if the filesystem appears to be clean (C<-f>).
636 This command is only needed because of C<guestfs_resize2fs>
637 (q.v.). Normally you should use C<guestfs_fsck>.
639 This function returns 0 on success or -1 on error.
641 =head2 guestfs_end_busy
643 int guestfs_end_busy (guestfs_h *handle);
645 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
646 state as is. This is only used when implementing
647 actions using the low-level API.
649 For more information on states, see L<guestfs(3)>.
651 This function returns 0 on success or -1 on error.
655 int guestfs_equal (guestfs_h *handle,
659 This compares the two files C<file1> and C<file2> and returns
660 true if their content is exactly equal, or false otherwise.
662 The external L<cmp(1)> program is used for the comparison.
664 This function returns a C truth value on success or -1 on error.
666 =head2 guestfs_exists
668 int guestfs_exists (guestfs_h *handle,
671 This returns C<true> if and only if there is a file, directory
672 (or anything) with the given C<path> name.
674 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.
676 This function returns a C truth value on success or -1 on error.
680 char *guestfs_file (guestfs_h *handle,
683 This call uses the standard L<file(1)> command to determine
684 the type or contents of the file. This also works on devices,
685 for example to find out whether a partition contains a filesystem.
687 The exact command which runs is C<file -bsL path>. Note in
688 particular that the filename is not prepended to the output
691 This function returns a string, or NULL on error.
692 I<The caller must free the returned string after use>.
696 char **guestfs_find (guestfs_h *handle,
697 const char *directory);
699 This command lists out all files and directories, recursively,
700 starting at C<directory>. It is essentially equivalent to
701 running the shell command C<find directory -print> but some
702 post-processing happens on the output, described below.
704 This returns a list of strings I<without any prefix>. Thus
705 if the directory structure was:
711 then the returned list from C<guestfs_find> C</tmp> would be
719 If C<directory> is not a directory, then this command returns
722 The returned list is sorted.
724 This function returns a NULL-terminated array of strings
725 (like L<environ(3)>), or NULL if there was an error.
726 I<The caller must free the strings and the array after use>.
730 int guestfs_fsck (guestfs_h *handle,
734 This runs the filesystem checker (fsck) on C<device> which
735 should have filesystem type C<fstype>.
737 The returned integer is the status. See L<fsck(8)> for the
738 list of status codes from C<fsck>.
746 Multiple status codes can be summed together.
750 A non-zero return code can mean "success", for example if
751 errors have been corrected on the filesystem.
755 Checking or repairing NTFS volumes is not supported
760 This command is entirely equivalent to running C<fsck -a -t fstype device>.
762 On error this function returns -1.
764 =head2 guestfs_get_append
766 const char *guestfs_get_append (guestfs_h *handle);
768 Return the additional kernel options which are added to the
769 guest kernel command line.
771 If C<NULL> then no options are added.
773 This function returns a string, or NULL on error.
774 The string is owned by the guest handle and must I<not> be freed.
776 =head2 guestfs_get_autosync
778 int guestfs_get_autosync (guestfs_h *handle);
780 Get the autosync flag.
782 This function returns a C truth value on success or -1 on error.
784 =head2 guestfs_get_e2label
786 char *guestfs_get_e2label (guestfs_h *handle,
789 This returns the ext2/3/4 filesystem label of the filesystem on
792 This function returns a string, or NULL on error.
793 I<The caller must free the returned string after use>.
795 =head2 guestfs_get_e2uuid
797 char *guestfs_get_e2uuid (guestfs_h *handle,
800 This returns the ext2/3/4 filesystem UUID of the filesystem on
803 This function returns a string, or NULL on error.
804 I<The caller must free the returned string after use>.
806 =head2 guestfs_get_path
808 const char *guestfs_get_path (guestfs_h *handle);
810 Return the current search path.
812 This is always non-NULL. If it wasn't set already, then this will
813 return the default path.
815 This function returns a string, or NULL on error.
816 The string is owned by the guest handle and must I<not> be freed.
818 =head2 guestfs_get_qemu
820 const char *guestfs_get_qemu (guestfs_h *handle);
822 Return the current qemu binary.
824 This is always non-NULL. If it wasn't set already, then this will
825 return the default qemu binary name.
827 This function returns a string, or NULL on error.
828 The string is owned by the guest handle and must I<not> be freed.
830 =head2 guestfs_get_state
832 int guestfs_get_state (guestfs_h *handle);
834 This returns the current state as an opaque integer. This is
835 only useful for printing debug and internal error messages.
837 For more information on states, see L<guestfs(3)>.
839 On error this function returns -1.
841 =head2 guestfs_get_verbose
843 int guestfs_get_verbose (guestfs_h *handle);
845 This returns the verbose messages flag.
847 This function returns a C truth value on success or -1 on error.
849 =head2 guestfs_grub_install
851 int guestfs_grub_install (guestfs_h *handle,
855 This command installs GRUB (the Grand Unified Bootloader) on
856 C<device>, with the root directory being C<root>.
858 This function returns 0 on success or -1 on error.
860 =head2 guestfs_hexdump
862 char *guestfs_hexdump (guestfs_h *handle,
865 This runs C<hexdump -C> on the given C<path>. The result is
866 the human-readable, canonical hex dump of the file.
868 This function returns a string, or NULL on error.
869 I<The caller must free the returned string after use>.
871 Because of the message protocol, there is a transfer limit
872 of somewhere between 2MB and 4MB. To transfer large files you should use
875 =head2 guestfs_is_busy
877 int guestfs_is_busy (guestfs_h *handle);
879 This returns true iff this handle is busy processing a command
880 (in the C<BUSY> state).
882 For more information on states, see L<guestfs(3)>.
884 This function returns a C truth value on success or -1 on error.
886 =head2 guestfs_is_config
888 int guestfs_is_config (guestfs_h *handle);
890 This returns true iff this handle is being configured
891 (in the C<CONFIG> state).
893 For more information on states, see L<guestfs(3)>.
895 This function returns a C truth value on success or -1 on error.
897 =head2 guestfs_is_dir
899 int guestfs_is_dir (guestfs_h *handle,
902 This returns C<true> if and only if there is a directory
903 with the given C<path> name. Note that it returns false for
904 other objects like files.
906 See also C<guestfs_stat>.
908 This function returns a C truth value on success or -1 on error.
910 =head2 guestfs_is_file
912 int guestfs_is_file (guestfs_h *handle,
915 This returns C<true> if and only if there is a file
916 with the given C<path> name. Note that it returns false for
917 other objects like directories.
919 See also C<guestfs_stat>.
921 This function returns a C truth value on success or -1 on error.
923 =head2 guestfs_is_launching
925 int guestfs_is_launching (guestfs_h *handle);
927 This returns true iff this handle is launching the subprocess
928 (in the C<LAUNCHING> state).
930 For more information on states, see L<guestfs(3)>.
932 This function returns a C truth value on success or -1 on error.
934 =head2 guestfs_is_ready
936 int guestfs_is_ready (guestfs_h *handle);
938 This returns true iff this handle is ready to accept commands
939 (in the C<READY> state).
941 For more information on states, see L<guestfs(3)>.
943 This function returns a C truth value on success or -1 on error.
945 =head2 guestfs_kill_subprocess
947 int guestfs_kill_subprocess (guestfs_h *handle);
949 This kills the qemu subprocess. You should never need to call this.
951 This function returns 0 on success or -1 on error.
953 =head2 guestfs_launch
955 int guestfs_launch (guestfs_h *handle);
957 Internally libguestfs is implemented by running a virtual machine
960 You should call this after configuring the handle
961 (eg. adding drives) but before performing any actions.
963 This function returns 0 on success or -1 on error.
965 =head2 guestfs_list_devices
967 char **guestfs_list_devices (guestfs_h *handle);
969 List all the block devices.
971 The full block device names are returned, eg. C</dev/sda>
973 This function returns a NULL-terminated array of strings
974 (like L<environ(3)>), or NULL if there was an error.
975 I<The caller must free the strings and the array after use>.
977 =head2 guestfs_list_partitions
979 char **guestfs_list_partitions (guestfs_h *handle);
981 List all the partitions detected on all block devices.
983 The full partition device names are returned, eg. C</dev/sda1>
985 This does not return logical volumes. For that you will need to
988 This function returns a NULL-terminated array of strings
989 (like L<environ(3)>), or NULL if there was an error.
990 I<The caller must free the strings and the array after use>.
994 char *guestfs_ll (guestfs_h *handle,
995 const char *directory);
997 List the files in C<directory> (relative to the root directory,
998 there is no cwd) in the format of 'ls -la'.
1000 This command is mostly useful for interactive sessions. It
1001 is I<not> intended that you try to parse the output string.
1003 This function returns a string, or NULL on error.
1004 I<The caller must free the returned string after use>.
1008 char **guestfs_ls (guestfs_h *handle,
1009 const char *directory);
1011 List the files in C<directory> (relative to the root directory,
1012 there is no cwd). The '.' and '..' entries are not returned, but
1013 hidden files are shown.
1015 This command is mostly useful for interactive sessions. Programs
1016 should probably use C<guestfs_readdir> instead.
1018 This function returns a NULL-terminated array of strings
1019 (like L<environ(3)>), or NULL if there was an error.
1020 I<The caller must free the strings and the array after use>.
1022 =head2 guestfs_lstat
1024 struct guestfs_stat *guestfs_lstat (guestfs_h *handle,
1027 Returns file information for the given C<path>.
1029 This is the same as C<guestfs_stat> except that if C<path>
1030 is a symbolic link, then the link is stat-ed, not the file it
1033 This is the same as the C<lstat(2)> system call.
1035 This function returns a C<struct guestfs_stat *>
1036 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1037 or NULL if there was an error.
1038 I<The caller must call C<free> after use>.
1040 =head2 guestfs_lvcreate
1042 int guestfs_lvcreate (guestfs_h *handle,
1044 const char *volgroup,
1047 This creates an LVM volume group called C<logvol>
1048 on the volume group C<volgroup>, with C<size> megabytes.
1050 This function returns 0 on success or -1 on error.
1052 =head2 guestfs_lvm_remove_all
1054 int guestfs_lvm_remove_all (guestfs_h *handle);
1056 This command removes all LVM logical volumes, volume groups
1057 and physical volumes.
1059 This function returns 0 on success or -1 on error.
1061 B<This command is dangerous. Without careful use you
1062 can easily destroy all your data>.
1064 =head2 guestfs_lvremove
1066 int guestfs_lvremove (guestfs_h *handle,
1067 const char *device);
1069 Remove an LVM logical volume C<device>, where C<device> is
1070 the path to the LV, such as C</dev/VG/LV>.
1072 You can also remove all LVs in a volume group by specifying
1073 the VG name, C</dev/VG>.
1075 This function returns 0 on success or -1 on error.
1077 =head2 guestfs_lvresize
1079 int guestfs_lvresize (guestfs_h *handle,
1083 This resizes (expands or shrinks) an existing LVM logical
1084 volume to C<mbytes>. When reducing, data in the reduced part
1087 This function returns 0 on success or -1 on error.
1091 char **guestfs_lvs (guestfs_h *handle);
1093 List all the logical volumes detected. This is the equivalent
1094 of the L<lvs(8)> command.
1096 This returns a list of the logical volume device names
1097 (eg. C</dev/VolGroup00/LogVol00>).
1099 See also C<guestfs_lvs_full>.
1101 This function returns a NULL-terminated array of strings
1102 (like L<environ(3)>), or NULL if there was an error.
1103 I<The caller must free the strings and the array after use>.
1105 =head2 guestfs_lvs_full
1107 struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *handle);
1109 List all the logical volumes detected. This is the equivalent
1110 of the L<lvs(8)> command. The "full" version includes all fields.
1112 This function returns a C<struct guestfs_lvm_lv_list *>
1113 (see E<lt>guestfs-structs.hE<gt>),
1114 or NULL if there was an error.
1115 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.
1117 =head2 guestfs_mkdir
1119 int guestfs_mkdir (guestfs_h *handle,
1122 Create a directory named C<path>.
1124 This function returns 0 on success or -1 on error.
1126 =head2 guestfs_mkdir_p
1128 int guestfs_mkdir_p (guestfs_h *handle,
1131 Create a directory named C<path>, creating any parent directories
1132 as necessary. This is like the C<mkdir -p> shell command.
1134 This function returns 0 on success or -1 on error.
1138 int guestfs_mkfs (guestfs_h *handle,
1140 const char *device);
1142 This creates a filesystem on C<device> (usually a partition
1143 or LVM logical volume). The filesystem type is C<fstype>, for
1146 This function returns 0 on success or -1 on error.
1148 =head2 guestfs_mount
1150 int guestfs_mount (guestfs_h *handle,
1152 const char *mountpoint);
1154 Mount a guest disk at a position in the filesystem. Block devices
1155 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1156 the guest. If those block devices contain partitions, they will have
1157 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1160 The rules are the same as for L<mount(2)>: A filesystem must
1161 first be mounted on C</> before others can be mounted. Other
1162 filesystems can only be mounted on directories which already
1165 The mounted filesystem is writable, if we have sufficient permissions
1166 on the underlying device.
1168 The filesystem options C<sync> and C<noatime> are set with this
1169 call, in order to improve reliability.
1171 This function returns 0 on success or -1 on error.
1173 =head2 guestfs_mount_options
1175 int guestfs_mount_options (guestfs_h *handle,
1176 const char *options,
1178 const char *mountpoint);
1180 This is the same as the C<guestfs_mount> command, but it
1181 allows you to set the mount options as for the
1182 L<mount(8)> I<-o> flag.
1184 This function returns 0 on success or -1 on error.
1186 =head2 guestfs_mount_ro
1188 int guestfs_mount_ro (guestfs_h *handle,
1190 const char *mountpoint);
1192 This is the same as the C<guestfs_mount> command, but it
1193 mounts the filesystem with the read-only (I<-o ro>) flag.
1195 This function returns 0 on success or -1 on error.
1197 =head2 guestfs_mount_vfs
1199 int guestfs_mount_vfs (guestfs_h *handle,
1200 const char *options,
1201 const char *vfstype,
1203 const char *mountpoint);
1205 This is the same as the C<guestfs_mount> command, but it
1206 allows you to set both the mount options and the vfstype
1207 as for the L<mount(8)> I<-o> and I<-t> flags.
1209 This function returns 0 on success or -1 on error.
1211 =head2 guestfs_mounts
1213 char **guestfs_mounts (guestfs_h *handle);
1215 This returns the list of currently mounted filesystems. It returns
1216 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1218 Some internal mounts are not shown.
1220 This function returns a NULL-terminated array of strings
1221 (like L<environ(3)>), or NULL if there was an error.
1222 I<The caller must free the strings and the array after use>.
1226 int guestfs_mv (guestfs_h *handle,
1230 This moves a file from C<src> to C<dest> where C<dest> is
1231 either a destination filename or destination directory.
1233 This function returns 0 on success or -1 on error.
1235 =head2 guestfs_ping_daemon
1237 int guestfs_ping_daemon (guestfs_h *handle);
1239 This is a test probe into the guestfs daemon running inside
1240 the qemu subprocess. Calling this function checks that the
1241 daemon responds to the ping message, without affecting the daemon
1242 or attached block device(s) in any other way.
1244 This function returns 0 on success or -1 on error.
1246 =head2 guestfs_pvcreate
1248 int guestfs_pvcreate (guestfs_h *handle,
1249 const char *device);
1251 This creates an LVM physical volume on the named C<device>,
1252 where C<device> should usually be a partition name such
1255 This function returns 0 on success or -1 on error.
1257 =head2 guestfs_pvremove
1259 int guestfs_pvremove (guestfs_h *handle,
1260 const char *device);
1262 This wipes a physical volume C<device> so that LVM will no longer
1265 The implementation uses the C<pvremove> command which refuses to
1266 wipe physical volumes that contain any volume groups, so you have
1267 to remove those first.
1269 This function returns 0 on success or -1 on error.
1271 =head2 guestfs_pvresize
1273 int guestfs_pvresize (guestfs_h *handle,
1274 const char *device);
1276 This resizes (expands or shrinks) an existing LVM physical
1277 volume to match the new size of the underlying device.
1279 This function returns 0 on success or -1 on error.
1283 char **guestfs_pvs (guestfs_h *handle);
1285 List all the physical volumes detected. This is the equivalent
1286 of the L<pvs(8)> command.
1288 This returns a list of just the device names that contain
1289 PVs (eg. C</dev/sda2>).
1291 See also C<guestfs_pvs_full>.
1293 This function returns a NULL-terminated array of strings
1294 (like L<environ(3)>), or NULL if there was an error.
1295 I<The caller must free the strings and the array after use>.
1297 =head2 guestfs_pvs_full
1299 struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *handle);
1301 List all the physical volumes detected. This is the equivalent
1302 of the L<pvs(8)> command. The "full" version includes all fields.
1304 This function returns a C<struct guestfs_lvm_pv_list *>
1305 (see E<lt>guestfs-structs.hE<gt>),
1306 or NULL if there was an error.
1307 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.
1309 =head2 guestfs_read_lines
1311 char **guestfs_read_lines (guestfs_h *handle,
1314 Return the contents of the file named C<path>.
1316 The file contents are returned as a list of lines. Trailing
1317 C<LF> and C<CRLF> character sequences are I<not> returned.
1319 Note that this function cannot correctly handle binary files
1320 (specifically, files containing C<\0> character which is treated
1321 as end of line). For those you need to use the C<guestfs_read_file>
1322 function which has a more complex interface.
1324 This function returns a NULL-terminated array of strings
1325 (like L<environ(3)>), or NULL if there was an error.
1326 I<The caller must free the strings and the array after use>.
1328 =head2 guestfs_resize2fs
1330 int guestfs_resize2fs (guestfs_h *handle,
1331 const char *device);
1333 This resizes an ext2 or ext3 filesystem to match the size of
1334 the underlying device.
1336 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
1337 on the C<device> before calling this command. For unknown reasons
1338 C<resize2fs> sometimes gives an error about this and sometimes not.
1339 In any case, it is always safe to call C<guestfs_e2fsck_f> before
1340 calling this function.
1342 This function returns 0 on success or -1 on error.
1346 int guestfs_rm (guestfs_h *handle,
1349 Remove the single file C<path>.
1351 This function returns 0 on success or -1 on error.
1353 =head2 guestfs_rm_rf
1355 int guestfs_rm_rf (guestfs_h *handle,
1358 Remove the file or directory C<path>, recursively removing the
1359 contents if its a directory. This is like the C<rm -rf> shell
1362 This function returns 0 on success or -1 on error.
1364 =head2 guestfs_rmdir
1366 int guestfs_rmdir (guestfs_h *handle,
1369 Remove the single directory C<path>.
1371 This function returns 0 on success or -1 on error.
1373 =head2 guestfs_set_append
1375 int guestfs_set_append (guestfs_h *handle,
1376 const char *append);
1378 This function is used to add additional options to the
1379 guest kernel command line.
1381 The default is C<NULL> unless overridden by setting
1382 C<LIBGUESTFS_APPEND> environment variable.
1384 Setting C<append> to C<NULL> means I<no> additional options
1385 are passed (libguestfs always adds a few of its own).
1387 This function returns 0 on success or -1 on error.
1389 =head2 guestfs_set_autosync
1391 int guestfs_set_autosync (guestfs_h *handle,
1394 If C<autosync> is true, this enables autosync. Libguestfs will make a
1395 best effort attempt to run C<guestfs_umount_all> followed by
1396 C<guestfs_sync> when the handle is closed
1397 (also if the program exits without closing handles).
1399 This is disabled by default (except in guestfish where it is
1400 enabled by default).
1402 This function returns 0 on success or -1 on error.
1404 =head2 guestfs_set_busy
1406 int guestfs_set_busy (guestfs_h *handle);
1408 This sets the state to C<BUSY>. This is only used when implementing
1409 actions using the low-level API.
1411 For more information on states, see L<guestfs(3)>.
1413 This function returns 0 on success or -1 on error.
1415 =head2 guestfs_set_e2label
1417 int guestfs_set_e2label (guestfs_h *handle,
1421 This sets the ext2/3/4 filesystem label of the filesystem on
1422 C<device> to C<label>. Filesystem labels are limited to
1425 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1426 to return the existing label on a filesystem.
1428 This function returns 0 on success or -1 on error.
1430 =head2 guestfs_set_e2uuid
1432 int guestfs_set_e2uuid (guestfs_h *handle,
1436 This sets the ext2/3/4 filesystem UUID of the filesystem on
1437 C<device> to C<uuid>. The format of the UUID and alternatives
1438 such as C<clear>, C<random> and C<time> are described in the
1439 L<tune2fs(8)> manpage.
1441 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1442 to return the existing UUID of a filesystem.
1444 This function returns 0 on success or -1 on error.
1446 =head2 guestfs_set_path
1448 int guestfs_set_path (guestfs_h *handle,
1451 Set the path that libguestfs searches for kernel and initrd.img.
1453 The default is C<$libdir/guestfs> unless overridden by setting
1454 C<LIBGUESTFS_PATH> environment variable.
1456 Setting C<path> to C<NULL> restores the default path.
1458 This function returns 0 on success or -1 on error.
1460 =head2 guestfs_set_qemu
1462 int guestfs_set_qemu (guestfs_h *handle,
1465 Set the qemu binary that we will use.
1467 The default is chosen when the library was compiled by the
1470 You can also override this by setting the C<LIBGUESTFS_QEMU>
1471 environment variable.
1473 Setting C<qemu> to C<NULL> restores the default qemu binary.
1475 This function returns 0 on success or -1 on error.
1477 =head2 guestfs_set_ready
1479 int guestfs_set_ready (guestfs_h *handle);
1481 This sets the state to C<READY>. This is only used when implementing
1482 actions using the low-level API.
1484 For more information on states, see L<guestfs(3)>.
1486 This function returns 0 on success or -1 on error.
1488 =head2 guestfs_set_verbose
1490 int guestfs_set_verbose (guestfs_h *handle,
1493 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
1495 Verbose messages are disabled unless the environment variable
1496 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
1498 This function returns 0 on success or -1 on error.
1500 =head2 guestfs_sfdisk
1502 int guestfs_sfdisk (guestfs_h *handle,
1507 char * const* const lines);
1509 This is a direct interface to the L<sfdisk(8)> program for creating
1510 partitions on block devices.
1512 C<device> should be a block device, for example C</dev/sda>.
1514 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1515 and sectors on the device, which are passed directly to sfdisk as
1516 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1517 of these, then the corresponding parameter is omitted. Usually for
1518 'large' disks, you can just pass C<0> for these, but for small
1519 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1520 out the right geometry and you will need to tell it.
1522 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1523 information refer to the L<sfdisk(8)> manpage.
1525 To create a single partition occupying the whole disk, you would
1526 pass C<lines> as a single element list, when the single element being
1527 the string C<,> (comma).
1529 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>
1531 This function returns 0 on success or -1 on error.
1533 B<This command is dangerous. Without careful use you
1534 can easily destroy all your data>.
1536 =head2 guestfs_sfdisk_N
1538 int guestfs_sfdisk_N (guestfs_h *handle,
1546 This runs L<sfdisk(8)> option to modify just the single
1547 partition C<n> (note: C<n> counts from 1).
1549 For other parameters, see C<guestfs_sfdisk>. You should usually
1550 pass C<0> for the cyls/heads/sectors parameters.
1552 This function returns 0 on success or -1 on error.
1554 B<This command is dangerous. Without careful use you
1555 can easily destroy all your data>.
1557 =head2 guestfs_sfdisk_disk_geometry
1559 char *guestfs_sfdisk_disk_geometry (guestfs_h *handle,
1560 const char *device);
1562 This displays the disk geometry of C<device> read from the
1563 partition table. Especially in the case where the underlying
1564 block device has been resized, this can be different from the
1565 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
1567 The result is in human-readable format, and not designed to
1570 This function returns a string, or NULL on error.
1571 I<The caller must free the returned string after use>.
1573 =head2 guestfs_sfdisk_kernel_geometry
1575 char *guestfs_sfdisk_kernel_geometry (guestfs_h *handle,
1576 const char *device);
1578 This displays the kernel's idea of the geometry of C<device>.
1580 The result is in human-readable format, and not designed to
1583 This function returns a string, or NULL on error.
1584 I<The caller must free the returned string after use>.
1586 =head2 guestfs_sfdisk_l
1588 char *guestfs_sfdisk_l (guestfs_h *handle,
1589 const char *device);
1591 This displays the partition table on C<device>, in the
1592 human-readable output of the L<sfdisk(8)> command. It is
1593 not intended to be parsed.
1595 This function returns a string, or NULL on error.
1596 I<The caller must free the returned string after use>.
1600 struct guestfs_stat *guestfs_stat (guestfs_h *handle,
1603 Returns file information for the given C<path>.
1605 This is the same as the C<stat(2)> system call.
1607 This function returns a C<struct guestfs_stat *>
1608 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1609 or NULL if there was an error.
1610 I<The caller must call C<free> after use>.
1612 =head2 guestfs_statvfs
1614 struct guestfs_statvfs *guestfs_statvfs (guestfs_h *handle,
1617 Returns file system statistics for any mounted file system.
1618 C<path> should be a file or directory in the mounted file system
1619 (typically it is the mount point itself, but it doesn't need to be).
1621 This is the same as the C<statvfs(2)> system call.
1623 This function returns a C<struct guestfs_statvfs *>
1624 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
1625 or NULL if there was an error.
1626 I<The caller must call C<free> after use>.
1628 =head2 guestfs_strings
1630 char **guestfs_strings (guestfs_h *handle,
1633 This runs the L<strings(1)> command on a file and returns
1634 the list of printable strings found.
1636 This function returns a NULL-terminated array of strings
1637 (like L<environ(3)>), or NULL if there was an error.
1638 I<The caller must free the strings and the array after use>.
1640 Because of the message protocol, there is a transfer limit
1641 of somewhere between 2MB and 4MB. To transfer large files you should use
1644 =head2 guestfs_strings_e
1646 char **guestfs_strings_e (guestfs_h *handle,
1647 const char *encoding,
1650 This is like the C<guestfs_strings> command, but allows you to
1651 specify the encoding.
1653 See the L<strings(1)> manpage for the full list of encodings.
1655 Commonly useful encodings are C<l> (lower case L) which will
1656 show strings inside Windows/x86 files.
1658 The returned strings are transcoded to UTF-8.
1660 This function returns a NULL-terminated array of strings
1661 (like L<environ(3)>), or NULL if there was an error.
1662 I<The caller must free the strings and the array after use>.
1664 Because of the message protocol, there is a transfer limit
1665 of somewhere between 2MB and 4MB. To transfer large files you should use
1670 int guestfs_sync (guestfs_h *handle);
1672 This syncs the disk, so that any writes are flushed through to the
1673 underlying disk image.
1675 You should always call this if you have modified a disk image, before
1678 This function returns 0 on success or -1 on error.
1680 =head2 guestfs_tar_in
1682 int guestfs_tar_in (guestfs_h *handle,
1683 const char *tarfile,
1684 const char *directory);
1686 This command uploads and unpacks local file C<tarfile> (an
1687 I<uncompressed> tar file) into C<directory>.
1689 To upload a compressed tarball, use C<guestfs_tgz_in>.
1691 This function returns 0 on success or -1 on error.
1693 =head2 guestfs_tar_out
1695 int guestfs_tar_out (guestfs_h *handle,
1696 const char *directory,
1697 const char *tarfile);
1699 This command packs the contents of C<directory> and downloads
1700 it to local file C<tarfile>.
1702 To download a compressed tarball, use C<guestfs_tgz_out>.
1704 This function returns 0 on success or -1 on error.
1706 =head2 guestfs_tgz_in
1708 int guestfs_tgz_in (guestfs_h *handle,
1709 const char *tarball,
1710 const char *directory);
1712 This command uploads and unpacks local file C<tarball> (a
1713 I<gzip compressed> tar file) into C<directory>.
1715 To upload an uncompressed tarball, use C<guestfs_tar_in>.
1717 This function returns 0 on success or -1 on error.
1719 =head2 guestfs_tgz_out
1721 int guestfs_tgz_out (guestfs_h *handle,
1722 const char *directory,
1723 const char *tarball);
1725 This command packs the contents of C<directory> and downloads
1726 it to local file C<tarball>.
1728 To download an uncompressed tarball, use C<guestfs_tar_out>.
1730 This function returns 0 on success or -1 on error.
1732 =head2 guestfs_touch
1734 int guestfs_touch (guestfs_h *handle,
1737 Touch acts like the L<touch(1)> command. It can be used to
1738 update the timestamps on a file, or, if the file does not exist,
1739 to create a new zero-length file.
1741 This function returns 0 on success or -1 on error.
1743 =head2 guestfs_tune2fs_l
1745 char **guestfs_tune2fs_l (guestfs_h *handle,
1746 const char *device);
1748 This returns the contents of the ext2, ext3 or ext4 filesystem
1749 superblock on C<device>.
1751 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1752 manpage for more details. The list of fields returned isn't
1753 clearly defined, and depends on both the version of C<tune2fs>
1754 that libguestfs was built against, and the filesystem itself.
1756 This function returns a NULL-terminated array of
1757 strings, or NULL if there was an error.
1758 The array of strings will always have length C<2n+1>, where
1759 C<n> keys and values alternate, followed by the trailing NULL entry.
1760 I<The caller must free the strings and the array after use>.
1762 =head2 guestfs_umount
1764 int guestfs_umount (guestfs_h *handle,
1765 const char *pathordevice);
1767 This unmounts the given filesystem. The filesystem may be
1768 specified either by its mountpoint (path) or the device which
1769 contains the filesystem.
1771 This function returns 0 on success or -1 on error.
1773 =head2 guestfs_umount_all
1775 int guestfs_umount_all (guestfs_h *handle);
1777 This unmounts all mounted filesystems.
1779 Some internal mounts are not unmounted by this call.
1781 This function returns 0 on success or -1 on error.
1783 =head2 guestfs_upload
1785 int guestfs_upload (guestfs_h *handle,
1786 const char *filename,
1787 const char *remotefilename);
1789 Upload local file C<filename> to C<remotefilename> on the
1792 C<filename> can also be a named pipe.
1794 See also C<guestfs_download>.
1796 This function returns 0 on success or -1 on error.
1798 =head2 guestfs_vg_activate
1800 int guestfs_vg_activate (guestfs_h *handle,
1802 char * const* const volgroups);
1804 This command activates or (if C<activate> is false) deactivates
1805 all logical volumes in the listed volume groups C<volgroups>.
1806 If activated, then they are made known to the
1807 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
1808 then those devices disappear.
1810 This command is the same as running C<vgchange -a y|n volgroups...>
1812 Note that if C<volgroups> is an empty list then B<all> volume groups
1813 are activated or deactivated.
1815 This function returns 0 on success or -1 on error.
1817 =head2 guestfs_vg_activate_all
1819 int guestfs_vg_activate_all (guestfs_h *handle,
1822 This command activates or (if C<activate> is false) deactivates
1823 all logical volumes in all volume groups.
1824 If activated, then they are made known to the
1825 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
1826 then those devices disappear.
1828 This command is the same as running C<vgchange -a y|n>
1830 This function returns 0 on success or -1 on error.
1832 =head2 guestfs_vgcreate
1834 int guestfs_vgcreate (guestfs_h *handle,
1835 const char *volgroup,
1836 char * const* const physvols);
1838 This creates an LVM volume group called C<volgroup>
1839 from the non-empty list of physical volumes C<physvols>.
1841 This function returns 0 on success or -1 on error.
1843 =head2 guestfs_vgremove
1845 int guestfs_vgremove (guestfs_h *handle,
1846 const char *vgname);
1848 Remove an LVM volume group C<vgname>, (for example C<VG>).
1850 This also forcibly removes all logical volumes in the volume
1853 This function returns 0 on success or -1 on error.
1857 char **guestfs_vgs (guestfs_h *handle);
1859 List all the volumes groups detected. This is the equivalent
1860 of the L<vgs(8)> command.
1862 This returns a list of just the volume group names that were
1863 detected (eg. C<VolGroup00>).
1865 See also C<guestfs_vgs_full>.
1867 This function returns a NULL-terminated array of strings
1868 (like L<environ(3)>), or NULL if there was an error.
1869 I<The caller must free the strings and the array after use>.
1871 =head2 guestfs_vgs_full
1873 struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *handle);
1875 List all the volumes groups detected. This is the equivalent
1876 of the L<vgs(8)> command. The "full" version includes all fields.
1878 This function returns a C<struct guestfs_lvm_vg_list *>
1879 (see E<lt>guestfs-structs.hE<gt>),
1880 or NULL if there was an error.
1881 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.
1883 =head2 guestfs_wait_ready
1885 int guestfs_wait_ready (guestfs_h *handle);
1887 Internally libguestfs is implemented by running a virtual machine
1890 You should call this after C<guestfs_launch> to wait for the launch
1893 This function returns 0 on success or -1 on error.
1895 =head2 guestfs_write_file
1897 int guestfs_write_file (guestfs_h *handle,
1899 const char *content,
1902 This call creates a file called C<path>. The contents of the
1903 file is the string C<content> (which can contain any 8 bit data),
1904 with length C<size>.
1906 As a special case, if C<size> is C<0>
1907 then the length is calculated using C<strlen> (so in this case
1908 the content cannot contain embedded ASCII NULs).
1910 I<NB.> Owing to a bug, writing content containing ASCII NUL
1911 characters does I<not> work, even if the length is specified.
1912 We hope to resolve this bug in a future version. In the meantime
1913 use C<guestfs_upload>.
1915 This function returns 0 on success or -1 on error.
1917 Because of the message protocol, there is a transfer limit
1918 of somewhere between 2MB and 4MB. To transfer large files you should use
1923 int guestfs_zero (guestfs_h *handle,
1924 const char *device);
1926 This command writes zeroes over the first few blocks of C<device>.
1928 How many blocks are zeroed isn't specified (but it's I<not> enough
1929 to securely wipe the device). It should be sufficient to remove
1930 any partition tables, filesystem superblocks and so on.
1932 This function returns 0 on success or -1 on error.
1934 =head2 guestfs_zerofree
1936 int guestfs_zerofree (guestfs_h *handle,
1937 const char *device);
1939 This runs the I<zerofree> program on C<device>. This program
1940 claims to zero unused inodes and disk blocks on an ext2/3
1941 filesystem, thus making it possible to compress the filesystem
1944 You should B<not> run this program if the filesystem is
1947 It is possible that using this program can damage the filesystem
1948 or data on the filesystem.
1950 This function returns 0 on success or -1 on error.