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 C<$PATH> environment variable will contain at least
483 C</usr/bin> and C</bin>. If you require a program from
484 another location, you should provide the full path in the
487 Shared libraries and data files required by the program
488 must be available on filesystems which are mounted in the
489 correct places. It is the caller's responsibility to ensure
490 all filesystems that are needed are mounted at the right
493 This function returns a string, or NULL on error.
494 I<The caller must free the returned string after use>.
496 =head2 guestfs_command_lines
498 char **guestfs_command_lines (guestfs_h *handle,
499 char * const* const arguments);
501 This is the same as C<guestfs_command>, but splits the
502 result into a list of lines.
504 This function returns a NULL-terminated array of strings
505 (like L<environ(3)>), or NULL if there was an error.
506 I<The caller must free the strings and the array after use>.
508 =head2 guestfs_config
510 int guestfs_config (guestfs_h *handle,
511 const char *qemuparam,
512 const char *qemuvalue);
514 This can be used to add arbitrary qemu command line parameters
515 of the form C<-param value>. Actually it's not quite arbitrary - we
516 prevent you from setting some parameters which would interfere with
517 parameters that we use.
519 The first character of C<param> string must be a C<-> (dash).
521 C<value> can be NULL.
523 This function returns 0 on success or -1 on error.
527 int guestfs_cp (guestfs_h *handle,
531 This copies a file from C<src> to C<dest> where C<dest> is
532 either a destination filename or destination directory.
534 This function returns 0 on success or -1 on error.
538 int guestfs_cp_a (guestfs_h *handle,
542 This copies a file or directory from C<src> to C<dest>
543 recursively using the C<cp -a> command.
545 This function returns 0 on success or -1 on error.
549 char *guestfs_debug (guestfs_h *handle,
551 char * const* const extraargs);
553 The C<guestfs_debug> command exposes some internals of
554 C<guestfsd> (the guestfs daemon) that runs inside the
557 There is no comprehensive help for this command. You have
558 to look at the file C<daemon/debug.c> in the libguestfs source
559 to find out what you can do.
561 This function returns a string, or NULL on error.
562 I<The caller must free the returned string after use>.
566 char *guestfs_dmesg (guestfs_h *handle);
568 This returns the kernel messages (C<dmesg> output) from
569 the guest kernel. This is sometimes useful for extended
570 debugging of problems.
572 Another way to get the same information is to enable
573 verbose messages with C<guestfs_set_verbose> or by setting
574 the environment variable C<LIBGUESTFS_DEBUG=1> before
577 This function returns a string, or NULL on error.
578 I<The caller must free the returned string after use>.
580 =head2 guestfs_download
582 int guestfs_download (guestfs_h *handle,
583 const char *remotefilename,
584 const char *filename);
586 Download file C<remotefilename> and save it as C<filename>
587 on the local machine.
589 C<filename> can also be a named pipe.
591 See also C<guestfs_upload>, C<guestfs_cat>.
593 This function returns 0 on success or -1 on error.
595 =head2 guestfs_drop_caches
597 int guestfs_drop_caches (guestfs_h *handle,
600 This instructs the guest kernel to drop its page cache,
601 and/or dentries and inode caches. The parameter C<whattodrop>
602 tells the kernel what precisely to drop, see
603 L<http://linux-mm.org/Drop_Caches>
605 Setting C<whattodrop> to 3 should drop everything.
607 This automatically calls L<sync(2)> before the operation,
608 so that the maximum guest memory is freed.
610 This function returns 0 on success or -1 on error.
614 int guestfs_equal (guestfs_h *handle,
618 This compares the two files C<file1> and C<file2> and returns
619 true if their content is exactly equal, or false otherwise.
621 The external L<cmp(1)> program is used for the comparison.
623 This function returns a C truth value on success or -1 on error.
625 =head2 guestfs_exists
627 int guestfs_exists (guestfs_h *handle,
630 This returns C<true> if and only if there is a file, directory
631 (or anything) with the given C<path> name.
633 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.
635 This function returns a C truth value on success or -1 on error.
639 char *guestfs_file (guestfs_h *handle,
642 This call uses the standard L<file(1)> command to determine
643 the type or contents of the file. This also works on devices,
644 for example to find out whether a partition contains a filesystem.
646 The exact command which runs is C<file -bsL path>. Note in
647 particular that the filename is not prepended to the output
650 This function returns a string, or NULL on error.
651 I<The caller must free the returned string after use>.
655 int guestfs_fsck (guestfs_h *handle,
659 This runs the filesystem checker (fsck) on C<device> which
660 should have filesystem type C<fstype>.
662 The returned integer is the status. See L<fsck(8)> for the
663 list of status codes from C<fsck>.
671 Multiple status codes can be summed together.
675 A non-zero return code can mean "success", for example if
676 errors have been corrected on the filesystem.
680 Checking or repairing NTFS volumes is not supported
685 This command is entirely equivalent to running C<fsck -a -t fstype device>.
687 On error this function returns -1.
689 =head2 guestfs_get_autosync
691 int guestfs_get_autosync (guestfs_h *handle);
693 Get the autosync flag.
695 This function returns a C truth value on success or -1 on error.
697 =head2 guestfs_get_e2label
699 char *guestfs_get_e2label (guestfs_h *handle,
702 This returns the ext2/3/4 filesystem label of the filesystem on
705 This function returns a string, or NULL on error.
706 I<The caller must free the returned string after use>.
708 =head2 guestfs_get_e2uuid
710 char *guestfs_get_e2uuid (guestfs_h *handle,
713 This returns the ext2/3/4 filesystem UUID of the filesystem on
716 This function returns a string, or NULL on error.
717 I<The caller must free the returned string after use>.
719 =head2 guestfs_get_path
721 const char *guestfs_get_path (guestfs_h *handle);
723 Return the current search path.
725 This is always non-NULL. If it wasn't set already, then this will
726 return the default path.
728 This function returns a string, or NULL on error.
729 The string is owned by the guest handle and must I<not> be freed.
731 =head2 guestfs_get_qemu
733 const char *guestfs_get_qemu (guestfs_h *handle);
735 Return the current qemu binary.
737 This is always non-NULL. If it wasn't set already, then this will
738 return the default qemu binary name.
740 This function returns a string, or NULL on error.
741 The string is owned by the guest handle and must I<not> be freed.
743 =head2 guestfs_get_state
745 int guestfs_get_state (guestfs_h *handle);
747 This returns the current state as an opaque integer. This is
748 only useful for printing debug and internal error messages.
750 For more information on states, see L<guestfs(3)>.
752 On error this function returns -1.
754 =head2 guestfs_get_verbose
756 int guestfs_get_verbose (guestfs_h *handle);
758 This returns the verbose messages flag.
760 This function returns a C truth value on success or -1 on error.
762 =head2 guestfs_grub_install
764 int guestfs_grub_install (guestfs_h *handle,
768 This command installs GRUB (the Grand Unified Bootloader) on
769 C<device>, with the root directory being C<root>.
771 This function returns 0 on success or -1 on error.
773 =head2 guestfs_hexdump
775 char *guestfs_hexdump (guestfs_h *handle,
778 This runs C<hexdump -C> on the given C<path>. The result is
779 the human-readable, canonical hex dump of the file.
781 This function returns a string, or NULL on error.
782 I<The caller must free the returned string after use>.
784 Because of the message protocol, there is a transfer limit
785 of somewhere between 2MB and 4MB. To transfer large files you should use
788 =head2 guestfs_is_busy
790 int guestfs_is_busy (guestfs_h *handle);
792 This returns true iff this handle is busy processing a command
793 (in the C<BUSY> state).
795 For more information on states, see L<guestfs(3)>.
797 This function returns a C truth value on success or -1 on error.
799 =head2 guestfs_is_config
801 int guestfs_is_config (guestfs_h *handle);
803 This returns true iff this handle is being configured
804 (in the C<CONFIG> state).
806 For more information on states, see L<guestfs(3)>.
808 This function returns a C truth value on success or -1 on error.
810 =head2 guestfs_is_dir
812 int guestfs_is_dir (guestfs_h *handle,
815 This returns C<true> if and only if there is a directory
816 with the given C<path> name. Note that it returns false for
817 other objects like files.
819 See also C<guestfs_stat>.
821 This function returns a C truth value on success or -1 on error.
823 =head2 guestfs_is_file
825 int guestfs_is_file (guestfs_h *handle,
828 This returns C<true> if and only if there is a file
829 with the given C<path> name. Note that it returns false for
830 other objects like directories.
832 See also C<guestfs_stat>.
834 This function returns a C truth value on success or -1 on error.
836 =head2 guestfs_is_launching
838 int guestfs_is_launching (guestfs_h *handle);
840 This returns true iff this handle is launching the subprocess
841 (in the C<LAUNCHING> state).
843 For more information on states, see L<guestfs(3)>.
845 This function returns a C truth value on success or -1 on error.
847 =head2 guestfs_is_ready
849 int guestfs_is_ready (guestfs_h *handle);
851 This returns true iff this handle is ready to accept commands
852 (in the C<READY> state).
854 For more information on states, see L<guestfs(3)>.
856 This function returns a C truth value on success or -1 on error.
858 =head2 guestfs_kill_subprocess
860 int guestfs_kill_subprocess (guestfs_h *handle);
862 This kills the qemu subprocess. You should never need to call this.
864 This function returns 0 on success or -1 on error.
866 =head2 guestfs_launch
868 int guestfs_launch (guestfs_h *handle);
870 Internally libguestfs is implemented by running a virtual machine
873 You should call this after configuring the handle
874 (eg. adding drives) but before performing any actions.
876 This function returns 0 on success or -1 on error.
878 =head2 guestfs_list_devices
880 char **guestfs_list_devices (guestfs_h *handle);
882 List all the block devices.
884 The full block device names are returned, eg. C</dev/sda>
886 This function returns a NULL-terminated array of strings
887 (like L<environ(3)>), or NULL if there was an error.
888 I<The caller must free the strings and the array after use>.
890 =head2 guestfs_list_partitions
892 char **guestfs_list_partitions (guestfs_h *handle);
894 List all the partitions detected on all block devices.
896 The full partition device names are returned, eg. C</dev/sda1>
898 This does not return logical volumes. For that you will need to
901 This function returns a NULL-terminated array of strings
902 (like L<environ(3)>), or NULL if there was an error.
903 I<The caller must free the strings and the array after use>.
907 char *guestfs_ll (guestfs_h *handle,
908 const char *directory);
910 List the files in C<directory> (relative to the root directory,
911 there is no cwd) in the format of 'ls -la'.
913 This command is mostly useful for interactive sessions. It
914 is I<not> intended that you try to parse the output string.
916 This function returns a string, or NULL on error.
917 I<The caller must free the returned string after use>.
921 char **guestfs_ls (guestfs_h *handle,
922 const char *directory);
924 List the files in C<directory> (relative to the root directory,
925 there is no cwd). The '.' and '..' entries are not returned, but
926 hidden files are shown.
928 This command is mostly useful for interactive sessions. Programs
929 should probably use C<guestfs_readdir> instead.
931 This function returns a NULL-terminated array of strings
932 (like L<environ(3)>), or NULL if there was an error.
933 I<The caller must free the strings and the array after use>.
937 struct guestfs_stat *guestfs_lstat (guestfs_h *handle,
940 Returns file information for the given C<path>.
942 This is the same as C<guestfs_stat> except that if C<path>
943 is a symbolic link, then the link is stat-ed, not the file it
946 This is the same as the C<lstat(2)> system call.
948 This function returns a C<struct guestfs_stat *>
949 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
950 or NULL if there was an error.
951 I<The caller must call C<free> after use>.
953 =head2 guestfs_lvcreate
955 int guestfs_lvcreate (guestfs_h *handle,
957 const char *volgroup,
960 This creates an LVM volume group called C<logvol>
961 on the volume group C<volgroup>, with C<size> megabytes.
963 This function returns 0 on success or -1 on error.
965 =head2 guestfs_lvm_remove_all
967 int guestfs_lvm_remove_all (guestfs_h *handle);
969 This command removes all LVM logical volumes, volume groups
970 and physical volumes.
972 This function returns 0 on success or -1 on error.
974 B<This command is dangerous. Without careful use you
975 can easily destroy all your data>.
977 =head2 guestfs_lvremove
979 int guestfs_lvremove (guestfs_h *handle,
982 Remove an LVM logical volume C<device>, where C<device> is
983 the path to the LV, such as C</dev/VG/LV>.
985 You can also remove all LVs in a volume group by specifying
986 the VG name, C</dev/VG>.
988 This function returns 0 on success or -1 on error.
992 char **guestfs_lvs (guestfs_h *handle);
994 List all the logical volumes detected. This is the equivalent
995 of the L<lvs(8)> command.
997 This returns a list of the logical volume device names
998 (eg. C</dev/VolGroup00/LogVol00>).
1000 See also C<guestfs_lvs_full>.
1002 This function returns a NULL-terminated array of strings
1003 (like L<environ(3)>), or NULL if there was an error.
1004 I<The caller must free the strings and the array after use>.
1006 =head2 guestfs_lvs_full
1008 struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *handle);
1010 List all the logical volumes detected. This is the equivalent
1011 of the L<lvs(8)> command. The "full" version includes all fields.
1013 This function returns a C<struct guestfs_lvm_lv_list *>
1014 (see E<lt>guestfs-structs.hE<gt>),
1015 or NULL if there was an error.
1016 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.
1018 =head2 guestfs_mkdir
1020 int guestfs_mkdir (guestfs_h *handle,
1023 Create a directory named C<path>.
1025 This function returns 0 on success or -1 on error.
1027 =head2 guestfs_mkdir_p
1029 int guestfs_mkdir_p (guestfs_h *handle,
1032 Create a directory named C<path>, creating any parent directories
1033 as necessary. This is like the C<mkdir -p> shell command.
1035 This function returns 0 on success or -1 on error.
1039 int guestfs_mkfs (guestfs_h *handle,
1041 const char *device);
1043 This creates a filesystem on C<device> (usually a partition
1044 or LVM logical volume). The filesystem type is C<fstype>, for
1047 This function returns 0 on success or -1 on error.
1049 =head2 guestfs_mount
1051 int guestfs_mount (guestfs_h *handle,
1053 const char *mountpoint);
1055 Mount a guest disk at a position in the filesystem. Block devices
1056 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
1057 the guest. If those block devices contain partitions, they will have
1058 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1061 The rules are the same as for L<mount(2)>: A filesystem must
1062 first be mounted on C</> before others can be mounted. Other
1063 filesystems can only be mounted on directories which already
1066 The mounted filesystem is writable, if we have sufficient permissions
1067 on the underlying device.
1069 The filesystem options C<sync> and C<noatime> are set with this
1070 call, in order to improve reliability.
1072 This function returns 0 on success or -1 on error.
1074 =head2 guestfs_mount_options
1076 int guestfs_mount_options (guestfs_h *handle,
1077 const char *options,
1079 const char *mountpoint);
1081 This is the same as the C<guestfs_mount> command, but it
1082 allows you to set the mount options as for the
1083 L<mount(8)> I<-o> flag.
1085 This function returns 0 on success or -1 on error.
1087 =head2 guestfs_mount_ro
1089 int guestfs_mount_ro (guestfs_h *handle,
1091 const char *mountpoint);
1093 This is the same as the C<guestfs_mount> command, but it
1094 mounts the filesystem with the read-only (I<-o ro>) flag.
1096 This function returns 0 on success or -1 on error.
1098 =head2 guestfs_mount_vfs
1100 int guestfs_mount_vfs (guestfs_h *handle,
1101 const char *options,
1102 const char *vfstype,
1104 const char *mountpoint);
1106 This is the same as the C<guestfs_mount> command, but it
1107 allows you to set both the mount options and the vfstype
1108 as for the L<mount(8)> I<-o> and I<-t> flags.
1110 This function returns 0 on success or -1 on error.
1112 =head2 guestfs_mounts
1114 char **guestfs_mounts (guestfs_h *handle);
1116 This returns the list of currently mounted filesystems. It returns
1117 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1119 Some internal mounts are not shown.
1121 This function returns a NULL-terminated array of strings
1122 (like L<environ(3)>), or NULL if there was an error.
1123 I<The caller must free the strings and the array after use>.
1127 int guestfs_mv (guestfs_h *handle,
1131 This moves a file from C<src> to C<dest> where C<dest> is
1132 either a destination filename or destination directory.
1134 This function returns 0 on success or -1 on error.
1136 =head2 guestfs_ping_daemon
1138 int guestfs_ping_daemon (guestfs_h *handle);
1140 This is a test probe into the guestfs daemon running inside
1141 the qemu subprocess. Calling this function checks that the
1142 daemon responds to the ping message, without affecting the daemon
1143 or attached block device(s) in any other way.
1145 This function returns 0 on success or -1 on error.
1147 =head2 guestfs_pvcreate
1149 int guestfs_pvcreate (guestfs_h *handle,
1150 const char *device);
1152 This creates an LVM physical volume on the named C<device>,
1153 where C<device> should usually be a partition name such
1156 This function returns 0 on success or -1 on error.
1158 =head2 guestfs_pvremove
1160 int guestfs_pvremove (guestfs_h *handle,
1161 const char *device);
1163 This wipes a physical volume C<device> so that LVM will no longer
1166 The implementation uses the C<pvremove> command which refuses to
1167 wipe physical volumes that contain any volume groups, so you have
1168 to remove those first.
1170 This function returns 0 on success or -1 on error.
1174 char **guestfs_pvs (guestfs_h *handle);
1176 List all the physical volumes detected. This is the equivalent
1177 of the L<pvs(8)> command.
1179 This returns a list of just the device names that contain
1180 PVs (eg. C</dev/sda2>).
1182 See also C<guestfs_pvs_full>.
1184 This function returns a NULL-terminated array of strings
1185 (like L<environ(3)>), or NULL if there was an error.
1186 I<The caller must free the strings and the array after use>.
1188 =head2 guestfs_pvs_full
1190 struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *handle);
1192 List all the physical volumes detected. This is the equivalent
1193 of the L<pvs(8)> command. The "full" version includes all fields.
1195 This function returns a C<struct guestfs_lvm_pv_list *>
1196 (see E<lt>guestfs-structs.hE<gt>),
1197 or NULL if there was an error.
1198 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.
1200 =head2 guestfs_read_lines
1202 char **guestfs_read_lines (guestfs_h *handle,
1205 Return the contents of the file named C<path>.
1207 The file contents are returned as a list of lines. Trailing
1208 C<LF> and C<CRLF> character sequences are I<not> returned.
1210 Note that this function cannot correctly handle binary files
1211 (specifically, files containing C<\0> character which is treated
1212 as end of line). For those you need to use the C<guestfs_read_file>
1213 function which has a more complex interface.
1215 This function returns a NULL-terminated array of strings
1216 (like L<environ(3)>), or NULL if there was an error.
1217 I<The caller must free the strings and the array after use>.
1221 int guestfs_rm (guestfs_h *handle,
1224 Remove the single file C<path>.
1226 This function returns 0 on success or -1 on error.
1228 =head2 guestfs_rm_rf
1230 int guestfs_rm_rf (guestfs_h *handle,
1233 Remove the file or directory C<path>, recursively removing the
1234 contents if its a directory. This is like the C<rm -rf> shell
1237 This function returns 0 on success or -1 on error.
1239 =head2 guestfs_rmdir
1241 int guestfs_rmdir (guestfs_h *handle,
1244 Remove the single directory C<path>.
1246 This function returns 0 on success or -1 on error.
1248 =head2 guestfs_set_autosync
1250 int guestfs_set_autosync (guestfs_h *handle,
1253 If C<autosync> is true, this enables autosync. Libguestfs will make a
1254 best effort attempt to run C<guestfs_umount_all> followed by
1255 C<guestfs_sync> when the handle is closed
1256 (also if the program exits without closing handles).
1258 This is disabled by default (except in guestfish where it is
1259 enabled by default).
1261 This function returns 0 on success or -1 on error.
1263 =head2 guestfs_set_busy
1265 int guestfs_set_busy (guestfs_h *handle);
1267 This sets the state to C<BUSY>. This is only used when implementing
1268 actions using the low-level API.
1270 For more information on states, see L<guestfs(3)>.
1272 This function returns 0 on success or -1 on error.
1274 =head2 guestfs_set_e2label
1276 int guestfs_set_e2label (guestfs_h *handle,
1280 This sets the ext2/3/4 filesystem label of the filesystem on
1281 C<device> to C<label>. Filesystem labels are limited to
1284 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1285 to return the existing label on a filesystem.
1287 This function returns 0 on success or -1 on error.
1289 =head2 guestfs_set_e2uuid
1291 int guestfs_set_e2uuid (guestfs_h *handle,
1295 This sets the ext2/3/4 filesystem UUID of the filesystem on
1296 C<device> to C<uuid>. The format of the UUID and alternatives
1297 such as C<clear>, C<random> and C<time> are described in the
1298 L<tune2fs(8)> manpage.
1300 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1301 to return the existing UUID of a filesystem.
1303 This function returns 0 on success or -1 on error.
1305 =head2 guestfs_set_path
1307 int guestfs_set_path (guestfs_h *handle,
1310 Set the path that libguestfs searches for kernel and initrd.img.
1312 The default is C<$libdir/guestfs> unless overridden by setting
1313 C<LIBGUESTFS_PATH> environment variable.
1315 The string C<path> is stashed in the libguestfs handle, so the caller
1316 must make sure it remains valid for the lifetime of the handle.
1318 Setting C<path> to C<NULL> restores the default path.
1320 This function returns 0 on success or -1 on error.
1322 =head2 guestfs_set_qemu
1324 int guestfs_set_qemu (guestfs_h *handle,
1327 Set the qemu binary that we will use.
1329 The default is chosen when the library was compiled by the
1332 You can also override this by setting the C<LIBGUESTFS_QEMU>
1333 environment variable.
1335 The string C<qemu> is stashed in the libguestfs handle, so the caller
1336 must make sure it remains valid for the lifetime of the handle.
1338 Setting C<qemu> to C<NULL> restores the default qemu binary.
1340 This function returns 0 on success or -1 on error.
1342 =head2 guestfs_set_ready
1344 int guestfs_set_ready (guestfs_h *handle);
1346 This sets the state to C<READY>. This is only used when implementing
1347 actions using the low-level API.
1349 For more information on states, see L<guestfs(3)>.
1351 This function returns 0 on success or -1 on error.
1353 =head2 guestfs_set_verbose
1355 int guestfs_set_verbose (guestfs_h *handle,
1358 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
1360 Verbose messages are disabled unless the environment variable
1361 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
1363 This function returns 0 on success or -1 on error.
1365 =head2 guestfs_sfdisk
1367 int guestfs_sfdisk (guestfs_h *handle,
1372 char * const* const lines);
1374 This is a direct interface to the L<sfdisk(8)> program for creating
1375 partitions on block devices.
1377 C<device> should be a block device, for example C</dev/sda>.
1379 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1380 and sectors on the device, which are passed directly to sfdisk as
1381 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1382 of these, then the corresponding parameter is omitted. Usually for
1383 'large' disks, you can just pass C<0> for these, but for small
1384 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1385 out the right geometry and you will need to tell it.
1387 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1388 information refer to the L<sfdisk(8)> manpage.
1390 To create a single partition occupying the whole disk, you would
1391 pass C<lines> as a single element list, when the single element being
1392 the string C<,> (comma).
1394 This function returns 0 on success or -1 on error.
1396 B<This command is dangerous. Without careful use you
1397 can easily destroy all your data>.
1401 struct guestfs_stat *guestfs_stat (guestfs_h *handle,
1404 Returns file information for the given C<path>.
1406 This is the same as the C<stat(2)> system call.
1408 This function returns a C<struct guestfs_stat *>
1409 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1410 or NULL if there was an error.
1411 I<The caller must call C<free> after use>.
1413 =head2 guestfs_statvfs
1415 struct guestfs_statvfs *guestfs_statvfs (guestfs_h *handle,
1418 Returns file system statistics for any mounted file system.
1419 C<path> should be a file or directory in the mounted file system
1420 (typically it is the mount point itself, but it doesn't need to be).
1422 This is the same as the C<statvfs(2)> system call.
1424 This function returns a C<struct guestfs_statvfs *>
1425 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
1426 or NULL if there was an error.
1427 I<The caller must call C<free> after use>.
1429 =head2 guestfs_strings
1431 char **guestfs_strings (guestfs_h *handle,
1434 This runs the L<strings(1)> command on a file and returns
1435 the list of printable strings found.
1437 This function returns a NULL-terminated array of strings
1438 (like L<environ(3)>), or NULL if there was an error.
1439 I<The caller must free the strings and the array after use>.
1441 Because of the message protocol, there is a transfer limit
1442 of somewhere between 2MB and 4MB. To transfer large files you should use
1445 =head2 guestfs_strings_e
1447 char **guestfs_strings_e (guestfs_h *handle,
1448 const char *encoding,
1451 This is like the C<guestfs_strings> command, but allows you to
1452 specify the encoding.
1454 See the L<strings(1)> manpage for the full list of encodings.
1456 Commonly useful encodings are C<l> (lower case L) which will
1457 show strings inside Windows/x86 files.
1459 The returned strings are transcoded to UTF-8.
1461 This function returns a NULL-terminated array of strings
1462 (like L<environ(3)>), or NULL if there was an error.
1463 I<The caller must free the strings and the array after use>.
1465 Because of the message protocol, there is a transfer limit
1466 of somewhere between 2MB and 4MB. To transfer large files you should use
1471 int guestfs_sync (guestfs_h *handle);
1473 This syncs the disk, so that any writes are flushed through to the
1474 underlying disk image.
1476 You should always call this if you have modified a disk image, before
1479 This function returns 0 on success or -1 on error.
1481 =head2 guestfs_tar_in
1483 int guestfs_tar_in (guestfs_h *handle,
1484 const char *tarfile,
1485 const char *directory);
1487 This command uploads and unpacks local file C<tarfile> (an
1488 I<uncompressed> tar file) into C<directory>.
1490 To upload a compressed tarball, use C<guestfs_tgz_in>.
1492 This function returns 0 on success or -1 on error.
1494 =head2 guestfs_tar_out
1496 int guestfs_tar_out (guestfs_h *handle,
1497 const char *directory,
1498 const char *tarfile);
1500 This command packs the contents of C<directory> and downloads
1501 it to local file C<tarfile>.
1503 To download a compressed tarball, use C<guestfs_tgz_out>.
1505 This function returns 0 on success or -1 on error.
1507 =head2 guestfs_tgz_in
1509 int guestfs_tgz_in (guestfs_h *handle,
1510 const char *tarball,
1511 const char *directory);
1513 This command uploads and unpacks local file C<tarball> (a
1514 I<gzip compressed> tar file) into C<directory>.
1516 To upload an uncompressed tarball, use C<guestfs_tar_in>.
1518 This function returns 0 on success or -1 on error.
1520 =head2 guestfs_tgz_out
1522 int guestfs_tgz_out (guestfs_h *handle,
1523 const char *directory,
1524 const char *tarball);
1526 This command packs the contents of C<directory> and downloads
1527 it to local file C<tarball>.
1529 To download an uncompressed tarball, use C<guestfs_tar_out>.
1531 This function returns 0 on success or -1 on error.
1533 =head2 guestfs_touch
1535 int guestfs_touch (guestfs_h *handle,
1538 Touch acts like the L<touch(1)> command. It can be used to
1539 update the timestamps on a file, or, if the file does not exist,
1540 to create a new zero-length file.
1542 This function returns 0 on success or -1 on error.
1544 =head2 guestfs_tune2fs_l
1546 char **guestfs_tune2fs_l (guestfs_h *handle,
1547 const char *device);
1549 This returns the contents of the ext2, ext3 or ext4 filesystem
1550 superblock on C<device>.
1552 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1553 manpage for more details. The list of fields returned isn't
1554 clearly defined, and depends on both the version of C<tune2fs>
1555 that libguestfs was built against, and the filesystem itself.
1557 This function returns a NULL-terminated array of
1558 strings, or NULL if there was an error.
1559 The array of strings will always have length C<2n+1>, where
1560 C<n> keys and values alternate, followed by the trailing NULL entry.
1561 I<The caller must free the strings and the array after use>.
1563 =head2 guestfs_umount
1565 int guestfs_umount (guestfs_h *handle,
1566 const char *pathordevice);
1568 This unmounts the given filesystem. The filesystem may be
1569 specified either by its mountpoint (path) or the device which
1570 contains the filesystem.
1572 This function returns 0 on success or -1 on error.
1574 =head2 guestfs_umount_all
1576 int guestfs_umount_all (guestfs_h *handle);
1578 This unmounts all mounted filesystems.
1580 Some internal mounts are not unmounted by this call.
1582 This function returns 0 on success or -1 on error.
1584 =head2 guestfs_upload
1586 int guestfs_upload (guestfs_h *handle,
1587 const char *filename,
1588 const char *remotefilename);
1590 Upload local file C<filename> to C<remotefilename> on the
1593 C<filename> can also be a named pipe.
1595 See also C<guestfs_download>.
1597 This function returns 0 on success or -1 on error.
1599 =head2 guestfs_vgcreate
1601 int guestfs_vgcreate (guestfs_h *handle,
1602 const char *volgroup,
1603 char * const* const physvols);
1605 This creates an LVM volume group called C<volgroup>
1606 from the non-empty list of physical volumes C<physvols>.
1608 This function returns 0 on success or -1 on error.
1610 =head2 guestfs_vgremove
1612 int guestfs_vgremove (guestfs_h *handle,
1613 const char *vgname);
1615 Remove an LVM volume group C<vgname>, (for example C<VG>).
1617 This also forcibly removes all logical volumes in the volume
1620 This function returns 0 on success or -1 on error.
1624 char **guestfs_vgs (guestfs_h *handle);
1626 List all the volumes groups detected. This is the equivalent
1627 of the L<vgs(8)> command.
1629 This returns a list of just the volume group names that were
1630 detected (eg. C<VolGroup00>).
1632 See also C<guestfs_vgs_full>.
1634 This function returns a NULL-terminated array of strings
1635 (like L<environ(3)>), or NULL if there was an error.
1636 I<The caller must free the strings and the array after use>.
1638 =head2 guestfs_vgs_full
1640 struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *handle);
1642 List all the volumes groups detected. This is the equivalent
1643 of the L<vgs(8)> command. The "full" version includes all fields.
1645 This function returns a C<struct guestfs_lvm_vg_list *>
1646 (see E<lt>guestfs-structs.hE<gt>),
1647 or NULL if there was an error.
1648 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.
1650 =head2 guestfs_wait_ready
1652 int guestfs_wait_ready (guestfs_h *handle);
1654 Internally libguestfs is implemented by running a virtual machine
1657 You should call this after C<guestfs_launch> to wait for the launch
1660 This function returns 0 on success or -1 on error.
1662 =head2 guestfs_write_file
1664 int guestfs_write_file (guestfs_h *handle,
1666 const char *content,
1669 This call creates a file called C<path>. The contents of the
1670 file is the string C<content> (which can contain any 8 bit data),
1671 with length C<size>.
1673 As a special case, if C<size> is C<0>
1674 then the length is calculated using C<strlen> (so in this case
1675 the content cannot contain embedded ASCII NULs).
1677 I<NB.> Owing to a bug, writing content containing ASCII NUL
1678 characters does I<not> work, even if the length is specified.
1679 We hope to resolve this bug in a future version. In the meantime
1680 use C<guestfs_upload>.
1682 This function returns 0 on success or -1 on error.
1684 Because of the message protocol, there is a transfer limit
1685 of somewhere between 2MB and 4MB. To transfer large files you should use
1690 int guestfs_zero (guestfs_h *handle,
1691 const char *device);
1693 This command writes zeroes over the first few blocks of C<device>.
1695 How many blocks are zeroed isn't specified (but it's I<not> enough
1696 to securely wipe the device). It should be sufficient to remove
1697 any partition tables, filesystem superblocks and so on.
1699 This function returns 0 on success or -1 on error.